kernel -- Per-mount syncer thread infrastructure.
[dragonfly.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  * 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>
41 #include <sys/tree.h>
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
49 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
50 #ifndef _SYS_QUEUE_H_
51 #include <sys/queue.h>
52 #endif
53 #ifndef _SYS_LOCK_H_
54 #include <sys/lock.h>
55 #endif
56 #ifndef _SYS_NAMECACHE_H_
57 #include <sys/namecache.h>
58 #endif
59 #ifndef _SYS_STATVFS_H_
60 #include <sys/statvfs.h>
61 #endif
62 #ifndef _SYS_THREAD_H_
63 #include <sys/thread.h>
64 #endif
65 #include <sys/vfs_quota.h>
66 #endif
67
68 struct thread;
69 struct journal;
70 struct vop_ops;
71 struct vop_mountctl_args;
72 struct statvfs;
73
74 typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
75
76 /*
77  * File identifier.  These are unique per filesystem on a single machine.
78  *
79  * fix_ext is also used by HAMMER.
80  */
81 #define MAXFIDSZ        16
82
83 struct fid {
84         u_short         fid_len;                /* length of data in bytes */
85         u_short         fid_ext;                /* extended data           */
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 */
94 #define MNAMELEN        80      /* length of buffer for returned name */
95
96 struct 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
121 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
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.
127  *
128  * All bio_ops callbacks must be MPSAFE and could be called without
129  * the mplock.
130  */
131 struct buf;
132
133 struct 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);
142         int     (*io_checkread) (struct buf *);
143         int     (*io_checkwrite) (struct buf *);
144 };
145
146 #endif
147
148 /*
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
158 struct ac_unode {
159         RB_ENTRY(ac_unode)      rb_entry;
160         uid_t                   left_bits;
161         uint64_t                uid_chunk[ACCT_CHUNK_NIDS];
162 };
163
164 struct ac_gnode {
165         RB_ENTRY(ac_gnode)      rb_entry;
166         gid_t                   left_bits;
167         uint64_t                gid_chunk[ACCT_CHUNK_NIDS];
168 };
169
170 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
171
172 struct 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 /*
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).
191  *
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.
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.
201  */
202 TAILQ_HEAD(vnodelst, vnode);
203 TAILQ_HEAD(journallst, journal);
204
205 struct mount {
206         TAILQ_ENTRY(mount) mnt_list;            /* mount list */
207         struct vfsops   *mnt_op;                /* operations on fs */
208         struct vfsconf  *mnt_vfc;               /* configuration info */
209         long            mnt_namecache_gen;      /* ++ to clear negative hits */
210         struct vnode    *mnt_syncer;            /* syncer vnode */
211         struct syncer_ctx *mnt_syncer_ctx;      /* syncer process context */
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 */
218         struct statvfs  mnt_vstat;              /* extended stats */
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 */
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 */
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 */
238         struct nchandle mnt_ncmountpt;          /* mount point */
239         struct nchandle mnt_ncmounton;          /* mounted on */
240         int             mnt_refs;               /* nchandle references */
241         struct lwkt_token mnt_token;            /* token lock if not MPSAFE */
242         struct journallst mnt_jlist;            /* list of active journals */
243         u_int8_t        *mnt_jbitmap;           /* streamid bitmap */
244         int16_t         mnt_streamid;           /* last streamid */
245
246         struct bio_ops  *mnt_bioops;            /* BIO ops (hammer, softupd) */
247
248         struct vfs_acct mnt_acct;               /* vfs space accounting */
249 };
250
251 #endif /* _KERNEL || _KERNEL_STRUCTURES */
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 */
266 #define MNT_TRIM        0x01000000      /* Enable online FS trimming */
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 */
290 #define MNT_ACCOUNTING  0x00020000      /* accounting is enabled on filesystem */
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   | \
305                         MNT_IGNORE      | MNT_NOSYMFOLLOW | MNT_EXPUBLIC| \
306                         MNT_ACCOUNTING  | MNT_TRIM)
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).
328  *
329  * MNTK_NOSTKMNT prevents mounting another filesystem inside the flagged one.
330  */
331 #define MNTK_UNMOUNTF   0x00000001      /* forced unmount in progress */
332 #define MNTK_MPSAFE     0x00010000      /* call vops without mnt_token lock */
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 */
337 #define MNTK_SG_MPSAFE  0x00200000      /* vop_strategy is MPSAFE */
338 #define MNTK_NCALIASED  0x00800000      /* namecached aliased */
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 */
342 #define MNTK_FSMID      0x08000000      /* getattr supports FSMIDs */
343 #define MNTK_NOSTKMNT   0x10000000      /* no stacked mount point allowed */
344 #define MNTK_NOMSYNC    0x20000000      /* used by tmpfs */
345 #define MNTK_THR_SYNC   0x40000000      /* fs sync thread requested */
346
347 #define MNTK_ALL_MPSAFE (MNTK_MPSAFE | MNTK_RD_MPSAFE | MNTK_WR_MPSAFE | \
348                          MNTK_GA_MPSAFE | MNTK_IN_MPSAFE | MNTK_SG_MPSAFE)
349
350 /*
351  * mountlist_*() defines
352  */
353 #define MNTSCAN_FORWARD         0x0001
354 #define MNTSCAN_REVERSE         0x0002
355 #define MNTSCAN_NOBUSY          0x0004
356
357 #define MNTINS_FIRST            0x0001
358 #define MNTINS_LAST             0x0002
359
360 /*
361  * Sysctl CTL_VFS definitions.
362  *
363  * Second level identifier specifies which filesystem. Second level
364  * identifier VFS_VFSCONF returns information about all filesystems.
365  * Second level identifier VFS_GENERIC is non-terminal.
366  */
367 #define VFS_VFSCONF             0       /* get configured filesystems */
368 #define VFS_GENERIC             0       /* generic filesystem information */
369 /*
370  * Third level identifiers for VFS_GENERIC are given below; third
371  * level identifiers for specific filesystems are given in their
372  * mount specific header files.
373  */
374 #define VFS_MAXTYPENUM  1       /* int: highest defined filesystem type */
375 #define VFS_CONF        2       /* struct: vfsconf for filesystem given
376                                    as next argument */
377
378 /*
379  * VFS MPLOCK helper.
380  */
381 #define VFS_MPLOCK_DECLARE      int xlock_mpsafe
382
383 #define VFS_MPLOCK1(mp)         VFS_MPLOCK_FLAG(mp, MNTK_MPSAFE)
384
385 #define VFS_MPLOCK2(mp)                                                 \
386                 do {                                                    \
387                         if (xlock_mpsafe) {                             \
388                                 get_mplock();   /* TEMPORARY */         \
389                                 lwkt_gettoken(&mp->mnt_token);          \
390                                 xlock_mpsafe = 0;                       \
391                         }                                               \
392                 } while(0)
393
394 #define VFS_MPLOCK_FLAG(mp, flag)                                       \
395                 do {                                                    \
396                         if (mp->mnt_kern_flag & flag) {                 \
397                                 xlock_mpsafe = 1;                       \
398                         } else {                                        \
399                                 get_mplock();   /* TEMPORARY */         \
400                                 lwkt_gettoken(&mp->mnt_token);          \
401                                 xlock_mpsafe = 0;                       \
402                         }                                               \
403                 } while(0)
404
405 #define VFS_MPUNLOCK(mp)                                                \
406                 do {                                                    \
407                         if (xlock_mpsafe == 0) {                        \
408                                 lwkt_reltoken(&mp->mnt_token);          \
409                                 rel_mplock();   /* TEMPORARY */         \
410                         }                                               \
411                 } while(0)
412
413 /*
414  * Flags for various system call interfaces.
415  *
416  * waitfor flags to vfs_sync() and getfsstat()
417  */
418 #define MNT_WAIT        0x0001  /* synchronously wait for I/O to complete */
419 #define MNT_NOWAIT      0x0002  /* start all I/O, but do not wait for it */
420 #define MNT_LAZY        0x0004  /* be lazy and do not necessarily push it all */
421
422 #define VOP_FSYNC_SYSCALL       0x0001  /* from system call */
423
424 /*
425  * Generic file handle
426  */
427 struct fhandle {
428         fsid_t  fh_fsid;        /* File system id of mount point */
429         struct  fid fh_fid;     /* File sys specific id */
430 };
431 typedef struct fhandle  fhandle_t;
432
433 /*
434  * Export arguments for local filesystem mount calls.
435  */
436 struct export_args {
437         int     ex_flags;               /* export related flags */
438         uid_t   ex_root;                /* mapping for root uid */
439         struct  ucred ex_anon;          /* mapping for anonymous user */
440         struct  sockaddr *ex_addr;      /* net address to which exported */
441         int     ex_addrlen;             /* and the net address length */
442         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
443         int     ex_masklen;             /* and the smask length */
444         char    *ex_indexfile;          /* index file for WebNFS URLs */
445 };
446
447 /*
448  * Structure holding information for a publicly exported filesystem
449  * (WebNFS). Currently the specs allow just for one such filesystem.
450  */
451 struct nfs_public {
452         int             np_valid;       /* Do we hold valid information */
453         fhandle_t       np_handle;      /* Filehandle for pub fs (internal) */
454         struct mount    *np_mount;      /* Mountpoint of exported fs */
455         char            *np_index;      /* Index file */
456 };
457
458 /*
459  * Filesystem configuration information. One of these exists for each
460  * type of filesystem supported by the kernel. These are searched at
461  * mount time to identify the requested filesystem.
462  */
463 #ifndef _SYS_QUEUE_H_
464 #include <sys/queue.h>
465 #endif
466 struct vfsconf {
467         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
468         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
469         int     vfc_typenum;            /* historic filesystem type number */
470         int     vfc_refcount;           /* number mounted of this type */
471         int     vfc_flags;              /* permanent flags */
472         STAILQ_ENTRY(vfsconf) vfc_next; /* next in list */
473 };
474
475 struct ovfsconf {
476         void    *vfc_vfsops;
477         char    vfc_name[32];
478         int     vfc_index;
479         int     vfc_refcount;
480         int     vfc_flags;
481 };
482
483 /*
484  * NB: these flags refer to IMPLEMENTATION properties, not properties of
485  * any actual mounts; i.e., it does not make sense to change the flags.
486  */
487 #define VFCF_STATIC     0x00010000      /* statically compiled into kernel */
488 #define VFCF_NETWORK    0x00020000      /* may get data over the network */
489 #define VFCF_READONLY   0x00040000      /* writes are not implemented */
490 #define VFCF_SYNTHETIC  0x00080000      /* data does not represent real files */
491 #define VFCF_LOOPBACK   0x00100000      /* aliases some other mounted FS */
492 #define VFCF_UNICODE    0x00200000      /* stores file names as Unicode*/
493
494 #ifdef _KERNEL
495
496 #ifdef MALLOC_DECLARE
497 MALLOC_DECLARE(M_MOUNT);
498 #endif
499 extern int nfs_mount_type;      /* vfc_typenum for nfs, or -1 */
500
501 struct vfsconf *vfsconf_find_by_name(const char *);
502 struct vfsconf *vfsconf_find_by_typenum(int);
503 int vfsconf_get_maxtypenum(void);
504 int vfsconf_each(int (*)(struct vfsconf *, void *), void *);
505
506 #endif
507
508 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
509
510 TAILQ_HEAD(mntlist, mount);     /* struct mntlist */
511
512 /*
513  * Operations supported on mounted file system.
514  */
515 struct nlookupdata;
516 struct nlookupdata;
517 struct mbuf;
518
519 typedef int vfs_mount_t(struct mount *mp, char *path, caddr_t data,
520                                     struct ucred *cred);
521 typedef int vfs_start_t(struct mount *mp, int flags);
522 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
523 typedef int vfs_root_t(struct mount *mp, struct vnode **vpp);
524 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
525                                     struct ucred *cred);
526 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp,
527                                     struct ucred *cred);
528 typedef int vfs_statvfs_t(struct mount *mp, struct statvfs *sbp,
529                                     struct ucred *cred);
530 typedef int vfs_sync_t(struct mount *mp, int waitfor);
531 typedef int vfs_vget_t(struct mount *mp, struct vnode *dvp,
532                                     ino_t ino, struct vnode **vpp);
533 typedef int vfs_fhtovp_t(struct mount *mp, struct vnode *rootvp,
534                                     struct fid *fhp, struct vnode **vpp);
535 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
536                                     int *extflagsp, struct ucred **credanonp);
537 typedef int vfs_vptofh_t(struct vnode *vp, struct fid *fhp);
538 typedef int vfs_init_t(struct vfsconf *);
539 typedef int vfs_uninit_t(struct vfsconf *);
540 typedef int vfs_extattrctl_t(struct mount *mp, int cmd, struct vnode *vp,
541                     int attrnamespace, const char *attrname,
542                     struct ucred *cred);
543 typedef int vfs_acinit_t(struct mount *mp);
544 typedef int vfs_acdone_t(struct mount *mp);
545 typedef void vfs_account_t(struct mount *mp,
546                         uid_t uid, gid_t gid, int64_t delta);
547
548 int vfs_mount(struct mount *mp, char *path, caddr_t data, struct ucred *cred);
549 int vfs_start(struct mount *mp, int flags);
550 int vfs_unmount(struct mount *mp, int mntflags);
551 int vfs_root(struct mount *mp, struct vnode **vpp);
552 int vfs_quotactl(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
553                                 struct ucred *cred);
554 int vfs_statfs(struct mount *mp, struct statfs *sbp, struct ucred *cred);
555 int vfs_statvfs(struct mount *mp, struct statvfs *sbp, struct ucred *cred);
556 int vfs_sync(struct mount *mp, int waitfor);
557 int vfs_vget(struct mount *mp, struct vnode *dvp,
558                                 ino_t ino, struct vnode **vpp);
559 int vfs_fhtovp(struct mount *mp, struct vnode *rootvp,
560                                 struct fid *fhp, struct vnode **vpp);
561 int vfs_checkexp(struct mount *mp, struct sockaddr *nam,
562                                 int *extflagsp, struct ucred **credanonp);
563 int vfs_vptofh(struct vnode *vp, struct fid *fhp);
564 int vfs_init(struct vfsconf *vfc);
565 int vfs_uninit(struct vfsconf *vfc, struct vfsconf *vfsp);
566 int vfs_extattrctl(struct mount *mp, int cmd, struct vnode *vp,
567                     int attrnamespace, const char *attrname,
568                     struct ucred *cred);
569
570
571 struct vfsops {
572         vfs_mount_t     *vfs_mount;
573         vfs_start_t     *vfs_start;
574         vfs_unmount_t   *vfs_unmount;
575         vfs_root_t      *vfs_root;
576         vfs_quotactl_t  *vfs_quotactl;
577         vfs_statfs_t    *vfs_statfs;
578         vfs_sync_t      *vfs_sync;
579         vfs_vget_t      *vfs_vget;
580         vfs_fhtovp_t    *vfs_fhtovp;
581         vfs_checkexp_t  *vfs_checkexp;
582         vfs_vptofh_t    *vfs_vptofh;
583         vfs_init_t      *vfs_init;
584         vfs_uninit_t    *vfs_uninit;
585         vfs_extattrctl_t *vfs_extattrctl;
586         vfs_statvfs_t   *vfs_statvfs;
587         vfs_acinit_t    *vfs_acinit;
588         vfs_acdone_t    *vfs_acdone;
589         vfs_account_t   *vfs_account;
590 };
591
592 #define VFS_MOUNT(MP, PATH, DATA, CRED)         \
593         vfs_mount(MP, PATH, DATA, CRED)
594 #define VFS_START(MP, FLAGS)                    \
595         vfs_start(MP, FLAGS)
596 #define VFS_UNMOUNT(MP, FORCE)                  \
597         vfs_unmount(MP, FORCE)
598 #define VFS_ROOT(MP, VPP)                       \
599         vfs_root(MP, VPP)
600 #define VFS_QUOTACTL(MP, C, U, A, CRED)         \
601         vfs_quotactl(MP, C, U, A, CRED)
602 #define VFS_STATFS(MP, SBP, CRED)               \
603         vfs_statfs(MP, SBP, CRED)
604 #define VFS_STATVFS(MP, SBP, CRED)              \
605         vfs_statvfs(MP, SBP, CRED)
606 #define VFS_SYNC(MP, WAIT)                      \
607         vfs_sync(MP, WAIT)
608 #define VFS_VGET(MP, DVP, INO, VPP)             \
609         vfs_vget(MP, DVP, INO, VPP)
610 #define VFS_FHTOVP(MP, ROOTVP, FIDP, VPP)       \
611         vfs_fhtovp(MP, ROOTVP, FIDP, VPP)
612 #define VFS_VPTOFH(VP, FIDP)                    \
613         vfs_vptofh(VP, FIDP)
614 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED)      \
615         vfs_checkexp(MP, NAM, EXFLG, CRED)
616 #define VFS_EXTATTRCTL(MP, C, FVP, NS, N, CRED) \
617         vfs_extattrctl(MP, C, FVP, NS, N, CRED)
618 #define VFS_ACCOUNT(MP, U, G, D) \
619         if (MP->mnt_op->vfs_account != NULL) \
620                 MP->mnt_op->vfs_account(MP, U, G, D);
621
622 #endif
623
624 #ifdef _KERNEL
625
626 #include <sys/module.h>
627
628 #define VFS_SET(vfsops, fsname, flags) \
629         static struct vfsconf fsname ## _vfsconf = {            \
630                 &vfsops,                                        \
631                 #fsname,                                        \
632                 -1,                                             \
633                 0,                                              \
634                 flags,                                          \
635                 { NULL },                                       \
636         };                                                      \
637         static moduledata_t fsname ## _mod = {                  \
638                 #fsname,                                        \
639                 vfs_modevent,                                   \
640                 & fsname ## _vfsconf                            \
641         };                                                      \
642         DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
643
644 #endif
645
646 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
647
648 #include <net/radix.h>
649
650 #define AF_MAX          36      /* XXX */
651
652 /*
653  * Network address lookup element
654  */
655 struct netcred {
656         struct  radix_node netc_rnodes[2];
657         int     netc_exflags;
658         struct  ucred netc_anon;
659 };
660
661 /*
662  * Network export information
663  */
664 struct netexport {
665         struct  netcred ne_defexported;               /* Default export */
666         struct  radix_node_head *ne_rtable[AF_MAX+1]; /* Individual exports */
667 };
668
669 #endif
670
671 #ifdef _KERNEL
672
673 extern  char *mountrootfsname;
674
675 /*
676  * exported vnode operations
677  */
678 int     dounmount (struct mount *, int);
679 int     vfs_setpublicfs                     /* set publicly exported fs */
680           (struct mount *, struct netexport *, const struct export_args *);
681 int     vfs_lock (struct mount *);         /* lock a vfs */
682 void    vfs_msync (struct mount *, int);
683 void    vfs_unlock (struct mount *);       /* unlock a vfs */
684 int     vfs_busy (struct mount *, int);
685 void    vfs_bufstats(void);
686 int     vfs_export                          /* process mount export info */
687           (struct mount *, struct netexport *, const struct export_args *);
688 struct  netcred *vfs_export_lookup          /* lookup host in fs export list */
689           (struct mount *, struct netexport *, struct sockaddr *);
690 int     vfs_allocate_syncvnode (struct mount *);
691 void    vfs_getnewfsid (struct mount *);
692 int     vfs_setfsid(struct mount *mp, fsid_t *template);
693 cdev_t  vfs_getrootfsid (struct mount *);
694 struct  mount *vfs_getvfs (fsid_t *);      /* return vfs given fsid */
695 int     vfs_modevent (module_t, int, void *);
696 int     vfs_mountedon (struct vnode *);    /* is a vfs mounted on vp */
697 int     vfs_rootmountalloc (char *, char *, struct mount **);
698 void    vfs_unbusy (struct mount *);
699 void    vfs_unmountall (void);
700 int     vfs_register (struct vfsconf *);
701 int     vfs_unregister (struct vfsconf *);
702 extern  struct nfs_public nfs_pub;
703
704 /* 
705  * Declarations for these vfs default operations are located in 
706  * kern/vfs_default.c, they should be used instead of making "dummy" 
707  * functions or casting entries in the VFS op table to "enopnotsupp()".
708  */ 
709 vfs_start_t     vfs_stdstart;
710 vfs_mount_t     vfs_stdmount;
711 vfs_unmount_t   vfs_stdunmount;
712 vfs_root_t      vfs_stdroot;
713 vfs_quotactl_t  vfs_stdquotactl;
714 vfs_statfs_t    vfs_stdstatfs;
715 vfs_statvfs_t   vfs_stdstatvfs;
716 vfs_sync_t      vfs_stdsync;
717 vfs_sync_t      vfs_stdnosync;
718 vfs_vget_t      vfs_stdvget;
719 vfs_fhtovp_t    vfs_stdfhtovp;
720 vfs_checkexp_t  vfs_stdcheckexp;
721 vfs_vptofh_t    vfs_stdvptofh;
722 vfs_init_t      vfs_stdinit;
723 vfs_uninit_t    vfs_stduninit;
724 vfs_extattrctl_t vfs_stdextattrctl;
725 vfs_acinit_t    vfs_stdac_init;
726 vfs_acdone_t    vfs_stdac_done;
727 vfs_account_t   vfs_stdaccount;
728 vfs_account_t   vfs_noaccount;
729
730 struct vop_access_args;
731 int vop_helper_access(struct vop_access_args *ap, uid_t ino_uid, gid_t ino_gid,
732                         mode_t ino_mode, u_int32_t ino_flags);
733 int vop_helper_setattr_flags(u_int32_t *ino_flags, u_int32_t vaflags,
734                         uid_t uid, struct ucred *cred);
735 uid_t vop_helper_create_uid(struct mount *mp, mode_t dmode, uid_t duid,
736                         struct ucred *cred, mode_t *modep);
737 int vop_helper_chmod(struct vnode *vp, mode_t new_mode, struct ucred *cred,
738                         uid_t cur_uid, gid_t cur_gid, mode_t *cur_modep);
739 int vop_helper_chown(struct vnode *vp, uid_t new_uid, gid_t new_gid,
740                         struct ucred *cred,
741                         uid_t *cur_uidp, gid_t *cur_gidp, mode_t *cur_modep);
742
743 void    add_bio_ops(struct bio_ops *ops);
744 void    rem_bio_ops(struct bio_ops *ops);
745
746 int     journal_mountctl(struct vop_mountctl_args *ap);
747 void    journal_remove_all_journals(struct mount *mp, int flags);
748
749 void    mountlist_insert(struct mount *, int);
750 int     mountlist_interlock(int (*callback)(struct mount *), struct mount *);
751 struct mount *mountlist_boot_getfirst(void);
752 void    mountlist_remove(struct mount *mp);
753 int     mountlist_scan(int (*callback)(struct mount *, void *), void *, int);
754 struct mount *mount_get_by_nc(struct namecache *ncp);
755 #else /* !_KERNEL */
756
757 #include <sys/cdefs.h>
758
759 __BEGIN_DECLS
760 int     fstatfs (int, struct statfs *);
761 int     getfh (const char *, fhandle_t *);
762 int     getfsstat (struct statfs *, long, int);
763 int     getmntinfo (struct statfs **, int);
764 int     getmntvinfo (struct statfs **, struct statvfs **, int);
765 int     mount (const char *, const char *, int, void *);
766 int     statfs (const char *, struct statfs *);
767 int     unmount (const char *, int);
768 int     fhopen (const struct fhandle *, int);
769 int     fhstat (const struct fhandle *, struct stat *);
770 int     fhstatfs (const struct fhandle *, struct statfs *);
771
772 /* C library stuff */
773 void    endvfsent (void);
774 struct  ovfsconf *getvfsbyname (const char *);
775 struct  ovfsconf *getvfsbytype (int);
776 struct  ovfsconf *getvfsent (void);
777 #define getvfsbyname    new_getvfsbyname
778 int     new_getvfsbyname (const char *, struct vfsconf *);
779 void    setvfsent (int);
780 int     vfsisloadable (const char *);
781 int     vfsload (const char *);
782 __END_DECLS
783
784 #endif /* _KERNEL */
785
786 #endif /* !_SYS_MOUNT_H_ */
787