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