include/sys/dmu_traverse.h

   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 https://opensource.org/licenses/CDDL-1.0.
  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, 2018 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
  34 extern "C" {
  35 #endif
  36
  37 struct dnode_phys;
  38 struct dsl_dataset;
  39 struct zilog;
  40 struct arc_buf;
  41
  42 typedef 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 /*
  53  * Encrypted dnode blocks have encrypted bonus buffers while the rest
  54  * of the dnode is left unencrypted. Callers can specify the
  55  * TRAVERSE_NO_DECRYPT flag to indicate to the traversal code that
  56  * they wish to receive the raw encrypted dnodes instead of attempting
  57  * to read the logical data.
  58  */
  59 #define TRAVERSE_NO_DECRYPT             (1<<5)
  60
  61 /* Special traverse error return value to indicate skipping of children */
  62 #define TRAVERSE_VISIT_NO_CHILDREN      -1
  63
  64 int traverse_dataset(struct dsl_dataset *ds,
  65     uint64_t txg_start, int flags, blkptr_cb_t func, void *arg);
  66 int traverse_dataset_resume(struct dsl_dataset *ds, uint64_t txg_start,
  67     zbookmark_phys_t *resume, int flags, blkptr_cb_t func, void *arg);
  68 int traverse_dataset_destroyed(spa_t *spa, blkptr_t *blkptr,
  69     uint64_t txg_start, zbookmark_phys_t *resume, int flags,
  70     blkptr_cb_t func, void *arg);
  71 int traverse_pool(spa_t *spa,
  72     uint64_t txg_start, int flags, blkptr_cb_t func, void *arg);
  73
  74 /*
  75  * Note that this calculation cannot overflow with the current maximum indirect
  76  * block size (128k).  If that maximum is increased to 1M, however, this
  77  * calculation can overflow, and handling would need to be added to ensure
  78  * continued correctness.
  79  */
  80 static inline uint64_t
  81 bp_span_in_blocks(uint8_t indblkshift, uint64_t level)
  82 {
  83         unsigned int shift = level * (indblkshift - SPA_BLKPTRSHIFT);
  84         ASSERT3U(shift, <, 64);
  85         return (1ULL << shift);
  86 }
  87
  88 #ifdef  __cplusplus
  89 }
  90 #endif
  91
  92 #endif /* _SYS_DMU_TRAVERSE_H */