xref: /OK3568_Linux_fs/u-boot/include/zfs/zfs.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  *  GRUB  --  GRand Unified Bootloader
3*4882a593Smuzhiyun  *  Copyright (C) 1999,2000,2001,2002,2003,2004  Free Software Foundation, Inc.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun /*
8*4882a593Smuzhiyun  * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef	GRUB_ZFS_HEADER
12*4882a593Smuzhiyun #define	GRUB_ZFS_HEADER 1
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun /*
16*4882a593Smuzhiyun  * On-disk version number.
17*4882a593Smuzhiyun  */
18*4882a593Smuzhiyun #define	SPA_VERSION			28ULL
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /*
21*4882a593Smuzhiyun  * The following are configuration names used in the nvlist describing a pool's
22*4882a593Smuzhiyun  * configuration.
23*4882a593Smuzhiyun  */
24*4882a593Smuzhiyun #define	ZPOOL_CONFIG_VERSION		"version"
25*4882a593Smuzhiyun #define	ZPOOL_CONFIG_POOL_NAME		"name"
26*4882a593Smuzhiyun #define	ZPOOL_CONFIG_POOL_STATE		"state"
27*4882a593Smuzhiyun #define	ZPOOL_CONFIG_POOL_TXG		"txg"
28*4882a593Smuzhiyun #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
29*4882a593Smuzhiyun #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
30*4882a593Smuzhiyun #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
31*4882a593Smuzhiyun #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
32*4882a593Smuzhiyun #define	ZPOOL_CONFIG_TYPE		"type"
33*4882a593Smuzhiyun #define	ZPOOL_CONFIG_CHILDREN		"children"
34*4882a593Smuzhiyun #define	ZPOOL_CONFIG_ID			"id"
35*4882a593Smuzhiyun #define	ZPOOL_CONFIG_GUID		"guid"
36*4882a593Smuzhiyun #define	ZPOOL_CONFIG_PATH		"path"
37*4882a593Smuzhiyun #define	ZPOOL_CONFIG_DEVID		"devid"
38*4882a593Smuzhiyun #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
39*4882a593Smuzhiyun #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
40*4882a593Smuzhiyun #define	ZPOOL_CONFIG_ASHIFT		"ashift"
41*4882a593Smuzhiyun #define	ZPOOL_CONFIG_ASIZE		"asize"
42*4882a593Smuzhiyun #define	ZPOOL_CONFIG_DTL		"DTL"
43*4882a593Smuzhiyun #define	ZPOOL_CONFIG_STATS		"stats"
44*4882a593Smuzhiyun #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
45*4882a593Smuzhiyun #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
46*4882a593Smuzhiyun #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
47*4882a593Smuzhiyun #define	ZPOOL_CONFIG_SPARES		"spares"
48*4882a593Smuzhiyun #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
49*4882a593Smuzhiyun #define	ZPOOL_CONFIG_NPARITY		"nparity"
50*4882a593Smuzhiyun #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
51*4882a593Smuzhiyun #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
52*4882a593Smuzhiyun #define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"
53*4882a593Smuzhiyun #define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"
54*4882a593Smuzhiyun #define	ZPOOL_CONFIG_IS_HOLE		"is_hole"
55*4882a593Smuzhiyun #define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"
56*4882a593Smuzhiyun #define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"
57*4882a593Smuzhiyun #define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"
58*4882a593Smuzhiyun /*
59*4882a593Smuzhiyun  * The persistent vdev state is stored as separate values rather than a single
60*4882a593Smuzhiyun  * 'vdev_state' entry.  This is because a device can be in multiple states, such
61*4882a593Smuzhiyun  * as offline and degraded.
62*4882a593Smuzhiyun  */
63*4882a593Smuzhiyun #define	ZPOOL_CONFIG_OFFLINE		"offline"
64*4882a593Smuzhiyun #define	ZPOOL_CONFIG_FAULTED		"faulted"
65*4882a593Smuzhiyun #define	ZPOOL_CONFIG_DEGRADED		"degraded"
66*4882a593Smuzhiyun #define	ZPOOL_CONFIG_REMOVED		"removed"
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun #define	VDEV_TYPE_ROOT			"root"
69*4882a593Smuzhiyun #define	VDEV_TYPE_MIRROR		"mirror"
70*4882a593Smuzhiyun #define	VDEV_TYPE_REPLACING		"replacing"
71*4882a593Smuzhiyun #define	VDEV_TYPE_RAIDZ			"raidz"
72*4882a593Smuzhiyun #define	VDEV_TYPE_DISK			"disk"
73*4882a593Smuzhiyun #define	VDEV_TYPE_FILE			"file"
74*4882a593Smuzhiyun #define	VDEV_TYPE_MISSING		"missing"
75*4882a593Smuzhiyun #define	VDEV_TYPE_HOLE			"hole"
76*4882a593Smuzhiyun #define	VDEV_TYPE_SPARE			"spare"
77*4882a593Smuzhiyun #define	VDEV_TYPE_L2CACHE		"l2cache"
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun /*
80*4882a593Smuzhiyun  * pool state.  The following states are written to disk as part of the normal
81*4882a593Smuzhiyun  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
82*4882a593Smuzhiyun  * states are software abstractions used at various levels to communicate pool
83*4882a593Smuzhiyun  * state.
84*4882a593Smuzhiyun  */
85*4882a593Smuzhiyun typedef enum pool_state {
86*4882a593Smuzhiyun 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
87*4882a593Smuzhiyun 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
88*4882a593Smuzhiyun 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
89*4882a593Smuzhiyun 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
90*4882a593Smuzhiyun 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
91*4882a593Smuzhiyun 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
92*4882a593Smuzhiyun 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
93*4882a593Smuzhiyun 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
94*4882a593Smuzhiyun } pool_state_t;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun struct zfs_data;
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun int zfs_fetch_nvlist(device_t dev, char **nvlist);
99*4882a593Smuzhiyun int zfs_getmdnobj(device_t dev, const char *fsfilename,
100*4882a593Smuzhiyun 			       uint64_t *mdnobj);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun char *zfs_nvlist_lookup_string(char *nvlist, char *name);
103*4882a593Smuzhiyun char *zfs_nvlist_lookup_nvlist(char *nvlist, char *name);
104*4882a593Smuzhiyun int zfs_nvlist_lookup_uint64(char *nvlist, char *name,
105*4882a593Smuzhiyun 				   uint64_t *out);
106*4882a593Smuzhiyun char *zfs_nvlist_lookup_nvlist_array(char *nvlist, char *name,
107*4882a593Smuzhiyun 					   size_t index);
108*4882a593Smuzhiyun int zfs_nvlist_lookup_nvlist_array_get_nelm(char *nvlist, char *name);
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun #endif	/* ! GRUB_ZFS_HEADER */
111