1 /* 2 * Copyright (c) 2000-2024 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, 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 * @(#)vnode.h 8.17 (Berkeley) 5/20/95 62 */ 63 64 #ifndef _VNODE_H_ 65 #define _VNODE_H_ 66 67 #include <stdint.h> 68 #include <sys/appleapiopts.h> 69 #include <sys/cdefs.h> 70 #ifdef KERNEL 71 #include <sys/kernel_types.h> 72 #include <sys/param.h> 73 #include <sys/signal.h> 74 #ifdef KERNEL_PRIVATE 75 #include <mach/mach_types.h> 76 #include <mach/memory_object_types.h> 77 #endif /* KERNEL_PRIVATE */ 78 #else 79 #include <stdint.h> 80 #endif /* KERNEL */ 81 82 /* 83 * The vnode is the focus of all file activity in UNIX. There is a 84 * unique vnode allocated for each active file, each current directory, 85 * each mounted-on file, text file, and the root. 86 */ 87 88 /* 89 * Vnode types. VNON means no type. 90 */ 91 enum vtype { 92 /* 0 */ 93 VNON, 94 /* 1 - 5 */ 95 VREG, VDIR, VBLK, VCHR, VLNK, 96 /* 6 - 10 */ 97 VSOCK, VFIFO, VBAD, VSTR, VCPLX 98 }; 99 100 /* 101 * Vnode tag types. 102 * These are for the benefit of external programs only (e.g., pstat) 103 * and should NEVER be inspected by the kernel. 104 */ 105 enum vtagtype { 106 /* 0 */ 107 VT_NON, 108 /* 1 reserved, overlaps with (CTL_VFS, VFS_NUMMNTOPS) */ 109 VT_UFS, 110 /* 2 - 5 */ 111 VT_NFS, VT_MFS, VT_MSDOSFS, VT_LFS, 112 /* 6 - 10 */ 113 VT_LOFS, VT_FDESC, VT_PORTAL, VT_NULL, VT_UMAP, 114 /* 11 - 15 */ 115 VT_KERNFS, VT_PROCFS, VT_AFS, VT_ISOFS, VT_MOCKFS, 116 /* 16 - 20 */ 117 VT_HFS, VT_ZFS, VT_DEVFS, VT_WEBDAV, VT_UDF, 118 /* 21 - 25 */ 119 VT_AFP, VT_CDDA, VT_CIFS, VT_OTHER, VT_APFS, 120 /* 26 - 27*/ 121 VT_LOCKERFS, VT_BINDFS, 122 }; 123 124 #define HAVE_VT_LOCKERFS 1 125 126 /* 127 * flags for VNOP_BLOCKMAP 128 */ 129 #define VNODE_READ 0x01 130 #define VNODE_WRITE 0x02 131 #define VNODE_BLOCKMAP_NO_TRACK 0x04 // APFS Fusion: Do not track this request 132 #define VNODE_CLUSTER_VERIFY 0x08 // Verification will be performed in the cluster layer 133 134 135 /* flags for VNOP_ALLOCATE */ 136 #define PREALLOCATE 0x00000001 /* preallocate allocation blocks */ 137 #define ALLOCATECONTIG 0x00000002 /* allocate contigious space */ 138 #define ALLOCATEALL 0x00000004 /* allocate all requested space */ 139 /* or no space at all */ 140 #define ALLOCATEPERSIST 0x00000008 /* do not deallocate allocated but unfilled blocks at close(2) */ 141 #define ALLOCATEFROMPEOF 0x00000010 /* allocate from the physical eof */ 142 #define ALLOCATEFROMVOL 0x00000020 /* allocate from the volume offset */ 143 144 /* 145 * Token indicating no attribute value yet assigned. some user source uses this 146 */ 147 #define VNOVAL (-1) 148 149 150 #ifdef KERNEL 151 152 /* 153 * Flags for ioflag. 154 */ 155 #define IO_UNIT 0x0001 /* do I/O as atomic unit */ 156 #define IO_APPEND 0x0002 /* append write to end */ 157 #define IO_SYNC 0x0004 /* do I/O synchronously */ 158 #define IO_NODELOCKED 0x0008 /* underlying node already locked */ 159 #define IO_NDELAY 0x0010 /* FNDELAY flag set in file table */ 160 #define IO_NOZEROFILL 0x0020 /* F_SETSIZE fcntl uses to prevent zero filling */ 161 #ifdef XNU_KERNEL_PRIVATE 162 #define IO_REVOKE IO_NOZEROFILL /* revoked close for tty, will Not be used in conjunction */ 163 #endif /* XNU_KERNEL_PRIVATE */ 164 #define IO_TAILZEROFILL 0x0040 /* zero fills at the tail of write */ 165 #define IO_HEADZEROFILL 0x0080 /* zero fills at the head of write */ 166 #define IO_NOZEROVALID 0x0100 /* do not zero fill if valid page */ 167 #define IO_NOZERODIRTY 0x0200 /* do not zero fill if page is dirty */ 168 #define IO_CLOSE 0x0400 /* I/O issued from close path */ 169 #define IO_NOCACHE 0x0800 /* same effect as VNOCACHE_DATA, but only for this 1 I/O */ 170 #define IO_RAOFF 0x1000 /* same effect as VRAOFF, but only for this 1 I/O */ 171 #define IO_DEFWRITE 0x2000 /* defer write if vfs.defwrite is set */ 172 #define IO_PASSIVE 0x4000 /* this I/O is marked as background I/O so it won't throttle Throttleable I/O */ 173 #define IO_BACKGROUND IO_PASSIVE /* used for backward compatibility. to be removed after IO_BACKGROUND is no longer 174 * used by DiskImages in-kernel mode */ 175 #define IO_NOAUTH 0x8000 /* No authorization checks. */ 176 #define IO_NODIRECT 0x10000 /* don't use direct synchronous writes if IO_NOCACHE is specified */ 177 #define IO_ENCRYPTED 0x20000 /* Retrieve encrypted blocks from the filesystem */ 178 #define IO_RETURN_ON_THROTTLE 0x40000 179 #define IO_SINGLE_WRITER 0x80000 180 #define IO_SYSCALL_DISPATCH 0x100000 /* I/O was originated from a file table syscall */ 181 #define IO_SWAP_DISPATCH 0x200000 /* I/O was originated from the swap layer */ 182 #define IO_SKIP_ENCRYPTION 0x400000 /* Skips en(de)cryption on the IO. Must be initiated from kernel */ 183 #define IO_EVTONLY 0x800000 /* the i/o is being done on an fd that's marked O_EVTONLY */ 184 #define IO_NOCACHE_SYSSPACE 0x1000000 /* same as IO_NOCACHE but also for UIO_SYSSPACE */ 185 #define IO_NOCACHE_SWRITE 0x2000000 /* same as IO_NOCACHE but also lossens retrictions for nocache writes */ 186 187 /* 188 * Component Name: this structure describes the pathname 189 * information that is passed through the VNOP interface. 190 */ 191 struct componentname { 192 /* 193 * Arguments to lookup. 194 */ 195 uint32_t cn_nameiop; /* lookup operation */ 196 uint32_t cn_flags; /* flags (see below) */ 197 #ifdef BSD_KERNEL_PRIVATE 198 vfs_context_t cn_context; 199 struct nameidata *cn_ndp; /* pointer back to nameidata */ 200 201 /* XXX use of these defines are deprecated */ 202 #define cn_proc (cn_context->vc_proc + 0) /* non-lvalue */ 203 #define cn_cred (cn_context->vc_ucred + 0) /* non-lvalue */ 204 205 #else 206 void * cn_reserved1; /* use vfs_context_t */ 207 void * cn_reserved2; /* use vfs_context_t */ 208 #endif 209 /* 210 * Shared between lookup and commit routines. 211 */ 212 char *cn_pnbuf; /* pathname buffer */ 213 int cn_pnlen; /* length of allocated buffer */ 214 char *cn_nameptr; /* pointer to looked up name */ 215 int cn_namelen; /* length of looked up component */ 216 uint32_t cn_hash; /* hash value of looked up name */ 217 uint32_t cn_consume; /* chars to consume in lookup() */ 218 }; 219 220 /* 221 * component name operations (for VNOP_LOOKUP) 222 */ 223 #define LOOKUP 0 /* perform name lookup only */ 224 #define CREATE 1 /* setup for file creation */ 225 #define DELETE 2 /* setup for file deletion */ 226 #define RENAME 3 /* setup for file renaming */ 227 #define OPMASK 3 /* mask for operation */ 228 229 /* 230 * component name operational modifier flags 231 */ 232 #define FOLLOW 0x00000040 /* follow symbolic links */ 233 234 /* 235 * component name parameter descriptors. 236 */ 237 #define ISDOTDOT 0x00002000 /* current component name is .. */ 238 #define MAKEENTRY 0x00004000 /* entry is to be added to name cache */ 239 #define ISLASTCN 0x00008000 /* this is last component of pathname */ 240 241 /* The following structure specifies a vnode for creation */ 242 struct vnode_fsparam { 243 struct mount * vnfs_mp; /* mount point to which this vnode_t is part of */ 244 enum vtype vnfs_vtype; /* vnode type */ 245 const char * vnfs_str; /* File system Debug aid */ 246 struct vnode * vnfs_dvp; /* The parent vnode */ 247 void * vnfs_fsnode; /* inode */ 248 int(**vnfs_vops)(void *); /* vnode dispatch table */ 249 int vnfs_markroot; /* is this a root vnode in FS (not a system wide one) */ 250 int vnfs_marksystem; /* is a system vnode */ 251 dev_t vnfs_rdev; /* dev_t for block or char vnodes */ 252 off_t vnfs_filesize; /* that way no need for getattr in UBC */ 253 struct componentname * vnfs_cnp; /* component name to add to namecache */ 254 uint32_t vnfs_flags; /* flags */ 255 }; 256 257 #define VNFS_NOCACHE 0x01 /* do not add to name cache at this time */ 258 #define VNFS_CANTCACHE 0x02 /* never add this instance to the name cache */ 259 #define VNFS_ADDFSREF 0x04 /* take fs (named) reference */ 260 261 #define VNCREATE_FLAVOR 0 262 #define VCREATESIZE sizeof(struct vnode_fsparam) 263 #ifdef KERNEL_PRIVATE 264 /* 265 * For use with SPI to create trigger vnodes. 266 */ 267 struct vnode_trigger_param; 268 #define VNCREATE_TRIGGER (('T' << 8) + ('V')) 269 #define VNCREATE_TRIGGER_SIZE sizeof(struct vnode_trigger_param) 270 #endif /* KERNEL_PRIVATE */ 271 272 273 #ifdef KERNEL_PRIVATE 274 /* 275 * Resolver callback SPI for trigger vnodes 276 * 277 * Only available from kernels built with CONFIG_TRIGGERS option 278 */ 279 280 /*! 281 * @enum Pathname Lookup Operations 282 * @abstract Constants defining pathname operations (passed to resolver callbacks) 283 */ 284 enum path_operation { 285 OP_LOOKUP, 286 OP_MOUNT, 287 OP_UNMOUNT, 288 OP_STATFS, 289 OP_OPEN, 290 OP_LINK, 291 OP_UNLINK, 292 OP_RENAME, 293 OP_CHDIR, 294 OP_CHROOT, 295 OP_MKNOD, 296 OP_MKFIFO, 297 OP_SYMLINK, 298 OP_ACCESS, 299 OP_PATHCONF, 300 OP_READLINK, 301 OP_GETATTR, 302 OP_SETATTR, 303 OP_TRUNCATE, 304 OP_COPYFILE, 305 OP_MKDIR, 306 OP_RMDIR, 307 OP_REVOKE, 308 OP_EXCHANGEDATA, 309 OP_SEARCHFS, 310 OP_FSCTL, 311 OP_GETXATTR, 312 OP_SETXATTR, 313 OP_REMOVEXATTR, 314 OP_LISTXATTR, 315 OP_MAXOP /* anything beyond previous entry is invalid */ 316 }; 317 318 /*! 319 * @enum resolver status 320 * @abstract Constants defining resolver status 321 * @constant RESOLVER_RESOLVED the resolver has finished (typically means a successful mount) 322 * @constant RESOLVER_NOCHANGE the resolver status didn't change 323 * @constant RESOLVER_UNRESOLVED the resolver has finished (typically means a successful unmount) 324 * @constant RESOLVER_ERROR the resolver encountered an error (errno passed in aux value) 325 * @constant RESOLVER_STOP a request to destroy trigger XXX do we need this??? 326 */ 327 enum resolver_status { 328 RESOLVER_RESOLVED, 329 RESOLVER_NOCHANGE, 330 RESOLVER_UNRESOLVED, 331 RESOLVER_ERROR, 332 RESOLVER_STOP 333 }; 334 335 typedef uint64_t resolver_result_t; 336 337 /* 338 * Compound resolver result 339 * 340 * The trigger vnode callbacks use a compound result value. In addition 341 * to the resolver status, it contains a sequence number and an auxiliary 342 * value. 343 * 344 * The sequence value is used by VFS to sequence-stamp trigger vnode 345 * state transitions. It is expected to be incremented each time a 346 * resolver changes state (ie resolved or unresolved). A result 347 * containing a stale sequence (older than a trigger vnode's current 348 * value) will be ignored by VFS. 349 * 350 * The auxiliary value is currently only used to deliver the errno 351 * value for RESOLVER_ERROR status conditions. When a RESOLVER_ERROR 352 * occurs, VFS will propagate this error back to the syscall that 353 * encountered the trigger vnode. 354 */ 355 extern resolver_result_t vfs_resolver_result(uint32_t seq, enum resolver_status stat, int aux); 356 357 /* 358 * Extract values from a compound resolver result 359 */ 360 extern enum resolver_status vfs_resolver_status(resolver_result_t); 361 extern uint32_t vfs_resolver_sequence(resolver_result_t); 362 extern int vfs_resolver_auxiliary(resolver_result_t); 363 364 365 /*! 366 * @typedef trigger_vnode_resolve_callback_t 367 * @abstract function prototype for a trigger vnode resolve callback 368 * @discussion This function is associated with a trigger vnode during a vnode create. It is 369 * typically called when a lookup operation occurs for a trigger vnode 370 * @param vp The trigger vnode which needs resolving 371 * @param cnp Various data about lookup, e.g. filename and state flags 372 * @param pop The pathname operation that initiated the lookup (see enum path_operation). 373 * @param flags resolve flags 374 * @param data Arbitrary data supplied by vnode trigger creator 375 * @param ctx Context for authentication. 376 * @return RESOLVER_RESOLVED, RESOLVER_NOCHANGE, RESOLVER_UNRESOLVED or RESOLVER_ERROR 377 */ 378 typedef resolver_result_t (* trigger_vnode_resolve_callback_t)( 379 vnode_t vp, 380 const struct componentname * cnp, 381 enum path_operation pop, 382 int flags, 383 void * data, 384 vfs_context_t ctx); 385 386 /*! 387 * @typedef trigger_vnode_unresolve_callback_t 388 * @abstract function prototype for a trigger vnode unresolve callback 389 * @discussion This function is associated with a trigger vnode during a vnode create. It is 390 * called to unresolve a trigger vnode (typically this means unmount). 391 * @param vp The trigger vnode which needs unresolving 392 * @param flags Unmount flags 393 * @param data Arbitrary data supplied by vnode trigger creator 394 * @param ctx Context for authentication. 395 * @return RESOLVER_NOCHANGE, RESOLVER_UNRESOLVED or RESOLVER_ERROR 396 */ 397 typedef resolver_result_t (* trigger_vnode_unresolve_callback_t)( 398 vnode_t vp, 399 int flags, 400 void * data, 401 vfs_context_t ctx); 402 403 /*! 404 * @typedef trigger_vnode_rearm_callback_t 405 * @abstract function prototype for a trigger vnode rearm callback 406 * @discussion This function is associated with a trigger vnode during a vnode create. It is 407 * called to verify a rearm from VFS (i.e. should VFS rearm the trigger?). 408 * @param vp The trigger vnode which needs rearming 409 * @param flags rearm flags 410 * @param data Arbitrary data supplied by vnode trigger creator 411 * @param ctx Context for authentication. 412 * @return RESOLVER_NOCHANGE or RESOLVER_ERROR 413 */ 414 typedef resolver_result_t (* trigger_vnode_rearm_callback_t)( 415 vnode_t vp, 416 int flags, 417 void * data, 418 vfs_context_t ctx); 419 420 /*! 421 * @typedef trigger_vnode_reclaim_callback_t 422 * @abstract function prototype for a trigger vnode reclaim callback 423 * @discussion This function is associated with a trigger vnode during a vnode create. It is 424 * called to deallocate private callback argument data 425 * @param vp The trigger vnode associated with the data 426 * @param data The arbitrary data supplied by vnode trigger creator 427 */ 428 typedef void (* trigger_vnode_reclaim_callback_t)( 429 vnode_t vp, 430 void * data); 431 432 /*! 433 * @function vnode_trigger_update 434 * @abstract Update a trigger vnode's state. 435 * @discussion This allows a resolver to notify VFS of a state change in a trigger vnode. 436 * @param vp The trigger vnode whose information to update. 437 * @param result A compound resolver result value 438 * @return EINVAL if result value is invalid or vp isn't a trigger vnode 439 */ 440 extern int vnode_trigger_update(vnode_t vp, resolver_result_t result); 441 442 struct vnode_trigger_info { 443 trigger_vnode_resolve_callback_t vti_resolve_func; 444 trigger_vnode_unresolve_callback_t vti_unresolve_func; 445 trigger_vnode_rearm_callback_t vti_rearm_func; 446 trigger_vnode_reclaim_callback_t vti_reclaim_func; 447 void * vti_data; /* auxiliary data (optional) */ 448 uint32_t vti_flags; /* optional flags (see below) */ 449 }; 450 451 /* 452 * SPI for creating a trigger vnode 453 * 454 * Uses the VNCREATE_TRIGGER flavor with existing vnode_create() KPI 455 * 456 * Only one resolver per vnode. 457 * 458 * ERRORS (in addition to vnode_create errors): 459 * EINVAL (invalid resolver info, like invalid flags) 460 * ENOTDIR (only directories can have a resolver) 461 * EPERM (vnode cannot be a trigger - eg root dir of a file system) 462 * ENOMEM 463 */ 464 struct vnode_trigger_param { 465 struct vnode_fsparam vnt_params; /* same as for VNCREATE_FLAVOR */ 466 trigger_vnode_resolve_callback_t vnt_resolve_func; 467 trigger_vnode_unresolve_callback_t vnt_unresolve_func; 468 trigger_vnode_rearm_callback_t vnt_rearm_func; 469 trigger_vnode_reclaim_callback_t vnt_reclaim_func; 470 void * vnt_data; /* auxiliary data (optional) */ 471 uint32_t vnt_flags; /* optional flags (see below) */ 472 }; 473 474 /* 475 * vnode trigger flags (vnt_flags) 476 * 477 * VNT_AUTO_REARM: 478 * On unmounts of a trigger mount, automatically re-arm the trigger. 479 * 480 * VNT_NO_DIRECT_MOUNT: 481 * A trigger vnode instance that doesn't directly trigger a mount, 482 * instead it triggers the mounting of sub-trigger nodes. 483 * 484 * VNT_KERN_RESOLVE: 485 * A trigger vnode where all parameters have been set by the kernel, 486 * such as NFS mirror mounts. 487 */ 488 #define VNT_AUTO_REARM (1 << 0) 489 #define VNT_NO_DIRECT_MOUNT (1 << 1) 490 #define VNT_KERN_RESOLVE (1 << 2) 491 #define VNT_VALID_MASK (VNT_AUTO_REARM | VNT_NO_DIRECT_MOUNT | \ 492 VNT_KERN_RESOLVE) 493 494 #endif /* KERNEL_PRIVATE */ 495 496 497 /* 498 * Vnode attributes, new-style. 499 * 500 * The vnode_attr structure is used to transact attribute changes and queries 501 * with the filesystem. 502 * 503 * Note that this structure may be extended, but existing fields must not move. 504 */ 505 506 #define VATTR_INIT(v) do {(v)->va_supported = (v)->va_active = 0ll; (v)->va_vaflags = 0; } while(0) 507 #define VATTR_SET_ACTIVE(v, a) ((v)->va_active |= VNODE_ATTR_ ## a) 508 #define VATTR_SET_SUPPORTED(v, a) ((v)->va_supported |= VNODE_ATTR_ ## a) 509 #define VATTR_IS_SUPPORTED(v, a) ((v)->va_supported & VNODE_ATTR_ ## a) 510 #define VATTR_CLEAR_ACTIVE(v, a) ((v)->va_active &= ~VNODE_ATTR_ ## a) 511 #define VATTR_CLEAR_SUPPORTED(v, a) ((v)->va_supported &= ~VNODE_ATTR_ ## a) 512 #define VATTR_CLEAR_SUPPORTED_ALL(v) ((v)->va_supported = 0) 513 #define VATTR_IS_ACTIVE(v, a) ((v)->va_active & VNODE_ATTR_ ## a) 514 #define VATTR_ALL_SUPPORTED(v) (((v)->va_active & (v)->va_supported) == (v)->va_active) 515 #define VATTR_INACTIVE_SUPPORTED(v) do {(v)->va_active &= ~(v)->va_supported; (v)->va_supported = 0;} while(0) 516 #define VATTR_SET(v, a, x) do { (v)-> a = (x); VATTR_SET_ACTIVE(v, a);} while(0) 517 #define VATTR_WANTED(v, a) VATTR_SET_ACTIVE(v, a) 518 #define VATTR_RETURN(v, a, x) do { (v)-> a = (x); VATTR_SET_SUPPORTED(v, a);} while(0) 519 #define VATTR_NOT_RETURNED(v, a) (VATTR_IS_ACTIVE(v, a) && !VATTR_IS_SUPPORTED(v, a)) 520 521 /* 522 * Two macros to simplify conditional checking in kernel code. 523 */ 524 #define VATTR_IS(v, a, x) (VATTR_IS_SUPPORTED(v, a) && (v)-> a == (x)) 525 #define VATTR_IS_NOT(v, a, x) (VATTR_IS_SUPPORTED(v, a) && (v)-> a != (x)) 526 527 #define VNODE_ATTR_va_rdev (1LL<< 0) /* 00000001 */ 528 #define VNODE_ATTR_va_nlink (1LL<< 1) /* 00000002 */ 529 #define VNODE_ATTR_va_total_size (1LL<< 2) /* 00000004 */ 530 #define VNODE_ATTR_va_total_alloc (1LL<< 3) /* 00000008 */ 531 #define VNODE_ATTR_va_data_size (1LL<< 4) /* 00000010 */ 532 #define VNODE_ATTR_va_data_alloc (1LL<< 5) /* 00000020 */ 533 #define VNODE_ATTR_va_iosize (1LL<< 6) /* 00000040 */ 534 #define VNODE_ATTR_va_uid (1LL<< 7) /* 00000080 */ 535 #define VNODE_ATTR_va_gid (1LL<< 8) /* 00000100 */ 536 #define VNODE_ATTR_va_mode (1LL<< 9) /* 00000200 */ 537 #define VNODE_ATTR_va_flags (1LL<<10) /* 00000400 */ 538 #define VNODE_ATTR_va_acl (1LL<<11) /* 00000800 */ 539 #define VNODE_ATTR_va_create_time (1LL<<12) /* 00001000 */ 540 #define VNODE_ATTR_va_access_time (1LL<<13) /* 00002000 */ 541 #define VNODE_ATTR_va_modify_time (1LL<<14) /* 00004000 */ 542 #define VNODE_ATTR_va_change_time (1LL<<15) /* 00008000 */ 543 #define VNODE_ATTR_va_backup_time (1LL<<16) /* 00010000 */ 544 #define VNODE_ATTR_va_fileid (1LL<<17) /* 00020000 */ 545 #define VNODE_ATTR_va_linkid (1LL<<18) /* 00040000 */ 546 #define VNODE_ATTR_va_parentid (1LL<<19) /* 00080000 */ 547 #define VNODE_ATTR_va_fsid (1LL<<20) /* 00100000 */ 548 #define VNODE_ATTR_va_filerev (1LL<<21) /* 00200000 */ 549 #define VNODE_ATTR_va_gen (1LL<<22) /* 00400000 */ 550 #define VNODE_ATTR_va_encoding (1LL<<23) /* 00800000 */ 551 #define VNODE_ATTR_va_type (1LL<<24) /* 01000000 */ 552 #define VNODE_ATTR_va_name (1LL<<25) /* 02000000 */ 553 #define VNODE_ATTR_va_uuuid (1LL<<26) /* 04000000 */ 554 #define VNODE_ATTR_va_guuid (1LL<<27) /* 08000000 */ 555 #define VNODE_ATTR_va_nchildren (1LL<<28) /* 10000000 */ 556 #define VNODE_ATTR_va_dirlinkcount (1LL<<29) /* 20000000 */ 557 #define VNODE_ATTR_va_addedtime (1LL<<30) /* 40000000 */ 558 #define VNODE_ATTR_va_dataprotect_class (1LL<<31) /* 80000000 */ 559 #define VNODE_ATTR_va_dataprotect_flags (1LL<<32) /* 100000000 */ 560 #define VNODE_ATTR_va_document_id (1LL<<33) /* 200000000 */ 561 #define VNODE_ATTR_va_devid (1LL<<34) /* 400000000 */ 562 #define VNODE_ATTR_va_objtype (1LL<<35) /* 800000000 */ 563 #define VNODE_ATTR_va_objtag (1LL<<36) /* 1000000000 */ 564 #define VNODE_ATTR_va_user_access (1LL<<37) /* 2000000000 */ 565 #define VNODE_ATTR_va_finderinfo (1LL<<38) /* 4000000000 */ 566 #define VNODE_ATTR_va_rsrc_length (1LL<<39) /* 8000000000 */ 567 #define VNODE_ATTR_va_rsrc_alloc (1LL<<40) /* 10000000000 */ 568 #define VNODE_ATTR_va_fsid64 (1LL<<41) /* 20000000000 */ 569 #define VNODE_ATTR_va_write_gencount (1LL<<42) /* 40000000000 */ 570 #define VNODE_ATTR_va_private_size (1LL<<43) /* 80000000000 */ 571 #define VNODE_ATTR_va_clone_id (1LL<<44) /* 100000000000 */ 572 #define VNODE_ATTR_va_extflags (1LL<<45) /* 200000000000 */ 573 #define VNODE_ATTR_va_recursive_gencount (1LL<<46) /* 400000000000 */ 574 #define VNODE_ATTR_va_attribution_tag (1LL<<47) /* 800000000000 */ 575 #define VNODE_ATTR_va_clone_refcnt (1LL<<48) /* 1000000000000 */ 576 577 #define VNODE_ATTR_BIT(n) (VNODE_ATTR_ ## n) 578 579 /* 580 * ALL of the attributes. 581 */ 582 #define VNODE_ATTR_ALL (VNODE_ATTR_BIT(va_rdev) | \ 583 VNODE_ATTR_BIT(va_nlink) | \ 584 VNODE_ATTR_BIT(va_total_size) | \ 585 VNODE_ATTR_BIT(va_total_alloc) | \ 586 VNODE_ATTR_BIT(va_data_size) | \ 587 VNODE_ATTR_BIT(va_data_alloc) | \ 588 VNODE_ATTR_BIT(va_iosize) | \ 589 VNODE_ATTR_BIT(va_uid) | \ 590 VNODE_ATTR_BIT(va_gid) | \ 591 VNODE_ATTR_BIT(va_mode) | \ 592 VNODE_ATTR_BIT(va_flags) | \ 593 VNODE_ATTR_BIT(va_acl) | \ 594 VNODE_ATTR_BIT(va_create_time) | \ 595 VNODE_ATTR_BIT(va_access_time) | \ 596 VNODE_ATTR_BIT(va_modify_time) | \ 597 VNODE_ATTR_BIT(va_change_time) | \ 598 VNODE_ATTR_BIT(va_backup_time) | \ 599 VNODE_ATTR_BIT(va_fileid) | \ 600 VNODE_ATTR_BIT(va_linkid) | \ 601 VNODE_ATTR_BIT(va_parentid) | \ 602 VNODE_ATTR_BIT(va_fsid) | \ 603 VNODE_ATTR_BIT(va_filerev) | \ 604 VNODE_ATTR_BIT(va_gen) | \ 605 VNODE_ATTR_BIT(va_encoding) | \ 606 VNODE_ATTR_BIT(va_type) | \ 607 VNODE_ATTR_BIT(va_name) | \ 608 VNODE_ATTR_BIT(va_uuuid) | \ 609 VNODE_ATTR_BIT(va_guuid) | \ 610 VNODE_ATTR_BIT(va_nchildren) | \ 611 VNODE_ATTR_BIT(va_dirlinkcount) | \ 612 VNODE_ATTR_BIT(va_addedtime) | \ 613 VNODE_ATTR_BIT(va_dataprotect_class) | \ 614 VNODE_ATTR_BIT(va_dataprotect_flags) | \ 615 VNODE_ATTR_BIT(va_document_id) | \ 616 VNODE_ATTR_BIT(va_devid) | \ 617 VNODE_ATTR_BIT(va_objtype) | \ 618 VNODE_ATTR_BIT(va_objtag) | \ 619 VNODE_ATTR_BIT(va_user_access) | \ 620 VNODE_ATTR_BIT(va_finderinfo) | \ 621 VNODE_ATTR_BIT(va_rsrc_length) | \ 622 VNODE_ATTR_BIT(va_rsrc_alloc) | \ 623 VNODE_ATTR_BIT(va_fsid64) | \ 624 VNODE_ATTR_BIT(va_write_gencount) | \ 625 VNODE_ATTR_BIT(va_private_size) | \ 626 VNODE_ATTR_BIT(va_clone_id) | \ 627 VNODE_ATTR_BIT(va_extflags) | \ 628 VNODE_ATTR_BIT(va_recursive_gencount) | \ 629 VNODE_ATTR_BIT(va_attribution_tag) | \ 630 VNODE_ATTR_BIT(va_clone_refcnt)) 631 632 633 /* 634 * Read-only attributes. 635 */ 636 #define VNODE_ATTR_RDONLY (VNODE_ATTR_BIT(va_rdev) | \ 637 VNODE_ATTR_BIT(va_nlink) | \ 638 VNODE_ATTR_BIT(va_total_size) | \ 639 VNODE_ATTR_BIT(va_total_alloc) | \ 640 VNODE_ATTR_BIT(va_data_alloc) | \ 641 VNODE_ATTR_BIT(va_iosize) | \ 642 VNODE_ATTR_BIT(va_fileid) | \ 643 VNODE_ATTR_BIT(va_linkid) | \ 644 VNODE_ATTR_BIT(va_parentid) | \ 645 VNODE_ATTR_BIT(va_fsid) | \ 646 VNODE_ATTR_BIT(va_filerev) | \ 647 VNODE_ATTR_BIT(va_gen) | \ 648 VNODE_ATTR_BIT(va_name) | \ 649 VNODE_ATTR_BIT(va_type) | \ 650 VNODE_ATTR_BIT(va_nchildren) | \ 651 VNODE_ATTR_BIT(va_dirlinkcount) | \ 652 VNODE_ATTR_BIT(va_devid) | \ 653 VNODE_ATTR_BIT(va_objtype) | \ 654 VNODE_ATTR_BIT(va_objtag) | \ 655 VNODE_ATTR_BIT(va_user_access) | \ 656 VNODE_ATTR_BIT(va_finderinfo) | \ 657 VNODE_ATTR_BIT(va_rsrc_length) | \ 658 VNODE_ATTR_BIT(va_rsrc_alloc) | \ 659 VNODE_ATTR_BIT(va_fsid64) | \ 660 VNODE_ATTR_BIT(va_write_gencount) | \ 661 VNODE_ATTR_BIT(va_private_size) | \ 662 VNODE_ATTR_BIT(va_clone_id) | \ 663 VNODE_ATTR_BIT(va_extflags) | \ 664 VNODE_ATTR_BIT(va_recursive_gencount) | \ 665 VNODE_ATTR_BIT(va_attribution_tag) | \ 666 VNODE_ATTR_BIT(va_clone_refcnt)) 667 668 /* 669 * Attributes that can be applied to a new file object. 670 */ 671 #define VNODE_ATTR_NEWOBJ (VNODE_ATTR_BIT(va_rdev) | \ 672 VNODE_ATTR_BIT(va_uid) | \ 673 VNODE_ATTR_BIT(va_gid) | \ 674 VNODE_ATTR_BIT(va_mode) | \ 675 VNODE_ATTR_BIT(va_flags) | \ 676 VNODE_ATTR_BIT(va_acl) | \ 677 VNODE_ATTR_BIT(va_create_time) | \ 678 VNODE_ATTR_BIT(va_modify_time) | \ 679 VNODE_ATTR_BIT(va_change_time) | \ 680 VNODE_ATTR_BIT(va_encoding) | \ 681 VNODE_ATTR_BIT(va_type) | \ 682 VNODE_ATTR_BIT(va_uuuid) | \ 683 VNODE_ATTR_BIT(va_guuid) | \ 684 VNODE_ATTR_BIT(va_dataprotect_class) | \ 685 VNODE_ATTR_BIT(va_dataprotect_flags) | \ 686 VNODE_ATTR_BIT(va_document_id)) 687 688 #include <sys/_types/_fsid_t.h> 689 690 struct vnode_attr { 691 /* bitfields */ 692 uint64_t va_supported; 693 uint64_t va_active; 694 695 /* 696 * Control flags. The low 16 bits are reserved for the 697 * ioflags being passed for truncation operations. 698 */ 699 int va_vaflags; 700 701 /* traditional stat(2) parameter fields */ 702 dev_t va_rdev; /* device id (device nodes only) */ 703 uint64_t va_nlink; /* number of references to this file */ 704 uint64_t va_total_size; /* size in bytes of all forks */ 705 uint64_t va_total_alloc; /* disk space used by all forks */ 706 uint64_t va_data_size; /* size in bytes of the fork managed by current vnode */ 707 uint64_t va_data_alloc; /* disk space used by the fork managed by current vnode */ 708 uint32_t va_iosize; /* optimal I/O blocksize */ 709 710 /* file security information */ 711 uid_t va_uid; /* owner UID */ 712 gid_t va_gid; /* owner GID */ 713 mode_t va_mode; /* posix permissions */ 714 uint32_t va_flags; /* file flags */ 715 struct kauth_acl *va_acl; /* access control list */ 716 717 /* timestamps */ 718 struct timespec va_create_time; /* time of creation */ 719 struct timespec va_access_time; /* time of last access */ 720 struct timespec va_modify_time; /* time of last data modification */ 721 struct timespec va_change_time; /* time of last metadata change */ 722 struct timespec va_backup_time; /* time of last backup */ 723 724 /* file parameters */ 725 uint64_t va_fileid; /* file unique ID in filesystem */ 726 uint64_t va_linkid; /* file link unique ID */ 727 uint64_t va_parentid; /* parent ID */ 728 uint32_t va_fsid; /* filesystem ID */ 729 uint64_t va_filerev; /* file revision counter */ /* XXX */ 730 uint32_t va_gen; /* file generation count */ /* XXX - relationship of 731 * these two? */ 732 /* misc parameters */ 733 uint32_t va_encoding; /* filename encoding script */ 734 735 enum vtype va_type; /* file type */ 736 char * va_name; /* Name for ATTR_CMN_NAME; MAXPATHLEN bytes */ 737 guid_t va_uuuid; /* file owner UUID */ 738 guid_t va_guuid; /* file group UUID */ 739 740 /* Meaningful for directories only */ 741 uint64_t va_nchildren; /* Number of items in a directory */ 742 uint64_t va_dirlinkcount; /* Real references to dir (i.e. excluding "." and ".." refs) */ 743 744 #ifdef BSD_KERNEL_PRIVATE 745 struct kauth_acl *va_base_acl; 746 #else 747 void * va_reserved1; 748 #endif /* BSD_KERNEL_PRIVATE */ 749 struct timespec va_addedtime; /* timestamp when item was added to parent directory */ 750 751 /* Data Protection fields */ 752 uint32_t va_dataprotect_class; /* class specified for this file if it didn't exist */ 753 uint32_t va_dataprotect_flags; /* flags from NP open(2) to the filesystem */ 754 755 /* Document revision tracking */ 756 uint32_t va_document_id; 757 758 /* Fields for Bulk args */ 759 uint32_t va_devid; /* devid of filesystem */ 760 uint32_t va_objtype; /* type of object */ 761 uint32_t va_objtag; /* vnode tag of filesystem */ 762 uint32_t va_user_access; /* access for user */ 763 uint8_t va_finderinfo[32]; /* Finder Info */ 764 uint64_t va_rsrc_length; /* Resource Fork length */ 765 uint64_t va_rsrc_alloc; /* Resource Fork allocation size */ 766 fsid_t va_fsid64; /* fsid, of the correct type */ 767 768 uint32_t va_write_gencount; /* counter that increments each time the file changes */ 769 770 uint64_t va_private_size; /* If the file were deleted, how many bytes would be freed immediately */ 771 uint64_t va_clone_id; /* If a file is cloned this is a unique id shared by all "perfect" clones */ 772 uint64_t va_extflags; /* extended file/directory flags */ 773 uint64_t va_recursive_gencount; /* for dir-stats enabled directories */ 774 uint64_t va_attribution_tag; /* a 64 bit hash of the bundle name associated with this file */ 775 uint32_t va_clone_refcnt; /* the number of "perfect" clones sharing the same clone_id */ 776 777 /* add new fields here only */ 778 }; 779 780 #ifdef BSD_KERNEL_PRIVATE 781 /* 782 * Flags for va_dataprotect_flags 783 */ 784 #define VA_DP_RAWENCRYPTED 0x0001 785 #define VA_DP_RAWUNENCRYPTED 0x0002 786 #define VA_DP_AUTHENTICATE 0x0004 787 788 #endif 789 790 /* 791 * Flags for va_vaflags. 792 */ 793 #define VA_UTIMES_NULL 0x010000 /* utimes argument was NULL */ 794 #define VA_EXCLUSIVE 0x020000 /* exclusive create request */ 795 #define VA_NOINHERIT 0x040000 /* Don't inherit ACLs from parent */ 796 #define VA_NOAUTH 0x080000 797 #define VA_64BITOBJIDS 0x100000 /* fileid/linkid/parentid are 64 bit */ 798 #define VA_REALFSID 0x200000 /* Return real fsid */ 799 #define VA_USEFSID 0x400000 /* Use fsid from filesystem */ 800 #define VA_FILESEC_ACL 0x800000 /* ACL is interior to filesec */ 801 802 /* 803 * Modes. Some values same as Ixxx entries from inode.h for now. 804 */ 805 #define VSUID 0x800 /*04000*/ /* set user id on execution */ 806 #define VSGID 0x400 /*02000*/ /* set group id on execution */ 807 #define VSVTX 0x200 /*01000*/ /* save swapped text even after use */ 808 #define VREAD 0x100 /*00400*/ /* read, write, execute permissions */ 809 #define VWRITE 0x080 /*00200*/ 810 #define VEXEC 0x040 /*00100*/ 811 812 /* 813 * Convert between vnode types and inode formats (since POSIX.1 814 * defines mode word of stat structure in terms of inode formats). 815 */ 816 extern enum vtype iftovt_tab[]; 817 extern int vttoif_tab[]; 818 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12]) 819 #define VTTOIF(indx) (vttoif_tab[(int)(indx)]) 820 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode)) 821 822 /* 823 * Flags to various vnode functions. 824 */ 825 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ 826 #define FORCECLOSE 0x0002 /* vflush: force file closeure */ 827 #define WRITECLOSE 0x0004 /* vflush: only close writeable files */ 828 #define SKIPSWAP 0x0008 /* vflush: skip vnodes marked VSWAP */ 829 #define SKIPROOT 0x0010 /* vflush: skip root vnodes marked VROOT */ 830 831 #define DOCLOSE 0x0008 /* vclean: close active files */ 832 833 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */ 834 #define V_SAVEMETA 0x0002 /* vinvalbuf: leave indirect blocks */ 835 836 #define REVOKEALL 0x0001 /* vnop_revoke: revoke all aliases */ 837 838 /* VNOP_REMOVE/unlink flags */ 839 #define VNODE_REMOVE_NODELETEBUSY 0x0001 /* Don't delete busy files (Carbon) */ 840 #define VNODE_REMOVE_SKIP_NAMESPACE_EVENT 0x0002 /* Do not upcall to userland handlers */ 841 #define VNODE_REMOVE_NO_AUDIT_PATH 0x0004 /* Do not audit the path */ 842 #define VNODE_REMOVE_DATALESS_DIR 0x0008 /* Special handling for removing a dataless directory without materialization */ 843 #ifdef BSD_KERNEL_PRIVATE 844 #define VNODE_REMOVE_NOFOLLOW_ANY 0x0010 845 #endif 846 #define VNODE_REMOVE_SYSTEM_DISCARDED 0x0020 /* Update speculative telemetry with SYSTEM_DISCARDED use state (Default USER_DISCARDED use state) */ 847 848 /* VNOP_READDIR flags: */ 849 #define VNODE_READDIR_EXTENDED 0x0001 /* use extended directory entries */ 850 #define VNODE_READDIR_REQSEEKOFF 0x0002 /* requires seek offset (cookies) */ 851 #define VNODE_READDIR_SEEKOFF32 0x0004 /* seek offset values should fit in 32 bits */ 852 #define VNODE_READDIR_NAMEMAX 0x0008 /* For extended readdir, try to limit names to NAME_MAX bytes */ 853 854 /* VNOP_CLONEFILE flags: */ 855 #define VNODE_CLONEFILE_DEFAULT 0x0000 856 #define VNODE_CLONEFILE_NOOWNERCOPY 0x0001 /* Don't copy ownership information */ 857 858 859 #define NULLVP ((struct vnode *)NULL) 860 861 #ifndef BSD_KERNEL_PRIVATE 862 struct vnodeop_desc; 863 #endif 864 865 extern int desiredvnodes; /* number of vnodes desired */ 866 867 extern struct smr apfs_smr; /* SMR domain for apfs kext, equivalent to _vfs_smr */ 868 869 /* 870 * This structure is used to configure the new vnodeops vector. 871 */ 872 struct vnodeopv_entry_desc { 873 struct vnodeop_desc *opve_op; /* which operation this is */ 874 int (*opve_impl)(void *); /* code implementing this operation */ 875 }; 876 struct vnodeopv_desc { 877 /* ptr to the ptr to the vector where op should go */ 878 int(***opv_desc_vector_p)(void *); 879 const struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */ 880 }; 881 882 /*! 883 * @function vn_default_error 884 * @abstract Default vnode operation to fill unsupported slots in vnode operation vectors. 885 * @return ENOTSUP 886 */ 887 int vn_default_error(void); 888 889 /* 890 * A generic structure. 891 * This can be used by bypass routines to identify generic arguments. 892 */ 893 struct vnop_generic_args { 894 struct vnodeop_desc *a_desc; 895 /* other random data follows, presumably */ 896 }; 897 898 #include <sys/vnode_if.h> 899 900 __BEGIN_DECLS 901 902 /*! 903 * @function vnode_create 904 * @abstract Create and initialize a vnode. 905 * @discussion Returns wth an iocount held on the vnode which must eventually be dropped with vnode_put(). 906 * @param flavor Should be VNCREATE_FLAVOR. 907 * @param size Size of the struct vnode_fsparam in "data". 908 * @param data Pointer to a struct vnode_fsparam containing initialization information. 909 * @param vpp Pointer to a vnode pointer, to be filled in with newly created vnode. 910 * @return 0 for success, error code otherwise. 911 */ 912 errno_t vnode_create(uint32_t flavor, uint32_t size, void *data, vnode_t *vpp); 913 914 #ifdef KERNEL_PRIVATE 915 916 __options_decl(vnode_create_options_t, uint32_t, { 917 VNODE_CREATE_DEFAULT = 0, 918 VNODE_CREATE_EMPTY = 1, 919 VNODE_CREATE_NODEALLOC = 2 920 }); 921 922 #define VNODE_CREATE_DEFAULT VNODE_CREATE_DEFAULT 923 924 /*! 925 * @function vnode_create_ext 926 * @abstract Create and initialize a vnode. 927 * @discussion Returns wth an iocount held on the vnode which must eventually be dropped with vnode_put(). 928 * @param flavor Should be VNCREATE_FLAVOR. 929 * @param size Size of the struct vnode_fsparam in "data". 930 * @param data Pointer to a struct vnode_fsparam containing initialization information. 931 * @param vpp Pointer to a vnode pointer, to be filled in with newly created vnode. 932 * @param vc_options options for vnode creation, by default a vnode that can be deallocated is created, 933 * use VNODE_CREATE_NODEALLOC to override the default behavior. 934 * @return 0 for success, error code otherwise. 935 */ 936 errno_t vnode_create_ext(uint32_t flavor, uint32_t size, void *data, vnode_t *vpp, vnode_create_options_t vc_options); 937 938 /* 939 * vnode create options (vc_options) 940 * 941 * VNODE_CREATE_EMPTY: 942 * An "empty" vnode( i.e. a vnode not initialized with filesystem information) is returned 943 * This results in the flavor, size and data arguments to vnode_create_ext getting ignored. 944 * 945 * VNODE_CREATE_NODEALLOC: 946 * The filesystem does not support vnodes that can be deallocated. By default, vnodes 947 * that are created by using vnode_create_ext can be deallocated and the calling filesytem 948 * uses vnode_hold and vnode_drop approrpiately. This flag should be be used to override 949 * the default behavior. 950 * 951 */ 952 953 /*! 954 * @function vnode_create_empty 955 * @abstract Create an empty, uninitialized vnode. 956 * @discussion Returns with an iocount held on the vnode which must eventually be 957 * dropped with vnode_put(). The next operation performed on the vnode must be 958 * vnode_initialize (or vnode_put if the vnode is not needed anymore). 959 * This interface is provided as a mechanism to pre-flight obtaining a vnode for 960 * certain filesystem operations which may need to get a vnode without filesystem 961 * locks held. It is imperative that nothing be done with the vnode till the 962 * succeeding vnode_initialize (or vnode_put as the case may be) call. 963 * @param vpp Pointer to a vnode pointer, to be filled in with newly created vnode. 964 * @return 0 for success, error code otherwise. 965 */ 966 errno_t vnode_create_empty(vnode_t *vpp); 967 968 /*! 969 * @function vnode_initialize 970 * @abstract Initialize a vnode obtained by vnode_create_empty 971 * @discussion Does not drop iocount held on the vnode which must eventually be 972 * dropped with vnode_put(). In case of an error however, the vnode's iocount is 973 * dropped and the vnode must not be referenced again by the caller. 974 * @param flavor Should be VNCREATE_FLAVOR. 975 * @param size Size of the struct vnode_fsparam in "data". 976 * @param data Pointer to a struct vnode_fsparam containing initialization information. 977 * @param vpp Pointer to a vnode pointer, to be filled in with newly created vnode. 978 * @return 0 for success, error code otherwise. 979 */ 980 errno_t vnode_initialize(uint32_t flavor, uint32_t size, void *data, vnode_t *vpp); 981 #endif /* KERNEL_PRIVATE */ 982 983 /*! 984 * @function vnode_addfsref 985 * @abstract Mark a vnode as being stored in a filesystem hash. 986 * @discussion Should only be called once on a vnode, and never if that vnode was created with VNFS_ADDFSREF. 987 * There should be a corresponding call to vnode_removefsref() when the vnode is reclaimed; VFS assumes that a 988 * n unused vnode will not be marked as referenced by a filesystem. 989 * @param vp The vnode to mark. 990 * @return Always 0. 991 */ 992 int vnode_addfsref(vnode_t vp); 993 994 /*! 995 * @function vnode_removefsref 996 * @abstract Mark a vnode as no longer being stored in a filesystem hash. 997 * @discussion Should only be called once on a vnode (during a reclaim), and only after the vnode has either been created with VNFS_ADDFSREF or marked by vnode_addfsref(). 998 * @param vp The vnode to unmark. 999 * @return Always 0. 1000 */ 1001 int vnode_removefsref(vnode_t vp); 1002 1003 /*! 1004 * @function vnode_hasdirtyblks 1005 * @abstract Check if a vnode has dirty data waiting to be written to disk. 1006 * @discussion Note that this routine is unsynchronized; it is only a snapshot and its result may cease to be true at the moment it is returned.. 1007 * @param vp The vnode to test. 1008 * @return Nonzero if there are dirty blocks, 0 otherwise 1009 */ 1010 int vnode_hasdirtyblks(vnode_t vp); 1011 1012 /*! 1013 * @function vnode_hascleanblks 1014 * @abstract Check if a vnode has clean buffers associated with it. 1015 * @discussion Note that this routine is unsynchronized; it is only a snapshot and its result may cease to be true at the moment it is returned.. 1016 * @param vp The vnode to test. 1017 * @return Nonzero if there are clean blocks, 0 otherwise. 1018 */ 1019 int vnode_hascleanblks(vnode_t vp); 1020 1021 #define VNODE_ASYNC_THROTTLE 15 1022 /*! 1023 * @function vnode_waitforwrites 1024 * @abstract Wait for the number of pending writes on a vnode to drop below a target. 1025 * @param vp The vnode to monitor. 1026 * @param output_target Max pending write count with which to return. 1027 * @param slpflag Flags for msleep(). 1028 * @param slptimeout Frequency with which to force a check for completion; increments of 10 ms. 1029 * @param msg String to pass msleep() . 1030 * @return 0 for success, or an error value from msleep(). 1031 */ 1032 int vnode_waitforwrites(vnode_t vp, int output_target, int slpflag, int slptimeout, const char *msg); 1033 1034 /*! 1035 * @function vnode_startwrite 1036 * @abstract Increment the count of pending writes on a vnode. 1037 * @param vp The vnode whose count to increment. 1038 */ 1039 void vnode_startwrite(vnode_t vp); 1040 1041 /*! 1042 * @function vnode_startwrite 1043 * @abstract Decrement the count of pending writes on a vnode . 1044 * @discussion Also wakes up threads waiting for the write count to drop, as in vnode_waitforwrites. 1045 * @param vp The vnode whose count to decrement. 1046 */ 1047 void vnode_writedone(vnode_t vp); 1048 1049 /*! 1050 * @function vnode_vtype 1051 * @abstract Return a vnode's type. 1052 * @param vp The vnode whose type to grab. 1053 * @return The vnode's type. 1054 */ 1055 enum vtype vnode_vtype(vnode_t vp); 1056 1057 /*! 1058 * @function vnode_vid 1059 * @abstract Return a vnode's vid (generation number), which is constant from creation until reclaim. 1060 * @param vp The vnode whose vid to grab. 1061 * @return The vnode's vid. 1062 */ 1063 uint32_t vnode_vid(vnode_t vp); 1064 1065 /*! 1066 * @function vnode_isonexternalstorage 1067 * @abstract Return whether or not the storage device backing a vnode is external or not. 1068 * @param vp The vnode whose physical location is to be determined. 1069 * @return TRUE if storage device is external, FALSE if otherwise. 1070 */ 1071 boolean_t vnode_isonexternalstorage(vnode_t vp); 1072 1073 /*! 1074 * @function vnode_mountedhere 1075 * @abstract Returns a pointer to a mount placed on top of a vnode, should it exist. 1076 * @param vp The vnode from whom to take the covering mount. 1077 * @return Pointer to mount covering a vnode, or NULL if none exists. 1078 */ 1079 mount_t vnode_mountedhere(vnode_t vp); 1080 1081 /*! 1082 * @function vnode_mount 1083 * @abstract Get the mount structure for the filesystem that a vnode belongs to. 1084 * @param vp The vnode whose mount to grab. 1085 * @return The mount, directly. 1086 */ 1087 mount_t vnode_mount(vnode_t vp); 1088 1089 /*! 1090 * @function vnode_specrdev 1091 * @abstract Return the device id of the device associated with a special file. 1092 * @param vp The vnode whose device id to extract--vnode must be a special file. 1093 * @return The device id. 1094 */ 1095 dev_t vnode_specrdev(vnode_t vp); 1096 1097 /*! 1098 * @function vnode_fsnode 1099 * @abstract Gets the filesystem-specific data associated with a vnode. 1100 * @param vp The vnode whose data to grab. 1101 * @return The filesystem-specific data, directly. 1102 */ 1103 void * vnode_fsnode(vnode_t vp); 1104 1105 /*! 1106 * @function vnode_clearfsnode 1107 * @abstract Sets a vnode's filesystem-specific data to be NULL. 1108 * @discussion This routine should only be called when a vnode is no longer in use, i.e. during a VNOP_RECLAIM. 1109 * @param vp The vnode whose data to clear out. 1110 */ 1111 void vnode_clearfsnode(vnode_t vp); 1112 1113 /*! 1114 * @function vnode_isvroot 1115 * @abstract Determine if a vnode is the root of its filesystem. 1116 * @param vp The vnode to test. 1117 * @return Nonzero if the vnode is the root, 0 if it is not. 1118 */ 1119 int vnode_isvroot(vnode_t vp); 1120 1121 /*! 1122 * @function vnode_issystem 1123 * @abstract Determine if a vnode is marked as a System vnode. 1124 * @param vp The vnode to test. 1125 * @return Nonzero if the vnode is a system vnode, 0 if it is not. 1126 */ 1127 int vnode_issystem(vnode_t vp); 1128 1129 /*! 1130 * @function vnode_ismount 1131 * @abstract Determine if there is currently a mount occurring which will cover this vnode. 1132 * @discussion Note that this is only a snapshot; a mount may begin or end at any time. 1133 * @param vp The vnode to test. 1134 * @return Nonzero if there is a mount in progress, 0 otherwise. 1135 */ 1136 int vnode_ismount(vnode_t vp); 1137 1138 /*! 1139 * @function vnode_isreg 1140 * @abstract Determine if a vnode is a regular file. 1141 * @param vp The vnode to test. 1142 * @return Nonzero if the vnode is of type VREG, 0 otherwise. 1143 */ 1144 int vnode_isreg(vnode_t vp); 1145 1146 /*! 1147 * @function vnode_isdir 1148 * @abstract Determine if a vnode is a directory. 1149 * @param vp The vnode to test. 1150 * @return Nonzero if the vnode is of type VDIR, 0 otherwise. 1151 */ 1152 int vnode_isdir(vnode_t vp); 1153 1154 /*! 1155 * @function vnode_islnk 1156 * @abstract Determine if a vnode is a symbolic link. 1157 * @param vp The vnode to test. 1158 * @return Nonzero if the vnode is of type VLNK, 0 otherwise. 1159 */ 1160 int vnode_islnk(vnode_t vp); 1161 1162 /*! 1163 * @function vnode_isfifo 1164 * @abstract Determine if a vnode is a named pipe. 1165 * @param vp The vnode to test. 1166 * @return Nonzero if the vnode is of type VFIFO, 0 otherwise. 1167 */ 1168 int vnode_isfifo(vnode_t vp); 1169 1170 /*! 1171 * @function vnode_isblk 1172 * @abstract Determine if a vnode is a block device special file. 1173 * @param vp The vnode to test. 1174 * @return Nonzero if the vnode is of type VBLK, 0 otherwise. 1175 */ 1176 int vnode_isblk(vnode_t vp); 1177 1178 /*! 1179 * @function vnode_ischr 1180 * @abstract Determine if a vnode is a character device special file. 1181 * @param vp The vnode to test. 1182 * @return Nonzero if the vnode is of type VCHR, 0 otherwise. 1183 */ 1184 int vnode_ischr(vnode_t vp); 1185 1186 /*! 1187 * @function vnode_isswap 1188 * @abstract Determine if a vnode is being used as a swap file. 1189 * @param vp The vnode to test. 1190 * @return Nonzero if the vnode is being used as swap, 0 otherwise. 1191 */ 1192 int vnode_isswap(vnode_t vp); 1193 1194 /*! 1195 * @function vnode_isnamedstream 1196 * @abstract Determine if a vnode is a named stream. 1197 * @param vp The vnode to test. 1198 * @return Nonzero if the vnode is a named stream, 0 otherwise. 1199 */ 1200 int vnode_isnamedstream(vnode_t vp); 1201 1202 #ifdef KERNEL_PRIVATE 1203 /*! 1204 * @function vnode_setasnamedstream 1205 * @abstract Set svp as a named stream of vp and take appropriate references. 1206 * @param vp The vnode whose namedstream has to be set. 1207 * @param svp The namedstream vnode. 1208 * @return 0 if the operation is successful, an error otherwise. 1209 */ 1210 errno_t vnode_setasnamedstream(vnode_t vp, vnode_t svp); 1211 1212 /*! 1213 * @function vnode_setasfirmlink 1214 * @abstract Set a vnode to act as a firmlink i.e. point to a target vnode. 1215 * @param vp The vnode which is to be acted on as a firmlink. 1216 * @param target_vp The vnode which will be the target of the firmlink. 1217 * @return 0 if the operation is successful, an error otherwise. 1218 */ 1219 errno_t vnode_setasfirmlink(vnode_t vp, vnode_t target_vp); 1220 1221 /*! 1222 * @function vnode_getfirmlink 1223 * @abstract If a vnode is a firmlink, get its target vnode. 1224 * @param vp The firmlink vnode. 1225 * @param target_vp The firmlink traget vnode. This vnode is returned with an iocount. 1226 * @return 0 if the operation is successful, an error otherwise. 1227 */ 1228 errno_t vnode_getfirmlink(vnode_t vp, vnode_t *target_vp); 1229 1230 #endif /* KERNEL_PRIVATE */ 1231 1232 /*! 1233 * @function vnode_ismountedon 1234 * @abstract Determine if a vnode is a block device on which a filesystem has been mounted. 1235 * @discussion A block device marked as being mounted on cannot be opened. 1236 * @param vp The vnode to test. 1237 * @return Nonzero if the vnode is a block device on which an filesystem is mounted, 0 otherwise. 1238 */ 1239 int vnode_ismountedon(vnode_t vp); 1240 1241 /*! 1242 * @function vnode_setmountedon 1243 * @abstract Set flags indicating that a block device vnode has been mounted as a filesystem. 1244 * @discussion A block device marked as being mounted on cannot be opened. 1245 * @param vp The vnode to set flags on, a block device. 1246 */ 1247 void vnode_setmountedon(vnode_t vp); 1248 1249 /*! 1250 * @function vnode_clearmountedon 1251 * @abstract Clear flags indicating that a block device vnode has been mounted as a filesystem. 1252 * @param vp The vnode to clear flags on, a block device. 1253 */ 1254 void vnode_clearmountedon(vnode_t vp); 1255 1256 /*! 1257 * @function vnode_isrecycled 1258 * @abstract Check if a vnode is dead or in the process of being killed (recycled). 1259 * @discussion This is only a snapshot: a vnode may start to be recycled, or go from dead to in use, at any time. 1260 * @param vp The vnode to test. 1261 * @return Nonzero if vnode is dead or being recycled, 0 otherwise. 1262 */ 1263 int vnode_isrecycled(vnode_t vp); 1264 1265 /*! 1266 * @function vnode_willberecycled 1267 * @abstract Check if a vnode is marked for recycling when the last reference to it is released. 1268 * @discussion This is only a snapshot: a vnode may start to be recycled, or go from dead to in use, at any time. 1269 * @param vp The vnode to test. 1270 * @return Nonzero if vnode is marked for recycling, 0 otherwise. 1271 */ 1272 int vnode_willberecycled(vnode_t vp); 1273 1274 /*! 1275 * @function vnode_isnocache 1276 * @abstract Check if a vnode is set to not have its data cached in memory (i.e. we write-through to disk and always read from disk). 1277 * @param vp The vnode to test. 1278 * @return Nonzero if vnode is set to not have data chached, 0 otherwise. 1279 */ 1280 int vnode_isnocache(vnode_t vp); 1281 1282 /*! 1283 * @function vnode_israge 1284 * @abstract Check if a vnode is marked for rapid aging 1285 * @param vp The vnode to test. 1286 * @return Nonzero if vnode is marked for rapid aging, 0 otherwise 1287 */ 1288 int vnode_israge(vnode_t vp); 1289 1290 /*! 1291 * @function vnode_needssnapshots 1292 * @abstract Check if a vnode needs snapshots events (regardless of its ctime status) 1293 * @param vp The vnode to test. 1294 * @return Nonzero if vnode needs snapshot events, 0 otherwise 1295 */ 1296 int vnode_needssnapshots(vnode_t vp); 1297 1298 /*! 1299 * @function vnode_setnocache 1300 * @abstract Set a vnode to not have its data cached in memory (i.e. we write-through to disk and always read from disk). 1301 * @param vp The vnode whose flags to set. 1302 */ 1303 void vnode_setnocache(vnode_t vp); 1304 1305 /*! 1306 * @function vnode_clearnocache 1307 * @abstract Clear the flag on a vnode indicating that data should not be cached in memory (i.e. we write-through to disk and always read from disk). 1308 * @param vp The vnode whose flags to clear. 1309 */ 1310 void vnode_clearnocache(vnode_t vp); 1311 1312 /*! 1313 * @function vnode_isnoreadahead 1314 * @abstract Check if a vnode is set to not have data speculatively read in in hopes of future cache hits. 1315 * @param vp The vnode to test. 1316 * @return Nonzero if readahead is disabled, 0 otherwise. 1317 */ 1318 int vnode_isnoreadahead(vnode_t vp); 1319 1320 /*! 1321 * @function vnode_setnoreadahead 1322 * @abstract Set a vnode to not have data speculatively read in in hopes of hitting in cache. 1323 * @param vp The vnode on which to prevent readahead. 1324 */ 1325 void vnode_setnoreadahead(vnode_t vp); 1326 1327 /*! 1328 * @function vnode_clearnoreadahead 1329 * @abstract Clear the flag indicating that a vnode should not have data speculatively read in. 1330 * @param vp The vnode whose flag to clear. 1331 */ 1332 void vnode_clearnoreadahead(vnode_t vp); 1333 1334 /*! 1335 * @function vnode_isfastdevicecandidate 1336 * @abstract Check if a vnode is a candidate to store on the fast device of a composite disk system 1337 * @param vp The vnode which you want to test. 1338 * @return Nonzero if the vnode is marked as a fast-device candidate 1339 */ 1340 int vnode_isfastdevicecandidate(vnode_t vp); 1341 1342 /*! 1343 * @function vnode_setfastdevicecandidate 1344 * @abstract Mark a vnode as a candidate to store on the fast device of a composite disk system 1345 * @discussion If the vnode is a directory, all its children will inherit this bit. 1346 * @param vp The vnode which you want marked. 1347 */ 1348 void vnode_setfastdevicecandidate(vnode_t vp); 1349 1350 /*! 1351 * @function vnode_clearfastdevicecandidate 1352 * @abstract Clear the status of a vnode being a candidate to store on the fast device of a composite disk system. 1353 * @param vp The vnode whose flag to clear. 1354 */ 1355 void vnode_clearfastdevicecandidate(vnode_t vp); 1356 1357 /*! 1358 * @function vnode_isautocandidate 1359 * @abstract Check if a vnode was automatically selected to be fast-dev candidate (see vnode_setfastdevicecandidate) 1360 * @param vp The vnode which you want to test. 1361 * @return Nonzero if the vnode was automatically marked as a fast-device candidate 1362 */ 1363 int vnode_isautocandidate(vnode_t vp); 1364 1365 /*! 1366 * @function vnode_setfastdevicecandidate 1367 * @abstract Mark a vnode as an automatically selected candidate for storing on the fast device of a composite disk system 1368 * @discussion If the vnode is a directory, all its children will inherit this bit. 1369 * @param vp The vnode which you want marked. 1370 */ 1371 void vnode_setautocandidate(vnode_t vp); 1372 1373 /*! 1374 * @function vnode_clearautocandidate 1375 * @abstract Clear the status of a vnode being an automatic candidate (see above) 1376 * @param vp The vnode whose flag to clear. 1377 */ 1378 void vnode_clearautocandidate(vnode_t vp); 1379 1380 /* left only for compat reasons as User code depends on this from getattrlist, for ex */ 1381 1382 /*! 1383 * @function vnode_settag 1384 * @abstract Set a vnode filesystem-specific "tag." 1385 * @discussion Sets a tag indicating which filesystem a vnode belongs to, e.g. VT_HFS, VT_UDF, VT_ZFS. The kernel never inspects this data, though the filesystem tags are defined in vnode.h; it is for the benefit of user programs via getattrlist. 1386 * @param vp The vnode whose tag to set. 1387 */ 1388 void vnode_settag(vnode_t vp, int tag); 1389 1390 /*! 1391 * @function vnode_tag 1392 * @abstract Get the vnode filesystem-specific "tag." 1393 * @discussion Gets the tag indicating which filesystem a vnode belongs to, e.g. VT_HFS, VT_UDF, VT_ZFS. The kernel never inspects this data, though the filesystem tags are defined in vnode.h; it is for the benefit of user programs via getattrlist. 1394 * @param vp The vnode whose tag to grab. 1395 * @return The tag. 1396 */ 1397 int vnode_tag(vnode_t vp); 1398 1399 /*! 1400 * @function vnode_getattr 1401 * @abstract Get vnode attributes. 1402 * @discussion Desired attributes are set with VATTR_SET_ACTIVE and VNODE_ATTR* macros. Supported attributes are determined after call with VATTR_IS_SUPPORTED. 1403 * @param vp The vnode whose attributes to grab. 1404 * @param vap Structure containing: 1) A list of requested attributes 2) Space to indicate which attributes are supported and being returned 3) Space to return attributes. 1405 * @param ctx Context for authentication. 1406 * @return 0 for success or an error code. 1407 */ 1408 int vnode_getattr(vnode_t vp, struct vnode_attr *vap, vfs_context_t ctx); 1409 1410 /* 1411 * Utility function to deal with 32/64 bit fsid 1412 */ 1413 extern uint64_t vnode_get_va_fsid(struct vnode_attr *vap); 1414 1415 /*! 1416 * @function vnode_setattr 1417 * @abstract Set vnode attributes. 1418 * @discussion Attributes to set are marked with VATTR_SET_ACTIVE and VNODE_ATTR* macros. Attributes successfully set are determined after call with VATTR_IS_SUPPORTED. 1419 * @param vp The vnode whose attributes to set. 1420 * @param vap Structure containing: 1) A list of attributes to set 2) Space for values for those attributes 3) Space to indicate which attributes were set. 1421 * @param ctx Context for authentication. 1422 * @return 0 for success or an error code. 1423 */ 1424 int vnode_setattr(vnode_t vp, struct vnode_attr *vap, vfs_context_t ctx); 1425 1426 /*! 1427 * @function vfs_rootvnode 1428 * @abstract Returns the root vnode with an iocount. 1429 * @discussion Caller must vnode_put() the root node when done. 1430 * @return Pointer to root vnode if successful; error code if there is a problem taking an iocount. 1431 */ 1432 vnode_t vfs_rootvnode(void); 1433 1434 /*! 1435 * @function vnode_uncache_credentials 1436 * @abstract Clear out cached credentials on a vnode. 1437 * @discussion When we authorize an action on a vnode, we cache the credential that was authorized and the actions it was authorized for in case a similar request follows. This function destroys that caching. 1438 * @param vp The vnode whose cache to clear. 1439 */ 1440 void vnode_uncache_credentials(vnode_t vp); 1441 1442 /*! 1443 * @function vnode_setmultipath 1444 * @abstract Mark a vnode as being reachable by multiple paths, i.e. as a hard link. 1445 * @discussion "Multipath" vnodes can be reached through more than one entry in the filesystem, and so must be handled differently for caching and event notification purposes. A filesystem should mark a vnode with multiple hardlinks this way. 1446 * @param vp The vnode to mark. 1447 */ 1448 void vnode_setmultipath(vnode_t vp); 1449 1450 /*! 1451 * @function vnode_vfsmaxsymlen 1452 * @abstract Determine the maximum length of a symbolic link for the filesystem on which a vnode resides. 1453 * @param vp The vnode for which to get filesystem symlink size cap. 1454 * @return Max symlink length. 1455 */ 1456 uint32_t vnode_vfsmaxsymlen(vnode_t vp); 1457 1458 /*! 1459 * @function vnode_vfsisrdonly 1460 * @abstract Determine if the filesystem to which a vnode belongs is mounted read-only. 1461 * @param vp The vnode for which to get filesystem writeability. 1462 * @return Nonzero if the filesystem is read-only, 0 otherwise. 1463 */ 1464 int vnode_vfsisrdonly(vnode_t vp); 1465 1466 /*! 1467 * @function vnode_vfstypenum 1468 * @abstract Get the "type number" of the filesystem to which a vnode belongs. 1469 * @discussion This is an archaic construct; most filesystems are assigned a type number based on the order in which they are registered with the system. 1470 * @param vp The vnode whose filesystem to examine. 1471 * @return The type number of the fileystem to which the vnode belongs. 1472 */ 1473 int vnode_vfstypenum(vnode_t vp); 1474 1475 /*! 1476 * @function vnode_vfsname 1477 * @abstract Get the name of the filesystem to which a vnode belongs. 1478 * @param vp The vnode whose filesystem to examine. 1479 * @param buf Destination for vfs name: should have size MFSNAMELEN or greater. 1480 */ 1481 void vnode_vfsname(vnode_t vp, char *buf); 1482 1483 /*! 1484 * @function vnode_vfs64bitready 1485 * @abstract Determine if the filesystem to which a vnode belongs is marked as ready to interact with 64-bit user processes. 1486 * @param vp The vnode whose filesystem to examine. 1487 * @return Nonzero if filesystem is marked ready for 64-bit interactions; 0 otherwise. 1488 */ 1489 int vnode_vfs64bitready(vnode_t vp); 1490 1491 /* These should move to private ... not documenting for now */ 1492 int vfs_context_get_special_port(vfs_context_t, int, ipc_port_t *); 1493 int vfs_context_set_special_port(vfs_context_t, int, ipc_port_t); 1494 1495 /*! 1496 * @function vfs_context_proc 1497 * @abstract Get the BSD process structure associated with a vfs_context_t. 1498 * @param ctx Context whose associated process to find. 1499 * @return Process if available, NULL otherwise. 1500 */ 1501 proc_t vfs_context_proc(vfs_context_t ctx); 1502 1503 /*! 1504 * @function vfs_context_ucred 1505 * @abstract Get the credential associated with a vfs_context_t. 1506 * @discussion Succeeds if and only if the context has a thread, the thread has a task, and the task has a BSD proc. 1507 * @param ctx Context whose associated process to find. 1508 * @returns credential if process available; NULL otherwise 1509 */ 1510 kauth_cred_t vfs_context_ucred(vfs_context_t ctx); 1511 1512 /*! 1513 * @function vfs_context_pid 1514 * @abstract Get the process id of the BSD process associated with a vfs_context_t. 1515 * @param ctx Context whose associated process to find. 1516 * @return Process id. 1517 */ 1518 int vfs_context_pid(vfs_context_t ctx); 1519 1520 #ifdef KERNEL_PRIVATE 1521 /*! 1522 * @function vfs_context_copy_audit_token 1523 * @abstract Copy the audit token of the BSD process associated with a vfs_context_t. 1524 * @param ctx Context whose associated process to find. 1525 * @param token Pointer to audit token buffer which will receive a copy of the audit token 1526 * @return 0 on success, non-zero if there was a problem obtaining the token 1527 */ 1528 int vfs_context_copy_audit_token(vfs_context_t ctx, audit_token_t *token); 1529 1530 #endif /* KERNEL_PRIVATE */ 1531 1532 /*! 1533 * @function vfs_context_issignal 1534 * @abstract Get a bitfield of pending signals for the BSD process associated with a vfs_context_t. 1535 * @discussion The bitfield is constructed using the sigmask() macro, in the sense of bits |= sigmask(SIGSEGV). 1536 * @param ctx Context whose associated process to find. 1537 * @return Bitfield of pending signals. 1538 */ 1539 int vfs_context_issignal(vfs_context_t ctx, sigset_t mask); 1540 1541 /*! 1542 * @function vfs_context_suser 1543 * @abstract Determine if a vfs_context_t corresponds to the superuser. 1544 * @param ctx Context to examine. 1545 * @return 0 if context belongs to superuser, EPERM otherwise. 1546 */ 1547 int vfs_context_suser(vfs_context_t ctx); 1548 1549 /*! 1550 * @function vfs_context_is64bit 1551 * @abstract Determine if a vfs_context_t corresponds to a 64-bit user process. 1552 * @param ctx Context to examine. 1553 * @return Nonzero if context is of 64-bit process, 0 otherwise. 1554 */ 1555 int vfs_context_is64bit(vfs_context_t ctx); 1556 1557 /*! 1558 * @function vfs_context_create 1559 * @abstract Create a new vfs_context_t with appropriate references held. 1560 * @discussion The context must be released with vfs_context_rele() when no longer in use. 1561 * @param ctx Context to copy, or NULL to use information from running thread. 1562 * @return The new context, or NULL in the event of failure. 1563 */ 1564 vfs_context_t vfs_context_create(vfs_context_t ctx); 1565 1566 #ifdef KERNEL_PRIVATE 1567 /*! 1568 * @function vfs_context_create_with_proc 1569 * @abstract Create a new vfs_context_t with appropriate references held, using the specified proc as a template. 1570 * discussion The context must be released with vfs_context_rele() when no longer in use. 1571 * @param proc Process to use as a template for the new context. 1572 * @return The new context, or NULL in the event of failure. 1573 */ 1574 vfs_context_t vfs_context_create_with_proc(proc_t proc); 1575 #endif /* KERNEL_PRIVATE */ 1576 1577 /*! 1578 * @function vfs_context_rele 1579 * @abstract Release references on components of a context and deallocate it. 1580 * @discussion A context should not be referenced after vfs_context_rele has been called. 1581 * @param ctx Context to release. 1582 * @return Always 0. 1583 */ 1584 int vfs_context_rele(vfs_context_t ctx); 1585 1586 /*! 1587 * @function vfs_context_current 1588 * @abstract Get the vfs_context for the current thread, or the kernel context if there is no context for current thread. 1589 * @discussion Kexts should not use this function--it is preferred to use vfs_context_create(NULL) and vfs_context_rele(), which ensure proper reference counting of underlying structures. 1590 * @return Context for current thread, or kernel context if thread context is unavailable. 1591 */ 1592 vfs_context_t vfs_context_current(void) __pure2; 1593 #ifdef KERNEL_PRIVATE 1594 int vfs_context_bind(vfs_context_t); 1595 1596 /*! 1597 * @function vfs_ctx_skipatime 1598 * @abstract Check to see if this context should skip updating a vnode's access times. 1599 * @discussion This is currently tied to the vnode rapid aging process. If the process is marked for rapid aging, 1600 * then the kernel should not update vnodes it touches for access time purposes. This will check to see if the 1601 * specified process and/or thread is marked for rapid aging when it manipulates vnodes. 1602 * @param ctx The context being investigated. 1603 * @return 1 if we should skip access time updates. 1604 * @return 0 if we should NOT skip access time updates. 1605 */ 1606 1607 int vfs_ctx_skipatime(vfs_context_t ctx); 1608 1609 #endif 1610 1611 /* Supported filesystem tags for vfs_[set|get]_thread_fs_private */ 1612 #define FS_PRIVATE_TAG_APFS (1) 1613 1614 /*! 1615 * @function vfs_set_thread_fs_private 1616 * @abstract Set the per-thread filesystem private data field. 1617 * @discussion Allows a filesystem to store an implementation specific value in the thread struct. 1618 * Note that this field is common to all filesystems thus re-entrancy should be taken into consideration. 1619 * @param tag Filesystem identification tag. 1620 * @param fs_private The value to be set. 1621 * @return 0 for success, ENOTSUP if the filesystem tag is not supported. 1622 */ 1623 int vfs_set_thread_fs_private(uint8_t tag, uint64_t fs_private); 1624 1625 /*! 1626 * @function vfs_get_thread_fs_private 1627 * @abstract Return the per-thread filesystem private data field. 1628 * @discussion Returns the per-thread value that was set by vfs_set_thread_fs_private(). 1629 * @param tag Filesystem identification tag. 1630 * @param fs_private The stored per-thread value. 1631 * @return 0 for success, ENOTSUP if the filesystem tag is not supported. 1632 */ 1633 int vfs_get_thread_fs_private(uint8_t tag, uint64_t *fs_private); 1634 1635 /*! 1636 * @function vflush 1637 * @abstract Reclaim the vnodes associated with a mount. 1638 * @param mp The mount whose vnodes to kill. 1639 * @param skipvp A specific vnode to not reclaim or to let interrupt an un-forced flush 1640 * @param flags Control which 1641 * @discussion This function is used to clear out the vnodes associated with a mount as part of the unmount process. 1642 * Its parameters can determine which vnodes to skip in the process and whether in-use vnodes should be forcibly reclaimed. 1643 * Filesystems should call this function from their unmount code, because VFS code will always call it with SKIPROOT | SKIPSWAP | SKIPSYSTEM; filesystems 1644 * must take care of such vnodes themselves. 1645 * SKIPSYSTEM skip vnodes marked VSYSTEM 1646 * FORCECLOSE force file closeure 1647 * WRITECLOSE only close writeable files 1648 * SKIPSWAP skip vnodes marked VSWAP 1649 * SKIPROOT skip root vnodes marked VROOT 1650 * @return 0 for success, EBUSY if vnodes were busy and FORCECLOSE was not set. 1651 */ 1652 int vflush(struct mount *mp, struct vnode *skipvp, int flags); 1653 1654 /*! 1655 * @function vnode_get 1656 * @abstract Increase the iocount on a vnode. 1657 * @discussion If vnode_get() succeeds, the resulting io-reference must be dropped with vnode_put(). 1658 * This function succeeds unless the vnode in question is dead or in the process of dying AND the current iocount is zero. 1659 * This means that it can block an ongoing reclaim which is blocked behind some other iocount. 1660 * 1661 * On success, vnode_get() returns with an iocount held on the vnode; this type of reference is intended to be held only for short periods of time (e.g. 1662 * across a function call) and provides a strong guarantee about the life of the vnode; vnodes with positive iocounts cannot be 1663 * recycled, and an iocount is required for any operation on a vnode. However, vnode_get() does not provide any guarantees 1664 * about the identity of the vnode it is called on; unless there is a known existing iocount on the vnode at time the call is made, 1665 * it could be recycled and put back in use before the vnode_get() succeeds, so the caller may be referencing a 1666 * completely different vnode than was intended. vnode_getwithref() and vnode_getwithvid() 1667 * provide guarantees about vnode identity. 1668 * 1669 * @return 0 for success, ENOENT if the vnode is dead and without existing io-reference. 1670 */ 1671 int vnode_get(vnode_t); 1672 1673 /*! 1674 * @function vnode_getwithvid 1675 * @abstract Increase the iocount on a vnode, checking that the vnode is alive and has not changed vid (i.e. been recycled) 1676 * @discussion If vnode_getwithvid() succeeds, the resulting io-reference must be dropped with vnode_put(). 1677 * This function succeeds unless the vnode in question is dead, in the process of dying, or has been recycled (and given a different vnode id). 1678 * The intended usage is that a vnode is stored and its vid (vnode_vid(vp)) recorded while an iocount is held (example: a filesystem hash). The 1679 * iocount is then dropped, and time passes (perhaps locks are dropped and picked back up). Subsequently, vnode_getwithvid() is called to get an iocount, 1680 * but we are alerted if the vnode has been recycled. 1681 * 1682 * On success, vnode_getwithvid() returns with an iocount held on the vnode; this type of reference is intended to be held only for short periods of time (e.g. 1683 * across a function call) and provides a strong guarantee about the life of the vnode. vnodes with positive iocounts cannot be 1684 * recycled. An iocount is required for any operation on a vnode. 1685 * @return 0 for success, ENOENT if the vnode is dead, in the process of being reclaimed, or has been recycled and reused. 1686 */ 1687 int vnode_getwithvid(vnode_t, uint32_t); 1688 1689 #ifdef BSD_KERNEL_PRIVATE 1690 int vnode_getwithvid_drainok(vnode_t, uint32_t); 1691 #endif /* BSD_KERNEL_PRIVATE */ 1692 1693 /*! 1694 * @function vnode_getwithref 1695 * @abstract Increase the iocount on a vnode on which a usecount (persistent reference) is held. 1696 * @discussion If vnode_getwithref() succeeds, the resulting io-reference must be dropped with vnode_put(). 1697 * vnode_getwithref() will succeed on dead vnodes; it should fail with ENOENT on vnodes which are in the process of being reclaimed. 1698 * Because it is only called with a usecount on the vnode, the caller is guaranteed that the vnode has not been 1699 * reused for a different file, though it may now be dead and have deadfs vnops (which return errors like EIO, ENXIO, ENOTDIR). 1700 * On success, vnode_getwithref() returns with an iocount held on the vnode; this type of reference is intended to be held only for short periods of time (e.g. 1701 * across a function call) and provides a strong guarantee about the life of the vnode. vnodes with positive iocounts cannot be 1702 * recycled. An iocount is required for any operation on a vnode. 1703 * @return 0 for success, ENOENT if the vnode is dead, in the process of being reclaimed, or has been recycled and reused. 1704 */ 1705 int vnode_getwithref(vnode_t vp); 1706 1707 #ifdef KERNEL_PRIVATE 1708 /*! 1709 * @function vnode_getwithref_noblock 1710 * @abstract Increase the iocount on a vnode on which a usecount (persistent reference) is held. 1711 * @discussion Similar to vnode_getwithref() but returns ENOENT instead of 1712 * blocking when the vnode is being reclaimed. 1713 * @return 0 for success, ENOENT if the vnode is dead, in the process of being 1714 * reclaimed, or has been recycled and reused. 1715 */ 1716 int vnode_getwithref_noblock(vnode_t vp); 1717 #endif /* KERNEL_PRIVATE */ 1718 1719 /*! 1720 * @function vnode_put 1721 * @abstract Decrement the iocount on a vnode. 1722 * @discussion vnode_put() is called to indicate that a vnode is no longer in active use. It removes the guarantee that a 1723 * vnode will not be recycled. This routine should be used to release io references no matter how they were obtained. 1724 * @param vp The vnode whose iocount to drop. 1725 * @return Always 0. 1726 */ 1727 int vnode_put(vnode_t vp); 1728 1729 /*! 1730 * @function vnode_ref 1731 * @abstract Increment the usecount on a vnode. 1732 * @discussion If vnode_ref() succeeds, the resulting usecount must be released with vnode_rele(). vnode_ref() is called to obtain 1733 * a persistent reference on a vnode. This type of reference does not provide the same strong guarantee that a vnode will persist 1734 * as does an iocount--it merely ensures that a vnode will not be reused to represent a different file. However, a usecount may be 1735 * held for extended periods of time, whereas an iocount is intended to be obtained and released quickly as part of performing a 1736 * vnode operation. A holder of a usecount must call vnode_getwithref()/vnode_put() in order to perform any operations on that vnode. 1737 * @param vp The vnode on which to obtain a persistent reference. 1738 * @return 0 for success; ENOENT if the vnode is dead or in the process of being recycled AND the calling thread is not the vnode owner. 1739 */ 1740 int vnode_ref(vnode_t vp); 1741 1742 /*! 1743 * @function vnode_rele 1744 * @abstract Decrement the usecount on a vnode. 1745 * @discussion vnode_rele() is called to relese a persistent reference on a vnode. Releasing the last usecount 1746 * opens the door for a vnode to be reused as a new file; it also triggers a VNOP_INACTIVE call to the filesystem, 1747 * though that will not happen immediately if there are outstanding iocount references. 1748 * @param vp The vnode whose usecount to drop. 1749 */ 1750 void vnode_rele(vnode_t vp); 1751 1752 /*! 1753 * @function vnode_isinuse 1754 * @abstract Determine if the number of persistent (usecount) references on a vnode is greater than a given count. 1755 * @discussion vnode_isinuse() compares a vnode's usecount (corresponding to vnode_ref() calls) to its refcnt parameter 1756 * (the number of references the caller expects to be on the vnode). Note that "kusecount" references, corresponding 1757 * to parties interested only in event notifications, e.g. open(..., O_EVTONLY), are not counted towards the total; the comparison is 1758 * (usecount - kusecount > recnt). It is 1759 * also important to note that the result is only a snapshot; usecounts can change from moment to moment, and the result of vnode_isinuse 1760 * may no longer be correct the very moment that the caller receives it. 1761 * @param vp The vnode whose use-status to check. 1762 * @param refcnt The threshold for saying that a vnode is in use. 1763 */ 1764 int vnode_isinuse(vnode_t vp, int refcnt); 1765 1766 /*! 1767 * @function vnode_hold 1768 * @abstract Increase the holdcount on a vnode. 1769 * @discussion the resulting hold must be dropped with vnode_drop(). 1770 * This function always succeeds and does not block but it can only be used in a context which already has a iocount or a usecount 1771 * or under a synchronization primitive which can block the reclaim (for example a filesystem hash table lock which is also taken in the 1772 * VNOP_RECLAIM implementation for that filesystem.) 1773 * A holdcount only prevents the vnode from being freed and provides no other guarantees. It allows safe access to vnode pointer 1774 * when the vnode access is no longer protected by an iocount, usecount or other sysnchronization primitive. 1775 * @param vp The vnode whose holdcount has to be incremented. 1776 * 1777 */ 1778 void vnode_hold(vnode_t vp); 1779 1780 /*! 1781 * @function vnode_drop 1782 * @abstract decrease the holdcount on vnode. 1783 * @discussion If the holdcount goes to zero and the vnode has been reclaimed, the vnode may also be freed. 1784 * Any access to the vnode after calling vnode_drop is unsafe unless it is a under a iocount or a usecount which has 1785 * been acquired prior to calling vnode_drop. 1786 * @param vp The vnode whose holdcount has to be decremented. 1787 * @return vnode passed and NULLVP if the vnode was freed. 1788 */ 1789 vnode_t vnode_drop(vnode_t vp); 1790 1791 /*! 1792 * @function vnode_recycle 1793 * @abstract Cause a vnode to be reclaimed and prepared for reuse. 1794 * @discussion Like all vnode KPIs, must be called with an iocount on the target vnode. 1795 * vnode_recycle() will mark that vnode for reclaim when all existing references are dropped. 1796 * @param vp The vnode to recycle. 1797 * @return 1 if the vnode was reclaimed (i.e. there were no existing references), 0 if it was only marked for future reclaim. 1798 */ 1799 int vnode_recycle(vnode_t vp); 1800 1801 /*! 1802 * @function vnode_ismonitored 1803 * @abstract Check whether a file has watchers that would make it useful to query a server 1804 * for file changes. 1805 * @param vp Vnode to examine. 1806 * @discussion Will not reenter the filesystem. 1807 * @return Zero if not monitored, nonzero if monitored. 1808 */ 1809 int vnode_ismonitored(vnode_t vp); 1810 1811 #ifdef KERNEL_PRIVATE 1812 1813 #define VNODE_EVENT_DELETE 0x00000001 /* file was removed */ 1814 #define VNODE_EVENT_WRITE 0x00000002 /* file or directory contents changed */ 1815 #define VNODE_EVENT_EXTEND 0x00000004 /* ubc size increased */ 1816 #define VNODE_EVENT_ATTRIB 0x00000008 /* attributes changed (suitable for permission changes if type unknown)*/ 1817 #define VNODE_EVENT_LINK 0x00000010 /* link count changed */ 1818 #define VNODE_EVENT_RENAME 0x00000020 /* vnode was renamed */ 1819 #define VNODE_EVENT_PERMS 0x00000040 /* permissions changed: will cause a NOTE_ATTRIB */ 1820 #define VNODE_EVENT_FILE_CREATED 0x00000080 /* file created in directory: will cause NOTE_WRITE */ 1821 #define VNODE_EVENT_DIR_CREATED 0x00000100 /* directory created inside this directory: will cause NOTE_WRITE */ 1822 #define VNODE_EVENT_FILE_REMOVED 0x00000200 /* file removed from this directory: will cause NOTE_WRITE */ 1823 #define VNODE_EVENT_DIR_REMOVED 0x00000400 /* subdirectory from this directory: will cause NOTE_WRITE */ 1824 1825 #ifdef BSD_KERNEL_PRIVATE 1826 #define VNODE_NOTIFY_ATTRS (VNODE_ATTR_BIT(va_fsid) | \ 1827 VNODE_ATTR_BIT(va_fileid)| \ 1828 VNODE_ATTR_BIT(va_mode) | \ 1829 VNODE_ATTR_BIT(va_uid) | \ 1830 VNODE_ATTR_BIT(va_document_id) | \ 1831 VNODE_ATTR_BIT(va_dirlinkcount) | \ 1832 VNODE_ATTR_BIT(va_nlink)) 1833 1834 1835 1836 #endif /* BSD_KERNEL_PRIVATE */ 1837 1838 /*! 1839 * @function vnode_isdyldsharedcache 1840 * @abstract Check whether a file is a dyld shared cache file. 1841 * @param vp Vnode to examine. 1842 * @discussion Will not reenter the filesystem. 1843 * @return nonzero if a dyld shared cache file, zero otherwise. 1844 */ 1845 int vnode_isdyldsharedcache(vnode_t vp); 1846 1847 1848 /*! 1849 * @function vn_authorize_unlink 1850 * @abstract Authorize an unlink operation given the vfs_context_t 1851 * @discussion Check if the context assocated with vfs_context_t is allowed to unlink the vnode vp in directory dvp. 1852 * @param dvp Parent vnode of the file to be unlinked 1853 * @param vp The vnode to be unlinked 1854 * @param cnp A componentname containing the name of the file to be unlinked. May be NULL. 1855 * @param reserved Pass NULL 1856 * @return returns zero if the operation is allowed, non-zero indicates the unlink is not authorized. 1857 */ 1858 int vn_authorize_unlink(vnode_t dvp, vnode_t vp, struct componentname *cnp, vfs_context_t ctx, void *reserved); 1859 1860 1861 /*! 1862 * @function vn_authorize_rmdir 1863 * @abstract Authorize an rmdir operation given the vfs_context_t 1864 * @discussion Check if the context assocated with vfs_context_t is allowed to rmdir the vnode vp in directory dvp. 1865 * @param dvp Parent vnode of the directory to be rmdir'ed 1866 * @param vp The vnode to be rmdir'ed 1867 * @param cnp A componentname containing the name of the file to be rmdir'ed. May be NULL. 1868 * @param reserved Pass NULL 1869 * @return returns zero if the operation is allowed, non-zero indicates the rmdir is not authorized. 1870 */ 1871 int vn_authorize_rmdir(vnode_t dvp, vnode_t vp, struct componentname *cnp, vfs_context_t ctx, void *reserved); 1872 1873 /*! 1874 * @function vn_getpath_fsenter 1875 * @abstract Attempt to get a vnode's path, willing to enter the filesystem. 1876 * @discussion Paths to vnodes are not always straightforward: a file with multiple hard-links will have multiple pathnames, 1877 * and it is sometimes impossible to determine a vnode's full path. vn_getpath_fsenter() may enter the filesystem 1878 * to try to construct a path, so filesystems should be wary of calling it. 1879 * @param vp Vnode whose path to get 1880 * @param pathbuf Buffer in which to store path. 1881 * @param len Destination for length of resulting path string. Result will include NULL-terminator in count--that is, "len" 1882 * will be strlen(pathbuf) + 1. 1883 * @return 0 for success or an error. 1884 */ 1885 int vn_getpath_fsenter(struct vnode *vp, char *pathbuf, int *len); 1886 1887 /*! 1888 * @function vn_getpath_no_firmlink 1889 * @abstract Attempt to get a vnode's path without a firm-link translation. 1890 * @discussion Paths to vnodes are not always straightforward: a file with multiple hard-links will have multiple pathnames, 1891 * and it is sometimes impossible to determine a vnode's full path. Like vn_getpath, it will not reenter the filesystem. 1892 * @param vp Vnode whose path to get 1893 * @param pathbuf Buffer in which to store path. 1894 * @param len Destination for length of resulting path string. Result will include NULL-terminator in count--that is, "len" 1895 * will be strlen(pathbuf) + 1. 1896 * @return 0 for success or an error. 1897 */ 1898 int vn_getpath_no_firmlink(struct vnode *vp, char *pathbuf, int *len); 1899 1900 /*! 1901 * @function vn_getpath_fsenter_with_parent 1902 * @abstract Attempt to get a vnode's path by entering the file system if needed given a vnode and it's directory vnode. 1903 * @discussion Same as vn_getpath_fsenter but is given the directory vnode as well as the target vnode. Used 1904 * to get the path from the vnode while performing rename, rmdir, and unlink. This is done to avoid potential 1905 * dead lock if another thread is doing a forced unmount. 1906 * @param dvp Containing directory vnode. Must be holding an IO count. 1907 * @param vp Vnode whose path to get. Must be holding an IO count. 1908 * @param pathbuf Buffer in which to store path. 1909 * @param len Destination for length of resulting path string. Result will include NULL-terminator in count--that is, "len" 1910 * will be strlen(pathbuf) + 1. 1911 * @return 0 for success or an error. 1912 */ 1913 int vn_getpath_fsenter_with_parent(struct vnode *dvp, struct vnode *vp, char *pathbuf, int *len); 1914 1915 /*! 1916 * @function vn_getpath_ext 1917 * @abstract Attempt to get a vnode's path without rentering filesystem (unless passed an option to allow) 1918 * @discussion Paths to vnodes are not always straightforward: a file with multiple hard-links will have multiple pathnames, 1919 * and it is sometimes impossible to determine a vnode's full path. vn_getpath_fsenter() may enter the filesystem 1920 * to try to construct a path, so filesystems should be wary of calling it. 1921 * @param vp Vnode whose path to get 1922 * @param dvp parent vnode of vnode whose path to get, can be NULL if not available. 1923 * @param pathbuf Buffer in which to store path. 1924 * @param len Destination for length of resulting path string. Result will include NULL-terminator in count--that is, "len" 1925 * will be strlen(pathbuf) + 1. 1926 * @param flags flags for controlling behavior. 1927 * @return 0 for success or an error. 1928 */ 1929 #define VN_GETPATH_NEW 0x0 1930 int vn_getpath_ext(struct vnode *vp, struct vnode *dvp, char *pathbuf, size_t *len, int flags); 1931 1932 /*! 1933 * @function vn_getpath_ext_with_mntlen 1934 * @abstract Attempt to get a vnode's path without rentering filesystem (unless passed an option to allow) 1935 * @discussion Paths to vnodes are not always straightforward: a file with multiple hard-links will have multiple pathnames, 1936 * and it is sometimes impossible to determine a vnode's full path. vn_getpath_fsenter() may enter the filesystem 1937 * to try to construct a path, so filesystems should be wary of calling it. 1938 * @param vp Vnode whose path to get 1939 * @param dvp parent vnode of vnode whose path to get, can be NULL if not available. 1940 * @param pathbuf Buffer in which to store path. 1941 * @param len Destination for length of resulting path string. Result will include NULL-terminator in count--that is, "len" 1942 * will be strlen(pathbuf) + 1. 1943 * @param mntlen Destination for length of path that is the mount point for the returned path. Will always be less than or equal to len. 1944 * will be strlen(pathbuf) + 1. 1945 * @param flags flags for controlling behavior. 1946 * @return 0 for success or an error. 1947 */ 1948 int vn_getpath_ext_with_mntlen(struct vnode *vp, struct vnode *dvp, char *pathbuf, size_t *len, size_t *mntlen, int flags); 1949 1950 /* supported flags for vn_getpath_ext */ 1951 #define VN_GETPATH_FSENTER 0x0001 /* Can re-enter filesystem */ 1952 #define VN_GETPATH_NO_FIRMLINK 0x0002 1953 #define VN_GETPATH_VOLUME_RELATIVE 0x0004 /* also implies VN_GETPATH_NO_FIRMLINK */ 1954 #define VN_GETPATH_NO_PROCROOT 0x0008 /* Give the non chrooted path for a process */ 1955 #define VN_GETPATH_CHECK_MOVED 0x0010 /* Return EAGAIN if the parent hierarchy is modified */ 1956 1957 #endif /* KERNEL_PRIVATE */ 1958 1959 #define VNODE_UPDATE_PARENT 0x01 1960 #define VNODE_UPDATE_NAMEDSTREAM_PARENT VNODE_UPDATE_PARENT 1961 #define VNODE_UPDATE_NAME 0x02 1962 #define VNODE_UPDATE_CACHE 0x04 1963 #define VNODE_UPDATE_PURGE 0x08 1964 #ifdef BSD_KERNEL_PRIVATE 1965 #define VNODE_UPDATE_PURGEFIRMLINK 0x10 1966 #define VNODE_UPDATE_FORCE_PARENT_REF 0x20 1967 #endif 1968 /*! 1969 * @function vnode_update_identity 1970 * @abstract Update vnode data associated with the vfs cache. 1971 * @discussion The vfs namecache is central to tracking vnode-identifying data and to locating files on the system. vnode_update_identity() 1972 * is used to update vnode data associated with the cache. It can set a vnode's parent and/or name (also potentially set by vnode_create()) 1973 * or flush cache data. 1974 * @param vp The vnode whose information to update. 1975 * @param dvp Parent to set on the vnode if VNODE_UPDATE_PARENT is used. 1976 * @param name Name to set in the cache for the vnode if VNODE_UPDATE_NAME is used. The buffer passed in can be subsequently freed, as the cache 1977 * does its own name storage. String should be NULL-terminated unless length and hash value are specified. 1978 * @param name_len Length of name, if known. Passing 0 causes the cache to determine the length itself. 1979 * @param name_hashval Hash value of name, if known. Passing 0 causes the cache to hash the name itself. 1980 * @param flags VNODE_UPDATE_PARENT: set parent. VNODE_UPDATE_NAME: set name. VNODE_UPDATE_CACHE: flush cache entries for hard links 1981 * associated with this file. VNODE_UPDATE_PURGE: flush cache entries for hard links and children of this file. 1982 */ 1983 void vnode_update_identity(vnode_t vp, vnode_t dvp, const char *name, int name_len, uint32_t name_hashval, int flags); 1984 1985 /*! 1986 * @function vn_bwrite 1987 * @abstract System-provided implementation of "bwrite" vnop. 1988 * @discussion This routine is available for filesystems which do not want to implement their own "bwrite" vnop. It just calls 1989 * buf_bwrite() without modifying its arguments. 1990 * @param ap Standard parameters to a bwrite vnop. 1991 * @return Results of buf_bwrite directly. 1992 */ 1993 int vn_bwrite(struct vnop_bwrite_args *ap); 1994 1995 /*! 1996 * @function vnode_authorize 1997 * @abstract Authorize a kauth-style action on a vnode. 1998 * @discussion Operations on dead vnodes are always allowed (though never do anything). 1999 * @param vp Vnode on which to authorize action. 2000 * @param dvp Parent of "vp," can be NULL. 2001 * @param action Action to authorize, e.g. KAUTH_VNODE_READ_DATA. See bsd/sys/kauth.h. 2002 * @param ctx Context for which to authorize actions. 2003 * @return EACCESS if permission is denied. 0 if operation allowed. Various errors from lower layers. 2004 */ 2005 int vnode_authorize(vnode_t vp, vnode_t dvp, kauth_action_t action, vfs_context_t ctx); 2006 2007 #ifdef KERNEL_PRIVATE 2008 /*! 2009 * @function vnode_attr_authorize_init 2010 * @abstract Initialize attributes for authorization of a kauth-style action on a file system object based on its attributes. 2011 * @discussion This function tells the caller what attributes may be required for a authorizing 2012 * a kauth style action. 2013 * @param vap attributes of file system object on which to authorize action. 2014 * @param dvap attributes of parent of file system object, can be NULL. 2015 * @param action Action to authorize, e.g. KAUTH_VNODE_READ_DATA. See bsd/sys/kauth.h. 2016 * @param ctx Context for which to authorize actions. 2017 * @return EINVAL if a required parameters are not passed (for eg. not passing dvap when the action is KAUTH_ACTION_DELETE), 0 otherwise. 2018 */ 2019 #define VNODE_ATTR_AUTHORIZE_AVAILABLE 0x01 2020 int vnode_attr_authorize_init(struct vnode_attr *vap, struct vnode_attr *dvap, kauth_action_t action, vfs_context_t ctx); 2021 2022 /*! 2023 * @function vnode_attr_authorize 2024 * @abstract Authorize a kauth-style action on a file system object based on its attributes. 2025 * @discussion This function should be preceded by a call to vnode_attr_authorize_init to get what attributes are required. 2026 * @param vap attributes of file system object on which to authorize action. 2027 * @param dvap attributes of parent of file system object, can be NULL. 2028 * @param mp mountpoint to which file system object belongs, can be NULL. 2029 * @param action Action to authorize, e.g. KAUTH_VNODE_READ_DATA. See bsd/sys/kauth.h. 2030 * @param ctx Context for which to authorize actions. 2031 * @return EACCESS if permission is denied. 0 if operation allowed. Various errors from lower layers. 2032 */ 2033 int vnode_attr_authorize(struct vnode_attr *vap, struct vnode_attr *dvap, mount_t mp, kauth_action_t action, vfs_context_t ctx); 2034 #endif /* KERNEL_PRIVATE */ 2035 2036 /*! 2037 * @function vnode_authattr 2038 * @abstract Given a vnode_attr structure, determine what kauth-style actions must be authorized in order to set those attributes. 2039 * @discussion vnode_authorize requires kauth-style actions; if we want to set a vnode_attr structure on a vnode, we need to translate 2040 * the set of attributes to a set of kauth-style actions. This routine will return errors for certain obviously disallowed, or 2041 * incoherent, actions. 2042 * @param vp The vnode on which to authorize action. 2043 * @param vap Pointer to vnode_attr struct containing desired attributes to set and their values. 2044 * @param actionp Destination for set of actions to authorize 2045 * @param ctx Context for which to authorize actions. 2046 * @return 0 (and a result in "actionp" for success. Otherwise, an error code. 2047 */ 2048 int vnode_authattr(vnode_t vp, struct vnode_attr *vap, kauth_action_t *actionp, vfs_context_t ctx); 2049 2050 /*! 2051 * @function vnode_authattr_new 2052 * @abstract Initialize and validate file creation parameters with respect to the current context. 2053 * @discussion vnode_authattr_new() will fill in unitialized values in the vnode_attr struct with defaults, and will validate the structure 2054 * with respect to the current context for file creation. 2055 * @param dvp The directory in which creation will occur. 2056 * @param vap Pointer to vnode_attr struct containing desired attributes to set and their values. 2057 * @param noauth If 1, treat the caller as the superuser, i.e. do not check permissions. 2058 * @param ctx Context for which to authorize actions. 2059 * @return KAUTH_RESULT_ALLOW for success, an error to indicate invalid or disallowed attributes. 2060 */ 2061 int vnode_authattr_new(vnode_t dvp, struct vnode_attr *vap, int noauth, vfs_context_t ctx); 2062 2063 /*! 2064 * @function vnode_close 2065 * @abstract Close a file as opened with vnode_open(). 2066 * @discussion vnode_close() drops the refcount (persistent reference) picked up in vnode_open() and calls down to the filesystem with VNOP_CLOSE. It should 2067 * be called with both an iocount and a refcount on the vnode and will drop both. 2068 * @param vp The vnode to close. 2069 * @param flags Flags to close: FWASWRITTEN indicates that the file was written to. 2070 * @param ctx Context against which to validate operation. 2071 * @return 0 for success or an error from the filesystem. 2072 */ 2073 errno_t vnode_close(vnode_t vp, int flags, vfs_context_t ctx); 2074 2075 /*! 2076 * @function vn_getpath 2077 * @abstract Construct the path to a vnode. 2078 * @discussion Paths to vnodes are not always straightforward: a file with multiple hard-links will have multiple pathnames, 2079 * and it is sometimes impossible to determine a vnode's full path. vn_getpath() will not enter the filesystem. 2080 * @param vp The vnode whose path to obtain. 2081 * @param pathbuf Destination for pathname; should be of size MAXPATHLEN 2082 * @param len Destination for length of resulting path string. Result will include NULL-terminator in count--that is, "len" 2083 * will be strlen(pathbuf) + 1. 2084 * @return 0 for success or an error code. 2085 */ 2086 int vn_getpath(struct vnode *vp, char *pathbuf, int *len); 2087 2088 /*! 2089 * @function vnode_notify 2090 * @abstract Send a notification up to VFS. 2091 * @param vp Vnode for which to provide notification. 2092 * @param vap Attributes for that vnode, to be passed to fsevents. 2093 * @discussion Filesystem determines which attributes to pass up using 2094 * vfs_get_notify_attributes(&vap). The most specific events possible should be passed, 2095 * e.g. VNODE_EVENT_FILE_CREATED on a directory rather than just VNODE_EVENT_WRITE, but 2096 * a less specific event can be passed up if more specific information is not available. 2097 * Will not reenter the filesystem. 2098 * @return 0 for success, else an error code. 2099 */ 2100 int vnode_notify(vnode_t vp, uint32_t events, struct vnode_attr *vap); 2101 2102 /*! 2103 * @function vfs_get_notify_attributes 2104 * @abstract Determine what attributes are required to send up a notification with vnode_notify(). 2105 * @param vap Structure to initialize and activate required attributes on. 2106 * @discussion Will not reenter the filesystem. 2107 * @return 0 for success, nonzero for error (currently always succeeds). 2108 */ 2109 int vfs_get_notify_attributes(struct vnode_attr *vap); 2110 2111 /* 2112 * Flags for the vnode_lookup and vnode_open 2113 */ 2114 #define VNODE_LOOKUP_NOFOLLOW 0x01 2115 #define VNODE_LOOKUP_NOCROSSMOUNT 0x02 2116 #define VNODE_LOOKUP_CROSSMOUNTNOWAIT 0x04 2117 #define VNODE_LOOKUP_NOFOLLOW_ANY 0x08 2118 /*! 2119 * @function vnode_lookup 2120 * @abstract Convert a path into a vnode. 2121 * @discussion This routine is a thin wrapper around xnu-internal lookup routines; if successful, 2122 * it returns with an iocount held on the resulting vnode which must be dropped with vnode_put(). 2123 * @param path Path to look up. 2124 * @param flags VNODE_LOOKUP_NOFOLLOW: do not follow symbolic links. VNODE_LOOKUP_NOCROSSMOUNT: do not cross mount points. 2125 * VNODE_LOOKUP_NOFOLLOW_ANY: no symlinks allowed in path 2126 * @return Results 0 for success or an error code. 2127 */ 2128 errno_t vnode_lookup(const char *path, int flags, vnode_t *vpp, vfs_context_t ctx); 2129 2130 #ifdef KERNEL_PRIVATE 2131 /*! 2132 * @function vnode_lookup starting from a directory vnode (only if path is relative) 2133 * @abstract Convert a path into a vnode. 2134 * @discussion This routine is a thin wrapper around xnu-internal lookup routines; if successful, 2135 * it returns with an iocount held on the resulting vnode which must be dropped with vnode_put(). 2136 * @param path Path to look up. 2137 * @param flags VNODE_LOOKUP_NOFOLLOW: do not follow symbolic links. VNODE_LOOKUP_NOCROSSMOUNT: do not cross mount points. 2138 * VNODE_LOOKUP_NOFOLLOW_ANY: no symlinks allowed in path 2139 * @param start_dvp vnode of directory to start lookup from. This parameter is ignored if path is absolute. start_dvp should 2140 * have an iocount on it. 2141 * @return Results 0 for success or an error code. 2142 */ 2143 errno_t vnode_lookupat(const char *path, int flags, vnode_t *vpp, vfs_context_t ctx, vnode_t start_dvp); 2144 #endif 2145 2146 /*! 2147 * @function vnode_open 2148 * @abstract Open a file identified by a path--roughly speaking an in-kernel open(2). 2149 * @discussion If vnode_open() succeeds, it returns with both an iocount and a usecount on the 2150 * returned vnode. Both will be release once vnode_close is called. 2151 * @param path Path to look up. 2152 * @param fmode e.g. O_NONBLOCK, O_APPEND; see bsd/sys/fcntl.h. 2153 * @param cmode Permissions with which to create file if it does not exist. 2154 * @param flags Same as vnode_lookup(). 2155 * @param vpp Destination for vnode. 2156 * @param ctx Context with which to authorize open/creation. 2157 * @return 0 for success or an error code. 2158 */ 2159 errno_t vnode_open(const char *path, int fmode, int cmode, int flags, vnode_t *vpp, vfs_context_t ctx); 2160 2161 /* 2162 * exported vnode operations 2163 */ 2164 2165 /*! 2166 * @function vnode_iterate 2167 * @abstract Perform an operation on (almost) all vnodes from a given mountpoint. 2168 * @param mp Mount whose vnodes to operate on. 2169 * @param flags 2170 * VNODE_RELOAD Mark inactive vnodes for recycle. 2171 * VNODE_WAIT 2172 * VNODE_WRITEABLE Only examine vnodes with writes in progress. 2173 * VNODE_WITHID No effect. 2174 * VNODE_NOLOCK_INTERNAL No effect. 2175 * VNODE_NODEAD No effect. 2176 * VNODE_NOSUSPEND No effect. 2177 * VNODE_ITERATE_ALL No effect. 2178 * VNODE_ITERATE_ACTIVE No effect. 2179 * VNODE_ITERATE_INACTIVE No effect. 2180 * 2181 * @param callout Function to call on each vnode. 2182 * @param arg Argument which will be passed to callout along with each vnode. 2183 * @return Zero for success, else an error code. Will return 0 immediately if there are no vnodes hooked into the mount. 2184 * @discussion Skips vnodes which are dead, in the process of reclaim, suspended, or of type VNON. 2185 */ 2186 int vnode_iterate(struct mount *mp, int flags, int (*callout)(struct vnode *, void *), void *arg); 2187 2188 /* 2189 * flags passed into vnode_iterate 2190 */ 2191 #define VNODE_RELOAD 0x01 2192 #define VNODE_WAIT 0x02 2193 #define VNODE_WRITEABLE 0x04 2194 #define VNODE_WITHID 0x08 2195 #define VNODE_NOLOCK_INTERNAL 0x10 2196 #define VNODE_NODEAD 0x20 2197 #define VNODE_NOSUSPEND 0x40 2198 #define VNODE_ITERATE_ALL 0x80 2199 #define VNODE_ITERATE_ACTIVE 0x100 2200 #define VNODE_ITERATE_INACTIVE 0x200 2201 #ifdef BSD_KERNEL_PRIVATE 2202 #define VNODE_ALWAYS 0x400 2203 #define VNODE_DRAINO 0x800 2204 #define VNODE_PAGER 0x1000 2205 #define VNODE_NOBLOCK 0x2000 2206 #define VNODE_WITHREF 0x4000 2207 #endif /* BSD_KERNEL_PRIVATE */ 2208 2209 /* 2210 * return values from callback 2211 */ 2212 #define VNODE_RETURNED 0 /* done with vnode, reference can be dropped */ 2213 #define VNODE_RETURNED_DONE 1 /* done with vnode, reference can be dropped, terminate iteration */ 2214 #define VNODE_CLAIMED 2 /* don't drop reference */ 2215 #define VNODE_CLAIMED_DONE 3 /* don't drop reference, terminate iteration */ 2216 2217 /*! 2218 * @function vn_revoke 2219 * @abstract Invalidate all references to a vnode. 2220 * @discussion Reclaims the vnode, giving it deadfs vnops (though not halting operations which are already in progress). 2221 * Also reclaims all aliased vnodes (important for devices). People holding usecounts on the vnode, e.g. processes 2222 * with the file open, will find that all subsequent operations but closing the file fail. 2223 * @param vp The vnode to revoke. 2224 * @param flags Unused. 2225 * @param ctx Context against which to validate operation. 2226 * @return 0 always. 2227 */ 2228 int vn_revoke(vnode_t vp, int flags, vfs_context_t ctx); 2229 2230 /* namecache function prototypes */ 2231 /*! 2232 * @function cache_lookup 2233 * @abstract Check for a filename in a directory using the VFS name cache. 2234 * @discussion cache_lookup() will flush negative cache entries and return 0 if the operation of the cn_nameiop is CREATE or RENAME. 2235 * Often used from the filesystem during a lookup vnop. The filesystem will be called to if there is a negative cache entry for a file, 2236 * so it can make sense to initially check for negative entries (and possibly lush them). 2237 * @param dvp Directory in which lookup is occurring. 2238 * @param vpp Destination for vnode pointer. 2239 * @param cnp Various data about lookup, e.g. filename and intended operation. 2240 * @return ENOENT: the filesystem has previously added a negative entry with cache_enter() to indicate that there is no 2241 * file of the given name in "dp." -1: successfully found a cached vnode (vpp is set). 0: No data in the cache, or operation is CREATE/RENAME. 2242 */ 2243 int cache_lookup(vnode_t dvp, vnode_t *vpp, struct componentname *cnp); 2244 2245 /*! 2246 * @function cache_enter 2247 * @abstract Add a (name,vnode) entry to the VFS namecache. 2248 * @discussion Generally used to add a cache entry after a successful filesystem-level lookup or to add a 2249 * negative entry after one which did not find its target. 2250 * @param dvp Directory in which file lives. 2251 * @param vp File to add to cache. A non-NULL vp is stored for rapid access; a NULL vp indicates 2252 * that there is no such file in the directory and speeds future failed lookups. 2253 * @param cnp Various data about lookup, e.g. filename and intended operation. 2254 */ 2255 void cache_enter(vnode_t dvp, vnode_t vp, struct componentname *cnp); 2256 2257 /*! 2258 * @function cache_purge 2259 * @abstract Remove all data relating to a vnode from the namecache. 2260 * @discussion Will flush all hardlinks to the vnode as well as all children (should any exist). Logical 2261 * to use when cached data about a vnode becomes invalid, for instance in an unlink. 2262 * @param vp The vnode to purge. 2263 */ 2264 void cache_purge(vnode_t vp); 2265 2266 /*! 2267 * @function cache_purge_negatives 2268 * @abstract Remove all negative cache entries which are children of a given vnode. 2269 * @discussion Appropriate to use when negative cache information for a directory could have 2270 * become invalid, e.g. after file creation. 2271 * @param vp The vnode whose negative children to purge. 2272 */ 2273 void cache_purge_negatives(vnode_t vp); 2274 2275 2276 /* 2277 * Global string-cache routines. You can pass zero for nc_hash 2278 * if you don't know it (add_name() will then compute the hash). 2279 * There are no flags for now but maybe someday. 2280 */ 2281 /*! 2282 * @function vfs_addname 2283 * @abstract Deprecated 2284 * @discussion vnode_update_identity() and vnode_create() make vfs_addname() unnecessary for kexts. 2285 */ 2286 const char *vfs_addname(const char *name, uint32_t len, uint32_t nc_hash, uint32_t flags); 2287 2288 /*! 2289 * @function vfs_removename 2290 * @abstract Deprecated 2291 * @discussion vnode_update_identity() and vnode_create() make vfs_addname() unnecessary for kexts. 2292 */ 2293 int vfs_removename(const char *name); 2294 2295 /*! 2296 * @function vcount 2297 * @abstract Count total references to a given file, disregarding "kusecount" (event listener, as with O_EVTONLY) references. 2298 * @discussion For a regular file, just return (usecount-kusecount); for device files, return the sum over all 2299 * vnodes 'v' which reference that device of (usecount(v) - kusecount(v)). Note that this is merely a snapshot and could be 2300 * invalid by the time the caller checks the result. 2301 * @param vp The vnode whose references to count. 2302 * @return Count of references. 2303 */ 2304 int vcount(vnode_t vp); 2305 2306 /*! 2307 * @function vn_path_package_check 2308 * @abstract Figure out if a path corresponds to a Mac OS X package. 2309 * @discussion Determines if the extension on a path is a known OS X extension type. 2310 * @param vp Unused. 2311 * @param path Path to check. 2312 * @param pathlen Size of path buffer. 2313 * @param component Set to index of start of last path component if the path is found to be a package. Set to -1 if 2314 * the path is not a known package type. 2315 * @return 0 unless some parameter was invalid, in which case EINVAL is returned. Determine package-ness by checking 2316 * what *component is set to. 2317 */ 2318 int vn_path_package_check(vnode_t vp, char *path, int pathlen, int *component); 2319 2320 #ifdef KERNEL_PRIVATE 2321 /*! 2322 * @function vn_searchfs_inappropriate_name 2323 * @abstract Figure out if the component is inappropriate for a SearchFS query. 2324 * @param name component to check 2325 * @param len length of component. 2326 * @return 0 if no match, 1 if inappropriate. 2327 */ 2328 int vn_searchfs_inappropriate_name(const char *name, int len); 2329 #endif 2330 2331 /*! 2332 * @function vn_rdwr 2333 * @abstract Read from or write to a file. 2334 * @discussion vn_rdwr() abstracts the details of constructing a uio and picking a vnode operation to allow 2335 * simple in-kernel file I/O. 2336 * @param rw UIO_READ for a read, UIO_WRITE for a write. 2337 * @param vp The vnode on which to perform I/O. 2338 * @param base Start of buffer into which to read or from which to write data. 2339 * @param len Length of buffer. 2340 * @param offset Offset within the file at which to start I/O. 2341 * @param segflg What kind of address "base" is. See uio_seg definition in sys/uio.h. UIO_SYSSPACE for kernelspace, UIO_USERSPACE for userspace. 2342 * UIO_USERSPACE32 and UIO_USERSPACE64 are in general preferred, but vn_rdwr will make sure that has the correct address sizes. 2343 * @param ioflg Defined in vnode.h, e.g. IO_NOAUTH, IO_NOCACHE. 2344 * @param cred Credential to pass down to filesystem for authentication. 2345 * @param aresid Destination for amount of requested I/O which was not completed, as with uio_resid(). 2346 * @param p Process requesting I/O. 2347 * @return 0 for success; errors from filesystem, and EIO if did not perform all requested I/O and the "aresid" parameter is NULL. 2348 */ 2349 int vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base, int len, off_t offset, enum uio_seg segflg, int ioflg, kauth_cred_t cred, int *aresid, proc_t p); 2350 2351 /*! 2352 * @function vn_rdwr_64 2353 * @abstract Read from or write to a file. 2354 * @discussion vn_rdwr_64() abstracts the details of constructing a uio and picking a vnode operation to allow 2355 * simple in-kernel file I/O. 2356 * @param rw UIO_READ for a read, UIO_WRITE for a write. 2357 * @param vp The vnode on which to perform I/O. 2358 * @param base Start of buffer into which to read or from which to write data. 2359 * @param len Length of buffer. 2360 * @param offset Offset within the file at which to start I/O. 2361 * @param segflg What kind of address "base" is. See uio_seg definition in sys/uio.h. UIO_SYSSPACE for kernelspace, UIO_USERSPACE for userspace. 2362 * UIO_USERSPACE32 and UIO_USERSPACE64 are in general preferred, but vn_rdwr will make sure that has the correct address sizes. 2363 * @param ioflg Defined in vnode.h, e.g. IO_NOAUTH, IO_NOCACHE. 2364 * @param cred Credential to pass down to filesystem for authentication. 2365 * @param aresid Destination for amount of requested I/O which was not completed, as with uio_resid(). 2366 * @param p Process requesting I/O. 2367 * @return 0 for success; errors from filesystem, and EIO if did not perform all requested I/O and the "aresid" parameter is NULL. 2368 */ 2369 int vn_rdwr_64(enum uio_rw rw, struct vnode *vp, uint64_t base, int64_t len, off_t offset, enum uio_seg segflg, int ioflg, kauth_cred_t cred, int64_t *aresid, struct proc *p); 2370 2371 #ifdef KERNEL_PRIVATE 2372 /*! 2373 * @function vnode_radvise 2374 * @abstract perform an advisory read on the vnode. 2375 * @param vp vnode on which to perform I/O. Caller should have acquired an iocount prior to calling this function. 2376 * @param offset offset to begin reading from. 2377 * @param len number of bytes to read. 2378 * @param ctx Context against which to validate operation. 2379 * @return 0 for success; errors from filesystem, and EINVAL if offset or len is not valid. 2380 */ 2381 errno_t vnode_rdadvise(vnode_t vp, off_t offset, int len, vfs_context_t ctx); 2382 #endif 2383 2384 /*! 2385 * @function vnode_getname 2386 * @abstract Get the name of a vnode from the VFS namecache. 2387 * @discussion Not all vnodes have names, and vnode names can change (notably, hardlinks). Use this routine at your own risk. 2388 * The string is returned with a refcount incremented in the cache; callers must call vnode_putname() to release that reference. 2389 * @param vp The vnode whose name to grab. 2390 * @return The name, or NULL if unavailable. 2391 */ 2392 const char *vnode_getname(vnode_t vp); 2393 2394 /*! 2395 * @function vnode_putname 2396 * @abstract Release a reference on a name from the VFS cache. 2397 * @discussion Should be called on a string obtained with vnode_getname(). 2398 * @param name String to release. 2399 */ 2400 void vnode_putname(const char *name); 2401 2402 /*! 2403 * @function vnode_getparent 2404 * @abstract Get an iocount on the parent of a vnode. 2405 * @discussion A vnode's parent may change over time or be reclaimed, so vnode_getparent() may return different 2406 * results at different times (e.g. a multiple-hardlink file). The parent is returned with an iocount which must 2407 * subsequently be dropped with vnode_put(). 2408 * @param vp The vnode whose parent to grab. 2409 * @return Parent if available, else NULL. 2410 */ 2411 vnode_t vnode_getparent(vnode_t vp); 2412 2413 /*! 2414 * @function vnode_setdirty 2415 * @abstract Mark the vnode as having data or metadata that needs to be written out during reclaim 2416 * @discussion The vnode should be marked as dirty anytime a file system defers flushing of data or meta-data associated with it. 2417 * @param vp the vnode to mark as dirty 2418 * @return 0 if successful else an error code. 2419 */ 2420 int vnode_setdirty(vnode_t vp); 2421 2422 /*! 2423 * @function vnode_cleardirty 2424 * @abstract Mark the vnode as clean i.e. all its data or metadata has been flushed 2425 * @discussion The vnode should be marked as clean whenever the file system is done flushing data or meta-data associated with it. 2426 * @param vp the vnode to clear as being dirty 2427 * @return 0 if successful else an error code. 2428 */ 2429 int vnode_cleardirty(vnode_t vp); 2430 2431 /*! 2432 * @function vnode_isdirty 2433 * @abstract Determine if a vnode is marked dirty. 2434 * @discussion The vnode should be marked as clean whenever the file system is done flushing data or meta-data associated with it. 2435 * @param vp the vnode to test. 2436 * @return Non-zero if the vnode is dirty, 0 otherwise. 2437 */ 2438 int vnode_isdirty(vnode_t vp); 2439 2440 #ifdef KERNEL_PRIVATE 2441 /*! 2442 * @function vnode_lookup_continue_needed 2443 * @abstract Determine whether vnode needs additional processing in VFS before being opened. 2444 * @discussion If result is zero, filesystem can open this vnode. If result is nonzero, 2445 * additional processing is needed in VFS (e.g. symlink, mountpoint). Nonzero results should 2446 * be passed up to VFS. 2447 * @param vp Vnode to consider opening (found by filesystem). 2448 * @param cnp Componentname as passed to filesystem from VFS. 2449 * @result 0 to indicate that a vnode can be opened, or an error that should be passed up to VFS. 2450 */ 2451 int vnode_lookup_continue_needed(vnode_t vp, struct componentname *cnp); 2452 2453 /*! 2454 * @function vnode_isonssd 2455 * @abstract Return whether or not the storage device backing a vnode is a solid state drive 2456 * @param vp The vnode whose backing store properties are to be queried 2457 * @return TRUE if storage device is an SSD, FALSE if otherwise. 2458 */ 2459 boolean_t vnode_isonssd(vnode_t vp); 2460 2461 /*! 2462 * @function vnode_istty 2463 * @abstract Determine if the given vnode represents a tty device. 2464 * @param vp Vnode to examine. 2465 * @result Non-zero to indicate that the vnode represents a tty device. Zero otherwise. 2466 */ 2467 int vnode_istty(vnode_t vp); 2468 2469 /*! 2470 * @function bdevvp 2471 * @abstract create a vnode for a given dev_t 2472 * @result non-zero to indicate failure, vnode provided in *vpp arg 2473 */ 2474 int bdevvp(dev_t dev, struct vnode **vpp); 2475 2476 /* 2477 * @function vnode_getfromfd 2478 * @abstract get a vnode from a file descriptor 2479 * @result non-zero to indicate failure, vnode provided in *vpp arg 2480 */ 2481 int vnode_getfromfd(vfs_context_t ctx, int fd, vnode_t *vpp); 2482 2483 /* 2484 * @function vnode_parent 2485 * @abstract Get the parent of a vnode. 2486 * @param vp The vnode whose parent to grab. 2487 * @return Parent if available, else NULL. 2488 */ 2489 vnode_t vnode_parent(vnode_t vp); 2490 2491 /* 2492 * @function vnode_getparent_and_name 2493 * @abstract Get an iocount on the parent of a vnode and the name of a vnode from the VFS namecache. 2494 * @discussion Combined version of vnode_getparent() and vnode_getname() to acquire both vnode name and parent 2495 * without releasing the name cache lock in interim. The parent is returned with an iocount which must 2496 * subsequently be dropped with vnode_put(). callers must call vnode_putname() to release the name reference. 2497 * @param vp The vnode whose parent and name to grab. 2498 * @param out_pvp A pointer to the output vnode parent. 2499 * @param out_name A pointer to the output vnode name. 2500 */ 2501 void vnode_getparent_and_name(vnode_t vp, vnode_t *out_pvp, const char **out_name); 2502 2503 /* 2504 * @function vfs_context_thread 2505 * @abstract Return the Mach thread associated with a vfs_context_t. 2506 * @param ctx The context to use. 2507 * @return The thread for this context, or NULL, if there is not one. 2508 */ 2509 thread_t vfs_context_thread(vfs_context_t ctx); 2510 2511 /* 2512 * @function vfs_context_task 2513 * @abstract Return the Mach task associated with a vfs_context_t. 2514 * @param ctx The context to use. 2515 * @return The task for this context, or NULL, if there is not one. 2516 */ 2517 task_t vfs_context_task(vfs_context_t ctx); 2518 2519 /*! 2520 * @function vnode_isauthfs 2521 * @abstract Determine if the given vnode is on an authenticated volume. 2522 * @param vp Vnode to examine. 2523 * @result Non-zero to indicate that the vnode is on an authenticated volume. Zero otherwise. 2524 */ 2525 int vnode_isauthfs(vnode_t vp); 2526 2527 #endif /* KERNEL_PRIVATE */ 2528 2529 #ifdef BSD_KERNEL_PRIVATE 2530 /* Not in export list so can be private */ 2531 struct stat; 2532 int vn_stat(struct vnode *vp, void * sb, kauth_filesec_t *xsec, int isstat64, int needsrealdev, 2533 vfs_context_t ctx); 2534 int vn_stat_noauth(struct vnode *vp, void * sb, kauth_filesec_t *xsec, int isstat64, int needsrealdev, 2535 vfs_context_t ctx, struct ucred *file_cred); 2536 int vaccess(mode_t file_mode, uid_t uid, gid_t gid, 2537 mode_t acc_mode, kauth_cred_t cred); 2538 int check_mountedon(dev_t dev, enum vtype type, int *errorp); 2539 int vn_getcdhash(struct vnode *vp, off_t offset, unsigned char *cdhash, uint8_t *type); 2540 void vnode_reclaim(vnode_t); 2541 vnode_t current_workingdir(void); 2542 void *vnode_vfsfsprivate(vnode_t); 2543 struct vfsstatfs *vnode_vfsstatfs(vnode_t); 2544 uint32_t vnode_vfsvisflags(vnode_t); 2545 uint32_t vnode_vfscmdflags(vnode_t); 2546 int vnode_is_openevt(vnode_t); 2547 void vnode_set_openevt(vnode_t); 2548 void vnode_clear_openevt(vnode_t); 2549 int vnode_isstandard(vnode_t); 2550 int vnode_makeimode(int, int); 2551 enum vtype vnode_iftovt(int); 2552 int vnode_vttoif(enum vtype); 2553 int vnode_isshadow(vnode_t); 2554 boolean_t vnode_on_reliable_media(vnode_t); 2555 /* 2556 * Indicate that a file has multiple hard links. VFS will always call 2557 * VNOP_LOOKUP on this vnode. Volfs will always ask for it's parent 2558 * object ID (instead of using the v_parent pointer). 2559 */ 2560 void vnode_setparent(vnode_t, vnode_t); 2561 void vnode_setname(vnode_t, char *); 2562 #if CONFIG_IOSCHED 2563 vnode_t vnode_mountdevvp(vnode_t); 2564 #endif 2565 #endif /* BSD_KERNEL_PRIVATE */ 2566 2567 #ifdef KERNEL_PRIVATE 2568 /*! 2569 * @function vnode_getname_printable 2570 * @abstract Get a non-null printable name of a vnode. 2571 * @Used to make sure a printable name is returned for all vnodes. If a name exists or can be artificially created, the routine creates a new entry in the VFS namecache. Otherwise, the function returns an artificially created vnode name which is safer and easier to use. vnode_putname_printable() should be used to release names obtained by this routine. 2572 * @param vp The vnode whose name to grab. 2573 * @return The printable name. 2574 */ 2575 const char *vnode_getname_printable(vnode_t vp); 2576 /*! 2577 * @function vnode_putname_printable 2578 * @abstract Release a reference on a name from the VFS cache if it was added by the matching vnode_getname_printable() call. 2579 * @param name String to release. 2580 */ 2581 void vnode_putname_printable(const char *name); 2582 #endif // KERNEL_PRIVATE 2583 2584 /*! 2585 * @function vnode_getbackingvnode 2586 * @abstract If the input vnode is a NULLFS mirrored vnode, then return the vnode it wraps. 2587 * @Used to un-mirror files, primarily for security purposes. On success, out_vp is always set to a vp with an iocount. The caller must release the iocount. 2588 * @param in_vp The vnode being asked about 2589 * @param out_vpp A pointer to the output vnode, unchanged on error 2590 * @return 0 on Success, ENOENT if in_vp doesn't mirror anything, EINVAL on parameter errors. 2591 */ 2592 int vnode_getbackingvnode(vnode_t in_vp, vnode_t* out_vpp); 2593 2594 /* 2595 * Helper functions for implementing VNOP_GETATTRLISTBULK for a filesystem 2596 */ 2597 2598 /*! 2599 * @function vfs_setup_vattr_from_attrlist 2600 * @abstract Setup a vnode_attr structure given an attrlist structure. 2601 * @Used by a VNOP_GETATTRLISTBULK implementation to setup a vnode_attr structure from a attribute list. It also returns the fixed size of the attribute buffer required. 2602 * @warning this forces new fork attr behavior, i.e. reinterpret forkattr bits as ATTR_CMNEXT 2603 * @param alp Pointer to attribute list structure. 2604 * @param vap Pointer to vnode_attr structure. 2605 * @param obj_vtype Type of object - If VNON is passed, then the type is ignored and common, file and dir attrs are used to initialise the vattrs. If set to VDIR, only common and directory attributes are used. For all other types, only common and file attrbutes are used. 2606 * @param attr_fixed_sizep Returns the fixed length required in the attrbute buffer for the object. NULL should be passed if it is not required. 2607 * @param ctx vfs context of caller. 2608 * @return error. 2609 */ 2610 errno_t vfs_setup_vattr_from_attrlist(struct attrlist *alp, struct vnode_attr *vap, enum vtype obj_vtype, ssize_t *attr_fixed_sizep, vfs_context_t ctx); 2611 2612 /*! 2613 * @function vfs_attr_pack 2614 * @abstract Pack a vnode_attr structure into a buffer in the same format as getattrlist(2). 2615 * @Used by a VNOP_GETATTRLISTBULK implementation to pack data provided into a vnode_attr structure into a buffer the way getattrlist(2) does. 2616 * @param vp If available, the vnode for which the attributes are being given, NULL if vnode is not available (which will usually be the case for a VNOP_GETATTRLISTBULK implementation. 2617 * @param uio - a uio_t initialised with one iovec.. 2618 * @param alp - Pointer to an attrlist structure. 2619 * @param options - options for call (same as options for getattrlistbulk(2)). 2620 * @param vap Pointer to a filled in vnode_attr structure. Data from the vnode_attr structure will be used to copy and lay out the data in the required format for getatrlistbulk(2) by this function. 2621 * @param fndesc Currently unused 2622 * @param ctx vfs context of caller. 2623 * @return error. 2624 */ 2625 errno_t vfs_attr_pack(vnode_t vp, uio_t uio, struct attrlist *alp, uint64_t options, struct vnode_attr *vap, void *fndesc, vfs_context_t ctx); 2626 2627 /*! 2628 * @function vfs_attr_pack_ex 2629 * @abstract Pack a vnode_attr structure into a buffer in the same format as getattrlist(2). 2630 * @Used by a VNOP_GETATTRLISTBULK implementation to pack data provided into a vnode_attr structure into a buffer the way getattrlist(2) does. 2631 * @param mp the mount structure for the filesystem the packing operation is happening on. 2632 * @param vp If available, the vnode for which the attributes are being given, NULL if vnode is not available (which will usually be the case for a VNOP_GETATTRLISTBULK implementation. 2633 * @param uio - a uio_t initialised with one iovec.. 2634 * @param alp - Pointer to an attrlist structure. 2635 * @param options - options for call (same as options for getattrlistbulk(2)). 2636 * @param vap Pointer to a filled in vnode_attr structure. Data from the vnode_attr structure will be used to copy and lay out the data in the required format for getatrlistbulk(2) by this function. 2637 * @param fndesc Currently unused 2638 * @param ctx vfs context of caller. 2639 * @return error. 2640 */ 2641 errno_t vfs_attr_pack_ext(mount_t mp, vnode_t vp, uio_t uio, struct attrlist *alp, uint64_t options, struct vnode_attr *vap, void *fndesc, vfs_context_t ctx); 2642 2643 #ifdef KERNEL_PRIVATE 2644 2645 /* vnode manipulations for devices */ 2646 int vnode_cmp_chrtoblk(vnode_t vp, vnode_t blk_vp); 2647 2648 // Returns a value suitable, safe and consistent for tracing and logging 2649 vm_offset_t kdebug_vnode(vnode_t vp); 2650 int vn_pathconf(vnode_t, int, int32_t *, vfs_context_t); 2651 int vnode_should_flush_after_write(vnode_t vp, int ioflag); 2652 void vfs_setowner(mount_t mp, uid_t uid, gid_t gid); 2653 uint64_t vfs_idle_time(mount_t mp); 2654 // Required until XsanFS is fixed... 2655 #ifndef vnode_usecount 2656 int vnode_usecount(vnode_t vp); 2657 #endif 2658 int vnode_writecount(vnode_t vp); 2659 int vnode_iocount(vnode_t vp); 2660 void vnode_rele_ext(vnode_t, int, int); 2661 int is_package_name(const char *name, int len); 2662 int vfs_context_issuser(vfs_context_t); 2663 int vfs_context_iskernel(vfs_context_t); 2664 vfs_context_t vfs_context_kernel(void) __pure2; /* get from 1st kernel thread */ 2665 vnode_t vfs_context_cwd(vfs_context_t); 2666 vnode_t vfs_context_get_cwd(vfs_context_t); /* get cwd with iocount */ 2667 int vnode_isnoflush(vnode_t); 2668 void vnode_setnoflush(vnode_t); 2669 void vnode_clearnoflush(vnode_t); 2670 memory_object_control_t vnode_memoryobject(vnode_t); 2671 #if CONFIG_IO_COMPRESSION_STATS 2672 void vnode_iocs_record_and_free(vnode_t); 2673 #endif /* CONFIG_IO_COMPRESSION_STATS */ 2674 2675 #define BUILDPATH_NO_FS_ENTER 0x1 /* Use cache values, do not enter file system */ 2676 #define BUILDPATH_CHECKACCESS 0x2 /* Check if parents have search rights */ 2677 #define BUILDPATH_CHECK_MOVED 0x4 /* Return EAGAIN if the parent hierarchy is modified */ 2678 #define BUILDPATH_VOLUME_RELATIVE 0x8 /* Return path relative to the nearest mount point */ 2679 #define BUILDPATH_NO_FIRMLINK 0x10 /* Return non-firmlinked path */ 2680 #define BUILDPATH_NO_PROCROOT 0x20 /* Return path relative to system root, not the process root */ 2681 2682 int vnode_issubdir(vnode_t vp, vnode_t dvp, int *is_subdir, vfs_context_t ctx); 2683 2684 struct vniodesc; 2685 typedef struct vniodesc *vniodesc_t; 2686 2687 #define VNIO_SUPPORT_PRESENT 2688 errno_t vnio_openfd(int fd, vniodesc_t *vniop); 2689 errno_t vnio_close(vniodesc_t); 2690 errno_t vnio_read(vniodesc_t, uio_t); 2691 vnode_t vnio_vnode(vniodesc_t); 2692 2693 int cache_lookup_ext(vnode_t dvp, vnode_t *vpp, struct componentname *cnp, 2694 int flags); 2695 #define CACHE_LOOKUP_ALLHITS 0x01 /* report all hits, even negatives for CREATE or RENAME */ 2696 2697 #endif // KERNEL_PRIVATE 2698 2699 #ifdef XNU_KERNEL_PRIVATE 2700 int build_path(vnode_t first_vp, char *buff, int buflen, int *outlen, int flags, vfs_context_t ctx); 2701 #endif 2702 2703 __END_DECLS 2704 2705 #endif /* KERNEL */ 2706 2707 /* 2708 * Structure for vnode level IO compression stats 2709 */ 2710 2711 #define IOCS_BUFFER_NUM_SIZE_BUCKETS 10 2712 #define IOCS_BUFFER_MAX_BUCKET 9 2713 #define IOCS_BUFFER_NUM_COMPRESSION_BUCKETS 7 2714 #define IOCS_BLOCK_NUM_SIZE_BUCKETS 16 2715 2716 struct io_compression_stats { 2717 uint64_t uncompressed_size; 2718 uint64_t compressed_size; 2719 uint32_t buffer_size_compression_dist[IOCS_BUFFER_NUM_SIZE_BUCKETS][IOCS_BUFFER_NUM_COMPRESSION_BUCKETS]; 2720 uint32_t block_compressed_size_dist[IOCS_BLOCK_NUM_SIZE_BUCKETS]; 2721 }; 2722 typedef struct io_compression_stats *io_compression_stats_t; 2723 2724 #define IOCS_SBE_PATH_LEN 128 2725 #define IOCS_PATH_START_BYTES_TO_COPY 108 2726 #define IOCS_PATH_END_BYTES_TO_COPY 20 /* Includes null termination */ 2727 2728 #define IOCS_SYSCTL_LIVE 0x00000001 2729 #define IOCS_SYSCTL_STORE_BUFFER_RD_ONLY 0x00000002 2730 #define IOCS_SYSCTL_STORE_BUFFER_MARK 0x00000004 2731 2732 struct iocs_store_buffer_entry { 2733 char path_name[IOCS_SBE_PATH_LEN]; 2734 struct io_compression_stats iocs; 2735 }; 2736 2737 #ifdef KERNEL_PRIVATE 2738 boolean_t vnode_is_rsr(vnode_t); 2739 #endif 2740 2741 #endif /* !_VNODE_H_ */ 2742