dmu_traverse.h revision 290756 
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
24 */
25
26#ifndef	_SYS_DMU_TRAVERSE_H
27#define	_SYS_DMU_TRAVERSE_H
28
29#include <sys/zfs_context.h>
30#include <sys/spa.h>
31#include <sys/zio.h>
32
33#ifdef	__cplusplus
34extern "C" {
35#endif
36
37struct dnode_phys;
38struct dsl_dataset;
39struct zilog;
40struct arc_buf;
41
42typedef int (blkptr_cb_t)(spa_t *spa, zilog_t *zilog, const blkptr_t *bp,
43    const zbookmark_phys_t *zb, const struct dnode_phys *dnp, void *arg);
44
45#define	TRAVERSE_PRE			(1<<0)
46#define	TRAVERSE_POST			(1<<1)
47#define	TRAVERSE_PREFETCH_METADATA	(1<<2)
48#define	TRAVERSE_PREFETCH_DATA		(1<<3)
49#define	TRAVERSE_PREFETCH (TRAVERSE_PREFETCH_METADATA | TRAVERSE_PREFETCH_DATA)
50#define	TRAVERSE_HARD			(1<<4)
51
52/* Special traverse error return value to indicate skipping of children */
53#define	TRAVERSE_VISIT_NO_CHILDREN	-1
54
55int traverse_dataset(struct dsl_dataset *ds,
56    uint64_t txg_start, int flags, blkptr_cb_t func, void *arg);
57int traverse_dataset_resume(struct dsl_dataset *ds, uint64_t txg_start,
58    zbookmark_phys_t *resume, int flags, blkptr_cb_t func, void *arg);
59int traverse_dataset_destroyed(spa_t *spa, blkptr_t *blkptr,
60    uint64_t txg_start, zbookmark_phys_t *resume, int flags,
61    blkptr_cb_t func, void *arg);
62int traverse_pool(spa_t *spa,
63    uint64_t txg_start, int flags, blkptr_cb_t func, void *arg);
64
65#ifdef	__cplusplus
66}
67#endif
68
69#endif /* _SYS_DMU_TRAVERSE_H */
70