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