Simplify vn_lock(), VOP_LOCK(), and VOP_UNLOCK() by removing the thread_t
[dragonfly.git] / sys / sys / vnode.h
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 $
35  * $DragonFly: src/sys/sys/vnode.h,v 1.51 2006/05/05 21:15:09 dillon Exp $
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/biotrack.h>
45 #include <sys/uio.h>
46 #include <sys/acl.h>
47 #include <sys/namecache.h>
48 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
49 #include <sys/thread.h>
50 #endif
51 #include <sys/vfsops.h>
52 #include <sys/vfscache.h>
53 #include <sys/tree.h>
54
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
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  */
67 TAILQ_HEAD(buflists, buf);
68
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  */
78 struct vrangelock;
79
80 TAILQ_HEAD(vrangelock_list, vrangelock);
81
82 struct vrangehead {
83         struct vrangelock_list  vh_list;
84 };
85
86 struct 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
98 static __inline
99 void
100 vrange_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
109 void    vrange_lock(struct vnode *vp, struct vrangelock *vr);
110 void    vrange_unlock(struct vnode *vp, struct vrangelock *vr);
111
112 static __inline
113 void
114 vrange_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
121 static __inline
122 void
123 vrange_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
131
132 /*
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.
148  *
149  * NOTE: The vnode operations vector, v_ops, is a double-indirect that
150  *       typically points to &v_mount->mnt_vn_use_ops.  We use a double
151  *       pointer because mnt_vn_use_ops may change dynamically when e.g.
152  *       journaling is turned on or off.
153  *
154  * NOTE: v_filesize is currently only applicable when a VM object is
155  *       associated with the vnode.  Otherwise it will be set to NOOFFSET.
156  */
157 RB_HEAD(buf_rb_tree, buf);
158 RB_HEAD(buf_rb_hash, buf);
159
160 struct vnode {
161         int     v_flag;                         /* vnode flags (see below) */
162         int     v_usecount;                     /* reference count of users */
163         int     v_writecount;
164         int     v_holdcnt;                      /* page & buffer references */
165         int     v_opencount;                    /* number of explicit opens */
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 */
168         u_long  v_id;                           /* capability identifier */
169         struct  mount *v_mount;                 /* ptr to vfs we are in */
170         struct  vop_ops **v_ops;                /* vnode operations vector */
171         TAILQ_ENTRY(vnode) v_freelist;          /* vnode freelist */
172         TAILQ_ENTRY(vnode) v_nmntvnodes;        /* vnodes for mount point */
173         struct buf_rb_tree v_rbclean_tree;      /* RB tree of clean bufs */
174         struct buf_rb_tree v_rbdirty_tree;      /* RB tree of dirty bufs */
175         struct buf_rb_hash v_rbhash_tree;       /* RB tree general lookup */
176         LIST_ENTRY(vnode) v_synclist;           /* vnodes with dirty buffers */
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 {
182                         udev_t  vu_udev;        /* device number for attach */
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         off_t   v_filesize;                     /* file EOF or NOOFFSET */
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 */
193         int     v_clen;                         /* length of current cluster */
194         struct vm_object *v_object;             /* Place to store VM object */
195         struct  lock v_lock;                    /* file/dir ops lock */
196         enum    vtagtype v_tag;                 /* type of underlying data */
197         void    *v_data;                        /* private data for fs */
198         struct namecache_list v_namecache;      /* associated nc entries */
199         struct  {
200                 struct  lwkt_token vpi_token;   /* lock to protect below */
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;
205         struct vmresident *v_resident;          /* optional vmresident */
206         struct vrangehead v_range;              /* range lock */
207 #ifdef  DEBUG_LOCKS
208         const char *filename;                   /* Source file doing locking */
209         int line;                               /* Line number doing locking */
210 #endif
211         void    *v_xaddr;
212 };
213 #define v_mountedhere   v_un.vu_mountedhere
214 #define v_socket        v_un.vu_socket
215 #define v_udev          v_un.vu_spec.vu_udev
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 */
233 #define VCTTYISOPEN     0x00010 /* controlling terminal tty is open */
234 #define VCKPT           0x00020 /* checkpoint-restored vnode */
235 #define VFSMID          0x00040 /* request FSMID update */
236 /* open for business    0x00080 */
237 /* open for business    0x00100 */
238 /* open for business    0x00200 */
239 /* open for business    0x00400 */
240 /* open for business    0x00800 */
241 /* open for business    0x01000 */
242 #define VOBJBUF         0x02000 /* Allocate buffers in VM object */
243 #define VINACTIVE       0x04000 /* The vnode is inactive */
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 */
247 #define VRECLAIMED      0x40000 /* This vnode has been destroyed */
248 #define VFREE           0x80000 /* This vnode is on the freelist */
249 /* open for business    0x100000 */
250 #define VONWORKLST      0x200000 /* On syncer work-list */
251 #define VMOUNT          0x400000 /* Mount in progress */
252 #define VOBJDIRTY       0x800000 /* object might be dirty */
253
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
262 /*
263  * Flags for ioflag. (high 16 bits used to ask for read-ahead and
264  * help with write clustering)
265  */
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 */
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 */
277
278 #define IO_SEQMAX       0x7F            /* seq heuristic max value */
279 #define IO_SEQSHIFT     16              /* seq heuristic in upper 16 bits */
280
281 /*
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.
286  */
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
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  */
306 #define VLKTIMEOUT     (hz / 20 + 1)
307
308 #ifdef _KERNEL
309
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  */
314 extern  enum vtype      iftovt_tab[];
315 extern  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))
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
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) \
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);
341
342 /*
343  * Global vnode data.
344  */
345 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
346 extern  struct namecache *rootncp;      /* root (i.e. "/") namecache */
347 extern  int desiredvnodes;              /* number of vnodes desired */
348 extern  time_t syncdelay;               /* max time to delay syncing data */
349 extern  time_t filedelay;               /* time to delay syncing files */
350 extern  time_t dirdelay;                /* time to delay syncing directories */
351 extern  time_t metadelay;               /* time to delay syncing metadata */
352 extern  struct vm_zone *namei_zone;
353 extern  int prtactive;                  /* nonzero to call vprint() */
354 extern  struct vattr va_null;           /* predefined null vattr structure */
355 extern  int vfs_ioopt;
356 extern  int numvnodes;
357 extern  int freevnodes;
358 extern  int vfs_fastdev;                /* fast specfs device access */
359
360 #endif /* _KERNEL */
361
362 /*
363  * Mods for extensibility.
364  */
365
366 /*
367  * Flags for vdesc_flags:
368  */
369 #define VDESC_MAX_VPS           8
370 /* Low order 8 flag bits are reserved for willrele flags for vp arguments. */
371 #define VDESC_VP0_WILLRELE      0x00000001
372 #define VDESC_VP1_WILLRELE      0x00000002
373 #define VDESC_VP2_WILLRELE      0x00000004
374 #define VDESC_VP3_WILLRELE      0x00000008
375 #define VDESC_VP4_WILLRELE      0x00000010
376 #define VDESC_VP5_WILLRELE      0x00000020
377 #define VDESC_VP6_WILLRELE      0x00000040
378 #define VDESC_VP7_WILLRELE      0x00000080
379 #define VDESC_NOMAP_VPP         0x00000100
380 #define VDESC_VPP_WILLRELE      0x00000200
381 #define VDESC_VP0_WILLUNLOCK    0x00010000
382 #define VDESC_VP1_WILLUNLOCK    0x00020000
383 #define VDESC_VP2_WILLUNLOCK    0x00040000
384 #define VDESC_VP3_WILLUNLOCK    0x00080000
385 #define VDESC_VP4_WILLUNLOCK    0x00100000
386 #define VDESC_VP5_WILLUNLOCK    0x00200000
387 #define VDESC_VP6_WILLUNLOCK    0x00400000
388 #define VDESC_VP7_WILLUNLOCK    0x00800000
389
390 /*
391  * VDESC_NO_OFFSET is used to identify the end of the offset list
392  * and in places where no such field exists.
393  */
394 #define VDESC_NO_OFFSET -1
395
396 /*
397  * This structure describes the vnode operation taking place.
398  */
399 struct vnodeop_desc {
400         int     vdesc_offset;           /* offset in vector--first for speed */
401         char    *vdesc_name;            /* a readable name for debugging */
402         int     vdesc_flags;            /* VDESC_* flags */
403
404         /*
405          * These ops are used by bypass routines to map and locate arguments.
406          * Creds and procs are not needed in bypass routines, but sometimes
407          * they are useful to (for example) transport layers.
408          * Nameidata is useful because it has a cred in it.
409          */
410         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
411         int     vdesc_vpp_offset;       /* return vpp location */
412         int     vdesc_cred_offset;      /* cred location, if any */
413         int     vdesc_proc_offset;      /* proc location, if any */
414         int     vdesc_componentname_offset; /* if any */
415 };
416
417 #ifdef _KERNEL
418 /*
419  * A list of all the operation descs.
420  */
421 extern struct vnodeop_desc *vnodeop_descs[];
422
423 /*
424  * Interlock for scanning list of vnodes attached to a mountpoint
425  */
426 extern struct lwkt_token mntvnode_token;
427
428 /*
429  * This macro is very helpful in defining those offsets in the vdesc struct.
430  *
431  * This is stolen from X11R4.  I ignored all the fancy stuff for
432  * Crays, so if you decide to port this to such a serious machine,
433  * you might want to consult Intrinsic.h's XtOffset{,Of,To}.
434  */
435 #define VOPARG_OFFSET(p_type,field) \
436         ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
437 #define VOPARG_OFFSETOF(s_type,field) \
438         VOPARG_OFFSET(s_type*,field)
439 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
440         ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
441
442 typedef int (*vnodeopv_entry_t)(struct vop_generic_args *);
443
444 /*
445  * This structure is used to configure the new vnodeops vector.  The entry
446  * descriptor describes a patricular VOP function while the operations
447  * vector descriptor recursively describes arrays of entry descriptors.
448  */
449 struct vnodeopv_entry_desc {
450         struct vnodeop_desc *opve_op;
451         vnodeopv_entry_t opve_func;
452 };
453
454 struct vnodeopv_desc {
455         struct vop_ops **opv_desc_vector;           /* vect to allocate/fill*/
456         struct vnodeopv_entry_desc *opv_desc_ops;   /* null terminated list */
457         int opv_flags;
458 };
459
460 struct vnodeopv_node {
461         TAILQ_ENTRY(vnodeopv_node)      entry;
462         struct vop_ops                  *ops;       /* allocated vector */
463         struct vnodeopv_entry_desc      *descs;     /* null terminated list */
464 };
465
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
486 #define ASSERT_VOP_LOCKED(vp, str) assert_vop_locked(vp, str)
487 #define ASSERT_VOP_UNLOCKED(vp, str) assert_vop_unlocked(vp, str);
488
489 #define ASSERT_VOP_ELOCKED(vp, str)                                     \
490 do {                                                                    \
491         struct vnode *_vp = (vp);                                       \
492                                                                         \
493         if (_vp && IS_LOCKING_VFS(_vp) &&                               \
494             VOP_ISLOCKED(_vp, curthread) != LK_EXCLUSIVE)               \
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)                               \
500 do {                                                                    \
501         struct vnode *_vp = (vp);                                       \
502                                                                         \
503         if (_vp && IS_LOCKING_VFS(_vp) &&                               \
504             VOP_ISLOCKED(_vp, curthread) != LK_EXCLOTHER)               \
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)                                     \
510 do {                                                                    \
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
519 void    assert_vop_locked(struct vnode *vp, const char *str);
520 void    assert_vop_unlocked(struct vnode *vp, const char *str);
521
522 #else
523
524 #define ASSERT_VOP_LOCKED(vp, str)
525 #define ASSERT_VOP_UNLOCKED(vp, str)
526
527 #endif /* DEBUG_VFS_LOCKS */
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  */
534
535 typedef int (*vocall_func_t)(struct vop_generic_args *);
536
537 /*
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).
543  */
544 #define VOCALL(vops, ap)                \
545         (*(vocall_func_t *)((char *)(vops)+((ap)->a_desc->vdesc_offset)))(ap)
546
547 #define VDESC(OP) (& __CONCAT(OP,_desc))
548 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
549
550 /*
551  * Public vnode manipulation functions.
552  */
553 struct file;
554 struct mount;
555 struct nlookupdata;
556 struct proc;
557 struct thread;
558 struct stat;
559 struct ucred;
560 struct uio;
561 struct vattr;
562 struct vnode;
563
564 void    addaliasu (struct vnode *vp, udev_t nvp_udev);
565 int     v_associate_rdev(struct vnode *vp, dev_t dev);
566 void    v_release_rdev(struct vnode *vp);
567 int     bdevvp (dev_t dev, struct vnode **vpp);
568 struct vnode *allocvnode(int lktimeout, int lkflags);
569 int     getnewvnode (enum vtagtype tag, struct mount *mp, 
570                     struct vnode **vpp, int timo, int lkflags);
571 int     getspecialvnode (enum vtagtype tag, struct mount *mp, 
572                     struct vop_ops **ops, struct vnode **vpp, int timo, 
573                     int lkflags);
574 int     spec_vnoperate (struct vop_generic_args *);
575 int     speedup_syncer (void);
576 void    vattr_null (struct vattr *vap);
577 int     vcount (struct vnode *vp);
578 int     vfinddev (dev_t dev, enum vtype type, struct vnode **vpp);
579 void    vfs_add_vnodeops_sysinit (const void *);
580 void    vfs_rm_vnodeops_sysinit (const void *);
581 void    vfs_add_vnodeops(struct mount *, struct vop_ops **,
582                         struct vnodeopv_entry_desc *, int);
583 void    vfs_rm_vnodeops(struct vop_ops **);
584 int     vflush (struct mount *mp, int rootrefs, int flags);
585 int     vmntvnodescan(struct mount *mp, int flags,
586             int (*fastfunc)(struct mount *mp, struct vnode *vp, void *data),
587             int (*slowfunc)(struct mount *mp, struct vnode *vp, void *data),
588             void *data);
589 void    insmntque(struct vnode *vp, struct mount *mp);
590
591 void    vclean (struct vnode *vp, int flags, struct thread *td);
592 void    vgone (struct vnode *vp);
593 void    vupdatefsmid (struct vnode *vp);
594 int     vinvalbuf (struct vnode *vp, int save, 
595             struct thread *td, int slpflag, int slptimeo);
596 int     vtruncbuf (struct vnode *vp, struct thread *td,
597                 off_t length, int blksize);
598 int     vfsync(struct vnode *vp, int waitfor, int passes,
599                 int (*checkdef)(struct buf *),
600                 int (*waitoutput)(struct vnode *, struct thread *));
601 int     vinitvmio(struct vnode *vp, off_t filesize);
602 void    vprint (char *label, struct vnode *vp);
603 int     vrecycle (struct vnode *vp, struct thread *td);
604 void    vn_strategy(struct vnode *vp, struct bio *bio);
605 int     vn_close (struct vnode *vp, int flags, struct thread *td);
606 int     vn_isdisk (struct vnode *vp, int *errp);
607 int     vn_lock (struct vnode *vp, int flags);
608 #ifdef  DEBUG_LOCKS
609 int     debug_vn_lock (struct vnode *vp, int flags,
610                 const char *filename, int line);
611 #define vn_lock(vp,flags)       debug_vn_lock(vp, flags, __FILE__, __LINE__)
612 #endif
613
614 int     vn_get_namelen(struct vnode *, int *);
615 void    vn_setspecops (struct file *fp);
616 int     vn_fullpath (struct proc *p, struct vnode *vn, char **retbuf, char **freebuf);
617 int     vn_open (struct nlookupdata *ndp, struct file *fp, int fmode, int cmode);
618 void    vn_pollevent (struct vnode *vp, int events);
619 void    vn_pollgone (struct vnode *vp);
620 int     vn_pollrecord (struct vnode *vp, struct thread *td, int events);
621 int     vn_rdwr (enum uio_rw rw, struct vnode *vp, caddr_t base,
622             int len, off_t offset, enum uio_seg segflg, int ioflg,
623             struct ucred *cred, int *aresid, struct thread *td);
624 int     vn_rdwr_inchunks (enum uio_rw rw, struct vnode *vp, caddr_t base,
625             int len, off_t offset, enum uio_seg segflg, int ioflg,
626             struct ucred *cred, int *aresid, struct thread *td);
627 int     vn_stat (struct vnode *vp, struct stat *sb, struct thread *td);
628 dev_t   vn_todev (struct vnode *vp);
629 void    vfs_timestamp (struct timespec *);
630 int     vn_writechk (struct vnode *vp);
631 int     vop_stdopen (struct vop_open_args *ap);
632 int     vop_stdclose (struct vop_close_args *ap);
633 int     vop_stdislocked (struct vop_islocked_args *ap);
634 int     vop_stdlock (struct vop_lock_args *ap);
635 int     vop_stdrlock (struct vop_lock_args *ap);
636 int     vop_stdunlock (struct vop_unlock_args *ap);
637 int     vop_nopoll (struct vop_poll_args *ap);
638 int     vop_stdpathconf (struct vop_pathconf_args *ap);
639 int     vop_stdpoll (struct vop_poll_args *ap);
640 int     vop_stdrevoke (struct vop_revoke_args *ap);
641 int     vop_eopnotsupp (struct vop_generic_args *ap);
642 int     vop_ebadf (struct vop_generic_args *ap);
643 int     vop_einval (struct vop_generic_args *ap);
644 int     vop_enotty (struct vop_generic_args *ap);
645 int     vop_defaultop (struct vop_generic_args *ap);
646 int     vop_null (struct vop_generic_args *ap);
647 int     vop_panic (struct vop_generic_args *ap);
648 int     vop_write_dirent(int *, struct uio *, ino_t, uint8_t, uint16_t,
649                          const char *);
650
651 int     vop_compat_nresolve(struct vop_nresolve_args *ap);
652 int     vop_compat_nlookupdotdot(struct vop_nlookupdotdot_args *ap);
653 int     vop_compat_ncreate(struct vop_ncreate_args *ap);
654 int     vop_compat_nmkdir(struct vop_nmkdir_args *ap);
655 int     vop_compat_nmknod(struct vop_nmknod_args *ap);
656 int     vop_compat_nlink(struct vop_nlink_args *ap);
657 int     vop_compat_nsymlink(struct vop_nsymlink_args *ap);
658 int     vop_compat_nwhiteout(struct vop_nwhiteout_args *ap);
659 int     vop_compat_nremove(struct vop_nremove_args *ap);
660 int     vop_compat_nrmdir(struct vop_nrmdir_args *ap);
661 int     vop_compat_nrename(struct vop_nrename_args *ap);
662
663 int     vx_lock (struct vnode *vp);
664 void    vx_unlock (struct vnode *vp);
665 int     vx_get (struct vnode *vp);
666 int     vx_get_nonblock (struct vnode *vp);
667 void    vx_put (struct vnode *vp);
668 int     vget (struct vnode *vp, int lockflag, struct thread *td);
669 void    vput (struct vnode *vp);
670 void    vhold (struct vnode *);
671 void    vdrop (struct vnode *);
672 void    vref (struct vnode *vp);
673 void    vrele (struct vnode *vp);
674 void    vsetflags (struct vnode *vp, int flags);
675 void    vclrflags (struct vnode *vp, int flags);
676
677 void    vfs_subr_init(void);
678 void    vfs_mount_init(void);
679 void    vfs_lock_init(void);
680 void    vfs_sync_init(void);
681
682 void    vn_syncer_add_to_worklist(struct vnode *, int);
683 void    vnlru_proc_wait(void);
684
685 extern  struct vop_ops *default_vnode_vops;
686 extern  struct vop_ops *spec_vnode_vops;
687 extern  struct vop_ops *dead_vnode_vops;
688
689 #endif /* _KERNEL */
690
691 #endif /* !_SYS_VNODE_H_ */