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  * Copyright (c) 2011 Pawel Jakub Dawidek <[email protected]>.
24  * All rights reserved.
25  */
26 
27 #ifndef	_SYS_FS_ZFS_VFSOPS_H
28 #define	_SYS_FS_ZFS_VFSOPS_H
29 
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 	struct vnode	*z_rootvnode;	/* root vnode */
50 	struct rmlock	z_rootvnodelock;/* protection for root vnode */
51 	uint64_t	z_unlinkedobj;	/* id of unlinked zapobj */
52 	uint64_t	z_max_blksz;	/* maximum block size for files */
53 	uint64_t	z_fuid_obj;	/* fuid table object number */
54 	uint64_t	z_fuid_size;	/* fuid table size */
55 	avl_tree_t	z_fuid_idx;	/* fuid tree keyed by index */
56 	avl_tree_t	z_fuid_domain;	/* fuid tree keyed by domain */
57 	krwlock_t	z_fuid_lock;	/* fuid lock */
58 	boolean_t	z_fuid_loaded;	/* fuid tables are loaded */
59 	boolean_t	z_fuid_dirty;   /* need to sync fuid table ? */
60 	struct zfs_fuid_info	*z_fuid_replay; /* fuid info for replay */
61 	zilog_t		*z_log;		/* intent log pointer */
62 	uint_t		z_acl_mode;	/* acl chmod/mode behavior */
63 	uint_t		z_acl_inherit;	/* acl inheritance behavior */
64 	zfs_case_t	z_case;		/* case-sense */
65 	boolean_t	z_utf8;		/* utf8-only */
66 	int		z_norm;		/* normalization flags */
67 	boolean_t	z_atime;	/* enable atimes mount option */
68 	boolean_t	z_unmounted;	/* unmounted */
69 	rrmlock_t	z_teardown_lock;
70 	krwlock_t	z_teardown_inactive_lock;
71 	list_t		z_all_znodes;	/* all vnodes in the fs */
72 	kmutex_t	z_znodes_lock;	/* lock for z_all_znodes */
73 	struct zfsctl_root	*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_use_namecache;/* make use of FreeBSD name cache */
81 	uint64_t	z_version;	/* ZPL version */
82 	uint64_t	z_shares_dir;	/* hidden shares dir */
83 	kmutex_t	z_lock;
84 	uint64_t	z_userquota_obj;
85 	uint64_t	z_groupquota_obj;
86 	uint64_t	z_replay_eof;	/* New end of file - replay only */
87 	sa_attr_type_t	*z_attr_table;	/* SA attr mapping->id */
88 #define	ZFS_OBJ_MTX_SZ	64
89 	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */
90 #if defined(__FreeBSD__)
91 	struct task	z_unlinked_drain_task;
92 #endif
93 };
94 
95 /*
96  * Normal filesystems (those not under .zfs/snapshot) have a total
97  * file ID size limited to 12 bytes (including the length field) due to
98  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
99  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
100  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
101  * is not possible to expand beyond 12 bytes without abandoning support
102  * of NFSv2.
103  *
104  * For normal filesystems, we partition up the available space as follows:
105  *	2 bytes		fid length (required)
106  *	6 bytes		object number (48 bits)
107  *	4 bytes		generation number (32 bits)
108  *
109  * We reserve only 48 bits for the object number, as this is the limit
110  * currently defined and imposed by the DMU.
111  */
112 typedef struct zfid_short {
113 	uint16_t	zf_len;
114 	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */
115 	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */
116 } zfid_short_t;
117 
118 /*
119  * Filesystems under .zfs/snapshot have a total file ID size of 22[*] bytes
120  * (including the length field).  This makes files under .zfs/snapshot
121  * accessible by NFSv3 and NFSv4, but not NFSv2.
122  *
123  * For files under .zfs/snapshot, we partition up the available space
124  * as follows:
125  *	2 bytes		fid length (required)
126  *	6 bytes		object number (48 bits)
127  *	4 bytes		generation number (32 bits)
128  *	6 bytes		objset id (48 bits)
129  *	4 bytes[**]	currently just zero (32 bits)
130  *
131  * We reserve only 48 bits for the object number and objset id, as these are
132  * the limits currently defined and imposed by the DMU.
133  *
134  * [*] 20 bytes on FreeBSD to fit into the size of struct fid.
135  * [**] 2 bytes on FreeBSD for the above reason.
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[2];		/* 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 extern int zfs_super_owner;
148 
149 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
150 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
151 extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
152     const char *domain, uint64_t rid, uint64_t *valuep);
153 extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
154     uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
155 extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
156     const char *domain, uint64_t rid, uint64_t quota);
157 extern boolean_t zfs_owner_overquota(zfsvfs_t *zfsvfs, struct znode *,
158     boolean_t isgroup);
159 extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
160     uint64_t fuid);
161 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
162 extern int zfsvfs_create(const char *name, zfsvfs_t **zfvp);
163 extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os);
164 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
165 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
166 
167 #ifdef _KERNEL
168 extern void zfsvfs_update_fromname(const char *oldname, const char *newname);
169 #endif
170 
171 #ifdef	__cplusplus
172 }
173 #endif
174 
175 #endif	/* _SYS_FS_ZFS_VFSOPS_H */
176