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  * 3. All advertising materials mentioning features or use of this software
   14  *    must display the following acknowledgement:
   15  *      This product includes software developed by the University of
   16  *      California, Berkeley and its contributors.
   17  * 4. Neither the name of the University nor the names of its contributors
   18  *    may be used to endorse or promote products derived from this software
   19  *    without specific prior written permission.
   20  *
   21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   31  * SUCH DAMAGE.
   32  *
   33  *      @(#)vnode.h     8.7 (Berkeley) 2/4/94
   34  * $FreeBSD: src/sys/sys/vnode.h,v 1.230 2003/11/12 03:14:31 rwatson Exp $
   35  */
   36 
   37 #ifndef _SYS_VNODE_H_
   38 #define _SYS_VNODE_H_
   39 
   40 /*
   41  * XXX - compatability until lockmgr() goes away or all the #includes are
   42  * updated.
   43  */
   44 #include <sys/lockmgr.h>
   45 
   46 #include <sys/queue.h>
   47 #include <sys/_lock.h>
   48 #include <sys/lock.h>
   49 #include <sys/_mutex.h>
   50 #include <sys/mutex.h>
   51 #include <sys/selinfo.h>
   52 #include <sys/uio.h>
   53 #include <sys/acl.h>
   54 #include <sys/ktr.h>
   55 
   56 /*
   57  * The vnode is the focus of all file activity in UNIX.  There is a
   58  * unique vnode allocated for each active file, each current directory,
   59  * each mounted-on file, text file, and the root.
   60  */
   61 
   62 /*
   63  * Vnode types.  VNON means no type.
   64  */
   65 enum vtype      { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD };
   66 
   67 /*
   68  * Each underlying filesystem allocates its own private area and hangs
   69  * it from v_data.  If non-null, this area is freed in getnewvnode().
   70  */
   71 TAILQ_HEAD(buflists, buf);
   72 
   73 typedef int     vop_t(void *);
   74 struct namecache;
   75 
   76 struct vpollinfo {
   77         struct  mtx vpi_lock;           /* lock to protect below */
   78         struct  selinfo vpi_selinfo;    /* identity of poller(s) */
   79         short   vpi_events;             /* what they are looking for */
   80         short   vpi_revents;            /* what has happened */
   81 };
   82 
   83 /*
   84  * Reading or writing any of these items requires holding the appropriate lock.
   85  *
   86  * Lock reference:
   87  *      c - namecache mutex
   88  *      f - freelist mutex
   89  *      i - interlock
   90  *      m - mntvnodes mutex
   91  *      p - pollinfo lock
   92  *      s - spechash mutex
   93  *      S - syncer mutex
   94  *      u - Only a reference to the vnode is needed to read.
   95  *      v - vnode lock
   96  *
   97  * Vnodes may be found on many lists.  The general way to deal with operating
   98  * on a vnode that is on a list is:
   99  *      1) Lock the list and find the vnode.
  100  *      2) Lock interlock so that the vnode does not go away.
  101  *      3) Unlock the list to avoid lock order reversals.
  102  *      4) vget with LK_INTERLOCK and check for ENOENT, or
  103  *      5) Check for XLOCK if the vnode lock is not required.
  104  *      6) Perform your operation, then vput().
  105  *
  106  * XXX Not all fields are locked yet and some fields that are marked are not
  107  * locked consistently.  This is a work in progress.  Requires Giant!
  108  */
  109 
  110 struct vnode {
  111         struct  mtx v_interlock;                /* lock for "i" things */
  112         u_long  v_iflag;                        /* i vnode flags (see below) */
  113         int     v_usecount;                     /* i ref count of users */
  114         long    v_numoutput;                    /* i writes in progress */
  115         struct thread *v_vxproc;                /* i thread owning VXLOCK */
  116         int     v_holdcnt;                      /* i page & buffer references */
  117         struct  buflists v_cleanblkhd;          /* i SORTED clean blocklist */
  118         struct buf      *v_cleanblkroot;        /* i clean buf splay tree  */
  119         int     v_cleanbufcnt;                  /* i number of clean buffers */
  120         struct  buflists v_dirtyblkhd;          /* i SORTED dirty blocklist */
  121         struct buf      *v_dirtyblkroot;        /* i dirty buf splay tree */
  122         int     v_dirtybufcnt;                  /* i number of dirty buffers */
  123         u_long  v_vflag;                        /* v vnode flags */
  124         int     v_writecount;                   /* v ref count of writers */
  125         struct vm_object *v_object;             /* v Place to store VM object */
  126         daddr_t v_lastw;                        /* v last write (write cluster) */
  127         daddr_t v_cstart;                       /* v start block of cluster */
  128         daddr_t v_lasta;                        /* v last allocation (cluster) */
  129         int     v_clen;                         /* v length of current cluster */
  130         union {
  131                 struct mount    *vu_mountedhere;/* v ptr to mounted vfs (VDIR) */
  132                 struct socket   *vu_socket;     /* v unix ipc (VSOCK) */
  133                 struct {
  134                         struct cdev     *vu_cdev; /* v device (VCHR, VBLK) */
  135                         SLIST_ENTRY(vnode) vu_specnext; /* s device aliases */
  136                 } vu_spec;
  137                 struct fifoinfo *vu_fifoinfo;   /* v fifo (VFIFO) */
  138         } v_un;
  139         TAILQ_ENTRY(vnode) v_freelist;          /* f vnode freelist */
  140         TAILQ_ENTRY(vnode) v_nmntvnodes;        /* m vnodes for mount point */
  141         LIST_ENTRY(vnode) v_synclist;           /* S dirty vnode list */
  142         enum    vtype v_type;                   /* u vnode type */
  143         const char *v_tag;                      /* u type of underlying data */
  144         void    *v_data;                        /* u private data for fs */
  145         struct  lock v_lock;                    /* u used if fs don't have one */
  146         struct  lock *v_vnlock;                 /* u pointer to vnode lock */
  147         vop_t   **v_op;                         /* u vnode operations vector */
  148         struct  mount *v_mount;                 /* u ptr to vfs we are in */
  149         LIST_HEAD(, namecache) v_cache_src;     /* c Cache entries from us */
  150         TAILQ_HEAD(, namecache) v_cache_dst;    /* c Cache entries to us */
  151         u_long  v_id;                           /* c capability identifier */
  152         struct  vnode *v_dd;                    /* c .. vnode */
  153         u_long  v_ddid;                         /* c .. capability identifier */
  154         struct vpollinfo *v_pollinfo;           /* p Poll events */
  155         struct label *v_label;                  /* MAC label for vnode */
  156 #ifdef  DEBUG_LOCKS
  157         const char *filename;                   /* Source file doing locking */
  158         int line;                               /* Line number doing locking */
  159 #endif
  160         udev_t  v_cachedfs;                     /* cached fs id */
  161         ino_t   v_cachedid;                     /* cached file id */
  162 };
  163 #define v_mountedhere   v_un.vu_mountedhere
  164 #define v_socket        v_un.vu_socket
  165 #define v_rdev          v_un.vu_spec.vu_cdev
  166 #define v_specnext      v_un.vu_spec.vu_specnext
  167 #define v_fifoinfo      v_un.vu_fifoinfo
  168 
  169 /*
  170  * Userland version of struct vnode, for sysctl.
  171  */
  172 struct xvnode {
  173         size_t  xv_size;                        /* sizeof(struct xvnode) */
  174         void    *xv_vnode;                      /* address of real vnode */
  175         u_long  xv_flag;                        /* vnode vflags */
  176         int     xv_usecount;                    /* reference count of users */
  177         int     xv_writecount;                  /* reference count of writers */
  178         int     xv_holdcnt;                     /* page & buffer references */
  179         u_long  xv_id;                          /* capability identifier */
  180         void    *xv_mount;                      /* address of parent mount */
  181         long    xv_numoutput;                   /* num of writes in progress */
  182         enum    vtype xv_type;                  /* vnode type */
  183         union {
  184                 void    *xvu_socket;            /* socket, if VSOCK */
  185                 void    *xvu_fifo;              /* fifo, if VFIFO */
  186                 udev_t  xvu_rdev;               /* maj/min, if VBLK/VCHR */
  187                 struct {
  188                         udev_t  xvu_dev;        /* device, if VDIR/VREG/VLNK */
  189                         ino_t   xvu_ino;        /* id, if VDIR/VREG/VLNK */
  190                 } xv_uns;
  191         } xv_un;
  192 };
  193 #define xv_socket       xv_un.xvu_socket
  194 #define xv_fifo         xv_un.xvu_fifo
  195 #define xv_rdev         xv_un.xvu_rdev
  196 #define xv_dev          xv_un.xv_uns.xvu_dev
  197 #define xv_ino          xv_un.xv_uns.xvu_ino
  198 
  199 #define VN_POLLEVENT(vp, events)                                \
  200         do {                                                    \
  201                 if ((vp)->v_pollinfo != NULL &&                 \
  202                     (vp)->v_pollinfo->vpi_events & (events))    \
  203                         vn_pollevent((vp), (events));           \
  204         } while (0)
  205 
  206 #define VN_KNOTE(vp, b)                                         \
  207         do {                                                    \
  208                 if ((vp)->v_pollinfo != NULL)                   \
  209                         KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b)); \
  210         } while (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         udev_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         udev_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 
  355 #ifdef DIAGNOSTIC
  356 #define VATTR_NULL(vap) vattr_null(vap)
  357 #else
  358 #define VATTR_NULL(vap) (*(vap) = va_null)      /* initialize a vattr */
  359 #endif /* DIAGNOSTIC */
  360 
  361 #define NULLVP  ((struct vnode *)NULL)
  362 
  363 #define VNODEOP_SET(f) \
  364         C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \
  365         C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f);
  366 
  367 /*
  368  * Global vnode data.
  369  */
  370 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
  371 extern  int async_io_version;           /* 0 or POSIX version of AIO i'face */
  372 extern  int desiredvnodes;              /* number of vnodes desired */
  373 extern  struct uma_zone *namei_zone;
  374 extern  int prtactive;                  /* nonzero to call vprint() */
  375 extern  struct vattr va_null;           /* predefined null vattr structure */
  376 
  377 /*
  378  * Macro/function to check for client cache inconsistency w.r.t. leasing.
  379  */
  380 #define LEASE_READ      0x1             /* Check lease for readers */
  381 #define LEASE_WRITE     0x2             /* Check lease for modifiers */
  382 
  383 
  384 extern void     (*lease_updatetime)(int deltat);
  385 
  386 /* Requires interlock */
  387 #define VSHOULDFREE(vp) \
  388         (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_DOINGINACT)) && \
  389          !(vp)->v_holdcnt && !(vp)->v_usecount && \
  390          (!(vp)->v_object || \
  391           !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count)))
  392 
  393 /* Requires interlock */
  394 #define VMIGHTFREE(vp) \
  395         (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_XLOCK|VI_DOINGINACT)) && \
  396          LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount)
  397 
  398 /* Requires interlock */
  399 #define VSHOULDBUSY(vp) \
  400         (((vp)->v_iflag & VI_FREE) && \
  401          ((vp)->v_holdcnt || (vp)->v_usecount))
  402 
  403 #define VI_LOCK(vp)     mtx_lock(&(vp)->v_interlock)
  404 #define VI_TRYLOCK(vp)  mtx_trylock(&(vp)->v_interlock)
  405 #define VI_UNLOCK(vp)   mtx_unlock(&(vp)->v_interlock)
  406 #define VI_MTX(vp)      (&(vp)->v_interlock)
  407 
  408 #endif /* _KERNEL */
  409 
  410 
  411 /*
  412  * Mods for extensibility.
  413  */
  414 
  415 /*
  416  * Flags for vdesc_flags:
  417  */
  418 #define VDESC_MAX_VPS           16
  419 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
  420 #define VDESC_VP0_WILLRELE      0x0001
  421 #define VDESC_VP1_WILLRELE      0x0002
  422 #define VDESC_VP2_WILLRELE      0x0004
  423 #define VDESC_VP3_WILLRELE      0x0008
  424 #define VDESC_NOMAP_VPP         0x0100
  425 #define VDESC_VPP_WILLRELE      0x0200
  426 
  427 /*
  428  * VDESC_NO_OFFSET is used to identify the end of the offset list
  429  * and in places where no such field exists.
  430  */
  431 #define VDESC_NO_OFFSET -1
  432 
  433 /*
  434  * This structure describes the vnode operation taking place.
  435  */
  436 struct vnodeop_desc {
  437         int      vdesc_offset;          /* offset in vector,first for speed */
  438         char    *vdesc_name;            /* a readable name for debugging */
  439         int      vdesc_flags;           /* VDESC_* flags */
  440 
  441         /*
  442          * These ops are used by bypass routines to map and locate arguments.
  443          * Creds and procs are not needed in bypass routines, but sometimes
  444          * they are useful to (for example) transport layers.
  445          * Nameidata is useful because it has a cred in it.
  446          */
  447         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
  448         int     vdesc_vpp_offset;       /* return vpp location */
  449         int     vdesc_cred_offset;      /* cred location, if any */
  450         int     vdesc_thread_offset;    /* thread location, if any */
  451         int     vdesc_componentname_offset; /* if any */
  452         /*
  453          * Finally, we've got a list of private data (about each operation)
  454          * for each transport layer.  (Support to manage this list is not
  455          * yet part of BSD.)
  456          */
  457         caddr_t *vdesc_transports;
  458 };
  459 
  460 #ifdef _KERNEL
  461 /*
  462  * A list of all the operation descs.
  463  */
  464 extern struct vnodeop_desc *vnodeop_descs[];
  465 
  466 #define VOPARG_OFFSETOF(s_type, field)  __offsetof(s_type, field)
  467 #define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
  468     ((s_type)(((char*)(struct_p)) + (s_offset)))
  469 
  470 /*
  471  * This structure is used to configure the new vnodeops vector.
  472  */
  473 struct vnodeopv_entry_desc {
  474         struct vnodeop_desc *opve_op;   /* which operation this is */
  475         vop_t *opve_impl;               /* code implementing this operation */
  476 };
  477 struct vnodeopv_desc {
  478                         /* ptr to the ptr to the vector where op should go */
  479         vop_t ***opv_desc_vector_p;
  480         struct vnodeopv_entry_desc *opv_desc_ops;   /* null terminated list */
  481 };
  482 
  483 /*
  484  * A generic structure.
  485  * This can be used by bypass routines to identify generic arguments.
  486  */
  487 struct vop_generic_args {
  488         struct vnodeop_desc *a_desc;
  489         /* other random data follows, presumably */
  490 };
  491 
  492 /*
  493  * Support code to aid in debugging VFS locking problems.  Not totally
  494  * reliable since if the thread sleeps between changing the lock
  495  * state and checking it with the assert, some other thread could
  496  * change the state.  They are good enough for debugging a single
  497  * filesystem using a single-threaded test.
  498  */
  499 void assert_vi_locked(struct vnode *vp, const char *str);
  500 void assert_vi_unlocked(struct vnode *vp, const char *str);
  501 void assert_vop_unlocked(struct vnode *vp, const char *str);
  502 void assert_vop_locked(struct vnode *vp, const char *str);
  503 void assert_vop_slocked(struct vnode *vp, const char *str);
  504 void assert_vop_elocked(struct vnode *vp, const char *str);
  505 void assert_vop_elocked_other(struct vnode *vp, const char *str);
  506 
  507 /* These are called from within the actuall VOPS */
  508 void vop_rename_pre(void *a);
  509 void vop_strategy_pre(void *a);
  510 void vop_lookup_pre(void *a);
  511 void vop_lookup_post(void *a, int rc);
  512 void vop_lock_pre(void *a);
  513 void vop_lock_post(void *a, int rc);
  514 void vop_unlock_pre(void *a);
  515 void vop_unlock_post(void *a, int rc);
  516 
  517 #ifdef DEBUG_VFS_LOCKS
  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 #define ASSERT_VOP_LOCKED(vp, str)      assert_vop_locked((vp), (str))
  522 #define ASSERT_VOP_UNLOCKED(vp, str)    assert_vop_unlocked((vp), (str))
  523 #define ASSERT_VOP_ELOCKED(vp, str)     assert_vop_elocked((vp), (str))
  524 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
  525 #define ASSERT_VOP_SLOCKED(vp, str)     assert_vop_slocked((vp), (str))
  526 
  527 #else
  528 
  529 #define ASSERT_VOP_LOCKED(vp, str)
  530 #define ASSERT_VOP_UNLOCKED(vp, str)
  531 #define ASSERT_VOP_ELOCKED(vp, str)
  532 #define ASSERT_VOP_ELOCKED_OTHER(vp, str)
  533 #define ASSERT_VOP_SLOCKED(vp, str)
  534 #define ASSERT_VI_UNLOCKED(vp, str)
  535 #define ASSERT_VI_LOCKED(vp, str)
  536 
  537 #endif
  538 
  539 /*
  540  * VOCALL calls an op given an ops vector.  We break it out because BSD's
  541  * vclean changes the ops vector and then wants to call ops with the old
  542  * vector.
  543  */
  544 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
  545 
  546 /*
  547  * This call works for vnodes in the kernel.
  548  */
  549 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
  550 #define VDESC(OP) (& __CONCAT(OP,_desc))
  551 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
  552 
  553 /*
  554  * VMIO support inline
  555  */
  556 
  557 extern int vmiodirenable;
  558 
  559 static __inline int
  560 vn_canvmio(struct vnode *vp)
  561 {
  562       if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
  563                 return(TRUE);
  564         return(FALSE);
  565 }
  566 
  567 /*
  568  * Finally, include the default set of vnode operations.
  569  */
  570 #include "vnode_if.h"
  571 
  572 /*
  573  * Public vnode manipulation functions.
  574  */
  575 struct componentname;
  576 struct file;
  577 struct mount;
  578 struct nameidata;
  579 struct ostat;
  580 struct thread;
  581 struct proc;
  582 struct stat;
  583 struct nstat;
  584 struct ucred;
  585 struct uio;
  586 struct vattr;
  587 struct vnode;
  588 
  589 extern int      (*lease_check_hook)(struct vop_lease_args *);
  590 extern int      (*softdep_fsync_hook)(struct vnode *);
  591 extern int      (*softdep_process_worklist_hook)(struct mount *);
  592 
  593 struct  vnode *addaliasu(struct vnode *vp, udev_t nvp_rdev);
  594 int     bdevvp(dev_t dev, struct vnode **vpp);
  595 /* cache_* may belong in namei.h. */
  596 void    cache_enter(struct vnode *dvp, struct vnode *vp,
  597             struct componentname *cnp);
  598 int     cache_lookup(struct vnode *dvp, struct vnode **vpp,
  599             struct componentname *cnp);
  600 void    cache_purge(struct vnode *vp);
  601 void    cache_purgevfs(struct mount *mp);
  602 int     cache_leaf_test(struct vnode *vp);
  603 int     change_dir(struct vnode *vp, struct thread *td);
  604 int     change_root(struct vnode *vp, struct thread *td);
  605 void    cvtstat(struct stat *st, struct ostat *ost);
  606 void    cvtnstat(struct stat *sb, struct nstat *nsb);
  607 int     getnewvnode(const char *tag, struct mount *mp, vop_t **vops,
  608             struct vnode **vpp);
  609 int     lease_check(struct vop_lease_args *ap);
  610 int     spec_vnoperate(struct vop_generic_args *);
  611 int     speedup_syncer(void);
  612 #define textvp_fullpath(p, rb, rfb) \
  613         vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
  614 int     vn_fullpath(struct thread *td, struct vnode *vn,
  615             char **retbuf, char **freebuf);
  616 int     vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
  617             mode_t acc_mode, struct ucred *cred, int *privused);
  618 int     vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
  619             gid_t file_gid, struct acl *acl, mode_t acc_mode,
  620             struct ucred *cred, int *privused);
  621 void    vattr_null(struct vattr *vap);
  622 int     vcount(struct vnode *vp);
  623 void    vdrop(struct vnode *);
  624 void    vdropl(struct vnode *);
  625 int     vfinddev(dev_t dev, enum vtype type, struct vnode **vpp);
  626 void    vfs_add_vnodeops(const void *);
  627 void    vfs_rm_vnodeops(const void *);
  628 int     vflush(struct mount *mp, int rootrefs, int flags);
  629 int     vget(struct vnode *vp, int lockflag, struct thread *td);
  630 void    vgone(struct vnode *vp);
  631 void    vgonel(struct vnode *vp, struct thread *td);
  632 void    vhold(struct vnode *);
  633 void    vholdl(struct vnode *);
  634 int     vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
  635             struct thread *td, int slpflag, int slptimeo);
  636 int     vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
  637             off_t length, int blksize);
  638 void    vprint(char *label, struct vnode *vp);
  639 int     vrecycle(struct vnode *vp, struct mtx *inter_lkp,
  640             struct thread *td);
  641 int     vn_close(struct vnode *vp,
  642             int flags, struct ucred *file_cred, struct thread *td);
  643 void    vn_finished_write(struct mount *mp);
  644 int     vn_isdisk(struct vnode *vp, int *errp);
  645 int     vn_lock(struct vnode *vp, int flags, struct thread *td);
  646 #ifdef  DEBUG_LOCKS
  647 int     debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
  648             const char *filename, int line);
  649 #define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
  650 #endif
  651 int     vn_open(struct nameidata *ndp, int *flagp, int cmode, int fdidx);
  652 int     vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
  653             struct ucred *cred, int fdidx);
  654 void    vn_pollevent(struct vnode *vp, int events);
  655 void    vn_pollgone(struct vnode *vp);
  656 int     vn_pollrecord(struct vnode *vp, struct thread *p, int events);
  657 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
  658             int len, off_t offset, enum uio_seg segflg, int ioflg,
  659             struct ucred *active_cred, struct ucred *file_cred, int *aresid,
  660             struct thread *td);
  661 int     vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
  662             int len, off_t offset, enum uio_seg segflg, int ioflg,
  663             struct ucred *active_cred, struct ucred *file_cred, int *aresid,
  664             struct thread *td);
  665 int     vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
  666             struct ucred *file_cred, struct thread *td);
  667 int     vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
  668 dev_t   vn_todev(struct vnode *vp);
  669 int     vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
  670             int flags);
  671 int     vn_writechk(struct vnode *vp);
  672 int     vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
  673             const char *attrname, int *buflen, char *buf, struct thread *td);
  674 int     vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
  675             const char *attrname, int buflen, char *buf, struct thread *td);
  676 int     vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
  677             const char *attrname, struct thread *td);
  678 int     vfs_cache_lookup(struct vop_lookup_args *ap);
  679 int     vfs_object_create(struct vnode *vp, struct thread *td,
  680             struct ucred *cred);
  681 void    vfs_timestamp(struct timespec *);
  682 void    vfs_write_resume(struct mount *mp);
  683 int     vfs_write_suspend(struct mount *mp);
  684 int     vop_stdbmap(struct vop_bmap_args *);
  685 int     vop_stdfsync(struct vop_fsync_args *);
  686 int     vop_stdgetwritemount(struct vop_getwritemount_args *);
  687 int     vop_stdgetpages(struct vop_getpages_args *);
  688 int     vop_stdinactive(struct vop_inactive_args *);
  689 int     vop_stdislocked(struct vop_islocked_args *);
  690 int     vop_stdlock(struct vop_lock_args *);
  691 int     vop_stdputpages(struct vop_putpages_args *);
  692 int     vop_stdunlock(struct vop_unlock_args *);
  693 int     vop_noislocked(struct vop_islocked_args *);
  694 int     vop_nolock(struct vop_lock_args *);
  695 int     vop_nopoll(struct vop_poll_args *);
  696 int     vop_nounlock(struct vop_unlock_args *);
  697 int     vop_stdpathconf(struct vop_pathconf_args *);
  698 int     vop_stdpoll(struct vop_poll_args *);
  699 int     vop_revoke(struct vop_revoke_args *);
  700 int     vop_sharedlock(struct vop_lock_args *);
  701 int     vop_eopnotsupp(struct vop_generic_args *ap);
  702 int     vop_ebadf(struct vop_generic_args *ap);
  703 int     vop_einval(struct vop_generic_args *ap);
  704 int     vop_enotty(struct vop_generic_args *ap);
  705 int     vop_defaultop(struct vop_generic_args *ap);
  706 int     vop_null(struct vop_generic_args *ap);
  707 int     vop_panic(struct vop_generic_args *ap);
  708 int     vop_stdcreatevobject(struct vop_createvobject_args *ap);
  709 int     vop_stddestroyvobject(struct vop_destroyvobject_args *ap);
  710 int     vop_stdgetvobject(struct vop_getvobject_args *ap);
  711 
  712 void    vfree(struct vnode *);
  713 void    vput(struct vnode *vp);
  714 void    vrele(struct vnode *vp);
  715 void    vref(struct vnode *vp);
  716 int     vrefcnt(struct vnode *vp);
  717 void    vbusy(struct vnode *vp);
  718 void    v_addpollinfo(struct vnode *vp);
  719 
  720 extern  vop_t **default_vnodeop_p;
  721 extern  vop_t **spec_vnodeop_p;
  722 extern  vop_t **dead_vnodeop_p;
  723 
  724 #endif /* _KERNEL */
  725 
  726 #endif /* !_SYS_VNODE_H_ */

Cache object: cf90ead82f700ec9928d6e6942b9b885


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