Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a02a0a383e
NetBSD/sys/sys/vnode.h

575 lines
19 KiB
C
Raw Blame History

/* $NetBSD: vnode.h,v 1.100 2002/10/29 12:31:26 blymn Exp $ */
/*
* 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 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.17 (Berkeley) 5/20/95
*/
#ifndef _SYS_VNODE_H_
#define _SYS_VNODE_H_
#include <sys/event.h>
#include <sys/lock.h>
#include <sys/queue.h>
/* XXX: clean up includes later */
#include <uvm/uvm_param.h> /* XXX */
#include <uvm/uvm_pglist.h> /* XXX */
#include <uvm/uvm_object.h> /* XXX */
#include <uvm/uvm_extern.h> /* XXX */
/*
* 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 };
/*
* Vnode tag types.
* These are for the benefit of external programs only (e.g., pstat)
* and should NEVER be inspected by the kernel.
*/
enum vtagtype {
VT_NON, VT_UFS, VT_NFS, VT_MFS, VT_MSDOSFS, VT_LFS, VT_LOFS, VT_FDESC,
VT_PORTAL, VT_NULL, VT_UMAP, VT_KERNFS, VT_PROCFS, VT_AFS, VT_ISOFS,
VT_UNION, VT_ADOSFS, VT_EXT2FS, VT_CODA, VT_FILECORE, VT_NTFS, VT_VFS,
VT_OVERLAY, VT_SMBFS
};
LIST_HEAD(buflists, buf);
/*
* Reading or writing any of these items requires holding the appropriate lock.
* v_freelist is locked by the global vnode_free_list simple lock.
* v_mntvnodes is locked by the global mntvnodes simple lock.
* v_flag, v_usecount, v_holdcount and v_writecount are
* locked by the v_interlock simple lock
*
* Each underlying filesystem allocates its own private area and hangs
* it from v_data.
*/
struct vnode {
struct uvm_object v_uobj; /* the VM object */
#define v_usecount v_uobj.uo_refs
#define v_interlock v_uobj.vmobjlock
voff_t v_size; /* size of file */
int v_flag; /* flags */
int v_numoutput; /* number of pending writes */
long v_writecount; /* reference count of writers */
long v_holdcnt; /* page & buffer references */
u_long v_id; /* capability identifier */
struct mount *v_mount; /* ptr to vfs we are in */
int (**v_op) __P((void *)); /* vnode operations vector */
TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist */
LIST_ENTRY(vnode) v_mntvnodes; /* vnodes for mount point */
struct buflists v_cleanblkhd; /* clean blocklist head */
struct buflists v_dirtyblkhd; /* dirty blocklist head */
LIST_ENTRY(vnode) v_synclist; /* vnodes with dirty buffers */
union {
struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */
struct socket *vu_socket; /* unix ipc (VSOCK) */
struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */
struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */
} v_un;
struct nqlease *v_lease; /* Soft reference to lease */
enum vtype v_type; /* vnode type */
enum vtagtype v_tag; /* type of underlying data */
struct lock v_lock; /* lock for this vnode */
struct lock *v_vnlock; /* pointer to lock */
void *v_data; /* private data for fs */
struct klist v_klist; /* knotes attached to vnode */
#ifdef VERIFIED_EXEC
char fp_status; /* fingerprint status
(see below) */
#endif
};
#define v_mountedhere v_un.vu_mountedhere
#define v_socket v_un.vu_socket
#define v_specinfo v_un.vu_specinfo
#define v_fifoinfo v_un.vu_fifoinfo
/*
* All vnode locking operations should use vp->v_vnlock. For leaf filesystems
* (such as ffs, lfs, msdosfs, etc), vp->v_vnlock = &vp->v_lock. For
* stacked filesystems, vp->v_vnlock may equal lowervp->v_vnlock.
*
* vp->v_vnlock may also be NULL, which indicates that a leaf node does not
* export a struct lock for vnode locking. Stacked filesystems (such as
* nullfs) must call the underlying fs for locking. See layerfs_ routines
* for examples.
*
* All filesystems must (pretend to) understand lockmanager flags.
*/
/*
* Vnode flags.
*/
#define VROOT 0x0001 /* root of its file system */
#define VTEXT 0x0002 /* vnode is a pure text prototype */
/* VSYSTEM only used to skip vflush()ing quota files */
#define VSYSTEM 0x0004 /* vnode being used by kernel */
/* VISTTY used when reading dead vnodes */
#define VISTTY 0x0008 /* vnode represents a tty */
#define VEXECMAP 0x0010 /* vnode has PROT_EXEC mappings */
#define VXLOCK 0x0100 /* vnode is locked to change underlying type */
#define VXWANT 0x0200 /* process is waiting for vnode */
#define VBWAIT 0x0400 /* waiting for output to complete */
#define VALIASED 0x0800 /* vnode has an alias */
#define VDIROP 0x1000 /* LFS: vnode is involved in a directory op */
#define VLAYER 0x2000 /* vnode is on a layer filesystem */
#define VONWORKLST 0x4000 /* On syncer work-list */
#define VDIRTY 0x8000 /* vnode possibly has dirty pages */
#define VSIZENOTSET ((voff_t)-1)
/*
* Valid states for the fingerprint flag - if signed exec is being used
*/
#ifdef VERIFIED_EXEC
#define FINGERPRINT_INVALID 0 /* fingerprint has not been evaluated */
#define FINGERPRINT_VALID 1 /* fingerprint evaluated and matches list */
#define FINGERPRINT_INDIRECT 2 /* fingerprint eval'd/matched but only
indirect execs allowed */
#define FINGERPRINT_NOMATCH 3 /* fingerprint evaluated but does not match */
#define FINGERPRINT_NOENTRY 4 /* fingerprint evaluated but no list entry */
#define FINGERPRINT_NODEV 5 /* fingerprint evaluated but no dev list */
#endif
/*
* 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) */
mode_t va_mode; /* files access mode and type */
nlink_t va_nlink; /* number of references to file */
uid_t va_uid; /* owner user id */
gid_t va_gid; /* owner group id */
long va_fsid; /* file system id (dev for now) */
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 */
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 */
/*
* Flags for ioflag.
*/
#define IO_UNIT 0x01 /* do I/O as atomic unit */
#define IO_APPEND 0x02 /* append write to end */
#define IO_SYNC (0x04|IO_DSYNC) /* sync I/O file integrity completion */
#define IO_NODELOCKED 0x08 /* underlying node already locked */
#define IO_NDELAY 0x10 /* FNDELAY flag set in file table */
#define IO_DSYNC 0x20 /* sync I/O data integrity completion */
#define IO_ALTSEMANTICS 0x40 /* use alternate i/o semantics */
/*
* Modes.
*/
#define VREAD 00004 /* read, write, execute permissions */
#define VWRITE 00002
#define VEXEC 00001
/*
* Token indicating no attribute value yet assigned.
*/
#define VNOVAL (-1)
#ifdef _KERNEL
/*
* 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 const 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 closeure */
#define WRITECLOSE 0x0004 /* vflush: only close writeable files */
#define DOCLOSE 0x0008 /* vclean: close active files */
#define V_SAVE 0x0001 /* vinvalbuf: sync file first */
/*
* Flags to various vnode operations.
*/
#define REVOKEALL 0x0001 /* revoke: revoke all aliases */
#define FSYNC_WAIT 0x0001 /* fsync: wait for completion */
#define FSYNC_DATAONLY 0x0002 /* fsync: hint: sync file data only */
#define FSYNC_RECLAIM 0x0004 /* fsync: hint: vnode is being reclaimed */
#define FSYNC_LAZY 0x0008 /* fsync: lazy sync (trickle) */
#define UPDATE_WAIT 0x0001 /* update: wait for completion */
#define UPDATE_DIROP 0x0002 /* update: hint to fs to wait or not */
#define HOLDRELE(vp) holdrele(vp)
#define VHOLD(vp) vhold(vp)
#define VREF(vp) vref(vp)
TAILQ_HEAD(freelst, vnode);
extern struct freelst vnode_hold_list; /* free vnodes referencing buffers */
extern struct freelst vnode_free_list; /* vnode free list */
extern struct simplelock vnode_free_list_slock;
#ifdef DIAGNOSTIC
#define ilstatic
#else
#define ilstatic static
#endif
ilstatic void holdrele(struct vnode *);
ilstatic void vhold(struct vnode *);
ilstatic void vref(struct vnode *);
#ifdef DIAGNOSTIC
#define VATTR_NULL(vap) vattr_null(vap)
#else
#define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
/*
* decrease buf or page ref
*/
static __inline void
holdrele(struct vnode *vp)
{
simple_lock(&vp->v_interlock);
vp->v_holdcnt--;
if ((vp->v_freelist.tqe_prev != (struct vnode **)0xdeadb) &&
vp->v_holdcnt == 0 && vp->v_usecount == 0) {
simple_lock(&vnode_free_list_slock);
TAILQ_REMOVE(&vnode_hold_list, vp, v_freelist);
TAILQ_INSERT_TAIL(&vnode_free_list, vp, v_freelist);
simple_unlock(&vnode_free_list_slock);
}
simple_unlock(&vp->v_interlock);
}
/*
* increase buf or page ref
*/
static __inline void
vhold(struct vnode *vp)
{
simple_lock(&vp->v_interlock);
if ((vp->v_freelist.tqe_prev != (struct vnode **)0xdeadb) &&
vp->v_holdcnt == 0 && vp->v_usecount == 0) {
simple_lock(&vnode_free_list_slock);
TAILQ_REMOVE(&vnode_free_list, vp, v_freelist);
TAILQ_INSERT_TAIL(&vnode_hold_list, vp, v_freelist);
simple_unlock(&vnode_free_list_slock);
}
vp->v_holdcnt++;
simple_unlock(&vp->v_interlock);
}
/*
* increase reference
*/
static __inline void
vref(struct vnode *vp)
{
simple_lock(&vp->v_interlock);
vp->v_usecount++;
simple_unlock(&vp->v_interlock);
}
#endif /* DIAGNOSTIC */
#define NULLVP ((struct vnode *)NULL)
#define VN_KNOTE(vp, b) KNOTE(&vp->v_klist, (b))
/*
* Global vnode data.
*/
extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
extern int desiredvnodes; /* number of vnodes desired */
extern long numvnodes; /* current number of vnodes */
extern time_t syncdelay; /* max time to delay syncing data */
extern time_t filedelay; /* time to delay syncing files */
extern time_t dirdelay; /* time to delay syncing directories */
extern time_t metadelay; /* time to delay syncing metadata */
extern struct vattr va_null; /* predefined null vattr structure */
/*
* Macro/function to check for client cache inconsistency w.r.t. leasing.
*/
#define LEASE_READ 0x1 /* Check lease for readers */
#define LEASE_WRITE 0x2 /* Check lease for modifiers */
#endif /* _KERNEL */
/*
* Mods for exensibility.
*/
/*
* Flags for vdesc_flags:
*/
#define VDESC_MAX_VPS 8
/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
#define VDESC_VP0_WILLRELE 0x00000001
#define VDESC_VP1_WILLRELE 0x00000002
#define VDESC_VP2_WILLRELE 0x00000004
#define VDESC_VP3_WILLRELE 0x00000008
#define VDESC_VP0_WILLUNLOCK 0x00000100
#define VDESC_VP1_WILLUNLOCK 0x00000200
#define VDESC_VP2_WILLUNLOCK 0x00000400
#define VDESC_VP3_WILLUNLOCK 0x00000800
#define VDESC_VP0_WILLPUT 0x00000101
#define VDESC_VP1_WILLPUT 0x00000202
#define VDESC_VP2_WILLPUT 0x00000404
#define VDESC_VP3_WILLPUT 0x00000808
#define VDESC_NOMAP_VPP 0x00010000
#define VDESC_VPP_WILLRELE 0x00020000
/*
* 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 {
int vdesc_offset; /* offset in vector--first for speed */
const char *vdesc_name; /* a readable name for debugging */
int vdesc_flags; /* VDESC_* flags */
/*
* 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.
*/
const 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_proc_offset; /* proc location, if any */
int vdesc_componentname_offset; /* if any */
/*
* Finally, we've got a list of private data (about each operation)
* for each transport layer. (Support to manage this list is not
* yet part of BSD.)
*/
caddr_t *vdesc_transports;
};
#ifdef _KERNEL
/*
* A list of all the operation descs.
*/
extern struct vnodeop_desc *vnodeop_descs[];
/*
* Interlock for scanning list of vnodes attached to a mountpoint
*/
extern struct simplelock mntvnode_slock;
/*
* This macro is very helpful in defining those offsets in the vdesc struct.
*
* This is stolen from X11R4. I ingored all the fancy stuff for
* Crays, so if you decide to port this to such a serious machine,
* you might want to consult Intrisics.h's XtOffset{,Of,To}.
*/
#define VOPARG_OFFSET(p_type,field) \
((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
#define VOPARG_OFFSETOF(s_type,field) \
VOPARG_OFFSET(s_type*,field)
#define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
/*
* This structure is used to configure the new vnodeops vector.
*/
struct vnodeopv_entry_desc {
const struct vnodeop_desc *opve_op; /* which operation this is */
int (*opve_impl)(void *); /* code implementing this operation */
};
struct vnodeopv_desc {
/* ptr to the ptr to the vector where op should go */
int (***opv_desc_vector_p)(void *);
const struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */
};
/*
* A default routine which just returns an error.
*/
int vn_default_error(void *);
/*
* 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 */
};
/*
* VOCALL calls an op given an ops vector. We break it out because BSD's
* vclean changes the ops vector and then wants to call ops with the old
* vector.
*/
/*
* actually, vclean doesn't use it anymore, but nfs does,
* for device specials and fifos.
*/
#define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
/*
* This call works for vnodes in the kernel.
*/
#define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
#define VDESC(OP) (& __CONCAT(OP,_desc))
#define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
/*
* Finally, include the default set of vnode operations.
*/
#include <sys/vnode_if.h>
/*
* Public vnode manipulation functions.
*/
struct file;
struct filedesc;
struct mount;
struct nameidata;
struct proc;
struct stat;
struct ucred;
struct uio;
struct vattr;
struct vnode;
/* see vnode(9) */
int bdevvp(dev_t dev, struct vnode **vpp);
int cdevvp(dev_t dev, struct vnode **vpp);
struct vnode *
checkalias(struct vnode *vp, dev_t nvp_rdev, struct mount *mp);
int getnewvnode(enum vtagtype tag, struct mount *mp,
int (**vops)(void *), struct vnode **vpp);
void ungetnewvnode(struct vnode *);
int vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
mode_t acc_mode, struct ucred *cred);
void vattr_null(struct vattr *vap);
int vcount(struct vnode *vp);
void vdevgone(int, int, int, enum vtype);
int vfinddev(dev_t, enum vtype, struct vnode **);
int vflush(struct mount *mp, struct vnode *vp, int flags);
void vflushbuf(struct vnode *vp, int sync);
int vget(struct vnode *vp, int lockflag);
void vgone(struct vnode *vp);
void vgonel(struct vnode *vp, struct proc *p);
int vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
struct proc *p, int slpflag, int slptimeo);
void vprint(char *label, struct vnode *vp);
void vput(struct vnode *vp);
int vrecycle(struct vnode *vp, struct simplelock *inter_lkp,
struct proc *p);
void vrele(struct vnode *vp);
int vtruncbuf(struct vnode *vp, daddr_t lbn,
int slpflag, int slptimeo);
void vwakeup(struct buf *);
/* see vnsubr(9) */
int vn_bwrite(void *ap);
int vn_close(struct vnode *vp,
int flags, struct ucred *cred, struct proc *p);
int vn_isunder(struct vnode *dvp, struct vnode *rvp, struct proc *p);
int vn_lock(struct vnode *vp, int flags);
void vn_markexec(struct vnode *);
int vn_marktext(struct vnode *);
int vn_open(struct nameidata *ndp, int fmode, int cmode);
int vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
int len, off_t offset, enum uio_seg segflg, int ioflg,
struct ucred *cred, size_t *aresid, struct proc *p);
int vn_readdir(struct file *fp, char *buf, int segflg, u_int count,
int *done, struct proc *p, off_t **cookies, int *ncookies);
void vn_restorerecurse(struct vnode *vp, u_int flags);
u_int vn_setrecurse(struct vnode *vp);
int vn_stat(struct vnode *vp, struct stat *sb, struct proc *p);
int vn_kqfilter(struct file *fp, struct knote *kn);
int vn_writechk(struct vnode *vp);
/* initialise global vnode management */
void vntblinit(void);
/* misc stuff */
void vn_syncer_add_to_worklist(struct vnode *vp, int delay);
void vn_syncer_remove_from_worklist(struct vnode *vp);
int speedup_syncer(void);
/* from vfs_syscalls.c - abused by compat code */
int getvnode(struct filedesc *fdp, int fd, struct file **fpp);
/* see vfsops(9) */
void vfs_getnewfsid(struct mount *);
#ifdef DDB
void vfs_vnode_print(struct vnode *, int, void (*)(const char *, ...));
#endif /* DDB */
#endif /* _KERNEL */
#endif /* !_SYS_VNODE_H_ */
Reference in New Issue View Git Blame Copy Permalink