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