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