xref: /spdk/test/unit/lib/bdev/part.c/part_ut.c (revision 784b9d48746955f210926648a0131f84f58de76f)
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 bdev_ut_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx)
184 {
185 }
186 
187 static void
188 part_test(void)
189 {
190 	struct spdk_bdev_part_base	*base;
191 	struct spdk_bdev_part		part1 = {};
192 	struct spdk_bdev_part		part2 = {};
193 	struct spdk_bdev		bdev_base = {};
194 	SPDK_BDEV_PART_TAILQ		tailq = TAILQ_HEAD_INITIALIZER(tailq);
195 	int rc;
196 
197 	bdev_base.name = "base";
198 	bdev_base.fn_table = &base_fn_table;
199 	bdev_base.module = &bdev_ut_if;
200 	rc = spdk_bdev_register(&bdev_base);
201 	CU_ASSERT(rc == 0);
202 	rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if,
203 					       &part_fn_table, &tailq, NULL,
204 					       NULL, 0, NULL, NULL, &base);
205 
206 	CU_ASSERT(rc == 0);
207 	SPDK_CU_ASSERT_FATAL(base != NULL);
208 
209 	rc = spdk_bdev_part_construct(&part1, base, "test1", 0, 100, "test");
210 	SPDK_CU_ASSERT_FATAL(rc == 0);
211 	rc = spdk_bdev_part_construct(&part2, base, "test2", 100, 100, "test");
212 	SPDK_CU_ASSERT_FATAL(rc == 0);
213 
214 	spdk_bdev_part_base_hotremove(base, &tailq);
215 
216 	spdk_bdev_part_base_free(base);
217 	_part_cleanup(&part1);
218 	_part_cleanup(&part2);
219 	spdk_bdev_unregister(&bdev_base, NULL, NULL);
220 
221 	poll_threads();
222 }
223 
224 static void
225 part_free_test(void)
226 {
227 	struct spdk_bdev_part_base	*base = NULL;
228 	struct spdk_bdev_part		*part;
229 	struct spdk_bdev		bdev_base = {};
230 	SPDK_BDEV_PART_TAILQ		tailq = TAILQ_HEAD_INITIALIZER(tailq);
231 	int rc;
232 
233 	bdev_base.name = "base";
234 	bdev_base.fn_table = &base_fn_table;
235 	bdev_base.module = &bdev_ut_if;
236 	rc = spdk_bdev_register(&bdev_base);
237 	CU_ASSERT(rc == 0);
238 	poll_threads();
239 
240 	rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if,
241 					       &part_fn_table, &tailq, NULL,
242 					       NULL, 0, NULL, NULL, &base);
243 	CU_ASSERT(rc == 0);
244 	CU_ASSERT(TAILQ_EMPTY(&tailq));
245 	SPDK_CU_ASSERT_FATAL(base != NULL);
246 
247 	part = calloc(1, sizeof(*part));
248 	SPDK_CU_ASSERT_FATAL(part != NULL);
249 	rc = spdk_bdev_part_construct(part, base, "test", 0, 100, "test");
250 	SPDK_CU_ASSERT_FATAL(rc == 0);
251 	poll_threads();
252 	CU_ASSERT(!TAILQ_EMPTY(&tailq));
253 
254 	spdk_bdev_unregister(&part->internal.bdev, NULL, NULL);
255 	poll_threads();
256 
257 	rc = spdk_bdev_part_free(part);
258 	CU_ASSERT(rc == 1);
259 	poll_threads();
260 	CU_ASSERT(TAILQ_EMPTY(&tailq));
261 
262 	spdk_bdev_unregister(&bdev_base, NULL, NULL);
263 	poll_threads();
264 }
265 
266 static void
267 part_get_io_channel_test(void)
268 {
269 	struct spdk_bdev_part_base	*base = NULL;
270 	struct spdk_bdev_desc   *desc = NULL;
271 	struct spdk_io_channel  *io_ch;
272 	struct spdk_bdev_part		*part;
273 	struct spdk_bdev		bdev_base = {};
274 	SPDK_BDEV_PART_TAILQ		tailq = TAILQ_HEAD_INITIALIZER(tailq);
275 	int rc;
276 
277 	spdk_bdev_initialize(bdev_init_cb, NULL);
278 
279 	bdev_base.name = "base";
280 	bdev_base.blocklen = 512;
281 	bdev_base.blockcnt = 1024;
282 	bdev_base.fn_table = &base_fn_table;
283 	bdev_base.module = &bdev_ut_if;
284 	rc = spdk_bdev_register(&bdev_base);
285 	CU_ASSERT(rc == 0);
286 
287 	rc = spdk_bdev_part_base_construct_ext("base", NULL, &vbdev_ut_if,
288 					       &part_fn_table, &tailq, NULL,
289 					       NULL, 100, NULL, NULL, &base);
290 	CU_ASSERT(rc == 0);
291 	CU_ASSERT(TAILQ_EMPTY(&tailq));
292 	SPDK_CU_ASSERT_FATAL(base != NULL);
293 
294 	part = calloc(1, sizeof(*part));
295 	SPDK_CU_ASSERT_FATAL(part != NULL);
296 	rc = spdk_bdev_part_construct(part, base, "test", 0, 100, "test");
297 	SPDK_CU_ASSERT_FATAL(rc == 0);
298 	CU_ASSERT(!TAILQ_EMPTY(&tailq));
299 
300 	rc = spdk_bdev_open_ext("test", true, bdev_ut_event_cb, NULL, &desc);
301 	CU_ASSERT(rc == 0);
302 	SPDK_CU_ASSERT_FATAL(desc != NULL);
303 	CU_ASSERT(&part->internal.bdev == spdk_bdev_desc_get_bdev(desc));
304 
305 	io_ch = spdk_bdev_get_io_channel(desc);
306 	CU_ASSERT(io_ch != NULL);
307 	CU_ASSERT(g_part_ut_io_device == 1);
308 
309 	spdk_put_io_channel(io_ch);
310 	spdk_bdev_close(desc);
311 	spdk_bdev_unregister(&part->internal.bdev, NULL, NULL);
312 	poll_threads();
313 	CU_ASSERT(g_part_ut_io_device == 0);
314 
315 	rc = spdk_bdev_part_free(part);
316 	CU_ASSERT(rc == 1);
317 	poll_threads();
318 	CU_ASSERT(TAILQ_EMPTY(&tailq));
319 
320 	spdk_bdev_unregister(&bdev_base, NULL, NULL);
321 	spdk_bdev_finish(bdev_fini_cb, NULL);
322 	poll_threads();
323 }
324 
325 int
326 main(int argc, char **argv)
327 {
328 	CU_pSuite		suite = NULL;
329 	unsigned int		num_failures;
330 
331 	CU_set_error_action(CUEA_ABORT);
332 	CU_initialize_registry();
333 
334 	suite = CU_add_suite("bdev_part", NULL, NULL);
335 
336 	CU_ADD_TEST(suite, part_test);
337 	CU_ADD_TEST(suite, part_free_test);
338 	CU_ADD_TEST(suite, part_get_io_channel_test);
339 
340 	allocate_cores(1);
341 	allocate_threads(1);
342 	set_thread(0);
343 
344 	CU_basic_set_mode(CU_BRM_VERBOSE);
345 	CU_basic_run_tests();
346 	num_failures = CU_get_number_of_failures();
347 	CU_cleanup_registry();
348 
349 	free_threads();
350 	free_cores();
351 
352 	return num_failures;
353 }
354