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