xref: /dpdk/app/test/test.c (revision 5a196330)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4 
5 #include <string.h>
6 #include <stdio.h>
7 #include <stdint.h>
8 #include <stdarg.h>
9 #include <stdlib.h>
10 #include <errno.h>
11 #include <termios.h>
12 #include <ctype.h>
13 #include <sys/queue.h>
14 
15 #ifdef RTE_LIB_CMDLINE
16 #include <cmdline_rdline.h>
17 #include <cmdline_parse.h>
18 #include <cmdline_socket.h>
19 #include <cmdline.h>
20 extern cmdline_parse_ctx_t main_ctx[];
21 #endif
22 
23 #include <rte_memory.h>
24 #include <rte_eal.h>
25 #include <rte_cycles.h>
26 #include <rte_log.h>
27 #include <rte_string_fns.h>
28 #ifdef RTE_LIB_TIMER
29 #include <rte_timer.h>
30 #endif
31 
32 #include "test.h"
33 #ifdef RTE_LIB_PDUMP
34 #include "test_pdump.h"
35 #endif
36 
37 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
38 
39 const char *prgname; /* to be set to argv[0] */
40 
41 static const char *recursive_call; /* used in linux for MP and other tests */
42 
43 static int
44 no_action(void){ return 0; }
45 
46 static int
47 do_recursive_call(void)
48 {
49 	unsigned i;
50 	struct {
51 		const char *env_var;
52 		int (*action_fn)(void);
53 	} actions[] =  {
54 			{ "run_secondary_instances", test_mp_secondary },
55 #ifdef RTE_LIB_PDUMP
56 #ifdef RTE_NET_RING
57 			{ "run_pdump_server_tests", test_pdump },
58 #endif
59 #endif
60 			{ "test_missing_c_flag", no_action },
61 			{ "test_main_lcore_flag", no_action },
62 			{ "test_invalid_n_flag", no_action },
63 			{ "test_no_hpet_flag", no_action },
64 			{ "test_allow_flag", no_action },
65 			{ "test_invalid_b_flag", no_action },
66 			{ "test_invalid_vdev_flag", no_action },
67 			{ "test_invalid_r_flag", no_action },
68 			{ "test_misc_flags", no_action },
69 			{ "test_memory_flags", no_action },
70 			{ "test_file_prefix", no_action },
71 			{ "test_no_huge_flag", no_action },
72 #ifdef RTE_LIB_TIMER
73 			{ "timer_secondary_spawn_wait", test_timer_secondary },
74 #endif
75 	};
76 
77 	if (recursive_call == NULL)
78 		return -1;
79 	for (i = 0; i < RTE_DIM(actions); i++) {
80 		if (strcmp(actions[i].env_var, recursive_call) == 0)
81 			return (actions[i].action_fn)();
82 	}
83 	printf("ERROR - missing action to take for %s\n", recursive_call);
84 	return -1;
85 }
86 
87 int last_test_result;
88 
89 #define MAX_EXTRA_ARGS 32
90 
91 int
92 main(int argc, char **argv)
93 {
94 #ifdef RTE_LIB_CMDLINE
95 	struct cmdline *cl;
96 #endif
97 	char *extra_args;
98 	int ret;
99 
100 	extra_args = getenv("DPDK_TEST_PARAMS");
101 	if (extra_args != NULL && strlen(extra_args) > 0) {
102 		char **all_argv;
103 		char *eargv[MAX_EXTRA_ARGS];
104 		int all_argc;
105 		int eargc;
106 		int i;
107 
108 		RTE_LOG(INFO, APP, "Using additional DPDK_TEST_PARAMS: '%s'\n",
109 				extra_args);
110 		eargc = rte_strsplit(extra_args, strlen(extra_args),
111 				eargv, MAX_EXTRA_ARGS, ' ');
112 
113 		/* merge argc/argv and the environment args */
114 		all_argc = argc + eargc;
115 		all_argv = malloc(sizeof(*all_argv) * (all_argc + 1));
116 		if (all_argv == NULL) {
117 			ret = -1;
118 			goto out;
119 		}
120 
121 		for (i = 0; i < argc; i++)
122 			all_argv[i] = argv[i];
123 		for (i = 0; i < eargc; i++)
124 			all_argv[argc + i] = eargv[i];
125 		all_argv[all_argc] = NULL;
126 
127 		/* call eal_init with combined args */
128 		ret = rte_eal_init(all_argc, all_argv);
129 		free(all_argv);
130 	} else
131 		ret = rte_eal_init(argc, argv);
132 	if (ret < 0) {
133 		ret = -1;
134 		goto out;
135 	}
136 
137 #ifdef RTE_LIB_TIMER
138 	if (rte_timer_subsystem_init() < 0) {
139 		ret = -1;
140 		goto out;
141 	}
142 #endif
143 
144 	if (commands_init() < 0) {
145 		ret = -1;
146 		goto out;
147 	}
148 
149 	argv += ret;
150 
151 	prgname = argv[0];
152 
153 	recursive_call = getenv(RECURSIVE_ENV_VAR);
154 	if (recursive_call != NULL) {
155 		ret = do_recursive_call();
156 		goto out;
157 	}
158 
159 #ifdef RTE_LIBEAL_USE_HPET
160 	if (rte_eal_hpet_init(1) < 0)
161 #endif
162 		RTE_LOG(INFO, APP,
163 				"HPET is not enabled, using TSC as default timer\n");
164 
165 
166 #ifdef RTE_LIB_CMDLINE
167 	char *dpdk_test = getenv("DPDK_TEST");
168 	if (dpdk_test && strlen(dpdk_test)) {
169 		char buf[1024];
170 
171 		cl = cmdline_new(main_ctx, "RTE>>", 0, 1);
172 		if (cl == NULL) {
173 			ret = -1;
174 			goto out;
175 		}
176 
177 		snprintf(buf, sizeof(buf), "%s\n", dpdk_test);
178 		if (cmdline_in(cl, buf, strlen(buf)) < 0) {
179 			printf("error on cmdline input\n");
180 
181 			ret = -1;
182 		} else {
183 			ret = last_test_result;
184 		}
185 		cmdline_free(cl);
186 		goto out;
187 	} else {
188 		/* if no DPDK_TEST env variable, go interactive */
189 		cl = cmdline_stdin_new(main_ctx, "RTE>>");
190 		if (cl == NULL) {
191 			ret = -1;
192 			goto out;
193 		}
194 
195 		cmdline_interact(cl);
196 		cmdline_stdin_exit(cl);
197 		cmdline_free(cl);
198 	}
199 #endif
200 	ret = 0;
201 
202 out:
203 #ifdef RTE_LIB_TIMER
204 	rte_timer_subsystem_finalize();
205 #endif
206 	rte_eal_cleanup();
207 	return ret;
208 }
209 
210 
211 int
212 unit_test_suite_runner(struct unit_test_suite *suite)
213 {
214 	int test_success;
215 	unsigned int total = 0, executed = 0, skipped = 0;
216 	unsigned int succeeded = 0, failed = 0, unsupported = 0;
217 	const char *status;
218 
219 	if (suite->suite_name) {
220 		printf(" + ------------------------------------------------------- +\n");
221 		printf(" + Test Suite : %s\n", suite->suite_name);
222 	}
223 
224 	if (suite->setup) {
225 		test_success = suite->setup();
226 		if (test_success != 0) {
227 			/*
228 			 * setup did not pass, so count all enabled tests and
229 			 * mark them as failed/skipped
230 			 */
231 			while (suite->unit_test_cases[total].testcase) {
232 				if (!suite->unit_test_cases[total].enabled ||
233 				    test_success == TEST_SKIPPED)
234 					skipped++;
235 				else
236 					failed++;
237 				total++;
238 			}
239 			goto suite_summary;
240 		}
241 	}
242 
243 	printf(" + ------------------------------------------------------- +\n");
244 
245 	while (suite->unit_test_cases[total].testcase) {
246 		if (!suite->unit_test_cases[total].enabled) {
247 			skipped++;
248 			total++;
249 			continue;
250 		} else {
251 			executed++;
252 		}
253 
254 		/* run test case setup */
255 		if (suite->unit_test_cases[total].setup)
256 			test_success = suite->unit_test_cases[total].setup();
257 		else
258 			test_success = TEST_SUCCESS;
259 
260 		if (test_success == TEST_SUCCESS) {
261 			/* run the test case */
262 			test_success = suite->unit_test_cases[total].testcase();
263 			if (test_success == TEST_SUCCESS)
264 				succeeded++;
265 			else if (test_success == TEST_SKIPPED)
266 				skipped++;
267 			else if (test_success == -ENOTSUP)
268 				unsupported++;
269 			else
270 				failed++;
271 		} else if (test_success == -ENOTSUP) {
272 			unsupported++;
273 		} else {
274 			failed++;
275 		}
276 
277 		/* run the test case teardown */
278 		if (suite->unit_test_cases[total].teardown)
279 			suite->unit_test_cases[total].teardown();
280 
281 		if (test_success == TEST_SUCCESS)
282 			status = "succeeded";
283 		else if (test_success == TEST_SKIPPED)
284 			status = "skipped";
285 		else if (test_success == -ENOTSUP)
286 			status = "unsupported";
287 		else
288 			status = "failed";
289 
290 		printf(" + TestCase [%2d] : %s %s\n", total,
291 				suite->unit_test_cases[total].name, status);
292 
293 		total++;
294 	}
295 
296 	/* Run test suite teardown */
297 	if (suite->teardown)
298 		suite->teardown();
299 
300 	goto suite_summary;
301 
302 suite_summary:
303 	printf(" + ------------------------------------------------------- +\n");
304 	printf(" + Test Suite Summary \n");
305 	printf(" + Tests Total :       %2d\n", total);
306 	printf(" + Tests Skipped :     %2d\n", skipped);
307 	printf(" + Tests Executed :    %2d\n", executed);
308 	printf(" + Tests Unsupported:  %2d\n", unsupported);
309 	printf(" + Tests Passed :      %2d\n", succeeded);
310 	printf(" + Tests Failed :      %2d\n", failed);
311 	printf(" + ------------------------------------------------------- +\n");
312 
313 	last_test_result = failed;
314 
315 	if (failed)
316 		return TEST_FAILED;
317 	if (total == skipped)
318 		return TEST_SKIPPED;
319 	return TEST_SUCCESS;
320 }
321