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