1/*
2 *  GRUB  --  GRand Unified Bootloader
3 *  Copyright (C) 1999,2000,2001,2002,2003,2004  Free Software Foundation, Inc.
4 *
5 *  This program is free software; you can redistribute it and/or modify
6 *  it under the terms of the GNU General Public License as published by
7 *  the Free Software Foundation; either version 2 of the License, or
8 *  (at your option) any later version.
9 *
10 *  This program is distributed in the hope that it will be useful,
11 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 *  GNU General Public License for more details.
14 *
15 *  You should have received a copy of the GNU General Public License
16 *  along with this program; if not, write to the Free Software
17 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20/*
21 * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
22 * Use is subject to license terms.
23 */
24
25/*
26 * Copyright (c) 2012 by Delphix. All rights reserved.
27 */
28
29#ifndef	_SYS_DMU_H
30#define	_SYS_DMU_H
31
32/*
33 * This file describes the interface that the DMU provides for its
34 * consumers.
35 *
36 * The DMU also interacts with the SPA.  That interface is described in
37 * dmu_spa.h.
38 */
39
40#define	B_FALSE	0
41#define	B_TRUE	1
42
43#define	DMU_OT_NEWTYPE 0x80
44#define	DMU_OT_METADATA 0x40
45#define	DMU_OT_BYTESWAP_MASK 0x3f
46
47#define	DMU_OT(byteswap, metadata) \
48	(DMU_OT_NEWTYPE | \
49	((metadata) ? DMU_OT_METADATA : 0) | \
50	((byteswap) & DMU_OT_BYTESWAP_MASK))
51
52#define	DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \
53	((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \
54	(ot) < DMU_OT_NUMTYPES)
55
56#define	DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \
57	((ot) & DMU_OT_METADATA) : \
58	dmu_ot[(ot)].ot_metadata)
59
60typedef enum dmu_object_byteswap {
61	DMU_BSWAP_UINT8,
62	DMU_BSWAP_UINT16,
63	DMU_BSWAP_UINT32,
64	DMU_BSWAP_UINT64,
65	DMU_BSWAP_ZAP,
66	DMU_BSWAP_DNODE,
67	DMU_BSWAP_OBJSET,
68	DMU_BSWAP_ZNODE,
69	DMU_BSWAP_OLDACL,
70	DMU_BSWAP_ACL,
71	DMU_BSWAP_NUMFUNCS
72} dmu_object_byteswap_t;
73
74typedef enum dmu_object_type {
75	DMU_OT_NONE,
76	/* general: */
77	DMU_OT_OBJECT_DIRECTORY,	/* ZAP */
78	DMU_OT_OBJECT_ARRAY,		/* UINT64 */
79	DMU_OT_PACKED_NVLIST,		/* UINT8 (XDR by nvlist_pack/unpack) */
80	DMU_OT_PACKED_NVLIST_SIZE,	/* UINT64 */
81	DMU_OT_BPOBJ,			/* UINT64 */
82	DMU_OT_BPOBJ_HDR,		/* UINT64 */
83	/* spa: */
84	DMU_OT_SPACE_MAP_HEADER,	/* UINT64 */
85	DMU_OT_SPACE_MAP,		/* UINT64 */
86	/* zil: */
87	DMU_OT_INTENT_LOG,		/* UINT64 */
88	/* dmu: */
89	DMU_OT_DNODE,			/* DNODE */
90	DMU_OT_OBJSET,			/* OBJSET */
91	/* dsl: */
92	DMU_OT_DSL_DIR,			/* UINT64 */
93	DMU_OT_DSL_DIR_CHILD_MAP,	/* ZAP */
94	DMU_OT_DSL_DS_SNAP_MAP,		/* ZAP */
95	DMU_OT_DSL_PROPS,		/* ZAP */
96	DMU_OT_DSL_DATASET,		/* UINT64 */
97	/* zpl: */
98	DMU_OT_ZNODE,			/* ZNODE */
99	DMU_OT_OLDACL,			/* Old ACL */
100	DMU_OT_PLAIN_FILE_CONTENTS,	/* UINT8 */
101	DMU_OT_DIRECTORY_CONTENTS,	/* ZAP */
102	DMU_OT_MASTER_NODE,		/* ZAP */
103	DMU_OT_UNLINKED_SET,		/* ZAP */
104	/* zvol: */
105	DMU_OT_ZVOL,			/* UINT8 */
106	DMU_OT_ZVOL_PROP,		/* ZAP */
107	/* other; for testing only! */
108	DMU_OT_PLAIN_OTHER,		/* UINT8 */
109	DMU_OT_UINT64_OTHER,		/* UINT64 */
110	DMU_OT_ZAP_OTHER,		/* ZAP */
111	/* new object types: */
112	DMU_OT_ERROR_LOG,		/* ZAP */
113	DMU_OT_SPA_HISTORY,		/* UINT8 */
114	DMU_OT_SPA_HISTORY_OFFSETS,	/* spa_his_phys_t */
115	DMU_OT_POOL_PROPS,		/* ZAP */
116	DMU_OT_DSL_PERMS,		/* ZAP */
117	DMU_OT_ACL,			/* ACL */
118	DMU_OT_SYSACL,			/* SYSACL */
119	DMU_OT_FUID,			/* FUID table (Packed NVLIST UINT8) */
120	DMU_OT_FUID_SIZE,		/* FUID table size UINT64 */
121	DMU_OT_NEXT_CLONES,		/* ZAP */
122	DMU_OT_SCAN_QUEUE,		/* ZAP */
123	DMU_OT_USERGROUP_USED,		/* ZAP */
124	DMU_OT_USERGROUP_QUOTA,		/* ZAP */
125	DMU_OT_USERREFS,		/* ZAP */
126	DMU_OT_DDT_ZAP,			/* ZAP */
127	DMU_OT_DDT_STATS,		/* ZAP */
128	DMU_OT_SA,			/* System attr */
129	DMU_OT_SA_MASTER_NODE,		/* ZAP */
130	DMU_OT_SA_ATTR_REGISTRATION,	/* ZAP */
131	DMU_OT_SA_ATTR_LAYOUTS,		/* ZAP */
132	DMU_OT_SCAN_XLATE,		/* ZAP */
133	DMU_OT_DEDUP,			/* fake dedup BP from ddt_bp_create() */
134	DMU_OT_DEADLIST,		/* ZAP */
135	DMU_OT_DEADLIST_HDR,		/* UINT64 */
136	DMU_OT_DSL_CLONES,		/* ZAP */
137	DMU_OT_BPOBJ_SUBOBJ,		/* UINT64 */
138	DMU_OT_NUMTYPES,
139
140	DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE),
141	DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE),
142	DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE),
143	DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE),
144	DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE),
145	DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE),
146	DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE),
147	DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE),
148	DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE),
149	DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE),
150} dmu_object_type_t;
151
152typedef enum dmu_objset_type {
153	DMU_OST_NONE,
154	DMU_OST_META,
155	DMU_OST_ZFS,
156	DMU_OST_ZVOL,
157	DMU_OST_OTHER,			/* For testing only! */
158	DMU_OST_ANY,			/* Be careful! */
159	DMU_OST_NUMTYPES
160} dmu_objset_type_t;
161
162/*
163 * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
164 */
165#define	DMU_POOL_DIRECTORY_OBJECT	1
166#define	DMU_POOL_CONFIG			"config"
167#define	DMU_POOL_FEATURES_FOR_READ	"features_for_read"
168#define	DMU_POOL_FEATURES_FOR_WRITE	"features_for_write"
169#define	DMU_POOL_FEATURE_DESCRIPTIONS	"feature_descriptions"
170#define	DMU_POOL_ROOT_DATASET		"root_dataset"
171#define	DMU_POOL_SYNC_BPLIST		"sync_bplist"
172#define	DMU_POOL_ERRLOG_SCRUB		"errlog_scrub"
173#define	DMU_POOL_ERRLOG_LAST		"errlog_last"
174#define	DMU_POOL_SPARES			"spares"
175#define	DMU_POOL_DEFLATE		"deflate"
176#define	DMU_POOL_HISTORY		"history"
177#define	DMU_POOL_PROPS			"pool_props"
178#define	DMU_POOL_L2CACHE		"l2cache"
179
180#endif	/* _SYS_DMU_H */
181