1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2018 Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk_cunit.h" 7 8 #include "common/lib/ut_multithread.c" 9 #include "unit/lib/json_mock.c" 10 11 #include "spdk/config.h" 12 /* HACK: disable VTune integration so the unit test doesn't need VTune headers and libs to build */ 13 #undef SPDK_CONFIG_VTUNE 14 15 #include "bdev/bdev.c" 16 #include "bdev/part.c" 17 18 struct ut_expected_io { 19 }; 20 21 struct bdev_ut_channel { 22 TAILQ_HEAD(, spdk_bdev_io) outstanding_io; 23 uint32_t outstanding_io_count; 24 TAILQ_HEAD(, ut_expected_io) expected_io; 25 }; 26 27 static uint32_t g_part_ut_io_device; 28 static struct bdev_ut_channel *g_bdev_ut_channel; 29 static int g_accel_io_device; 30 31 DEFINE_STUB(spdk_notify_send, uint64_t, (const char *type, const char *ctx), 0); 32 DEFINE_STUB(spdk_notify_type_register, struct spdk_notify_type *, (const char *type), NULL); 33 DEFINE_STUB(spdk_memory_domain_get_dma_device_id, const char *, (struct spdk_memory_domain *domain), 34 "test_domain"); 35 DEFINE_STUB(spdk_memory_domain_get_dma_device_type, enum spdk_dma_device_type, 36 (struct spdk_memory_domain *domain), 0); 37 DEFINE_STUB_V(spdk_accel_sequence_finish, 38 (struct spdk_accel_sequence *seq, spdk_accel_completion_cb cb_fn, void *cb_arg)); 39 DEFINE_STUB_V(spdk_accel_sequence_abort, (struct spdk_accel_sequence *seq)); 40 DEFINE_STUB_V(spdk_accel_sequence_reverse, (struct spdk_accel_sequence *seq)); 41 DEFINE_STUB(spdk_accel_append_copy, int, 42 (struct spdk_accel_sequence **seq, struct spdk_io_channel *ch, struct iovec *dst_iovs, 43 uint32_t dst_iovcnt, struct spdk_memory_domain *dst_domain, void *dst_domain_ctx, 44 struct iovec *src_iovs, uint32_t src_iovcnt, struct spdk_memory_domain *src_domain, 45 void *src_domain_ctx, int flags, spdk_accel_step_cb cb_fn, void *cb_arg), 0); 46 DEFINE_STUB(spdk_accel_get_memory_domain, struct spdk_memory_domain *, (void), NULL); 47 48 DEFINE_RETURN_MOCK(spdk_memory_domain_pull_data, int); 49 int 50 spdk_memory_domain_pull_data(struct spdk_memory_domain *src_domain, void *src_domain_ctx, 51 struct iovec *src_iov, uint32_t src_iov_cnt, struct iovec *dst_iov, uint32_t dst_iov_cnt, 52 spdk_memory_domain_data_cpl_cb cpl_cb, void *cpl_cb_arg) 53 { 54 HANDLE_RETURN_MOCK(spdk_memory_domain_pull_data); 55 56 cpl_cb(cpl_cb_arg, 0); 57 return 0; 58 } 59 60 DEFINE_RETURN_MOCK(spdk_memory_domain_push_data, int); 61 int 62 spdk_memory_domain_push_data(struct spdk_memory_domain *dst_domain, void *dst_domain_ctx, 63 struct iovec *dst_iov, uint32_t dst_iovcnt, struct iovec *src_iov, uint32_t src_iovcnt, 64 spdk_memory_domain_data_cpl_cb cpl_cb, void *cpl_cb_arg) 65 { 66 HANDLE_RETURN_MOCK(spdk_memory_domain_push_data); 67 68 cpl_cb(cpl_cb_arg, 0); 69 return 0; 70 } 71 72 struct spdk_io_channel * 73 spdk_accel_get_io_channel(void) 74 { 75 return spdk_get_io_channel(&g_accel_io_device); 76 } 77 78 static int 79 ut_accel_ch_create_cb(void *io_device, void *ctx) 80 { 81 return 0; 82 } 83 84 static void 85 ut_accel_ch_destroy_cb(void *io_device, void *ctx) 86 { 87 } 88 89 static int 90 ut_part_setup(void) 91 { 92 spdk_io_device_register(&g_accel_io_device, ut_accel_ch_create_cb, 93 ut_accel_ch_destroy_cb, 0, NULL); 94 return 0; 95 } 96 97 static int 98 ut_part_teardown(void) 99 { 100 spdk_io_device_unregister(&g_accel_io_device, NULL); 101 102 return 0; 103 } 104 105 static void 106 _part_cleanup(struct spdk_bdev_part *part) 107 { 108 spdk_io_device_unregister(part, NULL); 109 free(part->internal.bdev.name); 110 free(part->internal.bdev.product_name); 111 } 112 113 static struct spdk_io_channel * 114 part_ut_get_io_channel(void *ctx) 115 { 116 return spdk_get_io_channel(&g_part_ut_io_device); 117 } 118 119 void 120 spdk_scsi_nvme_translate(const struct spdk_bdev_io *bdev_io, 121 int *sc, int *sk, int *asc, int *ascq) 122 { 123 } 124 125 static int 126 bdev_ut_create_ch(void *io_device, void *ctx_buf) 127 { 128 struct bdev_ut_channel *ch = ctx_buf; 129 130 CU_ASSERT(g_bdev_ut_channel == NULL); 131 g_bdev_ut_channel = ch; 132 g_part_ut_io_device++; 133 134 TAILQ_INIT(&ch->outstanding_io); 135 ch->outstanding_io_count = 0; 136 TAILQ_INIT(&ch->expected_io); 137 return 0; 138 } 139 140 static void 141 bdev_ut_destroy_ch(void *io_device, void *ctx_buf) 142 { 143 CU_ASSERT(g_bdev_ut_channel != NULL); 144 g_bdev_ut_channel = NULL; 145 g_part_ut_io_device--; 146 } 147 148 struct spdk_bdev_module bdev_ut_if; 149 150 static int 151 bdev_ut_module_init(void) 152 { 153 spdk_io_device_register(&g_part_ut_io_device, bdev_ut_create_ch, bdev_ut_destroy_ch, 154 sizeof(struct bdev_ut_channel), NULL); 155 spdk_bdev_module_init_done(&bdev_ut_if); 156 return 0; 157 } 158 159 static void 160 bdev_ut_module_fini(void) 161 { 162 spdk_io_device_unregister(&g_part_ut_io_device, NULL); 163 } 164 165 struct spdk_bdev_module bdev_ut_if = { 166 .name = "bdev_ut", 167 .module_init = bdev_ut_module_init, 168 .module_fini = bdev_ut_module_fini, 169 .async_init = true, 170 }; 171 172 static void vbdev_ut_examine(struct spdk_bdev *bdev); 173 174 static int 175 vbdev_ut_module_init(void) 176 { 177 return 0; 178 } 179 180 static void 181 vbdev_ut_module_fini(void) 182 { 183 } 184 185 struct spdk_bdev_module vbdev_ut_if = { 186 .name = "vbdev_ut", 187 .module_init = vbdev_ut_module_init, 188 .module_fini = vbdev_ut_module_fini, 189 .examine_config = vbdev_ut_examine, 190 }; 191 192 SPDK_BDEV_MODULE_REGISTER(bdev_ut, &bdev_ut_if) 193 SPDK_BDEV_MODULE_REGISTER(vbdev_ut, &vbdev_ut_if) 194 195 static void 196 vbdev_ut_examine(struct spdk_bdev *bdev) 197 { 198 spdk_bdev_module_examine_done(&vbdev_ut_if); 199 } 200 201 static int 202 __destruct(void *ctx) 203 { 204 return 0; 205 } 206 207 static struct spdk_bdev_fn_table base_fn_table = { 208 .destruct = __destruct, 209 .get_io_channel = part_ut_get_io_channel, 210 }; 211 static struct spdk_bdev_fn_table part_fn_table = { 212 .destruct = __destruct, 213 }; 214 215 static void 216 bdev_init_cb(void *arg, int rc) 217 { 218 CU_ASSERT(rc == 0); 219 } 220 221 static void 222 bdev_fini_cb(void *arg) 223 { 224 } 225 226 static void 227 ut_init_bdev(void) 228 { 229 int rc; 230 231 rc = spdk_iobuf_initialize(); 232 CU_ASSERT(rc == 0); 233 234 spdk_bdev_initialize(bdev_init_cb, NULL); 235 poll_threads(); 236 } 237 238 static void 239 ut_fini_bdev(void) 240 { 241 spdk_bdev_finish(bdev_fini_cb, NULL); 242 spdk_iobuf_finish(bdev_fini_cb, NULL); 243 poll_threads(); 244 } 245 246 static void 247 bdev_ut_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 248 { 249 } 250 251 static void 252 part_test(void) 253 { 254 struct spdk_bdev_part_base *base; 255 struct spdk_bdev_part part1 = {}; 256 struct spdk_bdev_part part2 = {}; 257 struct spdk_bdev_part part3 = {}; 258 struct spdk_bdev bdev_base = {}; 259 SPDK_BDEV_PART_TAILQ tailq = TAILQ_HEAD_INITIALIZER(tailq); 260 int rc; 261 262 bdev_base.name = "base"; 263 bdev_base.fn_table = &base_fn_table; 264 bdev_base.module = &bdev_ut_if; 265 rc = spdk_bdev_register(&bdev_base); 266 CU_ASSERT(rc == 0); 267 rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if, 268 &part_fn_table, &tailq, NULL, 269 NULL, 0, NULL, NULL, &base); 270 271 CU_ASSERT(rc == 0); 272 SPDK_CU_ASSERT_FATAL(base != NULL); 273 274 rc = spdk_bdev_part_construct(&part1, base, "test1", 0, 100, "test"); 275 SPDK_CU_ASSERT_FATAL(rc == 0); 276 SPDK_CU_ASSERT_FATAL(base->ref == 1); 277 SPDK_CU_ASSERT_FATAL(base->claimed == true); 278 rc = spdk_bdev_part_construct(&part2, base, "test2", 100, 100, "test"); 279 SPDK_CU_ASSERT_FATAL(rc == 0); 280 SPDK_CU_ASSERT_FATAL(base->ref == 2); 281 SPDK_CU_ASSERT_FATAL(base->claimed == true); 282 rc = spdk_bdev_part_construct(&part3, base, "test1", 0, 100, "test"); 283 SPDK_CU_ASSERT_FATAL(rc != 0); 284 SPDK_CU_ASSERT_FATAL(base->ref == 2); 285 SPDK_CU_ASSERT_FATAL(base->claimed == true); 286 287 spdk_bdev_part_base_hotremove(base, &tailq); 288 289 spdk_bdev_part_base_free(base); 290 _part_cleanup(&part1); 291 _part_cleanup(&part2); 292 spdk_bdev_unregister(&bdev_base, NULL, NULL); 293 294 poll_threads(); 295 } 296 297 static void 298 part_free_test(void) 299 { 300 struct spdk_bdev_part_base *base = NULL; 301 struct spdk_bdev_part *part; 302 struct spdk_bdev bdev_base = {}; 303 SPDK_BDEV_PART_TAILQ tailq = TAILQ_HEAD_INITIALIZER(tailq); 304 int rc; 305 306 bdev_base.name = "base"; 307 bdev_base.fn_table = &base_fn_table; 308 bdev_base.module = &bdev_ut_if; 309 rc = spdk_bdev_register(&bdev_base); 310 CU_ASSERT(rc == 0); 311 poll_threads(); 312 313 rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if, 314 &part_fn_table, &tailq, NULL, 315 NULL, 0, NULL, NULL, &base); 316 CU_ASSERT(rc == 0); 317 CU_ASSERT(TAILQ_EMPTY(&tailq)); 318 SPDK_CU_ASSERT_FATAL(base != NULL); 319 320 part = calloc(1, sizeof(*part)); 321 SPDK_CU_ASSERT_FATAL(part != NULL); 322 rc = spdk_bdev_part_construct(part, base, "test", 0, 100, "test"); 323 SPDK_CU_ASSERT_FATAL(rc == 0); 324 poll_threads(); 325 CU_ASSERT(!TAILQ_EMPTY(&tailq)); 326 327 spdk_bdev_unregister(&part->internal.bdev, NULL, NULL); 328 poll_threads(); 329 330 rc = spdk_bdev_part_free(part); 331 CU_ASSERT(rc == 1); 332 poll_threads(); 333 CU_ASSERT(TAILQ_EMPTY(&tailq)); 334 335 spdk_bdev_unregister(&bdev_base, NULL, NULL); 336 poll_threads(); 337 } 338 339 static void 340 part_get_io_channel_test(void) 341 { 342 struct spdk_bdev_part_base *base = NULL; 343 struct spdk_bdev_desc *desc = NULL; 344 struct spdk_io_channel *io_ch; 345 struct spdk_bdev_part *part; 346 struct spdk_bdev bdev_base = {}; 347 SPDK_BDEV_PART_TAILQ tailq = TAILQ_HEAD_INITIALIZER(tailq); 348 int rc; 349 350 ut_init_bdev(); 351 bdev_base.name = "base"; 352 bdev_base.blocklen = 512; 353 bdev_base.blockcnt = 1024; 354 bdev_base.fn_table = &base_fn_table; 355 bdev_base.module = &bdev_ut_if; 356 rc = spdk_bdev_register(&bdev_base); 357 CU_ASSERT(rc == 0); 358 359 rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if, 360 &part_fn_table, &tailq, NULL, 361 NULL, 100, NULL, NULL, &base); 362 CU_ASSERT(rc == 0); 363 CU_ASSERT(TAILQ_EMPTY(&tailq)); 364 SPDK_CU_ASSERT_FATAL(base != NULL); 365 366 part = calloc(1, sizeof(*part)); 367 SPDK_CU_ASSERT_FATAL(part != NULL); 368 rc = spdk_bdev_part_construct(part, base, "test", 0, 100, "test"); 369 SPDK_CU_ASSERT_FATAL(rc == 0); 370 CU_ASSERT(!TAILQ_EMPTY(&tailq)); 371 372 rc = spdk_bdev_open_ext("test", true, bdev_ut_event_cb, NULL, &desc); 373 CU_ASSERT(rc == 0); 374 SPDK_CU_ASSERT_FATAL(desc != NULL); 375 CU_ASSERT(&part->internal.bdev == spdk_bdev_desc_get_bdev(desc)); 376 377 io_ch = spdk_bdev_get_io_channel(desc); 378 CU_ASSERT(io_ch != NULL); 379 CU_ASSERT(g_part_ut_io_device == 1); 380 381 spdk_put_io_channel(io_ch); 382 spdk_bdev_close(desc); 383 spdk_bdev_unregister(&part->internal.bdev, NULL, NULL); 384 poll_threads(); 385 CU_ASSERT(g_part_ut_io_device == 0); 386 387 rc = spdk_bdev_part_free(part); 388 CU_ASSERT(rc == 1); 389 poll_threads(); 390 CU_ASSERT(TAILQ_EMPTY(&tailq)); 391 392 spdk_bdev_unregister(&bdev_base, NULL, NULL); 393 ut_fini_bdev(); 394 } 395 396 int 397 main(int argc, char **argv) 398 { 399 CU_pSuite suite = NULL; 400 unsigned int num_failures; 401 402 CU_set_error_action(CUEA_ABORT); 403 CU_initialize_registry(); 404 405 suite = CU_add_suite("bdev_part", ut_part_setup, ut_part_teardown); 406 407 CU_ADD_TEST(suite, part_test); 408 CU_ADD_TEST(suite, part_free_test); 409 CU_ADD_TEST(suite, part_get_io_channel_test); 410 411 allocate_cores(1); 412 allocate_threads(1); 413 set_thread(0); 414 415 CU_basic_set_mode(CU_BRM_VERBOSE); 416 CU_basic_run_tests(); 417 num_failures = CU_get_number_of_failures(); 418 CU_cleanup_registry(); 419 420 free_threads(); 421 free_cores(); 422 423 return num_failures; 424 } 425