xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_vfsops.h (revision d019449136cec9f203f106de418421095790e4e2)
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_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 	boolean_t	z_use_sa;	/* version allow system attributes */
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 	sa_attr_type_t	*z_attr_table;	/* SA attr mapping->id */
83 #define	ZFS_OBJ_MTX_SZ	64
84 	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */
85 };
86 
87 /*
88  * Normal filesystems (those not under .zfs/snapshot) have a total
89  * file ID size limited to 12 bytes (including the length field) due to
90  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
91  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
92  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
93  * is not possible to expand beyond 12 bytes without abandoning support
94  * of NFSv2.
95  *
96  * For normal filesystems, we partition up the available space as follows:
97  *	2 bytes		fid length (required)
98  *	6 bytes		object number (48 bits)
99  *	4 bytes		generation number (32 bits)
100  *
101  * We reserve only 48 bits for the object number, as this is the limit
102  * currently defined and imposed by the DMU.
103  */
104 typedef struct zfid_short {
105 	uint16_t	zf_len;
106 	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */
107 	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */
108 } zfid_short_t;
109 
110 /*
111  * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
112  * (including the length field).  This makes files under .zfs/snapshot
113  * accessible by NFSv3 and NFSv4, but not NFSv2.
114  *
115  * For files under .zfs/snapshot, we partition up the available space
116  * as follows:
117  *	2 bytes		fid length (required)
118  *	6 bytes		object number (48 bits)
119  *	4 bytes		generation number (32 bits)
120  *	6 bytes		objset id (48 bits)
121  *	4 bytes		currently just zero (32 bits)
122  *
123  * We reserve only 48 bits for the object number and objset id, as these are
124  * the limits currently defined and imposed by the DMU.
125  */
126 typedef struct zfid_long {
127 	zfid_short_t	z_fid;
128 	uint8_t		zf_setid[6];		/* obj[i] = obj >> (8 * i) */
129 	uint8_t		zf_setgen[4];		/* gen[i] = gen >> (8 * i) */
130 } zfid_long_t;
131 
132 #define	SHORT_FID_LEN	(sizeof (zfid_short_t) - sizeof (uint16_t))
133 #define	LONG_FID_LEN	(sizeof (zfid_long_t) - sizeof (uint16_t))
134 
135 extern uint_t zfs_fsyncer_key;
136 
137 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
138 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, const char *osname);
139 extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
140     const char *domain, uint64_t rid, uint64_t *valuep);
141 extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
142     uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
143 extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
144     const char *domain, uint64_t rid, uint64_t quota);
145 extern boolean_t zfs_owner_overquota(zfsvfs_t *zfsvfs, struct znode *,
146     boolean_t isgroup);
147 extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
148     uint64_t fuid);
149 extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
150 extern int zfsvfs_create(const char *name, zfsvfs_t **zfvp);
151 extern void zfsvfs_free(zfsvfs_t *zfsvfs);
152 extern int zfs_check_global_label(const char *dsname, const char *hexsl);
153 
154 #ifdef	__cplusplus
155 }
156 #endif
157 
158 #endif	/* _SYS_FS_ZFS_VFSOPS_H */
159