The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/vnode.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    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 namecache *v_cache_dd;           /* c Cache entry for .. 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         struct lockf *v_lockf;                  /* Byte-level lock list */
  175 };
  176 
  177 #endif /* defined(_KERNEL) || defined(_KVM_VNODE) */
  178 
  179 #define v_mountedhere   v_un.vu_mount
  180 #define v_socket        v_un.vu_socket
  181 #define v_rdev          v_un.vu_cdev
  182 #define v_fifoinfo      v_un.vu_fifoinfo
  183 #define v_yield         v_un.vu_yield
  184 
  185 /* XXX: These are temporary to avoid a source sweep at this time */
  186 #define v_object        v_bufobj.bo_object
  187 
  188 /*
  189  * Userland version of struct vnode, for sysctl.
  190  */
  191 struct xvnode {
  192         size_t  xv_size;                        /* sizeof(struct xvnode) */
  193         void    *xv_vnode;                      /* address of real vnode */
  194         u_long  xv_flag;                        /* vnode vflags */
  195         int     xv_usecount;                    /* reference count of users */
  196         int     xv_writecount;                  /* reference count of writers */
  197         int     xv_holdcnt;                     /* page & buffer references */
  198         u_long  xv_id;                          /* capability identifier */
  199         void    *xv_mount;                      /* address of parent mount */
  200         long    xv_numoutput;                   /* num of writes in progress */
  201         enum    vtype xv_type;                  /* vnode type */
  202         union {
  203                 void    *xvu_socket;            /* socket, if VSOCK */
  204                 void    *xvu_fifo;              /* fifo, if VFIFO */
  205                 dev_t   xvu_rdev;               /* maj/min, if VBLK/VCHR */
  206                 struct {
  207                         dev_t   xvu_dev;        /* device, if VDIR/VREG/VLNK */
  208                         ino_t   xvu_ino;        /* id, if VDIR/VREG/VLNK */
  209                 } xv_uns;
  210         } xv_un;
  211 };
  212 #define xv_socket       xv_un.xvu_socket
  213 #define xv_fifo         xv_un.xvu_fifo
  214 #define xv_rdev         xv_un.xvu_rdev
  215 #define xv_dev          xv_un.xv_uns.xvu_dev
  216 #define xv_ino          xv_un.xv_uns.xvu_ino
  217 
  218 /* We don't need to lock the knlist */
  219 #define VN_KNLIST_EMPTY(vp) ((vp)->v_pollinfo == NULL ||        \
  220             KNLIST_EMPTY(&(vp)->v_pollinfo->vpi_selinfo.si_note))
  221 
  222 #define VN_KNOTE(vp, b, a)                                      \
  223         do {                                                    \
  224                 if (!VN_KNLIST_EMPTY(vp))                       \
  225                         KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), (a)); \
  226         } while (0)
  227 #define VN_KNOTE_LOCKED(vp, b)          VN_KNOTE(vp, b, 1)
  228 #define VN_KNOTE_UNLOCKED(vp, b)        VN_KNOTE(vp, b, 0)
  229 
  230 /*
  231  * Vnode flags.
  232  *      VI flags are protected by interlock and live in v_iflag
  233  *      VV flags are protected by the vnode lock and live in v_vflag
  234  */
  235 #define VI_MOUNT        0x0020  /* Mount in progress */
  236 #define VI_AGE          0x0040  /* Insert vnode at head of free list */
  237 #define VI_DOOMED       0x0080  /* This vnode is being recycled */
  238 #define VI_FREE         0x0100  /* This vnode is on the freelist */
  239 #define VI_OBJDIRTY     0x0400  /* object might be dirty */
  240 #define VI_DOINGINACT   0x0800  /* VOP_INACTIVE is in progress */
  241 #define VI_OWEINACT     0x1000  /* Need to call inactive */
  242 
  243 #define VV_ROOT         0x0001  /* root of its filesystem */
  244 #define VV_ISTTY        0x0002  /* vnode represents a tty */
  245 #define VV_NOSYNC       0x0004  /* unlinked, stop syncing */
  246 #define VV_CACHEDLABEL  0x0010  /* Vnode has valid cached MAC label */
  247 #define VV_TEXT         0x0020  /* vnode is a pure text prototype */
  248 #define VV_COPYONWRITE  0x0040  /* vnode is doing copy-on-write */
  249 #define VV_SYSTEM       0x0080  /* vnode being used by kernel */
  250 #define VV_PROCDEP      0x0100  /* vnode is process dependent */
  251 #define VV_NOKNOTE      0x0200  /* don't activate knotes on this vnode */
  252 #define VV_DELETED      0x0400  /* should be removed */
  253 #define VV_MD           0x0800  /* vnode backs the md device */
  254 #define VV_FORCEINSMQ   0x1000  /* force the insmntque to succeed */
  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 #define VN_LOCK_AREC(vp)        ((vp)->v_vnlock->lk_flags |= LK_CANRECURSE)
  401 #define VN_LOCK_ASHARE(vp)      ((vp)->v_vnlock->lk_flags &= ~LK_NOSHARE)
  402 
  403 #endif /* _KERNEL */
  404 
  405 /*
  406  * Mods for extensibility.
  407  */
  408 
  409 /*
  410  * Flags for vdesc_flags:
  411  */
  412 #define VDESC_MAX_VPS           16
  413 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
  414 #define VDESC_VP0_WILLRELE      0x0001
  415 #define VDESC_VP1_WILLRELE      0x0002
  416 #define VDESC_VP2_WILLRELE      0x0004
  417 #define VDESC_VP3_WILLRELE      0x0008
  418 #define VDESC_NOMAP_VPP         0x0100
  419 #define VDESC_VPP_WILLRELE      0x0200
  420 
  421 /*
  422  * A generic structure.
  423  * This can be used by bypass routines to identify generic arguments.
  424  */
  425 struct vop_generic_args {
  426         struct vnodeop_desc *a_desc;
  427         /* other random data follows, presumably */
  428 };
  429 
  430 typedef int vop_bypass_t(struct vop_generic_args *);
  431 
  432 /*
  433  * VDESC_NO_OFFSET is used to identify the end of the offset list
  434  * and in places where no such field exists.
  435  */
  436 #define VDESC_NO_OFFSET -1
  437 
  438 /*
  439  * This structure describes the vnode operation taking place.
  440  */
  441 struct vnodeop_desc {
  442         char    *vdesc_name;            /* a readable name for debugging */
  443         int      vdesc_flags;           /* VDESC_* flags */
  444         vop_bypass_t    *vdesc_call;    /* Function to call */
  445 
  446         /*
  447          * These ops are used by bypass routines to map and locate arguments.
  448          * Creds and procs are not needed in bypass routines, but sometimes
  449          * they are useful to (for example) transport layers.
  450          * Nameidata is useful because it has a cred in it.
  451          */
  452         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
  453         int     vdesc_vpp_offset;       /* return vpp location */
  454         int     vdesc_cred_offset;      /* cred location, if any */
  455         int     vdesc_thread_offset;    /* thread location, if any */
  456         int     vdesc_componentname_offset; /* if any */
  457 };
  458 
  459 #ifdef _KERNEL
  460 /*
  461  * A list of all the operation descs.
  462  */
  463 extern struct vnodeop_desc *vnodeop_descs[];
  464 
  465 #define VOPARG_OFFSETOF(s_type, field)  __offsetof(s_type, field)
  466 #define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
  467     ((s_type)(((char*)(struct_p)) + (s_offset)))
  468 
  469 
  470 #ifdef DEBUG_VFS_LOCKS
  471 /*
  472  * Support code to aid in debugging VFS locking problems.  Not totally
  473  * reliable since if the thread sleeps between changing the lock
  474  * state and checking it with the assert, some other thread could
  475  * change the state.  They are good enough for debugging a single
  476  * filesystem using a single-threaded test.
  477  */
  478 void    assert_vi_locked(struct vnode *vp, const char *str);
  479 void    assert_vi_unlocked(struct vnode *vp, const char *str);
  480 void    assert_vop_elocked(struct vnode *vp, const char *str);
  481 #if 0
  482 void    assert_vop_elocked_other(struct vnode *vp, const char *str);
  483 #endif
  484 void    assert_vop_locked(struct vnode *vp, const char *str);
  485 #if 0
  486 voi0    assert_vop_slocked(struct vnode *vp, const char *str);
  487 #endif
  488 void    assert_vop_unlocked(struct vnode *vp, const char *str);
  489 
  490 #define ASSERT_VI_LOCKED(vp, str)       assert_vi_locked((vp), (str))
  491 #define ASSERT_VI_UNLOCKED(vp, str)     assert_vi_unlocked((vp), (str))
  492 #define ASSERT_VOP_ELOCKED(vp, str)     assert_vop_elocked((vp), (str))
  493 #if 0
  494 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
  495 #endif
  496 #define ASSERT_VOP_LOCKED(vp, str)      assert_vop_locked((vp), (str))
  497 #if 0
  498 #define ASSERT_VOP_SLOCKED(vp, str)     assert_vop_slocked((vp), (str))
  499 #endif
  500 #define ASSERT_VOP_UNLOCKED(vp, str)    assert_vop_unlocked((vp), (str))
  501 
  502 #else /* !DEBUG_VFS_LOCKS */
  503 
  504 #define ASSERT_VI_LOCKED(vp, str)
  505 #define ASSERT_VI_UNLOCKED(vp, str)
  506 #define ASSERT_VOP_ELOCKED(vp, str)
  507 #if 0
  508 #define ASSERT_VOP_ELOCKED_OTHER(vp, str)
  509 #endif
  510 #define ASSERT_VOP_LOCKED(vp, str)
  511 #if 0
  512 #define ASSERT_VOP_SLOCKED(vp, str)
  513 #endif
  514 #define ASSERT_VOP_UNLOCKED(vp, str)
  515 #endif /* DEBUG_VFS_LOCKS */
  516 
  517 
  518 /*
  519  * This call works for vnodes in the kernel.
  520  */
  521 #define VCALL(c) ((c)->a_desc->vdesc_call(c))
  522 
  523 /*
  524  * VMIO support inline
  525  */
  526 
  527 extern int vmiodirenable;
  528 
  529 static __inline int
  530 vn_canvmio(struct vnode *vp)
  531 {
  532       if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
  533                 return(TRUE);
  534         return(FALSE);
  535 }
  536 
  537 /*
  538  * Finally, include the default set of vnode operations.
  539  */
  540 #include "vnode_if.h"
  541 
  542 /*
  543  * Public vnode manipulation functions.
  544  */
  545 struct componentname;
  546 struct file;
  547 struct mount;
  548 struct nameidata;
  549 struct ostat;
  550 struct thread;
  551 struct proc;
  552 struct stat;
  553 struct nstat;
  554 struct ucred;
  555 struct uio;
  556 struct vattr;
  557 struct vnode;
  558 
  559 extern int      (*lease_check_hook)(struct vop_lease_args *);
  560 
  561 /* cache_* may belong in namei.h. */
  562 void    cache_enter(struct vnode *dvp, struct vnode *vp,
  563             struct componentname *cnp);
  564 int     cache_lookup(struct vnode *dvp, struct vnode **vpp,
  565             struct componentname *cnp);
  566 void    cache_purge(struct vnode *vp);
  567 void    cache_purgevfs(struct mount *mp);
  568 int     change_dir(struct vnode *vp, struct thread *td);
  569 int     change_root(struct vnode *vp, struct thread *td);
  570 void    cvtstat(struct stat *st, struct ostat *ost);
  571 void    cvtnstat(struct stat *sb, struct nstat *nsb);
  572 int     getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
  573             struct vnode **vpp);
  574 int     insmntque1(struct vnode *vp, struct mount *mp,
  575             void (*dtr)(struct vnode *, void *), void *dtr_arg);
  576 int     insmntque(struct vnode *vp, struct mount *mp);
  577 u_quad_t init_va_filerev(void);
  578 int     lease_check(struct vop_lease_args *ap);
  579 int     speedup_syncer(void);
  580 #define textvp_fullpath(p, rb, rfb) \
  581         vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
  582 int     vn_fullpath(struct thread *td, struct vnode *vn,
  583             char **retbuf, char **freebuf);
  584 int     vn_fullpath_global(struct thread *td, struct vnode *vn,
  585             char **retbuf, char **freebuf);
  586 int     vaccess(enum vtype type, mode_t file_mode, uid_t file_uid,
  587             gid_t file_gid, mode_t acc_mode, struct ucred *cred,
  588             int *privused);
  589 int     vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
  590             gid_t file_gid, struct acl *acl, mode_t acc_mode,
  591             struct ucred *cred, int *privused);
  592 void    vattr_null(struct vattr *vap);
  593 int     vcount(struct vnode *vp);
  594 void    vdrop(struct vnode *);
  595 void    vdropl(struct vnode *);
  596 void    vfs_add_vnodeops(const void *);
  597 void    vfs_rm_vnodeops(const void *);
  598 int     vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
  599 int     vget(struct vnode *vp, int lockflag, struct thread *td);
  600 void    vgone(struct vnode *vp);
  601 void    vhold(struct vnode *);
  602 void    vholdl(struct vnode *);
  603 int     vinvalbuf(struct vnode *vp, int save,
  604             struct thread *td, int slpflag, int slptimeo);
  605 int     vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
  606             off_t length, int blksize);
  607 void    vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3);
  608 #define vprint(label, vp) vn_printf((vp), "%s\n", (label))
  609 int     vrecycle(struct vnode *vp, struct thread *td);
  610 int     vn_close(struct vnode *vp,
  611             int flags, struct ucred *file_cred, struct thread *td);
  612 void    vn_finished_write(struct mount *mp);
  613 void    vn_finished_secondary_write(struct mount *mp);
  614 int     vn_isdisk(struct vnode *vp, int *errp);
  615 int     _vn_lock(struct vnode *vp, int flags, struct thread *td, char *file, int line);
  616 #define vn_lock(vp, flags, td) _vn_lock(vp, flags, td, __FILE__, __LINE__)
  617 int     vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp);
  618 int     vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
  619             struct ucred *cred, struct file *fp);
  620 int     vn_pollrecord(struct vnode *vp, struct thread *p, int events);
  621 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base,
  622             int len, off_t offset, enum uio_seg segflg, int ioflg,
  623             struct ucred *active_cred, struct ucred *file_cred, int *aresid,
  624             struct thread *td);
  625 int     vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base,
  626             size_t len, off_t offset, enum uio_seg segflg, int ioflg,
  627             struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
  628             struct thread *td);
  629 int     vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
  630             struct ucred *file_cred, struct thread *td);
  631 int     vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
  632 int     vn_start_secondary_write(struct vnode *vp, struct mount **mpp,
  633             int flags);
  634 int     vn_writechk(struct vnode *vp);
  635 int     vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
  636             const char *attrname, int *buflen, char *buf, struct thread *td);
  637 int     vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
  638             const char *attrname, int buflen, char *buf, struct thread *td);
  639 int     vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
  640             const char *attrname, struct thread *td);
  641 int     vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags,
  642             struct vnode **rvp);
  643 
  644 int     vfs_cache_lookup(struct vop_lookup_args *ap);
  645 void    vfs_timestamp(struct timespec *);
  646 void    vfs_write_resume(struct mount *mp);
  647 int     vfs_write_suspend(struct mount *mp);
  648 int     vop_stdbmap(struct vop_bmap_args *);
  649 int     vop_stdfsync(struct vop_fsync_args *);
  650 int     vop_stdgetwritemount(struct vop_getwritemount_args *);
  651 int     vop_stdgetpages(struct vop_getpages_args *);
  652 int     vop_stdinactive(struct vop_inactive_args *);
  653 int     vop_stdislocked(struct vop_islocked_args *);
  654 int     vop_stdkqfilter(struct vop_kqfilter_args *);
  655 int     vop_stdlock(struct vop_lock1_args *);
  656 int     vop_stdputpages(struct vop_putpages_args *);
  657 int     vop_stdunlock(struct vop_unlock_args *);
  658 int     vop_nopoll(struct vop_poll_args *);
  659 int     vop_stdadvlock(struct vop_advlock_args *ap);
  660 int     vop_stdadvlockasync(struct vop_advlockasync_args *ap);
  661 int     vop_stdpathconf(struct vop_pathconf_args *);
  662 int     vop_stdpoll(struct vop_poll_args *);
  663 int     vop_stdvptofh(struct vop_vptofh_args *ap);
  664 int     vop_eopnotsupp(struct vop_generic_args *ap);
  665 int     vop_ebadf(struct vop_generic_args *ap);
  666 int     vop_einval(struct vop_generic_args *ap);
  667 int     vop_enotty(struct vop_generic_args *ap);
  668 int     vop_null(struct vop_generic_args *ap);
  669 int     vop_panic(struct vop_generic_args *ap);
  670 
  671 /* These are called from within the actual VOPS. */
  672 void    vop_create_post(void *a, int rc);
  673 void    vop_link_post(void *a, int rc);
  674 void    vop_lock_pre(void *a);
  675 void    vop_lock_post(void *a, int rc);
  676 void    vop_lookup_post(void *a, int rc);
  677 void    vop_lookup_pre(void *a);
  678 void    vop_mkdir_post(void *a, int rc);
  679 void    vop_mknod_post(void *a, int rc);
  680 void    vop_remove_post(void *a, int rc);
  681 void    vop_rename_post(void *a, int rc);
  682 void    vop_rename_pre(void *a);
  683 void    vop_rmdir_post(void *a, int rc);
  684 void    vop_setattr_post(void *a, int rc);
  685 void    vop_strategy_pre(void *a);
  686 void    vop_symlink_post(void *a, int rc);
  687 void    vop_unlock_post(void *a, int rc);
  688 void    vop_unlock_pre(void *a);
  689 
  690 #define VOP_WRITE_PRE(ap)                                               \
  691         struct vattr va;                                                \
  692         int error, osize, ooffset, noffset;                             \
  693                                                                         \
  694         osize = ooffset = noffset = 0;                                  \
  695         if (!VN_KNLIST_EMPTY((ap)->a_vp)) {                             \
  696                 error = VOP_GETATTR((ap)->a_vp, &va, (ap)->a_cred,      \
  697                     curthread);                                         \
  698                 if (error)                                              \
  699                         return (error);                                 \
  700                 ooffset = (ap)->a_uio->uio_offset;                      \
  701                 osize = va.va_size;                                     \
  702         }
  703 
  704 #define VOP_WRITE_POST(ap, ret)                                         \
  705         noffset = (ap)->a_uio->uio_offset;                              \
  706         if (noffset > ooffset && !VN_KNLIST_EMPTY((ap)->a_vp)) {        \
  707                 VFS_KNOTE_LOCKED((ap)->a_vp, NOTE_WRITE                 \
  708                     | (noffset > osize ? NOTE_EXTEND : 0));             \
  709         }
  710 
  711 #define VOP_LOCK(vp, flags, td) VOP_LOCK1(vp, flags, td, __FILE__, __LINE__)
  712 
  713 
  714 void    vput(struct vnode *vp);
  715 void    vrele(struct vnode *vp);
  716 void    vref(struct vnode *vp);
  717 int     vrefcnt(struct vnode *vp);
  718 void    v_addpollinfo(struct vnode *vp);
  719 
  720 int vnode_create_vobject(struct vnode *vp, off_t size, struct thread *td);
  721 void vnode_destroy_vobject(struct vnode *vp);
  722 
  723 extern struct vop_vector fifo_specops;
  724 extern struct vop_vector dead_vnodeops;
  725 extern struct vop_vector default_vnodeops;
  726 
  727 #define VOP_PANIC       ((void*)(uintptr_t)vop_panic)
  728 #define VOP_NULL        ((void*)(uintptr_t)vop_null)
  729 #define VOP_EBADF       ((void*)(uintptr_t)vop_ebadf)
  730 #define VOP_ENOTTY      ((void*)(uintptr_t)vop_enotty)
  731 #define VOP_EINVAL      ((void*)(uintptr_t)vop_einval)
  732 #define VOP_EOPNOTSUPP  ((void*)(uintptr_t)vop_eopnotsupp)
  733 
  734 /* vfs_hash.c */
  735 typedef int vfs_hash_cmp_t(struct vnode *vp, void *arg);
  736 
  737 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);
  738 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);
  739 void vfs_hash_rehash(struct vnode *vp, u_int hash);
  740 void vfs_hash_remove(struct vnode *vp);
  741 
  742 int vfs_kqfilter(struct vop_kqfilter_args *);
  743 void vfs_mark_atime(struct vnode *vp, struct thread *td);
  744 struct dirent;
  745 int vfs_read_dirent(struct vop_readdir_args *ap, struct dirent *dp, off_t off);
  746 
  747 #endif /* _KERNEL */
  748 
  749 #endif /* !_SYS_VNODE_H_ */

Cache object: 1dcf2d5dd69fc49053f7ba36e3bd364d


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.