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  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
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: src/sys/sys/vnode.h,v 1.243.2.3 2005/03/01 11:32:32 phk Exp $
   31  */
   32 
   33 #ifndef _SYS_VNODE_H_
   34 #define _SYS_VNODE_H_
   35 
   36 /*
   37  * XXX - compatability until lockmgr() goes away or all the #includes are
   38  * updated.
   39  */
   40 #include <sys/lockmgr.h>
   41 
   42 #include <sys/queue.h>
   43 #include <sys/_lock.h>
   44 #include <sys/lock.h>
   45 #include <sys/_mutex.h>
   46 #include <sys/mutex.h>
   47 #include <sys/selinfo.h>
   48 #include <sys/uio.h>
   49 #include <sys/acl.h>
   50 #include <sys/ktr.h>
   51 
   52 /*
   53  * The vnode is the focus of all file activity in UNIX.  There is a
   54  * unique vnode allocated for each active file, each current directory,
   55  * each mounted-on file, text file, and the root.
   56  */
   57 
   58 /*
   59  * Vnode types.  VNON means no type.
   60  */
   61 enum vtype      { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD };
   62 
   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 TAILQ_HEAD(buflists, buf);
   68 
   69 typedef int     vop_t(void *);
   70 struct namecache;
   71 
   72 struct vpollinfo {
   73         struct  mtx vpi_lock;           /* lock to protect below */
   74         struct  selinfo vpi_selinfo;    /* identity of poller(s) */
   75         short   vpi_events;             /* what they are looking for */
   76         short   vpi_revents;            /* what has happened */
   77 };
   78 
   79 /*
   80  * Reading or writing any of these items requires holding the appropriate lock.
   81  *
   82  * Lock reference:
   83  *      c - namecache mutex
   84  *      f - freelist mutex
   85  *      G - Giant
   86  *      i - interlock
   87  *      m - mntvnodes mutex
   88  *      p - pollinfo lock
   89  *      s - spechash mutex
   90  *      S - syncer mutex
   91  *      u - Only a reference to the vnode is needed to read.
   92  *      v - vnode lock
   93  *
   94  * Vnodes may be found on many lists.  The general way to deal with operating
   95  * on a vnode that is on a list is:
   96  *      1) Lock the list and find the vnode.
   97  *      2) Lock interlock so that the vnode does not go away.
   98  *      3) Unlock the list to avoid lock order reversals.
   99  *      4) vget with LK_INTERLOCK and check for ENOENT, or
  100  *      5) Check for XLOCK if the vnode lock is not required.
  101  *      6) Perform your operation, then vput().
  102  *
  103  * XXX Not all fields are locked yet and some fields that are marked are not
  104  * locked consistently.  This is a work in progress.  Requires Giant!
  105  */
  106 
  107 struct vnode {
  108         struct  mtx v_interlock;                /* lock for "i" things */
  109         u_long  v_iflag;                        /* i vnode flags (see below) */
  110         int     v_usecount;                     /* i ref count of users */
  111         long    v_numoutput;                    /* i writes in progress */
  112         struct thread *v_vxthread;              /* i thread owning VXLOCK */
  113         int     v_holdcnt;                      /* i page & buffer references */
  114         struct  buflists v_cleanblkhd;          /* i SORTED clean blocklist */
  115         struct buf      *v_cleanblkroot;        /* i clean buf splay tree  */
  116         int     v_cleanbufcnt;                  /* i number of clean buffers */
  117         struct  buflists v_dirtyblkhd;          /* i SORTED dirty blocklist */
  118         struct buf      *v_dirtyblkroot;        /* i dirty buf splay tree */
  119         int     v_dirtybufcnt;                  /* i number of dirty buffers */
  120         u_long  v_vflag;                        /* v vnode flags */
  121         int     v_writecount;                   /* v ref count of writers */
  122         struct vm_object *v_object;             /* v Place to store VM object */
  123         daddr_t v_lastw;                        /* v last write (write cluster) */
  124         daddr_t v_cstart;                       /* v start block of cluster */
  125         daddr_t v_lasta;                        /* v last allocation (cluster) */
  126         int     v_clen;                         /* v length of current cluster */
  127         union {
  128                 struct mount    *vu_mountedhere;/* v ptr to mounted vfs (VDIR) */
  129                 struct socket   *vu_socket;     /* v unix ipc (VSOCK) */
  130                 struct {
  131                         struct cdev     *vu_cdev; /* v device (VCHR, VBLK) */
  132                         SLIST_ENTRY(vnode) vu_specnext; /* s device aliases */
  133                 } vu_spec;
  134                 struct fifoinfo *vu_fifoinfo;   /* v fifo (VFIFO) */
  135         } v_un;
  136         TAILQ_ENTRY(vnode) v_freelist;          /* f vnode freelist */
  137         TAILQ_ENTRY(vnode) v_nmntvnodes;        /* m vnodes for mount point */
  138         LIST_ENTRY(vnode) v_synclist;           /* S dirty vnode list */
  139         enum    vtype v_type;                   /* u vnode type */
  140         const char *v_tag;                      /* u type of underlying data */
  141         void    *v_data;                        /* u private data for fs */
  142         struct  lock v_lock;                    /* u used if fs don't have one */
  143         struct  lock *v_vnlock;                 /* u pointer to vnode lock */
  144         vop_t   **v_op;                         /* u vnode operations vector */
  145         struct  mount *v_mount;                 /* u ptr to vfs we are in */
  146         LIST_HEAD(, namecache) v_cache_src;     /* c Cache entries from us */
  147         TAILQ_HEAD(, namecache) v_cache_dst;    /* c Cache entries to us */
  148         u_long  v_id;                           /* c capability identifier */
  149         struct  vnode *v_dd;                    /* c .. vnode */
  150         u_long  v_ddid;                         /* c .. capability identifier */
  151         struct vpollinfo *v_pollinfo;           /* G Poll events, p for *v_pi */
  152         struct label *v_label;                  /* MAC label for vnode */
  153 #ifdef  DEBUG_LOCKS
  154         const char *filename;                   /* Source file doing locking */
  155         int line;                               /* Line number doing locking */
  156 #endif
  157         dev_t   v_cachedfs;                     /* cached fs id */
  158         ino_t   v_cachedid;                     /* cached file id */
  159         int     v_bsize;                        /* block size for I/O */
  160 };
  161 #define v_mountedhere   v_un.vu_mountedhere
  162 #define v_socket        v_un.vu_socket
  163 #define v_rdev          v_un.vu_spec.vu_cdev
  164 #define v_specnext      v_un.vu_spec.vu_specnext
  165 #define v_fifoinfo      v_un.vu_fifoinfo
  166 
  167 /*
  168  * Userland version of struct vnode, for sysctl.
  169  */
  170 struct xvnode {
  171         size_t  xv_size;                        /* sizeof(struct xvnode) */
  172         void    *xv_vnode;                      /* address of real vnode */
  173         u_long  xv_flag;                        /* vnode vflags */
  174         int     xv_usecount;                    /* reference count of users */
  175         int     xv_writecount;                  /* reference count of writers */
  176         int     xv_holdcnt;                     /* page & buffer references */
  177         u_long  xv_id;                          /* capability identifier */
  178         void    *xv_mount;                      /* address of parent mount */
  179         long    xv_numoutput;                   /* num of writes in progress */
  180         enum    vtype xv_type;                  /* vnode type */
  181         union {
  182                 void    *xvu_socket;            /* socket, if VSOCK */
  183                 void    *xvu_fifo;              /* fifo, if VFIFO */
  184                 dev_t   xvu_rdev;               /* maj/min, if VBLK/VCHR */
  185                 struct {
  186                         dev_t   xvu_dev;        /* device, if VDIR/VREG/VLNK */
  187                         ino_t   xvu_ino;        /* id, if VDIR/VREG/VLNK */
  188                 } xv_uns;
  189         } xv_un;
  190 };
  191 #define xv_socket       xv_un.xvu_socket
  192 #define xv_fifo         xv_un.xvu_fifo
  193 #define xv_rdev         xv_un.xvu_rdev
  194 #define xv_dev          xv_un.xv_uns.xvu_dev
  195 #define xv_ino          xv_un.xv_uns.xvu_ino
  196 
  197 #define VN_POLLEVENT(vp, events)                                \
  198         do {                                                    \
  199                 if ((vp)->v_pollinfo != NULL &&                 \
  200                     (vp)->v_pollinfo->vpi_events & (events))    \
  201                         vn_pollevent((vp), (events));           \
  202         } while (0)
  203 
  204 #define VN_KNOTE(vp, b, a)                                              \
  205         do {                                                    \
  206                 if ((vp)->v_pollinfo != NULL)                   \
  207                         KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), (a)); \
  208         } while (0)
  209 #define VN_KNOTE_LOCKED(vp, b)          VN_KNOTE(vp, b, 1)
  210 #define VN_KNOTE_UNLOCKED(vp, b)        VN_KNOTE(vp, b, 0)
  211 
  212 /*
  213  * Vnode flags.
  214  *      VI flags are protected by interlock and live in v_iflag
  215  *      VV flags are protected by the vnode lock and live in v_vflag
  216  */
  217 #define VI_XLOCK        0x0001  /* vnode is locked to change vtype */
  218 #define VI_XWANT        0x0002  /* thread is waiting for vnode */
  219 #define VI_BWAIT        0x0004  /* waiting for output to complete */
  220 #define VI_OLOCK        0x0008  /* vnode is locked waiting for an object */
  221 #define VI_OWANT        0x0010  /* a thread is waiting for VOLOCK */
  222 #define VI_MOUNT        0x0020  /* Mount in progress */
  223 #define VI_AGE          0x0040  /* Insert vnode at head of free list */
  224 #define VI_DOOMED       0x0080  /* This vnode is being recycled */
  225 #define VI_FREE         0x0100  /* This vnode is on the freelist */
  226 #define VI_OBJDIRTY     0x0400  /* object might be dirty */
  227 #define VI_DOINGINACT   0x0800  /* VOP_INACTIVE is in progress */
  228 /*
  229  * XXX VI_ONWORKLST could be replaced with a check for NULL list elements
  230  * in v_synclist.
  231  */
  232 #define VI_ONWORKLST    0x0200  /* On syncer work-list */
  233 
  234 #define VV_ROOT         0x0001  /* root of its filesystem */
  235 #define VV_ISTTY        0x0002  /* vnode represents a tty */
  236 #define VV_NOSYNC       0x0004  /* unlinked, stop syncing */
  237 #define VV_OBJBUF       0x0008  /* Allocate buffers in VM object */
  238 #define VV_CACHEDLABEL  0x0010  /* Vnode has valid cached MAC label */
  239 #define VV_TEXT         0x0020  /* vnode is a pure text prototype */
  240 #define VV_COPYONWRITE  0x0040  /* vnode is doing copy-on-write */
  241 #define VV_SYSTEM       0x0080  /* vnode being used by kernel */
  242 #define VV_PROCDEP      0x0100  /* vnode is process dependent */
  243 
  244 /*
  245  * Vnode attributes.  A field value of VNOVAL represents a field whose value
  246  * is unavailable (getattr) or which is not to be changed (setattr).
  247  */
  248 struct vattr {
  249         enum vtype      va_type;        /* vnode type (for create) */
  250         u_short         va_mode;        /* files access mode and type */
  251         short           va_nlink;       /* number of references to file */
  252         uid_t           va_uid;         /* owner user id */
  253         gid_t           va_gid;         /* owner group id */
  254         dev_t           va_fsid;        /* filesystem id */
  255         long            va_fileid;      /* file id */
  256         u_quad_t        va_size;        /* file size in bytes */
  257         long            va_blocksize;   /* blocksize preferred for i/o */
  258         struct timespec va_atime;       /* time of last access */
  259         struct timespec va_mtime;       /* time of last modification */
  260         struct timespec va_ctime;       /* time file changed */
  261         struct timespec va_birthtime;   /* time file created */
  262         u_long          va_gen;         /* generation number of file */
  263         u_long          va_flags;       /* flags defined for file */
  264         dev_t           va_rdev;        /* device the special file represents */
  265         u_quad_t        va_bytes;       /* bytes of disk space held by file */
  266         u_quad_t        va_filerev;     /* file modification number */
  267         u_int           va_vaflags;     /* operations flags, see below */
  268         long            va_spare;       /* remain quad aligned */
  269 };
  270 
  271 /*
  272  * Flags for va_vaflags.
  273  */
  274 #define VA_UTIMES_NULL  0x01            /* utimes argument was NULL */
  275 #define VA_EXCLUSIVE    0x02            /* exclusive create request */
  276 
  277 /*
  278  * Flags for ioflag. (high 16 bits used to ask for read-ahead and
  279  * help with write clustering)
  280  */
  281 #define IO_UNIT         0x0001          /* do I/O as atomic unit */
  282 #define IO_APPEND       0x0002          /* append write to end */
  283 #define IO_SYNC         0x0004          /* do I/O synchronously */
  284 #define IO_NODELOCKED   0x0008          /* underlying node already locked */
  285 #define IO_NDELAY       0x0010          /* FNDELAY flag set in file table */
  286 #define IO_VMIO         0x0020          /* data already in VMIO space */
  287 #define IO_INVAL        0x0040          /* invalidate after I/O */
  288 #define IO_ASYNC        0x0080          /* bawrite rather then bdwrite */
  289 #define IO_DIRECT       0x0100          /* attempt to bypass buffer cache */
  290 #define IO_EXT          0x0400          /* operate on external attributes */
  291 #define IO_NORMAL       0x0800          /* operate on regular data */
  292 #define IO_NOMACCHECK   0x1000          /* MAC checks unnecessary */
  293 
  294 #define IO_SEQMAX       0x7F            /* seq heuristic max value */
  295 #define IO_SEQSHIFT     16              /* seq heuristic in upper 16 bits */
  296 
  297 /*
  298  *  Modes.  Some values same as Ixxx entries from inode.h for now.
  299  */
  300 #define VEXEC   000100          /* execute/search permission */
  301 #define VWRITE  000200          /* write permission */
  302 #define VREAD   000400          /* read permission */
  303 #define VSVTX   001000          /* save swapped text even after use */
  304 #define VSGID   002000          /* set group id on execution */
  305 #define VSUID   004000          /* set user id on execution */
  306 #define VADMIN  010000          /* permission to administer */
  307 #define VSTAT   020000          /* permission to retrieve attrs */
  308 #define VAPPEND 040000          /* permission to write/append */
  309 #define VALLPERM        (VEXEC | VWRITE | VREAD | VADMIN | VSTAT | VAPPEND)
  310 
  311 /*
  312  * Token indicating no attribute value yet assigned.
  313  */
  314 #define VNOVAL  (-1)
  315 
  316 /*
  317  * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
  318  */
  319 #define VLKTIMEOUT      (hz / 20 + 1)
  320 
  321 #ifdef _KERNEL
  322 
  323 #ifdef MALLOC_DECLARE
  324 MALLOC_DECLARE(M_VNODE);
  325 #endif
  326 
  327 /*
  328  * Convert between vnode types and inode formats (since POSIX.1
  329  * defines mode word of stat structure in terms of inode formats).
  330  */
  331 extern enum vtype       iftovt_tab[];
  332 extern int              vttoif_tab[];
  333 #define IFTOVT(mode)    (iftovt_tab[((mode) & S_IFMT) >> 12])
  334 #define VTTOIF(indx)    (vttoif_tab[(int)(indx)])
  335 #define MAKEIMODE(indx, mode)   (int)(VTTOIF(indx) | (mode))
  336 
  337 /*
  338  * Flags to various vnode functions.
  339  */
  340 #define SKIPSYSTEM      0x0001  /* vflush: skip vnodes marked VSYSTEM */
  341 #define FORCECLOSE      0x0002  /* vflush: force file closure */
  342 #define WRITECLOSE      0x0004  /* vflush: only close writable files */
  343 #define DOCLOSE         0x0008  /* vclean: close active files */
  344 #define V_SAVE          0x0001  /* vinvalbuf: sync file first */
  345 #define V_ALT           0x0002  /* vinvalbuf: invalidate only alternate bufs */
  346 #define V_NORMAL        0x0004  /* vinvalbuf: invalidate only regular bufs */
  347 #define REVOKEALL       0x0001  /* vop_revoke: revoke all aliases */
  348 #define V_WAIT          0x0001  /* vn_start_write: sleep for suspend */
  349 #define V_NOWAIT        0x0002  /* vn_start_write: don't sleep for suspend */
  350 #define V_XSLEEP        0x0004  /* vn_start_write: just return after sleep */
  351 
  352 #define VREF(vp)        vref(vp)
  353 
  354 #ifdef DIAGNOSTIC
  355 #define VATTR_NULL(vap) vattr_null(vap)
  356 #else
  357 #define VATTR_NULL(vap) (*(vap) = va_null)      /* initialize a vattr */
  358 #endif /* DIAGNOSTIC */
  359 
  360 #define NULLVP  ((struct vnode *)NULL)
  361 
  362 #define VNODEOP_SET(f) \
  363         C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \
  364         C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f);
  365 
  366 /*
  367  * Global vnode data.
  368  */
  369 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
  370 extern  int async_io_version;           /* 0 or POSIX version of AIO i'face */
  371 extern  int desiredvnodes;              /* number of vnodes desired */
  372 extern  struct uma_zone *namei_zone;
  373 extern  int prtactive;                  /* nonzero to call vprint() */
  374 extern  struct vattr va_null;           /* predefined null vattr structure */
  375 
  376 /*
  377  * Macro/function to check for client cache inconsistency w.r.t. leasing.
  378  */
  379 #define LEASE_READ      0x1             /* Check lease for readers */
  380 #define LEASE_WRITE     0x2             /* Check lease for modifiers */
  381 
  382 extern void     (*lease_updatetime)(int deltat);
  383 
  384 /* Requires interlock. */
  385 #define VSHOULDFREE(vp) \
  386         (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_DOINGINACT)) && \
  387          !(vp)->v_holdcnt && !(vp)->v_usecount && \
  388          (!(vp)->v_object || \
  389           !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count)))
  390 
  391 /* Requires interlock. */
  392 #define VMIGHTFREE(vp) \
  393         (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_XLOCK|VI_DOINGINACT)) && \
  394          LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount)
  395 
  396 /* Requires interlock. */
  397 #define VSHOULDBUSY(vp) \
  398         (((vp)->v_iflag & VI_FREE) && \
  399          ((vp)->v_holdcnt || (vp)->v_usecount))
  400 
  401 #define VI_LOCK(vp)     mtx_lock(&(vp)->v_interlock)
  402 #define VI_TRYLOCK(vp)  mtx_trylock(&(vp)->v_interlock)
  403 #define VI_UNLOCK(vp)   mtx_unlock(&(vp)->v_interlock)
  404 #define VI_MTX(vp)      (&(vp)->v_interlock)
  405 
  406 #endif /* _KERNEL */
  407 
  408 /*
  409  * Mods for extensibility.
  410  */
  411 
  412 /*
  413  * Flags for vdesc_flags:
  414  */
  415 #define VDESC_MAX_VPS           16
  416 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
  417 #define VDESC_VP0_WILLRELE      0x0001
  418 #define VDESC_VP1_WILLRELE      0x0002
  419 #define VDESC_VP2_WILLRELE      0x0004
  420 #define VDESC_VP3_WILLRELE      0x0008
  421 #define VDESC_NOMAP_VPP         0x0100
  422 #define VDESC_VPP_WILLRELE      0x0200
  423 
  424 /*
  425  * VDESC_NO_OFFSET is used to identify the end of the offset list
  426  * and in places where no such field exists.
  427  */
  428 #define VDESC_NO_OFFSET -1
  429 
  430 /*
  431  * This structure describes the vnode operation taking place.
  432  */
  433 struct vnodeop_desc {
  434         int      vdesc_offset;          /* offset in vector,first for speed */
  435         char    *vdesc_name;            /* a readable name for debugging */
  436         int      vdesc_flags;           /* VDESC_* flags */
  437 
  438         /*
  439          * These ops are used by bypass routines to map and locate arguments.
  440          * Creds and procs are not needed in bypass routines, but sometimes
  441          * they are useful to (for example) transport layers.
  442          * Nameidata is useful because it has a cred in it.
  443          */
  444         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
  445         int     vdesc_vpp_offset;       /* return vpp location */
  446         int     vdesc_cred_offset;      /* cred location, if any */
  447         int     vdesc_thread_offset;    /* thread location, if any */
  448         int     vdesc_componentname_offset; /* if any */
  449         /*
  450          * Finally, we've got a list of private data (about each operation)
  451          * for each transport layer.  (Support to manage this list is not
  452          * yet part of BSD.)
  453          */
  454         caddr_t *vdesc_transports;
  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  * This structure is used to configure the new vnodeops vector.
  469  */
  470 struct vnodeopv_entry_desc {
  471         struct vnodeop_desc *opve_op;   /* which operation this is */
  472         vop_t *opve_impl;               /* code implementing this operation */
  473 };
  474 struct vnodeopv_desc {
  475                         /* ptr to the ptr to the vector where op should go */
  476         vop_t ***opv_desc_vector_p;
  477         struct vnodeopv_entry_desc *opv_desc_ops;   /* null terminated list */
  478 };
  479 
  480 /*
  481  * A generic structure.
  482  * This can be used by bypass routines to identify generic arguments.
  483  */
  484 struct vop_generic_args {
  485         struct vnodeop_desc *a_desc;
  486         /* other random data follows, presumably */
  487 };
  488 
  489 #ifdef DEBUG_VFS_LOCKS
  490 /*
  491  * Support code to aid in debugging VFS locking problems.  Not totally
  492  * reliable since if the thread sleeps between changing the lock
  493  * state and checking it with the assert, some other thread could
  494  * change the state.  They are good enough for debugging a single
  495  * filesystem using a single-threaded test.
  496  */
  497 void    assert_vi_locked(struct vnode *vp, const char *str);
  498 void    assert_vi_unlocked(struct vnode *vp, const char *str);
  499 #if 0
  500 void    assert_vop_elocked(struct vnode *vp, const char *str);
  501 void    assert_vop_elocked_other(struct vnode *vp, const char *str);
  502 #endif
  503 void    assert_vop_locked(struct vnode *vp, const char *str);
  504 #if 0
  505 voi0    assert_vop_slocked(struct vnode *vp, const char *str);
  506 #endif
  507 void    assert_vop_unlocked(struct vnode *vp, const char *str);
  508 
  509 /* These are called from within the actual VOPS. */
  510 void    vop_lock_pre(void *a);
  511 void    vop_lock_post(void *a, int rc);
  512 void    vop_lookup_post(void *a, int rc);
  513 void    vop_lookup_pre(void *a);
  514 void    vop_rename_pre(void *a);
  515 void    vop_strategy_pre(void *a);
  516 void    vop_unlock_post(void *a, int rc);
  517 void    vop_unlock_pre(void *a);
  518 
  519 #define ASSERT_VI_LOCKED(vp, str)       assert_vi_locked((vp), (str))
  520 #define ASSERT_VI_UNLOCKED(vp, str)     assert_vi_unlocked((vp), (str))
  521 #if 0
  522 #define ASSERT_VOP_ELOCKED(vp, str)     assert_vop_elocked((vp), (str))
  523 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
  524 #endif
  525 #define ASSERT_VOP_LOCKED(vp, str)      assert_vop_locked((vp), (str))
  526 #if 0
  527 #define ASSERT_VOP_SLOCKED(vp, str)     assert_vop_slocked((vp), (str))
  528 #endif
  529 #define ASSERT_VOP_UNLOCKED(vp, str)    assert_vop_unlocked((vp), (str))
  530 
  531 #else /* !DEBUG_VFS_LOCKS */
  532 
  533 #define ASSERT_VI_LOCKED(vp, str)
  534 #define ASSERT_VI_UNLOCKED(vp, str)
  535 #if 0
  536 #define ASSERT_VOP_ELOCKED(vp, str)
  537 #define ASSERT_VOP_ELOCKED_OTHER(vp, str)
  538 #endif
  539 #define ASSERT_VOP_LOCKED(vp, str)
  540 #if 0
  541 #define ASSERT_VOP_SLOCKED(vp, str)
  542 #endif
  543 #define ASSERT_VOP_UNLOCKED(vp, str)
  544 #endif /* DEBUG_VFS_LOCKS */
  545 
  546 /*
  547  * VOCALL calls an op given an ops vector.  We break it out because BSD's
  548  * vclean changes the ops vector and then wants to call ops with the old
  549  * vector.
  550  */
  551 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
  552 
  553 /*
  554  * This call works for vnodes in the kernel.
  555  */
  556 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
  557 #define VDESC(OP) (& __CONCAT(OP,_desc))
  558 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
  559 
  560 /*
  561  * VMIO support inline
  562  */
  563 
  564 extern int vmiodirenable;
  565 
  566 static __inline int
  567 vn_canvmio(struct vnode *vp)
  568 {
  569       if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
  570                 return(TRUE);
  571         return(FALSE);
  572 }
  573 
  574 /*
  575  * Finally, include the default set of vnode operations.
  576  */
  577 #include "vnode_if.h"
  578 
  579 /*
  580  * Public vnode manipulation functions.
  581  */
  582 struct componentname;
  583 struct file;
  584 struct mount;
  585 struct nameidata;
  586 struct ostat;
  587 struct thread;
  588 struct proc;
  589 struct stat;
  590 struct nstat;
  591 struct ucred;
  592 struct uio;
  593 struct vattr;
  594 struct vnode;
  595 
  596 extern int      (*lease_check_hook)(struct vop_lease_args *);
  597 extern int      (*softdep_fsync_hook)(struct vnode *);
  598 extern int      (*softdep_process_worklist_hook)(struct mount *);
  599 
  600 struct  vnode *addaliasu(struct vnode *vp, dev_t nvp_rdev);
  601 int     bdevvp(struct cdev *dev, struct vnode **vpp);
  602 /* cache_* may belong in namei.h. */
  603 void    cache_enter(struct vnode *dvp, struct vnode *vp,
  604             struct componentname *cnp);
  605 int     cache_lookup(struct vnode *dvp, struct vnode **vpp,
  606             struct componentname *cnp);
  607 void    cache_purge(struct vnode *vp);
  608 void    cache_purgevfs(struct mount *mp);
  609 int     cache_leaf_test(struct vnode *vp);
  610 int     change_dir(struct vnode *vp, struct thread *td);
  611 int     change_root(struct vnode *vp, struct thread *td);
  612 void    cvtstat(struct stat *st, struct ostat *ost);
  613 void    cvtnstat(struct stat *sb, struct nstat *nsb);
  614 int     getnewvnode(const char *tag, struct mount *mp, vop_t **vops,
  615             struct vnode **vpp);
  616 int     lease_check(struct vop_lease_args *ap);
  617 int     spec_vnoperate(struct vop_generic_args *);
  618 int     speedup_syncer(void);
  619 #define textvp_fullpath(p, rb, rfb) \
  620         vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
  621 int     vn_fullpath(struct thread *td, struct vnode *vn,
  622             char **retbuf, char **freebuf);
  623 int     vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
  624             mode_t acc_mode, struct ucred *cred, int *privused);
  625 int     vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
  626             gid_t file_gid, struct acl *acl, mode_t acc_mode,
  627             struct ucred *cred, int *privused);
  628 void    vattr_null(struct vattr *vap);
  629 int     vcount(struct vnode *vp);
  630 void    vdrop(struct vnode *);
  631 void    vdropl(struct vnode *);
  632 int     vfinddev(struct cdev *dev, struct vnode **vpp);
  633 void    vfs_add_vnodeops(const void *);
  634 void    vfs_rm_vnodeops(const void *);
  635 int     vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
  636 int     vget(struct vnode *vp, int lockflag, struct thread *td);
  637 void    vgone(struct vnode *vp);
  638 void    vgonel(struct vnode *vp, struct thread *td);
  639 void    vhold(struct vnode *);
  640 void    vholdl(struct vnode *);
  641 int     vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
  642             struct thread *td, int slpflag, int slptimeo);
  643 int     vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
  644             off_t length, int blksize);
  645 void    vprint(char *label, struct vnode *vp);
  646 int     vrecycle(struct vnode *vp, void *dummyarg, struct thread *td);
  647 int     vn_close(struct vnode *vp,
  648             int flags, struct ucred *file_cred, struct thread *td);
  649 void    vn_finished_write(struct mount *mp);
  650 int     vn_isdisk(struct vnode *vp, int *errp);
  651 int     vn_lock(struct vnode *vp, int flags, struct thread *td);
  652 #ifdef  DEBUG_LOCKS
  653 int     debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
  654             const char *filename, int line);
  655 #define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
  656 #endif
  657 int     vn_open(struct nameidata *ndp, int *flagp, int cmode, int fdidx);
  658 int     vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
  659             struct ucred *cred, int fdidx);
  660 void    vn_pollevent(struct vnode *vp, int events);
  661 void    vn_pollgone(struct vnode *vp);
  662 int     vn_pollrecord(struct vnode *vp, struct thread *p, int events);
  663 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
  664             int len, off_t offset, enum uio_seg segflg, int ioflg,
  665             struct ucred *active_cred, struct ucred *file_cred, int *aresid,
  666             struct thread *td);
  667 int     vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
  668             size_t len, off_t offset, enum uio_seg segflg, int ioflg,
  669             struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
  670             struct thread *td);
  671 int     vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
  672             struct ucred *file_cred, struct thread *td);
  673 int     vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
  674 struct cdev *vn_todev(struct vnode *vp);
  675 int     vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
  676             int flags);
  677 int     vn_writechk(struct vnode *vp);
  678 int     vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
  679             const char *attrname, int *buflen, char *buf, struct thread *td);
  680 int     vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
  681             const char *attrname, int buflen, char *buf, struct thread *td);
  682 int     vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
  683             const char *attrname, struct thread *td);
  684 int     vfs_cache_lookup(struct vop_lookup_args *ap);
  685 int     vfs_object_create(struct vnode *vp, struct thread *td,
  686             struct ucred *cred);
  687 void    vfs_timestamp(struct timespec *);
  688 void    vfs_write_resume(struct mount *mp);
  689 int     vfs_write_suspend(struct mount *mp);
  690 int     vop_stdbmap(struct vop_bmap_args *);
  691 int     vop_stdfsync(struct vop_fsync_args *);
  692 int     vop_stdgetwritemount(struct vop_getwritemount_args *);
  693 int     vop_stdgetpages(struct vop_getpages_args *);
  694 int     vop_stdinactive(struct vop_inactive_args *);
  695 int     vop_stdislocked(struct vop_islocked_args *);
  696 int     vop_stdlock(struct vop_lock_args *);
  697 int     vop_stdputpages(struct vop_putpages_args *);
  698 int     vop_stdunlock(struct vop_unlock_args *);
  699 int     vop_nopoll(struct vop_poll_args *);
  700 int     vop_stdpathconf(struct vop_pathconf_args *);
  701 int     vop_stdpoll(struct vop_poll_args *);
  702 int     vop_revoke(struct vop_revoke_args *);
  703 int     vop_eopnotsupp(struct vop_generic_args *ap);
  704 int     vop_ebadf(struct vop_generic_args *ap);
  705 int     vop_einval(struct vop_generic_args *ap);
  706 int     vop_enotty(struct vop_generic_args *ap);
  707 int     vop_defaultop(struct vop_generic_args *ap);
  708 int     vop_null(struct vop_generic_args *ap);
  709 int     vop_panic(struct vop_generic_args *ap);
  710 int     vop_stdcreatevobject(struct vop_createvobject_args *ap);
  711 int     vop_stddestroyvobject(struct vop_destroyvobject_args *ap);
  712 int     vop_stdgetvobject(struct vop_getvobject_args *ap);
  713 
  714 void    vfree(struct vnode *);
  715 void    vput(struct vnode *vp);
  716 void    vrele(struct vnode *vp);
  717 void    vref(struct vnode *vp);
  718 int     vrefcnt(struct vnode *vp);
  719 void    vbusy(struct vnode *vp);
  720 void    v_addpollinfo(struct vnode *vp);
  721 
  722 extern  vop_t **default_vnodeop_p;
  723 extern  vop_t **spec_vnodeop_p;
  724 extern  vop_t **dead_vnodeop_p;
  725 
  726 #endif /* _KERNEL */
  727 
  728 #endif /* !_SYS_VNODE_H_ */

Cache object: b97327c83e59896fc1b18913e8ecc184


[ 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.