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