xref: /dpdk/drivers/raw/skeleton/skeleton_rawdev_test.c (revision db4e81351fb85ff623bd0438d1b5a8fb55fe9fee)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2017 NXP
3  */
4 
5 #include <rte_common.h>
6 #include <rte_mbuf.h>
7 #include <rte_malloc.h>
8 #include <rte_memcpy.h>
9 #include <rte_dev.h>
10 #include <rte_rawdev.h>
11 #include <rte_bus_vdev.h>
12 #include <rte_test.h>
13 
14 /* Using relative path as skeleton_rawdev is not part of exported headers */
15 #include "skeleton_rawdev.h"
16 
17 #define TEST_DEV_NAME "rawdev_skeleton"
18 
19 #define SKELDEV_LOGS(level, fmt, args...) \
20 	rte_log(RTE_LOG_ ## level, skeleton_pmd_logtype, fmt "\n", \
21 		##args)
22 
23 #define SKELDEV_TEST_INFO(fmt, args...) \
24 	SKELDEV_LOGS(INFO, fmt, ## args)
25 #define SKELDEV_TEST_DEBUG(fmt, args...) \
26 	SKELDEV_LOGS(DEBUG, fmt, ## args)
27 
28 #define SKELDEV_TEST_RUN(setup, teardown, test) \
29 	skeldev_test_run(setup, teardown, test, #test)
30 
31 #define TEST_SUCCESS 0
32 #define TEST_FAILED  -1
33 
34 static int total;
35 static int passed;
36 static int failed;
37 static int unsupported;
38 
39 static uint16_t test_dev_id;
40 
41 static int
42 testsuite_setup(void)
43 {
44 	uint8_t count;
45 	count = rte_rawdev_count();
46 	if (!count) {
47 		SKELDEV_TEST_INFO("\tNo existing rawdev; "
48 				  "Creating 'skeldev_rawdev'");
49 		return rte_vdev_init(TEST_DEV_NAME, NULL);
50 	}
51 
52 	return TEST_SUCCESS;
53 }
54 
55 static void local_teardown(void);
56 
57 static void
58 testsuite_teardown(void)
59 {
60 	local_teardown();
61 }
62 
63 static void
64 local_teardown(void)
65 {
66 	rte_vdev_uninit(TEST_DEV_NAME);
67 }
68 
69 static int
70 test_rawdev_count(void)
71 {
72 	uint8_t count;
73 	count = rte_rawdev_count();
74 	RTE_TEST_ASSERT(count > 0, "Invalid rawdev count %" PRIu8, count);
75 	return TEST_SUCCESS;
76 }
77 
78 static int
79 test_rawdev_get_dev_id(void)
80 {
81 	int ret;
82 	ret = rte_rawdev_get_dev_id("invalid_rawdev_device");
83 	RTE_TEST_ASSERT_FAIL(ret, "Expected <0 for invalid dev name ret=%d",
84 			     ret);
85 	return TEST_SUCCESS;
86 }
87 
88 static int
89 test_rawdev_socket_id(void)
90 {
91 	int socket_id;
92 	socket_id = rte_rawdev_socket_id(test_dev_id);
93 	RTE_TEST_ASSERT(socket_id != -EINVAL,
94 			"Failed to get socket_id %d", socket_id);
95 	socket_id = rte_rawdev_socket_id(RTE_RAWDEV_MAX_DEVS);
96 	RTE_TEST_ASSERT(socket_id == -EINVAL,
97 			"Expected -EINVAL %d", socket_id);
98 
99 	return TEST_SUCCESS;
100 }
101 
102 static int
103 test_rawdev_info_get(void)
104 {
105 	int ret;
106 	struct rte_rawdev_info rdev_info = {0};
107 	struct skeleton_rawdev_conf skel_conf = {0};
108 
109 	ret = rte_rawdev_info_get(test_dev_id, NULL, 0);
110 	RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret);
111 
112 	rdev_info.dev_private = &skel_conf;
113 
114 	ret = rte_rawdev_info_get(test_dev_id, &rdev_info, sizeof(skel_conf));
115 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to get raw dev info");
116 
117 	return TEST_SUCCESS;
118 }
119 
120 static int
121 test_rawdev_configure(void)
122 {
123 	int ret;
124 	struct rte_rawdev_info rdev_info = {0};
125 	struct skeleton_rawdev_conf rdev_conf_set = {0};
126 	struct skeleton_rawdev_conf rdev_conf_get = {0};
127 
128 	/* Check invalid configuration */
129 	ret = rte_rawdev_configure(test_dev_id, NULL, 0);
130 	RTE_TEST_ASSERT(ret == -EINVAL,
131 			"Null configure; Expected -EINVAL, got %d", ret);
132 
133 	/* Valid configuration test */
134 	rdev_conf_set.num_queues = 1;
135 	rdev_conf_set.capabilities = SKELETON_CAPA_FW_LOAD |
136 				     SKELETON_CAPA_FW_RESET;
137 
138 	rdev_info.dev_private = &rdev_conf_set;
139 	ret = rte_rawdev_configure(test_dev_id,
140 				   (rte_rawdev_obj_t)&rdev_info,
141 				   sizeof(rdev_conf_set));
142 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to configure rawdev (%d)", ret);
143 
144 	rdev_info.dev_private = &rdev_conf_get;
145 	ret = rte_rawdev_info_get(test_dev_id,
146 				  (rte_rawdev_obj_t)&rdev_info,
147 				  sizeof(rdev_conf_get));
148 	RTE_TEST_ASSERT_SUCCESS(ret,
149 				"Failed to obtain rawdev configuration (%d)",
150 				ret);
151 
152 	RTE_TEST_ASSERT_EQUAL(rdev_conf_set.num_queues,
153 			      rdev_conf_get.num_queues,
154 			      "Configuration test failed; num_queues (%d)(%d)",
155 			      rdev_conf_set.num_queues,
156 			      rdev_conf_get.num_queues);
157 	RTE_TEST_ASSERT_EQUAL(rdev_conf_set.capabilities,
158 			  rdev_conf_get.capabilities,
159 			  "Configuration test failed; capabilities");
160 
161 	return TEST_SUCCESS;
162 }
163 
164 static int
165 test_rawdev_queue_default_conf_get(void)
166 {
167 	int ret, i;
168 	struct rte_rawdev_info rdev_info = {0};
169 	struct skeleton_rawdev_conf rdev_conf_get = {0};
170 	struct skeleton_rawdev_queue q = {0};
171 
172 	/* Get the current configuration */
173 	rdev_info.dev_private = &rdev_conf_get;
174 	ret = rte_rawdev_info_get(test_dev_id,
175 				  (rte_rawdev_obj_t)&rdev_info,
176 				  sizeof(rdev_conf_get));
177 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to obtain rawdev configuration (%d)",
178 				ret);
179 
180 	/* call to test_rawdev_configure would have set the num_queues = 1 */
181 	RTE_TEST_ASSERT_SUCCESS(!(rdev_conf_get.num_queues > 0),
182 				"Invalid number of queues (%d). Expected 1",
183 				rdev_conf_get.num_queues);
184 	/* All queues by default should have state = DETACH and
185 	 * depth = DEF_DEPTH
186 	 */
187 	for (i = 0; i < rdev_conf_get.num_queues; i++) {
188 		rte_rawdev_queue_conf_get(test_dev_id, i, &q, sizeof(q));
189 		RTE_TEST_ASSERT_EQUAL(q.depth, SKELETON_QUEUE_DEF_DEPTH,
190 				      "Invalid default depth of queue (%d)",
191 				      q.depth);
192 		RTE_TEST_ASSERT_EQUAL(q.state, SKELETON_QUEUE_DETACH,
193 				      "Invalid default state of queue (%d)",
194 				      q.state);
195 	}
196 
197 	return TEST_SUCCESS;
198 }
199 
200 static int
201 test_rawdev_queue_count(void)
202 {
203 	unsigned int q_count;
204 
205 	/* Get the current configuration */
206 	q_count = rte_rawdev_queue_count(test_dev_id);
207 	RTE_TEST_ASSERT_EQUAL(q_count, 1, "Invalid queue count (%d)", q_count);
208 
209 	return TEST_SUCCESS;
210 }
211 
212 static int
213 test_rawdev_queue_setup(void)
214 {
215 	int ret;
216 	struct rte_rawdev_info rdev_info = {0};
217 	struct skeleton_rawdev_conf rdev_conf_get = {0};
218 	struct skeleton_rawdev_queue qset = {0};
219 	struct skeleton_rawdev_queue qget = {0};
220 
221 	/* Get the current configuration */
222 	rdev_info.dev_private = &rdev_conf_get;
223 	ret = rte_rawdev_info_get(test_dev_id,
224 				  (rte_rawdev_obj_t)&rdev_info,
225 				  sizeof(rdev_conf_get));
226 	RTE_TEST_ASSERT_SUCCESS(ret,
227 				"Failed to obtain rawdev configuration (%d)",
228 				ret);
229 
230 	/* call to test_rawdev_configure would have set the num_queues = 1 */
231 	RTE_TEST_ASSERT_SUCCESS(!(rdev_conf_get.num_queues > 0),
232 				"Invalid number of queues (%d). Expected 1",
233 				rdev_conf_get.num_queues);
234 
235 	/* Modify the queue depth for Queue 0 and attach it */
236 	qset.depth = 15;
237 	qset.state = SKELETON_QUEUE_ATTACH;
238 	ret = rte_rawdev_queue_setup(test_dev_id, 0, &qset, sizeof(qset));
239 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to setup queue (%d)", ret);
240 
241 	/* Now, fetching the queue 0 should show depth as 15 */
242 	ret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget, sizeof(qget));
243 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to get queue config (%d)", ret);
244 
245 	RTE_TEST_ASSERT_EQUAL(qset.depth, qget.depth,
246 			      "Failed to set queue depth: Need(%d), has(%d)",
247 			      qset.depth, qget.depth);
248 
249 	return TEST_SUCCESS;
250 }
251 
252 /* After executing test_rawdev_queue_setup, queue_id=0 would have depth as 15.
253  * Releasing should set it back to default. state would set to DETACH
254  */
255 static int
256 test_rawdev_queue_release(void)
257 {
258 	int ret;
259 	struct skeleton_rawdev_queue qget = {0};
260 
261 	/* Now, fetching the queue 0 should show depth as 100 */
262 	ret = rte_rawdev_queue_release(test_dev_id, 0);
263 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to release queue 0; (%d)", ret);
264 
265 	/* Now, fetching the queue 0 should show depth as default */
266 	ret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget, sizeof(qget));
267 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to get queue config (%d)", ret);
268 
269 	RTE_TEST_ASSERT_EQUAL(qget.depth, SKELETON_QUEUE_DEF_DEPTH,
270 			      "Release of Queue 0 failed; (depth)");
271 
272 	RTE_TEST_ASSERT_EQUAL(qget.state, SKELETON_QUEUE_DETACH,
273 			      "Release of Queue 0 failed; (state)");
274 
275 	return TEST_SUCCESS;
276 }
277 
278 static int
279 test_rawdev_attr_set_get(void)
280 {
281 	int ret;
282 	int *dummy_value, set_value;
283 	uint64_t ret_value;
284 
285 	/* Set an attribute and fetch it */
286 	ret = rte_rawdev_set_attr(test_dev_id, "Test1", 100);
287 	RTE_TEST_ASSERT(!ret, "Unable to set an attribute (Test1)");
288 
289 	dummy_value = &set_value;
290 	*dummy_value = 200;
291 	ret = rte_rawdev_set_attr(test_dev_id, "Test2", (uintptr_t)dummy_value);
292 
293 	/* Check if attributes have been set */
294 	ret = rte_rawdev_get_attr(test_dev_id, "Test1", &ret_value);
295 	RTE_TEST_ASSERT_EQUAL(ret_value, 100,
296 			      "Attribute (Test1) not set correctly (%" PRIu64 ")",
297 			      ret_value);
298 
299 	ret_value = 0;
300 	ret = rte_rawdev_get_attr(test_dev_id, "Test2", &ret_value);
301 	RTE_TEST_ASSERT_EQUAL(*((int *)(uintptr_t)ret_value), set_value,
302 			      "Attribute (Test2) not set correctly (%" PRIu64 ")",
303 			      ret_value);
304 
305 	return TEST_SUCCESS;
306 }
307 
308 static int
309 test_rawdev_start_stop(void)
310 {
311 	int ret;
312 	struct rte_rawdev_info rdev_info = {0};
313 	struct skeleton_rawdev_conf rdev_conf_get = {0};
314 	char *dummy_firmware = NULL;
315 
316 	/* Get the current configuration */
317 	rdev_info.dev_private = &rdev_conf_get;
318 
319 	/* Load a firmware using a dummy address area */
320 	dummy_firmware = rte_zmalloc("RAWDEV SKELETON", sizeof(int) * 10, 0);
321 	RTE_TEST_ASSERT(dummy_firmware != NULL,
322 			"Failed to create firmware memory backing");
323 
324 	ret = rte_rawdev_firmware_load(test_dev_id, dummy_firmware);
325 	RTE_TEST_ASSERT_SUCCESS(ret, "Firmware loading failed (%d)", ret);
326 
327 	/* Skeleton doesn't do anything with the firmware area - that is dummy
328 	 * and can be removed.
329 	 */
330 	rte_free(dummy_firmware);
331 	dummy_firmware = NULL;
332 
333 	rte_rawdev_start(test_dev_id);
334 	ret = rte_rawdev_info_get(test_dev_id, (rte_rawdev_obj_t)&rdev_info,
335 			sizeof(rdev_conf_get));
336 	RTE_TEST_ASSERT_SUCCESS(ret,
337 				"Failed to obtain rawdev configuration (%d)",
338 				ret);
339 	RTE_TEST_ASSERT_EQUAL(rdev_conf_get.device_state, SKELETON_DEV_RUNNING,
340 			      "Device start failed. State is (%d)",
341 			      rdev_conf_get.device_state);
342 
343 	rte_rawdev_stop(test_dev_id);
344 	ret = rte_rawdev_info_get(test_dev_id, (rte_rawdev_obj_t)&rdev_info,
345 			sizeof(rdev_conf_get));
346 	RTE_TEST_ASSERT_SUCCESS(ret,
347 				"Failed to obtain rawdev configuration (%d)",
348 				ret);
349 	RTE_TEST_ASSERT_EQUAL(rdev_conf_get.device_state, SKELETON_DEV_STOPPED,
350 			      "Device stop failed. State is (%d)",
351 			      rdev_conf_get.device_state);
352 
353 	/* Unloading the firmware once device is stopped */
354 	ret = rte_rawdev_firmware_unload(test_dev_id);
355 	RTE_TEST_ASSERT_SUCCESS(ret, "Failed to unload firmware (%d)", ret);
356 
357 	return TEST_SUCCESS;
358 }
359 
360 static int
361 test_rawdev_enqdeq(void)
362 {
363 	int ret;
364 	unsigned int count = 1;
365 	uint16_t queue_id = 0;
366 	struct rte_rawdev_buf buffers[1];
367 	struct rte_rawdev_buf *deq_buffers = NULL;
368 
369 	buffers[0].buf_addr = malloc(strlen(TEST_DEV_NAME) + 3);
370 	if (!buffers[0].buf_addr)
371 		goto cleanup;
372 	snprintf(buffers[0].buf_addr, strlen(TEST_DEV_NAME) + 2, "%s%d",
373 		 TEST_DEV_NAME, 0);
374 
375 	ret = rte_rawdev_enqueue_buffers(test_dev_id,
376 					 (struct rte_rawdev_buf **)&buffers,
377 					 count, &queue_id);
378 	RTE_TEST_ASSERT_EQUAL((unsigned int)ret, count,
379 			      "Unable to enqueue buffers");
380 
381 	deq_buffers = malloc(sizeof(struct rte_rawdev_buf) * count);
382 	if (!deq_buffers)
383 		goto cleanup;
384 
385 	ret = rte_rawdev_dequeue_buffers(test_dev_id,
386 					(struct rte_rawdev_buf **)&deq_buffers,
387 					count, &queue_id);
388 	RTE_TEST_ASSERT_EQUAL((unsigned int)ret, count,
389 			      "Unable to dequeue buffers");
390 
391 	if (deq_buffers)
392 		free(deq_buffers);
393 
394 	return TEST_SUCCESS;
395 cleanup:
396 	if (buffers[0].buf_addr)
397 		free(buffers[0].buf_addr);
398 
399 	return TEST_FAILED;
400 }
401 
402 static void skeldev_test_run(int (*setup)(void),
403 			     void (*teardown)(void),
404 			     int (*test)(void),
405 			     const char *name)
406 {
407 	int ret = 0;
408 
409 	if (setup) {
410 		ret = setup();
411 		if (ret < 0) {
412 			SKELDEV_TEST_INFO("Error setting up test %s", name);
413 			unsupported++;
414 		}
415 	}
416 
417 	if (test) {
418 		ret = test();
419 		if (ret < 0) {
420 			failed++;
421 			SKELDEV_TEST_INFO("%s Failed", name);
422 		} else {
423 			passed++;
424 			SKELDEV_TEST_DEBUG("%s Passed", name);
425 		}
426 	}
427 
428 	if (teardown)
429 		teardown();
430 
431 	total++;
432 }
433 
434 int
435 test_rawdev_skeldev(uint16_t dev_id)
436 {
437 	test_dev_id = dev_id;
438 	testsuite_setup();
439 
440 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_count);
441 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_get_dev_id);
442 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_socket_id);
443 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_info_get);
444 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_configure);
445 	SKELDEV_TEST_RUN(test_rawdev_configure, NULL,
446 			 test_rawdev_queue_default_conf_get);
447 	SKELDEV_TEST_RUN(test_rawdev_configure, NULL, test_rawdev_queue_setup);
448 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_queue_count);
449 	SKELDEV_TEST_RUN(test_rawdev_queue_setup, NULL,
450 			 test_rawdev_queue_release);
451 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_attr_set_get);
452 	SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_start_stop);
453 	SKELDEV_TEST_RUN(test_rawdev_queue_setup, NULL, test_rawdev_enqdeq);
454 
455 	testsuite_teardown();
456 
457 	SKELDEV_TEST_INFO("Total tests   : %d", total);
458 	SKELDEV_TEST_INFO("Passed        : %d", passed);
459 	SKELDEV_TEST_INFO("Failed        : %d", failed);
460 	SKELDEV_TEST_INFO("Not supported : %d", unsupported);
461 
462 	if (failed)
463 		return -1;
464 
465 	return 0;
466 };
467