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