1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #include <rte_common.h>
6 #include <rte_hexdump.h>
8 #include <rte_malloc.h>
9 #include <rte_memcpy.h>
10 #include <rte_cycles.h>
12 #include <rte_service.h>
13 #include <rte_service_component.h>
17 /* used as the service core ID */
18 static uint32_t slcore_id;
19 /* used as timestamp to detect if a service core is running */
20 static uint64_t service_tick;
21 /* used as a flag to check if a function was run */
22 static uint32_t service_remote_launch_flag;
24 #define SERVICE_DELAY 1
26 #define DUMMY_SERVICE_NAME "dummy_service"
27 #define MT_SAFE_SERVICE_NAME "mt_safe_service"
32 slcore_id = rte_get_next_lcore(/* start core */ -1,
40 testsuite_teardown(void)
42 /* release service cores? */
45 static int32_t dummy_cb(void *args)
49 rte_delay_ms(SERVICE_DELAY);
53 static int32_t dummy_mt_unsafe_cb(void *args)
55 /* before running test, the initialization has set pass_test to 1.
56 * If the cmpset in service-cores is working correctly, the code here
57 * should never fail to take the lock. If the lock *is* taken, fail the
58 * test, because two threads are concurrently in a non-MT safe callback.
60 uint32_t *test_params = args;
61 uint32_t *atomic_lock = &test_params[0];
62 uint32_t *pass_test = &test_params[1];
63 int lock_taken = rte_atomic32_cmpset(atomic_lock, 0, 1);
65 /* delay with the lock held */
67 rte_atomic32_clear((rte_atomic32_t *)atomic_lock);
69 /* 2nd thread will fail to take lock, so set pass flag */
77 static int32_t dummy_mt_safe_cb(void *args)
79 /* Atomic checks to ensure MT safe services allow > 1 thread to
80 * concurrently run the callback. The concept is as follows;
81 * 1) if lock is available, take the lock then delay
82 * 2) if first lock is taken, and a thread arrives in the CB, we know
83 * that 2 threads are running the callback at the same time: MT safe
85 uint32_t *test_params = args;
86 uint32_t *atomic_lock = &test_params[0];
87 uint32_t *pass_test = &test_params[1];
88 int lock_taken = rte_atomic32_cmpset(atomic_lock, 0, 1);
90 /* delay with the lock held */
92 rte_atomic32_clear((rte_atomic32_t *)atomic_lock);
94 /* 2nd thread will fail to take lock, so set pass flag */
101 /* unregister all services */
107 TEST_ASSERT_EQUAL(-EINVAL, rte_service_component_unregister(1000),
108 "Unregistered invalid service id");
110 uint32_t c = rte_service_get_count();
111 for (i = 0; i < c; i++) {
112 TEST_ASSERT_EQUAL(0, rte_service_component_unregister(i),
113 "Error unregistering a valid service");
116 rte_service_lcore_reset_all();
121 /* register a single dummy service */
125 /* make sure there are no remains from previous tests */
128 struct rte_service_spec service;
129 memset(&service, 0, sizeof(struct rte_service_spec));
131 TEST_ASSERT_EQUAL(-EINVAL,
132 rte_service_component_register(&service, NULL),
134 service.callback = dummy_cb;
136 TEST_ASSERT_EQUAL(-EINVAL,
137 rte_service_component_register(&service, NULL),
139 snprintf(service.name, sizeof(service.name), DUMMY_SERVICE_NAME);
142 TEST_ASSERT_EQUAL(0, rte_service_component_register(&service, &id),
143 "Failed to register valid service");
145 rte_service_component_runstate_set(id, 1);
150 /* verify get_by_name() service lookup */
152 service_get_by_name(void)
157 TEST_ASSERT_EQUAL(-ENODEV,
158 rte_service_get_by_name(DUMMY_SERVICE_NAME, &sid),
159 "get by name with invalid name should return -ENODEV");
160 TEST_ASSERT_EQUAL(-EINVAL,
161 rte_service_get_by_name(DUMMY_SERVICE_NAME, 0x0),
162 "get by name with NULL ptr should return -ENODEV");
164 /* register service */
165 struct rte_service_spec service;
166 memset(&service, 0, sizeof(struct rte_service_spec));
167 TEST_ASSERT_EQUAL(-EINVAL,
168 rte_service_component_register(&service, NULL),
170 service.callback = dummy_cb;
171 TEST_ASSERT_EQUAL(-EINVAL,
172 rte_service_component_register(&service, NULL),
174 snprintf(service.name, sizeof(service.name), DUMMY_SERVICE_NAME);
175 TEST_ASSERT_EQUAL(0, rte_service_component_register(&service, NULL),
176 "Failed to register valid service");
178 /* we unregistered all service, now registering 1, should be id 0 */
179 uint32_t service_id_as_expected = 0;
180 TEST_ASSERT_EQUAL(0, rte_service_get_by_name(DUMMY_SERVICE_NAME, &sid),
181 "Service get_by_name should return 0 on valid inputs");
182 TEST_ASSERT_EQUAL(service_id_as_expected, sid,
183 "Service get_by_name should equal expected id");
187 /* ensure after unregister, get_by_name returns NULL */
188 TEST_ASSERT_EQUAL(-ENODEV,
189 rte_service_get_by_name(DUMMY_SERVICE_NAME, &sid),
190 "get by name should return -ENODEV after unregister");
195 /* verify probe of capabilities */
197 service_probe_capability(void)
201 struct rte_service_spec service;
202 memset(&service, 0, sizeof(struct rte_service_spec));
203 service.callback = dummy_cb;
204 snprintf(service.name, sizeof(service.name), DUMMY_SERVICE_NAME);
205 service.capabilities |= RTE_SERVICE_CAP_MT_SAFE;
206 TEST_ASSERT_EQUAL(0, rte_service_component_register(&service, NULL),
207 "Register of MT SAFE service failed");
209 /* verify flag is enabled */
210 const uint32_t sid = 0;
211 int32_t mt = rte_service_probe_capability(sid, RTE_SERVICE_CAP_MT_SAFE);
212 TEST_ASSERT_EQUAL(1, mt, "MT SAFE capability flag not set.");
217 memset(&service, 0, sizeof(struct rte_service_spec));
218 service.callback = dummy_cb;
219 snprintf(service.name, sizeof(service.name), DUMMY_SERVICE_NAME);
220 TEST_ASSERT_EQUAL(0, rte_service_component_register(&service, NULL),
221 "Register of non-MT safe service failed");
223 /* verify flag is enabled */
224 mt = rte_service_probe_capability(sid, RTE_SERVICE_CAP_MT_SAFE);
225 TEST_ASSERT_EQUAL(0, mt, "MT SAFE cap flag set on non MT SAFE service");
227 return unregister_all();
230 /* verify the service name */
234 const char *name = rte_service_get_name(0);
235 int equal = strcmp(name, DUMMY_SERVICE_NAME);
236 TEST_ASSERT_EQUAL(0, equal, "Error: Service name not correct");
238 return unregister_all();
241 /* verify service dump */
245 const uint32_t sid = 0;
246 rte_service_set_stats_enable(sid, 1);
247 rte_service_dump(stdout, 0);
248 rte_service_set_stats_enable(sid, 0);
249 rte_service_dump(stdout, 0);
250 return unregister_all();
253 /* start and stop a service */
255 service_start_stop(void)
257 const uint32_t sid = 0;
259 /* runstate_get() returns if service is running and slcore is mapped */
260 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_id),
261 "Service core add did not return zero");
262 int ret = rte_service_map_lcore_set(sid, slcore_id, 1);
263 TEST_ASSERT_EQUAL(0, ret,
264 "Enabling service core, expected 0 got %d", ret);
266 TEST_ASSERT_EQUAL(0, rte_service_runstate_get(sid),
267 "Error: Service should be stopped");
269 TEST_ASSERT_EQUAL(0, rte_service_runstate_set(sid, 0),
270 "Error: Service stopped returned non-zero");
272 TEST_ASSERT_EQUAL(0, rte_service_runstate_get(sid),
273 "Error: Service is running - should be stopped");
275 TEST_ASSERT_EQUAL(0, rte_service_runstate_set(sid, 1),
276 "Error: Service start returned non-zero");
278 TEST_ASSERT_EQUAL(1, rte_service_runstate_get(sid),
279 "Error: Service is not running");
281 return unregister_all();
286 service_remote_launch_func(void *arg)
289 service_remote_launch_flag = 1;
293 /* enable and disable a lcore for a service */
295 service_lcore_en_dis_able(void)
297 const uint32_t sid = 0;
299 /* expected failure cases */
300 TEST_ASSERT_EQUAL(-EINVAL, rte_service_map_lcore_set(sid, 100000, 1),
301 "Enable on invalid core did not fail");
302 TEST_ASSERT_EQUAL(-EINVAL, rte_service_map_lcore_set(sid, 100000, 0),
303 "Disable on invalid core did not fail");
305 /* add service core to allow enabling */
306 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_id),
307 "Add service core failed when not in use before");
310 TEST_ASSERT_EQUAL(0, rte_service_map_lcore_set(sid, slcore_id, 1),
311 "Enabling valid service and core failed");
312 TEST_ASSERT_EQUAL(1, rte_service_map_lcore_get(sid, slcore_id),
313 "Enabled core returned not-enabled");
316 TEST_ASSERT_EQUAL(0, rte_service_map_lcore_set(sid, slcore_id, 0),
317 "Disabling valid service and lcore failed");
318 TEST_ASSERT_EQUAL(0, rte_service_map_lcore_get(sid, slcore_id),
319 "Disabled core returned enabled");
321 /* call remote_launch to verify that app can launch ex-service lcore */
322 service_remote_launch_flag = 0;
323 int ret = rte_eal_remote_launch(service_remote_launch_func, NULL,
325 TEST_ASSERT_EQUAL(0, ret, "Ex-service core remote launch failed.");
326 rte_eal_mp_wait_lcore();
327 TEST_ASSERT_EQUAL(1, service_remote_launch_flag,
328 "Ex-service core function call had no effect.");
330 return unregister_all();
334 service_lcore_running_check(void)
336 uint64_t tick = service_tick;
337 rte_delay_ms(SERVICE_DELAY * 10);
338 /* if (tick != service_tick) we know the lcore as polled the service */
339 return tick != service_tick;
343 service_lcore_add_del(void)
345 /* check initial count */
346 TEST_ASSERT_EQUAL(0, rte_service_lcore_count(),
347 "Service lcore count has value before adding a lcore");
349 /* check service lcore add */
350 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_id),
351 "Add service core failed when not in use before");
352 TEST_ASSERT_EQUAL(-EALREADY, rte_service_lcore_add(slcore_id),
353 "Add service core failed to refuse in-use lcore");
356 TEST_ASSERT_EQUAL(1, rte_service_lcore_count(),
357 "Service core count not equal to one");
359 /* retrieve core list, checking lcore ids */
360 const uint32_t size = 4;
361 uint32_t service_core_ids[size];
362 int32_t n = rte_service_lcore_list(service_core_ids, size);
363 TEST_ASSERT_EQUAL(1, n, "Service core list return should equal 1");
364 TEST_ASSERT_EQUAL(slcore_id, service_core_ids[0],
365 "Service core list lcore must equal slcore_id");
367 /* recheck count, add more cores, and check count */
368 TEST_ASSERT_EQUAL(1, rte_service_lcore_count(),
369 "Service core count not equal to one");
370 uint32_t slcore_1 = rte_get_next_lcore(/* start core */ -1,
373 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_1),
374 "Service core add did not return zero");
375 uint32_t slcore_2 = rte_get_next_lcore(/* start core */ slcore_1,
378 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_2),
379 "Service core add did not return zero");
381 uint32_t count = rte_service_lcore_count();
382 const uint32_t cores_at_this_point = 3;
383 TEST_ASSERT_EQUAL(cores_at_this_point, count,
384 "Service core count %d, expected %d", count,
385 cores_at_this_point);
387 /* check longer service core list */
388 n = rte_service_lcore_list(service_core_ids, size);
389 TEST_ASSERT_EQUAL(3, n, "Service core list return should equal 3");
390 TEST_ASSERT_EQUAL(slcore_id, service_core_ids[0],
391 "Service core list[0] lcore must equal 1");
392 TEST_ASSERT_EQUAL(slcore_1, service_core_ids[1],
393 "Service core list[1] lcore must equal 2");
394 TEST_ASSERT_EQUAL(slcore_2, service_core_ids[2],
395 "Service core list[2] lcore must equal 3");
397 /* recheck count, remove lcores, check remaining lcore_id is correct */
398 TEST_ASSERT_EQUAL(3, rte_service_lcore_count(),
399 "Service core count not equal to three");
400 TEST_ASSERT_EQUAL(0, rte_service_lcore_del(slcore_1),
401 "Service core add did not return zero");
402 TEST_ASSERT_EQUAL(0, rte_service_lcore_del(slcore_2),
403 "Service core add did not return zero");
404 TEST_ASSERT_EQUAL(1, rte_service_lcore_count(),
405 "Service core count not equal to one");
406 n = rte_service_lcore_list(service_core_ids, size);
407 TEST_ASSERT_EQUAL(1, n, "Service core list return should equal one");
408 TEST_ASSERT_EQUAL(slcore_id, service_core_ids[0],
409 "Service core list[0] lcore must equal %d",
412 return unregister_all();
416 service_threaded_test(int mt_safe)
420 /* add next 2 cores */
421 uint32_t slcore_1 = rte_get_next_lcore(/* start core */ -1,
424 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_1),
425 "mt safe lcore add fail");
426 uint32_t slcore_2 = rte_get_next_lcore(/* start core */ slcore_1,
429 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_2),
430 "mt safe lcore add fail");
432 /* Use atomic locks to verify that two threads are in the same function
433 * at the same time. These are passed to the unit tests through the
434 * callback userdata parameter
436 uint32_t test_params[2];
437 memset(test_params, 0, sizeof(uint32_t) * 2);
439 /* register MT safe service. */
440 struct rte_service_spec service;
441 memset(&service, 0, sizeof(struct rte_service_spec));
442 service.callback_userdata = test_params;
443 snprintf(service.name, sizeof(service.name), MT_SAFE_SERVICE_NAME);
446 service.callback = dummy_mt_safe_cb;
447 service.capabilities |= RTE_SERVICE_CAP_MT_SAFE;
449 service.callback = dummy_mt_unsafe_cb;
452 TEST_ASSERT_EQUAL(0, rte_service_component_register(&service, &id),
453 "Register of MT SAFE service failed");
455 const uint32_t sid = 0;
456 TEST_ASSERT_EQUAL(0, rte_service_runstate_set(sid, 1),
457 "Starting valid service failed");
458 TEST_ASSERT_EQUAL(0, rte_service_map_lcore_set(sid, slcore_1, 1),
459 "Failed to enable lcore 1 on mt safe service");
460 TEST_ASSERT_EQUAL(0, rte_service_map_lcore_set(sid, slcore_2, 1),
461 "Failed to enable lcore 2 on mt safe service");
462 rte_service_lcore_start(slcore_1);
463 rte_service_lcore_start(slcore_2);
465 /* wait for the worker threads to run */
467 rte_service_lcore_stop(slcore_1);
468 rte_service_lcore_stop(slcore_2);
470 TEST_ASSERT_EQUAL(0, test_params[1],
471 "Service run with component runstate = 0");
473 /* enable backend runstate: the service should run after this */
474 rte_service_component_runstate_set(id, 1);
476 /* initialize to pass, see callback comment for details */
480 rte_service_lcore_start(slcore_1);
481 rte_service_lcore_start(slcore_2);
483 /* wait for the worker threads to run */
485 rte_service_lcore_stop(slcore_1);
486 rte_service_lcore_stop(slcore_2);
488 TEST_ASSERT_EQUAL(1, test_params[1],
489 "MT Safe service not run by two cores concurrently");
490 TEST_ASSERT_EQUAL(0, rte_service_runstate_set(sid, 0),
491 "Failed to stop MT Safe service");
495 /* return the value of the callback pass_test variable to caller */
496 return test_params[1];
499 /* tests an MT SAFE service with two cores. The callback function ensures that
500 * two threads access the callback concurrently.
503 service_mt_safe_poll(void)
506 TEST_ASSERT_EQUAL(1, service_threaded_test(mt_safe),
507 "Error: MT Safe service not run by two cores concurrently");
511 /* tests a NON mt safe service with two cores, the callback is serialized
512 * using the atomic cmpset.
515 service_mt_unsafe_poll(void)
518 TEST_ASSERT_EQUAL(1, service_threaded_test(mt_safe),
519 "Error: NON MT Safe service run by two cores concurrently");
524 delay_as_a_mt_safe_service(void *args)
527 uint32_t *params = args;
529 /* retrieve done flag and atomic lock to inc/dec */
530 uint32_t *done = ¶ms[0];
531 rte_atomic32_t *lock = (rte_atomic32_t *)¶ms[1];
534 rte_atomic32_inc(lock);
536 if (rte_atomic32_read(lock) > 1)
537 /* pass: second core has simultaneously incremented */
539 rte_atomic32_dec(lock);
546 delay_as_a_service(void *args)
548 uint32_t *done = (uint32_t *)args;
555 service_run_on_app_core_func(void *arg)
557 uint32_t *delay_service_id = (uint32_t *)arg;
558 return rte_service_run_iter_on_app_lcore(*delay_service_id, 1);
562 service_app_lcore_poll_impl(const int mt_safe)
564 uint32_t params[2] = {0};
566 struct rte_service_spec service;
567 memset(&service, 0, sizeof(struct rte_service_spec));
568 snprintf(service.name, sizeof(service.name), MT_SAFE_SERVICE_NAME);
570 service.callback = delay_as_a_mt_safe_service;
571 service.callback_userdata = params;
572 service.capabilities |= RTE_SERVICE_CAP_MT_SAFE;
574 service.callback = delay_as_a_service;
575 service.callback_userdata = ¶ms;
579 TEST_ASSERT_EQUAL(0, rte_service_component_register(&service, &id),
580 "Register of app lcore delay service failed");
582 rte_service_component_runstate_set(id, 1);
583 rte_service_runstate_set(id, 1);
585 uint32_t app_core2 = rte_get_next_lcore(slcore_id, 1, 1);
586 int app_core2_ret = rte_eal_remote_launch(service_run_on_app_core_func,
591 int app_core1_ret = service_run_on_app_core_func(&id);
593 /* flag done, then wait for the spawned 2nd core to return */
595 rte_eal_mp_wait_lcore();
597 /* core two gets launched first - and should hold the service lock */
598 TEST_ASSERT_EQUAL(0, app_core2_ret,
599 "App core2 : run service didn't return zero");
602 /* mt safe should have both cores return 0 for success */
603 TEST_ASSERT_EQUAL(0, app_core1_ret,
604 "MT Safe: App core1 didn't return 0");
606 /* core one attempts to run later - should be blocked */
607 TEST_ASSERT_EQUAL(-EBUSY, app_core1_ret,
608 "MT Unsafe: App core1 didn't return -EBUSY");
617 service_app_lcore_mt_safe(void)
619 const int mt_safe = 1;
620 return service_app_lcore_poll_impl(mt_safe);
624 service_app_lcore_mt_unsafe(void)
626 const int mt_safe = 0;
627 return service_app_lcore_poll_impl(mt_safe);
630 /* start and stop a service core - ensuring it goes back to sleep */
632 service_lcore_start_stop(void)
634 /* start service core and service, create mapping so tick() runs */
635 const uint32_t sid = 0;
636 TEST_ASSERT_EQUAL(0, rte_service_runstate_set(sid, 1),
637 "Starting valid service failed");
638 TEST_ASSERT_EQUAL(-EINVAL, rte_service_map_lcore_set(sid, slcore_id, 1),
639 "Enabling valid service on non-service core must fail");
642 TEST_ASSERT_EQUAL(-EINVAL, rte_service_lcore_start(slcore_id),
643 "Service core start without add should return EINVAL");
644 TEST_ASSERT_EQUAL(0, rte_service_lcore_add(slcore_id),
645 "Service core add did not return zero");
646 TEST_ASSERT_EQUAL(0, rte_service_map_lcore_set(sid, slcore_id, 1),
647 "Enabling valid service on valid core failed");
648 TEST_ASSERT_EQUAL(0, rte_service_lcore_start(slcore_id),
649 "Service core start after add failed");
650 TEST_ASSERT_EQUAL(-EALREADY, rte_service_lcore_start(slcore_id),
651 "Service core expected as running but was stopped");
653 /* ensures core really is running the service function */
654 TEST_ASSERT_EQUAL(1, service_lcore_running_check(),
655 "Service core expected to poll service but it didn't");
658 TEST_ASSERT_EQUAL(-EBUSY, rte_service_lcore_stop(slcore_id),
659 "Service core running a service should return -EBUSY");
660 TEST_ASSERT_EQUAL(0, rte_service_runstate_set(sid, 0),
661 "Stopping valid service failed");
662 TEST_ASSERT_EQUAL(-EINVAL, rte_service_lcore_stop(100000),
663 "Invalid Service core stop should return -EINVAL");
664 TEST_ASSERT_EQUAL(0, rte_service_lcore_stop(slcore_id),
665 "Service core stop expected to return 0");
666 TEST_ASSERT_EQUAL(-EALREADY, rte_service_lcore_stop(slcore_id),
667 "Already stopped service core should return -EALREADY");
669 /* ensure service is not longer running */
670 TEST_ASSERT_EQUAL(0, service_lcore_running_check(),
671 "Service core expected to poll service but it didn't");
673 TEST_ASSERT_EQUAL(0, rte_service_lcore_del(slcore_id),
674 "Service core del did not return zero");
676 return unregister_all();
679 static struct unit_test_suite service_tests = {
680 .suite_name = "service core test suite",
681 .setup = testsuite_setup,
682 .teardown = testsuite_teardown,
684 TEST_CASE_ST(dummy_register, NULL, unregister_all),
685 TEST_CASE_ST(dummy_register, NULL, service_name),
686 TEST_CASE_ST(dummy_register, NULL, service_get_by_name),
687 TEST_CASE_ST(dummy_register, NULL, service_dump),
688 TEST_CASE_ST(dummy_register, NULL, service_probe_capability),
689 TEST_CASE_ST(dummy_register, NULL, service_start_stop),
690 TEST_CASE_ST(dummy_register, NULL, service_lcore_add_del),
691 TEST_CASE_ST(dummy_register, NULL, service_lcore_start_stop),
692 TEST_CASE_ST(dummy_register, NULL, service_lcore_en_dis_able),
693 TEST_CASE_ST(dummy_register, NULL, service_mt_unsafe_poll),
694 TEST_CASE_ST(dummy_register, NULL, service_mt_safe_poll),
695 TEST_CASE_ST(dummy_register, NULL, service_app_lcore_mt_safe),
696 TEST_CASE_ST(dummy_register, NULL, service_app_lcore_mt_unsafe),
697 TEST_CASES_END() /**< NULL terminate unit test array */
702 test_service_common(void)
704 return unit_test_suite_runner(&service_tests);
707 REGISTER_TEST_COMMAND(service_autotest, test_service_common);