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