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