1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk/stdinc.h" 7 8 #include "spdk_cunit.h" 9 #include "common/lib/test_env.c" 10 11 #include "ftl/ftl_core.c" 12 #include "ftl/ftl_band.c" 13 #include "../common/utils.c" 14 15 #define TEST_BAND_IDX 42 16 #define TEST_LBA 0x68676564 17 #define TEST_SEQ 0xDEADBEEF 18 #define G_GEO_ZONE_SIZE 10000 19 #define G_GEO_OPTIMAL_OPEN_ZONES 1 20 21 struct base_bdev_geometry g_geo = { 22 .write_unit_size = FTL_NUM_LBA_IN_BLOCK, 23 .optimal_open_zones = G_GEO_OPTIMAL_OPEN_ZONES, 24 .zone_size = G_GEO_ZONE_SIZE, 25 .blockcnt = (TEST_BAND_IDX + 1) * G_GEO_ZONE_SIZE * G_GEO_OPTIMAL_OPEN_ZONES, 26 }; 27 28 static struct spdk_ftl_dev *g_dev; 29 static struct ftl_band *g_band; 30 31 #if defined(DEBUG) 32 DEFINE_STUB_V(ftl_band_validate_md, (struct ftl_band *band, ftl_band_validate_md_cb cb)); 33 DEFINE_STUB_V(ftl_p2l_validate_ckpt, (struct ftl_band *band)); 34 DEFINE_STUB_V(ftl_trace_limits, (struct spdk_ftl_dev *dev, int limit, size_t num_free)); 35 DEFINE_STUB_V(ftl_trace_completion, (struct spdk_ftl_dev *dev, const struct ftl_io *io, 36 enum ftl_trace_completion completion)); 37 DEFINE_STUB_V(ftl_trace_defrag_band, (struct spdk_ftl_dev *dev, const struct ftl_band *band)); 38 DEFINE_STUB_V(ftl_trace_wbuf_fill, (struct spdk_ftl_dev *dev, const struct ftl_io *io)); 39 DEFINE_STUB_V(ftl_trace_wbuf_pop, (struct spdk_ftl_dev *dev, const struct ftl_wbuf_entry *entry)); 40 DEFINE_STUB_V(ftl_trace_write_band, (struct spdk_ftl_dev *dev, const struct ftl_band *band)); 41 DEFINE_STUB_V(ftl_trace_submission, (struct spdk_ftl_dev *dev, const struct ftl_io *io, 42 ftl_addr addr, size_t addr_cnt)); 43 #endif 44 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *bdev_io)); 45 DEFINE_STUB(spdk_bdev_get_block_size, uint32_t, (const struct spdk_bdev *bdev), 512); 46 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), "test"); 47 DEFINE_STUB(spdk_bdev_get_num_blocks, uint64_t, (const struct spdk_bdev *bdev), 0); 48 DEFINE_STUB(spdk_bdev_get_md_size, uint32_t, (const struct spdk_bdev *bdev), 8); 49 DEFINE_STUB(spdk_bdev_write_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 50 void *buf, uint64_t offset_blocks, uint64_t num_blocks, spdk_bdev_io_completion_cb cb, 51 void *cb_arg), 0); 52 DEFINE_STUB(spdk_bdev_write_blocks_with_md, int, (struct spdk_bdev_desc *desc, 53 struct spdk_io_channel *ch, void *buf, void *md, uint64_t offset_blocks, 54 uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 55 DEFINE_STUB(spdk_bdev_read_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 56 void *buf, uint64_t offset_blocks, uint64_t num_blocks, 57 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 58 DEFINE_STUB(spdk_bdev_write_zeroes_blocks, int, 59 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 60 uint64_t offset_blocks, uint64_t num_blocks, 61 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 62 DEFINE_STUB(spdk_bdev_writev_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 63 struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks, 64 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 65 DEFINE_STUB_V(ftl_io_advance, (struct ftl_io *io, size_t num_blocks)); 66 DEFINE_STUB(ftl_io_channel_get_ctx, struct ftl_io_channel *, 67 (struct spdk_io_channel *ioch), NULL); 68 DEFINE_STUB_V(ftl_io_complete, (struct ftl_io *io)); 69 DEFINE_STUB(ftl_io_current_lba, uint64_t, (const struct ftl_io *io), 0); 70 DEFINE_STUB_V(ftl_io_dec_req, (struct ftl_io *io)); 71 DEFINE_STUB_V(ftl_io_fail, (struct ftl_io *io, int status)); 72 DEFINE_STUB_V(ftl_io_free, (struct ftl_io *io)); 73 DEFINE_STUB(ftl_io_get_lba, uint64_t, 74 (const struct ftl_io *io, size_t offset), 0); 75 DEFINE_STUB_V(ftl_io_inc_req, (struct ftl_io *io)); 76 DEFINE_STUB(ftl_io_iovec_addr, void *, (struct ftl_io *io), NULL); 77 DEFINE_STUB(ftl_io_iovec_len_left, size_t, (struct ftl_io *io), 0); 78 79 DEFINE_STUB(ftl_iovec_num_blocks, size_t, 80 (struct iovec *iov, size_t iov_cnt), 0); 81 DEFINE_STUB_V(ftl_reloc, (struct ftl_reloc *reloc)); 82 83 DEFINE_STUB_V(ftl_reloc_add, (struct ftl_reloc *reloc, struct ftl_band *band, size_t offset, 84 size_t num_blocks, int prio, bool defrag)); 85 DEFINE_STUB(ftl_reloc_is_defrag_active, bool, (const struct ftl_reloc *reloc), false); 86 DEFINE_STUB(ftl_reloc_is_halted, bool, (const struct ftl_reloc *reloc), false); 87 DEFINE_STUB_V(ftl_reloc_halt, (struct ftl_reloc *reloc)); 88 DEFINE_STUB(spdk_bdev_is_zoned, bool, (const struct spdk_bdev *bdev), true); 89 DEFINE_STUB(ftl_p2l_ckpt_acquire, struct ftl_p2l_ckpt *, (struct spdk_ftl_dev *dev), NULL); 90 DEFINE_STUB(ftl_mngt_unmap, int, (struct spdk_ftl_dev *dev, uint64_t lba, uint64_t num_blocks, 91 spdk_ftl_fn cb, void *cb_cntx), 0); 92 DEFINE_STUB_V(ftl_p2l_ckpt_release, (struct spdk_ftl_dev *dev, struct ftl_p2l_ckpt *ckpt)); 93 94 DEFINE_STUB_V(ftl_l2p_process, (struct spdk_ftl_dev *dev)); 95 DEFINE_STUB_V(ftl_nv_cache_process, (struct spdk_ftl_dev *dev)); 96 DEFINE_STUB(ftl_nv_cache_is_halted, bool, (struct ftl_nv_cache *nvc), true); 97 DEFINE_STUB(ftl_nv_cache_chunks_busy, int, (struct ftl_nv_cache *nvc), true); 98 DEFINE_STUB(ftl_nv_cache_full, bool, (struct ftl_nv_cache *nvc), true); 99 DEFINE_STUB(ftl_l2p_is_halted, bool, (struct spdk_ftl_dev *dev), true); 100 DEFINE_STUB(ftl_nv_cache_write, bool, (struct ftl_io *io), true); 101 DEFINE_STUB_V(ftl_nv_cache_halt, (struct ftl_nv_cache *nvc)); 102 DEFINE_STUB_V(ftl_l2p_halt, (struct spdk_ftl_dev *dev)); 103 DEFINE_STUB(ftl_io_init, int, (struct spdk_io_channel *_ioch, struct ftl_io *io, uint64_t lba, 104 size_t num_blocks, 105 struct iovec *iov, size_t iov_cnt, spdk_ftl_fn cb_fn, void *cb_ctx, int type), 0); 106 DEFINE_STUB_V(ftl_mngt_next_step, (struct ftl_mngt_process *mngt)); 107 DEFINE_STUB_V(ftl_mngt_fail_step, (struct ftl_mngt_process *mngt)); 108 DEFINE_STUB_V(spdk_bdev_close, (struct spdk_bdev_desc *desc)); 109 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_desc *bdev_desc), 110 NULL); 111 DEFINE_STUB(spdk_bdev_io_type_supported, bool, (struct spdk_bdev *bdev, 112 enum spdk_bdev_io_type io_type), true); 113 DEFINE_STUB_V(spdk_bdev_module_release_bdev, (struct spdk_bdev *bdev)); 114 DEFINE_STUB(spdk_bdev_module_claim_bdev, int, (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 115 struct spdk_bdev_module *module), 0); 116 DEFINE_STUB(spdk_bdev_open_ext, int, (const char *bdev_name, bool write, 117 spdk_bdev_event_cb_t event_cb, 118 void *event_ctx, struct spdk_bdev_desc **desc), 0); 119 DEFINE_STUB(spdk_bdev_get_write_unit_size, uint32_t, (const struct spdk_bdev *bdev), 1); 120 DEFINE_STUB(spdk_bdev_is_md_separate, bool, (const struct spdk_bdev *bdev), true); 121 DEFINE_STUB(spdk_bdev_get_dif_type, enum spdk_dif_type, (const struct spdk_bdev *bdev), 122 SPDK_DIF_DISABLE); 123 DEFINE_STUB(ftl_md_xfer_blocks, uint64_t, (struct spdk_ftl_dev *dev), 4); 124 DEFINE_STUB_V(ftl_l2p_pin, (struct spdk_ftl_dev *dev, uint64_t lba, uint64_t count, 125 ftl_l2p_pin_cb cb, void *cb_ctx, 126 struct ftl_l2p_pin_ctx *pin_ctx)); 127 DEFINE_STUB_V(ftl_l2p_pin_skip, (struct spdk_ftl_dev *dev, ftl_l2p_pin_cb cb, void *cb_ctx, 128 struct ftl_l2p_pin_ctx *pin_ctx)); 129 DEFINE_STUB(ftl_nv_cache_read, int, (struct ftl_io *io, ftl_addr addr, uint32_t num_blocks, 130 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 131 DEFINE_STUB(spdk_bdev_queue_io_wait, int, (struct spdk_bdev *bdev, struct spdk_io_channel *ch, 132 struct spdk_bdev_io_wait_entry *entry), 0); 133 DEFINE_STUB(ftl_l2p_get, ftl_addr, (struct spdk_ftl_dev *dev, uint64_t lba), 0); 134 DEFINE_STUB_V(ftl_writer_run, (struct ftl_writer *writer)); 135 DEFINE_STUB(ftl_writer_is_halted, bool, (struct ftl_writer *writer), true); 136 DEFINE_STUB(ftl_mempool_claim_df, void *, (struct ftl_mempool *mpool, ftl_df_obj_id df_obj_id), 137 NULL); 138 DEFINE_STUB(ftl_bitmap_count_set, uint64_t, (struct ftl_bitmap *bitmap), 0); 139 DEFINE_STUB(ftl_p2l_ckpt_region_type, enum ftl_layout_region_type, 140 (const struct ftl_p2l_ckpt *ckpt), 0); 141 DEFINE_STUB(ftl_md_get_buffer, void *, (struct ftl_md *md), NULL); 142 DEFINE_STUB(ftl_md_get_vss_buffer, union ftl_md_vss *, (struct ftl_md *md), NULL); 143 DEFINE_STUB(ftl_nv_cache_acquire_trim_seq_id, uint64_t, (struct ftl_nv_cache *nv_cache), 0); 144 DEFINE_STUB_V(ftl_md_persist, (struct ftl_md *md)); 145 DEFINE_STUB_V(spdk_bdev_io_get_nvme_status, (const struct spdk_bdev_io *bdev_io, uint32_t *cdw0, 146 int *sct, int *sc)); 147 DEFINE_STUB(ftl_nv_cache_throttle, bool, (struct spdk_ftl_dev *dev), true); 148 149 static void 150 adjust_bitmap(struct ftl_bitmap **bitmap, uint64_t *bit) 151 { 152 if (*bitmap == g_dev->valid_map) { 153 *bitmap = g_band->p2l_map.valid; 154 *bit = test_offset_from_addr(*bit, g_band); 155 } 156 } 157 158 bool 159 ftl_bitmap_get(const struct ftl_bitmap *bitmap, uint64_t bit) 160 { 161 adjust_bitmap((struct ftl_bitmap **)&bitmap, &bit); 162 return spdk_bit_array_get((struct spdk_bit_array *)bitmap, bit); 163 } 164 165 void 166 ftl_bitmap_set(struct ftl_bitmap *bitmap, uint64_t bit) 167 { 168 int ret; 169 170 adjust_bitmap(&bitmap, &bit); 171 ret = spdk_bit_array_set((struct spdk_bit_array *)bitmap, bit); 172 CU_ASSERT_EQUAL(ret, 0); 173 } 174 175 void 176 ftl_bitmap_clear(struct ftl_bitmap *bitmap, uint64_t bit) 177 { 178 adjust_bitmap(&bitmap, &bit); 179 spdk_bit_array_clear((struct spdk_bit_array *)bitmap, bit); 180 } 181 182 static void 183 setup_band(void) 184 { 185 int rc; 186 187 g_dev = test_init_ftl_dev(&g_geo); 188 g_band = test_init_ftl_band(g_dev, TEST_BAND_IDX, ftl_get_num_blocks_in_band(g_dev)); 189 rc = ftl_band_alloc_p2l_map(g_band); 190 CU_ASSERT_EQUAL_FATAL(rc, 0); 191 } 192 193 static void 194 cleanup_band(void) 195 { 196 ftl_band_release_p2l_map(g_band); 197 test_free_ftl_band(g_band); 198 test_free_ftl_dev(g_dev); 199 } 200 201 static ftl_addr 202 addr_from_zone_id(uint64_t zone_id) 203 { 204 ftl_addr addr; 205 206 addr = zone_id * g_geo.zone_size; 207 return addr; 208 } 209 210 static void 211 test_band_block_offset_from_addr_base(void) 212 { 213 ftl_addr addr; 214 uint64_t offset; 215 216 setup_band(); 217 addr = addr_from_zone_id(0); 218 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 219 220 offset = ftl_band_block_offset_from_addr(g_band, addr); 221 CU_ASSERT_EQUAL(offset, 0); 222 cleanup_band(); 223 } 224 225 static void 226 test_band_block_offset_from_addr_offset(void) 227 { 228 ftl_addr addr; 229 uint64_t offset, expect, j; 230 231 setup_band(); 232 for (j = 0; j < g_geo.zone_size; ++j) { 233 addr = addr_from_zone_id(0); 234 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + j; 235 236 offset = ftl_band_block_offset_from_addr(g_band, addr); 237 238 expect = test_offset_from_addr(addr, g_band); 239 CU_ASSERT_EQUAL(offset, expect); 240 } 241 cleanup_band(); 242 } 243 244 static void 245 test_band_addr_from_block_offset(void) 246 { 247 ftl_addr addr, expect; 248 uint64_t offset, j; 249 250 setup_band(); 251 for (j = 0; j < g_geo.zone_size; ++j) { 252 expect = addr_from_zone_id(0); 253 expect += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + j; 254 255 offset = ftl_band_block_offset_from_addr(g_band, expect); 256 addr = ftl_band_addr_from_block_offset(g_band, offset); 257 258 CU_ASSERT_EQUAL(addr, expect); 259 } 260 cleanup_band(); 261 } 262 263 static void 264 test_band_set_addr(void) 265 { 266 struct ftl_p2l_map *p2l_map; 267 ftl_addr addr; 268 uint64_t offset = 0; 269 270 setup_band(); 271 p2l_map = &g_band->p2l_map; 272 addr = addr_from_zone_id(0); 273 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 274 275 CU_ASSERT_EQUAL(p2l_map->num_valid, 0); 276 277 offset = test_offset_from_addr(addr, g_band); 278 279 ftl_band_set_addr(g_band, TEST_LBA, addr); 280 ftl_band_set_p2l(g_band, TEST_LBA, addr, TEST_SEQ); 281 CU_ASSERT_EQUAL(p2l_map->num_valid, 1); 282 CU_ASSERT_EQUAL(p2l_map->band_map[offset].lba, TEST_LBA); 283 CU_ASSERT_EQUAL(p2l_map->band_map[offset].seq_id, TEST_SEQ); 284 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset)); 285 286 addr += g_geo.zone_size / 2; 287 offset = test_offset_from_addr(addr, g_band); 288 ftl_band_set_addr(g_band, TEST_LBA + 1, addr); 289 ftl_band_set_p2l(g_band, TEST_LBA + 1, addr, TEST_SEQ + 1); 290 CU_ASSERT_EQUAL(p2l_map->num_valid, 2); 291 CU_ASSERT_EQUAL(p2l_map->band_map[offset].lba, TEST_LBA + 1); 292 CU_ASSERT_EQUAL(p2l_map->band_map[offset].seq_id, TEST_SEQ + 1); 293 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset)); 294 addr -= g_geo.zone_size / 2; 295 offset = test_offset_from_addr(addr, g_band); 296 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset)); 297 cleanup_band(); 298 } 299 300 static void 301 test_invalidate_addr(void) 302 { 303 struct ftl_p2l_map *p2l_map; 304 ftl_addr addr; 305 uint64_t offset[2]; 306 307 setup_band(); 308 p2l_map = &g_band->p2l_map; 309 addr = addr_from_zone_id(0); 310 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 311 offset[0] = test_offset_from_addr(addr, g_band); 312 313 ftl_band_set_addr(g_band, TEST_LBA, addr); 314 ftl_band_set_p2l(g_band, TEST_LBA, addr, TEST_SEQ); 315 CU_ASSERT_EQUAL(p2l_map->num_valid, 1); 316 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset[0])); 317 ftl_invalidate_addr(g_band->dev, addr); 318 CU_ASSERT_EQUAL(p2l_map->num_valid, 0); 319 CU_ASSERT_FALSE(ftl_bitmap_get(p2l_map->valid, offset[0])); 320 321 offset[0] = test_offset_from_addr(addr, g_band); 322 ftl_band_set_addr(g_band, TEST_LBA, addr); 323 ftl_band_set_p2l(g_band, TEST_LBA, addr, TEST_SEQ); 324 addr += g_geo.zone_size / 2; 325 offset[1] = test_offset_from_addr(addr, g_band); 326 ftl_band_set_addr(g_band, TEST_LBA + 1, addr); 327 ftl_band_set_p2l(g_band, TEST_LBA + 1, addr, TEST_SEQ); 328 CU_ASSERT_EQUAL(p2l_map->num_valid, 2); 329 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset[0])); 330 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset[1])); 331 ftl_invalidate_addr(g_band->dev, addr); 332 CU_ASSERT_EQUAL(p2l_map->num_valid, 1); 333 CU_ASSERT_TRUE(ftl_bitmap_get(p2l_map->valid, offset[0])); 334 CU_ASSERT_FALSE(ftl_bitmap_get(p2l_map->valid, offset[1])); 335 cleanup_band(); 336 } 337 338 static void 339 test_next_xfer_addr(void) 340 { 341 ftl_addr addr, result, expect; 342 343 setup_band(); 344 /* Verify simple one block incremention */ 345 addr = addr_from_zone_id(0); 346 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 347 expect = addr; 348 expect += 1; 349 350 result = ftl_band_next_xfer_addr(g_band, addr, 1); 351 CU_ASSERT_EQUAL(result, expect); 352 353 /* Verify jumping from last zone to the first one */ 354 expect = addr_from_zone_id(0); 355 expect += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + g_dev->xfer_size; 356 addr = addr_from_zone_id(0); 357 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 358 result = ftl_band_next_xfer_addr(g_band, addr, g_dev->xfer_size); 359 CU_ASSERT_EQUAL(result, expect); 360 361 /* Verify jumping from last zone to the first one with unaligned offset */ 362 expect = addr_from_zone_id(0); 363 expect += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 364 expect += g_dev->xfer_size + 2; 365 addr = addr_from_zone_id(0); 366 addr += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev); 367 result = ftl_band_next_xfer_addr(g_band, addr, g_dev->xfer_size + 2); 368 CU_ASSERT_EQUAL(result, expect); 369 370 cleanup_band(); 371 } 372 373 int 374 main(int argc, char **argv) 375 { 376 CU_pSuite suite = NULL; 377 unsigned int num_failures; 378 379 CU_set_error_action(CUEA_ABORT); 380 CU_initialize_registry(); 381 382 suite = CU_add_suite("ftl_band_suite", NULL, NULL); 383 384 385 CU_ADD_TEST(suite, test_band_block_offset_from_addr_base); 386 CU_ADD_TEST(suite, test_band_block_offset_from_addr_offset); 387 CU_ADD_TEST(suite, test_band_addr_from_block_offset); 388 CU_ADD_TEST(suite, test_band_set_addr); 389 CU_ADD_TEST(suite, test_invalidate_addr); 390 CU_ADD_TEST(suite, test_next_xfer_addr); 391 392 CU_basic_set_mode(CU_BRM_VERBOSE); 393 CU_basic_run_tests(); 394 num_failures = CU_get_number_of_failures(); 395 CU_cleanup_registry(); 396 397 return num_failures; 398 } 399