| 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.7 2003/08/20 07:31:22 rob 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/uio.h> |
| 45 | #include <sys/acl.h> |
| 46 | |
| 47 | #include <machine/lock.h> |
| 48 | |
| 49 | /* |
| 50 | * The vnode is the focus of all file activity in UNIX. There is a |
| 51 | * unique vnode allocated for each active file, each current directory, |
| 52 | * each mounted-on file, text file, and the root. |
| 53 | */ |
| 54 | |
| 55 | /* |
| 56 | * Vnode types. VNON means no type. |
| 57 | */ |
| 58 | enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD }; |
| 59 | |
| 60 | /* |
| 61 | * Vnode tag types. |
| 62 | * These are for the benefit of external programs only (e.g., pstat) |
| 63 | * and should NEVER be inspected by the kernel. |
| 64 | */ |
| 65 | enum vtagtype { |
| 66 | VT_NON, VT_UFS, VT_NFS, VT_MFS, VT_PC, VT_LFS, VT_LOFS, VT_FDESC, |
| 67 | VT_PORTAL, VT_NULL, VT_UMAP, VT_KERNFS, VT_PROCFS, VT_AFS, VT_ISOFS, |
| 68 | VT_UNION, VT_MSDOSFS, VT_TFS, VT_VFS, VT_CODA, VT_NTFS, |
| 69 | VT_HPFS, VT_NWFS, VT_SMBFS |
| 70 | }; |
| 71 | |
| 72 | /* |
| 73 | * Each underlying filesystem allocates its own private area and hangs |
| 74 | * it from v_data. If non-null, this area is freed in getnewvnode(). |
| 75 | */ |
| 76 | TAILQ_HEAD(buflists, buf); |
| 77 | |
| 78 | typedef int vop_t (void *); |
| 79 | struct namecache; |
| 80 | |
| 81 | /* |
| 82 | * Reading or writing any of these items requires holding the appropriate lock. |
| 83 | * v_freelist is locked by the global vnode_free_list token. |
| 84 | * v_mntvnodes is locked by the global mntvnodes token. |
| 85 | * v_flag, v_usecount, v_holdcount and v_writecount are |
| 86 | * locked by the v_interlock token. |
| 87 | * v_pollinfo is locked by the lock contained inside it. |
| 88 | */ |
| 89 | struct vnode { |
| 90 | u_long v_flag; /* vnode flags (see below) */ |
| 91 | int v_usecount; /* reference count of users */ |
| 92 | int v_writecount; /* reference count of writers */ |
| 93 | int v_holdcnt; /* page & buffer references */ |
| 94 | u_long v_id; /* capability identifier */ |
| 95 | struct mount *v_mount; /* ptr to vfs we are in */ |
| 96 | vop_t **v_op; /* vnode operations vector */ |
| 97 | TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist */ |
| 98 | TAILQ_ENTRY(vnode) v_nmntvnodes; /* vnodes for mount point */ |
| 99 | struct buflists v_cleanblkhd; /* clean blocklist head */ |
| 100 | struct buflists v_dirtyblkhd; /* dirty blocklist head */ |
| 101 | LIST_ENTRY(vnode) v_synclist; /* vnodes with dirty buffers */ |
| 102 | long v_numoutput; /* num of writes in progress */ |
| 103 | enum vtype v_type; /* vnode type */ |
| 104 | union { |
| 105 | struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */ |
| 106 | struct socket *vu_socket; /* unix ipc (VSOCK) */ |
| 107 | struct { |
| 108 | struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */ |
| 109 | SLIST_ENTRY(vnode) vu_specnext; |
| 110 | } vu_spec; |
| 111 | struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */ |
| 112 | } v_un; |
| 113 | struct nqlease *v_lease; /* Soft reference to lease */ |
| 114 | daddr_t v_lastw; /* last write (write cluster) */ |
| 115 | daddr_t v_cstart; /* start block of cluster */ |
| 116 | daddr_t v_lasta; /* last allocation */ |
| 117 | int v_clen; /* length of current cluster */ |
| 118 | struct vm_object *v_object; /* Place to store VM object */ |
| 119 | struct lwkt_token v_interlock; /* lock on usecount and flag */ |
| 120 | struct lock *v_vnlock; /* used for non-locking fs's */ |
| 121 | enum vtagtype v_tag; /* type of underlying data */ |
| 122 | void *v_data; /* private data for fs */ |
| 123 | LIST_HEAD(, namecache) v_cache_src; /* Cache entries from us */ |
| 124 | TAILQ_HEAD(, namecache) v_cache_dst; /* Cache entries to us */ |
| 125 | struct vnode *v_dd; /* .. vnode */ |
| 126 | u_long v_ddid; /* .. capability identifier */ |
| 127 | struct { |
| 128 | struct lwkt_token vpi_token; /* lock to protect below */ |
| 129 | struct selinfo vpi_selinfo; /* identity of poller(s) */ |
| 130 | short vpi_events; /* what they are looking for */ |
| 131 | short vpi_revents; /* what has happened */ |
| 132 | } v_pollinfo; |
| 133 | struct proc *v_vxproc; /* proc owning VXLOCK */ |
| 134 | #ifdef DEBUG_LOCKS |
| 135 | const char *filename; /* Source file doing locking */ |
| 136 | int line; /* Line number doing locking */ |
| 137 | #endif |
| 138 | }; |
| 139 | #define v_mountedhere v_un.vu_mountedhere |
| 140 | #define v_socket v_un.vu_socket |
| 141 | #define v_rdev v_un.vu_spec.vu_specinfo |
| 142 | #define v_specnext v_un.vu_spec.vu_specnext |
| 143 | #define v_fifoinfo v_un.vu_fifoinfo |
| 144 | |
| 145 | #define VN_POLLEVENT(vp, events) \ |
| 146 | do { \ |
| 147 | if ((vp)->v_pollinfo.vpi_events & (events)) \ |
| 148 | vn_pollevent((vp), (events)); \ |
| 149 | } while (0) |
| 150 | |
| 151 | /* |
| 152 | * Vnode flags. |
| 153 | */ |
| 154 | #define VROOT 0x00001 /* root of its file system */ |
| 155 | #define VTEXT 0x00002 /* vnode is a pure text prototype */ |
| 156 | #define VSYSTEM 0x00004 /* vnode being used by kernel */ |
| 157 | #define VISTTY 0x00008 /* vnode represents a tty */ |
| 158 | #define VXLOCK 0x00100 /* vnode is locked to change underlying type */ |
| 159 | #define VXWANT 0x00200 /* process is waiting for vnode */ |
| 160 | #define VBWAIT 0x00400 /* waiting for output to complete */ |
| 161 | /* open for business 0x00800 */ |
| 162 | /* open for business 0x01000 */ |
| 163 | #define VOBJBUF 0x02000 /* Allocate buffers in VM object */ |
| 164 | /* open for business 0x04000 */ |
| 165 | #define VAGE 0x08000 /* Insert vnode at head of free list */ |
| 166 | #define VOLOCK 0x10000 /* vnode is locked waiting for an object */ |
| 167 | #define VOWANT 0x20000 /* a process is waiting for VOLOCK */ |
| 168 | #define VDOOMED 0x40000 /* This vnode is being recycled */ |
| 169 | #define VFREE 0x80000 /* This vnode is on the freelist */ |
| 170 | #define VONWORKLST 0x200000 /* On syncer work-list */ |
| 171 | #define VMOUNT 0x400000 /* Mount in progress */ |
| 172 | #define VOBJDIRTY 0x800000 /* object might be dirty */ |
| 173 | |
| 174 | /* |
| 175 | * Vnode attributes. A field value of VNOVAL represents a field whose value |
| 176 | * is unavailable (getattr) or which is not to be changed (setattr). |
| 177 | */ |
| 178 | struct vattr { |
| 179 | enum vtype va_type; /* vnode type (for create) */ |
| 180 | u_short va_mode; /* files access mode and type */ |
| 181 | short va_nlink; /* number of references to file */ |
| 182 | uid_t va_uid; /* owner user id */ |
| 183 | gid_t va_gid; /* owner group id */ |
| 184 | udev_t va_fsid; /* file system id */ |
| 185 | long va_fileid; /* file id */ |
| 186 | u_quad_t va_size; /* file size in bytes */ |
| 187 | long va_blocksize; /* blocksize preferred for i/o */ |
| 188 | struct timespec va_atime; /* time of last access */ |
| 189 | struct timespec va_mtime; /* time of last modification */ |
| 190 | struct timespec va_ctime; /* time file changed */ |
| 191 | u_long va_gen; /* generation number of file */ |
| 192 | u_long va_flags; /* flags defined for file */ |
| 193 | udev_t va_rdev; /* device the special file represents */ |
| 194 | u_quad_t va_bytes; /* bytes of disk space held by file */ |
| 195 | u_quad_t va_filerev; /* file modification number */ |
| 196 | u_int va_vaflags; /* operations flags, see below */ |
| 197 | long va_spare; /* remain quad aligned */ |
| 198 | }; |
| 199 | |
| 200 | /* |
| 201 | * Flags for va_vaflags. |
| 202 | */ |
| 203 | #define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */ |
| 204 | #define VA_EXCLUSIVE 0x02 /* exclusive create request */ |
| 205 | |
| 206 | /* |
| 207 | * Flags for ioflag. (high 16 bits used to ask for read-ahead and |
| 208 | * help with write clustering) |
| 209 | */ |
| 210 | #define IO_UNIT 0x0001 /* do I/O as atomic unit */ |
| 211 | #define IO_APPEND 0x0002 /* append write to end */ |
| 212 | #define IO_SYNC 0x0004 /* do I/O synchronously */ |
| 213 | #define IO_NODELOCKED 0x0008 /* underlying node already locked */ |
| 214 | #define IO_NDELAY 0x0010 /* FNDELAY flag set in file table */ |
| 215 | #define IO_VMIO 0x0020 /* data already in VMIO space */ |
| 216 | #define IO_INVAL 0x0040 /* invalidate after I/O */ |
| 217 | #define IO_ASYNC 0x0080 /* bawrite rather then bdwrite */ |
| 218 | #define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */ |
| 219 | #define IO_NOWDRAIN 0x0200 /* do not block on wdrain */ |
| 220 | #define IO_CORE 0x0400 /* I/O is part of core dump */ |
| 221 | |
| 222 | #define IO_SEQMAX 0x7F /* seq heuristic max value */ |
| 223 | #define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */ |
| 224 | |
| 225 | /* |
| 226 | * Modes. Some values same as Ixxx entries from inode.h for now. |
| 227 | */ |
| 228 | #define VSUID 04000 /* set user id on execution */ |
| 229 | #define VSGID 02000 /* set group id on execution */ |
| 230 | #define VSVTX 01000 /* save swapped text even after use */ |
| 231 | #define VREAD 00400 /* read, write, execute permissions */ |
| 232 | #define VWRITE 00200 |
| 233 | #define VEXEC 00100 |
| 234 | |
| 235 | /* |
| 236 | * Token indicating no attribute value yet assigned. |
| 237 | */ |
| 238 | #define VNOVAL (-1) |
| 239 | |
| 240 | /* |
| 241 | * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon) |
| 242 | */ |
| 243 | #define VLKTIMEOUT (hz / 20 + 1) |
| 244 | |
| 245 | #ifdef _KERNEL |
| 246 | |
| 247 | #ifdef MALLOC_DECLARE |
| 248 | MALLOC_DECLARE(M_VNODE); |
| 249 | #endif |
| 250 | |
| 251 | /* |
| 252 | * Convert between vnode types and inode formats (since POSIX.1 |
| 253 | * defines mode word of stat structure in terms of inode formats). |
| 254 | */ |
| 255 | extern enum vtype iftovt_tab[]; |
| 256 | extern int vttoif_tab[]; |
| 257 | #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12]) |
| 258 | #define VTTOIF(indx) (vttoif_tab[(int)(indx)]) |
| 259 | #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode)) |
| 260 | |
| 261 | /* |
| 262 | * Flags to various vnode functions. |
| 263 | */ |
| 264 | #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */ |
| 265 | #define FORCECLOSE 0x0002 /* vflush: force file closure */ |
| 266 | #define WRITECLOSE 0x0004 /* vflush: only close writable files */ |
| 267 | #define DOCLOSE 0x0008 /* vclean: close active files */ |
| 268 | #define V_SAVE 0x0001 /* vinvalbuf: sync file first */ |
| 269 | #define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */ |
| 270 | |
| 271 | #define VREF(vp) vref(vp) |
| 272 | |
| 273 | |
| 274 | #ifdef DIAGNOSTIC |
| 275 | #define VATTR_NULL(vap) vattr_null(vap) |
| 276 | #else |
| 277 | #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */ |
| 278 | #endif /* DIAGNOSTIC */ |
| 279 | |
| 280 | #define NULLVP ((struct vnode *)NULL) |
| 281 | |
| 282 | #define VNODEOP_SET(f) \ |
| 283 | C_SYSINIT(f##init, SI_SUB_VFS, SI_ORDER_SECOND, vfs_add_vnodeops, &f); \ |
| 284 | C_SYSUNINIT(f##uninit, SI_SUB_VFS, SI_ORDER_SECOND, vfs_rm_vnodeops, &f); |
| 285 | |
| 286 | /* |
| 287 | * Global vnode data. |
| 288 | */ |
| 289 | extern struct vnode *rootvnode; /* root (i.e. "/") vnode */ |
| 290 | extern int desiredvnodes; /* number of vnodes desired */ |
| 291 | extern time_t syncdelay; /* max time to delay syncing data */ |
| 292 | extern time_t filedelay; /* time to delay syncing files */ |
| 293 | extern time_t dirdelay; /* time to delay syncing directories */ |
| 294 | extern time_t metadelay; /* time to delay syncing metadata */ |
| 295 | extern struct vm_zone *namei_zone; |
| 296 | extern int prtactive; /* nonzero to call vprint() */ |
| 297 | extern struct vattr va_null; /* predefined null vattr structure */ |
| 298 | extern int vfs_ioopt; |
| 299 | |
| 300 | /* |
| 301 | * Macro/function to check for client cache inconsistency w.r.t. leasing. |
| 302 | */ |
| 303 | #define LEASE_READ 0x1 /* Check lease for readers */ |
| 304 | #define LEASE_WRITE 0x2 /* Check lease for modifiers */ |
| 305 | |
| 306 | |
| 307 | extern void (*lease_updatetime) (int deltat); |
| 308 | |
| 309 | #define VSHOULDFREE(vp) \ |
| 310 | (!((vp)->v_flag & (VFREE|VDOOMED)) && \ |
| 311 | !(vp)->v_holdcnt && !(vp)->v_usecount && \ |
| 312 | (!(vp)->v_object || \ |
| 313 | !((vp)->v_object->ref_count || (vp)->v_object->resident_page_count))) |
| 314 | |
| 315 | #define VMIGHTFREE(vp) \ |
| 316 | (!((vp)->v_flag & (VFREE|VDOOMED|VXLOCK)) && \ |
| 317 | LIST_EMPTY(&(vp)->v_cache_src) && !(vp)->v_usecount) |
| 318 | |
| 319 | #define VSHOULDBUSY(vp) \ |
| 320 | (((vp)->v_flag & VFREE) && \ |
| 321 | ((vp)->v_holdcnt || (vp)->v_usecount)) |
| 322 | |
| 323 | #define VI_LOCK(vp) lwkt_gettoken(&(vp)->v_interlock) |
| 324 | #define VI_UNLOCK(vp) lwkt_reltoken(&(vp)->v_interlock) |
| 325 | |
| 326 | #endif /* _KERNEL */ |
| 327 | |
| 328 | |
| 329 | /* |
| 330 | * Mods for extensibility. |
| 331 | */ |
| 332 | |
| 333 | /* |
| 334 | * Flags for vdesc_flags: |
| 335 | */ |
| 336 | #define VDESC_MAX_VPS 16 |
| 337 | /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */ |
| 338 | #define VDESC_VP0_WILLRELE 0x0001 |
| 339 | #define VDESC_VP1_WILLRELE 0x0002 |
| 340 | #define VDESC_VP2_WILLRELE 0x0004 |
| 341 | #define VDESC_VP3_WILLRELE 0x0008 |
| 342 | #define VDESC_NOMAP_VPP 0x0100 |
| 343 | #define VDESC_VPP_WILLRELE 0x0200 |
| 344 | |
| 345 | /* |
| 346 | * VDESC_NO_OFFSET is used to identify the end of the offset list |
| 347 | * and in places where no such field exists. |
| 348 | */ |
| 349 | #define VDESC_NO_OFFSET -1 |
| 350 | |
| 351 | /* |
| 352 | * This structure describes the vnode operation taking place. |
| 353 | */ |
| 354 | struct vnodeop_desc { |
| 355 | int vdesc_offset; /* offset in vector--first for speed */ |
| 356 | char *vdesc_name; /* a readable name for debugging */ |
| 357 | int vdesc_flags; /* VDESC_* flags */ |
| 358 | |
| 359 | /* |
| 360 | * These ops are used by bypass routines to map and locate arguments. |
| 361 | * Creds and procs are not needed in bypass routines, but sometimes |
| 362 | * they are useful to (for example) transport layers. |
| 363 | * Nameidata is useful because it has a cred in it. |
| 364 | */ |
| 365 | int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */ |
| 366 | int vdesc_vpp_offset; /* return vpp location */ |
| 367 | int vdesc_cred_offset; /* cred location, if any */ |
| 368 | int vdesc_proc_offset; /* proc location, if any */ |
| 369 | int vdesc_componentname_offset; /* if any */ |
| 370 | /* |
| 371 | * Finally, we've got a list of private data (about each operation) |
| 372 | * for each transport layer. (Support to manage this list is not |
| 373 | * yet part of BSD.) |
| 374 | */ |
| 375 | caddr_t *vdesc_transports; |
| 376 | }; |
| 377 | |
| 378 | #ifdef _KERNEL |
| 379 | /* |
| 380 | * A list of all the operation descs. |
| 381 | */ |
| 382 | extern struct vnodeop_desc *vnodeop_descs[]; |
| 383 | |
| 384 | /* |
| 385 | * Interlock for scanning list of vnodes attached to a mountpoint |
| 386 | */ |
| 387 | extern struct lwkt_token mntvnode_token; |
| 388 | |
| 389 | /* |
| 390 | * This macro is very helpful in defining those offsets in the vdesc struct. |
| 391 | * |
| 392 | * This is stolen from X11R4. I ignored all the fancy stuff for |
| 393 | * Crays, so if you decide to port this to such a serious machine, |
| 394 | * you might want to consult Intrinsic.h's XtOffset{,Of,To}. |
| 395 | */ |
| 396 | #define VOPARG_OFFSET(p_type,field) \ |
| 397 | ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL))) |
| 398 | #define VOPARG_OFFSETOF(s_type,field) \ |
| 399 | VOPARG_OFFSET(s_type*,field) |
| 400 | #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \ |
| 401 | ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET))) |
| 402 | |
| 403 | |
| 404 | /* |
| 405 | * This structure is used to configure the new vnodeops vector. |
| 406 | */ |
| 407 | struct vnodeopv_entry_desc { |
| 408 | struct vnodeop_desc *opve_op; /* which operation this is */ |
| 409 | vop_t *opve_impl; /* code implementing this operation */ |
| 410 | }; |
| 411 | struct vnodeopv_desc { |
| 412 | /* ptr to the ptr to the vector where op should go */ |
| 413 | vop_t ***opv_desc_vector_p; |
| 414 | struct vnodeopv_entry_desc *opv_desc_ops; /* null terminated list */ |
| 415 | }; |
| 416 | |
| 417 | /* |
| 418 | * A generic structure. |
| 419 | * This can be used by bypass routines to identify generic arguments. |
| 420 | */ |
| 421 | struct vop_generic_args { |
| 422 | struct vnodeop_desc *a_desc; |
| 423 | /* other random data follows, presumably */ |
| 424 | }; |
| 425 | |
| 426 | |
| 427 | #ifdef DEBUG_VFS_LOCKS |
| 428 | /* |
| 429 | * Macros to aid in tracing VFS locking problems. Not totally |
| 430 | * reliable since if the process sleeps between changing the lock |
| 431 | * state and checking it with the assert, some other process could |
| 432 | * change the state. They are good enough for debugging a single |
| 433 | * filesystem using a single-threaded test. I find that 'cvs co src' |
| 434 | * is a pretty good test. |
| 435 | */ |
| 436 | |
| 437 | /* |
| 438 | * [dfr] Kludge until I get around to fixing all the vfs locking. |
| 439 | */ |
| 440 | #define IS_LOCKING_VFS(vp) ((vp)->v_tag == VT_UFS \ |
| 441 | || (vp)->v_tag == VT_MFS \ |
| 442 | || (vp)->v_tag == VT_NFS \ |
| 443 | || (vp)->v_tag == VT_LFS \ |
| 444 | || (vp)->v_tag == VT_ISOFS \ |
| 445 | || (vp)->v_tag == VT_MSDOSFS) |
| 446 | |
| 447 | #define ASSERT_VOP_LOCKED(vp, str) \ |
| 448 | do { \ |
| 449 | struct vnode *_vp = (vp); \ |
| 450 | \ |
| 451 | if (_vp && IS_LOCKING_VFS(_vp) && !VOP_ISLOCKED(_vp, NULL)) \ |
| 452 | panic("%s: %p is not locked but should be", str, _vp); \ |
| 453 | } while (0) |
| 454 | |
| 455 | #define ASSERT_VOP_UNLOCKED(vp, str) \ |
| 456 | do { \ |
| 457 | struct vnode *_vp = (vp); \ |
| 458 | int lockstate; \ |
| 459 | \ |
| 460 | if (_vp && IS_LOCKING_VFS(_vp)) { \ |
| 461 | lockstate = VOP_ISLOCKED(_vp, curthread); \ |
| 462 | if (lockstate == LK_EXCLUSIVE) \ |
| 463 | panic("%s: %p is locked but should not be", \ |
| 464 | str, _vp); \ |
| 465 | } \ |
| 466 | } while (0) |
| 467 | |
| 468 | #define ASSERT_VOP_ELOCKED(vp, str) \ |
| 469 | do { \ |
| 470 | struct vnode *_vp = (vp); \ |
| 471 | \ |
| 472 | if (_vp && IS_LOCKING_VFS(_vp) && \ |
| 473 | VOP_ISLOCKED(_vp, curthread) != LK_EXCLUSIVE) \ |
| 474 | panic("%s: %p is not exclusive locked but should be", \ |
| 475 | str, _vp); \ |
| 476 | } while (0) |
| 477 | |
| 478 | #define ASSERT_VOP_ELOCKED_OTHER(vp, str) \ |
| 479 | do { \ |
| 480 | struct vnode *_vp = (vp); \ |
| 481 | \ |
| 482 | if (_vp && IS_LOCKING_VFS(_vp) && \ |
| 483 | VOP_ISLOCKED(_vp, curthread) != LK_EXCLOTHER) \ |
| 484 | panic("%s: %p is not exclusive locked by another proc", \ |
| 485 | str, _vp); \ |
| 486 | } while (0) |
| 487 | |
| 488 | #define ASSERT_VOP_SLOCKED(vp, str) \ |
| 489 | do { \ |
| 490 | struct vnode *_vp = (vp); \ |
| 491 | \ |
| 492 | if (_vp && IS_LOCKING_VFS(_vp) && \ |
| 493 | VOP_ISLOCKED(_vp, NULL) != LK_SHARED) \ |
| 494 | panic("%s: %p is not locked shared but should be", \ |
| 495 | str, _vp); \ |
| 496 | } while (0) |
| 497 | |
| 498 | #else |
| 499 | |
| 500 | #define ASSERT_VOP_LOCKED(vp, str) |
| 501 | #define ASSERT_VOP_UNLOCKED(vp, str) |
| 502 | |
| 503 | #endif |
| 504 | |
| 505 | /* |
| 506 | * VOCALL calls an op given an ops vector. We break it out because BSD's |
| 507 | * vclean changes the ops vector and then wants to call ops with the old |
| 508 | * vector. |
| 509 | */ |
| 510 | #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP)) |
| 511 | |
| 512 | /* |
| 513 | * This call works for vnodes in the kernel. |
| 514 | */ |
| 515 | #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP)) |
| 516 | #define VDESC(OP) (& __CONCAT(OP,_desc)) |
| 517 | #define VOFFSET(OP) (VDESC(OP)->vdesc_offset) |
| 518 | |
| 519 | /* |
| 520 | * VMIO support inline |
| 521 | */ |
| 522 | |
| 523 | extern int vmiodirenable; |
| 524 | |
| 525 | static __inline int |
| 526 | vn_canvmio(struct vnode *vp) |
| 527 | { |
| 528 | if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR))) |
| 529 | return(TRUE); |
| 530 | return(FALSE); |
| 531 | } |
| 532 | |
| 533 | /* |
| 534 | * Finally, include the default set of vnode operations. |
| 535 | */ |
| 536 | #include "vnode_if.h" |
| 537 | |
| 538 | /* |
| 539 | * Public vnode manipulation functions. |
| 540 | */ |
| 541 | struct componentname; |
| 542 | struct file; |
| 543 | struct mount; |
| 544 | struct nameidata; |
| 545 | struct ostat; |
| 546 | struct proc; |
| 547 | struct thread; |
| 548 | struct stat; |
| 549 | struct nstat; |
| 550 | struct ucred; |
| 551 | struct uio; |
| 552 | struct vattr; |
| 553 | struct vnode; |
| 554 | struct vop_bwrite_args; |
| 555 | |
| 556 | extern int (*lease_check_hook) (struct vop_lease_args *); |
| 557 | |
| 558 | void addalias (struct vnode *vp, dev_t nvp_rdev); |
| 559 | void addaliasu (struct vnode *vp, udev_t nvp_rdev); |
| 560 | int bdevvp (dev_t dev, struct vnode **vpp); |
| 561 | /* cache_* may belong in namei.h. */ |
| 562 | void cache_enter (struct vnode *dvp, struct vnode *vp, |
| 563 | struct componentname *cnp); |
| 564 | int cache_lookup (struct vnode *dvp, struct vnode **vpp, |
| 565 | struct componentname *cnp); |
| 566 | void cache_purge (struct vnode *vp); |
| 567 | void cache_purgevfs (struct mount *mp); |
| 568 | int cache_leaf_test (struct vnode *vp); |
| 569 | void cvtstat (struct stat *st, struct ostat *ost); |
| 570 | void cvtnstat (struct stat *sb, struct nstat *nsb); |
| 571 | int getnewvnode (enum vtagtype tag, |
| 572 | struct mount *mp, vop_t **vops, struct vnode **vpp); |
| 573 | int lease_check (struct vop_lease_args *ap); |
| 574 | int spec_vnoperate (struct vop_generic_args *); |
| 575 | int speedup_syncer (void); |
| 576 | int textvp_fullpath (struct proc *p, char **retbuf, char **retfreebuf); |
| 577 | void vattr_null (struct vattr *vap); |
| 578 | int vcount (struct vnode *vp); |
| 579 | void vdrop (struct vnode *); |
| 580 | int vfinddev (dev_t dev, enum vtype type, struct vnode **vpp); |
| 581 | void vfs_add_vnodeops (const void *); |
| 582 | void vfs_rm_vnodeops (const void *); |
| 583 | int vflush (struct mount *mp, int rootrefs, int flags); |
| 584 | int vget (struct vnode *vp, int lockflag, struct thread *td); |
| 585 | void vgone (struct vnode *vp); |
| 586 | void vgonel (struct vnode *vp, struct thread *td); |
| 587 | void vhold (struct vnode *); |
| 588 | int vinvalbuf (struct vnode *vp, int save, |
| 589 | struct thread *td, int slpflag, int slptimeo); |
| 590 | int vtruncbuf (struct vnode *vp, struct thread *td, |
| 591 | off_t length, int blksize); |
| 592 | void vprint (char *label, struct vnode *vp); |
| 593 | int vrecycle (struct vnode *vp, struct lwkt_token *inter_lkp, |
| 594 | struct thread *td); |
| 595 | int vn_close (struct vnode *vp, int flags, struct thread *td); |
| 596 | int vn_isdisk (struct vnode *vp, int *errp); |
| 597 | int vn_lock (struct vnode *vp, int flags, struct thread *td); |
| 598 | #ifdef DEBUG_LOCKS |
| 599 | int debug_vn_lock (struct vnode *vp, int flags, struct thread *td, |
| 600 | const char *filename, int line); |
| 601 | #define vn_lock(vp,flags,p) debug_vn_lock(vp,flags,p,__FILE__,__LINE__) |
| 602 | #endif |
| 603 | int vn_open (struct nameidata *ndp, int fmode, int cmode); |
| 604 | void vn_pollevent (struct vnode *vp, int events); |
| 605 | void vn_pollgone (struct vnode *vp); |
| 606 | int vn_pollrecord (struct vnode *vp, struct thread *td, int events); |
| 607 | int vn_rdwr (enum uio_rw rw, struct vnode *vp, caddr_t base, |
| 608 | int len, off_t offset, enum uio_seg segflg, int ioflg, |
| 609 | struct ucred *cred, int *aresid, struct thread *td); |
| 610 | int vn_rdwr_inchunks (enum uio_rw rw, struct vnode *vp, caddr_t base, |
| 611 | int len, off_t offset, enum uio_seg segflg, int ioflg, |
| 612 | struct ucred *cred, int *aresid, struct thread *td); |
| 613 | int vn_stat (struct vnode *vp, struct stat *sb, struct thread *td); |
| 614 | dev_t vn_todev (struct vnode *vp); |
| 615 | int vfs_cache_lookup (struct vop_lookup_args *ap); |
| 616 | int vfs_object_create (struct vnode *vp, struct thread *td); |
| 617 | void vfs_timestamp (struct timespec *); |
| 618 | int vn_writechk (struct vnode *vp); |
| 619 | int vop_stdbwrite (struct vop_bwrite_args *ap); |
| 620 | int vop_stdislocked (struct vop_islocked_args *); |
| 621 | int vop_stdlock (struct vop_lock_args *); |
| 622 | int vop_stdunlock (struct vop_unlock_args *); |
| 623 | int vop_noislocked (struct vop_islocked_args *); |
| 624 | int vop_nolock (struct vop_lock_args *); |
| 625 | int vop_nopoll (struct vop_poll_args *); |
| 626 | int vop_nounlock (struct vop_unlock_args *); |
| 627 | int vop_stdpathconf (struct vop_pathconf_args *); |
| 628 | int vop_stdpoll (struct vop_poll_args *); |
| 629 | int vop_revoke (struct vop_revoke_args *); |
| 630 | int vop_sharedlock (struct vop_lock_args *); |
| 631 | int vop_eopnotsupp (struct vop_generic_args *ap); |
| 632 | int vop_ebadf (struct vop_generic_args *ap); |
| 633 | int vop_einval (struct vop_generic_args *ap); |
| 634 | int vop_enotty (struct vop_generic_args *ap); |
| 635 | int vop_defaultop (struct vop_generic_args *ap); |
| 636 | int vop_null (struct vop_generic_args *ap); |
| 637 | int vop_panic (struct vop_generic_args *ap); |
| 638 | int vop_stdcreatevobject (struct vop_createvobject_args *ap); |
| 639 | int vop_stddestroyvobject (struct vop_destroyvobject_args *ap); |
| 640 | int vop_stdgetvobject (struct vop_getvobject_args *ap); |
| 641 | |
| 642 | void vfree (struct vnode *vp); |
| 643 | void vput (struct vnode *vp); |
| 644 | void vrele (struct vnode *vp); |
| 645 | void vref (struct vnode *vp); |
| 646 | void vbusy (struct vnode *vp); |
| 647 | |
| 648 | extern vop_t **default_vnodeop_p; |
| 649 | extern vop_t **spec_vnodeop_p; |
| 650 | |
| 651 | #endif /* _KERNEL */ |
| 652 | |
| 653 | #endif /* !_SYS_VNODE_H_ */ |