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