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


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

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

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

    1 /*-
    2  * Copyright (c) 1989, 1993
    3  *      The Regents of the University of California.  All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    8  * 1. Redistributions of source code must retain the above copyright
    9  *    notice, this list of conditions and the following disclaimer.
   10  * 2. Redistributions in binary form must reproduce the above copyright
   11  *    notice, this list of conditions and the following disclaimer in the
   12  *    documentation and/or other materials provided with the distribution.
   13  * 4. Neither the name of the University nor the names of its contributors
   14  *    may be used to endorse or promote products derived from this software
   15  *    without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  *      @(#)vnode.h     8.7 (Berkeley) 2/4/94
   30  * $FreeBSD: releng/8.4/sys/sys/vnode.h 249524 2013-04-15 19:45:09Z smh $
   31  */
   32 
   33 #ifndef _SYS_VNODE_H_
   34 #define _SYS_VNODE_H_
   35 
   36 #include <sys/bufobj.h>
   37 #include <sys/queue.h>
   38 #include <sys/lock.h>
   39 #include <sys/lockmgr.h>
   40 #include <sys/mutex.h>
   41 #include <sys/selinfo.h>
   42 #include <sys/uio.h>
   43 #include <sys/acl.h>
   44 #include <sys/ktr.h>
   45 
   46 /*
   47  * The vnode is the focus of all file activity in UNIX.  There is a
   48  * unique vnode allocated for each active file, each current directory,
   49  * each mounted-on file, text file, and the root.
   50  */
   51 
   52 /*
   53  * Vnode types.  VNON means no type.
   54  */
   55 enum vtype      { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD,
   56                   VMARKER };
   57 
   58 /*
   59  * Each underlying filesystem allocates its own private area and hangs
   60  * it from v_data.  If non-null, this area is freed in getnewvnode().
   61  */
   62 
   63 struct namecache;
   64 
   65 struct vpollinfo {
   66         struct  mtx vpi_lock;           /* lock to protect below */
   67         struct  selinfo vpi_selinfo;    /* identity of poller(s) */
   68         short   vpi_events;             /* what they are looking for */
   69         short   vpi_revents;            /* what has happened */
   70 };
   71 
   72 /*
   73  * Reading or writing any of these items requires holding the appropriate lock.
   74  *
   75  * Lock reference:
   76  *      c - namecache mutex
   77  *      f - freelist mutex
   78  *      i - interlock
   79  *      m - mount point interlock
   80  *      p - pollinfo lock
   81  *      u - Only a reference to the vnode is needed to read.
   82  *      v - vnode lock
   83  *
   84  * Vnodes may be found on many lists.  The general way to deal with operating
   85  * on a vnode that is on a list is:
   86  *      1) Lock the list and find the vnode.
   87  *      2) Lock interlock so that the vnode does not go away.
   88  *      3) Unlock the list to avoid lock order reversals.
   89  *      4) vget with LK_INTERLOCK and check for ENOENT, or
   90  *      5) Check for DOOMED if the vnode lock is not required.
   91  *      6) Perform your operation, then vput().
   92  */
   93 
   94 #if defined(_KERNEL) || defined(_KVM_VNODE)
   95 
   96 struct vnode {
   97         /*
   98          * Fields which define the identity of the vnode.  These fields are
   99          * owned by the filesystem (XXX: and vgone() ?)
  100          */
  101         enum    vtype v_type;                   /* u vnode type */
  102         const char *v_tag;                      /* u type of underlying data */
  103         struct  vop_vector *v_op;               /* u vnode operations vector */
  104         void    *v_data;                        /* u private data for fs */
  105 
  106         /*
  107          * Filesystem instance stuff
  108          */
  109         struct  mount *v_mount;                 /* u ptr to vfs we are in */
  110         TAILQ_ENTRY(vnode) v_nmntvnodes;        /* m vnodes for mount point */
  111 
  112         /*
  113          * Type specific fields, only one applies to any given vnode.
  114          * See #defines below for renaming to v_* namespace.
  115          */
  116         union {
  117                 struct mount    *vu_mount;      /* v ptr to mountpoint (VDIR) */
  118                 struct socket   *vu_socket;     /* v unix domain net (VSOCK) */
  119                 struct cdev     *vu_cdev;       /* v device (VCHR, VBLK) */
  120                 struct fifoinfo *vu_fifoinfo;   /* v fifo (VFIFO) */
  121                 int             vu_yield;       /*   yield count (VMARKER) */
  122         } v_un;
  123 
  124         /*
  125          * vfs_hash:  (mount + inode) -> vnode hash.
  126          */
  127         LIST_ENTRY(vnode)       v_hashlist;
  128         u_int                   v_hash;
  129 
  130         /*
  131          * VFS_namecache stuff
  132          */
  133         LIST_HEAD(, namecache) v_cache_src;     /* c Cache entries from us */
  134         TAILQ_HEAD(, namecache) v_cache_dst;    /* c Cache entries to us */
  135         struct namecache *v_cache_dd;           /* c Cache entry for .. vnode */
  136 
  137         /*
  138          * clustering stuff
  139          */
  140         daddr_t v_cstart;                       /* v start block of cluster */
  141         daddr_t v_lasta;                        /* v last allocation  */
  142         daddr_t v_lastw;                        /* v last write  */
  143         int     v_clen;                         /* v length of cur. cluster */
  144 
  145         /*
  146          * Locking
  147          */
  148         struct  lock v_lock;                    /* u (if fs don't have one) */
  149         struct  mtx v_interlock;                /* lock for "i" things */
  150         struct  lock *v_vnlock;                 /* u pointer to vnode lock */
  151         int     v_holdcnt;                      /* i prevents recycling. */
  152         int     v_usecount;                     /* i ref count of users */
  153         u_long  v_iflag;                        /* i vnode flags (see below) */
  154         u_long  v_vflag;                        /* v vnode flags */
  155         int     v_writecount;                   /* v ref count of writers */
  156 
  157         /*
  158          * The machinery of being a vnode
  159          */
  160         TAILQ_ENTRY(vnode) v_freelist;          /* f vnode freelist */
  161         struct bufobj   v_bufobj;               /* * Buffer cache object */
  162 
  163         /*
  164          * Hooks for various subsystems and features.
  165          */
  166         struct vpollinfo *v_pollinfo;           /* i Poll events, p for *v_pi */
  167         struct label *v_label;                  /* MAC label for vnode */
  168         struct lockf *v_lockf;          /* Byte-level advisory lock list */
  169 };
  170 
  171 #endif /* defined(_KERNEL) || defined(_KVM_VNODE) */
  172 
  173 #define v_mountedhere   v_un.vu_mount
  174 #define v_socket        v_un.vu_socket
  175 #define v_rdev          v_un.vu_cdev
  176 #define v_fifoinfo      v_un.vu_fifoinfo
  177 #define v_yield         v_un.vu_yield
  178 
  179 /* XXX: These are temporary to avoid a source sweep at this time */
  180 #define v_object        v_bufobj.bo_object
  181 
  182 /*
  183  * Userland version of struct vnode, for sysctl.
  184  */
  185 struct xvnode {
  186         size_t  xv_size;                        /* sizeof(struct xvnode) */
  187         void    *xv_vnode;                      /* address of real vnode */
  188         u_long  xv_flag;                        /* vnode vflags */
  189         int     xv_usecount;                    /* reference count of users */
  190         int     xv_writecount;                  /* reference count of writers */
  191         int     xv_holdcnt;                     /* page & buffer references */
  192         u_long  xv_id;                          /* capability identifier */
  193         void    *xv_mount;                      /* address of parent mount */
  194         long    xv_numoutput;                   /* num of writes in progress */
  195         enum    vtype xv_type;                  /* vnode type */
  196         union {
  197                 void    *xvu_socket;            /* socket, if VSOCK */
  198                 void    *xvu_fifo;              /* fifo, if VFIFO */
  199                 dev_t   xvu_rdev;               /* maj/min, if VBLK/VCHR */
  200                 struct {
  201                         dev_t   xvu_dev;        /* device, if VDIR/VREG/VLNK */
  202                         ino_t   xvu_ino;        /* id, if VDIR/VREG/VLNK */
  203                 } xv_uns;
  204         } xv_un;
  205 };
  206 #define xv_socket       xv_un.xvu_socket
  207 #define xv_fifo         xv_un.xvu_fifo
  208 #define xv_rdev         xv_un.xvu_rdev
  209 #define xv_dev          xv_un.xv_uns.xvu_dev
  210 #define xv_ino          xv_un.xv_uns.xvu_ino
  211 
  212 /* We don't need to lock the knlist */
  213 #define VN_KNLIST_EMPTY(vp) ((vp)->v_pollinfo == NULL ||        \
  214             KNLIST_EMPTY(&(vp)->v_pollinfo->vpi_selinfo.si_note))
  215 
  216 #define VN_KNOTE(vp, b, a)                                      \
  217         do {                                                    \
  218                 if (!VN_KNLIST_EMPTY(vp))                       \
  219                         KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), \
  220                             (a) | KNF_NOKQLOCK);                \
  221         } while (0)
  222 #define VN_KNOTE_LOCKED(vp, b)          VN_KNOTE(vp, b, KNF_LISTLOCKED)
  223 #define VN_KNOTE_UNLOCKED(vp, b)        VN_KNOTE(vp, b, 0)
  224 
  225 /*
  226  * Vnode flags.
  227  *      VI flags are protected by interlock and live in v_iflag
  228  *      VV flags are protected by the vnode lock and live in v_vflag
  229  *
  230  *      VI_DOOMED is doubly protected by the interlock and vnode lock.  Both
  231  *      are required for writing but the status may be checked with either.
  232  */
  233 #define VI_MOUNT        0x0020  /* Mount in progress */
  234 #define VI_AGE          0x0040  /* Insert vnode at head of free list */
  235 #define VI_DOOMED       0x0080  /* This vnode is being recycled */
  236 #define VI_FREE         0x0100  /* This vnode is on the freelist */
  237 #define VI_DOINGINACT   0x0800  /* VOP_INACTIVE is in progress */
  238 #define VI_OWEINACT     0x1000  /* Need to call inactive */
  239 
  240 #define VV_ROOT         0x0001  /* root of its filesystem */
  241 #define VV_ISTTY        0x0002  /* vnode represents a tty */
  242 #define VV_NOSYNC       0x0004  /* unlinked, stop syncing */
  243 #define VV_ETERNALDEV   0x0008  /* device that is never destroyed */
  244 #define VV_CACHEDLABEL  0x0010  /* Vnode has valid cached MAC label */
  245 #define VV_TEXT         0x0020  /* vnode is a pure text prototype */
  246 #define VV_COPYONWRITE  0x0040  /* vnode is doing copy-on-write */
  247 #define VV_SYSTEM       0x0080  /* vnode being used by kernel */
  248 #define VV_PROCDEP      0x0100  /* vnode is process dependent */
  249 #define VV_NOKNOTE      0x0200  /* don't activate knotes on this vnode */
  250 #define VV_DELETED      0x0400  /* should be removed */
  251 #define VV_MD           0x0800  /* vnode backs the md device */
  252 #define VV_FORCEINSMQ   0x1000  /* force the insmntque to succeed */
  253 
  254 /*
  255  * Vnode attributes.  A field value of VNOVAL represents a field whose value
  256  * is unavailable (getattr) or which is not to be changed (setattr).
  257  */
  258 struct vattr {
  259         enum vtype      va_type;        /* vnode type (for create) */
  260         u_short         va_mode;        /* files access mode and type */
  261         short           va_nlink;       /* number of references to file */
  262         uid_t           va_uid;         /* owner user id */
  263         gid_t           va_gid;         /* owner group id */
  264         dev_t           va_fsid;        /* filesystem id */
  265         long            va_fileid;      /* file id */
  266         u_quad_t        va_size;        /* file size in bytes */
  267         long            va_blocksize;   /* blocksize preferred for i/o */
  268         struct timespec va_atime;       /* time of last access */
  269         struct timespec va_mtime;       /* time of last modification */
  270         struct timespec va_ctime;       /* time file changed */
  271         struct timespec va_birthtime;   /* time file created */
  272         u_long          va_gen;         /* generation number of file */
  273         u_long          va_flags;       /* flags defined for file */
  274         dev_t           va_rdev;        /* device the special file represents */
  275         u_quad_t        va_bytes;       /* bytes of disk space held by file */
  276         u_quad_t        va_filerev;     /* file modification number */
  277         u_int           va_vaflags;     /* operations flags, see below */
  278         long            va_spare;       /* remain quad aligned */
  279 };
  280 
  281 /*
  282  * Flags for va_vaflags.
  283  */
  284 #define VA_UTIMES_NULL  0x01            /* utimes argument was NULL */
  285 #define VA_EXCLUSIVE    0x02            /* exclusive create request */
  286 
  287 /*
  288  * Flags for ioflag. (high 16 bits used to ask for read-ahead and
  289  * help with write clustering)
  290  * NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h
  291  */
  292 #define IO_UNIT         0x0001          /* do I/O as atomic unit */
  293 #define IO_APPEND       0x0002          /* append write to end */
  294 #define IO_NDELAY       0x0004          /* FNDELAY flag set in file table */
  295 #define IO_NODELOCKED   0x0008          /* underlying node already locked */
  296 #define IO_ASYNC        0x0010          /* bawrite rather then bdwrite */
  297 #define IO_VMIO         0x0020          /* data already in VMIO space */
  298 #define IO_INVAL        0x0040          /* invalidate after I/O */
  299 #define IO_SYNC         0x0080          /* do I/O synchronously */
  300 #define IO_DIRECT       0x0100          /* attempt to bypass buffer cache */
  301 #define IO_EXT          0x0400          /* operate on external attributes */
  302 #define IO_NORMAL       0x0800          /* operate on regular data */
  303 #define IO_NOMACCHECK   0x1000          /* MAC checks unnecessary */
  304 
  305 #define IO_SEQMAX       0x7F            /* seq heuristic max value */
  306 #define IO_SEQSHIFT     16              /* seq heuristic in upper 16 bits */
  307 
  308 /*
  309  * Flags for accmode_t.
  310  */
  311 #define VEXEC                   000000000100 /* execute/search permission */
  312 #define VWRITE                  000000000200 /* write permission */
  313 #define VREAD                   000000000400 /* read permission */
  314 #define VADMIN                  000000010000 /* being the file owner */
  315 #define VAPPEND                 000000040000 /* permission to write/append */
  316 /*
  317  * VEXPLICIT_DENY makes VOP_ACCESSX(9) return EPERM or EACCES only
  318  * if permission was denied explicitly, by a "deny" rule in NFSv4 ACL,
  319  * and 0 otherwise.  This never happens with ordinary unix access rights
  320  * or POSIX.1e ACLs.  Obviously, VEXPLICIT_DENY must be OR-ed with
  321  * some other V* constant.
  322  */
  323 #define VEXPLICIT_DENY          000000100000
  324 #define VREAD_NAMED_ATTRS       000000200000 /* not used */
  325 #define VWRITE_NAMED_ATTRS      000000400000 /* not used */
  326 #define VDELETE_CHILD           000001000000
  327 #define VREAD_ATTRIBUTES        000002000000 /* permission to stat(2) */
  328 #define VWRITE_ATTRIBUTES       000004000000 /* change {m,c,a}time */
  329 #define VDELETE                 000010000000
  330 #define VREAD_ACL               000020000000 /* read ACL and file mode */
  331 #define VWRITE_ACL              000040000000 /* change ACL and/or file mode */
  332 #define VWRITE_OWNER            000100000000 /* change file owner */
  333 #define VSYNCHRONIZE            000200000000 /* not used */
  334 
  335 /*
  336  * Permissions that were traditionally granted only to the file owner.
  337  */
  338 #define VADMIN_PERMS    (VADMIN | VWRITE_ATTRIBUTES | VWRITE_ACL | \
  339     VWRITE_OWNER)
  340 
  341 /*
  342  * Permissions that were traditionally granted to everyone.
  343  */
  344 #define VSTAT_PERMS     (VREAD_ATTRIBUTES | VREAD_ACL)
  345 
  346 /*
  347  * Permissions that allow to change the state of the file in any way.
  348  */
  349 #define VMODIFY_PERMS   (VWRITE | VAPPEND | VADMIN_PERMS | VDELETE_CHILD | \
  350     VDELETE)
  351 
  352 /*
  353  * Token indicating no attribute value yet assigned.
  354  */
  355 #define VNOVAL  (-1)
  356 
  357 /*
  358  * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
  359  */
  360 #define VLKTIMEOUT      (hz / 20 + 1)
  361 
  362 #ifdef _KERNEL
  363 
  364 #ifdef MALLOC_DECLARE
  365 MALLOC_DECLARE(M_VNODE);
  366 #endif
  367 
  368 /*
  369  * Convert between vnode types and inode formats (since POSIX.1
  370  * defines mode word of stat structure in terms of inode formats).
  371  */
  372 extern enum vtype       iftovt_tab[];
  373 extern int              vttoif_tab[];
  374 #define IFTOVT(mode)    (iftovt_tab[((mode) & S_IFMT) >> 12])
  375 #define VTTOIF(indx)    (vttoif_tab[(int)(indx)])
  376 #define MAKEIMODE(indx, mode)   (int)(VTTOIF(indx) | (mode))
  377 
  378 /*
  379  * Flags to various vnode functions.
  380  */
  381 #define SKIPSYSTEM      0x0001  /* vflush: skip vnodes marked VSYSTEM */
  382 #define FORCECLOSE      0x0002  /* vflush: force file closure */
  383 #define WRITECLOSE      0x0004  /* vflush: only close writable files */
  384 #define DOCLOSE         0x0008  /* vclean: close active files */
  385 #define V_SAVE          0x0001  /* vinvalbuf: sync file first */
  386 #define V_ALT           0x0002  /* vinvalbuf: invalidate only alternate bufs */
  387 #define V_NORMAL        0x0004  /* vinvalbuf: invalidate only regular bufs */
  388 #define V_CLEANONLY     0x0008  /* vinvalbuf: invalidate only clean bufs */
  389 #define REVOKEALL       0x0001  /* vop_revoke: revoke all aliases */
  390 #define V_WAIT          0x0001  /* vn_start_write: sleep for suspend */
  391 #define V_NOWAIT        0x0002  /* vn_start_write: don't sleep for suspend */
  392 #define V_XSLEEP        0x0004  /* vn_start_write: just return after sleep */
  393 
  394 #define VREF(vp)        vref(vp)
  395 
  396 #ifdef DIAGNOSTIC
  397 #define VATTR_NULL(vap) vattr_null(vap)
  398 #else
  399 #define VATTR_NULL(vap) (*(vap) = va_null)      /* initialize a vattr */
  400 #endif /* DIAGNOSTIC */
  401 
  402 #define NULLVP  ((struct vnode *)NULL)
  403 
  404 /*
  405  * Global vnode data.
  406  */
  407 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
  408 extern  int async_io_version;           /* 0 or POSIX version of AIO i'face */
  409 extern  int desiredvnodes;              /* number of vnodes desired */
  410 extern  struct uma_zone *namei_zone;
  411 extern  int prtactive;                  /* nonzero to call vprint() */
  412 extern  struct vattr va_null;           /* predefined null vattr structure */
  413 
  414 #define VI_LOCK(vp)     mtx_lock(&(vp)->v_interlock)
  415 #define VI_LOCK_FLAGS(vp, flags) mtx_lock_flags(&(vp)->v_interlock, (flags))
  416 #define VI_TRYLOCK(vp)  mtx_trylock(&(vp)->v_interlock)
  417 #define VI_UNLOCK(vp)   mtx_unlock(&(vp)->v_interlock)
  418 #define VI_MTX(vp)      (&(vp)->v_interlock)
  419 
  420 #define VN_LOCK_AREC(vp)                                                \
  421         ((vp)->v_vnlock->lock_object.lo_flags |= LO_RECURSABLE)
  422 #define VN_LOCK_ASHARE(vp)                                              \
  423         ((vp)->v_vnlock->lock_object.lo_flags &= ~LK_NOSHARE)
  424 
  425 #endif /* _KERNEL */
  426 
  427 /*
  428  * Mods for extensibility.
  429  */
  430 
  431 /*
  432  * Flags for vdesc_flags:
  433  */
  434 #define VDESC_MAX_VPS           16
  435 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
  436 #define VDESC_VP0_WILLRELE      0x0001
  437 #define VDESC_VP1_WILLRELE      0x0002
  438 #define VDESC_VP2_WILLRELE      0x0004
  439 #define VDESC_VP3_WILLRELE      0x0008
  440 #define VDESC_NOMAP_VPP         0x0100
  441 #define VDESC_VPP_WILLRELE      0x0200
  442 
  443 /*
  444  * A generic structure.
  445  * This can be used by bypass routines to identify generic arguments.
  446  */
  447 struct vop_generic_args {
  448         struct vnodeop_desc *a_desc;
  449         /* other random data follows, presumably */
  450 };
  451 
  452 typedef int vop_bypass_t(struct vop_generic_args *);
  453 
  454 /*
  455  * VDESC_NO_OFFSET is used to identify the end of the offset list
  456  * and in places where no such field exists.
  457  */
  458 #define VDESC_NO_OFFSET -1
  459 
  460 /*
  461  * This structure describes the vnode operation taking place.
  462  */
  463 struct vnodeop_desc {
  464         char    *vdesc_name;            /* a readable name for debugging */
  465         int      vdesc_flags;           /* VDESC_* flags */
  466         vop_bypass_t    *vdesc_call;    /* Function to call */
  467 
  468         /*
  469          * These ops are used by bypass routines to map and locate arguments.
  470          * Creds and procs are not needed in bypass routines, but sometimes
  471          * they are useful to (for example) transport layers.
  472          * Nameidata is useful because it has a cred in it.
  473          */
  474         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
  475         int     vdesc_vpp_offset;       /* return vpp location */
  476         int     vdesc_cred_offset;      /* cred location, if any */
  477         int     vdesc_thread_offset;    /* thread location, if any */
  478         int     vdesc_componentname_offset; /* if any */
  479 };
  480 
  481 #ifdef _KERNEL
  482 /*
  483  * A list of all the operation descs.
  484  */
  485 extern struct vnodeop_desc *vnodeop_descs[];
  486 
  487 #define VOPARG_OFFSETOF(s_type, field)  __offsetof(s_type, field)
  488 #define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
  489     ((s_type)(((char*)(struct_p)) + (s_offset)))
  490 
  491 
  492 #ifdef DEBUG_VFS_LOCKS
  493 /*
  494  * Support code to aid in debugging VFS locking problems.  Not totally
  495  * reliable since if the thread sleeps between changing the lock
  496  * state and checking it with the assert, some other thread could
  497  * change the state.  They are good enough for debugging a single
  498  * filesystem using a single-threaded test.
  499  */
  500 void    assert_vi_locked(struct vnode *vp, const char *str);
  501 void    assert_vi_unlocked(struct vnode *vp, const char *str);
  502 void    assert_vop_elocked(struct vnode *vp, const char *str);
  503 #if 0
  504 void    assert_vop_elocked_other(struct vnode *vp, const char *str);
  505 #endif
  506 void    assert_vop_locked(struct vnode *vp, const char *str);
  507 #if 0
  508 voi0    assert_vop_slocked(struct vnode *vp, const char *str);
  509 #endif
  510 void    assert_vop_unlocked(struct vnode *vp, const char *str);
  511 
  512 #define ASSERT_VI_LOCKED(vp, str)       assert_vi_locked((vp), (str))
  513 #define ASSERT_VI_UNLOCKED(vp, str)     assert_vi_unlocked((vp), (str))
  514 #define ASSERT_VOP_ELOCKED(vp, str)     assert_vop_elocked((vp), (str))
  515 #if 0
  516 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
  517 #endif
  518 #define ASSERT_VOP_LOCKED(vp, str)      assert_vop_locked((vp), (str))
  519 #if 0
  520 #define ASSERT_VOP_SLOCKED(vp, str)     assert_vop_slocked((vp), (str))
  521 #endif
  522 #define ASSERT_VOP_UNLOCKED(vp, str)    assert_vop_unlocked((vp), (str))
  523 
  524 #else /* !DEBUG_VFS_LOCKS */
  525 
  526 #define ASSERT_VI_LOCKED(vp, str)       ((void)0)
  527 #define ASSERT_VI_UNLOCKED(vp, str)     ((void)0)
  528 #define ASSERT_VOP_ELOCKED(vp, str)     ((void)0)
  529 #if 0
  530 #define ASSERT_VOP_ELOCKED_OTHER(vp, str)
  531 #endif
  532 #define ASSERT_VOP_LOCKED(vp, str)      ((void)0)
  533 #if 0
  534 #define ASSERT_VOP_SLOCKED(vp, str)
  535 #endif
  536 #define ASSERT_VOP_UNLOCKED(vp, str)    ((void)0)
  537 #endif /* DEBUG_VFS_LOCKS */
  538 
  539 
  540 /*
  541  * This call works for vnodes in the kernel.
  542  */
  543 #define VCALL(c) ((c)->a_desc->vdesc_call(c))
  544 
  545 #define DOINGASYNC(vp)                                          \
  546         (((vp)->v_mount->mnt_kern_flag & MNTK_ASYNC) != 0 &&    \
  547          ((curthread->td_pflags & TDP_SYNCIO) == 0))
  548 
  549 /*
  550  * VMIO support inline
  551  */
  552 
  553 extern int vmiodirenable;
  554 
  555 static __inline int
  556 vn_canvmio(struct vnode *vp)
  557 {
  558       if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
  559                 return(TRUE);
  560         return(FALSE);
  561 }
  562 
  563 /*
  564  * Finally, include the default set of vnode operations.
  565  */
  566 #include "vnode_if.h"
  567 
  568 /* vn_open_flags */
  569 #define VN_OPEN_NOAUDIT         0x00000001
  570 
  571 /*
  572  * Public vnode manipulation functions.
  573  */
  574 struct componentname;
  575 struct file;
  576 struct mount;
  577 struct nameidata;
  578 struct ostat;
  579 struct thread;
  580 struct proc;
  581 struct stat;
  582 struct nstat;
  583 struct ucred;
  584 struct uio;
  585 struct vattr;
  586 struct vnode;
  587 
  588 /* cache_* may belong in namei.h. */
  589 #define cache_enter(dvp, vp, cnp)                                       \
  590         cache_enter_time(dvp, vp, cnp, NULL, NULL)
  591 void    cache_enter_time(struct vnode *dvp, struct vnode *vp,
  592             struct componentname *cnp, struct timespec *tsp,
  593             struct timespec *dtsp);
  594 #define cache_lookup(dvp, vpp, cnp)                                     \
  595         cache_lookup_times(dvp, vpp, cnp, NULL, NULL)
  596 int     cache_lookup_times(struct vnode *dvp, struct vnode **vpp,
  597             struct componentname *cnp, struct timespec *tsp, int *ticksp);
  598 void    cache_purge(struct vnode *vp);
  599 void    cache_purge_negative(struct vnode *vp);
  600 void    cache_purgevfs(struct mount *mp);
  601 int     change_dir(struct vnode *vp, struct thread *td);
  602 int     change_root(struct vnode *vp, struct thread *td);
  603 void    cvtstat(struct stat *st, struct ostat *ost);
  604 void    cvtnstat(struct stat *sb, struct nstat *nsb);
  605 int     getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
  606             struct vnode **vpp);
  607 void    getnewvnode_reserve(u_int count);
  608 void    getnewvnode_drop_reserve(void);
  609 int     insmntque1(struct vnode *vp, struct mount *mp,
  610             void (*dtr)(struct vnode *, void *), void *dtr_arg);
  611 int     insmntque(struct vnode *vp, struct mount *mp);
  612 u_quad_t init_va_filerev(void);
  613 int     speedup_syncer(void);
  614 int     vn_vptocnp(struct vnode **vp, struct ucred *cred, char *buf,
  615             u_int *buflen);
  616 #define textvp_fullpath(p, rb, rfb) \
  617         vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
  618 int     vn_fullpath(struct thread *td, struct vnode *vn,
  619             char **retbuf, char **freebuf);
  620 int     vn_fullpath_global(struct thread *td, struct vnode *vn,
  621             char **retbuf, char **freebuf);
  622 int     vn_commname(struct vnode *vn, char *buf, u_int buflen);
  623 int     vaccess(enum vtype type, mode_t file_mode, uid_t file_uid,
  624             gid_t file_gid, accmode_t accmode, struct ucred *cred,
  625             int *privused);
  626 int     vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
  627             struct acl *aclp, accmode_t accmode, struct ucred *cred,
  628             int *privused);
  629 int     vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
  630             gid_t file_gid, struct acl *acl, accmode_t accmode,
  631             struct ucred *cred, int *privused);
  632 void    vattr_null(struct vattr *vap);
  633 int     vcount(struct vnode *vp);
  634 void    vdrop(struct vnode *);
  635 void    vdropl(struct vnode *);
  636 void    vdestroy(struct vnode *);
  637 int     vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
  638 int     vget(struct vnode *vp, int lockflag, struct thread *td);
  639 void    vgone(struct vnode *vp);
  640 void    vhold(struct vnode *);
  641 void    vholdl(struct vnode *);
  642 void    vinactive(struct vnode *, struct thread *);
  643 int     vinvalbuf(struct vnode *vp, int save, int slpflag, int slptimeo);
  644 int     vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
  645             off_t length, int blksize);
  646 void    vunref(struct vnode *);
  647 void    vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3);
  648 #define vprint(label, vp) vn_printf((vp), "%s\n", (label))
  649 int     vrecycle(struct vnode *vp, struct thread *td);
  650 int     vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off,
  651             struct ucred *cred);
  652 int     vn_close(struct vnode *vp,
  653             int flags, struct ucred *file_cred, struct thread *td);
  654 void    vn_finished_write(struct mount *mp);
  655 void    vn_finished_secondary_write(struct mount *mp);
  656 int     vn_isdisk(struct vnode *vp, int *errp);
  657 int     _vn_lock(struct vnode *vp, int flags, char *file, int line);
  658 #define vn_lock(vp, flags) _vn_lock(vp, flags, __FILE__, __LINE__)
  659 int     vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp);
  660 int     vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
  661             u_int vn_open_flags, struct ucred *cred, struct file *fp);
  662 void    vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end);
  663 int     vn_pollrecord(struct vnode *vp, struct thread *p, int events);
  664 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base,
  665             int len, off_t offset, enum uio_seg segflg, int ioflg,
  666             struct ucred *active_cred, struct ucred *file_cred, int *aresid,
  667             struct thread *td);
  668 int     vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base,
  669             size_t len, off_t offset, enum uio_seg segflg, int ioflg,
  670             struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
  671             struct thread *td);
  672 int     vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
  673             struct ucred *file_cred, struct thread *td);
  674 int     vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
  675 int     vn_start_secondary_write(struct vnode *vp, struct mount **mpp,
  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     vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags,
  685             struct vnode **rvp);
  686 
  687 int     vfs_cache_lookup(struct vop_lookup_args *ap);
  688 void    vfs_timestamp(struct timespec *);
  689 void    vfs_write_resume(struct mount *mp);
  690 int     vfs_write_suspend(struct mount *mp);
  691 int     vop_stdbmap(struct vop_bmap_args *);
  692 int     vop_stdfsync(struct vop_fsync_args *);
  693 int     vop_stdgetwritemount(struct vop_getwritemount_args *);
  694 int     vop_stdgetpages(struct vop_getpages_args *);
  695 int     vop_stdinactive(struct vop_inactive_args *);
  696 int     vop_stdislocked(struct vop_islocked_args *);
  697 int     vop_stdkqfilter(struct vop_kqfilter_args *);
  698 int     vop_stdlock(struct vop_lock1_args *);
  699 int     vop_stdputpages(struct vop_putpages_args *);
  700 int     vop_stdunlock(struct vop_unlock_args *);
  701 int     vop_nopoll(struct vop_poll_args *);
  702 int     vop_stdaccess(struct vop_access_args *ap);
  703 int     vop_stdaccessx(struct vop_accessx_args *ap);
  704 int     vop_stdadvise(struct vop_advise_args *ap);
  705 int     vop_stdadvlock(struct vop_advlock_args *ap);
  706 int     vop_stdadvlockasync(struct vop_advlockasync_args *ap);
  707 int     vop_stdallocate(struct vop_allocate_args *ap);
  708 int     vop_stdpathconf(struct vop_pathconf_args *);
  709 int     vop_stdpoll(struct vop_poll_args *);
  710 int     vop_stdvptocnp(struct vop_vptocnp_args *ap);
  711 int     vop_stdvptofh(struct vop_vptofh_args *ap);
  712 int     vop_eopnotsupp(struct vop_generic_args *ap);
  713 int     vop_ebadf(struct vop_generic_args *ap);
  714 int     vop_einval(struct vop_generic_args *ap);
  715 int     vop_enoent(struct vop_generic_args *ap);
  716 int     vop_enotty(struct vop_generic_args *ap);
  717 int     vop_null(struct vop_generic_args *ap);
  718 int     vop_panic(struct vop_generic_args *ap);
  719 
  720 /* These are called from within the actual VOPS. */
  721 void    vop_create_post(void *a, int rc);
  722 void    vop_deleteextattr_post(void *a, int rc);
  723 void    vop_link_post(void *a, int rc);
  724 void    vop_lock_pre(void *a);
  725 void    vop_lock_post(void *a, int rc);
  726 void    vop_lookup_post(void *a, int rc);
  727 void    vop_lookup_pre(void *a);
  728 void    vop_mkdir_post(void *a, int rc);
  729 void    vop_mknod_post(void *a, int rc);
  730 void    vop_remove_post(void *a, int rc);
  731 void    vop_rename_post(void *a, int rc);
  732 void    vop_rename_pre(void *a);
  733 void    vop_rmdir_post(void *a, int rc);
  734 void    vop_setattr_post(void *a, int rc);
  735 void    vop_setextattr_post(void *a, int rc);
  736 void    vop_strategy_pre(void *a);
  737 void    vop_symlink_post(void *a, int rc);
  738 void    vop_unlock_post(void *a, int rc);
  739 void    vop_unlock_pre(void *a);
  740 
  741 void    vop_rename_fail(struct vop_rename_args *ap);
  742 
  743 #define VOP_WRITE_PRE(ap)                                               \
  744         struct vattr va;                                                \
  745         int error, osize, ooffset, noffset;                             \
  746                                                                         \
  747         osize = ooffset = noffset = 0;                                  \
  748         if (!VN_KNLIST_EMPTY((ap)->a_vp)) {                             \
  749                 error = VOP_GETATTR((ap)->a_vp, &va, (ap)->a_cred);     \
  750                 if (error)                                              \
  751                         return (error);                                 \
  752                 ooffset = (ap)->a_uio->uio_offset;                      \
  753                 osize = va.va_size;                                     \
  754         }
  755 
  756 #define VOP_WRITE_POST(ap, ret)                                         \
  757         noffset = (ap)->a_uio->uio_offset;                              \
  758         if (noffset > ooffset && !VN_KNLIST_EMPTY((ap)->a_vp)) {        \
  759                 VFS_KNOTE_LOCKED((ap)->a_vp, NOTE_WRITE                 \
  760                     | (noffset > osize ? NOTE_EXTEND : 0));             \
  761         }
  762 
  763 #define VOP_LOCK(vp, flags) VOP_LOCK1(vp, flags, __FILE__, __LINE__)
  764 
  765 
  766 void    vput(struct vnode *vp);
  767 void    vrele(struct vnode *vp);
  768 void    vref(struct vnode *vp);
  769 int     vrefcnt(struct vnode *vp);
  770 void    v_addpollinfo(struct vnode *vp);
  771 
  772 int vnode_create_vobject(struct vnode *vp, off_t size, struct thread *td);
  773 void vnode_destroy_vobject(struct vnode *vp);
  774 
  775 extern struct vop_vector fifo_specops;
  776 extern struct vop_vector dead_vnodeops;
  777 extern struct vop_vector default_vnodeops;
  778 
  779 #define VOP_PANIC       ((void*)(uintptr_t)vop_panic)
  780 #define VOP_NULL        ((void*)(uintptr_t)vop_null)
  781 #define VOP_EBADF       ((void*)(uintptr_t)vop_ebadf)
  782 #define VOP_ENOTTY      ((void*)(uintptr_t)vop_enotty)
  783 #define VOP_EINVAL      ((void*)(uintptr_t)vop_einval)
  784 #define VOP_ENOENT      ((void*)(uintptr_t)vop_enoent)
  785 #define VOP_EOPNOTSUPP  ((void*)(uintptr_t)vop_eopnotsupp)
  786 
  787 /* vfs_hash.c */
  788 typedef int vfs_hash_cmp_t(struct vnode *vp, void *arg);
  789 
  790 int vfs_hash_get(const struct mount *mp, u_int hash, int flags, struct thread *td, struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
  791 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);
  792 void vfs_hash_rehash(struct vnode *vp, u_int hash);
  793 void vfs_hash_remove(struct vnode *vp);
  794 
  795 int vfs_kqfilter(struct vop_kqfilter_args *);
  796 void vfs_mark_atime(struct vnode *vp, struct ucred *cred);
  797 struct dirent;
  798 int vfs_read_dirent(struct vop_readdir_args *ap, struct dirent *dp, off_t off);
  799 
  800 int     vfs_unixify_accmode(accmode_t *accmode);
  801 int     vn_rlimit_fsize(const struct vnode *vn, const struct uio *uio, const struct thread *td);
  802 
  803 #endif /* _KERNEL */
  804 
  805 #endif /* !_SYS_VNODE_H_ */

Cache object: afdcfc769b50135a904cb24f213d8b67


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