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/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_l2p_unpin, (struct spdk_ftl_dev *dev, uint64_t lba, uint64_t count)); 63 DEFINE_STUB(ftl_l2p_get, ftl_addr, (struct spdk_ftl_dev *dev, uint64_t lba), 0); 64 DEFINE_STUB_V(ftl_mempool_put, (struct ftl_mempool *mpool, void *element)); 65 66 #if defined(FTL_DUMP_STATS) 67 DEFINE_STUB_V(ftl_dev_dump_stats, (const struct spdk_ftl_dev *dev)); 68 #endif 69 70 struct ftl_io_channel_ctx { 71 struct ftl_io_channel *ioch; 72 }; 73 74 struct ftl_io_channel * 75 ftl_io_channel_get_ctx(struct spdk_io_channel *ioch) 76 { 77 struct ftl_io_channel_ctx *ctx = spdk_io_channel_get_ctx(ioch); 78 79 return ctx->ioch; 80 } 81 82 struct spdk_io_channel * 83 spdk_bdev_get_io_channel(struct spdk_bdev_desc *bdev_desc) 84 { 85 return spdk_get_io_channel(bdev_desc); 86 } 87 88 static int 89 channel_create_cb(void *io_device, void *ctx) 90 { 91 return 0; 92 } 93 94 static void 95 channel_destroy_cb(void *io_device, void *ctx) 96 { 97 } 98 99 static struct spdk_ftl_dev * 100 setup_device(uint32_t num_threads, uint32_t xfer_size) 101 { 102 struct spdk_ftl_dev *dev; 103 struct ftl_io_channel *ioch; 104 struct ftl_io_channel_ctx *ctx; 105 106 allocate_threads(num_threads); 107 set_thread(0); 108 109 dev = calloc(1, sizeof(*dev)); 110 SPDK_CU_ASSERT_FATAL(dev != NULL); 111 112 dev->core_thread = spdk_get_thread(); 113 dev->ioch = calloc(1, SPDK_IO_CHANNEL_STRUCT_SIZE + sizeof(struct ftl_io_channel_ctx)); 114 SPDK_CU_ASSERT_FATAL(dev->ioch != NULL); 115 116 ctx = spdk_io_channel_get_ctx(dev->ioch); 117 ctx->ioch = calloc(1, sizeof(*ctx->ioch)); 118 119 ioch = ftl_io_channel_get_ctx(dev->ioch); 120 SPDK_CU_ASSERT_FATAL(ioch != NULL); 121 122 ioch->cq = spdk_ring_create(0, 1024, 0); 123 124 dev->conf = g_default_conf; 125 dev->xfer_size = xfer_size; 126 dev->base_bdev_desc = (struct spdk_bdev_desc *)0xdeadbeef; 127 dev->nv_cache.bdev_desc = (struct spdk_bdev_desc *)0xdead1234; 128 spdk_io_device_register(dev, channel_create_cb, channel_destroy_cb, 0, NULL); 129 spdk_io_device_register(dev->base_bdev_desc, channel_create_cb, channel_destroy_cb, 0, NULL); 130 spdk_io_device_register(dev->nv_cache.bdev_desc, channel_create_cb, channel_destroy_cb, 0, NULL); 131 132 TAILQ_INIT(&dev->ioch_queue); 133 134 return dev; 135 } 136 137 static void 138 free_device(struct spdk_ftl_dev *dev) 139 { 140 struct ftl_io_channel *ioch; 141 142 ioch = ftl_io_channel_get_ctx(dev->ioch); 143 spdk_ring_free(ioch->cq); 144 free(ioch); 145 146 spdk_io_device_unregister(dev, NULL); 147 spdk_io_device_unregister(dev->base_bdev_desc, NULL); 148 spdk_io_device_unregister(dev->nv_cache.bdev_desc, NULL); 149 150 while (!TAILQ_EMPTY(&dev->ioch_queue)) { 151 TAILQ_REMOVE(&dev->ioch_queue, TAILQ_FIRST(&dev->ioch_queue), entry); 152 } 153 154 free_threads(); 155 156 free(dev->ioch); 157 free(dev->sb); 158 free(dev); 159 } 160 161 static void 162 setup_io(struct ftl_io *io, struct spdk_ftl_dev *dev, spdk_ftl_fn cb, void *ctx) 163 { 164 io->dev = dev; 165 io->user_fn = cb; 166 io->cb_ctx = ctx; 167 io->flags = 0; 168 io->ioch = dev->ioch; 169 } 170 171 static void 172 io_complete_cb(void *ctx, int status) 173 { 174 *(int *)ctx = status; 175 } 176 177 static void 178 test_completion(void) 179 { 180 struct spdk_ftl_dev *dev; 181 struct ftl_io_channel *ioch; 182 struct ftl_io io = { 0 }, *io_ring; 183 int req, status = 0; 184 185 dev = setup_device(1, FTL_NUM_LBA_IN_BLOCK); 186 ioch = ftl_io_channel_get_ctx(dev->ioch); 187 188 /* Setup IO and 'send' NUM_REQUESTS subrequests */ 189 setup_io(&io, dev, io_complete_cb, &status); 190 io.status = -EIO; 191 192 #define NUM_REQUESTS 16 193 for (req = 0; req < NUM_REQUESTS; ++req) { 194 ftl_io_inc_req(&io); 195 CU_ASSERT_FALSE(ftl_io_done(&io)); 196 } 197 198 CU_ASSERT_EQUAL(io.req_cnt, NUM_REQUESTS); 199 200 /* Complete all but one subrequest, make sure io still not marked as done */ 201 for (req = 0; req < (NUM_REQUESTS - 1); ++req) { 202 ftl_io_dec_req(&io); 203 CU_ASSERT_FALSE(ftl_io_done(&io)); 204 } 205 206 CU_ASSERT_EQUAL(io.req_cnt, 1); 207 208 /* Complete last subrequest, make sure it appears on the completion queue */ 209 ftl_io_dec_req(&io); 210 CU_ASSERT_TRUE(ftl_io_done(&io)); 211 212 ftl_io_complete(&io); 213 214 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 1); 215 216 /* Dequeue and check if the completion callback changes the status, this is usually done via poller */ 217 spdk_ring_dequeue(ioch->cq, (void **)&io_ring, 1); 218 io_ring->user_fn(io_ring->cb_ctx, io_ring->status); 219 220 CU_ASSERT_EQUAL(status, -EIO); 221 222 free_device(dev); 223 } 224 225 static void 226 test_multiple_ios(void) 227 { 228 struct spdk_ftl_dev *dev; 229 struct ftl_io_channel *ioch; 230 struct ftl_io io[2] = { 0 }, *io_ring[2]; 231 int status = -1; 232 233 dev = setup_device(1, FTL_NUM_LBA_IN_BLOCK); 234 ioch = ftl_io_channel_get_ctx(dev->ioch); 235 236 /* Send t2o IOs and check if both are in the completion queue */ 237 setup_io(&io[0], dev, io_complete_cb, &status); 238 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 0); 239 240 ftl_io_complete(io); 241 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 1); 242 243 setup_io(&io[1], dev, io_complete_cb, &status); 244 245 ftl_io_complete(&io[1]); 246 CU_ASSERT_EQUAL(spdk_ring_count(ioch->cq), 2); 247 248 /* Dequeue and check if the completion callback changes the status, this is usually done via poller */ 249 spdk_ring_dequeue(ioch->cq, (void **)io_ring, 2); 250 status = -1; 251 io_ring[0]->user_fn(io_ring[0]->cb_ctx, io_ring[0]->status); 252 CU_ASSERT_EQUAL(status, 0); 253 status = -1; 254 io_ring[1]->user_fn(io_ring[1]->cb_ctx, io_ring[1]->status); 255 CU_ASSERT_EQUAL(status, 0); 256 257 free_device(dev); 258 } 259 260 int 261 main(int argc, char **argv) 262 { 263 CU_pSuite suite; 264 unsigned int num_failures; 265 266 CU_set_error_action(CUEA_ABORT); 267 CU_initialize_registry(); 268 269 suite = CU_add_suite("ftl_io_suite", NULL, NULL); 270 271 272 CU_ADD_TEST(suite, test_completion); 273 CU_ADD_TEST(suite, test_multiple_ios); 274 275 CU_basic_set_mode(CU_BRM_VERBOSE); 276 CU_basic_run_tests(); 277 num_failures = CU_get_number_of_failures(); 278 CU_cleanup_registry(); 279 280 return num_failures; 281 } 282