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