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