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