899 lines
32 KiB
C
899 lines
32 KiB
C
/*-
|
|
* Copyright (c) 1989, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 4. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* @(#)vnode.h 8.7 (Berkeley) 2/4/94
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _SYS_VNODE_H_
|
|
#define _SYS_VNODE_H_
|
|
|
|
#include <sys/bufobj.h>
|
|
#include <sys/queue.h>
|
|
#include <sys/lock.h>
|
|
#include <sys/lockmgr.h>
|
|
#include <sys/mutex.h>
|
|
#include <sys/rangelock.h>
|
|
#include <sys/selinfo.h>
|
|
#include <sys/uio.h>
|
|
#include <sys/acl.h>
|
|
#include <sys/ktr.h>
|
|
|
|
/*
|
|
* The vnode is the focus of all file activity in UNIX. There is a
|
|
* unique vnode allocated for each active file, each current directory,
|
|
* each mounted-on file, text file, and the root.
|
|
*/
|
|
|
|
/*
|
|
* Vnode types. VNON means no type.
|
|
*/
|
|
enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD,
|
|
VMARKER };
|
|
|
|
/*
|
|
* Each underlying filesystem allocates its own private area and hangs
|
|
* it from v_data. If non-null, this area is freed in getnewvnode().
|
|
*/
|
|
|
|
struct namecache;
|
|
|
|
struct vpollinfo {
|
|
struct mtx vpi_lock; /* lock to protect below */
|
|
struct selinfo vpi_selinfo; /* identity of poller(s) */
|
|
short vpi_events; /* what they are looking for */
|
|
short vpi_revents; /* what has happened */
|
|
};
|
|
|
|
/*
|
|
* Reading or writing any of these items requires holding the appropriate lock.
|
|
*
|
|
* Lock reference:
|
|
* c - namecache mutex
|
|
* f - freelist mutex
|
|
* i - interlock
|
|
* I - updated with atomics, 0->1 and 1->0 transitions with interlock held
|
|
* m - mount point interlock
|
|
* p - pollinfo lock
|
|
* u - Only a reference to the vnode is needed to read.
|
|
* v - vnode lock
|
|
*
|
|
* Vnodes may be found on many lists. The general way to deal with operating
|
|
* on a vnode that is on a list is:
|
|
* 1) Lock the list and find the vnode.
|
|
* 2) Lock interlock so that the vnode does not go away.
|
|
* 3) Unlock the list to avoid lock order reversals.
|
|
* 4) vget with LK_INTERLOCK and check for ENOENT, or
|
|
* 5) Check for DOOMED if the vnode lock is not required.
|
|
* 6) Perform your operation, then vput().
|
|
*/
|
|
|
|
#if defined(_KERNEL) || defined(_KVM_VNODE)
|
|
|
|
struct vnode {
|
|
/*
|
|
* Fields which define the identity of the vnode. These fields are
|
|
* owned by the filesystem (XXX: and vgone() ?)
|
|
*/
|
|
const char *v_tag; /* u type of underlying data */
|
|
struct vop_vector *v_op; /* u vnode operations vector */
|
|
void *v_data; /* u private data for fs */
|
|
|
|
/*
|
|
* Filesystem instance stuff
|
|
*/
|
|
struct mount *v_mount; /* u ptr to vfs we are in */
|
|
TAILQ_ENTRY(vnode) v_nmntvnodes; /* m vnodes for mount point */
|
|
|
|
/*
|
|
* Type specific fields, only one applies to any given vnode.
|
|
* See #defines below for renaming to v_* namespace.
|
|
*/
|
|
union {
|
|
struct mount *vu_mount; /* v ptr to mountpoint (VDIR) */
|
|
struct socket *vu_socket; /* v unix domain net (VSOCK) */
|
|
struct cdev *vu_cdev; /* v device (VCHR, VBLK) */
|
|
struct fifoinfo *vu_fifoinfo; /* v fifo (VFIFO) */
|
|
} v_un;
|
|
|
|
/*
|
|
* vfs_hash: (mount + inode) -> vnode hash. The hash value
|
|
* itself is grouped with other int fields, to avoid padding.
|
|
*/
|
|
LIST_ENTRY(vnode) v_hashlist;
|
|
|
|
/*
|
|
* VFS_namecache stuff
|
|
*/
|
|
LIST_HEAD(, namecache) v_cache_src; /* c Cache entries from us */
|
|
TAILQ_HEAD(, namecache) v_cache_dst; /* c Cache entries to us */
|
|
struct namecache *v_cache_dd; /* c Cache entry for .. vnode */
|
|
|
|
/*
|
|
* Locking
|
|
*/
|
|
struct lock v_lock; /* u (if fs don't have one) */
|
|
struct mtx v_interlock; /* lock for "i" things */
|
|
struct lock *v_vnlock; /* u pointer to vnode lock */
|
|
|
|
/*
|
|
* The machinery of being a vnode
|
|
*/
|
|
TAILQ_ENTRY(vnode) v_actfreelist; /* f vnode active/free lists */
|
|
struct bufobj v_bufobj; /* * Buffer cache object */
|
|
|
|
/*
|
|
* Hooks for various subsystems and features.
|
|
*/
|
|
struct vpollinfo *v_pollinfo; /* i Poll events, p for *v_pi */
|
|
struct label *v_label; /* MAC label for vnode */
|
|
struct lockf *v_lockf; /* Byte-level advisory lock list */
|
|
struct rangelock v_rl; /* Byte-range lock */
|
|
|
|
/*
|
|
* clustering stuff
|
|
*/
|
|
daddr_t v_cstart; /* v start block of cluster */
|
|
daddr_t v_lasta; /* v last allocation */
|
|
daddr_t v_lastw; /* v last write */
|
|
int v_clen; /* v length of cur. cluster */
|
|
|
|
u_int v_holdcnt; /* I prevents recycling. */
|
|
u_int v_usecount; /* I ref count of users */
|
|
u_int v_iflag; /* i vnode flags (see below) */
|
|
u_int v_vflag; /* v vnode flags */
|
|
int v_writecount; /* v ref count of writers */
|
|
u_int v_hash;
|
|
enum vtype v_type; /* u vnode type */
|
|
};
|
|
|
|
#endif /* defined(_KERNEL) || defined(_KVM_VNODE) */
|
|
|
|
#define v_mountedhere v_un.vu_mount
|
|
#define v_socket v_un.vu_socket
|
|
#define v_rdev v_un.vu_cdev
|
|
#define v_fifoinfo v_un.vu_fifoinfo
|
|
|
|
/* XXX: These are temporary to avoid a source sweep at this time */
|
|
#define v_object v_bufobj.bo_object
|
|
|
|
/*
|
|
* Userland version of struct vnode, for sysctl.
|
|
*/
|
|
struct xvnode {
|
|
size_t xv_size; /* sizeof(struct xvnode) */
|
|
void *xv_vnode; /* address of real vnode */
|
|
u_long xv_flag; /* vnode vflags */
|
|
int xv_usecount; /* reference count of users */
|
|
int xv_writecount; /* reference count of writers */
|
|
int xv_holdcnt; /* page & buffer references */
|
|
u_long xv_id; /* capability identifier */
|
|
void *xv_mount; /* address of parent mount */
|
|
long xv_numoutput; /* num of writes in progress */
|
|
enum vtype xv_type; /* vnode type */
|
|
union {
|
|
void *xvu_socket; /* socket, if VSOCK */
|
|
void *xvu_fifo; /* fifo, if VFIFO */
|
|
dev_t xvu_rdev; /* maj/min, if VBLK/VCHR */
|
|
struct {
|
|
dev_t xvu_dev; /* device, if VDIR/VREG/VLNK */
|
|
ino_t xvu_ino; /* id, if VDIR/VREG/VLNK */
|
|
} xv_uns;
|
|
} xv_un;
|
|
};
|
|
#define xv_socket xv_un.xvu_socket
|
|
#define xv_fifo xv_un.xvu_fifo
|
|
#define xv_rdev xv_un.xvu_rdev
|
|
#define xv_dev xv_un.xv_uns.xvu_dev
|
|
#define xv_ino xv_un.xv_uns.xvu_ino
|
|
|
|
/* We don't need to lock the knlist */
|
|
#define VN_KNLIST_EMPTY(vp) ((vp)->v_pollinfo == NULL || \
|
|
KNLIST_EMPTY(&(vp)->v_pollinfo->vpi_selinfo.si_note))
|
|
|
|
#define VN_KNOTE(vp, b, a) \
|
|
do { \
|
|
if (!VN_KNLIST_EMPTY(vp)) \
|
|
KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), \
|
|
(a) | KNF_NOKQLOCK); \
|
|
} while (0)
|
|
#define VN_KNOTE_LOCKED(vp, b) VN_KNOTE(vp, b, KNF_LISTLOCKED)
|
|
#define VN_KNOTE_UNLOCKED(vp, b) VN_KNOTE(vp, b, 0)
|
|
|
|
/*
|
|
* Vnode flags.
|
|
* VI flags are protected by interlock and live in v_iflag
|
|
* VV flags are protected by the vnode lock and live in v_vflag
|
|
*
|
|
* VI_DOOMED is doubly protected by the interlock and vnode lock. Both
|
|
* are required for writing but the status may be checked with either.
|
|
*/
|
|
#define VI_MOUNT 0x0020 /* Mount in progress */
|
|
#define VI_DOOMED 0x0080 /* This vnode is being recycled */
|
|
#define VI_FREE 0x0100 /* This vnode is on the freelist */
|
|
#define VI_ACTIVE 0x0200 /* This vnode is on the active list */
|
|
#define VI_DOINGINACT 0x0800 /* VOP_INACTIVE is in progress */
|
|
#define VI_OWEINACT 0x1000 /* Need to call inactive */
|
|
|
|
#define VV_ROOT 0x0001 /* root of its filesystem */
|
|
#define VV_ISTTY 0x0002 /* vnode represents a tty */
|
|
#define VV_NOSYNC 0x0004 /* unlinked, stop syncing */
|
|
#define VV_ETERNALDEV 0x0008 /* device that is never destroyed */
|
|
#define VV_CACHEDLABEL 0x0010 /* Vnode has valid cached MAC label */
|
|
#define VV_TEXT 0x0020 /* vnode is a pure text prototype */
|
|
#define VV_COPYONWRITE 0x0040 /* vnode is doing copy-on-write */
|
|
#define VV_SYSTEM 0x0080 /* vnode being used by kernel */
|
|
#define VV_PROCDEP 0x0100 /* vnode is process dependent */
|
|
#define VV_NOKNOTE 0x0200 /* don't activate knotes on this vnode */
|
|
#define VV_DELETED 0x0400 /* should be removed */
|
|
#define VV_MD 0x0800 /* vnode backs the md device */
|
|
#define VV_FORCEINSMQ 0x1000 /* force the insmntque to succeed */
|
|
|
|
/*
|
|
* Vnode attributes. A field value of VNOVAL represents a field whose value
|
|
* is unavailable (getattr) or which is not to be changed (setattr).
|
|
*/
|
|
struct vattr {
|
|
enum vtype va_type; /* vnode type (for create) */
|
|
u_short va_mode; /* files access mode and type */
|
|
short va_nlink; /* number of references to file */
|
|
uid_t va_uid; /* owner user id */
|
|
gid_t va_gid; /* owner group id */
|
|
dev_t va_fsid; /* filesystem id */
|
|
long va_fileid; /* file id */
|
|
u_quad_t va_size; /* file size in bytes */
|
|
long va_blocksize; /* blocksize preferred for i/o */
|
|
struct timespec va_atime; /* time of last access */
|
|
struct timespec va_mtime; /* time of last modification */
|
|
struct timespec va_ctime; /* time file changed */
|
|
struct timespec va_birthtime; /* time file created */
|
|
u_long va_gen; /* generation number of file */
|
|
u_long va_flags; /* flags defined for file */
|
|
dev_t va_rdev; /* device the special file represents */
|
|
u_quad_t va_bytes; /* bytes of disk space held by file */
|
|
u_quad_t va_filerev; /* file modification number */
|
|
u_int va_vaflags; /* operations flags, see below */
|
|
long va_spare; /* remain quad aligned */
|
|
};
|
|
|
|
/*
|
|
* Flags for va_vaflags.
|
|
*/
|
|
#define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */
|
|
#define VA_EXCLUSIVE 0x02 /* exclusive create request */
|
|
#define VA_SYNC 0x04 /* O_SYNC truncation */
|
|
|
|
/*
|
|
* Flags for ioflag. (high 16 bits used to ask for read-ahead and
|
|
* help with write clustering)
|
|
* NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h
|
|
*/
|
|
#define IO_UNIT 0x0001 /* do I/O as atomic unit */
|
|
#define IO_APPEND 0x0002 /* append write to end */
|
|
#define IO_NDELAY 0x0004 /* FNDELAY flag set in file table */
|
|
#define IO_NODELOCKED 0x0008 /* underlying node already locked */
|
|
#define IO_ASYNC 0x0010 /* bawrite rather then bdwrite */
|
|
#define IO_VMIO 0x0020 /* data already in VMIO space */
|
|
#define IO_INVAL 0x0040 /* invalidate after I/O */
|
|
#define IO_SYNC 0x0080 /* do I/O synchronously */
|
|
#define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */
|
|
#define IO_EXT 0x0400 /* operate on external attributes */
|
|
#define IO_NORMAL 0x0800 /* operate on regular data */
|
|
#define IO_NOMACCHECK 0x1000 /* MAC checks unnecessary */
|
|
#define IO_BUFLOCKED 0x2000 /* ffs flag; indir buf is locked */
|
|
#define IO_RANGELOCKED 0x4000 /* range locked */
|
|
|
|
#define IO_SEQMAX 0x7F /* seq heuristic max value */
|
|
#define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */
|
|
|
|
/*
|
|
* Flags for accmode_t.
|
|
*/
|
|
#define VEXEC 000000000100 /* execute/search permission */
|
|
#define VWRITE 000000000200 /* write permission */
|
|
#define VREAD 000000000400 /* read permission */
|
|
#define VADMIN 000000010000 /* being the file owner */
|
|
#define VAPPEND 000000040000 /* permission to write/append */
|
|
/*
|
|
* VEXPLICIT_DENY makes VOP_ACCESSX(9) return EPERM or EACCES only
|
|
* if permission was denied explicitly, by a "deny" rule in NFSv4 ACL,
|
|
* and 0 otherwise. This never happens with ordinary unix access rights
|
|
* or POSIX.1e ACLs. Obviously, VEXPLICIT_DENY must be OR-ed with
|
|
* some other V* constant.
|
|
*/
|
|
#define VEXPLICIT_DENY 000000100000
|
|
#define VREAD_NAMED_ATTRS 000000200000 /* not used */
|
|
#define VWRITE_NAMED_ATTRS 000000400000 /* not used */
|
|
#define VDELETE_CHILD 000001000000
|
|
#define VREAD_ATTRIBUTES 000002000000 /* permission to stat(2) */
|
|
#define VWRITE_ATTRIBUTES 000004000000 /* change {m,c,a}time */
|
|
#define VDELETE 000010000000
|
|
#define VREAD_ACL 000020000000 /* read ACL and file mode */
|
|
#define VWRITE_ACL 000040000000 /* change ACL and/or file mode */
|
|
#define VWRITE_OWNER 000100000000 /* change file owner */
|
|
#define VSYNCHRONIZE 000200000000 /* not used */
|
|
#define VCREAT 000400000000 /* creating new file */
|
|
#define VVERIFY 001000000000 /* verification required */
|
|
|
|
/*
|
|
* Permissions that were traditionally granted only to the file owner.
|
|
*/
|
|
#define VADMIN_PERMS (VADMIN | VWRITE_ATTRIBUTES | VWRITE_ACL | \
|
|
VWRITE_OWNER)
|
|
|
|
/*
|
|
* Permissions that were traditionally granted to everyone.
|
|
*/
|
|
#define VSTAT_PERMS (VREAD_ATTRIBUTES | VREAD_ACL)
|
|
|
|
/*
|
|
* Permissions that allow to change the state of the file in any way.
|
|
*/
|
|
#define VMODIFY_PERMS (VWRITE | VAPPEND | VADMIN_PERMS | VDELETE_CHILD | \
|
|
VDELETE)
|
|
|
|
/*
|
|
* Token indicating no attribute value yet assigned.
|
|
*/
|
|
#define VNOVAL (-1)
|
|
|
|
/*
|
|
* LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
|
|
*/
|
|
#define VLKTIMEOUT (hz / 20 + 1)
|
|
|
|
#ifdef _KERNEL
|
|
|
|
#ifdef MALLOC_DECLARE
|
|
MALLOC_DECLARE(M_VNODE);
|
|
#endif
|
|
|
|
extern u_int ncsizefactor;
|
|
|
|
/*
|
|
* Convert between vnode types and inode formats (since POSIX.1
|
|
* defines mode word of stat structure in terms of inode formats).
|
|
*/
|
|
extern enum vtype iftovt_tab[];
|
|
extern int vttoif_tab[];
|
|
#define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12])
|
|
#define VTTOIF(indx) (vttoif_tab[(int)(indx)])
|
|
#define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode))
|
|
|
|
/*
|
|
* Flags to various vnode functions.
|
|
*/
|
|
#define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */
|
|
#define FORCECLOSE 0x0002 /* vflush: force file closure */
|
|
#define WRITECLOSE 0x0004 /* vflush: only close writable files */
|
|
#define EARLYFLUSH 0x0008 /* vflush: early call for ffs_flushfiles */
|
|
#define V_SAVE 0x0001 /* vinvalbuf: sync file first */
|
|
#define V_ALT 0x0002 /* vinvalbuf: invalidate only alternate bufs */
|
|
#define V_NORMAL 0x0004 /* vinvalbuf: invalidate only regular bufs */
|
|
#define V_CLEANONLY 0x0008 /* vinvalbuf: invalidate only clean bufs */
|
|
#define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */
|
|
#define V_WAIT 0x0001 /* vn_start_write: sleep for suspend */
|
|
#define V_NOWAIT 0x0002 /* vn_start_write: don't sleep for suspend */
|
|
#define V_XSLEEP 0x0004 /* vn_start_write: just return after sleep */
|
|
#define V_MNTREF 0x0010 /* vn_start_write: mp is already ref-ed */
|
|
|
|
#define VR_START_WRITE 0x0001 /* vfs_write_resume: start write atomically */
|
|
#define VR_NO_SUSPCLR 0x0002 /* vfs_write_resume: do not clear suspension */
|
|
|
|
#define VS_SKIP_UNMOUNT 0x0001 /* vfs_write_suspend: fail if the
|
|
filesystem is being unmounted */
|
|
|
|
#define VREF(vp) vref(vp)
|
|
|
|
#ifdef DIAGNOSTIC
|
|
#define VATTR_NULL(vap) vattr_null(vap)
|
|
#else
|
|
#define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
|
|
#endif /* DIAGNOSTIC */
|
|
|
|
#define NULLVP ((struct vnode *)NULL)
|
|
|
|
/*
|
|
* Global vnode data.
|
|
*/
|
|
extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
|
|
extern struct mount *rootdevmp; /* "/dev" mount */
|
|
extern int desiredvnodes; /* number of vnodes desired */
|
|
extern struct uma_zone *namei_zone;
|
|
extern struct vattr va_null; /* predefined null vattr structure */
|
|
|
|
#define VI_LOCK(vp) mtx_lock(&(vp)->v_interlock)
|
|
#define VI_LOCK_FLAGS(vp, flags) mtx_lock_flags(&(vp)->v_interlock, (flags))
|
|
#define VI_TRYLOCK(vp) mtx_trylock(&(vp)->v_interlock)
|
|
#define VI_UNLOCK(vp) mtx_unlock(&(vp)->v_interlock)
|
|
#define VI_MTX(vp) (&(vp)->v_interlock)
|
|
|
|
#define VN_LOCK_AREC(vp) lockallowrecurse((vp)->v_vnlock)
|
|
#define VN_LOCK_ASHARE(vp) lockallowshare((vp)->v_vnlock)
|
|
#define VN_LOCK_DSHARE(vp) lockdisableshare((vp)->v_vnlock)
|
|
|
|
#endif /* _KERNEL */
|
|
|
|
/*
|
|
* Mods for extensibility.
|
|
*/
|
|
|
|
/*
|
|
* Flags for vdesc_flags:
|
|
*/
|
|
#define VDESC_MAX_VPS 16
|
|
/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
|
|
#define VDESC_VP0_WILLRELE 0x0001
|
|
#define VDESC_VP1_WILLRELE 0x0002
|
|
#define VDESC_VP2_WILLRELE 0x0004
|
|
#define VDESC_VP3_WILLRELE 0x0008
|
|
#define VDESC_NOMAP_VPP 0x0100
|
|
#define VDESC_VPP_WILLRELE 0x0200
|
|
|
|
/*
|
|
* A generic structure.
|
|
* This can be used by bypass routines to identify generic arguments.
|
|
*/
|
|
struct vop_generic_args {
|
|
struct vnodeop_desc *a_desc;
|
|
/* other random data follows, presumably */
|
|
};
|
|
|
|
typedef int vop_bypass_t(struct vop_generic_args *);
|
|
|
|
/*
|
|
* VDESC_NO_OFFSET is used to identify the end of the offset list
|
|
* and in places where no such field exists.
|
|
*/
|
|
#define VDESC_NO_OFFSET -1
|
|
|
|
/*
|
|
* This structure describes the vnode operation taking place.
|
|
*/
|
|
struct vnodeop_desc {
|
|
char *vdesc_name; /* a readable name for debugging */
|
|
int vdesc_flags; /* VDESC_* flags */
|
|
vop_bypass_t *vdesc_call; /* Function to call */
|
|
|
|
/*
|
|
* These ops are used by bypass routines to map and locate arguments.
|
|
* Creds and procs are not needed in bypass routines, but sometimes
|
|
* they are useful to (for example) transport layers.
|
|
* Nameidata is useful because it has a cred in it.
|
|
*/
|
|
int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */
|
|
int vdesc_vpp_offset; /* return vpp location */
|
|
int vdesc_cred_offset; /* cred location, if any */
|
|
int vdesc_thread_offset; /* thread location, if any */
|
|
int vdesc_componentname_offset; /* if any */
|
|
};
|
|
|
|
#ifdef _KERNEL
|
|
/*
|
|
* A list of all the operation descs.
|
|
*/
|
|
extern struct vnodeop_desc *vnodeop_descs[];
|
|
|
|
#define VOPARG_OFFSETOF(s_type, field) __offsetof(s_type, field)
|
|
#define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
|
|
((s_type)(((char*)(struct_p)) + (s_offset)))
|
|
|
|
|
|
#ifdef DEBUG_VFS_LOCKS
|
|
/*
|
|
* Support code to aid in debugging VFS locking problems. Not totally
|
|
* reliable since if the thread sleeps between changing the lock
|
|
* state and checking it with the assert, some other thread could
|
|
* change the state. They are good enough for debugging a single
|
|
* filesystem using a single-threaded test. Note that the unreliability is
|
|
* limited to false negatives; efforts were made to ensure that false
|
|
* positives cannot occur.
|
|
*/
|
|
void assert_vi_locked(struct vnode *vp, const char *str);
|
|
void assert_vi_unlocked(struct vnode *vp, const char *str);
|
|
void assert_vop_elocked(struct vnode *vp, const char *str);
|
|
#if 0
|
|
void assert_vop_elocked_other(struct vnode *vp, const char *str);
|
|
#endif
|
|
void assert_vop_locked(struct vnode *vp, const char *str);
|
|
#if 0
|
|
voi0 assert_vop_slocked(struct vnode *vp, const char *str);
|
|
#endif
|
|
void assert_vop_unlocked(struct vnode *vp, const char *str);
|
|
|
|
#define ASSERT_VI_LOCKED(vp, str) assert_vi_locked((vp), (str))
|
|
#define ASSERT_VI_UNLOCKED(vp, str) assert_vi_unlocked((vp), (str))
|
|
#define ASSERT_VOP_ELOCKED(vp, str) assert_vop_elocked((vp), (str))
|
|
#if 0
|
|
#define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
|
|
#endif
|
|
#define ASSERT_VOP_LOCKED(vp, str) assert_vop_locked((vp), (str))
|
|
#if 0
|
|
#define ASSERT_VOP_SLOCKED(vp, str) assert_vop_slocked((vp), (str))
|
|
#endif
|
|
#define ASSERT_VOP_UNLOCKED(vp, str) assert_vop_unlocked((vp), (str))
|
|
|
|
#else /* !DEBUG_VFS_LOCKS */
|
|
|
|
#define ASSERT_VI_LOCKED(vp, str) ((void)0)
|
|
#define ASSERT_VI_UNLOCKED(vp, str) ((void)0)
|
|
#define ASSERT_VOP_ELOCKED(vp, str) ((void)0)
|
|
#if 0
|
|
#define ASSERT_VOP_ELOCKED_OTHER(vp, str)
|
|
#endif
|
|
#define ASSERT_VOP_LOCKED(vp, str) ((void)0)
|
|
#if 0
|
|
#define ASSERT_VOP_SLOCKED(vp, str)
|
|
#endif
|
|
#define ASSERT_VOP_UNLOCKED(vp, str) ((void)0)
|
|
#endif /* DEBUG_VFS_LOCKS */
|
|
|
|
|
|
/*
|
|
* This call works for vnodes in the kernel.
|
|
*/
|
|
#define VCALL(c) ((c)->a_desc->vdesc_call(c))
|
|
|
|
#define DOINGASYNC(vp) \
|
|
(((vp)->v_mount->mnt_kern_flag & MNTK_ASYNC) != 0 && \
|
|
((curthread->td_pflags & TDP_SYNCIO) == 0))
|
|
|
|
/*
|
|
* VMIO support inline
|
|
*/
|
|
|
|
extern int vmiodirenable;
|
|
|
|
static __inline int
|
|
vn_canvmio(struct vnode *vp)
|
|
{
|
|
if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
|
|
return(TRUE);
|
|
return(FALSE);
|
|
}
|
|
|
|
/*
|
|
* Finally, include the default set of vnode operations.
|
|
*/
|
|
typedef void vop_getpages_iodone_t(void *, vm_page_t *, int, int);
|
|
#include "vnode_if.h"
|
|
|
|
/* vn_open_flags */
|
|
#define VN_OPEN_NOAUDIT 0x00000001
|
|
#define VN_OPEN_NOCAPCHECK 0x00000002
|
|
#define VN_OPEN_NAMECACHE 0x00000004
|
|
|
|
/*
|
|
* Public vnode manipulation functions.
|
|
*/
|
|
struct componentname;
|
|
struct file;
|
|
struct mount;
|
|
struct nameidata;
|
|
struct ostat;
|
|
struct thread;
|
|
struct proc;
|
|
struct stat;
|
|
struct nstat;
|
|
struct ucred;
|
|
struct uio;
|
|
struct vattr;
|
|
struct vfsops;
|
|
struct vnode;
|
|
|
|
typedef int (*vn_get_ino_t)(struct mount *, void *, int, struct vnode **);
|
|
|
|
int bnoreuselist(struct bufv *bufv, struct bufobj *bo, daddr_t startn,
|
|
daddr_t endn);
|
|
/* cache_* may belong in namei.h. */
|
|
void cache_changesize(int newhashsize);
|
|
#define cache_enter(dvp, vp, cnp) \
|
|
cache_enter_time(dvp, vp, cnp, NULL, NULL)
|
|
void cache_enter_time(struct vnode *dvp, struct vnode *vp,
|
|
struct componentname *cnp, struct timespec *tsp,
|
|
struct timespec *dtsp);
|
|
int cache_lookup(struct vnode *dvp, struct vnode **vpp,
|
|
struct componentname *cnp, struct timespec *tsp, int *ticksp);
|
|
void cache_purge(struct vnode *vp);
|
|
void cache_purge_negative(struct vnode *vp);
|
|
void cache_purgevfs(struct mount *mp);
|
|
int change_dir(struct vnode *vp, struct thread *td);
|
|
void cvtstat(struct stat *st, struct ostat *ost);
|
|
void cvtnstat(struct stat *sb, struct nstat *nsb);
|
|
int getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
|
|
struct vnode **vpp);
|
|
void getnewvnode_reserve(u_int count);
|
|
void getnewvnode_drop_reserve(void);
|
|
int insmntque1(struct vnode *vp, struct mount *mp,
|
|
void (*dtr)(struct vnode *, void *), void *dtr_arg);
|
|
int insmntque(struct vnode *vp, struct mount *mp);
|
|
u_quad_t init_va_filerev(void);
|
|
int speedup_syncer(void);
|
|
int vn_vptocnp(struct vnode **vp, struct ucred *cred, char *buf,
|
|
u_int *buflen);
|
|
#define textvp_fullpath(p, rb, rfb) \
|
|
vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
|
|
int vn_fullpath(struct thread *td, struct vnode *vn,
|
|
char **retbuf, char **freebuf);
|
|
int vn_fullpath_global(struct thread *td, struct vnode *vn,
|
|
char **retbuf, char **freebuf);
|
|
struct vnode *
|
|
vn_dir_dd_ino(struct vnode *vp);
|
|
int vn_commname(struct vnode *vn, char *buf, u_int buflen);
|
|
int vn_path_to_global_path(struct thread *td, struct vnode *vp,
|
|
char *path, u_int pathlen);
|
|
int vaccess(enum vtype type, mode_t file_mode, uid_t file_uid,
|
|
gid_t file_gid, accmode_t accmode, struct ucred *cred,
|
|
int *privused);
|
|
int vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
|
|
struct acl *aclp, accmode_t accmode, struct ucred *cred,
|
|
int *privused);
|
|
int vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
|
|
gid_t file_gid, struct acl *acl, accmode_t accmode,
|
|
struct ucred *cred, int *privused);
|
|
void vattr_null(struct vattr *vap);
|
|
int vcount(struct vnode *vp);
|
|
#define vdrop(vp) _vdrop((vp), 0)
|
|
#define vdropl(vp) _vdrop((vp), 1)
|
|
void _vdrop(struct vnode *, bool);
|
|
int vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
|
|
int vget(struct vnode *vp, int lockflag, struct thread *td);
|
|
void vgone(struct vnode *vp);
|
|
#define vhold(vp) _vhold((vp), 0)
|
|
#define vholdl(vp) _vhold((vp), 1)
|
|
void _vhold(struct vnode *, bool);
|
|
void vinactive(struct vnode *, struct thread *);
|
|
int vinvalbuf(struct vnode *vp, int save, int slpflag, int slptimeo);
|
|
int vtruncbuf(struct vnode *vp, struct ucred *cred, off_t length,
|
|
int blksize);
|
|
void vunref(struct vnode *);
|
|
void vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3);
|
|
#define vprint(label, vp) vn_printf((vp), "%s\n", (label))
|
|
int vrecycle(struct vnode *vp);
|
|
int vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off,
|
|
struct ucred *cred);
|
|
int vn_close(struct vnode *vp,
|
|
int flags, struct ucred *file_cred, struct thread *td);
|
|
void vn_finished_write(struct mount *mp);
|
|
void vn_finished_secondary_write(struct mount *mp);
|
|
int vn_isdisk(struct vnode *vp, int *errp);
|
|
int _vn_lock(struct vnode *vp, int flags, char *file, int line);
|
|
#define vn_lock(vp, flags) _vn_lock(vp, flags, __FILE__, __LINE__)
|
|
int vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp);
|
|
int vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
|
|
u_int vn_open_flags, struct ucred *cred, struct file *fp);
|
|
int vn_open_vnode(struct vnode *vp, int fmode, struct ucred *cred,
|
|
struct thread *td, struct file *fp);
|
|
void vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end);
|
|
int vn_pollrecord(struct vnode *vp, struct thread *p, int events);
|
|
int vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base,
|
|
int len, off_t offset, enum uio_seg segflg, int ioflg,
|
|
struct ucred *active_cred, struct ucred *file_cred, ssize_t *aresid,
|
|
struct thread *td);
|
|
int vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base,
|
|
size_t len, off_t offset, enum uio_seg segflg, int ioflg,
|
|
struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
|
|
struct thread *td);
|
|
int vn_rlimit_fsize(const struct vnode *vn, const struct uio *uio,
|
|
struct thread *td);
|
|
int vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
|
|
struct ucred *file_cred, struct thread *td);
|
|
int vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
|
|
int vn_start_secondary_write(struct vnode *vp, struct mount **mpp,
|
|
int flags);
|
|
int vn_writechk(struct vnode *vp);
|
|
int vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
|
|
const char *attrname, int *buflen, char *buf, struct thread *td);
|
|
int vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
|
|
const char *attrname, int buflen, char *buf, struct thread *td);
|
|
int vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
|
|
const char *attrname, struct thread *td);
|
|
int vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags,
|
|
struct vnode **rvp);
|
|
int vn_vget_ino_gen(struct vnode *vp, vn_get_ino_t alloc,
|
|
void *alloc_arg, int lkflags, struct vnode **rvp);
|
|
int vn_utimes_perm(struct vnode *vp, struct vattr *vap,
|
|
struct ucred *cred, struct thread *td);
|
|
|
|
int vn_io_fault_uiomove(char *data, int xfersize, struct uio *uio);
|
|
int vn_io_fault_pgmove(vm_page_t ma[], vm_offset_t offset, int xfersize,
|
|
struct uio *uio);
|
|
|
|
#define vn_rangelock_unlock(vp, cookie) \
|
|
rangelock_unlock(&(vp)->v_rl, (cookie), VI_MTX(vp))
|
|
#define vn_rangelock_unlock_range(vp, cookie, start, end) \
|
|
rangelock_unlock_range(&(vp)->v_rl, (cookie), (start), (end), \
|
|
VI_MTX(vp))
|
|
#define vn_rangelock_rlock(vp, start, end) \
|
|
rangelock_rlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
|
|
#define vn_rangelock_wlock(vp, start, end) \
|
|
rangelock_wlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
|
|
|
|
int vfs_cache_lookup(struct vop_lookup_args *ap);
|
|
void vfs_timestamp(struct timespec *);
|
|
void vfs_write_resume(struct mount *mp, int flags);
|
|
int vfs_write_suspend(struct mount *mp, int flags);
|
|
int vfs_write_suspend_umnt(struct mount *mp);
|
|
void vnlru_free(int, struct vfsops *);
|
|
int vop_stdbmap(struct vop_bmap_args *);
|
|
int vop_stdfsync(struct vop_fsync_args *);
|
|
int vop_stdgetwritemount(struct vop_getwritemount_args *);
|
|
int vop_stdgetpages(struct vop_getpages_args *);
|
|
int vop_stdinactive(struct vop_inactive_args *);
|
|
int vop_stdislocked(struct vop_islocked_args *);
|
|
int vop_stdkqfilter(struct vop_kqfilter_args *);
|
|
int vop_stdlock(struct vop_lock1_args *);
|
|
int vop_stdputpages(struct vop_putpages_args *);
|
|
int vop_stdunlock(struct vop_unlock_args *);
|
|
int vop_nopoll(struct vop_poll_args *);
|
|
int vop_stdaccess(struct vop_access_args *ap);
|
|
int vop_stdaccessx(struct vop_accessx_args *ap);
|
|
int vop_stdadvise(struct vop_advise_args *ap);
|
|
int vop_stdadvlock(struct vop_advlock_args *ap);
|
|
int vop_stdadvlockasync(struct vop_advlockasync_args *ap);
|
|
int vop_stdadvlockpurge(struct vop_advlockpurge_args *ap);
|
|
int vop_stdallocate(struct vop_allocate_args *ap);
|
|
int vop_stdpathconf(struct vop_pathconf_args *);
|
|
int vop_stdpoll(struct vop_poll_args *);
|
|
int vop_stdvptocnp(struct vop_vptocnp_args *ap);
|
|
int vop_stdvptofh(struct vop_vptofh_args *ap);
|
|
int vop_stdunp_bind(struct vop_unp_bind_args *ap);
|
|
int vop_stdunp_connect(struct vop_unp_connect_args *ap);
|
|
int vop_stdunp_detach(struct vop_unp_detach_args *ap);
|
|
int vop_eopnotsupp(struct vop_generic_args *ap);
|
|
int vop_ebadf(struct vop_generic_args *ap);
|
|
int vop_einval(struct vop_generic_args *ap);
|
|
int vop_enoent(struct vop_generic_args *ap);
|
|
int vop_enotty(struct vop_generic_args *ap);
|
|
int vop_null(struct vop_generic_args *ap);
|
|
int vop_panic(struct vop_generic_args *ap);
|
|
int dead_poll(struct vop_poll_args *ap);
|
|
int dead_read(struct vop_read_args *ap);
|
|
int dead_write(struct vop_write_args *ap);
|
|
|
|
/* These are called from within the actual VOPS. */
|
|
void vop_close_post(void *a, int rc);
|
|
void vop_create_post(void *a, int rc);
|
|
void vop_deleteextattr_post(void *a, int rc);
|
|
void vop_link_post(void *a, int rc);
|
|
void vop_lookup_post(void *a, int rc);
|
|
void vop_lookup_pre(void *a);
|
|
void vop_mkdir_post(void *a, int rc);
|
|
void vop_mknod_post(void *a, int rc);
|
|
void vop_open_post(void *a, int rc);
|
|
void vop_read_post(void *a, int rc);
|
|
void vop_readdir_post(void *a, int rc);
|
|
void vop_reclaim_post(void *a, int rc);
|
|
void vop_remove_post(void *a, int rc);
|
|
void vop_rename_post(void *a, int rc);
|
|
void vop_rename_pre(void *a);
|
|
void vop_rmdir_post(void *a, int rc);
|
|
void vop_setattr_post(void *a, int rc);
|
|
void vop_setextattr_post(void *a, int rc);
|
|
void vop_symlink_post(void *a, int rc);
|
|
|
|
#ifdef DEBUG_VFS_LOCKS
|
|
void vop_strategy_pre(void *a);
|
|
void vop_lock_pre(void *a);
|
|
void vop_lock_post(void *a, int rc);
|
|
void vop_unlock_post(void *a, int rc);
|
|
void vop_unlock_pre(void *a);
|
|
#else
|
|
#define vop_strategy_pre(x) do { } while (0)
|
|
#define vop_lock_pre(x) do { } while (0)
|
|
#define vop_lock_post(x, y) do { } while (0)
|
|
#define vop_unlock_post(x, y) do { } while (0)
|
|
#define vop_unlock_pre(x) do { } while (0)
|
|
#endif
|
|
|
|
void vop_rename_fail(struct vop_rename_args *ap);
|
|
|
|
#define VOP_WRITE_PRE(ap) \
|
|
struct vattr va; \
|
|
int error; \
|
|
off_t osize, ooffset, noffset; \
|
|
\
|
|
osize = ooffset = noffset = 0; \
|
|
if (!VN_KNLIST_EMPTY((ap)->a_vp)) { \
|
|
error = VOP_GETATTR((ap)->a_vp, &va, (ap)->a_cred); \
|
|
if (error) \
|
|
return (error); \
|
|
ooffset = (ap)->a_uio->uio_offset; \
|
|
osize = (off_t)va.va_size; \
|
|
}
|
|
|
|
#define VOP_WRITE_POST(ap, ret) \
|
|
noffset = (ap)->a_uio->uio_offset; \
|
|
if (noffset > ooffset && !VN_KNLIST_EMPTY((ap)->a_vp)) { \
|
|
VFS_KNOTE_LOCKED((ap)->a_vp, NOTE_WRITE \
|
|
| (noffset > osize ? NOTE_EXTEND : 0)); \
|
|
}
|
|
|
|
#define VOP_LOCK(vp, flags) VOP_LOCK1(vp, flags, __FILE__, __LINE__)
|
|
|
|
|
|
void vput(struct vnode *vp);
|
|
void vrele(struct vnode *vp);
|
|
void vref(struct vnode *vp);
|
|
void vrefl(struct vnode *vp);
|
|
int vrefcnt(struct vnode *vp);
|
|
void v_addpollinfo(struct vnode *vp);
|
|
|
|
int vnode_create_vobject(struct vnode *vp, off_t size, struct thread *td);
|
|
void vnode_destroy_vobject(struct vnode *vp);
|
|
|
|
extern struct vop_vector fifo_specops;
|
|
extern struct vop_vector dead_vnodeops;
|
|
extern struct vop_vector default_vnodeops;
|
|
|
|
#define VOP_PANIC ((void*)(uintptr_t)vop_panic)
|
|
#define VOP_NULL ((void*)(uintptr_t)vop_null)
|
|
#define VOP_EBADF ((void*)(uintptr_t)vop_ebadf)
|
|
#define VOP_ENOTTY ((void*)(uintptr_t)vop_enotty)
|
|
#define VOP_EINVAL ((void*)(uintptr_t)vop_einval)
|
|
#define VOP_ENOENT ((void*)(uintptr_t)vop_enoent)
|
|
#define VOP_EOPNOTSUPP ((void*)(uintptr_t)vop_eopnotsupp)
|
|
|
|
/* fifo_vnops.c */
|
|
int fifo_printinfo(struct vnode *);
|
|
|
|
/* vfs_hash.c */
|
|
typedef int vfs_hash_cmp_t(struct vnode *vp, void *arg);
|
|
|
|
void vfs_hash_changesize(int newhashsize);
|
|
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);
|
|
u_int vfs_hash_index(struct vnode *vp);
|
|
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);
|
|
void vfs_hash_ref(const struct mount *mp, u_int hash, struct thread *td,
|
|
struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
|
|
void vfs_hash_rehash(struct vnode *vp, u_int hash);
|
|
void vfs_hash_remove(struct vnode *vp);
|
|
|
|
int vfs_kqfilter(struct vop_kqfilter_args *);
|
|
void vfs_mark_atime(struct vnode *vp, struct ucred *cred);
|
|
struct dirent;
|
|
int vfs_read_dirent(struct vop_readdir_args *ap, struct dirent *dp, off_t off);
|
|
|
|
int vfs_unixify_accmode(accmode_t *accmode);
|
|
|
|
void vfs_unp_reclaim(struct vnode *vp);
|
|
|
|
int setfmode(struct thread *td, struct ucred *cred, struct vnode *vp, int mode);
|
|
int setfown(struct thread *td, struct ucred *cred, struct vnode *vp, uid_t uid,
|
|
gid_t gid);
|
|
int vn_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
|
|
struct thread *td);
|
|
int vn_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
|
|
struct thread *td);
|
|
|
|
#endif /* _KERNEL */
|
|
|
|
#endif /* !_SYS_VNODE_H_ */
|