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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24 
25 #ifndef	_SYS_FS_ZFS_VFSOPS_H
26 #define	_SYS_FS_ZFS_VFSOPS_H
27 
28 #include <sys/isa_defs.h>
29 #include <sys/types32.h>
30 #include <sys/list.h>
31 #include <sys/vfs.h>
32 #include <sys/zil.h>
33 #include <sys/sa.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 struct znode;
43 
44 struct zfsvfs {
45 	vfs_t		*z_vfs;		/* generic fs struct */
46 	zfsvfs_t	*z_parent;	/* parent fs */
47 	objset_t	*z_os;		/* objset reference */
48 	uint64_t	z_root;		/* id of root znode */
49 	uint64_t	z_unlinkedobj;	/* id of unlinked zapobj */
50 	uint64_t	z_max_blksz;	/* maximum block size for files */
51 	uint64_t	z_fuid_obj;	/* fuid table object number */
52 	uint64_t	z_fuid_size;	/* fuid table size */
53 	avl_tree_t	z_fuid_idx;	/* fuid tree keyed by index */
54 	avl_tree_t	z_fuid_domain;	/* fuid tree keyed by domain */
55 	krwlock_t	z_fuid_lock;	/* fuid lock */
56 	boolean_t	z_fuid_loaded;	/* fuid tables are loaded */
57 	boolean_t	z_fuid_dirty;   /* need to sync fuid table ? */
58 	struct zfs_fuid_info	*z_fuid_replay; /* fuid info for replay */
59 	zilog_t		*z_log;		/* intent log pointer */
60 	uint_t		z_acl_mode;	/* acl chmod/mode behavior */
61 	uint_t		z_acl_inherit;	/* acl inheritance behavior */
62 	boolean_t	z_acl_implicit;	/* acl implicit owner rights */
63 	zfs_case_t	z_case;		/* case-sense */
64 	boolean_t	z_utf8;		/* utf8-only */
65 	int		z_norm;		/* normalization flags */
66 	boolean_t	z_atime;	/* enable atimes mount option */
67 	boolean_t	z_unmounted;	/* unmounted */
68 	rrmlock_t	z_teardown_lock;
69 	krwlock_t	z_teardown_inactive_lock;
70 	list_t		z_all_znodes;	/* all vnodes in the fs */
71 	kmutex_t	z_znodes_lock;	/* lock for z_all_znodes */
72 	vnode_t		*z_rootdir;	/* mount root directory pointer */
73 	vnode_t		*z_ctldir;	/* .zfs directory pointer */
74 	boolean_t	z_show_ctldir;	/* expose .zfs in the root dir */
75 	boolean_t	z_issnap;	/* true if this is a snapshot */
76 	boolean_t	z_vscan;	/* virus scan on/off */
77 	boolean_t	z_use_fuids;	/* version allows fuids */
78 	boolean_t	z_replay;	/* set during ZIL replay */
79 	boolean_t	z_use_sa;	/* version allow system attributes */
80 	boolean_t	z_draining;	/* is true when drain is active */
81 	boolean_t	z_drain_cancel; /* signal the unlinked drain to stop */
82 	uint64_t	z_version;	/* ZPL version */
83 	uint64_t	z_shares_dir;	/* hidden shares dir */
84 	kmutex_t	z_lock;
85 	uint64_t	z_userquota_obj;
86 	uint64_t	z_groupquota_obj;
87 	uint64_t	z_userobjquota_obj;
88 	uint64_t	z_groupobjquota_obj;
89 	uint64_t	z_projectquota_obj;
90 	uint64_t	z_projectobjquota_obj;
91 	uint64_t	z_replay_eof;	/* New end of file - replay only */
92 	sa_attr_type_t	*z_attr_table;	/* SA attr mapping->id */
93 #define	ZFS_OBJ_MTX_SZ	64
94 	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */
95 	taskqid_t	z_drain_task;	/* task id for the unlink drain task */
96 };
97 
98 /*
99  * Normal filesystems (those not under .zfs/snapshot) have a total
100  * file ID size limited to 12 bytes (including the length field) due to
101  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
102  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
103  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
104  * is not possible to expand beyond 12 bytes without abandoning support
105  * of NFSv2.
106  *
107  * For normal filesystems, we partition up the available space as follows:
108  *	2 bytes		fid length (required)
109  *	6 bytes		object number (48 bits)
110  *	4 bytes		generation number (32 bits)
111  *
112  * We reserve only 48 bits for the object number, as this is the limit
113  * currently defined and imposed by the DMU.
114  */
115 typedef struct zfid_short {
116 	uint16_t	zf_len;
117 	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */
118 	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */
119 } zfid_short_t;
120 
121 /*
122  * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
123  * (including the length field).  This makes files under .zfs/snapshot
124  * accessible by NFSv3 and NFSv4, but not NFSv2.
125  *
126  * For files under .zfs/snapshot, we partition up the available space
127  * as follows:
128  *	2 bytes		fid length (required)
129  *	6 bytes		object number (48 bits)
130  *	4 bytes		generation number (32 bits)
131  *	6 bytes		objset id (48 bits)
132  *	4 bytes		currently just zero (32 bits)
133  *
134  * We reserve only 48 bits for the object number and objset id, as these are
135  * the limits currently defined and imposed by the DMU.
136  */
137 typedef struct zfid_long {
138 	zfid_short_t	z_fid;
139 	uint8_t		zf_setid[6];		/* obj[i] = obj >> (8 * i) */
140 	uint8_t		zf_setgen[4];		/* gen[i] = gen >> (8 * i) */
141 } zfid_long_t;
142 
143 #define	SHORT_FID_LEN	(sizeof (zfid_short_t) - sizeof (uint16_t))
144 #define	LONG_FID_LEN	(sizeof (zfid_long_t) - sizeof (uint16_t))
145 
146 extern uint_t zfs_fsyncer_key;
147 
148 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
149 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
150 extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
151     const char *domain, uint64_t rid, uint64_t *valuep);
152 extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
153     uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
154 extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
155     const char *domain, uint64_t rid, uint64_t quota);
156 extern boolean_t zfs_id_overblockquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
157     uint64_t id);
158 extern boolean_t zfs_id_overobjquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
159     uint64_t id);
160 extern boolean_t zfs_id_overquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
161     uint64_t id);
162 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
163 extern int zfsvfs_create(const char *name, boolean_t readony, zfsvfs_t **zfvp);
164 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os);
165 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
166 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
167 
168 #ifdef	__cplusplus
169 }
170 #endif
171 
172 #endif	/* _SYS_FS_ZFS_VFSOPS_H */
173