xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_vfsops.h (revision a38ddfee9c8c6b6c5a2947ff52fd2338362a4444)
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 2008 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 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/isa_defs.h>
32 #include <sys/types32.h>
33 #include <sys/list.h>
34 #include <sys/vfs.h>
35 #include <sys/zil.h>
36 #include <sys/rrwlock.h>
37 #include <sys/zfs_ioctl.h>
38 
39 #ifdef	__cplusplus
40 extern "C" {
41 #endif
42 
43 typedef struct zfsvfs zfsvfs_t;
44 
45 struct zfsvfs {
46 	vfs_t		*z_vfs;		/* generic fs struct */
47 	zfsvfs_t	*z_parent;	/* parent fs */
48 	objset_t	*z_os;		/* objset reference */
49 	uint64_t	z_root;		/* id of root znode */
50 	uint64_t	z_unlinkedobj;	/* id of unlinked zapobj */
51 	uint64_t	z_max_blksz;	/* maximum block size for files */
52 	uint64_t	z_assign;	/* TXG_NOWAIT or set by zil_replay() */
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 	struct zfs_fuid_info	*z_fuid_replay; /* fuid info for replay */
60 	zilog_t		*z_log;		/* intent log pointer */
61 	uint_t		z_acl_mode;	/* acl chmod/mode behavior */
62 	uint_t		z_acl_inherit;	/* acl inheritance behavior */
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 	rrwlock_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_ctldir;	/* .zfs directory pointer */
73 	boolean_t	z_show_ctldir;	/* expose .zfs in the root dir */
74 	boolean_t	z_issnap;	/* true if this is a snapshot */
75 	boolean_t	z_vscan;	/* virus scan on/off */
76 	boolean_t	z_use_fuids;	/* version allows fuids */
77 	kmutex_t	z_online_recv_lock; /* recv in prog grabs as WRITER */
78 	uint64_t	z_version;	/* ZPL version */
79 #define	ZFS_OBJ_MTX_SZ	64
80 	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */
81 };
82 
83 /*
84  * Normal filesystems (those not under .zfs/snapshot) have a total
85  * file ID size limited to 12 bytes (including the length field) due to
86  * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
87  * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
88  * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
89  * is not possible to expand beyond 12 bytes without abandoning support
90  * of NFSv2.
91  *
92  * For normal filesystems, we partition up the available space as follows:
93  *	2 bytes		fid length (required)
94  *	6 bytes		object number (48 bits)
95  *	4 bytes		generation number (32 bits)
96  *
97  * We reserve only 48 bits for the object number, as this is the limit
98  * currently defined and imposed by the DMU.
99  */
100 typedef struct zfid_short {
101 	uint16_t	zf_len;
102 	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */
103 	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */
104 } zfid_short_t;
105 
106 /*
107  * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
108  * (including the length field).  This makes files under .zfs/snapshot
109  * accessible by NFSv3 and NFSv4, but not NFSv2.
110  *
111  * For files under .zfs/snapshot, we partition up the available space
112  * as follows:
113  *	2 bytes		fid length (required)
114  *	6 bytes		object number (48 bits)
115  *	4 bytes		generation number (32 bits)
116  *	6 bytes		objset id (48 bits)
117  *	4 bytes		currently just zero (32 bits)
118  *
119  * We reserve only 48 bits for the object number and objset id, as these are
120  * the limits currently defined and imposed by the DMU.
121  */
122 typedef struct zfid_long {
123 	zfid_short_t	z_fid;
124 	uint8_t		zf_setid[6];		/* obj[i] = obj >> (8 * i) */
125 	uint8_t		zf_setgen[4];		/* gen[i] = gen >> (8 * i) */
126 } zfid_long_t;
127 
128 #define	SHORT_FID_LEN	(sizeof (zfid_short_t) - sizeof (uint16_t))
129 #define	LONG_FID_LEN	(sizeof (zfid_long_t) - sizeof (uint16_t))
130 
131 extern uint_t zfs_fsyncer_key;
132 
133 extern int zfs_suspend_fs(zfsvfs_t *zfsvfs, char *osname, int *mode);
134 extern int zfs_resume_fs(zfsvfs_t *zfsvfs, const char *osname, int mode);
135 
136 #ifdef	__cplusplus
137 }
138 #endif
139 
140 #endif	/* _SYS_FS_ZFS_VFSOPS_H */
141