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