?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge commit '5cabbc6b49070407fb9610cfe73d4c0e0dea3e77' into merges
[unleashed.git] / include / sys / fs / zfs.h
blob6e0a0febf5d45875b89c0c08e1398830be2bc396
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_SYNC,
149 ZFS_PROP_REFRATIO,
150 ZFS_PROP_WRITTEN,
151 ZFS_PROP_CLONES,
152 ZFS_PROP_LOGICALUSED,
153 ZFS_PROP_LOGICALREFERENCED,
154 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
155 ZFS_PROP_FILESYSTEM_LIMIT,
156 ZFS_PROP_SNAPSHOT_LIMIT,
157 ZFS_PROP_FILESYSTEM_COUNT,
158 ZFS_PROP_SNAPSHOT_COUNT,
159 ZFS_PROP_REDUNDANT_METADATA,
160 ZFS_PROP_PREV_SNAP,
161 ZFS_PROP_RECEIVE_RESUME_TOKEN,
162 ZFS_PROP_REMAPTXG, /* not exposed to the user */
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(8). */
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_SMB_ACL_SRC "src"
325 #define ZFS_SMB_ACL_TARGET "target"
326
327 typedef enum {
328 ZFS_CANMOUNT_OFF = 0,
329 ZFS_CANMOUNT_ON = 1,
330 ZFS_CANMOUNT_NOAUTO = 2
331 } zfs_canmount_type_t;
332
333 typedef enum {
334 ZFS_LOGBIAS_LATENCY = 0,
335 ZFS_LOGBIAS_THROUGHPUT = 1
336 } zfs_logbias_op_t;
337
338 typedef enum zfs_share_op {
339 ZFS_SHARE_NFS = 0,
340 ZFS_UNSHARE_NFS = 1,
341 ZFS_SHARE_SMB = 2,
342 ZFS_UNSHARE_SMB = 3
343 } zfs_share_op_t;
344
345 typedef enum zfs_smb_acl_op {
346 ZFS_SMB_ACL_ADD,
347 ZFS_SMB_ACL_REMOVE,
348 ZFS_SMB_ACL_RENAME,
349 ZFS_SMB_ACL_PURGE
350 } zfs_smb_acl_op_t;
351
352 typedef enum zfs_cache_type {
353 ZFS_CACHE_NONE = 0,
354 ZFS_CACHE_METADATA = 1,
355 ZFS_CACHE_ALL = 2
356 } zfs_cache_type_t;
357
358 typedef enum {
359 ZFS_SYNC_STANDARD = 0,
360 ZFS_SYNC_ALWAYS = 1,
361 ZFS_SYNC_DISABLED = 2
362 } zfs_sync_type_t;
363
364 typedef enum {
365 ZFS_REDUNDANT_METADATA_ALL,
366 ZFS_REDUNDANT_METADATA_MOST
367 } zfs_redundant_metadata_type_t;
368
369 /*
370 * On-disk version number.
371 */
372 #define SPA_VERSION_1 1ULL
373 #define SPA_VERSION_2 2ULL
374 #define SPA_VERSION_3 3ULL
375 #define SPA_VERSION_4 4ULL
376 #define SPA_VERSION_5 5ULL
377 #define SPA_VERSION_6 6ULL
378 #define SPA_VERSION_7 7ULL
379 #define SPA_VERSION_8 8ULL
380 #define SPA_VERSION_9 9ULL
381 #define SPA_VERSION_10 10ULL
382 #define SPA_VERSION_11 11ULL
383 #define SPA_VERSION_12 12ULL
384 #define SPA_VERSION_13 13ULL
385 #define SPA_VERSION_14 14ULL
386 #define SPA_VERSION_15 15ULL
387 #define SPA_VERSION_16 16ULL
388 #define SPA_VERSION_17 17ULL
389 #define SPA_VERSION_18 18ULL
390 #define SPA_VERSION_19 19ULL
391 #define SPA_VERSION_20 20ULL
392 #define SPA_VERSION_21 21ULL
393 #define SPA_VERSION_22 22ULL
394 #define SPA_VERSION_23 23ULL
395 #define SPA_VERSION_24 24ULL
396 #define SPA_VERSION_25 25ULL
397 #define SPA_VERSION_26 26ULL
398 #define SPA_VERSION_27 27ULL
399 #define SPA_VERSION_28 28ULL
400 #define SPA_VERSION_5000 5000ULL
401
402 /*
403 * When bumping up SPA_VERSION, make sure the boot loader ZFS understands
404 * the on-disk format change.
405 */
406 #define SPA_VERSION SPA_VERSION_5000
407 #define SPA_VERSION_STRING "5000"
408
409 /*
410 * Symbolic names for the changes that caused a SPA_VERSION switch.
411 * Used in the code when checking for presence or absence of a feature.
412 * Feel free to define multiple symbolic names for each version if there
413 * were multiple changes to on-disk structures during that version.
414 *
415 * NOTE: When checking the current SPA_VERSION in your code, be sure
416 * to use spa_version() since it reports the version of the
417 * last synced uberblock. Checking the in-flight version can
418 * be dangerous in some cases.
419 */
420 #define SPA_VERSION_INITIAL SPA_VERSION_1
421 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
422 #define SPA_VERSION_SPARES SPA_VERSION_3
423 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
424 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
425 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
426 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
427 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
428 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
429 #define SPA_VERSION_BOOTFS SPA_VERSION_6
430 #define SPA_VERSION_SLOGS SPA_VERSION_7
431 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
432 #define SPA_VERSION_FUID SPA_VERSION_9
433 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
434 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
435 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
436 #define SPA_VERSION_L2CACHE SPA_VERSION_10
437 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
438 #define SPA_VERSION_ORIGIN SPA_VERSION_11
439 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
440 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
441 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
442 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
443 #define SPA_VERSION_USERSPACE SPA_VERSION_15
444 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
445 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
446 #define SPA_VERSION_USERREFS SPA_VERSION_18
447 #define SPA_VERSION_HOLES SPA_VERSION_19
448 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
449 #define SPA_VERSION_DEDUP SPA_VERSION_21
450 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
451 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
452 #define SPA_VERSION_SA SPA_VERSION_24
453 #define SPA_VERSION_SCAN SPA_VERSION_25
454 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
455 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
456 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
457 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
458 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
459 #define SPA_VERSION_FEATURES SPA_VERSION_5000
460
461 #define SPA_VERSION_IS_SUPPORTED(v) \
462 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
463 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
464
465 /*
466 * ZPL version - rev'd whenever an incompatible on-disk format change
467 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
468 * also update the version_table[] and help message in zfs_prop.c.
469 *
470 * When changing, be sure to teach boot loader ZFS how to read
471 * the new format!
472 */
473 #define ZPL_VERSION_1 1ULL
474 #define ZPL_VERSION_2 2ULL
475 #define ZPL_VERSION_3 3ULL
476 #define ZPL_VERSION_4 4ULL
477 #define ZPL_VERSION_5 5ULL
478 #define ZPL_VERSION ZPL_VERSION_5
479 #define ZPL_VERSION_STRING "5"
480
481 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
482 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
483 #define ZPL_VERSION_FUID ZPL_VERSION_3
484 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
485 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
486 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
487 #define ZPL_VERSION_SA ZPL_VERSION_5
488
489 /* Rewind request information */
490 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
491 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
492 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
493 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
494 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
495 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
496 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
497
498 typedef struct zpool_rewind_policy {
499 uint32_t zrp_request; /* rewind behavior requested */
500 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
501 uint64_t zrp_maxdata; /* max acceptable data errors */
502 uint64_t zrp_txg; /* specific txg to load */
503 } zpool_rewind_policy_t;
504
505 /*
506 * The following are configuration names used in the nvlist describing a pool's
507 * configuration. New on-disk names should be prefixed with "<reverse-DNS>:"
508 * (e.g. "org.open-zfs:") to avoid conflicting names being developed
509 * independently.
510 */
511 #define ZPOOL_CONFIG_VERSION "version"
512 #define ZPOOL_CONFIG_POOL_NAME "name"
513 #define ZPOOL_CONFIG_POOL_STATE "state"
514 #define ZPOOL_CONFIG_POOL_TXG "txg"
515 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
516 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
517 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
518 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
519 #define ZPOOL_CONFIG_TYPE "type"
520 #define ZPOOL_CONFIG_CHILDREN "children"
521 #define ZPOOL_CONFIG_ID "id"
522 #define ZPOOL_CONFIG_GUID "guid"
523 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object"
524 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births"
525 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev"
526 #define ZPOOL_CONFIG_PATH "path"
527 #define ZPOOL_CONFIG_DEVID "devid"
528 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
529 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
530 #define ZPOOL_CONFIG_ASHIFT "ashift"
531 #define ZPOOL_CONFIG_ASIZE "asize"
532 #define ZPOOL_CONFIG_DTL "DTL"
533 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
534 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */
535 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
536 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */
537 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
538 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
539 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
540 #define ZPOOL_CONFIG_SPARES "spares"
541 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
542 #define ZPOOL_CONFIG_NPARITY "nparity"
543 #define ZPOOL_CONFIG_HOSTID "hostid"
544 #define ZPOOL_CONFIG_HOSTNAME "hostname"
545 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
546 #define ZPOOL_CONFIG_UNSPARE "unspare"
547 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
548 #define ZPOOL_CONFIG_IS_LOG "is_log"
549 #define ZPOOL_CONFIG_L2CACHE "l2cache"
550 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
551 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
552 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
553 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
554 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
555 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
556 #define ZPOOL_CONFIG_SPLIT "splitcfg"
557 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
558 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
559 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
560 #define ZPOOL_CONFIG_REMOVING "removing"
561 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
562 #define ZPOOL_CONFIG_COMMENT "comment"
563 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
564 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
565 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
566 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
567 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
568 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
569 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
570 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
571 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
572 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
573 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
574 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
575 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
576 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
577 /*
578 * The persistent vdev state is stored as separate values rather than a single
579 * 'vdev_state' entry. This is because a device can be in multiple states, such
580 * as offline and degraded.
581 */
582 #define ZPOOL_CONFIG_OFFLINE "offline"
583 #define ZPOOL_CONFIG_FAULTED "faulted"
584 #define ZPOOL_CONFIG_DEGRADED "degraded"
585 #define ZPOOL_CONFIG_REMOVED "removed"
586 #define ZPOOL_CONFIG_FRU "fru"
587 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
588
589 /* Rewind policy parameters */
590 #define ZPOOL_REWIND_POLICY "rewind-policy"
591 #define ZPOOL_REWIND_REQUEST "rewind-request"
592 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
593 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
594 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
595
596 /* Rewind data discovered */
597 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
598 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
599 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
600
601 #define VDEV_TYPE_ROOT "root"
602 #define VDEV_TYPE_MIRROR "mirror"
603 #define VDEV_TYPE_REPLACING "replacing"
604 #define VDEV_TYPE_RAIDZ "raidz"
605 #define VDEV_TYPE_DISK "disk"
606 #define VDEV_TYPE_FILE "file"
607 #define VDEV_TYPE_MISSING "missing"
608 #define VDEV_TYPE_HOLE "hole"
609 #define VDEV_TYPE_SPARE "spare"
610 #define VDEV_TYPE_LOG "log"
611 #define VDEV_TYPE_L2CACHE "l2cache"
612 #define VDEV_TYPE_INDIRECT "indirect"
613
614 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */
615 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \
616 "com.delphix:indirect_obsolete_sm"
617 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \
618 "com.delphix:obsolete_counts_are_precise"
619
620 /*
621 * This is needed in userland to report the minimum necessary device size.
622 *
623 * Note that the zfs test suite uses 64MB vdevs.
624 */
625 #define SPA_MINDEVSIZE (64ULL << 20)
626
627 /*
628 * Set if the fragmentation has not yet been calculated. This can happen
629 * because the space maps have not been upgraded or the histogram feature
630 * is not enabled.
631 */
632 #define ZFS_FRAG_INVALID UINT64_MAX
633
634 /*
635 * The location of the pool configuration repository, shared between kernel and
636 * userland.
637 */
638 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
639
640 /*
641 * vdev states are ordered from least to most healthy.
642 * A vdev that's CANT_OPEN or below is considered unusable.
643 */
644 typedef enum vdev_state {
645 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
646 VDEV_STATE_CLOSED, /* Not currently open */
647 VDEV_STATE_OFFLINE, /* Not allowed to open */
648 VDEV_STATE_REMOVED, /* Explicitly removed from system */
649 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
650 VDEV_STATE_FAULTED, /* External request to fault device */
651 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
652 VDEV_STATE_HEALTHY /* Presumed good */
653 } vdev_state_t;
654
655 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
656
657 /*
658 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
659 * of the vdev stats structure uses these constants to distinguish why.
660 */
661 typedef enum vdev_aux {
662 VDEV_AUX_NONE, /* no error */
663 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
664 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
665 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
666 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
667 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
668 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
669 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
670 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
671 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
672 VDEV_AUX_SPARED, /* hot spare used in another pool */
673 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
674 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
675 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
676 VDEV_AUX_EXTERNAL, /* external diagnosis */
677 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */
678 } vdev_aux_t;
679
680 /*
681 * pool state. The following states are written to disk as part of the normal
682 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
683 * states are software abstractions used at various levels to communicate
684 * pool state.
685 */
686 typedef enum pool_state {
687 POOL_STATE_ACTIVE = 0, /* In active use */
688 POOL_STATE_EXPORTED, /* Explicitly exported */
689 POOL_STATE_DESTROYED, /* Explicitly destroyed */
690 POOL_STATE_SPARE, /* Reserved for hot spare use */
691 POOL_STATE_L2CACHE, /* Level 2 ARC device */
692 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
693 POOL_STATE_UNAVAIL, /* Internal libzfs state */
694 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
695 } pool_state_t;
696
697 /*
698 * Scan Functions.
699 */
700 typedef enum pool_scan_func {
701 POOL_SCAN_NONE,
702 POOL_SCAN_SCRUB,
703 POOL_SCAN_RESILVER,
704 POOL_SCAN_FUNCS
705 } pool_scan_func_t;
706
707 /*
708 * Used to control scrub pause and resume.
709 */
710 typedef enum pool_scrub_cmd {
711 POOL_SCRUB_NORMAL = 0,
712 POOL_SCRUB_PAUSE,
713 POOL_SCRUB_FLAGS_END
714 } pool_scrub_cmd_t;
715
716
717 /*
718 * ZIO types. Needed to interpret vdev statistics below.
719 */
720 typedef enum zio_type {
721 ZIO_TYPE_NULL = 0,
722 ZIO_TYPE_READ,
723 ZIO_TYPE_WRITE,
724 ZIO_TYPE_FREE,
725 ZIO_TYPE_CLAIM,
726 ZIO_TYPE_IOCTL,
727 ZIO_TYPES
728 } zio_type_t;
729
730 /*
731 * Pool statistics. Note: all fields should be 64-bit because this
732 * is passed between kernel and userland as an nvlist uint64 array.
733 */
734 typedef struct pool_scan_stat {
735 /* values stored on disk */
736 uint64_t pss_func; /* pool_scan_func_t */
737 uint64_t pss_state; /* dsl_scan_state_t */
738 uint64_t pss_start_time; /* scan start time */
739 uint64_t pss_end_time; /* scan end time */
740 uint64_t pss_to_examine; /* total bytes to scan */
741 uint64_t pss_examined; /* total examined bytes */
742 uint64_t pss_to_process; /* total bytes to process */
743 uint64_t pss_processed; /* total processed bytes */
744 uint64_t pss_errors; /* scan errors */
745
746 /* values not stored on disk */
747 uint64_t pss_pass_exam; /* examined bytes per scan pass */
748 uint64_t pss_pass_start; /* start time of a scan pass */
749 uint64_t pss_pass_scrub_pause; /* pause time of a scurb pass */
750 /* cumulative time scrub spent paused, needed for rate calculation */
751 uint64_t pss_pass_scrub_spent_paused;
752 } pool_scan_stat_t;
753
754 typedef struct pool_removal_stat {
755 uint64_t prs_state; /* dsl_scan_state_t */
756 uint64_t prs_removing_vdev;
757 uint64_t prs_start_time;
758 uint64_t prs_end_time;
759 uint64_t prs_to_copy; /* bytes that need to be copied */
760 uint64_t prs_copied; /* bytes copied so far */
761 /*
762 * bytes of memory used for indirect mappings.
763 * This includes all removed vdevs.
764 */
765 uint64_t prs_mapping_memory;
766 } pool_removal_stat_t;
767
768 typedef enum dsl_scan_state {
769 DSS_NONE,
770 DSS_SCANNING,
771 DSS_FINISHED,
772 DSS_CANCELED,
773 DSS_NUM_STATES
774 } dsl_scan_state_t;
775
776
777 /*
778 * Vdev 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 vdev_stat {
782 hrtime_t vs_timestamp; /* time since vdev load */
783 uint64_t vs_state; /* vdev state */
784 uint64_t vs_aux; /* see vdev_aux_t */
785 uint64_t vs_alloc; /* space allocated */
786 uint64_t vs_space; /* total capacity */
787 uint64_t vs_dspace; /* deflated capacity */
788 uint64_t vs_rsize; /* replaceable dev size */
789 uint64_t vs_esize; /* expandable dev size */
790 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
791 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
792 uint64_t vs_read_errors; /* read errors */
793 uint64_t vs_write_errors; /* write errors */
794 uint64_t vs_checksum_errors; /* checksum errors */
795 uint64_t vs_self_healed; /* self-healed bytes */
796 uint64_t vs_scan_removing; /* removing? */
797 uint64_t vs_scan_processed; /* scan processed bytes */
798 uint64_t vs_fragmentation; /* device fragmentation */
799 } vdev_stat_t;
800
801 /*
802 * DDT statistics. Note: all fields should be 64-bit because this
803 * is passed between kernel and userland as an nvlist uint64 array.
804 */
805 typedef struct ddt_object {
806 uint64_t ddo_count; /* number of elments in ddt */
807 uint64_t ddo_dspace; /* size of ddt on disk */
808 uint64_t ddo_mspace; /* size of ddt in-core */
809 } ddt_object_t;
810
811 typedef struct ddt_stat {
812 uint64_t dds_blocks; /* blocks */
813 uint64_t dds_lsize; /* logical size */
814 uint64_t dds_psize; /* physical size */
815 uint64_t dds_dsize; /* deflated allocated size */
816 uint64_t dds_ref_blocks; /* referenced blocks */
817 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
818 uint64_t dds_ref_psize; /* referenced psize * refcnt */
819 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
820 } ddt_stat_t;
821
822 typedef struct ddt_histogram {
823 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
824 } ddt_histogram_t;
825
826 #define ZVOL_DRIVER "zvol"
827 #define ZFS_DRIVER "zfs"
828 #define ZFS_DEV "/dev/zfs"
829 #define ZFS_DISK_ROOT "/dev/dsk"
830 #define ZFS_DISK_ROOTD ZFS_DISK_ROOT "/"
831 #define ZFS_RDISK_ROOT "/dev/rdsk"
832 #define ZFS_RDISK_ROOTD ZFS_RDISK_ROOT "/"
833
834 /* general zvol path */
835 #define ZVOL_DIR "/dev/zvol"
836 /* expansion */
837 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
838 /* for dump and swap */
839 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
840 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
841
842 #define ZVOL_PROP_NAME "name"
843 #define ZVOL_DEFAULT_BLOCKSIZE 8192
844
845 /*
846 * /dev/zfs ioctl numbers.
847 */
848 typedef enum zfs_ioc {
849 ZFS_IOC_FIRST = ('Z' << 8),
850 ZFS_IOC = ZFS_IOC_FIRST,
851 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
852 ZFS_IOC_POOL_DESTROY,
853 ZFS_IOC_POOL_IMPORT,
854 ZFS_IOC_POOL_EXPORT,
855 ZFS_IOC_POOL_CONFIGS,
856 ZFS_IOC_POOL_STATS,
857 ZFS_IOC_POOL_TRYIMPORT,
858 ZFS_IOC_POOL_SCAN,
859 ZFS_IOC_POOL_FREEZE,
860 ZFS_IOC_POOL_UPGRADE,
861 ZFS_IOC_POOL_GET_HISTORY,
862 ZFS_IOC_VDEV_ADD,
863 ZFS_IOC_VDEV_REMOVE,
864 ZFS_IOC_VDEV_SET_STATE,
865 ZFS_IOC_VDEV_ATTACH,
866 ZFS_IOC_VDEV_DETACH,
867 ZFS_IOC_VDEV_SETPATH,
868 ZFS_IOC_VDEV_SETFRU,
869 ZFS_IOC_OBJSET_STATS,
870 ZFS_IOC_OBJSET_ZPLPROPS,
871 ZFS_IOC_DATASET_LIST_NEXT,
872 ZFS_IOC_SNAPSHOT_LIST_NEXT,
873 ZFS_IOC_SET_PROP,
874 ZFS_IOC_CREATE,
875 ZFS_IOC_DESTROY,
876 ZFS_IOC_ROLLBACK,
877 ZFS_IOC_RENAME,
878 ZFS_IOC_RECV,
879 ZFS_IOC_SEND,
880 ZFS_IOC_INJECT_FAULT,
881 ZFS_IOC_CLEAR_FAULT,
882 ZFS_IOC_INJECT_LIST_NEXT,
883 ZFS_IOC_ERROR_LOG,
884 ZFS_IOC_CLEAR,
885 ZFS_IOC_PROMOTE,
886 ZFS_IOC_SNAPSHOT,
887 ZFS_IOC_DSOBJ_TO_DSNAME,
888 ZFS_IOC_OBJ_TO_PATH,
889 ZFS_IOC_POOL_SET_PROPS,
890 ZFS_IOC_POOL_GET_PROPS,
891 ZFS_IOC_SET_FSACL,
892 ZFS_IOC_GET_FSACL,
893 ZFS_IOC_SHARE,
894 ZFS_IOC_INHERIT_PROP,
895 ZFS_IOC_SMB_ACL,
896 ZFS_IOC_USERSPACE_ONE,
897 ZFS_IOC_USERSPACE_MANY,
898 ZFS_IOC_USERSPACE_UPGRADE,
899 ZFS_IOC_HOLD,
900 ZFS_IOC_RELEASE,
901 ZFS_IOC_GET_HOLDS,
902 ZFS_IOC_OBJSET_RECVD_PROPS,
903 ZFS_IOC_VDEV_SPLIT,
904 ZFS_IOC_NEXT_OBJ,
905 ZFS_IOC_DIFF,
906 ZFS_IOC_TMP_SNAPSHOT,
907 ZFS_IOC_OBJ_TO_STATS,
908 ZFS_IOC_SPACE_WRITTEN,
909 ZFS_IOC_SPACE_SNAPS,
910 ZFS_IOC_DESTROY_SNAPS,
911 ZFS_IOC_POOL_REGUID,
912 ZFS_IOC_POOL_REOPEN,
913 ZFS_IOC_SEND_PROGRESS,
914 ZFS_IOC_LOG_HISTORY,
915 ZFS_IOC_SEND_NEW,
916 ZFS_IOC_SEND_SPACE,
917 ZFS_IOC_CLONE,
918 ZFS_IOC_BOOKMARK,
919 ZFS_IOC_GET_BOOKMARKS,
920 ZFS_IOC_DESTROY_BOOKMARKS,
921 ZFS_IOC_CHANNEL_PROGRAM,
922 ZFS_IOC_REMAP,
923 ZFS_IOC_LAST
924 } zfs_ioc_t;
925
926 /*
927 * Internal SPA load state. Used by FMA diagnosis engine.
928 */
929 typedef enum {
930 SPA_LOAD_NONE, /* no load in progress */
931 SPA_LOAD_OPEN, /* normal open */
932 SPA_LOAD_IMPORT, /* import in progress */
933 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
934 SPA_LOAD_RECOVER, /* recovery requested */
935 SPA_LOAD_ERROR, /* load failed */
936 SPA_LOAD_CREATE /* creation in progress */
937 } spa_load_state_t;
938
939 /*
940 * Bookmark name values.
941 */
942 #define ZPOOL_ERR_LIST "error list"
943 #define ZPOOL_ERR_DATASET "dataset"
944 #define ZPOOL_ERR_OBJECT "object"
945
946 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
947
948 /*
949 * The following are names used in the nvlist describing
950 * the pool's history log.
951 */
952 #define ZPOOL_HIST_RECORD "history record"
953 #define ZPOOL_HIST_TIME "history time"
954 #define ZPOOL_HIST_CMD "history command"
955 #define ZPOOL_HIST_WHO "history who"
956 #define ZPOOL_HIST_ZONE "history zone"
957 #define ZPOOL_HIST_HOST "history hostname"
958 #define ZPOOL_HIST_TXG "history txg"
959 #define ZPOOL_HIST_INT_EVENT "history internal event"
960 #define ZPOOL_HIST_INT_STR "history internal str"
961 #define ZPOOL_HIST_INT_NAME "internal_name"
962 #define ZPOOL_HIST_IOCTL "ioctl"
963 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
964 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
965 #define ZPOOL_HIST_DSNAME "dsname"
966 #define ZPOOL_HIST_DSID "dsid"
967 #define ZPOOL_HIST_ERRNO "errno"
968
969 /*
970 * Flags for ZFS_IOC_VDEV_SET_STATE
971 */
972 #define ZFS_ONLINE_CHECKREMOVE 0x1
973 #define ZFS_ONLINE_UNSPARE 0x2
974 #define ZFS_ONLINE_FORCEFAULT 0x4
975 #define ZFS_ONLINE_EXPAND 0x8
976 #define ZFS_OFFLINE_TEMPORARY 0x1
977
978 /*
979 * Flags for ZFS_IOC_POOL_IMPORT
980 */
981 #define ZFS_IMPORT_NORMAL 0x0
982 #define ZFS_IMPORT_VERBATIM 0x1
983 #define ZFS_IMPORT_ANY_HOST 0x2
984 #define ZFS_IMPORT_MISSING_LOG 0x4
985 #define ZFS_IMPORT_ONLY 0x8
986
987 /*
988 * Channel program argument/return nvlist keys and defaults.
989 */
990 #define ZCP_ARG_PROGRAM "program"
991 #define ZCP_ARG_ARGLIST "arg"
992 #define ZCP_ARG_SYNC "sync"
993 #define ZCP_ARG_INSTRLIMIT "instrlimit"
994 #define ZCP_ARG_MEMLIMIT "memlimit"
995
996 #define ZCP_ARG_CLIARGV "argv"
997
998 #define ZCP_RET_ERROR "error"
999 #define ZCP_RET_RETURN "return"
1000
1001 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000)
1002 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT)
1003 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024)
1004 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT)
1005
1006 /*
1007 * Sysevent payload members. ZFS will generate the following sysevents with the
1008 * given payloads:
1009 *
1010 * ESC_ZFS_RESILVER_START
1011 * ESC_ZFS_RESILVER_END
1012 * ESC_ZFS_POOL_DESTROY
1013 * ESC_ZFS_POOL_REGUID
1014 *
1015 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1016 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1017 *
1018 * ESC_ZFS_VDEV_REMOVE
1019 * ESC_ZFS_VDEV_CLEAR
1020 * ESC_ZFS_VDEV_CHECK
1021 *
1022 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1023 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1024 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
1025 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
1026 *
1027 * ESC_ZFS_HISTORY_EVENT
1028 *
1029 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1030 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1031 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional)
1032 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional)
1033 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional)
1034 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional)
1035 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional)
1036 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional)
1037 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional)
1038 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional)
1039 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional)
1040 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional)
1041 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional)
1042 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional)
1043 *
1044 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1045 * history log nvlist. The keynames will be free of any spaces or other
1046 * characters that could be potentially unexpected to consumers of the
1047 * sysevents.
1048 */
1049 #define ZFS_EV_POOL_NAME "pool_name"
1050 #define ZFS_EV_POOL_GUID "pool_guid"
1051 #define ZFS_EV_VDEV_PATH "vdev_path"
1052 #define ZFS_EV_VDEV_GUID "vdev_guid"
1053 #define ZFS_EV_HIST_TIME "history_time"
1054 #define ZFS_EV_HIST_CMD "history_command"
1055 #define ZFS_EV_HIST_WHO "history_who"
1056 #define ZFS_EV_HIST_ZONE "history_zone"
1057 #define ZFS_EV_HIST_HOST "history_hostname"
1058 #define ZFS_EV_HIST_TXG "history_txg"
1059 #define ZFS_EV_HIST_INT_EVENT "history_internal_event"
1060 #define ZFS_EV_HIST_INT_STR "history_internal_str"
1061 #define ZFS_EV_HIST_INT_NAME "history_internal_name"
1062 #define ZFS_EV_HIST_IOCTL "history_ioctl"
1063 #define ZFS_EV_HIST_DSNAME "history_dsname"
1064 #define ZFS_EV_HIST_DSID "history_dsid"
1065
1066 #ifdef __cplusplus
1067 }
1068 #endif
1069
1070 #endif /* _SYS_FS_ZFS_H */
Unleashed OS