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) 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
24 * Copyright (c) 2017 Datto Inc.
27 #ifndef _SYS_DSL_SCAN_H
28 #define _SYS_DSL_SCAN_H
30 #include <sys/zfs_context.h>
33 #include <sys/bplist.h>
46 * All members of this structure must be uint64_t, for byteswap
49 typedef struct dsl_scan_phys
{
50 uint64_t scn_func
; /* pool_scan_func_t */
51 uint64_t scn_state
; /* dsl_scan_state_t */
52 uint64_t scn_queue_obj
;
55 uint64_t scn_cur_min_txg
;
56 uint64_t scn_cur_max_txg
;
57 uint64_t scn_start_time
;
58 uint64_t scn_end_time
;
59 uint64_t scn_to_examine
; /* total bytes to be scanned */
60 uint64_t scn_examined
; /* bytes scanned so far */
61 uint64_t scn_to_process
;
62 uint64_t scn_processed
;
63 uint64_t scn_errors
; /* scan I/O error count */
64 uint64_t scn_ddt_class_max
;
65 ddt_bookmark_t scn_ddt_bookmark
;
66 zbookmark_phys_t scn_bookmark
;
67 uint64_t scn_flags
; /* dsl_scan_flags_t */
70 #define SCAN_PHYS_NUMINTS (sizeof (dsl_scan_phys_t) / sizeof (uint64_t))
72 typedef enum dsl_scan_flags
{
73 DSF_VISIT_DS_AGAIN
= 1<<0,
74 DSF_SCRUB_PAUSED
= 1<<1,
77 #define DSL_SCAN_FLAGS_MASK (DSF_VISIT_DS_AGAIN)
80 * Every pool will have one dsl_scan_t and this structure will contain
81 * in-memory information about the scan and a pointer to the on-disk
82 * representation (i.e. dsl_scan_phys_t). Most of the state of the scan
83 * is contained on-disk to allow the scan to resume in the event of a reboot
84 * or panic. This structure maintains information about the behavior of a
85 * running scan, some caching information, and how it should traverse the pool.
87 * The following members of this structure direct the behavior of the scan:
89 * scn_suspending - a scan that cannot be completed in a single txg or
90 * has exceeded its allotted time will need to suspend.
91 * When this flag is set the scanner will stop traversing
92 * the pool and write out the current state to disk.
94 * scn_restart_txg - directs the scanner to either restart or start a
95 * a scan at the specified txg value.
97 * scn_done_txg - when a scan completes its traversal it will set
98 * the completion txg to the next txg. This is necessary
99 * to ensure that any blocks that were freed during
100 * the scan but have not yet been processed (i.e deferred
101 * frees) are accounted for.
103 * This structure also maintains information about deferred frees which are
104 * a special kind of traversal. Deferred free can exist in either a bptree or
105 * a bpobj structure. The scn_is_bptree flag will indicate the type of
106 * deferred free that is in progress. If the deferred free is part of an
107 * asynchronous destroy then the scn_async_destroying flag will be set.
109 typedef struct dsl_scan
{
110 struct dsl_pool
*scn_dp
;
112 boolean_t scn_suspending
;
113 uint64_t scn_restart_txg
;
114 uint64_t scn_done_txg
;
115 uint64_t scn_sync_start_time
;
118 /* for freeing blocks */
119 boolean_t scn_is_bptree
;
120 boolean_t scn_async_destroying
;
121 boolean_t scn_async_stalled
;
122 uint64_t scn_visited_this_txg
;
124 dsl_scan_phys_t scn_phys
;
127 int dsl_scan_init(struct dsl_pool
*dp
, uint64_t txg
);
128 void dsl_scan_fini(struct dsl_pool
*dp
);
129 void dsl_scan_sync(struct dsl_pool
*, dmu_tx_t
*);
130 int dsl_scan_cancel(struct dsl_pool
*);
131 int dsl_scan(struct dsl_pool
*, pool_scan_func_t
);
132 boolean_t
dsl_scan_scrubbing(const struct dsl_pool
*dp
);
133 int dsl_scrub_set_pause_resume(const struct dsl_pool
*dp
, pool_scrub_cmd_t cmd
);
134 void dsl_resilver_restart(struct dsl_pool
*, uint64_t txg
);
135 boolean_t
dsl_scan_resilvering(struct dsl_pool
*dp
);
136 boolean_t
dsl_dataset_unstable(struct dsl_dataset
*ds
);
137 void dsl_scan_ddt_entry(dsl_scan_t
*scn
, enum zio_checksum checksum
,
138 ddt_entry_t
*dde
, dmu_tx_t
*tx
);
139 void dsl_scan_ds_destroyed(struct dsl_dataset
*ds
, struct dmu_tx
*tx
);
140 void dsl_scan_ds_snapshotted(struct dsl_dataset
*ds
, struct dmu_tx
*tx
);
141 void dsl_scan_ds_clone_swapped(struct dsl_dataset
*ds1
, struct dsl_dataset
*ds2
,
143 boolean_t
dsl_scan_active(dsl_scan_t
*scn
);
144 boolean_t
dsl_scan_is_paused_scrub(const dsl_scan_t
*scn
);
150 #endif /* _SYS_DSL_SCAN_H */