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