1*b819cea2SGordon Ross /*
2*b819cea2SGordon Ross  * CDDL HEADER START
3*b819cea2SGordon Ross  *
4*b819cea2SGordon Ross  * The contents of this file are subject to the terms of the
5*b819cea2SGordon Ross  * Common Development and Distribution License (the "License").
6*b819cea2SGordon Ross  * You may not use this file except in compliance with the License.
7*b819cea2SGordon Ross  *
8*b819cea2SGordon Ross  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*b819cea2SGordon Ross  * or http://www.opensolaris.org/os/licensing.
10*b819cea2SGordon Ross  * See the License for the specific language governing permissions
11*b819cea2SGordon Ross  * and limitations under the License.
12*b819cea2SGordon Ross  *
13*b819cea2SGordon Ross  * When distributing Covered Code, include this CDDL HEADER in each
14*b819cea2SGordon Ross  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*b819cea2SGordon Ross  * If applicable, add the following below this CDDL HEADER, with the
16*b819cea2SGordon Ross  * fields enclosed by brackets "[]" replaced with your own identifying
17*b819cea2SGordon Ross  * information: Portions Copyright [yyyy] [name of copyright owner]
18*b819cea2SGordon Ross  *
19*b819cea2SGordon Ross  * CDDL HEADER END
20*b819cea2SGordon Ross  */
21*b819cea2SGordon Ross 
22*b819cea2SGordon Ross /*
23*b819cea2SGordon Ross  * Copyright (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved.
24*b819cea2SGordon Ross  * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25*b819cea2SGordon Ross  */
26*b819cea2SGordon Ross 
27*b819cea2SGordon Ross /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
28*b819cea2SGordon Ross /*	  All Rights Reserved  	*/
29*b819cea2SGordon Ross 
30*b819cea2SGordon Ross /*
31*b819cea2SGordon Ross  * University Copyright- Copyright (c) 1982, 1986, 1988
32*b819cea2SGordon Ross  * The Regents of the University of California
33*b819cea2SGordon Ross  * All Rights Reserved
34*b819cea2SGordon Ross  *
35*b819cea2SGordon Ross  * University Acknowledgment- Portions of this document are derived from
36*b819cea2SGordon Ross  * software developed by the University of California, Berkeley, and its
37*b819cea2SGordon Ross  * contributors.
38*b819cea2SGordon Ross  */
39*b819cea2SGordon Ross 
40*b819cea2SGordon Ross #ifndef _SYS_VNODE_H
41*b819cea2SGordon Ross #define	_SYS_VNODE_H
42*b819cea2SGordon Ross 
43*b819cea2SGordon Ross #include <sys/types.h>
44*b819cea2SGordon Ross #include <sys/t_lock.h>
45*b819cea2SGordon Ross #include <sys/time_impl.h>
46*b819cea2SGordon Ross #include <sys/cred.h>
47*b819cea2SGordon Ross #include <sys/uio.h>
48*b819cea2SGordon Ross #include <sys/resource.h>
49*b819cea2SGordon Ross #include <vm/seg_enum.h>
50*b819cea2SGordon Ross #include <sys/kstat.h>
51*b819cea2SGordon Ross #include <sys/kmem.h>
52*b819cea2SGordon Ross #include <sys/list.h>
53*b819cea2SGordon Ross #include <sys/avl.h>
54*b819cea2SGordon Ross #ifdef	_KERNEL
55*b819cea2SGordon Ross #include <sys/rwstlock.h>
56*b819cea2SGordon Ross #include <sys/buf.h>
57*b819cea2SGordon Ross #endif	/* _KERNEL */
58*b819cea2SGordon Ross 
59*b819cea2SGordon Ross #ifdef	__cplusplus
60*b819cea2SGordon Ross extern "C" {
61*b819cea2SGordon Ross #endif
62*b819cea2SGordon Ross 
63*b819cea2SGordon Ross /*
64*b819cea2SGordon Ross  * Statistics for all vnode operations.
65*b819cea2SGordon Ross  * All operations record number of ops (since boot/mount/zero'ed).
66*b819cea2SGordon Ross  * Certain I/O operations (read, write, readdir) also record number
67*b819cea2SGordon Ross  * of bytes transferred.
68*b819cea2SGordon Ross  * This appears in two places in the system: one is embedded in each
69*b819cea2SGordon Ross  * vfs_t.  There is also an array of vopstats_t structures allocated
70*b819cea2SGordon Ross  * on a per-fstype basis.
71*b819cea2SGordon Ross  */
72*b819cea2SGordon Ross 
73*b819cea2SGordon Ross #define	VOPSTATS_STR	"vopstats_"	/* Initial string for vopstat kstats */
74*b819cea2SGordon Ross 
75*b819cea2SGordon Ross typedef struct vopstats {
76*b819cea2SGordon Ross 	kstat_named_t	nopen;		/* VOP_OPEN */
77*b819cea2SGordon Ross 	kstat_named_t	nclose;		/* VOP_CLOSE */
78*b819cea2SGordon Ross 	kstat_named_t	nread;		/* VOP_READ */
79*b819cea2SGordon Ross 	kstat_named_t	read_bytes;
80*b819cea2SGordon Ross 	kstat_named_t	nwrite;		/* VOP_WRITE */
81*b819cea2SGordon Ross 	kstat_named_t	write_bytes;
82*b819cea2SGordon Ross 	kstat_named_t	nioctl;		/* VOP_IOCTL */
83*b819cea2SGordon Ross 	kstat_named_t	nsetfl;		/* VOP_SETFL */
84*b819cea2SGordon Ross 	kstat_named_t	ngetattr;	/* VOP_GETATTR */
85*b819cea2SGordon Ross 	kstat_named_t	nsetattr;	/* VOP_SETATTR */
86*b819cea2SGordon Ross 	kstat_named_t	naccess;	/* VOP_ACCESS */
87*b819cea2SGordon Ross 	kstat_named_t	nlookup;	/* VOP_LOOKUP */
88*b819cea2SGordon Ross 	kstat_named_t	ncreate;	/* VOP_CREATE */
89*b819cea2SGordon Ross 	kstat_named_t	nremove;	/* VOP_REMOVE */
90*b819cea2SGordon Ross 	kstat_named_t	nlink;		/* VOP_LINK */
91*b819cea2SGordon Ross 	kstat_named_t	nrename;	/* VOP_RENAME */
92*b819cea2SGordon Ross 	kstat_named_t	nmkdir;		/* VOP_MKDIR */
93*b819cea2SGordon Ross 	kstat_named_t	nrmdir;		/* VOP_RMDIR */
94*b819cea2SGordon Ross 	kstat_named_t	nreaddir;	/* VOP_READDIR */
95*b819cea2SGordon Ross 	kstat_named_t	readdir_bytes;
96*b819cea2SGordon Ross 	kstat_named_t	nsymlink;	/* VOP_SYMLINK */
97*b819cea2SGordon Ross 	kstat_named_t	nreadlink;	/* VOP_READLINK */
98*b819cea2SGordon Ross 	kstat_named_t	nfsync;		/* VOP_FSYNC */
99*b819cea2SGordon Ross 	kstat_named_t	ninactive;	/* VOP_INACTIVE */
100*b819cea2SGordon Ross 	kstat_named_t	nfid;		/* VOP_FID */
101*b819cea2SGordon Ross 	kstat_named_t	nrwlock;	/* VOP_RWLOCK */
102*b819cea2SGordon Ross 	kstat_named_t	nrwunlock;	/* VOP_RWUNLOCK */
103*b819cea2SGordon Ross 	kstat_named_t	nseek;		/* VOP_SEEK */
104*b819cea2SGordon Ross 	kstat_named_t	ncmp;		/* VOP_CMP */
105*b819cea2SGordon Ross 	kstat_named_t	nfrlock;	/* VOP_FRLOCK */
106*b819cea2SGordon Ross 	kstat_named_t	nspace;		/* VOP_SPACE */
107*b819cea2SGordon Ross 	kstat_named_t	nrealvp;	/* VOP_REALVP */
108*b819cea2SGordon Ross 	kstat_named_t	ngetpage;	/* VOP_GETPAGE */
109*b819cea2SGordon Ross 	kstat_named_t	nputpage;	/* VOP_PUTPAGE */
110*b819cea2SGordon Ross 	kstat_named_t	nmap;		/* VOP_MAP */
111*b819cea2SGordon Ross 	kstat_named_t	naddmap;	/* VOP_ADDMAP */
112*b819cea2SGordon Ross 	kstat_named_t	ndelmap;	/* VOP_DELMAP */
113*b819cea2SGordon Ross 	kstat_named_t	npoll;		/* VOP_POLL */
114*b819cea2SGordon Ross 	kstat_named_t	ndump;		/* VOP_DUMP */
115*b819cea2SGordon Ross 	kstat_named_t	npathconf;	/* VOP_PATHCONF */
116*b819cea2SGordon Ross 	kstat_named_t	npageio;	/* VOP_PAGEIO */
117*b819cea2SGordon Ross 	kstat_named_t	ndumpctl;	/* VOP_DUMPCTL */
118*b819cea2SGordon Ross 	kstat_named_t	ndispose;	/* VOP_DISPOSE */
119*b819cea2SGordon Ross 	kstat_named_t	nsetsecattr;	/* VOP_SETSECATTR */
120*b819cea2SGordon Ross 	kstat_named_t	ngetsecattr;	/* VOP_GETSECATTR */
121*b819cea2SGordon Ross 	kstat_named_t	nshrlock;	/* VOP_SHRLOCK */
122*b819cea2SGordon Ross 	kstat_named_t	nvnevent;	/* VOP_VNEVENT */
123*b819cea2SGordon Ross 	kstat_named_t	nreqzcbuf;	/* VOP_REQZCBUF */
124*b819cea2SGordon Ross 	kstat_named_t	nretzcbuf;	/* VOP_RETZCBUF */
125*b819cea2SGordon Ross } vopstats_t;
126*b819cea2SGordon Ross 
127*b819cea2SGordon Ross /*
128*b819cea2SGordon Ross  * The vnode is the focus of all file activity in UNIX.
129*b819cea2SGordon Ross  * A vnode is allocated for each active file, each current
130*b819cea2SGordon Ross  * directory, each mounted-on file, and the root.
131*b819cea2SGordon Ross  *
132*b819cea2SGordon Ross  * Each vnode is usually associated with a file-system-specific node (for
133*b819cea2SGordon Ross  * UFS, this is the in-memory inode).  Generally, a vnode and an fs-node
134*b819cea2SGordon Ross  * should be created and destroyed together as a pair.
135*b819cea2SGordon Ross  *
136*b819cea2SGordon Ross  * If a vnode is reused for a new file, it should be reinitialized by calling
137*b819cea2SGordon Ross  * either vn_reinit() or vn_recycle().
138*b819cea2SGordon Ross  *
139*b819cea2SGordon Ross  * vn_reinit() resets the entire vnode as if it was returned by vn_alloc().
140*b819cea2SGordon Ross  * The caller is responsible for setting up the entire vnode after calling
141*b819cea2SGordon Ross  * vn_reinit().  This is important when using kmem caching where the vnode is
142*b819cea2SGordon Ross  * allocated by a constructor, for instance.
143*b819cea2SGordon Ross  *
144*b819cea2SGordon Ross  * vn_recycle() is used when the file system keeps some state around in both
145*b819cea2SGordon Ross  * the vnode and the associated FS-node.  In UFS, for example, the inode of
146*b819cea2SGordon Ross  * a deleted file can be reused immediately.  The v_data, v_vfsp, v_op, etc.
147*b819cea2SGordon Ross  * remains the same but certain fields related to the previous instance need
148*b819cea2SGordon Ross  * to be reset.  In particular:
149*b819cea2SGordon Ross  *	v_femhead
150*b819cea2SGordon Ross  *	v_path
151*b819cea2SGordon Ross  *	v_rdcnt, v_wrcnt
152*b819cea2SGordon Ross  *	v_mmap_read, v_mmap_write
153*b819cea2SGordon Ross  */
154*b819cea2SGordon Ross 
155*b819cea2SGordon Ross /*
156*b819cea2SGordon Ross  * vnode types.  VNON means no type.  These values are unrelated to
157*b819cea2SGordon Ross  * values in on-disk inodes.
158*b819cea2SGordon Ross  */
159*b819cea2SGordon Ross typedef enum vtype {
160*b819cea2SGordon Ross 	VNON	= 0,
161*b819cea2SGordon Ross 	VREG	= 1,
162*b819cea2SGordon Ross 	VDIR	= 2,
163*b819cea2SGordon Ross 	VBLK	= 3,
164*b819cea2SGordon Ross 	VCHR	= 4,
165*b819cea2SGordon Ross 	VLNK	= 5,
166*b819cea2SGordon Ross 	VFIFO	= 6,
167*b819cea2SGordon Ross 	VDOOR	= 7,
168*b819cea2SGordon Ross 	VPROC	= 8,
169*b819cea2SGordon Ross 	VSOCK	= 9,
170*b819cea2SGordon Ross 	VPORT	= 10,
171*b819cea2SGordon Ross 	VBAD	= 11
172*b819cea2SGordon Ross } vtype_t;
173*b819cea2SGordon Ross 
174*b819cea2SGordon Ross /*
175*b819cea2SGordon Ross  * VSD - Vnode Specific Data
176*b819cea2SGordon Ross  * Used to associate additional private data with a vnode.
177*b819cea2SGordon Ross  */
178*b819cea2SGordon Ross struct vsd_node {
179*b819cea2SGordon Ross 	list_node_t vs_nodes;		/* list of all VSD nodes */
180*b819cea2SGordon Ross 	uint_t vs_nkeys;		/* entries in value array */
181*b819cea2SGordon Ross 	void **vs_value;		/* array of value/key */
182*b819cea2SGordon Ross };
183*b819cea2SGordon Ross 
184*b819cea2SGordon Ross /*
185*b819cea2SGordon Ross  * Many of the fields in the vnode are read-only once they are initialized
186*b819cea2SGordon Ross  * at vnode creation time.  Other fields are protected by locks.
187*b819cea2SGordon Ross  *
188*b819cea2SGordon Ross  * IMPORTANT: vnodes should be created ONLY by calls to vn_alloc().  They
189*b819cea2SGordon Ross  * may not be embedded into the file-system specific node (inode).  The
190*b819cea2SGordon Ross  * size of vnodes may change.
191*b819cea2SGordon Ross  *
192*b819cea2SGordon Ross  * The v_lock protects:
193*b819cea2SGordon Ross  *   v_flag
194*b819cea2SGordon Ross  *   v_stream
195*b819cea2SGordon Ross  *   v_count
196*b819cea2SGordon Ross  *   v_shrlocks
197*b819cea2SGordon Ross  *   v_path
198*b819cea2SGordon Ross  *   v_vsd
199*b819cea2SGordon Ross  *   v_xattrdir
200*b819cea2SGordon Ross  *
201*b819cea2SGordon Ross  * A special lock (implemented by vn_vfswlock in vnode.c) protects:
202*b819cea2SGordon Ross  *   v_vfsmountedhere
203*b819cea2SGordon Ross  *
204*b819cea2SGordon Ross  * The global flock_lock mutex (in flock.c) protects:
205*b819cea2SGordon Ross  *   v_filocks
206*b819cea2SGordon Ross  *
207*b819cea2SGordon Ross  * IMPORTANT NOTE:
208*b819cea2SGordon Ross  *
209*b819cea2SGordon Ross  *   The following vnode fields are considered public and may safely be
210*b819cea2SGordon Ross  *   accessed by file systems or other consumers:
211*b819cea2SGordon Ross  *
212*b819cea2SGordon Ross  *     v_lock
213*b819cea2SGordon Ross  *     v_flag
214*b819cea2SGordon Ross  *     v_count
215*b819cea2SGordon Ross  *     v_data
216*b819cea2SGordon Ross  *     v_vfsp
217*b819cea2SGordon Ross  *     v_stream
218*b819cea2SGordon Ross  *     v_type
219*b819cea2SGordon Ross  *     v_rdev
220*b819cea2SGordon Ross  *
221*b819cea2SGordon Ross  * ALL OTHER FIELDS SHOULD BE ACCESSED ONLY BY THE OWNER OF THAT FIELD.
222*b819cea2SGordon Ross  * In particular, file systems should not access other fields; they may
223*b819cea2SGordon Ross  * change or even be removed.  The functionality which was once provided
224*b819cea2SGordon Ross  * by these fields is available through vn_* functions.
225*b819cea2SGordon Ross  */
226*b819cea2SGordon Ross 
227*b819cea2SGordon Ross struct fem_head;	/* from fem.h */
228*b819cea2SGordon Ross 
229*b819cea2SGordon Ross typedef struct vnode {
230*b819cea2SGordon Ross 	kmutex_t	v_lock;		/* protects vnode fields */
231*b819cea2SGordon Ross 	uint_t		v_flag;		/* vnode flags (see below) */
232*b819cea2SGordon Ross 	uint_t		v_count;	/* reference count */
233*b819cea2SGordon Ross 	void		*v_data;	/* private data for fs */
234*b819cea2SGordon Ross 	struct vfs	*v_vfsp;	/* ptr to containing VFS */
235*b819cea2SGordon Ross 	struct stdata	*v_stream;	/* associated stream */
236*b819cea2SGordon Ross 	enum vtype	v_type;		/* vnode type */
237*b819cea2SGordon Ross 	dev_t		v_rdev;		/* device (VCHR, VBLK) */
238*b819cea2SGordon Ross 
239*b819cea2SGordon Ross 	/* PRIVATE FIELDS BELOW - DO NOT USE */
240*b819cea2SGordon Ross 
241*b819cea2SGordon Ross 	krwlock_t	v_nbllock;	/* sync for NBMAND locks */
242*b819cea2SGordon Ross 	char		*v_path;	/* cached path */
243*b819cea2SGordon Ross 	uint_t		v_rdcnt;	/* open for read count  (VREG only) */
244*b819cea2SGordon Ross 	uint_t		v_wrcnt;	/* open for write count (VREG only) */
245*b819cea2SGordon Ross 	struct vnode	*v_xattrdir;	/* unnamed extended attr dir (GFS) */
246*b819cea2SGordon Ross 
247*b819cea2SGordon Ross 	/* Private to the fake vnode impl. */
248*b819cea2SGordon Ross 
249*b819cea2SGordon Ross 	int		v_fd;
250*b819cea2SGordon Ross 	dev_t		v_st_dev;
251*b819cea2SGordon Ross 	ino_t		v_st_ino;
252*b819cea2SGordon Ross 	avl_node_t	v_avl_node;
253*b819cea2SGordon Ross } vnode_t;
254*b819cea2SGordon Ross 
255*b819cea2SGordon Ross #define	IS_DEVVP(vp)	\
256*b819cea2SGordon Ross 	((vp)->v_type == VCHR || (vp)->v_type == VBLK || (vp)->v_type == VFIFO)
257*b819cea2SGordon Ross 
258*b819cea2SGordon Ross #define	VNODE_ALIGN	64
259*b819cea2SGordon Ross /* Count of low-order 0 bits in a vnode *, based on size and alignment. */
260*b819cea2SGordon Ross #if defined(_LP64)
261*b819cea2SGordon Ross #define	VNODE_ALIGN_LOG2	8
262*b819cea2SGordon Ross #else
263*b819cea2SGordon Ross #define	VNODE_ALIGN_LOG2	7
264*b819cea2SGordon Ross #endif
265*b819cea2SGordon Ross 
266*b819cea2SGordon Ross /*
267*b819cea2SGordon Ross  * vnode flags.
268*b819cea2SGordon Ross  */
269*b819cea2SGordon Ross #define	VROOT		0x01	/* root of its file system */
270*b819cea2SGordon Ross #define	VNOCACHE	0x02	/* don't keep cache pages on vnode */
271*b819cea2SGordon Ross #define	VNOMAP		0x04	/* file cannot be mapped/faulted */
272*b819cea2SGordon Ross #define	VDUP		0x08	/* file should be dup'ed rather then opened */
273*b819cea2SGordon Ross #define	VNOSWAP		0x10	/* file cannot be used as virtual swap device */
274*b819cea2SGordon Ross #define	VNOMOUNT	0x20	/* file cannot be covered by mount */
275*b819cea2SGordon Ross #define	VISSWAP		0x40	/* vnode is being used for swap */
276*b819cea2SGordon Ross #define	VSWAPLIKE	0x80	/* vnode acts like swap (but may not be) */
277*b819cea2SGordon Ross 
278*b819cea2SGordon Ross #define	IS_SWAPVP(vp)	(((vp)->v_flag & (VISSWAP | VSWAPLIKE)) != 0)
279*b819cea2SGordon Ross 
280*b819cea2SGordon Ross #if defined(_KERNEL)
281*b819cea2SGordon Ross typedef struct vn_vfslocks_entry {
282*b819cea2SGordon Ross 	rwstlock_t ve_lock;
283*b819cea2SGordon Ross 	void *ve_vpvfs;
284*b819cea2SGordon Ross 	struct vn_vfslocks_entry *ve_next;
285*b819cea2SGordon Ross 	uint32_t ve_refcnt;
286*b819cea2SGordon Ross 	char pad[64 - sizeof (rwstlock_t) - 2 * sizeof (void *) - \
287*b819cea2SGordon Ross 	    sizeof (uint32_t)];
288*b819cea2SGordon Ross } vn_vfslocks_entry_t;
289*b819cea2SGordon Ross #endif	/* _KERNEL */
290*b819cea2SGordon Ross 
291*b819cea2SGordon Ross /*
292*b819cea2SGordon Ross  * The following two flags are used to lock the v_vfsmountedhere field
293*b819cea2SGordon Ross  */
294*b819cea2SGordon Ross #define	VVFSLOCK	0x100
295*b819cea2SGordon Ross #define	VVFSWAIT	0x200
296*b819cea2SGordon Ross 
297*b819cea2SGordon Ross /*
298*b819cea2SGordon Ross  * Used to serialize VM operations on a vnode
299*b819cea2SGordon Ross  */
300*b819cea2SGordon Ross #define	VVMLOCK		0x400
301*b819cea2SGordon Ross 
302*b819cea2SGordon Ross /*
303*b819cea2SGordon Ross  * Tell vn_open() not to fail a directory open for writing but
304*b819cea2SGordon Ross  * to go ahead and call VOP_OPEN() to let the filesystem check.
305*b819cea2SGordon Ross  */
306*b819cea2SGordon Ross #define	VDIROPEN	0x800
307*b819cea2SGordon Ross 
308*b819cea2SGordon Ross /*
309*b819cea2SGordon Ross  * Flag to let the VM system know that this file is most likely a binary
310*b819cea2SGordon Ross  * or shared library since it has been mmap()ed EXEC at some time.
311*b819cea2SGordon Ross  */
312*b819cea2SGordon Ross #define	VVMEXEC		0x1000
313*b819cea2SGordon Ross 
314*b819cea2SGordon Ross #define	VPXFS		0x2000  /* clustering: global fs proxy vnode */
315*b819cea2SGordon Ross 
316*b819cea2SGordon Ross #define	IS_PXFSVP(vp)	((vp)->v_flag & VPXFS)
317*b819cea2SGordon Ross 
318*b819cea2SGordon Ross #define	V_XATTRDIR	0x4000	/* attribute unnamed directory */
319*b819cea2SGordon Ross 
320*b819cea2SGordon Ross #define	IS_XATTRDIR(vp)	((vp)->v_flag & V_XATTRDIR)
321*b819cea2SGordon Ross 
322*b819cea2SGordon Ross #define	V_LOCALITY	0x8000	/* whether locality aware */
323*b819cea2SGordon Ross 
324*b819cea2SGordon Ross /*
325*b819cea2SGordon Ross  * Flag that indicates the VM should maintain the v_pages list with all modified
326*b819cea2SGordon Ross  * pages on one end and unmodified pages at the other. This makes finding dirty
327*b819cea2SGordon Ross  * pages to write back to disk much faster at the expense of taking a minor
328*b819cea2SGordon Ross  * fault on the first store instruction which touches a writable page.
329*b819cea2SGordon Ross  */
330*b819cea2SGordon Ross #define	VMODSORT	(0x10000)
331*b819cea2SGordon Ross #define	IS_VMODSORT(vp) \
332*b819cea2SGordon Ross 	(pvn_vmodsort_supported != 0 && ((vp)->v_flag  & VMODSORT) != 0)
333*b819cea2SGordon Ross 
334*b819cea2SGordon Ross #define	VISSWAPFS	0x20000	/* vnode is being used for swapfs */
335*b819cea2SGordon Ross 
336*b819cea2SGordon Ross /*
337*b819cea2SGordon Ross  * The mdb memstat command assumes that IS_SWAPFSVP only uses the
338*b819cea2SGordon Ross  * vnode's v_flag field.  If this changes, cache the additional
339*b819cea2SGordon Ross  * fields in mdb; see vn_get in mdb/common/modules/genunix/memory.c
340*b819cea2SGordon Ross  */
341*b819cea2SGordon Ross #define	IS_SWAPFSVP(vp)	(((vp)->v_flag & VISSWAPFS) != 0)
342*b819cea2SGordon Ross 
343*b819cea2SGordon Ross #define	V_SYSATTR	0x40000	/* vnode is a GFS system attribute */
344*b819cea2SGordon Ross 
345*b819cea2SGordon Ross /*
346*b819cea2SGordon Ross  * Vnode attributes.  A bit-mask is supplied as part of the
347*b819cea2SGordon Ross  * structure to indicate the attributes the caller wants to
348*b819cea2SGordon Ross  * set (setattr) or extract (getattr).
349*b819cea2SGordon Ross  */
350*b819cea2SGordon Ross 
351*b819cea2SGordon Ross /*
352*b819cea2SGordon Ross  * Note that va_nodeid and va_nblocks are 64bit data type.
353*b819cea2SGordon Ross  * We support large files over NFSV3. With Solaris client and
354*b819cea2SGordon Ross  * Server that generates 64bit ino's and sizes these fields
355*b819cea2SGordon Ross  * will overflow if they are 32 bit sizes.
356*b819cea2SGordon Ross  */
357*b819cea2SGordon Ross 
358*b819cea2SGordon Ross typedef struct vattr {
359*b819cea2SGordon Ross 	uint_t		va_mask;	/* bit-mask of attributes */
360*b819cea2SGordon Ross 	vtype_t		va_type;	/* vnode type (for create) */
361*b819cea2SGordon Ross 	mode_t		va_mode;	/* file access mode */
362*b819cea2SGordon Ross 	uid_t		va_uid;		/* owner user id */
363*b819cea2SGordon Ross 	gid_t		va_gid;		/* owner group id */
364*b819cea2SGordon Ross 	dev_t		va_fsid;	/* file system id (dev for now) */
365*b819cea2SGordon Ross 	u_longlong_t	va_nodeid;	/* node id */
366*b819cea2SGordon Ross 	nlink_t		va_nlink;	/* number of references to file */
367*b819cea2SGordon Ross 	u_offset_t	va_size;	/* file size in bytes */
368*b819cea2SGordon Ross 	timestruc_t	va_atime;	/* time of last access */
369*b819cea2SGordon Ross 	timestruc_t	va_mtime;	/* time of last modification */
370*b819cea2SGordon Ross 	timestruc_t	va_ctime;	/* time of last status change */
371*b819cea2SGordon Ross 	dev_t		va_rdev;	/* device the file represents */
372*b819cea2SGordon Ross 	uint_t		va_blksize;	/* fundamental block size */
373*b819cea2SGordon Ross 	u_longlong_t	va_nblocks;	/* # of blocks allocated */
374*b819cea2SGordon Ross 	uint_t		va_seq;		/* sequence number */
375*b819cea2SGordon Ross } vattr_t;
376*b819cea2SGordon Ross 
377*b819cea2SGordon Ross #define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */
378*b819cea2SGordon Ross 
379*b819cea2SGordon Ross /*
380*b819cea2SGordon Ross  * Structure of all optional attributes.
381*b819cea2SGordon Ross  */
382*b819cea2SGordon Ross typedef struct xoptattr {
383*b819cea2SGordon Ross 	timestruc_t	xoa_createtime;	/* Create time of file */
384*b819cea2SGordon Ross 	uint8_t		xoa_archive;
385*b819cea2SGordon Ross 	uint8_t		xoa_system;
386*b819cea2SGordon Ross 	uint8_t		xoa_readonly;
387*b819cea2SGordon Ross 	uint8_t		xoa_hidden;
388*b819cea2SGordon Ross 	uint8_t		xoa_nounlink;
389*b819cea2SGordon Ross 	uint8_t		xoa_immutable;
390*b819cea2SGordon Ross 	uint8_t		xoa_appendonly;
391*b819cea2SGordon Ross 	uint8_t		xoa_nodump;
392*b819cea2SGordon Ross 	uint8_t		xoa_opaque;
393*b819cea2SGordon Ross 	uint8_t		xoa_av_quarantined;
394*b819cea2SGordon Ross 	uint8_t		xoa_av_modified;
395*b819cea2SGordon Ross 	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
396*b819cea2SGordon Ross 	uint8_t		xoa_reparse;
397*b819cea2SGordon Ross 	uint64_t	xoa_generation;
398*b819cea2SGordon Ross 	uint8_t		xoa_offline;
399*b819cea2SGordon Ross 	uint8_t		xoa_sparse;
400*b819cea2SGordon Ross } xoptattr_t;
401*b819cea2SGordon Ross 
402*b819cea2SGordon Ross /*
403*b819cea2SGordon Ross  * The xvattr structure is really a variable length structure that
404*b819cea2SGordon Ross  * is made up of:
405*b819cea2SGordon Ross  * - The classic vattr_t (xva_vattr)
406*b819cea2SGordon Ross  * - a 32 bit quantity (xva_mapsize) that specifies the size of the
407*b819cea2SGordon Ross  *   attribute bitmaps in 32 bit words.
408*b819cea2SGordon Ross  * - A pointer to the returned attribute bitmap (needed because the
409*b819cea2SGordon Ross  *   previous element, the requested attribute bitmap) is variable lenth.
410*b819cea2SGordon Ross  * - The requested attribute bitmap, which is an array of 32 bit words.
411*b819cea2SGordon Ross  *   Callers use the XVA_SET_REQ() macro to set the bits corresponding to
412*b819cea2SGordon Ross  *   the attributes that are being requested.
413*b819cea2SGordon Ross  * - The returned attribute bitmap, which is an array of 32 bit words.
414*b819cea2SGordon Ross  *   File systems that support optional attributes use the XVA_SET_RTN()
415*b819cea2SGordon Ross  *   macro to set the bits corresponding to the attributes that are being
416*b819cea2SGordon Ross  *   returned.
417*b819cea2SGordon Ross  * - The xoptattr_t structure which contains the attribute values
418*b819cea2SGordon Ross  *
419*b819cea2SGordon Ross  * xva_mapsize determines how many words in the attribute bitmaps.
420*b819cea2SGordon Ross  * Immediately following the attribute bitmaps is the xoptattr_t.
421*b819cea2SGordon Ross  * xva_getxoptattr() is used to get the pointer to the xoptattr_t
422*b819cea2SGordon Ross  * section.
423*b819cea2SGordon Ross  */
424*b819cea2SGordon Ross 
425*b819cea2SGordon Ross #define	XVA_MAPSIZE	3		/* Size of attr bitmaps */
426*b819cea2SGordon Ross #define	XVA_MAGIC	0x78766174	/* Magic # for verification */
427*b819cea2SGordon Ross 
428*b819cea2SGordon Ross /*
429*b819cea2SGordon Ross  * The xvattr structure is an extensible structure which permits optional
430*b819cea2SGordon Ross  * attributes to be requested/returned.  File systems may or may not support
431*b819cea2SGordon Ross  * optional attributes.  They do so at their own discretion but if they do
432*b819cea2SGordon Ross  * support optional attributes, they must register the VFSFT_XVATTR feature
433*b819cea2SGordon Ross  * so that the optional attributes can be set/retrived.
434*b819cea2SGordon Ross  *
435*b819cea2SGordon Ross  * The fields of the xvattr structure are:
436*b819cea2SGordon Ross  *
437*b819cea2SGordon Ross  * xva_vattr - The first element of an xvattr is a legacy vattr structure
438*b819cea2SGordon Ross  * which includes the common attributes.  If AT_XVATTR is set in the va_mask
439*b819cea2SGordon Ross  * then the entire structure is treated as an xvattr.  If AT_XVATTR is not
440*b819cea2SGordon Ross  * set, then only the xva_vattr structure can be used.
441*b819cea2SGordon Ross  *
442*b819cea2SGordon Ross  * xva_magic - 0x78766174 (hex for "xvat"). Magic number for verification.
443*b819cea2SGordon Ross  *
444*b819cea2SGordon Ross  * xva_mapsize - Size of requested and returned attribute bitmaps.
445*b819cea2SGordon Ross  *
446*b819cea2SGordon Ross  * xva_rtnattrmapp - Pointer to xva_rtnattrmap[].  We need this since the
447*b819cea2SGordon Ross  * size of the array before it, xva_reqattrmap[], could change which means
448*b819cea2SGordon Ross  * the location of xva_rtnattrmap[] could change.  This will allow unbundled
449*b819cea2SGordon Ross  * file systems to find the location of xva_rtnattrmap[] when the sizes change.
450*b819cea2SGordon Ross  *
451*b819cea2SGordon Ross  * xva_reqattrmap[] - Array of requested attributes.  Attributes are
452*b819cea2SGordon Ross  * represented by a specific bit in a specific element of the attribute
453*b819cea2SGordon Ross  * map array.  Callers set the bits corresponding to the attributes
454*b819cea2SGordon Ross  * that the caller wants to get/set.
455*b819cea2SGordon Ross  *
456*b819cea2SGordon Ross  * xva_rtnattrmap[] - Array of attributes that the file system was able to
457*b819cea2SGordon Ross  * process.  Not all file systems support all optional attributes.  This map
458*b819cea2SGordon Ross  * informs the caller which attributes the underlying file system was able
459*b819cea2SGordon Ross  * to set/get.  (Same structure as the requested attributes array in terms
460*b819cea2SGordon Ross  * of each attribute  corresponding to specific bits and array elements.)
461*b819cea2SGordon Ross  *
462*b819cea2SGordon Ross  * xva_xoptattrs - Structure containing values of optional attributes.
463*b819cea2SGordon Ross  * These values are only valid if the corresponding bits in xva_reqattrmap
464*b819cea2SGordon Ross  * are set and the underlying file system supports those attributes.
465*b819cea2SGordon Ross  */
466*b819cea2SGordon Ross typedef struct xvattr {
467*b819cea2SGordon Ross 	vattr_t		xva_vattr;	/* Embedded vattr structure */
468*b819cea2SGordon Ross 	uint32_t	xva_magic;	/* Magic Number */
469*b819cea2SGordon Ross 	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
470*b819cea2SGordon Ross 	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
471*b819cea2SGordon Ross 	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
472*b819cea2SGordon Ross 	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
473*b819cea2SGordon Ross 	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
474*b819cea2SGordon Ross } xvattr_t;
475*b819cea2SGordon Ross 
476*b819cea2SGordon Ross #ifdef _SYSCALL32
477*b819cea2SGordon Ross /*
478*b819cea2SGordon Ross  * For bigtypes time_t changed to 64 bit on the 64-bit kernel.
479*b819cea2SGordon Ross  * Define an old version for user/kernel interface
480*b819cea2SGordon Ross  */
481*b819cea2SGordon Ross 
482*b819cea2SGordon Ross #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
483*b819cea2SGordon Ross #pragma pack(4)
484*b819cea2SGordon Ross #endif
485*b819cea2SGordon Ross 
486*b819cea2SGordon Ross typedef struct vattr32 {
487*b819cea2SGordon Ross 	uint32_t	va_mask;	/* bit-mask of attributes */
488*b819cea2SGordon Ross 	vtype_t		va_type;	/* vnode type (for create) */
489*b819cea2SGordon Ross 	mode32_t	va_mode;	/* file access mode */
490*b819cea2SGordon Ross 	uid32_t		va_uid;		/* owner user id */
491*b819cea2SGordon Ross 	gid32_t		va_gid;		/* owner group id */
492*b819cea2SGordon Ross 	dev32_t		va_fsid;	/* file system id (dev for now) */
493*b819cea2SGordon Ross 	u_longlong_t	va_nodeid;	/* node id */
494*b819cea2SGordon Ross 	nlink_t		va_nlink;	/* number of references to file */
495*b819cea2SGordon Ross 	u_offset_t	va_size;	/* file size in bytes */
496*b819cea2SGordon Ross 	timestruc32_t	va_atime;	/* time of last access */
497*b819cea2SGordon Ross 	timestruc32_t	va_mtime;	/* time of last modification */
498*b819cea2SGordon Ross 	timestruc32_t	va_ctime;	/* time of last status change */
499*b819cea2SGordon Ross 	dev32_t		va_rdev;	/* device the file represents */
500*b819cea2SGordon Ross 	uint32_t	va_blksize;	/* fundamental block size */
501*b819cea2SGordon Ross 	u_longlong_t	va_nblocks;	/* # of blocks allocated */
502*b819cea2SGordon Ross 	uint32_t	va_seq;		/* sequence number */
503*b819cea2SGordon Ross } vattr32_t;
504*b819cea2SGordon Ross 
505*b819cea2SGordon Ross #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
506*b819cea2SGordon Ross #pragma pack()
507*b819cea2SGordon Ross #endif
508*b819cea2SGordon Ross 
509*b819cea2SGordon Ross #else  /* not _SYSCALL32 */
510*b819cea2SGordon Ross #define	vattr32		vattr
511*b819cea2SGordon Ross typedef vattr_t		vattr32_t;
512*b819cea2SGordon Ross #endif /* _SYSCALL32 */
513*b819cea2SGordon Ross 
514*b819cea2SGordon Ross /*
515*b819cea2SGordon Ross  * Attributes of interest to the caller of setattr or getattr.
516*b819cea2SGordon Ross  */
517*b819cea2SGordon Ross #define	AT_TYPE		0x00001
518*b819cea2SGordon Ross #define	AT_MODE		0x00002
519*b819cea2SGordon Ross #define	AT_UID		0x00004
520*b819cea2SGordon Ross #define	AT_GID		0x00008
521*b819cea2SGordon Ross #define	AT_FSID		0x00010
522*b819cea2SGordon Ross #define	AT_NODEID	0x00020
523*b819cea2SGordon Ross #define	AT_NLINK	0x00040
524*b819cea2SGordon Ross #define	AT_SIZE		0x00080
525*b819cea2SGordon Ross #define	AT_ATIME	0x00100
526*b819cea2SGordon Ross #define	AT_MTIME	0x00200
527*b819cea2SGordon Ross #define	AT_CTIME	0x00400
528*b819cea2SGordon Ross #define	AT_RDEV		0x00800
529*b819cea2SGordon Ross #define	AT_BLKSIZE	0x01000
530*b819cea2SGordon Ross #define	AT_NBLOCKS	0x02000
531*b819cea2SGordon Ross /*			0x04000 */	/* unused */
532*b819cea2SGordon Ross #define	AT_SEQ		0x08000
533*b819cea2SGordon Ross /*
534*b819cea2SGordon Ross  * If AT_XVATTR is set then there are additional bits to process in
535*b819cea2SGordon Ross  * the xvattr_t's attribute bitmap.  If this is not set then the bitmap
536*b819cea2SGordon Ross  * MUST be ignored.  Note that this bit must be set/cleared explicitly.
537*b819cea2SGordon Ross  * That is, setting AT_ALL will NOT set AT_XVATTR.
538*b819cea2SGordon Ross  */
539*b819cea2SGordon Ross #define	AT_XVATTR	0x10000
540*b819cea2SGordon Ross 
541*b819cea2SGordon Ross #define	AT_ALL		(AT_TYPE|AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\
542*b819cea2SGordon Ross 			AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\
543*b819cea2SGordon Ross 			AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
544*b819cea2SGordon Ross 
545*b819cea2SGordon Ross #define	AT_STAT		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\
546*b819cea2SGordon Ross 			AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV|AT_TYPE)
547*b819cea2SGordon Ross 
548*b819cea2SGordon Ross #define	AT_TIMES	(AT_ATIME|AT_MTIME|AT_CTIME)
549*b819cea2SGordon Ross 
550*b819cea2SGordon Ross #define	AT_NOSET	(AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|AT_TYPE|\
551*b819cea2SGordon Ross 			AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
552*b819cea2SGordon Ross 
553*b819cea2SGordon Ross /*
554*b819cea2SGordon Ross  * Attribute bits used in the extensible attribute's (xva's) attribute
555*b819cea2SGordon Ross  * bitmaps.  Note that the bitmaps are made up of a variable length number
556*b819cea2SGordon Ross  * of 32-bit words.  The convention is to use XAT{n}_{attrname} where "n"
557*b819cea2SGordon Ross  * is the element in the bitmap (starting at 1).  This convention is for
558*b819cea2SGordon Ross  * the convenience of the maintainer to keep track of which element each
559*b819cea2SGordon Ross  * attribute belongs to.
560*b819cea2SGordon Ross  *
561*b819cea2SGordon Ross  * NOTE THAT CONSUMERS MUST *NOT* USE THE XATn_* DEFINES DIRECTLY.  CONSUMERS
562*b819cea2SGordon Ross  * MUST USE THE XAT_* DEFINES.
563*b819cea2SGordon Ross  */
564*b819cea2SGordon Ross #define	XAT0_INDEX	0LL		/* Index into bitmap for XAT0 attrs */
565*b819cea2SGordon Ross #define	XAT0_CREATETIME	0x00000001	/* Create time of file */
566*b819cea2SGordon Ross #define	XAT0_ARCHIVE	0x00000002	/* Archive */
567*b819cea2SGordon Ross #define	XAT0_SYSTEM	0x00000004	/* System */
568*b819cea2SGordon Ross #define	XAT0_READONLY	0x00000008	/* Readonly */
569*b819cea2SGordon Ross #define	XAT0_HIDDEN	0x00000010	/* Hidden */
570*b819cea2SGordon Ross #define	XAT0_NOUNLINK	0x00000020	/* Nounlink */
571*b819cea2SGordon Ross #define	XAT0_IMMUTABLE	0x00000040	/* immutable */
572*b819cea2SGordon Ross #define	XAT0_APPENDONLY	0x00000080	/* appendonly */
573*b819cea2SGordon Ross #define	XAT0_NODUMP	0x00000100	/* nodump */
574*b819cea2SGordon Ross #define	XAT0_OPAQUE	0x00000200	/* opaque */
575*b819cea2SGordon Ross #define	XAT0_AV_QUARANTINED	0x00000400	/* anti-virus quarantine */
576*b819cea2SGordon Ross #define	XAT0_AV_MODIFIED	0x00000800	/* anti-virus modified */
577*b819cea2SGordon Ross #define	XAT0_AV_SCANSTAMP	0x00001000	/* anti-virus scanstamp */
578*b819cea2SGordon Ross #define	XAT0_REPARSE	0x00002000	/* FS reparse point */
579*b819cea2SGordon Ross #define	XAT0_GEN	0x00004000	/* object generation number */
580*b819cea2SGordon Ross #define	XAT0_OFFLINE	0x00008000	/* offline */
581*b819cea2SGordon Ross #define	XAT0_SPARSE	0x00010000	/* sparse */
582*b819cea2SGordon Ross 
583*b819cea2SGordon Ross #define	XAT0_ALL_ATTRS	(XAT0_CREATETIME|XAT0_ARCHIVE|XAT0_SYSTEM| \
584*b819cea2SGordon Ross     XAT0_READONLY|XAT0_HIDDEN|XAT0_NOUNLINK|XAT0_IMMUTABLE|XAT0_APPENDONLY| \
585*b819cea2SGordon Ross     XAT0_NODUMP|XAT0_OPAQUE|XAT0_AV_QUARANTINED|  XAT0_AV_MODIFIED| \
586*b819cea2SGordon Ross     XAT0_AV_SCANSTAMP|XAT0_REPARSE|XATO_GEN|XAT0_OFFLINE|XAT0_SPARSE)
587*b819cea2SGordon Ross 
588*b819cea2SGordon Ross /* Support for XAT_* optional attributes */
589*b819cea2SGordon Ross #define	XVA_MASK		0xffffffff	/* Used to mask off 32 bits */
590*b819cea2SGordon Ross #define	XVA_SHFT		32		/* Used to shift index */
591*b819cea2SGordon Ross 
592*b819cea2SGordon Ross /*
593*b819cea2SGordon Ross  * Used to pry out the index and attribute bits from the XAT_* attributes
594*b819cea2SGordon Ross  * defined below.  Note that we're masking things down to 32 bits then
595*b819cea2SGordon Ross  * casting to uint32_t.
596*b819cea2SGordon Ross  */
597*b819cea2SGordon Ross #define	XVA_INDEX(attr)		((uint32_t)(((attr) >> XVA_SHFT) & XVA_MASK))
598*b819cea2SGordon Ross #define	XVA_ATTRBIT(attr)	((uint32_t)((attr) & XVA_MASK))
599*b819cea2SGordon Ross 
600*b819cea2SGordon Ross /*
601*b819cea2SGordon Ross  * The following defines present a "flat namespace" so that consumers don't
602*b819cea2SGordon Ross  * need to keep track of which element belongs to which bitmap entry.
603*b819cea2SGordon Ross  *
604*b819cea2SGordon Ross  * NOTE THAT THESE MUST NEVER BE OR-ed TOGETHER
605*b819cea2SGordon Ross  */
606*b819cea2SGordon Ross #define	XAT_CREATETIME		((XAT0_INDEX << XVA_SHFT) | XAT0_CREATETIME)
607*b819cea2SGordon Ross #define	XAT_ARCHIVE		((XAT0_INDEX << XVA_SHFT) | XAT0_ARCHIVE)
608*b819cea2SGordon Ross #define	XAT_SYSTEM		((XAT0_INDEX << XVA_SHFT) | XAT0_SYSTEM)
609*b819cea2SGordon Ross #define	XAT_READONLY		((XAT0_INDEX << XVA_SHFT) | XAT0_READONLY)
610*b819cea2SGordon Ross #define	XAT_HIDDEN		((XAT0_INDEX << XVA_SHFT) | XAT0_HIDDEN)
611*b819cea2SGordon Ross #define	XAT_NOUNLINK		((XAT0_INDEX << XVA_SHFT) | XAT0_NOUNLINK)
612*b819cea2SGordon Ross #define	XAT_IMMUTABLE		((XAT0_INDEX << XVA_SHFT) | XAT0_IMMUTABLE)
613*b819cea2SGordon Ross #define	XAT_APPENDONLY		((XAT0_INDEX << XVA_SHFT) | XAT0_APPENDONLY)
614*b819cea2SGordon Ross #define	XAT_NODUMP		((XAT0_INDEX << XVA_SHFT) | XAT0_NODUMP)
615*b819cea2SGordon Ross #define	XAT_OPAQUE		((XAT0_INDEX << XVA_SHFT) | XAT0_OPAQUE)
616*b819cea2SGordon Ross #define	XAT_AV_QUARANTINED	((XAT0_INDEX << XVA_SHFT) | XAT0_AV_QUARANTINED)
617*b819cea2SGordon Ross #define	XAT_AV_MODIFIED		((XAT0_INDEX << XVA_SHFT) | XAT0_AV_MODIFIED)
618*b819cea2SGordon Ross #define	XAT_AV_SCANSTAMP	((XAT0_INDEX << XVA_SHFT) | XAT0_AV_SCANSTAMP)
619*b819cea2SGordon Ross #define	XAT_REPARSE		((XAT0_INDEX << XVA_SHFT) | XAT0_REPARSE)
620*b819cea2SGordon Ross #define	XAT_GEN			((XAT0_INDEX << XVA_SHFT) | XAT0_GEN)
621*b819cea2SGordon Ross #define	XAT_OFFLINE		((XAT0_INDEX << XVA_SHFT) | XAT0_OFFLINE)
622*b819cea2SGordon Ross #define	XAT_SPARSE		((XAT0_INDEX << XVA_SHFT) | XAT0_SPARSE)
623*b819cea2SGordon Ross 
624*b819cea2SGordon Ross /*
625*b819cea2SGordon Ross  * The returned attribute map array (xva_rtnattrmap[]) is located past the
626*b819cea2SGordon Ross  * requested attribute map array (xva_reqattrmap[]).  Its location changes
627*b819cea2SGordon Ross  * when the array sizes change.  We use a separate pointer in a known location
628*b819cea2SGordon Ross  * (xva_rtnattrmapp) to hold the location of xva_rtnattrmap[].  This is
629*b819cea2SGordon Ross  * set in xva_init()
630*b819cea2SGordon Ross  */
631*b819cea2SGordon Ross #define	XVA_RTNATTRMAP(xvap)	((xvap)->xva_rtnattrmapp)
632*b819cea2SGordon Ross 
633*b819cea2SGordon Ross /*
634*b819cea2SGordon Ross  * XVA_SET_REQ() sets an attribute bit in the proper element in the bitmap
635*b819cea2SGordon Ross  * of requested attributes (xva_reqattrmap[]).
636*b819cea2SGordon Ross  */
637*b819cea2SGordon Ross #define	XVA_SET_REQ(xvap, attr)					\
638*b819cea2SGordon Ross 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
639*b819cea2SGordon Ross 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
640*b819cea2SGordon Ross 	(xvap)->xva_reqattrmap[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
641*b819cea2SGordon Ross /*
642*b819cea2SGordon Ross  * XVA_CLR_REQ() clears an attribute bit in the proper element in the bitmap
643*b819cea2SGordon Ross  * of requested attributes (xva_reqattrmap[]).
644*b819cea2SGordon Ross  */
645*b819cea2SGordon Ross #define	XVA_CLR_REQ(xvap, attr)					\
646*b819cea2SGordon Ross 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
647*b819cea2SGordon Ross 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
648*b819cea2SGordon Ross 	(xvap)->xva_reqattrmap[XVA_INDEX(attr)] &= ~XVA_ATTRBIT(attr)
649*b819cea2SGordon Ross 
650*b819cea2SGordon Ross /*
651*b819cea2SGordon Ross  * XVA_SET_RTN() sets an attribute bit in the proper element in the bitmap
652*b819cea2SGordon Ross  * of returned attributes (xva_rtnattrmap[]).
653*b819cea2SGordon Ross  */
654*b819cea2SGordon Ross #define	XVA_SET_RTN(xvap, attr)					\
655*b819cea2SGordon Ross 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
656*b819cea2SGordon Ross 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
657*b819cea2SGordon Ross 	(XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
658*b819cea2SGordon Ross 
659*b819cea2SGordon Ross /*
660*b819cea2SGordon Ross  * XVA_ISSET_REQ() checks the requested attribute bitmap (xva_reqattrmap[])
661*b819cea2SGordon Ross  * to see of the corresponding attribute bit is set.  If so, returns non-zero.
662*b819cea2SGordon Ross  */
663