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