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