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