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