Remove owi(4) from build.
[dragonfly.git] / sys / sys / vnode.h
CommitLineData
984263bc
MD
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: src/sys/sys/vnode.h,v 1.111.2.19 2002/12/29 18:19:53 dillon Exp $
7540ab49 35 * $DragonFly: src/sys/sys/vnode.h,v 1.45 2006/03/29 18:44:52 dillon Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_VNODE_H_
39#define _SYS_VNODE_H_
40
41#include <sys/queue.h>
42#include <sys/lock.h>
43#include <sys/select.h>
81b5c339 44#include <sys/biotrack.h>
984263bc
MD
45#include <sys/uio.h>
46#include <sys/acl.h>
7ea21ed1 47#include <sys/namecache.h>
77a8676e
HP
48#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
49#include <sys/thread.h>
50#endif
0961aa92
MD
51#include <sys/vfsops.h>
52#include <sys/vfscache.h>
6bae6177 53#include <sys/tree.h>
77a8676e 54
984263bc
MD
55#include <machine/lock.h>
56
57/*
58 * The vnode is the focus of all file activity in UNIX. There is a
59 * unique vnode allocated for each active file, each current directory,
60 * each mounted-on file, text file, and the root.
61 */
62
984263bc
MD
63/*
64 * Each underlying filesystem allocates its own private area and hangs
65 * it from v_data. If non-null, this area is freed in getnewvnode().
66 */
67TAILQ_HEAD(buflists, buf);
68
6ddb7618
MD
69/*
70 * Range locks protect offset ranges in files and directories at a high
71 * level, allowing the actual I/O to be broken down into smaller pieces.
72 * Range locks will eventually be integrated into the clustered cache
73 * coherency infrastructure.
74 *
75 * We use a simple data structure for now, but eventually this should
76 * probably be a btree or red-black tree.
77 */
78struct vrangelock;
79
80TAILQ_HEAD(vrangelock_list, vrangelock);
81
82struct vrangehead {
83 struct vrangelock_list vh_list;
84};
85
86struct vrangelock {
87 TAILQ_ENTRY(vrangelock) vr_node;
88 int vr_flags;
89 off_t vr_offset;
90 off_t vr_length;
91};
92
93#define RNGL_WAITING 0x0001 /* waiting for lock, else has lock */
94#define RNGL_CHECK 0x0002 /* check for work on unlock */
95#define RNGL_SHARED 0x0004 /* shared lock, else exclusive */
96#define RNGL_ONLIST 0x0008 /* sanity check */
97
98static __inline
99void
100vrange_init(struct vrangelock *vr, int flags, off_t offset, off_t length)
101{
102 vr->vr_flags = flags;
103 vr->vr_offset = offset;
104 vr->vr_length = length;
105}
106
107#ifdef _KERNEL
108
109void vrange_lock(struct vnode *vp, struct vrangelock *vr);
110void vrange_unlock(struct vnode *vp, struct vrangelock *vr);
111
112static __inline
113void
114vrange_lock_shared(struct vnode *vp, struct vrangelock *vr,
115 off_t offset, off_t length)
116{
117 vrange_init(vr, RNGL_SHARED, offset, length);
118 vrange_lock(vp, vr);
119}
120
121static __inline
122void
123vrange_lock_excl(struct vnode *vp, struct vrangelock *vr,
124 off_t offset, off_t length)
125{
126 vrange_init(vr, 0, offset, length);
127 vrange_lock(vp, vr);
128}
129
130#endif
0961aa92 131
984263bc 132/*
6ddb7618
MD
133 * The vnode infrastructure is being reorgranized. Most reference-related
134 * fields are locked by the BGL, and most file I/O related operations and
135 * vnode teardown functions are locked by the vnode lock.
136 *
137 * File read operations require a shared lock, file write operations require
138 * an exclusive lock. Most directory operations (read or write) currently
139 * require an exclusive lock due to the side effects stored in the directory
140 * inode (which we intend to fix).
141 *
142 * File reads and writes are further protected by a range lock. The intention
143 * is to be able to break I/O operations down into more easily managed pieces
144 * so vm_page arrays can be passed through rather then UIOs. This work will
145 * occur in multiple stages. The range locks will also eventually be used to
146 * deal with clustered cache coherency issues and, more immediately, to
147 * protect operations associated with the kernel-managed journaling module.
e4c9c0c8 148 *
3446c007
MD
149 * NOTE: XXX v_opencount currently only used by specfs. It should be used
150 * universally.
151 *
6ddb7618
MD
152 * NOTE: The vnode operations vector, v_ops, is a double-indirect that
153 * typically points to &v_mount->mnt_vn_use_ops. We use a double
154 * pointer because mnt_vn_use_ops may change dynamically when e.g.
155 * journaling is turned on or off.
57f7b636
MD
156 *
157 * NOTE: v_filesize is currently only applicable when a VM object is
158 * associated with the vnode. Otherwise it will be set to NOOFFSET.
984263bc 159 */
6bae6177 160RB_HEAD(buf_rb_tree, buf);
1f1ea522 161RB_HEAD(buf_rb_hash, buf);
6bae6177 162
984263bc
MD
163struct vnode {
164 u_long v_flag; /* vnode flags (see below) */
165 int v_usecount; /* reference count of users */
81b5c339 166 int v_writecount;
984263bc 167 int v_holdcnt; /* page & buffer references */
e4c9c0c8 168 int v_opencount; /* number of explicit opens */
81b5c339
MD
169 struct bio_track v_track_read; /* track I/O's in progress */
170 struct bio_track v_track_write; /* track I/O's in progress */
984263bc
MD
171 u_long v_id; /* capability identifier */
172 struct mount *v_mount; /* ptr to vfs we are in */
6ddb7618 173 struct vop_ops **v_ops; /* vnode operations vector */
984263bc
MD
174 TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist */
175 TAILQ_ENTRY(vnode) v_nmntvnodes; /* vnodes for mount point */
6bae6177 176 struct buf_rb_tree v_rbclean_tree; /* RB tree of clean bufs */
54df1108 177 struct buf_rb_tree v_rbdirty_tree; /* RB tree of dirty bufs */
1f1ea522 178 struct buf_rb_hash v_rbhash_tree; /* RB tree general lookup */
984263bc 179 LIST_ENTRY(vnode) v_synclist; /* vnodes with dirty buffers */
984263bc
MD
180 enum vtype v_type; /* vnode type */
181 union {
182 struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */
183 struct socket *vu_socket; /* unix ipc (VSOCK) */
184 struct {
e4c9c0c8 185 udev_t vu_udev; /* device number for attach */
984263bc
MD
186 struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */
187 SLIST_ENTRY(vnode) vu_specnext;
188 } vu_spec;
189 struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */
190 } v_un;
57f7b636 191 off_t v_filesize; /* file EOF or NOOFFSET */
54078292
MD
192 off_t v_lazyw; /* lazy write iterator */
193 off_t v_lastw; /* last write (write cluster) */
194 off_t v_cstart; /* start block of cluster */
195 off_t v_lasta; /* last allocation */
984263bc
MD
196 int v_clen; /* length of current cluster */
197 struct vm_object *v_object; /* Place to store VM object */
3446c007 198 struct lock v_lock; /* file/dir ops lock */
984263bc 199 enum vtagtype v_tag; /* type of underlying data */
597aea93 200 void *v_data; /* private data for fs */
7ea21ed1 201 struct namecache_list v_namecache; /* associated nc entries */
984263bc 202 struct {
8a8d5d85 203 struct lwkt_token vpi_token; /* lock to protect below */
984263bc
MD
204 struct selinfo vpi_selinfo; /* identity of poller(s) */
205 short vpi_events; /* what they are looking for */
206 short vpi_revents; /* what has happened */
207 } v_pollinfo;
29802dbb 208 struct vmresident *v_resident; /* optional vmresident */
6ddb7618 209 struct vrangehead v_range; /* range lock */
984263bc
MD
210#ifdef DEBUG_LOCKS
211 const char *filename; /* Source file doing locking */
212 int line; /* Line number doing locking */
213#endif
5fd012e0 214 void *v_xaddr;
984263bc
MD
215};
216#define v_mountedhere v_un.vu_mountedhere
217#define v_socket v_un.vu_socket
e4c9c0c8 218#define v_udev v_un.vu_spec.vu_udev
984263bc
MD
219#define v_rdev v_un.vu_spec.vu_specinfo
220#define v_specnext v_un.vu_spec.vu_specnext
221#define v_fifoinfo v_un.vu_fifoinfo
222
223#define VN_POLLEVENT(vp, events) \
224 do { \
225 if ((vp)->v_pollinfo.vpi_events & (events)) \
226 vn_pollevent((vp), (events)); \
227 } while (0)
228
229/*
230 * Vnode flags.
231 */
232#define VROOT 0x00001 /* root of its file system */
233#define VTEXT 0x00002 /* vnode is a pure text prototype */
234#define VSYSTEM 0x00004 /* vnode being used by kernel */
235#define VISTTY 0x00008 /* vnode represents a tty */
5fd012e0 236#define VCTTYISOPEN 0x00010 /* controlling terminal tty is open */
12693083 237#define VCKPT 0x00020 /* checkpoint-restored vnode */
5fd012e0
MD
238/* open for business 0x00040 */
239/* open for business 0x00080 */
240/* open for business 0x00100 */
241/* open for business 0x00200 */
81b5c339 242/* open for business 0x00400 */
984263bc
MD
243/* open for business 0x00800 */
244/* open for business 0x01000 */
245#define VOBJBUF 0x02000 /* Allocate buffers in VM object */
5fd012e0 246#define VINACTIVE 0x04000 /* The vnode is inactive */
984263bc
MD
247#define VAGE 0x08000 /* Insert vnode at head of free list */
248#define VOLOCK 0x10000 /* vnode is locked waiting for an object */
249#define VOWANT 0x20000 /* a process is waiting for VOLOCK */
5fd012e0 250#define VRECLAIMED 0x40000 /* This vnode has been destroyed */
984263bc 251#define VFREE 0x80000 /* This vnode is on the freelist */
5fd012e0 252/* open for business 0x100000 */
984263bc
MD
253#define VONWORKLST 0x200000 /* On syncer work-list */
254#define VMOUNT 0x400000 /* Mount in progress */
597aea93 255#define VOBJDIRTY 0x800000 /* object might be dirty */
984263bc 256
5fd012e0
MD
257/*
258 * vmntvnodescan() flags
259 */
260#define VMSC_GETVP 1
261#define VMSC_GETVX 2
262#define VMSC_REFVP 3
263#define VMSC_NOWAIT 0x10
264
984263bc
MD
265/*
266 * Flags for ioflag. (high 16 bits used to ask for read-ahead and
267 * help with write clustering)
268 */
908b5ff6
MD
269#define IO_UNIT 0x0001 /* do I/O as atomic unit */
270#define IO_APPEND 0x0002 /* append write to end */
271#define IO_SYNC 0x0004 /* do I/O synchronously */
272#define IO_NODELOCKED 0x0008 /* underlying node already locked */
273#define IO_NDELAY 0x0010 /* FNDELAY flag set in file table */
274#define IO_VMIO 0x0020 /* data already in VMIO space */
275#define IO_INVAL 0x0040 /* invalidate after I/O */
276#define IO_ASYNC 0x0080 /* bawrite rather then bdwrite */
597aea93
DR
277#define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */
278#define IO_NOWDRAIN 0x0200 /* do not block on wdrain */
279#define IO_CORE 0x0400 /* I/O is part of core dump */
984263bc 280
597aea93
DR
281#define IO_SEQMAX 0x7F /* seq heuristic max value */
282#define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */
984263bc
MD
283
284/*
21739618
MD
285 * Modes. Note that these V-modes must match file S_I*USR, SUID, SGID,
286 * and SVTX flag bits.
287 *
288 * VCREATE, VDELETE, and VEXCL may only be used in naccess() calls.
984263bc 289 */
21739618
MD
290#define VDELETE 040000 /* delete if the file/dir exists */
291#define VCREATE 020000 /* create if the file/dir does not exist */
292#define VEXCL 010000 /* error if the file/dir already exists */
293
984263bc
MD
294#define VSUID 04000 /* set user id on execution */
295#define VSGID 02000 /* set group id on execution */
296#define VSVTX 01000 /* save swapped text even after use */
297#define VREAD 00400 /* read, write, execute permissions */
298#define VWRITE 00200
299#define VEXEC 00100
300
301/*
302 * Token indicating no attribute value yet assigned.
303 */
304#define VNOVAL (-1)
305
306/*
307 * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
308 */
597aea93 309#define VLKTIMEOUT (hz / 20 + 1)
984263bc
MD
310
311#ifdef _KERNEL
312
984263bc
MD
313/*
314 * Convert between vnode types and inode formats (since POSIX.1
315 * defines mode word of stat structure in terms of inode formats).
316 */
597aea93
DR
317extern enum vtype iftovt_tab[];
318extern int vttoif_tab[];
319#define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12])
320#define VTTOIF(indx) (vttoif_tab[(int)(indx)])
321#define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode))
984263bc
MD
322
323/*
324 * Flags to various vnode functions.
325 */
326#define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */
327#define FORCECLOSE 0x0002 /* vflush: force file closure */
328#define WRITECLOSE 0x0004 /* vflush: only close writable files */
329#define DOCLOSE 0x0008 /* vclean: close active files */
330#define V_SAVE 0x0001 /* vinvalbuf: sync file first */
331#define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */
332
984263bc
MD
333#ifdef DIAGNOSTIC
334#define VATTR_NULL(vap) vattr_null(vap)
335#else
336#define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
337#endif /* DIAGNOSTIC */
338
339#define NULLVP ((struct vnode *)NULL)
340
341#define VNODEOP_SET(f) \
0961aa92
MD
342 C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops_sysinit, &f); \
343 C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND,vfs_rm_vnodeops_sysinit, &f);
984263bc
MD
344
345/*
346 * Global vnode data.
347 */
348extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
21739618 349extern struct namecache *rootncp; /* root (i.e. "/") namecache */
984263bc
MD
350extern int desiredvnodes; /* number of vnodes desired */
351extern time_t syncdelay; /* max time to delay syncing data */
352extern time_t filedelay; /* time to delay syncing files */
353extern time_t dirdelay; /* time to delay syncing directories */
354extern time_t metadelay; /* time to delay syncing metadata */
355extern struct vm_zone *namei_zone;
356extern int prtactive; /* nonzero to call vprint() */
357extern struct vattr va_null; /* predefined null vattr structure */
358extern int vfs_ioopt;
5fd012e0
MD
359extern int numvnodes;
360extern int freevnodes;
fad57d0e 361extern int vfs_fastdev; /* fast specfs device access */
984263bc 362
984263bc
MD
363#endif /* _KERNEL */
364
984263bc
MD
365/*
366 * Mods for extensibility.
367 */
368
369/*
370 * Flags for vdesc_flags:
371 */
3446c007
MD
372#define VDESC_MAX_VPS 8
373/* Low order 8 flag bits are reserved for willrele flags for vp arguments. */
374#define VDESC_VP0_WILLRELE 0x00000001
375#define VDESC_VP1_WILLRELE 0x00000002
376#define VDESC_VP2_WILLRELE 0x00000004
377#define VDESC_VP3_WILLRELE 0x00000008
378#define VDESC_VP4_WILLRELE 0x00000010
379#define VDESC_VP5_WILLRELE 0x00000020
380#define VDESC_VP6_WILLRELE 0x00000040
381#define VDESC_VP7_WILLRELE 0x00000080
382#define VDESC_NOMAP_VPP 0x00000100
383#define VDESC_VPP_WILLRELE 0x00000200
384#define VDESC_VP0_WILLUNLOCK 0x00010000
385#define VDESC_VP1_WILLUNLOCK 0x00020000
386#define VDESC_VP2_WILLUNLOCK 0x00040000
387#define VDESC_VP3_WILLUNLOCK 0x00080000
388#define VDESC_VP4_WILLUNLOCK 0x00100000
389#define VDESC_VP5_WILLUNLOCK 0x00200000
390#define VDESC_VP6_WILLUNLOCK 0x00400000
391#define VDESC_VP7_WILLUNLOCK 0x00800000
984263bc
MD
392
393/*
394 * VDESC_NO_OFFSET is used to identify the end of the offset list
395 * and in places where no such field exists.
396 */
397#define VDESC_NO_OFFSET -1
398
399/*
400 * This structure describes the vnode operation taking place.
401 */
402struct vnodeop_desc {
403 int vdesc_offset; /* offset in vector--first for speed */
404 char *vdesc_name; /* a readable name for debugging */
405 int vdesc_flags; /* VDESC_* flags */
406
407 /*
408 * These ops are used by bypass routines to map and locate arguments.
409 * Creds and procs are not needed in bypass routines, but sometimes
410 * they are useful to (for example) transport layers.
411 * Nameidata is useful because it has a cred in it.
412 */
413 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */
414 int vdesc_vpp_offset; /* return vpp location */
415 int vdesc_cred_offset; /* cred location, if any */
416 int vdesc_proc_offset; /* proc location, if any */
417 int vdesc_componentname_offset; /* if any */
984263bc
MD
418};
419
420#ifdef _KERNEL
421/*
422 * A list of all the operation descs.
423 */
424extern struct vnodeop_desc *vnodeop_descs[];
425
426/*
427 * Interlock for scanning list of vnodes attached to a mountpoint
428 */
8a8d5d85 429extern struct lwkt_token mntvnode_token;
984263bc
MD
430
431/*
432 * This macro is very helpful in defining those offsets in the vdesc struct.
433 *
434 * This is stolen from X11R4. I ignored all the fancy stuff for
435 * Crays, so if you decide to port this to such a serious machine,
436 * you might want to consult Intrinsic.h's XtOffset{,Of,To}.
437 */
597aea93 438#define VOPARG_OFFSET(p_type,field) \
984263bc 439 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
597aea93 440#define VOPARG_OFFSETOF(s_type,field) \
984263bc 441 VOPARG_OFFSET(s_type*,field)
597aea93 442#define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
984263bc
MD
443 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
444
625ddaba 445typedef int (*vnodeopv_entry_t)(struct vop_generic_args *);
984263bc
MD
446
447/*
2d3e977e
MD
448 * This structure is used to configure the new vnodeops vector. The entry
449 * descriptor describes a patricular VOP function while the operations
450 * vector descriptor recursively describes arrays of entry descriptors.
984263bc
MD
451 */
452struct vnodeopv_entry_desc {
2d3e977e 453 struct vnodeop_desc *opve_op;
625ddaba 454 vnodeopv_entry_t opve_func;
984263bc 455};
2d3e977e 456
984263bc 457struct vnodeopv_desc {
2d3e977e 458 struct vop_ops **opv_desc_vector; /* vect to allocate/fill*/
984263bc 459 struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */
dc1be39c 460 int opv_flags;
984263bc
MD
461};
462
2d3e977e
MD
463struct vnodeopv_node {
464 TAILQ_ENTRY(vnodeopv_node) entry;
0961aa92
MD
465 struct vop_ops *ops; /* allocated vector */
466 struct vnodeopv_entry_desc *descs; /* null terminated list */
984263bc
MD
467};
468
984263bc
MD
469#ifdef DEBUG_VFS_LOCKS
470/*
471 * Macros to aid in tracing VFS locking problems. Not totally
472 * reliable since if the process sleeps between changing the lock
473 * state and checking it with the assert, some other process could
474 * change the state. They are good enough for debugging a single
475 * filesystem using a single-threaded test. I find that 'cvs co src'
476 * is a pretty good test.
477 */
478
479/*
480 * [dfr] Kludge until I get around to fixing all the vfs locking.
481 */
482#define IS_LOCKING_VFS(vp) ((vp)->v_tag == VT_UFS \
483 || (vp)->v_tag == VT_MFS \
484 || (vp)->v_tag == VT_NFS \
485 || (vp)->v_tag == VT_LFS \
486 || (vp)->v_tag == VT_ISOFS \
487 || (vp)->v_tag == VT_MSDOSFS)
488
597aea93
DR
489#define ASSERT_VOP_LOCKED(vp, str) assert_vop_locked(vp, str)
490#define ASSERT_VOP_UNLOCKED(vp, str) assert_vop_unlocked(vp, str);
984263bc
MD
491
492#define ASSERT_VOP_ELOCKED(vp, str) \
493do { \
494 struct vnode *_vp = (vp); \
495 \
496 if (_vp && IS_LOCKING_VFS(_vp) && \
dadab5e9 497 VOP_ISLOCKED(_vp, curthread) != LK_EXCLUSIVE) \
984263bc
MD
498 panic("%s: %p is not exclusive locked but should be", \
499 str, _vp); \
500} while (0)
501
502#define ASSERT_VOP_ELOCKED_OTHER(vp, str) \
503do { \
504 struct vnode *_vp = (vp); \
505 \
506 if (_vp && IS_LOCKING_VFS(_vp) && \
dadab5e9 507 VOP_ISLOCKED(_vp, curthread) != LK_EXCLOTHER) \
984263bc
MD
508 panic("%s: %p is not exclusive locked by another proc", \
509 str, _vp); \
510} while (0)
511
512#define ASSERT_VOP_SLOCKED(vp, str) \
513do { \
514 struct vnode *_vp = (vp); \
515 \
516 if (_vp && IS_LOCKING_VFS(_vp) && \
517 VOP_ISLOCKED(_vp, NULL) != LK_SHARED) \
518 panic("%s: %p is not locked shared but should be", \
519 str, _vp); \
520} while (0)
521
4f322a84
EN
522void assert_vop_locked(struct vnode *vp, const char *str);
523void assert_vop_unlocked(struct vnode *vp, const char *str);
524
984263bc
MD
525#else
526
597aea93
DR
527#define ASSERT_VOP_LOCKED(vp, str)
528#define ASSERT_VOP_UNLOCKED(vp, str)
984263bc 529
4f322a84 530#endif /* DEBUG_VFS_LOCKS */
984263bc
MD
531
532/*
533 * VOCALL calls an op given an ops vector. We break it out because BSD's
534 * vclean changes the ops vector and then wants to call ops with the old
535 * vector.
536 */
2d3e977e
MD
537
538typedef int (*vocall_func_t)(struct vop_generic_args *);
539
984263bc 540/*
0961aa92
MD
541 * This call executes the vops vector for the offset stored in the ap's
542 * descriptor of the passed vops rather then the one related to the
543 * ap's vop_ops structure. It is used to chain VOPS calls on behalf of
544 * filesystems from a VFS's context ONLY (that is, from a VFS's own vops
545 * vector function).
984263bc 546 */
0961aa92
MD
547#define VOCALL(vops, ap) \
548 (*(vocall_func_t *)((char *)(vops)+((ap)->a_desc->vdesc_offset)))(ap)
549
597aea93
DR
550#define VDESC(OP) (& __CONCAT(OP,_desc))
551#define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
984263bc 552
984263bc
MD
553/*
554 * Public vnode manipulation functions.
555 */
984263bc
MD
556struct file;
557struct mount;
fad57d0e 558struct nlookupdata;
984263bc 559struct proc;
dadab5e9 560struct thread;
984263bc 561struct stat;
984263bc
MD
562struct ucred;
563struct uio;
564struct vattr;
565struct vnode;
566struct vop_bwrite_args;
567
e4c9c0c8
MD
568void addaliasu (struct vnode *vp, udev_t nvp_udev);
569int v_associate_rdev(struct vnode *vp, dev_t dev);
570void v_release_rdev(struct vnode *vp);
b153f746 571int bdevvp (dev_t dev, struct vnode **vpp);
5fd012e0 572struct vnode *allocvnode(int lktimeout, int lkflags);
6ddb7618 573int getnewvnode (enum vtagtype tag, struct mount *mp,
3446c007 574 struct vnode **vpp, int timo, int lkflags);
6ddb7618
MD
575int getspecialvnode (enum vtagtype tag, struct mount *mp,
576 struct vop_ops **ops, struct vnode **vpp, int timo,
577 int lkflags);
b153f746
RG
578int spec_vnoperate (struct vop_generic_args *);
579int speedup_syncer (void);
597aea93
DR
580void vattr_null (struct vattr *vap);
581int vcount (struct vnode *vp);
b153f746 582int vfinddev (dev_t dev, enum vtype type, struct vnode **vpp);
0961aa92
MD
583void vfs_add_vnodeops_sysinit (const void *);
584void vfs_rm_vnodeops_sysinit (const void *);
6ddb7618 585void vfs_add_vnodeops(struct mount *, struct vop_ops **,
dc1be39c 586 struct vnodeopv_entry_desc *, int);
0961aa92 587void vfs_rm_vnodeops(struct vop_ops **);
b153f746 588int vflush (struct mount *mp, int rootrefs, int flags);
5fd012e0 589int vmntvnodescan(struct mount *mp, int flags,
41a01a4d 590 int (*fastfunc)(struct mount *mp, struct vnode *vp, void *data),
5fd012e0
MD
591 int (*slowfunc)(struct mount *mp, struct vnode *vp, void *data),
592 void *data);
593void insmntque(struct vnode *vp, struct mount *mp);
41a01a4d 594
5fd012e0 595void vclean (struct vnode *vp, int flags, struct thread *td);
597aea93 596void vgone (struct vnode *vp);
b153f746
RG
597int vinvalbuf (struct vnode *vp, int save,
598 struct thread *td, int slpflag, int slptimeo);
599int vtruncbuf (struct vnode *vp, struct thread *td,
600 off_t length, int blksize);
54078292 601int vfsync(struct vnode *vp, int waitfor, int passes, off_t loffset,
6bae6177
MD
602 int (*checkdef)(struct buf *),
603 int (*waitoutput)(struct vnode *, struct thread *));
7540ab49 604int vinitvmio(struct vnode *vp);
b153f746 605void vprint (char *label, struct vnode *vp);
5fd012e0 606int vrecycle (struct vnode *vp, struct thread *td);
81b5c339 607void vn_strategy(struct vnode *vp, struct bio *bio);
597aea93 608int vn_close (struct vnode *vp, int flags, struct thread *td);
b153f746 609int vn_isdisk (struct vnode *vp, int *errp);
5fd012e0 610int vn_lock (struct vnode *vp, int flags, struct thread *td);
984263bc 611#ifdef DEBUG_LOCKS
5fd012e0 612int debug_vn_lock (struct vnode *vp, int flags, struct thread *td,
b153f746 613 const char *filename, int line);
5fd012e0 614#define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
984263bc 615#endif
b310dfc4 616
5d72d6ed 617int vn_get_namelen(struct vnode *, int *);
fad57d0e 618void vn_setspecops (struct file *fp);
b310dfc4 619int vn_fullpath (struct proc *p, struct vnode *vn, char **retbuf, char **freebuf);
fad57d0e 620int vn_open (struct nlookupdata *ndp, struct file *fp, int fmode, int cmode);
b153f746
RG
621void vn_pollevent (struct vnode *vp, int events);
622void vn_pollgone (struct vnode *vp);
623int vn_pollrecord (struct vnode *vp, struct thread *td, int events);
624int vn_rdwr (enum uio_rw rw, struct vnode *vp, caddr_t base,
984263bc 625 int len, off_t offset, enum uio_seg segflg, int ioflg,
b153f746
RG
626 struct ucred *cred, int *aresid, struct thread *td);
627int vn_rdwr_inchunks (enum uio_rw rw, struct vnode *vp, caddr_t base,
984263bc 628 int len, off_t offset, enum uio_seg segflg, int ioflg,
b153f746
RG
629 struct ucred *cred, int *aresid, struct thread *td);
630int vn_stat (struct vnode *vp, struct stat *sb, struct thread *td);
631dev_t vn_todev (struct vnode *vp);
b153f746 632void vfs_timestamp (struct timespec *);
597aea93 633int vn_writechk (struct vnode *vp);
b153f746 634int vop_stdbwrite (struct vop_bwrite_args *ap);
2d3e977e
MD
635int vop_stdislocked (struct vop_islocked_args *ap);
636int vop_stdlock (struct vop_lock_args *ap);
3446c007 637int vop_stdrlock (struct vop_lock_args *ap);
2d3e977e 638int vop_stdunlock (struct vop_unlock_args *ap);
2d3e977e 639int vop_nopoll (struct vop_poll_args *ap);
2d3e977e
MD
640int vop_stdpathconf (struct vop_pathconf_args *ap);
641int vop_stdpoll (struct vop_poll_args *ap);
642int vop_stdrevoke (struct vop_revoke_args *ap);
b153f746
RG
643int vop_eopnotsupp (struct vop_generic_args *ap);
644int vop_ebadf (struct vop_generic_args *ap);
645int vop_einval (struct vop_generic_args *ap);
646int vop_enotty (struct vop_generic_args *ap);
647int vop_defaultop (struct vop_generic_args *ap);
648int vop_null (struct vop_generic_args *ap);
649int vop_panic (struct vop_generic_args *ap);
fc46f680
JS
650int vop_write_dirent(int *, struct uio *, ino_t, uint8_t, uint16_t,
651 const char *);
b153f746 652
fad57d0e
MD
653int vop_compat_nresolve(struct vop_nresolve_args *ap);
654int vop_compat_nlookupdotdot(struct vop_nlookupdotdot_args *ap);
655int vop_compat_ncreate(struct vop_ncreate_args *ap);
656int vop_compat_nmkdir(struct vop_nmkdir_args *ap);
657int vop_compat_nmknod(struct vop_nmknod_args *ap);
658int vop_compat_nlink(struct vop_nlink_args *ap);
659int vop_compat_nsymlink(struct vop_nsymlink_args *ap);
660int vop_compat_nwhiteout(struct vop_nwhiteout_args *ap);
661int vop_compat_nremove(struct vop_nremove_args *ap);
662int vop_compat_nrmdir(struct vop_nrmdir_args *ap);
663int vop_compat_nrename(struct vop_nrename_args *ap);
664
5fd012e0
MD
665int vx_lock (struct vnode *vp);
666void vx_unlock (struct vnode *vp);
667int vx_get (struct vnode *vp);
668int vx_get_nonblock (struct vnode *vp);
669void vx_put (struct vnode *vp);
670int vget (struct vnode *vp, int lockflag, struct thread *td);
597aea93 671void vput (struct vnode *vp);
5fd012e0
MD
672void vhold (struct vnode *);
673void vdrop (struct vnode *);
b153f746 674void vref (struct vnode *vp);
5fd012e0
MD
675void vrele (struct vnode *vp);
676void vsetflags (struct vnode *vp, int flags);
677void vclrflags (struct vnode *vp, int flags);
678
679void vfs_subr_init(void);
680void vfs_mount_init(void);
681void vfs_lock_init(void);
682void vfs_sync_init(void);
683
684void vn_syncer_add_to_worklist(struct vnode *, int);
685void vnlru_proc_wait(void);
686
2d3e977e
MD
687extern struct vop_ops *default_vnode_vops;
688extern struct vop_ops *spec_vnode_vops;
0961aa92 689extern struct vop_ops *dead_vnode_vops;
984263bc
MD
690
691#endif /* _KERNEL */
692
693#endif /* !_SYS_VNODE_H_ */