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