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