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