2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
32 #ifndef _UFS_UFS_UFSMOUNT_H_
33 #define _UFS_UFS_UFSMOUNT_H_
36 * Arguments to mount UFS-based filesystems
39 char *fspec; /* block special device to mount */
40 struct oexport_args export; /* network export information */
43 #include <sys/_task.h>
47 MALLOC_DECLARE(M_UFSMNT);
48 MALLOC_DECLARE(M_TRIM);
60 struct ufs_extattr_per_mount;
64 TAILQ_HEAD(inodedeplst, inodedep);
65 LIST_HEAD(bmsafemaphd, bmsafemap);
66 LIST_HEAD(trimlist_hashhead, ffs_blkfree_trim_params);
68 #include <sys/_lock.h>
69 #include <sys/_mutex.h>
73 * This structure describes the UFS specific mount structure data.
74 * The function operators are used to support different versions of
75 * UFS (UFS1, UFS2, etc).
78 * c - set at allocation then constant until freed
79 * i - ufsmount interlock (UFS_LOCK / UFS_UNLOCK)
80 * q - associated quota file is locked
81 * r - ref to parent mount structure is held (vfs_busy / vfs_unbusy)
84 struct mount *um_mountp; /* (r) filesystem vfs struct */
85 struct cdev *um_dev; /* (r) device mounted */
86 struct g_consumer *um_cp; /* (r) GEOM access point */
87 struct bufobj *um_bo; /* (r) Buffer cache object */
88 struct vnode *um_odevvp; /* (r) devfs dev vnode */
89 struct vnode *um_devvp; /* (r) mntfs private vnode */
90 uint64_t um_fstype; /* (c) type of filesystem */
91 struct fs *um_fs; /* (r) pointer to superblock */
92 struct ufs_extattr_per_mount um_extattr; /* (c) extended attrs */
93 uint64_t um_nindir; /* (c) indirect ptrs per blk */
94 uint64_t um_bptrtodb; /* (c) indir disk block ptr */
95 uint64_t um_seqinc; /* (c) inc between seq blocks */
96 uint64_t um_bsize; /* (c) fs block size */
97 uint64_t um_maxsymlinklen; /* (c) max size of short
99 struct mtx um_lock; /* (c) Protects ufsmount & fs */
100 struct sx um_checkpath_lock; /* (c) Protects ufs_checkpath()
102 struct mount_softdeps *um_softdep; /* (c) softdep mgmt structure */
103 struct vnode *um_quotas[MAXQUOTAS]; /* (q) pointer to quota files */
104 struct ucred *um_cred[MAXQUOTAS]; /* (q) quota file access cred */
105 time_t um_btime[MAXQUOTAS]; /* (q) block quota time limit */
106 time_t um_itime[MAXQUOTAS]; /* (q) inode quota time limit */
107 char um_qflags[MAXQUOTAS]; /* (i) quota specific flags */
108 int64_t um_savedmaxfilesize; /* (c) track maxfilesize */
109 uint64_t um_flags; /* (i) filesystem flags */
110 struct timeval um_last_fullmsg; /* (i) last full msg time */
111 int um_secs_fullmsg; /* (i) seconds since full msg */
112 struct timeval um_last_integritymsg; /* (i) last integrity msg */
113 int um_secs_integritymsg; /* (i) secs since integ msg */
114 uint64_t um_trim_inflight; /* (i) outstanding trim count */
115 uint64_t um_trim_inflight_blks; /* (i) outstanding trim blks */
116 uint64_t um_trim_total; /* (i) total trim count */
117 uint64_t um_trim_total_blks; /* (i) total trim block count */
118 struct taskqueue *um_trim_tq; /* (c) trim request queue */
119 struct trimlist_hashhead *um_trimhash; /* (i) trimlist hash table */
120 u_long um_trimlisthashsize; /* (i) trim hash table size-1 */
121 /* (c) - below function ptrs */
122 int (*um_balloc)(struct vnode *, off_t, int, struct ucred *,
124 int (*um_blkatoff)(struct vnode *, off_t, char **, struct buf **);
125 int (*um_truncate)(struct vnode *, off_t, int, struct ucred *);
126 int (*um_update)(struct vnode *, int);
127 int (*um_valloc)(struct vnode *, int, struct ucred *,
129 int (*um_vfree)(struct vnode *, ino_t, int);
130 void (*um_ifree)(struct ufsmount *, struct inode *);
131 int (*um_rdonly)(struct inode *);
132 void (*um_snapgone)(struct inode *);
133 int (*um_check_blkno)(struct mount *, ino_t, daddr_t, int);
139 #define UM_CANDELETE 0x00000001 /* devvp supports TRIM */
140 #define UM_WRITESUSPENDED 0x00000002 /* suspension in progress */
141 #define UM_CANSPEEDUP 0x00000004 /* devvp supports SPEEDUP */
142 #define UM_FSFAIL_CLEANUP 0x00000008 /* need cleanup after
143 unrecoverable error */
145 * function prototypes
147 #define UFS_BALLOC(aa, bb, cc, dd, ee, ff) \
148 VFSTOUFS((aa)->v_mount)->um_balloc(aa, bb, cc, dd, ee, ff)
149 #define UFS_BLKATOFF(aa, bb, cc, dd) \
150 VFSTOUFS((aa)->v_mount)->um_blkatoff(aa, bb, cc, dd)
151 #define UFS_TRUNCATE(aa, bb, cc, dd) \
152 VFSTOUFS((aa)->v_mount)->um_truncate(aa, bb, cc, dd)
153 #define UFS_UPDATE(aa, bb) VFSTOUFS((aa)->v_mount)->um_update(aa, bb)
154 #define UFS_VALLOC(aa, bb, cc, dd) \
155 VFSTOUFS((aa)->v_mount)->um_valloc(aa, bb, cc, dd)
156 #define UFS_VFREE(aa, bb, cc) VFSTOUFS((aa)->v_mount)->um_vfree(aa, bb, cc)
157 #define UFS_IFREE(aa, bb) ((aa)->um_ifree(aa, bb))
158 #define UFS_RDONLY(aa) (ITOUMP(aa)->um_rdonly(aa))
159 #define UFS_SNAPGONE(aa) (ITOUMP(aa)->um_snapgone(aa))
160 #define UFS_CHECK_BLKNO(aa, bb, cc, dd) \
161 (VFSTOUFS(aa)->um_check_blkno == NULL ? 0 : \
162 VFSTOUFS(aa)->um_check_blkno(aa, bb, cc, dd))
164 #define UFS_LOCK(aa) mtx_lock(&(aa)->um_lock)
165 #define UFS_UNLOCK(aa) mtx_unlock(&(aa)->um_lock)
166 #define UFS_MTX(aa) (&(aa)->um_lock)
175 * Flags describing the state of quotas.
177 #define QTF_OPENING 0x01 /* Q_QUOTAON in progress */
178 #define QTF_CLOSING 0x02 /* Q_QUOTAOFF in progress */
179 #define QTF_64BIT 0x04 /* 64-bit quota file */
181 /* Convert mount ptr to ufsmount ptr. */
182 #define VFSTOUFS(mp) ((struct ufsmount *)((mp)->mnt_data))
183 #define UFSTOVFS(ump) (ump)->um_mountp
186 * Macros to access filesystem parameters in the ufsmount structure.
189 #define MNINDIR(ump) ((ump)->um_nindir)
190 #define blkptrtodb(ump, b) ((b) << (ump)->um_bptrtodb)
191 #define is_sequential(ump, a, b) ((b) == (a) + ump->um_seqinc)
193 /* true if old FS format...*/
194 #define OFSFMT(vp) (VFSTOUFS((vp)->v_mount)->um_maxsymlinklen <= 0)