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