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