1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * CDDL HEADER START 4 * 5 * The contents of this file are subject to the terms of the 6 * Common Development and Distribution License (the "License"). 7 * You may not use this file except in compliance with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or https://opensource.org/licenses/CDDL-1.0. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright (c) 2012, 2017 by Delphix. All rights reserved. 25 * Copyright (c) 2017, 2019, Datto Inc. All rights reserved. 26 */ 27 28 #ifndef _SYS_DSL_SCAN_H 29 #define _SYS_DSL_SCAN_H 30 31 #include <sys/zfs_context.h> 32 #include <sys/zio.h> 33 #include <sys/zap.h> 34 #include <sys/ddt.h> 35 #include <sys/bplist.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 struct objset; 42 struct dsl_dir; 43 struct dsl_dataset; 44 struct dsl_pool; 45 struct dmu_tx; 46 47 extern int zfs_scan_suspend_progress; 48 49 /* 50 * All members of this structure must be uint64_t, for byteswap 51 * purposes. 52 */ 53 typedef struct dsl_scan_phys { 54 uint64_t scn_func; /* pool_scan_func_t */ 55 uint64_t scn_state; /* dsl_scan_state_t */ 56 uint64_t scn_queue_obj; 57 uint64_t scn_min_txg; 58 uint64_t scn_max_txg; 59 uint64_t scn_cur_min_txg; 60 uint64_t scn_cur_max_txg; 61 uint64_t scn_start_time; 62 uint64_t scn_end_time; 63 uint64_t scn_to_examine; /* total bytes to be scanned */ 64 uint64_t scn_examined; /* bytes scanned so far */ 65 uint64_t scn_skipped; /* bytes skipped by scanner */ 66 uint64_t scn_processed; 67 uint64_t scn_errors; /* scan I/O error count */ 68 uint64_t scn_ddt_class_max; 69 ddt_bookmark_t scn_ddt_bookmark; 70 zbookmark_phys_t scn_bookmark; 71 uint64_t scn_flags; /* dsl_scan_flags_t */ 72 } dsl_scan_phys_t; 73 74 #define SCAN_PHYS_NUMINTS (sizeof (dsl_scan_phys_t) / sizeof (uint64_t)) 75 76 typedef enum dsl_scan_flags { 77 DSF_VISIT_DS_AGAIN = 1<<0, 78 DSF_SCRUB_PAUSED = 1<<1, 79 } dsl_scan_flags_t; 80 81 #define DSL_SCAN_FLAGS_MASK (DSF_VISIT_DS_AGAIN) 82 83 typedef struct dsl_errorscrub_phys { 84 uint64_t dep_func; /* pool_scan_func_t */ 85 uint64_t dep_state; /* dsl_scan_state_t */ 86 uint64_t dep_cursor; /* serialized zap cursor for tracing progress */ 87 uint64_t dep_start_time; /* error scrub start time, unix timestamp */ 88 uint64_t dep_end_time; /* error scrub end time, unix timestamp */ 89 uint64_t dep_to_examine; /* total error blocks to be scrubbed */ 90 uint64_t dep_examined; /* blocks scrubbed so far */ 91 uint64_t dep_errors; /* error scrub I/O error count */ 92 uint64_t dep_paused_flags; /* flag for paused */ 93 } dsl_errorscrub_phys_t; 94 95 #define ERRORSCRUB_PHYS_NUMINTS (sizeof (dsl_errorscrub_phys_t) \ 96 / sizeof (uint64_t)) 97 98 /* 99 * Every pool will have one dsl_scan_t and this structure will contain 100 * in-memory information about the scan and a pointer to the on-disk 101 * representation (i.e. dsl_scan_phys_t). Most of the state of the scan 102 * is contained on-disk to allow the scan to resume in the event of a reboot 103 * or panic. This structure maintains information about the behavior of a 104 * running scan, some caching information, and how it should traverse the pool. 105 * 106 * The following members of this structure direct the behavior of the scan: 107 * 108 * scn_suspending - a scan that cannot be completed in a single txg or 109 * has exceeded its allotted time will need to suspend. 110 * When this flag is set the scanner will stop traversing 111 * the pool and write out the current state to disk. 112 * 113 * scn_restart_txg - directs the scanner to either restart or start a 114 * a scan at the specified txg value. 115 * 116 * scn_done_txg - when a scan completes its traversal it will set 117 * the completion txg to the next txg. This is necessary 118 * to ensure that any blocks that were freed during 119 * the scan but have not yet been processed (i.e deferred 120 * frees) are accounted for. 121 * 122 * This structure also maintains information about deferred frees which are 123 * a special kind of traversal. Deferred free can exist in either a bptree or 124 * a bpobj structure. The scn_is_bptree flag will indicate the type of 125 * deferred free that is in progress. If the deferred free is part of an 126 * asynchronous destroy then the scn_async_destroying flag will be set. 127 */ 128 typedef struct dsl_scan { 129 struct dsl_pool *scn_dp; 130 uint64_t scn_restart_txg; 131 uint64_t scn_done_txg; 132 uint64_t scn_sync_start_time; 133 uint64_t scn_issued_before_pass; 134 135 /* for freeing blocks */ 136 boolean_t scn_is_bptree; 137 boolean_t scn_async_destroying; 138 boolean_t scn_async_stalled; 139 uint64_t scn_async_block_min_time_ms; 140 141 /* flags and stats for controlling scan state */ 142 boolean_t scn_is_sorted; /* doing sequential scan */ 143 boolean_t scn_clearing; /* scan is issuing sequential extents */ 144 boolean_t scn_checkpointing; /* scan is issuing all queued extents */ 145 boolean_t scn_suspending; /* scan is suspending until next txg */ 146 uint64_t scn_last_checkpoint; /* time of last checkpoint */ 147 148 /* members for thread synchronization */ 149 zio_t *scn_zio_root; /* root zio for waiting on IO */ 150 taskq_t *scn_taskq; /* task queue for issuing extents */ 151 152 /* for controlling scan prefetch, protected by spa_scrub_lock */ 153 boolean_t scn_prefetch_stop; /* prefetch should stop */ 154 zbookmark_phys_t scn_prefetch_bookmark; /* prefetch start bookmark */ 155 avl_tree_t scn_prefetch_queue; /* priority queue of prefetch IOs */ 156 uint64_t scn_maxinflight_bytes; /* max bytes in flight for pool */ 157 158 /* per txg statistics */ 159 uint64_t scn_visited_this_txg; /* total bps visited this txg */ 160 uint64_t scn_dedup_frees_this_txg; /* dedup bps freed this txg */ 161 uint64_t scn_holes_this_txg; 162 uint64_t scn_lt_min_this_txg; 163 uint64_t scn_gt_max_this_txg; 164 uint64_t scn_ddt_contained_this_txg; 165 uint64_t scn_objsets_visited_this_txg; 166 uint64_t scn_avg_seg_size_this_txg; 167 uint64_t scn_segs_this_txg; 168 uint64_t scn_avg_zio_size_this_txg; 169 uint64_t scn_zios_this_txg; 170 171 /* zap cursor for tracing error scrub progress */ 172 zap_cursor_t errorscrub_cursor; 173 /* members needed for syncing scan status to disk */ 174 dsl_scan_phys_t scn_phys; /* on disk representation of scan */ 175 dsl_scan_phys_t scn_phys_cached; 176 avl_tree_t scn_queue; /* queue of datasets to scan */ 177 kmutex_t scn_queue_lock; /* serializes scn_queue inserts */ 178 uint64_t scn_queues_pending; /* outstanding data to issue */ 179 /* members needed for syncing error scrub status to disk */ 180 dsl_errorscrub_phys_t errorscrub_phys; 181 } dsl_scan_t; 182 183 typedef struct { 184 pool_scan_func_t func; 185 uint64_t txgstart; 186 uint64_t txgend; 187 } setup_sync_arg_t; 188 189 typedef struct dsl_scan_io_queue dsl_scan_io_queue_t; 190 191 void scan_init(void); 192 void scan_fini(void); 193 int dsl_scan_init(struct dsl_pool *dp, uint64_t txg); 194 int dsl_scan_setup_check(void *, dmu_tx_t *); 195 void dsl_scan_setup_sync(void *, dmu_tx_t *); 196 void dsl_scan_fini(struct dsl_pool *dp); 197 void dsl_scan_sync(struct dsl_pool *, dmu_tx_t *); 198 int dsl_scan_cancel(struct dsl_pool *); 199 int dsl_scan(struct dsl_pool *, pool_scan_func_t, uint64_t starttxg, 200 uint64_t txgend); 201 void dsl_scan_assess_vdev(struct dsl_pool *dp, vdev_t *vd); 202 boolean_t dsl_scan_scrubbing(const struct dsl_pool *dp); 203 boolean_t dsl_errorscrubbing(const struct dsl_pool *dp); 204 boolean_t dsl_errorscrub_active(dsl_scan_t *scn); 205 void dsl_scan_restart_resilver(struct dsl_pool *, uint64_t txg); 206 int dsl_scrub_set_pause_resume(const struct dsl_pool *dp, 207 pool_scrub_cmd_t cmd); 208 void dsl_errorscrub_sync(struct dsl_pool *, dmu_tx_t *); 209 boolean_t dsl_scan_resilvering(struct dsl_pool *dp); 210 boolean_t dsl_scan_resilver_scheduled(struct dsl_pool *dp); 211 boolean_t dsl_dataset_unstable(struct dsl_dataset *ds); 212 void dsl_scan_ddt_entry(dsl_scan_t *scn, enum zio_checksum checksum, 213 ddt_t *ddt, ddt_lightweight_entry_t *ddlwe, dmu_tx_t *tx); 214 void dsl_scan_ds_destroyed(struct dsl_dataset *ds, struct dmu_tx *tx); 215 void dsl_scan_ds_snapshotted(struct dsl_dataset *ds, struct dmu_tx *tx); 216 void dsl_scan_ds_clone_swapped(struct dsl_dataset *ds1, struct dsl_dataset *ds2, 217 struct dmu_tx *tx); 218 boolean_t dsl_scan_active(dsl_scan_t *scn); 219 boolean_t dsl_scan_is_paused_scrub(const dsl_scan_t *scn); 220 boolean_t dsl_errorscrub_is_paused(const dsl_scan_t *scn); 221 void dsl_scan_freed(spa_t *spa, const blkptr_t *bp); 222 void dsl_scan_io_queue_destroy(dsl_scan_io_queue_t *queue); 223 void dsl_scan_io_queue_vdev_xfer(vdev_t *svd, vdev_t *tvd); 224 225 #ifdef __cplusplus 226 } 227 #endif 228 229 #endif /* _SYS_DSL_SCAN_H */ 230