FreeBSD/Linux Kernel Cross Reference
sys/sys/mount.h
1 /*-
2 * Copyright (c) 1989, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)mount.h 8.21 (Berkeley) 5/20/95
30 * $FreeBSD: releng/10.0/sys/sys/mount.h 255136 2013-09-01 23:02:59Z rmacklem $
31 */
32
33 #ifndef _SYS_MOUNT_H_
34 #define _SYS_MOUNT_H_
35
36 #include <sys/ucred.h>
37 #include <sys/queue.h>
38 #ifdef _KERNEL
39 #include <sys/lock.h>
40 #include <sys/lockmgr.h>
41 #include <sys/_mutex.h>
42 #endif
43
44 /*
45 * NOTE: When changing statfs structure, mount structure, MNT_* flags or
46 * MNTK_* flags also update DDB show mount command in vfs_subr.c.
47 */
48
49 typedef struct fsid { int32_t val[2]; } fsid_t; /* filesystem id type */
50
51 /*
52 * File identifier.
53 * These are unique per filesystem on a single machine.
54 */
55 #define MAXFIDSZ 16
56
57 struct fid {
58 u_short fid_len; /* length of data in bytes */
59 u_short fid_data0; /* force longword alignment */
60 char fid_data[MAXFIDSZ]; /* data (variable length) */
61 };
62
63 /*
64 * filesystem statistics
65 */
66 #define MFSNAMELEN 16 /* length of type name including null */
67 #define MNAMELEN 88 /* size of on/from name bufs */
68 #define STATFS_VERSION 0x20030518 /* current version number */
69 struct statfs {
70 uint32_t f_version; /* structure version number */
71 uint32_t f_type; /* type of filesystem */
72 uint64_t f_flags; /* copy of mount exported flags */
73 uint64_t f_bsize; /* filesystem fragment size */
74 uint64_t f_iosize; /* optimal transfer block size */
75 uint64_t f_blocks; /* total data blocks in filesystem */
76 uint64_t f_bfree; /* free blocks in filesystem */
77 int64_t f_bavail; /* free blocks avail to non-superuser */
78 uint64_t f_files; /* total file nodes in filesystem */
79 int64_t f_ffree; /* free nodes avail to non-superuser */
80 uint64_t f_syncwrites; /* count of sync writes since mount */
81 uint64_t f_asyncwrites; /* count of async writes since mount */
82 uint64_t f_syncreads; /* count of sync reads since mount */
83 uint64_t f_asyncreads; /* count of async reads since mount */
84 uint64_t f_spare[10]; /* unused spare */
85 uint32_t f_namemax; /* maximum filename length */
86 uid_t f_owner; /* user that mounted the filesystem */
87 fsid_t f_fsid; /* filesystem id */
88 char f_charspare[80]; /* spare string space */
89 char f_fstypename[MFSNAMELEN]; /* filesystem type name */
90 char f_mntfromname[MNAMELEN]; /* mounted filesystem */
91 char f_mntonname[MNAMELEN]; /* directory on which mounted */
92 };
93
94 #ifdef _KERNEL
95 #define OMFSNAMELEN 16 /* length of fs type name, including null */
96 #define OMNAMELEN (88 - 2 * sizeof(long)) /* size of on/from name bufs */
97
98 /* XXX getfsstat.2 is out of date with write and read counter changes here. */
99 /* XXX statfs.2 is out of date with read counter changes here. */
100 struct ostatfs {
101 long f_spare2; /* placeholder */
102 long f_bsize; /* fundamental filesystem block size */
103 long f_iosize; /* optimal transfer block size */
104 long f_blocks; /* total data blocks in filesystem */
105 long f_bfree; /* free blocks in fs */
106 long f_bavail; /* free blocks avail to non-superuser */
107 long f_files; /* total file nodes in filesystem */
108 long f_ffree; /* free file nodes in fs */
109 fsid_t f_fsid; /* filesystem id */
110 uid_t f_owner; /* user that mounted the filesystem */
111 int f_type; /* type of filesystem */
112 int f_flags; /* copy of mount exported flags */
113 long f_syncwrites; /* count of sync writes since mount */
114 long f_asyncwrites; /* count of async writes since mount */
115 char f_fstypename[OMFSNAMELEN]; /* fs type name */
116 char f_mntonname[OMNAMELEN]; /* directory on which mounted */
117 long f_syncreads; /* count of sync reads since mount */
118 long f_asyncreads; /* count of async reads since mount */
119 short f_spares1; /* unused spare */
120 char f_mntfromname[OMNAMELEN];/* mounted filesystem */
121 short f_spares2; /* unused spare */
122 /*
123 * XXX on machines where longs are aligned to 8-byte boundaries, there
124 * is an unnamed int32_t here. This spare was after the apparent end
125 * of the struct until we bit off the read counters from f_mntonname.
126 */
127 long f_spare[2]; /* unused spare */
128 };
129
130 TAILQ_HEAD(vnodelst, vnode);
131
132 /* Mount options list */
133 TAILQ_HEAD(vfsoptlist, vfsopt);
134 struct vfsopt {
135 TAILQ_ENTRY(vfsopt) link;
136 char *name;
137 void *value;
138 int len;
139 int pos;
140 int seen;
141 };
142
143 /*
144 * Structure per mounted filesystem. Each mounted filesystem has an
145 * array of operations and an instance record. The filesystems are
146 * put on a doubly linked list.
147 *
148 * Lock reference:
149 * m - mountlist_mtx
150 * i - interlock
151 * v - vnode freelist mutex
152 *
153 * Unmarked fields are considered stable as long as a ref is held.
154 *
155 */
156 struct mount {
157 struct mtx mnt_mtx; /* mount structure interlock */
158 int mnt_gen; /* struct mount generation */
159 #define mnt_startzero mnt_list
160 TAILQ_ENTRY(mount) mnt_list; /* (m) mount list */
161 struct vfsops *mnt_op; /* operations on fs */
162 struct vfsconf *mnt_vfc; /* configuration info */
163 struct vnode *mnt_vnodecovered; /* vnode we mounted on */
164 struct vnode *mnt_syncer; /* syncer vnode */
165 int mnt_ref; /* (i) Reference count */
166 struct vnodelst mnt_nvnodelist; /* (i) list of vnodes */
167 int mnt_nvnodelistsize; /* (i) # of vnodes */
168 struct vnodelst mnt_activevnodelist; /* (v) list of active vnodes */
169 int mnt_activevnodelistsize;/* (v) # of active vnodes */
170 int mnt_writeopcount; /* (i) write syscalls pending */
171 int mnt_kern_flag; /* (i) kernel only flags */
172 uint64_t mnt_flag; /* (i) flags shared with user */
173 struct vfsoptlist *mnt_opt; /* current mount options */
174 struct vfsoptlist *mnt_optnew; /* new options passed to fs */
175 int mnt_maxsymlinklen; /* max size of short symlink */
176 struct statfs mnt_stat; /* cache of filesystem stats */
177 struct ucred *mnt_cred; /* credentials of mounter */
178 void * mnt_data; /* private data */
179 time_t mnt_time; /* last time written*/
180 int mnt_iosize_max; /* max size for clusters, etc */
181 struct netexport *mnt_export; /* export list */
182 struct label *mnt_label; /* MAC label for the fs */
183 u_int mnt_hashseed; /* Random seed for vfs_hash */
184 int mnt_lockref; /* (i) Lock reference count */
185 int mnt_secondary_writes; /* (i) # of secondary writes */
186 int mnt_secondary_accwrites;/* (i) secondary wr. starts */
187 struct thread *mnt_susp_owner; /* (i) thread owning suspension */
188 #define mnt_endzero mnt_gjprovider
189 char *mnt_gjprovider; /* gjournal provider name */
190 struct lock mnt_explock; /* vfs_export walkers lock */
191 TAILQ_ENTRY(mount) mnt_upper_link; /* (m) we in the all uppers */
192 TAILQ_HEAD(, mount) mnt_uppers; /* (m) upper mounts over us*/
193 };
194
195 /*
196 * Definitions for MNT_VNODE_FOREACH_ALL.
197 */
198 struct vnode *__mnt_vnode_next_all(struct vnode **mvp, struct mount *mp);
199 struct vnode *__mnt_vnode_first_all(struct vnode **mvp, struct mount *mp);
200 void __mnt_vnode_markerfree_all(struct vnode **mvp, struct mount *mp);
201
202 #define MNT_VNODE_FOREACH_ALL(vp, mp, mvp) \
203 for (vp = __mnt_vnode_first_all(&(mvp), (mp)); \
204 (vp) != NULL; vp = __mnt_vnode_next_all(&(mvp), (mp)))
205
206 #define MNT_VNODE_FOREACH_ALL_ABORT(mp, mvp) \
207 do { \
208 MNT_ILOCK(mp); \
209 __mnt_vnode_markerfree_all(&(mvp), (mp)); \
210 /* MNT_IUNLOCK(mp); -- done in above function */ \
211 mtx_assert(MNT_MTX(mp), MA_NOTOWNED); \
212 } while (0)
213
214 /*
215 * Definitions for MNT_VNODE_FOREACH_ACTIVE.
216 */
217 struct vnode *__mnt_vnode_next_active(struct vnode **mvp, struct mount *mp);
218 struct vnode *__mnt_vnode_first_active(struct vnode **mvp, struct mount *mp);
219 void __mnt_vnode_markerfree_active(struct vnode **mvp, struct mount *);
220
221 #define MNT_VNODE_FOREACH_ACTIVE(vp, mp, mvp) \
222 for (vp = __mnt_vnode_first_active(&(mvp), (mp)); \
223 (vp) != NULL; vp = __mnt_vnode_next_active(&(mvp), (mp)))
224
225 #define MNT_VNODE_FOREACH_ACTIVE_ABORT(mp, mvp) \
226 __mnt_vnode_markerfree_active(&(mvp), (mp))
227
228 #define MNT_ILOCK(mp) mtx_lock(&(mp)->mnt_mtx)
229 #define MNT_ITRYLOCK(mp) mtx_trylock(&(mp)->mnt_mtx)
230 #define MNT_IUNLOCK(mp) mtx_unlock(&(mp)->mnt_mtx)
231 #define MNT_MTX(mp) (&(mp)->mnt_mtx)
232 #define MNT_REF(mp) (mp)->mnt_ref++
233 #define MNT_REL(mp) do { \
234 KASSERT((mp)->mnt_ref > 0, ("negative mnt_ref")); \
235 (mp)->mnt_ref--; \
236 if ((mp)->mnt_ref == 0) \
237 wakeup((mp)); \
238 } while (0)
239
240 #endif /* _KERNEL */
241
242 /*
243 * User specifiable flags, stored in mnt_flag.
244 */
245 #define MNT_RDONLY 0x0000000000000001ULL /* read only filesystem */
246 #define MNT_SYNCHRONOUS 0x0000000000000002ULL /* fs written synchronously */
247 #define MNT_NOEXEC 0x0000000000000004ULL /* can't exec from filesystem */
248 #define MNT_NOSUID 0x0000000000000008ULL /* don't honor setuid fs bits */
249 #define MNT_NFS4ACLS 0x0000000000000010ULL /* enable NFS version 4 ACLs */
250 #define MNT_UNION 0x0000000000000020ULL /* union with underlying fs */
251 #define MNT_ASYNC 0x0000000000000040ULL /* fs written asynchronously */
252 #define MNT_SUIDDIR 0x0000000000100000ULL /* special SUID dir handling */
253 #define MNT_SOFTDEP 0x0000000000200000ULL /* using soft updates */
254 #define MNT_NOSYMFOLLOW 0x0000000000400000ULL /* do not follow symlinks */
255 #define MNT_GJOURNAL 0x0000000002000000ULL /* GEOM journal support enabled */
256 #define MNT_MULTILABEL 0x0000000004000000ULL /* MAC support for objects */
257 #define MNT_ACLS 0x0000000008000000ULL /* ACL support enabled */
258 #define MNT_NOATIME 0x0000000010000000ULL /* dont update file access time */
259 #define MNT_NOCLUSTERR 0x0000000040000000ULL /* disable cluster read */
260 #define MNT_NOCLUSTERW 0x0000000080000000ULL /* disable cluster write */
261 #define MNT_SUJ 0x0000000100000000ULL /* using journaled soft updates */
262
263 /*
264 * NFS export related mount flags.
265 */
266 #define MNT_EXRDONLY 0x0000000000000080ULL /* exported read only */
267 #define MNT_EXPORTED 0x0000000000000100ULL /* filesystem is exported */
268 #define MNT_DEFEXPORTED 0x0000000000000200ULL /* exported to the world */
269 #define MNT_EXPORTANON 0x0000000000000400ULL /* anon uid mapping for all */
270 #define MNT_EXKERB 0x0000000000000800ULL /* exported with Kerberos */
271 #define MNT_EXPUBLIC 0x0000000020000000ULL /* public export (WebNFS) */
272
273 /*
274 * Flags set by internal operations,
275 * but visible to the user.
276 * XXX some of these are not quite right.. (I've never seen the root flag set)
277 */
278 #define MNT_LOCAL 0x0000000000001000ULL /* filesystem is stored locally */
279 #define MNT_QUOTA 0x0000000000002000ULL /* quotas are enabled on fs */
280 #define MNT_ROOTFS 0x0000000000004000ULL /* identifies the root fs */
281 #define MNT_USER 0x0000000000008000ULL /* mounted by a user */
282 #define MNT_IGNORE 0x0000000000800000ULL /* do not show entry in df */
283
284 /*
285 * Mask of flags that are visible to statfs().
286 * XXX I think that this could now become (~(MNT_CMDFLAGS))
287 * but the 'mount' program may need changing to handle this.
288 */
289 #define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
290 MNT_NOSUID | MNT_UNION | MNT_SUJ | \
291 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
292 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
293 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
294 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
295 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
296 MNT_IGNORE | MNT_EXPUBLIC | MNT_NOSYMFOLLOW | \
297 MNT_GJOURNAL | MNT_MULTILABEL | MNT_ACLS | \
298 MNT_NFS4ACLS)
299
300 /* Mask of flags that can be updated. */
301 #define MNT_UPDATEMASK (MNT_NOSUID | MNT_NOEXEC | \
302 MNT_SYNCHRONOUS | MNT_UNION | MNT_ASYNC | \
303 MNT_NOATIME | \
304 MNT_NOSYMFOLLOW | MNT_IGNORE | \
305 MNT_NOCLUSTERR | MNT_NOCLUSTERW | MNT_SUIDDIR | \
306 MNT_ACLS | MNT_USER | MNT_NFS4ACLS)
307
308 /*
309 * External filesystem command modifier flags.
310 * Unmount can use the MNT_FORCE flag.
311 * XXX: These are not STATES and really should be somewhere else.
312 * XXX: MNT_BYFSID collides with MNT_ACLS, but because MNT_ACLS is only used for
313 * mount(2) and MNT_BYFSID is only used for unmount(2) it's harmless.
314 */
315 #define MNT_UPDATE 0x0000000000010000ULL /* not real mount, just update */
316 #define MNT_DELEXPORT 0x0000000000020000ULL /* delete export host lists */
317 #define MNT_RELOAD 0x0000000000040000ULL /* reload filesystem data */
318 #define MNT_FORCE 0x0000000000080000ULL /* force unmount or readonly */
319 #define MNT_SNAPSHOT 0x0000000001000000ULL /* snapshot the filesystem */
320 #define MNT_BYFSID 0x0000000008000000ULL /* specify filesystem by ID. */
321 #define MNT_CMDFLAGS (MNT_UPDATE | MNT_DELEXPORT | MNT_RELOAD | \
322 MNT_FORCE | MNT_SNAPSHOT | MNT_BYFSID)
323 /*
324 * Internal filesystem control flags stored in mnt_kern_flag.
325 *
326 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
327 * past the mount point. This keeps the subtree stable during mounts
328 * and unmounts.
329 *
330 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
331 * dounmount() is still waiting to lock the mountpoint. This allows
332 * the filesystem to cancel operations that might otherwise deadlock
333 * with the unmount attempt (used by NFS).
334 *
335 * MNTK_NOINSMNTQ is strict subset of MNTK_UNMOUNT. They are separated
336 * to allow for failed unmount attempt to restore the syncer vnode for
337 * the mount.
338 */
339 #define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */
340 #define MNTK_ASYNC 0x00000002 /* filtered async flag */
341 #define MNTK_SOFTDEP 0x00000004 /* async disabled by softdep */
342 #define MNTK_NOINSMNTQ 0x00000008 /* insmntque is not allowed */
343 #define MNTK_DRAINING 0x00000010 /* lock draining is happening */
344 #define MNTK_REFEXPIRE 0x00000020 /* refcount expiring is happening */
345 #define MNTK_EXTENDED_SHARED 0x00000040 /* Allow shared locking for more ops */
346 #define MNTK_SHARED_WRITES 0x00000080 /* Allow shared locking for writes */
347 #define MNTK_NO_IOPF 0x00000100 /* Disallow page faults during reads
348 and writes. Filesystem shall properly
349 handle i/o state on EFAULT. */
350 #define MNTK_VGONE_UPPER 0x00000200
351 #define MNTK_VGONE_WAITER 0x00000400
352 #define MNTK_LOOKUP_EXCL_DOTDOT 0x00000800
353 #define MNTK_MARKER 0x00001000
354 #define MNTK_UNMAPPED_BUFS 0x00002000
355 #define MNTK_NOASYNC 0x00800000 /* disable async */
356 #define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
357 #define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
358 #define MNTK_SUSPEND 0x08000000 /* request write suspension */
359 #define MNTK_SUSPEND2 0x04000000 /* block secondary writes */
360 #define MNTK_SUSPENDED 0x10000000 /* write operations are suspended */
361 #define MNTK_UNUSED25 0x20000000 /* --available-- */
362 #define MNTK_LOOKUP_SHARED 0x40000000 /* FS supports shared lock lookups */
363 #define MNTK_NOKNOTE 0x80000000 /* Don't send KNOTEs from VOP hooks */
364
365 #define MNT_SHARED_WRITES(mp) (((mp) != NULL) && \
366 ((mp)->mnt_kern_flag & MNTK_SHARED_WRITES))
367
368 /*
369 * Sysctl CTL_VFS definitions.
370 *
371 * Second level identifier specifies which filesystem. Second level
372 * identifier VFS_VFSCONF returns information about all filesystems.
373 * Second level identifier VFS_GENERIC is non-terminal.
374 */
375 #define VFS_VFSCONF 0 /* get configured filesystems */
376 #define VFS_GENERIC 0 /* generic filesystem information */
377 /*
378 * Third level identifiers for VFS_GENERIC are given below; third
379 * level identifiers for specific filesystems are given in their
380 * mount specific header files.
381 */
382 #define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
383 #define VFS_CONF 2 /* struct: vfsconf for filesystem given
384 as next argument */
385
386 /*
387 * Flags for various system call interfaces.
388 *
389 * waitfor flags to vfs_sync() and getfsstat()
390 */
391 #define MNT_WAIT 1 /* synchronously wait for I/O to complete */
392 #define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
393 #define MNT_LAZY 3 /* push data not written by filesystem syncer */
394 #define MNT_SUSPEND 4 /* Suspend file system after sync */
395
396 /*
397 * Generic file handle
398 */
399 struct fhandle {
400 fsid_t fh_fsid; /* Filesystem id of mount point */
401 struct fid fh_fid; /* Filesys specific id */
402 };
403 typedef struct fhandle fhandle_t;
404
405 /*
406 * Old export arguments without security flavor list
407 */
408 struct oexport_args {
409 int ex_flags; /* export related flags */
410 uid_t ex_root; /* mapping for root uid */
411 struct xucred ex_anon; /* mapping for anonymous user */
412 struct sockaddr *ex_addr; /* net address to which exported */
413 u_char ex_addrlen; /* and the net address length */
414 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
415 u_char ex_masklen; /* and the smask length */
416 char *ex_indexfile; /* index file for WebNFS URLs */
417 };
418
419 /*
420 * Export arguments for local filesystem mount calls.
421 */
422 #define MAXSECFLAVORS 5
423 struct export_args {
424 int ex_flags; /* export related flags */
425 uid_t ex_root; /* mapping for root uid */
426 struct xucred ex_anon; /* mapping for anonymous user */
427 struct sockaddr *ex_addr; /* net address to which exported */
428 u_char ex_addrlen; /* and the net address length */
429 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
430 u_char ex_masklen; /* and the smask length */
431 char *ex_indexfile; /* index file for WebNFS URLs */
432 int ex_numsecflavors; /* security flavor count */
433 int ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
434 };
435
436 /*
437 * Structure holding information for a publicly exported filesystem
438 * (WebNFS). Currently the specs allow just for one such filesystem.
439 */
440 struct nfs_public {
441 int np_valid; /* Do we hold valid information */
442 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
443 struct mount *np_mount; /* Mountpoint of exported fs */
444 char *np_index; /* Index file */
445 };
446
447 /*
448 * Filesystem configuration information. One of these exists for each
449 * type of filesystem supported by the kernel. These are searched at
450 * mount time to identify the requested filesystem.
451 *
452 * XXX: Never change the first two arguments!
453 */
454 struct vfsconf {
455 u_int vfc_version; /* ABI version number */
456 char vfc_name[MFSNAMELEN]; /* filesystem type name */
457 struct vfsops *vfc_vfsops; /* filesystem operations vector */
458 int vfc_typenum; /* historic filesystem type number */
459 int vfc_refcount; /* number mounted of this type */
460 int vfc_flags; /* permanent flags */
461 struct vfsoptdecl *vfc_opts; /* mount options */
462 TAILQ_ENTRY(vfsconf) vfc_list; /* list of vfscons */
463 };
464
465 /* Userland version of the struct vfsconf. */
466 struct xvfsconf {
467 struct vfsops *vfc_vfsops; /* filesystem operations vector */
468 char vfc_name[MFSNAMELEN]; /* filesystem type name */
469 int vfc_typenum; /* historic filesystem type number */
470 int vfc_refcount; /* number mounted of this type */
471 int vfc_flags; /* permanent flags */
472 struct vfsconf *vfc_next; /* next in list */
473 };
474
475 #ifndef BURN_BRIDGES
476 struct ovfsconf {
477 void *vfc_vfsops;
478 char vfc_name[32];
479 int vfc_index;
480 int vfc_refcount;
481 int vfc_flags;
482 };
483 #endif
484
485 /*
486 * NB: these flags refer to IMPLEMENTATION properties, not properties of
487 * any actual mounts; i.e., it does not make sense to change the flags.
488 */
489 #define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
490 #define VFCF_NETWORK 0x00020000 /* may get data over the network */
491 #define VFCF_READONLY 0x00040000 /* writes are not implemented */
492 #define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
493 #define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
494 #define VFCF_UNICODE 0x00200000 /* stores file names as Unicode */
495 #define VFCF_JAIL 0x00400000 /* can be mounted from within a jail */
496 #define VFCF_DELEGADMIN 0x00800000 /* supports delegated administration */
497 #define VFCF_SBDRY 0x01000000 /* defer stop requests */
498
499 typedef uint32_t fsctlop_t;
500
501 struct vfsidctl {
502 int vc_vers; /* should be VFSIDCTL_VERS1 (below) */
503 fsid_t vc_fsid; /* fsid to operate on */
504 char vc_fstypename[MFSNAMELEN];
505 /* type of fs 'nfs' or '*' */
506 fsctlop_t vc_op; /* operation VFS_CTL_* (below) */
507 void *vc_ptr; /* pointer to data structure */
508 size_t vc_len; /* sizeof said structure */
509 u_int32_t vc_spare[12]; /* spare (must be zero) */
510 };
511
512 /* vfsidctl API version. */
513 #define VFS_CTL_VERS1 0x01
514
515 /*
516 * New style VFS sysctls, do not reuse/conflict with the namespace for
517 * private sysctls.
518 * All "global" sysctl ops have the 33rd bit set:
519 * 0x...1....
520 * Private sysctl ops should have the 33rd bit unset.
521 */
522 #define VFS_CTL_QUERY 0x00010001 /* anything wrong? (vfsquery) */
523 #define VFS_CTL_TIMEO 0x00010002 /* set timeout for vfs notification */
524 #define VFS_CTL_NOLOCKS 0x00010003 /* disable file locking */
525
526 struct vfsquery {
527 u_int32_t vq_flags;
528 u_int32_t vq_spare[31];
529 };
530
531 /* vfsquery flags */
532 #define VQ_NOTRESP 0x0001 /* server down */
533 #define VQ_NEEDAUTH 0x0002 /* server bad auth */
534 #define VQ_LOWDISK 0x0004 /* we're low on space */
535 #define VQ_MOUNT 0x0008 /* new filesystem arrived */
536 #define VQ_UNMOUNT 0x0010 /* filesystem has left */
537 #define VQ_DEAD 0x0020 /* filesystem is dead, needs force unmount */
538 #define VQ_ASSIST 0x0040 /* filesystem needs assistance from external
539 program */
540 #define VQ_NOTRESPLOCK 0x0080 /* server lockd down */
541 #define VQ_FLAG0100 0x0100 /* placeholder */
542 #define VQ_FLAG0200 0x0200 /* placeholder */
543 #define VQ_FLAG0400 0x0400 /* placeholder */
544 #define VQ_FLAG0800 0x0800 /* placeholder */
545 #define VQ_FLAG1000 0x1000 /* placeholder */
546 #define VQ_FLAG2000 0x2000 /* placeholder */
547 #define VQ_FLAG4000 0x4000 /* placeholder */
548 #define VQ_FLAG8000 0x8000 /* placeholder */
549
550 #ifdef _KERNEL
551 /* Point a sysctl request at a vfsidctl's data. */
552 #define VCTLTOREQ(vc, req) \
553 do { \
554 (req)->newptr = (vc)->vc_ptr; \
555 (req)->newlen = (vc)->vc_len; \
556 (req)->newidx = 0; \
557 } while (0)
558 #endif
559
560 struct iovec;
561 struct uio;
562
563 #ifdef _KERNEL
564
565 /*
566 * vfs_busy specific flags and mask.
567 */
568 #define MBF_NOWAIT 0x01
569 #define MBF_MNTLSTLOCK 0x02
570 #define MBF_MASK (MBF_NOWAIT | MBF_MNTLSTLOCK)
571
572 #ifdef MALLOC_DECLARE
573 MALLOC_DECLARE(M_MOUNT);
574 #endif
575 extern int maxvfsconf; /* highest defined filesystem type */
576 extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
577
578 TAILQ_HEAD(vfsconfhead, vfsconf);
579 extern struct vfsconfhead vfsconf;
580
581 /*
582 * Operations supported on mounted filesystem.
583 */
584 struct mount_args;
585 struct nameidata;
586 struct sysctl_req;
587 struct mntarg;
588
589 typedef int vfs_cmount_t(struct mntarg *ma, void *data, uint64_t flags);
590 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
591 typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp);
592 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, void *arg);
593 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp);
594 typedef int vfs_sync_t(struct mount *mp, int waitfor);
595 typedef int vfs_vget_t(struct mount *mp, ino_t ino, int flags,
596 struct vnode **vpp);
597 typedef int vfs_fhtovp_t(struct mount *mp, struct fid *fhp,
598 int flags, struct vnode **vpp);
599 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
600 int *extflagsp, struct ucred **credanonp,
601 int *numsecflavors, int **secflavors);
602 typedef int vfs_init_t(struct vfsconf *);
603 typedef int vfs_uninit_t(struct vfsconf *);
604 typedef int vfs_extattrctl_t(struct mount *mp, int cmd,
605 struct vnode *filename_vp, int attrnamespace,
606 const char *attrname);
607 typedef int vfs_mount_t(struct mount *mp);
608 typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op,
609 struct sysctl_req *req);
610 typedef void vfs_susp_clean_t(struct mount *mp);
611 typedef void vfs_notify_lowervp_t(struct mount *mp, struct vnode *lowervp);
612 typedef void vfs_purge_t(struct mount *mp);
613
614 struct vfsops {
615 vfs_mount_t *vfs_mount;
616 vfs_cmount_t *vfs_cmount;
617 vfs_unmount_t *vfs_unmount;
618 vfs_root_t *vfs_root;
619 vfs_quotactl_t *vfs_quotactl;
620 vfs_statfs_t *vfs_statfs;
621 vfs_sync_t *vfs_sync;
622 vfs_vget_t *vfs_vget;
623 vfs_fhtovp_t *vfs_fhtovp;
624 vfs_checkexp_t *vfs_checkexp;
625 vfs_init_t *vfs_init;
626 vfs_uninit_t *vfs_uninit;
627 vfs_extattrctl_t *vfs_extattrctl;
628 vfs_sysctl_t *vfs_sysctl;
629 vfs_susp_clean_t *vfs_susp_clean;
630 vfs_notify_lowervp_t *vfs_reclaim_lowervp;
631 vfs_notify_lowervp_t *vfs_unlink_lowervp;
632 vfs_purge_t *vfs_purge;
633 vfs_mount_t *vfs_spare[6]; /* spares for ABI compat */
634 };
635
636 vfs_statfs_t __vfs_statfs;
637
638 #define VFS_PROLOGUE(MP) do { \
639 int _enable_stops; \
640 \
641 _enable_stops = ((MP) != NULL && \
642 ((MP)->mnt_vfc->vfc_flags & VFCF_SBDRY) && sigdeferstop())
643
644 #define VFS_EPILOGUE(MP) \
645 if (_enable_stops) \
646 sigallowstop(); \
647 } while (0)
648
649 #define VFS_MOUNT(MP) ({ \
650 int _rc; \
651 \
652 VFS_PROLOGUE(MP); \
653 _rc = (*(MP)->mnt_op->vfs_mount)(MP); \
654 VFS_EPILOGUE(MP); \
655 _rc; })
656
657 #define VFS_UNMOUNT(MP, FORCE) ({ \
658 int _rc; \
659 \
660 VFS_PROLOGUE(MP); \
661 _rc = (*(MP)->mnt_op->vfs_unmount)(MP, FORCE); \
662 VFS_EPILOGUE(MP); \
663 _rc; })
664
665 #define VFS_ROOT(MP, FLAGS, VPP) ({ \
666 int _rc; \
667 \
668 VFS_PROLOGUE(MP); \
669 _rc = (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP); \
670 VFS_EPILOGUE(MP); \
671 _rc; })
672
673 #define VFS_QUOTACTL(MP, C, U, A) ({ \
674 int _rc; \
675 \
676 VFS_PROLOGUE(MP); \
677 _rc = (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A); \
678 VFS_EPILOGUE(MP); \
679 _rc; })
680
681 #define VFS_STATFS(MP, SBP) ({ \
682 int _rc; \
683 \
684 VFS_PROLOGUE(MP); \
685 _rc = __vfs_statfs((MP), (SBP)); \
686 VFS_EPILOGUE(MP); \
687 _rc; })
688
689 #define VFS_SYNC(MP, WAIT) ({ \
690 int _rc; \
691 \
692 VFS_PROLOGUE(MP); \
693 _rc = (*(MP)->mnt_op->vfs_sync)(MP, WAIT); \
694 VFS_EPILOGUE(MP); \
695 _rc; })
696
697 #define VFS_VGET(MP, INO, FLAGS, VPP) ({ \
698 int _rc; \
699 \
700 VFS_PROLOGUE(MP); \
701 _rc = (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP); \
702 VFS_EPILOGUE(MP); \
703 _rc; })
704
705 #define VFS_FHTOVP(MP, FIDP, FLAGS, VPP) ({ \
706 int _rc; \
707 \
708 VFS_PROLOGUE(MP); \
709 _rc = (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, FLAGS, VPP); \
710 VFS_EPILOGUE(MP); \
711 _rc; })
712
713 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) ({ \
714 int _rc; \
715 \
716 VFS_PROLOGUE(MP); \
717 _rc = (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC,\
718 SEC); \
719 VFS_EPILOGUE(MP); \
720 _rc; })
721
722 #define VFS_EXTATTRCTL(MP, C, FN, NS, N) ({ \
723 int _rc; \
724 \
725 VFS_PROLOGUE(MP); \
726 _rc = (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N); \
727 VFS_EPILOGUE(MP); \
728 _rc; })
729
730 #define VFS_SYSCTL(MP, OP, REQ) ({ \
731 int _rc; \
732 \
733 VFS_PROLOGUE(MP); \
734 _rc = (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ); \
735 VFS_EPILOGUE(MP); \
736 _rc; })
737
738 #define VFS_SUSP_CLEAN(MP) do { \
739 if (*(MP)->mnt_op->vfs_susp_clean != NULL) { \
740 VFS_PROLOGUE(MP); \
741 (*(MP)->mnt_op->vfs_susp_clean)(MP); \
742 VFS_EPILOGUE(MP); \
743 } \
744 } while (0)
745
746 #define VFS_RECLAIM_LOWERVP(MP, VP) do { \
747 if (*(MP)->mnt_op->vfs_reclaim_lowervp != NULL) { \
748 VFS_PROLOGUE(MP); \
749 (*(MP)->mnt_op->vfs_reclaim_lowervp)((MP), (VP)); \
750 VFS_EPILOGUE(MP); \
751 } \
752 } while (0)
753
754 #define VFS_UNLINK_LOWERVP(MP, VP) do { \
755 if (*(MP)->mnt_op->vfs_unlink_lowervp != NULL) { \
756 VFS_PROLOGUE(MP); \
757 (*(MP)->mnt_op->vfs_unlink_lowervp)((MP), (VP)); \
758 VFS_EPILOGUE(MP); \
759 } \
760 } while (0)
761
762 #define VFS_PURGE(MP) do { \
763 if (*(MP)->mnt_op->vfs_purge != NULL) { \
764 VFS_PROLOGUE(MP); \
765 (*(MP)->mnt_op->vfs_purge)(MP); \
766 VFS_EPILOGUE(MP); \
767 } \
768 } while (0)
769
770 #define VFS_KNOTE_LOCKED(vp, hint) do \
771 { \
772 if (((vp)->v_vflag & VV_NOKNOTE) == 0) \
773 VN_KNOTE((vp), (hint), KNF_LISTLOCKED); \
774 } while (0)
775
776 #define VFS_KNOTE_UNLOCKED(vp, hint) do \
777 { \
778 if (((vp)->v_vflag & VV_NOKNOTE) == 0) \
779 VN_KNOTE((vp), (hint), 0); \
780 } while (0)
781
782 #define VFS_NOTIFY_UPPER_RECLAIM 1
783 #define VFS_NOTIFY_UPPER_UNLINK 2
784
785 #include <sys/module.h>
786
787 /*
788 * Version numbers.
789 */
790 #define VFS_VERSION_00 0x19660120
791 #define VFS_VERSION_01 0x20121030
792 #define VFS_VERSION VFS_VERSION_01
793
794 #define VFS_SET(vfsops, fsname, flags) \
795 static struct vfsconf fsname ## _vfsconf = { \
796 .vfc_version = VFS_VERSION, \
797 .vfc_name = #fsname, \
798 .vfc_vfsops = &vfsops, \
799 .vfc_typenum = -1, \
800 .vfc_flags = flags, \
801 }; \
802 static moduledata_t fsname ## _mod = { \
803 #fsname, \
804 vfs_modevent, \
805 & fsname ## _vfsconf \
806 }; \
807 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
808
809 extern char *mountrootfsname;
810
811 /*
812 * exported vnode operations
813 */
814
815 int dounmount(struct mount *, int, struct thread *);
816
817 int kernel_mount(struct mntarg *ma, uint64_t flags);
818 int kernel_vmount(int flags, ...);
819 struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len);
820 struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name);
821 struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...);
822 struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len);
823 void statfs_scale_blocks(struct statfs *sf, long max_size);
824 struct vfsconf *vfs_byname(const char *);
825 struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *);
826 void vfs_mount_destroy(struct mount *);
827 void vfs_event_signal(fsid_t *, u_int32_t, intptr_t);
828 void vfs_freeopts(struct vfsoptlist *opts);
829 void vfs_deleteopt(struct vfsoptlist *opts, const char *name);
830 int vfs_buildopts(struct uio *auio, struct vfsoptlist **options);
831 int vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w,
832 uint64_t val);
833 int vfs_getopt(struct vfsoptlist *, const char *, void **, int *);
834 int vfs_getopt_pos(struct vfsoptlist *opts, const char *name);
835 int vfs_getopt_size(struct vfsoptlist *opts, const char *name,
836 off_t *value);
837 char *vfs_getopts(struct vfsoptlist *, const char *, int *error);
838 int vfs_copyopt(struct vfsoptlist *, const char *, void *, int);
839 int vfs_filteropt(struct vfsoptlist *, const char **legal);
840 void vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...);
841 int vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...);
842 int vfs_setopt(struct vfsoptlist *opts, const char *name, void *value,
843 int len);
844 int vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value,
845 int len);
846 int vfs_setopts(struct vfsoptlist *opts, const char *name,
847 const char *value);
848 int vfs_setpublicfs /* set publicly exported fs */
849 (struct mount *, struct netexport *, struct export_args *);
850 void vfs_msync(struct mount *, int);
851 int vfs_busy(struct mount *, int);
852 int vfs_export /* process mount export info */
853 (struct mount *, struct export_args *);
854 void vfs_allocate_syncvnode(struct mount *);
855 void vfs_deallocate_syncvnode(struct mount *);
856 int vfs_donmount(struct thread *td, uint64_t fsflags,
857 struct uio *fsoptions);
858 void vfs_getnewfsid(struct mount *);
859 struct cdev *vfs_getrootfsid(struct mount *);
860 struct mount *vfs_getvfs(fsid_t *); /* return vfs given fsid */
861 struct mount *vfs_busyfs(fsid_t *);
862 int vfs_modevent(module_t, int, void *);
863 void vfs_mount_error(struct mount *, const char *, ...);
864 void vfs_mountroot(void); /* mount our root filesystem */
865 void vfs_mountedfrom(struct mount *, const char *from);
866 void vfs_notify_upper(struct vnode *, int);
867 void vfs_oexport_conv(const struct oexport_args *oexp,
868 struct export_args *exp);
869 void vfs_ref(struct mount *);
870 void vfs_rel(struct mount *);
871 struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *,
872 struct ucred *);
873 int vfs_suser(struct mount *, struct thread *);
874 void vfs_unbusy(struct mount *);
875 void vfs_unmountall(void);
876 extern TAILQ_HEAD(mntlist, mount) mountlist; /* mounted filesystem list */
877 extern struct mtx mountlist_mtx;
878 extern struct nfs_public nfs_pub;
879
880 /*
881 * Declarations for these vfs default operations are located in
882 * kern/vfs_default.c. They will be automatically used to replace
883 * null entries in VFS ops tables when registering a new filesystem
884 * type in the global table.
885 */
886 vfs_root_t vfs_stdroot;
887 vfs_quotactl_t vfs_stdquotactl;
888 vfs_statfs_t vfs_stdstatfs;
889 vfs_sync_t vfs_stdsync;
890 vfs_sync_t vfs_stdnosync;
891 vfs_vget_t vfs_stdvget;
892 vfs_fhtovp_t vfs_stdfhtovp;
893 vfs_checkexp_t vfs_stdcheckexp;
894 vfs_init_t vfs_stdinit;
895 vfs_uninit_t vfs_stduninit;
896 vfs_extattrctl_t vfs_stdextattrctl;
897 vfs_sysctl_t vfs_stdsysctl;
898
899 #else /* !_KERNEL */
900
901 #include <sys/cdefs.h>
902
903 struct stat;
904
905 __BEGIN_DECLS
906 int fhopen(const struct fhandle *, int);
907 int fhstat(const struct fhandle *, struct stat *);
908 int fhstatfs(const struct fhandle *, struct statfs *);
909 int fstatfs(int, struct statfs *);
910 int getfh(const char *, fhandle_t *);
911 int getfsstat(struct statfs *, long, int);
912 int getmntinfo(struct statfs **, int);
913 int lgetfh(const char *, fhandle_t *);
914 int mount(const char *, const char *, int, void *);
915 int nmount(struct iovec *, unsigned int, int);
916 int statfs(const char *, struct statfs *);
917 int unmount(const char *, int);
918
919 /* C library stuff */
920 int getvfsbyname(const char *, struct xvfsconf *);
921 __END_DECLS
922
923 #endif /* _KERNEL */
924
925 #endif /* !_SYS_MOUNT_H_ */
Cache object: 1b107ae7f6a1dfaf03fcbc68f6da4b09
|