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