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