1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
11 #include <rte_compat.h>
12 #include <rte_service.h>
13 #include "include/rte_service_component.h"
16 #include <rte_lcore.h>
17 #include <rte_common.h>
18 #include <rte_debug.h>
19 #include <rte_cycles.h>
20 #include <rte_atomic.h>
21 #include <rte_memory.h>
22 #include <rte_malloc.h>
24 #include "eal_private.h"
26 #define RTE_SERVICE_NUM_MAX 64
28 #define SERVICE_F_REGISTERED (1 << 0)
29 #define SERVICE_F_STATS_ENABLED (1 << 1)
30 #define SERVICE_F_START_CHECK (1 << 2)
32 /* runstates for services and lcores, denoting if they are active or not */
33 #define RUNSTATE_STOPPED 0
34 #define RUNSTATE_RUNNING 1
36 /* internal representation of a service */
37 struct rte_service_spec_impl {
38 /* public part of the struct */
39 struct rte_service_spec spec;
41 /* atomic lock that when set indicates a service core is currently
42 * running this service callback. When not set, a core may take the
43 * lock and then run the service callback.
45 rte_atomic32_t execute_lock;
47 /* API set/get-able variables */
50 uint8_t internal_flags;
52 /* per service statistics */
53 rte_atomic32_t num_mapped_cores;
55 uint64_t cycles_spent;
56 } __rte_cache_aligned;
58 /* the internal values of a service core */
60 /* map of services IDs are run on this core */
61 uint64_t service_mask;
62 uint8_t runstate; /* running or stopped */
63 uint8_t is_service_core; /* set if core is currently a service core */
64 uint8_t service_active_on_lcore[RTE_SERVICE_NUM_MAX];
66 uint64_t calls_per_service[RTE_SERVICE_NUM_MAX];
67 } __rte_cache_aligned;
69 static uint32_t rte_service_count;
70 static struct rte_service_spec_impl *rte_services;
71 static struct core_state *lcore_states;
72 static uint32_t rte_service_library_initialized;
75 rte_service_init(void)
77 if (rte_service_library_initialized) {
79 "service library init() called, init flag %d\n",
80 rte_service_library_initialized);
84 rte_services = rte_calloc("rte_services", RTE_SERVICE_NUM_MAX,
85 sizeof(struct rte_service_spec_impl),
88 RTE_LOG(ERR, EAL, "error allocating rte services array\n");
92 lcore_states = rte_calloc("rte_service_core_states", RTE_MAX_LCORE,
93 sizeof(struct core_state), RTE_CACHE_LINE_SIZE);
95 RTE_LOG(ERR, EAL, "error allocating core states array\n");
101 struct rte_config *cfg = rte_eal_get_configuration();
102 for (i = 0; i < RTE_MAX_LCORE; i++) {
103 if (lcore_config[i].core_role == ROLE_SERVICE) {
104 if ((unsigned int)i == cfg->master_lcore)
106 rte_service_lcore_add(i);
111 rte_service_library_initialized = 1;
114 rte_free(rte_services);
115 rte_free(lcore_states);
120 rte_service_finalize(void)
122 if (!rte_service_library_initialized)
125 rte_free(rte_services);
126 rte_free(lcore_states);
128 rte_service_library_initialized = 0;
131 /* returns 1 if service is registered and has not been unregistered
132 * Returns 0 if service never registered, or has been unregistered
135 service_valid(uint32_t id)
137 return !!(rte_services[id].internal_flags & SERVICE_F_REGISTERED);
140 static struct rte_service_spec_impl *
141 service_get(uint32_t id)
143 return &rte_services[id];
146 /* validate ID and retrieve service pointer, or return error value */
147 #define SERVICE_VALID_GET_OR_ERR_RET(id, service, retval) do { \
148 if (id >= RTE_SERVICE_NUM_MAX || !service_valid(id)) \
150 service = &rte_services[id]; \
153 /* returns 1 if statistics should be collected for service
154 * Returns 0 if statistics should not be collected for service
157 service_stats_enabled(struct rte_service_spec_impl *impl)
159 return !!(impl->internal_flags & SERVICE_F_STATS_ENABLED);
163 service_mt_safe(struct rte_service_spec_impl *s)
165 return !!(s->spec.capabilities & RTE_SERVICE_CAP_MT_SAFE);
169 rte_service_set_stats_enable(uint32_t id, int32_t enabled)
171 struct rte_service_spec_impl *s;
172 SERVICE_VALID_GET_OR_ERR_RET(id, s, 0);
175 s->internal_flags |= SERVICE_F_STATS_ENABLED;
177 s->internal_flags &= ~(SERVICE_F_STATS_ENABLED);
183 rte_service_set_runstate_mapped_check(uint32_t id, int32_t enabled)
185 struct rte_service_spec_impl *s;
186 SERVICE_VALID_GET_OR_ERR_RET(id, s, 0);
189 s->internal_flags |= SERVICE_F_START_CHECK;
191 s->internal_flags &= ~(SERVICE_F_START_CHECK);
197 rte_service_get_count(void)
199 return rte_service_count;
203 rte_service_get_by_name(const char *name, uint32_t *service_id)
209 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
210 if (service_valid(i) &&
211 strcmp(name, rte_services[i].spec.name) == 0) {
221 rte_service_get_name(uint32_t id)
223 struct rte_service_spec_impl *s;
224 SERVICE_VALID_GET_OR_ERR_RET(id, s, 0);
229 rte_service_probe_capability(uint32_t id, uint32_t capability)
231 struct rte_service_spec_impl *s;
232 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
233 return !!(s->spec.capabilities & capability);
237 rte_service_component_register(const struct rte_service_spec *spec,
241 int32_t free_slot = -1;
243 if (spec->callback == NULL || strlen(spec->name) == 0)
246 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
247 if (!service_valid(i)) {
253 if ((free_slot < 0) || (i == RTE_SERVICE_NUM_MAX))
256 struct rte_service_spec_impl *s = &rte_services[free_slot];
258 s->internal_flags |= SERVICE_F_REGISTERED | SERVICE_F_START_CHECK;
270 rte_service_component_unregister(uint32_t id)
273 struct rte_service_spec_impl *s;
274 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
279 s->internal_flags &= ~(SERVICE_F_REGISTERED);
281 /* clear the run-bit in all cores */
282 for (i = 0; i < RTE_MAX_LCORE; i++)
283 lcore_states[i].service_mask &= ~(UINT64_C(1) << id);
285 memset(&rte_services[id], 0, sizeof(struct rte_service_spec_impl));
291 rte_service_component_runstate_set(uint32_t id, uint32_t runstate)
293 struct rte_service_spec_impl *s;
294 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
297 s->comp_runstate = RUNSTATE_RUNNING;
299 s->comp_runstate = RUNSTATE_STOPPED;
306 rte_service_runstate_set(uint32_t id, uint32_t runstate)
308 struct rte_service_spec_impl *s;
309 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
312 s->app_runstate = RUNSTATE_RUNNING;
314 s->app_runstate = RUNSTATE_STOPPED;
321 rte_service_runstate_get(uint32_t id)
323 struct rte_service_spec_impl *s;
324 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
327 int check_disabled = !(s->internal_flags & SERVICE_F_START_CHECK);
328 int lcore_mapped = (rte_atomic32_read(&s->num_mapped_cores) > 0);
330 return (s->app_runstate == RUNSTATE_RUNNING) &&
331 (s->comp_runstate == RUNSTATE_RUNNING) &&
332 (check_disabled | lcore_mapped);
336 rte_service_runner_do_callback(struct rte_service_spec_impl *s,
337 struct core_state *cs, uint32_t service_idx)
339 void *userdata = s->spec.callback_userdata;
341 if (service_stats_enabled(s)) {
342 uint64_t start = rte_rdtsc();
343 s->spec.callback(userdata);
344 uint64_t end = rte_rdtsc();
345 s->cycles_spent += end - start;
346 cs->calls_per_service[service_idx]++;
349 s->spec.callback(userdata);
353 /* Expects the service 's' is valid. */
355 service_run(uint32_t i, struct core_state *cs, uint64_t service_mask,
356 struct rte_service_spec_impl *s)
361 if (s->comp_runstate != RUNSTATE_RUNNING ||
362 s->app_runstate != RUNSTATE_RUNNING ||
363 !(service_mask & (UINT64_C(1) << i))) {
364 cs->service_active_on_lcore[i] = 0;
368 cs->service_active_on_lcore[i] = 1;
370 /* check do we need cmpset, if MT safe or <= 1 core
371 * mapped, atomic ops are not required.
373 const int use_atomics = (service_mt_safe(s) == 0) &&
374 (rte_atomic32_read(&s->num_mapped_cores) > 1);
376 if (!rte_atomic32_cmpset((uint32_t *)&s->execute_lock, 0, 1))
379 rte_service_runner_do_callback(s, cs, i);
380 rte_atomic32_clear(&s->execute_lock);
382 rte_service_runner_do_callback(s, cs, i);
388 rte_service_may_be_active(uint32_t id)
390 uint32_t ids[RTE_MAX_LCORE] = {0};
391 int32_t lcore_count = rte_service_lcore_list(ids, RTE_MAX_LCORE);
394 if (id >= RTE_SERVICE_NUM_MAX || !service_valid(id))
397 for (i = 0; i < lcore_count; i++) {
398 if (lcore_states[i].service_active_on_lcore[id])
406 rte_service_run_iter_on_app_lcore(uint32_t id, uint32_t serialize_mt_unsafe)
408 struct core_state *cs = &lcore_states[rte_lcore_id()];
409 struct rte_service_spec_impl *s;
411 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
413 /* Atomically add this core to the mapped cores first, then examine if
414 * we can run the service. This avoids a race condition between
415 * checking the value, and atomically adding to the mapped count.
417 if (serialize_mt_unsafe)
418 rte_atomic32_inc(&s->num_mapped_cores);
420 if (service_mt_safe(s) == 0 &&
421 rte_atomic32_read(&s->num_mapped_cores) > 1) {
422 if (serialize_mt_unsafe)
423 rte_atomic32_dec(&s->num_mapped_cores);
427 int ret = service_run(id, cs, UINT64_MAX, s);
429 if (serialize_mt_unsafe)
430 rte_atomic32_dec(&s->num_mapped_cores);
436 rte_service_runner_func(void *arg)
440 const int lcore = rte_lcore_id();
441 struct core_state *cs = &lcore_states[lcore];
443 while (lcore_states[lcore].runstate == RUNSTATE_RUNNING) {
444 const uint64_t service_mask = cs->service_mask;
446 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
447 if (!service_valid(i))
449 /* return value ignored as no change to code flow */
450 service_run(i, cs, service_mask, service_get(i));
458 lcore_config[lcore].state = WAIT;
464 rte_service_lcore_count(void)
468 for (i = 0; i < RTE_MAX_LCORE; i++)
469 count += lcore_states[i].is_service_core;
474 rte_service_lcore_list(uint32_t array[], uint32_t n)
476 uint32_t count = rte_service_lcore_count();
485 for (i = 0; i < RTE_MAX_LCORE; i++) {
486 struct core_state *cs = &lcore_states[i];
487 if (cs->is_service_core) {
497 rte_service_lcore_count_services(uint32_t lcore)
499 if (lcore >= RTE_MAX_LCORE)
502 struct core_state *cs = &lcore_states[lcore];
503 if (!cs->is_service_core)
506 return __builtin_popcountll(cs->service_mask);
510 rte_service_start_with_defaults(void)
512 /* create a default mapping from cores to services, then start the
513 * services to make them transparent to unaware applications.
517 uint32_t count = rte_service_get_count();
519 int32_t lcore_iter = 0;
520 uint32_t ids[RTE_MAX_LCORE] = {0};
521 int32_t lcore_count = rte_service_lcore_list(ids, RTE_MAX_LCORE);
523 if (lcore_count == 0)
526 for (i = 0; (int)i < lcore_count; i++)
527 rte_service_lcore_start(ids[i]);
529 for (i = 0; i < count; i++) {
530 /* do 1:1 core mapping here, with each service getting
531 * assigned a single core by default. Adding multiple services
532 * should multiplex to a single core, or 1:1 if there are the
533 * same amount of services as service-cores
535 ret = rte_service_map_lcore_set(i, ids[lcore_iter], 1);
540 if (lcore_iter >= lcore_count)
543 ret = rte_service_runstate_set(i, 1);
552 service_update(struct rte_service_spec *service, uint32_t lcore,
553 uint32_t *set, uint32_t *enabled)
558 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
559 if ((struct rte_service_spec *)&rte_services[i] == service &&
566 if (sid == -1 || lcore >= RTE_MAX_LCORE)
569 if (!lcore_states[lcore].is_service_core)
572 uint64_t sid_mask = UINT64_C(1) << sid;
574 uint64_t lcore_mapped = lcore_states[lcore].service_mask &
577 if (*set && !lcore_mapped) {
578 lcore_states[lcore].service_mask |= sid_mask;
579 rte_atomic32_inc(&rte_services[sid].num_mapped_cores);
581 if (!*set && lcore_mapped) {
582 lcore_states[lcore].service_mask &= ~(sid_mask);
583 rte_atomic32_dec(&rte_services[sid].num_mapped_cores);
588 *enabled = !!(lcore_states[lcore].service_mask & (sid_mask));
596 rte_service_map_lcore_set(uint32_t id, uint32_t lcore, uint32_t enabled)
598 struct rte_service_spec_impl *s;
599 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
600 uint32_t on = enabled > 0;
601 return service_update(&s->spec, lcore, &on, 0);
605 rte_service_map_lcore_get(uint32_t id, uint32_t lcore)
607 struct rte_service_spec_impl *s;
608 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
610 int ret = service_update(&s->spec, lcore, 0, &enabled);
617 set_lcore_state(uint32_t lcore, int32_t state)
619 /* mark core state in hugepage backed config */
620 struct rte_config *cfg = rte_eal_get_configuration();
621 cfg->lcore_role[lcore] = state;
623 /* mark state in process local lcore_config */
624 lcore_config[lcore].core_role = state;
626 /* update per-lcore optimized state tracking */
627 lcore_states[lcore].is_service_core = (state == ROLE_SERVICE);
631 rte_service_lcore_reset_all(void)
633 /* loop over cores, reset all to mask 0 */
635 for (i = 0; i < RTE_MAX_LCORE; i++) {
636 if (lcore_states[i].is_service_core) {
637 lcore_states[i].service_mask = 0;
638 set_lcore_state(i, ROLE_RTE);
639 lcore_states[i].runstate = RUNSTATE_STOPPED;
642 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++)
643 rte_atomic32_set(&rte_services[i].num_mapped_cores, 0);
651 rte_service_lcore_add(uint32_t lcore)
653 if (lcore >= RTE_MAX_LCORE)
655 if (lcore_states[lcore].is_service_core)
658 set_lcore_state(lcore, ROLE_SERVICE);
660 /* ensure that after adding a core the mask and state are defaults */
661 lcore_states[lcore].service_mask = 0;
662 lcore_states[lcore].runstate = RUNSTATE_STOPPED;
666 return rte_eal_wait_lcore(lcore);
670 rte_service_lcore_del(uint32_t lcore)
672 if (lcore >= RTE_MAX_LCORE)
675 struct core_state *cs = &lcore_states[lcore];
676 if (!cs->is_service_core)
679 if (cs->runstate != RUNSTATE_STOPPED)
682 set_lcore_state(lcore, ROLE_RTE);
689 rte_service_lcore_start(uint32_t lcore)
691 if (lcore >= RTE_MAX_LCORE)
694 struct core_state *cs = &lcore_states[lcore];
695 if (!cs->is_service_core)
698 if (cs->runstate == RUNSTATE_RUNNING)
701 /* set core to run state first, and then launch otherwise it will
702 * return immediately as runstate keeps it in the service poll loop
704 lcore_states[lcore].runstate = RUNSTATE_RUNNING;
706 int ret = rte_eal_remote_launch(rte_service_runner_func, 0, lcore);
707 /* returns -EBUSY if the core is already launched, 0 on success */
712 rte_service_lcore_stop(uint32_t lcore)
714 if (lcore >= RTE_MAX_LCORE)
717 if (lcore_states[lcore].runstate == RUNSTATE_STOPPED)
721 uint64_t service_mask = lcore_states[lcore].service_mask;
722 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
723 int32_t enabled = service_mask & (UINT64_C(1) << i);
724 int32_t service_running = rte_service_runstate_get(i);
725 int32_t only_core = (1 ==
726 rte_atomic32_read(&rte_services[i].num_mapped_cores));
728 /* if the core is mapped, and the service is running, and this
729 * is the only core that is mapped, the service would cease to
730 * run if this core stopped, so fail instead.
732 if (enabled && service_running && only_core)
736 lcore_states[lcore].runstate = RUNSTATE_STOPPED;
742 rte_service_attr_get(uint32_t id, uint32_t attr_id, uint64_t *attr_value)
744 struct rte_service_spec_impl *s;
745 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
751 case RTE_SERVICE_ATTR_CYCLES:
752 *attr_value = s->cycles_spent;
754 case RTE_SERVICE_ATTR_CALL_COUNT:
755 *attr_value = s->calls;
763 rte_service_lcore_attr_get(uint32_t lcore, uint32_t attr_id,
764 uint64_t *attr_value)
766 struct core_state *cs;
768 if (lcore >= RTE_MAX_LCORE || !attr_value)
771 cs = &lcore_states[lcore];
772 if (!cs->is_service_core)
776 case RTE_SERVICE_LCORE_ATTR_LOOPS:
777 *attr_value = cs->loops;
785 rte_service_dump_one(FILE *f, struct rte_service_spec_impl *s,
786 uint64_t all_cycles, uint32_t reset)
788 /* avoid divide by zero */
805 fprintf(f, " %s: stats %d\tcalls %"PRIu64"\tcycles %"
806 PRIu64"\tavg: %"PRIu64"\n",
807 s->spec.name, service_stats_enabled(s), s->calls,
808 s->cycles_spent, s->cycles_spent / calls);
812 rte_service_attr_reset_all(uint32_t id)
814 struct rte_service_spec_impl *s;
815 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
818 rte_service_dump_one(NULL, s, 0, reset);
823 rte_service_lcore_attr_reset_all(uint32_t lcore)
825 struct core_state *cs;
827 if (lcore >= RTE_MAX_LCORE)
830 cs = &lcore_states[lcore];
831 if (!cs->is_service_core)
840 service_dump_calls_per_lcore(FILE *f, uint32_t lcore, uint32_t reset)
843 struct core_state *cs = &lcore_states[lcore];
845 fprintf(f, "%02d\t", lcore);
846 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
847 if (!service_valid(i))
849 fprintf(f, "%"PRIu64"\t", cs->calls_per_service[i]);
851 cs->calls_per_service[i] = 0;
857 rte_service_dump(FILE *f, uint32_t id)
860 int print_one = (id != UINT32_MAX);
862 uint64_t total_cycles = 0;
864 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
865 if (!service_valid(i))
867 total_cycles += rte_services[i].cycles_spent;
870 /* print only the specified service */
872 struct rte_service_spec_impl *s;
873 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
874 fprintf(f, "Service %s Summary\n", s->spec.name);
876 rte_service_dump_one(f, s, total_cycles, reset);
880 /* print all services, as UINT32_MAX was passed as id */
881 fprintf(f, "Services Summary\n");
882 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
883 if (!service_valid(i))
886 rte_service_dump_one(f, &rte_services[i], total_cycles, reset);
889 fprintf(f, "Service Cores Summary\n");
890 for (i = 0; i < RTE_MAX_LCORE; i++) {
891 if (lcore_config[i].core_role != ROLE_SERVICE)
895 service_dump_calls_per_lcore(f, i, reset);