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