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