Initial import from FreeBSD RELENG_4:
[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>
41
42#ifndef _KERNEL
43#if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
44#include <sys/stat.h>
45#endif /* !_POSIX_C_SOURCE */
46#endif /* !_KERNEL */
47
48#include <sys/queue.h>
49#ifdef _KERNEL
50#include <sys/lock.h>
51#endif
52
53typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
54
55/*
56 * File identifier.
57 * These are unique per filesystem on a single machine.
58 */
59#define MAXFIDSZ 16
60
61struct fid {
62 u_short fid_len; /* length of data in bytes */
63 u_short fid_reserved; /* force longword alignment */
64 char fid_data[MAXFIDSZ]; /* data (variable length) */
65};
66
67/*
68 * file system statistics
69 */
70
71#define MFSNAMELEN 16 /* length of fs type name, including null */
72#ifdef __i386__
73#define MNAMELEN 80 /* length of buffer for returned name */
74#endif
75#ifdef __alpha__
76#define MNAMELEN 72 /* length of buffer for returned name */
77#endif
78
79struct statfs {
80 long f_spare2; /* placeholder */
81 long f_bsize; /* fundamental file system block size */
82 long f_iosize; /* optimal transfer block size */
83 long f_blocks; /* total data blocks in file system */
84 long f_bfree; /* free blocks in fs */
85 long f_bavail; /* free blocks avail to non-superuser */
86 long f_files; /* total file nodes in file system */
87 long f_ffree; /* free file nodes in fs */
88 fsid_t f_fsid; /* file system id */
89 uid_t f_owner; /* user that mounted the filesystem */
90 int f_type; /* type of filesystem */
91 int f_flags; /* copy of mount exported flags */
92 long f_syncwrites; /* count of sync writes since mount */
93 long f_asyncwrites; /* count of async writes since mount */
94 char f_fstypename[MFSNAMELEN]; /* fs type name */
95 char f_mntonname[MNAMELEN]; /* directory on which mounted */
96 long f_syncreads; /* count of sync reads since mount */
97 long f_asyncreads; /* count of async reads since mount */
98 short f_spares1; /* unused spare */
99 char f_mntfromname[MNAMELEN];/* mounted filesystem */
100 short f_spares2; /* unused spare */
101 long f_spare[2]; /* unused spare */
102};
103
104#ifdef _KERNEL
105/*
106 * Structure per mounted file system. Each mounted file system has an
107 * array of operations and an instance record. The file systems are
108 * put on a doubly linked list.
109 *
110 * NOTE: mnt_nvnodelist and mnt_reservedvnlist. At the moment vnodes
111 * are linked into mnt_nvnodelist. At some point in the near future the
112 * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
113 * will become the dirty list and mnt_reservedvnlist will become the 'clean'
114 * list. Filesystem kld's syncing code should remain compatible since
115 * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
116 */
117TAILQ_HEAD(vnodelst, vnode);
118
119struct mount {
120 TAILQ_ENTRY(mount) mnt_list; /* mount list */
121 struct vfsops *mnt_op; /* operations on fs */
122 struct vfsconf *mnt_vfc; /* configuration info */
123 struct vnode *mnt_vnodecovered; /* vnode we mounted on */
124 struct vnode *mnt_syncer; /* syncer vnode */
125 struct vnodelst mnt_nvnodelist; /* list of vnodes this mount */
126 struct lock mnt_lock; /* mount structure lock */
127 int mnt_flag; /* flags shared with user */
128 int mnt_kern_flag; /* kernel only flags */
129 int mnt_maxsymlinklen; /* max size of short symlink */
130 struct statfs mnt_stat; /* cache of filesystem stats */
131 qaddr_t mnt_data; /* private data */
132 time_t mnt_time; /* last time written*/
133 u_int mnt_iosize_max; /* max IO request size */
134 struct vnodelst mnt_reservedvnlist; /* (future) dirty vnode list */
135 int mnt_nvnodelistsize; /* # of vnodes on this mount */
136};
137#endif /* _KERNEL */
138
139/*
140 * User specifiable flags.
141 */
142#define MNT_RDONLY 0x00000001 /* read only filesystem */
143#define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
144#define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
145#define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
146#define MNT_NODEV 0x00000010 /* don't interpret special files */
147#define MNT_UNION 0x00000020 /* union with underlying filesystem */
148#define MNT_ASYNC 0x00000040 /* file system written asynchronously */
149#define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */
150#define MNT_SOFTDEP 0x00200000 /* soft updates being done */
151#define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */
152#define MNT_NOATIME 0x10000000 /* disable update of file access time */
153#define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */
154#define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */
155
156/*
157 * NFS export related mount flags.
158 */
159#define MNT_EXRDONLY 0x00000080 /* exported read only */
160#define MNT_EXPORTED 0x00000100 /* file system is exported */
161#define MNT_DEFEXPORTED 0x00000200 /* exported to the world */
162#define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */
163#define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */
164#define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */
165
166/*
167 * Flags set by internal operations,
168 * but visible to the user.
169 * XXX some of these are not quite right.. (I've never seen the root flag set)
170 */
171#define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
172#define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
173#define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
174#define MNT_USER 0x00008000 /* mounted by a user */
175#define MNT_IGNORE 0x00800000 /* do not show entry in df */
176
177/*
178 * Mask of flags that are visible to statfs()
179 * XXX I think that this could now become (~(MNT_CMDFLAGS))
180 * but the 'mount' program may need changing to handle this.
181 */
182#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
183 MNT_NOSUID | MNT_NODEV | MNT_UNION | \
184 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
185 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
186 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
187 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
188 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
189 MNT_IGNORE | MNT_NOSYMFOLLOW | MNT_EXPUBLIC )
190/*
191 * External filesystem command modifier flags.
192 * Unmount can use the MNT_FORCE flag.
193 * XXX These are not STATES and really should be somewhere else.
194 */
195#define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
196#define MNT_DELEXPORT 0x00020000 /* delete export host lists */
197#define MNT_RELOAD 0x00040000 /* reload filesystem data */
198#define MNT_FORCE 0x00080000 /* force unmount or readonly change */
199#define MNT_CMDFLAGS (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
200/*
201 * Internal filesystem control flags stored in mnt_kern_flag.
202 *
203 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
204 * past the mount point. This keeps the subtree stable during mounts
205 * and unmounts.
206 *
207 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
208 * dounmount() is still waiting to lock the mountpoint. This allows
209 * the filesystem to cancel operations that might otherwise deadlock
210 * with the unmount attempt (used by NFS).
211 */
212#define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */
213#define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
214#define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
215#define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */
216
217/*
218 * Sysctl CTL_VFS definitions.
219 *
220 * Second level identifier specifies which filesystem. Second level
221 * identifier VFS_VFSCONF returns information about all filesystems.
222 * Second level identifier VFS_GENERIC is non-terminal.
223 */
224#define VFS_VFSCONF 0 /* get configured filesystems */
225#define VFS_GENERIC 0 /* generic filesystem information */
226/*
227 * Third level identifiers for VFS_GENERIC are given below; third
228 * level identifiers for specific filesystems are given in their
229 * mount specific header files.
230 */
231#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
232#define VFS_CONF 2 /* struct: vfsconf for filesystem given
233 as next argument */
234
235/*
236 * Flags for various system call interfaces.
237 *
238 * waitfor flags to vfs_sync() and getfsstat()
239 */
240#define MNT_WAIT 1 /* synchronously wait for I/O to complete */
241#define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
242#define MNT_LAZY 3 /* push data not written by filesystem syncer */
243
244/*
245 * Generic file handle
246 */
247struct fhandle {
248 fsid_t fh_fsid; /* File system id of mount point */
249 struct fid fh_fid; /* File sys specific id */
250};
251typedef struct fhandle fhandle_t;
252
253/*
254 * Export arguments for local filesystem mount calls.
255 */
256struct export_args {
257 int ex_flags; /* export related flags */
258 uid_t ex_root; /* mapping for root uid */
259 struct ucred ex_anon; /* mapping for anonymous user */
260 struct sockaddr *ex_addr; /* net address to which exported */
261 int ex_addrlen; /* and the net address length */
262 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
263 int ex_masklen; /* and the smask length */
264 char *ex_indexfile; /* index file for WebNFS URLs */
265};
266
267/*
268 * Structure holding information for a publicly exported filesystem
269 * (WebNFS). Currently the specs allow just for one such filesystem.
270 */
271struct nfs_public {
272 int np_valid; /* Do we hold valid information */
273 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
274 struct mount *np_mount; /* Mountpoint of exported fs */
275 char *np_index; /* Index file */
276};
277
278/*
279 * Filesystem configuration information. One of these exists for each
280 * type of filesystem supported by the kernel. These are searched at
281 * mount time to identify the requested filesystem.
282 */
283struct vfsconf {
284 struct vfsops *vfc_vfsops; /* filesystem operations vector */
285 char vfc_name[MFSNAMELEN]; /* filesystem type name */
286 int vfc_typenum; /* historic filesystem type number */
287 int vfc_refcount; /* number mounted of this type */
288 int vfc_flags; /* permanent flags */
289 struct vfsconf *vfc_next; /* next in list */
290};
291
292struct ovfsconf {
293 void *vfc_vfsops;
294 char vfc_name[32];
295 int vfc_index;
296 int vfc_refcount;
297 int vfc_flags;
298};
299
300/*
301 * NB: these flags refer to IMPLEMENTATION properties, not properties of
302 * any actual mounts; i.e., it does not make sense to change the flags.
303 */
304#define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
305#define VFCF_NETWORK 0x00020000 /* may get data over the network */
306#define VFCF_READONLY 0x00040000 /* writes are not implemented */
307#define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
308#define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
309#define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/
310
311#ifdef _KERNEL
312
313#ifdef MALLOC_DECLARE
314MALLOC_DECLARE(M_MOUNT);
315#endif
316extern int maxvfsconf; /* highest defined filesystem type */
317extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
318extern struct vfsconf *vfsconf; /* head of list of filesystem types */
319
320/*
321 * Operations supported on mounted file system.
322 */
323#ifdef __STDC__
324struct nameidata;
325struct mbuf;
326#endif
327
328struct vfsops {
329 int (*vfs_mount) __P((struct mount *mp, char *path, caddr_t data,
330 struct nameidata *ndp, struct proc *p));
331 int (*vfs_start) __P((struct mount *mp, int flags,
332 struct proc *p));
333 int (*vfs_unmount) __P((struct mount *mp, int mntflags,
334 struct proc *p));
335 int (*vfs_root) __P((struct mount *mp, struct vnode **vpp));
336 int (*vfs_quotactl) __P((struct mount *mp, int cmds, uid_t uid,
337 caddr_t arg, struct proc *p));
338 int (*vfs_statfs) __P((struct mount *mp, struct statfs *sbp,
339 struct proc *p));
340 int (*vfs_sync) __P((struct mount *mp, int waitfor,
341 struct ucred *cred, struct proc *p));
342 int (*vfs_vget) __P((struct mount *mp, ino_t ino,
343 struct vnode **vpp));
344 int (*vfs_fhtovp) __P((struct mount *mp, struct fid *fhp,
345 struct vnode **vpp));
346 int (*vfs_checkexp) __P((struct mount *mp, struct sockaddr *nam,
347 int *extflagsp, struct ucred **credanonp));
348 int (*vfs_vptofh) __P((struct vnode *vp, struct fid *fhp));
349 int (*vfs_init) __P((struct vfsconf *));
350 int (*vfs_uninit) __P((struct vfsconf *));
351 int (*vfs_extattrctl) __P((struct mount *mp, int cmd,
352 const char *attrname, caddr_t arg,
353 struct proc *p));
354};
355
356#define VFS_MOUNT(MP, PATH, DATA, NDP, P) \
357 (*(MP)->mnt_op->vfs_mount)(MP, PATH, DATA, NDP, P)
358#define VFS_START(MP, FLAGS, P) (*(MP)->mnt_op->vfs_start)(MP, FLAGS, P)
359#define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P)
360#define VFS_ROOT(MP, VPP) (*(MP)->mnt_op->vfs_root)(MP, VPP)
361#define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P)
362#define VFS_STATFS(MP, SBP, P) (*(MP)->mnt_op->vfs_statfs)(MP, SBP, P)
363#define VFS_SYNC(MP, WAIT, C, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, C, P)
364#define VFS_VGET(MP, INO, VPP) (*(MP)->mnt_op->vfs_vget)(MP, INO, VPP)
365#define VFS_FHTOVP(MP, FIDP, VPP) \
366 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP)
367#define VFS_VPTOFH(VP, FIDP) (*(VP)->v_mount->mnt_op->vfs_vptofh)(VP, FIDP)
368#define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \
369 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED)
370#define VFS_EXTATTRCTL(MP, C, N, A, P) \
371 (*(MP)->mnt_op->vfs_extattrctl)(MP, C, N, A, P)
372
373#include <sys/module.h>
374
375#define VFS_SET(vfsops, fsname, flags) \
376 static struct vfsconf fsname ## _vfsconf = { \
377 &vfsops, \
378 #fsname, \
379 -1, \
380 0, \
381 flags \
382 }; \
383 static moduledata_t fsname ## _mod = { \
384 #fsname, \
385 vfs_modevent, \
386 & fsname ## _vfsconf \
387 }; \
388 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
389
390#include <net/radix.h>
391
392#define AF_MAX 33 /* XXX */
393
394/*
395 * Network address lookup element
396 */
397struct netcred {
398 struct radix_node netc_rnodes[2];
399 int netc_exflags;
400 struct ucred netc_anon;
401};
402
403/*
404 * Network export information
405 */
406struct netexport {
407 struct netcred ne_defexported; /* Default export */
408 struct radix_node_head *ne_rtable[AF_MAX+1]; /* Individual exports */
409};
410
411extern char *mountrootfsname;
412
413/*
414 * exported vnode operations
415 */
416int dounmount __P((struct mount *, int, struct proc *));
417int vfs_setpublicfs /* set publicly exported fs */
418 __P((struct mount *, struct netexport *, struct export_args *));
419int vfs_lock __P((struct mount *)); /* lock a vfs */
420void vfs_msync __P((struct mount *, int));
421void vfs_unlock __P((struct mount *)); /* unlock a vfs */
422int vfs_busy __P((struct mount *, int, struct simplelock *, struct proc *));
423int vfs_export /* process mount export info */
424 __P((struct mount *, struct netexport *, struct export_args *));
425struct netcred *vfs_export_lookup /* lookup host in fs export list */
426 __P((struct mount *, struct netexport *, struct sockaddr *));
427int vfs_allocate_syncvnode __P((struct mount *));
428void vfs_getnewfsid __P((struct mount *));
429dev_t vfs_getrootfsid __P((struct mount *));
430struct mount *vfs_getvfs __P((fsid_t *)); /* return vfs given fsid */
431int vfs_modevent __P((module_t, int, void *));
432int vfs_mountedon __P((struct vnode *)); /* is a vfs mounted on vp */
433int vfs_rootmountalloc __P((char *, char *, struct mount **));
434void vfs_unbusy __P((struct mount *, struct proc *));
435void vfs_unmountall __P((void));
436int vfs_register __P((struct vfsconf *));
437int vfs_unregister __P((struct vfsconf *));
438extern TAILQ_HEAD(mntlist, mount) mountlist; /* mounted filesystem list */
439extern struct simplelock mountlist_slock;
440extern struct nfs_public nfs_pub;
441
442/*
443 * Declarations for these vfs default operations are located in
444 * kern/vfs_default.c, they should be used instead of making "dummy"
445 * functions or casting entries in the VFS op table to "enopnotsupp()".
446 */
447int vfs_stdmount __P((struct mount *mp, char *path, caddr_t data,
448 struct nameidata *ndp, struct proc *p));
449int vfs_stdstart __P((struct mount *mp, int flags, struct proc *p));
450int vfs_stdunmount __P((struct mount *mp, int mntflags, struct proc *p));
451int vfs_stdroot __P((struct mount *mp, struct vnode **vpp));
452int vfs_stdquotactl __P((struct mount *mp, int cmds, uid_t uid,
453 caddr_t arg, struct proc *p));
454int vfs_stdstatfs __P((struct mount *mp, struct statfs *sbp, struct proc *p));
455int vfs_stdsync __P((struct mount *mp, int waitfor, struct ucred *cred,
456 struct proc *p));
457int vfs_stdvget __P((struct mount *mp, ino_t ino, struct vnode **vpp));
458int vfs_stdfhtovp __P((struct mount *mp, struct fid *fhp, struct vnode **vpp));
459int vfs_stdcheckexp __P((struct mount *mp, struct sockaddr *nam,
460 int *extflagsp, struct ucred **credanonp));
461int vfs_stdvptofh __P((struct vnode *vp, struct fid *fhp));
462int vfs_stdinit __P((struct vfsconf *));
463int vfs_stduninit __P((struct vfsconf *));
464int vfs_stdextattrctl __P((struct mount *mp, int cmd, const char *attrname,
465 caddr_t arg, struct proc *p));
466
467#else /* !_KERNEL */
468
469#include <sys/cdefs.h>
470
471__BEGIN_DECLS
472int fstatfs __P((int, struct statfs *));
473int getfh __P((const char *, fhandle_t *));
474int getfsstat __P((struct statfs *, long, int));
475int getmntinfo __P((struct statfs **, int));
476int mount __P((const char *, const char *, int, void *));
477int statfs __P((const char *, struct statfs *));
478int unmount __P((const char *, int));
479int fhopen __P((const struct fhandle *, int));
480int fhstat __P((const struct fhandle *, struct stat *));
481int fhstatfs __P((const struct fhandle *, struct statfs *));
482
483/* C library stuff */
484void endvfsent __P((void));
485struct ovfsconf *getvfsbyname __P((const char *));
486struct ovfsconf *getvfsbytype __P((int));
487struct ovfsconf *getvfsent __P((void));
488#define getvfsbyname new_getvfsbyname
489int new_getvfsbyname __P((const char *, struct vfsconf *));
490void setvfsent __P((int));
491int vfsisloadable __P((const char *));
492int vfsload __P((const char *));
493__END_DECLS
494
495#endif /* _KERNEL */
496
497#endif /* !_SYS_MOUNT_H_ */