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 /*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 */
28
29 /* Portions Copyright 2010 Robert Milkowski */
30
31 #ifndef _SYS_FS_ZFS_H
32 #define _SYS_FS_ZFS_H
33
34 #include <sys/time.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /*
41 * Types and constants shared between userland and the kernel.
42 */
43
44 /*
45 * Each dataset can be one of the following types. These constants can be
46 * combined into masks that can be passed to various functions.
47 */
48 typedef enum {
49 ZFS_TYPE_FILESYSTEM = 0x1,
50 ZFS_TYPE_SNAPSHOT = 0x2,
51 ZFS_TYPE_VOLUME = 0x4,
52 ZFS_TYPE_POOL = 0x8
53 } zfs_type_t;
54
55 typedef enum dmu_objset_type {
56 DMU_OST_NONE,
57 DMU_OST_META,
58 DMU_OST_ZFS,
59 DMU_OST_ZVOL,
60 DMU_OST_OTHER, /* For testing only! */
61 DMU_OST_ANY, /* Be careful! */
62 DMU_OST_NUMTYPES
63 } dmu_objset_type_t;
64
65 #define ZFS_TYPE_DATASET \
66 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
67
68 #define ZAP_MAXNAMELEN 256
69 #define ZAP_MAXVALUELEN (1024 * 8)
70 #define ZAP_OLDMAXVALUELEN 1024
71
72 /*
73 * Dataset properties are identified by these constants and must be added to
74 * the end of this list to ensure that external consumers are not affected
75 * by the change. If you make any changes to this list, be sure to update
76 * the property table in usr/src/common/zfs/zfs_prop.c.
77 */
78 typedef enum {
79 ZFS_PROP_TYPE,
80 ZFS_PROP_CREATION,
81 ZFS_PROP_USED,
82 ZFS_PROP_AVAILABLE,
83 ZFS_PROP_REFERENCED,
84 ZFS_PROP_COMPRESSRATIO,
85 ZFS_PROP_MOUNTED,
86 ZFS_PROP_ORIGIN,
87 ZFS_PROP_QUOTA,
88 ZFS_PROP_RESERVATION,
89 ZFS_PROP_VOLSIZE,
90 ZFS_PROP_VOLBLOCKSIZE,
91 ZFS_PROP_RECORDSIZE,
92 ZFS_PROP_MOUNTPOINT,
93 ZFS_PROP_SHARENFS,
94 ZFS_PROP_CHECKSUM,
95 ZFS_PROP_COMPRESSION,
96 ZFS_PROP_ATIME,
97 ZFS_PROP_DEVICES,
98 ZFS_PROP_EXEC,
99 ZFS_PROP_SETUID,
100 ZFS_PROP_READONLY,
101 ZFS_PROP_ZONED,
102 ZFS_PROP_SNAPDIR,
103 ZFS_PROP_ACLMODE,
104 ZFS_PROP_ACLINHERIT,
105 ZFS_PROP_CREATETXG, /* not exposed to the user */
106 ZFS_PROP_NAME, /* not exposed to the user */
107 ZFS_PROP_CANMOUNT,
108 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
109 ZFS_PROP_XATTR,
110 ZFS_PROP_NUMCLONES, /* not exposed to the user */
111 ZFS_PROP_COPIES,
112 ZFS_PROP_VERSION,
113 ZFS_PROP_UTF8ONLY,
114 ZFS_PROP_NORMALIZE,
115 ZFS_PROP_CASE,
116 ZFS_PROP_VSCAN,
117 ZFS_PROP_NBMAND,
118 ZFS_PROP_SHARESMB,
119 ZFS_PROP_REFQUOTA,
120 ZFS_PROP_REFRESERVATION,
121 ZFS_PROP_GUID,
122 ZFS_PROP_PRIMARYCACHE,
123 ZFS_PROP_SECONDARYCACHE,
124 ZFS_PROP_USEDSNAP,
125 ZFS_PROP_USEDDS,
126 ZFS_PROP_USEDCHILD,
127 ZFS_PROP_USEDREFRESERV,
128 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
129 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
130 ZFS_PROP_DEFER_DESTROY,
131 ZFS_PROP_USERREFS,
132 ZFS_PROP_LOGBIAS,
133 ZFS_PROP_UNIQUE, /* not exposed to the user */
134 ZFS_PROP_OBJSETID, /* not exposed to the user */
135 ZFS_PROP_DEDUP,
136 ZFS_PROP_MLSLABEL,
137 ZFS_PROP_SYNC,
138 ZFS_PROP_REFRATIO,
139 ZFS_PROP_WRITTEN,
140 ZFS_PROP_CLONES,
141 ZFS_PROP_LOGICALUSED,
142 ZFS_PROP_LOGICALREFERENCED,
143 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
144 ZFS_NUM_PROPS
145 } zfs_prop_t;
146
147 typedef enum {
148 ZFS_PROP_USERUSED,
149 ZFS_PROP_USERQUOTA,
150 ZFS_PROP_GROUPUSED,
151 ZFS_PROP_GROUPQUOTA,
152 ZFS_NUM_USERQUOTA_PROPS
153 } zfs_userquota_prop_t;
154
155 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
156
157 /*
158 * Pool properties are identified by these constants and must be added to the
159 * end of this list to ensure that external consumers are not affected
160 * by the change. If you make any changes to this list, be sure to update
161 * the property table in usr/src/common/zfs/zpool_prop.c.
162 */
163 typedef enum {
164 ZPOOL_PROP_NAME,
165 ZPOOL_PROP_SIZE,
166 ZPOOL_PROP_CAPACITY,
167 ZPOOL_PROP_ALTROOT,
168 ZPOOL_PROP_HEALTH,
169 ZPOOL_PROP_GUID,
170 ZPOOL_PROP_VERSION,
171 ZPOOL_PROP_BOOTFS,
172 ZPOOL_PROP_DELEGATION,
173 ZPOOL_PROP_AUTOREPLACE,
174 ZPOOL_PROP_CACHEFILE,
175 ZPOOL_PROP_FAILUREMODE,
176 ZPOOL_PROP_LISTSNAPS,
177 ZPOOL_PROP_AUTOEXPAND,
178 ZPOOL_PROP_DEDUPDITTO,
179 ZPOOL_PROP_DEDUPRATIO,
180 ZPOOL_PROP_FREE,
181 ZPOOL_PROP_ALLOCATED,
182 ZPOOL_PROP_READONLY,
183 ZPOOL_PROP_COMMENT,
184 ZPOOL_PROP_EXPANDSZ,
185 ZPOOL_PROP_FREEING,
186 ZPOOL_NUM_PROPS
187 } zpool_prop_t;
188
189 /* Small enough to not hog a whole line of printout in zpool(1M). */
190 #define ZPROP_MAX_COMMENT 32
191
192 #define ZPROP_CONT -2
193 #define ZPROP_INVAL -1
194
195 #define ZPROP_VALUE "value"
196 #define ZPROP_SOURCE "source"
197
198 typedef enum {
199 ZPROP_SRC_NONE = 0x1,
200 ZPROP_SRC_DEFAULT = 0x2,
201 ZPROP_SRC_TEMPORARY = 0x4,
202 ZPROP_SRC_LOCAL = 0x8,
203 ZPROP_SRC_INHERITED = 0x10,
204 ZPROP_SRC_RECEIVED = 0x20
205 } zprop_source_t;
206
207 #define ZPROP_SRC_ALL 0x3f
208
209 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
210 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
211 /*
212 * Dataset flag implemented as a special entry in the props zap object
213 * indicating that the dataset has received properties on or after
214 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
215 * just as it did in earlier versions, and thereafter, local properties are
216 * preserved.
217 */
218 #define ZPROP_HAS_RECVD "$hasrecvd"
219
220 typedef enum {
221 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
222 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
223 } zprop_errflags_t;
224
225 typedef int (*zprop_func)(int, void *);
226
227 /*
228 * Properties to be set on the root file system of a new pool
229 * are stuffed into their own nvlist, which is then included in
230 * the properties nvlist with the pool properties.
231 */
232 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
233
234 /*
235 * Dataset property functions shared between libzfs and kernel.
236 */
237 const char *zfs_prop_default_string(zfs_prop_t);
238 uint64_t zfs_prop_default_numeric(zfs_prop_t);
239 boolean_t zfs_prop_readonly(zfs_prop_t);
240 boolean_t zfs_prop_inheritable(zfs_prop_t);
241 boolean_t zfs_prop_setonce(zfs_prop_t);
242 const char *zfs_prop_to_name(zfs_prop_t);
243 zfs_prop_t zfs_name_to_prop(const char *);
244 boolean_t zfs_prop_user(const char *);
245 boolean_t zfs_prop_userquota(const char *);
246 boolean_t zfs_prop_written(const char *);
247 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
248 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
249 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
250 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
251
252 /*
253 * Pool property functions shared between libzfs and kernel.
254 */
255 zpool_prop_t zpool_name_to_prop(const char *);
256 const char *zpool_prop_to_name(zpool_prop_t);
257 const char *zpool_prop_default_string(zpool_prop_t);
258 uint64_t zpool_prop_default_numeric(zpool_prop_t);
259 boolean_t zpool_prop_readonly(zpool_prop_t);
260 boolean_t zpool_prop_feature(const char *);
261 boolean_t zpool_prop_unsupported(const char *name);
262 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
263 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
264 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
265
266 /*
267 * Definitions for the Delegation.
268 */
269 typedef enum {
270 ZFS_DELEG_WHO_UNKNOWN = 0,
271 ZFS_DELEG_USER = 'u',
272 ZFS_DELEG_USER_SETS = 'U',
273 ZFS_DELEG_GROUP = 'g',
274 ZFS_DELEG_GROUP_SETS = 'G',
275 ZFS_DELEG_EVERYONE = 'e',
276 ZFS_DELEG_EVERYONE_SETS = 'E',
277 ZFS_DELEG_CREATE = 'c',
278 ZFS_DELEG_CREATE_SETS = 'C',
279 ZFS_DELEG_NAMED_SET = 's',
280 ZFS_DELEG_NAMED_SET_SETS = 'S'
281 } zfs_deleg_who_type_t;
282
283 typedef enum {
284 ZFS_DELEG_NONE = 0,
285 ZFS_DELEG_PERM_LOCAL = 1,
286 ZFS_DELEG_PERM_DESCENDENT = 2,
287 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
288 ZFS_DELEG_PERM_CREATE = 4
289 } zfs_deleg_inherit_t;
290
291 #define ZFS_DELEG_PERM_UID "uid"
292 #define ZFS_DELEG_PERM_GID "gid"
293 #define ZFS_DELEG_PERM_GROUPS "groups"
294
295 #define ZFS_MLSLABEL_DEFAULT "none"
296
297 #define ZFS_SMB_ACL_SRC "src"
298 #define ZFS_SMB_ACL_TARGET "target"
299
300 typedef enum {
301 ZFS_CANMOUNT_OFF = 0,
302 ZFS_CANMOUNT_ON = 1,
303 ZFS_CANMOUNT_NOAUTO = 2
304 } zfs_canmount_type_t;
305
306 typedef enum {
307 ZFS_LOGBIAS_LATENCY = 0,
308 ZFS_LOGBIAS_THROUGHPUT = 1
309 } zfs_logbias_op_t;
310
311 typedef enum zfs_share_op {
312 ZFS_SHARE_NFS = 0,
313 ZFS_UNSHARE_NFS = 1,
314 ZFS_SHARE_SMB = 2,
315 ZFS_UNSHARE_SMB = 3
316 } zfs_share_op_t;
317
318 typedef enum zfs_smb_acl_op {
319 ZFS_SMB_ACL_ADD,
320 ZFS_SMB_ACL_REMOVE,
321 ZFS_SMB_ACL_RENAME,
322 ZFS_SMB_ACL_PURGE
323 } zfs_smb_acl_op_t;
324
325 typedef enum zfs_cache_type {
326 ZFS_CACHE_NONE = 0,
327 ZFS_CACHE_METADATA = 1,
328 ZFS_CACHE_ALL = 2
329 } zfs_cache_type_t;
330
331 typedef enum {
332 ZFS_SYNC_STANDARD = 0,
333 ZFS_SYNC_ALWAYS = 1,
334 ZFS_SYNC_DISABLED = 2
335 } zfs_sync_type_t;
336
337
338 /*
339 * On-disk version number.
340 */
341 #define SPA_VERSION_1 1ULL
342 #define SPA_VERSION_2 2ULL
343 #define SPA_VERSION_3 3ULL
344 #define SPA_VERSION_4 4ULL
345 #define SPA_VERSION_5 5ULL
346 #define SPA_VERSION_6 6ULL
347 #define SPA_VERSION_7 7ULL
348 #define SPA_VERSION_8 8ULL
349 #define SPA_VERSION_9 9ULL
350 #define SPA_VERSION_10 10ULL
351 #define SPA_VERSION_11 11ULL
352 #define SPA_VERSION_12 12ULL
353 #define SPA_VERSION_13 13ULL
354 #define SPA_VERSION_14 14ULL
355 #define SPA_VERSION_15 15ULL
356 #define SPA_VERSION_16 16ULL
357 #define SPA_VERSION_17 17ULL
358 #define SPA_VERSION_18 18ULL
359 #define SPA_VERSION_19 19ULL
360 #define SPA_VERSION_20 20ULL
361 #define SPA_VERSION_21 21ULL
362 #define SPA_VERSION_22 22ULL
363 #define SPA_VERSION_23 23ULL
364 #define SPA_VERSION_24 24ULL
365 #define SPA_VERSION_25 25ULL
366 #define SPA_VERSION_26 26ULL
367 #define SPA_VERSION_27 27ULL
368 #define SPA_VERSION_28 28ULL
369 #define SPA_VERSION_5000 5000ULL
370
371 /*
372 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
373 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
374 * and do the appropriate changes. Also bump the version number in
375 * usr/src/grub/capability.
376 */
377 #define SPA_VERSION SPA_VERSION_5000
378 #define SPA_VERSION_STRING "5000"
379
380 /*
381 * Symbolic names for the changes that caused a SPA_VERSION switch.
382 * Used in the code when checking for presence or absence of a feature.
383 * Feel free to define multiple symbolic names for each version if there
384 * were multiple changes to on-disk structures during that version.
385 *
386 * NOTE: When checking the current SPA_VERSION in your code, be sure
387 * to use spa_version() since it reports the version of the
388 * last synced uberblock. Checking the in-flight version can
389 * be dangerous in some cases.
390 */
391 #define SPA_VERSION_INITIAL SPA_VERSION_1
392 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
393 #define SPA_VERSION_SPARES SPA_VERSION_3
394 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
395 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
396 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
397 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
398 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
399 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
400 #define SPA_VERSION_BOOTFS SPA_VERSION_6
401 #define SPA_VERSION_SLOGS SPA_VERSION_7
402 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
403 #define SPA_VERSION_FUID SPA_VERSION_9
404 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
405 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
406 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
407 #define SPA_VERSION_L2CACHE SPA_VERSION_10
408 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
409 #define SPA_VERSION_ORIGIN SPA_VERSION_11
410 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
411 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
412 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
413 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
414 #define SPA_VERSION_USERSPACE SPA_VERSION_15
415 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
416 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
417 #define SPA_VERSION_USERREFS SPA_VERSION_18
418 #define SPA_VERSION_HOLES SPA_VERSION_19
419 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
420 #define SPA_VERSION_DEDUP SPA_VERSION_21
421 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
422 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
423 #define SPA_VERSION_SA SPA_VERSION_24
424 #define SPA_VERSION_SCAN SPA_VERSION_25
425 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
426 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
427 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
428 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
429 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
430 #define SPA_VERSION_FEATURES SPA_VERSION_5000
431
432 #define SPA_VERSION_IS_SUPPORTED(v) \
433 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
434 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
435
436 /*
437 * ZPL version - rev'd whenever an incompatible on-disk format change
438 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
439 * also update the version_table[] and help message in zfs_prop.c.
440 *
441 * When changing, be sure to teach GRUB how to read the new format!
442 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
443 */
444 #define ZPL_VERSION_1 1ULL
445 #define ZPL_VERSION_2 2ULL
446 #define ZPL_VERSION_3 3ULL
447 #define ZPL_VERSION_4 4ULL
448 #define ZPL_VERSION_5 5ULL
449 #define ZPL_VERSION ZPL_VERSION_5
450 #define ZPL_VERSION_STRING "5"
451
452 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
453 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
454 #define ZPL_VERSION_FUID ZPL_VERSION_3
455 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
456 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
457 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
458 #define ZPL_VERSION_SA ZPL_VERSION_5
459
460 /* Rewind request information */
461 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
462 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
463 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
464 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
465 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
466 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
467 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
468
469 typedef struct zpool_rewind_policy {
470 uint32_t zrp_request; /* rewind behavior requested */
471 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
472 uint64_t zrp_maxdata; /* max acceptable data errors */
473 uint64_t zrp_txg; /* specific txg to load */
474 } zpool_rewind_policy_t;
475
476 /*
477 * The following are configuration names used in the nvlist describing a pool's
478 * configuration.
479 */
480 #define ZPOOL_CONFIG_VERSION "version"
481 #define ZPOOL_CONFIG_POOL_NAME "name"
482 #define ZPOOL_CONFIG_POOL_STATE "state"
483 #define ZPOOL_CONFIG_POOL_TXG "txg"
484 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
485 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
486 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
487 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
488 #define ZPOOL_CONFIG_TYPE "type"
489 #define ZPOOL_CONFIG_CHILDREN "children"
490 #define ZPOOL_CONFIG_ID "id"
491 #define ZPOOL_CONFIG_GUID "guid"
492 #define ZPOOL_CONFIG_PATH "path"
493 #define ZPOOL_CONFIG_DEVID "devid"
494 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
495 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
496 #define ZPOOL_CONFIG_ASHIFT "ashift"
497 #define ZPOOL_CONFIG_ASIZE "asize"
498 #define ZPOOL_CONFIG_DTL "DTL"
499 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
500 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
501 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
502 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
503 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
504 #define ZPOOL_CONFIG_SPARES "spares"
505 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
506 #define ZPOOL_CONFIG_NPARITY "nparity"
507 #define ZPOOL_CONFIG_HOSTID "hostid"
508 #define ZPOOL_CONFIG_HOSTNAME "hostname"
509 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
510 #define ZPOOL_CONFIG_UNSPARE "unspare"
511 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
512 #define ZPOOL_CONFIG_IS_LOG "is_log"
513 #define ZPOOL_CONFIG_L2CACHE "l2cache"
514 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
515 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
516 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
517 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
518 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
519 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
520 #define ZPOOL_CONFIG_SPLIT "splitcfg"
521 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
522 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
523 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
524 #define ZPOOL_CONFIG_REMOVING "removing"
525 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
526 #define ZPOOL_CONFIG_COMMENT "comment"
527 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
528 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
529 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
530 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
531 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
532 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
533 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
534 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
535 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
536 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
537 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
538 /*
539 * The persistent vdev state is stored as separate values rather than a single
540 * 'vdev_state' entry. This is because a device can be in multiple states, such
541 * as offline and degraded.
542 */
543 #define ZPOOL_CONFIG_OFFLINE "offline"
544 #define ZPOOL_CONFIG_FAULTED "faulted"
545 #define ZPOOL_CONFIG_DEGRADED "degraded"
546 #define ZPOOL_CONFIG_REMOVED "removed"
547 #define ZPOOL_CONFIG_FRU "fru"
548 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
549
550 /* Rewind policy parameters */
551 #define ZPOOL_REWIND_POLICY "rewind-policy"
552 #define ZPOOL_REWIND_REQUEST "rewind-request"
553 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
554 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
555 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
556
557 /* Rewind data discovered */
558 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
559 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
560 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
561
562 #define VDEV_TYPE_ROOT "root"
563 #define VDEV_TYPE_MIRROR "mirror"
564 #define VDEV_TYPE_REPLACING "replacing"
565 #define VDEV_TYPE_RAIDZ "raidz"
566 #define VDEV_TYPE_DISK "disk"
567 #define VDEV_TYPE_FILE "file"
568 #define VDEV_TYPE_MISSING "missing"
569 #define VDEV_TYPE_HOLE "hole"
570 #define VDEV_TYPE_SPARE "spare"
571 #define VDEV_TYPE_LOG "log"
572 #define VDEV_TYPE_L2CACHE "l2cache"
573
574 /*
575 * This is needed in userland to report the minimum necessary device size.
576 */
577 #define SPA_MINDEVSIZE (64ULL << 20)
578
579 /*
580 * The location of the pool configuration repository, shared between kernel and
581 * userland.
582 */
583 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
584
585 /*
586 * vdev states are ordered from least to most healthy.
587 * A vdev that's CANT_OPEN or below is considered unusable.
588 */
589 typedef enum vdev_state {
590 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
591 VDEV_STATE_CLOSED, /* Not currently open */
592 VDEV_STATE_OFFLINE, /* Not allowed to open */
593 VDEV_STATE_REMOVED, /* Explicitly removed from system */
594 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
595 VDEV_STATE_FAULTED, /* External request to fault device */
596 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
597 VDEV_STATE_HEALTHY /* Presumed good */
598 } vdev_state_t;
599
600 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
601
602 /*
603 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
604 * of the vdev stats structure uses these constants to distinguish why.
605 */
606 typedef enum vdev_aux {
607 VDEV_AUX_NONE, /* no error */
608 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
609 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
610 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
611 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
612 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
613 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
614 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
615 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
616 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
617 VDEV_AUX_SPARED, /* hot spare used in another pool */
618 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
619 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
620 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
621 VDEV_AUX_EXTERNAL, /* external diagnosis */
622 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */
623 } vdev_aux_t;
624
625 /*
626 * pool state. The following states are written to disk as part of the normal
627 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
628 * states are software abstractions used at various levels to communicate
629 * pool state.
630 */
631 typedef enum pool_state {
632 POOL_STATE_ACTIVE = 0, /* In active use */
633 POOL_STATE_EXPORTED, /* Explicitly exported */
634 POOL_STATE_DESTROYED, /* Explicitly destroyed */
635 POOL_STATE_SPARE, /* Reserved for hot spare use */
636 POOL_STATE_L2CACHE, /* Level 2 ARC device */
637 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
638 POOL_STATE_UNAVAIL, /* Internal libzfs state */
639 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
640 } pool_state_t;
641
642 /*
643 * Scan Functions.
644 */
645 typedef enum pool_scan_func {
646 POOL_SCAN_NONE,
647 POOL_SCAN_SCRUB,
648 POOL_SCAN_RESILVER,
649 POOL_SCAN_FUNCS
650 } pool_scan_func_t;
651
652 /*
653 * ZIO types. Needed to interpret vdev statistics below.
654 */
655 typedef enum zio_type {
656 ZIO_TYPE_NULL = 0,
657 ZIO_TYPE_READ,
658 ZIO_TYPE_WRITE,
659 ZIO_TYPE_FREE,
660 ZIO_TYPE_CLAIM,
661 ZIO_TYPE_IOCTL,
662 ZIO_TYPES
663 } zio_type_t;
664
665 /*
666 * Pool statistics. Note: all fields should be 64-bit because this
667 * is passed between kernel and userland as an nvlist uint64 array.
668 */
669 typedef struct pool_scan_stat {
670 /* values stored on disk */
671 uint64_t pss_func; /* pool_scan_func_t */
672 uint64_t pss_state; /* dsl_scan_state_t */
673 uint64_t pss_start_time; /* scan start time */
674 uint64_t pss_end_time; /* scan end time */
675 uint64_t pss_to_examine; /* total bytes to scan */
676 uint64_t pss_examined; /* total examined bytes */
677 uint64_t pss_to_process; /* total bytes to process */
678 uint64_t pss_processed; /* total processed bytes */
679 uint64_t pss_errors; /* scan errors */
680
681 /* values not stored on disk */
682 uint64_t pss_pass_exam; /* examined bytes per scan pass */
683 uint64_t pss_pass_start; /* start time of a scan pass */
684 } pool_scan_stat_t;
685
686 typedef enum dsl_scan_state {
687 DSS_NONE,
688 DSS_SCANNING,
689 DSS_FINISHED,
690 DSS_CANCELED,
691 DSS_NUM_STATES
692 } dsl_scan_state_t;
693
694
695 /*
696 * Vdev statistics. Note: all fields should be 64-bit because this
697 * is passed between kernel and userland as an nvlist uint64 array.
698 */
699 typedef struct vdev_stat {
700 hrtime_t vs_timestamp; /* time since vdev load */
701 uint64_t vs_state; /* vdev state */
702 uint64_t vs_aux; /* see vdev_aux_t */
703 uint64_t vs_alloc; /* space allocated */
704 uint64_t vs_space; /* total capacity */
705 uint64_t vs_dspace; /* deflated capacity */
706 uint64_t vs_rsize; /* replaceable dev size */
707 uint64_t vs_esize; /* expandable dev size */
708 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
709 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
710 uint64_t vs_read_errors; /* read errors */
711 uint64_t vs_write_errors; /* write errors */
712 uint64_t vs_checksum_errors; /* checksum errors */
713 uint64_t vs_self_healed; /* self-healed bytes */
714 uint64_t vs_scan_removing; /* removing? */
715 uint64_t vs_scan_processed; /* scan processed bytes */
716 } vdev_stat_t;
717
718 /*
719 * DDT statistics. Note: all fields should be 64-bit because this
720 * is passed between kernel and userland as an nvlist uint64 array.
721 */
722 typedef struct ddt_object {
723 uint64_t ddo_count; /* number of elments in ddt */
724 uint64_t ddo_dspace; /* size of ddt on disk */
725 uint64_t ddo_mspace; /* size of ddt in-core */
726 } ddt_object_t;
727
728 typedef struct ddt_stat {
729 uint64_t dds_blocks; /* blocks */
730 uint64_t dds_lsize; /* logical size */
731 uint64_t dds_psize; /* physical size */
732 uint64_t dds_dsize; /* deflated allocated size */
733 uint64_t dds_ref_blocks; /* referenced blocks */
734 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
735 uint64_t dds_ref_psize; /* referenced psize * refcnt */
736 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
737 } ddt_stat_t;
738
739 typedef struct ddt_histogram {
740 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
741 } ddt_histogram_t;
742
743 #define ZVOL_DRIVER "zvol"
744 #define ZFS_DRIVER "zfs"
745 #define ZFS_DEV "/dev/zfs"
746
747 /* general zvol path */
748 #define ZVOL_DIR "/dev/zvol"
749 /* expansion */
750 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
751 /* for dump and swap */
752 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
753 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
754
755 #define ZVOL_PROP_NAME "name"
756 #define ZVOL_DEFAULT_BLOCKSIZE 8192
757
758 /*
759 * /dev/zfs ioctl numbers.
760 */
761 typedef enum zfs_ioc {
762 ZFS_IOC_FIRST = ('Z' << 8),
763 ZFS_IOC = ZFS_IOC_FIRST,
764 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
765 ZFS_IOC_POOL_DESTROY,
766 ZFS_IOC_POOL_IMPORT,
767 ZFS_IOC_POOL_EXPORT,
768 ZFS_IOC_POOL_CONFIGS,
769 ZFS_IOC_POOL_STATS,
770 ZFS_IOC_POOL_TRYIMPORT,
771 ZFS_IOC_POOL_SCAN,
772 ZFS_IOC_POOL_FREEZE,
773 ZFS_IOC_POOL_UPGRADE,
774 ZFS_IOC_POOL_GET_HISTORY,
775 ZFS_IOC_VDEV_ADD,
776 ZFS_IOC_VDEV_REMOVE,
777 ZFS_IOC_VDEV_SET_STATE,
778 ZFS_IOC_VDEV_ATTACH,
779 ZFS_IOC_VDEV_DETACH,
780 ZFS_IOC_VDEV_SETPATH,
781 ZFS_IOC_VDEV_SETFRU,
782 ZFS_IOC_OBJSET_STATS,
783 ZFS_IOC_OBJSET_ZPLPROPS,
784 ZFS_IOC_DATASET_LIST_NEXT,
785 ZFS_IOC_SNAPSHOT_LIST_NEXT,
786 ZFS_IOC_SET_PROP,
787 ZFS_IOC_CREATE,
788 ZFS_IOC_DESTROY,
789 ZFS_IOC_ROLLBACK,
790 ZFS_IOC_RENAME,
791 ZFS_IOC_RECV,
792 ZFS_IOC_SEND,
793 ZFS_IOC_INJECT_FAULT,
794 ZFS_IOC_CLEAR_FAULT,
795 ZFS_IOC_INJECT_LIST_NEXT,
796 ZFS_IOC_ERROR_LOG,
797 ZFS_IOC_CLEAR,
798 ZFS_IOC_PROMOTE,
799 ZFS_IOC_SNAPSHOT,
800 ZFS_IOC_DSOBJ_TO_DSNAME,
801 ZFS_IOC_OBJ_TO_PATH,
802 ZFS_IOC_POOL_SET_PROPS,
803 ZFS_IOC_POOL_GET_PROPS,
804 ZFS_IOC_SET_FSACL,
805 ZFS_IOC_GET_FSACL,
806 ZFS_IOC_SHARE,
807 ZFS_IOC_INHERIT_PROP,
808 ZFS_IOC_SMB_ACL,
809 ZFS_IOC_USERSPACE_ONE,
810 ZFS_IOC_USERSPACE_MANY,
811 ZFS_IOC_USERSPACE_UPGRADE,
812 ZFS_IOC_HOLD,
813 ZFS_IOC_RELEASE,
814 ZFS_IOC_GET_HOLDS,
815 ZFS_IOC_OBJSET_RECVD_PROPS,
816 ZFS_IOC_VDEV_SPLIT,
817 ZFS_IOC_NEXT_OBJ,
818 ZFS_IOC_DIFF,
819 ZFS_IOC_TMP_SNAPSHOT,
820 ZFS_IOC_OBJ_TO_STATS,
821 ZFS_IOC_SPACE_WRITTEN,
822 ZFS_IOC_SPACE_SNAPS,
823 ZFS_IOC_DESTROY_SNAPS,
824 ZFS_IOC_POOL_REGUID,
825 ZFS_IOC_POOL_REOPEN,
826 ZFS_IOC_SEND_PROGRESS,
827 ZFS_IOC_LOG_HISTORY,
828 ZFS_IOC_SEND_NEW,
829 ZFS_IOC_SEND_SPACE,
830 ZFS_IOC_CLONE,
831 ZFS_IOC_LAST
832 } zfs_ioc_t;
833
834 /*
835 * Internal SPA load state. Used by FMA diagnosis engine.
836 */
837 typedef enum {
838 SPA_LOAD_NONE, /* no load in progress */
839 SPA_LOAD_OPEN, /* normal open */
840 SPA_LOAD_IMPORT, /* import in progress */
841 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
842 SPA_LOAD_RECOVER, /* recovery requested */
843 SPA_LOAD_ERROR /* load failed */
844 } spa_load_state_t;
845
846 /*
847 * Bookmark name values.
848 */
849 #define ZPOOL_ERR_LIST "error list"
850 #define ZPOOL_ERR_DATASET "dataset"
851 #define ZPOOL_ERR_OBJECT "object"
852
853 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
854
855 /*
856 * The following are names used in the nvlist describing
857 * the pool's history log.
858 */
859 #define ZPOOL_HIST_RECORD "history record"
860 #define ZPOOL_HIST_TIME "history time"
861 #define ZPOOL_HIST_CMD "history command"
862 #define ZPOOL_HIST_WHO "history who"
863 #define ZPOOL_HIST_ZONE "history zone"
864 #define ZPOOL_HIST_HOST "history hostname"
865 #define ZPOOL_HIST_TXG "history txg"
866 #define ZPOOL_HIST_INT_EVENT "history internal event"
867 #define ZPOOL_HIST_INT_STR "history internal str"
868 #define ZPOOL_HIST_INT_NAME "internal_name"
869 #define ZPOOL_HIST_IOCTL "ioctl"
870 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
871 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
872 #define ZPOOL_HIST_DSNAME "dsname"
873 #define ZPOOL_HIST_DSID "dsid"
874
875 /*
876 * Flags for ZFS_IOC_VDEV_SET_STATE
877 */
878 #define ZFS_ONLINE_CHECKREMOVE 0x1
879 #define ZFS_ONLINE_UNSPARE 0x2
880 #define ZFS_ONLINE_FORCEFAULT 0x4
881 #define ZFS_ONLINE_EXPAND 0x8
882 #define ZFS_OFFLINE_TEMPORARY 0x1
883
884 /*
885 * Flags for ZFS_IOC_POOL_IMPORT
886 */
887 #define ZFS_IMPORT_NORMAL 0x0
888 #define ZFS_IMPORT_VERBATIM 0x1
889 #define ZFS_IMPORT_ANY_HOST 0x2
890 #define ZFS_IMPORT_MISSING_LOG 0x4
891 #define ZFS_IMPORT_ONLY 0x8
892
893 /*
894 * Sysevent payload members. ZFS will generate the following sysevents with the
895 * given payloads:
896 *
897 * ESC_ZFS_RESILVER_START
898 * ESC_ZFS_RESILVER_END
899 * ESC_ZFS_POOL_DESTROY
900 * ESC_ZFS_POOL_REGUID
901 *
902 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
903 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
904 *
905 * ESC_ZFS_VDEV_REMOVE
906 * ESC_ZFS_VDEV_CLEAR
907 * ESC_ZFS_VDEV_CHECK
908 *
909 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
910 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
911 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
912 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
913 */
914 #define ZFS_EV_POOL_NAME "pool_name"
915 #define ZFS_EV_POOL_GUID "pool_guid"
916 #define ZFS_EV_VDEV_PATH "vdev_path"
917 #define ZFS_EV_VDEV_GUID "vdev_guid"
918
919 #ifdef __cplusplus
920 }
921 #endif
922
923 #endif /* _SYS_FS_ZFS_H */