1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2019 Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk/stdinc.h" 7 8 #include "spdk_internal/cunit.h" 9 #include "common/lib/ut_multithread.c" 10 11 #include "ftl/ftl_io.c" 12 #include "ftl/utils/ftl_conf.c" 13 14 DEFINE_STUB(spdk_bdev_io_get_append_location, uint64_t, (struct spdk_bdev_io *bdev_io), 0); 15 DEFINE_STUB_V(spdk_bdev_close, (struct spdk_bdev_desc *desc)); 16 DEFINE_STUB(spdk_bdev_desc_get_bdev, struct spdk_bdev *, (struct spdk_bdev_desc *desc), NULL); 17 DEFINE_STUB(spdk_bdev_get_optimal_open_zones, uint32_t, (const struct spdk_bdev *b), 1); 18 DEFINE_STUB(spdk_bdev_get_by_name, struct spdk_bdev *, (const char *bdev_name), NULL); 19 DEFINE_STUB(spdk_bdev_is_md_separate, bool, (const struct spdk_bdev *bdev), false); 20 DEFINE_STUB(spdk_bdev_is_zoned, bool, (const struct spdk_bdev *bdev), false); 21 DEFINE_STUB(spdk_bdev_zone_appendv, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 22 struct iovec *iov, int iovcnt, uint64_t zone_id, uint64_t num_blocks, 23 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 24 DEFINE_STUB(spdk_bdev_get_zone_size, uint64_t, (const struct spdk_bdev *b), 1024); 25 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *bdev_io)); 26 DEFINE_STUB(spdk_bdev_get_buf_align, size_t, (const struct spdk_bdev *bdev), 64); 27 DEFINE_STUB(spdk_bdev_get_dif_type, enum spdk_dif_type, 28 (const struct spdk_bdev *bdev), 0); 29 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), "test"); 30 DEFINE_STUB(spdk_bdev_get_write_unit_size, uint32_t, 31 (const struct spdk_bdev *bdev), 0); 32 DEFINE_STUB(spdk_bdev_io_type_supported, bool, (struct spdk_bdev *bdev, 33 enum spdk_bdev_io_type io_type), true); 34 DEFINE_STUB(spdk_bdev_open_ext, int, 35 (const char *bdev_name, bool write, spdk_bdev_event_cb_t event_cb, 36 void *event_ctx, struct spdk_bdev_desc **desc), 0); 37 DEFINE_STUB(spdk_bdev_read_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 38 void *buf, uint64_t offset_blocks, uint64_t num_blocks, 39 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 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_writev_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 47 struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks, 48 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 49 DEFINE_STUB(spdk_bdev_get_num_blocks, uint64_t, (const struct spdk_bdev *bdev), 1024); 50 DEFINE_STUB(spdk_bdev_get_md_size, uint32_t, (const struct spdk_bdev *bdev), 0); 51 DEFINE_STUB(spdk_bdev_get_block_size, uint32_t, (const struct spdk_bdev *bdev), 4096); 52 DEFINE_STUB_V(spdk_bdev_module_release_bdev, (struct spdk_bdev *bdev)); 53 DEFINE_STUB(spdk_bdev_write_zeroes_blocks, int, 54 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 55 uint64_t offset_blocks, uint64_t num_blocks, 56 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 57 DEFINE_STUB(spdk_mempool_create_ctor, struct spdk_mempool *, 58 (const char *name, size_t count, size_t ele_size, size_t cache_size, 59 int socket_id, spdk_mempool_obj_cb_t *obj_init, void *obj_init_arg), NULL); 60 DEFINE_STUB(spdk_mempool_obj_iter, uint32_t, 61 (struct spdk_mempool *mp, spdk_mempool_obj_cb_t obj_cb, void *obj_cb_arg), 0); 62 DEFINE_STUB_V(ftl_reloc, (struct ftl_reloc *reloc)); 63 DEFINE_STUB_V(ftl_reloc_free, (struct ftl_reloc *reloc)); 64 DEFINE_STUB_V(ftl_reloc_halt, (struct ftl_reloc *reloc)); 65 DEFINE_STUB(ftl_reloc_init, struct ftl_reloc *, (struct spdk_ftl_dev *dev), NULL); 66 DEFINE_STUB(ftl_reloc_is_halted, bool, (const struct ftl_reloc *reloc), false); 67 DEFINE_STUB_V(ftl_reloc_resume, (struct ftl_reloc *reloc)); 68 DEFINE_STUB_V(ftl_l2p_unpin, (struct spdk_ftl_dev *dev, uint64_t lba, uint64_t count)); 69 DEFINE_STUB(ftl_p2l_ckpt_acquire, struct ftl_p2l_ckpt *, (struct spdk_ftl_dev *dev), NULL); 70 DEFINE_STUB_V(ftl_p2l_ckpt_release, (struct spdk_ftl_dev *dev, struct ftl_p2l_ckpt *ckpt)); 71 DEFINE_STUB(ftl_l2p_get, ftl_addr, (struct spdk_ftl_dev *dev, uint64_t lba), 0); 72 DEFINE_STUB_V(ftl_mempool_put, (struct ftl_mempool *mpool, void *element)); 73 74 #if defined(DEBUG) 75 DEFINE_STUB_V(ftl_trace_submission, (struct spdk_ftl_dev *dev, const struct ftl_io *io, 76 ftl_addr addr, size_t addr_cnt)); 77 DEFINE_STUB_V(ftl_trace_lba_io_init, (struct spdk_ftl_dev *dev, const struct ftl_io *io)); 78 DEFINE_STUB_V(ftl_trace_limits, (struct spdk_ftl_dev *dev, int limit, size_t num_free)); 79 DEFINE_STUB(ftl_trace_alloc_id, uint64_t, (struct spdk_ftl_dev *dev), 0); 80 DEFINE_STUB_V(ftl_trace_completion, (struct spdk_ftl_dev *dev, const struct ftl_io *io, 81 enum ftl_trace_completion type)); 82 DEFINE_STUB_V(ftl_trace_write_band, (struct spdk_ftl_dev *dev, const struct ftl_band *band)); 83 #endif 84 85 #if defined(FTL_DUMP_STATS) 86 DEFINE_STUB_V(ftl_dev_dump_stats, (const struct spdk_ftl_dev *dev)); 87 #endif 88 89 struct ftl_io_channel_ctx { 90 struct ftl_io_channel *ioch; 91 }; 92 93 struct ftl_io_channel * 94 ftl_io_channel_get_ctx(struct spdk_io_channel *ioch) 95 { 96 struct ftl_io_channel_ctx *ctx = spdk_io_channel_get_ctx(ioch); 97 98 return ctx->ioch; 99 } 100 101 struct spdk_io_channel * 102 spdk_bdev_get_io_channel(struct spdk_bdev_desc *bdev_desc) 103 { 104 return spdk_get_io_channel(bdev_desc); 105 } 106 107 static int 108 channel_create_cb(void *io_device, void *ctx) 109 { 110 return 0; 111 } 112 113 static void 114 channel_destroy_cb(void *io_device, void *ctx) 115 { 116 } 117 118 static struct spdk_ftl_dev * 119 setup_device(uint32_t num_threads, uint32_t xfer_size) 120 { 121 struct spdk_ftl_dev *dev; 122 struct ftl_io_channel *ioch; 123 struct ftl_io_channel_ctx *ctx; 124 125 allocate_threads(num_threads); 126 set_thread(0); 127 128 dev = calloc(1, sizeof(*dev)); 129 SPDK_CU_ASSERT_FATAL(dev != NULL); 130 131 dev->core_thread = spdk_get_thread(); 132 dev->ioch = calloc(1, SPDK_IO_CHANNEL_STRUCT_SIZE + sizeof(struct ftl_io_channel_ctx)); 133 SPDK_CU_ASSERT_FATAL(dev->ioch != NULL); 134 135 ctx = spdk_io_channel_get_ctx(dev->ioch); 136 ctx->ioch = calloc(1, sizeof(*ctx->ioch)); 137 138 ioch = ftl_io_channel_get_ctx(dev->ioch); 139 SPDK_CU_ASSERT_FATAL(ioch != NULL); 140 141 ioch->cq = spdk_ring_create(0, 1024, 0); 142 143 dev->conf = g_default_conf; 144 dev->xfer_size = xfer_size; 145 dev->base_bdev_desc = (struct spdk_bdev_desc *)0xdeadbeef; 146 dev->nv_cache.bdev_desc = (struct spdk_bdev_desc *)0xdead1234; 147 spdk_io_device_register(dev, channel_create_cb, channel_destroy_cb, 0, NULL); 148 spdk_io_device_register(dev->base_bdev_desc, channel_create_cb, channel_destroy_cb, 0, NULL); 149 spdk_io_device_register(dev->nv_cache.bdev_desc, channel_create_cb, channel_destroy_cb, 0, NULL); 150 151 TAILQ_INIT(&dev->ioch_queue); 152 153 return dev; 154 } 155 156 static void 157 free_device(struct spdk_ftl_dev *dev) 158 { 159 struct ftl_io_channel *ioch; 160 161 ioch = ftl_io_channel_get_ctx(dev->ioch); 162 spdk_ring_free(ioch->cq); 163 free(ioch); 164 165 spdk_io_device_unregister(dev, NULL); 166 spdk_io_device_unregister(dev->base_bdev_desc, NULL); 167 spdk_io_device_unregister(dev->nv_cache.bdev_desc, NULL); 168 169 while (!TAILQ_EMPTY(&dev->ioch_queue)) { 170 TAILQ_REMOVE(&dev->ioch_queue, TAILQ_FIRST(&dev->ioch_queue), entry); 171 } 172 173 free_threads(); 174 175 free(dev->ioch); 176 free(dev->sb); 177 free(dev); 178 } 179 180 static void 181 setup_io(struct ftl_io *io, struct spdk_ftl_dev *dev, spdk_ftl_fn cb, void *ctx) 182 { 183 io->dev = dev; 184 io->user_fn = cb; 185 io->cb_ctx = ctx; 186 io->flags = 0; 187 io->ioch = dev->ioch; 188 } 189 190 static void 191 io_complete_cb(void *ctx, int status) 192 { 193 *(int *)ctx = status; 194 } 195 196 static void 197 test_completion(void) 198 { 199 struct spdk_ftl_dev *dev; 200 struct ftl_io_channel *ioch; 201 struct ftl_io io = { 0 }, *io_ring; 202 int req, status = 0; 203 204 dev = setup_device(1, FTL_NUM_LBA_IN_BLOCK); 205 ioch = ftl_io_channel_get_ctx(dev->ioch); 206 207 /* Setup IO and 'send' NUM_REQUESTS subrequests */ 208 setup_io(&io, dev, io_complete_cb, &status); 209 io.status = -EIO; 210 211 #define NUM_REQUESTS 16 212 for (req = 0; req < NUM_REQUESTS; ++req) { 213 ftl_io_inc_req(&io); 214 CU_ASSERT_FALSE(ftl_io_done(&io)); 215 } 216 217 CU_ASSERT_EQUAL(io.req_cnt, NUM_REQUESTS); 218 219 /* Complete all but one subrequest, make sure io still not marked as done */ 220 for (req = 0; req < (NUM_REQUESTS - 1); ++req) { 221 ftl_io_dec_req(&io); 222 CU_ASSERT_FALSE(ftl_io_done(&io)); 223 } 224 225 CU_ASSERT_EQUAL(io.req_cnt, 1); 226 227 /* Complete last subrequest, make sure it appears on the completion queue */ 228 ftl_io_dec_req(&io); 229 CU_ASSERT_TRUE(ftl_io_done(&io)); 230 231 ftl_io_complete(&io); 232 233 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 1); 234 235 /* Dequeue and check if the completion callback changes the status, this is usually done via poller */ 236 spdk_ring_dequeue(ioch->cq, (void **)&io_ring, 1); 237 io_ring->user_fn(io_ring->cb_ctx, io_ring->status); 238 239 CU_ASSERT_EQUAL(status, -EIO); 240 241 free_device(dev); 242 } 243 244 static void 245 test_multiple_ios(void) 246 { 247 struct spdk_ftl_dev *dev; 248 struct ftl_io_channel *ioch; 249 struct ftl_io io[2] = { 0 }, *io_ring[2]; 250 int status = -1; 251 252 dev = setup_device(1, FTL_NUM_LBA_IN_BLOCK); 253 ioch = ftl_io_channel_get_ctx(dev->ioch); 254 255 /* Send t2o IOs and check if both are in the completion queue */ 256 setup_io(&io[0], dev, io_complete_cb, &status); 257 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 0); 258 259 ftl_io_complete(io); 260 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 1); 261 262 setup_io(&io[1], dev, io_complete_cb, &status); 263 264 ftl_io_complete(&io[1]); 265 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 2); 266 267 /* Dequeue and check if the completion callback changes the status, this is usually done via poller */ 268 spdk_ring_dequeue(ioch->cq, (void **)io_ring, 2); 269 status = -1; 270 io_ring[0]->user_fn(io_ring[0]->cb_ctx, io_ring[0]->status); 271 CU_ASSERT_EQUAL(status, 0); 272 status = -1; 273 io_ring[1]->user_fn(io_ring[1]->cb_ctx, io_ring[1]->status); 274 CU_ASSERT_EQUAL(status, 0); 275 276 free_device(dev); 277 } 278 279 int 280 main(int argc, char **argv) 281 { 282 CU_pSuite suite; 283 unsigned int num_failures; 284 285 CU_initialize_registry(); 286 287 suite = CU_add_suite("ftl_io_suite", NULL, NULL); 288 289 290 CU_ADD_TEST(suite, test_completion); 291 CU_ADD_TEST(suite, test_multiple_ios); 292 293 num_failures = spdk_ut_run_tests(argc, argv, NULL); 294 CU_cleanup_registry(); 295 296 return num_failures; 297 } 298