drm: Reduce ioctl differences with Linux 4.7.10
[dragonfly.git] / sys / sys / mount.h
CommitLineData
984263bc
MD
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.
2c64e990 13 * 3. Neither the name of the University nor the names of its contributors
984263bc
MD
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: src/sys/sys/mount.h,v 1.89.2.7 2003/04/04 20:35:57 tegge Exp $
31 */
32
33#ifndef _SYS_MOUNT_H_
34#define _SYS_MOUNT_H_
35
3c7cc767 36#include <sys/queue.h>
95bf5f78 37#include <sys/tree.h>
3c7cc767 38#include <sys/ucred.h>
984263bc
MD
39
40#ifndef _KERNEL
41#if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
42#include <sys/stat.h>
43#endif /* !_POSIX_C_SOURCE */
44#endif /* !_KERNEL */
45
03d6a592 46#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
03d6a592 47#ifndef _SYS_LOCK_H_
984263bc
MD
48#include <sys/lock.h>
49#endif
28623bf9
MD
50#ifndef _SYS_NAMECACHE_H_
51#include <sys/namecache.h>
52#endif
d9fad06e
MD
53#ifndef _SYS_STATVFS_H_
54#include <sys/statvfs.h>
55#endif
aac0aabd
MD
56#ifndef _SYS_THREAD_H_
57#include <sys/thread.h>
58#endif
e788edda 59#include <sys/vfs_quota.h>
03d6a592 60#endif
984263bc 61
dadab5e9 62struct thread;
2281065e 63struct journal;
0961aa92 64struct vop_ops;
2281065e 65struct vop_mountctl_args;
0e735c8f 66struct statvfs;
bd7598aa 67struct vmntvnodescan_info;
dadab5e9 68
984263bc
MD
69typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
70
71/*
3e3a527f
MD
72 * File identifier. These are unique per filesystem on a single machine.
73 *
74 * fix_ext is also used by HAMMER.
984263bc
MD
75 */
76#define MAXFIDSZ 16
77
78struct fid {
79 u_short fid_len; /* length of data in bytes */
3e3a527f 80 u_short fid_ext; /* extended data */
984263bc 81 char fid_data[MAXFIDSZ]; /* data (variable length) */
4e32c858 82} __packed;
984263bc
MD
83
84/*
85 * file system statistics
86 */
87
88#define MFSNAMELEN 16 /* length of fs type name, including null */
984263bc 89#define MNAMELEN 80 /* length of buffer for returned name */
984263bc
MD
90
91struct statfs {
92 long f_spare2; /* placeholder */
93 long f_bsize; /* fundamental file system block size */
94 long f_iosize; /* optimal transfer block size */
95 long f_blocks; /* total data blocks in file system */
96 long f_bfree; /* free blocks in fs */
97 long f_bavail; /* free blocks avail to non-superuser */
98 long f_files; /* total file nodes in file system */
99 long f_ffree; /* free file nodes in fs */
100 fsid_t f_fsid; /* file system id */
101 uid_t f_owner; /* user that mounted the filesystem */
102 int f_type; /* type of filesystem */
103 int f_flags; /* copy of mount exported flags */
104 long f_syncwrites; /* count of sync writes since mount */
105 long f_asyncwrites; /* count of async writes since mount */
106 char f_fstypename[MFSNAMELEN]; /* fs type name */
107 char f_mntonname[MNAMELEN]; /* directory on which mounted */
108 long f_syncreads; /* count of sync reads since mount */
109 long f_asyncreads; /* count of async reads since mount */
110 short f_spares1; /* unused spare */
111 char f_mntfromname[MNAMELEN];/* mounted filesystem */
112 short f_spares2; /* unused spare */
113 long f_spare[2]; /* unused spare */
114};
115
ec12abe0 116#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
408357d8
MD
117
118/*
119 * bio_ops are associated with the mount structure and used in conjuction
120 * with the b_dep field in a buffer. Currently softupdates and HAMMER
121 * utilize this field.
59a647b1
MD
122 *
123 * All bio_ops callbacks must be MPSAFE and could be called without
124 * the mplock.
408357d8
MD
125 */
126struct buf;
127
128struct bio_ops {
129 TAILQ_ENTRY(bio_ops) entry;
130 void (*io_start) (struct buf *);
131 void (*io_complete) (struct buf *);
132 void (*io_deallocate) (struct buf *);
133 int (*io_fsync) (struct vnode *);
134 int (*io_sync) (struct mount *);
135 void (*io_movedeps) (struct buf *, struct buf *);
136 int (*io_countdeps) (struct buf *, int);
27bc0cb1
MD
137 int (*io_checkread) (struct buf *);
138 int (*io_checkwrite) (struct buf *);
408357d8
MD
139};
140
f236a458
FT
141#endif
142
95bf5f78 143/*
59a9a88c 144 * vfs quota accounting
95bf5f78
FT
145 *
146 * uids and gids often come in contiguous blocks; use a small linear
147 * array as the basic in-memory accounting allocation unit
148 */
149#define ACCT_CHUNK_BITS 5
150#define ACCT_CHUNK_NIDS (1<<ACCT_CHUNK_BITS)
151#define ACCT_CHUNK_MASK (ACCT_CHUNK_NIDS - 1)
152
3e8ec7e9
FT
153struct ac_counters {
154 uint64_t space;
155 uint64_t limit;
156};
157
95bf5f78
FT
158struct ac_unode {
159 RB_ENTRY(ac_unode) rb_entry;
160 uid_t left_bits;
3e8ec7e9 161 struct ac_counters uid_chunk[ACCT_CHUNK_NIDS];
95bf5f78
FT
162};
163
164struct ac_gnode {
165 RB_ENTRY(ac_gnode) rb_entry;
166 gid_t left_bits;
3e8ec7e9 167 struct ac_counters gid_chunk[ACCT_CHUNK_NIDS];
95bf5f78
FT
168};
169
f236a458
FT
170#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
171
95bf5f78
FT
172struct vfs_acct {
173 RB_HEAD(ac_utree,ac_unode) ac_uroot;
174 RB_HEAD(ac_gtree,ac_gnode) ac_groot;
175 uint64_t ac_bytes; /* total bytes used */
3e8ec7e9 176 uint64_t ac_limit;
95bf5f78
FT
177 struct spinlock ac_spin; /* protective spinlock */
178};
179
180
984263bc
MD
181/*
182 * Structure per mounted file system. Each mounted file system has an
183 * array of operations and an instance record. The file systems are
184 * put on a doubly linked list.
185 *
186 * NOTE: mnt_nvnodelist and mnt_reservedvnlist. At the moment vnodes
187 * are linked into mnt_nvnodelist. At some point in the near future the
188 * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
189 * will become the dirty list and mnt_reservedvnlist will become the 'clean'
190 * list. Filesystem kld's syncing code should remain compatible since
191 * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
41a01a4d 192 *
fad57d0e
MD
193 * NOTE: All VFSs must at least populate mnt_vn_ops or those VOP ops that
194 * only take namecache pointers will not be able to find their operations
195 * vector via namecache->nc_mount.
aac0aabd
MD
196 *
197 * MPSAFE NOTES: mnt_lock interlocks mounting and unmounting operations.
198 *
199 * mnt_token interlocks operations which adjust the mount
200 * structure and will also be held through VFS operations
201 * for VFSes not flagged MPSAFE.
87f62b1c
MD
202 *
203 * The VFS should pre-set VFCF_MPSAFE in the VFS_SET() to
204 * avoid use of the mplock during mounting. This will also
205 * cause MNTK_ALL_MPSAFE to be set in mnt_kern_flags. If the
206 * VFS does not set VFCF_MPSAFE then it can set individual
207 * MNTK_*_MPSAFE flags in mnt_kern_flags.
984263bc
MD
208 */
209TAILQ_HEAD(vnodelst, vnode);
2281065e 210TAILQ_HEAD(journallst, journal);
984263bc
MD
211
212struct mount {
213 TAILQ_ENTRY(mount) mnt_list; /* mount list */
214 struct vfsops *mnt_op; /* operations on fs */
215 struct vfsconf *mnt_vfc; /* configuration info */
75e479cf 216 u_int mnt_namecache_gen; /* ++ to clear negative hits */
d84f6fa1 217 u_int mnt_pbuf_count; /* pbuf usage limit */
984263bc 218 struct vnode *mnt_syncer; /* syncer vnode */
50e4012a 219 struct syncer_ctx *mnt_syncer_ctx; /* syncer process context */
984263bc 220 struct vnodelst mnt_nvnodelist; /* list of vnodes this mount */
bd7598aa 221 TAILQ_HEAD(,vmntvnodescan_info) mnt_vnodescan_list;
984263bc
MD
222 struct lock mnt_lock; /* mount structure lock */
223 int mnt_flag; /* flags shared with user */
224 int mnt_kern_flag; /* kernel only flags */
225 int mnt_maxsymlinklen; /* max size of short symlink */
226 struct statfs mnt_stat; /* cache of filesystem stats */
d9fad06e 227 struct statvfs mnt_vstat; /* extended stats */
984263bc
MD
228 qaddr_t mnt_data; /* private data */
229 time_t mnt_time; /* last time written*/
230 u_int mnt_iosize_max; /* max IO request size */
231 struct vnodelst mnt_reservedvnlist; /* (future) dirty vnode list */
232 int mnt_nvnodelistsize; /* # of vnodes on this mount */
6ddb7618
MD
233
234 /*
235 * ops vectors have a fixed stacking order. All primary calls run
236 * through mnt_vn_ops. This field is typically assigned to
237 * mnt_vn_norm_ops. If journaling has been enabled this field is
238 * usually assigned to mnt_vn_journal_ops.
239 */
240 struct vop_ops *mnt_vn_use_ops; /* current ops set */
241
242 struct vop_ops *mnt_vn_coherency_ops; /* cache coherency ops */
243 struct vop_ops *mnt_vn_journal_ops; /* journaling ops */
244 struct vop_ops *mnt_vn_norm_ops; /* for use by the VFS */
0961aa92
MD
245 struct vop_ops *mnt_vn_spec_ops; /* for use by the VFS */
246 struct vop_ops *mnt_vn_fifo_ops; /* for use by the VFS */
28623bf9
MD
247 struct nchandle mnt_ncmountpt; /* mount point */
248 struct nchandle mnt_ncmounton; /* mounted on */
3536c341 249 char mnt_pad[24]; /* (try to cache-align refs) */
28623bf9 250 int mnt_refs; /* nchandle references */
9629eb35 251 int mnt_hold; /* prevent kfree */
aac0aabd 252 struct lwkt_token mnt_token; /* token lock if not MPSAFE */
2281065e 253 struct journallst mnt_jlist; /* list of active journals */
797e4fe9
MD
254 u_int8_t *mnt_jbitmap; /* streamid bitmap */
255 int16_t mnt_streamid; /* last streamid */
408357d8
MD
256
257 struct bio_ops *mnt_bioops; /* BIO ops (hammer, softupd) */
95bf5f78
FT
258
259 struct vfs_acct mnt_acct; /* vfs space accounting */
984263bc 260};
2281065e 261
ec12abe0 262#endif /* _KERNEL || _KERNEL_STRUCTURES */
984263bc
MD
263
264/*
265 * User specifiable flags.
266 */
267#define MNT_RDONLY 0x00000001 /* read only filesystem */
268#define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
269#define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
270#define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
271#define MNT_NODEV 0x00000010 /* don't interpret special files */
e2950f41 272#define MNT_AUTOMOUNTED 0x00000020 /* mounted by automountd(8) */
984263bc
MD
273#define MNT_ASYNC 0x00000040 /* file system written asynchronously */
274#define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */
275#define MNT_SOFTDEP 0x00200000 /* soft updates being done */
276#define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */
e0fb398b 277#define MNT_TRIM 0x01000000 /* Enable online FS trimming */
984263bc
MD
278#define MNT_NOATIME 0x10000000 /* disable update of file access time */
279#define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */
280#define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */
281
282/*
283 * NFS export related mount flags.
284 */
285#define MNT_EXRDONLY 0x00000080 /* exported read only */
286#define MNT_EXPORTED 0x00000100 /* file system is exported */
287#define MNT_DEFEXPORTED 0x00000200 /* exported to the world */
288#define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */
289#define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */
290#define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */
291
292/*
293 * Flags set by internal operations,
294 * but visible to the user.
295 * XXX some of these are not quite right.. (I've never seen the root flag set)
296 */
297#define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
298#define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
299#define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
300#define MNT_USER 0x00008000 /* mounted by a user */
301#define MNT_IGNORE 0x00800000 /* do not show entry in df */
302
303/*
304 * Mask of flags that are visible to statfs()
305 * XXX I think that this could now become (~(MNT_CMDFLAGS))
306 * but the 'mount' program may need changing to handle this.
307 */
308#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
55358b98 309 MNT_NOSUID | MNT_NODEV | \
984263bc
MD
310 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
311 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
312 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
313 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
314 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
a3dce641 315 MNT_IGNORE | MNT_NOSYMFOLLOW | MNT_EXPUBLIC| \
e2950f41 316 MNT_TRIM | MNT_AUTOMOUNTED)
984263bc
MD
317/*
318 * External filesystem command modifier flags.
319 * Unmount can use the MNT_FORCE flag.
320 * XXX These are not STATES and really should be somewhere else.
321 */
322#define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
323#define MNT_DELEXPORT 0x00020000 /* delete export host lists */
324#define MNT_RELOAD 0x00040000 /* reload filesystem data */
325#define MNT_FORCE 0x00080000 /* force unmount or readonly change */
326#define MNT_CMDFLAGS (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
327/*
328 * Internal filesystem control flags stored in mnt_kern_flag.
329 *
330 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
331 * past the mount point. This keeps the subtree stable during mounts
332 * and unmounts.
333 *
334 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
335 * dounmount() is still waiting to lock the mountpoint. This allows
336 * the filesystem to cancel operations that might otherwise deadlock
337 * with the unmount attempt (used by NFS).
5dc91765
MD
338 *
339 * MNTK_NOSTKMNT prevents mounting another filesystem inside the flagged one.
984263bc
MD
340 */
341#define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */
51a529db 342#define MNTK_QUICKHALT 0x00008000 /* quick unmount on halt */
aac0aabd 343#define MNTK_MPSAFE 0x00010000 /* call vops without mnt_token lock */
2247fe02
MD
344#define MNTK_RD_MPSAFE 0x00020000 /* vop_read is MPSAFE */
345#define MNTK_WR_MPSAFE 0x00040000 /* vop_write is MPSAFE */
346#define MNTK_GA_MPSAFE 0x00080000 /* vop_getattr is MPSAFE */
347#define MNTK_IN_MPSAFE 0x00100000 /* vop_inactive is MPSAFE */
7a2de9a4 348#define MNTK_SG_MPSAFE 0x00200000 /* vop_strategy is MPSAFE */
28623bf9 349#define MNTK_NCALIASED 0x00800000 /* namecached aliased */
984263bc
MD
350#define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
351#define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
352#define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */
66a1ddf5 353#define MNTK_FSMID 0x08000000 /* getattr supports FSMIDs */
5dc91765 354#define MNTK_NOSTKMNT 0x10000000 /* no stacked mount point allowed */
2bc7505b 355#define MNTK_NOMSYNC 0x20000000 /* used by tmpfs */
50e4012a 356#define MNTK_THR_SYNC 0x40000000 /* fs sync thread requested */
0a5fa2b3 357#define MNTK_ST_MPSAFE 0x80000000 /* (mfs) vfs_start is MPSAFE */
984263bc 358
8801b30b 359#define MNTK_ALL_MPSAFE (MNTK_MPSAFE | MNTK_RD_MPSAFE | MNTK_WR_MPSAFE | \
0a5fa2b3
VS
360 MNTK_GA_MPSAFE | MNTK_IN_MPSAFE | MNTK_SG_MPSAFE | \
361 MNTK_ST_MPSAFE)
8801b30b 362
861905fb
MD
363/*
364 * mountlist_*() defines
365 */
366#define MNTSCAN_FORWARD 0x0001
367#define MNTSCAN_REVERSE 0x0002
368#define MNTSCAN_NOBUSY 0x0004
369
370#define MNTINS_FIRST 0x0001
371#define MNTINS_LAST 0x0002
372
984263bc
MD
373/*
374 * Sysctl CTL_VFS definitions.
375 *
376 * Second level identifier specifies which filesystem. Second level
377 * identifier VFS_VFSCONF returns information about all filesystems.
378 * Second level identifier VFS_GENERIC is non-terminal.
379 */
380#define VFS_VFSCONF 0 /* get configured filesystems */
381#define VFS_GENERIC 0 /* generic filesystem information */
382/*
383 * Third level identifiers for VFS_GENERIC are given below; third
384 * level identifiers for specific filesystems are given in their
385 * mount specific header files.
386 */
387#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
388#define VFS_CONF 2 /* struct: vfsconf for filesystem given
389 as next argument */
390
2247fe02
MD
391/*
392 * VFS MPLOCK helper.
393 */
3b998fa9 394#define VFS_MPLOCK_DECLARE int xlock_mpsafe
2247fe02 395
371cb095 396#define VFS_MPLOCK(mp) VFS_MPLOCK_FLAG(mp, MNTK_MPSAFE)
2247fe02 397
2247fe02
MD
398#define VFS_MPLOCK_FLAG(mp, flag) \
399 do { \
400 if (mp->mnt_kern_flag & flag) { \
401 xlock_mpsafe = 1; \
402 } else { \
403 get_mplock(); /* TEMPORARY */ \
3b998fa9 404 lwkt_gettoken(&mp->mnt_token); \
2247fe02
MD
405 xlock_mpsafe = 0; \
406 } \
407 } while(0)
408
409#define VFS_MPUNLOCK(mp) \
410 do { \
411 if (xlock_mpsafe == 0) { \
3b998fa9 412 lwkt_reltoken(&mp->mnt_token); \
2247fe02
MD
413 rel_mplock(); /* TEMPORARY */ \
414 } \
415 } while(0)
416
984263bc
MD
417/*
418 * Flags for various system call interfaces.
419 *
420 * waitfor flags to vfs_sync() and getfsstat()
421 */
28271622
MD
422#define MNT_WAIT 0x0001 /* synchronously wait for I/O to complete */
423#define MNT_NOWAIT 0x0002 /* start all I/O, but do not wait for it */
424#define MNT_LAZY 0x0004 /* be lazy and do not necessarily push it all */
984263bc 425
52174f71
MD
426#define VOP_FSYNC_SYSCALL 0x0001 /* from system call */
427
984263bc
MD
428/*
429 * Generic file handle
430 */
431struct fhandle {
432 fsid_t fh_fsid; /* File system id of mount point */
433 struct fid fh_fid; /* File sys specific id */
434};
435typedef struct fhandle fhandle_t;
436
437/*
438 * Export arguments for local filesystem mount calls.
439 */
440struct export_args {
441 int ex_flags; /* export related flags */
442 uid_t ex_root; /* mapping for root uid */
443 struct ucred ex_anon; /* mapping for anonymous user */
444 struct sockaddr *ex_addr; /* net address to which exported */
445 int ex_addrlen; /* and the net address length */
446 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
447 int ex_masklen; /* and the smask length */
448 char *ex_indexfile; /* index file for WebNFS URLs */
449};
450
451/*
452 * Structure holding information for a publicly exported filesystem
453 * (WebNFS). Currently the specs allow just for one such filesystem.
454 */
455struct nfs_public {
456 int np_valid; /* Do we hold valid information */
457 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
458 struct mount *np_mount; /* Mountpoint of exported fs */
459 char *np_index; /* Index file */
460};
461
462/*
463 * Filesystem configuration information. One of these exists for each
464 * type of filesystem supported by the kernel. These are searched at
465 * mount time to identify the requested filesystem.
466 */
467struct vfsconf {
468 struct vfsops *vfc_vfsops; /* filesystem operations vector */
469 char vfc_name[MFSNAMELEN]; /* filesystem type name */
470 int vfc_typenum; /* historic filesystem type number */
471 int vfc_refcount; /* number mounted of this type */
472 int vfc_flags; /* permanent flags */
2613053d 473 STAILQ_ENTRY(vfsconf) vfc_next; /* next in list */
984263bc
MD
474};
475
476struct ovfsconf {
477 void *vfc_vfsops;
478 char vfc_name[32];
479 int vfc_index;
480 int vfc_refcount;
481 int vfc_flags;
482};
483
484/*
485 * NB: these flags refer to IMPLEMENTATION properties, not properties of
486 * any actual mounts; i.e., it does not make sense to change the flags.
487 */
488#define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
489#define VFCF_NETWORK 0x00020000 /* may get data over the network */
490#define VFCF_READONLY 0x00040000 /* writes are not implemented */
491#define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
492#define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
493#define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/
87f62b1c 494#define VFCF_MPSAFE 0x00400000 /* VFS is fully MPSAFE */
984263bc 495
5e25370d
TK
496/* vfsquery flags */
497#define VQ_NOTRESP 0x0001 /* server down */
498#define VQ_NEEDAUTH 0x0002 /* server bad auth */
499#define VQ_LOWDISK 0x0004 /* we're low on space */
500#define VQ_MOUNT 0x0008 /* new filesystem arrived */
501#define VQ_UNMOUNT 0x0010 /* filesystem has left */
502#define VQ_DEAD 0x0020 /* filesystem is dead, needs force unmount */
503#define VQ_ASSIST 0x0040 /* filesystem needs assistance from external
504 program */
505#define VQ_NOTRESPLOCK 0x0080 /* server lockd down */
506#define VQ_FLAG0100 0x0100 /* placeholder */
507#define VQ_FLAG0200 0x0200 /* placeholder */
508#define VQ_FLAG0400 0x0400 /* placeholder */
509#define VQ_FLAG0800 0x0800 /* placeholder */
510#define VQ_FLAG1000 0x1000 /* placeholder */
511#define VQ_FLAG2000 0x2000 /* placeholder */
512#define VQ_FLAG4000 0x4000 /* placeholder */
513#define VQ_FLAG8000 0x8000 /* placeholder */
514
984263bc
MD
515#ifdef _KERNEL
516
517#ifdef MALLOC_DECLARE
518MALLOC_DECLARE(M_MOUNT);
519#endif
984263bc 520extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
2613053d
MN
521
522struct vfsconf *vfsconf_find_by_name(const char *);
523struct vfsconf *vfsconf_find_by_typenum(int);
524int vfsconf_get_maxtypenum(void);
525int vfsconf_each(int (*)(struct vfsconf *, void *), void *);
984263bc 526
ec12abe0
MD
527#endif
528
529#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
530
531TAILQ_HEAD(mntlist, mount); /* struct mntlist */
532
984263bc
MD
533/*
534 * Operations supported on mounted file system.
535 */
21739618 536struct nlookupdata;
fad57d0e 537struct nlookupdata;
984263bc 538struct mbuf;
984263bc 539
43c45e8f 540typedef int vfs_mount_t(struct mount *mp, char *path, caddr_t data,
acde96db
MD
541 struct ucred *cred);
542typedef int vfs_start_t(struct mount *mp, int flags);
543typedef int vfs_unmount_t(struct mount *mp, int mntflags);
43c45e8f
HP
544typedef int vfs_root_t(struct mount *mp, struct vnode **vpp);
545typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
acde96db 546 struct ucred *cred);
43c45e8f 547typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp,
acde96db 548 struct ucred *cred);
d9fad06e
MD
549typedef int vfs_statvfs_t(struct mount *mp, struct statvfs *sbp,
550 struct ucred *cred);
87de5057 551typedef int vfs_sync_t(struct mount *mp, int waitfor);
b9b0a6d0
MD
552typedef int vfs_vget_t(struct mount *mp, struct vnode *dvp,
553 ino_t ino, struct vnode **vpp);
67863d04
MD
554typedef int vfs_fhtovp_t(struct mount *mp, struct vnode *rootvp,
555 struct fid *fhp, struct vnode **vpp);
43c45e8f 556typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
b153f746 557 int *extflagsp, struct ucred **credanonp);
43c45e8f
HP
558typedef int vfs_vptofh_t(struct vnode *vp, struct fid *fhp);
559typedef int vfs_init_t(struct vfsconf *);
560typedef int vfs_uninit_t(struct vfsconf *);
0f6997f9
MD
561typedef int vfs_extattrctl_t(struct mount *mp, int cmd, struct vnode *vp,
562 int attrnamespace, const char *attrname,
563 struct ucred *cred);
e788edda 564typedef int vfs_acinit_t(struct mount *mp);
75a5a592 565typedef void vfs_acdone_t(struct mount *mp);
95bf5f78 566typedef void vfs_account_t(struct mount *mp,
1c18cfd0 567 uid_t uid, gid_t gid, int64_t delta);
75779c3c
AH
568typedef void vfs_ncpgen_set_t(struct mount *mp, struct namecache *ncp);
569typedef int vfs_ncpgen_test_t(struct mount *mp, struct namecache *ncp);
1c222faf 570typedef void vfs_modifying_t(struct mount *mp);
43c45e8f 571
aac0aabd
MD
572int vfs_mount(struct mount *mp, char *path, caddr_t data, struct ucred *cred);
573int vfs_start(struct mount *mp, int flags);
574int vfs_unmount(struct mount *mp, int mntflags);
575int vfs_root(struct mount *mp, struct vnode **vpp);
576int vfs_quotactl(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
577 struct ucred *cred);
578int vfs_statfs(struct mount *mp, struct statfs *sbp, struct ucred *cred);
579int vfs_statvfs(struct mount *mp, struct statvfs *sbp, struct ucred *cred);
580int vfs_sync(struct mount *mp, int waitfor);
581int vfs_vget(struct mount *mp, struct vnode *dvp,
582 ino_t ino, struct vnode **vpp);
583int vfs_fhtovp(struct mount *mp, struct vnode *rootvp,
584 struct fid *fhp, struct vnode **vpp);
585int vfs_checkexp(struct mount *mp, struct sockaddr *nam,
586 int *extflagsp, struct ucred **credanonp);
587int vfs_vptofh(struct vnode *vp, struct fid *fhp);
588int vfs_init(struct vfsconf *vfc);
589int vfs_uninit(struct vfsconf *vfc, struct vfsconf *vfsp);
0f6997f9
MD
590int vfs_extattrctl(struct mount *mp, int cmd, struct vnode *vp,
591 int attrnamespace, const char *attrname,
592 struct ucred *cred);
1c222faf 593int vfs_modifying(struct mount *mp);
aac0aabd 594
43c45e8f
HP
595struct vfsops {
596 vfs_mount_t *vfs_mount;
597 vfs_start_t *vfs_start;
598 vfs_unmount_t *vfs_unmount;
599 vfs_root_t *vfs_root;
600 vfs_quotactl_t *vfs_quotactl;
601 vfs_statfs_t *vfs_statfs;
602 vfs_sync_t *vfs_sync;
603 vfs_vget_t *vfs_vget;
604 vfs_fhtovp_t *vfs_fhtovp;
605 vfs_checkexp_t *vfs_checkexp;
606 vfs_vptofh_t *vfs_vptofh;
607 vfs_init_t *vfs_init;
608 vfs_uninit_t *vfs_uninit;
d9fad06e
MD
609 vfs_extattrctl_t *vfs_extattrctl;
610 vfs_statvfs_t *vfs_statvfs;
e788edda
FT
611 vfs_acinit_t *vfs_acinit;
612 vfs_acdone_t *vfs_acdone;
1c18cfd0 613 vfs_account_t *vfs_account;
75779c3c
AH
614 vfs_ncpgen_set_t *vfs_ncpgen_set;
615 vfs_ncpgen_test_t *vfs_ncpgen_test;
1c222faf 616 vfs_modifying_t *vfs_modifying;
984263bc
MD
617};
618
aac0aabd
MD
619#define VFS_MOUNT(MP, PATH, DATA, CRED) \
620 vfs_mount(MP, PATH, DATA, CRED)
621#define VFS_START(MP, FLAGS) \
622 vfs_start(MP, FLAGS)
623#define VFS_UNMOUNT(MP, FORCE) \
624 vfs_unmount(MP, FORCE)
625#define VFS_ROOT(MP, VPP) \
626 vfs_root(MP, VPP)
627#define VFS_QUOTACTL(MP, C, U, A, CRED) \
628 vfs_quotactl(MP, C, U, A, CRED)
629#define VFS_STATFS(MP, SBP, CRED) \
630 vfs_statfs(MP, SBP, CRED)
631#define VFS_STATVFS(MP, SBP, CRED) \
632 vfs_statvfs(MP, SBP, CRED)
633#define VFS_SYNC(MP, WAIT) \
634 vfs_sync(MP, WAIT)
635#define VFS_VGET(MP, DVP, INO, VPP) \
636 vfs_vget(MP, DVP, INO, VPP)
67863d04 637#define VFS_FHTOVP(MP, ROOTVP, FIDP, VPP) \
aac0aabd
MD
638 vfs_fhtovp(MP, ROOTVP, FIDP, VPP)
639#define VFS_VPTOFH(VP, FIDP) \
640 vfs_vptofh(VP, FIDP)
641#define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \
642 vfs_checkexp(MP, NAM, EXFLG, CRED)
0f6997f9
MD
643#define VFS_EXTATTRCTL(MP, C, FVP, NS, N, CRED) \
644 vfs_extattrctl(MP, C, FVP, NS, N, CRED)
82318d45 645#define VFS_ACCOUNT(MP, U, G, D) \
d4eea8cb 646 if ((MP->mnt_op->vfs_account != NULL) && (D != 0)) \
82318d45 647 MP->mnt_op->vfs_account(MP, U, G, D);
75a5a592 648#define VFS_ACINIT(MP, ERROR) \
59a9a88c 649 if (vfs_quota_enabled && MP->mnt_op->vfs_acinit != NULL) \
75a5a592
FT
650 ERROR = MP->mnt_op->vfs_acinit(MP);
651#define VFS_ACDONE(MP) \
59a9a88c 652 if (vfs_quota_enabled && MP->mnt_op->vfs_acdone != NULL) \
75a5a592 653 MP->mnt_op->vfs_acdone(MP);
75779c3c
AH
654#define VFS_NCPGEN_SET(MP, NCP) \
655 MP->mnt_op->vfs_ncpgen_set(MP, NCP)
656#define VFS_NCPGEN_TEST(MP, NCP) \
657 MP->mnt_op->vfs_ncpgen_test(MP, NCP)
1c222faf
MD
658#define VFS_MODIFYING(MP) \
659 MP->mnt_op->vfs_modifying(MP)
984263bc 660
ec12abe0
MD
661#endif
662
663#ifdef _KERNEL
664
984263bc
MD
665#include <sys/module.h>
666
667#define VFS_SET(vfsops, fsname, flags) \
668 static struct vfsconf fsname ## _vfsconf = { \
669 &vfsops, \
670 #fsname, \
671 -1, \
672 0, \
58661e79 673 flags, \
37c1c8fc 674 { NULL }, \
984263bc
MD
675 }; \
676 static moduledata_t fsname ## _mod = { \
677 #fsname, \
678 vfs_modevent, \
679 & fsname ## _vfsconf \
680 }; \
681 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
682
ec12abe0
MD
683#endif
684
685#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
686
984263bc
MD
687#include <net/radix.h>
688
fbb5a20f 689#define AF_MAX 36 /* XXX */
984263bc
MD
690
691/*
692 * Network address lookup element
693 */
694struct netcred {
695 struct radix_node netc_rnodes[2];
696 int netc_exflags;
697 struct ucred netc_anon;
698};
699
700/*
701 * Network export information
702 */
703struct netexport {
794500d0
NA
704 struct netcred ne_defexported; /* Default export */
705 struct radix_node_head *ne_inethead; /* IPv4 radix */
706 struct radix_node_head *ne_inet6head; /* IPv6 radix */
707 struct radix_node_head *ne_maskhead; /* Shared mask radix */
984263bc 708};
f9ecb661
MD
709#define NE_LOCK(nep) lwkt_getpooltoken(nep)
710#define NE_UNLOCK(nep) lwkt_relpooltoken(nep)
711#define NE_ASSERT_LOCKED(nep) \
712 ASSERT_LWKT_TOKEN_HELD(lwkt_token_pool_lookup(nep))
984263bc 713
ec12abe0
MD
714#endif
715
716#ifdef _KERNEL
984263bc
MD
717/*
718 * exported vnode operations
719 */
9629eb35
MD
720void mount_hold(struct mount *);
721void mount_drop(struct mount *);
51a529db 722int dounmount (struct mount *, int, int);
984263bc 723int vfs_setpublicfs /* set publicly exported fs */
1aa89f17 724 (struct mount *, struct netexport *, const struct export_args *);
b153f746
RG
725int vfs_lock (struct mount *); /* lock a vfs */
726void vfs_msync (struct mount *, int);
727void vfs_unlock (struct mount *); /* unlock a vfs */
f9642f56 728int vfs_busy (struct mount *, int);
984263bc 729int vfs_export /* process mount export info */
1aa89f17 730 (struct mount *, struct netexport *, const struct export_args *);
984263bc 731struct netcred *vfs_export_lookup /* lookup host in fs export list */
b153f746
RG
732 (struct mount *, struct netexport *, struct sockaddr *);
733int vfs_allocate_syncvnode (struct mount *);
734void vfs_getnewfsid (struct mount *);
67863d04 735int vfs_setfsid(struct mount *mp, fsid_t *template);
b13267a5 736cdev_t vfs_getrootfsid (struct mount *);
b153f746
RG
737struct mount *vfs_getvfs (fsid_t *); /* return vfs given fsid */
738int vfs_modevent (module_t, int, void *);
739int vfs_mountedon (struct vnode *); /* is a vfs mounted on vp */
740int vfs_rootmountalloc (char *, char *, struct mount **);
f9642f56 741void vfs_unbusy (struct mount *);
51a529db 742void vfs_unmountall (int halting);
b153f746
RG
743int vfs_register (struct vfsconf *);
744int vfs_unregister (struct vfsconf *);
984263bc
MD
745extern struct nfs_public nfs_pub;
746
747/*
748 * Declarations for these vfs default operations are located in
749 * kern/vfs_default.c, they should be used instead of making "dummy"
750 * functions or casting entries in the VFS op table to "enopnotsupp()".
751 */
43c45e8f 752vfs_start_t vfs_stdstart;
43c45e8f
HP
753vfs_root_t vfs_stdroot;
754vfs_quotactl_t vfs_stdquotactl;
755vfs_statfs_t vfs_stdstatfs;
d9fad06e 756vfs_statvfs_t vfs_stdstatvfs;
43c45e8f
HP
757vfs_sync_t vfs_stdsync;
758vfs_sync_t vfs_stdnosync;
759vfs_vget_t vfs_stdvget;
760vfs_fhtovp_t vfs_stdfhtovp;
761vfs_checkexp_t vfs_stdcheckexp;
762vfs_vptofh_t vfs_stdvptofh;
763vfs_init_t vfs_stdinit;
764vfs_uninit_t vfs_stduninit;
acde96db 765vfs_extattrctl_t vfs_stdextattrctl;
e788edda
FT
766vfs_acinit_t vfs_stdac_init;
767vfs_acdone_t vfs_stdac_done;
1c18cfd0 768vfs_account_t vfs_stdaccount;
e788edda 769vfs_account_t vfs_noaccount;
75779c3c
AH
770vfs_ncpgen_set_t vfs_stdncpgen_set;
771vfs_ncpgen_test_t vfs_stdncpgen_test;
1c222faf 772vfs_modifying_t vfs_stdmodifying;
43c45e8f 773
9340415c
MD
774struct vop_access_args;
775int vop_helper_access(struct vop_access_args *ap, uid_t ino_uid, gid_t ino_gid,
fb356552 776 mode_t ino_mode, u_int32_t ino_flags);
1399fa3b 777int vop_helper_setattr_flags(u_int32_t *ino_flags, u_int32_t vaflags,
fb356552
MD
778 uid_t uid, struct ucred *cred);
779uid_t vop_helper_create_uid(struct mount *mp, mode_t dmode, uid_t duid,
780 struct ucred *cred, mode_t *modep);
f7179e23
MD
781int vop_helper_chmod(struct vnode *vp, mode_t new_mode, struct ucred *cred,
782 uid_t cur_uid, gid_t cur_gid, mode_t *cur_modep);
783int vop_helper_chown(struct vnode *vp, uid_t new_uid, gid_t new_gid,
784 struct ucred *cred,
785 uid_t *cur_uidp, gid_t *cur_gidp, mode_t *cur_modep);
68ad1455 786int vop_helper_read_shortcut(struct vop_read_args *ap);
1399fa3b 787
408357d8
MD
788void add_bio_ops(struct bio_ops *ops);
789void rem_bio_ops(struct bio_ops *ops);
9340415c 790
2281065e 791int journal_mountctl(struct vop_mountctl_args *ap);
432b8263
MD
792void journal_remove_all_journals(struct mount *mp, int flags);
793
861905fb
MD
794void mountlist_insert(struct mount *, int);
795int mountlist_interlock(int (*callback)(struct mount *), struct mount *);
796struct mount *mountlist_boot_getfirst(void);
797void mountlist_remove(struct mount *mp);
cf7ad7d1 798int mountlist_exists(struct mount *mp);
861905fb 799int mountlist_scan(int (*callback)(struct mount *, void *), void *, int);
5b4cfb7e 800struct mount *mount_get_by_nc(struct namecache *ncp);
984263bc
MD
801#else /* !_KERNEL */
802
803#include <sys/cdefs.h>
804
805__BEGIN_DECLS
b153f746
RG
806int fstatfs (int, struct statfs *);
807int getfh (const char *, fhandle_t *);
808int getfsstat (struct statfs *, long, int);
809int getmntinfo (struct statfs **, int);
0e735c8f 810int getmntvinfo (struct statfs **, struct statvfs **, int);
b153f746
RG
811int mount (const char *, const char *, int, void *);
812int statfs (const char *, struct statfs *);
813int unmount (const char *, int);
814int fhopen (const struct fhandle *, int);
815int fhstat (const struct fhandle *, struct stat *);
816int fhstatfs (const struct fhandle *, struct statfs *);
984263bc
MD
817
818/* C library stuff */
b153f746
RG
819void endvfsent (void);
820struct ovfsconf *getvfsbyname (const char *);
821struct ovfsconf *getvfsbytype (int);
822struct ovfsconf *getvfsent (void);
984263bc 823#define getvfsbyname new_getvfsbyname
b153f746
RG
824int new_getvfsbyname (const char *, struct vfsconf *);
825void setvfsent (int);
826int vfsisloadable (const char *);
827int vfsload (const char *);
984263bc
MD
828__END_DECLS
829
830#endif /* _KERNEL */
831
832#endif /* !_SYS_MOUNT_H_ */
ec12abe0 833