]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - sys/sys/mount.h
MFC r257904:
[FreeBSD/stable/10.git] / 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$
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 #ifdef _KERNEL
366 static inline int
367 MNT_SHARED_WRITES(struct mount *mp)
368 {
369
370         return (mp != NULL && (mp->mnt_kern_flag & MNTK_SHARED_WRITES) != 0);
371 }
372
373 static inline int
374 MNT_EXTENDED_SHARED(struct mount *mp)
375 {
376
377         return (mp != NULL && (mp->mnt_kern_flag & MNTK_EXTENDED_SHARED) != 0);
378 }
379 #endif
380
381 /*
382  * Sysctl CTL_VFS definitions.
383  *
384  * Second level identifier specifies which filesystem. Second level
385  * identifier VFS_VFSCONF returns information about all filesystems.
386  * Second level identifier VFS_GENERIC is non-terminal.
387  */
388 #define VFS_VFSCONF             0       /* get configured filesystems */
389 #define VFS_GENERIC             0       /* generic filesystem information */
390 /*
391  * Third level identifiers for VFS_GENERIC are given below; third
392  * level identifiers for specific filesystems are given in their
393  * mount specific header files.
394  */
395 #define VFS_MAXTYPENUM  1       /* int: highest defined filesystem type */
396 #define VFS_CONF        2       /* struct: vfsconf for filesystem given
397                                    as next argument */
398
399 /*
400  * Flags for various system call interfaces.
401  *
402  * waitfor flags to vfs_sync() and getfsstat()
403  */
404 #define MNT_WAIT        1       /* synchronously wait for I/O to complete */
405 #define MNT_NOWAIT      2       /* start all I/O, but do not wait for it */
406 #define MNT_LAZY        3       /* push data not written by filesystem syncer */
407 #define MNT_SUSPEND     4       /* Suspend file system after sync */
408
409 /*
410  * Generic file handle
411  */
412 struct fhandle {
413         fsid_t  fh_fsid;        /* Filesystem id of mount point */
414         struct  fid fh_fid;     /* Filesys specific id */
415 };
416 typedef struct fhandle  fhandle_t;
417
418 /*
419  * Old export arguments without security flavor list
420  */
421 struct oexport_args {
422         int     ex_flags;               /* export related flags */
423         uid_t   ex_root;                /* mapping for root uid */
424         struct  xucred ex_anon;         /* mapping for anonymous user */
425         struct  sockaddr *ex_addr;      /* net address to which exported */
426         u_char  ex_addrlen;             /* and the net address length */
427         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
428         u_char  ex_masklen;             /* and the smask length */
429         char    *ex_indexfile;          /* index file for WebNFS URLs */
430 };
431
432 /*
433  * Export arguments for local filesystem mount calls.
434  */
435 #define MAXSECFLAVORS   5
436 struct export_args {
437         int     ex_flags;               /* export related flags */
438         uid_t   ex_root;                /* mapping for root uid */
439         struct  xucred ex_anon;         /* mapping for anonymous user */
440         struct  sockaddr *ex_addr;      /* net address to which exported */
441         u_char  ex_addrlen;             /* and the net address length */
442         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
443         u_char  ex_masklen;             /* and the smask length */
444         char    *ex_indexfile;          /* index file for WebNFS URLs */
445         int     ex_numsecflavors;       /* security flavor count */
446         int     ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
447 };
448
449 /*
450  * Structure holding information for a publicly exported filesystem
451  * (WebNFS). Currently the specs allow just for one such filesystem.
452  */
453 struct nfs_public {
454         int             np_valid;       /* Do we hold valid information */
455         fhandle_t       np_handle;      /* Filehandle for pub fs (internal) */
456         struct mount    *np_mount;      /* Mountpoint of exported fs */
457         char            *np_index;      /* Index file */
458 };
459
460 /*
461  * Filesystem configuration information. One of these exists for each
462  * type of filesystem supported by the kernel. These are searched at
463  * mount time to identify the requested filesystem.
464  *
465  * XXX: Never change the first two arguments!
466  */
467 struct vfsconf {
468         u_int   vfc_version;            /* ABI version number */
469         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
470         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
471         int     vfc_typenum;            /* historic filesystem type number */
472         int     vfc_refcount;           /* number mounted of this type */
473         int     vfc_flags;              /* permanent flags */
474         struct  vfsoptdecl *vfc_opts;   /* mount options */
475         TAILQ_ENTRY(vfsconf) vfc_list;  /* list of vfscons */
476 };
477
478 /* Userland version of the struct vfsconf. */
479 struct xvfsconf {
480         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
481         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
482         int     vfc_typenum;            /* historic filesystem type number */
483         int     vfc_refcount;           /* number mounted of this type */
484         int     vfc_flags;              /* permanent flags */
485         struct  vfsconf *vfc_next;      /* next in list */
486 };
487
488 #ifndef BURN_BRIDGES
489 struct ovfsconf {
490         void    *vfc_vfsops;
491         char    vfc_name[32];
492         int     vfc_index;
493         int     vfc_refcount;
494         int     vfc_flags;
495 };
496 #endif
497
498 /*
499  * NB: these flags refer to IMPLEMENTATION properties, not properties of
500  * any actual mounts; i.e., it does not make sense to change the flags.
501  */
502 #define VFCF_STATIC     0x00010000      /* statically compiled into kernel */
503 #define VFCF_NETWORK    0x00020000      /* may get data over the network */
504 #define VFCF_READONLY   0x00040000      /* writes are not implemented */
505 #define VFCF_SYNTHETIC  0x00080000      /* data does not represent real files */
506 #define VFCF_LOOPBACK   0x00100000      /* aliases some other mounted FS */
507 #define VFCF_UNICODE    0x00200000      /* stores file names as Unicode */
508 #define VFCF_JAIL       0x00400000      /* can be mounted from within a jail */
509 #define VFCF_DELEGADMIN 0x00800000      /* supports delegated administration */
510 #define VFCF_SBDRY      0x01000000      /* defer stop requests */
511
512 typedef uint32_t fsctlop_t;
513
514 struct vfsidctl {
515         int             vc_vers;        /* should be VFSIDCTL_VERS1 (below) */
516         fsid_t          vc_fsid;        /* fsid to operate on */
517         char            vc_fstypename[MFSNAMELEN];
518                                         /* type of fs 'nfs' or '*' */
519         fsctlop_t       vc_op;          /* operation VFS_CTL_* (below) */
520         void            *vc_ptr;        /* pointer to data structure */
521         size_t          vc_len;         /* sizeof said structure */
522         u_int32_t       vc_spare[12];   /* spare (must be zero) */
523 };
524
525 /* vfsidctl API version. */
526 #define VFS_CTL_VERS1   0x01
527
528 /*
529  * New style VFS sysctls, do not reuse/conflict with the namespace for
530  * private sysctls.
531  * All "global" sysctl ops have the 33rd bit set:
532  * 0x...1....
533  * Private sysctl ops should have the 33rd bit unset.
534  */
535 #define VFS_CTL_QUERY   0x00010001      /* anything wrong? (vfsquery) */
536 #define VFS_CTL_TIMEO   0x00010002      /* set timeout for vfs notification */
537 #define VFS_CTL_NOLOCKS 0x00010003      /* disable file locking */
538
539 struct vfsquery {
540         u_int32_t       vq_flags;
541         u_int32_t       vq_spare[31];
542 };
543
544 /* vfsquery flags */
545 #define VQ_NOTRESP      0x0001  /* server down */
546 #define VQ_NEEDAUTH     0x0002  /* server bad auth */
547 #define VQ_LOWDISK      0x0004  /* we're low on space */
548 #define VQ_MOUNT        0x0008  /* new filesystem arrived */
549 #define VQ_UNMOUNT      0x0010  /* filesystem has left */
550 #define VQ_DEAD         0x0020  /* filesystem is dead, needs force unmount */
551 #define VQ_ASSIST       0x0040  /* filesystem needs assistance from external
552                                    program */
553 #define VQ_NOTRESPLOCK  0x0080  /* server lockd down */
554 #define VQ_FLAG0100     0x0100  /* placeholder */
555 #define VQ_FLAG0200     0x0200  /* placeholder */
556 #define VQ_FLAG0400     0x0400  /* placeholder */
557 #define VQ_FLAG0800     0x0800  /* placeholder */
558 #define VQ_FLAG1000     0x1000  /* placeholder */
559 #define VQ_FLAG2000     0x2000  /* placeholder */
560 #define VQ_FLAG4000     0x4000  /* placeholder */
561 #define VQ_FLAG8000     0x8000  /* placeholder */
562
563 #ifdef _KERNEL
564 /* Point a sysctl request at a vfsidctl's data. */
565 #define VCTLTOREQ(vc, req)                                              \
566         do {                                                            \
567                 (req)->newptr = (vc)->vc_ptr;                           \
568                 (req)->newlen = (vc)->vc_len;                           \
569                 (req)->newidx = 0;                                      \
570         } while (0)
571 #endif
572
573 struct iovec;
574 struct uio;
575
576 #ifdef _KERNEL
577
578 /*
579  * vfs_busy specific flags and mask.
580  */
581 #define MBF_NOWAIT      0x01
582 #define MBF_MNTLSTLOCK  0x02
583 #define MBF_MASK        (MBF_NOWAIT | MBF_MNTLSTLOCK)
584
585 #ifdef MALLOC_DECLARE
586 MALLOC_DECLARE(M_MOUNT);
587 #endif
588 extern int maxvfsconf;          /* highest defined filesystem type */
589 extern int nfs_mount_type;      /* vfc_typenum for nfs, or -1 */
590
591 TAILQ_HEAD(vfsconfhead, vfsconf);
592 extern struct vfsconfhead vfsconf;
593
594 /*
595  * Operations supported on mounted filesystem.
596  */
597 struct mount_args;
598 struct nameidata;
599 struct sysctl_req;
600 struct mntarg;
601
602 typedef int vfs_cmount_t(struct mntarg *ma, void *data, uint64_t flags);
603 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
604 typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp);
605 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, void *arg);
606 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp);
607 typedef int vfs_sync_t(struct mount *mp, int waitfor);
608 typedef int vfs_vget_t(struct mount *mp, ino_t ino, int flags,
609                     struct vnode **vpp);
610 typedef int vfs_fhtovp_t(struct mount *mp, struct fid *fhp,
611                     int flags, struct vnode **vpp);
612 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
613                     int *extflagsp, struct ucred **credanonp,
614                     int *numsecflavors, int **secflavors);
615 typedef int vfs_init_t(struct vfsconf *);
616 typedef int vfs_uninit_t(struct vfsconf *);
617 typedef int vfs_extattrctl_t(struct mount *mp, int cmd,
618                     struct vnode *filename_vp, int attrnamespace,
619                     const char *attrname);
620 typedef int vfs_mount_t(struct mount *mp);
621 typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op,
622                     struct sysctl_req *req);
623 typedef void vfs_susp_clean_t(struct mount *mp);
624 typedef void vfs_notify_lowervp_t(struct mount *mp, struct vnode *lowervp);
625 typedef void vfs_purge_t(struct mount *mp);
626
627 struct vfsops {
628         vfs_mount_t             *vfs_mount;
629         vfs_cmount_t            *vfs_cmount;
630         vfs_unmount_t           *vfs_unmount;
631         vfs_root_t              *vfs_root;
632         vfs_quotactl_t          *vfs_quotactl;
633         vfs_statfs_t            *vfs_statfs;
634         vfs_sync_t              *vfs_sync;
635         vfs_vget_t              *vfs_vget;
636         vfs_fhtovp_t            *vfs_fhtovp;
637         vfs_checkexp_t          *vfs_checkexp;
638         vfs_init_t              *vfs_init;
639         vfs_uninit_t            *vfs_uninit;
640         vfs_extattrctl_t        *vfs_extattrctl;
641         vfs_sysctl_t            *vfs_sysctl;
642         vfs_susp_clean_t        *vfs_susp_clean;
643         vfs_notify_lowervp_t    *vfs_reclaim_lowervp;
644         vfs_notify_lowervp_t    *vfs_unlink_lowervp;
645         vfs_purge_t             *vfs_purge;
646         vfs_mount_t             *vfs_spare[6];  /* spares for ABI compat */
647 };
648
649 vfs_statfs_t    __vfs_statfs;
650
651 #define VFS_PROLOGUE(MP)        do {                                    \
652         struct mount *mp__;                                             \
653         int _enable_stops;                                              \
654                                                                         \
655         mp__ = (MP);                                                    \
656         _enable_stops = (mp__ != NULL &&                                \
657             (mp__->mnt_vfc->vfc_flags & VFCF_SBDRY) && sigdeferstop())
658
659 #define VFS_EPILOGUE(MP)                                                \
660         if (_enable_stops)                                              \
661                 sigallowstop();                                         \
662 } while (0)
663
664 #define VFS_MOUNT(MP) ({                                                \
665         int _rc;                                                        \
666                                                                         \
667         VFS_PROLOGUE(MP);                                               \
668         _rc = (*(MP)->mnt_op->vfs_mount)(MP);                           \
669         VFS_EPILOGUE(MP);                                               \
670         _rc; })
671
672 #define VFS_UNMOUNT(MP, FORCE) ({                                       \
673         int _rc;                                                        \
674                                                                         \
675         VFS_PROLOGUE(MP);                                               \
676         _rc = (*(MP)->mnt_op->vfs_unmount)(MP, FORCE);                  \
677         VFS_EPILOGUE(MP);                                               \
678         _rc; })
679
680 #define VFS_ROOT(MP, FLAGS, VPP) ({                                     \
681         int _rc;                                                        \
682                                                                         \
683         VFS_PROLOGUE(MP);                                               \
684         _rc = (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP);                \
685         VFS_EPILOGUE(MP);                                               \
686         _rc; })
687
688 #define VFS_QUOTACTL(MP, C, U, A) ({                                    \
689         int _rc;                                                        \
690                                                                         \
691         VFS_PROLOGUE(MP);                                               \
692         _rc = (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A);               \
693         VFS_EPILOGUE(MP);                                               \
694         _rc; })
695
696 #define VFS_STATFS(MP, SBP) ({                                          \
697         int _rc;                                                        \
698                                                                         \
699         VFS_PROLOGUE(MP);                                               \
700         _rc = __vfs_statfs((MP), (SBP));                                \
701         VFS_EPILOGUE(MP);                                               \
702         _rc; })
703
704 #define VFS_SYNC(MP, WAIT) ({                                           \
705         int _rc;                                                        \
706                                                                         \
707         VFS_PROLOGUE(MP);                                               \
708         _rc = (*(MP)->mnt_op->vfs_sync)(MP, WAIT);                      \
709         VFS_EPILOGUE(MP);                                               \
710         _rc; })
711
712 #define VFS_VGET(MP, INO, FLAGS, VPP) ({                                \
713         int _rc;                                                        \
714                                                                         \
715         VFS_PROLOGUE(MP);                                               \
716         _rc = (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP);           \
717         VFS_EPILOGUE(MP);                                               \
718         _rc; })
719
720 #define VFS_FHTOVP(MP, FIDP, FLAGS, VPP) ({                             \
721         int _rc;                                                        \
722                                                                         \
723         VFS_PROLOGUE(MP);                                               \
724         _rc = (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, FLAGS, VPP);        \
725         VFS_EPILOGUE(MP);                                               \
726         _rc; })
727
728 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) ({              \
729         int _rc;                                                        \
730                                                                         \
731         VFS_PROLOGUE(MP);                                               \
732         _rc = (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC,\
733             SEC);                                                       \
734         VFS_EPILOGUE(MP);                                               \
735         _rc; })
736
737 #define VFS_EXTATTRCTL(MP, C, FN, NS, N) ({                             \
738         int _rc;                                                        \
739                                                                         \
740         VFS_PROLOGUE(MP);                                               \
741         _rc = (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N);        \
742         VFS_EPILOGUE(MP);                                               \
743         _rc; })
744
745 #define VFS_SYSCTL(MP, OP, REQ) ({                                      \
746         int _rc;                                                        \
747                                                                         \
748         VFS_PROLOGUE(MP);                                               \
749         _rc = (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ);                 \
750         VFS_EPILOGUE(MP);                                               \
751         _rc; })
752
753 #define VFS_SUSP_CLEAN(MP) do {                                         \
754         if (*(MP)->mnt_op->vfs_susp_clean != NULL) {                    \
755                 VFS_PROLOGUE(MP);                                       \
756                 (*(MP)->mnt_op->vfs_susp_clean)(MP);                    \
757                 VFS_EPILOGUE(MP);                                       \
758         }                                                               \
759 } while (0)
760
761 #define VFS_RECLAIM_LOWERVP(MP, VP) do {                                \
762         if (*(MP)->mnt_op->vfs_reclaim_lowervp != NULL) {               \
763                 VFS_PROLOGUE(MP);                                       \
764                 (*(MP)->mnt_op->vfs_reclaim_lowervp)((MP), (VP));       \
765                 VFS_EPILOGUE(MP);                                       \
766         }                                                               \
767 } while (0)
768
769 #define VFS_UNLINK_LOWERVP(MP, VP) do {                                 \
770         if (*(MP)->mnt_op->vfs_unlink_lowervp != NULL) {                \
771                 VFS_PROLOGUE(MP);                                       \
772                 (*(MP)->mnt_op->vfs_unlink_lowervp)((MP), (VP));        \
773                 VFS_EPILOGUE(MP);                                       \
774         }                                                               \
775 } while (0)
776
777 #define VFS_PURGE(MP) do {                                              \
778         if (*(MP)->mnt_op->vfs_purge != NULL) {                         \
779                 VFS_PROLOGUE(MP);                                       \
780                 (*(MP)->mnt_op->vfs_purge)(MP);                         \
781                 VFS_EPILOGUE(MP);                                       \
782         }                                                               \
783 } while (0)
784
785 #define VFS_KNOTE_LOCKED(vp, hint) do                                   \
786 {                                                                       \
787         if (((vp)->v_vflag & VV_NOKNOTE) == 0)                          \
788                 VN_KNOTE((vp), (hint), KNF_LISTLOCKED);                 \
789 } while (0)
790
791 #define VFS_KNOTE_UNLOCKED(vp, hint) do                                 \
792 {                                                                       \
793         if (((vp)->v_vflag & VV_NOKNOTE) == 0)                          \
794                 VN_KNOTE((vp), (hint), 0);                              \
795 } while (0)
796
797 #define VFS_NOTIFY_UPPER_RECLAIM        1
798 #define VFS_NOTIFY_UPPER_UNLINK         2
799
800 #include <sys/module.h>
801
802 /*
803  * Version numbers.
804  */
805 #define VFS_VERSION_00  0x19660120
806 #define VFS_VERSION_01  0x20121030
807 #define VFS_VERSION     VFS_VERSION_01
808
809 #define VFS_SET(vfsops, fsname, flags) \
810         static struct vfsconf fsname ## _vfsconf = {            \
811                 .vfc_version = VFS_VERSION,                     \
812                 .vfc_name = #fsname,                            \
813                 .vfc_vfsops = &vfsops,                          \
814                 .vfc_typenum = -1,                              \
815                 .vfc_flags = flags,                             \
816         };                                                      \
817         static moduledata_t fsname ## _mod = {                  \
818                 #fsname,                                        \
819                 vfs_modevent,                                   \
820                 & fsname ## _vfsconf                            \
821         };                                                      \
822         DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
823
824 extern  char *mountrootfsname;
825
826 /*
827  * exported vnode operations
828  */
829
830 int     dounmount(struct mount *, int, struct thread *);
831
832 int     kernel_mount(struct mntarg *ma, uint64_t flags);
833 int     kernel_vmount(int flags, ...);
834 struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len);
835 struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name);
836 struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...);
837 struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len);
838 void    statfs_scale_blocks(struct statfs *sf, long max_size);
839 struct vfsconf *vfs_byname(const char *);
840 struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *);
841 void    vfs_mount_destroy(struct mount *);
842 void    vfs_event_signal(fsid_t *, u_int32_t, intptr_t);
843 void    vfs_freeopts(struct vfsoptlist *opts);
844 void    vfs_deleteopt(struct vfsoptlist *opts, const char *name);
845 int     vfs_buildopts(struct uio *auio, struct vfsoptlist **options);
846 int     vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w,
847             uint64_t val);
848 int     vfs_getopt(struct vfsoptlist *, const char *, void **, int *);
849 int     vfs_getopt_pos(struct vfsoptlist *opts, const char *name);
850 int     vfs_getopt_size(struct vfsoptlist *opts, const char *name,
851             off_t *value);
852 char    *vfs_getopts(struct vfsoptlist *, const char *, int *error);
853 int     vfs_copyopt(struct vfsoptlist *, const char *, void *, int);
854 int     vfs_filteropt(struct vfsoptlist *, const char **legal);
855 void    vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...);
856 int     vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...);
857 int     vfs_setopt(struct vfsoptlist *opts, const char *name, void *value,
858             int len);
859 int     vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value,
860             int len);
861 int     vfs_setopts(struct vfsoptlist *opts, const char *name,
862             const char *value);
863 int     vfs_setpublicfs                     /* set publicly exported fs */
864             (struct mount *, struct netexport *, struct export_args *);
865 void    vfs_msync(struct mount *, int);
866 int     vfs_busy(struct mount *, int);
867 int     vfs_export                       /* process mount export info */
868             (struct mount *, struct export_args *);
869 void    vfs_allocate_syncvnode(struct mount *);
870 void    vfs_deallocate_syncvnode(struct mount *);
871 int     vfs_donmount(struct thread *td, uint64_t fsflags,
872             struct uio *fsoptions);
873 void    vfs_getnewfsid(struct mount *);
874 struct cdev *vfs_getrootfsid(struct mount *);
875 struct  mount *vfs_getvfs(fsid_t *);      /* return vfs given fsid */
876 struct  mount *vfs_busyfs(fsid_t *);
877 int     vfs_modevent(module_t, int, void *);
878 void    vfs_mount_error(struct mount *, const char *, ...);
879 void    vfs_mountroot(void);                    /* mount our root filesystem */
880 void    vfs_mountedfrom(struct mount *, const char *from);
881 void    vfs_notify_upper(struct vnode *, int);
882 void    vfs_oexport_conv(const struct oexport_args *oexp,
883             struct export_args *exp);
884 void    vfs_ref(struct mount *);
885 void    vfs_rel(struct mount *);
886 struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *,
887             struct ucred *);
888 int     vfs_suser(struct mount *, struct thread *);
889 void    vfs_unbusy(struct mount *);
890 void    vfs_unmountall(void);
891 extern  TAILQ_HEAD(mntlist, mount) mountlist;   /* mounted filesystem list */
892 extern  struct mtx mountlist_mtx;
893 extern  struct nfs_public nfs_pub;
894
895 /*
896  * Declarations for these vfs default operations are located in
897  * kern/vfs_default.c.  They will be automatically used to replace
898  * null entries in VFS ops tables when registering a new filesystem
899  * type in the global table.
900  */
901 vfs_root_t              vfs_stdroot;
902 vfs_quotactl_t          vfs_stdquotactl;
903 vfs_statfs_t            vfs_stdstatfs;
904 vfs_sync_t              vfs_stdsync;
905 vfs_sync_t              vfs_stdnosync;
906 vfs_vget_t              vfs_stdvget;
907 vfs_fhtovp_t            vfs_stdfhtovp;
908 vfs_checkexp_t          vfs_stdcheckexp;
909 vfs_init_t              vfs_stdinit;
910 vfs_uninit_t            vfs_stduninit;
911 vfs_extattrctl_t        vfs_stdextattrctl;
912 vfs_sysctl_t            vfs_stdsysctl;
913
914 #else /* !_KERNEL */
915
916 #include <sys/cdefs.h>
917
918 struct stat;
919
920 __BEGIN_DECLS
921 int     fhopen(const struct fhandle *, int);
922 int     fhstat(const struct fhandle *, struct stat *);
923 int     fhstatfs(const struct fhandle *, struct statfs *);
924 int     fstatfs(int, struct statfs *);
925 int     getfh(const char *, fhandle_t *);
926 int     getfsstat(struct statfs *, long, int);
927 int     getmntinfo(struct statfs **, int);
928 int     lgetfh(const char *, fhandle_t *);
929 int     mount(const char *, const char *, int, void *);
930 int     nmount(struct iovec *, unsigned int, int);
931 int     statfs(const char *, struct statfs *);
932 int     unmount(const char *, int);
933
934 /* C library stuff */
935 int     getvfsbyname(const char *, struct xvfsconf *);
936 __END_DECLS
937
938 #endif /* _KERNEL */
939
940 #endif /* !_SYS_MOUNT_H_ */