sys/sys/vnode.h

   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$
  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/_lock.h>
  48 #include <sys/_mutex.h>
  49 #include <sys/selinfo.h>
  50 #include <sys/uio.h>
  51 #include <sys/acl.h>
  52 #include <vm/uma.h>
  53
  54 /*
  55  * The vnode is the focus of all file activity in UNIX.  There is a
  56  * unique vnode allocated for each active file, each current directory,
  57  * each mounted-on file, text file, and the root.
  58  */
  59
  60 /*
  61  * Vnode types.  VNON means no type.
  62  */
  63 enum vtype      { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD };
  64
  65 /*
  66  * Vnode tag types.
  67  * These are for the benefit of external programs only (e.g., pstat)
  68  * and should NEVER be inspected by the kernel.
  69  */
  70 enum vtagtype   {
  71         VT_NON, VT_UFS, VT_NFS, VT_UNUSED, VT_PC, VT_LFS, VT_LOFS, VT_FDESC,
  72         VT_PORTAL, VT_NULL, VT_UMAP, VT_KERNFS, VT_PROCFS, VT_AFS, VT_ISOFS,
  73         VT_UNION, VT_MSDOSFS, VT_DEVFS, VT_TFS, VT_VFS, VT_CODA, VT_NTFS,
  74         VT_HPFS, VT_NWFS, VT_PSEUDOFS, VT_SMBFS
  75 };
  76
  77 /*
  78  * Each underlying filesystem allocates its own private area and hangs
  79  * it from v_data.  If non-null, this area is freed in getnewvnode().
  80  */
  81 TAILQ_HEAD(buflists, buf);
  82
  83 typedef int     vop_t(void *);
  84 struct namecache;
  85
  86 struct vpollinfo {
  87         struct  mtx vpi_lock;           /* lock to protect below */
  88         struct  selinfo vpi_selinfo;    /* identity of poller(s) */
  89         short   vpi_events;             /* what they are looking for */
  90         short   vpi_revents;            /* what has happened */
  91 };
  92
  93 /*
  94  * Reading or writing any of these items requires holding the appropriate lock.
  95  * v_freelist is locked by the global vnode_free_list mutex.
  96  * v_mntvnodes is locked by the global mntvnodes mutex.
  97  * v_flag, v_usecount, v_holdcount and v_writecount are
  98  *    locked by the v_interlock mutex.
  99  * v_pollinfo is locked by the lock contained inside it.
 100  */
 101 struct vnode {
 102         u_long  v_flag;                         /* vnode flags (see below) */
 103         int     v_usecount;                     /* reference count of users */
 104         int     v_writecount;                   /* reference count of writers */
 105         int     v_holdcnt;                      /* page & buffer references */
 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;          /* vnode freelist */
 110         TAILQ_ENTRY(vnode) v_nmntvnodes;        /* vnodes for mount point */
 111         struct  buflists v_cleanblkhd;          /* clean blocklist head */
 112         struct  buflists v_dirtyblkhd;          /* dirty blocklist head */
 113         LIST_ENTRY(vnode) v_synclist;           /* vnodes with dirty buffers */
 114         long    v_numoutput;                    /* num of writes in progress */
 115         enum    vtype v_type;                   /* vnode type */
 116         union {
 117                 struct mount    *vu_mountedhere;/* ptr to mounted vfs (VDIR) */
 118                 struct socket   *vu_socket;     /* unix ipc (VSOCK) */
 119                 struct {
 120                         struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */
 121                         SLIST_ENTRY(vnode) vu_specnext;
 122                 } vu_spec;
 123                 struct fifoinfo *vu_fifoinfo;   /* fifo (VFIFO) */
 124         } v_un;
 125         daddr_t v_lastw;                        /* last write (write cluster) */
 126         daddr_t v_cstart;                       /* start block of cluster */
 127         daddr_t v_lasta;                        /* last allocation (cluster) */
 128         int     v_clen;                         /* length of current cluster */
 129         struct vm_object *v_object;             /* Place to store VM object */
 130         struct  mtx v_interlock;                /* lock on usecount and flag */
 131         struct  lock v_lock;                    /* used if fs don't have one */
 132         struct  lock *v_vnlock;                 /* pointer to vnode lock */
 133         enum    vtagtype 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;
 140         struct thread *v_vxproc;                /* thread owning VXLOCK */
 141 #ifdef  DEBUG_LOCKS
 142         const char *filename;                   /* Source file doing locking */
 143         int line;                               /* Line number doing locking */
 144 #endif
 145 };
 146 #define v_mountedhere   v_un.vu_mountedhere
 147 #define v_socket        v_un.vu_socket
 148 #define v_rdev          v_un.vu_spec.vu_specinfo
 149 #define v_specnext      v_un.vu_spec.vu_specnext
 150 #define v_fifoinfo      v_un.vu_fifoinfo
 151
 152 #define VN_POLLEVENT(vp, events)                                \
 153         do {                                                    \
 154                 if ((vp)->v_pollinfo != NULL &&                 \
 155                     (vp)->v_pollinfo->vpi_events & (events))    \
 156                         vn_pollevent((vp), (events));           \
 157         } while (0)
 158
 159 #define VN_KNOTE(vp, b)                                         \
 160         do {                                                    \
 161                 if ((vp)->v_pollinfo != NULL)                   \
 162                         KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b)); \
 163         } while (0)
 164
 165 /*
 166  * Vnode flags.
 167  */
 168 #define VROOT           0x00001 /* root of its file system */
 169 #define VTEXT           0x00002 /* vnode is a pure text prototype */
 170 #define VSYSTEM         0x00004 /* vnode being used by kernel */
 171 #define VISTTY          0x00008 /* vnode represents a tty */
 172 #define VXLOCK          0x00100 /* vnode is locked to change underlying type */
 173 #define VXWANT          0x00200 /* thread is waiting for vnode */
 174 #define VBWAIT          0x00400 /* waiting for output to complete */
 175 #define VNOSYNC         0x01000 /* unlinked, stop syncing */
 176 /* open for business    0x01000 */
 177 #define VOBJBUF         0x02000 /* Allocate buffers in VM object */
 178 #define VCOPYONWRITE    0x04000 /* vnode is doing copy-on-write */
 179 #define VAGE            0x08000 /* Insert vnode at head of free list */
 180 #define VOLOCK          0x10000 /* vnode is locked waiting for an object */
 181 #define VOWANT          0x20000 /* a thread is waiting for VOLOCK */
 182 #define VDOOMED         0x40000 /* This vnode is being recycled */
 183 #define VFREE           0x80000 /* This vnode is on the freelist */
 184 /* open for business    0x100000 */
 185 #define VONWORKLST      0x200000 /* On syncer work-list */
 186 #define VMOUNT          0x400000 /* Mount in progress */
 187 #define VOBJDIRTY       0x800000 /* object might be dirty */
 188
 189 /*
 190  * Vnode attributes.  A field value of VNOVAL represents a field whose value
 191  * is unavailable (getattr) or which is not to be changed (setattr).
 192  */
 193 struct vattr {
 194         enum vtype      va_type;        /* vnode type (for create) */
 195         u_short         va_mode;        /* files access mode and type */
 196         short           va_nlink;       /* number of references to file */
 197         uid_t           va_uid;         /* owner user id */
 198         gid_t           va_gid;         /* owner group id */
 199         udev_t          va_fsid;        /* file system id */
 200         long            va_fileid;      /* file id */
 201         u_quad_t        va_size;        /* file size in bytes */
 202         long            va_blocksize;   /* blocksize preferred for i/o */
 203         struct timespec va_atime;       /* time of last access */
 204         struct timespec va_mtime;       /* time of last modification */
 205         struct timespec va_ctime;       /* time file changed */
 206         u_long          va_gen;         /* generation number of file */
 207         u_long          va_flags;       /* flags defined for file */
 208         udev_t          va_rdev;        /* device the special file represents */
 209         u_quad_t        va_bytes;       /* bytes of disk space held by file */
 210         u_quad_t        va_filerev;     /* file modification number */
 211         u_int           va_vaflags;     /* operations flags, see below */
 212         long            va_spare;       /* remain quad aligned */
 213 };
 214
 215 /*
 216  * Flags for va_vaflags.
 217  */
 218 #define VA_UTIMES_NULL  0x01            /* utimes argument was NULL */
 219 #define VA_EXCLUSIVE    0x02            /* exclusive create request */
 220
 221 /*
 222  * Flags for ioflag. (high 16 bits used to ask for read-ahead and
 223  * help with write clustering)
 224  */
 225 #define IO_UNIT         0x01            /* do I/O as atomic unit */
 226 #define IO_APPEND       0x02            /* append write to end */
 227 #define IO_SYNC         0x04            /* do I/O synchronously */
 228 #define IO_NODELOCKED   0x08            /* underlying node already locked */
 229 #define IO_NDELAY       0x10            /* FNDELAY flag set in file table */
 230 #define IO_VMIO         0x20            /* data already in VMIO space */
 231 #define IO_INVAL        0x40            /* invalidate after I/O */
 232 #define IO_ASYNC        0x80            /* bawrite rather then bdwrite */
 233 #define IO_DIRECT       0x100           /* attempt to bypass buffer cache */
 234 #define IO_NOWDRAIN     0x200           /* do not block on wdrain */
 235
 236 /*
 237  *  Modes.  Some values same as Ixxx entries from inode.h for now.
 238  */
 239 #define VADMIN  010000          /* permission to administer vnode */
 240 #define VSUID   004000          /* set user id on execution */
 241 #define VSGID   002000          /* set group id on execution */
 242 #define VSVTX   001000          /* save swapped text even after use */
 243 #define VREAD   000400          /* read, write, execute permissions */
 244 #define VWRITE  000200
 245 #define VEXEC   000100
 246
 247 /*
 248  * Token indicating no attribute value yet assigned.
 249  */
 250 #define VNOVAL  (-1)
 251
 252 /*
 253  * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
 254  */
 255 #define VLKTIMEOUT      (hz / 20 + 1)
 256
 257 #ifdef _KERNEL
 258
 259 #ifdef MALLOC_DECLARE
 260 MALLOC_DECLARE(M_VNODE);
 261 #endif
 262
 263 /*
 264  * Convert between vnode types and inode formats (since POSIX.1
 265  * defines mode word of stat structure in terms of inode formats).
 266  */
 267 extern enum vtype       iftovt_tab[];
 268 extern int              vttoif_tab[];
 269 #define IFTOVT(mode)    (iftovt_tab[((mode) & S_IFMT) >> 12])
 270 #define VTTOIF(indx)    (vttoif_tab[(int)(indx)])
 271 #define MAKEIMODE(indx, mode)   (int)(VTTOIF(indx) | (mode))
 272
 273 /*
 274  * Flags to various vnode functions.
 275  */
 276 #define SKIPSYSTEM      0x0001  /* vflush: skip vnodes marked VSYSTEM */
 277 #define FORCECLOSE      0x0002  /* vflush: force file closure */
 278 #define WRITECLOSE      0x0004  /* vflush: only close writable files */
 279 #define DOCLOSE         0x0008  /* vclean: close active files */
 280 #define V_SAVE          0x0001  /* vinvalbuf: sync file first */
 281 #define REVOKEALL       0x0001  /* vop_revoke: revoke all aliases */
 282 #define V_WAIT          0x0001  /* vn_start_write: sleep for suspend */
 283 #define V_NOWAIT        0x0002  /* vn_start_write: don't sleep for suspend */
 284 #define V_XSLEEP        0x0004  /* vn_start_write: just return after sleep */
 285
 286 #define VREF(vp)        vref(vp)
 287
 288
 289 #ifdef DIAGNOSTIC
 290 #define VATTR_NULL(vap) vattr_null(vap)
 291 #else
 292 #define VATTR_NULL(vap) (*(vap) = va_null)      /* initialize a vattr */
 293 #endif /* DIAGNOSTIC */
 294
 295 #define NULLVP  ((struct vnode *)NULL)
 296
 297 #define VNODEOP_SET(f) \
 298         C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \
 299         C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f);
 300
 301 /*
 302  * Global vnode data.
 303  */
 304 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
 305 extern  int desiredvnodes;              /* number of vnodes desired */
 306 extern  uma_zone_t namei_zone;
 307 extern  int prtactive;                  /* nonzero to call vprint() */
 308 extern  struct vattr va_null;           /* predefined null vattr structure */
 309 extern  int vfs_ioopt;
 310
 311 /*
 312  * Macro/function to check for client cache inconsistency w.r.t. leasing.
 313  */
 314 #define LEASE_READ      0x1             /* Check lease for readers */
 315 #define LEASE_WRITE     0x2             /* Check lease for modifiers */
 316
 317
 318 extern void     (*lease_updatetime)(int deltat);
 319
 320 #define VSHOULDFREE(vp) \
 321         (!((vp)->v_flag & (VFREE|VDOOMED)) && \
 322          !(vp)->v_holdcnt && !(vp)->v_usecount && \
 323          (!(vp)->v_object || \
 324           !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count)))
 325
 326 #define VMIGHTFREE(vp) \
 327         (!((vp)->v_flag & (VFREE|VDOOMED|VXLOCK)) &&    \
 328          LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount)
 329
 330 #define VSHOULDBUSY(vp) \
 331         (((vp)->v_flag & VFREE) && \
 332          ((vp)->v_holdcnt || (vp)->v_usecount))
 333
 334 #define VI_LOCK(vp)     mtx_lock(&(vp)->v_interlock)
 335 #define VI_TRYLOCK(vp)  mtx_trylock(&(vp)->v_interlock)
 336 #define VI_UNLOCK(vp)   mtx_unlock(&(vp)->v_interlock)
 337
 338 #endif /* _KERNEL */
 339
 340
 341 /*
 342  * Mods for extensibility.
 343  */
 344
 345 /*
 346  * Flags for vdesc_flags:
 347  */
 348 #define VDESC_MAX_VPS           16
 349 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
 350 #define VDESC_VP0_WILLRELE      0x0001
 351 #define VDESC_VP1_WILLRELE      0x0002
 352 #define VDESC_VP2_WILLRELE      0x0004
 353 #define VDESC_VP3_WILLRELE      0x0008
 354 #define VDESC_NOMAP_VPP         0x0100
 355 #define VDESC_VPP_WILLRELE      0x0200
 356
 357 /*
 358  * VDESC_NO_OFFSET is used to identify the end of the offset list
 359  * and in places where no such field exists.
 360  */
 361 #define VDESC_NO_OFFSET -1
 362
 363 /*
 364  * This structure describes the vnode operation taking place.
 365  */
 366 struct vnodeop_desc {
 367         int      vdesc_offset;          /* offset in vector,first for speed */
 368         char    *vdesc_name;            /* a readable name for debugging */
 369         int      vdesc_flags;           /* VDESC_* flags */
 370
 371         /*
 372          * These ops are used by bypass routines to map and locate arguments.
 373          * Creds and procs are not needed in bypass routines, but sometimes
 374          * they are useful to (for example) transport layers.
 375          * Nameidata is useful because it has a cred in it.
 376          */
 377         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
 378         int     vdesc_vpp_offset;       /* return vpp location */
 379         int     vdesc_cred_offset;      /* cred location, if any */
 380         int     vdesc_thread_offset;    /* thread location, if any */
 381         int     vdesc_componentname_offset; /* if any */
 382         /*
 383          * Finally, we've got a list of private data (about each operation)
 384          * for each transport layer.  (Support to manage this list is not
 385          * yet part of BSD.)
 386          */
 387         caddr_t *vdesc_transports;
 388 };
 389
 390 #ifdef _KERNEL
 391 /*
 392  * A list of all the operation descs.
 393  */
 394 extern struct vnodeop_desc *vnodeop_descs[];
 395
 396 /*
 397  * Interlock for scanning list of vnodes attached to a mountpoint
 398  */
 399 extern struct mtx mntvnode_mtx;
 400
 401 /*
 402  * This macro is very helpful in defining those offsets in the vdesc struct.
 403  *
 404  * This is stolen from X11R4.  I ignored all the fancy stuff for
 405  * Crays, so if you decide to port this to such a serious machine,
 406  * you might want to consult Intrinsic.h's XtOffset{,Of,To}.
 407  */
 408 #define VOPARG_OFFSET(p_type,field) \
 409         ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
 410 #define VOPARG_OFFSETOF(s_type,field) \
 411         VOPARG_OFFSET(s_type*,field)
 412 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
 413         ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
 414
 415
 416 /*
 417  * This structure is used to configure the new vnodeops vector.
 418  */
 419 struct vnodeopv_entry_desc {
 420         struct vnodeop_desc *opve_op;   /* which operation this is */
 421         vop_t *opve_impl;               /* code implementing this operation */
 422 };
 423 struct vnodeopv_desc {
 424                         /* ptr to the ptr to the vector where op should go */
 425         vop_t ***opv_desc_vector_p;
 426         struct vnodeopv_entry_desc *opv_desc_ops;   /* null terminated list */
 427 };
 428
 429 /*
 430  * A generic structure.
 431  * This can be used by bypass routines to identify generic arguments.
 432  */
 433 struct vop_generic_args {
 434         struct vnodeop_desc *a_desc;
 435         /* other random data follows, presumably */
 436 };
 437
 438
 439 #ifdef DEBUG_VFS_LOCKS
 440 /*
 441  * Macros to aid in tracing VFS locking problems.  Not totally
 442  * reliable since if the thread sleeps between changing the lock
 443  * state and checking it with the assert, some other thread could
 444  * change the state.  They are good enough for debugging a single
 445  * filesystem using a single-threaded test.  I find that 'cvs co src'
 446  * is a pretty good test.
 447  */
 448
 449 /*
 450  * [dfr] Kludge until I get around to fixing all the vfs locking.
 451  */
 452 #define IS_LOCKING_VFS(vp)      ((vp)->v_tag == VT_UFS                  \
 453                                  || (vp)->v_tag == VT_NFS               \
 454                                  || (vp)->v_tag == VT_LFS               \
 455                                  || (vp)->v_tag == VT_ISOFS             \
 456                                  || (vp)->v_tag == VT_MSDOSFS           \
 457                                  || (vp)->v_tag == VT_DEVFS)
 458
 459 #define ASSERT_VOP_LOCKED(vp, str)                                      \
 460 do {                                                                    \
 461         struct vnode *_vp = (vp);                                       \
 462                                                                         \
 463         if (_vp && IS_LOCKING_VFS(_vp) && !VOP_ISLOCKED(_vp, NULL))     \
 464                 panic("%s: %p is not locked but should be", str, _vp);  \
 465 } while (0)
 466
 467 #define ASSERT_VOP_UNLOCKED(vp, str)                                    \
 468 do {                                                                    \
 469         struct vnode *_vp = (vp);                                       \
 470         int lockstate;                                                  \
 471                                                                         \
 472         if (_vp && IS_LOCKING_VFS(_vp)) {                               \
 473                 lockstate = VOP_ISLOCKED(_vp, curthread);               \
 474                 if (lockstate == LK_EXCLUSIVE)                          \
 475                         panic("%s: %p is locked but should not be",     \
 476                             str, _vp);                                  \
 477         }                                                               \
 478 } while (0)
 479
 480 #define ASSERT_VOP_ELOCKED(vp, str)                                     \
 481 do {                                                                    \
 482         struct vnode *_vp = (vp);                                       \
 483                                                                         \
 484         if (_vp && IS_LOCKING_VFS(_vp) &&                               \
 485             VOP_ISLOCKED(_vp, curthread) != LK_EXCLUSIVE)                       \
 486                 panic("%s: %p is not exclusive locked but should be",   \
 487                     str, _vp);                                          \
 488 } while (0)
 489
 490 #define ASSERT_VOP_ELOCKED_OTHER(vp, str)                               \
 491 do {                                                                    \
 492         struct vnode *_vp = (vp);                                       \
 493                                                                         \
 494         if (_vp && IS_LOCKING_VFS(_vp) &&                               \
 495             VOP_ISLOCKED(_vp, curthread) != LK_EXCLOTHER)                       \
 496                 panic("%s: %p is not exclusive locked by another thread",       \
 497                     str, _vp);                                          \
 498 } while (0)
 499
 500 #define ASSERT_VOP_SLOCKED(vp, str)                                     \
 501 do {                                                                    \
 502         struct vnode *_vp = (vp);                                       \
 503                                                                         \
 504         if (_vp && IS_LOCKING_VFS(_vp) &&                               \
 505             VOP_ISLOCKED(_vp, NULL) != LK_SHARED)                       \
 506                 panic("%s: %p is not locked shared but should be",      \
 507                     str, _vp);                                          \
 508 } while (0)
 509
 510 #else
 511
 512 #define ASSERT_VOP_LOCKED(vp, str)
 513 #define ASSERT_VOP_UNLOCKED(vp, str)
 514
 515 #endif
 516
 517 /*
 518  * VOCALL calls an op given an ops vector.  We break it out because BSD's
 519  * vclean changes the ops vector and then wants to call ops with the old
 520  * vector.
 521  */
 522 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
 523
 524 /*
 525  * This call works for vnodes in the kernel.
 526  */
 527 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
 528 #define VDESC(OP) (& __CONCAT(OP,_desc))
 529 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
 530
 531 /*
 532  * VMIO support inline
 533  */
 534
 535 extern int vmiodirenable;
 536
 537 static __inline int
 538 vn_canvmio(struct vnode *vp)
 539 {
 540       if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
 541                 return(TRUE);
 542         return(FALSE);
 543 }
 544
 545 /*
 546  * Finally, include the default set of vnode operations.
 547  */
 548 #include "vnode_if.h"
 549
 550 /*
 551  * Public vnode manipulation functions.
 552  */
 553 struct componentname;
 554 struct file;
 555 struct mount;
 556 struct nameidata;
 557 struct ostat;
 558 struct thread;
 559 struct proc;
 560 struct stat;
 561 struct nstat;
 562 struct ucred;
 563 struct uio;
 564 struct vattr;
 565 struct vnode;
 566
 567 extern int      (*lease_check_hook)(struct vop_lease_args *);
 568
 569 struct  vnode *addaliasu(struct vnode *vp, udev_t nvp_rdev);
 570 int     bdevvp(dev_t dev, struct vnode **vpp);
 571 /* cache_* may belong in namei.h. */
 572 void    cache_enter(struct vnode *dvp, struct vnode *vp,
 573             struct componentname *cnp);
 574 int     cache_lookup(struct vnode *dvp, struct vnode **vpp,
 575             struct componentname *cnp);
 576 void    cache_purge(struct vnode *vp);
 577 void    cache_purgevfs(struct mount *mp);
 578 int     cache_leaf_test(struct vnode *vp);
 579 void    cvtstat(struct stat *st, struct ostat *ost);
 580 void    cvtnstat(struct stat *sb, struct nstat *nsb);
 581 int     getnewvnode(enum vtagtype tag,
 582             struct mount *mp, vop_t **vops, struct vnode **vpp);
 583 int     lease_check(struct vop_lease_args *ap);
 584 int     spec_vnoperate(struct vop_generic_args *);
 585 int     speedup_syncer(void);
 586 #define textvp_fullpath(p, rb, rfb) \
 587         vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
 588 int     vn_fullpath(struct thread *td, struct vnode *vn,
 589             char **retbuf, char **freebuf);
 590 int     vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
 591             mode_t acc_mode, struct ucred *cred, int *privused);
 592 int     vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
 593             gid_t file_gid, struct acl *acl, mode_t acc_mode,
 594             struct ucred *cred, int *privused);
 595 void    vattr_null(struct vattr *vap);
 596 int     vcount(struct vnode *vp);
 597 void    vdrop(struct vnode *);
 598 int     vfinddev(dev_t dev, enum vtype type, struct vnode **vpp);
 599 void    vfs_add_vnodeops(const void *);
 600 void    vfs_rm_vnodeops(const void *);
 601 int     vflush(struct mount *mp, int rootrefs, int flags);
 602 int     vget(struct vnode *vp, int lockflag, struct thread *td);
 603 void    vgone(struct vnode *vp);
 604 void    vgonel(struct vnode *vp, struct thread *td);
 605 void    vhold(struct vnode *);
 606 int     vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
 607             struct thread *td, int slpflag, int slptimeo);
 608 int     vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
 609             off_t length, int blksize);
 610 void    vprint(char *label, struct vnode *vp);
 611 int     vrecycle(struct vnode *vp, struct mtx *inter_lkp,
 612             struct thread *td);
 613 int     vn_close(struct vnode *vp,
 614             int flags, struct ucred *cred, struct thread *td);
 615 void    vn_finished_write(struct mount *mp);
 616 int     vn_isdisk(struct vnode *vp, int *errp);
 617 int     vn_lock(struct vnode *vp, int flags, struct thread *td);
 618 #ifdef  DEBUG_LOCKS
 619 int     debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
 620             const char *filename, int line);
 621 #define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
 622 #endif
 623 int     vn_mkdir(char *path, int mode, enum uio_seg segflg, struct thread *td);
 624 int     vn_open(struct nameidata *ndp, int *flagp, int cmode);
 625 int     vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
 626             struct ucred *cred);
 627 void    vn_pollevent(struct vnode *vp, int events);
 628 void    vn_pollgone(struct vnode *vp);
 629 int     vn_pollrecord(struct vnode *vp, struct thread *p, int events);
 630 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
 631             int len, off_t offset, enum uio_seg segflg, int ioflg,
 632             struct ucred *cred, int *aresid, struct thread *td);
 633 int     vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
 634             int len, off_t offset, enum uio_seg segflg, int ioflg,
 635             struct ucred *cred, int *aresid, struct thread *td);
 636 int     vn_stat(struct vnode *vp, struct stat *sb, struct thread *td);
 637 int     vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
 638 dev_t   vn_todev(struct vnode *vp);
 639 int     vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
 640             int flags);
 641 int     vn_writechk(struct vnode *vp);
 642 int     vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
 643             const char *attrname, int *buflen, char *buf, struct thread *td);
 644 int     vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
 645             const char *attrname, int buflen, char *buf, struct thread *td);
 646 int     vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
 647             const char *attrname, struct thread *td);
 648 int     vfs_cache_lookup(struct vop_lookup_args *ap);
 649 int     vfs_object_create(struct vnode *vp, struct thread *td,
 650             struct ucred *cred);
 651 void    vfs_timestamp(struct timespec *);
 652 void    vfs_write_resume(struct mount *mp);
 653 void    vfs_write_suspend(struct mount *mp);
 654 int     vop_stdbmap(struct vop_bmap_args *);
 655 int     vop_stdgetwritemount(struct vop_getwritemount_args *);
 656 int     vop_stdgetpages(struct vop_getpages_args *);
 657 int     vop_stdinactive(struct vop_inactive_args *);
 658 int     vop_stdislocked(struct vop_islocked_args *);
 659 int     vop_stdlock(struct vop_lock_args *);
 660 int     vop_stdputpages(struct vop_putpages_args *);
 661 int     vop_stdunlock(struct vop_unlock_args *);
 662 int     vop_noislocked(struct vop_islocked_args *);
 663 int     vop_nolock(struct vop_lock_args *);
 664 int     vop_nopoll(struct vop_poll_args *);
 665 int     vop_nounlock(struct vop_unlock_args *);
 666 int     vop_stdpathconf(struct vop_pathconf_args *);
 667 int     vop_stdpoll(struct vop_poll_args *);
 668 int     vop_revoke(struct vop_revoke_args *);
 669 int     vop_sharedlock(struct vop_lock_args *);
 670 int     vop_eopnotsupp(struct vop_generic_args *ap);
 671 int     vop_ebadf(struct vop_generic_args *ap);
 672 int     vop_einval(struct vop_generic_args *ap);
 673 int     vop_enotty(struct vop_generic_args *ap);
 674 int     vop_defaultop(struct vop_generic_args *ap);
 675 int     vop_null(struct vop_generic_args *ap);
 676 int     vop_panic(struct vop_generic_args *ap);
 677 int     vop_stdcreatevobject(struct vop_createvobject_args *ap);
 678 int     vop_stddestroyvobject(struct vop_destroyvobject_args *ap);
 679 int     vop_stdgetvobject(struct vop_getvobject_args *ap);
 680
 681 void    vfree(struct vnode *);
 682 void    vput(struct vnode *vp);
 683 void    vrele(struct vnode *vp);
 684 void    vref(struct vnode *vp);
 685 void    vbusy(struct vnode *vp);
 686 void    v_addpollinfo(struct vnode *vp);
 687
 688 extern  vop_t **default_vnodeop_p;
 689 extern  vop_t **spec_vnodeop_p;
 690 extern  vop_t **dead_vnodeop_p;
 691
 692 #endif /* _KERNEL */
 693
 694 #endif /* !_SYS_VNODE_H_ */