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