xref: /illumos-gate/usr/src/uts/common/sys/vnode.h (revision d20abfaa)
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  */
217c478bd9Sstevel@tonic-gate /*
229d3574bfSNeil Perrin  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  */
257c478bd9Sstevel@tonic-gate 
267c478bd9Sstevel@tonic-gate /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
277c478bd9Sstevel@tonic-gate /*	  All Rights Reserved  	*/
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate /*
307c478bd9Sstevel@tonic-gate  * University Copyright- Copyright (c) 1982, 1986, 1988
317c478bd9Sstevel@tonic-gate  * The Regents of the University of California
327c478bd9Sstevel@tonic-gate  * All Rights Reserved
337c478bd9Sstevel@tonic-gate  *
347c478bd9Sstevel@tonic-gate  * University Acknowledgment- Portions of this document are derived from
357c478bd9Sstevel@tonic-gate  * software developed by the University of California, Berkeley, and its
367c478bd9Sstevel@tonic-gate  * contributors.
377c478bd9Sstevel@tonic-gate  */
387c478bd9Sstevel@tonic-gate 
397c478bd9Sstevel@tonic-gate #ifndef _SYS_VNODE_H
407c478bd9Sstevel@tonic-gate #define	_SYS_VNODE_H
417c478bd9Sstevel@tonic-gate 
427c478bd9Sstevel@tonic-gate #include <sys/types.h>
437c478bd9Sstevel@tonic-gate #include <sys/t_lock.h>
447c478bd9Sstevel@tonic-gate #include <sys/rwstlock.h>
457c478bd9Sstevel@tonic-gate #include <sys/time_impl.h>
467c478bd9Sstevel@tonic-gate #include <sys/cred.h>
477c478bd9Sstevel@tonic-gate #include <sys/uio.h>
487c478bd9Sstevel@tonic-gate #include <sys/resource.h>
497c478bd9Sstevel@tonic-gate #include <vm/seg_enum.h>
505a59a8b3Srsb #include <sys/kstat.h>
515a59a8b3Srsb #include <sys/kmem.h>
521b300de9Sjwahlig #include <sys/list.h>
537c478bd9Sstevel@tonic-gate #ifdef	_KERNEL
547c478bd9Sstevel@tonic-gate #include <sys/buf.h>
557c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
567c478bd9Sstevel@tonic-gate 
577c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
587c478bd9Sstevel@tonic-gate extern "C" {
597c478bd9Sstevel@tonic-gate #endif
607c478bd9Sstevel@tonic-gate 
615a59a8b3Srsb /*
625a59a8b3Srsb  * Statistics for all vnode operations.
635a59a8b3Srsb  * All operations record number of ops (since boot/mount/zero'ed).
645a59a8b3Srsb  * Certain I/O operations (read, write, readdir) also record number
655a59a8b3Srsb  * of bytes transferred.
665a59a8b3Srsb  * This appears in two places in the system: one is embedded in each
675a59a8b3Srsb  * vfs_t.  There is also an array of vopstats_t structures allocated
685a59a8b3Srsb  * on a per-fstype basis.
695a59a8b3Srsb  */
705a59a8b3Srsb 
715a59a8b3Srsb #define	VOPSTATS_STR	"vopstats_"	/* Initial string for vopstat kstats */
725a59a8b3Srsb 
735a59a8b3Srsb typedef struct vopstats {
745a59a8b3Srsb 	kstat_named_t	nopen;		/* VOP_OPEN */
755a59a8b3Srsb 	kstat_named_t	nclose;		/* VOP_CLOSE */
765a59a8b3Srsb 	kstat_named_t	nread;		/* VOP_READ */
775a59a8b3Srsb 	kstat_named_t	read_bytes;
785a59a8b3Srsb 	kstat_named_t	nwrite;		/* VOP_WRITE */
795a59a8b3Srsb 	kstat_named_t	write_bytes;
805a59a8b3Srsb 	kstat_named_t	nioctl;		/* VOP_IOCTL */
815a59a8b3Srsb 	kstat_named_t	nsetfl;		/* VOP_SETFL */
825a59a8b3Srsb 	kstat_named_t	ngetattr;	/* VOP_GETATTR */
835a59a8b3Srsb 	kstat_named_t	nsetattr;	/* VOP_SETATTR */
845a59a8b3Srsb 	kstat_named_t	naccess;	/* VOP_ACCESS */
855a59a8b3Srsb 	kstat_named_t	nlookup;	/* VOP_LOOKUP */
865a59a8b3Srsb 	kstat_named_t	ncreate;	/* VOP_CREATE */
875a59a8b3Srsb 	kstat_named_t	nremove;	/* VOP_REMOVE */
885a59a8b3Srsb 	kstat_named_t	nlink;		/* VOP_LINK */
895a59a8b3Srsb 	kstat_named_t	nrename;	/* VOP_RENAME */
905a59a8b3Srsb 	kstat_named_t	nmkdir;		/* VOP_MKDIR */
915a59a8b3Srsb 	kstat_named_t	nrmdir;		/* VOP_RMDIR */
925a59a8b3Srsb 	kstat_named_t	nreaddir;	/* VOP_READDIR */
935a59a8b3Srsb 	kstat_named_t	readdir_bytes;
945a59a8b3Srsb 	kstat_named_t	nsymlink;	/* VOP_SYMLINK */
955a59a8b3Srsb 	kstat_named_t	nreadlink;	/* VOP_READLINK */
965a59a8b3Srsb 	kstat_named_t	nfsync;		/* VOP_FSYNC */
975a59a8b3Srsb 	kstat_named_t	ninactive;	/* VOP_INACTIVE */
985a59a8b3Srsb 	kstat_named_t	nfid;		/* VOP_FID */
995a59a8b3Srsb 	kstat_named_t	nrwlock;	/* VOP_RWLOCK */
1005a59a8b3Srsb 	kstat_named_t	nrwunlock;	/* VOP_RWUNLOCK */
1015a59a8b3Srsb 	kstat_named_t	nseek;		/* VOP_SEEK */
1025a59a8b3Srsb 	kstat_named_t	ncmp;		/* VOP_CMP */
1035a59a8b3Srsb 	kstat_named_t	nfrlock;	/* VOP_FRLOCK */
1045a59a8b3Srsb 	kstat_named_t	nspace;		/* VOP_SPACE */
1055a59a8b3Srsb 	kstat_named_t	nrealvp;	/* VOP_REALVP */
1065a59a8b3Srsb 	kstat_named_t	ngetpage;	/* VOP_GETPAGE */
1075a59a8b3Srsb 	kstat_named_t	nputpage;	/* VOP_PUTPAGE */
1085a59a8b3Srsb 	kstat_named_t	nmap;		/* VOP_MAP */
1095a59a8b3Srsb 	kstat_named_t	naddmap;	/* VOP_ADDMAP */
1105a59a8b3Srsb 	kstat_named_t	ndelmap;	/* VOP_DELMAP */
1115a59a8b3Srsb 	kstat_named_t	npoll;		/* VOP_POLL */
1125a59a8b3Srsb 	kstat_named_t	ndump;		/* VOP_DUMP */
1135a59a8b3Srsb 	kstat_named_t	npathconf;	/* VOP_PATHCONF */
1145a59a8b3Srsb 	kstat_named_t	npageio;	/* VOP_PAGEIO */
1155a59a8b3Srsb 	kstat_named_t	ndumpctl;	/* VOP_DUMPCTL */
1165a59a8b3Srsb 	kstat_named_t	ndispose;	/* VOP_DISPOSE */
1175a59a8b3Srsb 	kstat_named_t	nsetsecattr;	/* VOP_SETSECATTR */
1185a59a8b3Srsb 	kstat_named_t	ngetsecattr;	/* VOP_GETSECATTR */
1195a59a8b3Srsb 	kstat_named_t	nshrlock;	/* VOP_SHRLOCK */
1205a59a8b3Srsb 	kstat_named_t	nvnevent;	/* VOP_VNEVENT */
1215a59a8b3Srsb } vopstats_t;
1225a59a8b3Srsb 
1237c478bd9Sstevel@tonic-gate /*
1247c478bd9Sstevel@tonic-gate  * The vnode is the focus of all file activity in UNIX.
1257c478bd9Sstevel@tonic-gate  * A vnode is allocated for each active file, each current
1267c478bd9Sstevel@tonic-gate  * directory, each mounted-on file, and the root.
1277c478bd9Sstevel@tonic-gate  *
1287c478bd9Sstevel@tonic-gate  * Each vnode is usually associated with a file-system-specific node (for
1297c478bd9Sstevel@tonic-gate  * UFS, this is the in-memory inode).  Generally, a vnode and an fs-node
1307c478bd9Sstevel@tonic-gate  * should be created and destroyed together as a pair.
1317c478bd9Sstevel@tonic-gate  *
1327c478bd9Sstevel@tonic-gate  * If a vnode is reused for a new file, it should be reinitialized by calling
1337c478bd9Sstevel@tonic-gate  * either vn_reinit() or vn_recycle().
1347c478bd9Sstevel@tonic-gate  *
1357c478bd9Sstevel@tonic-gate  * vn_reinit() resets the entire vnode as if it was returned by vn_alloc().
1367c478bd9Sstevel@tonic-gate  * The caller is responsible for setting up the entire vnode after calling
1377c478bd9Sstevel@tonic-gate  * vn_reinit().  This is important when using kmem caching where the vnode is
1387c478bd9Sstevel@tonic-gate  * allocated by a constructor, for instance.
1397c478bd9Sstevel@tonic-gate  *
1407c478bd9Sstevel@tonic-gate  * vn_recycle() is used when the file system keeps some state around in both
1417c478bd9Sstevel@tonic-gate  * the vnode and the associated FS-node.  In UFS, for example, the inode of
1427c478bd9Sstevel@tonic-gate  * a deleted file can be reused immediately.  The v_data, v_vfsp, v_op, etc.
1437c478bd9Sstevel@tonic-gate  * remains the same but certain fields related to the previous instance need
1447c478bd9Sstevel@tonic-gate  * to be reset.  In particular:
1457c478bd9Sstevel@tonic-gate  *	v_femhead
1467c478bd9Sstevel@tonic-gate  *	v_path
1477c478bd9Sstevel@tonic-gate  *	v_rdcnt, v_wrcnt
1487c478bd9Sstevel@tonic-gate  *	v_mmap_read, v_mmap_write
1497c478bd9Sstevel@tonic-gate  */
1507c478bd9Sstevel@tonic-gate 
1517c478bd9Sstevel@tonic-gate /*
1527c478bd9Sstevel@tonic-gate  * vnode types.  VNON means no type.  These values are unrelated to
1537c478bd9Sstevel@tonic-gate  * values in on-disk inodes.
1547c478bd9Sstevel@tonic-gate  */
1557c478bd9Sstevel@tonic-gate typedef enum vtype {
1567c478bd9Sstevel@tonic-gate 	VNON	= 0,
1577c478bd9Sstevel@tonic-gate 	VREG	= 1,
1587c478bd9Sstevel@tonic-gate 	VDIR	= 2,
1597c478bd9Sstevel@tonic-gate 	VBLK	= 3,
1607c478bd9Sstevel@tonic-gate 	VCHR	= 4,
1617c478bd9Sstevel@tonic-gate 	VLNK	= 5,
1627c478bd9Sstevel@tonic-gate 	VFIFO	= 6,
1637c478bd9Sstevel@tonic-gate 	VDOOR	= 7,
1647c478bd9Sstevel@tonic-gate 	VPROC	= 8,
1657c478bd9Sstevel@tonic-gate 	VSOCK	= 9,
1667c478bd9Sstevel@tonic-gate 	VPORT	= 10,
1677c478bd9Sstevel@tonic-gate 	VBAD	= 11
1687c478bd9Sstevel@tonic-gate } vtype_t;
1697c478bd9Sstevel@tonic-gate 
1701b300de9Sjwahlig /*
1711b300de9Sjwahlig  * VSD - Vnode Specific Data
1721b300de9Sjwahlig  * Used to associate additional private data with a vnode.
1731b300de9Sjwahlig  */
1741b300de9Sjwahlig struct vsd_node {
1751b300de9Sjwahlig 	list_node_t vs_nodes;		/* list of all VSD nodes */
1761b300de9Sjwahlig 	uint_t vs_nkeys;		/* entries in value array */
1771b300de9Sjwahlig 	void **vs_value;		/* array of value/key */
1781b300de9Sjwahlig };
1791b300de9Sjwahlig 
1807c478bd9Sstevel@tonic-gate /*
1817c478bd9Sstevel@tonic-gate  * Many of the fields in the vnode are read-only once they are initialized
1827c478bd9Sstevel@tonic-gate  * at vnode creation time.  Other fields are protected by locks.
1837c478bd9Sstevel@tonic-gate  *
1847c478bd9Sstevel@tonic-gate  * IMPORTANT: vnodes should be created ONLY by calls to vn_alloc().  They
1857c478bd9Sstevel@tonic-gate  * may not be embedded into the file-system specific node (inode).  The
1867c478bd9Sstevel@tonic-gate  * size of vnodes may change.
1877c478bd9Sstevel@tonic-gate  *
1887c478bd9Sstevel@tonic-gate  * The v_lock protects:
1897c478bd9Sstevel@tonic-gate  *   v_flag
1907c478bd9Sstevel@tonic-gate  *   v_stream
1917c478bd9Sstevel@tonic-gate  *   v_count
1927c478bd9Sstevel@tonic-gate  *   v_shrlocks
1937c478bd9Sstevel@tonic-gate  *   v_path
1941b300de9Sjwahlig  *   v_vsd
195da6c28aaSamw  *   v_xattrdir
1967c478bd9Sstevel@tonic-gate  *
1977c478bd9Sstevel@tonic-gate  * A special lock (implemented by vn_vfswlock in vnode.c) protects:
1987c478bd9Sstevel@tonic-gate  *   v_vfsmountedhere
1997c478bd9Sstevel@tonic-gate  *
2007c478bd9Sstevel@tonic-gate  * The global flock_lock mutex (in flock.c) protects:
2017c478bd9Sstevel@tonic-gate  *   v_filocks
2027c478bd9Sstevel@tonic-gate  *
2037c478bd9Sstevel@tonic-gate  * IMPORTANT NOTE:
2047c478bd9Sstevel@tonic-gate  *
2057c478bd9Sstevel@tonic-gate  *   The following vnode fields are considered public and may safely be
2067c478bd9Sstevel@tonic-gate  *   accessed by file systems or other consumers:
2077c478bd9Sstevel@tonic-gate  *
2087c478bd9Sstevel@tonic-gate  *     v_lock
2097c478bd9Sstevel@tonic-gate  *     v_flag
2107c478bd9Sstevel@tonic-gate  *     v_count
2117c478bd9Sstevel@tonic-gate  *     v_data
2127c478bd9Sstevel@tonic-gate  *     v_vfsp
2137c478bd9Sstevel@tonic-gate  *     v_stream
2147c478bd9Sstevel@tonic-gate  *     v_type
2157c478bd9Sstevel@tonic-gate  *     v_rdev
2167c478bd9Sstevel@tonic-gate  *
2177c478bd9Sstevel@tonic-gate  * ALL OTHER FIELDS SHOULD BE ACCESSED ONLY BY THE OWNER OF THAT FIELD.
2187c478bd9Sstevel@tonic-gate  * In particular, file systems should not access other fields; they may
2197c478bd9Sstevel@tonic-gate  * change or even be removed.  The functionality which was once provided
2207c478bd9Sstevel@tonic-gate  * by these fields is available through vn_* functions.
2217c478bd9Sstevel@tonic-gate  */
2227c478bd9Sstevel@tonic-gate 
2237c478bd9Sstevel@tonic-gate struct fem_head;	/* from fem.h */
2247c478bd9Sstevel@tonic-gate 
2257c478bd9Sstevel@tonic-gate typedef struct vnode {
2267c478bd9Sstevel@tonic-gate 	kmutex_t	v_lock;		/* protects vnode fields */
2277c478bd9Sstevel@tonic-gate 	uint_t		v_flag;		/* vnode flags (see below) */
2287c478bd9Sstevel@tonic-gate 	uint_t		v_count;	/* reference count */
2297c478bd9Sstevel@tonic-gate 	void		*v_data;	/* private data for fs */
2307c478bd9Sstevel@tonic-gate 	struct vfs	*v_vfsp;	/* ptr to containing VFS */
2317c478bd9Sstevel@tonic-gate 	struct stdata	*v_stream;	/* associated stream */
2327c478bd9Sstevel@tonic-gate 	enum vtype	v_type;		/* vnode type */
2337c478bd9Sstevel@tonic-gate 	dev_t		v_rdev;		/* device (VCHR, VBLK) */
2347c478bd9Sstevel@tonic-gate 
2357c478bd9Sstevel@tonic-gate 	/* PRIVATE FIELDS BELOW - DO NOT USE */
2367c478bd9Sstevel@tonic-gate 
2377c478bd9Sstevel@tonic-gate 	struct vfs	*v_vfsmountedhere; /* ptr to vfs mounted here */
2387c478bd9Sstevel@tonic-gate 	struct vnodeops	*v_op;		/* vnode operations */
2397c478bd9Sstevel@tonic-gate 	struct page	*v_pages;	/* vnode pages list */
2407c478bd9Sstevel@tonic-gate 	struct filock	*v_filocks;	/* ptr to filock list */
2417c478bd9Sstevel@tonic-gate 	struct shrlocklist *v_shrlocks;	/* ptr to shrlock list */
2427c478bd9Sstevel@tonic-gate 	krwlock_t	v_nbllock;	/* sync for NBMAND locks */
2437c478bd9Sstevel@tonic-gate 	kcondvar_t	v_cv;		/* synchronize locking */
2447c478bd9Sstevel@tonic-gate 	void		*v_locality;	/* hook for locality info */
2457c478bd9Sstevel@tonic-gate 	struct fem_head	*v_femhead;	/* fs monitoring */
2467c478bd9Sstevel@tonic-gate 	char		*v_path;	/* cached path */
2477c478bd9Sstevel@tonic-gate 	uint_t		v_rdcnt;	/* open for read count  (VREG only) */
2487c478bd9Sstevel@tonic-gate 	uint_t		v_wrcnt;	/* open for write count (VREG only) */
2497c478bd9Sstevel@tonic-gate 	u_longlong_t	v_mmap_read;	/* mmap read count */
2507c478bd9Sstevel@tonic-gate 	u_longlong_t	v_mmap_write;	/* mmap write count */
2517c478bd9Sstevel@tonic-gate 	void		*v_mpssdata;	/* info for large page mappings */
252df2381bfSpraks 	void		*v_fopdata;	/* list of file ops event watches */
253d216dff5SRobert Mastors 	kmutex_t	v_vsd_lock;	/* protects v_vsd field */
2541b300de9Sjwahlig 	struct vsd_node *v_vsd;		/* vnode specific data */
255da6c28aaSamw 	struct vnode	*v_xattrdir;	/* unnamed extended attr dir (GFS) */
256b5fca8f8Stomee 	uint_t		v_count_dnlc;	/* dnlc reference count */
2577c478bd9Sstevel@tonic-gate } vnode_t;
2587c478bd9Sstevel@tonic-gate 
2597c478bd9Sstevel@tonic-gate #define	IS_DEVVP(vp)	\
2607c478bd9Sstevel@tonic-gate 	((vp)->v_type == VCHR || (vp)->v_type == VBLK || (vp)->v_type == VFIFO)
2617c478bd9Sstevel@tonic-gate 
2627c478bd9Sstevel@tonic-gate /*
2637c478bd9Sstevel@tonic-gate  * vnode flags.
2647c478bd9Sstevel@tonic-gate  */
2657c478bd9Sstevel@tonic-gate #define	VROOT		0x01	/* root of its file system */
2667c478bd9Sstevel@tonic-gate #define	VNOCACHE	0x02	/* don't keep cache pages on vnode */
2677c478bd9Sstevel@tonic-gate #define	VNOMAP		0x04	/* file cannot be mapped/faulted */
2687c478bd9Sstevel@tonic-gate #define	VDUP		0x08	/* file should be dup'ed rather then opened */
2697c478bd9Sstevel@tonic-gate #define	VNOSWAP		0x10	/* file cannot be used as virtual swap device */
2707c478bd9Sstevel@tonic-gate #define	VNOMOUNT	0x20	/* file cannot be covered by mount */
2717c478bd9Sstevel@tonic-gate #define	VISSWAP		0x40	/* vnode is being used for swap */
2727c478bd9Sstevel@tonic-gate #define	VSWAPLIKE	0x80	/* vnode acts like swap (but may not be) */
2737c478bd9Sstevel@tonic-gate 
2747c478bd9Sstevel@tonic-gate #define	IS_SWAPVP(vp)	(((vp)->v_flag & (VISSWAP | VSWAPLIKE)) != 0)
2757c478bd9Sstevel@tonic-gate 
2767c478bd9Sstevel@tonic-gate typedef struct vn_vfslocks_entry {
2777c478bd9Sstevel@tonic-gate 	rwstlock_t ve_lock;
2787c478bd9Sstevel@tonic-gate 	void *ve_vpvfs;
2797c478bd9Sstevel@tonic-gate 	struct vn_vfslocks_entry *ve_next;
2807c478bd9Sstevel@tonic-gate 	uint32_t ve_refcnt;
2817c478bd9Sstevel@tonic-gate 	char pad[64 - sizeof (rwstlock_t) - 2 * sizeof (void *) - \
2827c478bd9Sstevel@tonic-gate 	    sizeof (uint32_t)];
2837c478bd9Sstevel@tonic-gate } vn_vfslocks_entry_t;
2847c478bd9Sstevel@tonic-gate 
2857c478bd9Sstevel@tonic-gate /*
2867c478bd9Sstevel@tonic-gate  * The following two flags are used to lock the v_vfsmountedhere field
2877c478bd9Sstevel@tonic-gate  */
2887c478bd9Sstevel@tonic-gate #define	VVFSLOCK	0x100
2897c478bd9Sstevel@tonic-gate #define	VVFSWAIT	0x200
2907c478bd9Sstevel@tonic-gate 
2917c478bd9Sstevel@tonic-gate /*
2927c478bd9Sstevel@tonic-gate  * Used to serialize VM operations on a vnode
2937c478bd9Sstevel@tonic-gate  */
2947c478bd9Sstevel@tonic-gate #define	VVMLOCK		0x400
2957c478bd9Sstevel@tonic-gate 
2967c478bd9Sstevel@tonic-gate /*
2977c478bd9Sstevel@tonic-gate  * Tell vn_open() not to fail a directory open for writing but
2987c478bd9Sstevel@tonic-gate  * to go ahead and call VOP_OPEN() to let the filesystem check.
2997c478bd9Sstevel@tonic-gate  */
3007c478bd9Sstevel@tonic-gate #define	VDIROPEN	0x800
3017c478bd9Sstevel@tonic-gate 
3027c478bd9Sstevel@tonic-gate /*
3037c478bd9Sstevel@tonic-gate  * Flag to let the VM system know that this file is most likely a binary
3047c478bd9Sstevel@tonic-gate  * or shared library since it has been mmap()ed EXEC at some time.
3057c478bd9Sstevel@tonic-gate  */
3067c478bd9Sstevel@tonic-gate #define	VVMEXEC		0x1000
3077c478bd9Sstevel@tonic-gate 
3087c478bd9Sstevel@tonic-gate #define	VPXFS		0x2000  /* clustering: global fs proxy vnode */
3097c478bd9Sstevel@tonic-gate 
3107c478bd9Sstevel@tonic-gate #define	IS_PXFSVP(vp)	((vp)->v_flag & VPXFS)
3117c478bd9Sstevel@tonic-gate 
3127c478bd9Sstevel@tonic-gate #define	V_XATTRDIR	0x4000	/* attribute unnamed directory */
3137c478bd9Sstevel@tonic-gate 
314ab04eb8eStimh #define	IS_XATTRDIR(vp)	((vp)->v_flag & V_XATTRDIR)
315ab04eb8eStimh 
3167c478bd9Sstevel@tonic-gate #define	V_LOCALITY	0x8000	/* whether locality aware */
3177c478bd9Sstevel@tonic-gate 
3187c478bd9Sstevel@tonic-gate /*
3197c478bd9Sstevel@tonic-gate  * Flag that indicates the VM should maintain the v_pages list with all modified
3207c478bd9Sstevel@tonic-gate  * pages on one end and unmodified pages at the other. This makes finding dirty
3217c478bd9Sstevel@tonic-gate  * pages to write back to disk much faster at the expense of taking a minor
3227c478bd9Sstevel@tonic-gate  * fault on the first store instruction which touches a writable page.
3237c478bd9Sstevel@tonic-gate  */
3247c478bd9Sstevel@tonic-gate #define	VMODSORT	(0x10000)
3257c478bd9Sstevel@tonic-gate #define	IS_VMODSORT(vp) \
3267c478bd9Sstevel@tonic-gate 	(pvn_vmodsort_supported != 0 && ((vp)->v_flag  & VMODSORT) != 0)
3277c478bd9Sstevel@tonic-gate 
3287c478bd9Sstevel@tonic-gate #define	VISSWAPFS	0x20000	/* vnode is being used for swapfs */
329*d20abfaaSPavel Tatashin 
330*d20abfaaSPavel Tatashin /*
331*d20abfaaSPavel Tatashin  * The mdb memstat command assumes that IS_SWAPFSVP only uses the
332*d20abfaaSPavel Tatashin  * vnode's v_flag field.  If this changes, cache the additional
333*d20abfaaSPavel Tatashin  * fields in mdb; see vn_get in mdb/common/modules/genunix/memory.c
334*d20abfaaSPavel Tatashin  */
3357c478bd9Sstevel@tonic-gate #define	IS_SWAPFSVP(vp)	(((vp)->v_flag & VISSWAPFS) != 0)
3367c478bd9Sstevel@tonic-gate 
337da6c28aaSamw #define	V_SYSATTR	0x40000	/* vnode is a GFS system attribute */
338da6c28aaSamw 
3397c478bd9Sstevel@tonic-gate /*
3407c478bd9Sstevel@tonic-gate  * Vnode attributes.  A bit-mask is supplied as part of the
3417c478bd9Sstevel@tonic-gate  * structure to indicate the attributes the caller wants to
3427c478bd9Sstevel@tonic-gate  * set (setattr) or extract (getattr).
3437c478bd9Sstevel@tonic-gate  */
3447c478bd9Sstevel@tonic-gate 
3457c478bd9Sstevel@tonic-gate /*
3467c478bd9Sstevel@tonic-gate  * Note that va_nodeid and va_nblocks are 64bit data type.
3477c478bd9Sstevel@tonic-gate  * We support large files over NFSV3. With Solaris client and
3487c478bd9Sstevel@tonic-gate  * Server that generates 64bit ino's and sizes these fields
3497c478bd9Sstevel@tonic-gate  * will overflow if they are 32 bit sizes.
3507c478bd9Sstevel@tonic-gate  */
3517c478bd9Sstevel@tonic-gate 
3527c478bd9Sstevel@tonic-gate typedef struct vattr {
3537c478bd9Sstevel@tonic-gate 	uint_t		va_mask;	/* bit-mask of attributes */
3547c478bd9Sstevel@tonic-gate 	vtype_t		va_type;	/* vnode type (for create) */
3557c478bd9Sstevel@tonic-gate 	mode_t		va_mode;	/* file access mode */
3567c478bd9Sstevel@tonic-gate 	uid_t		va_uid;		/* owner user id */
3577c478bd9Sstevel@tonic-gate 	gid_t		va_gid;		/* owner group id */
3587c478bd9Sstevel@tonic-gate 	dev_t		va_fsid;	/* file system id (dev for now) */
3597c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nodeid;	/* node id */
3607c478bd9Sstevel@tonic-gate 	nlink_t		va_nlink;	/* number of references to file */
3617c478bd9Sstevel@tonic-gate 	u_offset_t	va_size;	/* file size in bytes */
3627c478bd9Sstevel@tonic-gate 	timestruc_t	va_atime;	/* time of last access */
3637c478bd9Sstevel@tonic-gate 	timestruc_t	va_mtime;	/* time of last modification */
3647c478bd9Sstevel@tonic-gate 	timestruc_t	va_ctime;	/* time of last status change */
3657c478bd9Sstevel@tonic-gate 	dev_t		va_rdev;	/* device the file represents */
3667c478bd9Sstevel@tonic-gate 	uint_t		va_blksize;	/* fundamental block size */
3677c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nblocks;	/* # of blocks allocated */
3687c478bd9Sstevel@tonic-gate 	uint_t		va_seq;		/* sequence number */
3697c478bd9Sstevel@tonic-gate } vattr_t;
3707c478bd9Sstevel@tonic-gate 
371da6c28aaSamw #define	AV_SCANSTAMP_SZ	32		/* length of anti-virus scanstamp */
372da6c28aaSamw 
373da6c28aaSamw /*
374da6c28aaSamw  * Structure of all optional attributes.
375da6c28aaSamw  */
376da6c28aaSamw typedef struct xoptattr {
377da6c28aaSamw 	timestruc_t	xoa_createtime;	/* Create time of file */
378da6c28aaSamw 	uint8_t		xoa_archive;
379da6c28aaSamw 	uint8_t		xoa_system;
380da6c28aaSamw 	uint8_t		xoa_readonly;
381da6c28aaSamw 	uint8_t		xoa_hidden;
382da6c28aaSamw 	uint8_t		xoa_nounlink;
383da6c28aaSamw 	uint8_t		xoa_immutable;
384da6c28aaSamw 	uint8_t		xoa_appendonly;
385da6c28aaSamw 	uint8_t		xoa_nodump;
386da6c28aaSamw 	uint8_t		xoa_opaque;
387da6c28aaSamw 	uint8_t		xoa_av_quarantined;
388da6c28aaSamw 	uint8_t		xoa_av_modified;
389da6c28aaSamw 	uint8_t		xoa_av_scanstamp[AV_SCANSTAMP_SZ];
390da6c28aaSamw } xoptattr_t;
391da6c28aaSamw 
392da6c28aaSamw /*
393da6c28aaSamw  * The xvattr structure is really a variable length structure that
394da6c28aaSamw  * is made up of:
395da6c28aaSamw  * - The classic vattr_t (xva_vattr)
396da6c28aaSamw  * - a 32 bit quantity (xva_mapsize) that specifies the size of the
397da6c28aaSamw  *   attribute bitmaps in 32 bit words.
398da6c28aaSamw  * - A pointer to the returned attribute bitmap (needed because the
399da6c28aaSamw  *   previous element, the requested attribute bitmap) is variable lenth.
400da6c28aaSamw  * - The requested attribute bitmap, which is an array of 32 bit words.
401da6c28aaSamw  *   Callers use the XVA_SET_REQ() macro to set the bits corresponding to
402da6c28aaSamw  *   the attributes that are being requested.
403da6c28aaSamw  * - The returned attribute bitmap, which is an array of 32 bit words.
404da6c28aaSamw  *   File systems that support optional attributes use the XVA_SET_RTN()
405da6c28aaSamw  *   macro to set the bits corresponding to the attributes that are being
406da6c28aaSamw  *   returned.
407da6c28aaSamw  * - The xoptattr_t structure which contains the attribute values
408da6c28aaSamw  *
409da6c28aaSamw  * xva_mapsize determines how many words in the attribute bitmaps.
410da6c28aaSamw  * Immediately following the attribute bitmaps is the xoptattr_t.
411da6c28aaSamw  * xva_getxoptattr() is used to get the pointer to the xoptattr_t
412da6c28aaSamw  * section.
413da6c28aaSamw  */
414da6c28aaSamw 
415da6c28aaSamw #define	XVA_MAPSIZE	3		/* Size of attr bitmaps */
416da6c28aaSamw #define	XVA_MAGIC	0x78766174	/* Magic # for verification */
417da6c28aaSamw 
418da6c28aaSamw /*
419da6c28aaSamw  * The xvattr structure is an extensible structure which permits optional
420da6c28aaSamw  * attributes to be requested/returned.  File systems may or may not support
421da6c28aaSamw  * optional attributes.  They do so at their own discretion but if they do
422da6c28aaSamw  * support optional attributes, they must register the VFSFT_XVATTR feature
423da6c28aaSamw  * so that the optional attributes can be set/retrived.
424da6c28aaSamw  *
425da6c28aaSamw  * The fields of the xvattr structure are:
426da6c28aaSamw  *
427da6c28aaSamw  * xva_vattr - The first element of an xvattr is a legacy vattr structure
428da6c28aaSamw  * which includes the common attributes.  If AT_XVATTR is set in the va_mask
429da6c28aaSamw  * then the entire structure is treated as an xvattr.  If AT_XVATTR is not
430da6c28aaSamw  * set, then only the xva_vattr structure can be used.
431da6c28aaSamw  *
432da6c28aaSamw  * xva_magic - 0x78766174 (hex for "xvat"). Magic number for verification.
433da6c28aaSamw  *
434da6c28aaSamw  * xva_mapsize - Size of requested and returned attribute bitmaps.
435da6c28aaSamw  *
436da6c28aaSamw  * xva_rtnattrmapp - Pointer to xva_rtnattrmap[].  We need this since the
437da6c28aaSamw  * size of the array before it, xva_reqattrmap[], could change which means
438da6c28aaSamw  * the location of xva_rtnattrmap[] could change.  This will allow unbundled
439da6c28aaSamw  * file systems to find the location of xva_rtnattrmap[] when the sizes change.
440da6c28aaSamw  *
441da6c28aaSamw  * xva_reqattrmap[] - Array of requested attributes.  Attributes are
442da6c28aaSamw  * represented by a specific bit in a specific element of the attribute
443da6c28aaSamw  * map array.  Callers set the bits corresponding to the attributes
444da6c28aaSamw  * that the caller wants to get/set.
445da6c28aaSamw  *
446da6c28aaSamw  * xva_rtnattrmap[] - Array of attributes that the file system was able to
447da6c28aaSamw  * process.  Not all file systems support all optional attributes.  This map
448da6c28aaSamw  * informs the caller which attributes the underlying file system was able
449da6c28aaSamw  * to set/get.  (Same structure as the requested attributes array in terms
450da6c28aaSamw  * of each attribute  corresponding to specific bits and array elements.)
451da6c28aaSamw  *
452da6c28aaSamw  * xva_xoptattrs - Structure containing values of optional attributes.
453da6c28aaSamw  * These values are only valid if the corresponding bits in xva_reqattrmap
454da6c28aaSamw  * are set and the underlying file system supports those attributes.
455da6c28aaSamw  */
456da6c28aaSamw typedef struct xvattr {
457da6c28aaSamw 	vattr_t		xva_vattr;	/* Embedded vattr structure */
458da6c28aaSamw 	uint32_t	xva_magic;	/* Magic Number */
459da6c28aaSamw 	uint32_t	xva_mapsize;	/* Size of attr bitmap (32-bit words) */
460da6c28aaSamw 	uint32_t	*xva_rtnattrmapp;	/* Ptr to xva_rtnattrmap[] */
461da6c28aaSamw 	uint32_t	xva_reqattrmap[XVA_MAPSIZE];	/* Requested attrs */
462da6c28aaSamw 	uint32_t	xva_rtnattrmap[XVA_MAPSIZE];	/* Returned attrs */
463da6c28aaSamw 	xoptattr_t	xva_xoptattrs;	/* Optional attributes */
464da6c28aaSamw } xvattr_t;
465da6c28aaSamw 
4667c478bd9Sstevel@tonic-gate #ifdef _SYSCALL32
4677c478bd9Sstevel@tonic-gate /*
4687c478bd9Sstevel@tonic-gate  * For bigtypes time_t changed to 64 bit on the 64-bit kernel.
4697c478bd9Sstevel@tonic-gate  * Define an old version for user/kernel interface
4707c478bd9Sstevel@tonic-gate  */
4717c478bd9Sstevel@tonic-gate 
4727c478bd9Sstevel@tonic-gate #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
4737c478bd9Sstevel@tonic-gate #pragma pack(4)
4747c478bd9Sstevel@tonic-gate #endif
4757c478bd9Sstevel@tonic-gate 
4767c478bd9Sstevel@tonic-gate typedef struct vattr32 {
4777c478bd9Sstevel@tonic-gate 	uint32_t	va_mask;	/* bit-mask of attributes */
4787c478bd9Sstevel@tonic-gate 	vtype_t		va_type;	/* vnode type (for create) */
4797c478bd9Sstevel@tonic-gate 	mode32_t	va_mode;	/* file access mode */
4807c478bd9Sstevel@tonic-gate 	uid32_t		va_uid;		/* owner user id */
4817c478bd9Sstevel@tonic-gate 	gid32_t		va_gid;		/* owner group id */
4827c478bd9Sstevel@tonic-gate 	dev32_t		va_fsid;	/* file system id (dev for now) */
4837c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nodeid;	/* node id */
4847c478bd9Sstevel@tonic-gate 	nlink_t		va_nlink;	/* number of references to file */
4857c478bd9Sstevel@tonic-gate 	u_offset_t	va_size;	/* file size in bytes */
4867c478bd9Sstevel@tonic-gate 	timestruc32_t	va_atime;	/* time of last access */
4877c478bd9Sstevel@tonic-gate 	timestruc32_t	va_mtime;	/* time of last modification */
4887c478bd9Sstevel@tonic-gate 	timestruc32_t	va_ctime;	/* time of last status change */
4897c478bd9Sstevel@tonic-gate 	dev32_t		va_rdev;	/* device the file represents */
4907c478bd9Sstevel@tonic-gate 	uint32_t	va_blksize;	/* fundamental block size */
4917c478bd9Sstevel@tonic-gate 	u_longlong_t	va_nblocks;	/* # of blocks allocated */
4927c478bd9Sstevel@tonic-gate 	uint32_t	va_seq;		/* sequence number */
4937c478bd9Sstevel@tonic-gate } vattr32_t;
4947c478bd9Sstevel@tonic-gate 
4957c478bd9Sstevel@tonic-gate #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
4967c478bd9Sstevel@tonic-gate #pragma pack()
4977c478bd9Sstevel@tonic-gate #endif
4987c478bd9Sstevel@tonic-gate 
4997c478bd9Sstevel@tonic-gate #else  /* not _SYSCALL32 */
5007c478bd9Sstevel@tonic-gate #define	vattr32		vattr
5017c478bd9Sstevel@tonic-gate typedef vattr_t		vattr32_t;
5027c478bd9Sstevel@tonic-gate #endif /* _SYSCALL32 */
5037c478bd9Sstevel@tonic-gate 
5047c478bd9Sstevel@tonic-gate /*
5057c478bd9Sstevel@tonic-gate  * Attributes of interest to the caller of setattr or getattr.
5067c478bd9Sstevel@tonic-gate  */
507da6c28aaSamw #define	AT_TYPE		0x00001
508da6c28aaSamw #define	AT_MODE		0x00002
509da6c28aaSamw #define	AT_UID		0x00004
510da6c28aaSamw #define	AT_GID		0x00008
511da6c28aaSamw #define	AT_FSID		0x00010
512da6c28aaSamw #define	AT_NODEID	0x00020
513da6c28aaSamw #define	AT_NLINK	0x00040
514da6c28aaSamw #define	AT_SIZE		0x00080
515da6c28aaSamw #define	AT_ATIME	0x00100
516da6c28aaSamw #define	AT_MTIME	0x00200
517da6c28aaSamw #define	AT_CTIME	0x00400
518da6c28aaSamw #define	AT_RDEV		0x00800
519da6c28aaSamw #define	AT_BLKSIZE	0x01000
520da6c28aaSamw #define	AT_NBLOCKS	0x02000
521da6c28aaSamw /*			0x04000 */	/* unused */
522da6c28aaSamw #define	AT_SEQ		0x08000
523da6c28aaSamw /*
524da6c28aaSamw  * If AT_XVATTR is set then there are additional bits to process in
525da6c28aaSamw  * the xvattr_t's attribute bitmap.  If this is not set then the bitmap
526da6c28aaSamw  * MUST be ignored.  Note that this bit must be set/cleared explicitly.
527da6c28aaSamw  * That is, setting AT_ALL will NOT set AT_XVATTR.
528da6c28aaSamw  */
529da6c28aaSamw #define	AT_XVATTR	0x10000
5307c478bd9Sstevel@tonic-gate 
5317c478bd9Sstevel@tonic-gate #define	AT_ALL		(AT_TYPE|AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\
5327c478bd9Sstevel@tonic-gate 			AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\
5337c478bd9Sstevel@tonic-gate 			AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
5347c478bd9Sstevel@tonic-gate 
5357c478bd9Sstevel@tonic-gate #define	AT_STAT		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\
5367c478bd9Sstevel@tonic-gate 			AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV|AT_TYPE)
5377c478bd9Sstevel@tonic-gate 
5387c478bd9Sstevel@tonic-gate #define	AT_TIMES	(AT_ATIME|AT_MTIME|AT_CTIME)
5397c478bd9Sstevel@tonic-gate 
5407c478bd9Sstevel@tonic-gate #define	AT_NOSET	(AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|AT_TYPE|\
5417c478bd9Sstevel@tonic-gate 			AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
5427c478bd9Sstevel@tonic-gate 
543da6c28aaSamw /*
544da6c28aaSamw  * Attribute bits used in the extensible attribute's (xva's) attribute
545da6c28aaSamw  * bitmaps.  Note that the bitmaps are made up of a variable length number
546da6c28aaSamw  * of 32-bit words.  The convention is to use XAT{n}_{attrname} where "n"
547da6c28aaSamw  * is the element in the bitmap (starting at 1).  This convention is for
548da6c28aaSamw  * the convenience of the maintainer to keep track of which element each
549da6c28aaSamw  * attribute belongs to.
550da6c28aaSamw  *
551da6c28aaSamw  * NOTE THAT CONSUMERS MUST *NOT* USE THE XATn_* DEFINES DIRECTLY.  CONSUMERS
552da6c28aaSamw  * MUST USE THE XAT_* DEFINES.
553da6c28aaSamw  */
554da6c28aaSamw #define	XAT0_INDEX	0LL		/* Index into bitmap for XAT0 attrs */
555da6c28aaSamw #define	XAT0_CREATETIME	0x00000001	/* Create time of file */
556da6c28aaSamw #define	XAT0_ARCHIVE	0x00000002	/* Archive */
557da6c28aaSamw #define	XAT0_SYSTEM	0x00000004	/* System */
558da6c28aaSamw #define	XAT0_READONLY	0x00000008	/* Readonly */
559da6c28aaSamw #define	XAT0_HIDDEN	0x00000010	/* Hidden */
560da6c28aaSamw #define	XAT0_NOUNLINK	0x00000020	/* Nounlink */
561da6c28aaSamw #define	XAT0_IMMUTABLE	0x00000040	/* immutable */
562da6c28aaSamw #define	XAT0_APPENDONLY	0x00000080	/* appendonly */
563da6c28aaSamw #define	XAT0_NODUMP	0x00000100	/* nodump */
564da6c28aaSamw #define	XAT0_OPAQUE	0x00000200	/* opaque */
565da6c28aaSamw #define	XAT0_AV_QUARANTINED	0x00000400	/* anti-virus quarantine */
566da6c28aaSamw #define	XAT0_AV_MODIFIED	0x00000800	/* anti-virus modified */
567da6c28aaSamw #define	XAT0_AV_SCANSTAMP	0x00001000	/* anti-virus scanstamp */
568da6c28aaSamw 
569da6c28aaSamw #define	XAT0_ALL_ATTRS	(XAT0_CREATETIME|XAT0_ARCHIVE|XAT0_SYSTEM| \
570da6c28aaSamw     XAT0_READONLY|XAT0_HIDDEN|XAT0_NOUNLINK|XAT0_IMMUTABLE|XAT0_APPENDONLY| \
571da6c28aaSamw     XAT0_NODUMP|XAT0_OPAQUE|XAT0_AV_QUARANTINED| \
572da6c28aaSamw     XAT0_AV_MODIFIED|XAT0_AV_SCANSTAMP)
573da6c28aaSamw 
574da6c28aaSamw /* Support for XAT_* optional attributes */
575da6c28aaSamw #define	XVA_MASK		0xffffffff	/* Used to mask off 32 bits */
576da6c28aaSamw #define	XVA_SHFT		32		/* Used to shift index */
577da6c28aaSamw 
578da6c28aaSamw /*
579da6c28aaSamw  * Used to pry out the index and attribute bits from the XAT_* attributes
580da6c28aaSamw  * defined below.  Note that we're masking things down to 32 bits then
581da6c28aaSamw  * casting to uint32_t.
582da6c28aaSamw  */
583da6c28aaSamw #define	XVA_INDEX(attr)		((uint32_t)(((attr) >> XVA_SHFT) & XVA_MASK))
584da6c28aaSamw #define	XVA_ATTRBIT(attr)	((uint32_t)((attr) & XVA_MASK))
585da6c28aaSamw 
586da6c28aaSamw /*
587da6c28aaSamw  * The following defines present a "flat namespace" so that consumers don't
588da6c28aaSamw  * need to keep track of which element belongs to which bitmap entry.
589da6c28aaSamw  *
590da6c28aaSamw  * NOTE THAT THESE MUST NEVER BE OR-ed TOGETHER
591da6c28aaSamw  */
592da6c28aaSamw #define	XAT_CREATETIME		((XAT0_INDEX << XVA_SHFT) | XAT0_CREATETIME)
593da6c28aaSamw #define	XAT_ARCHIVE		((XAT0_INDEX << XVA_SHFT) | XAT0_ARCHIVE)
594da6c28aaSamw #define	XAT_SYSTEM		((XAT0_INDEX << XVA_SHFT) | XAT0_SYSTEM)
595da6c28aaSamw #define	XAT_READONLY		((XAT0_INDEX << XVA_SHFT) | XAT0_READONLY)
596da6c28aaSamw #define	XAT_HIDDEN		((XAT0_INDEX << XVA_SHFT) | XAT0_HIDDEN)
597da6c28aaSamw #define	XAT_NOUNLINK		((XAT0_INDEX << XVA_SHFT) | XAT0_NOUNLINK)
598da6c28aaSamw #define	XAT_IMMUTABLE		((XAT0_INDEX << XVA_SHFT) | XAT0_IMMUTABLE)
599da6c28aaSamw #define	XAT_APPENDONLY		((XAT0_INDEX << XVA_SHFT) | XAT0_APPENDONLY)
600da6c28aaSamw #define	XAT_NODUMP		((XAT0_INDEX << XVA_SHFT) | XAT0_NODUMP)
601da6c28aaSamw #define	XAT_OPAQUE		((XAT0_INDEX << XVA_SHFT) | XAT0_OPAQUE)
602da6c28aaSamw #define	XAT_AV_QUARANTINED	((XAT0_INDEX << XVA_SHFT) | XAT0_AV_QUARANTINED)
603da6c28aaSamw #define	XAT_AV_MODIFIED		((XAT0_INDEX << XVA_SHFT) | XAT0_AV_MODIFIED)
604da6c28aaSamw #define	XAT_AV_SCANSTAMP	((XAT0_INDEX << XVA_SHFT) | XAT0_AV_SCANSTAMP)
605da6c28aaSamw 
606da6c28aaSamw /*
607da6c28aaSamw  * The returned attribute map array (xva_rtnattrmap[]) is located past the
608da6c28aaSamw  * requested attribute map array (xva_reqattrmap[]).  Its location changes
609da6c28aaSamw  * when the array sizes change.  We use a separate pointer in a known location
610da6c28aaSamw  * (xva_rtnattrmapp) to hold the location of xva_rtnattrmap[].  This is
611da6c28aaSamw  * set in xva_init()
612da6c28aaSamw  */
613da6c28aaSamw #define	XVA_RTNATTRMAP(xvap)	((xvap)->xva_rtnattrmapp)
614da6c28aaSamw 
615da6c28aaSamw /*
616da6c28aaSamw  * XVA_SET_REQ() sets an attribute bit in the proper element in the bitmap
617da6c28aaSamw  * of requested attributes (xva_reqattrmap[]).
618da6c28aaSamw  */
619da6c28aaSamw #define	XVA_SET_REQ(xvap, attr)					\
620da6c28aaSamw 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
621da6c28aaSamw 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
622da6c28aaSamw 	(xvap)->xva_reqattrmap[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
623ae4caef8SMark Shellenbaum /*
624ae4caef8SMark Shellenbaum  * XVA_CLR_REQ() clears an attribute bit in the proper element in the bitmap
625ae4caef8SMark Shellenbaum  * of requested attributes (xva_reqattrmap[]).
626ae4caef8SMark Shellenbaum  */
627ae4caef8SMark Shellenbaum #define	XVA_CLR_REQ(xvap, attr)					\
628ae4caef8SMark Shellenbaum 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
629ae4caef8SMark Shellenbaum 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
630ae4caef8SMark Shellenbaum 	(xvap)->xva_reqattrmap[XVA_INDEX(attr)] &= ~XVA_ATTRBIT(attr)
631da6c28aaSamw 
632da6c28aaSamw /*
633da6c28aaSamw  * XVA_SET_RTN() sets an attribute bit in the proper element in the bitmap
634da6c28aaSamw  * of returned attributes (xva_rtnattrmap[]).
635da6c28aaSamw  */
636da6c28aaSamw #define	XVA_SET_RTN(xvap, attr)					\
637da6c28aaSamw 	ASSERT((xvap)->xva_vattr.va_mask | AT_XVATTR);		\
638da6c28aaSamw 	ASSERT((xvap)->xva_magic == XVA_MAGIC);			\
639da6c28aaSamw 	(XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] |= XVA_ATTRBIT(attr)
640da6c28aaSamw 
641da6c28aaSamw /*
642da6c28aaSamw  * XVA_ISSET_REQ() checks the requested attribute bitmap (xva_reqattrmap[])
643da6c28aaSamw  * to see of the corresponding attribute bit is set.  If so, returns non-zero.
644da6c28aaSamw  */
645da6c28aaSamw #define	XVA_ISSET_REQ(xvap, attr)					\
646da6c28aaSamw 	((((xvap)->xva_vattr.va_mask | AT_XVATTR) &&			\
647da6c28aaSamw 		((xvap)->xva_magic == XVA_MAGIC) &&			\
648da6c28aaSamw 		((xvap)->xva_mapsize > XVA_INDEX(attr))) ?		\
649da6c28aaSamw 	((xvap)->xva_reqattrmap[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) :	0)
650da6c28aaSamw 
651da6c28aaSamw /*
652da6c28aaSamw  * XVA_ISSET_RTN() checks the returned attribute bitmap (xva_rtnattrmap[])
653da6c28aaSamw  * to see of the corresponding attribute bit is set.  If so, returns non-zero.
654da6c28aaSamw  */
655da6c28aaSamw #define	XVA_ISSET_RTN(xvap, attr)					\
656da6c28aaSamw 	((((xvap)->xva_vattr.va_mask | AT_XVATTR) &&			\
657da6c28aaSamw 		((xvap)->xva_magic == XVA_MAGIC) &&			\
658da6c28aaSamw 		((xvap)->xva_mapsize > XVA_INDEX(attr))) ?		\
659da6c28aaSamw 	((XVA_RTNATTRMAP(xvap))[XVA_INDEX(attr)] & XVA_ATTRBIT(attr)) : 0)
660da6c28aaSamw 
6617c478bd9Sstevel@tonic-gate /*
6627c478bd9Sstevel@tonic-gate  *  Modes.  Some values same as S_xxx entries from stat.h for convenience.
6637c478bd9Sstevel@tonic-gate  */
6647c478bd9Sstevel@tonic-gate #define	VSUID		04000		/* set user id on execution */
6657c478bd9Sstevel@tonic-gate #define	VSGID		02000		/* set group id on execution */
6667c478bd9Sstevel@tonic-gate #define	VSVTX		01000		/* save swapped text even after use */
6677c478bd9Sstevel@tonic-gate 
6687c478bd9Sstevel@tonic-gate /*
6697c478bd9Sstevel@tonic-gate  * Permissions.
6707c478bd9Sstevel@tonic-gate  */
6717c478bd9Sstevel@tonic-gate #define	VREAD		00400
6727c478bd9Sstevel@tonic-gate #define	VWRITE		00200
6737c478bd9Sstevel@tonic-gate #define	VEXEC		00100
6747c478bd9Sstevel@tonic-gate 
6757c478bd9Sstevel@tonic-gate #define	MODEMASK	07777		/* mode bits plus permission bits */
6767c478bd9Sstevel@tonic-gate #define	PERMMASK	00777		/* permission bits */
6777c478bd9Sstevel@tonic-gate 
678da6c28aaSamw /*
679da6c28aaSamw  * VOP_ACCESS flags
680da6c28aaSamw  */
681da6c28aaSamw #define	V_ACE_MASK	0x1	/* mask represents  NFSv4 ACE permissions */
682da6c28aaSamw #define	V_APPEND	0x2	/* want to do append only check */
683da6c28aaSamw 
6847c478bd9Sstevel@tonic-gate /*
6857c478bd9Sstevel@tonic-gate  * Check whether mandatory file locking is enabled.
6867c478bd9Sstevel@tonic-gate  */
6877c478bd9Sstevel@tonic-gate 
6887c478bd9Sstevel@tonic-gate #define	MANDMODE(mode)		(((mode) & (VSGID|(VEXEC>>3))) == VSGID)
6897c478bd9Sstevel@tonic-gate #define	MANDLOCK(vp, mode)	((vp)->v_type == VREG && MANDMODE(mode))
6907c478bd9Sstevel@tonic-gate 
6917c478bd9Sstevel@tonic-gate /*
6927c478bd9Sstevel@tonic-gate  * Flags for vnode operations.
6937c478bd9Sstevel@tonic-gate  */
6947c478bd9Sstevel@tonic-gate enum rm		{ RMFILE, RMDIRECTORY };	/* rm or rmdir (remove) */
6957c478bd9Sstevel@tonic-gate enum symfollow	{ NO_FOLLOW, FOLLOW };		/* follow symlinks (or not) */
6967c478bd9Sstevel@tonic-gate enum vcexcl	{ NONEXCL, EXCL };		/* (non)excl create */
6977c478bd9Sstevel@tonic-gate enum create	{ CRCREAT, CRMKNOD, CRMKDIR };	/* reason for create */
6987c478bd9Sstevel@tonic-gate 
6997c478bd9Sstevel@tonic-gate typedef enum rm		rm_t;
7007c478bd9Sstevel@tonic-gate typedef enum symfollow	symfollow_t;
7017c478bd9Sstevel@tonic-gate typedef enum vcexcl	vcexcl_t;
7027c478bd9Sstevel@tonic-gate typedef enum create	create_t;
7037c478bd9Sstevel@tonic-gate 
7047c478bd9Sstevel@tonic-gate /* Vnode Events - Used by VOP_VNEVENT */
7057c478bd9Sstevel@tonic-gate typedef enum vnevent	{
7067c478bd9Sstevel@tonic-gate 	VE_SUPPORT	= 0,	/* Query */
7077c478bd9Sstevel@tonic-gate 	VE_RENAME_SRC	= 1,	/* Rename, with vnode as source */
7087c478bd9Sstevel@tonic-gate 	VE_RENAME_DEST	= 2,	/* Rename, with vnode as target/destination */
7097c478bd9Sstevel@tonic-gate 	VE_REMOVE	= 3,	/* Remove of vnode's name */
710df2381bfSpraks 	VE_RMDIR	= 4,	/* Remove of directory vnode's name */
711df2381bfSpraks 	VE_CREATE	= 5,	/* Create with vnode's name which exists */
712df2381bfSpraks 	VE_LINK		= 6, 	/* Link with vnode's name as source */
713df2381bfSpraks 	VE_RENAME_DEST_DIR	= 7, 	/* Rename with vnode as target dir */
714df2381bfSpraks 	VE_MOUNTEDOVER	= 8 	/* File or Filesystem got mounted over vnode */
7157c478bd9Sstevel@tonic-gate } vnevent_t;
7167c478bd9Sstevel@tonic-gate 
7177c478bd9Sstevel@tonic-gate /*
7187c478bd9Sstevel@tonic-gate  * Values for checking vnode open and map counts
7197c478bd9Sstevel@tonic-gate  */
7207c478bd9Sstevel@tonic-gate enum v_mode { V_READ, V_WRITE, V_RDORWR, V_RDANDWR };
7217c478bd9Sstevel@tonic-gate 
7227c478bd9Sstevel@tonic-gate typedef enum v_mode v_mode_t;
7237c478bd9Sstevel@tonic-gate 
7247c478bd9Sstevel@tonic-gate #define	V_TRUE	1
7257c478bd9Sstevel@tonic-gate #define	V_FALSE	0
7267c478bd9Sstevel@tonic-gate 
7277c478bd9Sstevel@tonic-gate /*
7287c478bd9Sstevel@tonic-gate  * Structure used on VOP_GETSECATTR and VOP_SETSECATTR operations
7297c478bd9Sstevel@tonic-gate  */
7307c478bd9Sstevel@tonic-gate 
7317c478bd9Sstevel@tonic-gate typedef struct vsecattr {
7327c478bd9Sstevel@tonic-gate 	uint_t		vsa_mask;	/* See below */
7337c478bd9Sstevel@tonic-gate 	int		vsa_aclcnt;	/* ACL entry count */
7347c478bd9Sstevel@tonic-gate 	void		*vsa_aclentp;	/* pointer to ACL entries */
7357c478bd9Sstevel@tonic-gate 	int		vsa_dfaclcnt;	/* default ACL entry count */
7367c478bd9Sstevel@tonic-gate 	void		*vsa_dfaclentp;	/* pointer to default ACL entries */
737da6c28aaSamw 	size_t		vsa_aclentsz;	/* ACE size in bytes of vsa_aclentp */
738da6c28aaSamw 	uint_t		vsa_aclflags;	/* ACE ACL flags */
7397c478bd9Sstevel@tonic-gate } vsecattr_t;
7407c478bd9Sstevel@tonic-gate 
7417c478bd9Sstevel@tonic-gate /* vsa_mask values */
742da6c28aaSamw #define	VSA_ACL			0x0001
743da6c28aaSamw #define	VSA_ACLCNT		0x0002
744da6c28aaSamw #define	VSA_DFACL		0x0004
745da6c28aaSamw #define	VSA_DFACLCNT		0x0008
746da6c28aaSamw #define	VSA_ACE			0x0010
747da6c28aaSamw #define	VSA_ACECNT		0x0020
748da6c28aaSamw #define	VSA_ACE_ALLTYPES	0x0040
749da6c28aaSamw #define	VSA_ACE_ACLFLAGS	0x0080	/* get/set ACE ACL flags */
7507c478bd9Sstevel@tonic-gate 
7517c478bd9Sstevel@tonic-gate /*
7527c478bd9Sstevel@tonic-gate  * Structure used by various vnode operations to determine
7537c478bd9Sstevel@tonic-gate  * the context (pid, host, identity) of a caller.
7547c478bd9Sstevel@tonic-gate  *
7557c478bd9Sstevel@tonic-gate  * The cc_caller_id is used to identify one or more callers who invoke
7567c478bd9Sstevel@tonic-gate  * operations, possibly on behalf of others.  For example, the NFS
7577c478bd9Sstevel@tonic-gate  * server could have it's own cc_caller_id which can be detected by
7587c478bd9Sstevel@tonic-gate  * vnode/vfs operations or (FEM) monitors on those operations.  New
7597c478bd9Sstevel@tonic-gate  * caller IDs are generated by fs_new_caller_id().
7607c478bd9Sstevel@tonic-gate  */
7617c478bd9Sstevel@tonic-gate typedef struct caller_context {
7627c478bd9Sstevel@tonic-gate 	pid_t		cc_pid;		/* Process ID of the caller */
7637c478bd9Sstevel@tonic-gate 	int		cc_sysid;	/* System ID, used for remote calls */
7647c478bd9Sstevel@tonic-gate 	u_longlong_t	cc_caller_id;	/* Identifier for (set of) caller(s) */
765cfae96c2Sjwahlig 	ulong_t		cc_flags;
7667c478bd9Sstevel@tonic-gate } caller_context_t;
7677c478bd9Sstevel@tonic-gate 
768cfae96c2Sjwahlig /*
769cfae96c2Sjwahlig  * Flags for caller context.  The caller sets CC_DONTBLOCK if it does not
770cfae96c2Sjwahlig  * want to block inside of a FEM monitor.  The monitor will set CC_WOULDBLOCK
771cfae96c2Sjwahlig  * and return EAGAIN if the operation would have blocked.
772cfae96c2Sjwahlig  */
773cfae96c2Sjwahlig #define	CC_WOULDBLOCK	0x01
774cfae96c2Sjwahlig #define	CC_DONTBLOCK	0x02
775cfae96c2Sjwahlig 
7767c478bd9Sstevel@tonic-gate /*
7777c478bd9Sstevel@tonic-gate  * Structure tags for function prototypes, defined elsewhere.
7787c478bd9Sstevel@tonic-gate  */
7797c478bd9Sstevel@tonic-gate struct pathname;
7807c478bd9Sstevel@tonic-gate struct fid;
7817c478bd9Sstevel@tonic-gate struct flock64;
7827c478bd9Sstevel@tonic-gate struct flk_callback;
7837c478bd9Sstevel@tonic-gate struct shrlock;
7847c478bd9Sstevel@tonic-gate struct page;
7857c478bd9Sstevel@tonic-gate struct seg;
7867c478bd9Sstevel@tonic-gate struct as;
7877c478bd9Sstevel@tonic-gate struct pollhead;
7889d3574bfSNeil Perrin struct taskq;
7897c478bd9Sstevel@tonic-gate 
790aa59c4cbSrsb #ifdef	_KERNEL
791aa59c4cbSrsb 
7927c478bd9Sstevel@tonic-gate /*
793aa59c4cbSrsb  * VNODE_OPS defines all the vnode operations.  It is used to define
794aa59c4cbSrsb  * the vnodeops structure (below) and the fs_func_p union (vfs_opreg.h).
795aa59c4cbSrsb  */
796aa59c4cbSrsb #define	VNODE_OPS							\
797da6c28aaSamw 	int	(*vop_open)(vnode_t **, int, cred_t *,			\
798da6c28aaSamw 				caller_context_t *);			\
799da6c28aaSamw 	int	(*vop_close)(vnode_t *, int, int, offset_t, cred_t *,	\
800da6c28aaSamw 				caller_context_t *);			\
801aa59c4cbSrsb 	int	(*vop_read)(vnode_t *, uio_t *, int, cred_t *,		\
802aa59c4cbSrsb 				caller_context_t *);			\
803aa59c4cbSrsb 	int	(*vop_write)(vnode_t *, uio_t *, int, cred_t *,		\
804aa59c4cbSrsb 				caller_context_t *);			\
805aa59c4cbSrsb 	int	(*vop_ioctl)(vnode_t *, int, intptr_t, int, cred_t *,	\
806da6c28aaSamw 				int *, caller_context_t *);		\
807da6c28aaSamw 	int	(*vop_setfl)(vnode_t *, int, int, cred_t *,		\
808da6c28aaSamw 				caller_context_t *);			\
809da6c28aaSamw 	int	(*vop_getattr)(vnode_t *, vattr_t *, int, cred_t *,	\
810da6c28aaSamw 				caller_context_t *);			\
811aa59c4cbSrsb 	int	(*vop_setattr)(vnode_t *, vattr_t *, int, cred_t *,	\
812aa59c4cbSrsb 				caller_context_t *);			\
813da6c28aaSamw 	int	(*vop_access)(vnode_t *, int, int, cred_t *,		\
814da6c28aaSamw 				caller_context_t *);			\
815aa59c4cbSrsb 	int	(*vop_lookup)(vnode_t *, char *, vnode_t **,		\
816aa59c4cbSrsb 				struct pathname *,			\
817da6c28aaSamw 				int, vnode_t *, cred_t *,		\
818da6c28aaSamw 				caller_context_t *, int *,		\
819da6c28aaSamw 				struct pathname *);			\
820aa59c4cbSrsb 	int	(*vop_create)(vnode_t *, char *, vattr_t *, vcexcl_t,	\
821da6c28aaSamw 				int, vnode_t **, cred_t *, int,		\
822da6c28aaSamw 				caller_context_t *, vsecattr_t *);	\
823da6c28aaSamw 	int	(*vop_remove)(vnode_t *, char *, cred_t *,		\
824da6c28aaSamw 				caller_context_t *, int);		\
825da6c28aaSamw 	int	(*vop_link)(vnode_t *, vnode_t *, char *, cred_t *,	\
826da6c28aaSamw 				caller_context_t *, int);		\
827aa59c4cbSrsb 	int	(*vop_rename)(vnode_t *, char *, vnode_t *, char *,	\
828da6c28aaSamw 				cred_t *, caller_context_t *, int);	\
829aa59c4cbSrsb 	int	(*vop_mkdir)(vnode_t *, char *, vattr_t *, vnode_t **,	\
830da6c28aaSamw 				cred_t *, caller_context_t *, int,	\
831da6c28aaSamw 				vsecattr_t *);				\
832da6c28aaSamw 	int	(*vop_rmdir)(vnode_t *, char *, vnode_t *, cred_t *,	\
833da6c28aaSamw 				caller_context_t *, int);		\
834da6c28aaSamw 	int	(*vop_readdir)(vnode_t *, uio_t *, cred_t *, int *,	\
835da6c28aaSamw 				caller_context_t *, int);		\
836aa59c4cbSrsb 	int	(*vop_symlink)(vnode_t *, char *, vattr_t *, char *,	\
837da6c28aaSamw 				cred_t *, caller_context_t *, int);	\
838da6c28aaSamw 	int	(*vop_readlink)(vnode_t *, uio_t *, cred_t *,		\
839da6c28aaSamw 				caller_context_t *);			\
840da6c28aaSamw 	int	(*vop_fsync)(vnode_t *, int, cred_t *,			\
841da6c28aaSamw 				caller_context_t *);			\
842da6c28aaSamw 	void	(*vop_inactive)(vnode_t *, cred_t *,			\
843da6c28aaSamw 				caller_context_t *);			\
844da6c28aaSamw 	int	(*vop_fid)(vnode_t *, struct fid *,			\
845da6c28aaSamw 				caller_context_t *);			\
846aa59c4cbSrsb 	int	(*vop_rwlock)(vnode_t *, int, caller_context_t *);	\
847aa59c4cbSrsb 	void	(*vop_rwunlock)(vnode_t *, int, caller_context_t *);	\
848da6c28aaSamw 	int	(*vop_seek)(vnode_t *, offset_t, offset_t *,		\
849da6c28aaSamw 				caller_context_t *);			\
850da6c28aaSamw 	int	(*vop_cmp)(vnode_t *, vnode_t *, caller_context_t *);	\
851aa59c4cbSrsb 	int	(*vop_frlock)(vnode_t *, int, struct flock64 *,		\
852aa59c4cbSrsb 				int, offset_t,				\
853da6c28aaSamw 				struct flk_callback *, cred_t *,	\
854da6c28aaSamw 				caller_context_t *);			\
855aa59c4cbSrsb 	int	(*vop_space)(vnode_t *, int, struct flock64 *,		\
856aa59c4cbSrsb 				int, offset_t,				\
857aa59c4cbSrsb 				cred_t *, caller_context_t *);		\
858da6c28aaSamw 	int	(*vop_realvp)(vnode_t *, vnode_t **,			\
859da6c28aaSamw 				caller_context_t *);			\
860aa59c4cbSrsb 	int	(*vop_getpage)(vnode_t *, offset_t, size_t, uint_t *,	\
861aa59c4cbSrsb 				struct page **, size_t, struct seg *,	\
862da6c28aaSamw 				caddr_t, enum seg_rw, cred_t *,		\
863da6c28aaSamw 				caller_context_t *);			\
864aa59c4cbSrsb 	int	(*vop_putpage)(vnode_t *, offset_t, size_t,		\
865da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
866aa59c4cbSrsb 	int	(*vop_map)(vnode_t *, offset_t, struct as *,		\
867aa59c4cbSrsb 				caddr_t *, size_t,			\
868da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *,	\
869da6c28aaSamw 				caller_context_t *);			\
870aa59c4cbSrsb 	int	(*vop_addmap)(vnode_t *, offset_t, struct as *,		\
871aa59c4cbSrsb 				caddr_t, size_t,			\
872da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *,	\
873da6c28aaSamw 				caller_context_t *);			\
874aa59c4cbSrsb 	int	(*vop_delmap)(vnode_t *, offset_t, struct as *,		\
875aa59c4cbSrsb 				caddr_t, size_t,			\
876da6c28aaSamw 				uint_t, uint_t, uint_t, cred_t *,	\
877da6c28aaSamw 				caller_context_t *);			\
878aa59c4cbSrsb 	int	(*vop_poll)(vnode_t *, short, int, short *,		\
879da6c28aaSamw 				struct pollhead **,			\
880da6c28aaSamw 				caller_context_t *);			\
881d7334e51Srm 	int	(*vop_dump)(vnode_t *, caddr_t, offset_t, offset_t,	\
882da6c28aaSamw 				caller_context_t *);			\
883da6c28aaSamw 	int	(*vop_pathconf)(vnode_t *, int, ulong_t *, cred_t *,	\
884da6c28aaSamw 				caller_context_t *);			\
885aa59c4cbSrsb 	int	(*vop_pageio)(vnode_t *, struct page *,			\
886da6c28aaSamw 				u_offset_t, size_t, int, cred_t *,	\
887da6c28aaSamw 				caller_context_t *);			\
888d7334e51Srm 	int	(*vop_dumpctl)(vnode_t *, int, offset_t *,		\
889da6c28aaSamw 				caller_context_t *);			\
890aa59c4cbSrsb 	void	(*vop_dispose)(vnode_t *, struct page *,		\
891da6c28aaSamw 				int, int, cred_t *,			\
892da6c28aaSamw 				caller_context_t *);			\
893aa59c4cbSrsb 	int	(*vop_setsecattr)(vnode_t *, vsecattr_t *,		\
894da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
895aa59c4cbSrsb 	int	(*vop_getsecattr)(vnode_t *, vsecattr_t *,		\
896da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
897aa59c4cbSrsb 	int	(*vop_shrlock)(vnode_t *, int, struct shrlock *,	\
898da6c28aaSamw 				int, cred_t *, caller_context_t *);	\
899da6c28aaSamw 	int	(*vop_vnevent)(vnode_t *, vnevent_t, vnode_t *,		\
900da6c28aaSamw 				char *, caller_context_t *)
901df2381bfSpraks 	/* NB: No ";" */
902aa59c4cbSrsb 
903aa59c4cbSrsb /*
904aa59c4cbSrsb  * Operations on vnodes.  Note: File systems must never operate directly
9057c478bd9Sstevel@tonic-gate  * on a 'vnodeops' structure -- it WILL change in future releases!  They
906aa59c4cbSrsb  * must use vn_make_ops() to create the structure.
9077c478bd9Sstevel@tonic-gate  */
9087c478bd9Sstevel@tonic-gate typedef struct vnodeops {
9097c478bd9Sstevel@tonic-gate 	const char *vnop_name;
910aa59c4cbSrsb 	VNODE_OPS;	/* Signatures of all vnode operations (vops) */
9117c478bd9Sstevel@tonic-gate } vnodeops_t;
9127c478bd9Sstevel@tonic-gate 
913aa59c4cbSrsb typedef int (*fs_generic_func_p) ();	/* Generic vop/vfsop/femop/fsemop ptr */
9147c478bd9Sstevel@tonic-gate 
915da6c28aaSamw extern int	fop_open(vnode_t **, int, cred_t *, caller_context_t *);
916da6c28aaSamw extern int	fop_close(vnode_t *, int, int, offset_t, cred_t *,
917da6c28aaSamw 				caller_context_t *);
9187c478bd9Sstevel@tonic-gate extern int	fop_read(vnode_t *, uio_t *, int, cred_t *, caller_context_t *);
9197c478bd9Sstevel@tonic-gate extern int	fop_write(vnode_t *, uio_t *, int, cred_t *,
9207c478bd9Sstevel@tonic-gate 				caller_context_t *);
921da6c28aaSamw extern int	fop_ioctl(vnode_t *, int, intptr_t, int, cred_t *, int *,
922da6c28aaSamw 				caller_context_t *);
923da6c28aaSamw extern int	fop_setfl(vnode_t *, int, int, cred_t *, caller_context_t *);
924da6c28aaSamw extern int	fop_getattr(vnode_t *, vattr_t *, int, cred_t *,
925da6c28aaSamw 				caller_context_t *);
9267c478bd9Sstevel@tonic-gate extern int	fop_setattr(vnode_t *, vattr_t *, int, cred_t *,
9277c478bd9Sstevel@tonic-gate 				caller_context_t *);
928da6c28aaSamw extern int	fop_access(vnode_t *, int, int, cred_t *, caller_context_t *);
9297c478bd9Sstevel@tonic-gate extern int	fop_lookup(vnode_t *, char *, vnode_t **, struct pathname *,
930da6c28aaSamw 				int, vnode_t *, cred_t *, caller_context_t *,
931da6c28aaSamw 				int *, struct pathname *);
9327c478bd9Sstevel@tonic-gate extern int	fop_create(vnode_t *, char *, vattr_t *, vcexcl_t, int,
933da6c28aaSamw 				vnode_t **, cred_t *, int, caller_context_t *,
934da6c28aaSamw 				vsecattr_t *);
935da6c28aaSamw extern int	fop_remove(vnode_t *vp, char *, cred_t *, caller_context_t *,
936da6c28aaSamw 				int);
937da6c28aaSamw extern int	fop_link(vnode_t *, vnode_t *, char *, cred_t *,
938da6c28aaSamw 				caller_context_t *, int);
939da6c28aaSamw extern int	fop_rename(vnode_t *, char *, vnode_t *, char *, cred_t *,
940da6c28aaSamw 				caller_context_t *, int);
941da6c28aaSamw extern int	fop_mkdir(vnode_t *, char *, vattr_t *, vnode_t **, cred_t *,
942da6c28aaSamw 				caller_context_t *, int, vsecattr_t *);
943da6c28aaSamw extern int	fop_rmdir(vnode_t *, char *, vnode_t *, cred_t *,
944da6c28aaSamw 				caller_context_t *, int);
945da6c28aaSamw extern int	fop_readdir(vnode_t *, uio_t *, cred_t *, int *,
946da6c28aaSamw 				caller_context_t *, int);
947da6c28aaSamw extern int	fop_symlink(vnode_t *, char *, vattr_t *, char *, cred_t *,
948da6c28aaSamw 				caller_context_t *, int);
949da6c28aaSamw extern int	fop_readlink(vnode_t *, uio_t *, cred_t *, caller_context_t *);
950da6c28aaSamw extern int	fop_fsync(vnode_t *, int, cred_t *, caller_context_t *);
951da6c28aaSamw extern void	fop_inactive(vnode_t *, cred_t *, caller_context_t *);
952da6c28aaSamw extern int	fop_fid(vnode_t *, struct fid *, caller_context_t *);
9537c478bd9Sstevel@tonic-gate extern int	fop_rwlock(vnode_t *, int, caller_context_t *);
9547c478bd9Sstevel@tonic-gate extern void	fop_rwunlock(vnode_t *, int, caller_context_t *);
955da6c28aaSamw extern int	fop_seek(vnode_t *, offset_t, offset_t *, caller_context_t *);
956da6c28aaSamw extern int	fop_cmp(vnode_t *, vnode_t *, caller_context_t *);
9577c478bd9Sstevel@tonic-gate extern int	fop_frlock(vnode_t *, int, struct flock64 *, int, offset_t,
958da6c28aaSamw 				struct flk_callback *, cred_t *,
959da6c28aaSamw 				caller_context_t *);
9607c478bd9Sstevel@tonic-gate extern int	fop_space(vnode_t *, int, struct flock64 *, int, offset_t,
9617c478bd9Sstevel@tonic-gate 				cred_t *, caller_context_t *);
962da6c28aaSamw extern int	fop_realvp(vnode_t *, vnode_t **, caller_context_t *);
9637c478bd9Sstevel@tonic-gate extern int	fop_getpage(vnode_t *, offset_t, size_t, uint_t *,
9647c478bd9Sstevel@tonic-gate 				struct page **, size_t, struct seg *,
965da6c28aaSamw 				caddr_t, enum seg_rw, cred_t *,
966da6c28aaSamw 				caller_context_t *);
967da6c28aaSamw extern int	fop_putpage(vnode_t *, offset_t, size_t, int, cred_t *,
968da6c28aaSamw 				caller_context_t *);
9697c478bd9Sstevel@tonic-gate extern int	fop_map(vnode_t *, offset_t, struct as *, caddr_t *, size_t,
970da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *cr,
971da6c28aaSamw 				caller_context_t *);
9727c478bd9Sstevel@tonic-gate extern int	fop_addmap(vnode_t *, offset_t, struct as *, caddr_t, size_t,
973da6c28aaSamw 				uchar_t, uchar_t, uint_t, cred_t *,
974da6c28aaSamw 				caller_context_t *);
9757c478bd9Sstevel@tonic-gate extern int	fop_delmap(vnode_t *, offset_t, struct as *, caddr_t, size_t,
976da6c28aaSamw 				uint_t, uint_t, uint_t, cred_t *,
977da6c28aaSamw 				caller_context_t *);
978da6c28aaSamw extern int	fop_poll(vnode_t *, short, int, short *, struct pollhead **,
979da6c28aaSamw 				caller_context_t *);
980d7334e51Srm extern int	fop_dump(vnode_t *, caddr_t, offset_t, offset_t,
981d7334e51Srm     caller_context_t *);
982da6c28aaSamw extern int	fop_pathconf(vnode_t *, int, ulong_t *, cred_t *,
983da6c28aaSamw 				caller_context_t *);
9847c478bd9Sstevel@tonic-gate extern int	fop_pageio(vnode_t *, struct page *, u_offset_t, size_t, int,
985da6c28aaSamw 				cred_t *, caller_context_t *);
986d7334e51Srm extern int	fop_dumpctl(vnode_t *, int, offset_t *, caller_context_t *);
987da6c28aaSamw extern void	fop_dispose(vnode_t *, struct page *, int, int, cred_t *,
988da6c28aaSamw 				caller_context_t *);
989da6c28aaSamw extern int	fop_setsecattr(vnode_t *, vsecattr_t *, int, cred_t *,
990da6c28aaSamw 				caller_context_t *);
991da6c28aaSamw extern int	fop_getsecattr(vnode_t *, vsecattr_t *, int, cred_t *,
992da6c28aaSamw 				caller_context_t *);
993da6c28aaSamw extern int	fop_shrlock(vnode_t *, int, struct shrlock *, int, cred_t *,
994da6c28aaSamw 				caller_context_t *);
995da6c28aaSamw extern int	fop_vnevent(vnode_t *, vnevent_t, vnode_t *, char *,
996da6c28aaSamw 				caller_context_t *);
9977c478bd9Sstevel@tonic-gate 
9987c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
9997c478bd9Sstevel@tonic-gate 
1000da6c28aaSamw #define	VOP_OPEN(vpp, mode, cr, ct) \
1001da6c28aaSamw 	fop_open(vpp, mode, cr, ct)
1002da6c28aaSamw #define	VOP_CLOSE(vp, f, c, o, cr, ct) \
1003da6c28aaSamw 	fop_close(vp, f, c, o, cr, ct)
10047c478bd9Sstevel@tonic-gate #define	VOP_READ(vp, uiop, iof, cr, ct) \
10057c478bd9Sstevel@tonic-gate 	fop_read(vp, uiop, iof, cr, ct)
10067c478bd9Sstevel@tonic-gate #define	VOP_WRITE(vp, uiop, iof, cr, ct) \
10077c478bd9Sstevel@tonic-gate 	fop_write(vp, uiop, iof, cr, ct)
1008da6c28aaSamw #define	VOP_IOCTL(vp, cmd, a, f, cr, rvp, ct) \
1009da6c28aaSamw 	fop_ioctl(vp, cmd, a, f, cr, rvp, ct)
1010da6c28aaSamw #define	VOP_SETFL(vp, f, a, cr, ct) \
1011da6c28aaSamw 	fop_setfl(vp, f, a, cr, ct)
1012da6c28aaSamw #define	VOP_GETATTR(vp, vap, f, cr, ct) \
1013da6c28aaSamw 	fop_getattr(vp, vap, f, cr, ct)
10147c478bd9Sstevel@tonic-gate #define	VOP_SETATTR(vp, vap, f, cr, ct) \
10157c478bd9Sstevel@tonic-gate 	fop_setattr(vp, vap, f, cr, ct)
1016da6c28aaSamw #define	VOP_ACCESS(vp, mode, f, cr, ct) \
1017da6c28aaSamw 	fop_access(vp, mode, f, cr, ct)
1018da6c28aaSamw #define	VOP_LOOKUP(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp) \
1019da6c28aaSamw 	fop_lookup(vp, cp, vpp, pnp, f, rdir, cr, ct, defp, rpnp)
1020da6c28aaSamw #define	VOP_CREATE(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap) \
1021da6c28aaSamw 	fop_create(dvp, p, vap, ex, mode, vpp, cr, flag, ct, vsap)
1022da6c28aaSamw #define	VOP_REMOVE(dvp, p, cr, ct, f) \
1023da6c28aaSamw 	fop_remove(dvp, p, cr, ct, f)
1024da6c28aaSamw #define	VOP_LINK(tdvp, fvp, p, cr, ct, f) \
1025da6c28aaSamw 	fop_link(tdvp, fvp, p, cr, ct, f)
1026da6c28aaSamw #define	VOP_RENAME(fvp, fnm, tdvp, tnm, cr, ct, f) \
1027da6c28aaSamw 	fop_rename(fvp, fnm, tdvp, tnm, cr, ct, f)
1028da6c28aaSamw #define	VOP_MKDIR(dp, p, vap, vpp, cr, ct, f, vsap) \
1029da6c28aaSamw 	fop_mkdir(dp, p, vap, vpp, cr, ct, f, vsap)
1030da6c28aaSamw #define	VOP_RMDIR(dp, p, cdir, cr, ct, f) \
1031da6c28aaSamw 	fop_rmdir(dp, p, cdir, cr, ct, f)
1032da6c28aaSamw #define	VOP_READDIR(vp, uiop, cr, eofp, ct, f) \
1033da6c28aaSamw 	fop_readdir(vp, uiop, cr, eofp, ct, f)
1034da6c28aaSamw #define	VOP_SYMLINK(dvp, lnm, vap, tnm, cr, ct, f) \
1035da6c28aaSamw 	fop_symlink(dvp, lnm, vap, tnm, cr, ct, f)
1036da6c28aaSamw #define	VOP_READLINK(vp, uiop, cr, ct) \
1037da6c28aaSamw 	fop_readlink(vp, uiop, cr, ct)
1038da6c28aaSamw #define	VOP_FSYNC(vp, syncflag, cr, ct) \
1039da6c28aaSamw 	fop_fsync(vp, syncflag, cr, ct)
1040da6c28aaSamw #define	VOP_INACTIVE(vp, cr, ct) \
1041da6c28aaSamw 	fop_inactive(vp, cr, ct)
1042da6c28aaSamw #define	VOP_FID(vp, fidp, ct) \
1043da6c28aaSamw 	fop_fid(vp, fidp, ct)
10447c478bd9Sstevel@tonic-gate #define	VOP_RWLOCK(vp, w, ct) \
10457c478bd9Sstevel@tonic-gate 	fop_rwlock(vp, w, ct)
10467c478bd9Sstevel@tonic-gate #define	VOP_RWUNLOCK(vp, w, ct) \
10477c478bd9Sstevel@tonic-gate 	fop_rwunlock(vp, w, ct)
1048da6c28aaSamw #define	VOP_SEEK(vp, ooff, noffp, ct) \
1049da6c28aaSamw 	fop_seek(vp, ooff, noffp, ct)
1050da6c28aaSamw #define	VOP_CMP(vp1, vp2, ct) \
1051da6c28aaSamw 	fop_cmp(vp1, vp2, ct)
1052da6c28aaSamw #define	VOP_FRLOCK(vp, cmd, a, f, o, cb, cr, ct) \
1053da6c28aaSamw 	fop_frlock(vp, cmd, a, f, o, cb, cr, ct)
10547c478bd9Sstevel@tonic-gate #define	VOP_SPACE(vp, cmd, a, f, o, cr, ct) \
10557c478bd9Sstevel@tonic-gate 	fop_space(vp, cmd, a, f, o, cr, ct)
1056da6c28aaSamw #define	VOP_REALVP(vp1, vp2, ct) \
1057da6c28aaSamw 	fop_realvp(vp1, vp2, ct)
1058da6c28aaSamw #define	VOP_GETPAGE(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct) \
1059da6c28aaSamw 	fop_getpage(vp, of, sz, pr, pl, ps, sg, a, rw, cr, ct)
1060da6c28aaSamw #define	VOP_PUTPAGE(vp, of, sz, fl, cr, ct) \
1061da6c28aaSamw 	fop_putpage(vp, of, sz, fl, cr, ct)
1062da6c28aaSamw #define	VOP_MAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1063da6c28aaSamw 	fop_map(vp, of, as, a, sz, p, mp, fl, cr, ct)
1064da6c28aaSamw #define	VOP_ADDMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1065da6c28aaSamw 	fop_addmap(vp, of, as, a, sz, p, mp, fl, cr, ct)
1066da6c28aaSamw #define	VOP_DELMAP(vp, of, as, a, sz, p, mp, fl, cr, ct) \
1067da6c28aaSamw 	fop_delmap(vp, of, as, a, sz, p, mp, fl, cr, ct)
1068da6c28aaSamw #define	VOP_POLL(vp, events, anyyet, reventsp, phpp, ct) \
1069da6c28aaSamw 	fop_poll(vp, events, anyyet, reventsp, phpp, ct)
1070da6c28aaSamw #define	VOP_DUMP(vp, addr, bn, count, ct) \
1071da6c28aaSamw 	fop_dump(vp, addr, bn, count, ct)
1072da6c28aaSamw #define	VOP_PATHCONF(vp, cmd, valp, cr, ct) \
1073da6c28aaSamw 	fop_pathconf(vp, cmd, valp, cr, ct)
1074da6c28aaSamw #define	VOP_PAGEIO(vp, pp, io_off, io_len, flags, cr, ct) \
1075da6c28aaSamw 	fop_pageio(vp, pp, io_off, io_len, flags, cr, ct)
1076da6c28aaSamw #define	VOP_DUMPCTL(vp, action, blkp, ct) \
1077da6c28aaSamw 	fop_dumpctl(vp, action, blkp, ct)
1078da6c28aaSamw #define	VOP_DISPOSE(vp, pp, flag, dn, cr, ct) \
1079da6c28aaSamw 	fop_dispose(vp, pp, flag, dn, cr, ct)
1080da6c28aaSamw #define	VOP_GETSECATTR(vp, vsap, f, cr, ct) \
1081da6c28aaSamw 	fop_getsecattr(vp, vsap, f, cr, ct)
1082da6c28aaSamw #define	VOP_SETSECATTR(vp, vsap, f, cr, ct) \
1083da6c28aaSamw 	fop_setsecattr(vp, vsap, f, cr, ct)
1084da6c28aaSamw #define	VOP_SHRLOCK(vp, cmd, shr, f, cr, ct) \
1085da6c28aaSamw 	fop_shrlock(vp, cmd, shr, f, cr, ct)
1086da6c28aaSamw #define	VOP_VNEVENT(vp, vnevent, dvp, fnm, ct) \
1087da6c28aaSamw 	fop_vnevent(vp, vnevent, dvp, fnm, ct)
10887c478bd9Sstevel@tonic-gate 
10897c478bd9Sstevel@tonic-gate #define	VOPNAME_OPEN		"open"
10907c478bd9Sstevel@tonic-gate #define	VOPNAME_CLOSE		"close"
10917c478bd9Sstevel@tonic-gate #define	VOPNAME_READ		"read"
10927c478bd9Sstevel@tonic-gate #define	VOPNAME_WRITE		"write"
10937c478bd9Sstevel@tonic-gate #define	VOPNAME_IOCTL		"ioctl"
10947c478bd9Sstevel@tonic-gate #define	VOPNAME_SETFL		"setfl"
10957c478bd9Sstevel@tonic-gate #define	VOPNAME_GETATTR		"getattr"
10967c478bd9Sstevel@tonic-gate #define	VOPNAME_SETATTR		"setattr"
10977c478bd9Sstevel@tonic-gate #define	VOPNAME_ACCESS		"access"
10987c478bd9Sstevel@tonic-gate #define	VOPNAME_LOOKUP		"lookup"
10997c478bd9Sstevel@tonic-gate #define	VOPNAME_CREATE		"create"
11007c478bd9Sstevel@tonic-gate #define	VOPNAME_REMOVE		"remove"
11017c478bd9Sstevel@tonic-gate #define	VOPNAME_LINK		"link"
11027c478bd9Sstevel@tonic-gate #define	VOPNAME_RENAME		"rename"
11037c478bd9Sstevel@tonic-gate #define	VOPNAME_MKDIR		"mkdir"
11047c478bd9Sstevel@tonic-gate #define	VOPNAME_RMDIR		"rmdir"
11057c478bd9Sstevel@tonic-gate #define	VOPNAME_READDIR		"readdir"
11067c478bd9Sstevel@tonic-gate #define	VOPNAME_SYMLINK		"symlink"
11077c478bd9Sstevel@tonic-gate #define	VOPNAME_READLINK	"readlink"
11087c478bd9Sstevel@tonic-gate #define	VOPNAME_FSYNC		"fsync"
11097c478bd9Sstevel@tonic-gate #define	VOPNAME_INACTIVE	"inactive"
11107c478bd9Sstevel@tonic-gate #define	VOPNAME_FID		"fid"
11117c478bd9Sstevel@tonic-gate #define	VOPNAME_RWLOCK		"rwlock"
11127c478bd9Sstevel@tonic-gate #define	VOPNAME_RWUNLOCK	"rwunlock"
11137c478bd9Sstevel@tonic-gate #define	VOPNAME_SEEK		"seek"
11147c478bd9Sstevel@tonic-gate #define	VOPNAME_CMP		"cmp"
11157c478bd9Sstevel@tonic-gate #define	VOPNAME_FRLOCK		"frlock"
11167c478bd9Sstevel@tonic-gate #define	VOPNAME_SPACE		"space"
11177c478bd9Sstevel@tonic-gate #define	VOPNAME_REALVP		"realvp"
11187c478bd9Sstevel@tonic-gate #define	VOPNAME_GETPAGE		"getpage"
11197c478bd9Sstevel@tonic-gate #define	VOPNAME_PUTPAGE		"putpage"
11207c478bd9Sstevel@tonic-gate #define	VOPNAME_MAP		"map"
11217c478bd9Sstevel@tonic-gate #define	VOPNAME_ADDMAP		"addmap"
11227c478bd9Sstevel@tonic-gate #define	VOPNAME_DELMAP		"delmap"
11237c478bd9Sstevel@tonic-gate #define	VOPNAME_POLL		"poll"
11247c478bd9Sstevel@tonic-gate #define	VOPNAME_DUMP		"dump"
11257c478bd9Sstevel@tonic-gate #define	VOPNAME_PATHCONF	"pathconf"
11267c478bd9Sstevel@tonic-gate #define	VOPNAME_PAGEIO		"pageio"
11277c478bd9Sstevel@tonic-gate #define	VOPNAME_DUMPCTL		"dumpctl"
11287c478bd9Sstevel@tonic-gate #define	VOPNAME_DISPOSE		"dispose"
11297c478bd9Sstevel@tonic-gate #define	VOPNAME_GETSECATTR	"getsecattr"
11307c478bd9Sstevel@tonic-gate #define	VOPNAME_SETSECATTR	"setsecattr"
11317c478bd9Sstevel@tonic-gate #define	VOPNAME_SHRLOCK		"shrlock"
11327c478bd9Sstevel@tonic-gate #define	VOPNAME_VNEVENT		"vnevent"
11337c478bd9Sstevel@tonic-gate 
11347c478bd9Sstevel@tonic-gate /*
11357c478bd9Sstevel@tonic-gate  * Flags for VOP_LOOKUP
1136da6c28aaSamw  *
1137da6c28aaSamw  * Defined in file.h, but also possible, FIGNORECASE
1138da6c28aaSamw  *
11397c478bd9Sstevel@tonic-gate  */
11407c478bd9Sstevel@tonic-gate #define	LOOKUP_DIR		0x01	/* want parent dir vp */
11417c478bd9Sstevel@tonic-gate #define	LOOKUP_XATTR		0x02	/* lookup up extended attr dir */
11427c478bd9Sstevel@tonic-gate #define	CREATE_XATTR_DIR	0x04	/* Create extended attr dir */
1143da6c28aaSamw #define	LOOKUP_HAVE_SYSATTR_DIR	0x08	/* Already created virtual GFS dir */
1144da6c28aaSamw 
1145da6c28aaSamw /*
1146da6c28aaSamw  * Flags for VOP_READDIR
1147da6c28aaSamw  */
1148da6c28aaSamw #define	V_RDDIR_ENTFLAGS	0x01	/* request dirent flags */
1149e802abbdSTim Haley #define	V_RDDIR_ACCFILTER	0x02	/* filter out inaccessible dirents */
11507c478bd9Sstevel@tonic-gate 
11517c478bd9Sstevel@tonic-gate /*
11527c478bd9Sstevel@tonic-gate  * Flags for VOP_RWLOCK/VOP_RWUNLOCK
11537c478bd9Sstevel@tonic-gate  * VOP_RWLOCK will return the flag that was actually set, or -1 if none.
11547c478bd9Sstevel@tonic-gate  */
11557c478bd9Sstevel@tonic-gate #define	V_WRITELOCK_TRUE	(1)	/* Request write-lock on the vnode */
11567c478bd9Sstevel@tonic-gate #define	V_WRITELOCK_FALSE	(0)	/* Request read-lock on the vnode */
11577c478bd9Sstevel@tonic-gate 
11587c478bd9Sstevel@tonic-gate /*
11597c478bd9Sstevel@tonic-gate  * Flags for VOP_DUMPCTL
11607c478bd9Sstevel@tonic-gate  */
11617c478bd9Sstevel@tonic-gate #define	DUMP_ALLOC	0
11627c478bd9Sstevel@tonic-gate #define	DUMP_FREE	1
11637c478bd9Sstevel@tonic-gate #define	DUMP_SCAN	2
11647c478bd9Sstevel@tonic-gate 
11657c478bd9Sstevel@tonic-gate /*
11667c478bd9Sstevel@tonic-gate  * Public vnode manipulation functions.
11677c478bd9Sstevel@tonic-gate  */
11687c478bd9Sstevel@tonic-gate #ifdef	_KERNEL
11697c478bd9Sstevel@tonic-gate 
11707c478bd9Sstevel@tonic-gate vnode_t *vn_alloc(int);
11717c478bd9Sstevel@tonic-gate void	vn_reinit(vnode_t *);
11727c478bd9Sstevel@tonic-gate void	vn_recycle(vnode_t *);
11737c478bd9Sstevel@tonic-gate void	vn_free(vnode_t *);
11747c478bd9Sstevel@tonic-gate 
11757c478bd9Sstevel@tonic-gate int	vn_is_readonly(vnode_t *);
11767c478bd9Sstevel@tonic-gate int   	vn_is_opened(vnode_t *, v_mode_t);
11777c478bd9Sstevel@tonic-gate int   	vn_is_mapped(vnode_t *, v_mode_t);
1178da6c28aaSamw int   	vn_has_other_opens(vnode_t *, v_mode_t);
1179da6c28aaSamw void	vn_open_upgrade(vnode_t *, int);
1180da6c28aaSamw void	vn_open_downgrade(vnode_t *, int);
11817c478bd9Sstevel@tonic-gate 
11827c478bd9Sstevel@tonic-gate int	vn_can_change_zones(vnode_t *vp);
11837c478bd9Sstevel@tonic-gate 
11847c478bd9Sstevel@tonic-gate int	vn_has_flocks(vnode_t *);
11857c478bd9Sstevel@tonic-gate int	vn_has_mandatory_locks(vnode_t *, int);
11867c478bd9Sstevel@tonic-gate int	vn_has_cached_data(vnode_t *);
11877c478bd9Sstevel@tonic-gate 
11887c478bd9Sstevel@tonic-gate void	vn_setops(vnode_t *, vnodeops_t *);
11897c478bd9Sstevel@tonic-gate vnodeops_t *vn_getops(vnode_t *);
11907c478bd9Sstevel@tonic-gate int	vn_matchops(vnode_t *, vnodeops_t *);
11917c478bd9Sstevel@tonic-gate int	vn_matchopval(vnode_t *, char *, fs_generic_func_p);
11927c478bd9Sstevel@tonic-gate int	vn_ismntpt(vnode_t *);
11937c478bd9Sstevel@tonic-gate 
11947c478bd9Sstevel@tonic-gate struct vfs *vn_mountedvfs(vnode_t *);
11957c478bd9Sstevel@tonic-gate 
1196b5fca8f8Stomee int	vn_in_dnlc(vnode_t *);
1197b5fca8f8Stomee 
11987c478bd9Sstevel@tonic-gate void	vn_create_cache(void);
11997c478bd9Sstevel@tonic-gate void	vn_destroy_cache(void);
12007c478bd9Sstevel@tonic-gate 
12017c478bd9Sstevel@tonic-gate void	vn_freevnodeops(vnodeops_t *);
12027c478bd9Sstevel@tonic-gate 
12037c478bd9Sstevel@tonic-gate int	vn_open(char *pnamep, enum uio_seg seg, int filemode, int createmode,
12047c478bd9Sstevel@tonic-gate 		struct vnode **vpp, enum create crwhy, mode_t umask);
12057c478bd9Sstevel@tonic-gate int	vn_openat(char *pnamep, enum uio_seg seg, int filemode, int createmode,
12067c478bd9Sstevel@tonic-gate 		struct vnode **vpp, enum create crwhy,
1207da6c28aaSamw 		mode_t umask, struct vnode *startvp, int fd);
12087c478bd9Sstevel@tonic-gate int	vn_create(char *pnamep, enum uio_seg seg, struct vattr *vap,
12097c478bd9Sstevel@tonic-gate 		enum vcexcl excl, int mode, struct vnode **vpp,
12107c478bd9Sstevel@tonic-gate 		enum create why, int flag, mode_t umask);
12117c478bd9Sstevel@tonic-gate int	vn_createat(char *pnamep, enum uio_seg seg, struct vattr *vap,
12127c478bd9Sstevel@tonic-gate 		enum vcexcl excl, int mode, struct vnode **vpp,
12137c478bd9Sstevel@tonic-gate 		enum create why, int flag, mode_t umask, struct vnode *startvp);
12147c478bd9Sstevel@tonic-gate int	vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base, ssize_t len,
12157c478bd9Sstevel@tonic-gate 		offset_t offset, enum uio_seg seg, int ioflag, rlim64_t ulimit,
12167c478bd9Sstevel@tonic-gate 		cred_t *cr, ssize_t *residp);
12177c478bd9Sstevel@tonic-gate void	vn_rele(struct vnode *vp);
12189d3574bfSNeil Perrin void	vn_rele_async(struct vnode *vp, struct taskq *taskq);
1219b5fca8f8Stomee void	vn_rele_dnlc(struct vnode *vp);
12207c478bd9Sstevel@tonic-gate void	vn_rele_stream(struct vnode *vp);
12217c478bd9Sstevel@tonic-gate int	vn_link(char *from, char *to, enum uio_seg seg);
12227c478bd9Sstevel@tonic-gate int	vn_rename(char *from, char *to, enum uio_seg seg);
12237c478bd9Sstevel@tonic-gate int	vn_renameat(vnode_t *fdvp, char *fname, vnode_t *tdvp, char *tname,
12247c478bd9Sstevel@tonic-gate 		enum uio_seg seg);
12257c478bd9Sstevel@tonic-gate int	vn_remove(char *fnamep, enum uio_seg seg, enum rm dirflag);
12267c478bd9Sstevel@tonic-gate int	vn_removeat(vnode_t *startvp, char *fnamep, enum uio_seg seg,
12277c478bd9Sstevel@tonic-gate 		enum rm dirflag);
12287c478bd9Sstevel@tonic-gate int	vn_compare(vnode_t *vp1, vnode_t *vp2);
12297c478bd9Sstevel@tonic-gate int	vn_vfswlock(struct vnode *vp);
12307c478bd9Sstevel@tonic-gate int	vn_vfswlock_wait(struct vnode *vp);
12317c478bd9Sstevel@tonic-gate int	vn_vfsrlock(struct vnode *vp);
12327c478bd9Sstevel@tonic-gate int	vn_vfsrlock_wait(struct vnode *vp);
12337c478bd9Sstevel@tonic-gate void	vn_vfsunlock(struct vnode *vp);
12347c478bd9Sstevel@tonic-gate int	vn_vfswlock_held(struct vnode *vp);
12357c478bd9Sstevel@tonic-gate vnode_t *specvp(struct vnode *vp, dev_t dev, vtype_t type, struct cred *cr);
12367c478bd9Sstevel@tonic-gate vnode_t *makespecvp(dev_t dev, vtype_t type);
12377c478bd9Sstevel@tonic-gate vn_vfslocks_entry_t *vn_vfslocks_getlock(void *);
12387c478bd9Sstevel@tonic-gate void	vn_vfslocks_rele(vn_vfslocks_entry_t *);
12397c478bd9Sstevel@tonic-gate 
1240ca2c3138Seschrock void vn_copypath(struct vnode *src, struct vnode *dst);
1241ca2c3138Seschrock void vn_setpath_str(struct vnode *vp, const char *str, size_t len);
1242ca2c3138Seschrock void vn_setpath(vnode_t *rootvp, struct vnode *startvp, struct vnode *vp,
1243ca2c3138Seschrock     const char *path, size_t plen);
124451ece835Seschrock void vn_renamepath(vnode_t *dvp, vnode_t *vp, const char *nm, size_t len);
1245ca2c3138Seschrock 
12467c478bd9Sstevel@tonic-gate /* Vnode event notification */
1247da6c28aaSamw void	vnevent_rename_src(vnode_t *, vnode_t *, char *, caller_context_t *);
1248da6c28aaSamw void	vnevent_rename_dest(vnode_t *, vnode_t *, char *, caller_context_t *);
1249da6c28aaSamw void	vnevent_remove(vnode_t *, vnode_t *, char *, caller_context_t *);
1250da6c28aaSamw void	vnevent_rmdir(vnode_t *, vnode_t *, char *, caller_context_t *);
1251da6c28aaSamw void	vnevent_create(vnode_t *, caller_context_t *);
1252da6c28aaSamw void	vnevent_link(vnode_t *, caller_context_t *);
1253da6c28aaSamw void	vnevent_rename_dest_dir(vnode_t *, caller_context_t *ct);
1254da6c28aaSamw void	vnevent_mountedover(vnode_t *, caller_context_t *);
1255da6c28aaSamw int	vnevent_support(vnode_t *, caller_context_t *);
12567c478bd9Sstevel@tonic-gate 
12571b300de9Sjwahlig /* Vnode specific data */
12581b300de9Sjwahlig void vsd_create(uint_t *, void (*)(void *));
12591b300de9Sjwahlig void vsd_destroy(uint_t *);
12601b300de9Sjwahlig void *vsd_get(vnode_t *, uint_t);
12611b300de9Sjwahlig int vsd_set(vnode_t *, uint_t, void *);
12621b300de9Sjwahlig void vsd_free(vnode_t *);
12631b300de9Sjwahlig 
1264da6c28aaSamw /*
1265da6c28aaSamw  * Extensible vnode attribute (xva) routines:
1266da6c28aaSamw  * xva_init() initializes an xvattr_t (zero struct, init mapsize, set AT_XATTR)
1267da6c28aaSamw  * xva_getxoptattr() returns a ponter to the xoptattr_t section of xvattr_t
1268da6c28aaSamw  */
1269da6c28aaSamw void		xva_init(xvattr_t *);
1270da6c28aaSamw xoptattr_t	*xva_getxoptattr(xvattr_t *);	/* Get ptr to xoptattr_t */
1271da6c28aaSamw 
1272da6c28aaSamw void xattr_init(void);		/* Initialize vnodeops for xattrs */
1273da6c28aaSamw 
1274da6c28aaSamw /* GFS tunnel for xattrs */
1275da6c28aaSamw int xattr_dir_lookup(vnode_t *, vnode_t **, int, cred_t *);
1276da6c28aaSamw 
12777c478bd9Sstevel@tonic-gate /* Context identification */
12787c478bd9Sstevel@tonic-gate u_longlong_t	fs_new_caller_id();
12797c478bd9Sstevel@tonic-gate 
12807c478bd9Sstevel@tonic-gate int	vn_vmpss_usepageio(vnode_t *);
12817c478bd9Sstevel@tonic-gate 
12827c478bd9Sstevel@tonic-gate /*
12837c478bd9Sstevel@tonic-gate  * Needed for use of IS_VMODSORT() in kernel.
12847c478bd9Sstevel@tonic-gate  */
12857c478bd9Sstevel@tonic-gate extern uint_t pvn_vmodsort_supported;
12867c478bd9Sstevel@tonic-gate 
12877c478bd9Sstevel@tonic-gate #define	VN_HOLD(vp)	{ \
12887c478bd9Sstevel@tonic-gate 	mutex_enter(&(vp)->v_lock); \
12897c478bd9Sstevel@tonic-gate 	(vp)->v_count++; \
12907c478bd9Sstevel@tonic-gate 	mutex_exit(&(vp)->v_lock); \
12917c478bd9Sstevel@tonic-gate }
12927c478bd9Sstevel@tonic-gate 
12937c478bd9Sstevel@tonic-gate #define	VN_RELE(vp)	{ \
12947c478bd9Sstevel@tonic-gate 	vn_rele(vp); \
12957c478bd9Sstevel@tonic-gate }
12967c478bd9Sstevel@tonic-gate 
12979d3574bfSNeil Perrin #define	VN_RELE_ASYNC(vp, taskq)	{ \
12989d3574bfSNeil Perrin 	vn_rele_async(vp, taskq); \
12999d3574bfSNeil Perrin }
13009d3574bfSNeil Perrin 
13017c478bd9Sstevel@tonic-gate #define	VN_SET_VFS_TYPE_DEV(vp, vfsp, type, dev)	{ \
13027c478bd9Sstevel@tonic-gate 	(vp)->v_vfsp = (vfsp); \
13037c478bd9Sstevel@tonic-gate 	(vp)->v_type = (type); \
13047c478bd9Sstevel@tonic-gate 	(vp)->v_rdev = (dev); \
13057c478bd9Sstevel@tonic-gate }
13067c478bd9Sstevel@tonic-gate 
13077c478bd9Sstevel@tonic-gate /*
13087c478bd9Sstevel@tonic-gate  * Compare two vnodes for equality.  In general this macro should be used
13097c478bd9Sstevel@tonic-gate  * in preference to calling VOP_CMP directly.
13107c478bd9Sstevel@tonic-gate  */
13117c478bd9Sstevel@tonic-gate #define	VN_CMP(VP1, VP2)	((VP1) == (VP2) ? 1 : 	\
13127c478bd9Sstevel@tonic-gate 	((VP1) && (VP2) && (vn_getops(VP1) == vn_getops(VP2)) ? \
1313da6c28aaSamw 	VOP_CMP(VP1, VP2, NULL) : 0))
13147c478bd9Sstevel@tonic-gate 
1315ad23a2dbSjohansen extern struct vnode kvp;
1316ad23a2dbSjohansen extern struct vnode zvp;
1317ad23a2dbSjohansen 
1318ad23a2dbSjohansen #define	VN_ISKAS(vp)		((vp) == &kvp || (vp) == &zvp)
1319ad23a2dbSjohansen 
13207c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
13217c478bd9Sstevel@tonic-gate 
13227c478bd9Sstevel@tonic-gate /*
13237c478bd9Sstevel@tonic-gate  * Flags to VOP_SETATTR/VOP_GETATTR.
13247c478bd9Sstevel@tonic-gate  */
13257c478bd9Sstevel@tonic-gate #define	ATTR_UTIME	0x01	/* non-default utime(2) request */
13267c478bd9Sstevel@tonic-gate #define	ATTR_EXEC	0x02	/* invocation from exec(2) */
13277c478bd9Sstevel@tonic-gate #define	ATTR_COMM	0x04	/* yield common vp attributes */
13287c478bd9Sstevel@tonic-gate #define	ATTR_HINT	0x08	/* information returned will be `hint' */
13297c478bd9Sstevel@tonic-gate #define	ATTR_REAL	0x10	/* yield attributes of the real vp */
1330da6c28aaSamw #define	ATTR_NOACLCHECK	0x20	/* Don't check ACL when checking permissions */
1331b9238976Sth #define	ATTR_TRIGGER	0x40	/* Mount first if vnode is a trigger mount */
13327c478bd9Sstevel@tonic-gate /*
13337c478bd9Sstevel@tonic-gate  * Generally useful macros.
13347c478bd9Sstevel@tonic-gate  */
13357c478bd9Sstevel@tonic-gate #define	VBSIZE(vp)	((vp)->v_vfsp->vfs_bsize)
1336fa9e4066Sahrens 
1337fa9e4066Sahrens #define	VTOZONE(vp)	((vp)->v_vfsp->vfs_zone)
1338fa9e4066Sahrens 
13397c478bd9Sstevel@tonic-gate #define	NULLVP		((struct vnode *)0)
13407c478bd9Sstevel@tonic-gate #define	NULLVPP		((struct vnode **)0)
13417c478bd9Sstevel@tonic-gate 
13427c478bd9Sstevel@tonic-gate #ifdef	_KERNEL
13437c478bd9Sstevel@tonic-gate 
13447c478bd9Sstevel@tonic-gate /*
13457c478bd9Sstevel@tonic-gate  * Structure used while handling asynchronous VOP_PUTPAGE operations.
13467c478bd9Sstevel@tonic-gate  */
13477c478bd9Sstevel@tonic-gate struct async_reqs {
13487c478bd9Sstevel@tonic-gate 	struct async_reqs *a_next;	/* pointer to next arg struct */
13497c478bd9Sstevel@tonic-gate 	struct vnode *a_vp;		/* vnode pointer */
13507c478bd9Sstevel@tonic-gate 	u_offset_t a_off;			/* offset in file */
13517c478bd9Sstevel@tonic-gate 	uint_t a_len;			/* size of i/o request */
13527c478bd9Sstevel@tonic-gate 	int a_flags;			/* flags to indicate operation type */
13537c478bd9Sstevel@tonic-gate 	struct cred *a_cred;		/* cred pointer	*/
13547c478bd9Sstevel@tonic-gate 	ushort_t a_prealloced;		/* set if struct is pre-allocated */
13557c478bd9Sstevel@tonic-gate };
13567c478bd9Sstevel@tonic-gate 
13577c478bd9Sstevel@tonic-gate /*
13587c478bd9Sstevel@tonic-gate  * VN_DISPOSE() -- given a page pointer, safely invoke VOP_DISPOSE().
13592e0ea4c4SMichael Corcoran  * Note that there is no guarantee that the page passed in will be
13602e0ea4c4SMichael Corcoran  * freed.  If that is required, then a check after calling VN_DISPOSE would
13612e0ea4c4SMichael Corcoran  * be necessary to ensure the page was freed.
13627c478bd9Sstevel@tonic-gate  */
13637c478bd9Sstevel@tonic-gate #define	VN_DISPOSE(pp, flag, dn, cr)	{ \
13647c478bd9Sstevel@tonic-gate 	extern struct vnode kvp; \
1365ad23a2dbSjohansen 	if ((pp)->p_vnode != NULL && !VN_ISKAS((pp)->p_vnode)) \
1366da6c28aaSamw 		VOP_DISPOSE((pp)->p_vnode, (pp), (flag), (dn), (cr), NULL); \
13677c478bd9Sstevel@tonic-gate 	else if ((flag) == B_FREE) \
13687c478bd9Sstevel@tonic-gate 		page_free((pp), (dn)); \
13697c478bd9Sstevel@tonic-gate 	else \
13707c478bd9Sstevel@tonic-gate 		page_destroy((pp), (dn)); \
13717c478bd9Sstevel@tonic-gate 	}
13727c478bd9Sstevel@tonic-gate 
13737c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
13747c478bd9Sstevel@tonic-gate 
13757c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
13767c478bd9Sstevel@tonic-gate }
13777c478bd9Sstevel@tonic-gate #endif
13787c478bd9Sstevel@tonic-gate 
13797c478bd9Sstevel@tonic-gate #endif	/* _SYS_VNODE_H */
1380