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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2013 by Delphix. All rights reserved.
26 #include <sys/zfs_context.h>
27 #include <sys/dmu_objset.h>
28 #include <sys/dmu_traverse.h>
29 #include <sys/dsl_dataset.h>
30 #include <sys/dsl_dir.h>
31 #include <sys/dsl_pool.h>
32 #include <sys/dnode.h>
35 #include <sys/dmu_impl.h>
37 #include <sys/sa_impl.h>
38 #include <sys/callb.h>
39 #include <sys/zfeature.h>
41 int zfs_pd_blks_max
= 100;
43 typedef struct prefetch_data
{
53 typedef struct traverse_data
{
58 zbookmark_t
*td_resume
;
60 prefetch_data_t
*td_pfd
;
65 #define TD_HARD(td) (td->td_flags & TRAVERSE_HARD)
67 static int traverse_dnode(traverse_data_t
*td
, const dnode_phys_t
*dnp
,
68 uint64_t objset
, uint64_t object
);
69 static void prefetch_dnode_metadata(traverse_data_t
*td
, const dnode_phys_t
*,
70 uint64_t objset
, uint64_t object
);
73 traverse_zil_block(zilog_t
*zilog
, blkptr_t
*bp
, void *arg
, uint64_t claim_txg
)
75 traverse_data_t
*td
= arg
;
81 if (claim_txg
== 0 && bp
->blk_birth
>= spa_first_txg(td
->td_spa
))
84 SET_BOOKMARK(&zb
, td
->td_objset
, ZB_ZIL_OBJECT
, ZB_ZIL_LEVEL
,
85 bp
->blk_cksum
.zc_word
[ZIL_ZC_SEQ
]);
87 (void) td
->td_func(td
->td_spa
, zilog
, bp
, &zb
, NULL
, td
->td_arg
);
93 traverse_zil_record(zilog_t
*zilog
, lr_t
*lrc
, void *arg
, uint64_t claim_txg
)
95 traverse_data_t
*td
= arg
;
97 if (lrc
->lrc_txtype
== TX_WRITE
) {
98 lr_write_t
*lr
= (lr_write_t
*)lrc
;
99 blkptr_t
*bp
= &lr
->lr_blkptr
;
105 if (claim_txg
== 0 || bp
->blk_birth
< claim_txg
)
108 SET_BOOKMARK(&zb
, td
->td_objset
, lr
->lr_foid
,
109 ZB_ZIL_LEVEL
, lr
->lr_offset
/ BP_GET_LSIZE(bp
));
111 (void) td
->td_func(td
->td_spa
, zilog
, bp
, &zb
, NULL
,
118 traverse_zil(traverse_data_t
*td
, zil_header_t
*zh
)
120 uint64_t claim_txg
= zh
->zh_claim_txg
;
124 * We only want to visit blocks that have been claimed but not yet
125 * replayed; plus, in read-only mode, blocks that are already stable.
127 if (claim_txg
== 0 && spa_writeable(td
->td_spa
))
130 zilog
= zil_alloc(spa_get_dsl(td
->td_spa
)->dp_meta_objset
, zh
);
132 (void) zil_parse(zilog
, traverse_zil_block
, traverse_zil_record
, td
,
138 typedef enum resume_skip
{
145 * Returns RESUME_SKIP_ALL if td indicates that we are resuming a traversal and
146 * the block indicated by zb does not need to be visited at all. Returns
147 * RESUME_SKIP_CHILDREN if we are resuming a post traversal and we reach the
148 * resume point. This indicates that this block should be visited but not its
149 * children (since they must have been visited in a previous traversal).
150 * Otherwise returns RESUME_SKIP_NONE.
153 resume_skip_check(traverse_data_t
*td
, const dnode_phys_t
*dnp
,
154 const zbookmark_t
*zb
)
156 if (td
->td_resume
!= NULL
&& !ZB_IS_ZERO(td
->td_resume
)) {
158 * If we already visited this bp & everything below,
159 * don't bother doing it again.
161 if (zbookmark_is_before(dnp
, zb
, td
->td_resume
))
162 return (RESUME_SKIP_ALL
);
165 * If we found the block we're trying to resume from, zero
166 * the bookmark out to indicate that we have resumed.
168 ASSERT3U(zb
->zb_object
, <=, td
->td_resume
->zb_object
);
169 if (bcmp(zb
, td
->td_resume
, sizeof (*zb
)) == 0) {
170 bzero(td
->td_resume
, sizeof (*zb
));
171 if (td
->td_flags
& TRAVERSE_POST
)
172 return (RESUME_SKIP_CHILDREN
);
175 return (RESUME_SKIP_NONE
);
179 traverse_pause(traverse_data_t
*td
, const zbookmark_t
*zb
)
181 ASSERT(td
->td_resume
!= NULL
);
182 ASSERT0(zb
->zb_level
);
183 bcopy(zb
, td
->td_resume
, sizeof (*td
->td_resume
));
187 traverse_prefetch_metadata(traverse_data_t
*td
,
188 const blkptr_t
*bp
, const zbookmark_t
*zb
)
190 uint32_t flags
= ARC_NOWAIT
| ARC_PREFETCH
;
192 if (!(td
->td_flags
& TRAVERSE_PREFETCH_METADATA
))
195 * If we are in the process of resuming, don't prefetch, because
196 * some children will not be needed (and in fact may have already
199 if (td
->td_resume
!= NULL
&& !ZB_IS_ZERO(td
->td_resume
))
201 if (BP_IS_HOLE(bp
) || bp
->blk_birth
<= td
->td_min_txg
)
203 if (BP_GET_LEVEL(bp
) == 0 && BP_GET_TYPE(bp
) != DMU_OT_DNODE
)
206 (void) arc_read(NULL
, td
->td_spa
, bp
, NULL
, NULL
,
207 ZIO_PRIORITY_ASYNC_READ
, ZIO_FLAG_CANFAIL
, &flags
, zb
);
211 traverse_visitbp(traverse_data_t
*td
, const dnode_phys_t
*dnp
,
212 const blkptr_t
*bp
, const zbookmark_t
*zb
)
214 int err
= 0, lasterr
= 0;
215 arc_buf_t
*buf
= NULL
;
216 boolean_t pause
= B_FALSE
;
218 switch (resume_skip_check(td
, dnp
, zb
)) {
219 case RESUME_SKIP_ALL
:
221 case RESUME_SKIP_CHILDREN
:
223 case RESUME_SKIP_NONE
:
229 if (bp
->blk_birth
== 0) {
230 if (spa_feature_is_active(td
->td_spa
, SPA_FEATURE_HOLE_BIRTH
)) {
232 * Since this block has a birth time of 0 it must be a
233 * hole created before the SPA_FEATURE_HOLE_BIRTH
234 * feature was enabled. If SPA_FEATURE_HOLE_BIRTH
235 * was enabled before the min_txg for this traveral we
236 * know the hole must have been created before the
237 * min_txg for this traveral, so we can skip it. If
238 * SPA_FEATURE_HOLE_BIRTH was enabled after the min_txg
239 * for this traveral we cannot tell if the hole was
240 * created before or after the min_txg for this
241 * traversal, so we cannot skip it.
243 uint64_t hole_birth_enabled_txg
;
244 VERIFY(spa_feature_enabled_txg(td
->td_spa
,
245 SPA_FEATURE_HOLE_BIRTH
, &hole_birth_enabled_txg
));
246 if (hole_birth_enabled_txg
< td
->td_min_txg
)
249 } else if (bp
->blk_birth
<= td
->td_min_txg
) {
253 if (BP_IS_HOLE(bp
)) {
254 err
= td
->td_func(td
->td_spa
, NULL
, bp
, zb
, dnp
, td
->td_arg
);
258 if (td
->td_pfd
&& !td
->td_pfd
->pd_exited
&&
259 ((td
->td_pfd
->pd_flags
& TRAVERSE_PREFETCH_DATA
) ||
260 BP_GET_TYPE(bp
) == DMU_OT_DNODE
|| BP_GET_LEVEL(bp
) > 0)) {
261 mutex_enter(&td
->td_pfd
->pd_mtx
);
262 ASSERT(td
->td_pfd
->pd_blks_fetched
>= 0);
263 while (td
->td_pfd
->pd_blks_fetched
== 0 &&
264 !td
->td_pfd
->pd_exited
)
265 cv_wait(&td
->td_pfd
->pd_cv
, &td
->td_pfd
->pd_mtx
);
266 td
->td_pfd
->pd_blks_fetched
--;
267 cv_broadcast(&td
->td_pfd
->pd_cv
);
268 mutex_exit(&td
->td_pfd
->pd_mtx
);
271 if (td
->td_flags
& TRAVERSE_PRE
) {
272 err
= td
->td_func(td
->td_spa
, NULL
, bp
, zb
, dnp
,
274 if (err
== TRAVERSE_VISIT_NO_CHILDREN
)
277 pause
= B_TRUE
; /* handle pausing at a common point */
282 if (BP_GET_LEVEL(bp
) > 0) {
283 uint32_t flags
= ARC_WAIT
;
285 int32_t epb
= BP_GET_LSIZE(bp
) >> SPA_BLKPTRSHIFT
;
288 err
= arc_read(NULL
, td
->td_spa
, bp
, arc_getbuf_func
, &buf
,
289 ZIO_PRIORITY_ASYNC_READ
, ZIO_FLAG_CANFAIL
, &flags
, zb
);
293 czb
= kmem_alloc(sizeof (zbookmark_t
), KM_PUSHPAGE
);
295 for (i
= 0; i
< epb
; i
++) {
296 SET_BOOKMARK(czb
, zb
->zb_objset
, zb
->zb_object
,
298 zb
->zb_blkid
* epb
+ i
);
299 traverse_prefetch_metadata(td
,
300 &((blkptr_t
*)buf
->b_data
)[i
], czb
);
303 /* recursively visitbp() blocks below this */
304 for (i
= 0; i
< epb
; i
++) {
305 SET_BOOKMARK(czb
, zb
->zb_objset
, zb
->zb_object
,
307 zb
->zb_blkid
* epb
+ i
);
308 err
= traverse_visitbp(td
, dnp
,
309 &((blkptr_t
*)buf
->b_data
)[i
], czb
);
317 kmem_free(czb
, sizeof (zbookmark_t
));
319 } else if (BP_GET_TYPE(bp
) == DMU_OT_DNODE
) {
320 uint32_t flags
= ARC_WAIT
;
322 int32_t epb
= BP_GET_LSIZE(bp
) >> DNODE_SHIFT
;
324 err
= arc_read(NULL
, td
->td_spa
, bp
, arc_getbuf_func
, &buf
,
325 ZIO_PRIORITY_ASYNC_READ
, ZIO_FLAG_CANFAIL
, &flags
, zb
);
330 for (i
= 0; i
< epb
; i
++) {
331 prefetch_dnode_metadata(td
, &dnp
[i
], zb
->zb_objset
,
332 zb
->zb_blkid
* epb
+ i
);
335 /* recursively visitbp() blocks below this */
336 for (i
= 0; i
< epb
; i
++) {
337 err
= traverse_dnode(td
, &dnp
[i
], zb
->zb_objset
,
338 zb
->zb_blkid
* epb
+ i
);
345 } else if (BP_GET_TYPE(bp
) == DMU_OT_OBJSET
) {
346 uint32_t flags
= ARC_WAIT
;
350 err
= arc_read(NULL
, td
->td_spa
, bp
, arc_getbuf_func
, &buf
,
351 ZIO_PRIORITY_ASYNC_READ
, ZIO_FLAG_CANFAIL
, &flags
, zb
);
356 dnp
= &osp
->os_meta_dnode
;
357 prefetch_dnode_metadata(td
, dnp
, zb
->zb_objset
,
358 DMU_META_DNODE_OBJECT
);
359 if (arc_buf_size(buf
) >= sizeof (objset_phys_t
)) {
360 prefetch_dnode_metadata(td
, &osp
->os_groupused_dnode
,
361 zb
->zb_objset
, DMU_GROUPUSED_OBJECT
);
362 prefetch_dnode_metadata(td
, &osp
->os_userused_dnode
,
363 zb
->zb_objset
, DMU_USERUSED_OBJECT
);
366 err
= traverse_dnode(td
, dnp
, zb
->zb_objset
,
367 DMU_META_DNODE_OBJECT
);
368 if (err
&& TD_HARD(td
)) {
372 if (err
== 0 && arc_buf_size(buf
) >= sizeof (objset_phys_t
)) {
373 dnp
= &osp
->os_groupused_dnode
;
374 err
= traverse_dnode(td
, dnp
, zb
->zb_objset
,
375 DMU_GROUPUSED_OBJECT
);
377 if (err
&& TD_HARD(td
)) {
381 if (err
== 0 && arc_buf_size(buf
) >= sizeof (objset_phys_t
)) {
382 dnp
= &osp
->os_userused_dnode
;
383 err
= traverse_dnode(td
, dnp
, zb
->zb_objset
,
384 DMU_USERUSED_OBJECT
);
389 (void) arc_buf_remove_ref(buf
, &buf
);
392 if (err
== 0 && (td
->td_flags
& TRAVERSE_POST
)) {
393 err
= td
->td_func(td
->td_spa
, NULL
, bp
, zb
, dnp
, td
->td_arg
);
398 if (pause
&& td
->td_resume
!= NULL
) {
399 ASSERT3U(err
, ==, ERESTART
);
400 ASSERT(!TD_HARD(td
));
401 traverse_pause(td
, zb
);
404 return (err
!= 0 ? err
: lasterr
);
408 prefetch_dnode_metadata(traverse_data_t
*td
, const dnode_phys_t
*dnp
,
409 uint64_t objset
, uint64_t object
)
414 for (j
= 0; j
< dnp
->dn_nblkptr
; j
++) {
415 SET_BOOKMARK(&czb
, objset
, object
, dnp
->dn_nlevels
- 1, j
);
416 traverse_prefetch_metadata(td
, &dnp
->dn_blkptr
[j
], &czb
);
419 if (dnp
->dn_flags
& DNODE_FLAG_SPILL_BLKPTR
) {
420 SET_BOOKMARK(&czb
, objset
, object
, 0, DMU_SPILL_BLKID
);
421 traverse_prefetch_metadata(td
, &dnp
->dn_spill
, &czb
);
426 traverse_dnode(traverse_data_t
*td
, const dnode_phys_t
*dnp
,
427 uint64_t objset
, uint64_t object
)
429 int j
, err
= 0, lasterr
= 0;
432 for (j
= 0; j
< dnp
->dn_nblkptr
; j
++) {
433 SET_BOOKMARK(&czb
, objset
, object
, dnp
->dn_nlevels
- 1, j
);
434 err
= traverse_visitbp(td
, dnp
, &dnp
->dn_blkptr
[j
], &czb
);
442 if (dnp
->dn_flags
& DNODE_FLAG_SPILL_BLKPTR
) {
443 SET_BOOKMARK(&czb
, objset
, object
, 0, DMU_SPILL_BLKID
);
444 err
= traverse_visitbp(td
, dnp
, &dnp
->dn_spill
, &czb
);
451 return (err
!= 0 ? err
: lasterr
);
456 traverse_prefetcher(spa_t
*spa
, zilog_t
*zilog
, const blkptr_t
*bp
,
457 const zbookmark_t
*zb
, const dnode_phys_t
*dnp
, void *arg
)
459 prefetch_data_t
*pfd
= arg
;
460 uint32_t aflags
= ARC_NOWAIT
| ARC_PREFETCH
;
462 ASSERT(pfd
->pd_blks_fetched
>= 0);
464 return (SET_ERROR(EINTR
));
466 if (BP_IS_HOLE(bp
) || BP_IS_EMBEDDED(bp
) ||
467 !((pfd
->pd_flags
& TRAVERSE_PREFETCH_DATA
) ||
468 BP_GET_TYPE(bp
) == DMU_OT_DNODE
|| BP_GET_LEVEL(bp
) > 0) ||
469 BP_GET_TYPE(bp
) == DMU_OT_INTENT_LOG
)
472 mutex_enter(&pfd
->pd_mtx
);
473 while (!pfd
->pd_cancel
&& pfd
->pd_blks_fetched
>= pfd
->pd_blks_max
)
474 cv_wait(&pfd
->pd_cv
, &pfd
->pd_mtx
);
475 pfd
->pd_blks_fetched
++;
476 cv_broadcast(&pfd
->pd_cv
);
477 mutex_exit(&pfd
->pd_mtx
);
479 (void) arc_read(NULL
, spa
, bp
, NULL
, NULL
, ZIO_PRIORITY_ASYNC_READ
,
480 ZIO_FLAG_CANFAIL
| ZIO_FLAG_SPECULATIVE
, &aflags
, zb
);
486 traverse_prefetch_thread(void *arg
)
488 traverse_data_t
*td_main
= arg
;
489 traverse_data_t td
= *td_main
;
492 td
.td_func
= traverse_prefetcher
;
493 td
.td_arg
= td_main
->td_pfd
;
496 SET_BOOKMARK(&czb
, td
.td_objset
,
497 ZB_ROOT_OBJECT
, ZB_ROOT_LEVEL
, ZB_ROOT_BLKID
);
498 (void) traverse_visitbp(&td
, NULL
, td
.td_rootbp
, &czb
);
500 mutex_enter(&td_main
->td_pfd
->pd_mtx
);
501 td_main
->td_pfd
->pd_exited
= B_TRUE
;
502 cv_broadcast(&td_main
->td_pfd
->pd_cv
);
503 mutex_exit(&td_main
->td_pfd
->pd_mtx
);
507 * NB: dataset must not be changing on-disk (eg, is a snapshot or we are
508 * in syncing context).
511 traverse_impl(spa_t
*spa
, dsl_dataset_t
*ds
, uint64_t objset
, blkptr_t
*rootbp
,
512 uint64_t txg_start
, zbookmark_t
*resume
, int flags
,
513 blkptr_cb_t func
, void *arg
)
520 ASSERT(ds
== NULL
|| objset
== ds
->ds_object
);
521 ASSERT(!(flags
& TRAVERSE_PRE
) || !(flags
& TRAVERSE_POST
));
524 * The data prefetching mechanism (the prefetch thread) is incompatible
525 * with resuming from a bookmark.
527 ASSERT(resume
== NULL
|| !(flags
& TRAVERSE_PREFETCH_DATA
));
529 td
= kmem_alloc(sizeof (traverse_data_t
), KM_PUSHPAGE
);
530 pd
= kmem_zalloc(sizeof (prefetch_data_t
), KM_PUSHPAGE
);
531 czb
= kmem_alloc(sizeof (zbookmark_t
), KM_PUSHPAGE
);
534 td
->td_objset
= objset
;
535 td
->td_rootbp
= rootbp
;
536 td
->td_min_txg
= txg_start
;
537 td
->td_resume
= resume
;
541 td
->td_flags
= flags
;
543 pd
->pd_blks_max
= zfs_pd_blks_max
;
544 pd
->pd_flags
= flags
;
545 mutex_init(&pd
->pd_mtx
, NULL
, MUTEX_DEFAULT
, NULL
);
546 cv_init(&pd
->pd_cv
, NULL
, CV_DEFAULT
, NULL
);
548 SET_BOOKMARK(czb
, td
->td_objset
,
549 ZB_ROOT_OBJECT
, ZB_ROOT_LEVEL
, ZB_ROOT_BLKID
);
551 /* See comment on ZIL traversal in dsl_scan_visitds. */
552 if (ds
!= NULL
&& !dsl_dataset_is_snapshot(ds
) && !BP_IS_HOLE(rootbp
)) {
553 uint32_t flags
= ARC_WAIT
;
557 err
= arc_read(NULL
, td
->td_spa
, rootbp
,
558 arc_getbuf_func
, &buf
,
559 ZIO_PRIORITY_ASYNC_READ
, ZIO_FLAG_CANFAIL
, &flags
, czb
);
564 traverse_zil(td
, &osp
->os_zil_header
);
565 (void) arc_buf_remove_ref(buf
, &buf
);
568 if (!(flags
& TRAVERSE_PREFETCH_DATA
) ||
569 0 == taskq_dispatch(system_taskq
, traverse_prefetch_thread
,
571 pd
->pd_exited
= B_TRUE
;
573 err
= traverse_visitbp(td
, NULL
, rootbp
, czb
);
575 mutex_enter(&pd
->pd_mtx
);
576 pd
->pd_cancel
= B_TRUE
;
577 cv_broadcast(&pd
->pd_cv
);
578 while (!pd
->pd_exited
)
579 cv_wait(&pd
->pd_cv
, &pd
->pd_mtx
);
580 mutex_exit(&pd
->pd_mtx
);
582 mutex_destroy(&pd
->pd_mtx
);
583 cv_destroy(&pd
->pd_cv
);
585 kmem_free(czb
, sizeof (zbookmark_t
));
586 kmem_free(pd
, sizeof (struct prefetch_data
));
587 kmem_free(td
, sizeof (struct traverse_data
));
593 * NB: dataset must not be changing on-disk (eg, is a snapshot or we are
594 * in syncing context).
597 traverse_dataset(dsl_dataset_t
*ds
, uint64_t txg_start
, int flags
,
598 blkptr_cb_t func
, void *arg
)
600 return (traverse_impl(ds
->ds_dir
->dd_pool
->dp_spa
, ds
, ds
->ds_object
,
601 &ds
->ds_phys
->ds_bp
, txg_start
, NULL
, flags
, func
, arg
));
605 traverse_dataset_destroyed(spa_t
*spa
, blkptr_t
*blkptr
,
606 uint64_t txg_start
, zbookmark_t
*resume
, int flags
,
607 blkptr_cb_t func
, void *arg
)
609 return (traverse_impl(spa
, NULL
, ZB_DESTROYED_OBJSET
,
610 blkptr
, txg_start
, resume
, flags
, func
, arg
));
614 * NB: pool must not be changing on-disk (eg, from zdb or sync context).
617 traverse_pool(spa_t
*spa
, uint64_t txg_start
, int flags
,
618 blkptr_cb_t func
, void *arg
)
620 int err
, lasterr
= 0;
622 dsl_pool_t
*dp
= spa_get_dsl(spa
);
623 objset_t
*mos
= dp
->dp_meta_objset
;
624 boolean_t hard
= (flags
& TRAVERSE_HARD
);
627 err
= traverse_impl(spa
, NULL
, 0, spa_get_rootblkptr(spa
),
628 txg_start
, NULL
, flags
, func
, arg
);
632 /* visit each dataset */
633 for (obj
= 1; err
== 0 || (err
!= ESRCH
&& hard
);
634 err
= dmu_object_next(mos
, &obj
, FALSE
, txg_start
)) {
635 dmu_object_info_t doi
;
637 err
= dmu_object_info(mos
, obj
, &doi
);
645 if (doi
.doi_bonus_type
== DMU_OT_DSL_DATASET
) {
647 uint64_t txg
= txg_start
;
649 dsl_pool_config_enter(dp
, FTAG
);
650 err
= dsl_dataset_hold_obj(dp
, obj
, FTAG
, &ds
);
651 dsl_pool_config_exit(dp
, FTAG
);
658 if (ds
->ds_phys
->ds_prev_snap_txg
> txg
)
659 txg
= ds
->ds_phys
->ds_prev_snap_txg
;
660 err
= traverse_dataset(ds
, txg
, flags
, func
, arg
);
661 dsl_dataset_rele(ds
, FTAG
);
671 return (err
!= 0 ? err
: lasterr
);
674 #if defined(_KERNEL) && defined(HAVE_SPL)
675 EXPORT_SYMBOL(traverse_dataset
);
676 EXPORT_SYMBOL(traverse_pool
);
678 module_param(zfs_pd_blks_max
, int, 0644);
679 MODULE_PARM_DESC(zfs_pd_blks_max
, "Max number of blocks to prefetch");