xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_vfsops.h (revision fb9b0aa8c76ff829a7069d38161a2cecc656b091)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_FS_ZFS_VFSOPS_H
27 #define	_SYS_FS_ZFS_VFSOPS_H
28 
29 #include <sys/isa_defs.h>
30 #include <sys/types32.h>
31 #include <sys/list.h>
32 #include <sys/vfs.h>
33 #include <sys/zil.h>
34 #include <sys/rrwlock.h>
35 #include <sys/zfs_ioctl.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 typedef struct zfsvfs zfsvfs_t;
42 
43 struct zfsvfs {
44 	vfs_t		*z_vfs;		/* generic fs struct */
45 	zfsvfs_t	*z_parent;	/* parent fs */
46 	objset_t	*z_os;		/* objset reference */
47 	uint64_t	z_root;		/* id of root znode */
48 	uint64_t	z_unlinkedobj;	/* id of unlinked zapobj */
49 	uint64_t	z_max_blksz;	/* maximum block size for files */
50 	uint64_t	z_fuid_obj;	/* fuid table object number */
51 	uint64_t	z_fuid_size;	/* fuid table size */
52 	avl_tree_t	z_fuid_idx;	/* fuid tree keyed by index */
53 	avl_tree_t	z_fuid_domain;	/* fuid tree keyed by domain */
54 	krwlock_t	z_fuid_lock;	/* fuid lock */
55 	boolean_t	z_fuid_loaded;	/* fuid tables are loaded */
56 	boolean_t	z_fuid_dirty;   /* need to sync fuid table ? */
57 	struct zfs_fuid_info	*z_fuid_replay; /* fuid info for replay */
58 	zilog_t		*z_log;		/* intent log pointer */
59 	uint_t		z_acl_mode;	/* acl chmod/mode behavior */
60 	uint_t		z_acl_inherit;	/* acl inheritance behavior */
61 	zfs_case_t	z_case;		/* case-sense */
62 	boolean_t	z_utf8;		/* utf8-only */
63 	int		z_norm;		/* normalization flags */
64 	boolean_t	z_atime;	/* enable atimes mount option */
65 	boolean_t	z_unmounted;	/* unmounted */
66 	rrwlock_t	z_teardown_lock;
67 	krwlock_t	z_teardown_inactive_lock;
68 	list_t		z_all_znodes;	/* all vnodes in the fs */
69 	kmutex_t	z_znodes_lock;	/* lock for z_all_znodes */
70 	vnode_t		*z_ctldir;	/* .zfs directory pointer */
71 	boolean_t	z_show_ctldir;	/* expose .zfs in the root dir */
72 	boolean_t	z_issnap;	/* true if this is a snapshot */
73 	boolean_t	z_vscan;	/* virus scan on/off */
74 	boolean_t	z_use_fuids;	/* version allows fuids */
75 	boolean_t	z_replay;	/* set during ZIL replay */
76 	kmutex_t	z_online_recv_lock; /* held while recv in progress */
77 	uint64_t	z_version;	/* ZPL version */
78 	uint64_t	z_shares_dir;	/* hidden shares dir */
79 	kmutex_t	z_lock;
80 	uint64_t	z_userquota_obj;
81 	uint64_t	z_groupquota_obj;
82 #define	ZFS_OBJ_MTX_SZ	64
83 	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */
84 };
85 
86 /*
87  * Normal filesystems (those not under .zfs/snapshot) have a total
88  * file ID size limited to 12 bytes (including the length field) due to
89  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
90  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
91  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
92  * is not possible to expand beyond 12 bytes without abandoning support
93  * of NFSv2.
94  *
95  * For normal filesystems, we partition up the available space as follows:
96  *	2 bytes		fid length (required)
97  *	6 bytes		object number (48 bits)
98  *	4 bytes		generation number (32 bits)
99  *
100  * We reserve only 48 bits for the object number, as this is the limit
101  * currently defined and imposed by the DMU.
102  */
103 typedef struct zfid_short {
104 	uint16_t	zf_len;
105 	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */
106 	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */
107 } zfid_short_t;
108 
109 /*
110  * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
111  * (including the length field).  This makes files under .zfs/snapshot
112  * accessible by NFSv3 and NFSv4, but not NFSv2.
113  *
114  * For files under .zfs/snapshot, we partition up the available space
115  * as follows:
116  *	2 bytes		fid length (required)
117  *	6 bytes		object number (48 bits)
118  *	4 bytes		generation number (32 bits)
119  *	6 bytes		objset id (48 bits)
120  *	4 bytes		currently just zero (32 bits)
121  *
122  * We reserve only 48 bits for the object number and objset id, as these are
123  * the limits currently defined and imposed by the DMU.
124  */
125 typedef struct zfid_long {
126 	zfid_short_t	z_fid;
127 	uint8_t		zf_setid[6];		/* obj[i] = obj >> (8 * i) */
128 	uint8_t		zf_setgen[4];		/* gen[i] = gen >> (8 * i) */
129 } zfid_long_t;
130 
131 #define	SHORT_FID_LEN	(sizeof (zfid_short_t) - sizeof (uint16_t))
132 #define	LONG_FID_LEN	(sizeof (zfid_long_t) - sizeof (uint16_t))
133 
134 extern uint_t zfs_fsyncer_key;
135 
136 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs, char *osname, int *mode);
137 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, const char *osname, int mode);
138 extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
139     const char *domain, uint64_t rid, uint64_t *valuep);
140 extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
141     uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
142 extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
143     const char *domain, uint64_t rid, uint64_t quota);
144 extern boolean_t zfs_usergroup_overquota(zfsvfs_t *zfsvfs,
145     boolean_t isgroup, uint64_t fuid);
146 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
147 extern int zfsvfs_create(const char *name, int mode, zfsvfs_t **zvp);
148 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
149 
150 #ifdef	__cplusplus
151 }
152 #endif
153 
154 #endif	/* _SYS_FS_ZFS_VFSOPS_H */
155