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