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

Cache object: b70fc32ff13e3e9ea231458901a73c50


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