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