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