?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
1948 zpool list should show more detailed pool information
[unleashed.git] / usr / src / uts / common / sys / vnode.h
blobd29152346e2ca201dc8bc2c4172b96860223f10f
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 uint8_t xoa_offline;
403 uint8_t xoa_sparse;
404 } xoptattr_t;
405
406 /*
407 * The xvattr structure is really a variable length structure that
408 * is made up of:
409 * - The classic vattr_t (xva_vattr)
410 * - a 32 bit quantity (xva_mapsize) that specifies the size of the
411 * attribute bitmaps in 32 bit words.
412 * - A pointer to the returned attribute bitmap (needed because the
413 * previous element, the requested attribute bitmap) is variable lenth.
414 * - The requested attribute bitmap, which is an array of 32 bit words.
415 * Callers use the XVA_SET_REQ() macro to set the bits corresponding to
416 * the attributes that are being requested.
417 * - The returned attribute bitmap, which is an array of 32 bit words.
418 * File systems that support optional attributes use the XVA_SET_RTN()
419 * macro to set the bits corresponding to the attributes that are being
420 * returned.
421 * - The xoptattr_t structure which contains the attribute values
422 *
423 * xva_mapsize determines how many words in the attribute bitmaps.
424 * Immediately following the attribute bitmaps is the xoptattr_t.
425 * xva_getxoptattr() is used to get the pointer to the xoptattr_t
426 * section.
427 */
428
429 #define XVA_MAPSIZE 3 /* Size of attr bitmaps */
430 #define XVA_MAGIC 0x78766174 /* Magic # for verification */
431
432 /*
433 * The xvattr structure is an extensible structure which permits optional
434 * attributes to be requested/returned. File systems may or may not support
435 * optional attributes. They do so at their own discretion but if they do
436 * support optional attributes, they must register the VFSFT_XVATTR feature
437 * so that the optional attributes can be set/retrived.
438 *
439 * The fields of the xvattr structure are:
440 *
441 * xva_vattr - The first element of an xvattr is a legacy vattr structure
442 * which includes the common attributes. If AT_XVATTR is set in the va_mask
443 * then the entire structure is treated as an xvattr. If AT_XVATTR is not
444 * set, then only the xva_vattr structure can be used.
445 *
446 * xva_magic - 0x78766174 (hex for "xvat"). Magic number for verification.
447 *
448 * xva_mapsize - Size of requested and returned attribute bitmaps.
449 *
450 * xva_rtnattrmapp - Pointer to xva_rtnattrmap[]. We need this since the
451 * size of the array before it, xva_reqattrmap[], could change which means
452 * the location of xva_rtnattrmap[] could change. This will allow unbundled
453 * file systems to find the location of xva_rtnattrmap[] when the sizes change.
454 *
455 * xva_reqattrmap[] - Array of requested attributes. Attributes are
456 * represented by a specific bit in a specific element of the attribute
457 * map array. Callers set the bits corresponding to the attributes
458 * that the caller wants to get/set.
459 *
460 * xva_rtnattrmap[] - Array of attributes that the file system was able to
461 * process. Not all file systems support all optional attributes. This map
462 * informs the caller which attributes the underlying file system was able
463 * to set/get. (Same structure as the requested attributes array in terms
464 * of each attribute corresponding to specific bits and array elements.)
465 *
466 * xva_xoptattrs - Structure containing values of optional attributes.
467 * These values are only valid if the corresponding bits in xva_reqattrmap
468 * are set and the underlying file system supports those attributes.
469 */
470 typedef struct xvattr {
471 vattr_t xva_vattr; /* Embedded vattr structure */
472 uint32_t xva_magic; /* Magic Number */
473 uint32_t xva_mapsize; /* Size of attr bitmap (32-bit words) */
474 uint32_t *xva_rtnattrmapp; /* Ptr to xva_rtnattrmap[] */
475 uint32_t xva_reqattrmap[XVA_MAPSIZE]; /* Requested attrs */
476 uint32_t xva_rtnattrmap[XVA_MAPSIZE]; /* Returned attrs */
477 xoptattr_t xva_xoptattrs; /* Optional attributes */
478 } xvattr_t;
479
480 #ifdef _SYSCALL32
481 /*
482 * For bigtypes time_t changed to 64 bit on the 64-bit kernel.
483 * Define an old version for user/kernel interface
484 */
485
486 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
487 #pragma pack(4)
488 #endif
489
490 typedef struct vattr32 {
491 uint32_t va_mask; /* bit-mask of attributes */
492 vtype_t va_type; /* vnode type (for create) */
493 mode32_t va_mode; /* file access mode */
494 uid32_t va_uid; /* owner user id */
495 gid32_t va_gid; /* owner group id */
496 dev32_t va_fsid; /* file system id (dev for now) */
497 u_longlong_t va_nodeid; /* node id */
498 nlink_t va_nlink; /* number of references to file */
499 u_offset_t va_size; /* file size in bytes */
500 timestruc32_t va_atime; /* time of last access */
501 timestruc32_t va_mtime; /* time of last modification */
502 timestruc32_t va_ctime; /* time of last status change */
503 dev32_t va_rdev; /* device the file represents */
504 uint32_t va_blksize; /* fundamental block size */
505 u_longlong_t va_nblocks; /* # of blocks allocated */
506 uint32_t va_seq; /* sequence number */
507 } vattr32_t;
508
509 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
510 #pragma pack()
511 #endif
512
513 #else /* not _SYSCALL32 */
514 #define vattr32 vattr
515 typedef vattr_t vattr32_t;
516 #endif /* _SYSCALL32 */
517
518 /*
519 * Attributes of interest to the caller of setattr or getattr.
520 */
521 #define AT_TYPE 0x00001
522 #define AT_MODE 0x00002
523 #define AT_UID 0x00004
524 #define AT_GID 0x00008
525 #define AT_FSID 0x00010
526 #define AT_NODEID 0x00020
527 #define AT_NLINK 0x00040
528 #define AT_SIZE 0x00080
529 #define AT_ATIME 0x00100
530 #define AT_MTIME 0x00200
531 #define AT_CTIME 0x00400
532 #define AT_RDEV 0x00800
533 #define AT_BLKSIZE 0x01000
534 #define AT_NBLOCKS 0x02000
535 /* 0x04000 */ /* unused */
536 #define AT_SEQ 0x08000
537 /*
538 * If AT_XVATTR is set then there are additional bits to process in
539 * the xvattr_t's attribute bitmap. If this is not set then the bitmap
540 * MUST be ignored. Note that this bit must be set/cleared explicitly.
541 * That is, setting AT_ALL will NOT set AT_XVATTR.
542 */
543 #define AT_XVATTR 0x10000
544
545 #define AT_ALL (AT_TYPE|AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\
546 AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\
547 AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
548
549 #define AT_STAT (AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\
550 AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV|AT_TYPE)
551
552 #define AT_TIMES (AT_ATIME|AT_MTIME|AT_CTIME)
553
554 #define AT_NOSET (AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|AT_TYPE|\
555 AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
556
557 /*
558 * Attribute bits used in the extensible attribute's (xva's) attribute
559 * bitmaps. Note that the bitmaps are made up of a variable length number
560 * of 32-bit words. The convention is to use XAT{n}_{attrname} where "n"
561 * is the element in the bitmap (starting at 1). This convention is for
562 * the convenience of the maintainer to keep track of which element each
563 * attribute belongs to.
564 *
565 * NOTE THAT CONSUMERS MUST *NOT* USE THE XATn_* DEFINES DIRECTLY. CONSUMERS
566 * MUST USE THE XAT_* DEFINES.
567 */
568 #define XAT0_INDEX 0LL /* Index into bitmap for XAT0 attrs */
569 #define XAT0_CREATETIME 0x00000001 /* Create time of file */
570 #define XAT0_ARCHIVE 0x00000002 /* Archive */
571 #define XAT0_SYSTEM 0x00000004 /* System */
572 #define XAT0_READONLY 0x00000008 /* Readonly */
573 #define XAT0_HIDDEN 0x00000010 /* Hidden */
574 #define XAT0_NOUNLINK 0x00000020 /* Nounlink */
575 #define XAT0_IMMUTABLE 0x00000040 /* immutable */
576 #define XAT0_APPENDONLY 0x00000080 /* appendonly */
577 #define XAT0_NODUMP 0x00000100 /* nodump */
578 #define XAT0_OPAQUE 0x00000200 /* opaque */
579 #define XAT0_AV_QUARANTINED 0x00000400 /* anti-virus quarantine */
580 #define XAT0_AV_MODIFIED 0x00000800 /* anti-virus modified */
581 #define XAT0_AV_SCANSTAMP 0x00001000 /* anti-virus scanstamp */
582 #define XAT0_REPARSE 0x00002000 /* FS reparse point */
583 #define XAT0_GEN 0x00004000 /* object generation number */
584 #define XAT0_OFFLINE 0x00008000 /* offline */
585 #define XAT0_SPARSE 0x00010000 /* sparse */
586
587 #define XAT0_ALL_ATTRS (XAT0_CREATETIME|XAT0_ARCHIVE|XAT0_SYSTEM| \
588 XAT0_READONLY|XAT0_HIDDEN|XAT0_NOUNLINK|XAT0_IMMUTABLE|XAT0_APPENDONLY| \
589 XAT0_NODUMP|XAT0_OPAQUE|XAT0_AV_QUARANTINED| XAT0_AV_MODIFIED| \
590 XAT0_AV_SCANSTAMP|XAT0_REPARSE|XATO_GEN|XAT0_OFFLINE|XAT0_SPARSE)
591
592 /* Support for XAT_* optional attributes */
593 #define XVA_MASK 0xffffffff /* Used to mask off 32 bits */
594 #define XVA_SHFT 32 /* Used to shift index */
595
596 /*
597 * Used to pry out the index and attribute bits from the XAT_* attributes
598 * defined below. Note that we're masking things down to 32 bits then
599 * casting to uint32_t.
600 */
601 #define XVA_INDEX(attr) ((uint32_t)(((attr) >> XVA_SHFT) & XVA_MASK))
602 #define XVA_ATTRBIT(attr) ((uint32_t)((attr) & XVA_MASK))
603
604 /*
605 * The following defines present a "flat namespace" so that consumers don't
606 * need to keep track of which element belongs to which bitmap entry.
607 *
608 * NOTE THAT THESE MUST NEVER BE OR-ed TOGETHER
609 */
610 #define XAT_CREATETIME ((XAT0_INDEX << XVA_SHFT) | XAT0_CREATETIME)
611 #define XAT_ARCHIVE ((XAT0_INDEX << XVA_SHFT) | XAT0_ARCHIVE)
612 #define XAT_SYSTEM ((XAT0_INDEX << XVA_SHFT) | XAT0_SYSTEM)
613 #define XAT_READONLY ((XAT0_INDEX << XVA_SHFT) | XAT0_READONLY)
614 #define XAT_HIDDEN ((XAT0_INDEX << XVA_SHFT) | XAT0_HIDDEN)
615 #define XAT_NOUNLINK ((XAT0_INDEX << XVA_SHFT) | XAT0_NOUNLINK)
616 #define XAT_IMMUTABLE ((XAT0_INDEX << XVA_SHFT) | XAT0_IMMUTABLE)
617 #define XAT_APPENDONLY ((XAT0_INDEX << XVA_SHFT) | XAT0_APPENDONLY)
618 #define XAT_NODUMP ((XAT0_INDEX << XVA_SHFT) | XAT0_NODUMP)
619 #define XAT_OPAQUE ((XAT0_INDEX << XVA_SHFT) | XAT0_OPAQUE)
620 #define XAT_AV_QUARANTINED ((XAT0_INDEX << XVA_SHFT) | XAT0_AV_QUARANTINED)
621 #define XAT_AV_MODIFIED ((XAT0_INDEX << XVA_SHFT) | XAT0_AV_MODIFIED)
622 #define XAT_AV_SCANSTAMP ((XAT0_INDEX << XVA_SHFT) | XAT0_AV_SCANSTAMP)
623 #define XAT_REPARSE ((XAT0_INDEX << XVA_SHFT) | XAT0_REPARSE)
624 #define XAT_GEN ((XAT0_INDEX << XVA_SHFT) | XAT0_GEN)
625 #define XAT_OFFLINE ((XAT0_INDEX << XVA_SHFT) | XAT0_OFFLINE)
626 #define XAT_SPARSE ((XAT0_INDEX << XVA_SHFT) | XAT0_SPARSE)
627
628 /*
629 * The returned attribute map array (xva_rtnattrmap[]) is located past the
630 * requested attribute map array (xva_reqattrmap[]). Its location changes
631 * when the array sizes change. We use a separate pointer in a known location
632 * (xva_rtnattrmapp) to hold the location of xva_rtnattrmap[]. This is
633 * set in xva_init()
634 */
635 #define XVA_RTNATTRMAP(xvap) ((xvap)->xva_rtnattrmapp)
636
637 /*
638 * XVA_SET_REQ() sets an attribute bit in the proper element in the bitmap
639 * of requested attributes (xva_reqattrmap[]).
640 */
641 #define XVA_SET_REQ(xvap, attr) \
642 ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR); \
643 ASSERT((xvap)->xva_magic == XVA_MAGIC); \
644 (xvap)->xva_reqattrmap[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
645 /*
646 * XVA_CLR_REQ() clears an attribute bit in the proper element in the bitmap
647 * of requested attributes (xva_reqattrmap[]).
648 */
649 #define XVA_CLR_REQ(xvap, attr) \
650 ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR); \
651 ASSERT((xvap)->xva_magic == XVA_MAGIC); \
652 (xvap)->xva_reqattrmap[XVA_INDEX(attr)] &= ~XVA_ATTRBIT(attr)
653
654 /*
655 * XVA_SET_RTN() sets an attribute bit in the proper element in the bitmap
656 * of returned attributes (xva_rtnattrmap[]).
657 */
658 #define XVA_SET_RTN(xvap, attr) \
659 ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR); \
660 ASSERT((xvap)->xva_magic == XVA_MAGIC); \
661 (XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
662
663 /*
664 * XVA_ISSET_REQ() checks the requested attribute bitmap (xva_reqattrmap[])
665 * to see of the corresponding attribute bit is set. If so, returns non-zero.
666 */
667 #define XVA_ISSET_REQ(xvap, attr) \
668 ((((xvap)->xva_vattr.va_mask | AT_XVATTR) && \
669 ((xvap)->xva_magic == XVA_MAGIC) && \
670 ((xvap)->xva_mapsize > XVA_INDEX(attr))) ? \
671 ((xvap)->xva_reqattrmap[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) : 0)
672
673 /*
674 * XVA_ISSET_RTN() checks the returned attribute bitmap (xva_rtnattrmap[])
675 * to see of the corresponding attribute bit is set. If so, returns non-zero.
676 */
677 #define XVA_ISSET_RTN(xvap, attr) \
678 ((((xvap)->xva_vattr.va_mask | AT_XVATTR) && \
679 ((xvap)->xva_magic == XVA_MAGIC) && \
680 ((xvap)->xva_mapsize > XVA_INDEX(attr))) ? \
681 ((XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) : 0)
682
683 /*
684 * Modes. Some values same as S_xxx entries from stat.h for convenience.
685 */
686 #define VSUID 04000 /* set user id on execution */
687 #define VSGID 02000 /* set group id on execution */
688 #define VSVTX 01000 /* save swapped text even after use */
689
690 /*
691 * Permissions.
692 */
693 #define VREAD 00400
694 #define VWRITE 00200
695 #define VEXEC 00100
696
697 #define MODEMASK 07777 /* mode bits plus permission bits */
698 #define PERMMASK 00777 /* permission bits */
699
700 /*
701 * VOP_ACCESS flags
702 */
703 #define V_ACE_MASK 0x1 /* mask represents NFSv4 ACE permissions */
704 #define V_APPEND 0x2 /* want to do append only check */
705
706 /*
707 * Check whether mandatory file locking is enabled.
708 */
709
710 #define MANDMODE(mode) (((mode) & (VSGID|(VEXEC>>3))) == VSGID)
711 #define MANDLOCK(vp, mode) ((vp)->v_type == VREG && MANDMODE(mode))
712
713 /*
714 * Flags for vnode operations.
715 */
716 enum rm { RMFILE, RMDIRECTORY }; /* rm or rmdir (remove) */
717 enum symfollow { NO_FOLLOW, FOLLOW }; /* follow symlinks (or not) */
718 enum vcexcl { NONEXCL, EXCL }; /* (non)excl create */
719 enum create { CRCREAT, CRMKNOD, CRMKDIR }; /* reason for create */
720
721 typedef enum rm rm_t;
722 typedef enum symfollow symfollow_t;
723 typedef enum vcexcl vcexcl_t;
724 typedef enum create create_t;
725
726 /* Vnode Events - Used by VOP_VNEVENT */
727 typedef enum vnevent {
728 VE_SUPPORT = 0, /* Query */
729 VE_RENAME_SRC = 1, /* Rename, with vnode as source */
730 VE_RENAME_DEST = 2, /* Rename, with vnode as target/destination */
731 VE_REMOVE = 3, /* Remove of vnode's name */
732 VE_RMDIR = 4, /* Remove of directory vnode's name */
733 VE_CREATE = 5, /* Create with vnode's name which exists */
734 VE_LINK = 6, /* Link with vnode's name as source */
735 VE_RENAME_DEST_DIR = 7, /* Rename with vnode as target dir */
736 VE_MOUNTEDOVER = 8 /* File or Filesystem got mounted over vnode */
737 } vnevent_t;
738
739 /*
740 * Values for checking vnode open and map counts
741 */
742 enum v_mode { V_READ, V_WRITE, V_RDORWR, V_RDANDWR };
743
744 typedef enum v_mode v_mode_t;
745
746 #define V_TRUE 1
747 #define V_FALSE 0
748
749 /*
750 * Structure used on VOP_GETSECATTR and VOP_SETSECATTR operations
751 */
752
753 typedef struct vsecattr {
754 uint_t vsa_mask; /* See below */
755 int vsa_aclcnt; /* ACL entry count */
756 void *vsa_aclentp; /* pointer to ACL entries */
757 int vsa_dfaclcnt; /* default ACL entry count */
758 void *vsa_dfaclentp; /* pointer to default ACL entries */
759 size_t vsa_aclentsz; /* ACE size in bytes of vsa_aclentp */
760 uint_t vsa_aclflags; /* ACE ACL flags */
761 } vsecattr_t;
762
763 /* vsa_mask values */
764 #define VSA_ACL 0x0001
765 #define VSA_ACLCNT 0x0002
766 #define VSA_DFACL 0x0004
767 #define VSA_DFACLCNT 0x0008
768 #define VSA_ACE 0x0010
769 #define VSA_ACECNT 0x0020
770 #define VSA_ACE_ALLTYPES 0x0040
771 #define VSA_ACE_ACLFLAGS 0x0080 /* get/set ACE ACL flags */
772
773 /*
774 * Structure used by various vnode operations to determine
775 * the context (pid, host, identity) of a caller.
776 *
777 * The cc_caller_id is used to identify one or more callers who invoke
778 * operations, possibly on behalf of others. For example, the NFS
779 * server could have it's own cc_caller_id which can be detected by
780 * vnode/vfs operations or (FEM) monitors on those operations. New
781 * caller IDs are generated by fs_new_caller_id().
782 */
783 typedef struct caller_context {
784 pid_t cc_pid; /* Process ID of the caller */
785 int cc_sysid; /* System ID, used for remote calls */
786 u_longlong_t cc_caller_id; /* Identifier for (set of) caller(s) */
787 ulong_t cc_flags;
788 } caller_context_t;
789
790 /*
791 * Flags for caller context. The caller sets CC_DONTBLOCK if it does not
792 * want to block inside of a FEM monitor. The monitor will set CC_WOULDBLOCK
793 * and return EAGAIN if the operation would have blocked.
794 */
795 #define CC_WOULDBLOCK 0x01
796 #define CC_DONTBLOCK 0x02
797
798 /*
799 * Structure tags for function prototypes, defined elsewhere.
800 */
801 struct pathname;
802 struct fid;
803 struct flock64;
804 struct flk_callback;
805 struct shrlock;
806 struct page;
807 struct seg;
808 struct as;
809 struct pollhead;
810 struct taskq;
811
812 #ifdef _KERNEL
813
814 /*
815 * VNODE_OPS defines all the vnode operations. It is used to define
816 * the vnodeops structure (below) and the fs_func_p union (vfs_opreg.h).
817 */
818 #define VNODE_OPS \
819 int (*vop_open)(vnode_t **, int, cred_t *, \
820 caller_context_t *); \
821 int (*vop_close)(vnode_t *, int, int, offset_t, cred_t *, \
822 caller_context_t *); \
823 int (*vop_read)(vnode_t *, uio_t *, int, cred_t *, \
824 caller_context_t *); \
825 int (*vop_write)(vnode_t *, uio_t *, int, cred_t *, \
826 caller_context_t *); \
827 int (*vop_ioctl)(vnode_t *, int, intptr_t, int, cred_t *, \
828 int *, caller_context_t *); \
829 int (*vop_setfl)(vnode_t *, int, int, cred_t *, \
830 caller_context_t *); \
831 int (*vop_getattr)(vnode_t *, vattr_t *, int, cred_t *, \
832 caller_context_t *); \
833 int (*vop_setattr)(vnode_t *, vattr_t *, int, cred_t *, \
834 caller_context_t *); \
835 int (*vop_access)(vnode_t *, int, int, cred_t *, \
836 caller_context_t *); \
837 int (*vop_lookup)(vnode_t *, char *, vnode_t **, \
838 struct pathname *, \
839 int, vnode_t *, cred_t *, \
840 caller_context_t *, int *, \
841 struct pathname *); \
842 int (*vop_create)(vnode_t *, char *, vattr_t *, vcexcl_t, \
843 int, vnode_t **, cred_t *, int, \
844 caller_context_t *, vsecattr_t *); \
845 int (*vop_remove)(vnode_t *, char *, cred_t *, \
846 caller_context_t *, int); \
847 int (*vop_link)(vnode_t *, vnode_t *, char *, cred_t *, \
848 caller_context_t *, int); \
849 int (*vop_rename)(vnode_t *, char *, vnode_t *, char *, \
850 cred_t *, caller_context_t *, int); \
851 int (*vop_mkdir)(vnode_t *, char *, vattr_t *, vnode_t **, \
852 cred_t *, caller_context_t *, int, \
853 vsecattr_t *); \
854 int (*vop_rmdir)(vnode_t *, char *, vnode_t *, cred_t *, \
855 caller_context_t *, int); \
856 int (*vop_readdir)(vnode_t *, uio_t *, cred_t *, int *, \
857 caller_context_t *, int); \
858 int (*vop_symlink)(vnode_t *, char *, vattr_t *, char *, \
859 cred_t *, caller_context_t *, int); \
860 int (*vop_readlink)(vnode_t *, uio_t *, cred_t *, \
861 caller_context_t *); \
862 int (*vop_fsync)(vnode_t *, int, cred_t *, \
863 caller_context_t *); \
864 void (*vop_inactive)(vnode_t *, cred_t *, \
865 caller_context_t *); \
866 int (*vop_fid)(vnode_t *, struct fid *, \
867 caller_context_t *); \
868 int (*vop_rwlock)(vnode_t *, int, caller_context_t *); \
869 void (*vop_rwunlock)(vnode_t *, int, caller_context_t *); \
870 int (*vop_seek)(vnode_t *, offset_t, offset_t *, \
871 caller_context_t *); \
872 int (*vop_cmp)(vnode_t *, vnode_t *, caller_context_t *); \
873 int (*vop_frlock)(vnode_t *, int, struct flock64 *, \
874 int, offset_t, \
875 struct flk_callback *, cred_t *, \
876 caller_context_t *); \
877 int (*vop_space)(vnode_t *, int, struct flock64 *, \
878 int, offset_t, \
879 cred_t *, caller_context_t *); \
880 int (*vop_realvp)(vnode_t *, vnode_t **, \
881 caller_context_t *); \
882 int (*vop_getpage)(vnode_t *, offset_t, size_t, uint_t *, \
883 struct page **, size_t, struct seg *, \
884 caddr_t, enum seg_rw, cred_t *, \
885 caller_context_t *); \
886 int (*vop_putpage)(vnode_t *, offset_t, size_t, \
887 int, cred_t *, caller_context_t *); \
888 int (*vop_map)(vnode_t *, offset_t, struct as *, \
889 caddr_t *, size_t, \
890 uchar_t, uchar_t, uint_t, cred_t *, \
891 caller_context_t *); \
892 int (*vop_addmap)(vnode_t *, offset_t, struct as *, \
893 caddr_t, size_t, \
894 uchar_t, uchar_t, uint_t, cred_t *, \
895 caller_context_t *); \
896 int (*vop_delmap)(vnode_t *, offset_t, struct as *, \
897 caddr_t, size_t, \
898 uint_t, uint_t, uint_t, cred_t *, \
899 caller_context_t *); \
900 int (*vop_poll)(vnode_t *, short, int, short *, \
901 struct pollhead **, \
902 caller_context_t *); \
903 int (*vop_dump)(vnode_t *, caddr_t, offset_t, offset_t, \
904 caller_context_t *); \
905 int (*vop_pathconf)(vnode_t *, int, ulong_t *, cred_t *, \
906 caller_context_t *); \
907 int (*vop_pageio)(vnode_t *, struct page *, \
908 u_offset_t, size_t, int, cred_t *, \
909 caller_context_t *); \
910 int (*vop_dumpctl)(vnode_t *, int, offset_t *, \
911 caller_context_t *); \
912 void (*vop_dispose)(vnode_t *, struct page *, \
913 int, int, cred_t *, \
914 caller_context_t *); \
915 int (*vop_setsecattr)(vnode_t *, vsecattr_t *, \
916 int, cred_t *, caller_context_t *); \
917 int (*vop_getsecattr)(vnode_t *, vsecattr_t *, \
918 int, cred_t *, caller_context_t *); \
919 int (*vop_shrlock)(vnode_t *, int, struct shrlock *, \
920 int, cred_t *, caller_context_t *); \
921 int (*vop_vnevent)(vnode_t *, vnevent_t, vnode_t *, \
922 char *, caller_context_t *); \
923 int (*vop_reqzcbuf)(vnode_t *, enum uio_rw, xuio_t *, \
924 cred_t *, caller_context_t *); \
925 int (*vop_retzcbuf)(vnode_t *, xuio_t *, cred_t *, \
926 caller_context_t *)
927 /* NB: No ";" */
928
929 /*
930 * Operations on vnodes. Note: File systems must never operate directly
931 * on a 'vnodeops' structure -- it WILL change in future releases! They
932 * must use vn_make_ops() to create the structure.
933 */
934 typedef struct vnodeops {
935 const char *vnop_name;
936 VNODE_OPS; /* Signatures of all vnode operations (vops) */
937 } vnodeops_t;
938
939 typedef int (*fs_generic_func_p) (); /* Generic vop/vfsop/femop/fsemop ptr */
940
941 extern int fop_open(vnode_t **, int, cred_t *, caller_context_t *);
942 extern int fop_close(vnode_t *, int, int, offset_t, cred_t *,
943 caller_context_t *);
944 extern int fop_read(vnode_t *, uio_t *, int, cred_t *, caller_context_t *);
945 extern int fop_write(vnode_t *, uio_t *, int, cred_t *,
946 caller_context_t *);
947 extern int fop_ioctl(vnode_t *, int, intptr_t, int, cred_t *, int *,
948 caller_context_t *);
949 extern int fop_setfl(vnode_t *, int, int, cred_t *, caller_context_t *);
950 extern int fop_getattr(vnode_t *, vattr_t *, int, cred_t *,
951 caller_context_t *);
952 extern int fop_setattr(vnode_t *, vattr_t *, int, cred_t *,
953 caller_context_t *);
954 extern int fop_access(vnode_t *, int, int, cred_t *, caller_context_t *);
955 extern int fop_lookup(vnode_t *, char *, vnode_t **, struct pathname *,
956 int, vnode_t *, cred_t *, caller_context_t *,
957 int *, struct pathname *);
958 extern int fop_create(vnode_t *, char *, vattr_t *, vcexcl_t, int,
959 vnode_t **, cred_t *, int, caller_context_t *,
960 vsecattr_t *);
961 extern int fop_remove(vnode_t *vp, char *, cred_t *, caller_context_t *,
962 int);
963 extern int fop_link(vnode_t *, vnode_t *, char *, cred_t *,
964 caller_context_t *, int);
965 extern int fop_rename(vnode_t *, char *, vnode_t *, char *, cred_t *,
966 caller_context_t *, int);
967 extern int fop_mkdir(vnode_t *, char *, vattr_t *, vnode_t **, cred_t *,
968 caller_context_t *, int, vsecattr_t *);
969 extern int fop_rmdir(vnode_t *, char *, vnode_t *, cred_t *,
970 caller_context_t *, int);
971 extern int fop_readdir(vnode_t *, uio_t *, cred_t *, int *,
972 caller_context_t *, int);
973 extern int fop_symlink(vnode_t *, char *, vattr_t *, char *, cred_t *,
974 caller_context_t *, int);
975 extern int fop_readlink(vnode_t *, uio_t *, cred_t *, caller_context_t *);
976 extern int fop_fsync(vnode_t *, int, cred_t *, caller_context_t *);
977 extern void fop_inactive(vnode_t *, cred_t *, caller_context_t *);
978 extern int fop_fid(vnode_t *, struct fid *, caller_context_t *);
979 extern int fop_rwlock(vnode_t *, int, caller_context_t *);
980 extern void fop_rwunlock(vnode_t *, int, caller_context_t *);
981 extern int fop_seek(vnode_t *, offset_t, offset_t *, caller_context_t *);
982 extern int fop_cmp(vnode_t *, vnode_t *, caller_context_t *);
983 extern int fop_frlock(vnode_t *, int, struct flock64 *, int, offset_t,
984 struct flk_callback *, cred_t *,
985 caller_context_t *);
986 extern int fop_space(vnode_t *, int, struct flock64 *, int, offset_t,
987 cred_t *, caller_context_t *);
988 extern int fop_realvp(vnode_t *, vnode_t **, caller_context_t *);
989 extern int fop_getpage(vnode_t *, offset_t, size_t, uint_t *,
990 struct page **, size_t, struct seg *,
991 caddr_t, enum seg_rw, cred_t *,
992 caller_context_t *);
993 extern int fop_putpage(vnode_t *, offset_t, size_t, int, cred_t *,
994 caller_context_t *);
995 extern int fop_map(vnode_t *, offset_t, struct as *, caddr_t *, size_t,
996 uchar_t, uchar_t, uint_t, cred_t *cr,
997 caller_context_t *);
998 extern int fop_addmap(vnode_t *, offset_t, struct as *, caddr_t, size_t,
999 uchar_t, uchar_t, uint_t, cred_t *,
1000 caller_context_t *);
1001 extern int fop_delmap(vnode_t *, offset_t, struct as *, caddr_t, size_t,
1002 uint_t, uint_t, uint_t, cred_t *,
1003 caller_context_t *);
1004 extern int fop_poll(vnode_t *, short, int, short *, struct pollhead **,
1005 caller_context_t *);
1006 extern int fop_dump(vnode_t *, caddr_t, offset_t, offset_t,
1007 caller_context_t *);
1008 extern int fop_pathconf(vnode_t *, int, ulong_t *, cred_t *,
1009 caller_context_t *);
1010 extern int fop_pageio(vnode_t *, struct page *, u_offset_t, size_t, int,
1011 cred_t *, caller_context_t *);
1012 extern int fop_dumpctl(vnode_t *, int, offset_t *, caller_context_t *);
1013 extern void fop_dispose(vnode_t *, struct page *, int, int, cred_t *,
1014 caller_context_t *);
1015 extern int fop_setsecattr(vnode_t *, vsecattr_t *, int, cred_t *,
1016 caller_context_t *);
1017 extern int fop_getsecattr(vnode_t *, vsecattr_t *, int, cred_t *,
1018 caller_context_t *);
1019 extern int fop_shrlock(vnode_t *, int, struct shrlock *, int, cred_t *,
1020 caller_context_t *);
1021 extern int fop_vnevent(vnode_t *, vnevent_t, vnode_t *, char *,
1022 caller_context_t *);
1023 extern int fop_reqzcbuf(vnode_t *, enum uio_rw, xuio_t *, cred_t *,
1024 caller_context_t *);
1025 extern int fop_retzcbuf(vnode_t *, xuio_t *, cred_t *, caller_context_t *);
1026
1027 #endif /* _KERNEL */
1028
1029 #define VOP_OPEN(vpp, mode, cr, ct) \
1030 fop_open(vpp, mode, cr, ct)
1031 #define VOP_CLOSE(vp, f, c, o, cr, ct) \
1032 fop_close(vp, f, c, o, cr, ct)
1033 #define VOP_READ(vp, uiop, iof, cr, ct) \
1034 fop_read(vp, uiop, iof, cr, ct)
1035 #define VOP_WRITE(vp, uiop, iof, cr, ct) \
1036 fop_write(vp, uiop, iof, cr, ct)
1037 #define VOP_IOCTL(vp, cmd, a, f, cr, rvp, ct) \
1038 fop_ioctl(vp, cmd, a, f, cr, rvp, ct)
1039 #define VOP_SETFL(vp, f, a, cr, ct) \
1040 fop_setfl(vp, f, a, cr, ct)
1041 #define VOP_GETATTR(vp, vap, f, cr, ct) \
1042 fop_getattr(vp, vap, f, cr, ct)
1043 #define VOP_SETATTR(vp, vap, f, cr, ct) \
1044 fop_setattr(vp, vap, f, cr, ct)
1045 #define VOP_ACCESS(vp, mode, f, cr, ct) \
1046 fop_access(vp, mode, f, cr, ct)
1047 #define VOP_LOOKUP(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp) \
1048 fop_lookup(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp)
1049 #define VOP_CREATE(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap) \
1050 fop_create(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap)
1051 #define VOP_REMOVE(dvp, p, cr, ct, f) \
1052 fop_remove(dvp, p, cr, ct, f)
1053 #define VOP_LINK(tdvp, fvp, p, cr, ct, f) \
1054 fop_link(tdvp, fvp, p, cr, ct, f)
1055 #define VOP_RENAME(fvp, fnm, tdvp, tnm, cr, ct, f) \
1056 fop_rename(fvp, fnm, tdvp, tnm, cr, ct, f)
1057 #define VOP_MKDIR(dp, p, vap, vpp, cr, ct, f, vsap) \
1058 fop_mkdir(dp, p, vap, vpp, cr, ct, f, vsap)
1059 #define VOP_RMDIR(dp, p, cdir, cr, ct, f) \
1060 fop_rmdir(dp, p, cdir, cr, ct, f)
1061 #define VOP_READDIR(vp, uiop, cr, eofp, ct, f) \
1062 fop_readdir(vp, uiop, cr, eofp, ct, f)
1063 #define VOP_SYMLINK(dvp, lnm, vap, tnm, cr, ct, f) \
1064 fop_symlink(dvp, lnm, vap, tnm, cr, ct, f)
1065 #define VOP_READLINK(vp, uiop, cr, ct) \
1066 fop_readlink(vp, uiop, cr, ct)
1067 #define VOP_FSYNC(vp, syncflag, cr, ct) \
1068 fop_fsync(vp, syncflag, cr, ct)
1069 #define VOP_INACTIVE(vp, cr, ct) \
1070 fop_inactive(vp, cr, ct)
1071 #define VOP_FID(vp, fidp, ct) \
1072 fop_fid(vp, fidp, ct)
1073 #define VOP_RWLOCK(vp, w, ct) \
1074 fop_rwlock(vp, w, ct)
1075 #define VOP_RWUNLOCK(vp, w, ct) \
1076 fop_rwunlock(vp, w, ct)
1077 #define VOP_SEEK(vp, ooff, noffp, ct) \
1078 fop_seek(vp, ooff, noffp, ct)
1079 #define VOP_CMP(vp1, vp2, ct) \
1080 fop_cmp(vp1, vp2, ct)
1081 #define VOP_FRLOCK(vp, cmd, a, f, o, cb, cr, ct) \
1082 fop_frlock(vp, cmd, a, f, o, cb, cr, ct)
1083 #define VOP_SPACE(vp, cmd, a, f, o, cr, ct) \
1084 fop_space(vp, cmd, a, f, o, cr, ct)
1085 #define VOP_REALVP(vp1, vp2, ct) \
1086 fop_realvp(vp1, vp2, ct)
1087 #define VOP_GETPAGE(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct) \
1088 fop_getpage(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct)
1089 #define VOP_PUTPAGE(vp, of, sz, fl, cr, ct) \
1090 fop_putpage(vp, of, sz, fl, cr, ct)
1091 #define VOP_MAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1092 fop_map(vp, of, as, a, sz, p, mp, fl, cr, ct)
1093 #define VOP_ADDMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1094 fop_addmap(vp, of, as, a, sz, p, mp, fl, cr, ct)
1095 #define VOP_DELMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1096 fop_delmap(vp, of, as, a, sz, p, mp, fl, cr, ct)
1097 #define VOP_POLL(vp, events, anyyet, reventsp, phpp, ct) \
1098 fop_poll(vp, events, anyyet, reventsp, phpp, ct)
1099 #define VOP_DUMP(vp, addr, bn, count, ct) \
1100 fop_dump(vp, addr, bn, count, ct)
1101 #define VOP_PATHCONF(vp, cmd, valp, cr, ct) \
1102 fop_pathconf(vp, cmd, valp, cr, ct)
1103 #define VOP_PAGEIO(vp, pp, io_off, io_len, flags, cr, ct) \
1104 fop_pageio(vp, pp, io_off, io_len, flags, cr, ct)
1105 #define VOP_DUMPCTL(vp, action, blkp, ct) \
1106 fop_dumpctl(vp, action, blkp, ct)
1107 #define VOP_DISPOSE(vp, pp, flag, dn, cr, ct) \
1108 fop_dispose(vp, pp, flag, dn, cr, ct)
1109 #define VOP_GETSECATTR(vp, vsap, f, cr, ct) \
1110 fop_getsecattr(vp, vsap, f, cr, ct)
1111 #define VOP_SETSECATTR(vp, vsap, f, cr, ct) \
1112 fop_setsecattr(vp, vsap, f, cr, ct)
1113 #define VOP_SHRLOCK(vp, cmd, shr, f, cr, ct) \
1114 fop_shrlock(vp, cmd, shr, f, cr, ct)
1115 #define VOP_VNEVENT(vp, vnevent, dvp, fnm, ct) \
1116 fop_vnevent(vp, vnevent, dvp, fnm, ct)
1117 #define VOP_REQZCBUF(vp, rwflag, xuiop, cr, ct) \
1118 fop_reqzcbuf(vp, rwflag, xuiop, cr, ct)
1119 #define VOP_RETZCBUF(vp, xuiop, cr, ct) \
1120 fop_retzcbuf(vp, xuiop, cr, ct)
1121
1122 #define VOPNAME_OPEN "open"
1123 #define VOPNAME_CLOSE "close"
1124 #define VOPNAME_READ "read"
1125 #define VOPNAME_WRITE "write"
1126 #define VOPNAME_IOCTL "ioctl"
1127 #define VOPNAME_SETFL "setfl"
1128 #define VOPNAME_GETATTR "getattr"
1129 #define VOPNAME_SETATTR "setattr"
1130 #define VOPNAME_ACCESS "access"
1131 #define VOPNAME_LOOKUP "lookup"
1132 #define VOPNAME_CREATE "create"
1133 #define VOPNAME_REMOVE "remove"
1134 #define VOPNAME_LINK "link"
1135 #define VOPNAME_RENAME "rename"
1136 #define VOPNAME_MKDIR "mkdir"
1137 #define VOPNAME_RMDIR "rmdir"
1138 #define VOPNAME_READDIR "readdir"
1139 #define VOPNAME_SYMLINK "symlink"
1140 #define VOPNAME_READLINK "readlink"
1141 #define VOPNAME_FSYNC "fsync"
1142 #define VOPNAME_INACTIVE "inactive"
1143 #define VOPNAME_FID "fid"
1144 #define VOPNAME_RWLOCK "rwlock"
1145 #define VOPNAME_RWUNLOCK "rwunlock"
1146 #define VOPNAME_SEEK "seek"
1147 #define VOPNAME_CMP "cmp"
1148 #define VOPNAME_FRLOCK "frlock"
1149 #define VOPNAME_SPACE "space"
1150 #define VOPNAME_REALVP "realvp"
1151 #define VOPNAME_GETPAGE "getpage"
1152 #define VOPNAME_PUTPAGE "putpage"
1153 #define VOPNAME_MAP "map"
1154 #define VOPNAME_ADDMAP "addmap"
1155 #define VOPNAME_DELMAP "delmap"
1156 #define VOPNAME_POLL "poll"
1157 #define VOPNAME_DUMP "dump"
1158 #define VOPNAME_PATHCONF "pathconf"
1159 #define VOPNAME_PAGEIO "pageio"
1160 #define VOPNAME_DUMPCTL "dumpctl"
1161 #define VOPNAME_DISPOSE "dispose"
1162 #define VOPNAME_GETSECATTR "getsecattr"
1163 #define VOPNAME_SETSECATTR "setsecattr"
1164 #define VOPNAME_SHRLOCK "shrlock"
1165 #define VOPNAME_VNEVENT "vnevent"
1166 #define VOPNAME_REQZCBUF "reqzcbuf"
1167 #define VOPNAME_RETZCBUF "retzcbuf"
1168
1169 /*
1170 * Flags for VOP_LOOKUP
1171 *
1172 * Defined in file.h, but also possible, FIGNORECASE and FSEARCH
1173 *
1174 */
1175 #define LOOKUP_DIR 0x01 /* want parent dir vp */
1176 #define LOOKUP_XATTR 0x02 /* lookup up extended attr dir */
1177 #define CREATE_XATTR_DIR 0x04 /* Create extended attr dir */
1178 #define LOOKUP_HAVE_SYSATTR_DIR 0x08 /* Already created virtual GFS dir */
1179
1180 /*
1181 * Flags for VOP_READDIR
1182 */
1183 #define V_RDDIR_ENTFLAGS 0x01 /* request dirent flags */
1184 #define V_RDDIR_ACCFILTER 0x02 /* filter out inaccessible dirents */
1185
1186 /*
1187 * Flags for VOP_RWLOCK/VOP_RWUNLOCK
1188 * VOP_RWLOCK will return the flag that was actually set, or -1 if none.
1189 */
1190 #define V_WRITELOCK_TRUE (1) /* Request write-lock on the vnode */
1191 #define V_WRITELOCK_FALSE (0) /* Request read-lock on the vnode */
1192
1193 /*
1194 * Flags for VOP_DUMPCTL
1195 */
1196 #define DUMP_ALLOC 0
1197 #define DUMP_FREE 1
1198 #define DUMP_SCAN 2
1199
1200 /*
1201 * Public vnode manipulation functions.
1202 */
1203 #ifdef _KERNEL
1204
1205 vnode_t *vn_alloc(int);
1206 void vn_reinit(vnode_t *);
1207 void vn_recycle(vnode_t *);
1208 void vn_free(vnode_t *);
1209
1210 int vn_is_readonly(vnode_t *);
1211 int vn_is_opened(vnode_t *, v_mode_t);
1212 int vn_is_mapped(vnode_t *, v_mode_t);
1213 int vn_has_other_opens(vnode_t *, v_mode_t);
1214 void vn_open_upgrade(vnode_t *, int);
1215 void vn_open_downgrade(vnode_t *, int);
1216
1217 int vn_can_change_zones(vnode_t *vp);
1218
1219 int vn_has_flocks(vnode_t *);
1220 int vn_has_mandatory_locks(vnode_t *, int);
1221 int vn_has_cached_data(vnode_t *);
1222
1223 void vn_setops(vnode_t *, vnodeops_t *);
1224 vnodeops_t *vn_getops(vnode_t *);
1225 int vn_matchops(vnode_t *, vnodeops_t *);
1226 int vn_matchopval(vnode_t *, char *, fs_generic_func_p);
1227 int vn_ismntpt(vnode_t *);
1228
1229 struct vfs *vn_mountedvfs(vnode_t *);
1230
1231 int vn_in_dnlc(vnode_t *);
1232
1233 void vn_create_cache(void);
1234 void vn_destroy_cache(void);
1235
1236 void vn_freevnodeops(vnodeops_t *);
1237
1238 int vn_open(char *pnamep, enum uio_seg seg, int filemode, int createmode,
1239 struct vnode **vpp, enum create crwhy, mode_t umask);
1240 int vn_openat(char *pnamep, enum uio_seg seg, int filemode, int createmode,
1241 struct vnode **vpp, enum create crwhy,
1242 mode_t umask, struct vnode *startvp, int fd);
1243 int vn_create(char *pnamep, enum uio_seg seg, struct vattr *vap,
1244 enum vcexcl excl, int mode, struct vnode **vpp,
1245 enum create why, int flag, mode_t umask);
1246 int vn_createat(char *pnamep, enum uio_seg seg, struct vattr *vap,
1247 enum vcexcl excl, int mode, struct vnode **vpp,
1248 enum create why, int flag, mode_t umask, struct vnode *startvp);
1249 int vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base, ssize_t len,
1250 offset_t offset, enum uio_seg seg, int ioflag, rlim64_t ulimit,
1251 cred_t *cr, ssize_t *residp);
1252 void vn_rele(struct vnode *vp);
1253 void vn_rele_async(struct vnode *vp, struct taskq *taskq);
1254 void vn_rele_dnlc(struct vnode *vp);
1255 void vn_rele_stream(struct vnode *vp);
1256 int vn_link(char *from, char *to, enum uio_seg seg);
1257 int vn_linkat(vnode_t *fstartvp, char *from, enum symfollow follow,
1258 vnode_t *tstartvp, char *to, enum uio_seg seg);
1259 int vn_rename(char *from, char *to, enum uio_seg seg);
1260 int vn_renameat(vnode_t *fdvp, char *fname, vnode_t *tdvp, char *tname,
1261 enum uio_seg seg);
1262 int vn_remove(char *fnamep, enum uio_seg seg, enum rm dirflag);
1263 int vn_removeat(vnode_t *startvp, char *fnamep, enum uio_seg seg,
1264 enum rm dirflag);
1265 int vn_compare(vnode_t *vp1, vnode_t *vp2);
1266 int vn_vfswlock(struct vnode *vp);
1267 int vn_vfswlock_wait(struct vnode *vp);
1268 int vn_vfsrlock(struct vnode *vp);
1269 int vn_vfsrlock_wait(struct vnode *vp);
1270 void vn_vfsunlock(struct vnode *vp);
1271 int vn_vfswlock_held(struct vnode *vp);
1272 vnode_t *specvp(struct vnode *vp, dev_t dev, vtype_t type, struct cred *cr);
1273 vnode_t *makespecvp(dev_t dev, vtype_t type);
1274 vn_vfslocks_entry_t *vn_vfslocks_getlock(void *);
1275 void vn_vfslocks_rele(vn_vfslocks_entry_t *);
1276 boolean_t vn_is_reparse(vnode_t *, cred_t *, caller_context_t *);
1277
1278 void vn_copypath(struct vnode *src, struct vnode *dst);
1279 void vn_setpath_str(struct vnode *vp, const char *str, size_t len);
1280 void vn_setpath(vnode_t *rootvp, struct vnode *startvp, struct vnode *vp,
1281 const char *path, size_t plen);
1282 void vn_renamepath(vnode_t *dvp, vnode_t *vp, const char *nm, size_t len);
1283
1284 /* Vnode event notification */
1285 void vnevent_rename_src(vnode_t *, vnode_t *, char *, caller_context_t *);
1286 void vnevent_rename_dest(vnode_t *, vnode_t *, char *, caller_context_t *);
1287 void vnevent_remove(vnode_t *, vnode_t *, char *, caller_context_t *);
1288 void vnevent_rmdir(vnode_t *, vnode_t *, char *, caller_context_t *);
1289 void vnevent_create(vnode_t *, caller_context_t *);
1290 void vnevent_link(vnode_t *, caller_context_t *);
1291 void vnevent_rename_dest_dir(vnode_t *, caller_context_t *ct);
1292 void vnevent_mountedover(vnode_t *, caller_context_t *);
1293 int vnevent_support(vnode_t *, caller_context_t *);
1294
1295 /* Vnode specific data */
1296 void vsd_create(uint_t *, void (*)(void *));
1297 void vsd_destroy(uint_t *);
1298 void *vsd_get(vnode_t *, uint_t);
1299 int vsd_set(vnode_t *, uint_t, void *);
1300 void vsd_free(vnode_t *);
1301
1302 /*
1303 * Extensible vnode attribute (xva) routines:
1304 * xva_init() initializes an xvattr_t (zero struct, init mapsize, set AT_XATTR)
1305 * xva_getxoptattr() returns a ponter to the xoptattr_t section of xvattr_t
1306 */
1307 void xva_init(xvattr_t *);
1308 xoptattr_t *xva_getxoptattr(xvattr_t *); /* Get ptr to xoptattr_t */
1309
1310 void xattr_init(void); /* Initialize vnodeops for xattrs */
1311
1312 /* GFS tunnel for xattrs */
1313 int xattr_dir_lookup(vnode_t *, vnode_t **, int, cred_t *);
1314
1315 /* Reparse Point */
1316 void reparse_point_init(void);
1317
1318 /* Context identification */
1319 u_longlong_t fs_new_caller_id();
1320
1321 int vn_vmpss_usepageio(vnode_t *);
1322
1323 /*
1324 * Needed for use of IS_VMODSORT() in kernel.
1325 */
1326 extern uint_t pvn_vmodsort_supported;
1327
1328 #define VN_HOLD(vp) { \
1329 mutex_enter(&(vp)->v_lock); \
1330 (vp)->v_count++; \
1331 mutex_exit(&(vp)->v_lock); \
1332 }
1333
1334 #define VN_RELE(vp) { \
1335 vn_rele(vp); \
1336 }
1337
1338 #define VN_RELE_ASYNC(vp, taskq) { \
1339 vn_rele_async(vp, taskq); \
1340 }
1341
1342 #define VN_SET_VFS_TYPE_DEV(vp, vfsp, type, dev) { \
1343 (vp)->v_vfsp = (vfsp); \
1344 (vp)->v_type = (type); \
1345 (vp)->v_rdev = (dev); \
1346 }
1347
1348 /*
1349 * Compare two vnodes for equality. In general this macro should be used
1350 * in preference to calling VOP_CMP directly.
1351 */
1352 #define VN_CMP(VP1, VP2) ((VP1) == (VP2) ? 1 : \
1353 ((VP1) && (VP2) && (vn_getops(VP1) == vn_getops(VP2)) ? \
1354 VOP_CMP(VP1, VP2, NULL) : 0))
1355
1356 /*
1357 * Some well-known global vnodes used by the VM system to name pages.
1358 */
1359 extern struct vnode kvps[];
1360
1361 typedef enum {
1362 KV_KVP, /* vnode for all segkmem pages */
1363 KV_ZVP, /* vnode for all ZFS pages */
1364 #if defined(__sparc)
1365 KV_MPVP, /* vnode for all page_t meta-pages */
1366 KV_PROMVP, /* vnode for all PROM pages */
1367 #endif /* __sparc */
1368 KV_MAX /* total number of vnodes in kvps[] */
1369 } kvps_index_t;
1370
1371 #define VN_ISKAS(vp) ((vp) >= &kvps[0] && (vp) < &kvps[KV_MAX])
1372
1373 #endif /* _KERNEL */
1374
1375 /*
1376 * Flags to VOP_SETATTR/VOP_GETATTR.
1377 */
1378 #define ATTR_UTIME 0x01 /* non-default utime(2) request */
1379 #define ATTR_EXEC 0x02 /* invocation from exec(2) */
1380 #define ATTR_COMM 0x04 /* yield common vp attributes */
1381 #define ATTR_HINT 0x08 /* information returned will be `hint' */
1382 #define ATTR_REAL 0x10 /* yield attributes of the real vp */
1383 #define ATTR_NOACLCHECK 0x20 /* Don't check ACL when checking permissions */
1384 #define ATTR_TRIGGER 0x40 /* Mount first if vnode is a trigger mount */
1385 /*
1386 * Generally useful macros.
1387 */
1388 #define VBSIZE(vp) ((vp)->v_vfsp->vfs_bsize)
1389
1390 #define VTOZONE(vp) ((vp)->v_vfsp->vfs_zone)
1391
1392 #define NULLVP ((struct vnode *)0)
1393 #define NULLVPP ((struct vnode **)0)
1394
1395 #ifdef _KERNEL
1396
1397 /*
1398 * Structure used while handling asynchronous VOP_PUTPAGE operations.
1399 */
1400 struct async_reqs {
1401 struct async_reqs *a_next; /* pointer to next arg struct */
1402 struct vnode *a_vp; /* vnode pointer */
1403 u_offset_t a_off; /* offset in file */
1404 uint_t a_len; /* size of i/o request */
1405 int a_flags; /* flags to indicate operation type */
1406 struct cred *a_cred; /* cred pointer */
1407 ushort_t a_prealloced; /* set if struct is pre-allocated */
1408 };
1409
1410 /*
1411 * VN_DISPOSE() -- given a page pointer, safely invoke VOP_DISPOSE().
1412 * Note that there is no guarantee that the page passed in will be
1413 * freed. If that is required, then a check after calling VN_DISPOSE would
1414 * be necessary to ensure the page was freed.
1415 */
1416 #define VN_DISPOSE(pp, flag, dn, cr) { \
1417 if ((pp)->p_vnode != NULL && !VN_ISKAS((pp)->p_vnode)) \
1418 VOP_DISPOSE((pp)->p_vnode, (pp), (flag), (dn), (cr), NULL); \
1419 else if ((flag) == B_FREE) \
1420 page_free((pp), (dn)); \
1421 else \
1422 page_destroy((pp), (dn)); \
1423 }
1424
1425 #endif /* _KERNEL */
1426
1427 #ifdef __cplusplus
1428 }
1429 #endif
1430
1431 #endif /* _SYS_VNODE_H */
Unleashed OS