1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "ftl_core.h" 7 #include "ftl_mngt.h" 8 #include "ftl_mngt_steps.h" 9 10 static const struct ftl_mngt_process_desc desc_startup; 11 static const struct ftl_mngt_process_desc desc_first_start; 12 13 static void 14 ftl_mngt_select_startup_mode(struct spdk_ftl_dev *dev, 15 struct ftl_mngt_process *mngt) 16 { 17 if (dev->conf.mode & SPDK_FTL_MODE_CREATE) { 18 ftl_mngt_call_process(mngt, &desc_first_start); 19 } else { 20 ftl_mngt_fail_step(mngt); 21 } 22 } 23 24 /* 25 * Common startup steps required by FTL in all cases (creation, load, dirty shutdown recovery). 26 * Includes actions like opening the devices, calculating the expected size and version of metadata, etc. 27 */ 28 static const struct ftl_mngt_process_desc desc_startup = { 29 .name = "FTL startup", 30 .steps = { 31 { 32 .name = "Check configuration", 33 .action = ftl_mngt_check_conf, 34 }, 35 { 36 .name = "Open base bdev", 37 .action = ftl_mngt_open_base_bdev, 38 .cleanup = ftl_mngt_close_base_bdev 39 }, 40 { 41 .name = "Open cache bdev", 42 .action = ftl_mngt_open_cache_bdev, 43 .cleanup = ftl_mngt_close_cache_bdev 44 }, 45 #ifdef SPDK_FTL_VSS_EMU 46 { 47 .name = "Initialize VSS emu", 48 .action = ftl_mngt_md_init_vss_emu, 49 .cleanup = ftl_mngt_md_deinit_vss_emu 50 }, 51 #endif 52 { 53 .name = "Initialize superblock", 54 .action = ftl_mngt_superblock_init, 55 .cleanup = ftl_mngt_superblock_deinit 56 }, 57 { 58 .name = "Initialize memory pools", 59 .action = ftl_mngt_init_mem_pools, 60 .cleanup = ftl_mngt_deinit_mem_pools 61 }, 62 { 63 .name = "Initialize bands", 64 .action = ftl_mngt_init_bands, 65 .cleanup = ftl_mngt_deinit_bands 66 }, 67 { 68 .name = "Register IO device", 69 .action = ftl_mngt_register_io_device, 70 .cleanup = ftl_mngt_unregister_io_device 71 }, 72 { 73 .name = "Initialize core IO channel", 74 .action = ftl_mngt_init_io_channel, 75 .cleanup = ftl_mngt_deinit_io_channel 76 }, 77 { 78 .name = "Decorate bands", 79 .action = ftl_mngt_decorate_bands 80 }, 81 { 82 .name = "Initialize layout", 83 .action = ftl_mngt_init_layout 84 }, 85 { 86 .name = "Initialize metadata", 87 .action = ftl_mngt_init_md, 88 .cleanup = ftl_mngt_deinit_md 89 }, 90 { 91 .name = "Initialize NV cache", 92 .action = ftl_mngt_init_nv_cache, 93 .cleanup = ftl_mngt_deinit_nv_cache 94 }, 95 { 96 .name = "Initialize bands metadata", 97 .action = ftl_mngt_init_bands_md 98 }, 99 { 100 .name = "Select startup mode", 101 .action = ftl_mngt_select_startup_mode 102 }, 103 {} 104 } 105 }; 106 107 /* 108 * Steps executed when creating FTL for the first time - most important being scrubbing 109 * old data/metadata (so it's not leaked during dirty shutdown recovery) and laying out 110 * regions for the new metadata (initializing band states, etc). 111 */ 112 static const struct ftl_mngt_process_desc desc_first_start = { 113 .name = "FTL first start", 114 .steps = { 115 { 116 .name = "Initialize L2P", 117 .action = ftl_mngt_init_l2p, 118 .cleanup = ftl_mngt_deinit_l2p 119 }, 120 { 121 .name = "Clear L2P", 122 .action = ftl_mngt_clear_l2p, 123 .cleanup = ftl_mngt_clear_l2p 124 }, 125 { 126 .name = "Scrub NV cache", 127 .action = ftl_mngt_scrub_nv_cache, 128 }, 129 { 130 .name = "Finalize band initialization", 131 .action = ftl_mngt_finalize_init_bands, 132 }, 133 { 134 .name = "Save initial band info metadata", 135 .action = ftl_mngt_persist_band_info_metadata, 136 }, 137 { 138 .name = "Save initial chunk info metadata", 139 .action = ftl_mngt_persist_nv_cache_metadata, 140 }, 141 { 142 .name = "Set FTL dirty state", 143 .action = ftl_mngt_set_dirty, 144 }, 145 { 146 .name = "Start core poller", 147 .action = ftl_mngt_start_core_poller, 148 .cleanup = ftl_mngt_stop_core_poller 149 }, 150 { 151 .name = "Finalize initialization", 152 .action = ftl_mngt_finalize_startup, 153 }, 154 {} 155 } 156 }; 157 158 int 159 ftl_mngt_call_dev_startup(struct spdk_ftl_dev *dev, ftl_mngt_completion cb, void *cb_cntx) 160 { 161 return ftl_mngt_process_execute(dev, &desc_startup, cb, cb_cntx); 162 } 163 164 void 165 ftl_mngt_rollback_device(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 166 { 167 ftl_mngt_call_process_rollback(mngt, &desc_startup); 168 } 169