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