| Commit | Line | Data |
|---|---|---|
| 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 $ | |
| 67863d04 | 35 | * $DragonFly: src/sys/sys/vnode.h,v 1.83 2008/09/17 21:44:19 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 | 48 | #endif |
| 9183fa5b MD |
49 | #ifndef _SYS_SELINFO_H_ |
| 50 | #include <sys/selinfo.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 | 75 | #endif |
| a3d02589 MD |
76 | #ifndef _SYS_SYSLINK_RPC_H_ |
| 77 | #include <sys/syslink_rpc.h> | |
| 31bd717a | 78 | #endif |
| 3c37c940 MD |
79 | #ifndef _SYS_SYSREF_H_ |
| 80 | #include <sys/sysref.h> | |
| 81 | #endif | |
| 9bfc4d6d MD |
82 | #ifndef _SYS_CCMS_H_ |
| 83 | #include <sys/ccms.h> | |
| 84 | #endif | |
| 03d6a592 | 85 | #ifndef _MACHINE_LOCK_H_ |
| 984263bc | 86 | #include <machine/lock.h> |
| 03d6a592 | 87 | #endif |
| 984263bc MD |
88 | |
| 89 | /* | |
| 90 | * The vnode is the focus of all file activity in UNIX. There is a | |
| 91 | * unique vnode allocated for each active file, each current directory, | |
| 92 | * each mounted-on file, text file, and the root. | |
| 93 | */ | |
| 94 | ||
| 95 | /* | |
| 984263bc MD |
96 | * Each underlying filesystem allocates its own private area and hangs |
| 97 | * it from v_data. If non-null, this area is freed in getnewvnode(). | |
| 98 | */ | |
| 99 | TAILQ_HEAD(buflists, buf); | |
| 100 | ||
| 6ddb7618 | 101 | /* |
| dad088a5 MD |
102 | * Struct for mount options to printable formats. |
| 103 | */ | |
| 104 | struct mountctl_opt { | |
| 105 | int o_opt; | |
| 106 | const char *o_name; | |
| 107 | }; | |
| 108 | ||
| 109 | /* | |
| 6ddb7618 MD |
110 | * Range locks protect offset ranges in files and directories at a high |
| 111 | * level, allowing the actual I/O to be broken down into smaller pieces. | |
| 112 | * Range locks will eventually be integrated into the clustered cache | |
| 113 | * coherency infrastructure. | |
| 114 | * | |
| 115 | * We use a simple data structure for now, but eventually this should | |
| 116 | * probably be a btree or red-black tree. | |
| 117 | */ | |
| 118 | struct vrangelock; | |
| 119 | ||
| 120 | TAILQ_HEAD(vrangelock_list, vrangelock); | |
| 121 | ||
| 122 | struct vrangehead { | |
| 123 | struct vrangelock_list vh_list; | |
| 124 | }; | |
| 125 | ||
| 126 | struct vrangelock { | |
| 127 | TAILQ_ENTRY(vrangelock) vr_node; | |
| 128 | int vr_flags; | |
| 129 | off_t vr_offset; | |
| 130 | off_t vr_length; | |
| 131 | }; | |
| 132 | ||
| 133 | #define RNGL_WAITING 0x0001 /* waiting for lock, else has lock */ | |
| 134 | #define RNGL_CHECK 0x0002 /* check for work on unlock */ | |
| 135 | #define RNGL_SHARED 0x0004 /* shared lock, else exclusive */ | |
| 136 | #define RNGL_ONLIST 0x0008 /* sanity check */ | |
| 137 | ||
| 138 | static __inline | |
| 139 | void | |
| 140 | vrange_init(struct vrangelock *vr, int flags, off_t offset, off_t length) | |
| 141 | { | |
| 142 | vr->vr_flags = flags; | |
| 143 | vr->vr_offset = offset; | |
| 144 | vr->vr_length = length; | |
| 145 | } | |
| 146 | ||
| 147 | #ifdef _KERNEL | |
| 148 | ||
| 149 | void vrange_lock(struct vnode *vp, struct vrangelock *vr); | |
| 150 | void vrange_unlock(struct vnode *vp, struct vrangelock *vr); | |
| 151 | ||
| 152 | static __inline | |
| 153 | void | |
| 154 | vrange_lock_shared(struct vnode *vp, struct vrangelock *vr, | |
| 155 | off_t offset, off_t length) | |
| 156 | { | |
| 157 | vrange_init(vr, RNGL_SHARED, offset, length); | |
| 158 | vrange_lock(vp, vr); | |
| 159 | } | |
| 160 | ||
| 161 | static __inline | |
| 162 | void | |
| 163 | vrange_lock_excl(struct vnode *vp, struct vrangelock *vr, | |
| 164 | off_t offset, off_t length) | |
| 165 | { | |
| 166 | vrange_init(vr, 0, offset, length); | |
| 167 | vrange_lock(vp, vr); | |
| 168 | } | |
| 169 | ||
| 170 | #endif | |
| 0961aa92 | 171 | |
| 984263bc | 172 | /* |
| 6ddb7618 MD |
173 | * The vnode infrastructure is being reorgranized. Most reference-related |
| 174 | * fields are locked by the BGL, and most file I/O related operations and | |
| 175 | * vnode teardown functions are locked by the vnode lock. | |
| 176 | * | |
| 177 | * File read operations require a shared lock, file write operations require | |
| 178 | * an exclusive lock. Most directory operations (read or write) currently | |
| 179 | * require an exclusive lock due to the side effects stored in the directory | |
| 180 | * inode (which we intend to fix). | |
| 181 | * | |
| 182 | * File reads and writes are further protected by a range lock. The intention | |
| 183 | * is to be able to break I/O operations down into more easily managed pieces | |
| 184 | * so vm_page arrays can be passed through rather then UIOs. This work will | |
| 185 | * occur in multiple stages. The range locks will also eventually be used to | |
| 186 | * deal with clustered cache coherency issues and, more immediately, to | |
| 187 | * protect operations associated with the kernel-managed journaling module. | |
| e4c9c0c8 | 188 | * |
| 008b2675 MD |
189 | * NOTE: Certain fields within the vnode structure requires v_token to be |
| 190 | * held. The vnode's normal lock need not be held when accessing | |
| 191 | * these fields as long as the vnode is deterministically referenced | |
| 192 | * (i.e. can't be ripped out from under the caller). This is typical | |
| 193 | * for code paths based on descriptors or file pointers, but not for | |
| 194 | * backdoor code paths that come in via the buffer cache. | |
| 6de32ba2 | 195 | * |
| 0202303b MD |
196 | * v_rbclean_tree |
| 197 | * v_rbdirty_tree | |
| 198 | * v_rbhash_tree | |
| 6de32ba2 MD |
199 | * v_pollinfo |
| 200 | * | |
| 6ddb7618 MD |
201 | * NOTE: The vnode operations vector, v_ops, is a double-indirect that |
| 202 | * typically points to &v_mount->mnt_vn_use_ops. We use a double | |
| 203 | * pointer because mnt_vn_use_ops may change dynamically when e.g. | |
| 204 | * journaling is turned on or off. | |
| 57f7b636 MD |
205 | * |
| 206 | * NOTE: v_filesize is currently only applicable when a VM object is | |
| 207 | * associated with the vnode. Otherwise it will be set to NOOFFSET. | |
| f63911bf MD |
208 | * |
| 209 | * NOTE: The following fields require a spin or token lock: | |
| 210 | * | |
| 211 | * v_namecache v_spinlock | |
| 212 | * v_rb* v_token | |
| 984263bc | 213 | */ |
| 6bae6177 | 214 | RB_HEAD(buf_rb_tree, buf); |
| 1f1ea522 | 215 | RB_HEAD(buf_rb_hash, buf); |
| 6bae6177 | 216 | |
| 984263bc | 217 | struct vnode { |
| 6b008938 | 218 | int v_flag; /* vnode flags (see below) */ |
| 81b5c339 | 219 | int v_writecount; |
| e4c9c0c8 | 220 | int v_opencount; /* number of explicit opens */ |
| 3c37c940 MD |
221 | int v_auxrefs; /* auxiliary references */ |
| 222 | struct sysref v_sysref; /* normal references */ | |
| 81b5c339 MD |
223 | struct bio_track v_track_read; /* track I/O's in progress */ |
| 224 | struct bio_track v_track_write; /* track I/O's in progress */ | |
| 66a1ddf5 MD |
225 | struct mount *v_mount; /* ptr to vfs we are in */ |
| 226 | struct vop_ops **v_ops; /* vnode operations vector */ | |
| 0e8bd897 | 227 | TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist/cachelist */ |
| 984263bc | 228 | TAILQ_ENTRY(vnode) v_nmntvnodes; /* vnodes for mount point */ |
| 6bae6177 | 229 | struct buf_rb_tree v_rbclean_tree; /* RB tree of clean bufs */ |
| 54df1108 | 230 | struct buf_rb_tree v_rbdirty_tree; /* RB tree of dirty bufs */ |
| 1f1ea522 | 231 | struct buf_rb_hash v_rbhash_tree; /* RB tree general lookup */ |
| 984263bc | 232 | LIST_ENTRY(vnode) v_synclist; /* vnodes with dirty buffers */ |
| 984263bc MD |
233 | enum vtype v_type; /* vnode type */ |
| 234 | union { | |
| 984263bc MD |
235 | struct socket *vu_socket; /* unix ipc (VSOCK) */ |
| 236 | struct { | |
| 0e9b9130 MD |
237 | int vu_umajor; /* device number for attach */ |
| 238 | int vu_uminor; | |
| 0de08e6d MD |
239 | struct cdev *vu_cdevinfo; /* device (VCHR, VBLK) */ |
| 240 | SLIST_ENTRY(vnode) vu_cdevnext; | |
| 241 | } vu_cdev; | |
| 984263bc MD |
242 | struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */ |
| 243 | } v_un; | |
| 57f7b636 | 244 | off_t v_filesize; /* file EOF or NOOFFSET */ |
| 54078292 MD |
245 | off_t v_lazyw; /* lazy write iterator */ |
| 246 | off_t v_lastw; /* last write (write cluster) */ | |
| 247 | off_t v_cstart; /* start block of cluster */ | |
| 248 | off_t v_lasta; /* last allocation */ | |
| 984263bc MD |
249 | int v_clen; /* length of current cluster */ |
| 250 | struct vm_object *v_object; /* Place to store VM object */ | |
| 3446c007 | 251 | struct lock v_lock; /* file/dir ops lock */ |
| 008b2675 | 252 | struct lwkt_token v_token; /* (see above) */ |
| 984263bc | 253 | enum vtagtype v_tag; /* type of underlying data */ |
| 597aea93 | 254 | void *v_data; /* private data for fs */ |
| f63911bf | 255 | struct namecache_list v_namecache; /* (S) associated nc entries */ |
| 984263bc | 256 | struct { |
| 984263bc MD |
257 | struct selinfo vpi_selinfo; /* identity of poller(s) */ |
| 258 | short vpi_events; /* what they are looking for */ | |
| 259 | short vpi_revents; /* what has happened */ | |
| 260 | } v_pollinfo; | |
| 29802dbb | 261 | struct vmresident *v_resident; /* optional vmresident */ |
| 6ddb7618 | 262 | struct vrangehead v_range; /* range lock */ |
| 9bfc4d6d | 263 | struct ccms_dataspace v_ccms; /* cache coherency */ |
| 984263bc MD |
264 | #ifdef DEBUG_LOCKS |
| 265 | const char *filename; /* Source file doing locking */ | |
| 266 | int line; /* Line number doing locking */ | |
| 267 | #endif | |
| 5fd012e0 | 268 | void *v_xaddr; |
| 984263bc | 269 | }; |
| 984263bc | 270 | #define v_socket v_un.vu_socket |
| 0e9b9130 MD |
271 | #define v_umajor v_un.vu_cdev.vu_umajor |
| 272 | #define v_uminor v_un.vu_cdev.vu_uminor | |
| 0de08e6d MD |
273 | #define v_rdev v_un.vu_cdev.vu_cdevinfo |
| 274 | #define v_cdevnext v_un.vu_cdev.vu_cdevnext | |
| 984263bc | 275 | #define v_fifoinfo v_un.vu_fifoinfo |
| 9d265729 | 276 | #define v_spinlock v_lock.lk_spinlock |
| 984263bc MD |
277 | |
| 278 | #define VN_POLLEVENT(vp, events) \ | |
| 279 | do { \ | |
| 280 | if ((vp)->v_pollinfo.vpi_events & (events)) \ | |
| 281 | vn_pollevent((vp), (events)); \ | |
| 282 | } while (0) | |
| 283 | ||
| 284 | /* | |
| 285 | * Vnode flags. | |
| 286 | */ | |
| 3e35303e MD |
287 | #define VROOT 0x00000001 /* root of its file system */ |
| 288 | #define VTEXT 0x00000002 /* vnode is a pure text prototype */ | |
| 289 | #define VSYSTEM 0x00000004 /* vnode being used by kernel */ | |
| 290 | #define VISTTY 0x00000008 /* vnode represents a tty */ | |
| 291 | #define VCTTYISOPEN 0x00000010 /* controlling terminal tty is open */ | |
| 292 | #define VCKPT 0x00000020 /* checkpoint-restored vnode */ | |
| d98152a8 | 293 | /* open for business 0x00000040 */ |
| 3e35303e MD |
294 | #define VMAYHAVELOCKS 0x00000080 /* maybe posix or flock locks on vp */ |
| 295 | #define VPFSROOT 0x00000100 /* may be a pseudo filesystem root */ | |
| 296 | /* open for business 0x00000200 */ | |
| 0e8bd897 MD |
297 | #define VAGE0 0x00000400 /* Age count for recycling - 2 bits */ |
| 298 | #define VAGE1 0x00000800 /* Age count for recycling - 2 bits */ | |
| 3e35303e MD |
299 | #define VCACHED 0x00001000 /* No active references but has cache value */ |
| 300 | #define VOBJBUF 0x00002000 /* Allocate buffers in VM object */ | |
| 301 | #define VINACTIVE 0x00004000 /* The vnode is inactive (did VOP_INACTIVE) */ | |
| 0e8bd897 | 302 | /* open for business 0x00008000 */ |
| 3e35303e MD |
303 | #define VOLOCK 0x00010000 /* vnode is locked waiting for an object */ |
| 304 | #define VOWANT 0x00020000 /* a process is waiting for VOLOCK */ | |
| 305 | #define VRECLAIMED 0x00040000 /* This vnode has been destroyed */ | |
| 306 | #define VFREE 0x00080000 /* This vnode is on the freelist */ | |
| c0885fab | 307 | #define VNOTSEEKABLE 0x00100000 /* rd/wr ignores file offset */ |
| 3e35303e MD |
308 | #define VONWORKLST 0x00200000 /* On syncer work-list */ |
| 309 | #define VMOUNT 0x00400000 /* Mount in progress */ | |
| 310 | #define VOBJDIRTY 0x00800000 /* object might be dirty */ | |
| 984263bc | 311 | |
| 2aff4871 MD |
312 | #define VMP_READ 0x01000000 /* supports MPSAFE read */ |
| 313 | #define VMP_WRITE 0x02000000 /* supports MPSAFE write */ | |
| 314 | #define VMP_GETATTR 0x04000000 /* supports MPSAFE getattr */ | |
| 315 | ||
| 984263bc | 316 | /* |
| 5fd012e0 MD |
317 | * vmntvnodescan() flags |
| 318 | */ | |
| 19b97e01 MD |
319 | #define VMSC_GETVP 0x01 |
| 320 | #define VMSC_GETVX 0x02 | |
| 5fd012e0 | 321 | #define VMSC_NOWAIT 0x10 |
| 19b97e01 | 322 | #define VMSC_ONEPASS 0x20 |
| 5fd012e0 MD |
323 | |
| 324 | /* | |
| 984263bc MD |
325 | * Flags for ioflag. (high 16 bits used to ask for read-ahead and |
| 326 | * help with write clustering) | |
| 327 | */ | |
| 908b5ff6 MD |
328 | #define IO_UNIT 0x0001 /* do I/O as atomic unit */ |
| 329 | #define IO_APPEND 0x0002 /* append write to end */ | |
| 330 | #define IO_SYNC 0x0004 /* do I/O synchronously */ | |
| 331 | #define IO_NODELOCKED 0x0008 /* underlying node already locked */ | |
| 332 | #define IO_NDELAY 0x0010 /* FNDELAY flag set in file table */ | |
| 333 | #define IO_VMIO 0x0020 /* data already in VMIO space */ | |
| 334 | #define IO_INVAL 0x0040 /* invalidate after I/O */ | |
| 335 | #define IO_ASYNC 0x0080 /* bawrite rather then bdwrite */ | |
| 597aea93 | 336 | #define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */ |
| cb63d1bc | 337 | #define IO_RECURSE 0x0200 /* possibly device-recursive (vn) */ |
| 597aea93 | 338 | #define IO_CORE 0x0400 /* I/O is part of core dump */ |
| 984263bc | 339 | |
| 597aea93 DR |
340 | #define IO_SEQMAX 0x7F /* seq heuristic max value */ |
| 341 | #define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */ | |
| 984263bc MD |
342 | |
| 343 | /* | |
| 21739618 MD |
344 | * Modes. Note that these V-modes must match file S_I*USR, SUID, SGID, |
| 345 | * and SVTX flag bits. | |
| 984263bc MD |
346 | */ |
| 347 | #define VSUID 04000 /* set user id on execution */ | |
| 348 | #define VSGID 02000 /* set group id on execution */ | |
| 349 | #define VSVTX 01000 /* save swapped text even after use */ | |
| 350 | #define VREAD 00400 /* read, write, execute permissions */ | |
| 351 | #define VWRITE 00200 | |
| 352 | #define VEXEC 00100 | |
| 353 | ||
| 354 | /* | |
| 355 | * Token indicating no attribute value yet assigned. | |
| 356 | */ | |
| 357 | #define VNOVAL (-1) | |
| 358 | ||
| 359 | /* | |
| 360 | * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon) | |
| 361 | */ | |
| 597aea93 | 362 | #define VLKTIMEOUT (hz / 20 + 1) |
| 984263bc MD |
363 | |
| 364 | #ifdef _KERNEL | |
| 365 | ||
| 984263bc MD |
366 | /* |
| 367 | * Convert between vnode types and inode formats (since POSIX.1 | |
| 368 | * defines mode word of stat structure in terms of inode formats). | |
| 369 | */ | |
| 597aea93 DR |
370 | extern enum vtype iftovt_tab[]; |
| 371 | extern int vttoif_tab[]; | |
| 372 | #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12]) | |
| 373 | #define VTTOIF(indx) (vttoif_tab[(int)(indx)]) | |
| 374 | #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode)) | |
| 984263bc MD |
375 | |
| 376 | /* | |
| 377 | * Flags to various vnode functions. | |
| 378 | */ | |
| 379 | #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ | |
| 380 | #define FORCECLOSE 0x0002 /* vflush: force file closure */ | |
| 381 | #define WRITECLOSE 0x0004 /* vflush: only close writable files */ | |
| 382 | #define DOCLOSE 0x0008 /* vclean: close active files */ | |
| 383 | #define V_SAVE 0x0001 /* vinvalbuf: sync file first */ | |
| 984263bc | 384 | |
| 984263bc MD |
385 | #ifdef DIAGNOSTIC |
| 386 | #define VATTR_NULL(vap) vattr_null(vap) | |
| 387 | #else | |
| 388 | #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */ | |
| 389 | #endif /* DIAGNOSTIC */ | |
| 390 | ||
| 391 | #define NULLVP ((struct vnode *)NULL) | |
| 392 | ||
| 393 | #define VNODEOP_SET(f) \ | |
| 66a1ddf5 MD |
394 | SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_nadd_vnodeops_sysinit, &f); \ |
| 395 | SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND,vfs_nrm_vnodeops_sysinit, &f); | |
| 984263bc MD |
396 | |
| 397 | /* | |
| 398 | * Global vnode data. | |
| 399 | */ | |
| 70aac194 MD |
400 | struct objcache; |
| 401 | ||
| 984263bc | 402 | extern struct vnode *rootvnode; /* root (i.e. "/") vnode */ |
| 28623bf9 | 403 | extern struct nchandle rootnch; /* root (i.e. "/") namecache */ |
| 984263bc MD |
404 | extern int desiredvnodes; /* number of vnodes desired */ |
| 405 | extern time_t syncdelay; /* max time to delay syncing data */ | |
| 406 | extern time_t filedelay; /* time to delay syncing files */ | |
| 407 | extern time_t dirdelay; /* time to delay syncing directories */ | |
| 408 | extern time_t metadelay; /* time to delay syncing metadata */ | |
| 70aac194 | 409 | extern struct objcache *namei_oc; |
| 984263bc MD |
410 | extern int prtactive; /* nonzero to call vprint() */ |
| 411 | extern struct vattr va_null; /* predefined null vattr structure */ | |
| 412 | extern int vfs_ioopt; | |
| 5fd012e0 MD |
413 | extern int numvnodes; |
| 414 | extern int freevnodes; | |
| fad57d0e | 415 | extern int vfs_fastdev; /* fast specfs device access */ |
| 984263bc | 416 | |
| 984263bc MD |
417 | /* |
| 418 | * Interlock for scanning list of vnodes attached to a mountpoint | |
| 419 | */ | |
| 8a8d5d85 | 420 | extern struct lwkt_token mntvnode_token; |
| 984263bc MD |
421 | |
| 422 | /* | |
| 423 | * This macro is very helpful in defining those offsets in the vdesc struct. | |
| 424 | * | |
| 425 | * This is stolen from X11R4. I ignored all the fancy stuff for | |
| 426 | * Crays, so if you decide to port this to such a serious machine, | |
| 427 | * you might want to consult Intrinsic.h's XtOffset{,Of,To}. | |
| 428 | */ | |
| 597aea93 | 429 | #define VOPARG_OFFSET(p_type,field) \ |
| 984263bc | 430 | ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL))) |
| 597aea93 | 431 | #define VOPARG_OFFSETOF(s_type,field) \ |
| 984263bc | 432 | VOPARG_OFFSET(s_type*,field) |
| 597aea93 | 433 | #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \ |
| 984263bc MD |
434 | ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET))) |
| 435 | ||
| 625ddaba | 436 | typedef int (*vnodeopv_entry_t)(struct vop_generic_args *); |
| 984263bc | 437 | |
| 984263bc MD |
438 | /* |
| 439 | * VOCALL calls an op given an ops vector. We break it out because BSD's | |
| 440 | * vclean changes the ops vector and then wants to call ops with the old | |
| 441 | * vector. | |
| 442 | */ | |
| 2d3e977e MD |
443 | |
| 444 | typedef int (*vocall_func_t)(struct vop_generic_args *); | |
| 445 | ||
| 984263bc | 446 | /* |
| 0961aa92 MD |
447 | * This call executes the vops vector for the offset stored in the ap's |
| 448 | * descriptor of the passed vops rather then the one related to the | |
| 449 | * ap's vop_ops structure. It is used to chain VOPS calls on behalf of | |
| 450 | * filesystems from a VFS's context ONLY (that is, from a VFS's own vops | |
| 451 | * vector function). | |
| 984263bc | 452 | */ |
| 0961aa92 | 453 | #define VOCALL(vops, ap) \ |
| 31bd717a | 454 | (*(vocall_func_t *)((char *)(vops)+((ap)->a_desc->sd_offset)))(ap) |
| 0961aa92 | 455 | |
| 597aea93 | 456 | #define VDESC(OP) (& __CONCAT(OP,_desc)) |
| 984263bc MD |
457 | |
| 458 | /* | |
| 984263bc MD |
459 | * Public vnode manipulation functions. |
| 460 | */ | |
| 984263bc MD |
461 | struct file; |
| 462 | struct mount; | |
| fad57d0e | 463 | struct nlookupdata; |
| 984263bc | 464 | struct proc; |
| dadab5e9 | 465 | struct thread; |
| 984263bc | 466 | struct stat; |
| 984263bc MD |
467 | struct ucred; |
| 468 | struct uio; | |
| 469 | struct vattr; | |
| 470 | struct vnode; | |
| 984263bc | 471 | |
| a8873631 | 472 | struct vnode *getsynthvnode(const char *devname); |
| 0e9b9130 | 473 | void addaliasu (struct vnode *vp, int x, int y); |
| b13267a5 | 474 | int v_associate_rdev(struct vnode *vp, cdev_t dev); |
| e4c9c0c8 | 475 | void v_release_rdev(struct vnode *vp); |
| b13267a5 | 476 | int bdevvp (cdev_t dev, struct vnode **vpp); |
| 5fd012e0 | 477 | struct vnode *allocvnode(int lktimeout, int lkflags); |
| 3c37c940 | 478 | int freesomevnodes(int count); |
| 6ddb7618 | 479 | int getnewvnode (enum vtagtype tag, struct mount *mp, |
| 3446c007 | 480 | struct vnode **vpp, int timo, int lkflags); |
| 6ddb7618 MD |
481 | int getspecialvnode (enum vtagtype tag, struct mount *mp, |
| 482 | struct vop_ops **ops, struct vnode **vpp, int timo, | |
| 483 | int lkflags); | |
| b153f746 | 484 | int speedup_syncer (void); |
| 3b0783db | 485 | int vaccess(enum vtype, mode_t, uid_t, gid_t, mode_t, struct ucred *); |
| 597aea93 DR |
486 | void vattr_null (struct vattr *vap); |
| 487 | int vcount (struct vnode *vp); | |
| b13267a5 | 488 | int vfinddev (cdev_t dev, enum vtype type, struct vnode **vpp); |
| 66a1ddf5 MD |
489 | void vfs_nadd_vnodeops_sysinit (void *); |
| 490 | void vfs_nrm_vnodeops_sysinit (void *); | |
| 491 | void vfs_add_vnodeops(struct mount *, struct vop_ops *, struct vop_ops **); | |
| 492 | void vfs_rm_vnodeops(struct mount *, struct vop_ops *, struct vop_ops **); | |
| b153f746 | 493 | int vflush (struct mount *mp, int rootrefs, int flags); |
| 5fd012e0 | 494 | int vmntvnodescan(struct mount *mp, int flags, |
| 41a01a4d | 495 | int (*fastfunc)(struct mount *mp, struct vnode *vp, void *data), |
| 5fd012e0 MD |
496 | int (*slowfunc)(struct mount *mp, struct vnode *vp, void *data), |
| 497 | void *data); | |
| 498 | void insmntque(struct vnode *vp, struct mount *mp); | |
| 41a01a4d | 499 | |
| 3c37c940 | 500 | void vclean_vxlocked (struct vnode *vp, int flags); |
| cf683bae | 501 | void vclean_unlocked (struct vnode *vp); |
| 3c37c940 | 502 | void vgone_vxlocked (struct vnode *vp); |
| b8477cda | 503 | int vrevoke (struct vnode *vp, struct ucred *cred); |
| 87de5057 MD |
504 | int vinvalbuf (struct vnode *vp, int save, int slpflag, int slptimeo); |
| 505 | int vtruncbuf (struct vnode *vp, off_t length, int blksize); | |
| 4e0ecc94 | 506 | int vfsync(struct vnode *vp, int waitfor, int passes, |
| 6bae6177 MD |
507 | int (*checkdef)(struct buf *), |
| 508 | int (*waitoutput)(struct vnode *, struct thread *)); | |
| 1c843a13 | 509 | int vinitvmio(struct vnode *vp, off_t filesize); |
| b153f746 | 510 | void vprint (char *label, struct vnode *vp); |
| 87de5057 | 511 | int vrecycle (struct vnode *vp); |
| 2ec4b00d | 512 | int vmaxiosize (struct vnode *vp); |
| 81b5c339 | 513 | void vn_strategy(struct vnode *vp, struct bio *bio); |
| 87de5057 | 514 | int vn_close (struct vnode *vp, int flags); |
| b153f746 | 515 | int vn_isdisk (struct vnode *vp, int *errp); |
| ca466bae | 516 | int vn_lock (struct vnode *vp, int flags); |
| a11aaa81 MD |
517 | int vn_islocked (struct vnode *vp); |
| 518 | void vn_unlock (struct vnode *vp); | |
| 984263bc | 519 | #ifdef DEBUG_LOCKS |
| ca466bae MD |
520 | int debug_vn_lock (struct vnode *vp, int flags, |
| 521 | const char *filename, int line); | |
| 522 | #define vn_lock(vp,flags) debug_vn_lock(vp, flags, __FILE__, __LINE__) | |
| 984263bc | 523 | #endif |
| b310dfc4 | 524 | |
| 5d72d6ed | 525 | int vn_get_namelen(struct vnode *, int *); |
| fad57d0e | 526 | void vn_setspecops (struct file *fp); |
| b310dfc4 | 527 | int vn_fullpath (struct proc *p, struct vnode *vn, char **retbuf, char **freebuf); |
| fad57d0e | 528 | int vn_open (struct nlookupdata *ndp, struct file *fp, int fmode, int cmode); |
| a8873631 | 529 | int vn_opendisk (const char *devname, int fmode, struct vnode **vpp); |
| b153f746 RG |
530 | void vn_pollevent (struct vnode *vp, int events); |
| 531 | void vn_pollgone (struct vnode *vp); | |
| 87de5057 | 532 | int vn_pollrecord (struct vnode *vp, int events); |
| b153f746 | 533 | int vn_rdwr (enum uio_rw rw, struct vnode *vp, caddr_t base, |
| 984263bc | 534 | int len, off_t offset, enum uio_seg segflg, int ioflg, |
| 87de5057 | 535 | struct ucred *cred, int *aresid); |
| b153f746 | 536 | int vn_rdwr_inchunks (enum uio_rw rw, struct vnode *vp, caddr_t base, |
| 984263bc | 537 | int len, off_t offset, enum uio_seg segflg, int ioflg, |
| 87de5057 MD |
538 | struct ucred *cred, int *aresid); |
| 539 | int vn_stat (struct vnode *vp, struct stat *sb, struct ucred *cred); | |
| b13267a5 | 540 | cdev_t vn_todev (struct vnode *vp); |
| b153f746 | 541 | void vfs_timestamp (struct timespec *); |
| dad088a5 | 542 | size_t vfs_flagstostr(int flags, const struct mountctl_opt *optp, char *buf, size_t len, int *errorp); |
| 349433c9 | 543 | void vn_mark_atime(struct vnode *vp, struct thread *td); |
| 28623bf9 MD |
544 | int vn_writechk (struct vnode *vp, struct nchandle *nch); |
| 545 | int ncp_writechk(struct nchandle *nch); | |
| 8ddc6004 MD |
546 | int vop_stdopen (struct vop_open_args *ap); |
| 547 | int vop_stdclose (struct vop_close_args *ap); | |
| 177403a9 | 548 | int vop_stdmountctl(struct vop_mountctl_args *ap); |
| 1787385d MD |
549 | int vop_stdgetpages(struct vop_getpages_args *ap); |
| 550 | int vop_stdputpages(struct vop_putpages_args *ap); | |
| 349433c9 | 551 | int vop_stdmarkatime(struct vop_markatime_args *ap); |
| aec8eea4 MD |
552 | int vop_stdnoread(struct vop_read_args *ap); |
| 553 | int vop_stdnowrite(struct vop_write_args *ap); | |
| 2d3e977e | 554 | int vop_nopoll (struct vop_poll_args *ap); |
| 2d3e977e MD |
555 | int vop_stdpathconf (struct vop_pathconf_args *ap); |
| 556 | int vop_stdpoll (struct vop_poll_args *ap); | |
| b153f746 RG |
557 | int vop_eopnotsupp (struct vop_generic_args *ap); |
| 558 | int vop_ebadf (struct vop_generic_args *ap); | |
| 559 | int vop_einval (struct vop_generic_args *ap); | |
| 560 | int vop_enotty (struct vop_generic_args *ap); | |
| 561 | int vop_defaultop (struct vop_generic_args *ap); | |
| 562 | int vop_null (struct vop_generic_args *ap); | |
| 563 | int vop_panic (struct vop_generic_args *ap); | |
| fc46f680 JS |
564 | int vop_write_dirent(int *, struct uio *, ino_t, uint8_t, uint16_t, |
| 565 | const char *); | |
| b153f746 | 566 | |
| fad57d0e MD |
567 | int vop_compat_nresolve(struct vop_nresolve_args *ap); |
| 568 | int vop_compat_nlookupdotdot(struct vop_nlookupdotdot_args *ap); | |
| 569 | int vop_compat_ncreate(struct vop_ncreate_args *ap); | |
| 570 | int vop_compat_nmkdir(struct vop_nmkdir_args *ap); | |
| 571 | int vop_compat_nmknod(struct vop_nmknod_args *ap); | |
| 572 | int vop_compat_nlink(struct vop_nlink_args *ap); | |
| 573 | int vop_compat_nsymlink(struct vop_nsymlink_args *ap); | |
| 574 | int vop_compat_nwhiteout(struct vop_nwhiteout_args *ap); | |
| 575 | int vop_compat_nremove(struct vop_nremove_args *ap); | |
| 576 | int vop_compat_nrmdir(struct vop_nrmdir_args *ap); | |
| 577 | int vop_compat_nrename(struct vop_nrename_args *ap); | |
| 578 | ||
| e3332475 | 579 | void vx_lock (struct vnode *vp); |
| 5fd012e0 | 580 | void vx_unlock (struct vnode *vp); |
| e3332475 | 581 | void vx_get (struct vnode *vp); |
| 5fd012e0 MD |
582 | int vx_get_nonblock (struct vnode *vp); |
| 583 | void vx_put (struct vnode *vp); | |
| 87de5057 | 584 | int vget (struct vnode *vp, int lockflag); |
| 597aea93 | 585 | void vput (struct vnode *vp); |
| 5fd012e0 MD |
586 | void vhold (struct vnode *); |
| 587 | void vdrop (struct vnode *); | |
| b153f746 | 588 | void vref (struct vnode *vp); |
| 5fd012e0 MD |
589 | void vrele (struct vnode *vp); |
| 590 | void vsetflags (struct vnode *vp, int flags); | |
| 591 | void vclrflags (struct vnode *vp, int flags); | |
| 592 | ||
| 593 | void vfs_subr_init(void); | |
| 594 | void vfs_mount_init(void); | |
| 595 | void vfs_lock_init(void); | |
| 596 | void vfs_sync_init(void); | |
| 597 | ||
| 598 | void vn_syncer_add_to_worklist(struct vnode *, int); | |
| 599 | void vnlru_proc_wait(void); | |
| 600 | ||
| 66a1ddf5 | 601 | extern struct vop_ops default_vnode_vops; |
| 66a1ddf5 MD |
602 | extern struct vop_ops dead_vnode_vops; |
| 603 | ||
| 604 | extern struct vop_ops *default_vnode_vops_p; | |
| 66a1ddf5 | 605 | extern struct vop_ops *dead_vnode_vops_p; |
| 984263bc | 606 | |
| 03d6a592 | 607 | #endif /* _KERNEL */ |
| 984263bc | 608 | |
| 03d6a592 MD |
609 | #endif /* _KERNEL || _KERNEL_STRUCTURES */ |
| 610 | #endif /* !_SYS_VNODE_H_ */ |