]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
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 | /* | |
9babb374 | 22 | * Copyright 2009 Sun Microsystems, Inc. All rights reserved. |
34dc7c2f BB |
23 | * Use is subject to license terms. |
24 | */ | |
25 | ||
26 | #ifndef _SYS_DBUF_H | |
27 | #define _SYS_DBUF_H | |
28 | ||
34dc7c2f BB |
29 | #include <sys/dmu.h> |
30 | #include <sys/spa.h> | |
31 | #include <sys/txg.h> | |
32 | #include <sys/zio.h> | |
33 | #include <sys/arc.h> | |
34 | #include <sys/zfs_context.h> | |
35 | #include <sys/refcount.h> | |
36 | ||
37 | #ifdef __cplusplus | |
38 | extern "C" { | |
39 | #endif | |
40 | ||
41 | #define DB_BONUS_BLKID (-1ULL) | |
42 | #define IN_DMU_SYNC 2 | |
43 | ||
44 | /* | |
45 | * define flags for dbuf_read | |
46 | */ | |
47 | ||
48 | #define DB_RF_MUST_SUCCEED (1 << 0) | |
49 | #define DB_RF_CANFAIL (1 << 1) | |
50 | #define DB_RF_HAVESTRUCT (1 << 2) | |
51 | #define DB_RF_NOPREFETCH (1 << 3) | |
52 | #define DB_RF_NEVERWAIT (1 << 4) | |
53 | #define DB_RF_CACHED (1 << 5) | |
54 | ||
55 | /* | |
b128c09f | 56 | * The simplified state transition diagram for dbufs looks like: |
34dc7c2f BB |
57 | * |
58 | * +----> READ ----+ | |
59 | * | | | |
60 | * | V | |
61 | * (alloc)-->UNCACHED CACHED-->EVICTING-->(free) | |
b128c09f BB |
62 | * | ^ ^ |
63 | * | | | | |
64 | * +----> FILL ----+ | | |
65 | * | | | |
66 | * | | | |
67 | * +--------> NOFILL -------+ | |
34dc7c2f BB |
68 | */ |
69 | typedef enum dbuf_states { | |
70 | DB_UNCACHED, | |
71 | DB_FILL, | |
b128c09f | 72 | DB_NOFILL, |
34dc7c2f BB |
73 | DB_READ, |
74 | DB_CACHED, | |
75 | DB_EVICTING | |
76 | } dbuf_states_t; | |
77 | ||
78 | struct objset_impl; | |
79 | struct dnode; | |
80 | struct dmu_tx; | |
81 | ||
82 | /* | |
83 | * level = 0 means the user data | |
84 | * level = 1 means the single indirect block | |
85 | * etc. | |
86 | */ | |
87 | ||
88 | #define LIST_LINK_INACTIVE(link) \ | |
89 | ((link)->list_next == NULL && (link)->list_prev == NULL) | |
90 | ||
91 | struct dmu_buf_impl; | |
92 | ||
93 | typedef enum override_states { | |
94 | DR_NOT_OVERRIDDEN, | |
95 | DR_IN_DMU_SYNC, | |
96 | DR_OVERRIDDEN | |
97 | } override_states_t; | |
98 | ||
99 | typedef struct dbuf_dirty_record { | |
100 | /* link on our parents dirty list */ | |
101 | list_node_t dr_dirty_node; | |
102 | ||
103 | /* transaction group this data will sync in */ | |
104 | uint64_t dr_txg; | |
105 | ||
106 | /* zio of outstanding write IO */ | |
107 | zio_t *dr_zio; | |
108 | ||
109 | /* pointer back to our dbuf */ | |
110 | struct dmu_buf_impl *dr_dbuf; | |
111 | ||
112 | /* pointer to next dirty record */ | |
113 | struct dbuf_dirty_record *dr_next; | |
114 | ||
115 | /* pointer to parent dirty record */ | |
116 | struct dbuf_dirty_record *dr_parent; | |
117 | ||
118 | union dirty_types { | |
119 | struct dirty_indirect { | |
120 | ||
121 | /* protect access to list */ | |
122 | kmutex_t dr_mtx; | |
123 | ||
124 | /* Our list of dirty children */ | |
125 | list_t dr_children; | |
126 | } di; | |
127 | struct dirty_leaf { | |
128 | ||
129 | /* | |
130 | * dr_data is set when we dirty the buffer | |
131 | * so that we can retain the pointer even if it | |
132 | * gets COW'd in a subsequent transaction group. | |
133 | */ | |
134 | arc_buf_t *dr_data; | |
135 | blkptr_t dr_overridden_by; | |
136 | override_states_t dr_override_state; | |
137 | } dl; | |
138 | } dt; | |
139 | } dbuf_dirty_record_t; | |
140 | ||
141 | typedef struct dmu_buf_impl { | |
142 | /* | |
143 | * The following members are immutable, with the exception of | |
144 | * db.db_data, which is protected by db_mtx. | |
145 | */ | |
146 | ||
147 | /* the publicly visible structure */ | |
148 | dmu_buf_t db; | |
149 | ||
150 | /* the objset we belong to */ | |
151 | struct objset_impl *db_objset; | |
152 | ||
153 | /* | |
154 | * the dnode we belong to (NULL when evicted) | |
155 | */ | |
156 | struct dnode *db_dnode; | |
157 | ||
158 | /* | |
159 | * our parent buffer; if the dnode points to us directly, | |
160 | * db_parent == db_dnode->dn_dbuf | |
161 | * only accessed by sync thread ??? | |
162 | * (NULL when evicted) | |
163 | */ | |
164 | struct dmu_buf_impl *db_parent; | |
165 | ||
166 | /* | |
167 | * link for hash table of all dmu_buf_impl_t's | |
168 | */ | |
169 | struct dmu_buf_impl *db_hash_next; | |
170 | ||
171 | /* our block number */ | |
172 | uint64_t db_blkid; | |
173 | ||
174 | /* | |
175 | * Pointer to the blkptr_t which points to us. May be NULL if we | |
176 | * don't have one yet. (NULL when evicted) | |
177 | */ | |
178 | blkptr_t *db_blkptr; | |
179 | ||
180 | /* | |
181 | * Our indirection level. Data buffers have db_level==0. | |
182 | * Indirect buffers which point to data buffers have | |
183 | * db_level==1. etc. Buffers which contain dnodes have | |
184 | * db_level==0, since the dnodes are stored in a file. | |
185 | */ | |
186 | uint8_t db_level; | |
187 | ||
188 | /* db_mtx protects the members below */ | |
189 | kmutex_t db_mtx; | |
190 | ||
191 | /* | |
192 | * Current state of the buffer | |
193 | */ | |
194 | dbuf_states_t db_state; | |
195 | ||
196 | /* | |
197 | * Refcount accessed by dmu_buf_{hold,rele}. | |
198 | * If nonzero, the buffer can't be destroyed. | |
199 | * Protected by db_mtx. | |
200 | */ | |
201 | refcount_t db_holds; | |
202 | ||
203 | /* buffer holding our data */ | |
204 | arc_buf_t *db_buf; | |
205 | ||
206 | kcondvar_t db_changed; | |
207 | dbuf_dirty_record_t *db_data_pending; | |
208 | ||
209 | /* pointer to most recent dirty record for this buffer */ | |
210 | dbuf_dirty_record_t *db_last_dirty; | |
211 | ||
212 | /* | |
213 | * Our link on the owner dnodes's dn_dbufs list. | |
214 | * Protected by its dn_dbufs_mtx. | |
215 | */ | |
216 | list_node_t db_link; | |
217 | ||
218 | /* Data which is unique to data (leaf) blocks: */ | |
219 | ||
220 | /* stuff we store for the user (see dmu_buf_set_user) */ | |
221 | void *db_user_ptr; | |
222 | void **db_user_data_ptr_ptr; | |
223 | dmu_buf_evict_func_t *db_evict_func; | |
224 | ||
225 | uint8_t db_immediate_evict; | |
226 | uint8_t db_freed_in_flight; | |
227 | ||
228 | uint8_t db_dirtycnt; | |
229 | } dmu_buf_impl_t; | |
230 | ||
231 | /* Note: the dbuf hash table is exposed only for the mdb module */ | |
232 | #define DBUF_MUTEXES 256 | |
233 | #define DBUF_HASH_MUTEX(h, idx) (&(h)->hash_mutexes[(idx) & (DBUF_MUTEXES-1)]) | |
234 | typedef struct dbuf_hash_table { | |
235 | uint64_t hash_table_mask; | |
236 | dmu_buf_impl_t **hash_table; | |
237 | kmutex_t hash_mutexes[DBUF_MUTEXES]; | |
238 | } dbuf_hash_table_t; | |
239 | ||
240 | ||
241 | uint64_t dbuf_whichblock(struct dnode *di, uint64_t offset); | |
242 | ||
243 | dmu_buf_impl_t *dbuf_create_tlib(struct dnode *dn, char *data); | |
244 | void dbuf_create_bonus(struct dnode *dn); | |
245 | ||
246 | dmu_buf_impl_t *dbuf_hold(struct dnode *dn, uint64_t blkid, void *tag); | |
247 | dmu_buf_impl_t *dbuf_hold_level(struct dnode *dn, int level, uint64_t blkid, | |
248 | void *tag); | |
249 | int dbuf_hold_impl(struct dnode *dn, uint8_t level, uint64_t blkid, int create, | |
250 | void *tag, dmu_buf_impl_t **dbp); | |
251 | ||
252 | void dbuf_prefetch(struct dnode *dn, uint64_t blkid); | |
253 | ||
254 | void dbuf_add_ref(dmu_buf_impl_t *db, void *tag); | |
255 | uint64_t dbuf_refcount(dmu_buf_impl_t *db); | |
256 | ||
257 | void dbuf_rele(dmu_buf_impl_t *db, void *tag); | |
258 | ||
259 | dmu_buf_impl_t *dbuf_find(struct dnode *dn, uint8_t level, uint64_t blkid); | |
260 | ||
261 | int dbuf_read(dmu_buf_impl_t *db, zio_t *zio, uint32_t flags); | |
262 | void dbuf_will_dirty(dmu_buf_impl_t *db, dmu_tx_t *tx); | |
34dc7c2f | 263 | void dbuf_fill_done(dmu_buf_impl_t *db, dmu_tx_t *tx); |
b128c09f | 264 | void dmu_buf_will_not_fill(dmu_buf_t *db, dmu_tx_t *tx); |
34dc7c2f BB |
265 | void dmu_buf_will_fill(dmu_buf_t *db, dmu_tx_t *tx); |
266 | void dmu_buf_fill_done(dmu_buf_t *db, dmu_tx_t *tx); | |
9babb374 | 267 | void dbuf_assign_arcbuf(dmu_buf_impl_t *db, arc_buf_t *buf, dmu_tx_t *tx); |
34dc7c2f BB |
268 | dbuf_dirty_record_t *dbuf_dirty(dmu_buf_impl_t *db, dmu_tx_t *tx); |
269 | ||
270 | void dbuf_clear(dmu_buf_impl_t *db); | |
271 | void dbuf_evict(dmu_buf_impl_t *db); | |
272 | ||
273 | void dbuf_setdirty(dmu_buf_impl_t *db, dmu_tx_t *tx); | |
274 | void dbuf_unoverride(dbuf_dirty_record_t *dr); | |
275 | void dbuf_sync_list(list_t *list, dmu_tx_t *tx); | |
276 | ||
b128c09f | 277 | void dbuf_free_range(struct dnode *dn, uint64_t start, uint64_t end, |
34dc7c2f BB |
278 | struct dmu_tx *); |
279 | ||
280 | void dbuf_new_size(dmu_buf_impl_t *db, int size, dmu_tx_t *tx); | |
281 | ||
282 | void dbuf_init(void); | |
283 | void dbuf_fini(void); | |
284 | ||
b128c09f BB |
285 | #define DBUF_IS_METADATA(db) \ |
286 | ((db)->db_level > 0 || dmu_ot[(db)->db_dnode->dn_type].ot_metadata) | |
287 | ||
288 | #define DBUF_GET_BUFC_TYPE(db) \ | |
289 | (DBUF_IS_METADATA(db) ? ARC_BUFC_METADATA : ARC_BUFC_DATA) | |
290 | ||
291 | #define DBUF_IS_CACHEABLE(db) \ | |
292 | ((db)->db_objset->os_primary_cache == ZFS_CACHE_ALL || \ | |
293 | (DBUF_IS_METADATA(db) && \ | |
294 | ((db)->db_objset->os_primary_cache == ZFS_CACHE_METADATA))) | |
295 | ||
296 | #define DBUF_IS_L2CACHEABLE(db) \ | |
297 | ((db)->db_objset->os_secondary_cache == ZFS_CACHE_ALL || \ | |
298 | (DBUF_IS_METADATA(db) && \ | |
299 | ((db)->db_objset->os_secondary_cache == ZFS_CACHE_METADATA))) | |
34dc7c2f BB |
300 | |
301 | #ifdef ZFS_DEBUG | |
302 | ||
303 | /* | |
304 | * There should be a ## between the string literal and fmt, to make it | |
305 | * clear that we're joining two strings together, but gcc does not | |
306 | * support that preprocessor token. | |
307 | */ | |
308 | #define dprintf_dbuf(dbuf, fmt, ...) do { \ | |
309 | if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ | |
310 | char __db_buf[32]; \ | |
311 | uint64_t __db_obj = (dbuf)->db.db_object; \ | |
312 | if (__db_obj == DMU_META_DNODE_OBJECT) \ | |
313 | (void) strcpy(__db_buf, "mdn"); \ | |
314 | else \ | |
315 | (void) snprintf(__db_buf, sizeof (__db_buf), "%lld", \ | |
316 | (u_longlong_t)__db_obj); \ | |
317 | dprintf_ds((dbuf)->db_objset->os_dsl_dataset, \ | |
318 | "obj=%s lvl=%u blkid=%lld " fmt, \ | |
319 | __db_buf, (dbuf)->db_level, \ | |
320 | (u_longlong_t)(dbuf)->db_blkid, __VA_ARGS__); \ | |
321 | } \ | |
322 | _NOTE(CONSTCOND) } while (0) | |
323 | ||
324 | #define dprintf_dbuf_bp(db, bp, fmt, ...) do { \ | |
325 | if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ | |
326 | char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP); \ | |
327 | sprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, bp); \ | |
328 | dprintf_dbuf(db, fmt " %s\n", __VA_ARGS__, __blkbuf); \ | |
329 | kmem_free(__blkbuf, BP_SPRINTF_LEN); \ | |
330 | } \ | |
331 | _NOTE(CONSTCOND) } while (0) | |
332 | ||
333 | #define DBUF_VERIFY(db) dbuf_verify(db) | |
334 | ||
335 | #else | |
336 | ||
337 | #define dprintf_dbuf(db, fmt, ...) | |
338 | #define dprintf_dbuf_bp(db, bp, fmt, ...) | |
339 | #define DBUF_VERIFY(db) | |
340 | ||
341 | #endif | |
342 | ||
343 | ||
344 | #ifdef __cplusplus | |
345 | } | |
346 | #endif | |
347 | ||
348 | #endif /* _SYS_DBUF_H */ |