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