vnode.h revision 140181
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 140181 2005-01-13 12:25:19Z 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
69struct namecache;
70
71struct vpollinfo {
72	struct	mtx vpi_lock;		/* lock to protect below */
73	struct	selinfo vpi_selinfo;	/* identity of poller(s) */
74	short	vpi_events;		/* what they are looking for */
75	short	vpi_revents;		/* what has happened */
76};
77
78/*
79 * Reading or writing any of these items requires holding the appropriate lock.
80 *
81 * Lock reference:
82 *	c - namecache mutex
83 *	f - freelist mutex
84 *	G - Giant
85 *	i - interlock
86 *	m - mntvnodes mutex
87 *	p - pollinfo lock
88 *	s - spechash mutex
89 *	S - syncer mutex
90 *	u - Only a reference to the vnode is needed to read.
91 *	v - vnode lock
92 *
93 * Vnodes may be found on many lists.  The general way to deal with operating
94 * on a vnode that is on a list is:
95 *	1) Lock the list and find the vnode.
96 *	2) Lock interlock so that the vnode does not go away.
97 *	3) Unlock the list to avoid lock order reversals.
98 *	4) vget with LK_INTERLOCK and check for ENOENT, or
99 *	5) Check for XLOCK if the vnode lock is not required.
100 *	6) Perform your operation, then vput().
101 *
102 * XXX Not all fields are locked yet and some fields that are marked are not
103 * locked consistently.  This is a work in progress.  Requires Giant!
104 */
105
106#if defined(_KERNEL) || defined(_KVM_VNODE)
107
108struct vnode {
109	struct	mtx v_interlock;		/* lock for "i" things */
110	u_long	v_iflag;			/* i vnode flags (see below) */
111	int	v_usecount;			/* i ref count of users */
112	struct thread *v_vxthread;		/* i thread owning VXLOCK */
113	int	v_holdcnt;			/* i page & buffer references */
114	struct bufobj	v_bufobj;		/* * Buffer cache object */
115	u_long	v_vflag;			/* v vnode flags */
116	int	v_writecount;			/* v ref count of writers */
117	daddr_t	v_lastw;			/* v last write (write cluster) */
118	daddr_t	v_cstart;			/* v start block of cluster */
119	daddr_t	v_lasta;			/* v last allocation (cluster) */
120	int	v_clen;				/* v length of current cluster */
121	union {
122		struct mount	*vu_mountedhere;/* v ptr to mounted vfs (VDIR) */
123		struct socket	*vu_socket;	/* v unix ipc (VSOCK) */
124		struct {
125			struct cdev	*vu_cdev; /* v device (VCHR, VBLK) */
126			SLIST_ENTRY(vnode) vu_specnext;	/* s device aliases */
127		} vu_spec;
128		struct fifoinfo	*vu_fifoinfo;	/* v fifo (VFIFO) */
129	} v_un;
130	TAILQ_ENTRY(vnode) v_freelist;		/* f vnode freelist */
131	TAILQ_ENTRY(vnode) v_nmntvnodes;	/* m vnodes for mount point */
132	enum	vtype v_type;			/* u vnode type */
133	const char *v_tag;			/* u type of underlying data */
134	void	*v_data;			/* u private data for fs */
135	struct	lock v_lock;			/* u used if fs don't have one */
136	struct	lock *v_vnlock;			/* u pointer to vnode lock */
137	struct	vop_vector *v_op;		/* u vnode operations vector */
138	struct	mount *v_mount;			/* u ptr to vfs we are in */
139	LIST_HEAD(, namecache) v_cache_src;	/* c Cache entries from us */
140	TAILQ_HEAD(, namecache) v_cache_dst;	/* c Cache entries to us */
141	u_long	v_id;				/* c capability identifier */
142	struct	vnode *v_dd;			/* c .. vnode */
143	u_long	v_ddid;				/* c .. capability identifier */
144	struct vpollinfo *v_pollinfo;		/* G Poll events, p for *v_pi */
145	struct label *v_label;			/* MAC label for vnode */
146#ifdef	DEBUG_LOCKS
147	const char *filename;			/* Source file doing locking */
148	int line;				/* Line number doing locking */
149#endif
150};
151
152#endif /* defined(_KERNEL) || defined(_KVM_VNODE) */
153
154#define	v_mountedhere	v_un.vu_mountedhere
155#define	v_socket	v_un.vu_socket
156#define	v_rdev		v_un.vu_spec.vu_cdev
157#define	v_specnext	v_un.vu_spec.vu_specnext
158#define	v_fifoinfo	v_un.vu_fifoinfo
159
160/* XXX: These are temporary to avoid a source sweep at this time */
161#define v_object	v_bufobj.bo_object
162
163/*
164 * Userland version of struct vnode, for sysctl.
165 */
166struct xvnode {
167	size_t	xv_size;			/* sizeof(struct xvnode) */
168	void	*xv_vnode;			/* address of real vnode */
169	u_long	xv_flag;			/* vnode vflags */
170	int	xv_usecount;			/* reference count of users */
171	int	xv_writecount;			/* reference count of writers */
172	int	xv_holdcnt;			/* page & buffer references */
173	u_long	xv_id;				/* capability identifier */
174	void	*xv_mount;			/* address of parent mount */
175	long	xv_numoutput;			/* num of writes in progress */
176	enum	vtype xv_type;			/* vnode type */
177	union {
178		void	*xvu_socket;		/* socket, if VSOCK */
179		void	*xvu_fifo;		/* fifo, if VFIFO */
180		dev_t	xvu_rdev;		/* maj/min, if VBLK/VCHR */
181		struct {
182			dev_t	xvu_dev;	/* device, if VDIR/VREG/VLNK */
183			ino_t	xvu_ino;	/* id, if VDIR/VREG/VLNK */
184		} xv_uns;
185	} xv_un;
186};
187#define xv_socket	xv_un.xvu_socket
188#define xv_fifo		xv_un.xvu_fifo
189#define xv_rdev		xv_un.xvu_rdev
190#define xv_dev		xv_un.xv_uns.xvu_dev
191#define xv_ino		xv_un.xv_uns.xvu_ino
192
193#define	VN_POLLEVENT(vp, events)				\
194	do {							\
195		if ((vp)->v_pollinfo != NULL && 		\
196		    (vp)->v_pollinfo->vpi_events & (events))	\
197			vn_pollevent((vp), (events));		\
198	} while (0)
199
200#define VN_KNOTE(vp, b, a)						\
201	do {							\
202		if ((vp)->v_pollinfo != NULL)			\
203			KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), (a)); \
204	} while (0)
205#define VN_KNOTE_LOCKED(vp, b)		VN_KNOTE(vp, b, 1)
206#define VN_KNOTE_UNLOCKED(vp, b)	VN_KNOTE(vp, b, 0)
207
208/*
209 * Vnode flags.
210 *	VI flags are protected by interlock and live in v_iflag
211 *	VV flags are protected by the vnode lock and live in v_vflag
212 */
213#define	VI_XLOCK	0x0001	/* vnode is locked to change vtype */
214#define	VI_XWANT	0x0002	/* thread is waiting for vnode */
215#define	VI_OLOCK	0x0008	/* vnode is locked waiting for an object */
216#define	VI_OWANT	0x0010	/* a thread is waiting for VOLOCK */
217#define	VI_MOUNT	0x0020	/* Mount in progress */
218#define	VI_AGE		0x0040	/* Insert vnode at head of free list */
219#define	VI_DOOMED	0x0080	/* This vnode is being recycled */
220#define	VI_FREE		0x0100	/* This vnode is on the freelist */
221#define	VI_OBJDIRTY	0x0400	/* object might be dirty */
222#define	VI_DOINGINACT	0x0800	/* VOP_INACTIVE is in progress */
223
224#define	VV_ROOT		0x0001	/* root of its filesystem */
225#define	VV_ISTTY	0x0002	/* vnode represents a tty */
226#define	VV_NOSYNC	0x0004	/* unlinked, stop syncing */
227#define	VV_OBJBUF	0x0008	/* Allocate buffers in VM object */
228#define	VV_CACHEDLABEL	0x0010	/* Vnode has valid cached MAC label */
229#define	VV_TEXT		0x0020	/* vnode is a pure text prototype */
230#define	VV_COPYONWRITE	0x0040	/* vnode is doing copy-on-write */
231#define	VV_SYSTEM	0x0080	/* vnode being used by kernel */
232#define	VV_PROCDEP	0x0100	/* vnode is process dependent */
233
234/*
235 * Vnode attributes.  A field value of VNOVAL represents a field whose value
236 * is unavailable (getattr) or which is not to be changed (setattr).
237 */
238struct vattr {
239	enum vtype	va_type;	/* vnode type (for create) */
240	u_short		va_mode;	/* files access mode and type */
241	short		va_nlink;	/* number of references to file */
242	uid_t		va_uid;		/* owner user id */
243	gid_t		va_gid;		/* owner group id */
244	dev_t		va_fsid;	/* filesystem id */
245	long		va_fileid;	/* file id */
246	u_quad_t	va_size;	/* file size in bytes */
247	long		va_blocksize;	/* blocksize preferred for i/o */
248	struct timespec	va_atime;	/* time of last access */
249	struct timespec	va_mtime;	/* time of last modification */
250	struct timespec	va_ctime;	/* time file changed */
251	struct timespec	va_birthtime;	/* time file created */
252	u_long		va_gen;		/* generation number of file */
253	u_long		va_flags;	/* flags defined for file */
254	dev_t		va_rdev;	/* device the special file represents */
255	u_quad_t	va_bytes;	/* bytes of disk space held by file */
256	u_quad_t	va_filerev;	/* file modification number */
257	u_int		va_vaflags;	/* operations flags, see below */
258	long		va_spare;	/* remain quad aligned */
259};
260
261/*
262 * Flags for va_vaflags.
263 */
264#define	VA_UTIMES_NULL	0x01		/* utimes argument was NULL */
265#define	VA_EXCLUSIVE	0x02		/* exclusive create request */
266
267/*
268 * Flags for ioflag. (high 16 bits used to ask for read-ahead and
269 * help with write clustering)
270 * NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h
271 */
272#define	IO_UNIT		0x0001		/* do I/O as atomic unit */
273#define	IO_APPEND	0x0002		/* append write to end */
274#define	IO_NDELAY	0x0004		/* FNDELAY flag set in file table */
275#define	IO_NODELOCKED	0x0008		/* underlying node already locked */
276#define	IO_ASYNC	0x0010		/* bawrite rather then bdwrite */
277#define	IO_VMIO		0x0020		/* data already in VMIO space */
278#define	IO_INVAL	0x0040		/* invalidate after I/O */
279#define	IO_SYNC		0x0080		/* do I/O synchronously */
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/*
354 * Global vnode data.
355 */
356extern	struct vnode *rootvnode;	/* root (i.e. "/") vnode */
357extern	int async_io_version;		/* 0 or POSIX version of AIO i'face */
358extern	int desiredvnodes;		/* number of vnodes desired */
359extern	struct uma_zone *namei_zone;
360extern	int prtactive;			/* nonzero to call vprint() */
361extern	struct vattr va_null;		/* predefined null vattr structure */
362
363/*
364 * Macro/function to check for client cache inconsistency w.r.t. leasing.
365 */
366#define	LEASE_READ	0x1		/* Check lease for readers */
367#define	LEASE_WRITE	0x2		/* Check lease for modifiers */
368
369extern void	(*lease_updatetime)(int deltat);
370
371/* Requires interlock. */
372#define	VSHOULDFREE(vp)	\
373	(!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_DOINGINACT)) && \
374	 !(vp)->v_holdcnt && !(vp)->v_usecount && \
375	 (!(vp)->v_object || \
376	  !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count)))
377
378/* Requires interlock. */
379#define	VMIGHTFREE(vp) \
380	(!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_XLOCK|VI_DOINGINACT)) && \
381	 LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount)
382
383/* Requires interlock. */
384#define	VSHOULDBUSY(vp)	\
385	(((vp)->v_iflag & VI_FREE) && \
386	 ((vp)->v_holdcnt || (vp)->v_usecount))
387
388#define	VI_LOCK(vp)	mtx_lock(&(vp)->v_interlock)
389#define	VI_TRYLOCK(vp)	mtx_trylock(&(vp)->v_interlock)
390#define	VI_UNLOCK(vp)	mtx_unlock(&(vp)->v_interlock)
391#define	VI_MTX(vp)	(&(vp)->v_interlock)
392
393#endif /* _KERNEL */
394
395/*
396 * Mods for extensibility.
397 */
398
399/*
400 * Flags for vdesc_flags:
401 */
402#define	VDESC_MAX_VPS		16
403/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
404#define	VDESC_VP0_WILLRELE	0x0001
405#define	VDESC_VP1_WILLRELE	0x0002
406#define	VDESC_VP2_WILLRELE	0x0004
407#define	VDESC_VP3_WILLRELE	0x0008
408#define	VDESC_NOMAP_VPP		0x0100
409#define	VDESC_VPP_WILLRELE	0x0200
410
411/*
412 * A generic structure.
413 * This can be used by bypass routines to identify generic arguments.
414 */
415struct vop_generic_args {
416	struct vnodeop_desc *a_desc;
417	/* other random data follows, presumably */
418};
419
420typedef int vop_bypass_t(struct vop_generic_args *);
421
422/*
423 * VDESC_NO_OFFSET is used to identify the end of the offset list
424 * and in places where no such field exists.
425 */
426#define VDESC_NO_OFFSET -1
427
428/*
429 * This structure describes the vnode operation taking place.
430 */
431struct vnodeop_desc {
432	char	*vdesc_name;		/* a readable name for debugging */
433	int	 vdesc_flags;		/* VDESC_* flags */
434	vop_bypass_t	*vdesc_call;	/* Function to call */
435
436	/*
437	 * These ops are used by bypass routines to map and locate arguments.
438	 * Creds and procs are not needed in bypass routines, but sometimes
439	 * they are useful to (for example) transport layers.
440	 * Nameidata is useful because it has a cred in it.
441	 */
442	int	*vdesc_vp_offsets;	/* list ended by VDESC_NO_OFFSET */
443	int	vdesc_vpp_offset;	/* return vpp location */
444	int	vdesc_cred_offset;	/* cred location, if any */
445	int	vdesc_thread_offset;	/* thread location, if any */
446	int	vdesc_componentname_offset; /* if any */
447	/*
448	 * Finally, we've got a list of private data (about each operation)
449	 * for each transport layer.  (Support to manage this list is not
450	 * yet part of BSD.)
451	 */
452	caddr_t	*vdesc_transports;
453};
454
455#ifdef _KERNEL
456/*
457 * A list of all the operation descs.
458 */
459extern struct vnodeop_desc *vnodeop_descs[];
460
461#define	VOPARG_OFFSETOF(s_type, field)	__offsetof(s_type, field)
462#define	VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
463    ((s_type)(((char*)(struct_p)) + (s_offset)))
464
465
466#ifdef DEBUG_VFS_LOCKS
467/*
468 * Support code to aid in debugging VFS locking problems.  Not totally
469 * reliable since if the thread sleeps between changing the lock
470 * state and checking it with the assert, some other thread could
471 * change the state.  They are good enough for debugging a single
472 * filesystem using a single-threaded test.
473 */
474void	assert_vi_locked(struct vnode *vp, const char *str);
475void	assert_vi_unlocked(struct vnode *vp, const char *str);
476#if 0
477void	assert_vop_elocked(struct vnode *vp, const char *str);
478void	assert_vop_elocked_other(struct vnode *vp, const char *str);
479#endif
480void	assert_vop_locked(struct vnode *vp, const char *str);
481#if 0
482voi0	assert_vop_slocked(struct vnode *vp, const char *str);
483#endif
484void	assert_vop_unlocked(struct vnode *vp, const char *str);
485
486/* These are called from within the actual VOPS. */
487void	vop_lock_pre(void *a);
488void	vop_lock_post(void *a, int rc);
489void	vop_lookup_post(void *a, int rc);
490void	vop_lookup_pre(void *a);
491void	vop_rename_pre(void *a);
492void	vop_strategy_pre(void *a);
493void	vop_unlock_post(void *a, int rc);
494void	vop_unlock_pre(void *a);
495
496#define	ASSERT_VI_LOCKED(vp, str)	assert_vi_locked((vp), (str))
497#define	ASSERT_VI_UNLOCKED(vp, str)	assert_vi_unlocked((vp), (str))
498#if 0
499#define	ASSERT_VOP_ELOCKED(vp, str)	assert_vop_elocked((vp), (str))
500#define	ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
501#endif
502#define	ASSERT_VOP_LOCKED(vp, str)	assert_vop_locked((vp), (str))
503#if 0
504#define	ASSERT_VOP_SLOCKED(vp, str)	assert_vop_slocked((vp), (str))
505#endif
506#define	ASSERT_VOP_UNLOCKED(vp, str)	assert_vop_unlocked((vp), (str))
507
508#else /* !DEBUG_VFS_LOCKS */
509
510#define	ASSERT_VI_LOCKED(vp, str)
511#define	ASSERT_VI_UNLOCKED(vp, str)
512#if 0
513#define	ASSERT_VOP_ELOCKED(vp, str)
514#define	ASSERT_VOP_ELOCKED_OTHER(vp, str)
515#endif
516#define	ASSERT_VOP_LOCKED(vp, str)
517#if 0
518#define	ASSERT_VOP_SLOCKED(vp, str)
519#endif
520#define	ASSERT_VOP_UNLOCKED(vp, str)
521#endif /* DEBUG_VFS_LOCKS */
522
523
524/*
525 * This call works for vnodes in the kernel.
526 */
527#define VCALL(c) ((c)->a_desc->vdesc_call(c))
528
529/*
530 * VMIO support inline
531 */
532
533extern int vmiodirenable;
534
535static __inline int
536vn_canvmio(struct vnode *vp)
537{
538      if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
539		return(TRUE);
540	return(FALSE);
541}
542
543/*
544 * Finally, include the default set of vnode operations.
545 */
546#include "vnode_if.h"
547
548/*
549 * Public vnode manipulation functions.
550 */
551struct componentname;
552struct file;
553struct mount;
554struct nameidata;
555struct ostat;
556struct thread;
557struct proc;
558struct stat;
559struct nstat;
560struct ucred;
561struct uio;
562struct vattr;
563struct vnode;
564
565extern int	(*lease_check_hook)(struct vop_lease_args *);
566extern int	(*softdep_fsync_hook)(struct vnode *);
567extern int	(*softdep_process_worklist_hook)(struct mount *);
568
569/* cache_* may belong in namei.h. */
570void	cache_enter(struct vnode *dvp, struct vnode *vp,
571	    struct componentname *cnp);
572int	cache_lookup(struct vnode *dvp, struct vnode **vpp,
573	    struct componentname *cnp);
574void	cache_purge(struct vnode *vp);
575void	cache_purgevfs(struct mount *mp);
576int	cache_leaf_test(struct vnode *vp);
577int	change_dir(struct vnode *vp, struct thread *td);
578int	change_root(struct vnode *vp, struct thread *td);
579void	cvtstat(struct stat *st, struct ostat *ost);
580void	cvtnstat(struct stat *sb, struct nstat *nsb);
581int	getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
582	    struct vnode **vpp);
583u_quad_t init_va_filerev(void);
584int	lease_check(struct vop_lease_args *ap);
585int	speedup_syncer(void);
586#define textvp_fullpath(p, rb, rfb) \
587	vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
588int	vn_fullpath(struct thread *td, struct vnode *vn,
589	    char **retbuf, char **freebuf);
590int	vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
591	    mode_t acc_mode, struct ucred *cred, int *privused);
592int	vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
593	    gid_t file_gid, struct acl *acl, mode_t acc_mode,
594	    struct ucred *cred, int *privused);
595void	vattr_null(struct vattr *vap);
596int	vcount(struct vnode *vp);
597void	vdrop(struct vnode *);
598void	vdropl(struct vnode *);
599int	vfinddev(struct cdev *dev, struct vnode **vpp);
600void	vfs_add_vnodeops(const void *);
601void	vfs_rm_vnodeops(const void *);
602int	vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
603int	vget(struct vnode *vp, int lockflag, struct thread *td);
604void	vgone(struct vnode *vp);
605void	vgonel(struct vnode *vp, struct thread *td);
606void	vhold(struct vnode *);
607void	vholdl(struct vnode *);
608int	vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
609	    struct thread *td, int slpflag, int slptimeo);
610int	vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
611	    off_t length, int blksize);
612void	vprint(char *label, struct vnode *vp);
613int	vrecycle(struct vnode *vp, struct mtx *inter_lkp,
614	    struct thread *td);
615int	vn_close(struct vnode *vp,
616	    int flags, struct ucred *file_cred, struct thread *td);
617void	vn_finished_write(struct mount *mp);
618int	vn_isdisk(struct vnode *vp, int *errp);
619int	vn_lock(struct vnode *vp, int flags, struct thread *td);
620#ifdef	DEBUG_LOCKS
621int	debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
622	    const char *filename, int line);
623#define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
624#endif
625int	vn_open(struct nameidata *ndp, int *flagp, int cmode, int fdidx);
626int	vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
627	    struct ucred *cred, int fdidx);
628void	vn_pollevent(struct vnode *vp, int events);
629void	vn_pollgone(struct vnode *vp);
630int	vn_pollrecord(struct vnode *vp, struct thread *p, int events);
631int	vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
632	    int len, off_t offset, enum uio_seg segflg, int ioflg,
633	    struct ucred *active_cred, struct ucred *file_cred, int *aresid,
634	    struct thread *td);
635int	vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
636	    size_t len, off_t offset, enum uio_seg segflg, int ioflg,
637	    struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
638	    struct thread *td);
639int	vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
640	    struct ucred *file_cred, struct thread *td);
641int	vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
642int	vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
643	    int flags);
644int	vn_writechk(struct vnode *vp);
645int	vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
646	    const char *attrname, int *buflen, char *buf, struct thread *td);
647int	vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
648	    const char *attrname, int buflen, char *buf, struct thread *td);
649int	vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
650	    const char *attrname, struct thread *td);
651int	vfs_cache_lookup(struct vop_lookup_args *ap);
652void	vfs_timestamp(struct timespec *);
653void	vfs_write_resume(struct mount *mp);
654int	vfs_write_suspend(struct mount *mp);
655int	vop_stdbmap(struct vop_bmap_args *);
656int	vop_stdfsync(struct vop_fsync_args *);
657int	vop_stdgetwritemount(struct vop_getwritemount_args *);
658int	vop_stdgetpages(struct vop_getpages_args *);
659int	vop_stdinactive(struct vop_inactive_args *);
660int	vop_stdislocked(struct vop_islocked_args *);
661int	vop_stdlock(struct vop_lock_args *);
662int	vop_stdputpages(struct vop_putpages_args *);
663int	vop_stdunlock(struct vop_unlock_args *);
664int	vop_nopoll(struct vop_poll_args *);
665int	vop_stdpathconf(struct vop_pathconf_args *);
666int	vop_stdpoll(struct vop_poll_args *);
667int	vop_eopnotsupp(struct vop_generic_args *ap);
668int	vop_ebadf(struct vop_generic_args *ap);
669int	vop_einval(struct vop_generic_args *ap);
670int	vop_enotty(struct vop_generic_args *ap);
671int	vop_null(struct vop_generic_args *ap);
672int	vop_panic(struct vop_generic_args *ap);
673int	vop_stdcreatevobject(struct vop_createvobject_args *ap);
674int	vop_stddestroyvobject(struct vop_destroyvobject_args *ap);
675int	vop_stdgetvobject(struct vop_getvobject_args *ap);
676
677void	vfree(struct vnode *);
678void	vput(struct vnode *vp);
679void	vrele(struct vnode *vp);
680void	vref(struct vnode *vp);
681int	vrefcnt(struct vnode *vp);
682void	vbusy(struct vnode *vp);
683void 	v_addpollinfo(struct vnode *vp);
684
685
686extern struct vop_vector fifo_specops;
687extern struct vop_vector dead_vnodeops;
688extern struct vop_vector default_vnodeops;
689
690#define VOP_PANIC	((void*)(uintptr_t)vop_panic)
691#define VOP_NULL	((void*)(uintptr_t)vop_null)
692#define VOP_EBADF	((void*)(uintptr_t)vop_ebadf)
693#define VOP_ENOTTY	((void*)(uintptr_t)vop_enotty)
694#define VOP_EINVAL	((void*)(uintptr_t)vop_einval)
695#define VOP_EOPNOTSUPP	((void*)(uintptr_t)vop_eopnotsupp)
696
697
698#endif /* _KERNEL */
699
700#endif /* !_SYS_VNODE_H_ */
701