xref: /spdk/test/unit/lib/bdev/part.c/part_ut.c (revision fecffda6ecf8853b82edccde429b68252f0a62c5)
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 
30 DEFINE_STUB(spdk_notify_send, uint64_t, (const char *type, const char *ctx), 0);
31 DEFINE_STUB(spdk_notify_type_register, struct spdk_notify_type *, (const char *type), NULL);
32 DEFINE_STUB(spdk_memory_domain_get_dma_device_id, const char *, (struct spdk_memory_domain *domain),
33 	    "test_domain");
34 DEFINE_STUB(spdk_memory_domain_get_dma_device_type, enum spdk_dma_device_type,
35 	    (struct spdk_memory_domain *domain), 0);
36 
37 DEFINE_RETURN_MOCK(spdk_memory_domain_pull_data, int);
38 int
39 spdk_memory_domain_pull_data(struct spdk_memory_domain *src_domain, void *src_domain_ctx,
40 			     struct iovec *src_iov, uint32_t src_iov_cnt, struct iovec *dst_iov, uint32_t dst_iov_cnt,
41 			     spdk_memory_domain_data_cpl_cb cpl_cb, void *cpl_cb_arg)
42 {
43 	HANDLE_RETURN_MOCK(spdk_memory_domain_pull_data);
44 
45 	cpl_cb(cpl_cb_arg, 0);
46 	return 0;
47 }
48 
49 DEFINE_RETURN_MOCK(spdk_memory_domain_push_data, int);
50 int
51 spdk_memory_domain_push_data(struct spdk_memory_domain *dst_domain, void *dst_domain_ctx,
52 			     struct iovec *dst_iov, uint32_t dst_iovcnt, struct iovec *src_iov, uint32_t src_iovcnt,
53 			     spdk_memory_domain_data_cpl_cb cpl_cb, void *cpl_cb_arg)
54 {
55 	HANDLE_RETURN_MOCK(spdk_memory_domain_push_data);
56 
57 	cpl_cb(cpl_cb_arg, 0);
58 	return 0;
59 }
60 
61 static void
62 _part_cleanup(struct spdk_bdev_part *part)
63 {
64 	spdk_io_device_unregister(part, NULL);
65 	free(part->internal.bdev.name);
66 	free(part->internal.bdev.product_name);
67 }
68 
69 static struct spdk_io_channel *
70 part_ut_get_io_channel(void *ctx)
71 {
72 	return spdk_get_io_channel(&g_part_ut_io_device);
73 }
74 
75 void
76 spdk_scsi_nvme_translate(const struct spdk_bdev_io *bdev_io,
77 			 int *sc, int *sk, int *asc, int *ascq)
78 {
79 }
80 
81 static int
82 bdev_ut_create_ch(void *io_device, void *ctx_buf)
83 {
84 	struct bdev_ut_channel *ch = ctx_buf;
85 
86 	CU_ASSERT(g_bdev_ut_channel == NULL);
87 	g_bdev_ut_channel = ch;
88 	g_part_ut_io_device++;
89 
90 	TAILQ_INIT(&ch->outstanding_io);
91 	ch->outstanding_io_count = 0;
92 	TAILQ_INIT(&ch->expected_io);
93 	return 0;
94 }
95 
96 static void
97 bdev_ut_destroy_ch(void *io_device, void *ctx_buf)
98 {
99 	CU_ASSERT(g_bdev_ut_channel != NULL);
100 	g_bdev_ut_channel = NULL;
101 	g_part_ut_io_device--;
102 }
103 
104 struct spdk_bdev_module bdev_ut_if;
105 
106 static int
107 bdev_ut_module_init(void)
108 {
109 	spdk_io_device_register(&g_part_ut_io_device, bdev_ut_create_ch, bdev_ut_destroy_ch,
110 				sizeof(struct bdev_ut_channel), NULL);
111 	spdk_bdev_module_init_done(&bdev_ut_if);
112 	return 0;
113 }
114 
115 static void
116 bdev_ut_module_fini(void)
117 {
118 	spdk_io_device_unregister(&g_part_ut_io_device, NULL);
119 }
120 
121 struct spdk_bdev_module bdev_ut_if = {
122 	.name = "bdev_ut",
123 	.module_init = bdev_ut_module_init,
124 	.module_fini = bdev_ut_module_fini,
125 	.async_init = true,
126 };
127 
128 static void vbdev_ut_examine(struct spdk_bdev *bdev);
129 
130 static int
131 vbdev_ut_module_init(void)
132 {
133 	return 0;
134 }
135 
136 static void
137 vbdev_ut_module_fini(void)
138 {
139 }
140 
141 struct spdk_bdev_module vbdev_ut_if = {
142 	.name = "vbdev_ut",
143 	.module_init = vbdev_ut_module_init,
144 	.module_fini = vbdev_ut_module_fini,
145 	.examine_config = vbdev_ut_examine,
146 };
147 
148 SPDK_BDEV_MODULE_REGISTER(bdev_ut, &bdev_ut_if)
149 SPDK_BDEV_MODULE_REGISTER(vbdev_ut, &vbdev_ut_if)
150 
151 static void
152 vbdev_ut_examine(struct spdk_bdev *bdev)
153 {
154 	spdk_bdev_module_examine_done(&vbdev_ut_if);
155 }
156 
157 static int
158 __destruct(void *ctx)
159 {
160 	return 0;
161 }
162 
163 static struct spdk_bdev_fn_table base_fn_table = {
164 	.destruct		= __destruct,
165 	.get_io_channel = part_ut_get_io_channel,
166 };
167 static struct spdk_bdev_fn_table part_fn_table = {
168 	.destruct		= __destruct,
169 };
170 
171 static void
172 bdev_init_cb(void *arg, int rc)
173 {
174 	CU_ASSERT(rc == 0);
175 }
176 
177 static void
178 bdev_fini_cb(void *arg)
179 {
180 }
181 
182 static void
183 ut_init_bdev(void)
184 {
185 	int rc;
186 
187 	rc = spdk_iobuf_initialize();
188 	CU_ASSERT(rc == 0);
189 
190 	spdk_bdev_initialize(bdev_init_cb, NULL);
191 	poll_threads();
192 }
193 
194 static void
195 ut_fini_bdev(void)
196 {
197 	spdk_bdev_finish(bdev_fini_cb, NULL);
198 	spdk_iobuf_finish(bdev_fini_cb, NULL);
199 	poll_threads();
200 }
201 
202 static void
203 bdev_ut_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx)
204 {
205 }
206 
207 static void
208 part_test(void)
209 {
210 	struct spdk_bdev_part_base	*base;
211 	struct spdk_bdev_part		part1 = {};
212 	struct spdk_bdev_part		part2 = {};
213 	struct spdk_bdev		bdev_base = {};
214 	SPDK_BDEV_PART_TAILQ		tailq = TAILQ_HEAD_INITIALIZER(tailq);
215 	int rc;
216 
217 	bdev_base.name = "base";
218 	bdev_base.fn_table = &base_fn_table;
219 	bdev_base.module = &bdev_ut_if;
220 	rc = spdk_bdev_register(&bdev_base);
221 	CU_ASSERT(rc == 0);
222 	rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if,
223 					       &part_fn_table, &tailq, NULL,
224 					       NULL, 0, NULL, NULL, &base);
225 
226 	CU_ASSERT(rc == 0);
227 	SPDK_CU_ASSERT_FATAL(base != NULL);
228 
229 	rc = spdk_bdev_part_construct(&part1, base, "test1", 0, 100, "test");
230 	SPDK_CU_ASSERT_FATAL(rc == 0);
231 	rc = spdk_bdev_part_construct(&part2, base, "test2", 100, 100, "test");
232 	SPDK_CU_ASSERT_FATAL(rc == 0);
233 
234 	spdk_bdev_part_base_hotremove(base, &tailq);
235 
236 	spdk_bdev_part_base_free(base);
237 	_part_cleanup(&part1);
238 	_part_cleanup(&part2);
239 	spdk_bdev_unregister(&bdev_base, NULL, NULL);
240 
241 	poll_threads();
242 }
243 
244 static void
245 part_free_test(void)
246 {
247 	struct spdk_bdev_part_base	*base = NULL;
248 	struct spdk_bdev_part		*part;
249 	struct spdk_bdev		bdev_base = {};
250 	SPDK_BDEV_PART_TAILQ		tailq = TAILQ_HEAD_INITIALIZER(tailq);
251 	int rc;
252 
253 	bdev_base.name = "base";
254 	bdev_base.fn_table = &base_fn_table;
255 	bdev_base.module = &bdev_ut_if;
256 	rc = spdk_bdev_register(&bdev_base);
257 	CU_ASSERT(rc == 0);
258 	poll_threads();
259 
260 	rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if,
261 					       &part_fn_table, &tailq, NULL,
262 					       NULL, 0, NULL, NULL, &base);
263 	CU_ASSERT(rc == 0);
264 	CU_ASSERT(TAILQ_EMPTY(&tailq));
265 	SPDK_CU_ASSERT_FATAL(base != NULL);
266 
267 	part = calloc(1, sizeof(*part));
268 	SPDK_CU_ASSERT_FATAL(part != NULL);
269 	rc = spdk_bdev_part_construct(part, base, "test", 0, 100, "test");
270 	SPDK_CU_ASSERT_FATAL(rc == 0);
271 	poll_threads();
272 	CU_ASSERT(!TAILQ_EMPTY(&tailq));
273 
274 	spdk_bdev_unregister(&part->internal.bdev, NULL, NULL);
275 	poll_threads();
276 
277 	rc = spdk_bdev_part_free(part);
278 	CU_ASSERT(rc == 1);
279 	poll_threads();
280 	CU_ASSERT(TAILQ_EMPTY(&tailq));
281 
282 	spdk_bdev_unregister(&bdev_base, NULL, NULL);
283 	poll_threads();
284 }
285 
286 static void
287 part_get_io_channel_test(void)
288 {
289 	struct spdk_bdev_part_base	*base = NULL;
290 	struct spdk_bdev_desc   *desc = NULL;
291 	struct spdk_io_channel  *io_ch;
292 	struct spdk_bdev_part		*part;
293 	struct spdk_bdev		bdev_base = {};
294 	SPDK_BDEV_PART_TAILQ		tailq = TAILQ_HEAD_INITIALIZER(tailq);
295 	int rc;
296 
297 	ut_init_bdev();
298 	bdev_base.name = "base";
299 	bdev_base.blocklen = 512;
300 	bdev_base.blockcnt = 1024;
301 	bdev_base.fn_table = &base_fn_table;
302 	bdev_base.module = &bdev_ut_if;
303 	rc = spdk_bdev_register(&bdev_base);
304 	CU_ASSERT(rc == 0);
305 
306 	rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if,
307 					       &part_fn_table, &tailq, NULL,
308 					       NULL, 100, NULL, NULL, &base);
309 	CU_ASSERT(rc == 0);
310 	CU_ASSERT(TAILQ_EMPTY(&tailq));
311 	SPDK_CU_ASSERT_FATAL(base != NULL);
312 
313 	part = calloc(1, sizeof(*part));
314 	SPDK_CU_ASSERT_FATAL(part != NULL);
315 	rc = spdk_bdev_part_construct(part, base, "test", 0, 100, "test");
316 	SPDK_CU_ASSERT_FATAL(rc == 0);
317 	CU_ASSERT(!TAILQ_EMPTY(&tailq));
318 
319 	rc = spdk_bdev_open_ext("test", true, bdev_ut_event_cb, NULL, &desc);
320 	CU_ASSERT(rc == 0);
321 	SPDK_CU_ASSERT_FATAL(desc != NULL);
322 	CU_ASSERT(&part->internal.bdev == spdk_bdev_desc_get_bdev(desc));
323 
324 	io_ch = spdk_bdev_get_io_channel(desc);
325 	CU_ASSERT(io_ch != NULL);
326 	CU_ASSERT(g_part_ut_io_device == 1);
327 
328 	spdk_put_io_channel(io_ch);
329 	spdk_bdev_close(desc);
330 	spdk_bdev_unregister(&part->internal.bdev, NULL, NULL);
331 	poll_threads();
332 	CU_ASSERT(g_part_ut_io_device == 0);
333 
334 	rc = spdk_bdev_part_free(part);
335 	CU_ASSERT(rc == 1);
336 	poll_threads();
337 	CU_ASSERT(TAILQ_EMPTY(&tailq));
338 
339 	spdk_bdev_unregister(&bdev_base, NULL, NULL);
340 	ut_fini_bdev();
341 }
342 
343 int
344 main(int argc, char **argv)
345 {
346 	CU_pSuite		suite = NULL;
347 	unsigned int		num_failures;
348 
349 	CU_set_error_action(CUEA_ABORT);
350 	CU_initialize_registry();
351 
352 	suite = CU_add_suite("bdev_part", NULL, NULL);
353 
354 	CU_ADD_TEST(suite, part_test);
355 	CU_ADD_TEST(suite, part_free_test);
356 	CU_ADD_TEST(suite, part_get_io_channel_test);
357 
358 	allocate_cores(1);
359 	allocate_threads(1);
360 	set_thread(0);
361 
362 	CU_basic_set_mode(CU_BRM_VERBOSE);
363 	CU_basic_run_tests();
364 	num_failures = CU_get_number_of_failures();
365 	CU_cleanup_registry();
366 
367 	free_threads();
368 	free_cores();
369 
370 	return num_failures;
371 }
372