xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision 46657f8d750bdb71753495ce2919170f126b8e34)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_FS_ZFS_H
27 #define	_SYS_FS_ZFS_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/types.h>
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 /*
38  * Types and constants shared between userland and the kernel.
39  */
40 
41 /*
42  * Each dataset can be one of the following types.  These constants can be
43  * combined into masks that can be passed to various functions.
44  */
45 typedef enum {
46 	ZFS_TYPE_FILESYSTEM	= 0x1,
47 	ZFS_TYPE_SNAPSHOT	= 0x2,
48 	ZFS_TYPE_VOLUME		= 0x4
49 } zfs_type_t;
50 
51 #define	ZFS_TYPE_ANY	\
52 	(ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
53 
54 /*
55  * Properties are identified by these constants and must be added to the
56  * end of this list to ensure that external conumsers are not affected
57  * by the change. The property list also determines how 'zfs get' will
58  * display them.  If you make any changes to this list, be sure to update
59  * the property table in usr/src/common/zfs/zfs_prop.c.
60  */
61 typedef enum {
62 	ZFS_PROP_CONT = -2,
63 	ZFS_PROP_INVAL = -1,
64 	ZFS_PROP_TYPE,
65 	ZFS_PROP_CREATION,
66 	ZFS_PROP_USED,
67 	ZFS_PROP_AVAILABLE,
68 	ZFS_PROP_REFERENCED,
69 	ZFS_PROP_COMPRESSRATIO,
70 	ZFS_PROP_MOUNTED,
71 	ZFS_PROP_ORIGIN,
72 	ZFS_PROP_QUOTA,
73 	ZFS_PROP_RESERVATION,
74 	ZFS_PROP_VOLSIZE,
75 	ZFS_PROP_VOLBLOCKSIZE,
76 	ZFS_PROP_RECORDSIZE,
77 	ZFS_PROP_MOUNTPOINT,
78 	ZFS_PROP_SHARENFS,
79 	ZFS_PROP_CHECKSUM,
80 	ZFS_PROP_COMPRESSION,
81 	ZFS_PROP_ATIME,
82 	ZFS_PROP_DEVICES,
83 	ZFS_PROP_EXEC,
84 	ZFS_PROP_SETUID,
85 	ZFS_PROP_READONLY,
86 	ZFS_PROP_ZONED,
87 	ZFS_PROP_SNAPDIR,
88 	ZFS_PROP_ACLMODE,
89 	ZFS_PROP_ACLINHERIT,
90 	ZFS_PROP_CREATETXG,		/* not exposed to the user */
91 	ZFS_PROP_NAME,			/* not exposed to the user */
92 	ZFS_PROP_CANMOUNT,
93 	ZFS_PROP_SHAREISCSI,
94 	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */
95 	ZFS_PROP_XATTR,
96 	ZFS_PROP_NUMCLONES		/* not exposed to the user */
97 } zfs_prop_t;
98 
99 #define	ZFS_PROP_VALUE		"value"
100 #define	ZFS_PROP_SOURCE		"source"
101 
102 /*
103  * The following functions are shared between libzfs and the kernel.
104  */
105 zfs_prop_t zfs_name_to_prop(const char *);
106 boolean_t zfs_prop_user(const char *);
107 int zfs_prop_readonly(zfs_prop_t);
108 const char *zfs_prop_default_string(zfs_prop_t);
109 const char *zfs_prop_to_name(zfs_prop_t);
110 uint64_t zfs_prop_default_numeric(zfs_prop_t);
111 int zfs_prop_inheritable(zfs_prop_t);
112 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
113 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
114 
115 /*
116  * Property Iterator
117  */
118 typedef zfs_prop_t (*zfs_prop_f)(zfs_prop_t, void *);
119 extern zfs_prop_t zfs_prop_iter(zfs_prop_f, void *, boolean_t);
120 
121 /*
122  * On-disk version number.
123  */
124 #define	ZFS_VERSION_1			1ULL
125 #define	ZFS_VERSION_2			2ULL
126 #define	ZFS_VERSION_3			3ULL
127 #define	ZFS_VERSION			ZFS_VERSION_3
128 #define	ZFS_VERSION_STRING		"3"
129 
130 /*
131  * Symbolic names for the changes that caused a ZFS_VERSION switch.
132  * Used in the code when checking for presence or absence of a feature.
133  * Feel free to define multiple symbolic names for each version if there
134  * were multiple changes to on-disk structures during that version.
135  *
136  * NOTE: When checking the current ZFS_VERSION in your code, be sure
137  *       to use spa_version() since it reports the version of the
138  *       last synced uberblock.  Checking the in-flight version can
139  *       be dangerous in some cases.
140  */
141 #define	ZFS_VERSION_INITIAL		ZFS_VERSION_1
142 #define	ZFS_VERSION_DITTO_BLOCKS	ZFS_VERSION_2
143 #define	ZFS_VERSION_SPARES		ZFS_VERSION_3
144 #define	ZFS_VERSION_RAID6		ZFS_VERSION_3
145 #define	ZFS_VERSION_BPLIST_ACCOUNT	ZFS_VERSION_3
146 #define	ZFS_VERSION_RAIDZ_DEFLATE	ZFS_VERSION_3
147 #define	ZFS_VERSION_DNODE_BYTES		ZFS_VERSION_3
148 
149 /*
150  * The following are configuration names used in the nvlist describing a pool's
151  * configuration.
152  */
153 #define	ZPOOL_CONFIG_VERSION		"version"
154 #define	ZPOOL_CONFIG_POOL_NAME		"name"
155 #define	ZPOOL_CONFIG_POOL_STATE		"state"
156 #define	ZPOOL_CONFIG_POOL_TXG		"txg"
157 #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
158 #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
159 #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
160 #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
161 #define	ZPOOL_CONFIG_TYPE		"type"
162 #define	ZPOOL_CONFIG_CHILDREN		"children"
163 #define	ZPOOL_CONFIG_ID			"id"
164 #define	ZPOOL_CONFIG_GUID		"guid"
165 #define	ZPOOL_CONFIG_PATH		"path"
166 #define	ZPOOL_CONFIG_DEVID		"devid"
167 #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
168 #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
169 #define	ZPOOL_CONFIG_ASHIFT		"ashift"
170 #define	ZPOOL_CONFIG_ASIZE		"asize"
171 #define	ZPOOL_CONFIG_DTL		"DTL"
172 #define	ZPOOL_CONFIG_STATS		"stats"
173 #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
174 #define	ZPOOL_CONFIG_OFFLINE		"offline"
175 #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
176 #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
177 #define	ZPOOL_CONFIG_SPARES		"spares"
178 #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
179 #define	ZPOOL_CONFIG_NPARITY		"nparity"
180 
181 #define	VDEV_TYPE_ROOT			"root"
182 #define	VDEV_TYPE_MIRROR		"mirror"
183 #define	VDEV_TYPE_REPLACING		"replacing"
184 #define	VDEV_TYPE_RAIDZ			"raidz"
185 #define	VDEV_TYPE_DISK			"disk"
186 #define	VDEV_TYPE_FILE			"file"
187 #define	VDEV_TYPE_MISSING		"missing"
188 #define	VDEV_TYPE_SPARE			"spare"
189 
190 /*
191  * This is needed in userland to report the minimum necessary device size.
192  */
193 #define	SPA_MINDEVSIZE		(64ULL << 20)
194 
195 /*
196  * The location of the pool configuration repository, shared between kernel and
197  * userland.
198  */
199 #define	ZPOOL_CACHE_DIR		"/etc/zfs"
200 #define	ZPOOL_CACHE_FILE	"zpool.cache"
201 #define	ZPOOL_CACHE_TMP		".zpool.cache"
202 
203 #define	ZPOOL_CACHE		ZPOOL_CACHE_DIR "/" ZPOOL_CACHE_FILE
204 
205 /*
206  * vdev states are ordered from least to most healthy.
207  * A vdev that's CANT_OPEN or below is considered unusable.
208  */
209 typedef enum vdev_state {
210 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
211 	VDEV_STATE_CLOSED,	/* Not currently open			*/
212 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
213 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
214 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
215 	VDEV_STATE_HEALTHY	/* Presumed good			*/
216 } vdev_state_t;
217 
218 /*
219  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
220  * of the vdev stats structure uses these constants to distinguish why.
221  */
222 typedef enum vdev_aux {
223 	VDEV_AUX_NONE,		/* no error				*/
224 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
225 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
226 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
227 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
228 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
229 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
230 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
231 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
232 	VDEV_AUX_SPARED		/* hot spare used in another pool	*/
233 } vdev_aux_t;
234 
235 /*
236  * pool state.  The following states are written to disk as part of the normal
237  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE.  The remaining states are
238  * software abstractions used at various levels to communicate pool state.
239  */
240 typedef enum pool_state {
241 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
242 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
243 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
244 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
245 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
246 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
247 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
248 } pool_state_t;
249 
250 /*
251  * Scrub types.
252  */
253 typedef enum pool_scrub_type {
254 	POOL_SCRUB_NONE,
255 	POOL_SCRUB_RESILVER,
256 	POOL_SCRUB_EVERYTHING,
257 	POOL_SCRUB_TYPES
258 } pool_scrub_type_t;
259 
260 /*
261  * ZIO types.  Needed to interpret vdev statistics below.
262  */
263 typedef enum zio_type {
264 	ZIO_TYPE_NULL = 0,
265 	ZIO_TYPE_READ,
266 	ZIO_TYPE_WRITE,
267 	ZIO_TYPE_FREE,
268 	ZIO_TYPE_CLAIM,
269 	ZIO_TYPE_IOCTL,
270 	ZIO_TYPES
271 } zio_type_t;
272 
273 /*
274  * Vdev statistics.  Note: all fields should be 64-bit because this
275  * is passed between kernel and userland as an nvlist uint64 array.
276  */
277 typedef struct vdev_stat {
278 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
279 	uint64_t	vs_state;		/* vdev state		*/
280 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
281 	uint64_t	vs_alloc;		/* space allocated	*/
282 	uint64_t	vs_space;		/* total capacity	*/
283 	uint64_t	vs_dspace;		/* deflated capacity	*/
284 	uint64_t	vs_rsize;		/* replaceable dev size */
285 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
286 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
287 	uint64_t	vs_read_errors;		/* read errors		*/
288 	uint64_t	vs_write_errors;	/* write errors		*/
289 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
290 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
291 	uint64_t	vs_scrub_type;		/* pool_scrub_type_t	*/
292 	uint64_t	vs_scrub_complete;	/* completed?		*/
293 	uint64_t	vs_scrub_examined;	/* bytes examined; top	*/
294 	uint64_t	vs_scrub_repaired;	/* bytes repaired; leaf	*/
295 	uint64_t	vs_scrub_errors;	/* errors during scrub	*/
296 	uint64_t	vs_scrub_start;		/* UTC scrub start time	*/
297 	uint64_t	vs_scrub_end;		/* UTC scrub end time	*/
298 } vdev_stat_t;
299 
300 #define	ZFS_DRIVER	"zfs"
301 #define	ZFS_DEV		"/dev/zfs"
302 
303 /*
304  * zvol paths.  Irritatingly, the devfsadm interfaces want all these
305  * paths without the /dev prefix, but for some things, we want the
306  * /dev prefix.  Below are the names without /dev.
307  */
308 #define	ZVOL_DEV_DIR	"zvol/dsk"
309 #define	ZVOL_RDEV_DIR	"zvol/rdsk"
310 
311 /*
312  * And here are the things we need with /dev, etc. in front of them.
313  */
314 #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zvol@0:"
315 #define	ZVOL_FULL_DEV_DIR	"/dev/" ZVOL_DEV_DIR
316 
317 #define	ZVOL_PROP_NAME		"name"
318 
319 /*
320  * /dev/zfs ioctl numbers.
321  */
322 #define	ZFS_IOC		('Z' << 8)
323 
324 typedef enum zfs_ioc {
325 	ZFS_IOC_POOL_CREATE = ZFS_IOC,
326 	ZFS_IOC_POOL_DESTROY,
327 	ZFS_IOC_POOL_IMPORT,
328 	ZFS_IOC_POOL_EXPORT,
329 	ZFS_IOC_POOL_CONFIGS,
330 	ZFS_IOC_POOL_STATS,
331 	ZFS_IOC_POOL_TRYIMPORT,
332 	ZFS_IOC_POOL_SCRUB,
333 	ZFS_IOC_POOL_FREEZE,
334 	ZFS_IOC_POOL_UPGRADE,
335 	ZFS_IOC_POOL_GET_HISTORY,
336 	ZFS_IOC_POOL_LOG_HISTORY,
337 	ZFS_IOC_VDEV_ADD,
338 	ZFS_IOC_VDEV_REMOVE,
339 	ZFS_IOC_VDEV_ONLINE,
340 	ZFS_IOC_VDEV_OFFLINE,
341 	ZFS_IOC_VDEV_ATTACH,
342 	ZFS_IOC_VDEV_DETACH,
343 	ZFS_IOC_VDEV_SETPATH,
344 	ZFS_IOC_OBJSET_STATS,
345 	ZFS_IOC_DATASET_LIST_NEXT,
346 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
347 	ZFS_IOC_SET_PROP,
348 	ZFS_IOC_CREATE_MINOR,
349 	ZFS_IOC_REMOVE_MINOR,
350 	ZFS_IOC_CREATE,
351 	ZFS_IOC_DESTROY,
352 	ZFS_IOC_ROLLBACK,
353 	ZFS_IOC_RENAME,
354 	ZFS_IOC_RECVBACKUP,
355 	ZFS_IOC_SENDBACKUP,
356 	ZFS_IOC_INJECT_FAULT,
357 	ZFS_IOC_CLEAR_FAULT,
358 	ZFS_IOC_INJECT_LIST_NEXT,
359 	ZFS_IOC_ERROR_LOG,
360 	ZFS_IOC_CLEAR,
361 	ZFS_IOC_PROMOTE,
362 	ZFS_IOC_DESTROY_SNAPS,
363 	ZFS_IOC_SNAPSHOT,
364 	ZFS_IOC_DSOBJ_TO_DSNAME,
365 	ZFS_IOC_OBJ_TO_PATH
366 } zfs_ioc_t;
367 
368 /*
369  * Internal SPA load state.  Used by FMA diagnosis engine.
370  */
371 typedef enum {
372 	SPA_LOAD_NONE,		/* no load in progress */
373 	SPA_LOAD_OPEN,		/* normal open */
374 	SPA_LOAD_IMPORT,	/* import in progress */
375 	SPA_LOAD_TRYIMPORT	/* tryimport in progress */
376 } spa_load_state_t;
377 
378 /*
379  * Bookmark name values.
380  */
381 #define	ZPOOL_ERR_LIST		"error list"
382 #define	ZPOOL_ERR_DATASET	"dataset"
383 #define	ZPOOL_ERR_OBJECT	"object"
384 
385 #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
386 
387 /*
388  * The following are names used in the nvlist describing
389  * the pool's history log.
390  */
391 #define	ZPOOL_HIST_RECORD	"history record"
392 #define	ZPOOL_HIST_TIME		"history time"
393 #define	ZPOOL_HIST_CMD		"history command"
394 
395 #ifdef	__cplusplus
396 }
397 #endif
398 
399 #endif	/* _SYS_FS_ZFS_H */
400