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