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