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 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 */
25
26 #ifndef _SYS_SPACE_MAP_H
27 #define _SYS_SPACE_MAP_H
28
29 #pragma ident "%Z%%M% %I% %E% SMI"
30
31 #include <sys/avl.h>
32 #include <sys/dmu.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 typedef struct space_map_ops space_map_ops_t;
39
40 typedef struct space_map {
41 avl_tree_t sm_root; /* AVL tree of map segments */
42 uint64_t sm_space; /* sum of all segments in the map */
43 uint64_t sm_start; /* start of map */
44 uint64_t sm_size; /* size of map */
45 uint8_t sm_shift; /* unit shift */
46 uint8_t sm_pad[3]; /* unused */
47 uint8_t sm_loaded; /* map loaded? */
48 uint8_t sm_loading; /* map loading? */
49 kcondvar_t sm_load_cv; /* map load completion */
50 space_map_ops_t *sm_ops; /* space map block picker ops vector */
51 void *sm_ppd; /* picker-private data */
52 kmutex_t *sm_lock; /* pointer to lock that protects map */
53 } space_map_t;
54
55 typedef struct space_seg {
56 avl_node_t ss_node; /* AVL node */
57 uint64_t ss_start; /* starting offset of this segment */
58 uint64_t ss_end; /* ending offset (non-inclusive) */
59 } space_seg_t;
60
61 typedef struct space_map_obj {
62 uint64_t smo_object; /* on-disk space map object */
63 uint64_t smo_objsize; /* size of the object */
64 uint64_t smo_alloc; /* space allocated from the map */
65 } space_map_obj_t;
66
67 struct space_map_ops {
68 void (*smop_load)(space_map_t *sm);
69 void (*smop_unload)(space_map_t *sm);
70 uint64_t (*smop_alloc)(space_map_t *sm, uint64_t size);
71 void (*smop_claim)(space_map_t *sm, uint64_t start, uint64_t size);
72 void (*smop_free)(space_map_t *sm, uint64_t start, uint64_t size);
73 };
74
75 /*
76 * allocation/free entry
77 *
78 * 1 47 1 15
79 * ,---+------------------------------+------+-----------------.
80 * | 0 | offset (sm_shift units) | type | run |
81 * `---+------------------------------+------+-----------------'
82 * 63 62 17 16 15 0
83 *
84 * special entry
85 *
86 * 1 1 6 56
87 * ,---+---+----------+----------------------------------------.
88 * | 1 | 1 | action | <action specific> |
89 * `---+---+----------+----------------------------------------'
90 * 63 62 61 56 55 0
91 *
92 * debug entry
93 *
94 * 1 1 2 10 50
95 * ,---+---+--------+----------+-------------------------------.
96 * | 1 | 0 | action | syncpass | txg (lower bits) |
97 * `---+---+--------+----------+-------------------------------'
98 * 63 62 61 60 59 50 49 0
99 */
100
101 /* All this stuff takes and returns bytes */
102 #define SM_RUN_DECODE(x) (BF64_DECODE(x, 0, 15) + 1)
103 #define SM_RUN_ENCODE(x) BF64_ENCODE((x) - 1, 0, 15)
104 #define SM_TYPE_DECODE(x) BF64_DECODE(x, 15, 1)
105 #define SM_TYPE_ENCODE(x) BF64_ENCODE(x, 15, 1)
106 #define SM_OFFSET_DECODE(x) BF64_DECODE(x, 16, 47)
107 #define SM_OFFSET_ENCODE(x) BF64_ENCODE(x, 16, 47)
108
109 #define SM_IS_SPECIAL(x) (BF64_DECODE(x, 62, 2) == 3)
110 #define SM_SPECIAL_ENCODE() BF64_ENCODE(3, 62, 2)
111 #define SM_IS_DEBUG(x) (BF64_DECODE(x, 62, 2) == 2)
112 #define SM_DEBUG_ENCODE() BF64_ENCODE(2, 62, 2)
113
114 #define SM_SPECIAL_ACTION_DECODE(x) BF64_DECODE(x, 56, 6)
115 #define SM_SPECIAL_ACTION_ENCODE(x) BF64_ENCODE(x, 56, 6)
116
117 #define SM_DEBUG_ACTION_DECODE(x) BF64_DECODE(x, 60, 3)
118 #define SM_DEBUG_ACTION_ENCODE(x) BF64_ENCODE(x, 60, 3)
119 #define SM_DEBUG_SYNCPASS_DECODE(x) BF64_DECODE(x, 50, 10)
120 #define SM_DEBUG_SYNCPASS_ENCODE(x) BF64_ENCODE(x, 50, 10)
121 #define SM_DEBUG_TXG_DECODE(x) BF64_DECODE(x, 0, 50)
122 #define SM_DEBUG_TXG_ENCODE(x) BF64_ENCODE(x, 0, 50)
123
124 #define SM_RUN_MAX SM_RUN_DECODE(~0ULL)
125
126 #define SM_ALLOC 0x0
127 #define SM_FREE 0x1
128
129 #define SM_FOLD 0x01
130
131 /*
132 * The data for a given space map can be kept on blocks of any size.
133 * Larger blocks entail fewer i/o operations, but they also cause the
134 * DMU to keep more data in-core, and also to waste more i/o bandwidth
135 * when only a few blocks have changed since the last transaction group.
136 * This could use a lot more research, but for now, set the freelist
137 * block size to 4k (2^12).
138 */
139 #define SPACE_MAP_BLOCKSHIFT 12
140
141 typedef void space_map_func_t(space_map_t *sm, uint64_t start, uint64_t size);
142
143 extern void space_map_create(space_map_t *sm, uint64_t start, uint64_t size,
144 uint8_t shift, kmutex_t *lp);
145 extern void space_map_destroy(space_map_t *sm);
146 extern void space_map_add(space_map_t *sm, uint64_t start, uint64_t size);
147 extern void space_map_remove(space_map_t *sm, uint64_t start, uint64_t size);
148 extern int space_map_contains(space_map_t *sm, uint64_t start, uint64_t size);
149 extern void space_map_vacate(space_map_t *sm,
150 space_map_func_t *func, space_map_t *mdest);
151 extern void space_map_walk(space_map_t *sm,
152 space_map_func_t *func, space_map_t *mdest);
153 extern void space_map_excise(space_map_t *sm, uint64_t start, uint64_t size);
154 extern void space_map_union(space_map_t *smd, space_map_t *sms);
155
156 extern void space_map_load_wait(space_map_t *sm);
157 extern int space_map_load(space_map_t *sm, space_map_ops_t *ops,
158 uint8_t maptype, space_map_obj_t *smo, objset_t *os);
159 extern void space_map_unload(space_map_t *sm);
160
161 extern uint64_t space_map_alloc(space_map_t *sm, uint64_t size);
162 extern void space_map_claim(space_map_t *sm, uint64_t start, uint64_t size);
163 extern void space_map_free(space_map_t *sm, uint64_t start, uint64_t size);
164
165 extern void space_map_sync(space_map_t *sm, uint8_t maptype,
166 space_map_obj_t *smo, objset_t *os, dmu_tx_t *tx);
167 extern void space_map_truncate(space_map_obj_t *smo,
168 objset_t *os, dmu_tx_t *tx);
169
170 #ifdef __cplusplus
171 }
172 #endif
173
174 #endif /* _SYS_SPACE_MAP_H */