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