vnode.h revision 143560
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 143560 2005-03-14 09:25:19Z jeff $
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 DOOMED 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	/*
110	 * Fields which define the identity of the vnode.  These fields are
111	 * owned by the filesystem (XXX: and vgone() ?)
112	 */
113	enum	vtype v_type;			/* u vnode type */
114	const char *v_tag;			/* u type of underlying data */
115	struct	vop_vector *v_op;		/* u vnode operations vector */
116	void	*v_data;			/* u private data for fs */
117
118	/*
119	 * Filesystem instance stuff
120	 */
121	struct	mount *v_mount;			/* u ptr to vfs we are in */
122	TAILQ_ENTRY(vnode) v_nmntvnodes;	/* m vnodes for mount point */
123
124	/*
125	 * Type specific fields, only one applies to any given vnode.
126	 * See #defines below for renaming to v_* namespace.
127	 */
128	union {
129		struct mount	*vu_mount;	/* v ptr to mountpoint (VDIR) */
130		struct socket	*vu_socket;	/* v unix domain net (VSOCK) */
131		struct cdev	*vu_cdev; 	/* v device (VCHR, VBLK) */
132		struct fifoinfo	*vu_fifoinfo;	/* v fifo (VFIFO) */
133	} v_un;
134
135	/*
136	 * VFS_namecache stuff
137	 */
138	LIST_HEAD(, namecache) v_cache_src;	/* c Cache entries from us */
139	TAILQ_HEAD(, namecache) v_cache_dst;	/* c Cache entries to us */
140	u_long	v_id;				/* c capability identifier */
141	struct	vnode *v_dd;			/* c .. vnode */
142	u_long	v_ddid;				/* c .. capability identifier */
143
144	/*
145	 * clustering stuff
146	 */
147	daddr_t	v_cstart;			/* v start block of cluster */
148	daddr_t	v_lasta;			/* v last allocation  */
149	daddr_t	v_lastw;			/* v last write  */
150	int	v_clen;				/* v length of cur. cluster */
151
152	/*
153	 * Locking
154	 */
155	struct	lock v_lock;			/* u (if fs don't have one) */
156	struct	mtx v_interlock;		/* lock for "i" things */
157	struct	lock *v_vnlock;			/* u pointer to vnode lock */
158#ifdef	DEBUG_LOCKS
159	const char *filename;			/* Source file doing locking */
160	int line;				/* Line number doing locking */
161#endif
162	int	v_holdcnt;			/* i prevents recycling. */
163	int	v_usecount;			/* i ref count of users */
164	struct thread *v_vxthread;		/* i thread running vgone. */
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#define VN_KNOTE(vp, b, a)						\
223	do {							\
224		if ((vp)->v_pollinfo != NULL)			\
225			KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), (a)); \
226	} while (0)
227#define VN_KNOTE_LOCKED(vp, b)		VN_KNOTE(vp, b, 1)
228#define VN_KNOTE_UNLOCKED(vp, b)	VN_KNOTE(vp, b, 0)
229
230/*
231 * Vnode flags.
232 *	VI flags are protected by interlock and live in v_iflag
233 *	VV flags are protected by the vnode lock and live in v_vflag
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
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_CACHEDLABEL	0x0010	/* Vnode has valid cached MAC label */
246#define	VV_TEXT		0x0020	/* vnode is a pure text prototype */
247#define	VV_COPYONWRITE	0x0040	/* vnode is doing copy-on-write */
248#define	VV_SYSTEM	0x0080	/* vnode being used by kernel */
249#define	VV_PROCDEP	0x0100	/* vnode is process dependent */
250
251/*
252 * Vnode attributes.  A field value of VNOVAL represents a field whose value
253 * is unavailable (getattr) or which is not to be changed (setattr).
254 */
255struct vattr {
256	enum vtype	va_type;	/* vnode type (for create) */
257	u_short		va_mode;	/* files access mode and type */
258	short		va_nlink;	/* number of references to file */
259	uid_t		va_uid;		/* owner user id */
260	gid_t		va_gid;		/* owner group id */
261	dev_t		va_fsid;	/* filesystem id */
262	long		va_fileid;	/* file id */
263	u_quad_t	va_size;	/* file size in bytes */
264	long		va_blocksize;	/* blocksize preferred for i/o */
265	struct timespec	va_atime;	/* time of last access */
266	struct timespec	va_mtime;	/* time of last modification */
267	struct timespec	va_ctime;	/* time file changed */
268	struct timespec	va_birthtime;	/* time file created */
269	u_long		va_gen;		/* generation number of file */
270	u_long		va_flags;	/* flags defined for file */
271	dev_t		va_rdev;	/* device the special file represents */
272	u_quad_t	va_bytes;	/* bytes of disk space held by file */
273	u_quad_t	va_filerev;	/* file modification number */
274	u_int		va_vaflags;	/* operations flags, see below */
275	long		va_spare;	/* remain quad aligned */
276};
277
278/*
279 * Flags for va_vaflags.
280 */
281#define	VA_UTIMES_NULL	0x01		/* utimes argument was NULL */
282#define	VA_EXCLUSIVE	0x02		/* exclusive create request */
283
284/*
285 * Flags for ioflag. (high 16 bits used to ask for read-ahead and
286 * help with write clustering)
287 * NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h
288 */
289#define	IO_UNIT		0x0001		/* do I/O as atomic unit */
290#define	IO_APPEND	0x0002		/* append write to end */
291#define	IO_NDELAY	0x0004		/* FNDELAY flag set in file table */
292#define	IO_NODELOCKED	0x0008		/* underlying node already locked */
293#define	IO_ASYNC	0x0010		/* bawrite rather then bdwrite */
294#define	IO_VMIO		0x0020		/* data already in VMIO space */
295#define	IO_INVAL	0x0040		/* invalidate after I/O */
296#define	IO_SYNC		0x0080		/* do I/O synchronously */
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/*
371 * Global vnode data.
372 */
373extern	struct vnode *rootvnode;	/* root (i.e. "/") vnode */
374extern	int async_io_version;		/* 0 or POSIX version of AIO i'face */
375extern	int desiredvnodes;		/* number of vnodes desired */
376extern	struct uma_zone *namei_zone;
377extern	int prtactive;			/* nonzero to call vprint() */
378extern	struct vattr va_null;		/* predefined null vattr structure */
379
380/*
381 * Macro/function to check for client cache inconsistency w.r.t. leasing.
382 */
383#define	LEASE_READ	0x1		/* Check lease for readers */
384#define	LEASE_WRITE	0x2		/* Check lease for modifiers */
385
386extern void	(*lease_updatetime)(int deltat);
387
388/* Requires interlock. */
389#define	VCANRECYCLE(vp)							\
390	(((vp)->v_iflag & VI_FREE) && !(vp)->v_holdcnt)
391
392/* Requires interlock. */
393#define	VSHOULDFREE(vp)							\
394	(!((vp)->v_iflag & VI_FREE) && !(vp)->v_holdcnt &&		\
395	 (!(vp)->v_object || !(vp)->v_object->resident_page_count))
396
397/* Requires interlock. */
398#define	VSHOULDBUSY(vp)							\
399	(((vp)->v_iflag & VI_FREE) && (vp)->v_holdcnt)
400
401#define	VI_LOCK(vp)	mtx_lock(&(vp)->v_interlock)
402#define	VI_TRYLOCK(vp)	mtx_trylock(&(vp)->v_interlock)
403#define	VI_UNLOCK(vp)	mtx_unlock(&(vp)->v_interlock)
404#define	VI_MTX(vp)	(&(vp)->v_interlock)
405
406#endif /* _KERNEL */
407
408/*
409 * Mods for extensibility.
410 */
411
412/*
413 * Flags for vdesc_flags:
414 */
415#define	VDESC_MAX_VPS		16
416/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
417#define	VDESC_VP0_WILLRELE	0x0001
418#define	VDESC_VP1_WILLRELE	0x0002
419#define	VDESC_VP2_WILLRELE	0x0004
420#define	VDESC_VP3_WILLRELE	0x0008
421#define	VDESC_NOMAP_VPP		0x0100
422#define	VDESC_VPP_WILLRELE	0x0200
423
424/*
425 * A generic structure.
426 * This can be used by bypass routines to identify generic arguments.
427 */
428struct vop_generic_args {
429	struct vnodeop_desc *a_desc;
430	/* other random data follows, presumably */
431};
432
433typedef int vop_bypass_t(struct vop_generic_args *);
434
435/*
436 * VDESC_NO_OFFSET is used to identify the end of the offset list
437 * and in places where no such field exists.
438 */
439#define VDESC_NO_OFFSET -1
440
441/*
442 * This structure describes the vnode operation taking place.
443 */
444struct vnodeop_desc {
445	char	*vdesc_name;		/* a readable name for debugging */
446	int	 vdesc_flags;		/* VDESC_* flags */
447	vop_bypass_t	*vdesc_call;	/* Function to call */
448
449	/*
450	 * These ops are used by bypass routines to map and locate arguments.
451	 * Creds and procs are not needed in bypass routines, but sometimes
452	 * they are useful to (for example) transport layers.
453	 * Nameidata is useful because it has a cred in it.
454	 */
455	int	*vdesc_vp_offsets;	/* list ended by VDESC_NO_OFFSET */
456	int	vdesc_vpp_offset;	/* return vpp location */
457	int	vdesc_cred_offset;	/* cred location, if any */
458	int	vdesc_thread_offset;	/* thread location, if any */
459	int	vdesc_componentname_offset; /* if any */
460	/*
461	 * Finally, we've got a list of private data (about each operation)
462	 * for each transport layer.  (Support to manage this list is not
463	 * yet part of BSD.)
464	 */
465	caddr_t	*vdesc_transports;
466};
467
468#ifdef _KERNEL
469/*
470 * A list of all the operation descs.
471 */
472extern struct vnodeop_desc *vnodeop_descs[];
473
474#define	VOPARG_OFFSETOF(s_type, field)	__offsetof(s_type, field)
475#define	VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
476    ((s_type)(((char*)(struct_p)) + (s_offset)))
477
478
479#ifdef DEBUG_VFS_LOCKS
480/*
481 * Support code to aid in debugging VFS locking problems.  Not totally
482 * reliable since if the thread sleeps between changing the lock
483 * state and checking it with the assert, some other thread could
484 * change the state.  They are good enough for debugging a single
485 * filesystem using a single-threaded test.
486 */
487void	assert_vi_locked(struct vnode *vp, const char *str);
488void	assert_vi_unlocked(struct vnode *vp, const char *str);
489#if 0
490void	assert_vop_elocked(struct vnode *vp, const char *str);
491void	assert_vop_elocked_other(struct vnode *vp, const char *str);
492#endif
493void	assert_vop_locked(struct vnode *vp, const char *str);
494#if 0
495voi0	assert_vop_slocked(struct vnode *vp, const char *str);
496#endif
497void	assert_vop_unlocked(struct vnode *vp, const char *str);
498
499/* These are called from within the actual VOPS. */
500void	vop_lock_pre(void *a);
501void	vop_lock_post(void *a, int rc);
502void	vop_lookup_post(void *a, int rc);
503void	vop_lookup_pre(void *a);
504void	vop_rename_pre(void *a);
505void	vop_strategy_pre(void *a);
506void	vop_unlock_post(void *a, int rc);
507void	vop_unlock_pre(void *a);
508
509#define	ASSERT_VI_LOCKED(vp, str)	assert_vi_locked((vp), (str))
510#define	ASSERT_VI_UNLOCKED(vp, str)	assert_vi_unlocked((vp), (str))
511#if 0
512#define	ASSERT_VOP_ELOCKED(vp, str)	assert_vop_elocked((vp), (str))
513#define	ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
514#endif
515#define	ASSERT_VOP_LOCKED(vp, str)	assert_vop_locked((vp), (str))
516#if 0
517#define	ASSERT_VOP_SLOCKED(vp, str)	assert_vop_slocked((vp), (str))
518#endif
519#define	ASSERT_VOP_UNLOCKED(vp, str)	assert_vop_unlocked((vp), (str))
520
521#else /* !DEBUG_VFS_LOCKS */
522
523#define	ASSERT_VI_LOCKED(vp, str)
524#define	ASSERT_VI_UNLOCKED(vp, str)
525#if 0
526#define	ASSERT_VOP_ELOCKED(vp, str)
527#define	ASSERT_VOP_ELOCKED_OTHER(vp, str)
528#endif
529#define	ASSERT_VOP_LOCKED(vp, str)
530#if 0
531#define	ASSERT_VOP_SLOCKED(vp, str)
532#endif
533#define	ASSERT_VOP_UNLOCKED(vp, str)
534#endif /* DEBUG_VFS_LOCKS */
535
536
537/*
538 * This call works for vnodes in the kernel.
539 */
540#define VCALL(c) ((c)->a_desc->vdesc_call(c))
541
542/*
543 * VMIO support inline
544 */
545
546extern int vmiodirenable;
547
548static __inline int
549vn_canvmio(struct vnode *vp)
550{
551      if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
552		return(TRUE);
553	return(FALSE);
554}
555
556/*
557 * Finally, include the default set of vnode operations.
558 */
559#include "vnode_if.h"
560
561/*
562 * Public vnode manipulation functions.
563 */
564struct componentname;
565struct file;
566struct mount;
567struct nameidata;
568struct ostat;
569struct thread;
570struct proc;
571struct stat;
572struct nstat;
573struct ucred;
574struct uio;
575struct vattr;
576struct vnode;
577
578extern int	(*lease_check_hook)(struct vop_lease_args *);
579extern int	(*softdep_process_worklist_hook)(struct mount *);
580
581/* cache_* may belong in namei.h. */
582void	cache_enter(struct vnode *dvp, struct vnode *vp,
583	    struct componentname *cnp);
584int	cache_lookup(struct vnode *dvp, struct vnode **vpp,
585	    struct componentname *cnp);
586void	cache_purge(struct vnode *vp);
587void	cache_purgevfs(struct mount *mp);
588int	cache_leaf_test(struct vnode *vp);
589int	change_dir(struct vnode *vp, struct thread *td);
590int	change_root(struct vnode *vp, struct thread *td);
591void	cvtstat(struct stat *st, struct ostat *ost);
592void	cvtnstat(struct stat *sb, struct nstat *nsb);
593int	getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
594	    struct vnode **vpp);
595u_quad_t init_va_filerev(void);
596int	lease_check(struct vop_lease_args *ap);
597int	speedup_syncer(void);
598#define textvp_fullpath(p, rb, rfb) \
599	vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
600int	vn_fullpath(struct thread *td, struct vnode *vn,
601	    char **retbuf, char **freebuf);
602int	vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
603	    mode_t acc_mode, struct ucred *cred, int *privused);
604int	vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
605	    gid_t file_gid, struct acl *acl, mode_t acc_mode,
606	    struct ucred *cred, int *privused);
607void	vattr_null(struct vattr *vap);
608int	vcount(struct vnode *vp);
609void	vdrop(struct vnode *);
610void	vfs_add_vnodeops(const void *);
611void	vfs_rm_vnodeops(const void *);
612int	vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
613int	vget(struct vnode *vp, int lockflag, struct thread *td);
614void	vgone(struct vnode *vp);
615void	vgonel(struct vnode *vp, struct thread *td);
616void	vhold(struct vnode *);
617int	vinvalbuf(struct vnode *vp, int save,
618	    struct thread *td, int slpflag, int slptimeo);
619int	vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
620	    off_t length, int blksize);
621void	vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3);
622#define vprint(label, vp) vn_printf((vp), "%s\n", (label))
623int	vrecycle(struct vnode *vp, struct thread *td);
624int	vn_close(struct vnode *vp,
625	    int flags, struct ucred *file_cred, struct thread *td);
626void	vn_finished_write(struct mount *mp);
627int	vn_isdisk(struct vnode *vp, int *errp);
628int	vn_lock(struct vnode *vp, int flags, struct thread *td);
629#ifdef	DEBUG_LOCKS
630int	debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
631	    const char *filename, int line);
632#define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
633#endif
634int	vn_open(struct nameidata *ndp, int *flagp, int cmode, int fdidx);
635int	vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
636	    struct ucred *cred, int fdidx);
637int	vn_pollrecord(struct vnode *vp, struct thread *p, int events);
638int	vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
639	    int len, off_t offset, enum uio_seg segflg, int ioflg,
640	    struct ucred *active_cred, struct ucred *file_cred, int *aresid,
641	    struct thread *td);
642int	vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
643	    size_t len, off_t offset, enum uio_seg segflg, int ioflg,
644	    struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
645	    struct thread *td);
646int	vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
647	    struct ucred *file_cred, struct thread *td);
648int	vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
649int	vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
650	    int flags);
651int	vn_writechk(struct vnode *vp);
652int	vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
653	    const char *attrname, int *buflen, char *buf, struct thread *td);
654int	vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
655	    const char *attrname, int buflen, char *buf, struct thread *td);
656int	vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
657	    const char *attrname, struct thread *td);
658int	vfs_cache_lookup(struct vop_lookup_args *ap);
659void	vfs_timestamp(struct timespec *);
660void	vfs_write_resume(struct mount *mp);
661int	vfs_write_suspend(struct mount *mp);
662int	vop_stdbmap(struct vop_bmap_args *);
663int	vop_stdfsync(struct vop_fsync_args *);
664int	vop_stdgetwritemount(struct vop_getwritemount_args *);
665int	vop_stdgetpages(struct vop_getpages_args *);
666int	vop_stdinactive(struct vop_inactive_args *);
667int	vop_stdislocked(struct vop_islocked_args *);
668int	vop_stdlock(struct vop_lock_args *);
669int	vop_stdputpages(struct vop_putpages_args *);
670int	vop_stdunlock(struct vop_unlock_args *);
671int	vop_nopoll(struct vop_poll_args *);
672int	vop_stdpathconf(struct vop_pathconf_args *);
673int	vop_stdpoll(struct vop_poll_args *);
674int	vop_eopnotsupp(struct vop_generic_args *ap);
675int	vop_ebadf(struct vop_generic_args *ap);
676int	vop_einval(struct vop_generic_args *ap);
677int	vop_enotty(struct vop_generic_args *ap);
678int	vop_null(struct vop_generic_args *ap);
679int	vop_panic(struct vop_generic_args *ap);
680
681void	vfree(struct vnode *);
682void	vput(struct vnode *vp);
683void	vrele(struct vnode *vp);
684void	vref(struct vnode *vp);
685int	vrefcnt(struct vnode *vp);
686void 	v_addpollinfo(struct vnode *vp);
687
688int vnode_create_vobject(struct vnode *vp, size_t size, struct thread *td);
689void vnode_destroy_vobject(struct vnode *vp);
690
691extern struct vop_vector fifo_specops;
692extern struct vop_vector dead_vnodeops;
693extern struct vop_vector default_vnodeops;
694
695#define VOP_PANIC	((void*)(uintptr_t)vop_panic)
696#define VOP_NULL	((void*)(uintptr_t)vop_null)
697#define VOP_EBADF	((void*)(uintptr_t)vop_ebadf)
698#define VOP_ENOTTY	((void*)(uintptr_t)vop_enotty)
699#define VOP_EINVAL	((void*)(uintptr_t)vop_einval)
700#define VOP_EOPNOTSUPP	((void*)(uintptr_t)vop_eopnotsupp)
701
702
703#endif /* _KERNEL */
704
705#endif /* !_SYS_VNODE_H_ */
706