1/* 2 * Copyright (c) 2000-2010 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 78#ifndef KERNEL 79#include <stdint.h> 80#include <sys/ucred.h> 81#include <sys/queue.h> /* XXX needed for user builds */ 82#include <Availability.h> 83#else 84#include <sys/kernel_types.h> 85#include <uuid/uuid.h> 86#endif 87 88typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */ 89 90/* 91 * file system statistics 92 */ 93 94#define MFSNAMELEN 15 /* length of fs type name, not inc. null */ 95#define MFSTYPENAMELEN 16 /* length of fs type name including null */ 96 97#if __DARWIN_64_BIT_INO_T 98#define MNAMELEN MAXPATHLEN /* length of buffer for returned name */ 99#else /* ! __DARWIN_64_BIT_INO_T */ 100#define MNAMELEN 90 /* length of buffer for returned name */ 101#endif /* __DARWIN_64_BIT_INO_T */ 102 103#define __DARWIN_STRUCT_STATFS64 { \ 104 uint32_t f_bsize; /* fundamental file system block size */ \ 105 int32_t f_iosize; /* optimal transfer block size */ \ 106 uint64_t f_blocks; /* total data blocks in file system */ \ 107 uint64_t f_bfree; /* free blocks in fs */ \ 108 uint64_t f_bavail; /* free blocks avail to non-superuser */ \ 109 uint64_t f_files; /* total file nodes in file system */ \ 110 uint64_t f_ffree; /* free file nodes in fs */ \ 111 fsid_t f_fsid; /* file system id */ \ 112 uid_t f_owner; /* user that mounted the filesystem */ \ 113 uint32_t f_type; /* type of filesystem */ \ 114 uint32_t f_flags; /* copy of mount exported flags */ \ 115 uint32_t f_fssubtype; /* fs sub-type (flavor) */ \ 116 char f_fstypename[MFSTYPENAMELEN]; /* fs type name */ \ 117 char f_mntonname[MAXPATHLEN]; /* directory on which mounted */ \ 118 char f_mntfromname[MAXPATHLEN]; /* mounted filesystem */ \ 119 uint32_t f_reserved[8]; /* For future use */ \ 120} 121 122#if !__DARWIN_ONLY_64_BIT_INO_T 123 124struct statfs64 __DARWIN_STRUCT_STATFS64; 125 126#endif /* !__DARWIN_ONLY_64_BIT_INO_T */ 127 128#if __DARWIN_64_BIT_INO_T 129 130struct statfs __DARWIN_STRUCT_STATFS64; 131 132#else /* !__DARWIN_64_BIT_INO_T */ 133 134/* 135 * LP64 - WARNING - must be kept in sync with struct user_statfs in mount_internal.h. 136 */ 137struct statfs { 138 short f_otype; /* TEMPORARY SHADOW COPY OF f_type */ 139 short f_oflags; /* TEMPORARY SHADOW COPY OF f_flags */ 140 long f_bsize; /* fundamental file system block size */ 141 long f_iosize; /* optimal transfer block size */ 142 long f_blocks; /* total data blocks in file system */ 143 long f_bfree; /* free blocks in fs */ 144 long f_bavail; /* free blocks avail to non-superuser */ 145 long f_files; /* total file nodes in file system */ 146 long f_ffree; /* free file nodes in fs */ 147 fsid_t f_fsid; /* file system id */ 148 uid_t f_owner; /* user that mounted the filesystem */ 149 short f_reserved1; /* spare for later */ 150 short f_type; /* type of filesystem */ 151 long f_flags; /* copy of mount exported flags */ 152 long f_reserved2[2]; /* reserved for future use */ 153 char f_fstypename[MFSNAMELEN]; /* fs type name */ 154 char f_mntonname[MNAMELEN]; /* directory on which mounted */ 155 char f_mntfromname[MNAMELEN];/* mounted filesystem */ 156 char f_reserved3; /* For alignment */ 157 long f_reserved4[4]; /* For future use */ 158}; 159 160#endif /* __DARWIN_64_BIT_INO_T */ 161 162#pragma pack(4) 163 164struct vfsstatfs { 165 uint32_t f_bsize; /* fundamental file system block size */ 166 size_t f_iosize; /* optimal transfer block size */ 167 uint64_t f_blocks; /* total data blocks in file system */ 168 uint64_t f_bfree; /* free blocks in fs */ 169 uint64_t f_bavail; /* free blocks avail to non-superuser */ 170 uint64_t f_bused; /* free blocks avail to non-superuser */ 171 uint64_t f_files; /* total file nodes in file system */ 172 uint64_t f_ffree; /* free file nodes in fs */ 173 fsid_t f_fsid; /* file system id */ 174 uid_t f_owner; /* user that mounted the filesystem */ 175 uint64_t f_flags; /* copy of mount exported flags */ 176 char f_fstypename[MFSTYPENAMELEN];/* fs type name inclus */ 177 char f_mntonname[MAXPATHLEN];/* directory on which mounted */ 178 char f_mntfromname[MAXPATHLEN];/* mounted filesystem */ 179 uint32_t f_fssubtype; /* fs sub-type (flavor) */ 180 void *f_reserved[2]; /* For future use == 0 */ 181}; 182 183#pragma pack() 184 185#ifdef KERNEL 186/* 187 * Kernel level support for the VFS_GETATTR(), VFS_SETATTR() for use in 188 * implementation of filesystem KEXTs, and by the vfs_getattr() and 189 * vfs_setattr() KPIs. 190 */ 191 192#define VFSATTR_INIT(s) ((s)->f_supported = (s)->f_active = 0LL) 193#define VFSATTR_SET_SUPPORTED(s, a) ((s)->f_supported |= VFSATTR_ ## a) 194#define VFSATTR_IS_SUPPORTED(s, a) ((s)->f_supported & VFSATTR_ ## a) 195#define VFSATTR_CLEAR_ACTIVE(s, a) ((s)->f_active &= ~VFSATTR_ ## a) 196#define VFSATTR_IS_ACTIVE(s, a) ((s)->f_active & VFSATTR_ ## a) 197#define VFSATTR_ALL_SUPPORTED(s) (((s)->f_active & (s)->f_supported) == (s)->f_active) 198#define VFSATTR_WANTED(s, a) ((s)->f_active |= VFSATTR_ ## a) 199#define VFSATTR_RETURN(s, a, x) do { (s)-> a = (x); VFSATTR_SET_SUPPORTED(s, a);} while(0) 200 201#define VFSATTR_f_objcount (1LL<< 0) 202#define VFSATTR_f_filecount (1LL<< 1) 203#define VFSATTR_f_dircount (1LL<< 2) 204#define VFSATTR_f_maxobjcount (1LL<< 3) 205#define VFSATTR_f_bsize (1LL<< 4) 206#define VFSATTR_f_iosize (1LL<< 5) 207#define VFSATTR_f_blocks (1LL<< 6) 208#define VFSATTR_f_bfree (1LL<< 7) 209#define VFSATTR_f_bavail (1LL<< 8) 210#define VFSATTR_f_bused (1LL<< 9) 211#define VFSATTR_f_files (1LL<< 10) 212#define VFSATTR_f_ffree (1LL<< 11) 213#define VFSATTR_f_fsid (1LL<< 12) 214#define VFSATTR_f_owner (1LL<< 13) 215#define VFSATTR_f_capabilities (1LL<< 14) 216#define VFSATTR_f_attributes (1LL<< 15) 217#define VFSATTR_f_create_time (1LL<< 16) 218#define VFSATTR_f_modify_time (1LL<< 17) 219#define VFSATTR_f_access_time (1LL<< 18) 220#define VFSATTR_f_backup_time (1LL<< 19) 221#define VFSATTR_f_fssubtype (1LL<< 20) 222#define VFSATTR_f_vol_name (1LL<< 21) 223#define VFSATTR_f_signature (1LL<< 22) 224#define VFSATTR_f_carbon_fsid (1LL<< 23) 225#define VFSATTR_f_uuid (1LL<< 24) 226 227/* 228 * Argument structure. 229 */ 230#pragma pack(4) 231/* 232 * Note: the size of the vfs_attr structure can change. 233 * A kext should only reference the fields that are 234 * marked as active; it should not depend on the actual 235 * size of the structure or attempt to copy it. 236 */ 237struct vfs_attr { 238 uint64_t f_supported; 239 uint64_t f_active; 240 241 uint64_t f_objcount; /* number of filesystem objects in volume */ 242 uint64_t f_filecount; /* ... files */ 243 uint64_t f_dircount; /* ... directories */ 244 uint64_t f_maxobjcount; /* maximum number of filesystem objects */ 245 246 uint32_t f_bsize; /* block size for the below size values */ 247 size_t f_iosize; /* optimal transfer block size */ 248 uint64_t f_blocks; /* total data blocks in file system */ 249 uint64_t f_bfree; /* free blocks in fs */ 250 uint64_t f_bavail; /* free blocks avail to non-superuser */ 251 uint64_t f_bused; /* blocks in use */ 252 uint64_t f_files; /* total file nodes in file system */ 253 uint64_t f_ffree; /* free file nodes in fs */ 254 fsid_t f_fsid; /* file system id */ 255 uid_t f_owner; /* user that mounted the filesystem */ 256 257 vol_capabilities_attr_t f_capabilities; 258 vol_attributes_attr_t f_attributes; 259 260 struct timespec f_create_time; /* creation time */ 261 struct timespec f_modify_time; /* last modification time */ 262 struct timespec f_access_time; /* time of last access */ 263 struct timespec f_backup_time; /* last backup time */ 264 265 uint32_t f_fssubtype; /* filesystem subtype */ 266 267 char *f_vol_name; /* volume name */ 268 269 uint16_t f_signature; /* used for ATTR_VOL_SIGNATURE, Carbon's FSVolumeInfo.signature */ 270 uint16_t f_carbon_fsid; /* same as Carbon's FSVolumeInfo.filesystemID */ 271 uuid_t f_uuid; /* file system UUID (version 3 or 5), available in 10.6 and later */ 272}; 273 274#pragma pack() 275 276#endif /* KERNEL */ 277 278/* 279 * User specifiable flags. 280 * 281 * Unmount uses MNT_FORCE flag. 282 */ 283#define MNT_RDONLY 0x00000001 /* read only filesystem */ 284#define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */ 285#define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */ 286#define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */ 287#define MNT_NODEV 0x00000010 /* don't interpret special files */ 288#define MNT_UNION 0x00000020 /* union with underlying filesystem */ 289#define MNT_ASYNC 0x00000040 /* file system written asynchronously */ 290#define MNT_CPROTECT 0x00000080 /* file system supports content protection */ 291 292/* 293 * NFS export related mount flags. 294 */ 295#define MNT_EXPORTED 0x00000100 /* file system is exported */ 296 297/* 298 * MAC labeled / "quarantined" flag 299 */ 300#define MNT_QUARANTINE 0x00000400 /* file system is quarantined */ 301 302/* 303 * Flags set by internal operations. 304 */ 305#define MNT_LOCAL 0x00001000 /* filesystem is stored locally */ 306#define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */ 307#define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */ 308#define MNT_DOVOLFS 0x00008000 /* FS supports volfs (deprecated flag in Mac OS X 10.5) */ 309 310 311#define MNT_DONTBROWSE 0x00100000 /* file system is not appropriate path to user data */ 312#define MNT_IGNORE_OWNERSHIP 0x00200000 /* VFS will ignore ownership information on filesystem objects */ 313#define MNT_AUTOMOUNTED 0x00400000 /* filesystem was mounted by automounter */ 314#define MNT_JOURNALED 0x00800000 /* filesystem is journaled */ 315#define MNT_NOUSERXATTR 0x01000000 /* Don't allow user extended attributes */ 316#define MNT_DEFWRITE 0x02000000 /* filesystem should defer writes */ 317#define MNT_MULTILABEL 0x04000000 /* MAC support for individual labels */ 318#define MNT_NOATIME 0x10000000 /* disable update of file access time */ 319#ifdef BSD_KERNEL_PRIVATE 320/* #define MNT_IMGSRC_BY_INDEX 0x20000000 see sys/imgsrc.h */ 321#endif /* BSD_KERNEL_PRIVATE */ 322 323/* backwards compatibility only */ 324#define MNT_UNKNOWNPERMISSIONS MNT_IGNORE_OWNERSHIP 325 326 327/* 328 * XXX I think that this could now become (~(MNT_CMDFLAGS)) 329 * but the 'mount' program may need changing to handle this. 330 */ 331#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \ 332 MNT_NOSUID | MNT_NODEV | MNT_UNION | \ 333 MNT_ASYNC | MNT_EXPORTED | MNT_QUARANTINE | \ 334 MNT_LOCAL | MNT_QUOTA | \ 335 MNT_ROOTFS | MNT_DOVOLFS | MNT_DONTBROWSE | \ 336 MNT_IGNORE_OWNERSHIP | MNT_AUTOMOUNTED | MNT_JOURNALED | \ 337 MNT_NOUSERXATTR | MNT_DEFWRITE | MNT_MULTILABEL | \ 338 MNT_NOATIME | MNT_CPROTECT) 339/* 340 * External filesystem command modifier flags. 341 * Unmount can use the MNT_FORCE flag. 342 * XXX These are not STATES and really should be somewhere else. 343 * External filesystem control flags. 344 */ 345#define MNT_UPDATE 0x00010000 /* not a real mount, just an update */ 346#define MNT_NOBLOCK 0x00020000 /* don't block unmount if not responding */ 347#define MNT_RELOAD 0x00040000 /* reload filesystem data */ 348#define MNT_FORCE 0x00080000 /* force unmount or readonly change */ 349#define MNT_CMDFLAGS (MNT_UPDATE|MNT_NOBLOCK|MNT_RELOAD|MNT_FORCE) 350 351 352 353/* 354 * Sysctl CTL_VFS definitions. 355 * 356 * Second level identifier specifies which filesystem. Second level 357 * identifier VFS_GENERIC returns information about all filesystems. 358 */ 359#define VFS_GENERIC 0 /* generic filesystem information */ 360#define VFS_NUMMNTOPS 1 /* int: total num of vfs mount/unmount operations */ 361/* 362 * Third level identifiers for VFS_GENERIC are given below; third 363 * level identifiers for specific filesystems are given in their 364 * mount specific header files. 365 */ 366#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */ 367#define VFS_CONF 2 /* struct: vfsconf for filesystem given 368 as next argument */ 369#define VFS_SET_PACKAGE_EXTS 3 /* set package extension list */ 370 371/* 372 * Flags for various system call interfaces. 373 * 374 * waitfor flags to vfs_sync() and getfsstat() 375 */ 376#define MNT_WAIT 1 /* synchronized I/O file integrity completion */ 377#define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */ 378#define MNT_DWAIT 4 /* synchronized I/O data integrity completion */ 379 380 381#ifndef KERNEL 382struct mount; 383typedef struct mount * mount_t; 384struct vnode; 385typedef struct vnode * vnode_t; 386#endif 387 388/* Reserved fields preserve binary compatibility */ 389struct vfsconf { 390 uint32_t vfc_reserved1; /* opaque */ 391 char vfc_name[MFSNAMELEN]; /* filesystem type name */ 392 int vfc_typenum; /* historic filesystem type number */ 393 int vfc_refcount; /* number mounted of this type */ 394 int vfc_flags; /* permanent flags */ 395 uint32_t vfc_reserved2; /* opaque */ 396 uint32_t vfc_reserved3; /* opaque */ 397}; 398 399struct vfsidctl { 400 int vc_vers; /* should be VFSIDCTL_VERS1 (below) */ 401 fsid_t vc_fsid; /* fsid to operate on. */ 402 void *vc_ptr; /* pointer to data structure. */ 403 size_t vc_len; /* sizeof said structure. */ 404 u_int32_t vc_spare[12]; /* spare (must be zero). */ 405}; 406 407 408/* vfsidctl API version. */ 409#define VFS_CTL_VERS1 0x01 410 411#ifdef KERNEL 412struct user_vfsidctl { 413 int vc_vers; /* should be VFSIDCTL_VERS1 (below) */ 414 fsid_t vc_fsid; /* fsid to operate on. */ 415 user_addr_t vc_ptr __attribute((aligned(8))); /* pointer to data structure. */ 416 user_size_t vc_len; /* sizeof said structure. */ 417 u_int32_t vc_spare[12]; /* spare (must be zero). */ 418}; 419 420struct user32_vfsidctl { 421 int vc_vers; /* should be VFSIDCTL_VERS1 (below) */ 422 fsid_t vc_fsid; /* fsid to operate on. */ 423 user32_addr_t vc_ptr; /* pointer to data structure. */ 424 user32_size_t vc_len; /* sizeof said structure. */ 425 u_int32_t vc_spare[12]; /* spare (must be zero). */ 426}; 427 428union union_vfsidctl { /* the fields vc_vers and vc_fsid are compatible */ 429 struct user32_vfsidctl vc32; 430 struct user_vfsidctl vc64; 431}; 432 433#endif /* KERNEL */ 434 435/* 436 * New style VFS sysctls, do not reuse/conflict with the namespace for 437 * private sysctls. 438 */ 439#define VFS_CTL_STATFS 0x00010001 /* statfs */ 440#define VFS_CTL_UMOUNT 0x00010002 /* unmount */ 441#define VFS_CTL_QUERY 0x00010003 /* anything wrong? (vfsquery) */ 442#define VFS_CTL_NEWADDR 0x00010004 /* reconnect to new address */ 443#define VFS_CTL_TIMEO 0x00010005 /* set timeout for vfs notification */ 444#define VFS_CTL_NOLOCKS 0x00010006 /* disable file locking */ 445#define VFS_CTL_SADDR 0x00010007 /* get server address */ 446#define VFS_CTL_DISC 0x00010008 /* server disconnected */ 447#define VFS_CTL_SERVERINFO 0x00010009 /* information about fs server */ 448 449struct vfsquery { 450 u_int32_t vq_flags; 451 u_int32_t vq_spare[31]; 452}; 453 454struct vfs_server { 455 int32_t vs_minutes; /* minutes until server goes down. */ 456 u_int8_t vs_server_name[MAXHOSTNAMELEN*3]; /* UTF8 server name to display (null terminated) */ 457}; 458 459/* vfsquery flags */ 460#define VQ_NOTRESP 0x0001 /* server down */ 461#define VQ_NEEDAUTH 0x0002 /* server bad auth */ 462#define VQ_LOWDISK 0x0004 /* we're low on space */ 463#define VQ_MOUNT 0x0008 /* new filesystem arrived */ 464#define VQ_UNMOUNT 0x0010 /* filesystem has left */ 465#define VQ_DEAD 0x0020 /* filesystem is dead, needs force unmount */ 466#define VQ_ASSIST 0x0040 /* filesystem needs assistance from external program */ 467#define VQ_NOTRESPLOCK 0x0080 /* server lockd down */ 468#define VQ_UPDATE 0x0100 /* filesystem information has changed */ 469#define VQ_VERYLOWDISK 0x0200 /* file system has *very* little disk space left */ 470#define VQ_SYNCEVENT 0x0400 /* a sync just happened (not set by kernel starting Mac OS X 10.9) */ 471#define VQ_SERVEREVENT 0x0800 /* server issued notification/warning */ 472#define VQ_FLAG1000 0x1000 /* placeholder */ 473#define VQ_FLAG2000 0x2000 /* placeholder */ 474#define VQ_FLAG4000 0x4000 /* placeholder */ 475#define VQ_FLAG8000 0x8000 /* placeholder */ 476 477 478#ifdef KERNEL 479 480/* Structure for setting device IO parameters per mount point */ 481struct vfsioattr { 482 u_int32_t io_maxreadcnt; /* Max. byte count for read */ 483 u_int32_t io_maxwritecnt; /* Max. byte count for write */ 484 u_int32_t io_segreadcnt; /* Max. segment count for read */ 485 u_int32_t io_segwritecnt; /* Max. segment count for write */ 486 u_int32_t io_maxsegreadsize; /* Max. segment read size */ 487 u_int32_t io_maxsegwritesize; /* Max. segment write size */ 488 u_int32_t io_devblocksize; /* the underlying device block size */ 489 u_int32_t io_flags; /* flags for underlying device */ 490 void * io_reserved[2]; /* extended attribute information */ 491}; 492 493#define VFS_IOATTR_FLAGS_FUA 0x01 /* Write-through cache supported */ 494#define VFS_IOATTR_FLAGS_UNMAP 0x02 /* Unmap (trim) supported */ 495 496/* 497 * Filesystem Registration information 498 */ 499#define VFS_TBLTHREADSAFE 0x0001 /* Only threadsafe filesystems are supported */ 500#define VFS_TBLFSNODELOCK 0x0002 /* Only threadsafe filesystems are supported */ 501#define VFS_TBLNOTYPENUM 0x0008 502#define VFS_TBLLOCALVOL 0x0010 503#define VFS_TBL64BITREADY 0x0020 504#define VFS_TBLNATIVEXATTR 0x0040 505#define VFS_TBLDIRLINKS 0x0080 506#define VFS_TBLUNMOUNT_PREFLIGHT 0x0100 /* does a preflight check before unmounting */ 507#define VFS_TBLGENERICMNTARGS 0x0200 /* force generic mount args for local fs */ 508#define VFS_TBLREADDIR_EXTENDED 0x0400 /* fs supports VNODE_READDIR_EXTENDED */ 509#define VFS_TBLNOMACLABEL 0x1000 510#define VFS_TBLVNOP_PAGEINV2 0x2000 511#define VFS_TBLVNOP_PAGEOUTV2 0x4000 512#define VFS_TBLVNOP_NOUPDATEID_RENAME 0x8000 /* vfs should not call vnode_update_ident on rename */ 513 514 515struct vfs_fsentry { 516 struct vfsops * vfe_vfsops; /* vfs operations */ 517 int vfe_vopcnt; /* # of vnodeopv_desc being registered (reg, spec, fifo ...) */ 518 struct vnodeopv_desc ** vfe_opvdescs; /* null terminated; */ 519 int vfe_fstypenum; /* historic filesystem type number */ 520 char vfe_fsname[MFSNAMELEN]; /* filesystem type name */ 521 uint32_t vfe_flags; /* defines the FS capabilities */ 522 void * vfe_reserv[2]; /* reserved for future use; set this to zero*/ 523 }; 524 525 526 527struct vfsops { 528 /*! 529 @function vfs_mount 530 @abstract Perform filesystem-specific operations required for mounting. 531 @discussion Typical operations include setting the mount-specific data with vfs_setfsprivate(). 532 Note that if a mount call fails, the filesystem must clean up any state it has constructed, because 533 vfs-level mount code will not clean it up. 534 @param mp Mount structure for the newly mounted filesystem. 535 @param devvp Device that the filesystem is mounted from. 536 @param data Filesystem-specific data passed down from userspace. 537 @param context Context to authenticate for mount. 538 @return 0 for success, else an error code. Once success is returned, the filesystem should be ready to go active; 539 VFS will not ask again. 540 */ 541 int (*vfs_mount)(struct mount *mp, vnode_t devvp, user_addr_t data, vfs_context_t context); 542 543 /*! 544 @function vfs_start 545 @abstract Mark a mount as ready to be used. 546 @discussion After receiving this calldown, a filesystem will be hooked into the mount list and should expect 547 calls down from the VFS layer. 548 @param mp Mount structure being activated. 549 @param flags Unused. 550 @param context Context to authenticate for mount. 551 @return Return value is ignored. 552 */ 553 int (*vfs_start)(struct mount *mp, int flags, vfs_context_t context); 554 555 /*! 556 @function vfs_unmount 557 @abstract Perform filesystem-specific cleanup as part of unmount. 558 @discussion If the unmount downcall succeeds, VFS considers itself authorized to destroy all 559 state related to the mount. 560 @param mp Mount structure to unmount. 561 @param mntflags MNT_FORCE indicates that we wish to unmount even if there are active vnodes. 562 @param context Context to authenticate for unmount. 563 @return 0 for success, else an error code. 564 */ 565 int (*vfs_unmount)(struct mount *mp, int mntflags, vfs_context_t context); 566 567 /*! 568 @function vfs_root 569 @abstract Get the root vnode of a filesystem. 570 @discussion Upon success, should return with an iocount held on the root vnode which the caller will 571 drop with vnode_put(). 572 @param mp Mount for which to get the root. 573 @param vpp Destination for root vnode. 574 @param context Context to authenticate for getting the root. 575 @return 0 for success, else an error code. 576 */ 577 int (*vfs_root)(struct mount *mp, struct vnode **vpp, vfs_context_t context); 578 579 /*! 580 @function vfs_quotactl 581 @abstract Manipulate quotas for a volume. 582 @param mp Mount for which to manipulate quotas. 583 @param cmds Detailed in "quotactl" manual page. 584 @param uid Detailed in "quotactl" manual page. 585 @param arg Detailed in "quotactl" manual page. 586 @param context Context to authenticate for changing quotas. 587 @return 0 for success, else an error code. 588 */ 589 int (*vfs_quotactl)(struct mount *mp, int cmds, uid_t uid, caddr_t arg, vfs_context_t context); 590 591 /*! 592 @function vfs_getattr 593 @abstract Get filesystem attributes. 594 @discussion See VFSATTR_RETURN, VFSATTR_ACTIVE, VFSATTR_SET_SUPPORTED, VFSATTR_WANTED macros. 595 @param mp Mount for which to get parameters. 596 @param vfa Container for specifying which attributes are desired and which attributes the filesystem 597 supports, as well as for returning results. 598 @param ctx Context to authenticate for getting filesystem attributes. 599 @return 0 for success, else an error code. 600 */ 601 int (*vfs_getattr)(struct mount *mp, struct vfs_attr *, vfs_context_t context); 602/* int (*vfs_statfs)(struct mount *mp, struct vfsstatfs *sbp, vfs_context_t context);*/ 603 604 /*! 605 @function vfs_sync 606 @abstract Flush all filesystem data to backing store. 607 @discussion vfs_sync will be called as part of the sync() system call and during unmount. 608 @param mp Mountpoint to sync. 609 @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. 610 @param ctx Context to authenticate for the sync. 611 @return 0 for success, else an error code. 612 */ 613 int (*vfs_sync)(struct mount *mp, int waitfor, vfs_context_t context); 614 615 /*! 616 @function vfs_vget 617 @abstract Get a vnode by file id (inode number). 618 @discussion This routine is chiefly used to build paths to vnodes. Result should be turned with an iocount that the 619 caller will drop with vnode_put(). 620 @param mp Mount against which to look up inode number. 621 @param ino File ID for desired file, as found through a readdir. 622 @param vpp Destination for vnode. 623 @return 0 for success, else an error code. 624 */ 625 int (*vfs_vget)(struct mount *mp, ino64_t ino, struct vnode **vpp, vfs_context_t context); 626 627 /*! 628 @function vfs_fhtovp 629 @abstract Get the vnode corresponding to a file handle. 630 @discussion Filesystems can return handles to files which are independent of their (transient) vnode identities. 631 vfs_thtovp converts that persistent handle back to a vnode. The vnode should be returned with an iocount which 632 the caller will drop with vnode_put(). 633 @param mp Mount against which to look up file handle. 634 @param fhlen Size of file handle structure, as returned by vfs_vptofh. 635 @param fhp Pointer to handle. 636 @param vpp Destination for vnode. 637 @param ctx Context against which to authenticate the file-handle conversion. 638 @return 0 for success, else an error code. 639 */ 640 int (*vfs_fhtovp)(struct mount *mp, int fhlen, unsigned char *fhp, struct vnode **vpp, 641 vfs_context_t context); 642 643 /*! 644 @function vfs_vptofh 645 @abstract Get a persistent handle corresponding to a vnode. 646 @param mp Mount against which to convert the vnode to a handle. 647 @param fhlen Size of buffer provided for handle; set to size of actual handle returned. 648 @param fhp Pointer to buffer in which to place handle data. 649 @param ctx Context against which to authenticate the file-handle request. 650 @return 0 for success, else an error code. 651 */ 652 int (*vfs_vptofh)(struct vnode *vp, int *fhlen, unsigned char *fhp, vfs_context_t context); 653 654 /*! 655 @function vfs_init 656 @abstract Prepare a filesystem for having instances mounted. 657 @discussion This routine is called once, before any particular instance of a filesystem 658 is mounted; it allows the filesystem to initialize whatever global data structures 659 are shared across all mounts. If this returns successfully, a filesystem should be ready to have 660 instances mounted. 661 @param vfsconf Configuration information. Currently, the only useful data are the filesystem name, 662 typenum, and flags. The flags field will be either 0 or MNT_LOCAL. Many filesystems ignore this 663 parameter. 664 @return 0 for success, else an error code. 665 */ 666 int (*vfs_init)(struct vfsconf *); 667 668 /*! 669 @function vfs_sysctl 670 @abstract Broad interface for querying and controlling filesystem. 671 @discussion VFS defines VFS_CTL_QUERY as a generic status request which is answered 672 with the VQ_* macros in a "struct vfsquery." 673 A filesystem may also define implementation-specific commands. See "man 3 sysctl" 674 for the meaning of sysctl parameters. 675 @param context Context against which to authenticate command. 676 @return 0 for success, else an error code. 677 */ 678 int (*vfs_sysctl)(int *, u_int, user_addr_t, size_t *, user_addr_t, size_t, vfs_context_t context); 679 680 /*! 681 @function vfs_setattr 682 @abstract Set filesystem attributes. 683 @discussion The other side of the vfs_getattr coin. Currently only called to set volume name. 684 @param mp Mount on which to set attributes. 685 @param vfa VFS attribute structure containing requested attributes to set and their values. Currently 686 will only be called with f_vol_name set. 687 @param context Context against which to authenticate attribute change. 688 @return 0 for success, else an error code. 689 */ 690 int (*vfs_setattr)(struct mount *mp, struct vfs_attr *, vfs_context_t context); 691 void *vfs_reserved[7]; 692}; 693 694 695/* 696 * flags passed into vfs_iterate 697 */ 698#ifdef PRIVATE 699#define VFS_ITERATE_TAIL_FIRST (1 << 0) 700#endif /* PRIVATE */ 701 702/* 703 * return values from callback 704 */ 705#define VFS_RETURNED 0 /* done with vnode, reference can be dropped */ 706#define VFS_RETURNED_DONE 1 /* done with vnode, reference can be dropped, terminate iteration */ 707#define VFS_CLAIMED 2 /* don't drop reference */ 708#define VFS_CLAIMED_DONE 3 /* don't drop reference, terminate iteration */ 709 710 711__BEGIN_DECLS 712#ifdef BSD_KERNEL_PRIVATE 713extern int VFS_MOUNT(mount_t, vnode_t, user_addr_t, vfs_context_t); 714extern int VFS_START(mount_t, int, vfs_context_t); 715extern int VFS_UNMOUNT(mount_t, int, vfs_context_t); 716extern int VFS_ROOT(mount_t, vnode_t *, vfs_context_t); 717extern int VFS_QUOTACTL(mount_t, int, uid_t, caddr_t, vfs_context_t); 718extern int VFS_GETATTR(mount_t, struct vfs_attr *, vfs_context_t); 719extern int VFS_SETATTR(mount_t, struct vfs_attr *, vfs_context_t); 720extern int VFS_SYNC(mount_t, int, vfs_context_t); 721extern int VFS_VGET(mount_t, ino64_t, vnode_t *, vfs_context_t); 722extern int VFS_FHTOVP(mount_t, int, unsigned char *, vnode_t *, vfs_context_t); 723extern int VFS_VPTOFH(vnode_t, int *, unsigned char *, vfs_context_t); 724#endif /* BSD_KERNEL_PRIVATE */ 725/* 726 * prototypes for exported VFS operations 727 */ 728 729/*! 730 @function vfs_fsadd 731 @abstract Register a filesystem with VFS. 732 @discussion Typically called by a filesystem Kernel Extension when it is loaded. 733 @param vfe Filesystem information: table of vfs operations, list of vnode operation tables, 734 filesystem type number (can be omitted with VFS_TBLNOTYPENUM flag), name, flags. 735 @param handle Opaque handle which will be passed to vfs_fsremove. 736 @return 0 for success, else an error code. 737 */ 738int vfs_fsadd(struct vfs_fsentry *, vfstable_t *); 739 740/*! 741 @function vfs_fsremove 742 @abstract Unregister a filesystem with VFS. 743 @discussion Typically called by a filesystem Kernel Extension when it is unloaded. 744 @param handle Handle which was returned by vfs_fsadd. 745 @return 0 for success, else an error code. 746 */ 747int vfs_fsremove(vfstable_t); 748 749/*! 750 @function vfs_iterate 751 @abstract Iterate over all mountpoints with a callback. Used, for example, by sync(). 752 @param flags Unused. 753 @param callback Function which takes a mount and arbitrary passed-in "arg," and returns one of VFS_RETURNED_DONE or VFS_CLAIMED_DONE: end 754 iteration and return success. VFS_RETURNED or VFS_CLAIMED: continue iterating. Anything else: continue iterating. 755 @param arg Arbitrary data to pass to callback. 756 @return 0 for success, else an error code. 757 */ 758int vfs_iterate(int, int (*)(struct mount *, void *), void *); 759 760/*! 761 @function vfs_init_io_attributes 762 @abstract Set I/O attributes on a mountpoint based on device properties. 763 @param devvp Block device vnode from which a filesystem is being mounted. 764 @param mp Mountpoint whose I/O parameters to initialize. 765 @return 0 for success, else an error code. 766 */ 767int vfs_init_io_attributes(vnode_t, mount_t); 768 769/*! 770 @function vfs_flags 771 @abstract Retrieve mount flags. 772 @discussion Results will be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS. 773 @param mp Mount whose flags to grab. 774 @return Flags. 775 */ 776uint64_t vfs_flags(mount_t); 777 778/*! 779 @function vfs_setflags 780 @abstract Set flags on a mount. 781 @discussion Sets mount flags to the bitwise "OR" of their current value and the specified bits. Often 782 used by a filesystem as part of the mount process. 783 @param mp Mount whose flags to set. 784 @param flags Flags to activate. Must be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS. 785 @return Flags. 786 */ 787void vfs_setflags(mount_t, uint64_t); 788 789/*! 790 @function vfs_clearflags 791 @abstract Clear flags on a mount. 792 @discussion Sets mount flags to the bitwise "AND" of their current value and the complement of the specified bits. 793 @param mp Mount whose flags to set. 794 @param flags Flags to deactivate. Must be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS. 795 @return void. 796 */ 797void vfs_clearflags(mount_t, uint64_t); 798 799/*! 800 @function vfs_issynchronous 801 @abstract Determine if writes to a filesystem occur synchronously. 802 @param mp Mount to test. 803 @return Nonzero if writes occur synchronously, else 0. 804 */ 805int vfs_issynchronous(mount_t); 806 807/*! 808 @function vfs_iswriteupgrade 809 @abstract Determine if a filesystem is mounted read-only but a request has been made to upgrade 810 to read-write. 811 @param mp Mount to test. 812 @return Nonzero if a request has been made to update from read-only to read-write, else 0. 813 */ 814int vfs_iswriteupgrade(mount_t); 815 816/*! 817 @function vfs_isupdate 818 @abstract Determine if a mount update is in progress. 819 @param mp Mount to test. 820 @return Nonzero if a mount update is in progress, 0 otherwise. 821 */ 822int vfs_isupdate(mount_t); 823 824/*! 825 @function vfs_isreload 826 @abstract Determine if a reload of filesystem data is in progress. This can only be the case 827 for a read-only filesystem; all data is brought in from secondary storage. 828 @param mp Mount to test. 829 @return Nonzero if a request has been made to reload data, else 0. 830 */ 831int vfs_isreload(mount_t); 832 833/*! 834 @function vfs_isforce 835 @abstract Determine if a forced unmount is in progress. 836 @discussion A forced unmount invalidates open files. 837 @param mp Mount to test. 838 @return Nonzero if a request has been made to forcibly unmount, else 0. 839 */ 840int vfs_isforce(mount_t); 841 842/*! 843 @function vfs_isunmount 844 @abstract Determine if an unmount is in progress. 845 @discussion This is an unsynchronized snapshot of the mount state. It should only be called 846 if the mount is known to be valid, e.g. there are known to be live files on that volume. 847 @param mp Mount to test. 848 @return Nonzero if an unmount is in progress, else zero. 849 */ 850int vfs_isunmount(mount_t mp); 851 852/*! 853 @function vfs_isrdonly 854 @abstract Determine if a filesystem is mounted read-only. 855 @param mp Mount to test. 856 @return Nonzero if filesystem is mounted read-only, else 0. 857 */ 858int vfs_isrdonly(mount_t); 859 860/*! 861 @function vfs_isrdwr 862 @abstract Determine if a filesystem is mounted with writes enabled. 863 @param mp Mount to test. 864 @return Nonzero if filesystem is mounted read-write, else 0. 865 */ 866int vfs_isrdwr(mount_t); 867 868/*! 869 @function vfs_authopaque 870 @abstract Determine if a filesystem's authorization decisions occur remotely. 871 @param mp Mount to test. 872 @return Nonzero if filesystem authorization is controlled remotely, else 0. 873 */ 874int vfs_authopaque(mount_t); 875 876/*! 877 @function vfs_authopaqueaccess 878 @abstract Check if a filesystem is marked as having reliable remote VNOP_ACCESS support. 879 @param mp Mount to test. 880 @return Nonzero if VNOP_ACCESS is supported remotely, else 0. 881 */ 882int vfs_authopaqueaccess(mount_t); 883 884/*! 885 @function vfs_setauthopaque 886 @abstract Mark a filesystem as having authorization decisions controlled remotely. 887 @param mp Mount to mark. 888 @return void. 889 */ 890void vfs_setauthopaque(mount_t); 891 892/*! 893 @function vfs_setauthopaqueaccess 894 @abstract Mark a filesystem as having remote VNOP_ACCESS support. 895 @param mp Mount to mark. 896 @return void. 897 */ 898void vfs_setauthopaqueaccess(mount_t); 899 900/*! 901 @function vfs_clearauthopaque 902 @abstract Mark a filesystem as not having remote authorization decisions. 903 @param mp Mount to mark. 904 @return void. 905 */ 906void vfs_clearauthopaque(mount_t); 907 908/*! 909 @function vfs_clearauthopaque 910 @abstract Mark a filesystem as not having remote VNOP_ACCESS support. 911 @param mp Mount to mark. 912 @return void. 913 */ 914void vfs_clearauthopaqueaccess(mount_t); 915 916/*! 917 @function vfs_setextendedsecurity 918 @abstract Mark a filesystem as supporting security controls beyond POSIX permissions. 919 @discussion Specific controls include ACLs, file owner UUIDs, and group UUIDs. 920 @param mp Mount to test. 921 @return void. 922 */ 923void vfs_setextendedsecurity(mount_t); 924 925/*! 926 @function vfs_clearextendedsecurity 927 @abstract Mark a filesystem as NOT supporting security controls beyond POSIX permissions. 928 @discussion Specific controls include ACLs, file owner UUIDs, and group UUIDs. 929 @param mp Mount to test. 930 @return void. 931 */ 932void vfs_clearextendedsecurity(mount_t); 933 934/*! 935 @function vfs_setlocklocal 936 @abstract Mark a filesystem as using VFS-level advisory locking support. 937 @discussion Advisory locking operations will not call down to the filesystem if this flag is set. 938 @param mp Mount to mark. 939 @return void. 940 */ 941void vfs_setlocklocal(mount_t); 942 943/*! 944 @function vfs_authcache_ttl 945 @abstract Determine the time-to-live of cached authorized credentials for files in this filesystem. 946 @discussion If a filesystem is set to allow caching credentials, the VFS layer can authorize 947 previously-authorized actions from the same vfs_context_t without calling down to the filesystem (though 948 it will not deny based on the cache). 949 @param mp Mount for which to check cache lifetime. 950 @return Cache lifetime in seconds. CACHED_RIGHT_INFINITE_TTL indicates that credentials never expire. 951 */ 952int vfs_authcache_ttl(mount_t); 953 954/*! 955 @function vfs_setauthcache_ttl 956 @abstract Enable credential caching and set time-to-live of cached authorized credentials for files in this filesystem. 957 @discussion If a filesystem is set to allow caching credentials, the VFS layer can authorize 958 previously-authorized actions from the same vfs_context_t without calling down to the filesystem (though 959 it will not deny based on the cache). 960 @param mp Mount for which to set cache lifetime. 961 @return void. 962 */ 963void vfs_setauthcache_ttl(mount_t, int); 964 965/*! 966 @function vfs_clearauthcache_ttl 967 @abstract Remove time-to-live controls for cached credentials on a filesytem. Filesystems with remote authorization 968 decisions (opaque) will still have KAUTH_VNODE_SEARCH rights cached for a default of CACHED_LOOKUP_RIGHT_TTL seconds. 969 @param mp Mount for which to clear cache lifetime. 970 @return void. 971 */ 972void vfs_clearauthcache_ttl(mount_t); 973 974/* 975 * return value from vfs_cachedrights_ttl if 976 * neither MNTK_AUTH_OPAQUE | MNTK_AUTH_CACHE_TTL 977 * is set in mnt_kern_flag.. it indicates 978 * that no TTL is being applied to the vnode rights cache 979 */ 980#define CACHED_RIGHT_INFINITE_TTL ~0 981 982/*! 983 @function vfs_maxsymlen 984 @abstract Get the maximum length of a symbolic link on a filesystem. 985 @param mp Mount from which to get symlink length cap. 986 @return Max symlink length. 987 */ 988uint32_t vfs_maxsymlen(mount_t); 989 990/*! 991 @function vfs_setmaxsymlen 992 @abstract Set the maximum length of a symbolic link on a filesystem. 993 @param mp Mount on which to set symlink length cap. 994 @param symlen Length to set. 995 @return Max symlink length. 996 */ 997void vfs_setmaxsymlen(mount_t, uint32_t); 998 999/*! 1000 @function vfs_fsprivate 1001 @abstract Get filesystem-private mount data. 1002 @discussion A filesystem generally has an internal mount structure which it attaches to the VFS-level mount structure 1003 as part of the mounting process. 1004 @param mp Mount for which to get private data. 1005 @return Private data. 1006 */ 1007void * vfs_fsprivate(mount_t); 1008 1009/*! 1010 @function vfs_setfsprivate 1011 @abstract Set filesystem-private mount data. 1012 @discussion A filesystem generally has an internal mount structure which it attaches to the VFS-level mount structure 1013 as part of the mounting process. 1014 @param mp Mount for which to set private data. 1015 @return Void. 1016 */ 1017void vfs_setfsprivate(mount_t, void *mntdata); 1018 1019/*! 1020 @function vfs_statfs 1021 @abstract Get information about filesystem status. 1022 @discussion Each filesystem has a struct vfsstatfs associated with it which is updated as events occur; this function 1023 returns a pointer to it. Note that the data in the structure will continue to change over time and also that it may 1024 be quite stale of vfs_update_vfsstat has not been called recently. 1025 @param mp Mount for which to get vfsstatfs pointer. 1026 @return Pointer to vfsstatfs. 1027 */ 1028struct vfsstatfs * vfs_statfs(mount_t); 1029#define VFS_USER_EVENT 0 1030#define VFS_KERNEL_EVENT 1 1031 1032/*! 1033 @function vfs_update_vfsstat 1034 @abstract Update cached filesystem status information in the VFS mount structure. 1035 @discussion Each filesystem has a struct vfsstatfs associated with it which is updated as events occur; this function 1036 updates it so that the structure pointer returned by vfs_statfs() returns a pointer to fairly recent data. 1037 @param mp Mount for which to update cached status information. 1038 @param ctx Context to authenticate against for call down to filesystem. 1039 @param eventtype VFS_USER_EVENT: need for update is driven by user-level request; perform additional authentication. 1040 VFS_KERNEL_EVENT: need for update is driven by in-kernel events. Skip extra authentication. 1041 @return 0 for success, or an error code for authentication failure or problem with call to filesystem to 1042 request information. 1043 */ 1044int vfs_update_vfsstat(mount_t, vfs_context_t, int eventtype); 1045 1046/*! 1047 @function vfs_typenum 1048 @abstract Get (archaic) filesystem type number. 1049 @discussion Filesystem type numbers are an old construct; most filesystems just get a number assigned based on 1050 the order in which they are registered with the system. 1051 @param mp Mount for which to get type number. 1052 @return Type number. 1053 */ 1054int vfs_typenum(mount_t); 1055 1056/*! 1057 @function vfs_name 1058 @abstract Copy filesystem name into a buffer. 1059 @discussion Get filesystem name; this refers to the filesystem type of which a mount is an instantiation, 1060 rather than a name specific to the mountpoint. 1061 @param mp Mount for which to get name. 1062 @param buffer Destination for name; length should be at least MFSNAMELEN. 1063 @return void. 1064 */ 1065void vfs_name(mount_t, char *); 1066 1067/*! 1068 @function vfs_devblocksize 1069 @abstract Get the block size of the device underlying a mount. 1070 @param mp Mount for which to get block size. 1071 @return Block size. 1072 */ 1073int vfs_devblocksize(mount_t); 1074 1075/*! 1076 @function vfs_ioattr 1077 @abstract Get I/O attributes associated with a mounpoint. 1078 @param mp Mount for which to get attributes. If NULL, system defaults are filled into ioattrp. 1079 @param ioattrp Destination for results. 1080 @return void. 1081 */ 1082void vfs_ioattr(mount_t, struct vfsioattr *); 1083 1084/*! 1085 @function vfs_setioattr 1086 @abstract Set I/O attributes associated with a mounpoint. 1087 @param mp Mount for which to set attributes. 1088 @param ioattrp Structure containing I/O parameters; all fields must be filled in. 1089 @return void. 1090 */ 1091void vfs_setioattr(mount_t, struct vfsioattr *); 1092 1093/*! 1094 @function vfs_64bitready 1095 @abstract Check if the filesystem associated with a mountpoint is marked ready for interaction with 64-bit user processes. 1096 @param mp Mount to test. 1097 @return Nonzero if filesystem is ready for 64-bit; 0 otherwise. 1098 */ 1099int vfs_64bitready(mount_t); 1100 1101 1102#define LK_NOWAIT 1 1103/*! 1104 @function vfs_busy 1105 @abstract "Busy" a mountpoint. 1106 @discussion vfs_busy() will "busy" a mountpoint, preventing unmounts from taking off, by taking its reader-writer lock 1107 in a shared manner. If a mount is dead, 1108 it will fail; if an unmount is in progress, depending on flags, it will either fail immediately or block 1109 until the unmount completes (then failing if the unmount has succeeded, or potentially succeeding if unmounting failed). 1110 A successful vfs_busy() must be followed by a vfs_unbusy() to release the lock on the mount. 1111 @param mp Mount to busy. 1112 @param flags LK_NOWAIT: fail with ENOENT if an unmount is in progress. 1113 @return 0 for success, with a lock held; an error code otherwise, with no lock held. 1114 */ 1115int vfs_busy(mount_t, int); 1116 1117/*! 1118 @function vfs_unbusy 1119 @abstract "Unbusy" a mountpoint by releasing its read-write lock. 1120 @discussion A successful vfs_busy() must be followed by a vfs_unbusy() to release the lock on the mount. 1121 @param mp Mount to unbusy. 1122 @return void. 1123 */ 1124void vfs_unbusy(mount_t); 1125 1126/*! 1127 @function vfs_getnewfsid 1128 @abstract Generate a unique filesystem ID for a mount and store it in the mount structure. 1129 @discussion Filesystem IDs are returned as part of "struct statfs." This function is typically 1130 called as part of file-system specific mount code (i.e. through VFS_MOUNT). 1131 @param mp Mount to set an ID for. 1132 @return void. 1133 */ 1134void vfs_getnewfsid(struct mount *); 1135 1136/*! 1137 @function vfs_getvfs 1138 @abstract Given a filesystem ID, look up a mount structure. 1139 @param fsid Filesystem ID to look up. 1140 @return Mountpoint if found, else NULL. Note unmounting mountpoints can be returned. 1141 */ 1142mount_t vfs_getvfs(fsid_t *); 1143 1144/*! 1145 @function vfs_mountedon 1146 @abstract Check whether a given block device has a filesystem mounted on it. 1147 @discussion Note that this is NOT a check for a covered vnode (the directory upon which 1148 a filesystem is mounted)--it is a test for whether a block device is being used as the source 1149 of a filesystem. Note that a block device marked as being mounted on cannot be opened. 1150 @param vp The vnode to test. 1151 @return EBUSY if vnode is indeed the source of a filesystem; 0 if it is not. 1152 */ 1153int vfs_mountedon(struct vnode *); 1154 1155/*! 1156 @function vfs_unmountbyfsid 1157 @abstract Find a filesystem by ID and unmount it. 1158 @param fsid ID of filesystem to unmount, as found through (for example) statfs. 1159 @param flags MNT_FORCE: forcibly invalidate files open on the mount (though in-flight I/O operations 1160 will be allowed to complete). 1161 @param ctx Context against which to authenticate unmount operation. 1162 @return 0 for succcess, nonero for failure. 1163 */ 1164int vfs_unmountbyfsid(fsid_t *, int, vfs_context_t); 1165 1166/*! 1167 @function vfs_event_signal 1168 @abstract Post a kqueue-style event on a filesystem (EVFILT_FS). 1169 @param fsid Unused. 1170 @param event Events to post. 1171 @param data Unused. 1172 @return void. 1173 */ 1174void vfs_event_signal(fsid_t *, u_int32_t, intptr_t); 1175/*! 1176 @function vfs_event_init 1177 @abstract This function should not be called by kexts. 1178 */ 1179void vfs_event_init(void); /* XXX We should not export this */ 1180#ifdef KERNEL_PRIVATE 1181int vfs_getbyid(fsid_t *fsid, ino64_t ino, vnode_t *vpp, vfs_context_t ctx); 1182int vfs_getattr(mount_t mp, struct vfs_attr *vfa, vfs_context_t ctx); 1183int vfs_setattr(mount_t mp, struct vfs_attr *vfa, vfs_context_t ctx); 1184int vfs_extendedsecurity(mount_t); 1185mount_t vfs_getvfs_by_mntonname(char *); 1186vnode_t vfs_vnodecovered(mount_t mp); /* Returns vnode with an iocount that must be released with vnode_put() */ 1187vnode_t vfs_devvp(mount_t mp); /* Please see block comment with implementation */ 1188int vfs_nativexattrs (mount_t mp); /* whether or not the FS supports EAs natively */ 1189void * vfs_mntlabel(mount_t mp); /* Safe to cast to "struct label*"; returns "void*" to limit dependence of mount.h on security headers. */ 1190void vfs_setunmountpreflight(mount_t mp); 1191void vfs_setcompoundopen(mount_t mp); 1192uint64_t vfs_throttle_mask(mount_t mp); 1193 1194struct vnode_trigger_info; 1195 1196/*! 1197 @function vfs_addtrigger 1198 @abstract Create an "external" trigger vnode: look up a vnode and mark it as 1199 a trigger. Can only safely be called in the context of a callback set by 1200 vfs_settriggercallback(). May only be used on a file which is not already 1201 marked as a trigger. 1202 @param relpath Path relative to root of mountpoint at which to mark trigger. 1203 @param vtip Information about trigger; analogous to "vnode_trigger_param" 1204 argument to vnode_create. 1205 @param ctx Authorization context. 1206 */ 1207int vfs_addtrigger(mount_t mp, const char *relpath, struct vnode_trigger_info *vtip, vfs_context_t ctx); 1208 1209 1210/*! 1211 @enum vfs_trigger_callback_op_t 1212 @abstract Operation to perform after an attempted unmount (successful or otherwise). 1213 @constant VTC_REPLACE Unmount failed: attempt to replace triggers. Only valid 1214 VFS operation to perform in this context is vfs_addtrigger(). 1215 @constant VTC_RELEASE Unmount succeeded: release external triggering context. 1216 */ 1217typedef enum { 1218 VTC_REPLACE, 1219 VTC_RELEASE 1220} vfs_trigger_callback_op_t; 1221 1222/*! 1223 @typedef vfs_trigger_callback_t 1224 @abstract Callback to be passed to vfs_settriggercallback() and invoked from 1225 unmount context. 1226 @param mp Mountpoint on which unmount is occurring. 1227 @param op Operation (see vfs_trigger_callback_op_t) 1228 @param data Context passed to vfs_settriggercallback() 1229 @param ctx Authorization context in which unmount is occurring. 1230 */ 1231typedef void vfs_trigger_callback_t(mount_t mp, vfs_trigger_callback_op_t op, void *data, vfs_context_t ctx); 1232 1233/*! 1234 @function vfs_settriggercallback 1235 @abstract Install a callback to be called after unmount attempts on a volume, 1236 to restore triggers for failed unmounts and release state for successful ones. 1237 @discussion Installs a callback which will be called in two situations: a 1238 failed unmount where vnodes may have been reclaimed and a successful unmount. 1239 Gives an external trigger-marking entity an opportunity to replace triggers 1240 which may have been reclaimed. The callback can only be installed (not 1241 cleared), and only one callback can be installed. The callback will be called 1242 with a read-write lock held on the mount point; in the VTC_REPLACE case, the 1243 <em>only</em> valid VFS operation to perform in the context of the callback is 1244 vfs_addtrigger() on the mountpoint in question. This rwlock is held in order 1245 to attempt to provide some modicum of coverage from lookups which might find 1246 missing trigger vnodes and receive spurious ENOENTs. Note that this 1247 protection is incomplete--current working directories, or traversals up into a 1248 volume via ".." may still find missing triggers. As of this writing, no 1249 serialization mechanism exists to do better than this. 1250 When the "op" is VTC_RELEASE, the mountpoint is going away, and the only valid 1251 VFS operation is to free the private data pointer if needed. The callback 1252 will be called immediately, with VTC_REPLACE, from vfs_settriggercallback(), 1253 if installation is successful. 1254 @param fsid FSID for filesystem in question. 1255 @param vtc Callback pointer. 1256 @param data Context pointer to be passed to callback. 1257 @param flags Currently unused. 1258 @param ctx Authorization context. 1259 @return 0 for success. EBUSY if a trigger has already been installed. 1260 */ 1261int vfs_settriggercallback(fsid_t *fsid, vfs_trigger_callback_t vtc, void *data, uint32_t flags, vfs_context_t ctx); 1262 1263#endif /* KERNEL_PRIVATE */ 1264__END_DECLS 1265 1266#endif /* KERNEL */ 1267 1268#ifndef KERNEL 1269 1270/* 1271 * Generic file handle 1272 */ 1273#define NFS_MAX_FH_SIZE NFSV4_MAX_FH_SIZE 1274#define NFSV4_MAX_FH_SIZE 128 1275#define NFSV3_MAX_FH_SIZE 64 1276#define NFSV2_MAX_FH_SIZE 32 1277struct fhandle { 1278 int fh_len; /* length of file handle */ 1279 unsigned char fh_data[NFS_MAX_FH_SIZE]; /* file handle value */ 1280}; 1281typedef struct fhandle fhandle_t; 1282 1283 1284__BEGIN_DECLS 1285int fhopen(const struct fhandle *, int); 1286int fstatfs(int, struct statfs *) __DARWIN_INODE64(fstatfs); 1287#if !__DARWIN_ONLY_64_BIT_INO_T 1288int fstatfs64(int, struct statfs64 *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_6,__IPHONE_NA,__IPHONE_NA); 1289#endif /* !__DARWIN_ONLY_64_BIT_INO_T */ 1290int getfh(const char *, fhandle_t *); 1291int getfsstat(struct statfs *, int, int) __DARWIN_INODE64(getfsstat); 1292#if !__DARWIN_ONLY_64_BIT_INO_T 1293int getfsstat64(struct statfs64 *, int, int) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_6,__IPHONE_NA,__IPHONE_NA); 1294#endif /* !__DARWIN_ONLY_64_BIT_INO_T */ 1295int getmntinfo(struct statfs **, int) __DARWIN_INODE64(getmntinfo); 1296#if !__DARWIN_ONLY_64_BIT_INO_T 1297int getmntinfo64(struct statfs64 **, int) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_6,__IPHONE_NA,__IPHONE_NA); 1298#endif /* !__DARWIN_ONLY_64_BIT_INO_T */ 1299int mount(const char *, const char *, int, void *); 1300int statfs(const char *, struct statfs *) __DARWIN_INODE64(statfs); 1301#if !__DARWIN_ONLY_64_BIT_INO_T 1302int statfs64(const char *, struct statfs64 *) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_6,__IPHONE_NA,__IPHONE_NA); 1303#endif /* !__DARWIN_ONLY_64_BIT_INO_T */ 1304int unmount(const char *, int); 1305int getvfsbyname(const char *, struct vfsconf *); 1306__END_DECLS 1307 1308#endif /* KERNEL */ 1309#endif /* !_SYS_MOUNT_H_ */ 1310