FreeBSD/Linux Kernel Cross Reference
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: releng/5.1/sys/sys/vnode.h 114061 2003-04-26 08:36:06Z alc $
35 */
36
37 #ifndef _SYS_VNODE_H_
38 #define _SYS_VNODE_H_
39
40 /*
41 * XXX - compatability until lockmgr() goes away or all the #includes are
42 * updated.
43 */
44 #include <sys/lockmgr.h>
45
46 #include <sys/queue.h>
47 #include <sys/_label.h>
48 #include <sys/_lock.h>
49 #include <sys/lock.h>
50 #include <sys/_mutex.h>
51 #include <sys/mutex.h>
52 #include <sys/selinfo.h>
53 #include <sys/uio.h>
54 #include <sys/acl.h>
55 #include <sys/ktr.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 * Vnode types. VNON means no type.
65 */
66 enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD };
67
68 /*
69 * Each underlying filesystem allocates its own private area and hangs
70 * it from v_data. If non-null, this area is freed in getnewvnode().
71 */
72 TAILQ_HEAD(buflists, buf);
73
74 typedef int vop_t(void *);
75 struct namecache;
76
77 struct vpollinfo {
78 struct mtx vpi_lock; /* lock to protect below */
79 struct selinfo vpi_selinfo; /* identity of poller(s) */
80 short vpi_events; /* what they are looking for */
81 short vpi_revents; /* what has happened */
82 };
83
84 /*
85 * Reading or writing any of these items requires holding the appropriate lock.
86 *
87 * Lock reference:
88 * c - namecache mutex
89 * f - freelist mutex
90 * i - interlock
91 * m - mntvnodes mutex
92 * p - pollinfo lock
93 * s - spechash mutex
94 * S - syncer mutex
95 * u - Only a reference to the vnode is needed to read.
96 * v - vnode lock
97 *
98 * XXX Not all fields are locked yet and some fields that are marked are not
99 * locked consistently. This is a work in progress.
100 */
101
102 struct vnode {
103 struct mtx v_interlock; /* lock for "i" things */
104 u_long v_iflag; /* i vnode flags (see below) */
105 int v_usecount; /* i ref count of users */
106 long v_numoutput; /* i writes in progress */
107 struct thread *v_vxproc; /* i thread owning VXLOCK */
108 int v_holdcnt; /* i page & buffer references */
109 struct buflists v_cleanblkhd; /* i SORTED clean blocklist */
110 struct buf *v_cleanblkroot; /* i clean buf splay tree */
111 int v_cleanbufcnt; /* i number of clean buffers */
112 struct buflists v_dirtyblkhd; /* i SORTED dirty blocklist */
113 struct buf *v_dirtyblkroot; /* i dirty buf splay tree */
114 int v_dirtybufcnt; /* i number of dirty buffers */
115 u_long v_vflag; /* v vnode flags */
116 int v_writecount; /* v ref count of writers */
117 struct vm_object *v_object; /* v Place to store VM object */
118 daddr_t v_lastw; /* v last write (write cluster) */
119 daddr_t v_cstart; /* v start block of cluster */
120 daddr_t v_lasta; /* v last allocation (cluster) */
121 int v_clen; /* v length of current cluster */
122 union {
123 struct mount *vu_mountedhere;/* v ptr to mounted vfs (VDIR) */
124 struct socket *vu_socket; /* v unix ipc (VSOCK) */
125 struct {
126 struct cdev *vu_cdev; /* v device (VCHR, VBLK) */
127 SLIST_ENTRY(vnode) vu_specnext; /* s device aliases */
128 } vu_spec;
129 struct fifoinfo *vu_fifoinfo; /* v fifo (VFIFO) */
130 } v_un;
131 TAILQ_ENTRY(vnode) v_freelist; /* f vnode freelist */
132 TAILQ_ENTRY(vnode) v_nmntvnodes; /* m vnodes for mount point */
133 LIST_ENTRY(vnode) v_synclist; /* S dirty vnode list */
134 enum vtype v_type; /* u vnode type */
135 const char *v_tag; /* u type of underlying data */
136 void *v_data; /* u private data for fs */
137 struct lock v_lock; /* u used if fs don't have one */
138 struct lock *v_vnlock; /* u pointer to vnode lock */
139 vop_t **v_op; /* u vnode operations vector */
140 struct mount *v_mount; /* u ptr to vfs we are in */
141 LIST_HEAD(, namecache) v_cache_src; /* c Cache entries from us */
142 TAILQ_HEAD(, namecache) v_cache_dst; /* c Cache entries to us */
143 u_long v_id; /* c capability identifier */
144 struct vnode *v_dd; /* c .. vnode */
145 u_long v_ddid; /* c .. capability identifier */
146 struct vpollinfo *v_pollinfo; /* p Poll events */
147 struct label v_label; /* MAC label for vnode */
148 #ifdef DEBUG_LOCKS
149 const char *filename; /* Source file doing locking */
150 int line; /* Line number doing locking */
151 #endif
152 udev_t v_cachedfs; /* cached fs id */
153 ino_t v_cachedid; /* cached file id */
154 };
155 #define v_mountedhere v_un.vu_mountedhere
156 #define v_socket v_un.vu_socket
157 #define v_rdev v_un.vu_spec.vu_cdev
158 #define v_specnext v_un.vu_spec.vu_specnext
159 #define v_fifoinfo v_un.vu_fifoinfo
160
161 /*
162 * Userland version of struct vnode, for sysctl.
163 */
164 struct xvnode {
165 size_t xv_size; /* sizeof(struct xvnode) */
166 void *xv_vnode; /* address of real vnode */
167 u_long xv_flag; /* vnode vflags */
168 int xv_usecount; /* reference count of users */
169 int xv_writecount; /* reference count of writers */
170 int xv_holdcnt; /* page & buffer references */
171 u_long xv_id; /* capability identifier */
172 void *xv_mount; /* address of parent mount */
173 long xv_numoutput; /* num of writes in progress */
174 enum vtype xv_type; /* vnode type */
175 union {
176 void *xvu_socket; /* socket, if VSOCK */
177 void *xvu_fifo; /* fifo, if VFIFO */
178 udev_t xvu_rdev; /* maj/min, if VBLK/VCHR */
179 struct {
180 udev_t xvu_dev; /* device, if VDIR/VREG/VLNK */
181 ino_t xvu_ino; /* id, if VDIR/VREG/VLNK */
182 } xv_uns;
183 } xv_un;
184 };
185 #define xv_socket xv_un.xvu_socket
186 #define xv_fifo xv_un.xvu_fifo
187 #define xv_rdev xv_un.xvu_rdev
188 #define xv_dev xv_un.xv_uns.xvu_dev
189 #define xv_ino xv_un.xv_uns.xvu_ino
190
191 #define VN_POLLEVENT(vp, events) \
192 do { \
193 if ((vp)->v_pollinfo != NULL && \
194 (vp)->v_pollinfo->vpi_events & (events)) \
195 vn_pollevent((vp), (events)); \
196 } while (0)
197
198 #define VN_KNOTE(vp, b) \
199 do { \
200 if ((vp)->v_pollinfo != NULL) \
201 KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b)); \
202 } while (0)
203
204 /*
205 * Vnode flags.
206 * VI flags are protected by interlock and live in v_iflag
207 * VV flags are protected by the vnode lock and live in v_vflag
208 */
209 #define VI_XLOCK 0x0001 /* vnode is locked to change vtype */
210 #define VI_XWANT 0x0002 /* thread is waiting for vnode */
211 #define VI_BWAIT 0x0004 /* waiting for output to complete */
212 #define VI_OLOCK 0x0008 /* vnode is locked waiting for an object */
213 #define VI_OWANT 0x0010 /* a thread is waiting for VOLOCK */
214 #define VI_MOUNT 0x0020 /* Mount in progress */
215 #define VI_AGE 0x0040 /* Insert vnode at head of free list */
216 #define VI_DOOMED 0x0080 /* This vnode is being recycled */
217 #define VI_FREE 0x0100 /* This vnode is on the freelist */
218 #define VI_OBJDIRTY 0x0400 /* object might be dirty */
219 #define VI_DOINGINACT 0x0800 /* VOP_INACTIVE is in progress */
220 /*
221 * XXX VI_ONWORKLST could be replaced with a check for NULL list elements
222 * in v_synclist.
223 */
224 #define VI_ONWORKLST 0x0200 /* On syncer work-list */
225
226 #define VV_ROOT 0x0001 /* root of its filesystem */
227 #define VV_ISTTY 0x0002 /* vnode represents a tty */
228 #define VV_NOSYNC 0x0004 /* unlinked, stop syncing */
229 #define VV_OBJBUF 0x0008 /* Allocate buffers in VM object */
230 #define VV_CACHEDLABEL 0x0010 /* Vnode has valid cached MAC label */
231 #define VV_TEXT 0x0020 /* vnode is a pure text prototype */
232 #define VV_COPYONWRITE 0x0040 /* vnode is doing copy-on-write */
233 #define VV_SYSTEM 0x0080 /* vnode being used by kernel */
234 #define VV_PROCDEP 0x0100 /* vnode is process dependent */
235
236 /*
237 * Vnode attributes. A field value of VNOVAL represents a field whose value
238 * is unavailable (getattr) or which is not to be changed (setattr).
239 */
240 struct vattr {
241 enum vtype va_type; /* vnode type (for create) */
242 u_short va_mode; /* files access mode and type */
243 short va_nlink; /* number of references to file */
244 uid_t va_uid; /* owner user id */
245 gid_t va_gid; /* owner group id */
246 udev_t va_fsid; /* filesystem id */
247 long va_fileid; /* file id */
248 u_quad_t va_size; /* file size in bytes */
249 long va_blocksize; /* blocksize preferred for i/o */
250 struct timespec va_atime; /* time of last access */
251 struct timespec va_mtime; /* time of last modification */
252 struct timespec va_ctime; /* time file changed */
253 struct timespec va_birthtime; /* time file created */
254 u_long va_gen; /* generation number of file */
255 u_long va_flags; /* flags defined for file */
256 udev_t va_rdev; /* device the special file represents */
257 u_quad_t va_bytes; /* bytes of disk space held by file */
258 u_quad_t va_filerev; /* file modification number */
259 u_int va_vaflags; /* operations flags, see below */
260 long va_spare; /* remain quad aligned */
261 };
262
263 /*
264 * Flags for va_vaflags.
265 */
266 #define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */
267 #define VA_EXCLUSIVE 0x02 /* exclusive create request */
268
269 /*
270 * Flags for ioflag. (high 16 bits used to ask for read-ahead and
271 * help with write clustering)
272 */
273 #define IO_UNIT 0x0001 /* do I/O as atomic unit */
274 #define IO_APPEND 0x0002 /* append write to end */
275 #define IO_SYNC 0x0004 /* do I/O synchronously */
276 #define IO_NODELOCKED 0x0008 /* underlying node already locked */
277 #define IO_NDELAY 0x0010 /* FNDELAY flag set in file table */
278 #define IO_VMIO 0x0020 /* data already in VMIO space */
279 #define IO_INVAL 0x0040 /* invalidate after I/O */
280 #define IO_ASYNC 0x0080 /* bawrite rather then bdwrite */
281 #define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */
282 #define IO_NOWDRAIN 0x0200 /* do not block on wdrain */
283 #define IO_EXT 0x0400 /* operate on external attributes */
284 #define IO_NORMAL 0x0800 /* operate on regular data */
285 #define IO_NOMACCHECK 0x1000 /* MAC checks unnecessary */
286
287 #define IO_SEQMAX 0x7F /* seq heuristic max value */
288 #define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */
289
290 /*
291 * Modes. Some values same as Ixxx entries from inode.h for now.
292 */
293 #define VEXEC 000100 /* execute/search permission */
294 #define VWRITE 000200 /* write permission */
295 #define VREAD 000400 /* read permission */
296 #define VSVTX 001000 /* save swapped text even after use */
297 #define VSGID 002000 /* set group id on execution */
298 #define VSUID 004000 /* set user id on execution */
299 #define VADMIN 010000 /* permission to administer */
300 #define VSTAT 020000 /* permission to retrieve attrs */
301 #define VAPPEND 040000 /* permission to write/append */
302 #define VALLPERM (VEXEC | VWRITE | VREAD | VADMIN | VSTAT | VAPPEND)
303
304 /*
305 * Token indicating no attribute value yet assigned.
306 */
307 #define VNOVAL (-1)
308
309 /*
310 * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
311 */
312 #define VLKTIMEOUT (hz / 20 + 1)
313
314 #ifdef _KERNEL
315
316 #ifdef MALLOC_DECLARE
317 MALLOC_DECLARE(M_VNODE);
318 #endif
319
320 /*
321 * Convert between vnode types and inode formats (since POSIX.1
322 * defines mode word of stat structure in terms of inode formats).
323 */
324 extern enum vtype iftovt_tab[];
325 extern int vttoif_tab[];
326 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12])
327 #define VTTOIF(indx) (vttoif_tab[(int)(indx)])
328 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode))
329
330 /*
331 * Flags to various vnode functions.
332 */
333 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */
334 #define FORCECLOSE 0x0002 /* vflush: force file closure */
335 #define WRITECLOSE 0x0004 /* vflush: only close writable files */
336 #define DOCLOSE 0x0008 /* vclean: close active files */
337 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */
338 #define V_ALT 0x0002 /* vinvalbuf: invalidate only alternate bufs */
339 #define V_NORMAL 0x0004 /* vinvalbuf: invalidate only regular bufs */
340 #define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */
341 #define V_WAIT 0x0001 /* vn_start_write: sleep for suspend */
342 #define V_NOWAIT 0x0002 /* vn_start_write: don't sleep for suspend */
343 #define V_XSLEEP 0x0004 /* vn_start_write: just return after sleep */
344
345 #define VREF(vp) vref(vp)
346
347
348 #ifdef DIAGNOSTIC
349 #define VATTR_NULL(vap) vattr_null(vap)
350 #else
351 #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
352 #endif /* DIAGNOSTIC */
353
354 #define NULLVP ((struct vnode *)NULL)
355
356 #define VNODEOP_SET(f) \
357 C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \
358 C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f);
359
360 /*
361 * Global vnode data.
362 */
363 extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
364 extern int async_io_version; /* 0 or POSIX version of AIO i'face */
365 extern int desiredvnodes; /* number of vnodes desired */
366 extern struct uma_zone *namei_zone;
367 extern int prtactive; /* nonzero to call vprint() */
368 extern struct vattr va_null; /* predefined null vattr structure */
369
370 /*
371 * Macro/function to check for client cache inconsistency w.r.t. leasing.
372 */
373 #define LEASE_READ 0x1 /* Check lease for readers */
374 #define LEASE_WRITE 0x2 /* Check lease for modifiers */
375
376
377 extern void (*lease_updatetime)(int deltat);
378
379 /* Requires interlock */
380 #define VSHOULDFREE(vp) \
381 (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_DOINGINACT)) && \
382 !(vp)->v_holdcnt && !(vp)->v_usecount && \
383 (!(vp)->v_object || \
384 !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count)))
385
386 /* Requires interlock */
387 #define VMIGHTFREE(vp) \
388 (!((vp)->v_iflag & (VI_FREE|VI_DOOMED|VI_XLOCK|VI_DOINGINACT)) && \
389 LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount)
390
391 /* Requires interlock */
392 #define VSHOULDBUSY(vp) \
393 (((vp)->v_iflag & VI_FREE) && \
394 ((vp)->v_holdcnt || (vp)->v_usecount))
395
396 #define VI_LOCK(vp) mtx_lock(&(vp)->v_interlock)
397 #define VI_TRYLOCK(vp) mtx_trylock(&(vp)->v_interlock)
398 #define VI_UNLOCK(vp) mtx_unlock(&(vp)->v_interlock)
399 #define VI_MTX(vp) (&(vp)->v_interlock)
400
401 #endif /* _KERNEL */
402
403
404 /*
405 * Mods for extensibility.
406 */
407
408 /*
409 * Flags for vdesc_flags:
410 */
411 #define VDESC_MAX_VPS 16
412 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
413 #define VDESC_VP0_WILLRELE 0x0001
414 #define VDESC_VP1_WILLRELE 0x0002
415 #define VDESC_VP2_WILLRELE 0x0004
416 #define VDESC_VP3_WILLRELE 0x0008
417 #define VDESC_NOMAP_VPP 0x0100
418 #define VDESC_VPP_WILLRELE 0x0200
419
420 /*
421 * VDESC_NO_OFFSET is used to identify the end of the offset list
422 * and in places where no such field exists.
423 */
424 #define VDESC_NO_OFFSET -1
425
426 /*
427 * This structure describes the vnode operation taking place.
428 */
429 struct vnodeop_desc {
430 int vdesc_offset; /* offset in vector,first for speed */
431 char *vdesc_name; /* a readable name for debugging */
432 int vdesc_flags; /* VDESC_* flags */
433
434 /*
435 * These ops are used by bypass routines to map and locate arguments.
436 * Creds and procs are not needed in bypass routines, but sometimes
437 * they are useful to (for example) transport layers.
438 * Nameidata is useful because it has a cred in it.
439 */
440 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */
441 int vdesc_vpp_offset; /* return vpp location */
442 int vdesc_cred_offset; /* cred location, if any */
443 int vdesc_thread_offset; /* thread location, if any */
444 int vdesc_componentname_offset; /* if any */
445 /*
446 * Finally, we've got a list of private data (about each operation)
447 * for each transport layer. (Support to manage this list is not
448 * yet part of BSD.)
449 */
450 caddr_t *vdesc_transports;
451 };
452
453 #ifdef _KERNEL
454 /*
455 * A list of all the operation descs.
456 */
457 extern struct vnodeop_desc *vnodeop_descs[];
458
459 /*
460 * Interlock for scanning list of vnodes attached to a mountpoint
461 */
462 extern struct mtx mntvnode_mtx;
463
464 /*
465 * This macro is very helpful in defining those offsets in the vdesc struct.
466 *
467 * This is stolen from X11R4. I ignored all the fancy stuff for
468 * Crays, so if you decide to port this to such a serious machine,
469 * you might want to consult Intrinsic.h's XtOffset{,Of,To}.
470 */
471 #define VOPARG_OFFSET(p_type,field) \
472 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
473 #define VOPARG_OFFSETOF(s_type,field) \
474 VOPARG_OFFSET(s_type*,field)
475 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
476 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
477
478
479 /*
480 * This structure is used to configure the new vnodeops vector.
481 */
482 struct vnodeopv_entry_desc {
483 struct vnodeop_desc *opve_op; /* which operation this is */
484 vop_t *opve_impl; /* code implementing this operation */
485 };
486 struct vnodeopv_desc {
487 /* ptr to the ptr to the vector where op should go */
488 vop_t ***opv_desc_vector_p;
489 struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */
490 };
491
492 /*
493 * A generic structure.
494 * This can be used by bypass routines to identify generic arguments.
495 */
496 struct vop_generic_args {
497 struct vnodeop_desc *a_desc;
498 /* other random data follows, presumably */
499 };
500
501 /*
502 * Support code to aid in debugging VFS locking problems. Not totally
503 * reliable since if the thread sleeps between changing the lock
504 * state and checking it with the assert, some other thread could
505 * change the state. They are good enough for debugging a single
506 * filesystem using a single-threaded test.
507 */
508 void assert_vi_locked(struct vnode *vp, char *str);
509 void assert_vi_unlocked(struct vnode *vp, char *str);
510 void assert_vop_unlocked(struct vnode *vp, char *str);
511 void assert_vop_locked(struct vnode *vp, char *str);
512 void assert_vop_slocked(struct vnode *vp, char *str);
513 void assert_vop_elocked(struct vnode *vp, char *str);
514 void assert_vop_elocked_other(struct vnode *vp, char *str);
515
516 /* These are called from within the actuall VOPS */
517 void vop_rename_pre(void *a);
518 void vop_strategy_pre(void *a);
519 void vop_lookup_pre(void *a);
520 void vop_lookup_post(void *a, int rc);
521 void vop_lock_pre(void *a);
522 void vop_lock_post(void *a, int rc);
523 void vop_unlock_pre(void *a);
524 void vop_unlock_post(void *a, int rc);
525
526 #ifdef DEBUG_VFS_LOCKS
527
528 #define ASSERT_VI_LOCKED(vp, str) assert_vi_locked((vp), (str))
529 #define ASSERT_VI_UNLOCKED(vp, str) assert_vi_unlocked((vp), (str))
530 #define ASSERT_VOP_LOCKED(vp, str) assert_vop_locked((vp), (str))
531 #define ASSERT_VOP_UNLOCKED(vp, str) assert_vop_unlocked((vp), (str))
532 #define ASSERT_VOP_ELOCKED(vp, str) assert_vop_elocked((vp), (str))
533 #define ASSERT_VOP_ELOCKED_OTHER(vp, str) assert_vop_locked_other((vp), (str))
534 #define ASSERT_VOP_SLOCKED(vp, str) assert_vop_slocked((vp), (str))
535
536 #else
537
538 #define ASSERT_VOP_LOCKED(vp, str)
539 #define ASSERT_VOP_UNLOCKED(vp, str)
540 #define ASSERT_VOP_ELOCKED(vp, str)
541 #define ASSERT_VOP_ELOCKED_OTHER(vp, str)
542 #define ASSERT_VOP_SLOCKED(vp, str)
543 #define ASSERT_VI_UNLOCKED(vp, str)
544 #define ASSERT_VI_LOCKED(vp, str)
545
546 #endif
547
548 /*
549 * VOCALL calls an op given an ops vector. We break it out because BSD's
550 * vclean changes the ops vector and then wants to call ops with the old
551 * vector.
552 */
553 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
554
555 /*
556 * This call works for vnodes in the kernel.
557 */
558 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
559 #define VDESC(OP) (& __CONCAT(OP,_desc))
560 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
561
562 /*
563 * VMIO support inline
564 */
565
566 extern int vmiodirenable;
567
568 static __inline int
569 vn_canvmio(struct vnode *vp)
570 {
571 if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
572 return(TRUE);
573 return(FALSE);
574 }
575
576 /*
577 * Finally, include the default set of vnode operations.
578 */
579 #include "vnode_if.h"
580
581 /*
582 * Public vnode manipulation functions.
583 */
584 struct componentname;
585 struct file;
586 struct mount;
587 struct nameidata;
588 struct ostat;
589 struct thread;
590 struct proc;
591 struct stat;
592 struct nstat;
593 struct ucred;
594 struct uio;
595 struct vattr;
596 struct vnode;
597
598 extern int (*lease_check_hook)(struct vop_lease_args *);
599 extern int (*softdep_fsync_hook)(struct vnode *);
600 extern int (*softdep_process_worklist_hook)(struct mount *);
601
602 struct vnode *addaliasu(struct vnode *vp, udev_t nvp_rdev);
603 int bdevvp(dev_t dev, struct vnode **vpp);
604 /* cache_* may belong in namei.h. */
605 void cache_enter(struct vnode *dvp, struct vnode *vp,
606 struct componentname *cnp);
607 int cache_lookup(struct vnode *dvp, struct vnode **vpp,
608 struct componentname *cnp);
609 void cache_purge(struct vnode *vp);
610 void cache_purgevfs(struct mount *mp);
611 int cache_leaf_test(struct vnode *vp);
612 int change_dir(struct vnode *vp, struct thread *td);
613 int change_root(struct vnode *vp, struct thread *td);
614 void cvtstat(struct stat *st, struct ostat *ost);
615 void cvtnstat(struct stat *sb, struct nstat *nsb);
616 int getnewvnode(const char *tag, struct mount *mp, vop_t **vops,
617 struct vnode **vpp);
618 int lease_check(struct vop_lease_args *ap);
619 int spec_vnoperate(struct vop_generic_args *);
620 int speedup_syncer(void);
621 #define textvp_fullpath(p, rb, rfb) \
622 vn_fullpath(FIRST_THREAD_IN_PROC(p), (p)->p_textvp, rb, rfb)
623 int vn_fullpath(struct thread *td, struct vnode *vn,
624 char **retbuf, char **freebuf);
625 int vaccess(enum vtype type, mode_t file_mode, uid_t uid, gid_t gid,
626 mode_t acc_mode, struct ucred *cred, int *privused);
627 int vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
628 gid_t file_gid, struct acl *acl, mode_t acc_mode,
629 struct ucred *cred, int *privused);
630 void vattr_null(struct vattr *vap);
631 int vcount(struct vnode *vp);
632 void vdrop(struct vnode *);
633 void vdropl(struct vnode *);
634 int vfinddev(dev_t dev, enum vtype type, struct vnode **vpp);
635 void vfs_add_vnodeops(const void *);
636 void vfs_rm_vnodeops(const void *);
637 int vflush(struct mount *mp, int rootrefs, int flags);
638 int vget(struct vnode *vp, int lockflag, struct thread *td);
639 void vgone(struct vnode *vp);
640 void vgonel(struct vnode *vp, struct thread *td);
641 void vhold(struct vnode *);
642 void vholdl(struct vnode *);
643 int vinvalbuf(struct vnode *vp, int save, struct ucred *cred,
644 struct thread *td, int slpflag, int slptimeo);
645 int vtruncbuf(struct vnode *vp, struct ucred *cred, struct thread *td,
646 off_t length, int blksize);
647 void vprint(char *label, struct vnode *vp);
648 int vrecycle(struct vnode *vp, struct mtx *inter_lkp,
649 struct thread *td);
650 int vn_close(struct vnode *vp,
651 int flags, struct ucred *file_cred, struct thread *td);
652 void vn_finished_write(struct mount *mp);
653 int vn_isdisk(struct vnode *vp, int *errp);
654 int vn_lock(struct vnode *vp, int flags, struct thread *td);
655 #ifdef DEBUG_LOCKS
656 int debug_vn_lock(struct vnode *vp, int flags, struct thread *p,
657 const char *filename, int line);
658 #define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__)
659 #endif
660 int vn_open(struct nameidata *ndp, int *flagp, int cmode);
661 int vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
662 struct ucred *cred);
663 void vn_pollevent(struct vnode *vp, int events);
664 void vn_pollgone(struct vnode *vp);
665 int vn_pollrecord(struct vnode *vp, struct thread *p, int events);
666 int vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
667 int len, off_t offset, enum uio_seg segflg, int ioflg,
668 struct ucred *active_cred, struct ucred *file_cred, int *aresid,
669 struct thread *td);
670 int vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, caddr_t base,
671 int len, off_t offset, enum uio_seg segflg, int ioflg,
672 struct ucred *active_cred, struct ucred *file_cred, int *aresid,
673 struct thread *td);
674 int vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
675 struct ucred *file_cred, struct thread *td);
676 int vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
677 dev_t vn_todev(struct vnode *vp);
678 int vn_write_suspend_wait(struct vnode *vp, struct mount *mp,
679 int flags);
680 int vn_writechk(struct vnode *vp);
681 int vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
682 const char *attrname, int *buflen, char *buf, struct thread *td);
683 int vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
684 const char *attrname, int buflen, char *buf, struct thread *td);
685 int vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
686 const char *attrname, struct thread *td);
687 int vfs_cache_lookup(struct vop_lookup_args *ap);
688 int vfs_object_create(struct vnode *vp, struct thread *td,
689 struct ucred *cred);
690 void vfs_timestamp(struct timespec *);
691 void vfs_write_resume(struct mount *mp);
692 int vfs_write_suspend(struct mount *mp);
693 int vop_stdbmap(struct vop_bmap_args *);
694 int vop_stdfsync(struct vop_fsync_args *);
695 int vop_stdgetwritemount(struct vop_getwritemount_args *);
696 int vop_stdgetpages(struct vop_getpages_args *);
697 int vop_stdinactive(struct vop_inactive_args *);
698 int vop_stdislocked(struct vop_islocked_args *);
699 int vop_stdlock(struct vop_lock_args *);
700 int vop_stdputpages(struct vop_putpages_args *);
701 int vop_stdunlock(struct vop_unlock_args *);
702 int vop_noislocked(struct vop_islocked_args *);
703 int vop_nolock(struct vop_lock_args *);
704 int vop_nopoll(struct vop_poll_args *);
705 int vop_nounlock(struct vop_unlock_args *);
706 int vop_stdpathconf(struct vop_pathconf_args *);
707 int vop_stdpoll(struct vop_poll_args *);
708 int vop_revoke(struct vop_revoke_args *);
709 int vop_sharedlock(struct vop_lock_args *);
710 int vop_eopnotsupp(struct vop_generic_args *ap);
711 int vop_ebadf(struct vop_generic_args *ap);
712 int vop_einval(struct vop_generic_args *ap);
713 int vop_enotty(struct vop_generic_args *ap);
714 int vop_defaultop(struct vop_generic_args *ap);
715 int vop_null(struct vop_generic_args *ap);
716 int vop_panic(struct vop_generic_args *ap);
717 int vop_stdcreatevobject(struct vop_createvobject_args *ap);
718 int vop_stddestroyvobject(struct vop_destroyvobject_args *ap);
719 int vop_stdgetvobject(struct vop_getvobject_args *ap);
720
721 void vfree(struct vnode *);
722 void vput(struct vnode *vp);
723 void vrele(struct vnode *vp);
724 void vref(struct vnode *vp);
725 int vrefcnt(struct vnode *vp);
726 void vbusy(struct vnode *vp);
727 void v_addpollinfo(struct vnode *vp);
728
729 extern vop_t **default_vnodeop_p;
730 extern vop_t **spec_vnodeop_p;
731 extern vop_t **dead_vnodeop_p;
732
733 #endif /* _KERNEL */
734
735 #endif /* !_SYS_VNODE_H_ */
Cache object: 364d4a740b12f21a989ced5ba3c61bf5
|