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