1 /*- 2 * Copyright (c) 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)vnode.h 8.7 (Berkeley) 2/4/94 30 * $FreeBSD$ 31 */ 32 33 #ifndef _SYS_VNODE_H_ 34 #define _SYS_VNODE_H_ 35 36 #include <sys/bufobj.h> 37 #include <sys/queue.h> 38 #include <sys/lock.h> 39 #include <sys/lockmgr.h> 40 #include <sys/mutex.h> 41 #include <sys/selinfo.h> 42 #include <sys/uio.h> 43 #include <sys/acl.h> 44 #include <sys/ktr.h> 45 46 /* 47 * The vnode is the focus of all file activity in UNIX. There is a 48 * unique vnode allocated for each active file, each current directory, 49 * each mounted-on file, text file, and the root. 50 */ 51 52 /* 53 * Vnode types. VNON means no type. 54 */ 55 enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD, 56 VMARKER }; 57 58 /* 59 * Each underlying filesystem allocates its own private area and hangs 60 * it from v_data. If non-null, this area is freed in getnewvnode(). 61 */ 62 63 struct namecache; 64 65 struct vpollinfo { 66 struct mtx vpi_lock; /* lock to protect below */ 67 struct selinfo vpi_selinfo; /* identity of poller(s) */ 68 short vpi_events; /* what they are looking for */ 69 short vpi_revents; /* what has happened */ 70 }; 71 72 /* 73 * Reading or writing any of these items requires holding the appropriate lock. 74 * 75 * Lock reference: 76 * c - namecache mutex 77 * f - freelist mutex 78 * G - Giant 79 * i - interlock 80 * m - mntvnodes mutex 81 * p - pollinfo lock 82 * s - spechash mutex 83 * S - syncer mutex 84 * u - Only a reference to the vnode is needed to read. 85 * v - vnode lock 86 * 87 * Vnodes may be found on many lists. The general way to deal with operating 88 * on a vnode that is on a list is: 89 * 1) Lock the list and find the vnode. 90 * 2) Lock interlock so that the vnode does not go away. 91 * 3) Unlock the list to avoid lock order reversals. 92 * 4) vget with LK_INTERLOCK and check for ENOENT, or 93 * 5) Check for DOOMED if the vnode lock is not required. 94 * 6) Perform your operation, then vput(). 95 */ 96 97 #if defined(_KERNEL) || defined(_KVM_VNODE) 98 99 struct vnode { 100 /* 101 * Fields which define the identity of the vnode. These fields are 102 * owned by the filesystem (XXX: and vgone() ?) 103 */ 104 enum vtype v_type; /* u vnode type */ 105 const char *v_tag; /* u type of underlying data */ 106 struct vop_vector *v_op; /* u vnode operations vector */ 107 void *v_data; /* u private data for fs */ 108 109 /* 110 * Filesystem instance stuff 111 */ 112 struct mount *v_mount; /* u ptr to vfs we are in */ 113 TAILQ_ENTRY(vnode) v_nmntvnodes; /* m vnodes for mount point */ 114 115 /* 116 * Type specific fields, only one applies to any given vnode. 117 * See #defines below for renaming to v_* namespace. 118 */ 119 union { 120 struct mount *vu_mount; /* v ptr to mountpoint (VDIR) */ 121 struct socket *vu_socket; /* v unix domain net (VSOCK) */ 122 struct cdev *vu_cdev; /* v device (VCHR, VBLK) */ 123 struct fifoinfo *vu_fifoinfo; /* v fifo (VFIFO) */ 124 int vu_yield; /* yield count (VMARKER) */ 125 } v_un; 126 127 /* 128 * vfs_hash: (mount + inode) -> vnode hash. 129 */ 130 LIST_ENTRY(vnode) v_hashlist; 131 u_int v_hash; 132 133 /* 134 * VFS_namecache stuff 135 */ 136 LIST_HEAD(, namecache) v_cache_src; /* c Cache entries from us */ 137 TAILQ_HEAD(, namecache) v_cache_dst; /* c Cache entries to us */ 138 struct namecache *v_cache_dd; /* c Cache entry for .. vnode */ 139 140 /* 141 * clustering stuff 142 */ 143 daddr_t v_cstart; /* v start block of cluster */ 144 daddr_t v_lasta; /* v last allocation */ 145 daddr_t v_lastw; /* v last write */ 146 int v_clen; /* v length of cur. cluster */ 147 148 /* 149 * Locking 150 */ 151 struct lock v_lock; /* u (if fs don't have one) */ 152 struct mtx v_interlock; /* lock for "i" things */ 153 struct lock *v_vnlock; /* u pointer to vnode lock */ 154 int v_holdcnt; /* i prevents recycling. */ 155 int v_usecount; /* i ref count of users */ 156 u_long v_iflag; /* i vnode flags (see below) */ 157 u_long v_vflag; /* v vnode flags */ 158 int v_writecount; /* v ref count of writers */ 159 160 /* 161 * The machinery of being a vnode 162 */ 163 TAILQ_ENTRY(vnode) v_freelist; /* f vnode freelist */ 164 struct bufobj v_bufobj; /* * Buffer cache object */ 165 166 /* 167 * Hooks for various subsystems and features. 168 */ 169 struct vpollinfo *v_pollinfo; /* G Poll events, p for *v_pi */ 170 struct label *v_label; /* MAC label for vnode */ 171 struct lockf *v_lockf; /* Byte-level lock list */ 172 }; 173 174 #endif /* defined(_KERNEL) || defined(_KVM_VNODE) */ 175 176 #define v_mountedhere v_un.vu_mount 177 #define v_socket v_un.vu_socket 178 #define v_rdev v_un.vu_cdev 179 #define v_fifoinfo v_un.vu_fifoinfo 180 #define v_yield v_un.vu_yield 181 182 /* XXX: These are temporary to avoid a source sweep at this time */ 183 #define v_object v_bufobj.bo_object 184 185 /* 186 * Userland version of struct vnode, for sysctl. 187 */ 188 struct xvnode { 189 size_t xv_size; /* sizeof(struct xvnode) */ 190 void *xv_vnode; /* address of real vnode */ 191 u_long xv_flag; /* vnode vflags */ 192 int xv_usecount; /* reference count of users */ 193 int xv_writecount; /* reference count of writers */ 194 int xv_holdcnt; /* page & buffer references */ 195 u_long xv_id; /* capability identifier */ 196 void *xv_mount; /* address of parent mount */ 197 long xv_numoutput; /* num of writes in progress */ 198 enum vtype xv_type; /* vnode type */ 199 union { 200 void *xvu_socket; /* socket, if VSOCK */ 201 void *xvu_fifo; /* fifo, if VFIFO */ 202 dev_t xvu_rdev; /* maj/min, if VBLK/VCHR */ 203 struct { 204 dev_t xvu_dev; /* device, if VDIR/VREG/VLNK */ 205 ino_t xvu_ino; /* id, if VDIR/VREG/VLNK */ 206 } xv_uns; 207 } xv_un; 208 }; 209 #define xv_socket xv_un.xvu_socket 210 #define xv_fifo xv_un.xvu_fifo 211 #define xv_rdev xv_un.xvu_rdev 212 #define xv_dev xv_un.xv_uns.xvu_dev 213 #define xv_ino xv_un.xv_uns.xvu_ino 214 215 /* We don't need to lock the knlist */ 216 #define VN_KNLIST_EMPTY(vp) ((vp)->v_pollinfo == NULL || \ 217 KNLIST_EMPTY(&(vp)->v_pollinfo->vpi_selinfo.si_note)) 218 219 #define VN_KNOTE(vp, b, a) \ 220 do { \ 221 if (!VN_KNLIST_EMPTY(vp)) \ 222 KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), \ 223 (a) | KNF_NOKQLOCK); \ 224 } while (0) 225 #define VN_KNOTE_LOCKED(vp, b) VN_KNOTE(vp, b, KNF_LISTLOCKED) 226 #define VN_KNOTE_UNLOCKED(vp, b) VN_KNOTE(vp, b, 0) 227 228 /* 229 * Vnode flags. 230 * VI flags are protected by interlock and live in v_iflag 231 * VV flags are protected by the vnode lock and live in v_vflag 232 * 233 * VI_DOOMED is doubly protected by the interlock and vnode lock. Both 234 * are required for writing but the status may be checked with either. 235 */ 236 #define VI_MOUNT 0x0020 /* Mount in progress */ 237 #define VI_AGE 0x0040 /* Insert vnode at head of free list */ 238 #define VI_DOOMED 0x0080 /* This vnode is being recycled */ 239 #define VI_FREE 0x0100 /* This vnode is on the freelist */ 240 #define VI_DOINGINACT 0x0800 /* VOP_INACTIVE is in progress */ 241 #define VI_OWEINACT 0x1000 /* Need to call inactive */ 242 243 #define VV_ROOT 0x0001 /* root of its filesystem */ 244 #define VV_ISTTY 0x0002 /* vnode represents a tty */ 245 #define VV_NOSYNC 0x0004 /* unlinked, stop syncing */ 246 #define VV_ETERNALDEV 0x0008 /* device that is never destroyed */ 247 #define VV_CACHEDLABEL 0x0010 /* Vnode has valid cached MAC label */ 248 #define VV_TEXT 0x0020 /* vnode is a pure text prototype */ 249 #define VV_COPYONWRITE 0x0040 /* vnode is doing copy-on-write */ 250 #define VV_SYSTEM 0x0080 /* vnode being used by kernel */ 251 #define VV_PROCDEP 0x0100 /* vnode is process dependent */ 252 #define VV_NOKNOTE 0x0200 /* don't activate knotes on this vnode */ 253 #define VV_DELETED 0x0400 /* should be removed */ 254 #define VV_MD 0x0800 /* vnode backs the md device */ 255 #define VV_FORCEINSMQ 0x1000 /* force the insmntque to succeed */ 256 257 /* 258 * Vnode attributes. A field value of VNOVAL represents a field whose value 259 * is unavailable (getattr) or which is not to be changed (setattr). 260 */ 261 struct vattr { 262 enum vtype va_type; /* vnode type (for create) */ 263 u_short va_mode; /* files access mode and type */ 264 short va_nlink; /* number of references to file */ 265 uid_t va_uid; /* owner user id */ 266 gid_t va_gid; /* owner group id */ 267 dev_t va_fsid; /* filesystem id */ 268 long va_fileid; /* file id */ 269 u_quad_t va_size; /* file size in bytes */ 270 long va_blocksize; /* blocksize preferred for i/o */ 271 struct timespec va_atime; /* time of last access */ 272 struct timespec va_mtime; /* time of last modification */ 273 struct timespec va_ctime; /* time file changed */ 274 struct timespec va_birthtime; /* time file created */ 275 u_long va_gen; /* generation number of file */ 276 u_long va_flags; /* flags defined for file */ 277 dev_t va_rdev; /* device the special file represents */ 278 u_quad_t va_bytes; /* bytes of disk space held by file */ 279 u_quad_t va_filerev; /* file modification number */ 280 u_int va_vaflags; /* operations flags, see below */ 281 long va_spare; /* remain quad aligned */ 282 }; 283 284 /* 285 * Flags for va_vaflags. 286 */ 287 #define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */ 288 #define VA_EXCLUSIVE 0x02 /* exclusive create request */ 289 290 /* 291 * Flags for ioflag. (high 16 bits used to ask for read-ahead and 292 * help with write clustering) 293 * NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h 294 */ 295 #define IO_UNIT 0x0001 /* do I/O as atomic unit */ 296 #define IO_APPEND 0x0002 /* append write to end */ 297 #define IO_NDELAY 0x0004 /* FNDELAY flag set in file table */ 298 #define IO_NODELOCKED 0x0008 /* underlying node already locked */ 299 #define IO_ASYNC 0x0010 /* bawrite rather then bdwrite */ 300 #define IO_VMIO 0x0020 /* data already in VMIO space */ 301 #define IO_INVAL 0x0040 /* invalidate after I/O */ 302 #define IO_SYNC 0x0080 /* do I/O synchronously */ 303 #define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */ 304 #define IO_EXT 0x0400 /* operate on external attributes */ 305 #define IO_NORMAL 0x0800 /* operate on regular data */ 306 #define IO_NOMACCHECK 0x1000 /* MAC checks unnecessary */ 307 308 #define IO_SEQMAX 0x7F /* seq heuristic max value */ 309 #define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */ 310 311 /* 312 * Flags for accmode_t. 313 */ 314 #define VEXEC 000000000100 /* execute/search permission */ 315 #define VWRITE 000000000200 /* write permission */ 316 #define VREAD 000000000400 /* read permission */ 317 #define VADMIN 000000010000 /* being the file owner */ 318 #define VAPPEND 000000040000 /* permission to write/append */ 319 /* 320 * VEXPLICIT_DENY makes VOP_ACCESSX(9) return EPERM or EACCES only 321 * if permission was denied explicitly, by a "deny" rule in NFSv4 ACL, 322 * and 0 otherwise. This never happens with ordinary unix access rights 323 * or POSIX.1e ACLs. Obviously, VEXPLICIT_DENY must be OR-ed with 324 * some other V* constant. 325 */ 326 #define VEXPLICIT_DENY 000000100000 327 #define VREAD_NAMED_ATTRS 000000200000 /* not used */ 328 #define VWRITE_NAMED_ATTRS 000000400000 /* not used */ 329 #define VDELETE_CHILD 000001000000 330 #define VREAD_ATTRIBUTES 000002000000 /* permission to stat(2) */ 331 #define VWRITE_ATTRIBUTES 000004000000 /* change {m,c,a}time */ 332 #define VDELETE 000010000000 333 #define VREAD_ACL 000020000000 /* read ACL and file mode */ 334 #define VWRITE_ACL 000040000000 /* change ACL and/or file mode */ 335 #define VWRITE_OWNER 000100000000 /* change file owner */ 336 #define VSYNCHRONIZE 000200000000 /* not used */ 337 338 /* 339 * Permissions that were traditionally granted only to the file owner. 340 */ 341 #define VADMIN_PERMS (VADMIN | VWRITE_ATTRIBUTES | VWRITE_ACL | \ 342 VWRITE_OWNER) 343 344 /* 345 * Permissions that were traditionally granted to everyone. 346 */ 347 #define VSTAT_PERMS (VREAD_ATTRIBUTES | VREAD_ACL) 348 349 /* 350 * Permissions that allow to change the state of the file in any way. 351 */ 352 #define VMODIFY_PERMS (VWRITE | VAPPEND | VADMIN_PERMS | VDELETE_CHILD | \ 353 VDELETE) 354 355 /* 356 * Token indicating no attribute value yet assigned. 357 */ 358 #define VNOVAL (-1) 359 360 /* 361 * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon) 362 */ 363 #define VLKTIMEOUT (hz / 20 + 1) 364 365 #ifdef _KERNEL 366 367 #ifdef MALLOC_DECLARE 368 MALLOC_DECLARE(M_VNODE); 369 #endif 370 371 /* 372 * Convert between vnode types and inode formats (since POSIX.1 373 * defines mode word of stat structure in terms of inode formats). 374 */ 375 extern enum vtype iftovt_tab[]; 376 extern int vttoif_tab[]; 377 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12]) 378 #define VTTOIF(indx) (vttoif_tab[(int)(indx)]) 379 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode)) 380 381 /* 382 * Flags to various vnode functions. 383 */ 384 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ 385 #define FORCECLOSE 0x0002 /* vflush: force file closure */ 386 #define WRITECLOSE 0x0004 /* vflush: only close writable files */ 387 #define DOCLOSE 0x0008 /* vclean: close active files */ 388 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */ 389 #define V_ALT 0x0002 /* vinvalbuf: invalidate only alternate bufs */ 390 #define V_NORMAL 0x0004 /* vinvalbuf: invalidate only regular bufs */ 391 #define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */ 392 #define V_WAIT 0x0001 /* vn_start_write: sleep for suspend */ 393 #define V_NOWAIT 0x0002 /* vn_start_write: don't sleep for suspend */ 394 #define V_XSLEEP 0x0004 /* vn_start_write: just return after sleep */ 395 396 #define VREF(vp) vref(vp) 397 398 #ifdef DIAGNOSTIC 399 #define VATTR_NULL(vap) vattr_null(vap) 400 #else 401 #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */ 402 #endif /* DIAGNOSTIC */ 403 404 #define NULLVP ((struct vnode *)NULL) 405 406 /* 407 * Global vnode data. 408 */ 409 extern struct vnode *rootvnode; /* root (i.e. "/") vnode */ 410 extern int async_io_version; /* 0 or POSIX version of AIO i'face */ 411 extern int desiredvnodes; /* number of vnodes desired */ 412 extern struct uma_zone *namei_zone; 413 extern int prtactive; /* nonzero to call vprint() */ 414 extern struct vattr va_null; /* predefined null vattr structure */ 415 416 #define VI_LOCK(vp) mtx_lock(&(vp)->v_interlock) 417 #define VI_LOCK_FLAGS(vp, flags) mtx_lock_flags(&(vp)->v_interlock, (flags)) 418 #define VI_TRYLOCK(vp) mtx_trylock(&(vp)->v_interlock) 419 #define VI_UNLOCK(vp) mtx_unlock(&(vp)->v_interlock) 420 #define VI_MTX(vp) (&(vp)->v_interlock) 421 422 #define VN_LOCK_AREC(vp) lockallowrecurse((vp)->v_vnlock) 423 #define VN_LOCK_ASHARE(vp) lockallowshare((vp)->v_vnlock) 424 425 #endif /* _KERNEL */ 426 427 /* 428 * Mods for extensibility. 429 */ 430 431 /* 432 * Flags for vdesc_flags: 433 */ 434 #define VDESC_MAX_VPS 16 435 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */ 436 #define VDESC_VP0_WILLRELE 0x0001 437 #define VDESC_VP1_WILLRELE 0x0002 438 #define VDESC_VP2_WILLRELE 0x0004 439 #define VDESC_VP3_WILLRELE 0x0008 440 #define VDESC_NOMAP_VPP 0x0100 441 #define VDESC_VPP_WILLRELE 0x0200 442 443 /* 444 * A generic structure. 445 * This can be used by bypass routines to identify generic arguments. 446 */ 447 struct vop_generic_args { 448 struct vnodeop_desc *a_desc; 449 /* other random data follows, presumably */ 450 }; 451 452 typedef int vop_bypass_t(struct vop_generic_args *); 453 454 /* 455 * VDESC_NO_OFFSET is used to identify the end of the offset list 456 * and in places where no such field exists. 457 */ 458 #define VDESC_NO_OFFSET -1 459 460 /* 461 * This structure describes the vnode operation taking place. 462 */ 463 struct vnodeop_desc { 464 char *vdesc_name; /* a readable name for debugging */ 465 int vdesc_flags; /* VDESC_* flags */ 466 vop_bypass_t *vdesc_call; /* Function to call */ 467 468 /* 469 * These ops are used by bypass routines to map and locate arguments. 470 * Creds and procs are not needed in bypass routines, but sometimes 471 * they are useful to (for example) transport layers. 472 * Nameidata is useful because it has a cred in it. 473 */ 474 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */ 475 int vdesc_vpp_offset; /* return vpp location */ 476 int vdesc_cred_offset; /* cred location, if any */ 477 int vdesc_thread_offset; /* thread location, if any */ 478 int vdesc_componentname_offset; /* if any */ 479 }; 480 481 #ifdef _KERNEL 482 /* 483 * A list of all the operation descs. 484 */ 485 extern struct vnodeop_desc *vnodeop_descs[]; 486 487 #define VOPARG_OFFSETOF(s_type, field) __offsetof(s_type, field) 488 #define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \ 489 ((s_type)(((char*)(struct_p)) + (s_offset))) 490 491 492 #ifdef DEBUG_VFS_LOCKS 493 /* 494 * Support code to aid in debugging VFS locking problems. Not totally 495 * reliable since if the thread sleeps between changing the lock 496 * state and checking it with the assert, some other thread could 497 * change the state. They are good enough for debugging a single 498 * filesystem using a single-threaded test. 499 */ 500 void assert_vi_locked(struct vnode *vp, const char *str); 501 void assert_vi_unlocked(struct vnode *vp, const char *str); 502 void assert_vop_elocked(struct vnode *vp, const char *str); 503 #if 0 504 void assert_vop_elocked_other(struct vnode *vp, const char *str); 505 #endif 506 void assert_vop_locked(struct vnode *vp, const char *str); 507 #if 0 508 voi0 assert_vop_slocked(struct vnode *vp, const char *str); 509 #endif 510 void assert_vop_unlocked(struct vnode *vp, const char *str); 511 512 #define ASSERT_VI_LOCKED(vp, str) assert_vi_locked((vp), (str)) 513 #define ASSERT_VI_UNLOCKED(vp, str) assert_vi_unlocked((vp), (str)) 514 #define ASSERT_VOP_ELOCKED(vp, str) assert_vop_elocked((vp), (str)) 515 #if 0 516 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str)) 517 #endif 518 #define ASSERT_VOP_LOCKED(vp, str) assert_vop_locked((vp), (str)) 519 #if 0 520 #define ASSERT_VOP_SLOCKED(vp, str) assert_vop_slocked((vp), (str)) 521 #endif 522 #define ASSERT_VOP_UNLOCKED(vp, str) assert_vop_unlocked((vp), (str)) 523 524 #else /* !DEBUG_VFS_LOCKS */ 525 526 #define ASSERT_VI_LOCKED(vp, str) ((void)0) 527 #define ASSERT_VI_UNLOCKED(vp, str) ((void)0) 528 #define ASSERT_VOP_ELOCKED(vp, str) ((void)0) 529 #if 0 530 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) 531 #endif 532 #define ASSERT_VOP_LOCKED(vp, str) ((void)0) 533 #if 0 534 #define ASSERT_VOP_SLOCKED(vp, str) 535 #endif 536 #define ASSERT_VOP_UNLOCKED(vp, str) ((void)0) 537 #endif /* DEBUG_VFS_LOCKS */ 538 539 540 /* 541 * This call works for vnodes in the kernel. 542 */ 543 #define VCALL(c) ((c)->a_desc->vdesc_call(c)) 544 545 /* 546 * VMIO support inline 547 */ 548 549 extern int vmiodirenable; 550 551 static __inline int 552 vn_canvmio(struct vnode *vp) 553 { 554 if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR))) 555 return(TRUE); 556 return(FALSE); 557 } 558 559 /* 560 * Finally, include the default set of vnode operations. 561 */ 562 #include "vnode_if.h" 563 564 /* vn_open_flags */ 565 #define VN_OPEN_NOAUDIT 0x00000001 566 567 /* 568 * Public vnode manipulation functions. 569 */ 570 struct componentname; 571 struct file; 572 struct mount; 573 struct nameidata; 574 struct ostat; 575 struct thread; 576 struct proc; 577 struct stat; 578 struct nstat; 579 struct ucred; 580 struct uio; 581 struct vattr; 582 struct vnode; 583 584 /* cache_* may belong in namei.h. */ 585 void cache_enter(struct vnode *dvp, struct vnode *vp, 586 struct componentname *cnp); 587 int cache_lookup(struct vnode *dvp, struct vnode **vpp, 588 struct componentname *cnp); 589 void cache_purge(struct vnode *vp); 590 void cache_purge_negative(struct vnode *vp); 591 void cache_purgevfs(struct mount *mp); 592 int change_dir(struct vnode *vp, struct thread *td); 593 int change_root(struct vnode *vp, struct thread *td); 594 void cvtstat(struct stat *st, struct ostat *ost); 595 void cvtnstat(struct stat *sb, struct nstat *nsb); 596 int getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops, 597 struct vnode **vpp); 598 int insmntque1(struct vnode *vp, struct mount *mp, 599 void (*dtr)(struct vnode *, void *), void *dtr_arg); 600 int insmntque(struct vnode *vp, struct mount *mp); 601 u_quad_t init_va_filerev(void); 602 int speedup_syncer(void); 603 int vn_vptocnp(struct vnode **vp, struct ucred *cred, char *buf, 604 u_int *buflen); 605 #define textvp_fullpath(p, rb, rfb) \ 606 vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb) 607 int vn_fullpath(struct thread *td, struct vnode *vn, 608 char **retbuf, char **freebuf); 609 int vn_fullpath_global(struct thread *td, struct vnode *vn, 610 char **retbuf, char **freebuf); 611 int vn_commname(struct vnode *vn, char *buf, u_int buflen); 612 int vaccess(enum vtype type, mode_t file_mode, uid_t file_uid, 613 gid_t file_gid, accmode_t accmode, struct ucred *cred, 614 int *privused); 615 int vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid, 616 struct acl *aclp, accmode_t accmode, struct ucred *cred, 617 int *privused); 618 int vaccess_acl_posix1e(enum vtype type, uid_t file_uid, 619 gid_t file_gid, struct acl *acl, accmode_t accmode, 620 struct ucred *cred, int *privused); 621 void vattr_null(struct vattr *vap); 622 int vcount(struct vnode *vp); 623 void vdrop(struct vnode *); 624 void vdropl(struct vnode *); 625 void vdestroy(struct vnode *); 626 int vflush(struct mount *mp, int rootrefs, int flags, struct thread *td); 627 int vget(struct vnode *vp, int lockflag, struct thread *td); 628 void vgone(struct vnode *vp); 629 void vhold(struct vnode *); 630 void vholdl(struct vnode *); 631 int vinvalbuf(struct vnode *vp, int save, int slpflag, int slptimeo); 632 int vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td, 633 off_t length, int blksize); 634 void vunref(struct vnode *); 635 void vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3); 636 #define vprint(label, vp) vn_printf((vp), "%s\n", (label)) 637 int vrecycle(struct vnode *vp, struct thread *td); 638 int vn_close(struct vnode *vp, 639 int flags, struct ucred *file_cred, struct thread *td); 640 void vn_finished_write(struct mount *mp); 641 void vn_finished_secondary_write(struct mount *mp); 642 int vn_isdisk(struct vnode *vp, int *errp); 643 int _vn_lock(struct vnode *vp, int flags, char *file, int line); 644 #define vn_lock(vp, flags) _vn_lock(vp, flags, __FILE__, __LINE__) 645 int vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp); 646 int vn_open_cred(struct nameidata *ndp, int *flagp, int cmode, 647 u_int vn_open_flags, struct ucred *cred, struct file *fp); 648 int vn_pollrecord(struct vnode *vp, struct thread *p, int events); 649 int vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base, 650 int len, off_t offset, enum uio_seg segflg, int ioflg, 651 struct ucred *active_cred, struct ucred *file_cred, int *aresid, 652 struct thread *td); 653 int vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base, 654 size_t len, off_t offset, enum uio_seg segflg, int ioflg, 655 struct ucred *active_cred, struct ucred *file_cred, size_t *aresid, 656 struct thread *td); 657 int vn_rlimit_fsize(const struct vnode *vn, const struct uio *uio, 658 const struct thread *td); 659 int vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred, 660 struct ucred *file_cred, struct thread *td); 661 int vn_start_write(struct vnode *vp, struct mount **mpp, int flags); 662 int vn_start_secondary_write(struct vnode *vp, struct mount **mpp, 663 int flags); 664 int vn_writechk(struct vnode *vp); 665 int vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace, 666 const char *attrname, int *buflen, char *buf, struct thread *td); 667 int vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace, 668 const char *attrname, int buflen, char *buf, struct thread *td); 669 int vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace, 670 const char *attrname, struct thread *td); 671 int vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags, 672 struct vnode **rvp); 673 674 675 int vfs_cache_lookup(struct vop_lookup_args *ap); 676 void vfs_timestamp(struct timespec *); 677 void vfs_write_resume(struct mount *mp); 678 int vfs_write_suspend(struct mount *mp); 679 int vop_stdbmap(struct vop_bmap_args *); 680 int vop_stdfsync(struct vop_fsync_args *); 681 int vop_stdgetwritemount(struct vop_getwritemount_args *); 682 int vop_stdgetpages(struct vop_getpages_args *); 683 int vop_stdinactive(struct vop_inactive_args *); 684 int vop_stdislocked(struct vop_islocked_args *); 685 int vop_stdkqfilter(struct vop_kqfilter_args *); 686 int vop_stdlock(struct vop_lock1_args *); 687 int vop_stdputpages(struct vop_putpages_args *); 688 int vop_stdunlock(struct vop_unlock_args *); 689 int vop_nopoll(struct vop_poll_args *); 690 int vop_stdaccess(struct vop_access_args *ap); 691 int vop_stdaccessx(struct vop_accessx_args *ap); 692 int vop_stdadvlock(struct vop_advlock_args *ap); 693 int vop_stdadvlockasync(struct vop_advlockasync_args *ap); 694 int vop_stdadvlockpurge(struct vop_advlockpurge_args *ap); 695 int vop_stdpathconf(struct vop_pathconf_args *); 696 int vop_stdpoll(struct vop_poll_args *); 697 int vop_stdvptocnp(struct vop_vptocnp_args *ap); 698 int vop_stdvptofh(struct vop_vptofh_args *ap); 699 int vop_eopnotsupp(struct vop_generic_args *ap); 700 int vop_ebadf(struct vop_generic_args *ap); 701 int vop_einval(struct vop_generic_args *ap); 702 int vop_enoent(struct vop_generic_args *ap); 703 int vop_enotty(struct vop_generic_args *ap); 704 int vop_null(struct vop_generic_args *ap); 705 int vop_panic(struct vop_generic_args *ap); 706 707 /* These are called from within the actual VOPS. */ 708 void vop_create_post(void *a, int rc); 709 void vop_link_post(void *a, int rc); 710 void vop_lock_pre(void *a); 711 void vop_lock_post(void *a, int rc); 712 void vop_lookup_post(void *a, int rc); 713 void vop_lookup_pre(void *a); 714 void vop_mkdir_post(void *a, int rc); 715 void vop_mknod_post(void *a, int rc); 716 void vop_remove_post(void *a, int rc); 717 void vop_rename_post(void *a, int rc); 718 void vop_rename_pre(void *a); 719 void vop_rmdir_post(void *a, int rc); 720 void vop_setattr_post(void *a, int rc); 721 void vop_strategy_pre(void *a); 722 void vop_symlink_post(void *a, int rc); 723 void vop_unlock_post(void *a, int rc); 724 void vop_unlock_pre(void *a); 725 726 void vop_rename_fail(struct vop_rename_args *ap); 727 728 #define VOP_WRITE_PRE(ap) \ 729 struct vattr va; \ 730 int error, osize, ooffset, noffset; \ 731 \ 732 osize = ooffset = noffset = 0; \ 733 if (!VN_KNLIST_EMPTY((ap)->a_vp)) { \ 734 error = VOP_GETATTR((ap)->a_vp, &va, (ap)->a_cred); \ 735 if (error) \ 736 return (error); \ 737 ooffset = (ap)->a_uio->uio_offset; \ 738 osize = va.va_size; \ 739 } 740 741 #define VOP_WRITE_POST(ap, ret) \ 742 noffset = (ap)->a_uio->uio_offset; \ 743 if (noffset > ooffset && !VN_KNLIST_EMPTY((ap)->a_vp)) { \ 744 VFS_KNOTE_LOCKED((ap)->a_vp, NOTE_WRITE \ 745 | (noffset > osize ? NOTE_EXTEND : 0)); \ 746 } 747 748 #define VOP_LOCK(vp, flags) VOP_LOCK1(vp, flags, __FILE__, __LINE__) 749 750 751 void vput(struct vnode *vp); 752 void vrele(struct vnode *vp); 753 void vref(struct vnode *vp); 754 int vrefcnt(struct vnode *vp); 755 void v_addpollinfo(struct vnode *vp); 756 757 int vnode_create_vobject(struct vnode *vp, off_t size, struct thread *td); 758 void vnode_destroy_vobject(struct vnode *vp); 759 760 extern struct vop_vector fifo_specops; 761 extern struct vop_vector dead_vnodeops; 762 extern struct vop_vector default_vnodeops; 763 764 #define VOP_PANIC ((void*)(uintptr_t)vop_panic) 765 #define VOP_NULL ((void*)(uintptr_t)vop_null) 766 #define VOP_EBADF ((void*)(uintptr_t)vop_ebadf) 767 #define VOP_ENOTTY ((void*)(uintptr_t)vop_enotty) 768 #define VOP_EINVAL ((void*)(uintptr_t)vop_einval) 769 #define VOP_ENOENT ((void*)(uintptr_t)vop_enoent) 770 #define VOP_EOPNOTSUPP ((void*)(uintptr_t)vop_eopnotsupp) 771 772 /* vfs_hash.c */ 773 typedef int vfs_hash_cmp_t(struct vnode *vp, void *arg); 774 775 int vfs_hash_get(const struct mount *mp, u_int hash, int flags, struct thread *td, struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg); 776 int vfs_hash_insert(struct vnode *vp, u_int hash, int flags, struct thread *td, struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg); 777 void vfs_hash_rehash(struct vnode *vp, u_int hash); 778 void vfs_hash_remove(struct vnode *vp); 779 780 int vfs_kqfilter(struct vop_kqfilter_args *); 781 void vfs_mark_atime(struct vnode *vp, struct ucred *cred); 782 struct dirent; 783 int vfs_read_dirent(struct vop_readdir_args *ap, struct dirent *dp, off_t off); 784 785 int vfs_unixify_accmode(accmode_t *accmode); 786 787 #endif /* _KERNEL */ 788 789 #endif /* !_SYS_VNODE_H_ */ 790