xref: /xnu-8792.61.2/bsd/sys/mount.h (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1 /*
2  * Copyright (c) 2000-2021 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29 /*
30  * Copyright (c) 1989, 1991, 1993
31  *	The Regents of the University of California.  All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  * 1. Redistributions of source code must retain the above copyright
37  *    notice, this list of conditions and the following disclaimer.
38  * 2. Redistributions in binary form must reproduce the above copyright
39  *    notice, this list of conditions and the following disclaimer in the
40  *    documentation and/or other materials provided with the distribution.
41  * 3. All advertising materials mentioning features or use of this software
42  *    must display the following acknowledgement:
43  *	This product includes software developed by the University of
44  *	California, Berkeley and its contributors.
45  * 4. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)mount.h	8.21 (Berkeley) 5/20/95
62  */
63 /*
64  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
65  * support for mandatory and extensible security protections.  This notice
66  * is included in support of clause 2.2 (b) of the Apple Public License,
67  * Version 2.0.
68  */
69 
70 
71 #ifndef _SYS_MOUNT_H_
72 #define _SYS_MOUNT_H_
73 
74 #include <sys/appleapiopts.h>
75 #include <sys/cdefs.h>
76 #include <sys/attr.h>           /* needed for vol_capabilities_attr_t */
77 #include <os/base.h>
78 
79 #ifndef KERNEL
80 #include <stdint.h>
81 #include <sys/ucred.h>
82 #include <sys/queue.h>          /* XXX needed for user builds */
83 #include <Availability.h>
84 #else
85 #include <sys/kernel_types.h>
86 #include <uuid/uuid.h>
87 #endif
88 
89 #include <sys/_types/_fsid_t.h> /* file system id type */
90 #include <sys/_types/_graftdmg_un.h>
91 
92 /*
93  * file system statistics
94  */
95 
96 #define MFSNAMELEN      15      /* length of fs type name, not inc. null */
97 #define MFSTYPENAMELEN  16      /* length of fs type name including null */
98 
99 #if __DARWIN_64_BIT_INO_T
100 #define MNAMELEN        MAXPATHLEN      /* length of buffer for returned name */
101 #else /* ! __DARWIN_64_BIT_INO_T */
102 #define MNAMELEN        90              /* length of buffer for returned name */
103 #endif /* __DARWIN_64_BIT_INO_T */
104 
105 #define MNT_EXT_ROOT_DATA_VOL      0x00000001      /* Data volume of root volume group */
106 
107 #define __DARWIN_STRUCT_STATFS64 { \
108 	uint32_t	f_bsize;        /* fundamental file system block size */ \
109 	int32_t		f_iosize;       /* optimal transfer block size */ \
110 	uint64_t	f_blocks;       /* total data blocks in file system */ \
111 	uint64_t	f_bfree;        /* free blocks in fs */ \
112 	uint64_t	f_bavail;       /* free blocks avail to non-superuser */ \
113 	uint64_t	f_files;        /* total file nodes in file system */ \
114 	uint64_t	f_ffree;        /* free file nodes in fs */ \
115 	fsid_t		f_fsid;         /* file system id */ \
116 	uid_t		f_owner;        /* user that mounted the filesystem */ \
117 	uint32_t	f_type;         /* type of filesystem */ \
118 	uint32_t	f_flags;        /* copy of mount exported flags */ \
119 	uint32_t	f_fssubtype;    /* fs sub-type (flavor) */ \
120 	char		f_fstypename[MFSTYPENAMELEN];   /* fs type name */ \
121 	char		f_mntonname[MAXPATHLEN];        /* directory on which mounted */ \
122 	char		f_mntfromname[MAXPATHLEN];      /* mounted filesystem */ \
123 	uint32_t    f_flags_ext;    /* extended flags */ \
124 	uint32_t	f_reserved[7];  /* For future use */ \
125 }
126 
127 #if !__DARWIN_ONLY_64_BIT_INO_T
128 
129 struct statfs64 __DARWIN_STRUCT_STATFS64;
130 
131 #endif /* !__DARWIN_ONLY_64_BIT_INO_T */
132 
133 #if __DARWIN_64_BIT_INO_T
134 
135 struct statfs __DARWIN_STRUCT_STATFS64;
136 
137 #else /* !__DARWIN_64_BIT_INO_T */
138 
139 /*
140  * LP64 - WARNING - must be kept in sync with struct user_statfs in mount_internal.h.
141  */
142 struct statfs {
143 	short   f_otype;                /* TEMPORARY SHADOW COPY OF f_type */
144 	short   f_oflags;               /* TEMPORARY SHADOW COPY OF f_flags */
145 	long    f_bsize;                /* fundamental file system block size */
146 	long    f_iosize;               /* optimal transfer block size */
147 	long    f_blocks;               /* total data blocks in file system */
148 	long    f_bfree;                /* free blocks in fs */
149 	long    f_bavail;               /* free blocks avail to non-superuser */
150 	long    f_files;                /* total file nodes in file system */
151 	long    f_ffree;                /* free file nodes in fs */
152 	fsid_t  f_fsid;                 /* file system id */
153 	uid_t   f_owner;                /* user that mounted the filesystem */
154 	short   f_reserved1;    /* spare for later */
155 	short   f_type;                 /* type of filesystem */
156 	long    f_flags;                /* copy of mount exported flags */
157 	long    f_reserved2[2]; /* reserved for future use */
158 	char    f_fstypename[MFSNAMELEN]; /* fs type name */
159 	char    f_mntonname[MNAMELEN];  /* directory on which mounted */
160 	char    f_mntfromname[MNAMELEN];/* mounted filesystem */
161 	char    f_reserved3;    /* For alignment */
162 	long    f_reserved4[4]; /* For future use */
163 };
164 
165 #endif /* __DARWIN_64_BIT_INO_T */
166 
167 #pragma pack(4)
168 
169 struct vfsstatfs {
170 	uint32_t        f_bsize;        /* fundamental file system block size */
171 	size_t          f_iosize;       /* optimal transfer block size */
172 	uint64_t        f_blocks;       /* total data blocks in file system */
173 	uint64_t        f_bfree;        /* free blocks in fs */
174 	uint64_t        f_bavail;       /* free blocks avail to non-superuser */
175 	uint64_t        f_bused;        /* free blocks avail to non-superuser */
176 	uint64_t        f_files;        /* total file nodes in file system */
177 	uint64_t        f_ffree;        /* free file nodes in fs */
178 	fsid_t          f_fsid;         /* file system id */
179 	uid_t           f_owner;        /* user that mounted the filesystem */
180 	uint64_t        f_flags;        /* copy of mount exported flags */
181 	char            f_fstypename[MFSTYPENAMELEN];/* fs type name inclus */
182 	char            f_mntonname[MAXPATHLEN];/* directory on which mounted */
183 	char            f_mntfromname[MAXPATHLEN];/* mounted filesystem */
184 	uint32_t        f_fssubtype;     /* fs sub-type (flavor) */
185 	void            *f_reserved[2];         /* For future use == 0 */
186 };
187 
188 #pragma pack()
189 
190 #ifdef KERNEL
191 /*
192  * Kernel level support for the VFS_GETATTR(), VFS_SETATTR() for use in
193  * implementation of filesystem KEXTs, and by the vfs_getattr() and
194  * vfs_setattr() KPIs.
195  */
196 
197 #define VFSATTR_INIT(s)                 ((s)->f_supported = (s)->f_active = 0LL)
198 #define VFSATTR_SET_SUPPORTED(s, a)     ((s)->f_supported |= VFSATTR_ ## a)
199 #define VFSATTR_IS_SUPPORTED(s, a)      ((s)->f_supported & VFSATTR_ ## a)
200 #define VFSATTR_CLEAR_ACTIVE(s, a)      ((s)->f_active &= ~VFSATTR_ ## a)
201 #define VFSATTR_IS_ACTIVE(s, a)         ((s)->f_active & VFSATTR_ ## a)
202 #define VFSATTR_ALL_SUPPORTED(s)        (((s)->f_active & (s)->f_supported) == (s)->f_active)
203 #define VFSATTR_WANTED(s, a)            ((s)->f_active |= VFSATTR_ ## a)
204 #define VFSATTR_RETURN(s, a, x)         do { (s)-> a = (x); VFSATTR_SET_SUPPORTED(s, a);} while(0)
205 
206 #define VFSATTR_f_objcount              (1LL<<  0)
207 #define VFSATTR_f_filecount             (1LL<<  1)
208 #define VFSATTR_f_dircount              (1LL<<  2)
209 #define VFSATTR_f_maxobjcount           (1LL<<  3)
210 #define VFSATTR_f_bsize                 (1LL<< 4)
211 #define VFSATTR_f_iosize                (1LL<<  5)
212 #define VFSATTR_f_blocks                (1LL<<  6)
213 #define VFSATTR_f_bfree                 (1LL<<  7)
214 #define VFSATTR_f_bavail                (1LL<<  8)
215 #define VFSATTR_f_bused                 (1LL<<  9)
216 #define VFSATTR_f_files                 (1LL<< 10)
217 #define VFSATTR_f_ffree                 (1LL<< 11)
218 #define VFSATTR_f_fsid                  (1LL<< 12)
219 #define VFSATTR_f_owner                 (1LL<< 13)
220 #define VFSATTR_f_capabilities          (1LL<< 14)
221 #define VFSATTR_f_attributes            (1LL<< 15)
222 #define VFSATTR_f_create_time           (1LL<< 16)
223 #define VFSATTR_f_modify_time           (1LL<< 17)
224 #define VFSATTR_f_access_time           (1LL<< 18)
225 #define VFSATTR_f_backup_time           (1LL<< 19)
226 #define VFSATTR_f_fssubtype             (1LL<< 20)
227 #define VFSATTR_f_vol_name              (1LL<< 21)
228 #define VFSATTR_f_signature             (1LL<< 22)
229 #define VFSATTR_f_carbon_fsid           (1LL<< 23)
230 #define VFSATTR_f_uuid                  (1LL<< 24)
231 #define VFSATTR_f_quota         (1LL<< 25)
232 #define VFSATTR_f_reserved              (1LL<< 26)
233 
234 
235 /*
236  * Argument structure.
237  */
238 #pragma pack(4)
239 /*
240  * Note: the size of the vfs_attr structure can change.
241  * A kext should only reference the fields that are
242  * marked as active; it should not depend on the actual
243  * size of the structure or attempt to copy it.
244  */
245 struct vfs_attr {
246 	uint64_t        f_supported;
247 	uint64_t        f_active;
248 
249 	uint64_t        f_objcount;     /* number of filesystem objects in volume */
250 	uint64_t        f_filecount;    /* ... files */
251 	uint64_t        f_dircount;     /* ... directories */
252 	uint64_t        f_maxobjcount;  /* maximum number of filesystem objects */
253 
254 	uint32_t        f_bsize;        /* block size for the below size values */
255 	size_t          f_iosize;       /* optimal transfer block size */
256 	uint64_t        f_blocks;       /* total data blocks in file system */
257 	uint64_t        f_bfree;        /* free blocks in fs */
258 	uint64_t        f_bavail;       /* free blocks avail to non-superuser */
259 	uint64_t        f_bused;        /* blocks in use */
260 	uint64_t        f_files;        /* total file nodes in file system */
261 	uint64_t        f_ffree;        /* free file nodes in fs */
262 	fsid_t          f_fsid;         /* file system id */
263 	uid_t           f_owner;        /* user that mounted the filesystem */
264 
265 	vol_capabilities_attr_t f_capabilities;
266 	vol_attributes_attr_t f_attributes;
267 
268 	struct timespec f_create_time;  /* creation time */
269 	struct timespec f_modify_time;  /* last modification time */
270 	struct timespec f_access_time;  /* time of last access */
271 	struct timespec f_backup_time;  /* last backup time */
272 
273 	uint32_t        f_fssubtype;    /* filesystem subtype */
274 
275 	char            *f_vol_name;    /* volume name */
276 
277 	uint16_t        f_signature;    /* used for ATTR_VOL_SIGNATURE, Carbon's FSVolumeInfo.signature */
278 	uint16_t        f_carbon_fsid;  /* same as Carbon's FSVolumeInfo.filesystemID */
279 	uuid_t          f_uuid;         /* file system UUID (version 3 or 5), available in 10.6 and later */
280 	uint64_t        f_quota;        /* total quota data blocks in file system */
281 	uint64_t        f_reserved;     /* total reserved data blocks in file system */
282 };
283 
284 #pragma pack()
285 
286 #endif  /* KERNEL */
287 
288 /*
289  * User specifiable flags.
290  *
291  * Unmount uses MNT_FORCE flag.
292  */
293 #define MNT_RDONLY      0x00000001      /* read only filesystem */
294 #define MNT_SYNCHRONOUS 0x00000002      /* file system written synchronously */
295 #define MNT_NOEXEC      0x00000004      /* can't exec from filesystem */
296 #define MNT_NOSUID      0x00000008      /* don't honor setuid bits on fs */
297 #define MNT_NODEV       0x00000010      /* don't interpret special files */
298 #define MNT_UNION       0x00000020      /* union with underlying filesystem */
299 #define MNT_ASYNC       0x00000040      /* file system written asynchronously */
300 #define MNT_CPROTECT    0x00000080      /* file system supports content protection */
301 
302 /*
303  * NFS export related mount flags.
304  */
305 #define MNT_EXPORTED    0x00000100      /* file system is exported */
306 
307 /*
308  * Denotes storage which can be removed from the system by the user.
309  */
310 
311 #define MNT_REMOVABLE   0x00000200
312 
313 /*
314  * MAC labeled / "quarantined" flag
315  */
316 #define MNT_QUARANTINE  0x00000400      /* file system is quarantined */
317 
318 /*
319  * Flags set by internal operations.
320  */
321 #define MNT_LOCAL       0x00001000      /* filesystem is stored locally */
322 #define MNT_QUOTA       0x00002000      /* quotas are enabled on filesystem */
323 #define MNT_ROOTFS      0x00004000      /* identifies the root filesystem */
324 #define MNT_DOVOLFS     0x00008000      /* FS supports volfs (deprecated flag in Mac OS X 10.5) */
325 
326 
327 #define MNT_DONTBROWSE  0x00100000      /* file system is not appropriate path to user data */
328 #define MNT_IGNORE_OWNERSHIP 0x00200000 /* VFS will ignore ownership information on filesystem objects */
329 #define MNT_AUTOMOUNTED 0x00400000      /* filesystem was mounted by automounter */
330 #define MNT_JOURNALED   0x00800000      /* filesystem is journaled */
331 #define MNT_NOUSERXATTR 0x01000000      /* Don't allow user extended attributes */
332 #define MNT_DEFWRITE    0x02000000      /* filesystem should defer writes */
333 #define MNT_MULTILABEL  0x04000000      /* MAC support for individual labels */
334 #define MNT_NOFOLLOW    0x08000000      /* don't follow symlink when resolving mount point */
335 #define MNT_NOATIME             0x10000000      /* disable update of file access time */
336 #define MNT_SNAPSHOT    0x40000000 /* The mount is a snapshot */
337 #define MNT_STRICTATIME 0x80000000      /* enable strict update of file access time */
338 #ifdef BSD_KERNEL_PRIVATE
339 /* #define MNT_IMGSRC_BY_INDEX 0x20000000 see sys/imgsrc.h */
340 #endif /* BSD_KERNEL_PRIVATE */
341 
342 /* backwards compatibility only */
343 #define MNT_UNKNOWNPERMISSIONS MNT_IGNORE_OWNERSHIP
344 
345 
346 /*
347  * XXX I think that this could now become (~(MNT_CMDFLAGS))
348  * but the 'mount' program may need changing to handle this.
349  */
350 #define MNT_VISFLAGMASK (MNT_RDONLY	| MNT_SYNCHRONOUS | MNT_NOEXEC	| \
351 	                MNT_NOSUID	| MNT_NODEV	| MNT_UNION	| \
352 	                MNT_ASYNC	| MNT_EXPORTED	| MNT_QUARANTINE | \
353 	                MNT_LOCAL	| MNT_QUOTA | MNT_REMOVABLE | \
354 	                MNT_ROOTFS	| MNT_DOVOLFS	| MNT_DONTBROWSE | \
355 	                MNT_IGNORE_OWNERSHIP | MNT_AUTOMOUNTED | MNT_JOURNALED | \
356 	                MNT_NOUSERXATTR | MNT_DEFWRITE	| MNT_MULTILABEL | \
357 	                MNT_NOFOLLOW | MNT_NOATIME | MNT_STRICTATIME | \
358 	                MNT_SNAPSHOT | MNT_CPROTECT)
359 /*
360  * External filesystem command modifier flags.
361  * Unmount can use the MNT_FORCE flag.
362  * XXX These are not STATES and really should be somewhere else.
363  * External filesystem control flags.
364  */
365 #define MNT_UPDATE      0x00010000      /* not a real mount, just an update */
366 #define MNT_NOBLOCK     0x00020000      /* don't block unmount if not responding */
367 #define MNT_RELOAD      0x00040000      /* reload filesystem data */
368 #define MNT_FORCE       0x00080000      /* force unmount or readonly change */
369 #define MNT_CMDFLAGS    (MNT_UPDATE|MNT_NOBLOCK|MNT_RELOAD|MNT_FORCE)
370 
371 
372 
373 /*
374  * Sysctl CTL_VFS definitions.
375  *
376  * Second level identifier specifies which filesystem. Second level
377  * identifier VFS_GENERIC returns information about all filesystems.
378  */
379 #define VFS_GENERIC             0       /* generic filesystem information */
380 #define VFS_NUMMNTOPS           1       /* int: total num of vfs mount/unmount operations */
381 /*
382  * Third level identifiers for VFS_GENERIC are given below; third
383  * level identifiers for specific filesystems are given in their
384  * mount specific header files.
385  */
386 #define VFS_MAXTYPENUM  1       /* int: highest defined filesystem type */
387 #define VFS_CONF        2       /* struct: vfsconf for filesystem given
388 	                         *  as next argument */
389 
390 /*
391  * Flags for various system call interfaces.
392  *
393  * waitfor flags to vfs_sync() and getfsstat()
394  */
395 #define MNT_WAIT        1       /* synchronized I/O file integrity completion */
396 #define MNT_NOWAIT      2       /* start all I/O, but do not wait for it */
397 #define MNT_DWAIT       4       /* synchronized I/O data integrity completion */
398 #ifdef KERNEL
399 /* only for VFS_SYNC */
400 #define MNT_VOLUME      8       /* sync on a single mounted filesystem  */
401 #endif
402 
403 
404 #if !defined(KERNEL) && !defined(_KERN_SYS_KERNELTYPES_H_) /* also defined in kernel_types.h */
405 struct mount;
406 typedef struct mount * mount_t;
407 struct vnode;
408 typedef struct vnode * vnode_t;
409 #endif
410 
411 /* Reserved fields preserve binary compatibility */
412 struct vfsconf {
413 	uint32_t vfc_reserved1;         /* opaque */
414 	char    vfc_name[MFSNAMELEN];   /* filesystem type name */
415 	int     vfc_typenum;            /* historic filesystem type number */
416 	int     vfc_refcount;           /* number mounted of this type */
417 	int     vfc_flags;              /* permanent flags */
418 	uint32_t vfc_reserved2;         /* opaque */
419 	uint32_t vfc_reserved3;         /* opaque */
420 };
421 
422 struct vfsidctl {
423 	int             vc_vers;        /* should be VFSIDCTL_VERS1 (below) */
424 	fsid_t          vc_fsid;        /* fsid to operate on. */
425 	void            *vc_ptr;        /* pointer to data structure. */
426 	size_t          vc_len;         /* sizeof said structure. */
427 	u_int32_t       vc_spare[12];   /* spare (must be zero). */
428 };
429 
430 
431 /* vfsidctl API version. */
432 #define VFS_CTL_VERS1   0x01
433 
434 #ifdef KERNEL
435 struct user_vfsidctl {
436 	int                              vc_vers;       /* should be VFSIDCTL_VERS1 (below) */
437 	fsid_t                   vc_fsid;               /* fsid to operate on. */
438 	user_addr_t              vc_ptr __attribute((aligned(8)));      /* pointer to data structure. */
439 	user_size_t              vc_len;                /* sizeof said structure. */
440 	u_int32_t                vc_spare[12];  /* spare (must be zero). */
441 };
442 
443 struct user32_vfsidctl {
444 	int                              vc_vers;       /* should be VFSIDCTL_VERS1 (below) */
445 	fsid_t                   vc_fsid;               /* fsid to operate on. */
446 	user32_addr_t    vc_ptr;                /* pointer to data structure. */
447 	user32_size_t    vc_len;                /* sizeof said structure. */
448 	u_int32_t                vc_spare[12];  /* spare (must be zero). */
449 };
450 
451 union union_vfsidctl { /* the fields vc_vers and vc_fsid are compatible */
452 	struct user32_vfsidctl vc32;
453 	struct user_vfsidctl vc64;
454 };
455 
456 #endif /* KERNEL */
457 
458 /*
459  * New style VFS sysctls, do not reuse/conflict with the namespace for
460  * private sysctls.
461  */
462 #define VFS_CTL_OSTATFS 0x00010001      /* old legacy statfs */
463 #define VFS_CTL_UMOUNT  0x00010002      /* unmount */
464 #define VFS_CTL_QUERY   0x00010003      /* anything wrong? (vfsquery) */
465 #define VFS_CTL_NEWADDR 0x00010004      /* reconnect to new address */
466 #define VFS_CTL_TIMEO   0x00010005      /* set timeout for vfs notification */
467 #define VFS_CTL_NOLOCKS 0x00010006      /* disable file locking */
468 #define VFS_CTL_SADDR   0x00010007      /* get server address */
469 #define VFS_CTL_DISC    0x00010008      /* server disconnected */
470 #define VFS_CTL_SERVERINFO  0x00010009  /* information about fs server */
471 #define VFS_CTL_NSTATUS 0x0001000A      /* netfs mount status */
472 #define VFS_CTL_STATFS64 0x0001000B     /* statfs64 */
473 
474 #ifndef KERNEL
475 /*
476  * Automatically select the correct VFS_CTL_*STATFS* flavor based
477  * on what "struct statfs" layout the client will use.
478  */
479 #if __DARWIN_64_BIT_INO_T
480 #define VFS_CTL_STATFS  VFS_CTL_STATFS64
481 #else
482 #define VFS_CTL_STATFS  VFS_CTL_OSTATFS
483 #endif
484 #endif /* ! KERNEL */
485 
486 struct vfsquery {
487 	u_int32_t       vq_flags;
488 	u_int32_t       vq_spare[31];
489 };
490 
491 struct vfs_server {
492 	int32_t  vs_minutes;                    /* minutes until server goes down. */
493 	u_int8_t vs_server_name[MAXHOSTNAMELEN * 3]; /* UTF8 server name to display (null terminated) */
494 };
495 
496 /*
497  * NetFS mount status - returned by VFS_CTL_NSTATUS
498  */
499 struct netfs_status {
500 	u_int32_t       ns_status;              // Current status of mount (vfsquery flags)
501 	char            ns_mountopts[512];      // Significant mount options
502 	uint32_t        ns_waittime;            // Time waiting for reply (sec)
503 	uint32_t        ns_threadcount;         // Number of threads blocked on network calls
504 	uint64_t        ns_threadids[0];        // Thread IDs of those blocked threads
505 };
506 
507 /* vfsquery flags */
508 #define VQ_NOTRESP      0x0001  /* server down */
509 #define VQ_NEEDAUTH     0x0002  /* server bad auth */
510 #define VQ_LOWDISK      0x0004  /* we're low on space */
511 #define VQ_MOUNT        0x0008  /* new filesystem arrived */
512 #define VQ_UNMOUNT      0x0010  /* filesystem has left */
513 #define VQ_DEAD         0x0020  /* filesystem is dead, needs force unmount */
514 #define VQ_ASSIST       0x0040  /* filesystem needs assistance from external program */
515 #define VQ_NOTRESPLOCK  0x0080  /* server lockd down */
516 #define VQ_UPDATE       0x0100  /* filesystem information has changed */
517 #define VQ_VERYLOWDISK  0x0200  /* file system has *very* little disk space left */
518 #define VQ_SYNCEVENT    0x0400  /* a sync just happened (not set by kernel starting Mac OS X 10.9) */
519 #define VQ_SERVEREVENT  0x0800  /* server issued notification/warning */
520 #define VQ_QUOTA        0x1000  /* a user quota has been hit */
521 #define VQ_NEARLOWDISK          0x2000  /* Above lowdisk and below desired disk space */
522 #define VQ_DESIRED_DISK         0x4000  /* the desired disk space */
523 #define VQ_FREE_SPACE_CHANGE    0x8000  /* free disk space has significantly changed */
524 #define VQ_FLAG10000    0x10000  /* placeholder */
525 
526 
527 #ifdef KERNEL
528 
529 /* Structure for setting device IO parameters per mount point */
530 struct vfsioattr {
531 	u_int32_t       io_maxreadcnt;          /* Max. byte count for read */
532 	u_int32_t       io_maxwritecnt;         /* Max. byte count for write */
533 	u_int32_t       io_segreadcnt;          /* Max. segment count for read */
534 	u_int32_t       io_segwritecnt;         /* Max. segment count for write */
535 	u_int32_t       io_maxsegreadsize;      /* Max. segment read size  */
536 	u_int32_t       io_maxsegwritesize;     /* Max. segment write size */
537 	u_int32_t       io_devblocksize;        /* the underlying device block size */
538 	u_int32_t       io_flags;                       /* flags for underlying device */
539 	union {
540 		int64_t io_max_swappin_available;
541 		// On 32 bit architectures, we don't have any spare
542 		void *io_reserved[2];
543 	};
544 };
545 
546 #define VFS_IOATTR_FLAGS_FUA                            0x00000001      /* Write-through cache supported */
547 #define VFS_IOATTR_FLAGS_UNMAP                          0x00000002      /* Unmap (trim) supported */
548 #define VFS_IOATTR_FLAGS_SWAPPIN_SUPPORTED      0x00000010      /* Pinning swap file supported */
549 
550 /*
551  * Filesystem Registration information
552  */
553 #define VFS_TBLTHREADSAFE               0x0001  /* Only threadsafe filesystems are supported */
554 #define VFS_TBLFSNODELOCK               0x0002  /* Only threadsafe filesystems are supported */
555 #define VFS_TBLNOTYPENUM                0x0008
556 #define VFS_TBLLOCALVOL                 0x0010
557 #define VFS_TBL64BITREADY               0x0020
558 #define VFS_TBLNATIVEXATTR              0x0040
559 #define VFS_TBLDIRLINKS                 0x0080
560 #define VFS_TBLUNMOUNT_PREFLIGHT        0x0100  /* does a preflight check before unmounting */
561 #define VFS_TBLGENERICMNTARGS           0x0200  /* force generic mount args for local fs */
562 #define VFS_TBLREADDIR_EXTENDED         0x0400  /* fs supports VNODE_READDIR_EXTENDED */
563 #define VFS_TBLNOMACLABEL               0x1000
564 #define VFS_TBLVNOP_PAGEINV2            0x2000
565 #define VFS_TBLVNOP_PAGEOUTV2           0x4000
566 #define VFS_TBLVNOP_NOUPDATEID_RENAME   0x8000  /* vfs should not call vnode_update_ident on rename */
567 #define VFS_TBLVNOP_SECLUDE_RENAME      0x10000
568 #define VFS_TBLCANMOUNTROOT             0x20000
569 
570 
571 struct vfs_fsentry {
572 	struct vfsops * vfe_vfsops;     /* vfs operations */
573 	int             vfe_vopcnt;     /* # of vnodeopv_desc being registered (reg, spec, fifo ...) */
574 	struct vnodeopv_desc ** vfe_opvdescs; /* null terminated;  */
575 	int                     vfe_fstypenum;  /* historic filesystem type number */
576 	char            vfe_fsname[MFSNAMELEN]; /* filesystem type name */
577 	uint32_t        vfe_flags;              /* defines the FS capabilities */
578 	void *              vfe_reserv[2];/* reserved for future use; set this to zero*/
579 };
580 
581 
582 
583 struct vfsops {
584 	/*!
585 	 *  @field vfs_mount
586 	 *  @abstract Perform filesystem-specific operations required for mounting.
587 	 *  @discussion Typical operations include setting the mount-specific data with vfs_setfsprivate().
588 	 *  Note that if a mount call fails, the filesystem must clean up any state it has constructed, because
589 	 *  vfs-level mount code will not clean it up.
590 	 *  @param mp Mount structure for the newly mounted filesystem.
591 	 *  @param devvp Device that the filesystem is mounted from.
592 	 *  @param data Filesystem-specific data passed down from userspace.
593 	 *  @param context Context to authenticate for mount.
594 	 *  @return 0 for success, else an error code.  Once success is returned, the filesystem should be ready to go active;
595 	 *  VFS will not ask again.
596 	 */
597 	int  (*vfs_mount)(struct mount *mp, vnode_t devvp, user_addr_t data, vfs_context_t context);
598 
599 	/*!
600 	 *  @field vfs_start
601 	 *  @abstract Mark a mount as ready to be used.
602 	 *  @discussion After receiving this calldown, a filesystem will be hooked into the mount list and should expect
603 	 *  calls down from the VFS layer.
604 	 *  @param mp Mount structure being activated.
605 	 *  @param flags Unused.
606 	 *  @param context Context to authenticate for mount.
607 	 *  @return Return value is ignored.
608 	 */
609 	int  (*vfs_start)(struct mount *mp, int flags, vfs_context_t context);
610 
611 	/*!
612 	 *  @field vfs_unmount
613 	 *  @abstract Perform filesystem-specific cleanup as part of unmount.
614 	 *  @discussion If the unmount downcall succeeds, VFS considers itself authorized to destroy all
615 	 *  state related to the mount.
616 	 *  @param mp Mount structure to unmount.
617 	 *  @param mntflags MNT_FORCE indicates that we wish to unmount even if there are active vnodes.
618 	 *  @param context Context to authenticate for unmount.
619 	 *  @return 0 for success, else an error code.
620 	 */
621 	int  (*vfs_unmount)(struct mount *mp, int mntflags, vfs_context_t context);
622 
623 	/*!
624 	 *  @field vfs_root
625 	 *  @abstract Get the root vnode of a filesystem.
626 	 *  @discussion Upon success, should return with an iocount held on the root vnode which the caller will
627 	 *  drop with vnode_put().
628 	 *  @param mp Mount for which to get the root.
629 	 *  @param vpp Destination for root vnode.
630 	 *  @param context Context to authenticate for getting the root.
631 	 *  @return 0 for success, else an error code.
632 	 */
633 	int  (*vfs_root)(struct mount *mp, struct vnode **vpp, vfs_context_t context);
634 
635 	/*!
636 	 *  @field vfs_quotactl
637 	 *  @abstract Manipulate quotas for a volume.
638 	 *  @param mp Mount for which to manipulate quotas.
639 	 *  @param cmds Detailed in "quotactl" manual page.
640 	 *  @param uid Detailed in "quotactl" manual page.
641 	 *  @param arg Detailed in "quotactl" manual page.
642 	 *  @param context Context to authenticate for changing quotas.
643 	 *  @return 0 for success, else an error code.
644 	 */
645 	int  (*vfs_quotactl)(struct mount *mp, int cmds, uid_t uid, caddr_t arg, vfs_context_t context);
646 
647 	/*!
648 	 *  @field vfs_getattr
649 	 *  @abstract Get filesystem attributes.
650 	 *  @discussion See VFSATTR_RETURN, VFSATTR_ACTIVE, VFSATTR_SET_SUPPORTED, VFSATTR_WANTED macros.
651 	 *  @param mp Mount for which to get parameters.
652 	 *  @param vfa Container for specifying which attributes are desired and which attributes the filesystem
653 	 *  supports, as well as for returning results.
654 	 *  @param context Context to authenticate for getting filesystem attributes.
655 	 *  @return 0 for success, else an error code.
656 	 */
657 	int  (*vfs_getattr)(struct mount *mp, struct vfs_attr *vfa, vfs_context_t context);
658 /*	int  (*vfs_statfs)(struct mount *mp, struct vfsstatfs *sbp, vfs_context_t context);*/
659 
660 	/*!
661 	 *  @field vfs_sync
662 	 *  @abstract Flush all filesystem data to backing store.
663 	 *  @discussion vfs_sync will be called as part of the sync() system call and during unmount.
664 	 *  @param mp Mountpoint to sync.
665 	 *  @param waitfor MNT_WAIT: flush synchronously, waiting for all data to be written before returning. MNT_NOWAIT: start I/O but do not wait for it.
666 	 *  @param context Context to authenticate for the sync.
667 	 *  @return 0 for success, else an error code.
668 	 */
669 	int  (*vfs_sync)(struct mount *mp, int waitfor, vfs_context_t context);
670 
671 	/*!
672 	 *  @field vfs_vget
673 	 *  @abstract Get a vnode by file id (inode number).
674 	 *  @discussion This routine is chiefly used to build paths to vnodes.  Result should be turned with an iocount that the
675 	 *  caller will drop with vnode_put().
676 	 *  @param mp Mount against which to look up inode number.
677 	 *  @param ino File ID for desired file, as found through a readdir.
678 	 *  @param vpp Destination for vnode.
679 	 *  @return 0 for success, else an error code.
680 	 */
681 	int  (*vfs_vget)(struct mount *mp, ino64_t ino, struct vnode **vpp, vfs_context_t context);
682 
683 	/*!
684 	 *  @field vfs_fhtovp
685 	 *  @abstract Get the vnode corresponding to a file handle.
686 	 *  @discussion Filesystems can return handles to files which are independent of their (transient) vnode identities.
687 	 *  vfs_thtovp converts that persistent handle back to a vnode.  The vnode should be returned with an iocount which
688 	 *  the caller will drop with vnode_put().
689 	 *  @param mp Mount against which to look up file handle.
690 	 *  @param fhlen Size of file handle structure, as returned by vfs_vptofh.
691 	 *  @param fhp Pointer to handle.
692 	 *  @param vpp Destination for vnode.
693 	 *  @param context Context against which to authenticate the file-handle conversion.
694 	 *  @return 0 for success, else an error code.
695 	 */
696 	int  (*vfs_fhtovp)(struct mount *mp, int fhlen, unsigned char *fhp, struct vnode **vpp,
697 	    vfs_context_t context);
698 
699 	/*!
700 	 *  @field vfs_vptofh
701 	 *  @abstract Get a persistent handle corresponding to a vnode.
702 	 *  @param vp Vnode against which to obtain the file-handle
703 	 *  @param fhlen Size of buffer provided for handle; set to size of actual handle returned.
704 	 *  @param fhp Pointer to buffer in which to place handle data.
705 	 *  @param context Context against which to authenticate the file-handle request.
706 	 *  @return 0 for success, else an error code.
707 	 */
708 	int  (*vfs_vptofh)(struct vnode *vp, int *fhlen, unsigned char *fhp, vfs_context_t context);
709 
710 	/*!
711 	 *  @field vfs_init
712 	 *  @abstract Prepare a filesystem for having instances mounted.
713 	 *  @discussion This routine is called once, before any particular instance of a filesystem
714 	 *  is mounted; it allows the filesystem to initialize whatever global data structures
715 	 *  are shared across all mounts.  If this returns successfully, a filesystem should be ready to have
716 	 *  instances mounted.
717 	 *  @param vfsc Configuration information.  Currently, the only useful data are the filesystem name,
718 	 *  typenum, and flags.  The flags field will be either 0 or MNT_LOCAL.  Many filesystems ignore this
719 	 *  parameter.
720 	 *  @return 0 for success, else an error code.
721 	 */
722 	int  (*vfs_init)(struct vfsconf *vfsc);
723 
724 	/*!
725 	 *  @field vfs_sysctl
726 	 *  @abstract Broad interface for querying and controlling filesystem.
727 	 *  @discussion VFS defines VFS_CTL_QUERY as a generic status request which is answered
728 	 *  with the VQ_* macros in a "struct vfsquery."
729 	 *  A filesystem may also define implementation-specific commands.  See "man 3 sysctl"
730 	 *  for the meaning of sysctl parameters.
731 	 *  @param context Context against which to authenticate command.
732 	 *  @return 0 for success, else an error code.
733 	 */
734 	int  (*vfs_sysctl)(int *, u_int, user_addr_t, size_t *, user_addr_t, size_t, vfs_context_t context);
735 
736 	/*!
737 	 *  @field vfs_setattr
738 	 *  @abstract Set filesystem attributes.
739 	 *  @discussion The other side of the vfs_getattr coin.  Currently only called to set volume name.
740 	 *  @param mp Mount on which to set attributes.
741 	 *  @param vfa VFS attribute structure containing requested attributes to set and their values.  Currently
742 	 *  will only be called with f_vol_name set.
743 	 *  @param context Context against which to authenticate attribute change.
744 	 *  @return 0 for success, else an error code.
745 	 */
746 	int  (*vfs_setattr)(struct mount *mp, struct vfs_attr *vfa, vfs_context_t context);
747 
748 	/*!
749 	 *  @field vfs_ioctl
750 	 *  @abstract File system control operations.
751 	 *  @discussion  Unlike vfs_sysctl, this is specific to a particular volume.
752 	 *  @param mp The mount to execute the command on.
753 	 *  @param command Identifier for action to take.  The command used here
754 	 *  should be in the same namespace as VNOP ioctl commands.
755 	 *  @param data Pointer to data; this can be an integer constant (of 32 bits
756 	 *  only) or an address to be read from or written to, depending on "command."
757 	 *  If it is an address, it is valid and resides in the kernel; callers of
758 	 *  VFS_IOCTL() are responsible for copying to and from userland.
759 	 *  @param flags Reserved for future use, set to zero
760 	 *  @param context Context against which to authenticate ioctl request.
761 	 *  @return 0 for success, else an error code.
762 	 */
763 	int  (*vfs_ioctl)(struct mount *mp, u_long command, caddr_t data,
764 	    int flags, vfs_context_t context);
765 
766 	/*!
767 	 *  @field vfs_vget_snapdir
768 	 *  @abstract Get the vnode for the snapshot directory of a filesystem.
769 	 *  @discussion Upon success, should return with an iocount held on the root vnode which the caller will
770 	 *  drop with vnode_put().
771 	 *  @param mp Mount for which to get the root.
772 	 *  @param vpp Destination for snapshot directory vnode.
773 	 *  @param context Context to authenticate for getting the snapshot directory.
774 	 *  @return 0 for success, else an error code.
775 	 */
776 	int  (*vfs_vget_snapdir)(struct mount *mp, struct vnode **vpp, vfs_context_t context);
777 	void *vfs_reserved5;
778 	void *vfs_reserved4;
779 	void *vfs_reserved3;
780 	void *vfs_reserved2;
781 	void *vfs_reserved1;
782 };
783 
784 #ifdef KERNEL
785 
786 /*
787  * Commands for vfs_ioctl. While they are encoded the same way as for ioctl(2),
788  * there is no generic interface for them from userspace like ioctl(2).
789  */
790 struct fs_snapshot_mount_args {
791 	mount_t sm_mp;
792 	struct componentname *sm_cnp;
793 };
794 
795 #define VFSIOC_MOUNT_SNAPSHOT  _IOW('V', 1, struct fs_snapshot_mount_args)
796 
797 struct fs_snapshot_revert_args {
798 	struct componentname *sr_cnp;
799 };
800 #define VFSIOC_REVERT_SNAPSHOT  _IOW('V', 2, struct fs_snapshot_revert_args)
801 
802 struct fs_snapshot_root_args {
803 	struct componentname *sr_cnp;
804 };
805 #define VFSIOC_ROOT_SNAPSHOT  _IOW('V', 3, struct fs_snapshot_root_args)
806 
807 typedef struct fs_role_mount_args {
808 	mount_t root_mp;
809 	uint32_t mount_role;
810 } fs_role_mount_args_t;
811 
812 OS_ENUM(vfs_roles, uint32_t,
813     VFS_SYSTEM_ROLE = 1,
814     VFS_RECOVERY_ROLE = 4,
815     VFS_VM_ROLE = 8,
816     VFS_PREBOOT_ROLE = 16,
817     VFS_DATA_ROLE = 64);
818 
819 #define VFSIOC_MOUNT_BYROLE  _IOW('V', 4, fs_role_mount_args_t)
820 
821 // When this is defined, it is safe to use VFS_RECOVERY_ROLE and
822 // VFS_PREBOOT_ROLE.
823 #define VFSIOC_MOUNT_BYROLE_has_recovery 1
824 
825 #endif /* KERNEL */
826 
827 /*
828  * flags passed into vfs_iterate
829  */
830 #ifdef PRIVATE
831 #define VFS_ITERATE_TAIL_FIRST  (1 << 0)
832 #define VFS_ITERATE_CB_DROPREF  (1 << 1)        // Callback will drop the iterref
833 #define VFS_ITERATE_NOSKIP_UNMOUNT  (1 << 2)    /* Callback will be made on FS in unmount.
834 	                                        * The callback cannot make any calls
835 	                                        * into the Filesystem when this is set. */
836 #endif /* PRIVATE */
837 
838 /*
839  * return values from callback
840  */
841 #define VFS_RETURNED            0       /* done with vnode, reference can be dropped */
842 #define VFS_RETURNED_DONE       1       /* done with vnode, reference can be dropped, terminate iteration */
843 #define VFS_CLAIMED             2       /* don't drop reference */
844 #define VFS_CLAIMED_DONE        3       /* don't drop reference, terminate iteration */
845 
846 
847 __BEGIN_DECLS
848 #ifdef BSD_KERNEL_PRIVATE
849 extern int VFS_MOUNT(mount_t, vnode_t, user_addr_t, vfs_context_t);
850 extern int VFS_START(mount_t, int, vfs_context_t);
851 extern int VFS_UNMOUNT(mount_t, int, vfs_context_t);
852 extern int VFS_ROOT(mount_t, vnode_t *, vfs_context_t);
853 extern int VFS_QUOTACTL(mount_t, int, uid_t, caddr_t, vfs_context_t);
854 extern int VFS_GETATTR(mount_t, struct vfs_attr *, vfs_context_t);
855 extern int VFS_SETATTR(mount_t, struct vfs_attr *, vfs_context_t);
856 extern int VFS_SYNC(mount_t, int, vfs_context_t);
857 extern int VFS_VGET(mount_t, ino64_t, vnode_t *, vfs_context_t);
858 extern int VFS_FHTOVP(mount_t, int, unsigned char *, vnode_t *, vfs_context_t);
859 extern int VFS_VPTOFH(vnode_t, int *, unsigned char *, vfs_context_t);
860 extern int VFS_IOCTL(mount_t mp, u_long command, caddr_t data,
861     int flags, vfs_context_t context);
862 extern int VFS_VGET_SNAPDIR(mount_t, vnode_t *, vfs_context_t);
863 #endif /* BSD_KERNEL_PRIVATE */
864 /*
865  * prototypes for exported VFS operations
866  */
867 
868 /*!
869  *  @function vfs_fsadd
870  *  @abstract Register a filesystem with VFS.
871  *  @discussion Typically called by a filesystem Kernel Extension when it is loaded.
872  *  @param vfe Filesystem information: table of vfs operations, list of vnode operation tables,
873  *  filesystem type number (can be omitted with VFS_TBLNOTYPENUM flag), name, flags.
874  *  @param handle Opaque handle which will be passed to vfs_fsremove.
875  *  @return 0 for success, else an error code.
876  */
877 int vfs_fsadd(struct vfs_fsentry *vfe, vfstable_t *handle);
878 
879 /*!
880  *  @function vfs_fsremove
881  *  @abstract Unregister a filesystem with VFS.
882  *  @discussion Typically called by a filesystem Kernel Extension when it is unloaded.
883  *  @param handle Handle which was returned by vfs_fsadd.
884  *  @return 0 for success, else an error code.
885  */
886 int vfs_fsremove(vfstable_t handle);
887 
888 /*!
889  *  @function vfs_iterate
890  *  @abstract Iterate over all mountpoints with a callback.  Used, for example, by sync().
891  *  @param flags Unused.
892  *  @param callout Function which takes a mount and arbitrary passed-in "arg," and returns one of VFS_RETURNED_DONE or VFS_CLAIMED_DONE: end
893  *  iteration and return success.  VFS_RETURNED or VFS_CLAIMED: continue iterating. Anything else: continue iterating.
894  *  @param arg Arbitrary data to pass to callback.
895  *  @return 0 for success, else an error code.
896  */
897 int     vfs_iterate(int flags, int (*callout)(struct mount *, void *), void *arg);
898 
899 /*!
900  *  @function vfs_init_io_attributes
901  *  @abstract Set I/O attributes on a mountpoint based on device properties.
902  *  @param devvp Block device vnode from which a filesystem is being mounted.
903  *  @param mp Mountpoint whose I/O parameters to initialize.
904  *  @return 0 for success, else an error code.
905  */
906 int     vfs_init_io_attributes(vnode_t devvp, mount_t mp);
907 
908 /*!
909  *  @function vfs_flags
910  *  @abstract Retrieve mount flags.
911  *  @discussion Results will be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS.
912  *  @param mp Mount whose flags to grab.
913  *  @return Flags.
914  */
915 uint64_t vfs_flags(mount_t mp);
916 
917 /*!
918  *  @function vfs_setflags
919  *  @abstract Set flags on a mount.
920  *  @discussion Sets mount flags to the bitwise "OR" of their current value and the specified bits. Often
921  *  used by a filesystem as part of the mount process.
922  *  @param mp Mount whose flags to set.
923  *  @param flags Flags to activate.  Must be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS.
924  */
925 void    vfs_setflags(mount_t mp, uint64_t flags);
926 
927 /*!
928  *  @function vfs_clearflags
929  *  @abstract Clear flags on a mount.
930  *  @discussion Sets mount flags to the bitwise "AND" of their current value and the complement of the specified bits.
931  *  @param mp Mount whose flags to set.
932  *  @param flags Flags to deactivate.  Must be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS.
933  */
934 void    vfs_clearflags(mount_t mp, uint64_t flags);
935 
936 /*!
937  *  @function vfs_issynchronous
938  *  @abstract Determine if writes to a filesystem occur synchronously.
939  *  @param mp Mount to test.
940  *  @return Nonzero if writes occur synchronously, else 0.
941  */
942 int     vfs_issynchronous(mount_t mp);
943 
944 /*!
945  *  @function vfs_iswriteupgrade
946  *  @abstract Determine if a filesystem is mounted read-only but a request has been made to upgrade
947  *  to read-write.
948  *  @param mp Mount to test.
949  *  @return Nonzero if a request has been made to update from read-only to read-write, else 0.
950  */
951 int     vfs_iswriteupgrade(mount_t mp);
952 
953 /*!
954  *  @function vfs_isupdate
955  *  @abstract Determine if a mount update is in progress.
956  *  @param mp Mount to test.
957  *  @return Nonzero if a mount update is in progress, 0 otherwise.
958  */
959 int     vfs_isupdate(mount_t mp);
960 
961 /*!
962  *  @function vfs_isreload
963  *  @abstract Determine if a reload of filesystem data is in progress.  This can only be the case
964  *  for a read-only filesystem; all data is brought in from secondary storage.
965  *  @param mp Mount to test.
966  *  @return Nonzero if a request has been made to reload data, else 0.
967  */
968 int     vfs_isreload(mount_t mp);
969 
970 /*!
971  *  @function vfs_isforce
972  *  @abstract Determine if a forced unmount is in progress.
973  *  @discussion A forced unmount invalidates open files.
974  *  @param mp Mount to test.
975  *  @return Nonzero if a request has been made to forcibly unmount, else 0.
976  */
977 int     vfs_isforce(mount_t mp);
978 
979 /*!
980  *  @function vfs_isunmount
981  *  @abstract Determine if an unmount is in progress.
982  *  @discussion This is an unsynchronized snapshot of the mount state.  It should only be called
983  *  if the mount is known to be valid, e.g. there are known to be live files on that volume.
984  *  @param mp Mount to test.
985  *  @return Nonzero if an unmount is in progress, else zero.
986  */
987 int     vfs_isunmount(mount_t mp);
988 
989 /*!
990  *  @function vfs_isrdonly
991  *  @abstract Determine if a filesystem is mounted read-only.
992  *  @param mp Mount to test.
993  *  @return Nonzero if filesystem is mounted read-only, else 0.
994  */
995 int     vfs_isrdonly(mount_t mp);
996 
997 /*!
998  *  @function vfs_isrdwr
999  *  @abstract Determine if a filesystem is mounted with writes enabled.
1000  *  @param mp Mount to test.
1001  *  @return Nonzero if filesystem is mounted read-write, else 0.
1002  */
1003 int     vfs_isrdwr(mount_t mp);
1004 
1005 /*!
1006  *  @function vfs_authopaque
1007  *  @abstract Determine if a filesystem's authorization decisions occur remotely.
1008  *  @param mp Mount to test.
1009  *  @return Nonzero if filesystem authorization is controlled remotely, else 0.
1010  */
1011 int     vfs_authopaque(mount_t mp);
1012 
1013 /*!
1014  *  @function vfs_authopaqueaccess
1015  *  @abstract Check if a filesystem is marked as having reliable remote VNOP_ACCESS support.
1016  *  @param mp Mount to test.
1017  *  @return Nonzero if VNOP_ACCESS is supported remotely, else 0.
1018  */
1019 int     vfs_authopaqueaccess(mount_t mp);
1020 
1021 /*!
1022  *  @function vfs_setauthopaque
1023  *  @abstract Mark a filesystem as having authorization decisions controlled remotely.
1024  *  @param mp Mount to mark.
1025  */
1026 void    vfs_setauthopaque(mount_t mp);
1027 
1028 /*!
1029  *  @function vfs_setauthopaqueaccess
1030  *  @abstract Mark a filesystem as having remote VNOP_ACCESS support.
1031  *  @param mp Mount to mark.
1032  */
1033 void    vfs_setauthopaqueaccess(mount_t mp);
1034 
1035 /*!
1036  *  @function vfs_clearauthopaque
1037  *  @abstract Mark a filesystem as not having remote authorization decisions.
1038  *  @param mp Mount to mark.
1039  */
1040 void    vfs_clearauthopaque(mount_t mp);
1041 
1042 /*!
1043  *  @function vfs_clearauthopaque
1044  *  @abstract Mark a filesystem as not having remote VNOP_ACCESS support.
1045  *  @param mp Mount to mark.
1046  */
1047 void    vfs_clearauthopaqueaccess(mount_t mp);
1048 
1049 /*!
1050  *  @function vfs_setextendedsecurity
1051  *  @abstract Mark a filesystem as supporting security controls beyond POSIX permissions.
1052  *  @discussion Specific controls include ACLs, file owner UUIDs, and group UUIDs.
1053  *  @param mp Mount to test.
1054  */
1055 void    vfs_setextendedsecurity(mount_t mp);
1056 
1057 /*!
1058  *  @function vfs_clearextendedsecurity
1059  *  @abstract Mark a filesystem as NOT supporting security controls beyond POSIX permissions.
1060  *  @discussion Specific controls include ACLs, file owner UUIDs, and group UUIDs.
1061  *  @param mp Mount to test.
1062  */
1063 void    vfs_clearextendedsecurity(mount_t mp);
1064 
1065 /*!
1066  *  @function vfs_setnoswap
1067  *  @abstract Mark a filesystem as unable to use swap files.
1068  *  @param mp Mount to mark.
1069  */
1070 #ifdef KERNEL_PRIVATE
1071 void    vfs_setnoswap(mount_t mp);
1072 #endif
1073 
1074 /*!
1075  *  @function vfs_clearnoswap
1076  *  @abstract Mark a filesystem as capable of using swap files.
1077  *  @param mp Mount to mark.
1078  */
1079 #ifdef KERNEL_PRIVATE
1080 void    vfs_clearnoswap(mount_t mp);
1081 #endif
1082 
1083 /*!
1084  *  @function vfs_setlocklocal
1085  *  @abstract Mark a filesystem as using VFS-level advisory locking support.
1086  *  @discussion Advisory locking operations will not call down to the filesystem if this flag is set.
1087  *  @param mp Mount to mark.
1088  */
1089 void    vfs_setlocklocal(mount_t mp);
1090 
1091 /*!
1092  *  @function vfs_authcache_ttl
1093  *  @abstract Determine the time-to-live of cached authorized credentials for files in this filesystem.
1094  *  @discussion If a filesystem is set to allow caching credentials, the VFS layer can authorize
1095  *  previously-authorized actions from the same vfs_context_t without calling down to the filesystem (though
1096  *  it will not deny based on the cache).
1097  *  @param mp Mount for which to check cache lifetime.
1098  *  @return  Cache lifetime in seconds.  CACHED_RIGHT_INFINITE_TTL indicates that credentials never expire.
1099  */
1100 int     vfs_authcache_ttl(mount_t mp);
1101 
1102 /*!
1103  *  @function vfs_setauthcache_ttl
1104  *  @abstract Enable credential caching and set  time-to-live of cached authorized credentials for files in this filesystem.
1105  *  @discussion If a filesystem is set to allow caching credentials, the VFS layer can authorize
1106  *  previously-authorized actions from the same vfs_context_t without calling down to the filesystem (though
1107  *  it will not deny based on the cache).
1108  *  @param mp Mount for which to set cache lifetime.
1109  */
1110 void    vfs_setauthcache_ttl(mount_t mp, int ttl);
1111 
1112 /*!
1113  *  @function vfs_clearauthcache_ttl
1114  *  @abstract Remove time-to-live controls for cached credentials on a filesytem.  Filesystems with remote authorization
1115  *  decisions (opaque) will still have KAUTH_VNODE_SEARCH rights cached for a default of CACHED_LOOKUP_RIGHT_TTL seconds.
1116  *  @param mp Mount for which to clear cache lifetime.
1117  */
1118 void    vfs_clearauthcache_ttl(mount_t mp);
1119 
1120 /*
1121  * return value from vfs_cachedrights_ttl if
1122  * neither MNTK_AUTH_OPAQUE | MNTK_AUTH_CACHE_TTL
1123  * is set in mnt_kern_flag.. it indicates
1124  * that no TTL is being applied to the vnode rights cache
1125  */
1126 #define CACHED_RIGHT_INFINITE_TTL       ~0
1127 
1128 /*!
1129  *  @function vfs_maxsymlen
1130  *  @abstract Get the maximum length of a symbolic link on a filesystem.
1131  *  @param mp Mount from which to get symlink length cap.
1132  *  @return Max symlink length.
1133  */
1134 uint32_t vfs_maxsymlen(mount_t mp);
1135 
1136 /*!
1137  *  @function vfs_setmaxsymlen
1138  *  @abstract Set the maximum length of a symbolic link on a filesystem.
1139  *  @param mp Mount on which to set symlink length cap.
1140  *  @param symlen Length to set.
1141  */
1142 void    vfs_setmaxsymlen(mount_t mp, uint32_t symlen);
1143 
1144 /*!
1145  *  @function vfs_fsprivate
1146  *  @abstract Get filesystem-private mount data.
1147  *  @discussion A filesystem generally has an internal mount structure which it attaches to the VFS-level mount structure
1148  *  as part of the mounting process.
1149  *  @param mp Mount for which to get private data.
1150  *  @return Private data.
1151  */
1152 void *  vfs_fsprivate(mount_t mp);
1153 
1154 /*!
1155  *  @function vfs_setfsprivate
1156  *  @abstract Set filesystem-private mount data.
1157  *  @discussion A filesystem generally has an internal mount structure which it attaches to the VFS-level mount structure
1158  *  as part of the mounting process.
1159  *  @param mp Mount for which to set private data.
1160  */
1161 void    vfs_setfsprivate(mount_t mp, void *mntdata);
1162 
1163 /*!
1164  *  @function vfs_statfs
1165  *  @abstract Get information about filesystem status.
1166  *  @discussion Each filesystem has a struct vfsstatfs associated with it which is updated as events occur; this function
1167  *  returns a pointer to it.  Note that the data in the structure will continue to change over time and also that it may
1168  *  be quite stale if vfs_update_vfsstat has not been called recently.
1169  *  @param mp Mount for which to get vfsstatfs pointer.
1170  *  @return Pointer to vfsstatfs.
1171  */
1172 struct vfsstatfs *      vfs_statfs(mount_t mp);
1173 #define VFS_USER_EVENT          0
1174 #define VFS_KERNEL_EVENT        1
1175 
1176 /*!
1177  *  @function vfs_update_vfsstat
1178  *  @abstract Update cached filesystem status information in the VFS mount structure.
1179  *  @discussion Each filesystem has a struct vfsstatfs associated with it which is updated as events occur; this function
1180  *  updates it so that the structure pointer returned by vfs_statfs() returns a pointer to fairly recent data.
1181  *  @param mp Mount for which to update cached status information.
1182  *  @param ctx Context to authenticate against for call down to filesystem.
1183  *  @param eventtype VFS_USER_EVENT: need for update is driven by user-level request; perform additional authentication.
1184  *  VFS_KERNEL_EVENT: need for update is driven by in-kernel events.  Skip extra authentication.
1185  *  @return 0 for success, or an error code for authentication failure or problem with call to filesystem to
1186  *  request information.
1187  */
1188 int     vfs_update_vfsstat(mount_t mp, vfs_context_t ctx, int eventtype);
1189 
1190 /*!
1191  *  @function vfs_typenum
1192  *  @abstract Get (archaic) filesystem type number.
1193  *  @discussion Filesystem type numbers are an old construct; most filesystems just get a number assigned based on
1194  *  the order in which they are registered with the system.
1195  *  @param mp Mount for which to get type number.
1196  *  @return Type number.
1197  */
1198 int     vfs_typenum(mount_t mp);
1199 
1200 /*!
1201  *  @function vfs_name
1202  *  @abstract Copy filesystem name into a buffer.
1203  *  @discussion Get filesystem name; this refers to the filesystem type of which a mount is an instantiation,
1204  *  rather than a name specific to the mountpoint.
1205  *  @param mp Mount for which to get name.
1206  *  @param buffer Destination for name; length should be at least MFSNAMELEN.
1207  */
1208 void    vfs_name(mount_t mp, char *buffer);
1209 
1210 /*!
1211  *  @function vfs_devblocksize
1212  *  @abstract Get the block size of the device underlying a mount.
1213  *  @param mp Mount for which to get block size.
1214  *  @return Block size.
1215  */
1216 int     vfs_devblocksize(mount_t mp);
1217 
1218 /*!
1219  *  @function vfs_ioattr
1220  *  @abstract Get I/O attributes associated with a mounpoint.
1221  *  @param mp Mount for which to get attributes.  If NULL, system defaults are filled into ioattrp.
1222  *  @param ioattrp Destination for results.
1223  */
1224 void    vfs_ioattr(mount_t mp, struct vfsioattr *ioattrp);
1225 
1226 /*!
1227  *  @function vfs_setioattr
1228  *  @abstract Set I/O attributes associated with a mounpoint.
1229  *  @param mp Mount for which to set attributes.
1230  *  @param ioattrp Structure containing I/O parameters; all fields must be filled in.
1231  */
1232 void    vfs_setioattr(mount_t mp, struct vfsioattr *ioattrp);
1233 
1234 /*!
1235  *  @function vfs_64bitready
1236  *  @abstract Check if the filesystem associated with a mountpoint is marked ready for interaction with 64-bit user processes.
1237  *  @param mp Mount to test.
1238  *  @return Nonzero if filesystem is ready for 64-bit; 0 otherwise.
1239  */
1240 int     vfs_64bitready(mount_t mp);
1241 
1242 
1243 #define LK_NOWAIT 1
1244 /*!
1245  *  @function vfs_busy
1246  *  @abstract "Busy" a mountpoint.
1247  *  @discussion vfs_busy() will "busy" a mountpoint, preventing unmounts from taking off, by taking its reader-writer lock
1248  *  in a shared manner.  If a mount is dead,
1249  *  it will fail; if an unmount is in progress, depending on flags, it will either fail immediately or block
1250  *  until the unmount completes (then failing if the unmount has succeeded, or potentially succeeding if unmounting failed).
1251  *  A successful vfs_busy() must be followed by a vfs_unbusy() to release the lock on the mount.
1252  *  @param mp Mount to busy.
1253  *  @param flags LK_NOWAIT: fail with ENOENT if an unmount is in progress.
1254  *  @return 0 for success, with a lock held; an error code otherwise, with no lock held.
1255  */
1256 int     vfs_busy(mount_t mp, int flags);
1257 
1258 /*!
1259  *  @function vfs_unbusy
1260  *  @abstract "Unbusy" a mountpoint by releasing its read-write lock.
1261  *  @discussion A successful vfs_busy() must be followed by a vfs_unbusy() to release the lock on the mount.
1262  *  @param mp Mount to unbusy.
1263  */
1264 void    vfs_unbusy(mount_t mp);
1265 
1266 /*!
1267  *  @function vfs_getnewfsid
1268  *  @abstract Generate a unique filesystem ID for a mount and store it in the mount structure.
1269  *  @discussion Filesystem IDs are returned as part of "struct statfs."  This function is typically
1270  *  called as part of file-system specific mount code (i.e. through VFS_MOUNT).
1271  *  @param mp Mount to set an ID for.
1272  */
1273 void    vfs_getnewfsid(struct mount *mp);
1274 
1275 /*!
1276  *  @function vfs_getvfs
1277  *  @abstract Given a filesystem ID, look up a mount structure.
1278  *  @param fsid Filesystem ID to look up.
1279  *  @return Mountpoint if found, else NULL.  Note unmounting mountpoints can be returned.
1280  */
1281 mount_t vfs_getvfs(fsid_t *fsid);
1282 
1283 /*!
1284  *  @function vfs_mountedon
1285  *  @abstract Check whether a given block device has a filesystem mounted on it.
1286  *  @discussion Note that this is NOT a check for a covered vnode (the directory upon which
1287  *  a filesystem is mounted)--it is a test for whether a block device is being used as the source
1288  *  of a filesystem.  Note that a block device marked as being mounted on cannot be opened.
1289  *  @param vp The vnode to test.
1290  *  @return EBUSY if vnode is indeed the source of a filesystem; 0 if it is not.
1291  */
1292 int     vfs_mountedon(struct vnode *vp);
1293 
1294 /*!
1295  *  @function vfs_unmountbyfsid
1296  *  @abstract Find a filesystem by ID and unmount it.
1297  *  @param fsid ID of filesystem to unmount, as found through (for example) statfs.
1298  *  @param flags MNT_FORCE: forcibly invalidate files open on the mount (though in-flight I/O operations
1299  *  will be allowed to complete).
1300  *  @param ctx Context against which to authenticate unmount operation.
1301  *  @return 0 for succcess, nonero for failure.
1302  */
1303 int     vfs_unmountbyfsid(fsid_t *fsid, int flags, vfs_context_t ctx);
1304 
1305 /*!
1306  *  @function vfs_event_signal
1307  *  @abstract Post a kqueue-style event on a filesystem (EVFILT_FS).
1308  *  @param fsid Unused.
1309  *  @param event Events to post.
1310  *  @param data Unused.
1311  */
1312 void    vfs_event_signal(fsid_t *fsid, u_int32_t event, intptr_t data);
1313 
1314 /*!
1315  *  @function vfs_event_init
1316  *  @abstract This function should not be called by kexts.
1317  */
1318 void    vfs_event_init(void); /* XXX We should not export this */
1319 
1320 /*!
1321  *  @function vfs_set_root_unmount_cleanly
1322  *  @abstract This function should be called by the root file system
1323  *  when it is being mounted if the file system state is consistent.
1324  */
1325 void vfs_set_root_unmounted_cleanly(void);
1326 
1327 #ifdef KERNEL_PRIVATE
1328 int     vfs_getbyid(fsid_t *fsid, ino64_t ino, vnode_t *vpp, vfs_context_t ctx);
1329 int     vfs_getattr(mount_t mp, struct vfs_attr *vfa, vfs_context_t ctx);
1330 int     vfs_setattr(mount_t mp, struct vfs_attr *vfa, vfs_context_t ctx);
1331 int     vfs_extendedsecurity(mount_t);
1332 mount_t vfs_getvfs_by_mntonname(char *);
1333 vnode_t vfs_vnodecovered(mount_t mp); /* Returns vnode with an iocount that must be released with vnode_put() */
1334 vnode_t vfs_devvp(mount_t mp); /* Please see block comment with implementation */
1335 int vfs_nativexattrs(mount_t mp);  /* whether or not the FS supports EAs natively */
1336 void *  vfs_mntlabel(mount_t mp); /* Safe to cast to "struct label*"; returns "void*" to limit dependence of mount.h on security headers.  */
1337 void    vfs_setcompoundopen(mount_t mp);
1338 uint64_t vfs_throttle_mask(mount_t mp);
1339 int vfs_isswapmount(mount_t mp);
1340 int     vfs_context_dataless_materialization_is_prevented(vfs_context_t);
1341 boolean_t vfs_context_is_dataless_manipulator(vfs_context_t);
1342 boolean_t vfs_context_can_resolve_triggers(vfs_context_t);
1343 boolean_t vfs_context_can_break_leases(vfs_context_t);
1344 void    vfs_setmntsystem(mount_t mp);
1345 void    vfs_setmntsystemdata(mount_t mp);
1346 void    vfs_setmntswap(mount_t mp);
1347 boolean_t vfs_is_basesystem(mount_t mp);
1348 boolean_t vfs_iskernelmount(mount_t mp);
1349 
1350 boolean_t vfs_shutdown_in_progress(void);
1351 boolean_t vfs_shutdown_finished(void);
1352 void    vfs_update_last_completion_time(void);
1353 uint64_t vfs_last_completion_time(void);
1354 
1355 OS_ENUM(bsd_bootfail_mode, uint32_t,
1356     BSD_BOOTFAIL_SEAL_BROKEN = 1,
1357     BSD_BOOTFAIL_MEDIA_MISSING = 2);
1358 
1359 boolean_t bsd_boot_to_recovery(bsd_bootfail_mode_t mode, uuid_t volume_uuid, boolean_t reboot);
1360 
1361 struct vnode_trigger_info;
1362 
1363 /*!
1364  *  @function vfs_addtrigger
1365  *  @abstract Create an "external" trigger vnode: look up a vnode and mark it as
1366  *  a trigger.  Can only safely be called in the context of a callback set by
1367  *  vfs_settriggercallback().  May only be used on a file which is not already
1368  *  marked as a trigger.
1369  *  @param relpath Path relative to root of mountpoint at which to mark trigger.
1370  *  @param vtip Information about trigger; analogous to "vnode_trigger_param"
1371  *       argument to vnode_create.
1372  *  @param ctx Authorization context.
1373  */
1374 int     vfs_addtrigger(mount_t mp, const char *relpath, struct vnode_trigger_info *vtip, vfs_context_t ctx);
1375 
1376 
1377 /*!
1378  *  @enum vfs_trigger_callback_op_t
1379  *  @abstract Operation to perform after an attempted unmount (successful or otherwise).
1380  *  @constant VTC_REPLACE Unmount failed: attempt to replace triggers.  Only valid
1381  *       VFS operation to perform in this context is vfs_addtrigger().
1382  *  @constant VTC_RELEASE Unmount succeeded: release external triggering context.
1383  */
1384 typedef enum {
1385 	VTC_REPLACE,
1386 	VTC_RELEASE
1387 } vfs_trigger_callback_op_t;
1388 
1389 /*!
1390  *  @typedef vfs_trigger_callback_t
1391  *  @abstract Callback to be passed to vfs_settriggercallback() and invoked from
1392  *       unmount context.
1393  *  @param mp Mountpoint on which unmount is occurring.
1394  *  @param op Operation (see vfs_trigger_callback_op_t)
1395  *  @param data Context passed to vfs_settriggercallback()
1396  *  @param ctx Authorization context in which unmount is occurring.
1397  */
1398 typedef void vfs_trigger_callback_t(mount_t mp, vfs_trigger_callback_op_t op, void *data, vfs_context_t ctx);
1399 
1400 /*!
1401  *  @function vfs_settriggercallback
1402  *  @abstract Install a callback to be called after unmount attempts on a volume,
1403  *  to restore triggers for failed unmounts and release state for successful ones.
1404  *  @discussion Installs a callback which will be called in two situations: a
1405  *  failed unmount where vnodes may have been reclaimed and a successful unmount.
1406  *  Gives an external trigger-marking entity an opportunity to replace triggers
1407  *  which may have been reclaimed.  The callback can only be installed (not
1408  *  cleared), and only one callback can be installed.  The callback will be called
1409  *  with a read-write lock held on the mount point; in the VTC_REPLACE case, the
1410  *  <em>only</em> valid VFS operation to perform in the context of the callback is
1411  *  vfs_addtrigger() on the mountpoint in question.  This rwlock is held in order
1412  *  to attempt to provide some modicum of coverage from lookups which might find
1413  *  missing trigger vnodes and receive spurious ENOENTs.  Note that this
1414  *  protection is incomplete--current working directories, or traversals up into a
1415  *  volume via ".." may still find missing triggers.  As of this writing, no
1416  *  serialization mechanism exists to do better than this.
1417  *  When the "op" is VTC_RELEASE, the mountpoint is going away, and the only valid
1418  *  VFS operation is to free the  private data pointer if needed.  The callback
1419  *  will be called immediately, with VTC_REPLACE, from vfs_settriggercallback(),
1420  *  if installation is successful.
1421  *  @param fsid FSID for filesystem in question.
1422  *  @param vtc Callback pointer.
1423  *  @param data Context pointer to be passed to callback.
1424  *  @param flags Currently unused.
1425  *  @param ctx Authorization context.
1426  *  @return 0 for success.  EBUSY if a trigger has already been installed.
1427  */
1428 int     vfs_settriggercallback(fsid_t *fsid, vfs_trigger_callback_t vtc, void *data, uint32_t flags, vfs_context_t ctx);
1429 
1430 /* tags a volume as not supporting extended readdir for NFS exports */
1431 void mount_set_noreaddirext(mount_t);
1432 
1433 /*!
1434  *  @function vfs_get_statfs64
1435  *  @abstract Get the same information as vfs_statfs(), but in a format suitable
1436  *  for copying to userland.
1437  */
1438 void vfs_get_statfs64(struct mount *mp, struct statfs64 *sfs);
1439 
1440 /*!
1441  * @function vfs_mount_id
1442  * @abstract Retrieve the system-wide unique mount ID for a mount point.
1443  * The ID is generated at mount and does not change on remount.
1444  * @param mp Mountpoint for which to get the mount ID.
1445  */
1446 uint64_t vfs_mount_id(mount_t mp);
1447 
1448 /*!
1449  * @function vfs_mount_at_path
1450  * @abstract A wrapper around kernel_mount() to be used only in special
1451  * circumstances.
1452  */
1453 int vfs_mount_at_path(const char *fstype, const char *path,
1454     vnode_t pvp, vnode_t vp, void *data, size_t datalen, int mnt_flags,
1455     int flags);
1456 
1457 /*!
1458  * @function vfs_mount_override_type_name
1459  * @abstract override the fstypename for statfs.
1460  * @param mp Mountpint for which to override the type name.
1461  * @param name Name to override.
1462  */
1463 int vfs_mount_override_type_name(mount_t mp, const char *name);
1464 
1465 #define VFS_MOUNT_FLAG_NOAUTH           0x01 /* Don't check the UID of the directory we are mounting on */
1466 #define VFS_MOUNT_FLAG_PERMIT_UNMOUNT   0x02 /* Allow (non-forced) unmounts by users other the one who mounted the volume */
1467 #define VFS_MOUNT_FLAG_CURRENT_CONTEXT  0x04 /* Mount using the current VFS context */
1468 
1469 #endif  /* KERNEL_PRIVATE */
1470 __END_DECLS
1471 
1472 #endif /* KERNEL */
1473 
1474 /*
1475  * Generic file handle
1476  */
1477 #define NFS_MAX_FH_SIZE         NFSV4_MAX_FH_SIZE
1478 #define NFSV4_MAX_FH_SIZE       128
1479 #define NFSV3_MAX_FH_SIZE       64
1480 #define NFSV2_MAX_FH_SIZE       32
1481 struct fhandle {
1482 	unsigned int    fh_len;                         /* length of file handle */
1483 	unsigned char   fh_data[NFS_MAX_FH_SIZE];       /* file handle value */
1484 };
1485 typedef struct fhandle  fhandle_t;
1486 
1487 OS_ENUM(graftdmg_type, uint32_t,
1488     GRAFTDMG_CRYPTEX_BOOT = 1,
1489     GRAFTDMG_CRYPTEX_PREBOOT = 2,
1490     GRAFTDMG_CRYPTEX_DOWNLEVEL = 3);
1491 
1492 
1493 
1494 #ifndef KERNEL
1495 
1496 __BEGIN_DECLS
1497 int     fhopen(const struct fhandle *, int);
1498 int     fstatfs(int, struct statfs *) __DARWIN_INODE64(fstatfs);
1499 #if !__DARWIN_ONLY_64_BIT_INO_T
1500 int     fstatfs64(int, struct statfs64 *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5, __MAC_10_6, __IPHONE_NA, __IPHONE_NA);
1501 #endif /* !__DARWIN_ONLY_64_BIT_INO_T */
1502 int     getfh(const char *, fhandle_t *);
1503 int     getfsstat(struct statfs *, int, int) __DARWIN_INODE64(getfsstat);
1504 #if !__DARWIN_ONLY_64_BIT_INO_T
1505 int     getfsstat64(struct statfs64 *, int, int) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5, __MAC_10_6, __IPHONE_NA, __IPHONE_NA);
1506 #endif /* !__DARWIN_ONLY_64_BIT_INO_T */
1507 int     getmntinfo(struct statfs **, int) __DARWIN_INODE64(getmntinfo);
1508 int     getmntinfo_r_np(struct statfs **, int) __DARWIN_INODE64(getmntinfo_r_np)
1509 __OSX_AVAILABLE(10.13) __IOS_AVAILABLE(11.0)
1510 __TVOS_AVAILABLE(11.0) __WATCHOS_AVAILABLE(4.0);
1511 #if !__DARWIN_ONLY_64_BIT_INO_T
1512 int     getmntinfo64(struct statfs64 **, int) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5, __MAC_10_6, __IPHONE_NA, __IPHONE_NA);
1513 #endif /* !__DARWIN_ONLY_64_BIT_INO_T */
1514 int     mount(const char *, const char *, int, void *);
1515 int     fmount(const char *, int, int, void *) __OSX_AVAILABLE(10.13) __IOS_AVAILABLE(11.0) __TVOS_AVAILABLE(11.0) __WATCHOS_AVAILABLE(4.0);
1516 int     statfs(const char *, struct statfs *) __DARWIN_INODE64(statfs);
1517 #if !__DARWIN_ONLY_64_BIT_INO_T
1518 int     statfs64(const char *, struct statfs64 *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5, __MAC_10_6, __IPHONE_NA, __IPHONE_NA);
1519 #endif /* !__DARWIN_ONLY_64_BIT_INO_T */
1520 int     unmount(const char *, int);
1521 int     getvfsbyname(const char *, struct vfsconf *);
1522 #if PRIVATE
1523 int     pivot_root(const char *, const char *) __OSX_AVAILABLE(10.16);
1524 int     graftdmg(int, const char *, uint32_t, graftdmg_args_un *) __OSX_AVAILABLE(13.0) __IOS_AVAILABLE(16.0);
1525 int     ungraftdmg(const char *, uint64_t) __OSX_AVAILABLE(13.0) __IOS_AVAILABLE(16.0);
1526 #endif
1527 __END_DECLS
1528 
1529 #endif /* KERNEL */
1530 #endif /* !_SYS_MOUNT_H_ */
1531