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