?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
uts: make emu10k non-verbose
[unleashed.git] / include / sys / fs / zfs.h
blob83c33250890977a0f97526f0a033330e26f68945
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_SYNC,
148 ZFS_PROP_REFRATIO,
149 ZFS_PROP_WRITTEN,
150 ZFS_PROP_CLONES,
151 ZFS_PROP_LOGICALUSED,
152 ZFS_PROP_LOGICALREFERENCED,
153 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
154 ZFS_PROP_FILESYSTEM_LIMIT,
155 ZFS_PROP_SNAPSHOT_LIMIT,
156 ZFS_PROP_FILESYSTEM_COUNT,
157 ZFS_PROP_SNAPSHOT_COUNT,
158 ZFS_PROP_REDUNDANT_METADATA,
159 ZFS_PROP_PREV_SNAP,
160 ZFS_PROP_RECEIVE_RESUME_TOKEN,
161 ZFS_NUM_PROPS
162 } zfs_prop_t;
163
164 typedef enum {
165 ZFS_PROP_USERUSED,
166 ZFS_PROP_USERQUOTA,
167 ZFS_PROP_GROUPUSED,
168 ZFS_PROP_GROUPQUOTA,
169 ZFS_NUM_USERQUOTA_PROPS
170 } zfs_userquota_prop_t;
171
172 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
173
174 /*
175 * Pool properties are identified by these constants and must be added to the
176 * end of this list to ensure that external consumers are not affected
177 * by the change. If you make any changes to this list, be sure to update
178 * the property table in usr/src/common/zfs/zpool_prop.c.
179 */
180 typedef enum {
181 ZPOOL_PROP_NAME,
182 ZPOOL_PROP_SIZE,
183 ZPOOL_PROP_CAPACITY,
184 ZPOOL_PROP_ALTROOT,
185 ZPOOL_PROP_HEALTH,
186 ZPOOL_PROP_GUID,
187 ZPOOL_PROP_VERSION,
188 ZPOOL_PROP_BOOTFS,
189 ZPOOL_PROP_DELEGATION,
190 ZPOOL_PROP_AUTOREPLACE,
191 ZPOOL_PROP_CACHEFILE,
192 ZPOOL_PROP_FAILUREMODE,
193 ZPOOL_PROP_LISTSNAPS,
194 ZPOOL_PROP_AUTOEXPAND,
195 ZPOOL_PROP_DEDUPDITTO,
196 ZPOOL_PROP_DEDUPRATIO,
197 ZPOOL_PROP_FREE,
198 ZPOOL_PROP_ALLOCATED,
199 ZPOOL_PROP_READONLY,
200 ZPOOL_PROP_COMMENT,
201 ZPOOL_PROP_EXPANDSZ,
202 ZPOOL_PROP_FREEING,
203 ZPOOL_PROP_FRAGMENTATION,
204 ZPOOL_PROP_LEAKED,
205 ZPOOL_PROP_MAXBLOCKSIZE,
206 ZPOOL_NUM_PROPS
207 } zpool_prop_t;
208
209 /* Small enough to not hog a whole line of printout in zpool(1M). */
210 #define ZPROP_MAX_COMMENT 32
211
212 #define ZPROP_CONT -2
213 #define ZPROP_INVAL -1
214
215 #define ZPROP_VALUE "value"
216 #define ZPROP_SOURCE "source"
217
218 typedef enum {
219 ZPROP_SRC_NONE = 0x1,
220 ZPROP_SRC_DEFAULT = 0x2,
221 ZPROP_SRC_TEMPORARY = 0x4,
222 ZPROP_SRC_LOCAL = 0x8,
223 ZPROP_SRC_INHERITED = 0x10,
224 ZPROP_SRC_RECEIVED = 0x20
225 } zprop_source_t;
226
227 #define ZPROP_SRC_ALL 0x3f
228
229 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
230 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
231 /*
232 * Dataset flag implemented as a special entry in the props zap object
233 * indicating that the dataset has received properties on or after
234 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
235 * just as it did in earlier versions, and thereafter, local properties are
236 * preserved.
237 */
238 #define ZPROP_HAS_RECVD "$hasrecvd"
239
240 typedef enum {
241 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
242 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
243 } zprop_errflags_t;
244
245 typedef int (*zprop_func)(int, void *);
246
247 /*
248 * Properties to be set on the root file system of a new pool
249 * are stuffed into their own nvlist, which is then included in
250 * the properties nvlist with the pool properties.
251 */
252 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
253
254 /*
255 * Dataset property functions shared between libzfs and kernel.
256 */
257 const char *zfs_prop_default_string(zfs_prop_t);
258 uint64_t zfs_prop_default_numeric(zfs_prop_t);
259 boolean_t zfs_prop_readonly(zfs_prop_t);
260 boolean_t zfs_prop_inheritable(zfs_prop_t);
261 boolean_t zfs_prop_setonce(zfs_prop_t);
262 const char *zfs_prop_to_name(zfs_prop_t);
263 zfs_prop_t zfs_name_to_prop(const char *);
264 boolean_t zfs_prop_user(const char *);
265 boolean_t zfs_prop_userquota(const char *);
266 boolean_t zfs_prop_written(const char *);
267 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
268 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
269 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
270 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
271
272 /*
273 * Pool property functions shared between libzfs and kernel.
274 */
275 zpool_prop_t zpool_name_to_prop(const char *);
276 const char *zpool_prop_to_name(zpool_prop_t);
277 const char *zpool_prop_default_string(zpool_prop_t);
278 uint64_t zpool_prop_default_numeric(zpool_prop_t);
279 boolean_t zpool_prop_readonly(zpool_prop_t);
280 boolean_t zpool_prop_feature(const char *);
281 boolean_t zpool_prop_unsupported(const char *name);
282 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
283 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
284 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
285
286 /*
287 * Definitions for the Delegation.
288 */
289 typedef enum {
290 ZFS_DELEG_WHO_UNKNOWN = 0,
291 ZFS_DELEG_USER = 'u',
292 ZFS_DELEG_USER_SETS = 'U',
293 ZFS_DELEG_GROUP = 'g',
294 ZFS_DELEG_GROUP_SETS = 'G',
295 ZFS_DELEG_EVERYONE = 'e',
296 ZFS_DELEG_EVERYONE_SETS = 'E',
297 ZFS_DELEG_CREATE = 'c',
298 ZFS_DELEG_CREATE_SETS = 'C',
299 ZFS_DELEG_NAMED_SET = 's',
300 ZFS_DELEG_NAMED_SET_SETS = 'S'
301 } zfs_deleg_who_type_t;
302
303 typedef enum {
304 ZFS_DELEG_NONE = 0,
305 ZFS_DELEG_PERM_LOCAL = 1,
306 ZFS_DELEG_PERM_DESCENDENT = 2,
307 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
308 ZFS_DELEG_PERM_CREATE = 4
309 } zfs_deleg_inherit_t;
310
311 #define ZFS_DELEG_PERM_UID "uid"
312 #define ZFS_DELEG_PERM_GID "gid"
313 #define ZFS_DELEG_PERM_GROUPS "groups"
314
315 #define ZFS_SMB_ACL_SRC "src"
316 #define ZFS_SMB_ACL_TARGET "target"
317
318 typedef enum {
319 ZFS_CANMOUNT_OFF = 0,
320 ZFS_CANMOUNT_ON = 1,
321 ZFS_CANMOUNT_NOAUTO = 2
322 } zfs_canmount_type_t;
323
324 typedef enum {
325 ZFS_LOGBIAS_LATENCY = 0,
326 ZFS_LOGBIAS_THROUGHPUT = 1
327 } zfs_logbias_op_t;
328
329 typedef enum zfs_share_op {
330 ZFS_SHARE_NFS = 0,
331 ZFS_UNSHARE_NFS = 1,
332 ZFS_SHARE_SMB = 2,
333 ZFS_UNSHARE_SMB = 3
334 } zfs_share_op_t;
335
336 typedef enum zfs_smb_acl_op {
337 ZFS_SMB_ACL_ADD,
338 ZFS_SMB_ACL_REMOVE,
339 ZFS_SMB_ACL_RENAME,
340 ZFS_SMB_ACL_PURGE
341 } zfs_smb_acl_op_t;
342
343 typedef enum zfs_cache_type {
344 ZFS_CACHE_NONE = 0,
345 ZFS_CACHE_METADATA = 1,
346 ZFS_CACHE_ALL = 2
347 } zfs_cache_type_t;
348
349 typedef enum {
350 ZFS_SYNC_STANDARD = 0,
351 ZFS_SYNC_ALWAYS = 1,
352 ZFS_SYNC_DISABLED = 2
353 } zfs_sync_type_t;
354
355 typedef enum {
356 ZFS_REDUNDANT_METADATA_ALL,
357 ZFS_REDUNDANT_METADATA_MOST
358 } zfs_redundant_metadata_type_t;
359
360 /*
361 * On-disk version number.
362 */
363 #define SPA_VERSION_1 1ULL
364 #define SPA_VERSION_2 2ULL
365 #define SPA_VERSION_3 3ULL
366 #define SPA_VERSION_4 4ULL
367 #define SPA_VERSION_5 5ULL
368 #define SPA_VERSION_6 6ULL
369 #define SPA_VERSION_7 7ULL
370 #define SPA_VERSION_8 8ULL
371 #define SPA_VERSION_9 9ULL
372 #define SPA_VERSION_10 10ULL
373 #define SPA_VERSION_11 11ULL
374 #define SPA_VERSION_12 12ULL
375 #define SPA_VERSION_13 13ULL
376 #define SPA_VERSION_14 14ULL
377 #define SPA_VERSION_15 15ULL
378 #define SPA_VERSION_16 16ULL
379 #define SPA_VERSION_17 17ULL
380 #define SPA_VERSION_18 18ULL
381 #define SPA_VERSION_19 19ULL
382 #define SPA_VERSION_20 20ULL
383 #define SPA_VERSION_21 21ULL
384 #define SPA_VERSION_22 22ULL
385 #define SPA_VERSION_23 23ULL
386 #define SPA_VERSION_24 24ULL
387 #define SPA_VERSION_25 25ULL
388 #define SPA_VERSION_26 26ULL
389 #define SPA_VERSION_27 27ULL
390 #define SPA_VERSION_28 28ULL
391 #define SPA_VERSION_5000 5000ULL
392
393 /*
394 * When bumping up SPA_VERSION, make sure the boot loader ZFS understands
395 * the on-disk format change.
396 */
397 #define SPA_VERSION SPA_VERSION_5000
398 #define SPA_VERSION_STRING "5000"
399
400 /*
401 * Symbolic names for the changes that caused a SPA_VERSION switch.
402 * Used in the code when checking for presence or absence of a feature.
403 * Feel free to define multiple symbolic names for each version if there
404 * were multiple changes to on-disk structures during that version.
405 *
406 * NOTE: When checking the current SPA_VERSION in your code, be sure
407 * to use spa_version() since it reports the version of the
408 * last synced uberblock. Checking the in-flight version can
409 * be dangerous in some cases.
410 */
411 #define SPA_VERSION_INITIAL SPA_VERSION_1
412 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
413 #define SPA_VERSION_SPARES SPA_VERSION_3
414 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
415 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
416 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
417 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
418 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
419 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
420 #define SPA_VERSION_BOOTFS SPA_VERSION_6
421 #define SPA_VERSION_SLOGS SPA_VERSION_7
422 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
423 #define SPA_VERSION_FUID SPA_VERSION_9
424 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
425 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
426 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
427 #define SPA_VERSION_L2CACHE SPA_VERSION_10
428 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
429 #define SPA_VERSION_ORIGIN SPA_VERSION_11
430 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
431 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
432 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
433 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
434 #define SPA_VERSION_USERSPACE SPA_VERSION_15
435 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
436 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
437 #define SPA_VERSION_USERREFS SPA_VERSION_18
438 #define SPA_VERSION_HOLES SPA_VERSION_19
439 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
440 #define SPA_VERSION_DEDUP SPA_VERSION_21
441 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
442 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
443 #define SPA_VERSION_SA SPA_VERSION_24
444 #define SPA_VERSION_SCAN SPA_VERSION_25
445 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
446 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
447 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
448 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
449 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
450 #define SPA_VERSION_FEATURES SPA_VERSION_5000
451
452 #define SPA_VERSION_IS_SUPPORTED(v) \
453 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
454 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
455
456 /*
457 * ZPL version - rev'd whenever an incompatible on-disk format change
458 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
459 * also update the version_table[] and help message in zfs_prop.c.
460 *
461 * When changing, be sure to teach boot loader ZFS how to read
462 * the new format!
463 */
464 #define ZPL_VERSION_1 1ULL
465 #define ZPL_VERSION_2 2ULL
466 #define ZPL_VERSION_3 3ULL
467 #define ZPL_VERSION_4 4ULL
468 #define ZPL_VERSION_5 5ULL
469 #define ZPL_VERSION ZPL_VERSION_5
470 #define ZPL_VERSION_STRING "5"
471
472 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
473 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
474 #define ZPL_VERSION_FUID ZPL_VERSION_3
475 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
476 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
477 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
478 #define ZPL_VERSION_SA ZPL_VERSION_5
479
480 /* Rewind request information */
481 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
482 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
483 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
484 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
485 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
486 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
487 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
488
489 typedef struct zpool_rewind_policy {
490 uint32_t zrp_request; /* rewind behavior requested */
491 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
492 uint64_t zrp_maxdata; /* max acceptable data errors */
493 uint64_t zrp_txg; /* specific txg to load */
494 } zpool_rewind_policy_t;
495
496 /*
497 * The following are configuration names used in the nvlist describing a pool's
498 * configuration.
499 */
500 #define ZPOOL_CONFIG_VERSION "version"
501 #define ZPOOL_CONFIG_POOL_NAME "name"
502 #define ZPOOL_CONFIG_POOL_STATE "state"
503 #define ZPOOL_CONFIG_POOL_TXG "txg"
504 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
505 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
506 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
507 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
508 #define ZPOOL_CONFIG_TYPE "type"
509 #define ZPOOL_CONFIG_CHILDREN "children"
510 #define ZPOOL_CONFIG_ID "id"
511 #define ZPOOL_CONFIG_GUID "guid"
512 #define ZPOOL_CONFIG_PATH "path"
513 #define ZPOOL_CONFIG_DEVID "devid"
514 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
515 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
516 #define ZPOOL_CONFIG_ASHIFT "ashift"
517 #define ZPOOL_CONFIG_ASIZE "asize"
518 #define ZPOOL_CONFIG_DTL "DTL"
519 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
520 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
521 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
522 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
523 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
524 #define ZPOOL_CONFIG_SPARES "spares"
525 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
526 #define ZPOOL_CONFIG_NPARITY "nparity"
527 #define ZPOOL_CONFIG_HOSTID "hostid"
528 #define ZPOOL_CONFIG_HOSTNAME "hostname"
529 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
530 #define ZPOOL_CONFIG_UNSPARE "unspare"
531 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
532 #define ZPOOL_CONFIG_IS_LOG "is_log"
533 #define ZPOOL_CONFIG_L2CACHE "l2cache"
534 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
535 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
536 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
537 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
538 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
539 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
540 #define ZPOOL_CONFIG_SPLIT "splitcfg"
541 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
542 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
543 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
544 #define ZPOOL_CONFIG_REMOVING "removing"
545 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
546 #define ZPOOL_CONFIG_COMMENT "comment"
547 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
548 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
549 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
550 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
551 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
552 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
553 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
554 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
555 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
556 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
557 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
558 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
559 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
560 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
561 /*
562 * The persistent vdev state is stored as separate values rather than a single
563 * 'vdev_state' entry. This is because a device can be in multiple states, such
564 * as offline and degraded.
565 */
566 #define ZPOOL_CONFIG_OFFLINE "offline"
567 #define ZPOOL_CONFIG_FAULTED "faulted"
568 #define ZPOOL_CONFIG_DEGRADED "degraded"
569 #define ZPOOL_CONFIG_REMOVED "removed"
570 #define ZPOOL_CONFIG_FRU "fru"
571 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
572
573 /* Rewind policy parameters */
574 #define ZPOOL_REWIND_POLICY "rewind-policy"
575 #define ZPOOL_REWIND_REQUEST "rewind-request"
576 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
577 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
578 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
579
580 /* Rewind data discovered */
581 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
582 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
583 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
584
585 #define VDEV_TYPE_ROOT "root"
586 #define VDEV_TYPE_MIRROR "mirror"
587 #define VDEV_TYPE_REPLACING "replacing"
588 #define VDEV_TYPE_RAIDZ "raidz"
589 #define VDEV_TYPE_DISK "disk"
590 #define VDEV_TYPE_FILE "file"
591 #define VDEV_TYPE_MISSING "missing"
592 #define VDEV_TYPE_HOLE "hole"
593 #define VDEV_TYPE_SPARE "spare"
594 #define VDEV_TYPE_LOG "log"
595 #define VDEV_TYPE_L2CACHE "l2cache"
596
597 /*
598 * This is needed in userland to report the minimum necessary device size.
599 *
600 * Note that the zfs test suite uses 64MB vdevs.
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 /*
728 * Vdev statistics. Note: all fields should be 64-bit because this
729 * is passed between kernel and userland as an nvlist uint64 array.
730 */
731 typedef struct vdev_stat {
732 hrtime_t vs_timestamp; /* time since vdev load */
733 uint64_t vs_state; /* vdev state */
734 uint64_t vs_aux; /* see vdev_aux_t */
735 uint64_t vs_alloc; /* space allocated */
736 uint64_t vs_space; /* total capacity */
737 uint64_t vs_dspace; /* deflated capacity */
738 uint64_t vs_rsize; /* replaceable dev size */
739 uint64_t vs_esize; /* expandable dev size */
740 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
741 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
742 uint64_t vs_read_errors; /* read errors */
743 uint64_t vs_write_errors; /* write errors */
744 uint64_t vs_checksum_errors; /* checksum errors */
745 uint64_t vs_self_healed; /* self-healed bytes */
746 uint64_t vs_scan_removing; /* removing? */
747 uint64_t vs_scan_processed; /* scan processed bytes */
748 uint64_t vs_fragmentation; /* device fragmentation */
749 } vdev_stat_t;
750
751 /*
752 * DDT statistics. Note: all fields should be 64-bit because this
753 * is passed between kernel and userland as an nvlist uint64 array.
754 */
755 typedef struct ddt_object {
756 uint64_t ddo_count; /* number of elments in ddt */
757 uint64_t ddo_dspace; /* size of ddt on disk */
758 uint64_t ddo_mspace; /* size of ddt in-core */
759 } ddt_object_t;
760
761 typedef struct ddt_stat {
762 uint64_t dds_blocks; /* blocks */
763 uint64_t dds_lsize; /* logical size */
764 uint64_t dds_psize; /* physical size */
765 uint64_t dds_dsize; /* deflated allocated size */
766 uint64_t dds_ref_blocks; /* referenced blocks */
767 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
768 uint64_t dds_ref_psize; /* referenced psize * refcnt */
769 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
770 } ddt_stat_t;
771
772 typedef struct ddt_histogram {
773 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
774 } ddt_histogram_t;
775
776 #define ZVOL_DRIVER "zvol"
777 #define ZFS_DRIVER "zfs"
778 #define ZFS_DEV "/dev/zfs"
779 #define ZFS_DISK_ROOT "/dev/dsk"
780 #define ZFS_DISK_ROOTD ZFS_DISK_ROOT "/"
781 #define ZFS_RDISK_ROOT "/dev/rdsk"
782 #define ZFS_RDISK_ROOTD ZFS_RDISK_ROOT "/"
783
784 /* general zvol path */
785 #define ZVOL_DIR "/dev/zvol"
786 /* expansion */
787 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
788 /* for dump and swap */
789 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
790 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
791
792 #define ZVOL_PROP_NAME "name"
793 #define ZVOL_DEFAULT_BLOCKSIZE 8192
794
795 /*
796 * /dev/zfs ioctl numbers.
797 */
798 typedef enum zfs_ioc {
799 ZFS_IOC_FIRST = ('Z' << 8),
800 ZFS_IOC = ZFS_IOC_FIRST,
801 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
802 ZFS_IOC_POOL_DESTROY,
803 ZFS_IOC_POOL_IMPORT,
804 ZFS_IOC_POOL_EXPORT,
805 ZFS_IOC_POOL_CONFIGS,
806 ZFS_IOC_POOL_STATS,
807 ZFS_IOC_POOL_TRYIMPORT,
808 ZFS_IOC_POOL_SCAN,
809 ZFS_IOC_POOL_FREEZE,
810 ZFS_IOC_POOL_UPGRADE,
811 ZFS_IOC_POOL_GET_HISTORY,
812 ZFS_IOC_VDEV_ADD,
813 ZFS_IOC_VDEV_REMOVE,
814 ZFS_IOC_VDEV_SET_STATE,
815 ZFS_IOC_VDEV_ATTACH,
816 ZFS_IOC_VDEV_DETACH,
817 ZFS_IOC_VDEV_SETPATH,
818 ZFS_IOC_VDEV_SETFRU,
819 ZFS_IOC_OBJSET_STATS,
820 ZFS_IOC_OBJSET_ZPLPROPS,
821 ZFS_IOC_DATASET_LIST_NEXT,
822 ZFS_IOC_SNAPSHOT_LIST_NEXT,
823 ZFS_IOC_SET_PROP,
824 ZFS_IOC_CREATE,
825 ZFS_IOC_DESTROY,
826 ZFS_IOC_ROLLBACK,
827 ZFS_IOC_RENAME,
828 ZFS_IOC_RECV,
829 ZFS_IOC_SEND,
830 ZFS_IOC_INJECT_FAULT,
831 ZFS_IOC_CLEAR_FAULT,
832 ZFS_IOC_INJECT_LIST_NEXT,
833 ZFS_IOC_ERROR_LOG,
834 ZFS_IOC_CLEAR,
835 ZFS_IOC_PROMOTE,
836 ZFS_IOC_SNAPSHOT,
837 ZFS_IOC_DSOBJ_TO_DSNAME,
838 ZFS_IOC_OBJ_TO_PATH,
839 ZFS_IOC_POOL_SET_PROPS,
840 ZFS_IOC_POOL_GET_PROPS,
841 ZFS_IOC_SET_FSACL,
842 ZFS_IOC_GET_FSACL,
843 ZFS_IOC_SHARE,
844 ZFS_IOC_INHERIT_PROP,
845 ZFS_IOC_SMB_ACL,
846 ZFS_IOC_USERSPACE_ONE,
847 ZFS_IOC_USERSPACE_MANY,
848 ZFS_IOC_USERSPACE_UPGRADE,
849 ZFS_IOC_HOLD,
850 ZFS_IOC_RELEASE,
851 ZFS_IOC_GET_HOLDS,
852 ZFS_IOC_OBJSET_RECVD_PROPS,
853 ZFS_IOC_VDEV_SPLIT,
854 ZFS_IOC_NEXT_OBJ,
855 ZFS_IOC_DIFF,
856 ZFS_IOC_TMP_SNAPSHOT,
857 ZFS_IOC_OBJ_TO_STATS,
858 ZFS_IOC_SPACE_WRITTEN,
859 ZFS_IOC_SPACE_SNAPS,
860 ZFS_IOC_DESTROY_SNAPS,
861 ZFS_IOC_POOL_REGUID,
862 ZFS_IOC_POOL_REOPEN,
863 ZFS_IOC_SEND_PROGRESS,
864 ZFS_IOC_LOG_HISTORY,
865 ZFS_IOC_SEND_NEW,
866 ZFS_IOC_SEND_SPACE,
867 ZFS_IOC_CLONE,
868 ZFS_IOC_BOOKMARK,
869 ZFS_IOC_GET_BOOKMARKS,
870 ZFS_IOC_DESTROY_BOOKMARKS,
871 ZFS_IOC_LAST
872 } zfs_ioc_t;
873
874 /*
875 * Internal SPA load state. Used by FMA diagnosis engine.
876 */
877 typedef enum {
878 SPA_LOAD_NONE, /* no load in progress */
879 SPA_LOAD_OPEN, /* normal open */
880 SPA_LOAD_IMPORT, /* import in progress */
881 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
882 SPA_LOAD_RECOVER, /* recovery requested */
883 SPA_LOAD_ERROR, /* load failed */
884 SPA_LOAD_CREATE /* creation in progress */
885 } spa_load_state_t;
886
887 /*
888 * Bookmark name values.
889 */
890 #define ZPOOL_ERR_LIST "error list"
891 #define ZPOOL_ERR_DATASET "dataset"
892 #define ZPOOL_ERR_OBJECT "object"
893
894 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
895
896 /*
897 * The following are names used in the nvlist describing
898 * the pool's history log.
899 */
900 #define ZPOOL_HIST_RECORD "history record"
901 #define ZPOOL_HIST_TIME "history time"
902 #define ZPOOL_HIST_CMD "history command"
903 #define ZPOOL_HIST_WHO "history who"
904 #define ZPOOL_HIST_ZONE "history zone"
905 #define ZPOOL_HIST_HOST "history hostname"
906 #define ZPOOL_HIST_TXG "history txg"
907 #define ZPOOL_HIST_INT_EVENT "history internal event"
908 #define ZPOOL_HIST_INT_STR "history internal str"
909 #define ZPOOL_HIST_INT_NAME "internal_name"
910 #define ZPOOL_HIST_IOCTL "ioctl"
911 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
912 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
913 #define ZPOOL_HIST_DSNAME "dsname"
914 #define ZPOOL_HIST_DSID "dsid"
915
916 /*
917 * Flags for ZFS_IOC_VDEV_SET_STATE
918 */
919 #define ZFS_ONLINE_CHECKREMOVE 0x1
920 #define ZFS_ONLINE_UNSPARE 0x2
921 #define ZFS_ONLINE_FORCEFAULT 0x4
922 #define ZFS_ONLINE_EXPAND 0x8
923 #define ZFS_OFFLINE_TEMPORARY 0x1
924
925 /*
926 * Flags for ZFS_IOC_POOL_IMPORT
927 */
928 #define ZFS_IMPORT_NORMAL 0x0
929 #define ZFS_IMPORT_VERBATIM 0x1
930 #define ZFS_IMPORT_ANY_HOST 0x2
931 #define ZFS_IMPORT_MISSING_LOG 0x4
932 #define ZFS_IMPORT_ONLY 0x8
933
934 /*
935 * Sysevent payload members. ZFS will generate the following sysevents with the
936 * given payloads:
937 *
938 * ESC_ZFS_RESILVER_START
939 * ESC_ZFS_RESILVER_END
940 * ESC_ZFS_POOL_DESTROY
941 * ESC_ZFS_POOL_REGUID
942 *
943 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
944 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
945 *
946 * ESC_ZFS_VDEV_REMOVE
947 * ESC_ZFS_VDEV_CLEAR
948 * ESC_ZFS_VDEV_CHECK
949 *
950 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
951 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
952 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
953 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
954 */
955 #define ZFS_EV_POOL_NAME "pool_name"
956 #define ZFS_EV_POOL_GUID "pool_guid"
957 #define ZFS_EV_VDEV_PATH "vdev_path"
958 #define ZFS_EV_VDEV_GUID "vdev_guid"
959
960 #ifdef __cplusplus
961 }
962 #endif
963
964 #endif /* _SYS_FS_ZFS_H */
Unleashed OS