vnode.h revision 103314
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. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)vnode.h 8.7 (Berkeley) 2/4/94 34 * $FreeBSD: head/sys/sys/vnode.h 103314 2002-09-14 09:02:28Z njl $ 35 */ 36 37#ifndef _SYS_VNODE_H_ 38#define _SYS_VNODE_H_ 39 40/* 41 * XXX - compatability until lockmgr() goes away or all the #includes are 42 * updated. 43 */ 44#include <sys/lockmgr.h> 45 46#include <sys/queue.h> 47#include <sys/_label.h> 48#include <sys/_lock.h> 49#include <sys/lock.h> 50#include <sys/_mutex.h> 51#include <sys/mutex.h> 52#include <sys/selinfo.h> 53#include <sys/uio.h> 54#include <sys/acl.h> 55 56/* 57 * The vnode is the focus of all file activity in UNIX. There is a 58 * unique vnode allocated for each active file, each current directory, 59 * each mounted-on file, text file, and the root. 60 */ 61 62/* 63 * Vnode types. VNON means no type. 64 */ 65enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD }; 66 67/* 68 * Each underlying filesystem allocates its own private area and hangs 69 * it from v_data. If non-null, this area is freed in getnewvnode(). 70 */ 71TAILQ_HEAD(buflists, buf); 72 73typedef int vop_t(void *); 74struct namecache; 75 76struct vpollinfo { 77 struct mtx vpi_lock; /* lock to protect below */ 78 struct selinfo vpi_selinfo; /* identity of poller(s) */ 79 short vpi_events; /* what they are looking for */ 80 short vpi_revents; /* what has happened */ 81}; 82 83/* 84 * Reading or writing any of these items requires holding the appropriate lock. 85 * 86 * Lock reference: 87 * f - freelist mutex 88 * i - interlock 89 * m - mntvnodes mutex 90 * p - pollinfo lock 91 * v - vnode lock 92 * 93 * XXX Not all fields are locked yet and some fields that are marked are not 94 * locked consistently. This is a work in progress. 95 */ 96 97struct vnode { 98 struct mtx v_interlock; /* lock for "i" things */ 99 u_long v_iflag; /* i vnode flags (see below) */ 100 int v_usecount; /* i ref count of users */ 101 int v_writecount; /* i ref count of writers */ 102 long v_numoutput; /* i writes in progress */ 103 struct thread *v_vxproc; /* i thread owning VXLOCK */ 104 int v_holdcnt; /* i page & buffer references */ 105 u_long v_vflag; /* v vnode flags */ 106 u_long v_id; /* capability identifier */ 107 struct mount *v_mount; /* ptr to vfs we are in */ 108 vop_t **v_op; /* vnode operations vector */ 109 TAILQ_ENTRY(vnode) v_freelist; /* f vnode freelist */ 110 TAILQ_ENTRY(vnode) v_nmntvnodes; /* m vnodes for mount point */ 111 struct buflists v_cleanblkhd; /* SORTED clean blocklist */ 112 struct buf *v_cleanblkroot; /* clean buf splay tree root */ 113 struct buflists v_dirtyblkhd; /* SORTED dirty blocklist */ 114 struct buf *v_dirtyblkroot; /* dirty buf splay tree root */ 115 LIST_ENTRY(vnode) v_synclist; /* vnodes with dirty buffers */ 116 enum vtype v_type; /* vnode type */ 117 union { 118 struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */ 119 struct socket *vu_socket; /* unix ipc (VSOCK) */ 120 struct { 121 struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */ 122 SLIST_ENTRY(vnode) vu_specnext; 123 } vu_spec; 124 struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */ 125 } v_un; 126 daddr_t v_lastw; /* last write (write cluster) */ 127 daddr_t v_cstart; /* start block of cluster */ 128 daddr_t v_lasta; /* last allocation (cluster) */ 129 int v_clen; /* length of current cluster */ 130 struct vm_object *v_object; /* Place to store VM object */ 131 struct lock v_lock; /* used if fs don't have one */ 132 struct lock *v_vnlock; /* pointer to vnode lock */ 133 const char *v_tag; /* type of underlying data */ 134 void *v_data; /* private data for fs */ 135 LIST_HEAD(, namecache) v_cache_src; /* Cache entries from us */ 136 TAILQ_HEAD(, namecache) v_cache_dst; /* Cache entries to us */ 137 struct vnode *v_dd; /* .. vnode */ 138 u_long v_ddid; /* .. capability identifier */ 139 struct vpollinfo *v_pollinfo; /* p Poll events */ 140 struct label v_label; /* MAC label for vnode */ 141#ifdef DEBUG_LOCKS 142 const char *filename; /* Source file doing locking */ 143 int line; /* Line number doing locking */ 144#endif 145 udev_t v_cachedfs; /* cached fs id */ 146 ino_t v_cachedid; /* cached file id */ 147}; 148#define v_mountedhere v_un.vu_mountedhere 149#define v_socket v_un.vu_socket 150#define v_rdev v_un.vu_spec.vu_specinfo 151#define v_specnext v_un.vu_spec.vu_specnext 152#define v_fifoinfo v_un.vu_fifoinfo 153 154/* 155 * Userland version of struct vnode, for sysctl. 156 */ 157struct xvnode { 158 size_t xv_size; /* sizeof(struct xvnode) */ 159 void *xv_vnode; /* address of real vnode */ 160 u_long xv_flag; /* vnode vflags */ 161 int xv_usecount; /* reference count of users */ 162 int xv_writecount; /* reference count of writers */ 163 int xv_holdcnt; /* page & buffer references */ 164 u_long xv_id; /* capability identifier */ 165 void *xv_mount; /* address of parent mount */ 166 long xv_numoutput; /* num of writes in progress */ 167 enum vtype xv_type; /* vnode type */ 168 union { 169 void *xvu_socket; /* socket, if VSOCK */ 170 void *xvu_fifo; /* fifo, if VFIFO */ 171 udev_t xvu_rdev; /* maj/min, if VBLK/VCHR */ 172 struct { 173 udev_t xvu_dev; /* device, if VDIR/VREG/VLNK */ 174 ino_t xvu_ino; /* id, if VDIR/VREG/VLNK */ 175 }; 176 } xv_un; 177}; 178#define xv_socket xv_un.xvu_socket 179#define xv_fifo xv_un.xvu_fifo 180#define xv_rdev xv_un.xvu_rdev 181#define xv_dev xv_un.xvu_dev 182#define xv_ino xv_un.xvu_ino 183 184#define VN_POLLEVENT(vp, events) \ 185 do { \ 186 if ((vp)->v_pollinfo != NULL && \ 187 (vp)->v_pollinfo->vpi_events & (events)) \ 188 vn_pollevent((vp), (events)); \ 189 } while (0) 190 191#define VN_KNOTE(vp, b) \ 192 do { \ 193 if ((vp)->v_pollinfo != NULL) \ 194 KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b)); \ 195 } while (0) 196 197/* 198 * Vnode flags. 199 * VI flags are protected by interlock and live in v_iflag 200 * VV flags are protected by the vnode lock and live in v_vflag 201 */ 202#define VI_XLOCK 0x0001 /* vnode is locked to change vtype */ 203#define VI_XWANT 0x0002 /* thread is waiting for vnode */ 204#define VI_BWAIT 0x0004 /* waiting for output to complete */ 205#define VI_OLOCK 0x0008 /* vnode is locked waiting for an object */ 206#define VI_OWANT 0x0010 /* a thread is waiting for VOLOCK */ 207#define VI_MOUNT 0x0020 /* Mount in progress */ 208#define VI_AGE 0x0040 /* Insert vnode at head of free list */ 209#define VI_DOOMED 0x0080 /* This vnode is being recycled */ 210#define VI_FREE 0x0100 /* This vnode is on the freelist */ 211#define VI_OBJDIRTY 0x0400 /* object might be dirty */ 212/* 213 * XXX VI_ONWORKLST could be replaced with a check for NULL list elements 214 * in v_synclist. 215 */ 216#define VI_ONWORKLST 0x0200 /* On syncer work-list */ 217 218#define VV_ROOT 0x0001 /* root of its filesystem */ 219#define VV_ISTTY 0x0002 /* vnode represents a tty */ 220#define VV_NOSYNC 0x0004 /* unlinked, stop syncing */ 221#define VV_OBJBUF 0x0008 /* Allocate buffers in VM object */ 222#define VV_CACHEDLABEL 0x0010 /* Vnode has valid cached MAC label */ 223#define VV_TEXT 0x0020 /* vnode is a pure text prototype */ 224#define VV_COPYONWRITE 0x0040 /* vnode is doing copy-on-write */ 225#define VV_SYSTEM 0x0080 /* vnode being used by kernel */ 226#define VV_PROCDEP 0x0100 /* vnode is process dependent */ 227 228/* 229 * Vnode attributes. A field value of VNOVAL represents a field whose value 230 * is unavailable (getattr) or which is not to be changed (setattr). 231 */ 232struct vattr { 233 enum vtype va_type; /* vnode type (for create) */ 234 u_short va_mode; /* files access mode and type */ 235 short va_nlink; /* number of references to file */ 236 uid_t va_uid; /* owner user id */ 237 gid_t va_gid; /* owner group id */ 238 udev_t va_fsid; /* filesystem id */ 239 long va_fileid; /* file id */ 240 u_quad_t va_size; /* file size in bytes */ 241 long va_blocksize; /* blocksize preferred for i/o */ 242 struct timespec va_atime; /* time of last access */ 243 struct timespec va_mtime; /* time of last modification */ 244 struct timespec va_ctime; /* time file changed */ 245 struct timespec va_birthtime; /* time file created */ 246 u_long va_gen; /* generation number of file */ 247 u_long va_flags; /* flags defined for file */ 248 udev_t va_rdev; /* device the special file represents */ 249 u_quad_t va_bytes; /* bytes of disk space held by file */ 250 u_quad_t va_filerev; /* file modification number */ 251 u_int va_vaflags; /* operations flags, see below */ 252 long va_spare; /* remain quad aligned */ 253}; 254 255/* 256 * Flags for va_vaflags. 257 */ 258#define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */ 259#define VA_EXCLUSIVE 0x02 /* exclusive create request */ 260 261/* 262 * Flags for ioflag. (high 16 bits used to ask for read-ahead and 263 * help with write clustering) 264 */ 265#define IO_UNIT 0x0001 /* do I/O as atomic unit */ 266#define IO_APPEND 0x0002 /* append write to end */ 267#define IO_SYNC 0x0004 /* do I/O synchronously */ 268#define IO_NODELOCKED 0x0008 /* underlying node already locked */ 269#define IO_NDELAY 0x0010 /* FNDELAY flag set in file table */ 270#define IO_VMIO 0x0020 /* data already in VMIO space */ 271#define IO_INVAL 0x0040 /* invalidate after I/O */ 272#define IO_ASYNC 0x0080 /* bawrite rather then bdwrite */ 273#define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */ 274#define IO_NOWDRAIN 0x0200 /* do not block on wdrain */ 275#define IO_EXT 0x0400 /* operate on external attributes */ 276#define IO_NORMAL 0x0800 /* operate on regular data */ 277#define IO_NOMACCHECK 0x1000 /* MAC checks unnecessary */ 278 279/* 280 * Modes. Some values same as Ixxx entries from inode.h for now. 281 */ 282#define VEXEC 000100 /* execute/search permission */ 283#define VWRITE 000200 /* write permission */ 284#define VREAD 000400 /* read permission */ 285#define VSVTX 001000 /* save swapped text even after use */ 286#define VSGID 002000 /* set group id on execution */ 287#define VSUID 004000 /* set user id on execution */ 288#define VADMIN 010000 /* permission to administer */ 289#define VSTAT 020000 /* permission to retrieve attrs */ 290#define VAPPEND 040000 /* permission to write/append */ 291#define VALLPERM (VEXEC | VWRITE | VREAD | VADMIN | VSTAT | VAPPEND) 292 293/* 294 * Token indicating no attribute value yet assigned. 295 */ 296#define VNOVAL (-1) 297 298/* 299 * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon) 300 */ 301#define VLKTIMEOUT (hz / 20 + 1) 302 303#ifdef _KERNEL 304 305#ifdef MALLOC_DECLARE 306MALLOC_DECLARE(M_VNODE); 307#endif 308 309/* 310 * Convert between vnode types and inode formats (since POSIX.1 311 * defines mode word of stat structure in terms of inode formats). 312 */ 313extern enum vtype iftovt_tab[]; 314extern int vttoif_tab[]; 315#define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12]) 316#define VTTOIF(indx) (vttoif_tab[(int)(indx)]) 317#define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode)) 318 319/* 320 * Flags to various vnode functions. 321 */ 322#define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ 323#define FORCECLOSE 0x0002 /* vflush: force file closure */ 324#define WRITECLOSE 0x0004 /* vflush: only close writable files */ 325#define DOCLOSE 0x0008 /* vclean: close active files */ 326#define V_SAVE 0x0001 /* vinvalbuf: sync file first */ 327#define V_ALT 0x0002 /* vinvalbuf: invalidate only alternate bufs */ 328#define V_NORMAL 0x0004 /* vinvalbuf: invalidate only regular bufs */ 329#define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */ 330#define V_WAIT 0x0001 /* vn_start_write: sleep for suspend */ 331#define V_NOWAIT 0x0002 /* vn_start_write: don't sleep for suspend */ 332#define V_XSLEEP 0x0004 /* vn_start_write: just return after sleep */ 333 334#define VREF(vp) vref(vp) 335 336 337#ifdef DIAGNOSTIC 338#define VATTR_NULL(vap) vattr_null(vap) 339#else 340#define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */ 341#endif /* DIAGNOSTIC */ 342 343#define NULLVP ((struct vnode *)NULL) 344 345#define VNODEOP_SET(f) \ 346 C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \ 347 C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f); 348 349/* 350 * Global vnode data. 351 */ 352extern struct vnode *rootvnode; /* root (i.e. "/") vnode */ 353extern int desiredvnodes; /* number of vnodes desired */ 354extern struct uma_zone *namei_zone; 355extern int prtactive; /* nonzero to call vprint() */ 356extern struct vattr va_null; /* predefined null vattr structure */ 357extern int vfs_ioopt; 358 359/* 360 * Macro/function to check for client cache inconsistency w.r.t. leasing. 361 */ 362#define LEASE_READ 0x1 /* Check lease for readers */ 363#define LEASE_WRITE 0x2 /* Check lease for modifiers */ 364 365 366extern void (*lease_updatetime)(int deltat); 367 368/* Requires interlock */ 369#define VSHOULDFREE(vp) \ 370 (!((vp)->v_iflag & (VI_FREE|VI_DOOMED)) && \ 371 !(vp)->v_holdcnt && !(vp)->v_usecount && \ 372 (!(vp)->v_object || \ 373 !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count))) 374 375/* Requires interlock */ 376#define VMIGHTFREE(vp) \ 377 (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_XLOCK)) && \ 378 LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount) 379 380/* Requires interlock */ 381#define VSHOULDBUSY(vp) \ 382 (((vp)->v_iflag & VI_FREE) && \ 383 ((vp)->v_holdcnt || (vp)->v_usecount)) 384 385#define VI_LOCK(vp) mtx_lock(&(vp)->v_interlock) 386#define VI_TRYLOCK(vp) mtx_trylock(&(vp)->v_interlock) 387#define VI_UNLOCK(vp) mtx_unlock(&(vp)->v_interlock) 388#define VI_MTX(vp) (&(vp)->v_interlock) 389 390#endif /* _KERNEL */ 391 392 393/* 394 * Mods for extensibility. 395 */ 396 397/* 398 * Flags for vdesc_flags: 399 */ 400#define VDESC_MAX_VPS 16 401/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */ 402#define VDESC_VP0_WILLRELE 0x0001 403#define VDESC_VP1_WILLRELE 0x0002 404#define VDESC_VP2_WILLRELE 0x0004 405#define VDESC_VP3_WILLRELE 0x0008 406#define VDESC_NOMAP_VPP 0x0100 407#define VDESC_VPP_WILLRELE 0x0200 408 409/* 410 * VDESC_NO_OFFSET is used to identify the end of the offset list 411 * and in places where no such field exists. 412 */ 413#define VDESC_NO_OFFSET -1 414 415/* 416 * This structure describes the vnode operation taking place. 417 */ 418struct vnodeop_desc { 419 int vdesc_offset; /* offset in vector,first for speed */ 420 char *vdesc_name; /* a readable name for debugging */ 421 int vdesc_flags; /* VDESC_* flags */ 422 423 /* 424 * These ops are used by bypass routines to map and locate arguments. 425 * Creds and procs are not needed in bypass routines, but sometimes 426 * they are useful to (for example) transport layers. 427 * Nameidata is useful because it has a cred in it. 428 */ 429 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */ 430 int vdesc_vpp_offset; /* return vpp location */ 431 int vdesc_cred_offset; /* cred location, if any */ 432 int vdesc_thread_offset; /* thread location, if any */ 433 int vdesc_componentname_offset; /* if any */ 434 /* 435 * Finally, we've got a list of private data (about each operation) 436 * for each transport layer. (Support to manage this list is not 437 * yet part of BSD.) 438 */ 439 caddr_t *vdesc_transports; 440}; 441 442#ifdef _KERNEL 443/* 444 * A list of all the operation descs. 445 */ 446extern struct vnodeop_desc *vnodeop_descs[]; 447 448/* 449 * Interlock for scanning list of vnodes attached to a mountpoint 450 */ 451extern struct mtx mntvnode_mtx; 452 453/* 454 * This macro is very helpful in defining those offsets in the vdesc struct. 455 * 456 * This is stolen from X11R4. I ignored all the fancy stuff for 457 * Crays, so if you decide to port this to such a serious machine, 458 * you might want to consult Intrinsic.h's XtOffset{,Of,To}. 459 */ 460#define VOPARG_OFFSET(p_type,field) \ 461 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL))) 462#define VOPARG_OFFSETOF(s_type,field) \ 463 VOPARG_OFFSET(s_type*,field) 464#define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \ 465 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET))) 466 467 468/* 469 * This structure is used to configure the new vnodeops vector. 470 */ 471struct vnodeopv_entry_desc { 472 struct vnodeop_desc *opve_op; /* which operation this is */ 473 vop_t *opve_impl; /* code implementing this operation */ 474}; 475struct vnodeopv_desc { 476 /* ptr to the ptr to the vector where op should go */ 477 vop_t ***opv_desc_vector_p; 478 struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */ 479}; 480 481/* 482 * A generic structure. 483 * This can be used by bypass routines to identify generic arguments. 484 */ 485struct vop_generic_args { 486 struct vnodeop_desc *a_desc; 487 /* other random data follows, presumably */ 488}; 489 490 491#ifdef DEBUG_VFS_LOCKS 492/* 493 * Macros to aid in tracing VFS locking problems. Not totally 494 * reliable since if the thread sleeps between changing the lock 495 * state and checking it with the assert, some other thread could 496 * change the state. They are good enough for debugging a single 497 * filesystem using a single-threaded test. I find that 'cvs co src' 498 * is a pretty good test. 499 */ 500 501extern int vfs_badlock_panic; 502extern int vfs_badlock_print; 503extern int vfs_badlock_mutex; 504 505#define ASSERT_VI_UNLOCKED(vp) \ 506do { \ 507 struct vnode *_vp = (vp); \ 508 \ 509 if (vfs_badlock_mutex) \ 510 mtx_assert(VI_MTX(_vp), MA_NOTOWNED); \ 511} while (0) \ 512 513#define ASSERT_VI_LOCKED(vp) \ 514do { \ 515 struct vnode *_vp = (vp); \ 516 \ 517 if (vfs_badlock_mutex) \ 518 mtx_assert(VI_MTX(_vp), MA_OWNED); \ 519} while (0) \ 520 521 522/* 523 * This only exists to supress warnings from unlocked specfs accesses. It is 524 * no longer ok to have an unlocked VFS. 525 */ 526 527#define IGNORE_LOCK(vp) ((vp)->v_type == VCHR || (vp)->v_type == VBAD) 528 529#define ASSERT_VOP_LOCKED(vp, str) \ 530do { \ 531 struct vnode *_vp = (vp); \ 532 \ 533 if (_vp && !IGNORE_LOCK(_vp) && !VOP_ISLOCKED(_vp, NULL)) { \ 534 if (vfs_badlock_print) \ 535 printf("%s: %p is not locked but should be\n", \ 536 str, _vp); \ 537 if (vfs_badlock_panic) \ 538 Debugger("Lock violation.\n"); \ 539 } \ 540} while (0) 541 542#define ASSERT_VOP_UNLOCKED(vp, str) \ 543do { \ 544 struct vnode *_vp = (vp); \ 545 int lockstate; \ 546 \ 547 if (_vp && !IGNORE_LOCK(_vp)) { \ 548 lockstate = VOP_ISLOCKED(_vp, curthread); \ 549 if (lockstate == LK_EXCLUSIVE) { \ 550 if (vfs_badlock_print) \ 551 printf("%s: %p is locked but should not be\n", \ 552 str, _vp); \ 553 if (vfs_badlock_panic) \ 554 Debugger("Lock Violation.\n"); \ 555 } \ 556 } \ 557} while (0) 558 559#define ASSERT_VOP_ELOCKED(vp, str) \ 560do { \ 561 struct vnode *_vp = (vp); \ 562 \ 563 if (_vp && !IGNORE_LOCK(_vp) && \ 564 VOP_ISLOCKED(_vp, curthread) != LK_EXCLUSIVE) { \ 565 if (vfs_badlock_print) \ 566 printf("%s: %p is not exclusive locked but should be\n",\ 567 str, _vp); \ 568 if (vfs_badlock_panic) \ 569 Debugger("Lock violation.\n"); \ 570 } \ 571} while (0) 572 573#define ASSERT_VOP_ELOCKED_OTHER(vp, str) \ 574do { \ 575 struct vnode *_vp = (vp); \ 576 \ 577 if (_vp && !IGNORE_LOCK(_vp) && \ 578 VOP_ISLOCKED(_vp, curthread) != LK_EXCLOTHER) { \ 579 if (vfs_badlock_print) \ 580 printf("%s: %p is not exclusive locked by another thread\n",\ 581 str, _vp); \ 582 if (vfs_badlock_panic) \ 583 Debugger("Lock violation.\n"); \ 584 } \ 585} while (0) 586 587#define ASSERT_VOP_SLOCKED(vp, str) \ 588do { \ 589 struct vnode *_vp = (vp); \ 590 \ 591 if (_vp && !IGNORE_LOCK(_vp) && \ 592 VOP_ISLOCKED(_vp, NULL) != LK_SHARED) { \ 593 if (vfs_badlock_print) \ 594 printf("%s: %p is not locked shared but should be",\ 595 str, _vp); \ 596 if (vfs_badlock_panic) \ 597 Debugger("Lock violation.\n"); \ 598 } \ 599} while (0) 600 601void vop_rename_pre(void *a); 602void vop_strategy_pre(void *a); 603void vop_lookup_pre(void *a); 604void vop_lookup_post(void *a, int rc); 605void vop_lock_pre(void *a); 606void vop_lock_post(void *a, int rc); 607void vop_unlock_pre(void *a); 608void vop_unlock_post(void *a, int rc); 609 610#else 611 612#define ASSERT_VOP_LOCKED(vp, str) 613#define ASSERT_VOP_UNLOCKED(vp, str) 614#define ASSERT_VI_UNLOCKED(vp) 615#define ASSERT_VI_LOCKED(vp) 616 617#endif 618 619/* 620 * VOCALL calls an op given an ops vector. We break it out because BSD's 621 * vclean changes the ops vector and then wants to call ops with the old 622 * vector. 623 */ 624#define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP)) 625 626/* 627 * This call works for vnodes in the kernel. 628 */ 629#define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP)) 630#define VDESC(OP) (& __CONCAT(OP,_desc)) 631#define VOFFSET(OP) (VDESC(OP)->vdesc_offset) 632 633/* 634 * VMIO support inline 635 */ 636 637extern int vmiodirenable; 638 639static __inline int 640vn_canvmio(struct vnode *vp) 641{ 642 if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR))) 643 return(TRUE); 644 return(FALSE); 645} 646 647/* 648 * Finally, include the default set of vnode operations. 649 */ 650#include "vnode_if.h" 651 652/* 653 * Public vnode manipulation functions. 654 */ 655struct componentname; 656struct file; 657struct mount; 658struct nameidata; 659struct ostat; 660struct thread; 661struct proc; 662struct stat; 663struct nstat; 664struct ucred; 665struct uio; 666struct vattr; 667struct vnode; 668 669extern int (*lease_check_hook)(struct vop_lease_args *); 670extern int (*softdep_fsync_hook)(struct vnode *); 671extern int (*softdep_process_worklist_hook)(struct mount *); 672 673struct vnode *addaliasu(struct vnode *vp, udev_t nvp_rdev); 674int bdevvp(dev_t dev, struct vnode **vpp); 675/* cache_* may belong in namei.h. */ 676void cache_enter(struct vnode *dvp, struct vnode *vp, 677 struct componentname *cnp); 678int cache_lookup(struct vnode *dvp, struct vnode **vpp, 679 struct componentname *cnp); 680void cache_purge(struct vnode *vp); 681void cache_purgevfs(struct mount *mp); 682int cache_leaf_test(struct vnode *vp); 683void cvtstat(struct stat *st, struct ostat *ost); 684void cvtnstat(struct stat *sb, struct nstat *nsb); 685int getnewvnode(const char *tag, struct mount *mp, vop_t **vops, 686 struct vnode **vpp); 687int lease_check(struct vop_lease_args *ap); 688int spec_vnoperate(struct vop_generic_args *); 689int speedup_syncer(void); 690#define textvp_fullpath(p, rb, rfb) \ 691 vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb) 692int vn_fullpath(struct thread *td, struct vnode *vn, 693 char **retbuf, char **freebuf); 694int vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid, 695 mode_t acc_mode, struct ucred *cred, int *privused); 696int vaccess_acl_posix1e(enum vtype type, uid_t file_uid, 697 gid_t file_gid, struct acl *acl, mode_t acc_mode, 698 struct ucred *cred, int *privused); 699void vattr_null(struct vattr *vap); 700int vcount(struct vnode *vp); 701void vdrop(struct vnode *); 702int vfinddev(dev_t dev, enum vtype type, struct vnode **vpp); 703void vfs_add_vnodeops(const void *); 704void vfs_rm_vnodeops(const void *); 705int vflush(struct mount *mp, int rootrefs, int flags); 706int vget(struct vnode *vp, int lockflag, struct thread *td); 707void vgone(struct vnode *vp); 708void vgonel(struct vnode *vp, struct thread *td); 709void vhold(struct vnode *); 710int vinvalbuf(struct vnode *vp, int save, struct ucred *cred, 711 struct thread *td, int slpflag, int slptimeo); 712int vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td, 713 off_t length, int blksize); 714void vprint(char *label, struct vnode *vp); 715int vrecycle(struct vnode *vp, struct mtx *inter_lkp, 716 struct thread *td); 717int vn_close(struct vnode *vp, 718 int flags, struct ucred *file_cred, struct thread *td); 719void vn_finished_write(struct mount *mp); 720int vn_isdisk(struct vnode *vp, int *errp); 721int vn_lock(struct vnode *vp, int flags, struct thread *td); 722#ifdef DEBUG_LOCKS 723int debug_vn_lock(struct vnode *vp, int flags, struct thread *p, 724 const char *filename, int line); 725#define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__) 726#endif 727int vn_open(struct nameidata *ndp, int *flagp, int cmode); 728int vn_open_cred(struct nameidata *ndp, int *flagp, int cmode, 729 struct ucred *cred); 730void vn_pollevent(struct vnode *vp, int events); 731void vn_pollgone(struct vnode *vp); 732int vn_pollrecord(struct vnode *vp, struct thread *p, int events); 733int vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base, 734 int len, off_t offset, enum uio_seg segflg, int ioflg, 735 struct ucred *active_cred, struct ucred *file_cred, int *aresid, 736 struct thread *td); 737int vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base, 738 int len, off_t offset, enum uio_seg segflg, int ioflg, 739 struct ucred *active_cred, struct ucred *file_cred, int *aresid, 740 struct thread *td); 741int vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred, 742 struct ucred *file_cred, struct thread *td); 743int vn_start_write(struct vnode *vp, struct mount **mpp, int flags); 744dev_t vn_todev(struct vnode *vp); 745int vn_write_suspend_wait(struct vnode *vp, struct mount *mp, 746 int flags); 747int vn_writechk(struct vnode *vp); 748int vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace, 749 const char *attrname, int *buflen, char *buf, struct thread *td); 750int vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace, 751 const char *attrname, int buflen, char *buf, struct thread *td); 752int vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace, 753 const char *attrname, struct thread *td); 754int vfs_cache_lookup(struct vop_lookup_args *ap); 755int vfs_object_create(struct vnode *vp, struct thread *td, 756 struct ucred *cred); 757void vfs_timestamp(struct timespec *); 758void vfs_write_resume(struct mount *mp); 759void vfs_write_suspend(struct mount *mp); 760int vop_stdbmap(struct vop_bmap_args *); 761int vop_stdgetwritemount(struct vop_getwritemount_args *); 762int vop_stdgetpages(struct vop_getpages_args *); 763int vop_stdinactive(struct vop_inactive_args *); 764int vop_stdislocked(struct vop_islocked_args *); 765int vop_stdlock(struct vop_lock_args *); 766int vop_stdputpages(struct vop_putpages_args *); 767int vop_stdunlock(struct vop_unlock_args *); 768int vop_noislocked(struct vop_islocked_args *); 769int vop_nolock(struct vop_lock_args *); 770int vop_nopoll(struct vop_poll_args *); 771int vop_nounlock(struct vop_unlock_args *); 772int vop_stdpathconf(struct vop_pathconf_args *); 773int vop_stdpoll(struct vop_poll_args *); 774int vop_revoke(struct vop_revoke_args *); 775int vop_sharedlock(struct vop_lock_args *); 776int vop_eopnotsupp(struct vop_generic_args *ap); 777int vop_ebadf(struct vop_generic_args *ap); 778int vop_einval(struct vop_generic_args *ap); 779int vop_enotty(struct vop_generic_args *ap); 780int vop_defaultop(struct vop_generic_args *ap); 781int vop_null(struct vop_generic_args *ap); 782int vop_panic(struct vop_generic_args *ap); 783int vop_stdcreatevobject(struct vop_createvobject_args *ap); 784int vop_stddestroyvobject(struct vop_destroyvobject_args *ap); 785int vop_stdgetvobject(struct vop_getvobject_args *ap); 786 787void vfree(struct vnode *); 788void vput(struct vnode *vp); 789void vrele(struct vnode *vp); 790void vref(struct vnode *vp); 791void vbusy(struct vnode *vp); 792void v_addpollinfo(struct vnode *vp); 793 794extern vop_t **default_vnodeop_p; 795extern vop_t **spec_vnodeop_p; 796extern vop_t **dead_vnodeop_p; 797 798#endif /* _KERNEL */ 799 800#endif /* !_SYS_VNODE_H_ */ 801