xref: /illumos-gate/usr/src/uts/common/sys/vnode.h (revision 04909c8c)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
55a59a8b3Srsb  * Common Development and Distribution License (the "License").
65a59a8b3Srsb  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
21794f0adbSRoger A. Faulkner 
227c478bd9Sstevel@tonic-gate /*
23cb15d5d9SPeter Rival  * Copyright (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved.
24*04909c8cSJohn Levon  * Copyright (c) 2018, Joyent, Inc.
25ade42b55SSebastien Roy  * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
26f06dce2cSAndrew Stormont  * Copyright 2017 RackTop Systems.
277c478bd9Sstevel@tonic-gate  */
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
30b4203d75SMarcel Telka /*	  All Rights Reserved	*/
317c478bd9Sstevel@tonic-gate 
327c478bd9Sstevel@tonic-gate /*
337c478bd9Sstevel@tonic-gate  * University Copyright- Copyright (c) 1982, 1986, 1988
347c478bd9Sstevel@tonic-gate  * The Regents of the University of California
357c478bd9Sstevel@tonic-gate  * All Rights Reserved
367c478bd9Sstevel@tonic-gate  *
377c478bd9Sstevel@tonic-gate  * University Acknowledgment- Portions of this document are derived from
387c478bd9Sstevel@tonic-gate  * software developed by the University of California, Berkeley, and its
397c478bd9Sstevel@tonic-gate  * contributors.
407c478bd9Sstevel@tonic-gate  */
417c478bd9Sstevel@tonic-gate 
427c478bd9Sstevel@tonic-gate #ifndef _SYS_VNODE_H
437c478bd9Sstevel@tonic-gate #define	_SYS_VNODE_H
447c478bd9Sstevel@tonic-gate 
457c478bd9Sstevel@tonic-gate #include <sys/types.h>
467c478bd9Sstevel@tonic-gate #include <sys/t_lock.h>
477c478bd9Sstevel@tonic-gate #include <sys/rwstlock.h>
487c478bd9Sstevel@tonic-gate #include <sys/time_impl.h>
497c478bd9Sstevel@tonic-gate #include <sys/cred.h>
507c478bd9Sstevel@tonic-gate #include <sys/uio.h>
517c478bd9Sstevel@tonic-gate #include <sys/resource.h>
527c478bd9Sstevel@tonic-gate #include <vm/seg_enum.h>
535a59a8b3Srsb #include <sys/kstat.h>
545a59a8b3Srsb #include <sys/kmem.h>
551b300de9Sjwahlig #include <sys/list.h>
567c478bd9Sstevel@tonic-gate #ifdef	_KERNEL
577c478bd9Sstevel@tonic-gate #include <sys/buf.h>
58ade42b55SSebastien Roy #include <sys/sdt.h>
597c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
607c478bd9Sstevel@tonic-gate 
617c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
627c478bd9Sstevel@tonic-gate extern "C" {
637c478bd9Sstevel@tonic-gate #endif
647c478bd9Sstevel@tonic-gate 
655a59a8b3Srsb /*
665a59a8b3Srsb  * Statistics for all vnode operations.
675a59a8b3Srsb  * All operations record number of ops (since boot/mount/zero'ed).
685a59a8b3Srsb  * Certain I/O operations (read, write, readdir) also record number
695a59a8b3Srsb  * of bytes transferred.
705a59a8b3Srsb  * This appears in two places in the system: one is embedded in each
715a59a8b3Srsb  * vfs_t.  There is also an array of vopstats_t structures allocated
725a59a8b3Srsb  * on a per-fstype basis.
735a59a8b3Srsb  */
745a59a8b3Srsb 
755a59a8b3Srsb #define	VOPSTATS_STR	"vopstats_"	/* Initial string for vopstat kstats */
765a59a8b3Srsb 
775a59a8b3Srsb typedef struct vopstats {
785a59a8b3Srsb 	kstat_named_t	nopen;		/* VOP_OPEN */
795a59a8b3Srsb 	kstat_named_t	nclose;		/* VOP_CLOSE */
805a59a8b3Srsb 	kstat_named_t	nread;		/* VOP_READ */
815a59a8b3Srsb 	kstat_named_t	read_bytes;
825a59a8b3Srsb 	kstat_named_t	nwrite;		/* VOP_WRITE */
835a59a8b3Srsb 	kstat_named_t	write_bytes;
845a59a8b3Srsb 	kstat_named_t	nioctl;		/* VOP_IOCTL */
855a59a8b3Srsb 	kstat_named_t	nsetfl;		/* VOP_SETFL */
865a59a8b3Srsb 	kstat_named_t	ngetattr;	/* VOP_GETATTR */
875a59a8b3Srsb 	kstat_named_t	nsetattr;	/* VOP_SETATTR */
885a59a8b3Srsb 	kstat_named_t	naccess;	/* VOP_ACCESS */
895a59a8b3Srsb 	kstat_named_t	nlookup;	/* VOP_LOOKUP */
905a59a8b3Srsb 	kstat_named_t	ncreate;	/* VOP_CREATE */
915a59a8b3Srsb 	kstat_named_t	nremove;	/* VOP_REMOVE */
925a59a8b3Srsb 	kstat_named_t	nlink;		/* VOP_LINK */
935a59a8b3Srsb 	kstat_named_t	nrename;	/* VOP_RENAME */
945a59a8b3Srsb 	kstat_named_t	nmkdir;		/* VOP_MKDIR */
955a59a8b3Srsb 	kstat_named_t	nrmdir;		/* VOP_RMDIR */
965a59a8b3Srsb 	kstat_named_t	nreaddir;	/* VOP_READDIR */
975a59a8b3Srsb 	kstat_named_t	readdir_bytes;
985a59a8b3Srsb 	kstat_named_t	nsymlink;	/* VOP_SYMLINK */
995a59a8b3Srsb 	kstat_named_t	nreadlink;	/* VOP_READLINK */
1005a59a8b3Srsb 	kstat_named_t	nfsync;		/* VOP_FSYNC */
1015a59a8b3Srsb 	kstat_named_t	ninactive;	/* VOP_INACTIVE */
1025a59a8b3Srsb 	kstat_named_t	nfid;		/* VOP_FID */
1035a59a8b3Srsb 	kstat_named_t	nrwlock;	/* VOP_RWLOCK */
1045a59a8b3Srsb 	kstat_named_t	nrwunlock;	/* VOP_RWUNLOCK */
1055a59a8b3Srsb 	kstat_named_t	nseek;		/* VOP_SEEK */
1065a59a8b3Srsb 	kstat_named_t	ncmp;		/* VOP_CMP */
1075a59a8b3Srsb 	kstat_named_t	nfrlock;	/* VOP_FRLOCK */
1085a59a8b3Srsb 	kstat_named_t	nspace;		/* VOP_SPACE */
1095a59a8b3Srsb 	kstat_named_t	nrealvp;	/* VOP_REALVP */
1105a59a8b3Srsb 	kstat_named_t	ngetpage;	/* VOP_GETPAGE */
1115a59a8b3Srsb 	kstat_named_t	nputpage;	/* VOP_PUTPAGE */
1125a59a8b3Srsb 	kstat_named_t	nmap;		/* VOP_MAP */
1135a59a8b3Srsb 	kstat_named_t	naddmap;	/* VOP_ADDMAP */
1145a59a8b3Srsb 	kstat_named_t	ndelmap;	/* VOP_DELMAP */
1155a59a8b3Srsb 	kstat_named_t	npoll;		/* VOP_POLL */
1165a59a8b3Srsb 	kstat_named_t	ndump;		/* VOP_DUMP */
1175a59a8b3Srsb 	kstat_named_t	npathconf;	/* VOP_PATHCONF */
1185a59a8b3Srsb 	kstat_named_t	npageio;	/* VOP_PAGEIO */
1195a59a8b3Srsb 	kstat_named_t	ndumpctl;	/* VOP_DUMPCTL */
1205a59a8b3Srsb 	kstat_named_t	ndispose;	/* VOP_DISPOSE */
1215a59a8b3Srsb 	kstat_named_t	nsetsecattr;	/* VOP_SETSECATTR */
1225a59a8b3Srsb 	kstat_named_t	ngetsecattr;	/* VOP_GETSECATTR */
1235a59a8b3Srsb 	kstat_named_t	nshrlock;	/* VOP_SHRLOCK */
1245a59a8b3Srsb 	kstat_named_t	nvnevent;	/* VOP_VNEVENT */
125c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 	kstat_named_t	nreqzcbuf;	/* VOP_REQZCBUF */
126c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 	kstat_named_t	nretzcbuf;	/* VOP_RETZCBUF */
1275a59a8b3Srsb } vopstats_t;
1285a59a8b3Srsb 
1297c478bd9Sstevel@tonic-gate /*
1307c478bd9Sstevel@tonic-gate  * The vnode is the focus of all file activity in UNIX.
1317c478bd9Sstevel@tonic-gate  * A vnode is allocated for each active file, each current
1327c478bd9Sstevel@tonic-gate  * directory, each mounted-on file, and the root.
1337c478bd9Sstevel@tonic-gate  *
1347c478bd9Sstevel@tonic-gate  * Each vnode is usually associated with a file-system-specific node (for
1357c478bd9Sstevel@tonic-gate  * UFS, this is the in-memory inode).  Generally, a vnode and an fs-node
1367c478bd9Sstevel@tonic-gate  * should be created and destroyed together as a pair.
1377c478bd9Sstevel@tonic-gate  *
1387c478bd9Sstevel@tonic-gate  * If a vnode is reused for a new file, it should be reinitialized by calling
1397c478bd9Sstevel@tonic-gate  * either vn_reinit() or vn_recycle().
1407c478bd9Sstevel@tonic-gate  *
1417c478bd9Sstevel@tonic-gate  * vn_reinit() resets the entire vnode as if it was returned by vn_alloc().
1427c478bd9Sstevel@tonic-gate  * The caller is responsible for setting up the entire vnode after calling
1437c478bd9Sstevel@tonic-gate  * vn_reinit().  This is important when using kmem caching where the vnode is
1447c478bd9Sstevel@tonic-gate  * allocated by a constructor, for instance.
1457c478bd9Sstevel@tonic-gate  *
1467c478bd9Sstevel@tonic-gate  * vn_recycle() is used when the file system keeps some state around in both
1477c478bd9Sstevel@tonic-gate  * the vnode and the associated FS-node.  In UFS, for example, the inode of
1487c478bd9Sstevel@tonic-gate  * a deleted file can be reused immediately.  The v_data, v_vfsp, v_op, etc.
1497c478bd9Sstevel@tonic-gate  * remains the same but certain fields related to the previous instance need
1507c478bd9Sstevel@tonic-gate  * to be reset.  In particular:
1517c478bd9Sstevel@tonic-gate  *	v_femhead
1527c478bd9Sstevel@tonic-gate  *	v_path
1537c478bd9Sstevel@tonic-gate  *	v_rdcnt, v_wrcnt
1547c478bd9Sstevel@tonic-gate  *	v_mmap_read, v_mmap_write
1557c478bd9Sstevel@tonic-gate  */
1567c478bd9Sstevel@tonic-gate 
1577c478bd9Sstevel@tonic-gate /*
1587c478bd9Sstevel@tonic-gate  * vnode types.  VNON means no type.  These values are unrelated to
1597c478bd9Sstevel@tonic-gate  * values in on-disk inodes.
1607c478bd9Sstevel@tonic-gate  */
1617c478bd9Sstevel@tonic-gate typedef enum vtype {
1627c478bd9Sstevel@tonic-gate 	VNON	= 0,
1637c478bd9Sstevel@tonic-gate 	VREG	= 1,
1647c478bd9Sstevel@tonic-gate 	VDIR	= 2,
1657c478bd9Sstevel@tonic-gate 	VBLK	= 3,
1667c478bd9Sstevel@tonic-gate 	VCHR	= 4,
1677c478bd9Sstevel@tonic-gate 	VLNK	= 5,
1687c478bd9Sstevel@tonic-gate 	VFIFO	= 6,
1697c478bd9Sstevel@tonic-gate 	VDOOR	= 7,
1707c478bd9Sstevel@tonic-gate 	VPROC	= 8,
1717c478bd9Sstevel@tonic-gate 	VSOCK	= 9,
1727c478bd9Sstevel@tonic-gate 	VPORT	= 10,
1737c478bd9Sstevel@tonic-gate 	VBAD	= 11
1747c478bd9Sstevel@tonic-gate } vtype_t;
1757c478bd9Sstevel@tonic-gate 
1761b300de9Sjwahlig /*
1771b300de9Sjwahlig  * VSD - Vnode Specific Data
1781b300de9Sjwahlig  * Used to associate additional private data with a vnode.
1791b300de9Sjwahlig  */
1801b300de9Sjwahlig struct vsd_node {
1811b300de9Sjwahlig 	list_node_t vs_nodes;		/* list of all VSD nodes */
1821b300de9Sjwahlig 	uint_t vs_nkeys;		/* entries in value array */
1831b300de9Sjwahlig 	void **vs_value;		/* array of value/key */
1841b300de9Sjwahlig };
1851b300de9Sjwahlig 
1867c478bd9Sstevel@tonic-gate /*
1877c478bd9Sstevel@tonic-gate  * Many of the fields in the vnode are read-only once they are initialized
1887c478bd9Sstevel@tonic-gate  * at vnode creation time.  Other fields are protected by locks.
1897c478bd9Sstevel@tonic-gate  *
1907c478bd9Sstevel@tonic-gate  * IMPORTANT: vnodes should be created ONLY by calls to vn_alloc().  They
1917c478bd9Sstevel@tonic-gate  * may not be embedded into the file-system specific node (inode).  The
1927c478bd9Sstevel@tonic-gate  * size of vnodes may change.
1937c478bd9Sstevel@tonic-gate  *
1947c478bd9Sstevel@tonic-gate  * The v_lock protects:
1957c478bd9Sstevel@tonic-gate  *   v_flag
1967c478bd9Sstevel@tonic-gate  *   v_stream
1977c478bd9Sstevel@tonic-gate  *   v_count
1987c478bd9Sstevel@tonic-gate  *   v_shrlocks
1997c478bd9Sstevel@tonic-gate  *   v_path
2001b300de9Sjwahlig  *   v_vsd
201da6c28aaSamw  *   v_xattrdir
2027c478bd9Sstevel@tonic-gate  *
2037c478bd9Sstevel@tonic-gate  * A special lock (implemented by vn_vfswlock in vnode.c) protects:
2047c478bd9Sstevel@tonic-gate  *   v_vfsmountedhere
2057c478bd9Sstevel@tonic-gate  *
2067c478bd9Sstevel@tonic-gate  * The global flock_lock mutex (in flock.c) protects:
2077c478bd9Sstevel@tonic-gate  *   v_filocks
2087c478bd9Sstevel@tonic-gate  *
2097c478bd9Sstevel@tonic-gate  * IMPORTANT NOTE:
2107c478bd9Sstevel@tonic-gate  *
2117c478bd9Sstevel@tonic-gate  *   The following vnode fields are considered public and may safely be
2127c478bd9Sstevel@tonic-gate  *   accessed by file systems or other consumers:
2137c478bd9Sstevel@tonic-gate  *
2147c478bd9Sstevel@tonic-gate  *     v_lock
2157c478bd9Sstevel@tonic-gate  *     v_flag
2167c478bd9Sstevel@tonic-gate  *     v_count
2177c478bd9Sstevel@tonic-gate  *     v_data
2187c478bd9Sstevel@tonic-gate  *     v_vfsp
2197c478bd9Sstevel@tonic-gate  *     v_stream
2207c478bd9Sstevel@tonic-gate  *     v_type
2217c478bd9Sstevel@tonic-gate  *     v_rdev
2227c478bd9Sstevel@tonic-gate  *
2237c478bd9Sstevel@tonic-gate  * ALL OTHER FIELDS SHOULD BE ACCESSED ONLY BY THE OWNER OF THAT FIELD.
2247c478bd9Sstevel@tonic-gate  * In particular, file systems should not access other fields; they may
2257c478bd9Sstevel@tonic-gate  * change or even be removed.  The functionality which was once provided
2267c478bd9Sstevel@tonic-gate  * by these fields is available through vn_* functions.
227e2fc3408SPatrick Mooney  *
228e2fc3408SPatrick Mooney  * VNODE PATH THEORY:
229e2fc3408SPatrick Mooney  * In each vnode, the v_path field holds a cached version of the canonical
230e2fc3408SPatrick Mooney  * filesystem path which that node represents.  Because vnodes lack contextual
231e2fc3408SPatrick Mooney  * information about their own name or position in the VFS hierarchy, this path
232e2fc3408SPatrick Mooney  * must be calculated when the vnode is instantiated by operations such as
233e2fc3408SPatrick Mooney  * fop_create, fop_lookup, or fop_mkdir.  During said operations, both the
234e2fc3408SPatrick Mooney  * parent vnode (and its cached v_path) and future name are known, so the
235e2fc3408SPatrick Mooney  * v_path of the resulting object can easily be set.
236e2fc3408SPatrick Mooney  *
237e2fc3408SPatrick Mooney  * The caching nature of v_path is complicated in the face of directory
238e2fc3408SPatrick Mooney  * renames.  Filesystem drivers are responsible for calling vn_renamepath when
239e2fc3408SPatrick Mooney  * a fop_rename operation succeeds.  While the v_path on the renamed vnode will
240e2fc3408SPatrick Mooney  * be updated, existing children of the directory (direct, or at deeper levels)
241e2fc3408SPatrick Mooney  * will now possess v_path caches which are stale.
242e2fc3408SPatrick Mooney  *
243e2fc3408SPatrick Mooney  * It is expensive (and for non-directories, impossible) to recalculate stale
244e2fc3408SPatrick Mooney  * v_path entries during operations such as vnodetopath.  The best time during
245e2fc3408SPatrick Mooney  * which to correct such wrongs is the same as when v_path is first
246e2fc3408SPatrick Mooney  * initialized: during fop_create/fop_lookup/fop_mkdir/etc, where adequate
247e2fc3408SPatrick Mooney  * context is available to generate the current path.
248e2fc3408SPatrick Mooney  *
249e2fc3408SPatrick Mooney  * In order to quickly detect stale v_path entries (without full lookup
250e2fc3408SPatrick Mooney  * verification) to trigger a v_path update, the v_path_stamp field has been
251e2fc3408SPatrick Mooney  * added to vnode_t.  As part of successful fop_create/fop_lookup/fop_mkdir
252e2fc3408SPatrick Mooney  * operations, where the name and parent vnode are available, the following
253e2fc3408SPatrick Mooney  * rules are used to determine updates to the child:
254e2fc3408SPatrick Mooney  *
255e2fc3408SPatrick Mooney  * 1. If the parent lacks a v_path, clear any existing v_path and v_path_stamp
256e2fc3408SPatrick Mooney  *    on the child.  Until the parent v_path is refreshed to a valid state, the
257e2fc3408SPatrick Mooney  *    child v_path must be considered invalid too.
258e2fc3408SPatrick Mooney  *
259e2fc3408SPatrick Mooney  * 2. If the child lacks a v_path (implying v_path_stamp == 0), it inherits the
260e2fc3408SPatrick Mooney  *    v_path_stamp value from its parent and its v_path is updated.
261e2fc3408SPatrick Mooney  *
262e2fc3408SPatrick Mooney  * 3. If the child v_path_stamp is less than v_path_stamp in the parent, it is
263e2fc3408SPatrick Mooney  *    an indication that the child v_path is stale.  The v_path is updated and
264e2fc3408SPatrick Mooney  *    v_path_stamp in the child is set to the current hrtime().
265e2fc3408SPatrick Mooney  *
266e2fc3408SPatrick Mooney  *    It does _not_ inherit the parent v_path_stamp in order to propagate the
267e2fc3408SPatrick Mooney  *    the time of v_path invalidation through the directory structure.  This
268e2fc3408SPatrick Mooney  *    prevents concurrent invalidations (operating with a now-incorrect v_path)
269e2fc3408SPatrick Mooney  *    at deeper levels in the tree from persisting.
270e2fc3408SPatrick Mooney  *
271e2fc3408SPatrick Mooney  * 4. If the child v_path_stamp is greater or equal to the parent, no action
272e2fc3408SPatrick Mooney  *    needs to be taken.
273e2fc3408SPatrick Mooney  *
274e2fc3408SPatrick Mooney  * Note that fop_rename operations do not follow this ruleset.  They perform an
275e2fc3408SPatrick Mooney  * explicit update of v_path and v_path_stamp (setting it to the current time)
276e2fc3408SPatrick Mooney  *
277e2fc3408SPatrick Mooney  * With these constraints in place, v_path invalidations and updates should
278e2fc3408SPatrick Mooney  * proceed in a timely manner as vnodes are accessed.  While there still are
279e2fc3408SPatrick Mooney  * limited cases where vnodetopath operations will fail, the risk is minimized.
2807c478bd9Sstevel@tonic-gate  */
2817c478bd9Sstevel@tonic-gate 
2827c478bd9Sstevel@tonic-gate struct fem_head;	/* from fem.h */
2837c478bd9Sstevel@tonic-gate 
2847c478bd9Sstevel@tonic-gate typedef struct vnode {
2857c478bd9Sstevel@tonic-gate 	kmutex_t	v_lock;		/* protects vnode fields */
2867c478bd9Sstevel@tonic-gate 	uint_t		v_flag;		/* vnode flags (see below) */
2877c478bd9Sstevel@tonic-gate 	uint_t		v_count;	/* reference count */
2887c478bd9Sstevel@tonic-gate 	void		*v_data;	/* private data for fs */
2897c478bd9Sstevel@tonic-gate 	struct vfs	*v_vfsp;	/* ptr to containing VFS */
2907c478bd9Sstevel@tonic-gate 	struct stdata	*v_stream;	/* associated stream */
2917c478bd9Sstevel@tonic-gate 	enum vtype	v_type;		/* vnode type */
2927c478bd9Sstevel@tonic-gate 	dev_t		v_rdev;		/* device (VCHR, VBLK) */
2937c478bd9Sstevel@tonic-gate 
2947c478bd9Sstevel@tonic-gate 	/* PRIVATE FIELDS BELOW - DO NOT USE */
2957c478bd9Sstevel@tonic-gate 
2967c478bd9Sstevel@tonic-gate 	struct vfs	*v_vfsmountedhere; /* ptr to vfs mounted here */
2977c478bd9Sstevel@tonic-gate 	struct vnodeops	*v_op;		/* vnode operations */
2987c478bd9Sstevel@tonic-gate 	struct page	*v_pages;	/* vnode pages list */
2997c478bd9Sstevel@tonic-gate 	struct filock	*v_filocks;	/* ptr to filock list */
3007c478bd9Sstevel@tonic-gate 	struct shrlocklist *v_shrlocks;	/* ptr to shrlock list */
3017c478bd9Sstevel@tonic-gate 	krwlock_t	v_nbllock;	/* sync for NBMAND locks */
3027c478bd9Sstevel@tonic-gate 	kcondvar_t	v_cv;		/* synchronize locking */
3037c478bd9Sstevel@tonic-gate 	void		*v_locality;	/* hook for locality info */
3047c478bd9Sstevel@tonic-gate 	struct fem_head	*v_femhead;	/* fs monitoring */
3057c478bd9Sstevel@tonic-gate 	char		*v_path;	/* cached path */
306e2fc3408SPatrick Mooney 	hrtime_t	v_path_stamp;	/* timestamp for cached path */
3077c478bd9Sstevel@tonic-gate 	uint_t		v_rdcnt;	/* open for read count  (VREG only) */
3087c478bd9Sstevel@tonic-gate 	uint_t		v_wrcnt;	/* open for write count (VREG only) */
3097c478bd9Sstevel@tonic-gate 	u_longlong_t	v_mmap_read;	/* mmap read count */
3107c478bd9Sstevel@tonic-gate 	u_longlong_t	v_mmap_write;	/* mmap write count */
3117c478bd9Sstevel@tonic-gate 	void		*v_mpssdata;	/* info for large page mappings */
312df2381bfSpraks 	void		*v_fopdata;	/* list of file ops event watches */
313d216dff5SRobert Mastors 	kmutex_t	v_vsd_lock;	/* protects v_vsd field */
3141b300de9Sjwahlig 	struct vsd_node *v_vsd;		/* vnode specific data */
315da6c28aaSamw 	struct vnode	*v_xattrdir;	/* unnamed extended attr dir (GFS) */
316b5fca8f8Stomee 	uint_t		v_count_dnlc;	/* dnlc reference count */
3177c478bd9Sstevel@tonic-gate } vnode_t;
3187c478bd9Sstevel@tonic-gate 
3197c478bd9Sstevel@tonic-gate #define	IS_DEVVP(vp)	\
3207c478bd9Sstevel@tonic-gate 	((vp)->v_type == VCHR || (vp)->v_type == VBLK || (vp)->v_type == VFIFO)
3217c478bd9Sstevel@tonic-gate 
322cb15d5d9SPeter Rival #define	VNODE_ALIGN	64
323cb15d5d9SPeter Rival /* Count of low-order 0 bits in a vnode *, based on size and alignment. */
3241ab248cfSPeter Rival #if defined(_LP64)
325cb15d5d9SPeter Rival #define	VNODE_ALIGN_LOG2	8
3261ab248cfSPeter Rival #else
3271ab248cfSPeter Rival #define	VNODE_ALIGN_LOG2	7
3281ab248cfSPeter Rival #endif
329cb15d5d9SPeter Rival 
3307c478bd9Sstevel@tonic-gate /*
3317c478bd9Sstevel@tonic-gate  * vnode flags.
3327c478bd9Sstevel@tonic-gate  */
3337c478bd9Sstevel@tonic-gate #define	VROOT		0x01	/* root of its file system */
3347c478bd9Sstevel@tonic-gate #define	VNOCACHE	0x02	/* don't keep cache pages on vnode */
3357c478bd9Sstevel@tonic-gate #define	VNOMAP		0x04	/* file cannot be mapped/faulted */
3367c478bd9Sstevel@tonic-gate #define	VDUP		0x08	/* file should be dup'ed rather then opened */
3377c478bd9Sstevel@tonic-gate #define	VNOSWAP		0x10	/* file cannot be used as virtual swap device */
3387c478bd9Sstevel@tonic-gate #define	VNOMOUNT	0x20	/* file cannot be covered by mount */
3397c478bd9Sstevel@tonic-gate #define	VISSWAP		0x40	/* vnode is being used for swap */
3407c478bd9Sstevel@tonic-gate #define	VSWAPLIKE	0x80	/* vnode acts like swap (but may not be) */
3417c478bd9Sstevel@tonic-gate 
3427c478bd9Sstevel@tonic-gate #define	IS_SWAPVP(vp)	(((vp)->v_flag & (VISSWAP | VSWAPLIKE)) != 0)
3437c478bd9Sstevel@tonic-gate 
344f06dce2cSAndrew Stormont #ifdef _KERNEL
3457c478bd9Sstevel@tonic-gate typedef struct vn_vfslocks_entry {
3467c478bd9Sstevel@tonic-gate 	rwstlock_t ve_lock;
3477c478bd9Sstevel@tonic-gate 	void *ve_vpvfs;
3487c478bd9Sstevel@tonic-gate 	struct vn_vfslocks_entry *ve_next;
3497c478bd9Sstevel@tonic-gate 	uint32_t ve_refcnt;
3507c478bd9Sstevel@tonic-gate 	char pad[64 - sizeof (rwstlock_t) - 2 * sizeof (void *) - \
3517c478bd9Sstevel@tonic-gate 	    sizeof (uint32_t)];
3527c478bd9Sstevel@tonic-gate } vn_vfslocks_entry_t;
353f06dce2cSAndrew Stormont #endif
3547c478bd9Sstevel@tonic-gate 
3557c478bd9Sstevel@tonic-gate /*
3567c478bd9Sstevel@tonic-gate  * The following two flags are used to lock the v_vfsmountedhere field
3577c478bd9Sstevel@tonic-gate  */
3587c478bd9Sstevel@tonic-gate #define	VVFSLOCK	0x100
3597c478bd9Sstevel@tonic-gate #define	VVFSWAIT	0x200
3607c478bd9Sstevel@tonic-gate 
3617c478bd9Sstevel@tonic-gate /*
3627c478bd9Sstevel@tonic-gate  * Used to serialize VM operations on a vnode
3637c478bd9Sstevel@tonic-gate  */
3647c478bd9Sstevel@tonic-gate #define	VVMLOCK		0x400
3657c478bd9Sstevel@tonic-gate 
3667c478bd9Sstevel@tonic-gate /*
3677c478bd9Sstevel@tonic-gate  * Tell vn_open() not to fail a directory open for writing but
3687c478bd9Sstevel@tonic-gate  * to go ahead and call VOP_OPEN() to let the filesystem check.
3697c478bd9Sstevel@tonic-gate  */
3707c478bd9Sstevel@tonic-gate #define	VDIROPEN	0x800
3717c478bd9Sstevel@tonic-gate 
3727c478bd9Sstevel@tonic-gate /*
3737c478bd9Sstevel@tonic-gate  * Flag to let the VM system know that this file is most likely a binary
3747c478bd9Sstevel@tonic-gate  * or shared library since it has been mmap()ed EXEC at some time.
3757c478bd9Sstevel@tonic-gate  */
3767c478bd9Sstevel@tonic-gate #define	VVMEXEC		0x1000
3777c478bd9Sstevel@tonic-gate 
3787c478bd9Sstevel@tonic-gate #define	VPXFS		0x2000  /* clustering: global fs proxy vnode */
3797c478bd9Sstevel@tonic-gate 
3807c478bd9Sstevel@tonic-gate #define	IS_PXFSVP(vp)	((vp)->v_flag & VPXFS)
3817c478bd9Sstevel@tonic-gate 
3827c478bd9Sstevel@tonic-gate #define	V_XATTRDIR	0x4000	/* attribute unnamed directory */
3837c478bd9Sstevel@tonic-gate 
384ab04eb8eStimh #define	IS_XATTRDIR(vp)	((vp)->v_flag & V_XATTRDIR)
385ab04eb8eStimh 
3867c478bd9Sstevel@tonic-gate #define	V_LOCALITY	0x8000	/* whether locality aware */
3877c478bd9Sstevel@tonic-gate 
3887c478bd9Sstevel@tonic-gate /*
3897c478bd9Sstevel@tonic-gate  * Flag that indicates the VM should maintain the v_pages list with all modified
3907c478bd9Sstevel@tonic-gate  * pages on one end and unmodified pages at the other. This makes finding dirty
3917c478bd9Sstevel@tonic-gate  * pages to write back to disk much faster at the expense of taking a minor
3927c478bd9Sstevel@tonic-gate  * fault on the first store instruction which touches a writable page.
3937c478bd9Sstevel@tonic-gate  */
3947c478bd9Sstevel@tonic-gate #define	VMODSORT	(0x10000)
3957c478bd9Sstevel@tonic-gate #define	IS_VMODSORT(vp) \
3967c478bd9Sstevel@tonic-gate 	(pvn_vmodsort_supported != 0 && ((vp)->v_flag  & VMODSORT) != 0)
3977c478bd9Sstevel@tonic-gate 
3987c478bd9Sstevel@tonic-gate #define	VISSWAPFS	0x20000	/* vnode is being used for swapfs */
399d20abfaaSPavel Tatashin 
400d20abfaaSPavel Tatashin /*
401d20abfaaSPavel Tatashin  * The mdb memstat command assumes that IS_SWAPFSVP only uses the
402d20abfaaSPavel Tatashin  * vnode's v_flag field.  If this changes, cache the additional
403d20abfaaSPavel Tatashin  * fields in mdb; see vn_get in mdb/common/modules/genunix/memory.c
404d20abfaaSPavel Tatashin  */
4057c478bd9Sstevel@tonic-gate #define	IS_SWAPFSVP(vp)	(((vp)->v_flag & VISSWAPFS) != 0)
4067c478bd9Sstevel@tonic-gate 
407da6c28aaSamw #define	V_SYSATTR	0x40000	/* vnode is a GFS system attribute */
408da6c28aaSamw 
409e2fc3408SPatrick Mooney /*
410e2fc3408SPatrick Mooney  * Indication that VOP_LOOKUP operations on this vnode may yield results from a
411e2fc3408SPatrick Mooney  * different VFS instance.  The main use of this is to suppress v_path
412e2fc3408SPatrick Mooney  * calculation logic when filesystems such as procfs emit results which defy
413e2fc3408SPatrick Mooney  * expectations about normal VFS behavior.
414e2fc3408SPatrick Mooney  */
415e2fc3408SPatrick Mooney #define	VTRAVERSE	0x80000
416e2fc3408SPatrick Mooney 
4177c478bd9Sstevel@tonic-gate /*
4187c478bd9Sstevel@tonic-gate  * Vnode attributes.  A bit-mask is supplied as part of the
4197c478bd9Sstevel@tonic-gate  * structure to indicate the attributes the caller wants to
4207c478bd9Sstevel@tonic-gate  * set (setattr) or extract (getattr).
4217c478bd9Sstevel@tonic-gate  */
4227c478bd9Sstevel@tonic-gate 
4237c478bd9Sstevel@tonic-gate /*
4247c478bd9Sstevel@tonic-gate  * Note that va_nodeid and va_nblocks are 64bit data type.
4257c478bd9Sstevel@tonic-gate  * We support large files over NFSV3. With Solaris client and
4267c478bd9Sstevel@tonic-gate  * Server that generates 64bit ino's and sizes these fields
4277c478bd9Sstevel@tonic-gate  * will overflow if they are 32 bit sizes.
4287c478bd9Sstevel@tonic-gate  */
4297c478bd9Sstevel@tonic-gate 
4307c478bd9Sstevel@tonic-gate typedef struct vattr {
4317c478bd9Sstevel@tonic-gate 	uint_t		va_mask;	/* bit-mask of attributes */
4327c478bd9Sstevel@tonic-gate 	vtype_t		va_type;	/* vnode type (for create) */
4337c478bd9Sstevel@tonic-gate 	mode_t		va_mode;	/* file access mode */
4347c478bd9Sstevel@tonic-gate 	uid_t		va_uid;		/* owner user id */
4357c478bd9Sstevel@tonic-gate 	gid_t		va_gid;		/* owner group id */
4367c478bd9Sstevel@tonic-gate 	dev_t		va_fsid;	/* file system id (dev for now) */
4377c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nodeid;	/* node id */
4387c478bd9Sstevel@tonic-gate 	nlink_t		va_nlink;	/* number of references to file */
4397c478bd9Sstevel@tonic-gate 	u_offset_t	va_size;	/* file size in bytes */
4407c478bd9Sstevel@tonic-gate 	timestruc_t	va_atime;	/* time of last access */
4417c478bd9Sstevel@tonic-gate 	timestruc_t	va_mtime;	/* time of last modification */
4427c478bd9Sstevel@tonic-gate 	timestruc_t	va_ctime;	/* time of last status change */
4437c478bd9Sstevel@tonic-gate 	dev_t		va_rdev;	/* device the file represents */
4447c478bd9Sstevel@tonic-gate 	uint_t		va_blksize;	/* fundamental block size */
4457c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nblocks;	/* # of blocks allocated */
4467c478bd9Sstevel@tonic-gate 	uint_t		va_seq;		/* sequence number */
4477c478bd9Sstevel@tonic-gate } vattr_t;
4487c478bd9Sstevel@tonic-gate 
449da6c28aaSamw #define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */
450da6c28aaSamw 
451da6c28aaSamw /*
452da6c28aaSamw  * Structure of all optional attributes.
453da6c28aaSamw  */
454da6c28aaSamw typedef struct xoptattr {
455da6c28aaSamw 	timestruc_t	xoa_createtime;	/* Create time of file */
456da6c28aaSamw 	uint8_t		xoa_archive;
457da6c28aaSamw 	uint8_t		xoa_system;
458da6c28aaSamw 	uint8_t		xoa_readonly;
459da6c28aaSamw 	uint8_t		xoa_hidden;
460da6c28aaSamw 	uint8_t		xoa_nounlink;
461da6c28aaSamw 	uint8_t		xoa_immutable;
462da6c28aaSamw 	uint8_t		xoa_appendonly;
463da6c28aaSamw 	uint8_t		xoa_nodump;
464da6c28aaSamw 	uint8_t		xoa_opaque;
465da6c28aaSamw 	uint8_t		xoa_av_quarantined;
466da6c28aaSamw 	uint8_t		xoa_av_modified;
467da6c28aaSamw 	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
4687a286c47SDai Ngo 	uint8_t		xoa_reparse;
46999d5e173STim Haley 	uint64_t	xoa_generation;
470fd9ee8b5Sjoyce mcintosh 	uint8_t		xoa_offline;
471fd9ee8b5Sjoyce mcintosh 	uint8_t		xoa_sparse;
472f67950b2SNasf-Fan 	uint8_t		xoa_projinherit;
473f67950b2SNasf-Fan 	uint64_t	xoa_projid;
474da6c28aaSamw } xoptattr_t;
475da6c28aaSamw 
476da6c28aaSamw /*
477da6c28aaSamw  * The xvattr structure is really a variable length structure that
478da6c28aaSamw  * is made up of:
479da6c28aaSamw  * - The classic vattr_t (xva_vattr)
480da6c28aaSamw  * - a 32 bit quantity (xva_mapsize) that specifies the size of the
481da6c28aaSamw  *   attribute bitmaps in 32 bit words.
482da6c28aaSamw  * - A pointer to the returned attribute bitmap (needed because the
483da6c28aaSamw  *   previous element, the requested attribute bitmap) is variable lenth.
484da6c28aaSamw  * - The requested attribute bitmap, which is an array of 32 bit words.
485da6c28aaSamw  *   Callers use the XVA_SET_REQ() macro to set the bits corresponding to
486da6c28aaSamw  *   the attributes that are being requested.
487da6c28aaSamw  * - The returned attribute bitmap, which is an array of 32 bit words.
488da6c28aaSamw  *   File systems that support optional attributes use the XVA_SET_RTN()
489da6c28aaSamw  *   macro to set the bits corresponding to the attributes that are being
490da6c28aaSamw  *   returned.
491da6c28aaSamw  * - The xoptattr_t structure which contains the attribute values
492da6c28aaSamw  *
493da6c28aaSamw  * xva_mapsize determines how many words in the attribute bitmaps.
494da6c28aaSamw  * Immediately following the attribute bitmaps is the xoptattr_t.
495da6c28aaSamw  * xva_getxoptattr() is used to get the pointer to the xoptattr_t
496da6c28aaSamw  * section.
497da6c28aaSamw  */
498da6c28aaSamw 
499da6c28aaSamw #define	XVA_MAPSIZE	3		/* Size of attr bitmaps */
500da6c28aaSamw #define	XVA_MAGIC	0x78766174	/* Magic # for verification */
501da6c28aaSamw 
502da6c28aaSamw /*
503da6c28aaSamw  * The xvattr structure is an extensible structure which permits optional
504da6c28aaSamw  * attributes to be requested/returned.  File systems may or may not support
505da6c28aaSamw  * optional attributes.  They do so at their own discretion but if they do
506da6c28aaSamw  * support optional attributes, they must register the VFSFT_XVATTR feature
507da6c28aaSamw  * so that the optional attributes can be set/retrived.
508da6c28aaSamw  *
509da6c28aaSamw  * The fields of the xvattr structure are:
510da6c28aaSamw  *
511da6c28aaSamw  * xva_vattr - The first element of an xvattr is a legacy vattr structure
512da6c28aaSamw  * which includes the common attributes.  If AT_XVATTR is set in the va_mask
513da6c28aaSamw  * then the entire structure is treated as an xvattr.  If AT_XVATTR is not
514da6c28aaSamw  * set, then only the xva_vattr structure can be used.
515da6c28aaSamw  *
516da6c28aaSamw  * xva_magic - 0x78766174 (hex for "xvat"). Magic number for verification.
517da6c28aaSamw  *
518da6c28aaSamw  * xva_mapsize - Size of requested and returned attribute bitmaps.
519da6c28aaSamw  *
520da6c28aaSamw  * xva_rtnattrmapp - Pointer to xva_rtnattrmap[].  We need this since the
521da6c28aaSamw  * size of the array before it, xva_reqattrmap[], could change which means
522da6c28aaSamw  * the location of xva_rtnattrmap[] could change.  This will allow unbundled
523da6c28aaSamw  * file systems to find the location of xva_rtnattrmap[] when the sizes change.
524da6c28aaSamw  *
525da6c28aaSamw  * xva_reqattrmap[] - Array of requested attributes.  Attributes are
526da6c28aaSamw  * represented by a specific bit in a specific element of the attribute
527da6c28aaSamw  * map array.  Callers set the bits corresponding to the attributes
528da6c28aaSamw  * that the caller wants to get/set.
529da6c28aaSamw  *
530da6c28aaSamw  * xva_rtnattrmap[] - Array of attributes that the file system was able to
531da6c28aaSamw  * process.  Not all file systems support all optional attributes.  This map
532da6c28aaSamw  * informs the caller which attributes the underlying file system was able
533da6c28aaSamw  * to set/get.  (Same structure as the requested attributes array in terms
534da6c28aaSamw  * of each attribute  corresponding to specific bits and array elements.)
535da6c28aaSamw  *
536da6c28aaSamw  * xva_xoptattrs - Structure containing values of optional attributes.
537da6c28aaSamw  * These values are only valid if the corresponding bits in xva_reqattrmap
538da6c28aaSamw  * are set and the underlying file system supports those attributes.
539da6c28aaSamw  */
540da6c28aaSamw typedef struct xvattr {
541da6c28aaSamw 	vattr_t		xva_vattr;	/* Embedded vattr structure */
542da6c28aaSamw 	uint32_t	xva_magic;	/* Magic Number */
543da6c28aaSamw 	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
544da6c28aaSamw 	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
545da6c28aaSamw 	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
546da6c28aaSamw 	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
547da6c28aaSamw 	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
548da6c28aaSamw } xvattr_t;
549da6c28aaSamw 
5507c478bd9Sstevel@tonic-gate #ifdef _SYSCALL32
5517c478bd9Sstevel@tonic-gate /*
5527c478bd9Sstevel@tonic-gate  * For bigtypes time_t changed to 64 bit on the 64-bit kernel.
5537c478bd9Sstevel@tonic-gate  * Define an old version for user/kernel interface
5547c478bd9Sstevel@tonic-gate  */
5557c478bd9Sstevel@tonic-gate 
5567c478bd9Sstevel@tonic-gate #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
5577c478bd9Sstevel@tonic-gate #pragma pack(4)
5587c478bd9Sstevel@tonic-gate #endif
5597c478bd9Sstevel@tonic-gate 
5607c478bd9Sstevel@tonic-gate typedef struct vattr32 {
5617c478bd9Sstevel@tonic-gate 	uint32_t	va_mask;	/* bit-mask of attributes */
5627c478bd9Sstevel@tonic-gate 	vtype_t		va_type;	/* vnode type (for create) */
5637c478bd9Sstevel@tonic-gate 	mode32_t	va_mode;	/* file access mode */
5647c478bd9Sstevel@tonic-gate 	uid32_t		va_uid;		/* owner user id */
5657c478bd9Sstevel@tonic-gate 	gid32_t		va_gid;		/* owner group id */
5667c478bd9Sstevel@tonic-gate 	dev32_t		va_fsid;	/* file system id (dev for now) */
5677c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nodeid;	/* node id */
5687c478bd9Sstevel@tonic-gate 	nlink_t		va_nlink;	/* number of references to file */
5697c478bd9Sstevel@tonic-gate 	u_offset_t	va_size;	/* file size in bytes */
5707c478bd9Sstevel@tonic-gate 	timestruc32_t	va_atime;	/* time of last access */
5717c478bd9Sstevel@tonic-gate 	timestruc32_t	va_mtime;	/* time of last modification */
5727c478bd9Sstevel@tonic-gate 	timestruc32_t	va_ctime;	/* time of last status change */
5737c478bd9Sstevel@tonic-gate 	dev32_t		va_rdev;	/* device the file represents */
5747c478bd9Sstevel@tonic-gate 	uint32_t	va_blksize;	/* fundamental block size */
5757c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nblocks;	/* # of blocks allocated */
5767c478bd9Sstevel@tonic-gate 	uint32_t	va_seq;		/* sequence number */
5777c478bd9Sstevel@tonic-gate } vattr32_t;
5787c478bd9Sstevel@tonic-gate 
5797c478bd9Sstevel@tonic-gate #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
5807c478bd9Sstevel@tonic-gate #pragma pack()
5817c478bd9Sstevel@tonic-gate #endif
5827c478bd9Sstevel@tonic-gate 
5837c478bd9Sstevel@tonic-gate #else  /* not _SYSCALL32 */
5847c478bd9Sstevel@tonic-gate #define	vattr32		vattr
5857c478bd9Sstevel@tonic-gate typedef vattr_t		vattr32_t;
5867c478bd9Sstevel@tonic-gate #endif /* _SYSCALL32 */
5877c478bd9Sstevel@tonic-gate 
5887c478bd9Sstevel@tonic-gate /*
5897c478bd9Sstevel@tonic-gate  * Attributes of interest to the caller of setattr or getattr.
5907c478bd9Sstevel@tonic-gate  */
591da6c28aaSamw #define	AT_TYPE		0x00001
592da6c28aaSamw #define	AT_MODE		0x00002
593da6c28aaSamw #define	AT_UID		0x00004
594da6c28aaSamw #define	AT_GID		0x00008
595da6c28aaSamw #define	AT_FSID		0x00010
596da6c28aaSamw #define	AT_NODEID	0x00020
597da6c28aaSamw #define	AT_NLINK	0x00040
598da6c28aaSamw #define	AT_SIZE		0x00080
599da6c28aaSamw #define	AT_ATIME	0x00100
600da6c28aaSamw #define	AT_MTIME	0x00200
601da6c28aaSamw #define	AT_CTIME	0x00400
602da6c28aaSamw #define	AT_RDEV		0x00800
603da6c28aaSamw #define	AT_BLKSIZE	0x01000
604da6c28aaSamw #define	AT_NBLOCKS	0x02000
605da6c28aaSamw /*			0x04000 */	/* unused */
606da6c28aaSamw #define	AT_SEQ		0x08000
607da6c28aaSamw /*
608da6c28aaSamw  * If AT_XVATTR is set then there are additional bits to process in
609da6c28aaSamw  * the xvattr_t's attribute bitmap.  If this is not set then the bitmap
610da6c28aaSamw  * MUST be ignored.  Note that this bit must be set/cleared explicitly.
611da6c28aaSamw  * That is, setting AT_ALL will NOT set AT_XVATTR.
612da6c28aaSamw  */
613da6c28aaSamw #define	AT_XVATTR	0x10000
6147c478bd9Sstevel@tonic-gate 
6157c478bd9Sstevel@tonic-gate #define	AT_ALL		(AT_TYPE|AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\
6167c478bd9Sstevel@tonic-gate 			AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\
6177c478bd9Sstevel@tonic-gate 			AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
6187c478bd9Sstevel@tonic-gate 
6197c478bd9Sstevel@tonic-gate #define	AT_STAT		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\
6207c478bd9Sstevel@tonic-gate 			AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV|AT_TYPE)
6217c478bd9Sstevel@tonic-gate 
6227c478bd9Sstevel@tonic-gate #define	AT_TIMES	(AT_ATIME|AT_MTIME|AT_CTIME)
6237c478bd9Sstevel@tonic-gate 
6247c478bd9Sstevel@tonic-gate #define	AT_NOSET	(AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|AT_TYPE|\
6257c478bd9Sstevel@tonic-gate 			AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
6267c478bd9Sstevel@tonic-gate 
627da6c28aaSamw /*
628da6c28aaSamw  * Attribute bits used in the extensible attribute's (xva's) attribute
629da6c28aaSamw  * bitmaps.  Note that the bitmaps are made up of a variable length number
630da6c28aaSamw  * of 32-bit words.  The convention is to use XAT{n}_{attrname} where "n"
631da6c28aaSamw  * is the element in the bitmap (starting at 1).  This convention is for
632da6c28aaSamw  * the convenience of the maintainer to keep track of which element each
633da6c28aaSamw  * attribute belongs to.
634da6c28aaSamw  *
635da6c28aaSamw  * NOTE THAT CONSUMERS MUST *NOT* USE THE XATn_* DEFINES DIRECTLY.  CONSUMERS
636da6c28aaSamw  * MUST USE THE XAT_* DEFINES.
637da6c28aaSamw  */
638da6c28aaSamw #define	XAT0_INDEX	0LL		/* Index into bitmap for XAT0 attrs */
639da6c28aaSamw #define	XAT0_CREATETIME	0x00000001	/* Create time of file */
640da6c28aaSamw #define	XAT0_ARCHIVE	0x00000002	/* Archive */
641da6c28aaSamw #define	XAT0_SYSTEM	0x00000004	/* System */
642da6c28aaSamw #define	XAT0_READONLY	0x00000008	/* Readonly */
643da6c28aaSamw #define	XAT0_HIDDEN	0x00000010	/* Hidden */
644da6c28aaSamw #define	XAT0_NOUNLINK	0x00000020	/* Nounlink */
645da6c28aaSamw #define	XAT0_IMMUTABLE	0x00000040	/* immutable */
646da6c28aaSamw #define	XAT0_APPENDONLY	0x00000080	/* appendonly */
647da6c28aaSamw #define	XAT0_NODUMP	0x00000100	/* nodump */
648da6c28aaSamw #define	XAT0_OPAQUE	0x00000200	/* opaque */
649da6c28aaSamw #define	XAT0_AV_QUARANTINED	0x00000400	/* anti-virus quarantine */
650da6c28aaSamw #define	XAT0_AV_MODIFIED	0x00000800	/* anti-virus modified */
651da6c28aaSamw #define	XAT0_AV_SCANSTAMP	0x00001000	/* anti-virus scanstamp */
6527a286c47SDai Ngo #define	XAT0_REPARSE	0x00002000	/* FS reparse point */
65399d5e173STim Haley #define	XAT0_GEN	0x00004000	/* object generation number */
654fd9ee8b5Sjoyce mcintosh #define	XAT0_OFFLINE	0x00008000	/* offline */
655fd9ee8b5Sjoyce mcintosh #define	XAT0_SPARSE	0x00010000	/* sparse */
656f67950b2SNasf-Fan #define	XAT0_PROJINHERIT	0x00020000	/* Create with parent projid */
657f67950b2SNasf-Fan #define	XAT0_PROJID	0x00040000	/* Project ID */
658da6c28aaSamw 
659da6c28aaSamw #define	XAT0_ALL_ATTRS	(XAT0_CREATETIME|XAT0_ARCHIVE|XAT0_SYSTEM| \
660da6c28aaSamw     XAT0_READONLY|XAT0_HIDDEN|XAT0_NOUNLINK|XAT0_IMMUTABLE|XAT0_APPENDONLY| \
661fd9ee8b5Sjoyce mcintosh     XAT0_NODUMP|XAT0_OPAQUE|XAT0_AV_QUARANTINED|  XAT0_AV_MODIFIED| \
662f67950b2SNasf-Fan     XAT0_AV_SCANSTAMP|XAT0_REPARSE|XATO_GEN|XAT0_OFFLINE|XAT0_SPARSE| \
663f67950b2SNasf-Fan     XAT0_PROJINHERIT | XAT0_PROJID)
664da6c28aaSamw 
665da6c28aaSamw /* Support for XAT_* optional attributes */
666da6c28aaSamw #define	XVA_MASK		0xffffffff	/* Used to mask off 32 bits */
667da6c28aaSamw #define	XVA_SHFT		32		/* Used to shift index */
668da6c28aaSamw 
669da6c28aaSamw /*
670da6c28aaSamw  * Used to pry out the index and attribute bits from the XAT_* attributes
671da6c28aaSamw  * defined below.  Note that we're masking things down to 32 bits then
672da6c28aaSamw  * casting to uint32_t.
673da6c28aaSamw  */
674da6c28aaSamw #define	XVA_INDEX(attr)		((uint32_t)(((attr) >> XVA_SHFT) & XVA_MASK))
675da6c28aaSamw #define	XVA_ATTRBIT(attr)	((uint32_t)((attr) & XVA_MASK))
676da6c28aaSamw 
677da6c28aaSamw /*
678da6c28aaSamw  * The following defines present a "flat namespace" so that consumers don't
679da6c28aaSamw  * need to keep track of which element belongs to which bitmap entry.
680da6c28aaSamw  *
681da6c28aaSamw  * NOTE THAT THESE MUST NEVER BE OR-ed TOGETHER
682da6c28aaSamw  */
683da6c28aaSamw #define	XAT_CREATETIME		((XAT0_INDEX << XVA_SHFT) | XAT0_CREATETIME)
684da6c28aaSamw #define	XAT_ARCHIVE		((XAT0_INDEX << XVA_SHFT) | XAT0_ARCHIVE)
685da6c28aaSamw #define	XAT_SYSTEM		((XAT0_INDEX << XVA_SHFT) | XAT0_SYSTEM)
686da6c28aaSamw #define	XAT_READONLY		((XAT0_INDEX << XVA_SHFT) | XAT0_READONLY)
687da6c28aaSamw #define	XAT_HIDDEN		((XAT0_INDEX << XVA_SHFT) | XAT0_HIDDEN)
688da6c28aaSamw #define	XAT_NOUNLINK		((XAT0_INDEX << XVA_SHFT) | XAT0_NOUNLINK)
689da6c28aaSamw #define	XAT_IMMUTABLE		((XAT0_INDEX << XVA_SHFT) | XAT0_IMMUTABLE)
690da6c28aaSamw #define	XAT_APPENDONLY		((XAT0_INDEX << XVA_SHFT) | XAT0_APPENDONLY)
691da6c28aaSamw #define	XAT_NODUMP		((XAT0_INDEX << XVA_SHFT) | XAT0_NODUMP)
692da6c28aaSamw #define	XAT_OPAQUE		((XAT0_INDEX << XVA_SHFT) | XAT0_OPAQUE)
693da6c28aaSamw #define	XAT_AV_QUARANTINED	((XAT0_INDEX << XVA_SHFT) | XAT0_AV_QUARANTINED)
694da6c28aaSamw #define	XAT_AV_MODIFIED		((XAT0_INDEX << XVA_SHFT) | XAT0_AV_MODIFIED)
695da6c28aaSamw #define	XAT_AV_SCANSTAMP	((XAT0_INDEX << XVA_SHFT) | XAT0_AV_SCANSTAMP)
6967a286c47SDai Ngo #define	XAT_REPARSE		((XAT0_INDEX << XVA_SHFT) | XAT0_REPARSE)
69799d5e173STim Haley #define	XAT_GEN			((XAT0_INDEX << XVA_SHFT) | XAT0_GEN)
698fd9ee8b5Sjoyce mcintosh #define	XAT_OFFLINE		((XAT0_INDEX << XVA_SHFT) | XAT0_OFFLINE)
699fd9ee8b5Sjoyce mcintosh #define	XAT_SPARSE		((XAT0_INDEX << XVA_SHFT) | XAT0_SPARSE)
700f67950b2SNasf-Fan #define	XAT_PROJINHERIT		((XAT0_INDEX << XVA_SHFT) | XAT0_PROJINHERIT)
701f67950b2SNasf-Fan #define	XAT_PROJID		((XAT0_INDEX << XVA_SHFT) | XAT0_PROJID)
702da6c28aaSamw 
703da6c28aaSamw /*
704da6c28aaSamw  * The returned attribute map array (xva_rtnattrmap[]) is located past the
705da6c28aaSamw  * requested attribute map array (xva_reqattrmap[]).  Its location changes
706da6c28aaSamw  * when the array sizes change.  We use a separate pointer in a known location
707da6c28aaSamw  * (xva_rtnattrmapp) to hold the location of xva_rtnattrmap[].  This is
708da6c28aaSamw  * set in xva_init()
709da6c28aaSamw  */
710da6c28aaSamw #define	XVA_RTNATTRMAP(xvap)	((xvap)->xva_rtnattrmapp)
711da6c28aaSamw 
712da6c28aaSamw /*
713da6c28aaSamw  * XVA_SET_REQ() sets an attribute bit in the proper element in the bitmap
714da6c28aaSamw  * of requested attributes (xva_reqattrmap[]).
715da6c28aaSamw  */
716da6c28aaSamw #define	XVA_SET_REQ(xvap, attr)					\
717da6c28aaSamw 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
718da6c28aaSamw 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
719da6c28aaSamw 	(xvap)->xva_reqattrmap[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
720ae4caef8SMark Shellenbaum /*
721ae4caef8SMark Shellenbaum  * XVA_CLR_REQ() clears an attribute bit in the proper element in the bitmap
722ae4caef8SMark Shellenbaum  * of requested attributes (xva_reqattrmap[]).
723ae4caef8SMark Shellenbaum  */
724ae4caef8SMark Shellenbaum #define	XVA_CLR_REQ(xvap, attr)					\
725ae4caef8SMark Shellenbaum 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
726ae4caef8SMark Shellenbaum 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
727ae4caef8SMark Shellenbaum 	(xvap)->xva_reqattrmap[XVA_INDEX(attr)] &= ~XVA_ATTRBIT(attr)
728da6c28aaSamw 
729da6c28aaSamw /*
730da6c28aaSamw  * XVA_SET_RTN() sets an attribute bit in the proper element in the bitmap
731da6c28aaSamw  * of returned attributes (xva_rtnattrmap[]).
732da6c28aaSamw  */
733da6c28aaSamw #define	XVA_SET_RTN(xvap, attr)					\
734da6c28aaSamw 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
735da6c28aaSamw 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
736da6c28aaSamw 	(XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
737da6c28aaSamw 
738da6c28aaSamw /*
739da6c28aaSamw  * XVA_ISSET_REQ() checks the requested attribute bitmap (xva_reqattrmap[])
740da6c28aaSamw  * to see of the corresponding attribute bit is set.  If so, returns non-zero.
741da6c28aaSamw  */
742da6c28aaSamw #define	XVA_ISSET_REQ(xvap, attr)					\
743da6c28aaSamw 	((((xvap)->xva_vattr.va_mask | AT_XVATTR) &&			\
744da6c28aaSamw 		((xvap)->xva_magic == XVA_MAGIC) &&			\
745da6c28aaSamw 		((xvap)->xva_mapsize > XVA_INDEX(attr))) ?		\
746da6c28aaSamw 	((xvap)->xva_reqattrmap[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) :	0)
747da6c28aaSamw 
748da6c28aaSamw /*
749da6c28aaSamw  * XVA_ISSET_RTN() checks the returned attribute bitmap (xva_rtnattrmap[])
750da6c28aaSamw  * to see of the corresponding attribute bit is set.  If so, returns non-zero.
751da6c28aaSamw  */
752da6c28aaSamw #define	XVA_ISSET_RTN(xvap, attr)					\
753da6c28aaSamw 	((((xvap)->xva_vattr.va_mask | AT_XVATTR) &&			\
754da6c28aaSamw 		((xvap)->xva_magic == XVA_MAGIC) &&			\
755da6c28aaSamw 		((xvap)->xva_mapsize > XVA_INDEX(attr))) ?		\
756da6c28aaSamw 	((XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) : 0)
757da6c28aaSamw 
7587c478bd9Sstevel@tonic-gate /*
7597c478bd9Sstevel@tonic-gate  *  Modes.  Some values same as S_xxx entries from stat.h for convenience.
7607c478bd9Sstevel@tonic-gate  */
7617c478bd9Sstevel@tonic-gate #define	VSUID		04000		/* set user id on execution */
7627c478bd9Sstevel@tonic-gate #define	VSGID		02000		/* set group id on execution */
7637c478bd9Sstevel@tonic-gate #define	VSVTX		01000		/* save swapped text even after use */
7647c478bd9Sstevel@tonic-gate 
7657c478bd9Sstevel@tonic-gate /*
7667c478bd9Sstevel@tonic-gate  * Permissions.
7677c478bd9Sstevel@tonic-gate  */
7687c478bd9Sstevel@tonic-gate #define	VREAD		00400
7697c478bd9Sstevel@tonic-gate #define	VWRITE		00200
7707c478bd9Sstevel@tonic-gate #define	VEXEC		00100
7717c478bd9Sstevel@tonic-gate 
7727c478bd9Sstevel@tonic-gate #define	MODEMASK	07777		/* mode bits plus permission bits */
7737c478bd9Sstevel@tonic-gate #define	PERMMASK	00777		/* permission bits */
7747c478bd9Sstevel@tonic-gate 
775da6c28aaSamw /*
776da6c28aaSamw  * VOP_ACCESS flags
777da6c28aaSamw  */
778da6c28aaSamw #define	V_ACE_MASK	0x1	/* mask represents  NFSv4 ACE permissions */
779da6c28aaSamw #define	V_APPEND	0x2	/* want to do append only check */
780da6c28aaSamw 
7817c478bd9Sstevel@tonic-gate /*
7827c478bd9Sstevel@tonic-gate  * Check whether mandatory file locking is enabled.
7837c478bd9Sstevel@tonic-gate  */
7847c478bd9Sstevel@tonic-gate 
7857c478bd9Sstevel@tonic-gate #define	MANDMODE(mode)		(((mode) & (VSGID|(VEXEC>>3))) == VSGID)
7867c478bd9Sstevel@tonic-gate #define	MANDLOCK(vp, mode)	((vp)->v_type == VREG && MANDMODE(mode))
7877c478bd9Sstevel@tonic-gate 
7887c478bd9Sstevel@tonic-gate /*
7897c478bd9Sstevel@tonic-gate  * Flags for vnode operations.
7907c478bd9Sstevel@tonic-gate  */
7917c478bd9Sstevel@tonic-gate enum rm		{ RMFILE, RMDIRECTORY };	/* rm or rmdir (remove) */
7927c478bd9Sstevel@tonic-gate enum symfollow	{ NO_FOLLOW, FOLLOW };		/* follow symlinks (or not) */
7937c478bd9Sstevel@tonic-gate enum vcexcl	{ NONEXCL, EXCL };		/* (non)excl create */
7947c478bd9Sstevel@tonic-gate enum create	{ CRCREAT, CRMKNOD, CRMKDIR };	/* reason for create */
7957c478bd9Sstevel@tonic-gate 
7967c478bd9Sstevel@tonic-gate typedef enum rm		rm_t;
7977c478bd9Sstevel@tonic-gate typedef enum symfollow	symfollow_t;
7987c478bd9Sstevel@tonic-gate typedef enum vcexcl	vcexcl_t;
7997c478bd9Sstevel@tonic-gate typedef enum create	create_t;
8007c478bd9Sstevel@tonic-gate 
80154207fd2SJerry Jelinek /*
80254207fd2SJerry Jelinek  * Vnode Events - Used by VOP_VNEVENT
80354207fd2SJerry Jelinek  * The VE_PRE_RENAME_* events fire before the rename operation and are
80454207fd2SJerry Jelinek  * primarily used for specialized applications, such as NFSv4 delegation, which
80554207fd2SJerry Jelinek  * need to know about rename before it occurs.
80654207fd2SJerry Jelinek  */
8077c478bd9Sstevel@tonic-gate typedef enum vnevent	{
8087c478bd9Sstevel@tonic-gate 	VE_SUPPORT	= 0,	/* Query */
8097c478bd9Sstevel@tonic-gate 	VE_RENAME_SRC	= 1,	/* Rename, with vnode as source */
8107c478bd9Sstevel@tonic-gate 	VE_RENAME_DEST	= 2,	/* Rename, with vnode as target/destination */
8117c478bd9Sstevel@tonic-gate 	VE_REMOVE	= 3,	/* Remove of vnode's name */
812df2381bfSpraks 	VE_RMDIR	= 4,	/* Remove of directory vnode's name */
813df2381bfSpraks 	VE_CREATE	= 5,	/* Create with vnode's name which exists */
814df2381bfSpraks 	VE_LINK		= 6, 	/* Link with vnode's name as source */
815df2381bfSpraks 	VE_RENAME_DEST_DIR	= 7, 	/* Rename with vnode as target dir */
81672102e74SBryan Cantrill 	VE_MOUNTEDOVER	= 8, 	/* File or Filesystem got mounted over vnode */
81754207fd2SJerry Jelinek 	VE_TRUNCATE = 9,	/* Truncate */
81854207fd2SJerry Jelinek 	VE_PRE_RENAME_SRC = 10,	/* Pre-rename, with vnode as source */
81954207fd2SJerry Jelinek 	VE_PRE_RENAME_DEST = 11, /* Pre-rename, with vnode as target/dest. */
82054207fd2SJerry Jelinek 	VE_PRE_RENAME_DEST_DIR = 12 /* Pre-rename with vnode as target dir */
8217c478bd9Sstevel@tonic-gate } vnevent_t;
8227c478bd9Sstevel@tonic-gate 
8237c478bd9Sstevel@tonic-gate /*
8247c478bd9Sstevel@tonic-gate  * Values for checking vnode open and map counts
8257c478bd9Sstevel@tonic-gate  */
8267c478bd9Sstevel@tonic-gate enum v_mode { V_READ, V_WRITE, V_RDORWR, V_RDANDWR };
8277c478bd9Sstevel@tonic-gate 
8287c478bd9Sstevel@tonic-gate typedef enum v_mode v_mode_t;
8297c478bd9Sstevel@tonic-gate 
8307c478bd9Sstevel@tonic-gate #define	V_TRUE	1
8317c478bd9Sstevel@tonic-gate #define	V_FALSE	0
8327c478bd9Sstevel@tonic-gate 
8337c478bd9Sstevel@tonic-gate /*
8347c478bd9Sstevel@tonic-gate  * Structure used on VOP_GETSECATTR and VOP_SETSECATTR operations
8357c478bd9Sstevel@tonic-gate  */
8367c478bd9Sstevel@tonic-gate 
8377c478bd9Sstevel@tonic-gate typedef struct vsecattr {
8387c478bd9Sstevel@tonic-gate 	uint_t		vsa_mask;	/* See below */
8397c478bd9Sstevel@tonic-gate 	int		vsa_aclcnt;	/* ACL entry count */
8407c478bd9Sstevel@tonic-gate 	void		*vsa_aclentp;	/* pointer to ACL entries */
8417c478bd9Sstevel@tonic-gate 	int		vsa_dfaclcnt;	/* default ACL entry count */
8427c478bd9Sstevel@tonic-gate 	void		*vsa_dfaclentp;	/* pointer to default ACL entries */
843da6c28aaSamw 	size_t		vsa_aclentsz;	/* ACE size in bytes of vsa_aclentp */
844da6c28aaSamw 	uint_t		vsa_aclflags;	/* ACE ACL flags */
8457c478bd9Sstevel@tonic-gate } vsecattr_t;
8467c478bd9Sstevel@tonic-gate 
8477c478bd9Sstevel@tonic-gate /* vsa_mask values */
848da6c28aaSamw #define	VSA_ACL			0x0001
849da6c28aaSamw #define	VSA_ACLCNT		0x0002
850da6c28aaSamw #define	VSA_DFACL		0x0004
851da6c28aaSamw #define	VSA_DFACLCNT		0x0008
852da6c28aaSamw #define	VSA_ACE			0x0010
853da6c28aaSamw #define	VSA_ACECNT		0x0020
854da6c28aaSamw #define	VSA_ACE_ALLTYPES	0x0040
855da6c28aaSamw #define	VSA_ACE_ACLFLAGS	0x0080	/* get/set ACE ACL flags */
8567c478bd9Sstevel@tonic-gate 
8577c478bd9Sstevel@tonic-gate /*
8587c478bd9Sstevel@tonic-gate  * Structure used by various vnode operations to determine
8597c478bd9Sstevel@tonic-gate  * the context (pid, host, identity) of a caller.
8607c478bd9Sstevel@tonic-gate  *
8617c478bd9Sstevel@tonic-gate  * The cc_caller_id is used to identify one or more callers who invoke
8627c478bd9Sstevel@tonic-gate  * operations, possibly on behalf of others.  For example, the NFS
8637c478bd9Sstevel@tonic-gate  * server could have it's own cc_caller_id which can be detected by
8647c478bd9Sstevel@tonic-gate  * vnode/vfs operations or (FEM) monitors on those operations.  New
8657c478bd9Sstevel@tonic-gate  * caller IDs are generated by fs_new_caller_id().
8667c478bd9Sstevel@tonic-gate  */
8677c478bd9Sstevel@tonic-gate typedef struct caller_context {
8687c478bd9Sstevel@tonic-gate 	pid_t		cc_pid;		/* Process ID of the caller */
8697c478bd9Sstevel@tonic-gate 	int		cc_sysid;	/* System ID, used for remote calls */
8707c478bd9Sstevel@tonic-gate 	u_longlong_t	cc_caller_id;	/* Identifier for (set of) caller(s) */
871cfae96c2Sjwahlig 	ulong_t		cc_flags;
8727c478bd9Sstevel@tonic-gate } caller_context_t;
8737c478bd9Sstevel@tonic-gate 
874cfae96c2Sjwahlig /*
875cfae96c2Sjwahlig  * Flags for caller context.  The caller sets CC_DONTBLOCK if it does not
876cfae96c2Sjwahlig  * want to block inside of a FEM monitor.  The monitor will set CC_WOULDBLOCK
877cfae96c2Sjwahlig  * and return EAGAIN if the operation would have blocked.
878cfae96c2Sjwahlig  */
879cfae96c2Sjwahlig #define	CC_WOULDBLOCK	0x01
880cfae96c2Sjwahlig #define	CC_DONTBLOCK	0x02
881cfae96c2Sjwahlig 
8827c478bd9Sstevel@tonic-gate /*
8837c478bd9Sstevel@tonic-gate  * Structure tags for function prototypes, defined elsewhere.
8847c478bd9Sstevel@tonic-gate  */
8857c478bd9Sstevel@tonic-gate struct pathname;
8867c478bd9Sstevel@tonic-gate struct fid;
8877c478bd9Sstevel@tonic-gate struct flock64;
8887c478bd9Sstevel@tonic-gate struct flk_callback;
8897c478bd9Sstevel@tonic-gate struct shrlock;
8907c478bd9Sstevel@tonic-gate struct page;
8917c478bd9Sstevel@tonic-gate struct seg;
8927c478bd9Sstevel@tonic-gate struct as;
8937c478bd9Sstevel@tonic-gate struct pollhead;
8949d3574bfSNeil Perrin struct taskq;
8957c478bd9Sstevel@tonic-gate 
896aa59c4cbSrsb #ifdef	_KERNEL
897aa59c4cbSrsb 
8987c478bd9Sstevel@tonic-gate /*
899aa59c4cbSrsb  * VNODE_OPS defines all the vnode operations.  It is used to define
900aa59c4cbSrsb  * the vnodeops structure (below) and the fs_func_p union (vfs_opreg.h).
901aa59c4cbSrsb  */
902aa59c4cbSrsb #define	VNODE_OPS							\
903da6c28aaSamw 	int	(*vop_open)(vnode_t **, int, cred_t *,			\
904da6c28aaSamw 				caller_context_t *);			\
905da6c28aaSamw 	int	(*vop_close)(vnode_t *, int, int, offset_t, cred_t *,	\
906da6c28aaSamw 				caller_context_t *);			\
907aa59c4cbSrsb 	int	(*vop_read)(vnode_t *, uio_t *, int, cred_t *,		\
908aa59c4cbSrsb 				caller_context_t *);			\
909aa59c4cbSrsb 	int	(*vop_write)(vnode_t *, uio_t *, int, cred_t *,		\
910aa59c4cbSrsb 				caller_context_t *);			\
911aa59c4cbSrsb 	int	(*vop_ioctl)(vnode_t *, int, intptr_t, int, cred_t *,	\
912da6c28aaSamw 				int *, caller_context_t *);		\
913da6c28aaSamw 	int	(*vop_setfl)(vnode_t *, int, int, cred_t *,		\
914da6c28aaSamw 				caller_context_t *);			\
915da6c28aaSamw 	int	(*vop_getattr)(vnode_t *, vattr_t *, int, cred_t *,	\
916da6c28aaSamw 				caller_context_t *);			\
917aa59c4cbSrsb 	int	(*vop_setattr)(vnode_t *, vattr_t *, int, cred_t *,	\
918aa59c4cbSrsb 				caller_context_t *);			\
919da6c28aaSamw 	int	(*vop_access)(vnode_t *, int, int, cred_t *,		\
920da6c28aaSamw 				caller_context_t *);			\
921aa59c4cbSrsb 	int	(*vop_lookup)(vnode_t *, char *, vnode_t **,		\
922aa59c4cbSrsb 				struct pathname *,			\
923da6c28aaSamw 				int, vnode_t *, cred_t *,		\
924da6c28aaSamw 				caller_context_t *, int *,		\
925da6c28aaSamw 				struct pathname *);			\
926aa59c4cbSrsb 	int	(*vop_create)(vnode_t *, char *, vattr_t *, vcexcl_t,	\
927da6c28aaSamw 				int, vnode_t **, cred_t *, int,		\
928da6c28aaSamw 				caller_context_t *, vsecattr_t *);	\
929da6c28aaSamw 	int	(*vop_remove)(vnode_t *, char *, cred_t *,		\
930da6c28aaSamw 				caller_context_t *, int);		\
931da6c28aaSamw 	int	(*vop_link)(vnode_t *, vnode_t *, char *, cred_t *,	\
932da6c28aaSamw 				caller_context_t *, int);		\
933aa59c4cbSrsb 	int	(*vop_rename)(vnode_t *, char *, vnode_t *, char *,	\
934da6c28aaSamw 				cred_t *, caller_context_t *, int);	\
935aa59c4cbSrsb 	int	(*vop_mkdir)(vnode_t *, char *, vattr_t *, vnode_t **,	\
936da6c28aaSamw 				cred_t *, caller_context_t *, int,	\
937da6c28aaSamw 				vsecattr_t *);				\
938da6c28aaSamw 	int	(*vop_rmdir)(vnode_t *, char *, vnode_t *, cred_t *,	\
939da6c28aaSamw 				caller_context_t *, int);		\
940da6c28aaSamw 	int	(*vop_readdir)(vnode_t *, uio_t *, cred_t *, int *,	\
941da6c28aaSamw 				caller_context_t *, int);		\
942aa59c4cbSrsb 	int	(*vop_symlink)(vnode_t *, char *, vattr_t *, char *,	\
943da6c28aaSamw 				cred_t *, caller_context_t *, int);	\
944da6c28aaSamw 	int	(*vop_readlink)(vnode_t *, uio_t *, cred_t *,		\
945da6c28aaSamw 				caller_context_t *);			\
946da6c28aaSamw 	int	(*vop_fsync)(vnode_t *, int, cred_t *,			\
947da6c28aaSamw 				caller_context_t *);			\
948da6c28aaSamw 	void	(*vop_inactive)(vnode_t *, cred_t *,			\
949da6c28aaSamw 				caller_context_t *);			\
950da6c28aaSamw 	int	(*vop_fid)(vnode_t *, struct fid *,			\
951da6c28aaSamw 				caller_context_t *);			\
952aa59c4cbSrsb 	int	(*vop_rwlock)(vnode_t *, int, caller_context_t *);	\
953aa59c4cbSrsb 	void	(*vop_rwunlock)(vnode_t *, int, caller_context_t *);	\
954da6c28aaSamw 	int	(*vop_seek)(vnode_t *, offset_t, offset_t *,		\
955da6c28aaSamw 				caller_context_t *);			\
956da6c28aaSamw 	int	(*vop_cmp)(vnode_t *, vnode_t *, caller_context_t *);	\
957aa59c4cbSrsb 	int	(*vop_frlock)(vnode_t *, int, struct flock64 *,		\
958aa59c4cbSrsb 				int, offset_t,				\
959da6c28aaSamw 				struct flk_callback *, cred_t *,	\
960da6c28aaSamw 				caller_context_t *);			\
961aa59c4cbSrsb 	int	(*vop_space)(vnode_t *, int, struct flock64 *,		\
962aa59c4cbSrsb 				int, offset_t,				\
963aa59c4cbSrsb 				cred_t *, caller_context_t *);		\
964da6c28aaSamw 	int	(*vop_realvp)(vnode_t *, vnode_t **,			\
965da6c28aaSamw 				caller_context_t *);			\
966aa59c4cbSrsb 	int	(*vop_getpage)(vnode_t *, offset_t, size_t, uint_t *,	\
967aa59c4cbSrsb 				struct page **, size_t, struct seg *,	\
968da6c28aaSamw 				caddr_t, enum seg_rw, cred_t *,		\
969da6c28aaSamw 				caller_context_t *);			\
970aa59c4cbSrsb 	int	(*vop_putpage)(vnode_t *, offset_t, size_t,		\
971da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
972aa59c4cbSrsb 	int	(*vop_map)(vnode_t *, offset_t, struct as *,		\
973aa59c4cbSrsb 				caddr_t *, size_t,			\
974da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *,	\
975da6c28aaSamw 				caller_context_t *);			\
976aa59c4cbSrsb 	int	(*vop_addmap)(vnode_t *, offset_t, struct as *,		\
977aa59c4cbSrsb 				caddr_t, size_t,			\
978da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *,	\
979da6c28aaSamw 				caller_context_t *);			\
980aa59c4cbSrsb 	int	(*vop_delmap)(vnode_t *, offset_t, struct as *,		\
981aa59c4cbSrsb 				caddr_t, size_t,			\
982da6c28aaSamw 				uint_t, uint_t, uint_t, cred_t *,	\
983da6c28aaSamw 				caller_context_t *);			\
984aa59c4cbSrsb 	int	(*vop_poll)(vnode_t *, short, int, short *,		\
985da6c28aaSamw 				struct pollhead **,			\
986da6c28aaSamw 				caller_context_t *);			\
987d7334e51Srm 	int	(*vop_dump)(vnode_t *, caddr_t, offset_t, offset_t,	\
988da6c28aaSamw 				caller_context_t *);			\
989da6c28aaSamw 	int	(*vop_pathconf)(vnode_t *, int, ulong_t *, cred_t *,	\
990da6c28aaSamw 				caller_context_t *);			\
991aa59c4cbSrsb 	int	(*vop_pageio)(vnode_t *, struct page *,			\
992da6c28aaSamw 				u_offset_t, size_t, int, cred_t *,	\
993da6c28aaSamw 				caller_context_t *);			\
994d7334e51Srm 	int	(*vop_dumpctl)(vnode_t *, int, offset_t *,		\
995da6c28aaSamw 				caller_context_t *);			\
996aa59c4cbSrsb 	void	(*vop_dispose)(vnode_t *, struct page *,		\
997da6c28aaSamw 				int, int, cred_t *,			\
998da6c28aaSamw 				caller_context_t *);			\
999aa59c4cbSrsb 	int	(*vop_setsecattr)(vnode_t *, vsecattr_t *,		\
1000da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
1001aa59c4cbSrsb 	int	(*vop_getsecattr)(vnode_t *, vsecattr_t *,		\
1002da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
1003aa59c4cbSrsb 	int	(*vop_shrlock)(vnode_t *, int, struct shrlock *,	\
1004da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
1005da6c28aaSamw 	int	(*vop_vnevent)(vnode_t *, vnevent_t, vnode_t *,		\
1006c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 				char *, caller_context_t *);		\
1007c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 	int	(*vop_reqzcbuf)(vnode_t *, enum uio_rw, xuio_t *,	\
1008c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 				cred_t *, caller_context_t *);		\
1009c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 	int	(*vop_retzcbuf)(vnode_t *, xuio_t *, cred_t *,		\
1010c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 				caller_context_t *)
1011df2381bfSpraks 	/* NB: No ";" */
1012aa59c4cbSrsb 
1013aa59c4cbSrsb /*
1014aa59c4cbSrsb  * Operations on vnodes.  Note: File systems must never operate directly
10157c478bd9Sstevel@tonic-gate  * on a 'vnodeops' structure -- it WILL change in future releases!  They
1016aa59c4cbSrsb  * must use vn_make_ops() to create the structure.
10177c478bd9Sstevel@tonic-gate  */
10187c478bd9Sstevel@tonic-gate typedef struct vnodeops {
10197c478bd9Sstevel@tonic-gate 	const char *vnop_name;
1020aa59c4cbSrsb 	VNODE_OPS;	/* Signatures of all vnode operations (vops) */
10217c478bd9Sstevel@tonic-gate } vnodeops_t;
10227c478bd9Sstevel@tonic-gate 
1023aa59c4cbSrsb typedef int (*fs_generic_func_p) ();	/* Generic vop/vfsop/femop/fsemop ptr */
10247c478bd9Sstevel@tonic-gate 
1025da6c28aaSamw extern int	fop_open(vnode_t **, int, cred_t *, caller_context_t *);
1026da6c28aaSamw extern int	fop_close(vnode_t *, int, int, offset_t, cred_t *,
1027da6c28aaSamw 				caller_context_t *);
10287c478bd9Sstevel@tonic-gate extern int	fop_read(vnode_t *, uio_t *, int, cred_t *, caller_context_t *);
10297c478bd9Sstevel@tonic-gate extern int	fop_write(vnode_t *, uio_t *, int, cred_t *,
10307c478bd9Sstevel@tonic-gate 				caller_context_t *);
1031da6c28aaSamw extern int	fop_ioctl(vnode_t *, int, intptr_t, int, cred_t *, int *,
1032da6c28aaSamw 				caller_context_t *);
1033da6c28aaSamw extern int	fop_setfl(vnode_t *, int, int, cred_t *, caller_context_t *);
1034da6c28aaSamw extern int	fop_getattr(vnode_t *, vattr_t *, int, cred_t *,
1035da6c28aaSamw 				caller_context_t *);
10367c478bd9Sstevel@tonic-gate extern int	fop_setattr(vnode_t *, vattr_t *, int, cred_t *,
10377c478bd9Sstevel@tonic-gate 				caller_context_t *);
1038da6c28aaSamw extern int	fop_access(vnode_t *, int, int, cred_t *, caller_context_t *);
10397c478bd9Sstevel@tonic-gate extern int	fop_lookup(vnode_t *, char *, vnode_t **, struct pathname *,
1040da6c28aaSamw 				int, vnode_t *, cred_t *, caller_context_t *,
1041da6c28aaSamw 				int *, struct pathname *);
10427c478bd9Sstevel@tonic-gate extern int	fop_create(vnode_t *, char *, vattr_t *, vcexcl_t, int,
1043da6c28aaSamw 				vnode_t **, cred_t *, int, caller_context_t *,
1044da6c28aaSamw 				vsecattr_t *);
1045da6c28aaSamw extern int	fop_remove(vnode_t *vp, char *, cred_t *, caller_context_t *,
1046da6c28aaSamw 				int);
1047da6c28aaSamw extern int	fop_link(vnode_t *, vnode_t *, char *, cred_t *,
1048da6c28aaSamw 				caller_context_t *, int);
1049da6c28aaSamw extern int	fop_rename(vnode_t *, char *, vnode_t *, char *, cred_t *,
1050da6c28aaSamw 				caller_context_t *, int);
1051da6c28aaSamw extern int	fop_mkdir(vnode_t *, char *, vattr_t *, vnode_t **, cred_t *,
1052da6c28aaSamw 				caller_context_t *, int, vsecattr_t *);
1053da6c28aaSamw extern int	fop_rmdir(vnode_t *, char *, vnode_t *, cred_t *,
1054da6c28aaSamw 				caller_context_t *, int);
1055da6c28aaSamw extern int	fop_readdir(vnode_t *, uio_t *, cred_t *, int *,
1056da6c28aaSamw 				caller_context_t *, int);
1057da6c28aaSamw extern int	fop_symlink(vnode_t *, char *, vattr_t *, char *, cred_t *,
1058da6c28aaSamw 				caller_context_t *, int);
1059da6c28aaSamw extern int	fop_readlink(vnode_t *, uio_t *, cred_t *, caller_context_t *);
1060da6c28aaSamw extern int	fop_fsync(vnode_t *, int, cred_t *, caller_context_t *);
1061da6c28aaSamw extern void	fop_inactive(vnode_t *, cred_t *, caller_context_t *);
1062da6c28aaSamw extern int	fop_fid(vnode_t *, struct fid *, caller_context_t *);
10637c478bd9Sstevel@tonic-gate extern int	fop_rwlock(vnode_t *, int, caller_context_t *);
10647c478bd9Sstevel@tonic-gate extern void	fop_rwunlock(vnode_t *, int, caller_context_t *);
1065da6c28aaSamw extern int	fop_seek(vnode_t *, offset_t, offset_t *, caller_context_t *);
1066da6c28aaSamw extern int	fop_cmp(vnode_t *, vnode_t *, caller_context_t *);
10677c478bd9Sstevel@tonic-gate extern int	fop_frlock(vnode_t *, int, struct flock64 *, int, offset_t,
1068da6c28aaSamw 				struct flk_callback *, cred_t *,
1069da6c28aaSamw 				caller_context_t *);
10707c478bd9Sstevel@tonic-gate extern int	fop_space(vnode_t *, int, struct flock64 *, int, offset_t,
10717c478bd9Sstevel@tonic-gate 				cred_t *, caller_context_t *);
1072da6c28aaSamw extern int	fop_realvp(vnode_t *, vnode_t **, caller_context_t *);
10737c478bd9Sstevel@tonic-gate extern int	fop_getpage(vnode_t *, offset_t, size_t, uint_t *,
10747c478bd9Sstevel@tonic-gate 				struct page **, size_t, struct seg *,
1075da6c28aaSamw 				caddr_t, enum seg_rw, cred_t *,
1076da6c28aaSamw 				caller_context_t *);
1077da6c28aaSamw extern int	fop_putpage(vnode_t *, offset_t, size_t, int, cred_t *,
1078da6c28aaSamw 				caller_context_t *);
10797c478bd9Sstevel@tonic-gate extern int	fop_map(vnode_t *, offset_t, struct as *, caddr_t *, size_t,
1080da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *cr,
1081da6c28aaSamw 				caller_context_t *);
10827c478bd9Sstevel@tonic-gate extern int	fop_addmap(vnode_t *, offset_t, struct as *, caddr_t, size_t,
1083da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *,
1084da6c28aaSamw 				caller_context_t *);
10857c478bd9Sstevel@tonic-gate extern int	fop_delmap(vnode_t *, offset_t, struct as *, caddr_t, size_t,
1086da6c28aaSamw 				uint_t, uint_t, uint_t, cred_t *,
1087da6c28aaSamw 				caller_context_t *);
1088da6c28aaSamw extern int	fop_poll(vnode_t *, short, int, short *, struct pollhead **,
1089da6c28aaSamw 				caller_context_t *);
1090d7334e51Srm extern int	fop_dump(vnode_t *, caddr_t, offset_t, offset_t,
1091d7334e51Srm     caller_context_t *);
1092da6c28aaSamw extern int	fop_pathconf(vnode_t *, int, ulong_t *, cred_t *,
1093da6c28aaSamw 				caller_context_t *);
10947c478bd9Sstevel@tonic-gate extern int	fop_pageio(vnode_t *, struct page *, u_offset_t, size_t, int,
1095da6c28aaSamw 				cred_t *, caller_context_t *);
1096d7334e51Srm extern int	fop_dumpctl(vnode_t *, int, offset_t *, caller_context_t *);
1097da6c28aaSamw extern void	fop_dispose(vnode_t *, struct page *, int, int, cred_t *,
1098da6c28aaSamw 				caller_context_t *);
1099da6c28aaSamw extern int	fop_setsecattr(vnode_t *, vsecattr_t *, int, cred_t *,
1100da6c28aaSamw 				caller_context_t *);
1101da6c28aaSamw extern int	fop_getsecattr(vnode_t *, vsecattr_t *, int, cred_t *,
1102da6c28aaSamw 				caller_context_t *);
1103da6c28aaSamw extern int	fop_shrlock(vnode_t *, int, struct shrlock *, int, cred_t *,
1104da6c28aaSamw 				caller_context_t *);
1105da6c28aaSamw extern int	fop_vnevent(vnode_t *, vnevent_t, vnode_t *, char *,
1106da6c28aaSamw 				caller_context_t *);
1107c242f9a0Schunli zhang - Sun Microsystems - Irvine United States extern int	fop_reqzcbuf(vnode_t *, enum uio_rw, xuio_t *, cred_t *,
1108c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 				caller_context_t *);
1109c242f9a0Schunli zhang - Sun Microsystems - Irvine United States extern int	fop_retzcbuf(vnode_t *, xuio_t *, cred_t *, caller_context_t *);
11107c478bd9Sstevel@tonic-gate 
11117c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
11127c478bd9Sstevel@tonic-gate 
1113da6c28aaSamw #define	VOP_OPEN(vpp, mode, cr, ct) \
1114da6c28aaSamw 	fop_open(vpp, mode, cr, ct)
1115da6c28aaSamw #define	VOP_CLOSE(vp, f, c, o, cr, ct) \
1116da6c28aaSamw 	fop_close(vp, f, c, o, cr, ct)
11177c478bd9Sstevel@tonic-gate #define	VOP_READ(vp, uiop, iof, cr, ct) \
11187c478bd9Sstevel@tonic-gate 	fop_read(vp, uiop, iof, cr, ct)
11197c478bd9Sstevel@tonic-gate #define	VOP_WRITE(vp, uiop, iof, cr, ct) \
11207c478bd9Sstevel@tonic-gate 	fop_write(vp, uiop, iof, cr, ct)
1121da6c28aaSamw #define	VOP_IOCTL(vp, cmd, a, f, cr, rvp, ct) \
1122da6c28aaSamw 	fop_ioctl(vp, cmd, a, f, cr, rvp, ct)
1123da6c28aaSamw #define	VOP_SETFL(vp, f, a, cr, ct) \
1124da6c28aaSamw 	fop_setfl(vp, f, a, cr, ct)
1125da6c28aaSamw #define	VOP_GETATTR(vp, vap, f, cr, ct) \
1126da6c28aaSamw 	fop_getattr(vp, vap, f, cr, ct)
11277c478bd9Sstevel@tonic-gate #define	VOP_SETATTR(vp, vap, f, cr, ct) \
11287c478bd9Sstevel@tonic-gate 	fop_setattr(vp, vap, f, cr, ct)
1129da6c28aaSamw #define	VOP_ACCESS(vp, mode, f, cr, ct) \
1130da6c28aaSamw 	fop_access(vp, mode, f, cr, ct)
1131da6c28aaSamw #define	VOP_LOOKUP(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp) \
1132da6c28aaSamw 	fop_lookup(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp)
1133da6c28aaSamw #define	VOP_CREATE(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap) \
1134da6c28aaSamw 	fop_create(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap)
1135da6c28aaSamw #define	VOP_REMOVE(dvp, p, cr, ct, f) \
1136da6c28aaSamw 	fop_remove(dvp, p, cr, ct, f)
1137da6c28aaSamw #define	VOP_LINK(tdvp, fvp, p, cr, ct, f) \
1138da6c28aaSamw 	fop_link(tdvp, fvp, p, cr, ct, f)
1139da6c28aaSamw #define	VOP_RENAME(fvp, fnm, tdvp, tnm, cr, ct, f) \
1140da6c28aaSamw 	fop_rename(fvp, fnm, tdvp, tnm, cr, ct, f)
1141da6c28aaSamw #define	VOP_MKDIR(dp, p, vap, vpp, cr, ct, f, vsap) \
1142da6c28aaSamw 	fop_mkdir(dp, p, vap, vpp, cr, ct, f, vsap)
1143da6c28aaSamw #define	VOP_RMDIR(dp, p, cdir, cr, ct, f) \
1144da6c28aaSamw 	fop_rmdir(dp, p, cdir, cr, ct, f)
1145da6c28aaSamw #define	VOP_READDIR(vp, uiop, cr, eofp, ct, f) \
1146da6c28aaSamw 	fop_readdir(vp, uiop, cr, eofp, ct, f)
1147da6c28aaSamw #define	VOP_SYMLINK(dvp, lnm, vap, tnm, cr, ct, f) \
1148da6c28aaSamw 	fop_symlink(dvp, lnm, vap, tnm, cr, ct, f)
1149da6c28aaSamw #define	VOP_READLINK(vp, uiop, cr, ct) \
1150da6c28aaSamw 	fop_readlink(vp, uiop, cr, ct)
1151da6c28aaSamw #define	VOP_FSYNC(vp, syncflag, cr, ct) \
1152da6c28aaSamw 	fop_fsync(vp, syncflag, cr, ct)
1153da6c28aaSamw #define	VOP_INACTIVE(vp, cr, ct) \
1154da6c28aaSamw 	fop_inactive(vp, cr, ct)
1155da6c28aaSamw #define	VOP_FID(vp, fidp, ct) \
1156da6c28aaSamw 	fop_fid(vp, fidp, ct)
11577c478bd9Sstevel@tonic-gate #define	VOP_RWLOCK(vp, w, ct) \
11587c478bd9Sstevel@tonic-gate 	fop_rwlock(vp, w, ct)
11597c478bd9Sstevel@tonic-gate #define	VOP_RWUNLOCK(vp, w, ct) \
11607c478bd9Sstevel@tonic-gate 	fop_rwunlock(vp, w, ct)
1161da6c28aaSamw #define	VOP_SEEK(vp, ooff, noffp, ct) \
1162da6c28aaSamw 	fop_seek(vp, ooff, noffp, ct)
1163da6c28aaSamw #define	VOP_CMP(vp1, vp2, ct) \
1164da6c28aaSamw 	fop_cmp(vp1, vp2, ct)
1165da6c28aaSamw #define	VOP_FRLOCK(vp, cmd, a, f, o, cb, cr, ct) \
1166da6c28aaSamw 	fop_frlock(vp, cmd, a, f, o, cb, cr, ct)
11677c478bd9Sstevel@tonic-gate #define	VOP_SPACE(vp, cmd, a, f, o, cr, ct) \
11687c478bd9Sstevel@tonic-gate 	fop_space(vp, cmd, a, f, o, cr, ct)
1169da6c28aaSamw #define	VOP_REALVP(vp1, vp2, ct) \
1170da6c28aaSamw 	fop_realvp(vp1, vp2, ct)
1171da6c28aaSamw #define	VOP_GETPAGE(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct) \
1172da6c28aaSamw 	fop_getpage(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct)
1173da6c28aaSamw #define	VOP_PUTPAGE(vp, of, sz, fl, cr, ct) \
1174da6c28aaSamw 	fop_putpage(vp, of, sz, fl, cr, ct)
1175da6c28aaSamw #define	VOP_MAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1176da6c28aaSamw 	fop_map(vp, of, as, a, sz, p, mp, fl, cr, ct)
1177da6c28aaSamw #define	VOP_ADDMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1178da6c28aaSamw 	fop_addmap(vp, of, as, a, sz, p, mp, fl, cr, ct)
1179da6c28aaSamw #define	VOP_DELMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1180da6c28aaSamw 	fop_delmap(vp, of, as, a, sz, p, mp, fl, cr, ct)
1181da6c28aaSamw #define	VOP_POLL(vp, events, anyyet, reventsp, phpp, ct) \
1182da6c28aaSamw 	fop_poll(vp, events, anyyet, reventsp, phpp, ct)
1183da6c28aaSamw #define	VOP_DUMP(vp, addr, bn, count, ct) \
1184da6c28aaSamw 	fop_dump(vp, addr, bn, count, ct)
1185da6c28aaSamw #define	VOP_PATHCONF(vp, cmd, valp, cr, ct) \
1186da6c28aaSamw 	fop_pathconf(vp, cmd, valp, cr, ct)
1187da6c28aaSamw #define	VOP_PAGEIO(vp, pp, io_off, io_len, flags, cr, ct) \
1188da6c28aaSamw 	fop_pageio(vp, pp, io_off, io_len, flags, cr, ct)
1189da6c28aaSamw #define	VOP_DUMPCTL(vp, action, blkp, ct) \
1190da6c28aaSamw 	fop_dumpctl(vp, action, blkp, ct)
1191da6c28aaSamw #define	VOP_DISPOSE(vp, pp, flag, dn, cr, ct) \
1192da6c28aaSamw 	fop_dispose(vp, pp, flag, dn, cr, ct)
1193da6c28aaSamw #define	VOP_GETSECATTR(vp, vsap, f, cr, ct) \
1194da6c28aaSamw 	fop_getsecattr(vp, vsap, f, cr, ct)
1195da6c28aaSamw #define	VOP_SETSECATTR(vp, vsap, f, cr, ct) \
1196da6c28aaSamw 	fop_setsecattr(vp, vsap, f, cr, ct)
1197da6c28aaSamw #define	VOP_SHRLOCK(vp, cmd, shr, f, cr, ct) \
1198da6c28aaSamw 	fop_shrlock(vp, cmd, shr, f, cr, ct)
1199da6c28aaSamw #define	VOP_VNEVENT(vp, vnevent, dvp, fnm, ct) \
1200da6c28aaSamw 	fop_vnevent(vp, vnevent, dvp, fnm, ct)
1201c242f9a0Schunli zhang - Sun Microsystems - Irvine United States #define	VOP_REQZCBUF(vp, rwflag, xuiop, cr, ct) \
1202c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 	fop_reqzcbuf(vp, rwflag, xuiop, cr, ct)
1203c242f9a0Schunli zhang - Sun Microsystems - Irvine United States #define	VOP_RETZCBUF(vp, xuiop, cr, ct) \
1204c242f9a0Schunli zhang - Sun Microsystems - Irvine United States 	fop_retzcbuf(vp, xuiop, cr, ct)
12057c478bd9Sstevel@tonic-gate 
12067c478bd9Sstevel@tonic-gate #define	VOPNAME_OPEN		"open"
12077c478bd9Sstevel@tonic-gate #define	VOPNAME_CLOSE		"close"
12087c478bd9Sstevel@tonic-gate #define	VOPNAME_READ		"read"
12097c478bd9Sstevel@tonic-gate #define	VOPNAME_WRITE		"write"
12107c478bd9Sstevel@tonic-gate #define	VOPNAME_IOCTL		"ioctl"
12117c478bd9Sstevel@tonic-gate #define	VOPNAME_SETFL		"setfl"
12127c478bd9Sstevel@tonic-gate #define	VOPNAME_GETATTR		"getattr"
12137c478bd9Sstevel@tonic-gate #define	VOPNAME_SETATTR		"setattr"
12147c478bd9Sstevel@tonic-gate #define	VOPNAME_ACCESS		"access"
12157c478bd9Sstevel@tonic-gate #define	VOPNAME_LOOKUP		"lookup"
12167c478bd9Sstevel@tonic-gate #define	VOPNAME_CREATE		"create"
12177c478bd9Sstevel@tonic-gate #define	VOPNAME_REMOVE		"remove"
12187c478bd9Sstevel@tonic-gate #define	VOPNAME_LINK		"link"
12197c478bd9Sstevel@tonic-gate #define	VOPNAME_RENAME		"rename"
12207c478bd9Sstevel@tonic-gate #define	VOPNAME_MKDIR		"mkdir"
12217c478bd9Sstevel@tonic-gate #define	VOPNAME_RMDIR		"rmdir"
12227c478bd9Sstevel@tonic-gate #define	VOPNAME_READDIR		"readdir"
12237c478bd9Sstevel@tonic-gate #define	VOPNAME_SYMLINK		"symlink"
12247c478bd9Sstevel@tonic-gate #define	VOPNAME_READLINK	"readlink"
12257c478bd9Sstevel@tonic-gate #define	VOPNAME_FSYNC		"fsync"
12267c478bd9Sstevel@tonic-gate #define	VOPNAME_INACTIVE	"inactive"
12277c478bd9Sstevel@tonic-gate #define	VOPNAME_FID		"fid"
12287c478bd9Sstevel@tonic-gate #define	VOPNAME_RWLOCK		"rwlock"
12297c478bd9Sstevel@tonic-gate #define	VOPNAME_RWUNLOCK	"rwunlock"
12307c478bd9Sstevel@tonic-gate #define	VOPNAME_SEEK		"seek"
12317c478bd9Sstevel@tonic-gate #define	VOPNAME_CMP		"cmp"
12327c478bd9Sstevel@tonic-gate #define	VOPNAME_FRLOCK		"frlock"
12337c478bd9Sstevel@tonic-gate #define	VOPNAME_SPACE		"space"
12347c478bd9Sstevel@tonic-gate #define	VOPNAME_REALVP		"realvp"
12357c478bd9Sstevel@tonic-gate #define	VOPNAME_GETPAGE		"getpage"
12367c478bd9Sstevel@tonic-gate #define	VOPNAME_PUTPAGE		"putpage"
12377c478bd9Sstevel@tonic-gate #define	VOPNAME_MAP		"map"
12387c478bd9Sstevel@tonic-gate #define	VOPNAME_ADDMAP		"addmap"
12397c478bd9Sstevel@tonic-gate #define	VOPNAME_DELMAP		"delmap"
12407c478bd9Sstevel@tonic-gate #define	VOPNAME_POLL		"poll"
12417c478bd9Sstevel@tonic-gate #define	VOPNAME_DUMP		"dump"
12427c478bd9Sstevel@tonic-gate #define	VOPNAME_PATHCONF	"pathconf"
12437c478bd9Sstevel@tonic-gate #define	VOPNAME_PAGEIO		"pageio"
12447c478bd9Sstevel@tonic-gate #define	VOPNAME_DUMPCTL		"dumpctl"
12457c478bd9Sstevel@tonic-gate #define	VOPNAME_DISPOSE		"dispose"
12467c478bd9Sstevel@tonic-gate #define	VOPNAME_GETSECATTR	"getsecattr"
12477c478bd9Sstevel@tonic-gate #define	VOPNAME_SETSECATTR	"setsecattr"
12487c478bd9Sstevel@tonic-gate #define	VOPNAME_SHRLOCK		"shrlock"
12497c478bd9Sstevel@tonic-gate #define	VOPNAME_VNEVENT		"vnevent"
1250c242f9a0Schunli zhang - Sun Microsystems - Irvine United States #define	VOPNAME_REQZCBUF	"reqzcbuf"
1251c242f9a0Schunli zhang - Sun Microsystems - Irvine United States #define	VOPNAME_RETZCBUF	"retzcbuf"
12527c478bd9Sstevel@tonic-gate 
12537c478bd9Sstevel@tonic-gate /*
12547c478bd9Sstevel@tonic-gate  * Flags for VOP_LOOKUP
1255da6c28aaSamw  *
1256794f0adbSRoger A. Faulkner  * Defined in file.h, but also possible, FIGNORECASE and FSEARCH
1257da6c28aaSamw  *
12587c478bd9Sstevel@tonic-gate  */
12597c478bd9Sstevel@tonic-gate #define	LOOKUP_DIR		0x01	/* want parent dir vp */
12607c478bd9Sstevel@tonic-gate #define	LOOKUP_XATTR		0x02	/* lookup up extended attr dir */
12617c478bd9Sstevel@tonic-gate #define	CREATE_XATTR_DIR	0x04	/* Create extended attr dir */
1262da6c28aaSamw #define	LOOKUP_HAVE_SYSATTR_DIR	0x08	/* Already created virtual GFS dir */
1263da6c28aaSamw 
1264da6c28aaSamw /*
1265da6c28aaSamw  * Flags for VOP_READDIR
1266da6c28aaSamw  */
1267da6c28aaSamw #define	V_RDDIR_ENTFLAGS	0x01	/* request dirent flags */
1268e802abbdSTim Haley #define	V_RDDIR_ACCFILTER	0x02	/* filter out inaccessible dirents */
12697c478bd9Sstevel@tonic-gate 
12707c478bd9Sstevel@tonic-gate /*
12717c478bd9Sstevel@tonic-gate  * Flags for VOP_RWLOCK/VOP_RWUNLOCK
12727c478bd9Sstevel@tonic-gate  * VOP_RWLOCK will return the flag that was actually set, or -1 if none.
12737c478bd9Sstevel@tonic-gate  */
12747c478bd9Sstevel@tonic-gate #define	V_WRITELOCK_TRUE	(1)	/* Request write-lock on the vnode */
12757c478bd9Sstevel@tonic-gate #define	V_WRITELOCK_FALSE	(0)	/* Request read-lock on the vnode */
12767c478bd9Sstevel@tonic-gate 
12777c478bd9Sstevel@tonic-gate /*
12787c478bd9Sstevel@tonic-gate  * Flags for VOP_DUMPCTL
12797c478bd9Sstevel@tonic-gate  */
12807c478bd9Sstevel@tonic-gate #define	DUMP_ALLOC	0
12817c478bd9Sstevel@tonic-gate #define	DUMP_FREE	1
12827c478bd9Sstevel@tonic-gate #define	DUMP_SCAN	2
12837c478bd9Sstevel@tonic-gate 
12847c478bd9Sstevel@tonic-gate /*
12857c478bd9Sstevel@tonic-gate  * Public vnode manipulation functions.
12867c478bd9Sstevel@tonic-gate  */
12877c478bd9Sstevel@tonic-gate #ifdef	_KERNEL
12887c478bd9Sstevel@tonic-gate 
12897c478bd9Sstevel@tonic-gate vnode_t *vn_alloc(int);
12907c478bd9Sstevel@tonic-gate void	vn_reinit(vnode_t *);
12917c478bd9Sstevel@tonic-gate void	vn_recycle(vnode_t *);
12927c478bd9Sstevel@tonic-gate void	vn_free(vnode_t *);
12937c478bd9Sstevel@tonic-gate 
12947c478bd9Sstevel@tonic-gate int	vn_is_readonly(vnode_t *);
12957c478bd9Sstevel@tonic-gate int   	vn_is_opened(vnode_t *, v_mode_t);
12967c478bd9Sstevel@tonic-gate int   	vn_is_mapped(vnode_t *, v_mode_t);
1297da6c28aaSamw int   	vn_has_other_opens(vnode_t *, v_mode_t);
1298da6c28aaSamw void	vn_open_upgrade(vnode_t *, int);
1299da6c28aaSamw void	vn_open_downgrade(vnode_t *, int);
13007c478bd9Sstevel@tonic-gate 
13017c478bd9Sstevel@tonic-gate int	vn_can_change_zones(vnode_t *vp);
13027c478bd9Sstevel@tonic-gate 
13037c478bd9Sstevel@tonic-gate int	vn_has_flocks(vnode_t *);
13047c478bd9Sstevel@tonic-gate int	vn_has_mandatory_locks(vnode_t *, int);
13057c478bd9Sstevel@tonic-gate int	vn_has_cached_data(vnode_t *);
13067c478bd9Sstevel@tonic-gate 
13077c478bd9Sstevel@tonic-gate void	vn_setops(vnode_t *, vnodeops_t *);
13087c478bd9Sstevel@tonic-gate vnodeops_t *vn_getops(vnode_t *);
13097c478bd9Sstevel@tonic-gate int	vn_matchops(vnode_t *, vnodeops_t *);
13107c478bd9Sstevel@tonic-gate int	vn_matchopval(vnode_t *, char *, fs_generic_func_p);
13117c478bd9Sstevel@tonic-gate int	vn_ismntpt(vnode_t *);
13127c478bd9Sstevel@tonic-gate 
13137c478bd9Sstevel@tonic-gate struct vfs *vn_mountedvfs(vnode_t *);
13147c478bd9Sstevel@tonic-gate 
1315b5fca8f8Stomee int	vn_in_dnlc(vnode_t *);
1316b5fca8f8Stomee 
13177c478bd9Sstevel@tonic-gate void	vn_create_cache(void);
13187c478bd9Sstevel@tonic-gate void	vn_destroy_cache(void);
13197c478bd9Sstevel@tonic-gate 
13207c478bd9Sstevel@tonic-gate void	vn_freevnodeops(vnodeops_t *);
13217c478bd9Sstevel@tonic-gate 
13227c478bd9Sstevel@tonic-gate int	vn_open(char *pnamep, enum uio_seg seg, int filemode, int createmode,
13237c478bd9Sstevel@tonic-gate 		struct vnode **vpp, enum create crwhy, mode_t umask);
13247c478bd9Sstevel@tonic-gate int	vn_openat(char *pnamep, enum uio_seg seg, int filemode, int createmode,
13257c478bd9Sstevel@tonic-gate 		struct vnode **vpp, enum create crwhy,
1326da6c28aaSamw 		mode_t umask, struct vnode *startvp, int fd);
13277c478bd9Sstevel@tonic-gate int	vn_create(char *pnamep, enum uio_seg seg, struct vattr *vap,
13287c478bd9Sstevel@tonic-gate 		enum vcexcl excl, int mode, struct vnode **vpp,
13297c478bd9Sstevel@tonic-gate 		enum create why, int flag, mode_t umask);
13307c478bd9Sstevel@tonic-gate int	vn_createat(char *pnamep, enum uio_seg seg, struct vattr *vap,
13317c478bd9Sstevel@tonic-gate 		enum vcexcl excl, int mode, struct vnode **vpp,
13327c478bd9Sstevel@tonic-gate 		enum create why, int flag, mode_t umask, struct vnode *startvp);
13337c478bd9Sstevel@tonic-gate int	vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base, ssize_t len,
13347c478bd9Sstevel@tonic-gate 		offset_t offset, enum uio_seg seg, int ioflag, rlim64_t ulimit,
13357c478bd9Sstevel@tonic-gate 		cred_t *cr, ssize_t *residp);
13367c478bd9Sstevel@tonic-gate void	vn_rele(struct vnode *vp);
13379d3574bfSNeil Perrin void	vn_rele_async(struct vnode *vp, struct taskq *taskq);
1338b5fca8f8Stomee void	vn_rele_dnlc(struct vnode *vp);
13397c478bd9Sstevel@tonic-gate void	vn_rele_stream(struct vnode *vp);
13407c478bd9Sstevel@tonic-gate int	vn_link(char *from, char *to, enum uio_seg seg);
1341794f0adbSRoger A. Faulkner int	vn_linkat(vnode_t *fstartvp, char *from, enum symfollow follow,
1342794f0adbSRoger A. Faulkner 		vnode_t *tstartvp, char *to, enum uio_seg seg);
13437c478bd9Sstevel@tonic-gate int	vn_rename(char *from, char *to, enum uio_seg seg);
13447c478bd9Sstevel@tonic-gate int	vn_renameat(vnode_t *fdvp, char *fname, vnode_t *tdvp, char *tname,
13457c478bd9Sstevel@tonic-gate 		enum uio_seg seg);
13467c478bd9Sstevel@tonic-gate int	vn_remove(char *fnamep, enum uio_seg seg, enum rm dirflag);
13477c478bd9Sstevel@tonic-gate int	vn_removeat(vnode_t *startvp, char *fnamep, enum uio_seg seg,
13487c478bd9Sstevel@tonic-gate 		enum rm dirflag);
13497c478bd9Sstevel@tonic-gate int	vn_compare(vnode_t *vp1, vnode_t *vp2);
13507c478bd9Sstevel@tonic-gate int	vn_vfswlock(struct vnode *vp);
13517c478bd9Sstevel@tonic-gate int	vn_vfswlock_wait(struct vnode *vp);
13527c478bd9Sstevel@tonic-gate int	vn_vfsrlock(struct vnode *vp);
13537c478bd9Sstevel@tonic-gate int	vn_vfsrlock_wait(struct vnode *vp);
13547c478bd9Sstevel@tonic-gate void	vn_vfsunlock(struct vnode *vp);
13557c478bd9Sstevel@tonic-gate int	vn_vfswlock_held(struct vnode *vp);
13567c478bd9Sstevel@tonic-gate vnode_t *specvp(struct vnode *vp, dev_t dev, vtype_t type, struct cred *cr);
13577c478bd9Sstevel@tonic-gate vnode_t *makespecvp(dev_t dev, vtype_t type);
13587c478bd9Sstevel@tonic-gate vn_vfslocks_entry_t *vn_vfslocks_getlock(void *);
13597c478bd9Sstevel@tonic-gate void	vn_vfslocks_rele(vn_vfslocks_entry_t *);
13602f172c55SRobert Thurlow boolean_t vn_is_reparse(vnode_t *, cred_t *, caller_context_t *);
13617c478bd9Sstevel@tonic-gate 
1362ca2c3138Seschrock void vn_copypath(struct vnode *src, struct vnode *dst);
1363ca2c3138Seschrock void vn_setpath_str(struct vnode *vp, const char *str, size_t len);
1364ca2c3138Seschrock void vn_setpath(vnode_t *rootvp, struct vnode *startvp, struct vnode *vp,
1365ca2c3138Seschrock     const char *path, size_t plen);
136651ece835Seschrock void vn_renamepath(vnode_t *dvp, vnode_t *vp, const char *nm, size_t len);
1367ca2c3138Seschrock 
1368e2fc3408SPatrick Mooney /* Private vnode manipulation functions */
1369e2fc3408SPatrick Mooney void vn_clearpath(vnode_t *, hrtime_t);
1370e2fc3408SPatrick Mooney void vn_updatepath(vnode_t *, vnode_t *, const char *);
1371e2fc3408SPatrick Mooney 
1372e2fc3408SPatrick Mooney 
13737c478bd9Sstevel@tonic-gate /* Vnode event notification */
1374da6c28aaSamw void	vnevent_rename_src(vnode_t *, vnode_t *, char *, caller_context_t *);
1375da6c28aaSamw void	vnevent_rename_dest(vnode_t *, vnode_t *, char *, caller_context_t *);
1376da6c28aaSamw void	vnevent_remove(vnode_t *, vnode_t *, char *, caller_context_t *);
1377da6c28aaSamw void	vnevent_rmdir(vnode_t *, vnode_t *, char *, caller_context_t *);
1378da6c28aaSamw void	vnevent_create(vnode_t *, caller_context_t *);
1379da6c28aaSamw void	vnevent_link(vnode_t *, caller_context_t *);
1380da6c28aaSamw void	vnevent_rename_dest_dir(vnode_t *, caller_context_t *ct);
1381da6c28aaSamw void	vnevent_mountedover(vnode_t *, caller_context_t *);
138272102e74SBryan Cantrill void	vnevent_truncate(vnode_t *, caller_context_t *);
1383da6c28aaSamw int	vnevent_support(vnode_t *, caller_context_t *);
138454207fd2SJerry Jelinek void	vnevent_pre_rename_src(vnode_t *, vnode_t *, char *,
138554207fd2SJerry Jelinek 	    caller_context_t *);
138654207fd2SJerry Jelinek void	vnevent_pre_rename_dest(vnode_t *, vnode_t *, char *,
138754207fd2SJerry Jelinek 	    caller_context_t *);
138854207fd2SJerry Jelinek void	vnevent_pre_rename_dest_dir(vnode_t *, vnode_t *, char *,
138954207fd2SJerry Jelinek 	    caller_context_t *);
13907c478bd9Sstevel@tonic-gate 
13911b300de9Sjwahlig /* Vnode specific data */
13921b300de9Sjwahlig void vsd_create(uint_t *, void (*)(void *));
13931b300de9Sjwahlig void vsd_destroy(uint_t *);
13941b300de9Sjwahlig void *vsd_get(vnode_t *, uint_t);
13951b300de9Sjwahlig int vsd_set(vnode_t *, uint_t, void *);
13961b300de9Sjwahlig void vsd_free(vnode_t *);
13971b300de9Sjwahlig 
1398da6c28aaSamw /*
1399da6c28aaSamw  * Extensible vnode attribute (xva) routines:
1400da6c28aaSamw  * xva_init() initializes an xvattr_t (zero struct, init mapsize, set AT_XATTR)
1401da6c28aaSamw  * xva_getxoptattr() returns a ponter to the xoptattr_t section of xvattr_t
1402da6c28aaSamw  */
1403da6c28aaSamw void		xva_init(xvattr_t *);
1404da6c28aaSamw xoptattr_t	*xva_getxoptattr(xvattr_t *);	/* Get ptr to xoptattr_t */
1405da6c28aaSamw 
1406da6c28aaSamw void xattr_init(void);		/* Initialize vnodeops for xattrs */
1407da6c28aaSamw 
1408da6c28aaSamw /* GFS tunnel for xattrs */
1409da6c28aaSamw int xattr_dir_lookup(vnode_t *, vnode_t **, int, cred_t *);
1410da6c28aaSamw 
14117a286c47SDai Ngo /* Reparse Point */
14127a286c47SDai Ngo void reparse_point_init(void);
14137a286c47SDai Ngo 
14147c478bd9Sstevel@tonic-gate /* Context identification */
14157c478bd9Sstevel@tonic-gate u_longlong_t	fs_new_caller_id();
14167c478bd9Sstevel@tonic-gate 
14177c478bd9Sstevel@tonic-gate int	vn_vmpss_usepageio(vnode_t *);
14187c478bd9Sstevel@tonic-gate 
1419e2fc3408SPatrick Mooney /* Empty v_path placeholder */
1420e2fc3408SPatrick Mooney extern char *vn_vpath_empty;
1421e2fc3408SPatrick Mooney 
14227c478bd9Sstevel@tonic-gate /*
14237c478bd9Sstevel@tonic-gate  * Needed for use of IS_VMODSORT() in kernel.
14247c478bd9Sstevel@tonic-gate  */
14257c478bd9Sstevel@tonic-gate extern uint_t pvn_vmodsort_supported;
14267c478bd9Sstevel@tonic-gate 
1427ade42b55SSebastien Roy /*
1428ade42b55SSebastien Roy  * All changes to v_count should be done through VN_HOLD() or VN_RELE(), or
1429ade42b55SSebastien Roy  * one of their variants. This makes it possible to ensure proper locking,
1430ade42b55SSebastien Roy  * and to guarantee that all modifications are accompanied by a firing of
1431ade42b55SSebastien Roy  * the vn-hold or vn-rele SDT DTrace probe.
1432ade42b55SSebastien Roy  *
1433ade42b55SSebastien Roy  * Example DTrace command for tracing vnode references using these probes:
1434ade42b55SSebastien Roy  *
1435ade42b55SSebastien Roy  * dtrace -q -n 'sdt:::vn-hold,sdt:::vn-rele
1436ade42b55SSebastien Roy  * {
1437ade42b55SSebastien Roy  *	this->vp = (vnode_t *)arg0;
1438ade42b55SSebastien Roy  *	printf("%s %s(%p[%s]) %d\n", execname, probename, this->vp,
1439ade42b55SSebastien Roy  *	    this->vp->v_path == NULL ? "NULL" : stringof(this->vp->v_path),
1440ade42b55SSebastien Roy  *	    this->vp->v_count)
1441ade42b55SSebastien Roy  * }'
1442ade42b55SSebastien Roy  */
1443ade42b55SSebastien Roy #define	VN_HOLD_LOCKED(vp) {			\
1444ade42b55SSebastien Roy 	ASSERT(mutex_owned(&(vp)->v_lock));	\
1445ade42b55SSebastien Roy 	(vp)->v_count++;			\
1446ade42b55SSebastien Roy 	DTRACE_PROBE1(vn__hold, vnode_t *, vp);	\
1447ade42b55SSebastien Roy }
1448ade42b55SSebastien Roy 
1449ade42b55SSebastien Roy #define	VN_HOLD(vp)	{		\
1450ade42b55SSebastien Roy 	mutex_enter(&(vp)->v_lock);	\
1451ade42b55SSebastien Roy 	VN_HOLD_LOCKED(vp);		\
1452ade42b55SSebastien Roy 	mutex_exit(&(vp)->v_lock);	\
14537c478bd9Sstevel@tonic-gate }
14547c478bd9Sstevel@tonic-gate 
14557c478bd9Sstevel@tonic-gate #define	VN_RELE(vp)	{ \
14567c478bd9Sstevel@tonic-gate 	vn_rele(vp); \
14577c478bd9Sstevel@tonic-gate }
14587c478bd9Sstevel@tonic-gate 
14599d3574bfSNeil Perrin #define	VN_RELE_ASYNC(vp, taskq)	{ \
14609d3574bfSNeil Perrin 	vn_rele_async(vp, taskq); \
14619d3574bfSNeil Perrin }
14629d3574bfSNeil Perrin 
1463ade42b55SSebastien Roy #define	VN_RELE_LOCKED(vp) {			\
1464ade42b55SSebastien Roy 	ASSERT(mutex_owned(&(vp)->v_lock));	\
1465ade42b55SSebastien Roy 	ASSERT((vp)->v_count >= 1);		\
1466ade42b55SSebastien Roy 	(vp)->v_count--;			\
1467ade42b55SSebastien Roy 	DTRACE_PROBE1(vn__rele, vnode_t *, vp);	\
1468ade42b55SSebastien Roy }
1469ade42b55SSebastien Roy 
14707c478bd9Sstevel@tonic-gate #define	VN_SET_VFS_TYPE_DEV(vp, vfsp, type, dev)	{ \
14717c478bd9Sstevel@tonic-gate 	(vp)->v_vfsp = (vfsp); \
14727c478bd9Sstevel@tonic-gate 	(vp)->v_type = (type); \
14737c478bd9Sstevel@tonic-gate 	(vp)->v_rdev = (dev); \
14747c478bd9Sstevel@tonic-gate }
14757c478bd9Sstevel@tonic-gate 
14767c478bd9Sstevel@tonic-gate /*
14777c478bd9Sstevel@tonic-gate  * Compare two vnodes for equality.  In general this macro should be used
14787c478bd9Sstevel@tonic-gate  * in preference to calling VOP_CMP directly.
14797c478bd9Sstevel@tonic-gate  */
14807c478bd9Sstevel@tonic-gate #define	VN_CMP(VP1, VP2)	((VP1) == (VP2) ? 1 : 	\
14817c478bd9Sstevel@tonic-gate 	((VP1) && (VP2) && (vn_getops(VP1) == vn_getops(VP2)) ? \
1482da6c28aaSamw 	VOP_CMP(VP1, VP2, NULL) : 0))
14837c478bd9Sstevel@tonic-gate 
1484af4c679fSSean McEnroe /*
1485af4c679fSSean McEnroe  * Some well-known global vnodes used by the VM system to name pages.
1486af4c679fSSean McEnroe  */
1487af4c679fSSean McEnroe extern struct vnode kvps[];
1488af4c679fSSean McEnroe 
1489af4c679fSSean McEnroe typedef enum {
1490af4c679fSSean McEnroe 	KV_KVP,		/* vnode for all segkmem pages */
1491af4c679fSSean McEnroe 	KV_ZVP,		/* vnode for all ZFS pages */
1492*04909c8cSJohn Levon 	KV_VVP,		/* vnode for all VMM pages */
1493af4c679fSSean McEnroe #if defined(__sparc)
1494af4c679fSSean McEnroe 	KV_MPVP,	/* vnode for all page_t meta-pages */
1495af4c679fSSean McEnroe 	KV_PROMVP,	/* vnode for all PROM pages */
1496af4c679fSSean McEnroe #endif	/* __sparc */
1497af4c679fSSean McEnroe 	KV_MAX		/* total number of vnodes in kvps[] */
1498af4c679fSSean McEnroe } kvps_index_t;
1499ad23a2dbSjohansen 
1500af4c679fSSean McEnroe #define	VN_ISKAS(vp)	((vp) >= &kvps[0] && (vp) < &kvps[KV_MAX])
1501ad23a2dbSjohansen 
15027c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
15037c478bd9Sstevel@tonic-gate 
15047c478bd9Sstevel@tonic-gate /*
15057c478bd9Sstevel@tonic-gate  * Flags to VOP_SETATTR/VOP_GETATTR.
15067c478bd9Sstevel@tonic-gate  */
15077c478bd9Sstevel@tonic-gate #define	ATTR_UTIME	0x01	/* non-default utime(2) request */
15087c478bd9Sstevel@tonic-gate #define	ATTR_EXEC	0x02	/* invocation from exec(2) */
15097c478bd9Sstevel@tonic-gate #define	ATTR_COMM	0x04	/* yield common vp attributes */
15107c478bd9Sstevel@tonic-gate #define	ATTR_HINT	0x08	/* information returned will be `hint' */
15117c478bd9Sstevel@tonic-gate #define	ATTR_REAL	0x10	/* yield attributes of the real vp */
1512da6c28aaSamw #define	ATTR_NOACLCHECK	0x20	/* Don't check ACL when checking permissions */
1513b9238976Sth #define	ATTR_TRIGGER	0x40	/* Mount first if vnode is a trigger mount */
15147c478bd9Sstevel@tonic-gate /*
15157c478bd9Sstevel@tonic-gate  * Generally useful macros.
15167c478bd9Sstevel@tonic-gate  */
15177c478bd9Sstevel@tonic-gate #define	VBSIZE(vp)	((vp)->v_vfsp->vfs_bsize)
1518fa9e4066Sahrens 
1519fa9e4066Sahrens #define	VTOZONE(vp)	((vp)->v_vfsp->vfs_zone)
1520fa9e4066Sahrens 
15217c478bd9Sstevel@tonic-gate #define	NULLVP		((struct vnode *)0)
15227c478bd9Sstevel@tonic-gate #define	NULLVPP		((struct vnode **)0)
15237c478bd9Sstevel@tonic-gate 
15247c478bd9Sstevel@tonic-gate #ifdef	_KERNEL
15257c478bd9Sstevel@tonic-gate 
15267c478bd9Sstevel@tonic-gate /*
15277c478bd9Sstevel@tonic-gate  * Structure used while handling asynchronous VOP_PUTPAGE operations.
15287c478bd9Sstevel@tonic-gate  */
15297c478bd9Sstevel@tonic-gate struct async_reqs {
15307c478bd9Sstevel@tonic-gate 	struct async_reqs *a_next;	/* pointer to next arg struct */
15317c478bd9Sstevel@tonic-gate 	struct vnode *a_vp;		/* vnode pointer */
15327c478bd9Sstevel@tonic-gate 	u_offset_t a_off;			/* offset in file */
15337c478bd9Sstevel@tonic-gate 	uint_t a_len;			/* size of i/o request */
15347c478bd9Sstevel@tonic-gate 	int a_flags;			/* flags to indicate operation type */
15357c478bd9Sstevel@tonic-gate 	struct cred *a_cred;		/* cred pointer	*/
15367c478bd9Sstevel@tonic-gate 	ushort_t a_prealloced;		/* set if struct is pre-allocated */
15377c478bd9Sstevel@tonic-gate };
15387c478bd9Sstevel@tonic-gate 
15397c478bd9Sstevel@tonic-gate /*
15407c478bd9Sstevel@tonic-gate  * VN_DISPOSE() -- given a page pointer, safely invoke VOP_DISPOSE().
15412e0ea4c4SMichael Corcoran  * Note that there is no guarantee that the page passed in will be
15422e0ea4c4SMichael Corcoran  * freed.  If that is required, then a check after calling VN_DISPOSE would
15432e0ea4c4SMichael Corcoran  * be necessary to ensure the page was freed.
15447c478bd9Sstevel@tonic-gate  */
15457c478bd9Sstevel@tonic-gate #define	VN_DISPOSE(pp, flag, dn, cr)	{ \
1546ad23a2dbSjohansen 	if ((pp)->p_vnode != NULL && !VN_ISKAS((pp)->p_vnode)) \
1547da6c28aaSamw 		VOP_DISPOSE((pp)->p_vnode, (pp), (flag), (dn), (cr), NULL); \
15487c478bd9Sstevel@tonic-gate 	else if ((flag) == B_FREE) \
15497c478bd9Sstevel@tonic-gate 		page_free((pp), (dn)); \
15507c478bd9Sstevel@tonic-gate 	else \
15517c478bd9Sstevel@tonic-gate 		page_destroy((pp), (dn)); \
15527c478bd9Sstevel@tonic-gate 	}
15537c478bd9Sstevel@tonic-gate 
15547c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
15557c478bd9Sstevel@tonic-gate 
15567c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
15577c478bd9Sstevel@tonic-gate }
15587c478bd9Sstevel@tonic-gate #endif
15597c478bd9Sstevel@tonic-gate 
15607c478bd9Sstevel@tonic-gate #endif	/* _SYS_VNODE_H */
1561