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