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

Cache object: ff126db17e471fdca5791aae371aea13


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