sys/sys/vnode.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)vnode.h     8.7 (Berkeley) 2/4/94
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_VNODE_H_
  36 #define _SYS_VNODE_H_
  37
  38 #include <sys/bufobj.h>
  39 #include <sys/queue.h>
  40 #include <sys/lock.h>
  41 #include <sys/lockmgr.h>
  42 #include <sys/mutex.h>
  43 #include <sys/rangelock.h>
  44 #include <sys/selinfo.h>
  45 #include <sys/uio.h>
  46 #include <sys/acl.h>
  47 #include <sys/ktr.h>
  48 #include <sys/_seqc.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                   VMARKER };
  61
  62 enum vgetstate  { VGET_NONE, VGET_HOLDCNT, VGET_USECOUNT };
  63 /*
  64  * Each underlying filesystem allocates its own private area and hangs
  65  * it from v_data.  If non-null, this area is freed in getnewvnode().
  66  */
  67
  68 struct namecache;
  69
  70 struct vpollinfo {
  71         struct  mtx vpi_lock;           /* lock to protect below */
  72         struct  selinfo vpi_selinfo;    /* identity of poller(s) */
  73         short   vpi_events;             /* what they are looking for */
  74         short   vpi_revents;            /* what has happened */
  75 };
  76
  77 /*
  78  * Reading or writing any of these items requires holding the appropriate lock.
  79  *
  80  * Lock reference:
  81  *      c - namecache mutex
  82  *      i - interlock
  83  *      l - mp mnt_listmtx or freelist mutex
  84  *      I - updated with atomics, 0->1 and 1->0 transitions with interlock held
  85  *      m - mount point interlock
  86  *      p - pollinfo lock
  87  *      u - Only a reference to the vnode is needed to read.
  88  *      v - vnode lock
  89  *
  90  * Vnodes may be found on many lists.  The general way to deal with operating
  91  * on a vnode that is on a list is:
  92  *      1) Lock the list and find the vnode.
  93  *      2) Lock interlock so that the vnode does not go away.
  94  *      3) Unlock the list to avoid lock order reversals.
  95  *      4) vget with LK_INTERLOCK and check for ENOENT, or
  96  *      5) Check for DOOMED if the vnode lock is not required.
  97  *      6) Perform your operation, then vput().
  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:8;                 /* u vnode type */
 108         short   v_irflag;                       /* i frequently read flags */
 109         seqc_t  v_seqc;                         /* i modification count */
 110         uint32_t v_nchash;                      /* u namecache hash */
 111         struct  vop_vector *v_op;               /* u vnode operations vector */
 112         void    *v_data;                        /* u private data for fs */
 113
 114         /*
 115          * Filesystem instance stuff
 116          */
 117         struct  mount *v_mount;                 /* u ptr to vfs we are in */
 118         TAILQ_ENTRY(vnode) v_nmntvnodes;        /* m vnodes for mount point */
 119
 120         /*
 121          * Type specific fields, only one applies to any given vnode.
 122          */
 123         union {
 124                 struct mount    *v_mountedhere; /* v ptr to mountpoint (VDIR) */
 125                 struct unpcb    *v_unpcb;       /* v unix domain net (VSOCK) */
 126                 struct cdev     *v_rdev;        /* v device (VCHR, VBLK) */
 127                 struct fifoinfo *v_fifoinfo;    /* v fifo (VFIFO) */
 128         };
 129
 130         /*
 131          * vfs_hash: (mount + inode) -> vnode hash.  The hash value
 132          * itself is grouped with other int fields, to avoid padding.
 133          */
 134         LIST_ENTRY(vnode)       v_hashlist;
 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 namecache *v_cache_dd;           /* c Cache entry for .. vnode */
 142
 143         /*
 144          * Locking
 145          */
 146         struct  lock v_lock;                    /* u (if fs don't have one) */
 147         struct  mtx v_interlock;                /* lock for "i" things */
 148         struct  lock *v_vnlock;                 /* u pointer to vnode lock */
 149
 150         /*
 151          * The machinery of being a vnode
 152          */
 153         TAILQ_ENTRY(vnode) v_vnodelist;         /* l vnode lists */
 154         TAILQ_ENTRY(vnode) v_lazylist;          /* l vnode lazy list */
 155         struct bufobj   v_bufobj;               /* * Buffer cache object */
 156
 157         /*
 158          * Hooks for various subsystems and features.
 159          */
 160         struct vpollinfo *v_pollinfo;           /* i Poll events, p for *v_pi */
 161         struct label *v_label;                  /* MAC label for vnode */
 162         struct lockf *v_lockf;          /* Byte-level advisory lock list */
 163         struct rangelock v_rl;                  /* Byte-range lock */
 164
 165         /*
 166          * clustering stuff
 167          */
 168         daddr_t v_cstart;                       /* v start block of cluster */
 169         daddr_t v_lasta;                        /* v last allocation  */
 170         daddr_t v_lastw;                        /* v last write  */
 171         int     v_clen;                         /* v length of cur. cluster */
 172
 173         u_int   v_holdcnt;                      /* I prevents recycling. */
 174         u_int   v_usecount;                     /* I ref count of users */
 175         u_short v_iflag;                        /* i vnode flags (see below) */
 176         u_short v_vflag;                        /* v vnode flags */
 177         u_short v_mflag;                        /* l mnt-specific vnode flags */
 178         short   v_dbatchcpu;                    /* i LRU requeue deferral batch */
 179         int     v_writecount;                   /* I ref count of writers or
 180                                                    (negative) text users */
 181         int     v_seqc_users;                   /* i modifications pending */
 182         u_int   v_hash;
 183 };
 184
 185 #endif /* defined(_KERNEL) || defined(_KVM_VNODE) */
 186
 187 #define bo2vnode(bo)    __containerof((bo), struct vnode, v_bufobj)
 188
 189 /* XXX: These are temporary to avoid a source sweep at this time */
 190 #define v_object        v_bufobj.bo_object
 191
 192 /*
 193  * Userland version of struct vnode, for sysctl.
 194  */
 195 struct xvnode {
 196         size_t  xv_size;                        /* sizeof(struct xvnode) */
 197         void    *xv_vnode;                      /* address of real vnode */
 198         u_long  xv_flag;                        /* vnode vflags */
 199         int     xv_usecount;                    /* reference count of users */
 200         int     xv_writecount;                  /* reference count of writers */
 201         int     xv_holdcnt;                     /* page & buffer references */
 202         u_long  xv_id;                          /* capability identifier */
 203         void    *xv_mount;                      /* address of parent mount */
 204         long    xv_numoutput;                   /* num of writes in progress */
 205         enum    vtype xv_type;                  /* vnode type */
 206         union {
 207                 void    *xvu_socket;            /* unpcb, if VSOCK */
 208                 void    *xvu_fifo;              /* fifo, if VFIFO */
 209                 dev_t   xvu_rdev;               /* maj/min, if VBLK/VCHR */
 210                 struct {
 211                         dev_t   xvu_dev;        /* device, if VDIR/VREG/VLNK */
 212                         ino_t   xvu_ino;        /* id, if VDIR/VREG/VLNK */
 213                 } xv_uns;
 214         } xv_un;
 215 };
 216 #define xv_socket       xv_un.xvu_socket
 217 #define xv_fifo         xv_un.xvu_fifo
 218 #define xv_rdev         xv_un.xvu_rdev
 219 #define xv_dev          xv_un.xv_uns.xvu_dev
 220 #define xv_ino          xv_un.xv_uns.xvu_ino
 221
 222 /* We don't need to lock the knlist */
 223 #define VN_KNLIST_EMPTY(vp) ((vp)->v_pollinfo == NULL ||        \
 224             KNLIST_EMPTY(&(vp)->v_pollinfo->vpi_selinfo.si_note))
 225
 226 #define VN_KNOTE(vp, b, a)                                      \
 227         do {                                                    \
 228                 if (!VN_KNLIST_EMPTY(vp))                       \
 229                         KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), \
 230                             (a) | KNF_NOKQLOCK);                \
 231         } while (0)
 232 #define VN_KNOTE_LOCKED(vp, b)          VN_KNOTE(vp, b, KNF_LISTLOCKED)
 233 #define VN_KNOTE_UNLOCKED(vp, b)        VN_KNOTE(vp, b, 0)
 234
 235 /*
 236  * Vnode flags.
 237  *      VI flags are protected by interlock and live in v_iflag
 238  *      VV flags are protected by the vnode lock and live in v_vflag
 239  *
 240  *      VIRF_DOOMED is doubly protected by the interlock and vnode lock.  Both
 241  *      are required for writing but the status may be checked with either.
 242  */
 243 #define VHOLD_NO_SMR    (1<<29) /* Disable vhold_smr */
 244 #define VHOLD_ALL_FLAGS (VHOLD_NO_SMR)
 245
 246 #define VIRF_DOOMED     0x0001  /* This vnode is being recycled */
 247 #define VIRF_PGREAD     0x0002  /* Direct reads from the page cache are permitted,
 248                                    never cleared once set */
 249 #define VIRF_MOUNTPOINT 0x0004  /* This vnode is mounted on */
 250
 251 #define VI_TEXT_REF     0x0001  /* Text ref grabbed use ref */
 252 #define VI_MOUNT        0x0002  /* Mount in progress */
 253 #define VI_DOINGINACT   0x0004  /* VOP_INACTIVE is in progress */
 254 #define VI_OWEINACT     0x0008  /* Need to call inactive */
 255 #define VI_DEFINACT     0x0010  /* deferred inactive */
 256
 257 #define VV_ROOT         0x0001  /* root of its filesystem */
 258 #define VV_ISTTY        0x0002  /* vnode represents a tty */
 259 #define VV_NOSYNC       0x0004  /* unlinked, stop syncing */
 260 #define VV_ETERNALDEV   0x0008  /* device that is never destroyed */
 261 #define VV_CACHEDLABEL  0x0010  /* Vnode has valid cached MAC label */
 262 #define VV_VMSIZEVNLOCK 0x0020  /* object size check requires vnode lock */
 263 #define VV_COPYONWRITE  0x0040  /* vnode is doing copy-on-write */
 264 #define VV_SYSTEM       0x0080  /* vnode being used by kernel */
 265 #define VV_PROCDEP      0x0100  /* vnode is process dependent */
 266 #define VV_NOKNOTE      0x0200  /* don't activate knotes on this vnode */
 267 #define VV_DELETED      0x0400  /* should be removed */
 268 #define VV_MD           0x0800  /* vnode backs the md device */
 269 #define VV_FORCEINSMQ   0x1000  /* force the insmntque to succeed */
 270 #define VV_READLINK     0x2000  /* fdescfs linux vnode */
 271
 272 #define VMP_LAZYLIST    0x0001  /* Vnode is on mnt's lazy list */
 273
 274 /*
 275  * Vnode attributes.  A field value of VNOVAL represents a field whose value
 276  * is unavailable (getattr) or which is not to be changed (setattr).
 277  */
 278 struct vattr {
 279         enum vtype      va_type;        /* vnode type (for create) */
 280         u_short         va_mode;        /* files access mode and type */
 281         u_short         va_padding0;
 282         uid_t           va_uid;         /* owner user id */
 283         gid_t           va_gid;         /* owner group id */
 284         nlink_t         va_nlink;       /* number of references to file */
 285         dev_t           va_fsid;        /* filesystem id */
 286         ino_t           va_fileid;      /* file id */
 287         u_quad_t        va_size;        /* file size in bytes */
 288         long            va_blocksize;   /* blocksize preferred for i/o */
 289         struct timespec va_atime;       /* time of last access */
 290         struct timespec va_mtime;       /* time of last modification */
 291         struct timespec va_ctime;       /* time file changed */
 292         struct timespec va_birthtime;   /* time file created */
 293         u_long          va_gen;         /* generation number of file */
 294         u_long          va_flags;       /* flags defined for file */
 295         dev_t           va_rdev;        /* device the special file represents */
 296         u_quad_t        va_bytes;       /* bytes of disk space held by file */
 297         u_quad_t        va_filerev;     /* file modification number */
 298         u_int           va_vaflags;     /* operations flags, see below */
 299         long            va_spare;       /* remain quad aligned */
 300 };
 301
 302 /*
 303  * Flags for va_vaflags.
 304  */
 305 #define VA_UTIMES_NULL  0x01            /* utimes argument was NULL */
 306 #define VA_EXCLUSIVE    0x02            /* exclusive create request */
 307 #define VA_SYNC         0x04            /* O_SYNC truncation */
 308
 309 /*
 310  * Flags for ioflag. (high 16 bits used to ask for read-ahead and
 311  * help with write clustering)
 312  * NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h
 313  */
 314 #define IO_UNIT         0x0001          /* do I/O as atomic unit */
 315 #define IO_APPEND       0x0002          /* append write to end */
 316 #define IO_NDELAY       0x0004          /* FNDELAY flag set in file table */
 317 #define IO_NODELOCKED   0x0008          /* underlying node already locked */
 318 #define IO_ASYNC        0x0010          /* bawrite rather then bdwrite */
 319 #define IO_VMIO         0x0020          /* data already in VMIO space */
 320 #define IO_INVAL        0x0040          /* invalidate after I/O */
 321 #define IO_SYNC         0x0080          /* do I/O synchronously */
 322 #define IO_DIRECT       0x0100          /* attempt to bypass buffer cache */
 323 #define IO_NOREUSE      0x0200          /* VMIO data won't be reused */
 324 #define IO_EXT          0x0400          /* operate on external attributes */
 325 #define IO_NORMAL       0x0800          /* operate on regular data */
 326 #define IO_NOMACCHECK   0x1000          /* MAC checks unnecessary */
 327 #define IO_BUFLOCKED    0x2000          /* ffs flag; indir buf is locked */
 328 #define IO_RANGELOCKED  0x4000          /* range locked */
 329 #define IO_DATASYNC     0x8000          /* do only data I/O synchronously */
 330
 331 #define IO_SEQMAX       0x7F            /* seq heuristic max value */
 332 #define IO_SEQSHIFT     16              /* seq heuristic in upper 16 bits */
 333
 334 /*
 335  * Flags for accmode_t.
 336  */
 337 #define VEXEC                   000000000100 /* execute/search permission */
 338 #define VWRITE                  000000000200 /* write permission */
 339 #define VREAD                   000000000400 /* read permission */
 340 #define VADMIN                  000000010000 /* being the file owner */
 341 #define VAPPEND                 000000040000 /* permission to write/append */
 342 /*
 343  * VEXPLICIT_DENY makes VOP_ACCESSX(9) return EPERM or EACCES only
 344  * if permission was denied explicitly, by a "deny" rule in NFSv4 ACL,
 345  * and 0 otherwise.  This never happens with ordinary unix access rights
 346  * or POSIX.1e ACLs.  Obviously, VEXPLICIT_DENY must be OR-ed with
 347  * some other V* constant.
 348  */
 349 #define VEXPLICIT_DENY          000000100000
 350 #define VREAD_NAMED_ATTRS       000000200000 /* not used */
 351 #define VWRITE_NAMED_ATTRS      000000400000 /* not used */
 352 #define VDELETE_CHILD           000001000000
 353 #define VREAD_ATTRIBUTES        000002000000 /* permission to stat(2) */
 354 #define VWRITE_ATTRIBUTES       000004000000 /* change {m,c,a}time */
 355 #define VDELETE                 000010000000
 356 #define VREAD_ACL               000020000000 /* read ACL and file mode */
 357 #define VWRITE_ACL              000040000000 /* change ACL and/or file mode */
 358 #define VWRITE_OWNER            000100000000 /* change file owner */
 359 #define VSYNCHRONIZE            000200000000 /* not used */
 360 #define VCREAT                  000400000000 /* creating new file */
 361 #define VVERIFY                 001000000000 /* verification required */
 362
 363 /*
 364  * Permissions that were traditionally granted only to the file owner.
 365  */
 366 #define VADMIN_PERMS    (VADMIN | VWRITE_ATTRIBUTES | VWRITE_ACL | \
 367     VWRITE_OWNER)
 368
 369 /*
 370  * Permissions that were traditionally granted to everyone.
 371  */
 372 #define VSTAT_PERMS     (VREAD_ATTRIBUTES | VREAD_ACL)
 373
 374 /*
 375  * Permissions that allow to change the state of the file in any way.
 376  */
 377 #define VMODIFY_PERMS   (VWRITE | VAPPEND | VADMIN_PERMS | VDELETE_CHILD | \
 378     VDELETE)
 379
 380 /*
 381  * Token indicating no attribute value yet assigned.
 382  */
 383 #define VNOVAL  (-1)
 384
 385 /*
 386  * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
 387  */
 388 #define VLKTIMEOUT      (hz / 20 + 1)
 389
 390 #ifdef _KERNEL
 391
 392 #ifdef MALLOC_DECLARE
 393 MALLOC_DECLARE(M_VNODE);
 394 #endif
 395
 396 extern u_int ncsizefactor;
 397 extern const u_int io_hold_cnt;
 398
 399 /*
 400  * Convert between vnode types and inode formats (since POSIX.1
 401  * defines mode word of stat structure in terms of inode formats).
 402  */
 403 extern enum vtype       iftovt_tab[];
 404 extern int              vttoif_tab[];
 405 #define IFTOVT(mode)    (iftovt_tab[((mode) & S_IFMT) >> 12])
 406 #define VTTOIF(indx)    (vttoif_tab[(int)(indx)])
 407 #define MAKEIMODE(indx, mode)   (int)(VTTOIF(indx) | (mode))
 408
 409 /*
 410  * Flags to various vnode functions.
 411  */
 412 #define SKIPSYSTEM      0x0001  /* vflush: skip vnodes marked VSYSTEM */
 413 #define FORCECLOSE      0x0002  /* vflush: force file closure */
 414 #define WRITECLOSE      0x0004  /* vflush: only close writable files */
 415 #define EARLYFLUSH      0x0008  /* vflush: early call for ffs_flushfiles */
 416 #define V_SAVE          0x0001  /* vinvalbuf: sync file first */
 417 #define V_ALT           0x0002  /* vinvalbuf: invalidate only alternate bufs */
 418 #define V_NORMAL        0x0004  /* vinvalbuf: invalidate only regular bufs */
 419 #define V_CLEANONLY     0x0008  /* vinvalbuf: invalidate only clean bufs */
 420 #define V_VMIO          0x0010  /* vinvalbuf: called during pageout */
 421 #define V_ALLOWCLEAN    0x0020  /* vinvalbuf: allow clean buffers after flush */
 422 #define REVOKEALL       0x0001  /* vop_revoke: revoke all aliases */
 423 #define V_WAIT          0x0001  /* vn_start_write: sleep for suspend */
 424 #define V_NOWAIT        0x0002  /* vn_start_write: don't sleep for suspend */
 425 #define V_XSLEEP        0x0004  /* vn_start_write: just return after sleep */
 426 #define V_MNTREF        0x0010  /* vn_start_write: mp is already ref-ed */
 427
 428 #define VR_START_WRITE  0x0001  /* vfs_write_resume: start write atomically */
 429 #define VR_NO_SUSPCLR   0x0002  /* vfs_write_resume: do not clear suspension */
 430
 431 #define VS_SKIP_UNMOUNT 0x0001  /* vfs_write_suspend: fail if the
 432                                    filesystem is being unmounted */
 433
 434 #define VREF(vp)        vref(vp)
 435
 436 #ifdef DIAGNOSTIC
 437 #define VATTR_NULL(vap) vattr_null(vap)
 438 #else
 439 #define VATTR_NULL(vap) (*(vap) = va_null)      /* initialize a vattr */
 440 #endif /* DIAGNOSTIC */
 441
 442 #define NULLVP  ((struct vnode *)NULL)
 443
 444 /*
 445  * Global vnode data.
 446  */
 447 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
 448 extern  struct mount *rootdevmp;        /* "/dev" mount */
 449 extern  u_long desiredvnodes;           /* number of vnodes desired */
 450 extern  struct uma_zone *namei_zone;
 451 extern  struct vattr va_null;           /* predefined null vattr structure */
 452
 453 extern  u_int vn_lock_pair_pause_max;
 454
 455 #define VI_LOCK(vp)     mtx_lock(&(vp)->v_interlock)
 456 #define VI_LOCK_FLAGS(vp, flags) mtx_lock_flags(&(vp)->v_interlock, (flags))
 457 #define VI_TRYLOCK(vp)  mtx_trylock(&(vp)->v_interlock)
 458 #define VI_UNLOCK(vp)   mtx_unlock(&(vp)->v_interlock)
 459 #define VI_MTX(vp)      (&(vp)->v_interlock)
 460
 461 #define VN_LOCK_AREC(vp)        lockallowrecurse((vp)->v_vnlock)
 462 #define VN_LOCK_ASHARE(vp)      lockallowshare((vp)->v_vnlock)
 463 #define VN_LOCK_DSHARE(vp)      lockdisableshare((vp)->v_vnlock)
 464
 465 #endif /* _KERNEL */
 466
 467 /*
 468  * Mods for extensibility.
 469  */
 470
 471 /*
 472  * Flags for vdesc_flags:
 473  */
 474 #define VDESC_MAX_VPS           16
 475 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
 476 #define VDESC_VP0_WILLRELE      0x0001
 477 #define VDESC_VP1_WILLRELE      0x0002
 478 #define VDESC_VP2_WILLRELE      0x0004
 479 #define VDESC_VP3_WILLRELE      0x0008
 480
 481 /*
 482  * A generic structure.
 483  * This can be used by bypass routines to identify generic arguments.
 484  */
 485 struct vop_generic_args {
 486         struct vnodeop_desc *a_desc;
 487         /* other random data follows, presumably */
 488 };
 489
 490 typedef int vop_bypass_t(struct vop_generic_args *);
 491
 492 /*
 493  * VDESC_NO_OFFSET is used to identify the end of the offset list
 494  * and in places where no such field exists.
 495  */
 496 #define VDESC_NO_OFFSET -1
 497
 498 /*
 499  * This structure describes the vnode operation taking place.
 500  */
 501 struct vnodeop_desc {
 502         char    *vdesc_name;            /* a readable name for debugging */
 503         int      vdesc_flags;           /* VDESC_* flags */
 504         int     vdesc_vop_offset;
 505         vop_bypass_t    *vdesc_call;    /* Function to call */
 506
 507         /*
 508          * These ops are used by bypass routines to map and locate arguments.
 509          * Creds and procs are not needed in bypass routines, but sometimes
 510          * they are useful to (for example) transport layers.
 511          * Nameidata is useful because it has a cred in it.
 512          */
 513         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
 514         int     vdesc_vpp_offset;       /* return vpp location */
 515         int     vdesc_cred_offset;      /* cred location, if any */
 516         int     vdesc_thread_offset;    /* thread location, if any */
 517         int     vdesc_componentname_offset; /* if any */
 518 };
 519
 520 #ifdef _KERNEL
 521 /*
 522  * A list of all the operation descs.
 523  */
 524 extern struct vnodeop_desc *vnodeop_descs[];
 525
 526 #define VOPARG_OFFSETOF(s_type, field)  __offsetof(s_type, field)
 527 #define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
 528     ((s_type)(((char*)(struct_p)) + (s_offset)))
 529
 530 #ifdef DEBUG_VFS_LOCKS
 531 /*
 532  * Support code to aid in debugging VFS locking problems.  Not totally
 533  * reliable since if the thread sleeps between changing the lock
 534  * state and checking it with the assert, some other thread could
 535  * change the state.  They are good enough for debugging a single
 536  * filesystem using a single-threaded test.  Note that the unreliability is
 537  * limited to false negatives; efforts were made to ensure that false
 538  * positives cannot occur.
 539  */
 540 void    assert_vi_locked(struct vnode *vp, const char *str);
 541 void    assert_vi_unlocked(struct vnode *vp, const char *str);
 542 void    assert_vop_elocked(struct vnode *vp, const char *str);
 543 void    assert_vop_locked(struct vnode *vp, const char *str);
 544 void    assert_vop_unlocked(struct vnode *vp, const char *str);
 545
 546 #define ASSERT_VI_LOCKED(vp, str)       assert_vi_locked((vp), (str))
 547 #define ASSERT_VI_UNLOCKED(vp, str)     assert_vi_unlocked((vp), (str))
 548 #define ASSERT_VOP_ELOCKED(vp, str)     assert_vop_elocked((vp), (str))
 549 #define ASSERT_VOP_LOCKED(vp, str)      assert_vop_locked((vp), (str))
 550 #define ASSERT_VOP_UNLOCKED(vp, str)    assert_vop_unlocked((vp), (str))
 551
 552 #define ASSERT_VOP_IN_SEQC(vp)  do {                            \
 553         struct vnode *_vp = (vp);                               \
 554                                                                 \
 555         VNPASS(seqc_in_modify(_vp->v_seqc), _vp);               \
 556 } while (0)
 557
 558 #define ASSERT_VOP_NOT_IN_SEQC(vp)      do {                    \
 559         struct vnode *_vp = (vp);                               \
 560                                                                 \
 561         VNPASS(!seqc_in_modify(_vp->v_seqc), _vp);              \
 562 } while (0)
 563
 564 #else /* !DEBUG_VFS_LOCKS */
 565
 566 #define ASSERT_VI_LOCKED(vp, str)       ((void)0)
 567 #define ASSERT_VI_UNLOCKED(vp, str)     ((void)0)
 568 #define ASSERT_VOP_ELOCKED(vp, str)     ((void)0)
 569 #define ASSERT_VOP_LOCKED(vp, str)      ((void)0)
 570 #define ASSERT_VOP_UNLOCKED(vp, str)    ((void)0)
 571
 572 #define ASSERT_VOP_IN_SEQC(vp)          ((void)0)
 573 #define ASSERT_VOP_NOT_IN_SEQC(vp)      ((void)0)
 574
 575 #endif /* DEBUG_VFS_LOCKS */
 576
 577 /*
 578  * This call works for vnodes in the kernel.
 579  */
 580 #define VCALL(c) ((c)->a_desc->vdesc_call(c))
 581
 582 #define DOINGASYNC(vp)                                          \
 583         (((vp)->v_mount->mnt_kern_flag & MNTK_ASYNC) != 0 &&    \
 584          ((curthread->td_pflags & TDP_SYNCIO) == 0))
 585
 586 /*
 587  * VMIO support inline
 588  */
 589
 590 extern int vmiodirenable;
 591
 592 static __inline int
 593 vn_canvmio(struct vnode *vp)
 594 {
 595       if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
 596                 return(TRUE);
 597         return(FALSE);
 598 }
 599
 600 /*
 601  * Finally, include the default set of vnode operations.
 602  */
 603 typedef void vop_getpages_iodone_t(void *, vm_page_t *, int, int);
 604 #include "vnode_if.h"
 605
 606 /* vn_open_flags */
 607 #define VN_OPEN_NOAUDIT         0x00000001
 608 #define VN_OPEN_NOCAPCHECK      0x00000002
 609 #define VN_OPEN_NAMECACHE       0x00000004
 610 #define VN_OPEN_INVFS           0x00000008
 611
 612 /*
 613  * Public vnode manipulation functions.
 614  */
 615 struct componentname;
 616 struct file;
 617 struct mount;
 618 struct nameidata;
 619 struct ostat;
 620 struct freebsd11_stat;
 621 struct thread;
 622 struct proc;
 623 struct stat;
 624 struct nstat;
 625 struct ucred;
 626 struct uio;
 627 struct vattr;
 628 struct vfsops;
 629 struct vnode;
 630
 631 typedef int (*vn_get_ino_t)(struct mount *, void *, int, struct vnode **);
 632
 633 int     bnoreuselist(struct bufv *bufv, struct bufobj *bo, daddr_t startn,
 634             daddr_t endn);
 635 /* cache_* may belong in namei.h. */
 636 void    cache_changesize(u_long newhashsize);
 637 #define cache_enter(dvp, vp, cnp)                                       \
 638         cache_enter_time(dvp, vp, cnp, NULL, NULL)
 639 void    cache_enter_time(struct vnode *dvp, struct vnode *vp,
 640             struct componentname *cnp, struct timespec *tsp,
 641             struct timespec *dtsp);
 642 int     cache_lookup(struct vnode *dvp, struct vnode **vpp,
 643             struct componentname *cnp, struct timespec *tsp, int *ticksp);
 644 void    cache_vnode_init(struct vnode *vp);
 645 void    cache_purge(struct vnode *vp);
 646 void    cache_purge_vgone(struct vnode *vp);
 647 void    cache_purge_negative(struct vnode *vp);
 648 void    cache_purgevfs(struct mount *mp);
 649 void    cache_vop_rename(struct vnode *fdvp, struct vnode *fvp, struct vnode *tdvp,
 650     struct vnode *tvp, struct componentname *fcnp, struct componentname *tcnp);
 651 void    cache_vop_rmdir(struct vnode *dvp, struct vnode *vp);
 652 #ifdef INVARIANTS
 653 void    cache_validate(struct vnode *dvp, struct vnode *vp,
 654             struct componentname *cnp);
 655 #else
 656 static inline void
 657 cache_validate(struct vnode *dvp, struct vnode *vp, struct componentname *cnp)
 658 {
 659 }
 660 #endif
 661 void    cache_fast_lookup_enabled_recalc(void);
 662 int     change_dir(struct vnode *vp, struct thread *td);
 663 void    cvtstat(struct stat *st, struct ostat *ost);
 664 void    freebsd11_cvtnstat(struct stat *sb, struct nstat *nsb);
 665 int     freebsd11_cvtstat(struct stat *st, struct freebsd11_stat *ost);
 666 int     getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
 667             struct vnode **vpp);
 668 void    getnewvnode_reserve(void);
 669 void    getnewvnode_drop_reserve(void);
 670 int     insmntque1(struct vnode *vp, struct mount *mp,
 671             void (*dtr)(struct vnode *, void *), void *dtr_arg);
 672 int     insmntque(struct vnode *vp, struct mount *mp);
 673 u_quad_t init_va_filerev(void);
 674 int     speedup_syncer(void);
 675 int     vn_vptocnp(struct vnode **vp, char *buf, size_t *buflen);
 676 int     vn_getcwd(char *buf, char **retbuf, size_t *buflen);
 677 int     vn_fullpath(struct vnode *vp, char **retbuf, char **freebuf);
 678 int     vn_fullpath_global(struct vnode *vp, char **retbuf, char **freebuf);
 679 struct vnode *
 680         vn_dir_dd_ino(struct vnode *vp);
 681 int     vn_commname(struct vnode *vn, char *buf, u_int buflen);
 682 int     vn_path_to_global_path(struct thread *td, struct vnode *vp,
 683             char *path, u_int pathlen);
 684 int     vaccess(enum vtype type, mode_t file_mode, uid_t file_uid,
 685             gid_t file_gid, accmode_t accmode, struct ucred *cred);
 686 int     vaccess_vexec_smr(mode_t file_mode, uid_t file_uid, gid_t file_gid,
 687             struct ucred *cred);
 688 int     vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
 689             struct acl *aclp, accmode_t accmode, struct ucred *cred);
 690 int     vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
 691             gid_t file_gid, struct acl *acl, accmode_t accmode,
 692             struct ucred *cred);
 693 void    vattr_null(struct vattr *vap);
 694 void    vlazy(struct vnode *);
 695 void    vdrop(struct vnode *);
 696 void    vdropl(struct vnode *);
 697 int     vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
 698 int     vget(struct vnode *vp, int flags);
 699 enum vgetstate  vget_prep_smr(struct vnode *vp);
 700 enum vgetstate  vget_prep(struct vnode *vp);
 701 int     vget_finish(struct vnode *vp, int flags, enum vgetstate vs);
 702 void    vget_finish_ref(struct vnode *vp, enum vgetstate vs);
 703 void    vget_abort(struct vnode *vp, enum vgetstate vs);
 704 void    vgone(struct vnode *vp);
 705 void    vhold(struct vnode *);
 706 void    vholdnz(struct vnode *);
 707 bool    vhold_smr(struct vnode *);
 708 void    vinactive(struct vnode *vp);
 709 int     vinvalbuf(struct vnode *vp, int save, int slpflag, int slptimeo);
 710 int     vtruncbuf(struct vnode *vp, off_t length, int blksize);
 711 void    v_inval_buf_range(struct vnode *vp, daddr_t startlbn, daddr_t endlbn,
 712             int blksize);
 713 void    vunref(struct vnode *);
 714 void    vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3);
 715 int     vrecycle(struct vnode *vp);
 716 int     vrecyclel(struct vnode *vp);
 717 int     vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off,
 718             struct ucred *cred);
 719 int     vn_close(struct vnode *vp,
 720             int flags, struct ucred *file_cred, struct thread *td);
 721 int     vn_copy_file_range(struct vnode *invp, off_t *inoffp,
 722             struct vnode *outvp, off_t *outoffp, size_t *lenp,
 723             unsigned int flags, struct ucred *incred, struct ucred *outcred,
 724             struct thread *fsize_td);
 725 void    vn_finished_write(struct mount *mp);
 726 void    vn_finished_secondary_write(struct mount *mp);
 727 int     vn_fsync_buf(struct vnode *vp, int waitfor);
 728 int     vn_generic_copy_file_range(struct vnode *invp, off_t *inoffp,
 729             struct vnode *outvp, off_t *outoffp, size_t *lenp,
 730             unsigned int flags, struct ucred *incred, struct ucred *outcred,
 731             struct thread *fsize_td);
 732 int     vn_need_pageq_flush(struct vnode *vp);
 733 bool    vn_isdisk_error(struct vnode *vp, int *errp);
 734 bool    vn_isdisk(struct vnode *vp);
 735 int     _vn_lock(struct vnode *vp, int flags, const char *file, int line);
 736 #define vn_lock(vp, flags) _vn_lock(vp, flags, __FILE__, __LINE__)
 737 void    vn_lock_pair(struct vnode *vp1, bool vp1_locked, struct vnode *vp2,
 738             bool vp2_locked);
 739 int     vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp);
 740 int     vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
 741             u_int vn_open_flags, struct ucred *cred, struct file *fp);
 742 int     vn_open_vnode(struct vnode *vp, int fmode, struct ucred *cred,
 743             struct thread *td, struct file *fp);
 744 void    vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end);
 745 int     vn_pollrecord(struct vnode *vp, struct thread *p, int events);
 746 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base,
 747             int len, off_t offset, enum uio_seg segflg, int ioflg,
 748             struct ucred *active_cred, struct ucred *file_cred, ssize_t *aresid,
 749             struct thread *td);
 750 int     vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base,
 751             size_t len, off_t offset, enum uio_seg segflg, int ioflg,
 752             struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
 753             struct thread *td);
 754 int     vn_read_from_obj(struct vnode *vp, struct uio *uio);
 755 int     vn_rlimit_fsize(const struct vnode *vp, const struct uio *uio,
 756             struct thread *td);
 757 int     vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
 758 int     vn_start_secondary_write(struct vnode *vp, struct mount **mpp,
 759             int flags);
 760 int     vn_truncate_locked(struct vnode *vp, off_t length, bool sync,
 761             struct ucred *cred);
 762 int     vn_writechk(struct vnode *vp);
 763 int     vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
 764             const char *attrname, int *buflen, char *buf, struct thread *td);
 765 int     vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
 766             const char *attrname, int buflen, char *buf, struct thread *td);
 767 int     vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
 768             const char *attrname, struct thread *td);
 769 int     vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags,
 770             struct vnode **rvp);
 771 int     vn_vget_ino_gen(struct vnode *vp, vn_get_ino_t alloc,
 772             void *alloc_arg, int lkflags, struct vnode **rvp);
 773 int     vn_utimes_perm(struct vnode *vp, struct vattr *vap,
 774             struct ucred *cred, struct thread *td);
 775
 776 int     vn_io_fault_uiomove(char *data, int xfersize, struct uio *uio);
 777 int     vn_io_fault_pgmove(vm_page_t ma[], vm_offset_t offset, int xfersize,
 778             struct uio *uio);
 779
 780 void    vn_seqc_write_begin_unheld_locked(struct vnode *vp);
 781 void    vn_seqc_write_begin_unheld(struct vnode *vp);
 782 void    vn_seqc_write_begin_locked(struct vnode *vp);
 783 void    vn_seqc_write_begin(struct vnode *vp);
 784 void    vn_seqc_write_end_locked(struct vnode *vp);
 785 void    vn_seqc_write_end(struct vnode *vp);
 786 #define vn_seqc_read_any(vp)            seqc_read_any(&(vp)->v_seqc)
 787 #define vn_seqc_read_notmodify(vp)      seqc_read_notmodify(&(vp)->v_seqc)
 788 #define vn_seqc_consistent(vp, seq)     seqc_consistent(&(vp)->v_seqc, seq)
 789
 790 #define vn_rangelock_unlock(vp, cookie)                                 \
 791         rangelock_unlock(&(vp)->v_rl, (cookie), VI_MTX(vp))
 792 #define vn_rangelock_unlock_range(vp, cookie, start, end)               \
 793         rangelock_unlock_range(&(vp)->v_rl, (cookie), (start), (end),   \
 794             VI_MTX(vp))
 795 #define vn_rangelock_rlock(vp, start, end)                              \
 796         rangelock_rlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
 797 #define vn_rangelock_tryrlock(vp, start, end)                           \
 798         rangelock_tryrlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
 799 #define vn_rangelock_wlock(vp, start, end)                              \
 800         rangelock_wlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
 801 #define vn_rangelock_trywlock(vp, start, end)                           \
 802         rangelock_trywlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
 803
 804 #define vn_irflag_read(vp)      atomic_load_short(&(vp)->v_irflag)
 805 void    vn_irflag_set_locked(struct vnode *vp, short toset);
 806 void    vn_irflag_set(struct vnode *vp, short toset);
 807 void    vn_irflag_set_cond_locked(struct vnode *vp, short toset);
 808 void    vn_irflag_set_cond(struct vnode *vp, short toset);
 809 void    vn_irflag_unset_locked(struct vnode *vp, short tounset);
 810 void    vn_irflag_unset(struct vnode *vp, short tounset);
 811
 812 int     vfs_cache_lookup(struct vop_lookup_args *ap);
 813 int     vfs_cache_root(struct mount *mp, int flags, struct vnode **vpp);
 814 void    vfs_timestamp(struct timespec *);
 815 void    vfs_write_resume(struct mount *mp, int flags);
 816 int     vfs_write_suspend(struct mount *mp, int flags);
 817 int     vfs_write_suspend_umnt(struct mount *mp);
 818 void    vnlru_free(int, struct vfsops *);
 819 int     vop_stdbmap(struct vop_bmap_args *);
 820 int     vop_stdfdatasync_buf(struct vop_fdatasync_args *);
 821 int     vop_stdfsync(struct vop_fsync_args *);
 822 int     vop_stdgetwritemount(struct vop_getwritemount_args *);
 823 int     vop_stdgetpages(struct vop_getpages_args *);
 824 int     vop_stdinactive(struct vop_inactive_args *);
 825 int     vop_stdioctl(struct vop_ioctl_args *);
 826 int     vop_stdneed_inactive(struct vop_need_inactive_args *);
 827 int     vop_stdkqfilter(struct vop_kqfilter_args *);
 828 int     vop_stdlock(struct vop_lock1_args *);
 829 int     vop_stdunlock(struct vop_unlock_args *);
 830 int     vop_stdislocked(struct vop_islocked_args *);
 831 int     vop_lock(struct vop_lock1_args *);
 832 int     vop_unlock(struct vop_unlock_args *);
 833 int     vop_islocked(struct vop_islocked_args *);
 834 int     vop_stdputpages(struct vop_putpages_args *);
 835 int     vop_nopoll(struct vop_poll_args *);
 836 int     vop_stdaccess(struct vop_access_args *ap);
 837 int     vop_stdaccessx(struct vop_accessx_args *ap);
 838 int     vop_stdadvise(struct vop_advise_args *ap);
 839 int     vop_stdadvlock(struct vop_advlock_args *ap);
 840 int     vop_stdadvlockasync(struct vop_advlockasync_args *ap);
 841 int     vop_stdadvlockpurge(struct vop_advlockpurge_args *ap);
 842 int     vop_stdallocate(struct vop_allocate_args *ap);
 843 int     vop_stdset_text(struct vop_set_text_args *ap);
 844 int     vop_stdpathconf(struct vop_pathconf_args *);
 845 int     vop_stdpoll(struct vop_poll_args *);
 846 int     vop_stdvptocnp(struct vop_vptocnp_args *ap);
 847 int     vop_stdvptofh(struct vop_vptofh_args *ap);
 848 int     vop_stdunp_bind(struct vop_unp_bind_args *ap);
 849 int     vop_stdunp_connect(struct vop_unp_connect_args *ap);
 850 int     vop_stdunp_detach(struct vop_unp_detach_args *ap);
 851 int     vop_eopnotsupp(struct vop_generic_args *ap);
 852 int     vop_ebadf(struct vop_generic_args *ap);
 853 int     vop_einval(struct vop_generic_args *ap);
 854 int     vop_enoent(struct vop_generic_args *ap);
 855 int     vop_enotty(struct vop_generic_args *ap);
 856 int     vop_eagain(struct vop_generic_args *ap);
 857 int     vop_null(struct vop_generic_args *ap);
 858 int     vop_panic(struct vop_generic_args *ap);
 859 int     dead_poll(struct vop_poll_args *ap);
 860 int     dead_read(struct vop_read_args *ap);
 861 int     dead_write(struct vop_write_args *ap);
 862
 863 /* These are called from within the actual VOPS. */
 864 void    vop_close_post(void *a, int rc);
 865 void    vop_create_pre(void *a);
 866 void    vop_create_post(void *a, int rc);
 867 void    vop_whiteout_pre(void *a);
 868 void    vop_whiteout_post(void *a, int rc);
 869 void    vop_deleteextattr_pre(void *a);
 870 void    vop_deleteextattr_post(void *a, int rc);
 871 void    vop_link_pre(void *a);
 872 void    vop_link_post(void *a, int rc);
 873 void    vop_lookup_post(void *a, int rc);
 874 void    vop_lookup_pre(void *a);
 875 void    vop_mkdir_pre(void *a);
 876 void    vop_mkdir_post(void *a, int rc);
 877 void    vop_mknod_pre(void *a);
 878 void    vop_mknod_post(void *a, int rc);
 879 void    vop_open_post(void *a, int rc);
 880 void    vop_read_post(void *a, int rc);
 881 void    vop_read_pgcache_post(void *ap, int rc);
 882 void    vop_readdir_post(void *a, int rc);
 883 void    vop_reclaim_post(void *a, int rc);
 884 void    vop_remove_pre(void *a);
 885 void    vop_remove_post(void *a, int rc);
 886 void    vop_rename_post(void *a, int rc);
 887 void    vop_rename_pre(void *a);
 888 void    vop_rmdir_pre(void *a);
 889 void    vop_rmdir_post(void *a, int rc);
 890 void    vop_setattr_pre(void *a);
 891 void    vop_setattr_post(void *a, int rc);
 892 void    vop_setacl_pre(void *a);
 893 void    vop_setacl_post(void *a, int rc);
 894 void    vop_setextattr_pre(void *a);
 895 void    vop_setextattr_post(void *a, int rc);
 896 void    vop_symlink_pre(void *a);
 897 void    vop_symlink_post(void *a, int rc);
 898 int     vop_sigdefer(struct vop_vector *vop, struct vop_generic_args *a);
 899
 900 #ifdef DEBUG_VFS_LOCKS
 901 void    vop_fplookup_vexec_debugpre(void *a);
 902 void    vop_fplookup_vexec_debugpost(void *a, int rc);
 903 void    vop_strategy_debugpre(void *a);
 904 void    vop_lock_debugpre(void *a);
 905 void    vop_lock_debugpost(void *a, int rc);
 906 void    vop_unlock_debugpre(void *a);
 907 void    vop_need_inactive_debugpre(void *a);
 908 void    vop_need_inactive_debugpost(void *a, int rc);
 909 void    vop_mkdir_debugpost(void *a, int rc);
 910 #else
 911 #define vop_fplookup_vexec_debugpre(x)          do { } while (0)
 912 #define vop_fplookup_vexec_debugpost(x, y)      do { } while (0)
 913 #define vop_strategy_debugpre(x)                do { } while (0)
 914 #define vop_lock_debugpre(x)                    do { } while (0)
 915 #define vop_lock_debugpost(x, y)                do { } while (0)
 916 #define vop_unlock_debugpre(x)                  do { } while (0)
 917 #define vop_need_inactive_debugpre(x)           do { } while (0)
 918 #define vop_need_inactive_debugpost(x, y)       do { } while (0)
 919 #define vop_mkdir_debugpost(x, y)               do { } while (0)
 920 #endif
 921
 922 void    vop_rename_fail(struct vop_rename_args *ap);
 923
 924 #define vop_stat_helper_pre(ap) ({                                              \
 925         int _error;                                                             \
 926         AUDIT_ARG_VNODE1(ap->a_vp);                                             \
 927         _error = mac_vnode_check_stat(ap->a_active_cred, ap->a_file_cred, ap->a_vp);\
 928         if (__predict_true(_error == 0))                                        \
 929                 bzero(ap->a_sb, sizeof(*ap->a_sb));                             \
 930         _error;                                                                 \
 931 })
 932
 933 #define vop_stat_helper_post(ap, error) ({                                      \
 934         int _error = (error);                                                   \
 935         if (priv_check_cred_vfs_generation(ap->a_td->td_ucred))                 \
 936                 ap->a_sb->st_gen = 0;                                           \
 937         _error;                                                                 \
 938 })
 939
 940 #define VOP_WRITE_PRE(ap)                                               \
 941         struct vattr va;                                                \
 942         int error;                                                      \
 943         off_t osize, ooffset, noffset;                                  \
 944                                                                         \
 945         osize = ooffset = noffset = 0;                                  \
 946         if (!VN_KNLIST_EMPTY((ap)->a_vp)) {                             \
 947                 error = VOP_GETATTR((ap)->a_vp, &va, (ap)->a_cred);     \
 948                 if (error)                                              \
 949                         return (error);                                 \
 950                 ooffset = (ap)->a_uio->uio_offset;                      \
 951                 osize = (off_t)va.va_size;                              \
 952         }
 953
 954 #define VOP_WRITE_POST(ap, ret)                                         \
 955         noffset = (ap)->a_uio->uio_offset;                              \
 956         if (noffset > ooffset && !VN_KNLIST_EMPTY((ap)->a_vp)) {        \
 957                 VFS_KNOTE_LOCKED((ap)->a_vp, NOTE_WRITE                 \
 958                     | (noffset > osize ? NOTE_EXTEND : 0));             \
 959         }
 960
 961 #define VOP_LOCK(vp, flags) VOP_LOCK1(vp, flags, __FILE__, __LINE__)
 962
 963 #ifdef INVARIANTS
 964 #define VOP_ADD_WRITECOUNT_CHECKED(vp, cnt)                             \
 965 do {                                                                    \
 966         int error_;                                                     \
 967                                                                         \
 968         error_ = VOP_ADD_WRITECOUNT((vp), (cnt));                       \
 969         VNASSERT(error_ == 0, (vp), ("VOP_ADD_WRITECOUNT returned %d",  \
 970             error_));                                                   \
 971 } while (0)
 972 #define VOP_SET_TEXT_CHECKED(vp)                                        \
 973 do {                                                                    \
 974         int error_;                                                     \
 975                                                                         \
 976         error_ = VOP_SET_TEXT((vp));                                    \
 977         VNASSERT(error_ == 0, (vp), ("VOP_SET_TEXT returned %d",        \
 978             error_));                                                   \
 979 } while (0)
 980 #define VOP_UNSET_TEXT_CHECKED(vp)                                      \
 981 do {                                                                    \
 982         int error_;                                                     \
 983                                                                         \
 984         error_ = VOP_UNSET_TEXT((vp));                                  \
 985         VNASSERT(error_ == 0, (vp), ("VOP_UNSET_TEXT returned %d",      \
 986             error_));                                                   \
 987 } while (0)
 988 #else
 989 #define VOP_ADD_WRITECOUNT_CHECKED(vp, cnt)     VOP_ADD_WRITECOUNT((vp), (cnt))
 990 #define VOP_SET_TEXT_CHECKED(vp)                VOP_SET_TEXT((vp))
 991 #define VOP_UNSET_TEXT_CHECKED(vp)              VOP_UNSET_TEXT((vp))
 992 #endif
 993
 994 #define VN_IS_DOOMED(vp)        __predict_false((vn_irflag_read(vp) & VIRF_DOOMED) != 0)
 995
 996 void    vput(struct vnode *vp);
 997 void    vrele(struct vnode *vp);
 998 void    vref(struct vnode *vp);
 999 void    vrefact(struct vnode *vp);
1000 void    v_addpollinfo(struct vnode *vp);
1001 static __inline int
1002 vrefcnt(struct vnode *vp)
1003 {
1004
1005         return (vp->v_usecount);
1006 }
1007
1008 #define vholdl(vp)      do {                                            \
1009         ASSERT_VI_LOCKED(vp, __func__);                                 \
1010         vhold(vp);                                                      \
1011 } while (0)
1012
1013 #define vrefl(vp)       do {                                            \
1014         ASSERT_VI_LOCKED(vp, __func__);                                 \
1015         vref(vp);                                                       \
1016 } while (0)
1017
1018 int vnode_create_vobject(struct vnode *vp, off_t size, struct thread *td);
1019 void vnode_destroy_vobject(struct vnode *vp);
1020
1021 extern struct vop_vector fifo_specops;
1022 extern struct vop_vector dead_vnodeops;
1023 extern struct vop_vector default_vnodeops;
1024
1025 #define VOP_PANIC       ((void*)(uintptr_t)vop_panic)
1026 #define VOP_NULL        ((void*)(uintptr_t)vop_null)
1027 #define VOP_EBADF       ((void*)(uintptr_t)vop_ebadf)
1028 #define VOP_ENOTTY      ((void*)(uintptr_t)vop_enotty)
1029 #define VOP_EINVAL      ((void*)(uintptr_t)vop_einval)
1030 #define VOP_ENOENT      ((void*)(uintptr_t)vop_enoent)
1031 #define VOP_EOPNOTSUPP  ((void*)(uintptr_t)vop_eopnotsupp)
1032 #define VOP_EAGAIN      ((void*)(uintptr_t)vop_eagain)
1033
1034 /* fifo_vnops.c */
1035 int     fifo_printinfo(struct vnode *);
1036
1037 /* vfs_hash.c */
1038 typedef int vfs_hash_cmp_t(struct vnode *vp, void *arg);
1039
1040 void vfs_hash_changesize(u_long newhashsize);
1041 int vfs_hash_get(const struct mount *mp, u_int hash, int flags,
1042     struct thread *td, struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
1043 u_int vfs_hash_index(struct vnode *vp);
1044 int vfs_hash_insert(struct vnode *vp, u_int hash, int flags, struct thread *td,
1045     struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
1046 void vfs_hash_ref(const struct mount *mp, u_int hash, struct thread *td,
1047     struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
1048 void vfs_hash_rehash(struct vnode *vp, u_int hash);
1049 void vfs_hash_remove(struct vnode *vp);
1050
1051 int vfs_kqfilter(struct vop_kqfilter_args *);
1052 struct dirent;
1053 int vfs_read_dirent(struct vop_readdir_args *ap, struct dirent *dp, off_t off);
1054 int vfs_emptydir(struct vnode *vp);
1055
1056 int vfs_unixify_accmode(accmode_t *accmode);
1057
1058 void vfs_unp_reclaim(struct vnode *vp);
1059
1060 int setfmode(struct thread *td, struct ucred *cred, struct vnode *vp, int mode);
1061 int setfown(struct thread *td, struct ucred *cred, struct vnode *vp, uid_t uid,
1062     gid_t gid);
1063 int vn_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
1064     struct thread *td);
1065 int vn_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
1066     struct thread *td);
1067
1068 void vn_fsid(struct vnode *vp, struct vattr *va);
1069
1070 int vn_dir_check_exec(struct vnode *vp, struct componentname *cnp);
1071
1072 #define VOP_UNLOCK_FLAGS(vp, flags)     ({                              \
1073         struct vnode *_vp = (vp);                                       \
1074         int _flags = (flags);                                           \
1075         int _error;                                                     \
1076                                                                         \
1077         if ((_flags & ~(LK_INTERLOCK | LK_RELEASE)) != 0)               \
1078                 panic("%s: unsupported flags %x\n", __func__, flags);   \
1079         _error = VOP_UNLOCK(_vp);                                       \
1080         if (_flags & LK_INTERLOCK)                                      \
1081                 VI_UNLOCK(_vp);                                         \
1082         _error;                                                         \
1083 })
1084
1085 #include <sys/kernel.h>
1086
1087 #define VFS_VOP_VECTOR_REGISTER(vnodeops) \
1088         SYSINIT(vfs_vector_##vnodeops##_f, SI_SUB_VFS, SI_ORDER_ANY, \
1089             vfs_vector_op_register, &vnodeops)
1090
1091 #define VFS_SMR_DECLARE                         \
1092         extern smr_t vfs_smr
1093
1094 #define VFS_SMR()       vfs_smr
1095 #define vfs_smr_enter() smr_enter(VFS_SMR())
1096 #define vfs_smr_exit()  smr_exit(VFS_SMR())
1097 #define vfs_smr_entered_load(ptr)       smr_entered_load((ptr), VFS_SMR())
1098 #define VFS_SMR_ASSERT_ENTERED()        SMR_ASSERT_ENTERED(VFS_SMR())
1099 #define VFS_SMR_ASSERT_NOT_ENTERED()    SMR_ASSERT_NOT_ENTERED(VFS_SMR())
1100 #define VFS_SMR_ZONE_SET(zone)  uma_zone_set_smr((zone), VFS_SMR())
1101
1102 #define vn_load_v_data_smr(vp)  ({              \
1103         struct vnode *_vp = (vp);               \
1104                                                 \
1105         VFS_SMR_ASSERT_ENTERED();               \
1106         atomic_load_ptr(&(_vp)->v_data);        \
1107 })
1108
1109 #endif /* _KERNEL */
1110
1111 #endif /* !_SYS_VNODE_H_ */