]> git.proxmox.com Git - mirror_zfs.git/blob - include/sys/fs/zfs.h
projects / mirror_zfs.git / blob
? search:


d25e8b5a5bb5096cf7a7575a9d763e60edf8f83d
[mirror_zfs.git] / include / sys / fs / zfs.h
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, 2018 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2013, 2017 Joyent, Inc. All rights reserved.
27 * Copyright (c) 2014 Integros [integros.com]
28 * Copyright (c) 2017, Intel Corporation.
29 * Copyright (c) 2019 Datto Inc.
30 */
31
32 /* Portions Copyright 2010 Robert Milkowski */
33
34 #ifndef _SYS_FS_ZFS_H
35 #define _SYS_FS_ZFS_H
36
37 #include <sys/time.h>
38 #include <sys/zio_priority.h>
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /*
45 * Types and constants shared between userland and the kernel.
46 */
47
48 /*
49 * Each dataset can be one of the following types. These constants can be
50 * combined into masks that can be passed to various functions.
51 */
52 typedef enum {
53 ZFS_TYPE_FILESYSTEM = (1 << 0),
54 ZFS_TYPE_SNAPSHOT = (1 << 1),
55 ZFS_TYPE_VOLUME = (1 << 2),
56 ZFS_TYPE_POOL = (1 << 3),
57 ZFS_TYPE_BOOKMARK = (1 << 4)
58 } zfs_type_t;
59
60 /*
61 * NB: lzc_dataset_type should be updated whenever a new objset type is added,
62 * if it represents a real type of a dataset that can be created from userland.
63 */
64 typedef enum dmu_objset_type {
65 DMU_OST_NONE,
66 DMU_OST_META,
67 DMU_OST_ZFS,
68 DMU_OST_ZVOL,
69 DMU_OST_OTHER, /* For testing only! */
70 DMU_OST_ANY, /* Be careful! */
71 DMU_OST_NUMTYPES
72 } dmu_objset_type_t;
73
74 #define ZFS_TYPE_DATASET \
75 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
76
77 /*
78 * All of these include the terminating NUL byte.
79 */
80 #define ZAP_MAXNAMELEN 256
81 #define ZAP_MAXVALUELEN (1024 * 8)
82 #define ZAP_OLDMAXVALUELEN 1024
83 #define ZFS_MAX_DATASET_NAME_LEN 256
84
85 /*
86 * Dataset properties are identified by these constants and must be added to
87 * the end of this list to ensure that external consumers are not affected
88 * by the change. If you make any changes to this list, be sure to update
89 * the property table in module/zcommon/zfs_prop.c.
90 */
91 typedef enum {
92 ZPROP_CONT = -2,
93 ZPROP_INVAL = -1,
94 ZFS_PROP_TYPE = 0,
95 ZFS_PROP_CREATION,
96 ZFS_PROP_USED,
97 ZFS_PROP_AVAILABLE,
98 ZFS_PROP_REFERENCED,
99 ZFS_PROP_COMPRESSRATIO,
100 ZFS_PROP_MOUNTED,
101 ZFS_PROP_ORIGIN,
102 ZFS_PROP_QUOTA,
103 ZFS_PROP_RESERVATION,
104 ZFS_PROP_VOLSIZE,
105 ZFS_PROP_VOLBLOCKSIZE,
106 ZFS_PROP_RECORDSIZE,
107 ZFS_PROP_MOUNTPOINT,
108 ZFS_PROP_SHARENFS,
109 ZFS_PROP_CHECKSUM,
110 ZFS_PROP_COMPRESSION,
111 ZFS_PROP_ATIME,
112 ZFS_PROP_DEVICES,
113 ZFS_PROP_EXEC,
114 ZFS_PROP_SETUID,
115 ZFS_PROP_READONLY,
116 ZFS_PROP_ZONED,
117 ZFS_PROP_SNAPDIR,
118 ZFS_PROP_PRIVATE, /* not exposed to user, temporary */
119 ZFS_PROP_ACLINHERIT,
120 ZFS_PROP_CREATETXG,
121 ZFS_PROP_NAME, /* not exposed to the user */
122 ZFS_PROP_CANMOUNT,
123 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
124 ZFS_PROP_XATTR,
125 ZFS_PROP_NUMCLONES, /* not exposed to the user */
126 ZFS_PROP_COPIES,
127 ZFS_PROP_VERSION,
128 ZFS_PROP_UTF8ONLY,
129 ZFS_PROP_NORMALIZE,
130 ZFS_PROP_CASE,
131 ZFS_PROP_VSCAN,
132 ZFS_PROP_NBMAND,
133 ZFS_PROP_SHARESMB,
134 ZFS_PROP_REFQUOTA,
135 ZFS_PROP_REFRESERVATION,
136 ZFS_PROP_GUID,
137 ZFS_PROP_PRIMARYCACHE,
138 ZFS_PROP_SECONDARYCACHE,
139 ZFS_PROP_USEDSNAP,
140 ZFS_PROP_USEDDS,
141 ZFS_PROP_USEDCHILD,
142 ZFS_PROP_USEDREFRESERV,
143 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
144 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
145 ZFS_PROP_DEFER_DESTROY,
146 ZFS_PROP_USERREFS,
147 ZFS_PROP_LOGBIAS,
148 ZFS_PROP_UNIQUE, /* not exposed to the user */
149 ZFS_PROP_OBJSETID,
150 ZFS_PROP_DEDUP,
151 ZFS_PROP_MLSLABEL,
152 ZFS_PROP_SYNC,
153 ZFS_PROP_DNODESIZE,
154 ZFS_PROP_REFRATIO,
155 ZFS_PROP_WRITTEN,
156 ZFS_PROP_CLONES,
157 ZFS_PROP_LOGICALUSED,
158 ZFS_PROP_LOGICALREFERENCED,
159 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
160 ZFS_PROP_VOLMODE,
161 ZFS_PROP_FILESYSTEM_LIMIT,
162 ZFS_PROP_SNAPSHOT_LIMIT,
163 ZFS_PROP_FILESYSTEM_COUNT,
164 ZFS_PROP_SNAPSHOT_COUNT,
165 ZFS_PROP_SNAPDEV,
166 ZFS_PROP_ACLTYPE,
167 ZFS_PROP_SELINUX_CONTEXT,
168 ZFS_PROP_SELINUX_FSCONTEXT,
169 ZFS_PROP_SELINUX_DEFCONTEXT,
170 ZFS_PROP_SELINUX_ROOTCONTEXT,
171 ZFS_PROP_RELATIME,
172 ZFS_PROP_REDUNDANT_METADATA,
173 ZFS_PROP_OVERLAY,
174 ZFS_PROP_PREV_SNAP,
175 ZFS_PROP_RECEIVE_RESUME_TOKEN,
176 ZFS_PROP_ENCRYPTION,
177 ZFS_PROP_KEYLOCATION,
178 ZFS_PROP_KEYFORMAT,
179 ZFS_PROP_PBKDF2_SALT,
180 ZFS_PROP_PBKDF2_ITERS,
181 ZFS_PROP_ENCRYPTION_ROOT,
182 ZFS_PROP_KEY_GUID,
183 ZFS_PROP_KEYSTATUS,
184 ZFS_PROP_REMAPTXG, /* not exposed to the user */
185 ZFS_PROP_SPECIAL_SMALL_BLOCKS,
186 ZFS_PROP_IVSET_GUID, /* not exposed to the user */
187 ZFS_NUM_PROPS
188 } zfs_prop_t;
189
190 typedef enum {
191 ZFS_PROP_USERUSED,
192 ZFS_PROP_USERQUOTA,
193 ZFS_PROP_GROUPUSED,
194 ZFS_PROP_GROUPQUOTA,
195 ZFS_PROP_USEROBJUSED,
196 ZFS_PROP_USEROBJQUOTA,
197 ZFS_PROP_GROUPOBJUSED,
198 ZFS_PROP_GROUPOBJQUOTA,
199 ZFS_PROP_PROJECTUSED,
200 ZFS_PROP_PROJECTQUOTA,
201 ZFS_PROP_PROJECTOBJUSED,
202 ZFS_PROP_PROJECTOBJQUOTA,
203 ZFS_NUM_USERQUOTA_PROPS
204 } zfs_userquota_prop_t;
205
206 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
207
208 /*
209 * Pool properties are identified by these constants and must be added to the
210 * end of this list to ensure that external consumers are not affected
211 * by the change. If you make any changes to this list, be sure to update
212 * the property table in module/zcommon/zpool_prop.c.
213 */
214 typedef enum {
215 ZPOOL_PROP_INVAL = -1,
216 ZPOOL_PROP_NAME,
217 ZPOOL_PROP_SIZE,
218 ZPOOL_PROP_CAPACITY,
219 ZPOOL_PROP_ALTROOT,
220 ZPOOL_PROP_HEALTH,
221 ZPOOL_PROP_GUID,
222 ZPOOL_PROP_VERSION,
223 ZPOOL_PROP_BOOTFS,
224 ZPOOL_PROP_DELEGATION,
225 ZPOOL_PROP_AUTOREPLACE,
226 ZPOOL_PROP_CACHEFILE,
227 ZPOOL_PROP_FAILUREMODE,
228 ZPOOL_PROP_LISTSNAPS,
229 ZPOOL_PROP_AUTOEXPAND,
230 ZPOOL_PROP_DEDUPDITTO,
231 ZPOOL_PROP_DEDUPRATIO,
232 ZPOOL_PROP_FREE,
233 ZPOOL_PROP_ALLOCATED,
234 ZPOOL_PROP_READONLY,
235 ZPOOL_PROP_ASHIFT,
236 ZPOOL_PROP_COMMENT,
237 ZPOOL_PROP_EXPANDSZ,
238 ZPOOL_PROP_FREEING,
239 ZPOOL_PROP_FRAGMENTATION,
240 ZPOOL_PROP_LEAKED,
241 ZPOOL_PROP_MAXBLOCKSIZE,
242 ZPOOL_PROP_TNAME,
243 ZPOOL_PROP_MAXDNODESIZE,
244 ZPOOL_PROP_MULTIHOST,
245 ZPOOL_PROP_CHECKPOINT,
246 ZPOOL_PROP_LOAD_GUID,
247 ZPOOL_NUM_PROPS
248 } zpool_prop_t;
249
250 /* Small enough to not hog a whole line of printout in zpool(1M). */
251 #define ZPROP_MAX_COMMENT 32
252
253 #define ZPROP_VALUE "value"
254 #define ZPROP_SOURCE "source"
255
256 typedef enum {
257 ZPROP_SRC_NONE = 0x1,
258 ZPROP_SRC_DEFAULT = 0x2,
259 ZPROP_SRC_TEMPORARY = 0x4,
260 ZPROP_SRC_LOCAL = 0x8,
261 ZPROP_SRC_INHERITED = 0x10,
262 ZPROP_SRC_RECEIVED = 0x20
263 } zprop_source_t;
264
265 #define ZPROP_SRC_ALL 0x3f
266
267 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
268 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
269
270 /*
271 * Dataset flag implemented as a special entry in the props zap object
272 * indicating that the dataset has received properties on or after
273 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
274 * just as it did in earlier versions, and thereafter, local properties are
275 * preserved.
276 */
277 #define ZPROP_HAS_RECVD "$hasrecvd"
278
279 typedef enum {
280 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
281 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
282 } zprop_errflags_t;
283
284 typedef int (*zprop_func)(int, void *);
285
286 /*
287 * Properties to be set on the root file system of a new pool
288 * are stuffed into their own nvlist, which is then included in
289 * the properties nvlist with the pool properties.
290 */
291 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
292
293 /*
294 * Length of 'written@' and 'written#'
295 */
296 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8
297
298 /*
299 * Dataset property functions shared between libzfs and kernel.
300 */
301 const char *zfs_prop_default_string(zfs_prop_t);
302 uint64_t zfs_prop_default_numeric(zfs_prop_t);
303 boolean_t zfs_prop_readonly(zfs_prop_t);
304 boolean_t zfs_prop_visible(zfs_prop_t prop);
305 boolean_t zfs_prop_inheritable(zfs_prop_t);
306 boolean_t zfs_prop_setonce(zfs_prop_t);
307 boolean_t zfs_prop_encryption_key_param(zfs_prop_t);
308 boolean_t zfs_prop_valid_keylocation(const char *, boolean_t);
309 const char *zfs_prop_to_name(zfs_prop_t);
310 zfs_prop_t zfs_name_to_prop(const char *);
311 boolean_t zfs_prop_user(const char *);
312 boolean_t zfs_prop_userquota(const char *);
313 boolean_t zfs_prop_written(const char *);
314 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
315 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
316 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
317 boolean_t zfs_prop_valid_for_type(int, zfs_type_t, boolean_t);
318
319 /*
320 * Pool property functions shared between libzfs and kernel.
321 */
322 zpool_prop_t zpool_name_to_prop(const char *);
323 const char *zpool_prop_to_name(zpool_prop_t);
324 const char *zpool_prop_default_string(zpool_prop_t);
325 uint64_t zpool_prop_default_numeric(zpool_prop_t);
326 boolean_t zpool_prop_readonly(zpool_prop_t);
327 boolean_t zpool_prop_setonce(zpool_prop_t);
328 boolean_t zpool_prop_feature(const char *);
329 boolean_t zpool_prop_unsupported(const char *);
330 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
331 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
332 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
333
334 /*
335 * Definitions for the Delegation.
336 */
337 typedef enum {
338 ZFS_DELEG_WHO_UNKNOWN = 0,
339 ZFS_DELEG_USER = 'u',
340 ZFS_DELEG_USER_SETS = 'U',
341 ZFS_DELEG_GROUP = 'g',
342 ZFS_DELEG_GROUP_SETS = 'G',
343 ZFS_DELEG_EVERYONE = 'e',
344 ZFS_DELEG_EVERYONE_SETS = 'E',
345 ZFS_DELEG_CREATE = 'c',
346 ZFS_DELEG_CREATE_SETS = 'C',
347 ZFS_DELEG_NAMED_SET = 's',
348 ZFS_DELEG_NAMED_SET_SETS = 'S'
349 } zfs_deleg_who_type_t;
350
351 typedef enum {
352 ZFS_DELEG_NONE = 0,
353 ZFS_DELEG_PERM_LOCAL = 1,
354 ZFS_DELEG_PERM_DESCENDENT = 2,
355 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
356 ZFS_DELEG_PERM_CREATE = 4
357 } zfs_deleg_inherit_t;
358
359 #define ZFS_DELEG_PERM_UID "uid"
360 #define ZFS_DELEG_PERM_GID "gid"
361 #define ZFS_DELEG_PERM_GROUPS "groups"
362
363 #define ZFS_MLSLABEL_DEFAULT "none"
364
365 #define ZFS_SMB_ACL_SRC "src"
366 #define ZFS_SMB_ACL_TARGET "target"
367
368 typedef enum {
369 ZFS_CANMOUNT_OFF = 0,
370 ZFS_CANMOUNT_ON = 1,
371 ZFS_CANMOUNT_NOAUTO = 2
372 } zfs_canmount_type_t;
373
374 typedef enum {
375 ZFS_LOGBIAS_LATENCY = 0,
376 ZFS_LOGBIAS_THROUGHPUT = 1
377 } zfs_logbias_op_t;
378
379 typedef enum zfs_share_op {
380 ZFS_SHARE_NFS = 0,
381 ZFS_UNSHARE_NFS = 1,
382 ZFS_SHARE_SMB = 2,
383 ZFS_UNSHARE_SMB = 3
384 } zfs_share_op_t;
385
386 typedef enum zfs_smb_acl_op {
387 ZFS_SMB_ACL_ADD,
388 ZFS_SMB_ACL_REMOVE,
389 ZFS_SMB_ACL_RENAME,
390 ZFS_SMB_ACL_PURGE
391 } zfs_smb_acl_op_t;
392
393 typedef enum zfs_cache_type {
394 ZFS_CACHE_NONE = 0,
395 ZFS_CACHE_METADATA = 1,
396 ZFS_CACHE_ALL = 2
397 } zfs_cache_type_t;
398
399 typedef enum {
400 ZFS_SYNC_STANDARD = 0,
401 ZFS_SYNC_ALWAYS = 1,
402 ZFS_SYNC_DISABLED = 2
403 } zfs_sync_type_t;
404
405 typedef enum {
406 ZFS_XATTR_OFF = 0,
407 ZFS_XATTR_DIR = 1,
408 ZFS_XATTR_SA = 2
409 } zfs_xattr_type_t;
410
411 typedef enum {
412 ZFS_DNSIZE_LEGACY = 0,
413 ZFS_DNSIZE_AUTO = 1,
414 ZFS_DNSIZE_1K = 1024,
415 ZFS_DNSIZE_2K = 2048,
416 ZFS_DNSIZE_4K = 4096,
417 ZFS_DNSIZE_8K = 8192,
418 ZFS_DNSIZE_16K = 16384
419 } zfs_dnsize_type_t;
420
421 typedef enum {
422 ZFS_REDUNDANT_METADATA_ALL,
423 ZFS_REDUNDANT_METADATA_MOST
424 } zfs_redundant_metadata_type_t;
425
426 typedef enum {
427 ZFS_VOLMODE_DEFAULT = 0,
428 ZFS_VOLMODE_GEOM = 1,
429 ZFS_VOLMODE_DEV = 2,
430 ZFS_VOLMODE_NONE = 3
431 } zfs_volmode_t;
432
433 typedef enum zfs_keystatus {
434 ZFS_KEYSTATUS_NONE = 0,
435 ZFS_KEYSTATUS_UNAVAILABLE,
436 ZFS_KEYSTATUS_AVAILABLE,
437 } zfs_keystatus_t;
438
439 typedef enum zfs_keyformat {
440 ZFS_KEYFORMAT_NONE = 0,
441 ZFS_KEYFORMAT_RAW,
442 ZFS_KEYFORMAT_HEX,
443 ZFS_KEYFORMAT_PASSPHRASE,
444 ZFS_KEYFORMAT_FORMATS
445 } zfs_keyformat_t;
446
447 typedef enum zfs_key_location {
448 ZFS_KEYLOCATION_NONE = 0,
449 ZFS_KEYLOCATION_PROMPT,
450 ZFS_KEYLOCATION_URI,
451 ZFS_KEYLOCATION_LOCATIONS
452 } zfs_keylocation_t;
453
454 #define DEFAULT_PBKDF2_ITERATIONS 350000
455 #define MIN_PBKDF2_ITERATIONS 100000
456
457 /*
458 * On-disk version number.
459 */
460 #define SPA_VERSION_1 1ULL
461 #define SPA_VERSION_2 2ULL
462 #define SPA_VERSION_3 3ULL
463 #define SPA_VERSION_4 4ULL
464 #define SPA_VERSION_5 5ULL
465 #define SPA_VERSION_6 6ULL
466 #define SPA_VERSION_7 7ULL
467 #define SPA_VERSION_8 8ULL
468 #define SPA_VERSION_9 9ULL
469 #define SPA_VERSION_10 10ULL
470 #define SPA_VERSION_11 11ULL
471 #define SPA_VERSION_12 12ULL
472 #define SPA_VERSION_13 13ULL
473 #define SPA_VERSION_14 14ULL
474 #define SPA_VERSION_15 15ULL
475 #define SPA_VERSION_16 16ULL
476 #define SPA_VERSION_17 17ULL
477 #define SPA_VERSION_18 18ULL
478 #define SPA_VERSION_19 19ULL
479 #define SPA_VERSION_20 20ULL
480 #define SPA_VERSION_21 21ULL
481 #define SPA_VERSION_22 22ULL
482 #define SPA_VERSION_23 23ULL
483 #define SPA_VERSION_24 24ULL
484 #define SPA_VERSION_25 25ULL
485 #define SPA_VERSION_26 26ULL
486 #define SPA_VERSION_27 27ULL
487 #define SPA_VERSION_28 28ULL
488 #define SPA_VERSION_5000 5000ULL
489
490 /*
491 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
492 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
493 * and do the appropriate changes. Also bump the version number in
494 * usr/src/grub/capability.
495 */
496 #define SPA_VERSION SPA_VERSION_5000
497 #define SPA_VERSION_STRING "5000"
498
499 /*
500 * Symbolic names for the changes that caused a SPA_VERSION switch.
501 * Used in the code when checking for presence or absence of a feature.
502 * Feel free to define multiple symbolic names for each version if there
503 * were multiple changes to on-disk structures during that version.
504 *
505 * NOTE: When checking the current SPA_VERSION in your code, be sure
506 * to use spa_version() since it reports the version of the
507 * last synced uberblock. Checking the in-flight version can
508 * be dangerous in some cases.
509 */
510 #define SPA_VERSION_INITIAL SPA_VERSION_1
511 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
512 #define SPA_VERSION_SPARES SPA_VERSION_3
513 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
514 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
515 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
516 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
517 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
518 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
519 #define SPA_VERSION_BOOTFS SPA_VERSION_6
520 #define SPA_VERSION_SLOGS SPA_VERSION_7
521 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
522 #define SPA_VERSION_FUID SPA_VERSION_9
523 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
524 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
525 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
526 #define SPA_VERSION_L2CACHE SPA_VERSION_10
527 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
528 #define SPA_VERSION_ORIGIN SPA_VERSION_11
529 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
530 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
531 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
532 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
533 #define SPA_VERSION_USERSPACE SPA_VERSION_15
534 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
535 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
536 #define SPA_VERSION_USERREFS SPA_VERSION_18
537 #define SPA_VERSION_HOLES SPA_VERSION_19
538 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
539 #define SPA_VERSION_DEDUP SPA_VERSION_21
540 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
541 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
542 #define SPA_VERSION_SA SPA_VERSION_24
543 #define SPA_VERSION_SCAN SPA_VERSION_25
544 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
545 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
546 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
547 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
548 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
549 #define SPA_VERSION_FEATURES SPA_VERSION_5000
550
551 #define SPA_VERSION_IS_SUPPORTED(v) \
552 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
553 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
554
555 /*
556 * ZPL version - rev'd whenever an incompatible on-disk format change
557 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
558 * also update the version_table[] and help message in zfs_prop.c.
559 *
560 * When changing, be sure to teach GRUB how to read the new format!
561 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
562 */
563 #define ZPL_VERSION_1 1ULL
564 #define ZPL_VERSION_2 2ULL
565 #define ZPL_VERSION_3 3ULL
566 #define ZPL_VERSION_4 4ULL
567 #define ZPL_VERSION_5 5ULL
568 #define ZPL_VERSION ZPL_VERSION_5
569 #define ZPL_VERSION_STRING "5"
570
571 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
572 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
573 #define ZPL_VERSION_FUID ZPL_VERSION_3
574 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
575 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
576 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
577 #define ZPL_VERSION_SA ZPL_VERSION_5
578
579 /* Rewind policy information */
580 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
581 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
582 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
583 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
584 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
585 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
586 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
587
588 typedef struct zpool_load_policy {
589 uint32_t zlp_rewind; /* rewind policy requested */
590 uint64_t zlp_maxmeta; /* max acceptable meta-data errors */
591 uint64_t zlp_maxdata; /* max acceptable data errors */
592 uint64_t zlp_txg; /* specific txg to load */
593 } zpool_load_policy_t;
594
595 /*
596 * The following are configuration names used in the nvlist describing a pool's
597 * configuration. New on-disk names should be prefixed with "<reverse-DNS>:"
598 * (e.g. "org.open-zfs:") to avoid conflicting names being developed
599 * independently.
600 */
601 #define ZPOOL_CONFIG_VERSION "version"
602 #define ZPOOL_CONFIG_POOL_NAME "name"
603 #define ZPOOL_CONFIG_POOL_STATE "state"
604 #define ZPOOL_CONFIG_POOL_TXG "txg"
605 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
606 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
607 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
608 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
609 #define ZPOOL_CONFIG_TYPE "type"
610 #define ZPOOL_CONFIG_CHILDREN "children"
611 #define ZPOOL_CONFIG_ID "id"
612 #define ZPOOL_CONFIG_GUID "guid"
613 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object"
614 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births"
615 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev"
616 #define ZPOOL_CONFIG_PATH "path"
617 #define ZPOOL_CONFIG_DEVID "devid"
618 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
619 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
620 #define ZPOOL_CONFIG_ASHIFT "ashift"
621 #define ZPOOL_CONFIG_ASIZE "asize"
622 #define ZPOOL_CONFIG_DTL "DTL"
623 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
624 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */
625 #define ZPOOL_CONFIG_CHECKPOINT_STATS "checkpoint_stats" /* not on disk */
626 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
627 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */
628
629 /* container nvlist of extended stats */
630 #define ZPOOL_CONFIG_VDEV_STATS_EX "vdev_stats_ex"
631
632 /* Active queue read/write stats */
633 #define ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE "vdev_sync_r_active_queue"
634 #define ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE "vdev_sync_w_active_queue"
635 #define ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE "vdev_async_r_active_queue"
636 #define ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE "vdev_async_w_active_queue"
637 #define ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE "vdev_async_scrub_active_queue"
638
639 /* Queue sizes */
640 #define ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE "vdev_sync_r_pend_queue"
641 #define ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE "vdev_sync_w_pend_queue"
642 #define ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE "vdev_async_r_pend_queue"
643 #define ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE "vdev_async_w_pend_queue"
644 #define ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE "vdev_async_scrub_pend_queue"
645
646 /* Latency read/write histogram stats */
647 #define ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO "vdev_tot_r_lat_histo"
648 #define ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO "vdev_tot_w_lat_histo"
649 #define ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO "vdev_disk_r_lat_histo"
650 #define ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO "vdev_disk_w_lat_histo"
651 #define ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO "vdev_sync_r_lat_histo"
652 #define ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO "vdev_sync_w_lat_histo"
653 #define ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO "vdev_async_r_lat_histo"
654 #define ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO "vdev_async_w_lat_histo"
655 #define ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO "vdev_scrub_histo"
656
657 /* Request size histograms */
658 #define ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO "vdev_sync_ind_r_histo"
659 #define ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO "vdev_sync_ind_w_histo"
660 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO "vdev_async_ind_r_histo"
661 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO "vdev_async_ind_w_histo"
662 #define ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO "vdev_ind_scrub_histo"
663 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO "vdev_sync_agg_r_histo"
664 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO "vdev_sync_agg_w_histo"
665 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO "vdev_async_agg_r_histo"
666 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO "vdev_async_agg_w_histo"
667 #define ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO "vdev_agg_scrub_histo"
668
669 /* Number of slow IOs */
670 #define ZPOOL_CONFIG_VDEV_SLOW_IOS "vdev_slow_ios"
671
672 /* vdev enclosure sysfs path */
673 #define ZPOOL_CONFIG_VDEV_ENC_SYSFS_PATH "vdev_enc_sysfs_path"
674
675 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
676 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
677 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
678 #define ZPOOL_CONFIG_SPARES "spares"
679 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
680 #define ZPOOL_CONFIG_NPARITY "nparity"
681 #define ZPOOL_CONFIG_HOSTID "hostid"
682 #define ZPOOL_CONFIG_HOSTNAME "hostname"
683 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
684 #define ZPOOL_CONFIG_UNSPARE "unspare"
685 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
686 #define ZPOOL_CONFIG_IS_LOG "is_log"
687 #define ZPOOL_CONFIG_L2CACHE "l2cache"
688 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
689 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
690 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
691 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
692 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
693 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
694 #define ZPOOL_CONFIG_SPLIT "splitcfg"
695 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
696 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
697 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
698 #define ZPOOL_CONFIG_REMOVING "removing"
699 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
700 #define ZPOOL_CONFIG_COMMENT "comment"
701 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
702 #define ZPOOL_CONFIG_SUSPENDED_REASON "suspended_reason" /* not stored */
703 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
704 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
705 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
706 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
707 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
708 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
709 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
710 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
711 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
712 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
713 #define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */
714 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
715 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
716 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
717 #define ZPOOL_CONFIG_RESILVER_DEFER "com.datto:resilver_defer"
718 #define ZPOOL_CONFIG_CACHEFILE "cachefile" /* not stored on disk */
719 #define ZPOOL_CONFIG_MMP_STATE "mmp_state" /* not stored on disk */
720 #define ZPOOL_CONFIG_MMP_TXG "mmp_txg" /* not stored on disk */
721 #define ZPOOL_CONFIG_MMP_HOSTNAME "mmp_hostname" /* not stored on disk */
722 #define ZPOOL_CONFIG_MMP_HOSTID "mmp_hostid" /* not stored on disk */
723 #define ZPOOL_CONFIG_ALLOCATION_BIAS "alloc_bias" /* not stored on disk */
724 #define ZPOOL_CONFIG_EXPANSION_TIME "expansion_time" /* not stored */
725
726 /*
727 * The persistent vdev state is stored as separate values rather than a single
728 * 'vdev_state' entry. This is because a device can be in multiple states, such
729 * as offline and degraded.
730 */
731 #define ZPOOL_CONFIG_OFFLINE "offline"
732 #define ZPOOL_CONFIG_FAULTED "faulted"
733 #define ZPOOL_CONFIG_DEGRADED "degraded"
734 #define ZPOOL_CONFIG_REMOVED "removed"
735 #define ZPOOL_CONFIG_FRU "fru"
736 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
737
738 /* Pool load policy parameters */
739 #define ZPOOL_LOAD_POLICY "load-policy"
740 #define ZPOOL_LOAD_REWIND_POLICY "load-rewind-policy"
741 #define ZPOOL_LOAD_REQUEST_TXG "load-request-txg"
742 #define ZPOOL_LOAD_META_THRESH "load-meta-thresh"
743 #define ZPOOL_LOAD_DATA_THRESH "load-data-thresh"
744
745 /* Rewind data discovered */
746 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
747 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
748 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
749
750 #define VDEV_TYPE_ROOT "root"
751 #define VDEV_TYPE_MIRROR "mirror"
752 #define VDEV_TYPE_REPLACING "replacing"
753 #define VDEV_TYPE_RAIDZ "raidz"
754 #define VDEV_TYPE_DISK "disk"
755 #define VDEV_TYPE_FILE "file"
756 #define VDEV_TYPE_MISSING "missing"
757 #define VDEV_TYPE_HOLE "hole"
758 #define VDEV_TYPE_SPARE "spare"
759 #define VDEV_TYPE_LOG "log"
760 #define VDEV_TYPE_L2CACHE "l2cache"
761 #define VDEV_TYPE_INDIRECT "indirect"
762
763 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */
764 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \
765 "com.delphix:indirect_obsolete_sm"
766 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \
767 "com.delphix:obsolete_counts_are_precise"
768 #define VDEV_TOP_ZAP_POOL_CHECKPOINT_SM \
769 "com.delphix:pool_checkpoint_sm"
770
771 #define VDEV_TOP_ZAP_ALLOCATION_BIAS \
772 "org.zfsonlinux:allocation_bias"
773
774 /* vdev metaslab allocation bias */
775 #define VDEV_ALLOC_BIAS_LOG "log"
776 #define VDEV_ALLOC_BIAS_SPECIAL "special"
777 #define VDEV_ALLOC_BIAS_DEDUP "dedup"
778
779 #define VDEV_LEAF_ZAP_INITIALIZE_LAST_OFFSET \
780 "com.delphix:next_offset_to_initialize"
781 #define VDEV_LEAF_ZAP_INITIALIZE_STATE \
782 "com.delphix:vdev_initialize_state"
783 #define VDEV_LEAF_ZAP_INITIALIZE_ACTION_TIME \
784 "com.delphix:vdev_initialize_action_time"
785
786 /*
787 * This is needed in userland to report the minimum necessary device size.
788 */
789 #define SPA_MINDEVSIZE (64ULL << 20)
790
791 /*
792 * Set if the fragmentation has not yet been calculated. This can happen
793 * because the space maps have not been upgraded or the histogram feature
794 * is not enabled.
795 */
796 #define ZFS_FRAG_INVALID UINT64_MAX
797
798 /*
799 * The location of the pool configuration repository, shared between kernel and
800 * userland.
801 */
802 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
803
804 /*
805 * vdev states are ordered from least to most healthy.
806 * A vdev that's CANT_OPEN or below is considered unusable.
807 */
808 typedef enum vdev_state {
809 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
810 VDEV_STATE_CLOSED, /* Not currently open */
811 VDEV_STATE_OFFLINE, /* Not allowed to open */
812 VDEV_STATE_REMOVED, /* Explicitly removed from system */
813 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
814 VDEV_STATE_FAULTED, /* External request to fault device */
815 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
816 VDEV_STATE_HEALTHY /* Presumed good */
817 } vdev_state_t;
818
819 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
820
821 /*
822 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
823 * of the vdev stats structure uses these constants to distinguish why.
824 */
825 typedef enum vdev_aux {
826 VDEV_AUX_NONE, /* no error */
827 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
828 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
829 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
830 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
831 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
832 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
833 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
834 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
835 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
836 VDEV_AUX_SPARED, /* hot spare used in another pool */
837 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
838 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
839 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
840 VDEV_AUX_EXTERNAL, /* external diagnosis or forced fault */
841 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */
842 VDEV_AUX_BAD_ASHIFT, /* vdev ashift is invalid */
843 VDEV_AUX_EXTERNAL_PERSIST, /* persistent forced fault */
844 VDEV_AUX_ACTIVE, /* vdev active on a different host */
845 VDEV_AUX_CHILDREN_OFFLINE, /* all children are offline */
846 } vdev_aux_t;
847
848 /*
849 * pool state. The following states are written to disk as part of the normal
850 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
851 * states are software abstractions used at various levels to communicate
852 * pool state.
853 */
854 typedef enum pool_state {
855 POOL_STATE_ACTIVE = 0, /* In active use */
856 POOL_STATE_EXPORTED, /* Explicitly exported */
857 POOL_STATE_DESTROYED, /* Explicitly destroyed */
858 POOL_STATE_SPARE, /* Reserved for hot spare use */
859 POOL_STATE_L2CACHE, /* Level 2 ARC device */
860 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
861 POOL_STATE_UNAVAIL, /* Internal libzfs state */
862 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
863 } pool_state_t;
864
865 /*
866 * mmp state. The following states provide additional detail describing
867 * why a pool couldn't be safely imported.
868 */
869 typedef enum mmp_state {
870 MMP_STATE_ACTIVE = 0, /* In active use */
871 MMP_STATE_INACTIVE, /* Inactive and safe to import */
872 MMP_STATE_NO_HOSTID /* System hostid is not set */
873 } mmp_state_t;
874
875 /*
876 * Scan Functions.
877 */
878 typedef enum pool_scan_func {
879 POOL_SCAN_NONE,
880 POOL_SCAN_SCRUB,
881 POOL_SCAN_RESILVER,
882 POOL_SCAN_FUNCS
883 } pool_scan_func_t;
884
885 /*
886 * Used to control scrub pause and resume.
887 */
888 typedef enum pool_scrub_cmd {
889 POOL_SCRUB_NORMAL = 0,
890 POOL_SCRUB_PAUSE,
891 POOL_SCRUB_FLAGS_END
892 } pool_scrub_cmd_t;
893
894 typedef enum {
895 CS_NONE,
896 CS_CHECKPOINT_EXISTS,
897 CS_CHECKPOINT_DISCARDING,
898 CS_NUM_STATES
899 } checkpoint_state_t;
900
901 typedef struct pool_checkpoint_stat {
902 uint64_t pcs_state; /* checkpoint_state_t */
903 uint64_t pcs_start_time; /* time checkpoint/discard started */
904 uint64_t pcs_space; /* checkpointed space */
905 } pool_checkpoint_stat_t;
906
907 /*
908 * ZIO types. Needed to interpret vdev statistics below.
909 */
910 typedef enum zio_type {
911 ZIO_TYPE_NULL = 0,
912 ZIO_TYPE_READ,
913 ZIO_TYPE_WRITE,
914 ZIO_TYPE_FREE,
915 ZIO_TYPE_CLAIM,
916 ZIO_TYPE_IOCTL,
917 ZIO_TYPES
918 } zio_type_t;
919
920 /*
921 * Pool statistics. Note: all fields should be 64-bit because this
922 * is passed between kernel and userland as an nvlist uint64 array.
923 */
924 typedef struct pool_scan_stat {
925 /* values stored on disk */
926 uint64_t pss_func; /* pool_scan_func_t */
927 uint64_t pss_state; /* dsl_scan_state_t */
928 uint64_t pss_start_time; /* scan start time */
929 uint64_t pss_end_time; /* scan end time */
930 uint64_t pss_to_examine; /* total bytes to scan */
931 uint64_t pss_examined; /* total bytes located by scanner */
932 uint64_t pss_to_process; /* total bytes to process */
933 uint64_t pss_processed; /* total processed bytes */
934 uint64_t pss_errors; /* scan errors */
935
936 /* values not stored on disk */
937 uint64_t pss_pass_exam; /* examined bytes per scan pass */
938 uint64_t pss_pass_start; /* start time of a scan pass */
939 uint64_t pss_pass_scrub_pause; /* pause time of a scurb pass */
940 /* cumulative time scrub spent paused, needed for rate calculation */
941 uint64_t pss_pass_scrub_spent_paused;
942 uint64_t pss_pass_issued; /* issued bytes per scan pass */
943 uint64_t pss_issued; /* total bytes checked by scanner */
944 } pool_scan_stat_t;
945
946 typedef struct pool_removal_stat {
947 uint64_t prs_state; /* dsl_scan_state_t */
948 uint64_t prs_removing_vdev;
949 uint64_t prs_start_time;
950 uint64_t prs_end_time;
951 uint64_t prs_to_copy; /* bytes that need to be copied */
952 uint64_t prs_copied; /* bytes copied so far */
953 /*
954 * bytes of memory used for indirect mappings.
955 * This includes all removed vdevs.
956 */
957 uint64_t prs_mapping_memory;
958 } pool_removal_stat_t;
959
960 typedef enum dsl_scan_state {
961 DSS_NONE,
962 DSS_SCANNING,
963 DSS_FINISHED,
964 DSS_CANCELED,
965 DSS_NUM_STATES
966 } dsl_scan_state_t;
967
968 /*
969 * Errata described by http://zfsonlinux.org/msg/ZFS-8000-ER. The ordering
970 * of this enum must be maintained to ensure the errata identifiers map to
971 * the correct documentation. New errata may only be appended to the list
972 * and must contain corresponding documentation at the above link.
973 */
974 typedef enum zpool_errata {
975 ZPOOL_ERRATA_NONE,
976 ZPOOL_ERRATA_ZOL_2094_SCRUB,
977 ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY,
978 ZPOOL_ERRATA_ZOL_6845_ENCRYPTION,
979 ZPOOL_ERRATA_ZOL_8308_ENCRYPTION,
980 } zpool_errata_t;
981
982 /*
983 * Vdev statistics. Note: all fields should be 64-bit because this
984 * is passed between kernel and userland as an nvlist uint64 array.
985 */
986 typedef struct vdev_stat {
987 hrtime_t vs_timestamp; /* time since vdev load */
988 uint64_t vs_state; /* vdev state */
989 uint64_t vs_aux; /* see vdev_aux_t */
990 uint64_t vs_alloc; /* space allocated */
991 uint64_t vs_space; /* total capacity */
992 uint64_t vs_dspace; /* deflated capacity */
993 uint64_t vs_rsize; /* replaceable dev size */
994 uint64_t vs_esize; /* expandable dev size */
995 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
996 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
997 uint64_t vs_read_errors; /* read errors */
998 uint64_t vs_write_errors; /* write errors */
999 uint64_t vs_checksum_errors; /* checksum errors */
1000 uint64_t vs_initialize_errors; /* initializing errors */
1001 uint64_t vs_self_healed; /* self-healed bytes */
1002 uint64_t vs_scan_removing; /* removing? */
1003 uint64_t vs_scan_processed; /* scan processed bytes */
1004 uint64_t vs_fragmentation; /* device fragmentation */
1005 uint64_t vs_initialize_bytes_done; /* bytes initialized */
1006 uint64_t vs_initialize_bytes_est; /* total bytes to initialize */
1007 uint64_t vs_initialize_state; /* vdev_initialzing_state_t */
1008 uint64_t vs_initialize_action_time; /* time_t */
1009 uint64_t vs_checkpoint_space; /* checkpoint-consumed space */
1010 uint64_t vs_resilver_deferred; /* resilver deferred */
1011 uint64_t vs_slow_ios; /* slow IOs */
1012 } vdev_stat_t;
1013
1014 /*
1015 * Extended stats
1016 *
1017 * These are stats which aren't included in the original iostat output. For
1018 * convenience, they are grouped together in vdev_stat_ex, although each stat
1019 * is individually exported as an nvlist.
1020 */
1021 typedef struct vdev_stat_ex {
1022 /* Number of ZIOs issued to disk and waiting to finish */
1023 uint64_t vsx_active_queue[ZIO_PRIORITY_NUM_QUEUEABLE];
1024
1025 /* Number of ZIOs pending to be issued to disk */
1026 uint64_t vsx_pend_queue[ZIO_PRIORITY_NUM_QUEUEABLE];
1027
1028 /*
1029 * Below are the histograms for various latencies. Buckets are in
1030 * units of nanoseconds.
1031 */
1032
1033 /*
1034 * 2^37 nanoseconds = 134s. Timeouts will probably start kicking in
1035 * before this.
1036 */
1037 #define VDEV_L_HISTO_BUCKETS 37 /* Latency histo buckets */
1038 #define VDEV_RQ_HISTO_BUCKETS 25 /* Request size histo buckets */
1039
1040 /* Amount of time in ZIO queue (ns) */
1041 uint64_t vsx_queue_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
1042 [VDEV_L_HISTO_BUCKETS];
1043
1044 /* Total ZIO latency (ns). Includes queuing and disk access time */
1045 uint64_t vsx_total_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS];
1046
1047 /* Amount of time to read/write the disk (ns) */
1048 uint64_t vsx_disk_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS];
1049
1050 /* "lookup the bucket for a value" histogram macros */
1051 #define HISTO(val, buckets) (val != 0 ? MIN(highbit64(val) - 1, \
1052 buckets - 1) : 0)
1053 #define L_HISTO(a) HISTO(a, VDEV_L_HISTO_BUCKETS)
1054 #define RQ_HISTO(a) HISTO(a, VDEV_RQ_HISTO_BUCKETS)
1055
1056 /* Physical IO histogram */
1057 uint64_t vsx_ind_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
1058 [VDEV_RQ_HISTO_BUCKETS];
1059
1060 /* Delegated (aggregated) physical IO histogram */
1061 uint64_t vsx_agg_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
1062 [VDEV_RQ_HISTO_BUCKETS];
1063
1064 } vdev_stat_ex_t;
1065
1066 /*
1067 * Initialize functions.
1068 */
1069 typedef enum pool_initialize_func {
1070 POOL_INITIALIZE_DO,
1071 POOL_INITIALIZE_CANCEL,
1072 POOL_INITIALIZE_SUSPEND,
1073 POOL_INITIALIZE_FUNCS
1074 } pool_initialize_func_t;
1075
1076 /*
1077 * DDT statistics. Note: all fields should be 64-bit because this
1078 * is passed between kernel and userland as an nvlist uint64 array.
1079 */
1080 typedef struct ddt_object {
1081 uint64_t ddo_count; /* number of elements in ddt */
1082 uint64_t ddo_dspace; /* size of ddt on disk */
1083 uint64_t ddo_mspace; /* size of ddt in-core */
1084 } ddt_object_t;
1085
1086 typedef struct ddt_stat {
1087 uint64_t dds_blocks; /* blocks */
1088 uint64_t dds_lsize; /* logical size */
1089 uint64_t dds_psize; /* physical size */
1090 uint64_t dds_dsize; /* deflated allocated size */
1091 uint64_t dds_ref_blocks; /* referenced blocks */
1092 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
1093 uint64_t dds_ref_psize; /* referenced psize * refcnt */
1094 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
1095 } ddt_stat_t;
1096
1097 typedef struct ddt_histogram {
1098 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
1099 } ddt_histogram_t;
1100
1101 #define ZVOL_DRIVER "zvol"
1102 #define ZFS_DRIVER "zfs"
1103 #define ZFS_DEV "/dev/zfs"
1104 #define ZFS_SHARETAB "/etc/dfs/sharetab"
1105
1106 #define ZFS_SUPER_MAGIC 0x2fc12fc1
1107
1108 /* general zvol path */
1109 #define ZVOL_DIR "/dev"
1110
1111 #define ZVOL_MAJOR 230
1112 #define ZVOL_MINOR_BITS 4
1113 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
1114 #define ZVOL_MINORS (1 << 4)
1115 #define ZVOL_DEV_NAME "zd"
1116
1117 #define ZVOL_PROP_NAME "name"
1118 #define ZVOL_DEFAULT_BLOCKSIZE 8192
1119
1120 typedef enum {
1121 VDEV_INITIALIZE_NONE,
1122 VDEV_INITIALIZE_ACTIVE,
1123 VDEV_INITIALIZE_CANCELED,
1124 VDEV_INITIALIZE_SUSPENDED,
1125 VDEV_INITIALIZE_COMPLETE
1126 } vdev_initializing_state_t;
1127
1128 /*
1129 * nvlist name constants. Facilitate restricting snapshot iteration range for
1130 * the "list next snapshot" ioctl
1131 */
1132 #define SNAP_ITER_MIN_TXG "snap_iter_min_txg"
1133 #define SNAP_ITER_MAX_TXG "snap_iter_max_txg"
1134
1135 /*
1136 * /dev/zfs ioctl numbers.
1137 *
1138 * These numbers cannot change over time. New ioctl numbers must be appended.
1139 */
1140 typedef enum zfs_ioc {
1141 /*
1142 * Illumos - 71/128 numbers reserved.
1143 */
1144 ZFS_IOC_FIRST = ('Z' << 8),
1145 ZFS_IOC = ZFS_IOC_FIRST,
1146 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, /* 0x5a00 */
1147 ZFS_IOC_POOL_DESTROY, /* 0x5a01 */
1148 ZFS_IOC_POOL_IMPORT, /* 0x5a02 */
1149 ZFS_IOC_POOL_EXPORT, /* 0x5a03 */
1150 ZFS_IOC_POOL_CONFIGS, /* 0x5a04 */
1151 ZFS_IOC_POOL_STATS, /* 0x5a05 */
1152 ZFS_IOC_POOL_TRYIMPORT, /* 0x5a06 */
1153 ZFS_IOC_POOL_SCAN, /* 0x5a07 */
1154 ZFS_IOC_POOL_FREEZE, /* 0x5a08 */
1155 ZFS_IOC_POOL_UPGRADE, /* 0x5a09 */
1156 ZFS_IOC_POOL_GET_HISTORY, /* 0x5a0a */
1157 ZFS_IOC_VDEV_ADD, /* 0x5a0b */
1158 ZFS_IOC_VDEV_REMOVE, /* 0x5a0c */
1159 ZFS_IOC_VDEV_SET_STATE, /* 0x5a0d */
1160 ZFS_IOC_VDEV_ATTACH, /* 0x5a0e */
1161 ZFS_IOC_VDEV_DETACH, /* 0x5a0f */
1162 ZFS_IOC_VDEV_SETPATH, /* 0x5a10 */
1163 ZFS_IOC_VDEV_SETFRU, /* 0x5a11 */
1164 ZFS_IOC_OBJSET_STATS, /* 0x5a12 */
1165 ZFS_IOC_OBJSET_ZPLPROPS, /* 0x5a13 */
1166 ZFS_IOC_DATASET_LIST_NEXT, /* 0x5a14 */
1167 ZFS_IOC_SNAPSHOT_LIST_NEXT, /* 0x5a15 */
1168 ZFS_IOC_SET_PROP, /* 0x5a16 */
1169 ZFS_IOC_CREATE, /* 0x5a17 */
1170 ZFS_IOC_DESTROY, /* 0x5a18 */
1171 ZFS_IOC_ROLLBACK, /* 0x5a19 */
1172 ZFS_IOC_RENAME, /* 0x5a1a */
1173 ZFS_IOC_RECV, /* 0x5a1b */
1174 ZFS_IOC_SEND, /* 0x5a1c */
1175 ZFS_IOC_INJECT_FAULT, /* 0x5a1d */
1176 ZFS_IOC_CLEAR_FAULT, /* 0x5a1e */
1177 ZFS_IOC_INJECT_LIST_NEXT, /* 0x5a1f */
1178 ZFS_IOC_ERROR_LOG, /* 0x5a20 */
1179 ZFS_IOC_CLEAR, /* 0x5a21 */
1180 ZFS_IOC_PROMOTE, /* 0x5a22 */
1181 ZFS_IOC_SNAPSHOT, /* 0x5a23 */
1182 ZFS_IOC_DSOBJ_TO_DSNAME, /* 0x5a24 */
1183 ZFS_IOC_OBJ_TO_PATH, /* 0x5a25 */
1184 ZFS_IOC_POOL_SET_PROPS, /* 0x5a26 */
1185 ZFS_IOC_POOL_GET_PROPS, /* 0x5a27 */
1186 ZFS_IOC_SET_FSACL, /* 0x5a28 */
1187 ZFS_IOC_GET_FSACL, /* 0x5a29 */
1188 ZFS_IOC_SHARE, /* 0x5a2a */
1189 ZFS_IOC_INHERIT_PROP, /* 0x5a2b */
1190 ZFS_IOC_SMB_ACL, /* 0x5a2c */
1191 ZFS_IOC_USERSPACE_ONE, /* 0x5a2d */
1192 ZFS_IOC_USERSPACE_MANY, /* 0x5a2e */
1193 ZFS_IOC_USERSPACE_UPGRADE, /* 0x5a2f */
1194 ZFS_IOC_HOLD, /* 0x5a30 */
1195 ZFS_IOC_RELEASE, /* 0x5a31 */
1196 ZFS_IOC_GET_HOLDS, /* 0x5a32 */
1197 ZFS_IOC_OBJSET_RECVD_PROPS, /* 0x5a33 */
1198 ZFS_IOC_VDEV_SPLIT, /* 0x5a34 */
1199 ZFS_IOC_NEXT_OBJ, /* 0x5a35 */
1200 ZFS_IOC_DIFF, /* 0x5a36 */
1201 ZFS_IOC_TMP_SNAPSHOT, /* 0x5a37 */
1202 ZFS_IOC_OBJ_TO_STATS, /* 0x5a38 */
1203 ZFS_IOC_SPACE_WRITTEN, /* 0x5a39 */
1204 ZFS_IOC_SPACE_SNAPS, /* 0x5a3a */
1205 ZFS_IOC_DESTROY_SNAPS, /* 0x5a3b */
1206 ZFS_IOC_POOL_REGUID, /* 0x5a3c */
1207 ZFS_IOC_POOL_REOPEN, /* 0x5a3d */
1208 ZFS_IOC_SEND_PROGRESS, /* 0x5a3e */
1209 ZFS_IOC_LOG_HISTORY, /* 0x5a3f */
1210 ZFS_IOC_SEND_NEW, /* 0x5a40 */
1211 ZFS_IOC_SEND_SPACE, /* 0x5a41 */
1212 ZFS_IOC_CLONE, /* 0x5a42 */
1213 ZFS_IOC_BOOKMARK, /* 0x5a43 */
1214 ZFS_IOC_GET_BOOKMARKS, /* 0x5a44 */
1215 ZFS_IOC_DESTROY_BOOKMARKS, /* 0x5a45 */
1216 ZFS_IOC_RECV_NEW, /* 0x5a46 */
1217 ZFS_IOC_POOL_SYNC, /* 0x5a47 */
1218 ZFS_IOC_CHANNEL_PROGRAM, /* 0x5a48 */
1219 ZFS_IOC_LOAD_KEY, /* 0x5a49 */
1220 ZFS_IOC_UNLOAD_KEY, /* 0x5a4a */
1221 ZFS_IOC_CHANGE_KEY, /* 0x5a4b */
1222 ZFS_IOC_REMAP, /* 0x5a4c */
1223 ZFS_IOC_POOL_CHECKPOINT, /* 0x5a4d */
1224 ZFS_IOC_POOL_DISCARD_CHECKPOINT, /* 0x5a4e */
1225 ZFS_IOC_POOL_INITIALIZE, /* 0x5a4f */
1226
1227 /*
1228 * Linux - 3/64 numbers reserved.
1229 */
1230 ZFS_IOC_LINUX = ('Z' << 8) + 0x80,
1231 ZFS_IOC_EVENTS_NEXT, /* 0x5a81 */
1232 ZFS_IOC_EVENTS_CLEAR, /* 0x5a82 */
1233 ZFS_IOC_EVENTS_SEEK, /* 0x5a83 */
1234
1235 /*
1236 * FreeBSD - 1/64 numbers reserved.
1237 */
1238 ZFS_IOC_FREEBSD = ('Z' << 8) + 0xC0,
1239
1240 ZFS_IOC_LAST
1241 } zfs_ioc_t;
1242
1243 /*
1244 * zvol ioctl to get dataset name
1245 */
1246 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAX_DATASET_NAME_LEN])
1247
1248 /*
1249 * ZFS-specific error codes used for returning descriptive errors
1250 * to the userland through zfs ioctls.
1251 *
1252 * The enum implicitly includes all the error codes from errno.h.
1253 * New code should use and extend this enum for errors that are
1254 * not described precisely by generic errno codes.
1255 *
1256 * These numbers should not change over time. New entries should be appended.
1257 */
1258 typedef enum {
1259 ZFS_ERR_CHECKPOINT_EXISTS = 1024,
1260 ZFS_ERR_DISCARDING_CHECKPOINT,
1261 ZFS_ERR_NO_CHECKPOINT,
1262 ZFS_ERR_DEVRM_IN_PROGRESS,
1263 ZFS_ERR_VDEV_TOO_BIG,
1264 ZFS_ERR_IOC_CMD_UNAVAIL,
1265 ZFS_ERR_IOC_ARG_UNAVAIL,
1266 ZFS_ERR_IOC_ARG_REQUIRED,
1267 ZFS_ERR_IOC_ARG_BADTYPE,
1268 ZFS_ERR_WRONG_PARENT,
1269 ZFS_ERR_FROM_IVSET_GUID_MISSING,
1270 ZFS_ERR_FROM_IVSET_GUID_MISMATCH,
1271 } zfs_errno_t;
1272
1273 /*
1274 * Internal SPA load state. Used by FMA diagnosis engine.
1275 */
1276 typedef enum {
1277 SPA_LOAD_NONE, /* no load in progress */
1278 SPA_LOAD_OPEN, /* normal open */
1279 SPA_LOAD_IMPORT, /* import in progress */
1280 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
1281 SPA_LOAD_RECOVER, /* recovery requested */
1282 SPA_LOAD_ERROR, /* load failed */
1283 SPA_LOAD_CREATE /* creation in progress */
1284 } spa_load_state_t;
1285
1286 /*
1287 * Bookmark name values.
1288 */
1289 #define ZPOOL_ERR_LIST "error list"
1290 #define ZPOOL_ERR_DATASET "dataset"
1291 #define ZPOOL_ERR_OBJECT "object"
1292
1293 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
1294
1295 /*
1296 * The following are names used in the nvlist describing
1297 * the pool's history log.
1298 */
1299 #define ZPOOL_HIST_RECORD "history record"
1300 #define ZPOOL_HIST_TIME "history time"
1301 #define ZPOOL_HIST_CMD "history command"
1302 #define ZPOOL_HIST_WHO "history who"
1303 #define ZPOOL_HIST_ZONE "history zone"
1304 #define ZPOOL_HIST_HOST "history hostname"
1305 #define ZPOOL_HIST_TXG "history txg"
1306 #define ZPOOL_HIST_INT_EVENT "history internal event"
1307 #define ZPOOL_HIST_INT_STR "history internal str"
1308 #define ZPOOL_HIST_INT_NAME "internal_name"
1309 #define ZPOOL_HIST_IOCTL "ioctl"
1310 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
1311 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
1312 #define ZPOOL_HIST_DSNAME "dsname"
1313 #define ZPOOL_HIST_DSID "dsid"
1314 #define ZPOOL_HIST_ERRNO "errno"
1315
1316 /*
1317 * Special nvlist name that will not have its args recorded in the pool's
1318 * history log.
1319 */
1320 #define ZPOOL_HIDDEN_ARGS "hidden_args"
1321
1322 /*
1323 * The following are names used when invoking ZFS_IOC_POOL_INITIALIZE.
1324 */
1325 #define ZPOOL_INITIALIZE_COMMAND "initialize_command"
1326 #define ZPOOL_INITIALIZE_VDEVS "initialize_vdevs"
1327
1328 /*
1329 * Flags for ZFS_IOC_VDEV_SET_STATE
1330 */
1331 #define ZFS_ONLINE_CHECKREMOVE 0x1
1332 #define ZFS_ONLINE_UNSPARE 0x2
1333 #define ZFS_ONLINE_FORCEFAULT 0x4
1334 #define ZFS_ONLINE_EXPAND 0x8
1335 #define ZFS_OFFLINE_TEMPORARY 0x1
1336
1337 /*
1338 * Flags for ZFS_IOC_POOL_IMPORT
1339 */
1340 #define ZFS_IMPORT_NORMAL 0x0
1341 #define ZFS_IMPORT_VERBATIM 0x1
1342 #define ZFS_IMPORT_ANY_HOST 0x2
1343 #define ZFS_IMPORT_MISSING_LOG 0x4
1344 #define ZFS_IMPORT_ONLY 0x8
1345 #define ZFS_IMPORT_TEMP_NAME 0x10
1346 #define ZFS_IMPORT_SKIP_MMP 0x20
1347 #define ZFS_IMPORT_LOAD_KEYS 0x40
1348 #define ZFS_IMPORT_CHECKPOINT 0x80
1349
1350 /*
1351 * Channel program argument/return nvlist keys and defaults.
1352 */
1353 #define ZCP_ARG_PROGRAM "program"
1354 #define ZCP_ARG_ARGLIST "arg"
1355 #define ZCP_ARG_SYNC "sync"
1356 #define ZCP_ARG_INSTRLIMIT "instrlimit"
1357 #define ZCP_ARG_MEMLIMIT "memlimit"
1358
1359 #define ZCP_ARG_CLIARGV "argv"
1360
1361 #define ZCP_RET_ERROR "error"
1362 #define ZCP_RET_RETURN "return"
1363
1364 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000)
1365 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT)
1366 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024)
1367 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT)
1368
1369 /*
1370 * Sysevent payload members. ZFS will generate the following sysevents with the
1371 * given payloads:
1372 *
1373 * ESC_ZFS_RESILVER_START
1374 * ESC_ZFS_RESILVER_END
1375 * ESC_ZFS_POOL_DESTROY
1376 * ESC_ZFS_POOL_REGUID
1377 *
1378 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1379 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1380 *
1381 * ESC_ZFS_VDEV_REMOVE
1382 * ESC_ZFS_VDEV_CLEAR
1383 * ESC_ZFS_VDEV_CHECK
1384 *
1385 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1386 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1387 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
1388 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
1389 *
1390 * ESC_ZFS_HISTORY_EVENT
1391 *
1392 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1393 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1394 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional)
1395 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional)
1396 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional)
1397 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional)
1398 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional)
1399 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional)
1400 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional)
1401 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional)
1402 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional)
1403 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional)
1404 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional)
1405 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional)
1406 *
1407 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1408 * history log nvlist. The keynames will be free of any spaces or other
1409 * characters that could be potentially unexpected to consumers of the
1410 * sysevents.
1411 */
1412 #define ZFS_EV_POOL_NAME "pool_name"
1413 #define ZFS_EV_POOL_GUID "pool_guid"
1414 #define ZFS_EV_VDEV_PATH "vdev_path"
1415 #define ZFS_EV_VDEV_GUID "vdev_guid"
1416 #define ZFS_EV_HIST_TIME "history_time"
1417 #define ZFS_EV_HIST_CMD "history_command"
1418 #define ZFS_EV_HIST_WHO "history_who"
1419 #define ZFS_EV_HIST_ZONE "history_zone"
1420 #define ZFS_EV_HIST_HOST "history_hostname"
1421 #define ZFS_EV_HIST_TXG "history_txg"
1422 #define ZFS_EV_HIST_INT_EVENT "history_internal_event"
1423 #define ZFS_EV_HIST_INT_STR "history_internal_str"
1424 #define ZFS_EV_HIST_INT_NAME "history_internal_name"
1425 #define ZFS_EV_HIST_IOCTL "history_ioctl"
1426 #define ZFS_EV_HIST_DSNAME "history_dsname"
1427 #define ZFS_EV_HIST_DSID "history_dsid"
1428
1429 #ifdef __cplusplus
1430 }
1431 #endif
1432
1433 #endif /* _SYS_FS_ZFS_H */
ZFS On Linux mirror for PVE