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