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