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