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