xref: /freebsd/sys/ufs/ufs/ufsmount.h (revision 42249ef2)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)ufsmount.h	8.6 (Berkeley) 3/30/95
32  * $FreeBSD$
33  */
34 
35 #ifndef _UFS_UFS_UFSMOUNT_H_
36 #define	_UFS_UFS_UFSMOUNT_H_
37 
38 /*
39  * Arguments to mount UFS-based filesystems
40  */
41 struct ufs_args {
42 	char	*fspec;			/* block special device to mount */
43 	struct	oexport_args export;	/* network export information */
44 };
45 
46 #ifdef _KERNEL
47 
48 #ifdef MALLOC_DECLARE
49 MALLOC_DECLARE(M_UFSMNT);
50 MALLOC_DECLARE(M_TRIM);
51 #endif
52 
53 struct buf;
54 struct inode;
55 struct nameidata;
56 struct taskqueue;
57 struct timeval;
58 struct ucred;
59 struct uio;
60 struct vnode;
61 struct ufs_extattr_per_mount;
62 struct jblocks;
63 struct inodedep;
64 
65 TAILQ_HEAD(inodedeplst, inodedep);
66 LIST_HEAD(bmsafemaphd, bmsafemap);
67 LIST_HEAD(trimlist_hashhead, ffs_blkfree_trim_params);
68 
69 /*
70  * This structure describes the UFS specific mount structure data.
71  * The function operators are used to support different versions of
72  * UFS (UFS1, UFS2, etc).
73  *
74  * Lock reference:
75  *	c - set at allocation then constant until freed
76  *	i - ufsmount interlock (UFS_LOCK / UFS_UNLOCK)
77  *	q - associated quota file is locked
78  *	r - ref to parent mount structure is held (vfs_busy / vfs_unbusy)
79  *	u - managed by user process fsck_ufs
80  */
81 struct ufsmount {
82 	struct	mount *um_mountp;		/* (r) filesystem vfs struct */
83 	struct	cdev *um_dev;			/* (r) device mounted */
84 	struct	g_consumer *um_cp;		/* (r) GEOM access point */
85 	struct	bufobj *um_bo;			/* (r) Buffer cache object */
86 	struct	vnode *um_devvp;		/* (r) blk dev mounted vnode */
87 	u_long	um_fstype;			/* (c) type of filesystem */
88 	struct	fs *um_fs;			/* (r) pointer to superblock */
89 	struct	ufs_extattr_per_mount um_extattr; /* (c) extended attrs */
90 	u_long	um_nindir;			/* (c) indirect ptrs per blk */
91 	u_long	um_bptrtodb;			/* (c) indir disk block ptr */
92 	u_long	um_seqinc;			/* (c) inc between seq blocks */
93 	struct	mtx um_lock;			/* (c) Protects ufsmount & fs */
94 	pid_t	um_fsckpid;			/* (u) PID can do fsck sysctl */
95 	struct	mount_softdeps *um_softdep;	/* (c) softdep mgmt structure */
96 	struct	vnode *um_quotas[MAXQUOTAS];	/* (q) pointer to quota files */
97 	struct	ucred *um_cred[MAXQUOTAS];	/* (q) quota file access cred */
98 	time_t	um_btime[MAXQUOTAS];		/* (q) block quota time limit */
99 	time_t	um_itime[MAXQUOTAS];		/* (q) inode quota time limit */
100 	char	um_qflags[MAXQUOTAS];		/* (i) quota specific flags */
101 	int64_t	um_savedmaxfilesize;		/* (c) track maxfilesize */
102 	u_int	um_flags;			/* (i) filesystem flags */
103 	struct	timeval um_last_fullmsg;	/* (i) last full msg time */
104 	int	um_secs_fullmsg;		/* (i) seconds since full msg */
105 	struct	timeval um_last_integritymsg;	/* (i) last integrity msg */
106 	int	um_secs_integritymsg;		/* (i) secs since integ msg */
107 	u_int	um_trim_inflight;		/* (i) outstanding trim count */
108 	u_int	um_trim_inflight_blks;		/* (i) outstanding trim blks */
109 	u_long	um_trim_total;			/* (i) total trim count */
110 	u_long	um_trim_total_blks;		/* (i) total trim block count */
111 	struct	taskqueue *um_trim_tq;		/* (c) trim request queue */
112 	struct	trimlist_hashhead *um_trimhash;	/* (i) trimlist hash table */
113 	u_long	um_trimlisthashsize;		/* (i) trim hash table size-1 */
114 						/* (c) - below function ptrs */
115 	int	(*um_balloc)(struct vnode *, off_t, int, struct ucred *,
116 		    int, struct buf **);
117 	int	(*um_blkatoff)(struct vnode *, off_t, char **, struct buf **);
118 	int	(*um_truncate)(struct vnode *, off_t, int, struct ucred *);
119 	int	(*um_update)(struct vnode *, int);
120 	int	(*um_valloc)(struct vnode *, int, struct ucred *,
121 		    struct vnode **);
122 	int	(*um_vfree)(struct vnode *, ino_t, int);
123 	void	(*um_ifree)(struct ufsmount *, struct inode *);
124 	int	(*um_rdonly)(struct inode *);
125 	void	(*um_snapgone)(struct inode *);
126 	int	(*um_check_blkno)(struct mount *, ino_t, daddr_t, int);
127 };
128 
129 /*
130  * filesystem flags
131  */
132 #define UM_CANDELETE		0x00000001	/* devvp supports TRIM */
133 #define UM_WRITESUSPENDED	0x00000002	/* suspension in progress */
134 
135 /*
136  * function prototypes
137  */
138 #define	UFS_BALLOC(aa, bb, cc, dd, ee, ff) \
139 	VFSTOUFS((aa)->v_mount)->um_balloc(aa, bb, cc, dd, ee, ff)
140 #define	UFS_BLKATOFF(aa, bb, cc, dd) \
141 	VFSTOUFS((aa)->v_mount)->um_blkatoff(aa, bb, cc, dd)
142 #define	UFS_TRUNCATE(aa, bb, cc, dd) \
143 	VFSTOUFS((aa)->v_mount)->um_truncate(aa, bb, cc, dd)
144 #define	UFS_UPDATE(aa, bb) VFSTOUFS((aa)->v_mount)->um_update(aa, bb)
145 #define	UFS_VALLOC(aa, bb, cc, dd) \
146 	VFSTOUFS((aa)->v_mount)->um_valloc(aa, bb, cc, dd)
147 #define	UFS_VFREE(aa, bb, cc) VFSTOUFS((aa)->v_mount)->um_vfree(aa, bb, cc)
148 #define	UFS_IFREE(aa, bb) ((aa)->um_ifree(aa, bb))
149 #define	UFS_RDONLY(aa) (ITOUMP(aa)->um_rdonly(aa))
150 #define	UFS_SNAPGONE(aa) (ITOUMP(aa)->um_snapgone(aa))
151 #define	UFS_CHECK_BLKNO(aa, bb, cc, dd) 		\
152 	(VFSTOUFS(aa)->um_check_blkno == NULL ? 0 :	\
153 	 VFSTOUFS(aa)->um_check_blkno(aa, bb, cc, dd))
154 
155 #define	UFS_LOCK(aa)	mtx_lock(&(aa)->um_lock)
156 #define	UFS_UNLOCK(aa)	mtx_unlock(&(aa)->um_lock)
157 #define	UFS_MTX(aa)	(&(aa)->um_lock)
158 
159 /*
160  * Filesystem types
161  */
162 #define	UFS1	1
163 #define	UFS2	2
164 
165 /*
166  * Flags describing the state of quotas.
167  */
168 #define	QTF_OPENING	0x01			/* Q_QUOTAON in progress */
169 #define	QTF_CLOSING	0x02			/* Q_QUOTAOFF in progress */
170 #define	QTF_64BIT	0x04			/* 64-bit quota file */
171 
172 /* Convert mount ptr to ufsmount ptr. */
173 #define	VFSTOUFS(mp)	((struct ufsmount *)((mp)->mnt_data))
174 #define	UFSTOVFS(ump)	(ump)->um_mountp
175 
176 /*
177  * Macros to access filesystem parameters in the ufsmount structure.
178  * Used by ufs_bmap.
179  */
180 #define	MNINDIR(ump)			((ump)->um_nindir)
181 #define	blkptrtodb(ump, b)		((b) << (ump)->um_bptrtodb)
182 #define	is_sequential(ump, a, b)	((b) == (a) + ump->um_seqinc)
183 #endif /* _KERNEL */
184 
185 #endif
186