1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */ 27 /* All Rights Reserved */ 28 29 /* 30 * University Copyright- Copyright (c) 1982, 1986, 1988 31 * The Regents of the University of California 32 * All Rights Reserved 33 * 34 * University Acknowledgment- Portions of this document are derived from 35 * software developed by the University of California, Berkeley, and its 36 * contributors. 37 */ 38 39 #ifndef _SYS_VNODE_H 40 #define _SYS_VNODE_H 41 42 #include <sys/types.h> 43 #include <sys/t_lock.h> 44 #include <sys/rwstlock.h> 45 #include <sys/time_impl.h> 46 #include <sys/cred.h> 47 #include <sys/uio.h> 48 #include <sys/resource.h> 49 #include <vm/seg_enum.h> 50 #include <sys/kstat.h> 51 #include <sys/kmem.h> 52 #include <sys/list.h> 53 #ifdef _KERNEL 54 #include <sys/buf.h> 55 #endif /* _KERNEL */ 56 57 #ifdef __cplusplus 58 extern "C" { 59 #endif 60 61 /* 62 * Statistics for all vnode operations. 63 * All operations record number of ops (since boot/mount/zero'ed). 64 * Certain I/O operations (read, write, readdir) also record number 65 * of bytes transferred. 66 * This appears in two places in the system: one is embedded in each 67 * vfs_t. There is also an array of vopstats_t structures allocated 68 * on a per-fstype basis. 69 */ 70 71 #define VOPSTATS_STR "vopstats_" /* Initial string for vopstat kstats */ 72 73 typedef struct vopstats { 74 kstat_named_t nopen; /* VOP_OPEN */ 75 kstat_named_t nclose; /* VOP_CLOSE */ 76 kstat_named_t nread; /* VOP_READ */ 77 kstat_named_t read_bytes; 78 kstat_named_t nwrite; /* VOP_WRITE */ 79 kstat_named_t write_bytes; 80 kstat_named_t nioctl; /* VOP_IOCTL */ 81 kstat_named_t nsetfl; /* VOP_SETFL */ 82 kstat_named_t ngetattr; /* VOP_GETATTR */ 83 kstat_named_t nsetattr; /* VOP_SETATTR */ 84 kstat_named_t naccess; /* VOP_ACCESS */ 85 kstat_named_t nlookup; /* VOP_LOOKUP */ 86 kstat_named_t ncreate; /* VOP_CREATE */ 87 kstat_named_t nremove; /* VOP_REMOVE */ 88 kstat_named_t nlink; /* VOP_LINK */ 89 kstat_named_t nrename; /* VOP_RENAME */ 90 kstat_named_t nmkdir; /* VOP_MKDIR */ 91 kstat_named_t nrmdir; /* VOP_RMDIR */ 92 kstat_named_t nreaddir; /* VOP_READDIR */ 93 kstat_named_t readdir_bytes; 94 kstat_named_t nsymlink; /* VOP_SYMLINK */ 95 kstat_named_t nreadlink; /* VOP_READLINK */ 96 kstat_named_t nfsync; /* VOP_FSYNC */ 97 kstat_named_t ninactive; /* VOP_INACTIVE */ 98 kstat_named_t nfid; /* VOP_FID */ 99 kstat_named_t nrwlock; /* VOP_RWLOCK */ 100 kstat_named_t nrwunlock; /* VOP_RWUNLOCK */ 101 kstat_named_t nseek; /* VOP_SEEK */ 102 kstat_named_t ncmp; /* VOP_CMP */ 103 kstat_named_t nfrlock; /* VOP_FRLOCK */ 104 kstat_named_t nspace; /* VOP_SPACE */ 105 kstat_named_t nrealvp; /* VOP_REALVP */ 106 kstat_named_t ngetpage; /* VOP_GETPAGE */ 107 kstat_named_t nputpage; /* VOP_PUTPAGE */ 108 kstat_named_t nmap; /* VOP_MAP */ 109 kstat_named_t naddmap; /* VOP_ADDMAP */ 110 kstat_named_t ndelmap; /* VOP_DELMAP */ 111 kstat_named_t npoll; /* VOP_POLL */ 112 kstat_named_t ndump; /* VOP_DUMP */ 113 kstat_named_t npathconf; /* VOP_PATHCONF */ 114 kstat_named_t npageio; /* VOP_PAGEIO */ 115 kstat_named_t ndumpctl; /* VOP_DUMPCTL */ 116 kstat_named_t ndispose; /* VOP_DISPOSE */ 117 kstat_named_t nsetsecattr; /* VOP_SETSECATTR */ 118 kstat_named_t ngetsecattr; /* VOP_GETSECATTR */ 119 kstat_named_t nshrlock; /* VOP_SHRLOCK */ 120 kstat_named_t nvnevent; /* VOP_VNEVENT */ 121 kstat_named_t nreqzcbuf; /* VOP_REQZCBUF */ 122 kstat_named_t nretzcbuf; /* VOP_RETZCBUF */ 123 } vopstats_t; 124 125 /* 126 * The vnode is the focus of all file activity in UNIX. 127 * A vnode is allocated for each active file, each current 128 * directory, each mounted-on file, and the root. 129 * 130 * Each vnode is usually associated with a file-system-specific node (for 131 * UFS, this is the in-memory inode). Generally, a vnode and an fs-node 132 * should be created and destroyed together as a pair. 133 * 134 * If a vnode is reused for a new file, it should be reinitialized by calling 135 * either vn_reinit() or vn_recycle(). 136 * 137 * vn_reinit() resets the entire vnode as if it was returned by vn_alloc(). 138 * The caller is responsible for setting up the entire vnode after calling 139 * vn_reinit(). This is important when using kmem caching where the vnode is 140 * allocated by a constructor, for instance. 141 * 142 * vn_recycle() is used when the file system keeps some state around in both 143 * the vnode and the associated FS-node. In UFS, for example, the inode of 144 * a deleted file can be reused immediately. The v_data, v_vfsp, v_op, etc. 145 * remains the same but certain fields related to the previous instance need 146 * to be reset. In particular: 147 * v_femhead 148 * v_path 149 * v_rdcnt, v_wrcnt 150 * v_mmap_read, v_mmap_write 151 */ 152 153 /* 154 * vnode types. VNON means no type. These values are unrelated to 155 * values in on-disk inodes. 156 */ 157 typedef enum vtype { 158 VNON = 0, 159 VREG = 1, 160 VDIR = 2, 161 VBLK = 3, 162 VCHR = 4, 163 VLNK = 5, 164 VFIFO = 6, 165 VDOOR = 7, 166 VPROC = 8, 167 VSOCK = 9, 168 VPORT = 10, 169 VBAD = 11 170 } vtype_t; 171 172 /* 173 * VSD - Vnode Specific Data 174 * Used to associate additional private data with a vnode. 175 */ 176 struct vsd_node { 177 list_node_t vs_nodes; /* list of all VSD nodes */ 178 uint_t vs_nkeys; /* entries in value array */ 179 void **vs_value; /* array of value/key */ 180 }; 181 182 /* 183 * Many of the fields in the vnode are read-only once they are initialized 184 * at vnode creation time. Other fields are protected by locks. 185 * 186 * IMPORTANT: vnodes should be created ONLY by calls to vn_alloc(). They 187 * may not be embedded into the file-system specific node (inode). The 188 * size of vnodes may change. 189 * 190 * The v_lock protects: 191 * v_flag 192 * v_stream 193 * v_count 194 * v_shrlocks 195 * v_path 196 * v_vsd 197 * v_xattrdir 198 * 199 * A special lock (implemented by vn_vfswlock in vnode.c) protects: 200 * v_vfsmountedhere 201 * 202 * The global flock_lock mutex (in flock.c) protects: 203 * v_filocks 204 * 205 * IMPORTANT NOTE: 206 * 207 * The following vnode fields are considered public and may safely be 208 * accessed by file systems or other consumers: 209 * 210 * v_lock 211 * v_flag 212 * v_count 213 * v_data 214 * v_vfsp 215 * v_stream 216 * v_type 217 * v_rdev 218 * 219 * ALL OTHER FIELDS SHOULD BE ACCESSED ONLY BY THE OWNER OF THAT FIELD. 220 * In particular, file systems should not access other fields; they may 221 * change or even be removed. The functionality which was once provided 222 * by these fields is available through vn_* functions. 223 */ 224 225 struct fem_head; /* from fem.h */ 226 227 typedef struct vnode { 228 kmutex_t v_lock; /* protects vnode fields */ 229 uint_t v_flag; /* vnode flags (see below) */ 230 uint_t v_count; /* reference count */ 231 void *v_data; /* private data for fs */ 232 struct vfs *v_vfsp; /* ptr to containing VFS */ 233 struct stdata *v_stream; /* associated stream */ 234 enum vtype v_type; /* vnode type */ 235 dev_t v_rdev; /* device (VCHR, VBLK) */ 236 237 /* PRIVATE FIELDS BELOW - DO NOT USE */ 238 239 struct vfs *v_vfsmountedhere; /* ptr to vfs mounted here */ 240 struct vnodeops *v_op; /* vnode operations */ 241 struct page *v_pages; /* vnode pages list */ 242 struct filock *v_filocks; /* ptr to filock list */ 243 struct shrlocklist *v_shrlocks; /* ptr to shrlock list */ 244 krwlock_t v_nbllock; /* sync for NBMAND locks */ 245 kcondvar_t v_cv; /* synchronize locking */ 246 void *v_locality; /* hook for locality info */ 247 struct fem_head *v_femhead; /* fs monitoring */ 248 char *v_path; /* cached path */ 249 uint_t v_rdcnt; /* open for read count (VREG only) */ 250 uint_t v_wrcnt; /* open for write count (VREG only) */ 251 u_longlong_t v_mmap_read; /* mmap read count */ 252 u_longlong_t v_mmap_write; /* mmap write count */ 253 void *v_mpssdata; /* info for large page mappings */ 254 void *v_fopdata; /* list of file ops event watches */ 255 kmutex_t v_vsd_lock; /* protects v_vsd field */ 256 struct vsd_node *v_vsd; /* vnode specific data */ 257 struct vnode *v_xattrdir; /* unnamed extended attr dir (GFS) */ 258 uint_t v_count_dnlc; /* dnlc reference count */ 259 } vnode_t; 260 261 #define IS_DEVVP(vp) \ 262 ((vp)->v_type == VCHR || (vp)->v_type == VBLK || (vp)->v_type == VFIFO) 263 264 #define VNODE_ALIGN 64 265 /* Count of low-order 0 bits in a vnode *, based on size and alignment. */ 266 #if defined(_LP64) 267 #define VNODE_ALIGN_LOG2 8 268 #else 269 #define VNODE_ALIGN_LOG2 7 270 #endif 271 272 /* 273 * vnode flags. 274 */ 275 #define VROOT 0x01 /* root of its file system */ 276 #define VNOCACHE 0x02 /* don't keep cache pages on vnode */ 277 #define VNOMAP 0x04 /* file cannot be mapped/faulted */ 278 #define VDUP 0x08 /* file should be dup'ed rather then opened */ 279 #define VNOSWAP 0x10 /* file cannot be used as virtual swap device */ 280 #define VNOMOUNT 0x20 /* file cannot be covered by mount */ 281 #define VISSWAP 0x40 /* vnode is being used for swap */ 282 #define VSWAPLIKE 0x80 /* vnode acts like swap (but may not be) */ 283 284 #define IS_SWAPVP(vp) (((vp)->v_flag & (VISSWAP | VSWAPLIKE)) != 0) 285 286 typedef struct vn_vfslocks_entry { 287 rwstlock_t ve_lock; 288 void *ve_vpvfs; 289 struct vn_vfslocks_entry *ve_next; 290 uint32_t ve_refcnt; 291 char pad[64 - sizeof (rwstlock_t) - 2 * sizeof (void *) - \ 292 sizeof (uint32_t)]; 293 } vn_vfslocks_entry_t; 294 295 /* 296 * The following two flags are used to lock the v_vfsmountedhere field 297 */ 298 #define VVFSLOCK 0x100 299 #define VVFSWAIT 0x200 300 301 /* 302 * Used to serialize VM operations on a vnode 303 */ 304 #define VVMLOCK 0x400 305 306 /* 307 * Tell vn_open() not to fail a directory open for writing but 308 * to go ahead and call VOP_OPEN() to let the filesystem check. 309 */ 310 #define VDIROPEN 0x800 311 312 /* 313 * Flag to let the VM system know that this file is most likely a binary 314 * or shared library since it has been mmap()ed EXEC at some time. 315 */ 316 #define VVMEXEC 0x1000 317 318 #define VPXFS 0x2000 /* clustering: global fs proxy vnode */ 319 320 #define IS_PXFSVP(vp) ((vp)->v_flag & VPXFS) 321 322 #define V_XATTRDIR 0x4000 /* attribute unnamed directory */ 323 324 #define IS_XATTRDIR(vp) ((vp)->v_flag & V_XATTRDIR) 325 326 #define V_LOCALITY 0x8000 /* whether locality aware */ 327 328 /* 329 * Flag that indicates the VM should maintain the v_pages list with all modified 330 * pages on one end and unmodified pages at the other. This makes finding dirty 331 * pages to write back to disk much faster at the expense of taking a minor 332 * fault on the first store instruction which touches a writable page. 333 */ 334 #define VMODSORT (0x10000) 335 #define IS_VMODSORT(vp) \ 336 (pvn_vmodsort_supported != 0 && ((vp)->v_flag & VMODSORT) != 0) 337 338 #define VISSWAPFS 0x20000 /* vnode is being used for swapfs */ 339 340 /* 341 * The mdb memstat command assumes that IS_SWAPFSVP only uses the 342 * vnode's v_flag field. If this changes, cache the additional 343 * fields in mdb; see vn_get in mdb/common/modules/genunix/memory.c 344 */ 345 #define IS_SWAPFSVP(vp) (((vp)->v_flag & VISSWAPFS) != 0) 346 347 #define V_SYSATTR 0x40000 /* vnode is a GFS system attribute */ 348 349 /* 350 * Vnode attributes. A bit-mask is supplied as part of the 351 * structure to indicate the attributes the caller wants to 352 * set (setattr) or extract (getattr). 353 */ 354 355 /* 356 * Note that va_nodeid and va_nblocks are 64bit data type. 357 * We support large files over NFSV3. With Solaris client and 358 * Server that generates 64bit ino's and sizes these fields 359 * will overflow if they are 32 bit sizes. 360 */ 361 362 typedef struct vattr { 363 uint_t va_mask; /* bit-mask of attributes */ 364 vtype_t va_type; /* vnode type (for create) */ 365 mode_t va_mode; /* file access mode */ 366 uid_t va_uid; /* owner user id */ 367 gid_t va_gid; /* owner group id */ 368 dev_t va_fsid; /* file system id (dev for now) */ 369 u_longlong_t va_nodeid; /* node id */ 370 nlink_t va_nlink; /* number of references to file */ 371 u_offset_t va_size; /* file size in bytes */ 372 timestruc_t va_atime; /* time of last access */ 373 timestruc_t va_mtime; /* time of last modification */ 374 timestruc_t va_ctime; /* time of last status change */ 375 dev_t va_rdev; /* device the file represents */ 376 uint_t va_blksize; /* fundamental block size */ 377 u_longlong_t va_nblocks; /* # of blocks allocated */ 378 uint_t va_seq; /* sequence number */ 379 } vattr_t; 380 381 #define AV_SCANSTAMP_SZ 32 /* length of anti-virus scanstamp */ 382 383 /* 384 * Structure of all optional attributes. 385 */ 386 typedef struct xoptattr { 387 timestruc_t xoa_createtime; /* Create time of file */ 388 uint8_t xoa_archive; 389 uint8_t xoa_system; 390 uint8_t xoa_readonly; 391 uint8_t xoa_hidden; 392 uint8_t xoa_nounlink; 393 uint8_t xoa_immutable; 394 uint8_t xoa_appendonly; 395 uint8_t xoa_nodump; 396 uint8_t xoa_opaque; 397 uint8_t xoa_av_quarantined; 398 uint8_t xoa_av_modified; 399 uint8_t xoa_av_scanstamp[AV_SCANSTAMP_SZ]; 400 uint8_t xoa_reparse; 401 uint64_t xoa_generation; 402 } xoptattr_t; 403 404 /* 405 * The xvattr structure is really a variable length structure that 406 * is made up of: 407 * - The classic vattr_t (xva_vattr) 408 * - a 32 bit quantity (xva_mapsize) that specifies the size of the 409 * attribute bitmaps in 32 bit words. 410 * - A pointer to the returned attribute bitmap (needed because the 411 * previous element, the requested attribute bitmap) is variable lenth. 412 * - The requested attribute bitmap, which is an array of 32 bit words. 413 * Callers use the XVA_SET_REQ() macro to set the bits corresponding to 414 * the attributes that are being requested. 415 * - The returned attribute bitmap, which is an array of 32 bit words. 416 * File systems that support optional attributes use the XVA_SET_RTN() 417 * macro to set the bits corresponding to the attributes that are being 418 * returned. 419 * - The xoptattr_t structure which contains the attribute values 420 * 421 * xva_mapsize determines how many words in the attribute bitmaps. 422 * Immediately following the attribute bitmaps is the xoptattr_t. 423 * xva_getxoptattr() is used to get the pointer to the xoptattr_t 424 * section. 425 */ 426 427 #define XVA_MAPSIZE 3 /* Size of attr bitmaps */ 428 #define XVA_MAGIC 0x78766174 /* Magic # for verification */ 429 430 /* 431 * The xvattr structure is an extensible structure which permits optional 432 * attributes to be requested/returned. File systems may or may not support 433 * optional attributes. They do so at their own discretion but if they do 434 * support optional attributes, they must register the VFSFT_XVATTR feature 435 * so that the optional attributes can be set/retrived. 436 * 437 * The fields of the xvattr structure are: 438 * 439 * xva_vattr - The first element of an xvattr is a legacy vattr structure 440 * which includes the common attributes. If AT_XVATTR is set in the va_mask 441 * then the entire structure is treated as an xvattr. If AT_XVATTR is not 442 * set, then only the xva_vattr structure can be used. 443 * 444 * xva_magic - 0x78766174 (hex for "xvat"). Magic number for verification. 445 * 446 * xva_mapsize - Size of requested and returned attribute bitmaps. 447 * 448 * xva_rtnattrmapp - Pointer to xva_rtnattrmap[]. We need this since the 449 * size of the array before it, xva_reqattrmap[], could change which means 450 * the location of xva_rtnattrmap[] could change. This will allow unbundled 451 * file systems to find the location of xva_rtnattrmap[] when the sizes change. 452 * 453 * xva_reqattrmap[] - Array of requested attributes. Attributes are 454 * represented by a specific bit in a specific element of the attribute 455 * map array. Callers set the bits corresponding to the attributes 456 * that the caller wants to get/set. 457 * 458 * xva_rtnattrmap[] - Array of attributes that the file system was able to 459 * process. Not all file systems support all optional attributes. This map 460 * informs the caller which attributes the underlying file system was able 461 * to set/get. (Same structure as the requested attributes array in terms 462 * of each attribute corresponding to specific bits and array elements.) 463 * 464 * xva_xoptattrs - Structure containing values of optional attributes. 465 * These values are only valid if the corresponding bits in xva_reqattrmap 466 * are set and the underlying file system supports those attributes. 467 */ 468 typedef struct xvattr { 469 vattr_t xva_vattr; /* Embedded vattr structure */ 470 uint32_t xva_magic; /* Magic Number */ 471 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */ 472 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */ 473 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */ 474 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */ 475 xoptattr_t xva_xoptattrs; /* Optional attributes */ 476 } xvattr_t; 477 478 #ifdef _SYSCALL32 479 /* 480 * For bigtypes time_t changed to 64 bit on the 64-bit kernel. 481 * Define an old version for user/kernel interface 482 */ 483 484 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 485 #pragma pack(4) 486 #endif 487 488 typedef struct vattr32 { 489 uint32_t va_mask; /* bit-mask of attributes */ 490 vtype_t va_type; /* vnode type (for create) */ 491 mode32_t va_mode; /* file access mode */ 492 uid32_t va_uid; /* owner user id */ 493 gid32_t va_gid; /* owner group id */ 494 dev32_t va_fsid; /* file system id (dev for now) */ 495 u_longlong_t va_nodeid; /* node id */ 496 nlink_t va_nlink; /* number of references to file */ 497 u_offset_t va_size; /* file size in bytes */ 498 timestruc32_t va_atime; /* time of last access */ 499 timestruc32_t va_mtime; /* time of last modification */ 500 timestruc32_t va_ctime; /* time of last status change */ 501 dev32_t va_rdev; /* device the file represents */ 502 uint32_t va_blksize; /* fundamental block size */ 503 u_longlong_t va_nblocks; /* # of blocks allocated */ 504 uint32_t va_seq; /* sequence number */ 505 } vattr32_t; 506 507 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 508 #pragma pack() 509 #endif 510 511 #else /* not _SYSCALL32 */ 512 #define vattr32 vattr 513 typedef vattr_t vattr32_t; 514 #endif /* _SYSCALL32 */ 515 516 /* 517 * Attributes of interest to the caller of setattr or getattr. 518 */ 519 #define AT_TYPE 0x00001 520 #define AT_MODE 0x00002 521 #define AT_UID 0x00004 522 #define AT_GID 0x00008 523 #define AT_FSID 0x00010 524 #define AT_NODEID 0x00020 525 #define AT_NLINK 0x00040 526 #define AT_SIZE 0x00080 527 #define AT_ATIME 0x00100 528 #define AT_MTIME 0x00200 529 #define AT_CTIME 0x00400 530 #define AT_RDEV 0x00800 531 #define AT_BLKSIZE 0x01000 532 #define AT_NBLOCKS 0x02000 533 /* 0x04000 */ /* unused */ 534 #define AT_SEQ 0x08000 535 /* 536 * If AT_XVATTR is set then there are additional bits to process in 537 * the xvattr_t's attribute bitmap. If this is not set then the bitmap 538 * MUST be ignored. Note that this bit must be set/cleared explicitly. 539 * That is, setting AT_ALL will NOT set AT_XVATTR. 540 */ 541 #define AT_XVATTR 0x10000 542 543 #define AT_ALL (AT_TYPE|AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\ 544 AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\ 545 AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ) 546 547 #define AT_STAT (AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\ 548 AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV|AT_TYPE) 549 550 #define AT_TIMES (AT_ATIME|AT_MTIME|AT_CTIME) 551 552 #define AT_NOSET (AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|AT_TYPE|\ 553 AT_BLKSIZE|AT_NBLOCKS|AT_SEQ) 554 555 /* 556 * Attribute bits used in the extensible attribute's (xva's) attribute 557 * bitmaps. Note that the bitmaps are made up of a variable length number 558 * of 32-bit words. The convention is to use XAT{n}_{attrname} where "n" 559 * is the element in the bitmap (starting at 1). This convention is for 560 * the convenience of the maintainer to keep track of which element each 561 * attribute belongs to. 562 * 563 * NOTE THAT CONSUMERS MUST *NOT* USE THE XATn_* DEFINES DIRECTLY. CONSUMERS 564 * MUST USE THE XAT_* DEFINES. 565 */ 566 #define XAT0_INDEX 0LL /* Index into bitmap for XAT0 attrs */ 567 #define XAT0_CREATETIME 0x00000001 /* Create time of file */ 568 #define XAT0_ARCHIVE 0x00000002 /* Archive */ 569 #define XAT0_SYSTEM 0x00000004 /* System */ 570 #define XAT0_READONLY 0x00000008 /* Readonly */ 571 #define XAT0_HIDDEN 0x00000010 /* Hidden */ 572 #define XAT0_NOUNLINK 0x00000020 /* Nounlink */ 573 #define XAT0_IMMUTABLE 0x00000040 /* immutable */ 574 #define XAT0_APPENDONLY 0x00000080 /* appendonly */ 575 #define XAT0_NODUMP 0x00000100 /* nodump */ 576 #define XAT0_OPAQUE 0x00000200 /* opaque */ 577 #define XAT0_AV_QUARANTINED 0x00000400 /* anti-virus quarantine */ 578 #define XAT0_AV_MODIFIED 0x00000800 /* anti-virus modified */ 579 #define XAT0_AV_SCANSTAMP 0x00001000 /* anti-virus scanstamp */ 580 #define XAT0_REPARSE 0x00002000 /* FS reparse point */ 581 #define XAT0_GEN 0x00004000 /* object generation number */ 582 583 #define XAT0_ALL_ATTRS (XAT0_CREATETIME|XAT0_ARCHIVE|XAT0_SYSTEM| \ 584 XAT0_READONLY|XAT0_HIDDEN|XAT0_NOUNLINK|XAT0_IMMUTABLE|XAT0_APPENDONLY| \ 585 XAT0_NODUMP|XAT0_OPAQUE|XAT0_AV_QUARANTINED| \ 586 XAT0_AV_MODIFIED|XAT0_AV_SCANSTAMP|XAT0_REPARSE|XAT0_GEN) 587 588 /* Support for XAT_* optional attributes */ 589 #define XVA_MASK 0xffffffff /* Used to mask off 32 bits */ 590 #define XVA_SHFT 32 /* Used to shift index */ 591 592 /* 593 * Used to pry out the index and attribute bits from the XAT_* attributes 594 * defined below. Note that we're masking things down to 32 bits then 595 * casting to uint32_t. 596 */ 597 #define XVA_INDEX(attr) ((uint32_t)(((attr) >> XVA_SHFT) & XVA_MASK)) 598 #define XVA_ATTRBIT(attr) ((uint32_t)((attr) & XVA_MASK)) 599 600 /* 601 * The following defines present a "flat namespace" so that consumers don't 602 * need to keep track of which element belongs to which bitmap entry. 603 * 604 * NOTE THAT THESE MUST NEVER BE OR-ed TOGETHER 605 */ 606 #define XAT_CREATETIME ((XAT0_INDEX << XVA_SHFT) | XAT0_CREATETIME) 607 #define XAT_ARCHIVE ((XAT0_INDEX << XVA_SHFT) | XAT0_ARCHIVE) 608 #define XAT_SYSTEM ((XAT0_INDEX << XVA_SHFT) | XAT0_SYSTEM) 609 #define XAT_READONLY ((XAT0_INDEX << XVA_SHFT) | XAT0_READONLY) 610 #define XAT_HIDDEN ((XAT0_INDEX << XVA_SHFT) | XAT0_HIDDEN) 611 #define XAT_NOUNLINK ((XAT0_INDEX << XVA_SHFT) | XAT0_NOUNLINK) 612 #define XAT_IMMUTABLE ((XAT0_INDEX << XVA_SHFT) | XAT0_IMMUTABLE) 613 #define XAT_APPENDONLY ((XAT0_INDEX << XVA_SHFT) | XAT0_APPENDONLY) 614 #define XAT_NODUMP ((XAT0_INDEX << XVA_SHFT) | XAT0_NODUMP) 615 #define XAT_OPAQUE ((XAT0_INDEX << XVA_SHFT) | XAT0_OPAQUE) 616 #define XAT_AV_QUARANTINED ((XAT0_INDEX << XVA_SHFT) | XAT0_AV_QUARANTINED) 617 #define XAT_AV_MODIFIED ((XAT0_INDEX << XVA_SHFT) | XAT0_AV_MODIFIED) 618 #define XAT_AV_SCANSTAMP ((XAT0_INDEX << XVA_SHFT) | XAT0_AV_SCANSTAMP) 619 #define XAT_REPARSE ((XAT0_INDEX << XVA_SHFT) | XAT0_REPARSE) 620 #define XAT_GEN ((XAT0_INDEX << XVA_SHFT) | XAT0_GEN) 621 622 /* 623 * The returned attribute map array (xva_rtnattrmap[]) is located past the 624 * requested attribute map array (xva_reqattrmap[]). Its location changes 625 * when the array sizes change. We use a separate pointer in a known location 626 * (xva_rtnattrmapp) to hold the location of xva_rtnattrmap[]. This is 627 * set in xva_init() 628 */ 629 #define XVA_RTNATTRMAP(xvap) ((xvap)->xva_rtnattrmapp) 630 631 /* 632 * XVA_SET_REQ() sets an attribute bit in the proper element in the bitmap 633 * of requested attributes (xva_reqattrmap[]). 634 */ 635 #define XVA_SET_REQ(xvap, attr) \ 636 ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR); \ 637 ASSERT((xvap)->xva_magic == XVA_MAGIC); \ 638 (xvap)->xva_reqattrmap[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr) 639 /* 640 * XVA_CLR_REQ() clears an attribute bit in the proper element in the bitmap 641 * of requested attributes (xva_reqattrmap[]). 642 */ 643 #define XVA_CLR_REQ(xvap, attr) \ 644 ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR); \ 645 ASSERT((xvap)->xva_magic == XVA_MAGIC); \ 646 (xvap)->xva_reqattrmap[XVA_INDEX(attr)] &= ~XVA_ATTRBIT(attr) 647 648 /* 649 * XVA_SET_RTN() sets an attribute bit in the proper element in the bitmap 650 * of returned attributes (xva_rtnattrmap[]). 651 */ 652 #define XVA_SET_RTN(xvap, attr) \ 653 ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR); \ 654 ASSERT((xvap)->xva_magic == XVA_MAGIC); \ 655 (XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr) 656 657 /* 658 * XVA_ISSET_REQ() checks the requested attribute bitmap (xva_reqattrmap[]) 659 * to see of the corresponding attribute bit is set. If so, returns non-zero. 660 */ 661 #define XVA_ISSET_REQ(xvap, attr) \ 662 ((((xvap)->xva_vattr.va_mask | AT_XVATTR) && \ 663 ((xvap)->xva_magic == XVA_MAGIC) && \ 664 ((xvap)->xva_mapsize > XVA_INDEX(attr))) ? \ 665 ((xvap)->xva_reqattrmap[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) : 0) 666 667 /* 668 * XVA_ISSET_RTN() checks the returned attribute bitmap (xva_rtnattrmap[]) 669 * to see of the corresponding attribute bit is set. If so, returns non-zero. 670 */ 671 #define XVA_ISSET_RTN(xvap, attr) \ 672 ((((xvap)->xva_vattr.va_mask | AT_XVATTR) && \ 673 ((xvap)->xva_magic == XVA_MAGIC) && \ 674 ((xvap)->xva_mapsize > XVA_INDEX(attr))) ? \ 675 ((XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) : 0) 676 677 /* 678 * Modes. Some values same as S_xxx entries from stat.h for convenience. 679 */ 680 #define VSUID 04000 /* set user id on execution */ 681 #define VSGID 02000 /* set group id on execution */ 682 #define VSVTX 01000 /* save swapped text even after use */ 683 684 /* 685 * Permissions. 686 */ 687 #define VREAD 00400 688 #define VWRITE 00200 689 #define VEXEC 00100 690 691 #define MODEMASK 07777 /* mode bits plus permission bits */ 692 #define PERMMASK 00777 /* permission bits */ 693 694 /* 695 * VOP_ACCESS flags 696 */ 697 #define V_ACE_MASK 0x1 /* mask represents NFSv4 ACE permissions */ 698 #define V_APPEND 0x2 /* want to do append only check */ 699 700 /* 701 * Check whether mandatory file locking is enabled. 702 */ 703 704 #define MANDMODE(mode) (((mode) & (VSGID|(VEXEC>>3))) == VSGID) 705 #define MANDLOCK(vp, mode) ((vp)->v_type == VREG && MANDMODE(mode)) 706 707 /* 708 * Flags for vnode operations. 709 */ 710 enum rm { RMFILE, RMDIRECTORY }; /* rm or rmdir (remove) */ 711 enum symfollow { NO_FOLLOW, FOLLOW }; /* follow symlinks (or not) */ 712 enum vcexcl { NONEXCL, EXCL }; /* (non)excl create */ 713 enum create { CRCREAT, CRMKNOD, CRMKDIR }; /* reason for create */ 714 715 typedef enum rm rm_t; 716 typedef enum symfollow symfollow_t; 717 typedef enum vcexcl vcexcl_t; 718 typedef enum create create_t; 719 720 /* Vnode Events - Used by VOP_VNEVENT */ 721 typedef enum vnevent { 722 VE_SUPPORT = 0, /* Query */ 723 VE_RENAME_SRC = 1, /* Rename, with vnode as source */ 724 VE_RENAME_DEST = 2, /* Rename, with vnode as target/destination */ 725 VE_REMOVE = 3, /* Remove of vnode's name */ 726 VE_RMDIR = 4, /* Remove of directory vnode's name */ 727 VE_CREATE = 5, /* Create with vnode's name which exists */ 728 VE_LINK = 6, /* Link with vnode's name as source */ 729 VE_RENAME_DEST_DIR = 7, /* Rename with vnode as target dir */ 730 VE_MOUNTEDOVER = 8 /* File or Filesystem got mounted over vnode */ 731 } vnevent_t; 732 733 /* 734 * Values for checking vnode open and map counts 735 */ 736 enum v_mode { V_READ, V_WRITE, V_RDORWR, V_RDANDWR }; 737 738 typedef enum v_mode v_mode_t; 739 740 #define V_TRUE 1 741 #define V_FALSE 0 742 743 /* 744 * Structure used on VOP_GETSECATTR and VOP_SETSECATTR operations 745 */ 746 747 typedef struct vsecattr { 748 uint_t vsa_mask; /* See below */ 749 int vsa_aclcnt; /* ACL entry count */ 750 void *vsa_aclentp; /* pointer to ACL entries */ 751 int vsa_dfaclcnt; /* default ACL entry count */ 752 void *vsa_dfaclentp; /* pointer to default ACL entries */ 753 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */ 754 uint_t vsa_aclflags; /* ACE ACL flags */ 755 } vsecattr_t; 756 757 /* vsa_mask values */ 758 #define VSA_ACL 0x0001 759 #define VSA_ACLCNT 0x0002 760 #define VSA_DFACL 0x0004 761 #define VSA_DFACLCNT 0x0008 762 #define VSA_ACE 0x0010 763 #define VSA_ACECNT 0x0020 764 #define VSA_ACE_ALLTYPES 0x0040 765 #define VSA_ACE_ACLFLAGS 0x0080 /* get/set ACE ACL flags */ 766 767 /* 768 * Structure used by various vnode operations to determine 769 * the context (pid, host, identity) of a caller. 770 * 771 * The cc_caller_id is used to identify one or more callers who invoke 772 * operations, possibly on behalf of others. For example, the NFS 773 * server could have it's own cc_caller_id which can be detected by 774 * vnode/vfs operations or (FEM) monitors on those operations. New 775 * caller IDs are generated by fs_new_caller_id(). 776 */ 777 typedef struct caller_context { 778 pid_t cc_pid; /* Process ID of the caller */ 779 int cc_sysid; /* System ID, used for remote calls */ 780 u_longlong_t cc_caller_id; /* Identifier for (set of) caller(s) */ 781 ulong_t cc_flags; 782 } caller_context_t; 783 784 /* 785 * Flags for caller context. The caller sets CC_DONTBLOCK if it does not 786 * want to block inside of a FEM monitor. The monitor will set CC_WOULDBLOCK 787 * and return EAGAIN if the operation would have blocked. 788 */ 789 #define CC_WOULDBLOCK 0x01 790 #define CC_DONTBLOCK 0x02 791 792 /* 793 * Structure tags for function prototypes, defined elsewhere. 794 */ 795 struct pathname; 796 struct fid; 797 struct flock64; 798 struct flk_callback; 799 struct shrlock; 800 struct page; 801 struct seg; 802 struct as; 803 struct pollhead; 804 struct taskq; 805 806 #ifdef _KERNEL 807 808 /* 809 * VNODE_OPS defines all the vnode operations. It is used to define 810 * the vnodeops structure (below) and the fs_func_p union (vfs_opreg.h). 811 */ 812 #define VNODE_OPS \ 813 int (*vop_open)(vnode_t **, int, cred_t *, \ 814 caller_context_t *); \ 815 int (*vop_close)(vnode_t *, int, int, offset_t, cred_t *, \ 816 caller_context_t *); \ 817 int (*vop_read)(vnode_t *, uio_t *, int, cred_t *, \ 818 caller_context_t *); \ 819 int (*vop_write)(vnode_t *, uio_t *, int, cred_t *, \ 820 caller_context_t *); \ 821 int (*vop_ioctl)(vnode_t *, int, intptr_t, int, cred_t *, \ 822 int *, caller_context_t *); \ 823 int (*vop_setfl)(vnode_t *, int, int, cred_t *, \ 824 caller_context_t *); \ 825 int (*vop_getattr)(vnode_t *, vattr_t *, int, cred_t *, \ 826 caller_context_t *); \ 827 int (*vop_setattr)(vnode_t *, vattr_t *, int, cred_t *, \ 828 caller_context_t *); \ 829 int (*vop_access)(vnode_t *, int, int, cred_t *, \ 830 caller_context_t *); \ 831 int (*vop_lookup)(vnode_t *, char *, vnode_t **, \ 832 struct pathname *, \ 833 int, vnode_t *, cred_t *, \ 834 caller_context_t *, int *, \ 835 struct pathname *); \ 836 int (*vop_create)(vnode_t *, char *, vattr_t *, vcexcl_t, \ 837 int, vnode_t **, cred_t *, int, \ 838 caller_context_t *, vsecattr_t *); \ 839 int (*vop_remove)(vnode_t *, char *, cred_t *, \ 840 caller_context_t *, int); \ 841 int (*vop_link)(vnode_t *, vnode_t *, char *, cred_t *, \ 842 caller_context_t *, int); \ 843 int (*vop_rename)(vnode_t *, char *, vnode_t *, char *, \ 844 cred_t *, caller_context_t *, int); \ 845 int (*vop_mkdir)(vnode_t *, char *, vattr_t *, vnode_t **, \ 846 cred_t *, caller_context_t *, int, \ 847 vsecattr_t *); \ 848 int (*vop_rmdir)(vnode_t *, char *, vnode_t *, cred_t *, \ 849 caller_context_t *, int); \ 850 int (*vop_readdir)(vnode_t *, uio_t *, cred_t *, int *, \ 851 caller_context_t *, int); \ 852 int (*vop_symlink)(vnode_t *, char *, vattr_t *, char *, \ 853 cred_t *, caller_context_t *, int); \ 854 int (*vop_readlink)(vnode_t *, uio_t *, cred_t *, \ 855 caller_context_t *); \ 856 int (*vop_fsync)(vnode_t *, int, cred_t *, \ 857 caller_context_t *); \ 858 void (*vop_inactive)(vnode_t *, cred_t *, \ 859 caller_context_t *); \ 860 int (*vop_fid)(vnode_t *, struct fid *, \ 861 caller_context_t *); \ 862 int (*vop_rwlock)(vnode_t *, int, caller_context_t *); \ 863 void (*vop_rwunlock)(vnode_t *, int, caller_context_t *); \ 864 int (*vop_seek)(vnode_t *, offset_t, offset_t *, \ 865 caller_context_t *); \ 866 int (*vop_cmp)(vnode_t *, vnode_t *, caller_context_t *); \ 867 int (*vop_frlock)(vnode_t *, int, struct flock64 *, \ 868 int, offset_t, \ 869 struct flk_callback *, cred_t *, \ 870 caller_context_t *); \ 871 int (*vop_space)(vnode_t *, int, struct flock64 *, \ 872 int, offset_t, \ 873 cred_t *, caller_context_t *); \ 874 int (*vop_realvp)(vnode_t *, vnode_t **, \ 875 caller_context_t *); \ 876 int (*vop_getpage)(vnode_t *, offset_t, size_t, uint_t *, \ 877 struct page **, size_t, struct seg *, \ 878 caddr_t, enum seg_rw, cred_t *, \ 879 caller_context_t *); \ 880 int (*vop_putpage)(vnode_t *, offset_t, size_t, \ 881 int, cred_t *, caller_context_t *); \ 882 int (*vop_map)(vnode_t *, offset_t, struct as *, \ 883 caddr_t *, size_t, \ 884 uchar_t, uchar_t, uint_t, cred_t *, \ 885 caller_context_t *); \ 886 int (*vop_addmap)(vnode_t *, offset_t, struct as *, \ 887 caddr_t, size_t, \ 888 uchar_t, uchar_t, uint_t, cred_t *, \ 889 caller_context_t *); \ 890 int (*vop_delmap)(vnode_t *, offset_t, struct as *, \ 891 caddr_t, size_t, \ 892 uint_t, uint_t, uint_t, cred_t *, \ 893 caller_context_t *); \ 894 int (*vop_poll)(vnode_t *, short, int, short *, \ 895 struct pollhead **, \ 896 caller_context_t *); \ 897 int (*vop_dump)(vnode_t *, caddr_t, offset_t, offset_t, \ 898 caller_context_t *); \ 899 int (*vop_pathconf)(vnode_t *, int, ulong_t *, cred_t *, \ 900 caller_context_t *); \ 901 int (*vop_pageio)(vnode_t *, struct page *, \ 902 u_offset_t, size_t, int, cred_t *, \ 903 caller_context_t *); \ 904 int (*vop_dumpctl)(vnode_t *, int, offset_t *, \ 905 caller_context_t *); \ 906 void (*vop_dispose)(vnode_t *, struct page *, \ 907 int, int, cred_t *, \ 908 caller_context_t *); \ 909 int (*vop_setsecattr)(vnode_t *, vsecattr_t *, \ 910 int, cred_t *, caller_context_t *); \ 911 int (*vop_getsecattr)(vnode_t *, vsecattr_t *, \ 912 int, cred_t *, caller_context_t *); \ 913 int (*vop_shrlock)(vnode_t *, int, struct shrlock *, \ 914 int, cred_t *, caller_context_t *); \ 915 int (*vop_vnevent)(vnode_t *, vnevent_t, vnode_t *, \ 916 char *, caller_context_t *); \ 917 int (*vop_reqzcbuf)(vnode_t *, enum uio_rw, xuio_t *, \ 918 cred_t *, caller_context_t *); \ 919 int (*vop_retzcbuf)(vnode_t *, xuio_t *, cred_t *, \ 920 caller_context_t *) 921 /* NB: No ";" */ 922 923 /* 924 * Operations on vnodes. Note: File systems must never operate directly 925 * on a 'vnodeops' structure -- it WILL change in future releases! They 926 * must use vn_make_ops() to create the structure. 927 */ 928 typedef struct vnodeops { 929 const char *vnop_name; 930 VNODE_OPS; /* Signatures of all vnode operations (vops) */ 931 } vnodeops_t; 932 933 typedef int (*fs_generic_func_p) (); /* Generic vop/vfsop/femop/fsemop ptr */ 934 935 extern int fop_open(vnode_t **, int, cred_t *, caller_context_t *); 936 extern int fop_close(vnode_t *, int, int, offset_t, cred_t *, 937 caller_context_t *); 938 extern int fop_read(vnode_t *, uio_t *, int, cred_t *, caller_context_t *); 939 extern int fop_write(vnode_t *, uio_t *, int, cred_t *, 940 caller_context_t *); 941 extern int fop_ioctl(vnode_t *, int, intptr_t, int, cred_t *, int *, 942 caller_context_t *); 943 extern int fop_setfl(vnode_t *, int, int, cred_t *, caller_context_t *); 944 extern int fop_getattr(vnode_t *, vattr_t *, int, cred_t *, 945 caller_context_t *); 946 extern int fop_setattr(vnode_t *, vattr_t *, int, cred_t *, 947 caller_context_t *); 948 extern int fop_access(vnode_t *, int, int, cred_t *, caller_context_t *); 949 extern int fop_lookup(vnode_t *, char *, vnode_t **, struct pathname *, 950 int, vnode_t *, cred_t *, caller_context_t *, 951 int *, struct pathname *); 952 extern int fop_create(vnode_t *, char *, vattr_t *, vcexcl_t, int, 953 vnode_t **, cred_t *, int, caller_context_t *, 954 vsecattr_t *); 955 extern int fop_remove(vnode_t *vp, char *, cred_t *, caller_context_t *, 956 int); 957 extern int fop_link(vnode_t *, vnode_t *, char *, cred_t *, 958 caller_context_t *, int); 959 extern int fop_rename(vnode_t *, char *, vnode_t *, char *, cred_t *, 960 caller_context_t *, int); 961 extern int fop_mkdir(vnode_t *, char *, vattr_t *, vnode_t **, cred_t *, 962 caller_context_t *, int, vsecattr_t *); 963 extern int fop_rmdir(vnode_t *, char *, vnode_t *, cred_t *, 964 caller_context_t *, int); 965 extern int fop_readdir(vnode_t *, uio_t *, cred_t *, int *, 966 caller_context_t *, int); 967 extern int fop_symlink(vnode_t *, char *, vattr_t *, char *, cred_t *, 968 caller_context_t *, int); 969 extern int fop_readlink(vnode_t *, uio_t *, cred_t *, caller_context_t *); 970 extern int fop_fsync(vnode_t *, int, cred_t *, caller_context_t *); 971 extern void fop_inactive(vnode_t *, cred_t *, caller_context_t *); 972 extern int fop_fid(vnode_t *, struct fid *, caller_context_t *); 973 extern int fop_rwlock(vnode_t *, int, caller_context_t *); 974 extern void fop_rwunlock(vnode_t *, int, caller_context_t *); 975 extern int fop_seek(vnode_t *, offset_t, offset_t *, caller_context_t *); 976 extern int fop_cmp(vnode_t *, vnode_t *, caller_context_t *); 977 extern int fop_frlock(vnode_t *, int, struct flock64 *, int, offset_t, 978 struct flk_callback *, cred_t *, 979 caller_context_t *); 980 extern int fop_space(vnode_t *, int, struct flock64 *, int, offset_t, 981 cred_t *, caller_context_t *); 982 extern int fop_realvp(vnode_t *, vnode_t **, caller_context_t *); 983 extern int fop_getpage(vnode_t *, offset_t, size_t, uint_t *, 984 struct page **, size_t, struct seg *, 985 caddr_t, enum seg_rw, cred_t *, 986 caller_context_t *); 987 extern int fop_putpage(vnode_t *, offset_t, size_t, int, cred_t *, 988 caller_context_t *); 989 extern int fop_map(vnode_t *, offset_t, struct as *, caddr_t *, size_t, 990 uchar_t, uchar_t, uint_t, cred_t *cr, 991 caller_context_t *); 992 extern int fop_addmap(vnode_t *, offset_t, struct as *, caddr_t, size_t, 993 uchar_t, uchar_t, uint_t, cred_t *, 994 caller_context_t *); 995 extern int fop_delmap(vnode_t *, offset_t, struct as *, caddr_t, size_t, 996 uint_t, uint_t, uint_t, cred_t *, 997 caller_context_t *); 998 extern int fop_poll(vnode_t *, short, int, short *, struct pollhead **, 999 caller_context_t *); 1000 extern int fop_dump(vnode_t *, caddr_t, offset_t, offset_t, 1001 caller_context_t *); 1002 extern int fop_pathconf(vnode_t *, int, ulong_t *, cred_t *, 1003 caller_context_t *); 1004 extern int fop_pageio(vnode_t *, struct page *, u_offset_t, size_t, int, 1005 cred_t *, caller_context_t *); 1006 extern int fop_dumpctl(vnode_t *, int, offset_t *, caller_context_t *); 1007 extern void fop_dispose(vnode_t *, struct page *, int, int, cred_t *, 1008 caller_context_t *); 1009 extern int fop_setsecattr(vnode_t *, vsecattr_t *, int, cred_t *, 1010 caller_context_t *); 1011 extern int fop_getsecattr(vnode_t *, vsecattr_t *, int, cred_t *, 1012 caller_context_t *); 1013 extern int fop_shrlock(vnode_t *, int, struct shrlock *, int, cred_t *, 1014 caller_context_t *); 1015 extern int fop_vnevent(vnode_t *, vnevent_t, vnode_t *, char *, 1016 caller_context_t *); 1017 extern int fop_reqzcbuf(vnode_t *, enum uio_rw, xuio_t *, cred_t *, 1018 caller_context_t *); 1019 extern int fop_retzcbuf(vnode_t *, xuio_t *, cred_t *, caller_context_t *); 1020 1021 #endif /* _KERNEL */ 1022 1023 #define VOP_OPEN(vpp, mode, cr, ct) \ 1024 fop_open(vpp, mode, cr, ct) 1025 #define VOP_CLOSE(vp, f, c, o, cr, ct) \ 1026 fop_close(vp, f, c, o, cr, ct) 1027 #define VOP_READ(vp, uiop, iof, cr, ct) \ 1028 fop_read(vp, uiop, iof, cr, ct) 1029 #define VOP_WRITE(vp, uiop, iof, cr, ct) \ 1030 fop_write(vp, uiop, iof, cr, ct) 1031 #define VOP_IOCTL(vp, cmd, a, f, cr, rvp, ct) \ 1032 fop_ioctl(vp, cmd, a, f, cr, rvp, ct) 1033 #define VOP_SETFL(vp, f, a, cr, ct) \ 1034 fop_setfl(vp, f, a, cr, ct) 1035 #define VOP_GETATTR(vp, vap, f, cr, ct) \ 1036 fop_getattr(vp, vap, f, cr, ct) 1037 #define VOP_SETATTR(vp, vap, f, cr, ct) \ 1038 fop_setattr(vp, vap, f, cr, ct) 1039 #define VOP_ACCESS(vp, mode, f, cr, ct) \ 1040 fop_access(vp, mode, f, cr, ct) 1041 #define VOP_LOOKUP(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp) \ 1042 fop_lookup(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp) 1043 #define VOP_CREATE(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap) \ 1044 fop_create(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap) 1045 #define VOP_REMOVE(dvp, p, cr, ct, f) \ 1046 fop_remove(dvp, p, cr, ct, f) 1047 #define VOP_LINK(tdvp, fvp, p, cr, ct, f) \ 1048 fop_link(tdvp, fvp, p, cr, ct, f) 1049 #define VOP_RENAME(fvp, fnm, tdvp, tnm, cr, ct, f) \ 1050 fop_rename(fvp, fnm, tdvp, tnm, cr, ct, f) 1051 #define VOP_MKDIR(dp, p, vap, vpp, cr, ct, f, vsap) \ 1052 fop_mkdir(dp, p, vap, vpp, cr, ct, f, vsap) 1053 #define VOP_RMDIR(dp, p, cdir, cr, ct, f) \ 1054 fop_rmdir(dp, p, cdir, cr, ct, f) 1055 #define VOP_READDIR(vp, uiop, cr, eofp, ct, f) \ 1056 fop_readdir(vp, uiop, cr, eofp, ct, f) 1057 #define VOP_SYMLINK(dvp, lnm, vap, tnm, cr, ct, f) \ 1058 fop_symlink(dvp, lnm, vap, tnm, cr, ct, f) 1059 #define VOP_READLINK(vp, uiop, cr, ct) \ 1060 fop_readlink(vp, uiop, cr, ct) 1061 #define VOP_FSYNC(vp, syncflag, cr, ct) \ 1062 fop_fsync(vp, syncflag, cr, ct) 1063 #define VOP_INACTIVE(vp, cr, ct) \ 1064 fop_inactive(vp, cr, ct) 1065 #define VOP_FID(vp, fidp, ct) \ 1066 fop_fid(vp, fidp, ct) 1067 #define VOP_RWLOCK(vp, w, ct) \ 1068 fop_rwlock(vp, w, ct) 1069 #define VOP_RWUNLOCK(vp, w, ct) \ 1070 fop_rwunlock(vp, w, ct) 1071 #define VOP_SEEK(vp, ooff, noffp, ct) \ 1072 fop_seek(vp, ooff, noffp, ct) 1073 #define VOP_CMP(vp1, vp2, ct) \ 1074 fop_cmp(vp1, vp2, ct) 1075 #define VOP_FRLOCK(vp, cmd, a, f, o, cb, cr, ct) \ 1076 fop_frlock(vp, cmd, a, f, o, cb, cr, ct) 1077 #define VOP_SPACE(vp, cmd, a, f, o, cr, ct) \ 1078 fop_space(vp, cmd, a, f, o, cr, ct) 1079 #define VOP_REALVP(vp1, vp2, ct) \ 1080 fop_realvp(vp1, vp2, ct) 1081 #define VOP_GETPAGE(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct) \ 1082 fop_getpage(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct) 1083 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) \ 1084 fop_putpage(vp, of, sz, fl, cr, ct) 1085 #define VOP_MAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \ 1086 fop_map(vp, of, as, a, sz, p, mp, fl, cr, ct) 1087 #define VOP_ADDMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \ 1088 fop_addmap(vp, of, as, a, sz, p, mp, fl, cr, ct) 1089 #define VOP_DELMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \ 1090 fop_delmap(vp, of, as, a, sz, p, mp, fl, cr, ct) 1091 #define VOP_POLL(vp, events, anyyet, reventsp, phpp, ct) \ 1092 fop_poll(vp, events, anyyet, reventsp, phpp, ct) 1093 #define VOP_DUMP(vp, addr, bn, count, ct) \ 1094 fop_dump(vp, addr, bn, count, ct) 1095 #define VOP_PATHCONF(vp, cmd, valp, cr, ct) \ 1096 fop_pathconf(vp, cmd, valp, cr, ct) 1097 #define VOP_PAGEIO(vp, pp, io_off, io_len, flags, cr, ct) \ 1098 fop_pageio(vp, pp, io_off, io_len, flags, cr, ct) 1099 #define VOP_DUMPCTL(vp, action, blkp, ct) \ 1100 fop_dumpctl(vp, action, blkp, ct) 1101 #define VOP_DISPOSE(vp, pp, flag, dn, cr, ct) \ 1102 fop_dispose(vp, pp, flag, dn, cr, ct) 1103 #define VOP_GETSECATTR(vp, vsap, f, cr, ct) \ 1104 fop_getsecattr(vp, vsap, f, cr, ct) 1105 #define VOP_SETSECATTR(vp, vsap, f, cr, ct) \ 1106 fop_setsecattr(vp, vsap, f, cr, ct) 1107 #define VOP_SHRLOCK(vp, cmd, shr, f, cr, ct) \ 1108 fop_shrlock(vp, cmd, shr, f, cr, ct) 1109 #define VOP_VNEVENT(vp, vnevent, dvp, fnm, ct) \ 1110 fop_vnevent(vp, vnevent, dvp, fnm, ct) 1111 #define VOP_REQZCBUF(vp, rwflag, xuiop, cr, ct) \ 1112 fop_reqzcbuf(vp, rwflag, xuiop, cr, ct) 1113 #define VOP_RETZCBUF(vp, xuiop, cr, ct) \ 1114 fop_retzcbuf(vp, xuiop, cr, ct) 1115 1116 #define VOPNAME_OPEN "open" 1117 #define VOPNAME_CLOSE "close" 1118 #define VOPNAME_READ "read" 1119 #define VOPNAME_WRITE "write" 1120 #define VOPNAME_IOCTL "ioctl" 1121 #define VOPNAME_SETFL "setfl" 1122 #define VOPNAME_GETATTR "getattr" 1123 #define VOPNAME_SETATTR "setattr" 1124 #define VOPNAME_ACCESS "access" 1125 #define VOPNAME_LOOKUP "lookup" 1126 #define VOPNAME_CREATE "create" 1127 #define VOPNAME_REMOVE "remove" 1128 #define VOPNAME_LINK "link" 1129 #define VOPNAME_RENAME "rename" 1130 #define VOPNAME_MKDIR "mkdir" 1131 #define VOPNAME_RMDIR "rmdir" 1132 #define VOPNAME_READDIR "readdir" 1133 #define VOPNAME_SYMLINK "symlink" 1134 #define VOPNAME_READLINK "readlink" 1135 #define VOPNAME_FSYNC "fsync" 1136 #define VOPNAME_INACTIVE "inactive" 1137 #define VOPNAME_FID "fid" 1138 #define VOPNAME_RWLOCK "rwlock" 1139 #define VOPNAME_RWUNLOCK "rwunlock" 1140 #define VOPNAME_SEEK "seek" 1141 #define VOPNAME_CMP "cmp" 1142 #define VOPNAME_FRLOCK "frlock" 1143 #define VOPNAME_SPACE "space" 1144 #define VOPNAME_REALVP "realvp" 1145 #define VOPNAME_GETPAGE "getpage" 1146 #define VOPNAME_PUTPAGE "putpage" 1147 #define VOPNAME_MAP "map" 1148 #define VOPNAME_ADDMAP "addmap" 1149 #define VOPNAME_DELMAP "delmap" 1150 #define VOPNAME_POLL "poll" 1151 #define VOPNAME_DUMP "dump" 1152 #define VOPNAME_PATHCONF "pathconf" 1153 #define VOPNAME_PAGEIO "pageio" 1154 #define VOPNAME_DUMPCTL "dumpctl" 1155 #define VOPNAME_DISPOSE "dispose" 1156 #define VOPNAME_GETSECATTR "getsecattr" 1157 #define VOPNAME_SETSECATTR "setsecattr" 1158 #define VOPNAME_SHRLOCK "shrlock" 1159 #define VOPNAME_VNEVENT "vnevent" 1160 #define VOPNAME_REQZCBUF "reqzcbuf" 1161 #define VOPNAME_RETZCBUF "retzcbuf" 1162 1163 /* 1164 * Flags for VOP_LOOKUP 1165 * 1166 * Defined in file.h, but also possible, FIGNORECASE and FSEARCH 1167 * 1168 */ 1169 #define LOOKUP_DIR 0x01 /* want parent dir vp */ 1170 #define LOOKUP_XATTR 0x02 /* lookup up extended attr dir */ 1171 #define CREATE_XATTR_DIR 0x04 /* Create extended attr dir */ 1172 #define LOOKUP_HAVE_SYSATTR_DIR 0x08 /* Already created virtual GFS dir */ 1173 1174 /* 1175 * Flags for VOP_READDIR 1176 */ 1177 #define V_RDDIR_ENTFLAGS 0x01 /* request dirent flags */ 1178 #define V_RDDIR_ACCFILTER 0x02 /* filter out inaccessible dirents */ 1179 1180 /* 1181 * Flags for VOP_RWLOCK/VOP_RWUNLOCK 1182 * VOP_RWLOCK will return the flag that was actually set, or -1 if none. 1183 */ 1184 #define V_WRITELOCK_TRUE (1) /* Request write-lock on the vnode */ 1185 #define V_WRITELOCK_FALSE (0) /* Request read-lock on the vnode */ 1186 1187 /* 1188 * Flags for VOP_DUMPCTL 1189 */ 1190 #define DUMP_ALLOC 0 1191 #define DUMP_FREE 1 1192 #define DUMP_SCAN 2 1193 1194 /* 1195 * Public vnode manipulation functions. 1196 */ 1197 #ifdef _KERNEL 1198 1199 vnode_t *vn_alloc(int); 1200 void vn_reinit(vnode_t *); 1201 void vn_recycle(vnode_t *); 1202 void vn_free(vnode_t *); 1203 1204 int vn_is_readonly(vnode_t *); 1205 int vn_is_opened(vnode_t *, v_mode_t); 1206 int vn_is_mapped(vnode_t *, v_mode_t); 1207 int vn_has_other_opens(vnode_t *, v_mode_t); 1208 void vn_open_upgrade(vnode_t *, int); 1209 void vn_open_downgrade(vnode_t *, int); 1210 1211 int vn_can_change_zones(vnode_t *vp); 1212 1213 int vn_has_flocks(vnode_t *); 1214 int vn_has_mandatory_locks(vnode_t *, int); 1215 int vn_has_cached_data(vnode_t *); 1216 1217 void vn_setops(vnode_t *, vnodeops_t *); 1218 vnodeops_t *vn_getops(vnode_t *); 1219 int vn_matchops(vnode_t *, vnodeops_t *); 1220 int vn_matchopval(vnode_t *, char *, fs_generic_func_p); 1221 int vn_ismntpt(vnode_t *); 1222 1223 struct vfs *vn_mountedvfs(vnode_t *); 1224 1225 int vn_in_dnlc(vnode_t *); 1226 1227 void vn_create_cache(void); 1228 void vn_destroy_cache(void); 1229 1230 void vn_freevnodeops(vnodeops_t *); 1231 1232 int vn_open(char *pnamep, enum uio_seg seg, int filemode, int createmode, 1233 struct vnode **vpp, enum create crwhy, mode_t umask); 1234 int vn_openat(char *pnamep, enum uio_seg seg, int filemode, int createmode, 1235 struct vnode **vpp, enum create crwhy, 1236 mode_t umask, struct vnode *startvp, int fd); 1237 int vn_create(char *pnamep, enum uio_seg seg, struct vattr *vap, 1238 enum vcexcl excl, int mode, struct vnode **vpp, 1239 enum create why, int flag, mode_t umask); 1240 int vn_createat(char *pnamep, enum uio_seg seg, struct vattr *vap, 1241 enum vcexcl excl, int mode, struct vnode **vpp, 1242 enum create why, int flag, mode_t umask, struct vnode *startvp); 1243 int vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base, ssize_t len, 1244 offset_t offset, enum uio_seg seg, int ioflag, rlim64_t ulimit, 1245 cred_t *cr, ssize_t *residp); 1246 void vn_rele(struct vnode *vp); 1247 void vn_rele_async(struct vnode *vp, struct taskq *taskq); 1248 void vn_rele_dnlc(struct vnode *vp); 1249 void vn_rele_stream(struct vnode *vp); 1250 int vn_link(char *from, char *to, enum uio_seg seg); 1251 int vn_linkat(vnode_t *fstartvp, char *from, enum symfollow follow, 1252 vnode_t *tstartvp, char *to, enum uio_seg seg); 1253 int vn_rename(char *from, char *to, enum uio_seg seg); 1254 int vn_renameat(vnode_t *fdvp, char *fname, vnode_t *tdvp, char *tname, 1255 enum uio_seg seg); 1256 int vn_remove(char *fnamep, enum uio_seg seg, enum rm dirflag); 1257 int vn_removeat(vnode_t *startvp, char *fnamep, enum uio_seg seg, 1258 enum rm dirflag); 1259 int vn_compare(vnode_t *vp1, vnode_t *vp2); 1260 int vn_vfswlock(struct vnode *vp); 1261 int vn_vfswlock_wait(struct vnode *vp); 1262 int vn_vfsrlock(struct vnode *vp); 1263 int vn_vfsrlock_wait(struct vnode *vp); 1264 void vn_vfsunlock(struct vnode *vp); 1265 int vn_vfswlock_held(struct vnode *vp); 1266 vnode_t *specvp(struct vnode *vp, dev_t dev, vtype_t type, struct cred *cr); 1267 vnode_t *makespecvp(dev_t dev, vtype_t type); 1268 vn_vfslocks_entry_t *vn_vfslocks_getlock(void *); 1269 void vn_vfslocks_rele(vn_vfslocks_entry_t *); 1270 boolean_t vn_is_reparse(vnode_t *, cred_t *, caller_context_t *); 1271 1272 void vn_copypath(struct vnode *src, struct vnode *dst); 1273 void vn_setpath_str(struct vnode *vp, const char *str, size_t len); 1274 void vn_setpath(vnode_t *rootvp, struct vnode *startvp, struct vnode *vp, 1275 const char *path, size_t plen); 1276 void vn_renamepath(vnode_t *dvp, vnode_t *vp, const char *nm, size_t len); 1277 1278 /* Vnode event notification */ 1279 void vnevent_rename_src(vnode_t *, vnode_t *, char *, caller_context_t *); 1280 void vnevent_rename_dest(vnode_t *, vnode_t *, char *, caller_context_t *); 1281 void vnevent_remove(vnode_t *, vnode_t *, char *, caller_context_t *); 1282 void vnevent_rmdir(vnode_t *, vnode_t *, char *, caller_context_t *); 1283 void vnevent_create(vnode_t *, caller_context_t *); 1284 void vnevent_link(vnode_t *, caller_context_t *); 1285 void vnevent_rename_dest_dir(vnode_t *, caller_context_t *ct); 1286 void vnevent_mountedover(vnode_t *, caller_context_t *); 1287 int vnevent_support(vnode_t *, caller_context_t *); 1288 1289 /* Vnode specific data */ 1290 void vsd_create(uint_t *, void (*)(void *)); 1291 void vsd_destroy(uint_t *); 1292 void *vsd_get(vnode_t *, uint_t); 1293 int vsd_set(vnode_t *, uint_t, void *); 1294 void vsd_free(vnode_t *); 1295 1296 /* 1297 * Extensible vnode attribute (xva) routines: 1298 * xva_init() initializes an xvattr_t (zero struct, init mapsize, set AT_XATTR) 1299 * xva_getxoptattr() returns a ponter to the xoptattr_t section of xvattr_t 1300 */ 1301 void xva_init(xvattr_t *); 1302 xoptattr_t *xva_getxoptattr(xvattr_t *); /* Get ptr to xoptattr_t */ 1303 1304 void xattr_init(void); /* Initialize vnodeops for xattrs */ 1305 1306 /* GFS tunnel for xattrs */ 1307 int xattr_dir_lookup(vnode_t *, vnode_t **, int, cred_t *); 1308 1309 /* Reparse Point */ 1310 void reparse_point_init(void); 1311 1312 /* Context identification */ 1313 u_longlong_t fs_new_caller_id(); 1314 1315 int vn_vmpss_usepageio(vnode_t *); 1316 1317 /* 1318 * Needed for use of IS_VMODSORT() in kernel. 1319 */ 1320 extern uint_t pvn_vmodsort_supported; 1321 1322 #define VN_HOLD(vp) { \ 1323 mutex_enter(&(vp)->v_lock); \ 1324 (vp)->v_count++; \ 1325 mutex_exit(&(vp)->v_lock); \ 1326 } 1327 1328 #define VN_RELE(vp) { \ 1329 vn_rele(vp); \ 1330 } 1331 1332 #define VN_RELE_ASYNC(vp, taskq) { \ 1333 vn_rele_async(vp, taskq); \ 1334 } 1335 1336 #define VN_SET_VFS_TYPE_DEV(vp, vfsp, type, dev) { \ 1337 (vp)->v_vfsp = (vfsp); \ 1338 (vp)->v_type = (type); \ 1339 (vp)->v_rdev = (dev); \ 1340 } 1341 1342 /* 1343 * Compare two vnodes for equality. In general this macro should be used 1344 * in preference to calling VOP_CMP directly. 1345 */ 1346 #define VN_CMP(VP1, VP2) ((VP1) == (VP2) ? 1 : \ 1347 ((VP1) && (VP2) && (vn_getops(VP1) == vn_getops(VP2)) ? \ 1348 VOP_CMP(VP1, VP2, NULL) : 0)) 1349 1350 /* 1351 * Some well-known global vnodes used by the VM system to name pages. 1352 */ 1353 extern struct vnode kvps[]; 1354 1355 typedef enum { 1356 KV_KVP, /* vnode for all segkmem pages */ 1357 KV_ZVP, /* vnode for all ZFS pages */ 1358 #if defined(__sparc) 1359 KV_MPVP, /* vnode for all page_t meta-pages */ 1360 KV_PROMVP, /* vnode for all PROM pages */ 1361 #endif /* __sparc */ 1362 KV_MAX /* total number of vnodes in kvps[] */ 1363 } kvps_index_t; 1364 1365 #define VN_ISKAS(vp) ((vp) >= &kvps[0] && (vp) < &kvps[KV_MAX]) 1366 1367 #endif /* _KERNEL */ 1368 1369 /* 1370 * Flags to VOP_SETATTR/VOP_GETATTR. 1371 */ 1372 #define ATTR_UTIME 0x01 /* non-default utime(2) request */ 1373 #define ATTR_EXEC 0x02 /* invocation from exec(2) */ 1374 #define ATTR_COMM 0x04 /* yield common vp attributes */ 1375 #define ATTR_HINT 0x08 /* information returned will be `hint' */ 1376 #define ATTR_REAL 0x10 /* yield attributes of the real vp */ 1377 #define ATTR_NOACLCHECK 0x20 /* Don't check ACL when checking permissions */ 1378 #define ATTR_TRIGGER 0x40 /* Mount first if vnode is a trigger mount */ 1379 /* 1380 * Generally useful macros. 1381 */ 1382 #define VBSIZE(vp) ((vp)->v_vfsp->vfs_bsize) 1383 1384 #define VTOZONE(vp) ((vp)->v_vfsp->vfs_zone) 1385 1386 #define NULLVP ((struct vnode *)0) 1387 #define NULLVPP ((struct vnode **)0) 1388 1389 #ifdef _KERNEL 1390 1391 /* 1392 * Structure used while handling asynchronous VOP_PUTPAGE operations. 1393 */ 1394 struct async_reqs { 1395 struct async_reqs *a_next; /* pointer to next arg struct */ 1396 struct vnode *a_vp; /* vnode pointer */ 1397 u_offset_t a_off; /* offset in file */ 1398 uint_t a_len; /* size of i/o request */ 1399 int a_flags; /* flags to indicate operation type */ 1400 struct cred *a_cred; /* cred pointer */ 1401 ushort_t a_prealloced; /* set if struct is pre-allocated */ 1402 }; 1403 1404 /* 1405 * VN_DISPOSE() -- given a page pointer, safely invoke VOP_DISPOSE(). 1406 * Note that there is no guarantee that the page passed in will be 1407 * freed. If that is required, then a check after calling VN_DISPOSE would 1408 * be necessary to ensure the page was freed. 1409 */ 1410 #define VN_DISPOSE(pp, flag, dn, cr) { \ 1411 if ((pp)->p_vnode != NULL && !VN_ISKAS((pp)->p_vnode)) \ 1412 VOP_DISPOSE((pp)->p_vnode, (pp), (flag), (dn), (cr), NULL); \ 1413 else if ((flag) == B_FREE) \ 1414 page_free((pp), (dn)); \ 1415 else \ 1416 page_destroy((pp), (dn)); \ 1417 } 1418 1419 #endif /* _KERNEL */ 1420 1421 #ifdef __cplusplus 1422 } 1423 #endif 1424 1425 #endif /* _SYS_VNODE_H */ 1426