vnode.h revision 99426
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 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)vnode.h	8.7 (Berkeley) 2/4/94
34 * $FreeBSD: head/sys/sys/vnode.h 99426 2002-07-05 05:51:25Z jeff $
35 */
36
37#ifndef _SYS_VNODE_H_
38#define	_SYS_VNODE_H_
39
40/*
41 * XXX - compatability until lockmgr() goes away or all the #includes are
42 * updated.
43 */
44#include <sys/lockmgr.h>
45
46#include <sys/queue.h>
47#include <sys/_lock.h>
48#include <sys/_mutex.h>
49#include <sys/selinfo.h>
50#include <sys/uio.h>
51#include <sys/acl.h>
52#include <vm/uma.h>
53
54/*
55 * The vnode is the focus of all file activity in UNIX.  There is a
56 * unique vnode allocated for each active file, each current directory,
57 * each mounted-on file, text file, and the root.
58 */
59
60/*
61 * Vnode types.  VNON means no type.
62 */
63enum vtype	{ VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD };
64
65/*
66 * Vnode tag types.
67 * These are for the benefit of external programs only (e.g., pstat)
68 * and should NEVER be inspected by the kernel.
69 */
70enum vtagtype	{
71	VT_NON, VT_UFS, VT_NFS, VT_UNUSED, VT_PC, VT_LFS, VT_LOFS, VT_FDESC,
72	VT_PORTAL, VT_NULL, VT_UMAP, VT_KERNFS, VT_PROCFS, VT_AFS, VT_ISOFS,
73	VT_UNION, VT_MSDOSFS, VT_DEVFS, VT_TFS, VT_VFS, VT_CODA, VT_NTFS,
74	VT_HPFS, VT_NWFS, VT_PSEUDOFS, VT_SMBFS, VT_UDF
75};
76
77/*
78 * Each underlying filesystem allocates its own private area and hangs
79 * it from v_data.  If non-null, this area is freed in getnewvnode().
80 */
81TAILQ_HEAD(buflists, buf);
82
83typedef	int	vop_t(void *);
84struct namecache;
85
86struct vpollinfo {
87	struct	mtx vpi_lock;		/* lock to protect below */
88	struct	selinfo vpi_selinfo;	/* identity of poller(s) */
89	short	vpi_events;		/* what they are looking for */
90	short	vpi_revents;		/* what has happened */
91};
92
93/*
94 * Reading or writing any of these items requires holding the appropriate lock.
95 * v_freelist is locked by the global vnode_free_list mutex.
96 * v_mntvnodes is locked by the global mntvnodes mutex.
97 * v_flag, v_usecount, v_holdcount and v_writecount are
98 *    locked by the v_interlock mutex.
99 * v_pollinfo is locked by the lock contained inside it.
100 */
101struct vnode {
102	u_long	v_flag;				/* vnode flags (see below) */
103	int	v_usecount;			/* reference count of users */
104	int	v_writecount;			/* reference count of writers */
105	int	v_holdcnt;			/* page & buffer references */
106	u_long	v_id;				/* capability identifier */
107	struct	mount *v_mount;			/* ptr to vfs we are in */
108	vop_t	**v_op;				/* vnode operations vector */
109	TAILQ_ENTRY(vnode) v_freelist;		/* vnode freelist */
110	TAILQ_ENTRY(vnode) v_nmntvnodes;	/* vnodes for mount point */
111	struct	buflists v_cleanblkhd;		/* clean blocklist head */
112	struct	buflists v_dirtyblkhd;		/* dirty blocklist head */
113	LIST_ENTRY(vnode) v_synclist;		/* vnodes with dirty buffers */
114	long	v_numoutput;			/* num of writes in progress */
115	enum	vtype v_type;			/* vnode type */
116	union {
117		struct mount	*vu_mountedhere;/* ptr to mounted vfs (VDIR) */
118		struct socket	*vu_socket;	/* unix ipc (VSOCK) */
119		struct {
120			struct specinfo	*vu_specinfo; /* device (VCHR, VBLK) */
121			SLIST_ENTRY(vnode) vu_specnext;
122		} vu_spec;
123		struct fifoinfo	*vu_fifoinfo;	/* fifo (VFIFO) */
124	} v_un;
125	daddr_t	v_lastw;			/* last write (write cluster) */
126	daddr_t	v_cstart;			/* start block of cluster */
127	daddr_t	v_lasta;			/* last allocation (cluster) */
128	int	v_clen;				/* length of current cluster */
129	struct vm_object *v_object;		/* Place to store VM object */
130	struct	mtx v_interlock;		/* lock on usecount and flag */
131	struct	lock v_lock;			/* used if fs don't have one */
132	struct	lock *v_vnlock;			/* pointer to vnode lock */
133	enum	vtagtype v_tag;			/* type of underlying data */
134	void	*v_data;			/* private data for fs */
135	LIST_HEAD(, namecache) v_cache_src;	/* Cache entries from us */
136	TAILQ_HEAD(, namecache) v_cache_dst;	/* Cache entries to us */
137	struct	vnode *v_dd;			/* .. vnode */
138	u_long	v_ddid;				/* .. capability identifier */
139	struct vpollinfo *v_pollinfo;
140	struct thread *v_vxproc;		/* thread owning VXLOCK */
141#ifdef	DEBUG_LOCKS
142	const char *filename;			/* Source file doing locking */
143	int line;				/* Line number doing locking */
144#endif
145};
146#define	v_mountedhere	v_un.vu_mountedhere
147#define	v_socket	v_un.vu_socket
148#define	v_rdev		v_un.vu_spec.vu_specinfo
149#define	v_specnext	v_un.vu_spec.vu_specnext
150#define	v_fifoinfo	v_un.vu_fifoinfo
151
152#define	VN_POLLEVENT(vp, events)				\
153	do {							\
154		if ((vp)->v_pollinfo != NULL && 		\
155		    (vp)->v_pollinfo->vpi_events & (events))	\
156			vn_pollevent((vp), (events));		\
157	} while (0)
158
159#define VN_KNOTE(vp, b)						\
160	do {							\
161		if ((vp)->v_pollinfo != NULL)			\
162			KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b)); \
163	} while (0)
164
165/*
166 * Vnode flags.
167 */
168#define	VROOT		0x00001	/* root of its filesystem */
169#define	VTEXT		0x00002	/* vnode is a pure text prototype */
170#define	VSYSTEM		0x00004	/* vnode being used by kernel */
171#define	VISTTY		0x00008	/* vnode represents a tty */
172#define	VXLOCK		0x00100	/* vnode is locked to change underlying type */
173#define	VXWANT		0x00200	/* thread is waiting for vnode */
174#define	VBWAIT		0x00400	/* waiting for output to complete */
175#define	VNOSYNC		0x01000	/* unlinked, stop syncing */
176/* open for business    0x01000 */
177#define	VOBJBUF		0x02000	/* Allocate buffers in VM object */
178#define	VCOPYONWRITE    0x04000 /* vnode is doing copy-on-write */
179#define	VAGE		0x08000	/* Insert vnode at head of free list */
180#define	VOLOCK		0x10000	/* vnode is locked waiting for an object */
181#define	VOWANT		0x20000	/* a thread is waiting for VOLOCK */
182#define	VDOOMED		0x40000	/* This vnode is being recycled */
183#define	VFREE		0x80000	/* This vnode is on the freelist */
184/* open for business	0x100000 */
185#define	VONWORKLST	0x200000 /* On syncer work-list */
186#define	VMOUNT		0x400000 /* Mount in progress */
187#define	VOBJDIRTY	0x800000 /* object might be dirty */
188
189/*
190 * Vnode attributes.  A field value of VNOVAL represents a field whose value
191 * is unavailable (getattr) or which is not to be changed (setattr).
192 */
193struct vattr {
194	enum vtype	va_type;	/* vnode type (for create) */
195	u_short		va_mode;	/* files access mode and type */
196	short		va_nlink;	/* number of references to file */
197	uid_t		va_uid;		/* owner user id */
198	gid_t		va_gid;		/* owner group id */
199	udev_t		va_fsid;	/* filesystem id */
200	long		va_fileid;	/* file id */
201	u_quad_t	va_size;	/* file size in bytes */
202	long		va_blocksize;	/* blocksize preferred for i/o */
203	struct timespec	va_atime;	/* time of last access */
204	struct timespec	va_mtime;	/* time of last modification */
205	struct timespec	va_ctime;	/* time file changed */
206	struct timespec	va_createtime;	/* time file created */
207	u_long		va_gen;		/* generation number of file */
208	u_long		va_flags;	/* flags defined for file */
209	udev_t		va_rdev;	/* device the special file represents */
210	u_quad_t	va_bytes;	/* bytes of disk space held by file */
211	u_quad_t	va_filerev;	/* file modification number */
212	u_int		va_vaflags;	/* operations flags, see below */
213	long		va_spare;	/* remain quad aligned */
214};
215
216/*
217 * Flags for va_vaflags.
218 */
219#define	VA_UTIMES_NULL	0x01		/* utimes argument was NULL */
220#define	VA_EXCLUSIVE	0x02		/* exclusive create request */
221
222/*
223 * Flags for ioflag. (high 16 bits used to ask for read-ahead and
224 * help with write clustering)
225 */
226#define	IO_UNIT		0x01		/* do I/O as atomic unit */
227#define	IO_APPEND	0x02		/* append write to end */
228#define	IO_SYNC		0x04		/* do I/O synchronously */
229#define	IO_NODELOCKED	0x08		/* underlying node already locked */
230#define	IO_NDELAY	0x10		/* FNDELAY flag set in file table */
231#define	IO_VMIO		0x20		/* data already in VMIO space */
232#define	IO_INVAL	0x40		/* invalidate after I/O */
233#define	IO_ASYNC	0x80		/* bawrite rather then bdwrite */
234#define IO_DIRECT	0x100		/* attempt to bypass buffer cache */
235#define IO_NOWDRAIN	0x200		/* do not block on wdrain */
236
237/*
238 *  Modes.  Some values same as Ixxx entries from inode.h for now.
239 */
240#define	VADMIN	010000		/* permission to administer vnode */
241#define	VSUID	004000		/* set user id on execution */
242#define	VSGID	002000		/* set group id on execution */
243#define	VSVTX	001000		/* save swapped text even after use */
244#define	VREAD	000400		/* read, write, execute permissions */
245#define	VWRITE	000200
246#define	VEXEC	000100
247
248/*
249 * Token indicating no attribute value yet assigned.
250 */
251#define	VNOVAL	(-1)
252
253/*
254 * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
255 */
256#define VLKTIMEOUT	(hz / 20 + 1)
257
258#ifdef _KERNEL
259
260#ifdef MALLOC_DECLARE
261MALLOC_DECLARE(M_VNODE);
262#endif
263
264/*
265 * Convert between vnode types and inode formats (since POSIX.1
266 * defines mode word of stat structure in terms of inode formats).
267 */
268extern enum vtype	iftovt_tab[];
269extern int		vttoif_tab[];
270#define	IFTOVT(mode)	(iftovt_tab[((mode) & S_IFMT) >> 12])
271#define	VTTOIF(indx)	(vttoif_tab[(int)(indx)])
272#define	MAKEIMODE(indx, mode)	(int)(VTTOIF(indx) | (mode))
273
274/*
275 * Flags to various vnode functions.
276 */
277#define	SKIPSYSTEM	0x0001	/* vflush: skip vnodes marked VSYSTEM */
278#define	FORCECLOSE	0x0002	/* vflush: force file closure */
279#define	WRITECLOSE	0x0004	/* vflush: only close writable files */
280#define	DOCLOSE		0x0008	/* vclean: close active files */
281#define	V_SAVE		0x0001	/* vinvalbuf: sync file first */
282#define	REVOKEALL	0x0001	/* vop_revoke: revoke all aliases */
283#define	V_WAIT		0x0001	/* vn_start_write: sleep for suspend */
284#define	V_NOWAIT	0x0002	/* vn_start_write: don't sleep for suspend */
285#define	V_XSLEEP	0x0004	/* vn_start_write: just return after sleep */
286
287#define	VREF(vp)	vref(vp)
288
289
290#ifdef DIAGNOSTIC
291#define	VATTR_NULL(vap)	vattr_null(vap)
292#else
293#define	VATTR_NULL(vap)	(*(vap) = va_null)	/* initialize a vattr */
294#endif /* DIAGNOSTIC */
295
296#define	NULLVP	((struct vnode *)NULL)
297
298#define	VNODEOP_SET(f) \
299	C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \
300	C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f);
301
302/*
303 * Global vnode data.
304 */
305extern	struct vnode *rootvnode;	/* root (i.e. "/") vnode */
306extern	int desiredvnodes;		/* number of vnodes desired */
307extern	uma_zone_t namei_zone;
308extern	int prtactive;			/* nonzero to call vprint() */
309extern	struct vattr va_null;		/* predefined null vattr structure */
310extern	int vfs_ioopt;
311
312/*
313 * Macro/function to check for client cache inconsistency w.r.t. leasing.
314 */
315#define	LEASE_READ	0x1		/* Check lease for readers */
316#define	LEASE_WRITE	0x2		/* Check lease for modifiers */
317
318
319extern void	(*lease_updatetime)(int deltat);
320
321#define	VSHOULDFREE(vp)	\
322	(!((vp)->v_flag & (VFREE|VDOOMED)) && \
323	 !(vp)->v_holdcnt && !(vp)->v_usecount && \
324	 (!(vp)->v_object || \
325	  !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count)))
326
327#define VMIGHTFREE(vp) \
328	(!((vp)->v_flag & (VFREE|VDOOMED|VXLOCK)) &&	\
329	 LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount)
330
331#define	VSHOULDBUSY(vp)	\
332	(((vp)->v_flag & VFREE) && \
333	 ((vp)->v_holdcnt || (vp)->v_usecount))
334
335#define	VI_LOCK(vp)	mtx_lock(&(vp)->v_interlock)
336#define	VI_TRYLOCK(vp)	mtx_trylock(&(vp)->v_interlock)
337#define	VI_UNLOCK(vp)	mtx_unlock(&(vp)->v_interlock)
338
339#endif /* _KERNEL */
340
341
342/*
343 * Mods for extensibility.
344 */
345
346/*
347 * Flags for vdesc_flags:
348 */
349#define	VDESC_MAX_VPS		16
350/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
351#define	VDESC_VP0_WILLRELE	0x0001
352#define	VDESC_VP1_WILLRELE	0x0002
353#define	VDESC_VP2_WILLRELE	0x0004
354#define	VDESC_VP3_WILLRELE	0x0008
355#define	VDESC_NOMAP_VPP		0x0100
356#define	VDESC_VPP_WILLRELE	0x0200
357
358/*
359 * VDESC_NO_OFFSET is used to identify the end of the offset list
360 * and in places where no such field exists.
361 */
362#define VDESC_NO_OFFSET -1
363
364/*
365 * This structure describes the vnode operation taking place.
366 */
367struct vnodeop_desc {
368	int	 vdesc_offset;		/* offset in vector,first for speed */
369	char	*vdesc_name;		/* a readable name for debugging */
370	int	 vdesc_flags;		/* VDESC_* flags */
371
372	/*
373	 * These ops are used by bypass routines to map and locate arguments.
374	 * Creds and procs are not needed in bypass routines, but sometimes
375	 * they are useful to (for example) transport layers.
376	 * Nameidata is useful because it has a cred in it.
377	 */
378	int	*vdesc_vp_offsets;	/* list ended by VDESC_NO_OFFSET */
379	int	vdesc_vpp_offset;	/* return vpp location */
380	int	vdesc_cred_offset;	/* cred location, if any */
381	int	vdesc_thread_offset;	/* thread location, if any */
382	int	vdesc_componentname_offset; /* if any */
383	/*
384	 * Finally, we've got a list of private data (about each operation)
385	 * for each transport layer.  (Support to manage this list is not
386	 * yet part of BSD.)
387	 */
388	caddr_t	*vdesc_transports;
389};
390
391#ifdef _KERNEL
392/*
393 * A list of all the operation descs.
394 */
395extern struct vnodeop_desc *vnodeop_descs[];
396
397/*
398 * Interlock for scanning list of vnodes attached to a mountpoint
399 */
400extern struct mtx mntvnode_mtx;
401
402/*
403 * This macro is very helpful in defining those offsets in the vdesc struct.
404 *
405 * This is stolen from X11R4.  I ignored all the fancy stuff for
406 * Crays, so if you decide to port this to such a serious machine,
407 * you might want to consult Intrinsic.h's XtOffset{,Of,To}.
408 */
409#define	VOPARG_OFFSET(p_type,field) \
410	((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
411#define	VOPARG_OFFSETOF(s_type,field) \
412	VOPARG_OFFSET(s_type*,field)
413#define	VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
414	((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
415
416
417/*
418 * This structure is used to configure the new vnodeops vector.
419 */
420struct vnodeopv_entry_desc {
421	struct vnodeop_desc *opve_op;   /* which operation this is */
422	vop_t *opve_impl;		/* code implementing this operation */
423};
424struct vnodeopv_desc {
425			/* ptr to the ptr to the vector where op should go */
426	vop_t ***opv_desc_vector_p;
427	struct vnodeopv_entry_desc *opv_desc_ops;   /* null terminated list */
428};
429
430/*
431 * A generic structure.
432 * This can be used by bypass routines to identify generic arguments.
433 */
434struct vop_generic_args {
435	struct vnodeop_desc *a_desc;
436	/* other random data follows, presumably */
437};
438
439
440#ifdef DEBUG_VFS_LOCKS
441/*
442 * Macros to aid in tracing VFS locking problems.  Not totally
443 * reliable since if the thread sleeps between changing the lock
444 * state and checking it with the assert, some other thread could
445 * change the state.  They are good enough for debugging a single
446 * filesystem using a single-threaded test.  I find that 'cvs co src'
447 * is a pretty good test.
448 */
449
450extern int vfs_badlock_panic;
451extern int vfs_badlock_print;
452
453/*
454 * [dfr] Kludge until I get around to fixing all the vfs locking.
455 */
456#define IS_LOCKING_VFS(vp)	(  ((vp)->v_tag == VT_UFS		\
457				 || (vp)->v_tag == VT_NFS		\
458				 || (vp)->v_tag == VT_LFS		\
459				 || (vp)->v_tag == VT_ISOFS		\
460				 || (vp)->v_tag == VT_MSDOSFS		\
461				 || (vp)->v_tag == VT_DEVFS		\
462				 || (vp)->v_tag == VT_UDF)		\
463				 && ((vp)->v_type != VBLK		\
464				 && (vp)->v_type != VCHR) )
465
466#define ASSERT_VOP_LOCKED(vp, str)					\
467do {									\
468	struct vnode *_vp = (vp);					\
469									\
470	if (_vp && IS_LOCKING_VFS(_vp) && !VOP_ISLOCKED(_vp, NULL)) {	\
471		if (vfs_badlock_print)					\
472			printf("%s: %p is not locked but should be\n",	\
473			    str, _vp);					\
474		if (vfs_badlock_panic)					\
475			Debugger("Lock violation.\n");			\
476	}								\
477} while (0)
478
479#define ASSERT_VOP_UNLOCKED(vp, str)					\
480do {									\
481	struct vnode *_vp = (vp);					\
482	int lockstate;							\
483									\
484	if (_vp && IS_LOCKING_VFS(_vp)) {				\
485		lockstate = VOP_ISLOCKED(_vp, curthread);		\
486		if (lockstate == LK_EXCLUSIVE) {			\
487			if (vfs_badlock_print)				\
488				printf("%s: %p is locked but should not be\n",	\
489				    str, _vp);				\
490			if (vfs_badlock_panic)				\
491				Debugger("Lock Violation.\n");		\
492		}							\
493	}								\
494} while (0)
495
496#define ASSERT_VOP_ELOCKED(vp, str)					\
497do {									\
498	struct vnode *_vp = (vp);					\
499									\
500	if (_vp && IS_LOCKING_VFS(_vp) &&				\
501	    VOP_ISLOCKED(_vp, curthread) != LK_EXCLUSIVE)			\
502		panic("%s: %p is not exclusive locked but should be",	\
503		    str, _vp);						\
504} while (0)
505
506#define ASSERT_VOP_ELOCKED_OTHER(vp, str)				\
507do {									\
508	struct vnode *_vp = (vp);					\
509									\
510	if (_vp && IS_LOCKING_VFS(_vp) &&				\
511	    VOP_ISLOCKED(_vp, curthread) != LK_EXCLOTHER)			\
512		panic("%s: %p is not exclusive locked by another thread",	\
513		    str, _vp);						\
514} while (0)
515
516#define ASSERT_VOP_SLOCKED(vp, str)					\
517do {									\
518	struct vnode *_vp = (vp);					\
519									\
520	if (_vp && IS_LOCKING_VFS(_vp) &&				\
521	    VOP_ISLOCKED(_vp, NULL) != LK_SHARED)			\
522		panic("%s: %p is not locked shared but should be",	\
523		    str, _vp);						\
524} while (0)
525
526#else
527
528#define ASSERT_VOP_LOCKED(vp, str)
529#define ASSERT_VOP_UNLOCKED(vp, str)
530
531#endif
532
533/*
534 * VOCALL calls an op given an ops vector.  We break it out because BSD's
535 * vclean changes the ops vector and then wants to call ops with the old
536 * vector.
537 */
538#define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
539
540/*
541 * This call works for vnodes in the kernel.
542 */
543#define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
544#define VDESC(OP) (& __CONCAT(OP,_desc))
545#define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
546
547/*
548 * VMIO support inline
549 */
550
551extern int vmiodirenable;
552
553static __inline int
554vn_canvmio(struct vnode *vp)
555{
556      if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
557		return(TRUE);
558	return(FALSE);
559}
560
561/*
562 * Finally, include the default set of vnode operations.
563 */
564#include "vnode_if.h"
565
566/*
567 * Public vnode manipulation functions.
568 */
569struct componentname;
570struct file;
571struct mount;
572struct nameidata;
573struct ostat;
574struct thread;
575struct proc;
576struct stat;
577struct nstat;
578struct ucred;
579struct uio;
580struct vattr;
581struct vnode;
582
583extern int	(*lease_check_hook)(struct vop_lease_args *);
584extern int	(*softdep_fsync_hook)(struct vnode *);
585extern int	(*softdep_process_worklist_hook)(struct mount *);
586
587struct	vnode *addaliasu(struct vnode *vp, udev_t nvp_rdev);
588int	bdevvp(dev_t dev, struct vnode **vpp);
589/* cache_* may belong in namei.h. */
590void	cache_enter(struct vnode *dvp, struct vnode *vp,
591	    struct componentname *cnp);
592int	cache_lookup(struct vnode *dvp, struct vnode **vpp,
593	    struct componentname *cnp);
594void	cache_purge(struct vnode *vp);
595void	cache_purgevfs(struct mount *mp);
596int	cache_leaf_test(struct vnode *vp);
597void	cvtstat(struct stat *st, struct ostat *ost);
598void	cvtnstat(struct stat *sb, struct nstat *nsb);
599int	getnewvnode(enum vtagtype tag,
600	    struct mount *mp, vop_t **vops, struct vnode **vpp);
601int	lease_check(struct vop_lease_args *ap);
602int	spec_vnoperate(struct vop_generic_args *);
603int	speedup_syncer(void);
604#define textvp_fullpath(p, rb, rfb) \
605	vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
606int	vn_fullpath(struct thread *td, struct vnode *vn,
607	    char **retbuf, char **freebuf);
608int	vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
609	    mode_t acc_mode, struct ucred *cred, int *privused);
610int	vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
611	    gid_t file_gid, struct acl *acl, mode_t acc_mode,
612	    struct ucred *cred, int *privused);
613void	vattr_null(struct vattr *vap);
614int	vcount(struct vnode *vp);
615void	vdrop(struct vnode *);
616int	vfinddev(dev_t dev, enum vtype type, struct vnode **vpp);
617void	vfs_add_vnodeops(const void *);
618void	vfs_rm_vnodeops(const void *);
619int	vflush(struct mount *mp, int rootrefs, int flags);
620int	vget(struct vnode *vp, int lockflag, struct thread *td);
621void	vgone(struct vnode *vp);
622void	vgonel(struct vnode *vp, struct thread *td);
623void	vhold(struct vnode *);
624int	vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
625	    struct thread *td, int slpflag, int slptimeo);
626int	vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
627	    off_t length, int blksize);
628void	vprint(char *label, struct vnode *vp);
629int	vrecycle(struct vnode *vp, struct mtx *inter_lkp,
630	    struct thread *td);
631int	vn_close(struct vnode *vp,
632	    int flags, struct ucred *cred, struct thread *td);
633void	vn_finished_write(struct mount *mp);
634int	vn_isdisk(struct vnode *vp, int *errp);
635int	vn_lock(struct vnode *vp, int flags, struct thread *td);
636#ifdef	DEBUG_LOCKS
637int	debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
638	    const char *filename, int line);
639#define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
640#endif
641int	vn_mkdir(char *path, int mode, enum uio_seg segflg, struct thread *td);
642int	vn_open(struct nameidata *ndp, int *flagp, int cmode);
643int	vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
644	    struct ucred *cred);
645void	vn_pollevent(struct vnode *vp, int events);
646void	vn_pollgone(struct vnode *vp);
647int	vn_pollrecord(struct vnode *vp, struct thread *p, int events);
648int	vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
649	    int len, off_t offset, enum uio_seg segflg, int ioflg,
650	    struct ucred *cred, int *aresid, struct thread *td);
651int	vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
652	    int len, off_t offset, enum uio_seg segflg, int ioflg,
653	    struct ucred *cred, int *aresid, struct thread *td);
654int	vn_stat(struct vnode *vp, struct stat *sb, struct thread *td);
655int	vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
656dev_t	vn_todev(struct vnode *vp);
657int	vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
658	    int flags);
659int	vn_writechk(struct vnode *vp);
660int	vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
661	    const char *attrname, int *buflen, char *buf, struct thread *td);
662int	vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
663	    const char *attrname, int buflen, char *buf, struct thread *td);
664int	vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
665	    const char *attrname, struct thread *td);
666int	vfs_cache_lookup(struct vop_lookup_args *ap);
667int	vfs_object_create(struct vnode *vp, struct thread *td,
668	    struct ucred *cred);
669void	vfs_timestamp(struct timespec *);
670void	vfs_write_resume(struct mount *mp);
671void	vfs_write_suspend(struct mount *mp);
672int	vop_stdbmap(struct vop_bmap_args *);
673int	vop_stdgetwritemount(struct vop_getwritemount_args *);
674int	vop_stdgetpages(struct vop_getpages_args *);
675int	vop_stdinactive(struct vop_inactive_args *);
676int	vop_stdislocked(struct vop_islocked_args *);
677int	vop_stdlock(struct vop_lock_args *);
678int	vop_stdputpages(struct vop_putpages_args *);
679int	vop_stdunlock(struct vop_unlock_args *);
680int	vop_noislocked(struct vop_islocked_args *);
681int	vop_nolock(struct vop_lock_args *);
682int	vop_nopoll(struct vop_poll_args *);
683int	vop_nounlock(struct vop_unlock_args *);
684int	vop_stdpathconf(struct vop_pathconf_args *);
685int	vop_stdpoll(struct vop_poll_args *);
686int	vop_revoke(struct vop_revoke_args *);
687int	vop_sharedlock(struct vop_lock_args *);
688int	vop_eopnotsupp(struct vop_generic_args *ap);
689int	vop_ebadf(struct vop_generic_args *ap);
690int	vop_einval(struct vop_generic_args *ap);
691int	vop_enotty(struct vop_generic_args *ap);
692int	vop_defaultop(struct vop_generic_args *ap);
693int	vop_null(struct vop_generic_args *ap);
694int	vop_panic(struct vop_generic_args *ap);
695int	vop_stdcreatevobject(struct vop_createvobject_args *ap);
696int	vop_stddestroyvobject(struct vop_destroyvobject_args *ap);
697int	vop_stdgetvobject(struct vop_getvobject_args *ap);
698
699void	vfree(struct vnode *);
700void	vput(struct vnode *vp);
701void	vrele(struct vnode *vp);
702void	vref(struct vnode *vp);
703void	vbusy(struct vnode *vp);
704void 	v_addpollinfo(struct vnode *vp);
705
706extern	vop_t **default_vnodeop_p;
707extern	vop_t **spec_vnodeop_p;
708extern	vop_t **dead_vnodeop_p;
709
710#endif /* _KERNEL */
711
712#endif /* !_SYS_VNODE_H_ */
713