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