4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #include <rte_service.h>
42 #include "include/rte_service_component.h"
45 #include <rte_lcore.h>
46 #include <rte_common.h>
47 #include <rte_debug.h>
48 #include <rte_cycles.h>
49 #include <rte_atomic.h>
50 #include <rte_memory.h>
51 #include <rte_malloc.h>
53 #define RTE_SERVICE_NUM_MAX 64
55 #define SERVICE_F_REGISTERED (1 << 0)
56 #define SERVICE_F_STATS_ENABLED (1 << 1)
58 /* runstates for services and lcores, denoting if they are active or not */
59 #define RUNSTATE_STOPPED 0
60 #define RUNSTATE_RUNNING 1
62 /* internal representation of a service */
63 struct rte_service_spec_impl {
64 /* public part of the struct */
65 struct rte_service_spec spec;
67 /* atomic lock that when set indicates a service core is currently
68 * running this service callback. When not set, a core may take the
69 * lock and then run the service callback.
71 rte_atomic32_t execute_lock;
73 /* API set/get-able variables */
75 uint8_t internal_flags;
77 /* per service statistics */
78 uint32_t num_mapped_cores;
80 uint64_t cycles_spent;
81 } __rte_cache_aligned;
83 /* the internal values of a service core */
85 /* map of services IDs are run on this core */
86 uint64_t service_mask;
87 uint8_t runstate; /* running or stopped */
88 uint8_t is_service_core; /* set if core is currently a service core */
90 /* extreme statistics */
91 uint64_t calls_per_service[RTE_SERVICE_NUM_MAX];
92 } __rte_cache_aligned;
94 static uint32_t rte_service_count;
95 static struct rte_service_spec_impl *rte_services;
96 static struct core_state *lcore_states;
97 static uint32_t rte_service_library_initialized;
99 int32_t rte_service_init(void)
101 if (rte_service_library_initialized) {
102 printf("service library init() called, init flag %d\n",
103 rte_service_library_initialized);
107 rte_services = rte_calloc("rte_services", RTE_SERVICE_NUM_MAX,
108 sizeof(struct rte_service_spec_impl),
109 RTE_CACHE_LINE_SIZE);
111 printf("error allocating rte services array\n");
115 lcore_states = rte_calloc("rte_service_core_states", RTE_MAX_LCORE,
116 sizeof(struct core_state), RTE_CACHE_LINE_SIZE);
118 printf("error allocating core states array\n");
124 struct rte_config *cfg = rte_eal_get_configuration();
125 for (i = 0; i < RTE_MAX_LCORE; i++) {
126 if (lcore_config[i].core_role == ROLE_SERVICE) {
127 if ((unsigned int)i == cfg->master_lcore)
129 rte_service_lcore_add(i);
134 rte_service_library_initialized = 1;
138 /* returns 1 if service is registered and has not been unregistered
139 * Returns 0 if service never registered, or has been unregistered
142 service_valid(uint32_t id)
144 return !!(rte_services[id].internal_flags & SERVICE_F_REGISTERED);
147 /* validate ID and retrieve service pointer, or return error value */
148 #define SERVICE_VALID_GET_OR_ERR_RET(id, service, retval) do { \
149 if (id >= RTE_SERVICE_NUM_MAX || !service_valid(id)) \
151 service = &rte_services[id]; \
154 /* returns 1 if statistics should be colleced for service
155 * Returns 0 if statistics should not be collected for service
158 service_stats_enabled(struct rte_service_spec_impl *impl)
160 return !!(impl->internal_flags & SERVICE_F_STATS_ENABLED);
164 service_mt_safe(struct rte_service_spec_impl *s)
166 return s->spec.capabilities & RTE_SERVICE_CAP_MT_SAFE;
169 int32_t 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_get_count(void)
185 return rte_service_count;
188 int32_t rte_service_get_by_name(const char *name, uint32_t *service_id)
194 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
195 if (service_valid(i) &&
196 strcmp(name, rte_services[i].spec.name) == 0) {
206 rte_service_get_name(uint32_t id)
208 struct rte_service_spec_impl *s;
209 SERVICE_VALID_GET_OR_ERR_RET(id, s, 0);
214 rte_service_probe_capability(uint32_t id, uint32_t capability)
216 struct rte_service_spec_impl *s;
217 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
218 return s->spec.capabilities & capability;
222 rte_service_component_register(const struct rte_service_spec *spec,
226 int32_t free_slot = -1;
228 if (spec->callback == NULL || strlen(spec->name) == 0)
231 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
232 if (!service_valid(i)) {
238 if ((free_slot < 0) || (i == RTE_SERVICE_NUM_MAX))
241 struct rte_service_spec_impl *s = &rte_services[free_slot];
243 s->internal_flags |= SERVICE_F_REGISTERED;
255 rte_service_component_unregister(uint32_t id)
258 struct rte_service_spec_impl *s;
259 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
264 s->internal_flags &= ~(SERVICE_F_REGISTERED);
266 /* clear the run-bit in all cores */
267 for (i = 0; i < RTE_MAX_LCORE; i++)
268 lcore_states[i].service_mask &= ~(UINT64_C(1) << id);
270 memset(&rte_services[id], 0, sizeof(struct rte_service_spec_impl));
276 rte_service_runstate_set(uint32_t id, uint32_t runstate)
278 struct rte_service_spec_impl *s;
279 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
282 s->runstate = RUNSTATE_RUNNING;
284 s->runstate = RUNSTATE_STOPPED;
291 rte_service_runstate_get(uint32_t id)
293 struct rte_service_spec_impl *s;
294 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
296 return (s->runstate == RUNSTATE_RUNNING) && (s->num_mapped_cores > 0);
300 rte_service_runner_do_callback(struct rte_service_spec_impl *s,
301 struct core_state *cs, uint32_t service_idx)
303 void *userdata = s->spec.callback_userdata;
305 if (service_stats_enabled(s)) {
306 uint64_t start = rte_rdtsc();
307 s->spec.callback(userdata);
308 uint64_t end = rte_rdtsc();
309 s->cycles_spent += end - start;
310 cs->calls_per_service[service_idx]++;
313 s->spec.callback(userdata);
317 rte_service_runner_func(void *arg)
321 const int lcore = rte_lcore_id();
322 struct core_state *cs = &lcore_states[lcore];
324 while (lcore_states[lcore].runstate == RUNSTATE_RUNNING) {
325 const uint64_t service_mask = cs->service_mask;
326 for (i = 0; i < rte_service_count; i++) {
327 struct rte_service_spec_impl *s = &rte_services[i];
328 if (s->runstate != RUNSTATE_RUNNING ||
329 !(service_mask & (UINT64_C(1) << i)))
332 /* check do we need cmpset, if MT safe or <= 1 core
333 * mapped, atomic ops are not required.
335 const int use_atomics = (service_mt_safe(s) == 0) &&
336 (s->num_mapped_cores > 1);
338 uint32_t *lock = (uint32_t *)&s->execute_lock;
339 if (rte_atomic32_cmpset(lock, 0, 1)) {
340 rte_service_runner_do_callback(s, cs, i);
341 rte_atomic32_clear(&s->execute_lock);
344 rte_service_runner_do_callback(s, cs, i);
350 lcore_config[lcore].state = WAIT;
356 rte_service_lcore_count(void)
360 for (i = 0; i < RTE_MAX_LCORE; i++)
361 count += lcore_states[i].is_service_core;
366 rte_service_lcore_list(uint32_t array[], uint32_t n)
368 uint32_t count = rte_service_lcore_count();
377 for (i = 0; i < RTE_MAX_LCORE; i++) {
378 struct core_state *cs = &lcore_states[i];
379 if (cs->is_service_core) {
389 rte_service_lcore_count_services(uint32_t lcore)
391 if (lcore >= RTE_MAX_LCORE)
394 struct core_state *cs = &lcore_states[lcore];
395 if (!cs->is_service_core)
398 return __builtin_popcountll(cs->service_mask);
402 rte_service_start_with_defaults(void)
404 /* create a default mapping from cores to services, then start the
405 * services to make them transparent to unaware applications.
409 uint32_t count = rte_service_get_count();
411 int32_t lcore_iter = 0;
412 uint32_t ids[RTE_MAX_LCORE];
413 int32_t lcore_count = rte_service_lcore_list(ids, RTE_MAX_LCORE);
415 if (lcore_count == 0)
418 for (i = 0; (int)i < lcore_count; i++)
419 rte_service_lcore_start(ids[i]);
421 for (i = 0; i < count; i++) {
422 /* do 1:1 core mapping here, with each service getting
423 * assigned a single core by default. Adding multiple services
424 * should multiplex to a single core, or 1:1 if there are the
425 * same amount of services as service-cores
427 ret = rte_service_map_lcore_set(i, ids[lcore_iter], 1);
432 if (lcore_iter >= lcore_count)
435 ret = rte_service_runstate_set(i, 1);
444 service_update(struct rte_service_spec *service, uint32_t lcore,
445 uint32_t *set, uint32_t *enabled)
450 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
451 if ((struct rte_service_spec *)&rte_services[i] == service &&
458 if (sid == -1 || lcore >= RTE_MAX_LCORE)
461 if (!lcore_states[lcore].is_service_core)
464 uint64_t sid_mask = UINT64_C(1) << sid;
467 lcore_states[lcore].service_mask |= sid_mask;
468 rte_services[sid].num_mapped_cores++;
470 lcore_states[lcore].service_mask &= ~(sid_mask);
471 rte_services[sid].num_mapped_cores--;
476 *enabled = (lcore_states[lcore].service_mask & (sid_mask));
484 rte_service_map_lcore_set(uint32_t id, uint32_t lcore, uint32_t enabled)
486 struct rte_service_spec_impl *s;
487 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
488 uint32_t on = enabled > 0;
489 return service_update(&s->spec, lcore, &on, 0);
493 rte_service_map_lcore_get(uint32_t id, uint32_t lcore)
495 struct rte_service_spec_impl *s;
496 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
498 int ret = service_update(&s->spec, lcore, 0, &enabled);
504 int32_t rte_service_lcore_reset_all(void)
506 /* loop over cores, reset all to mask 0 */
508 for (i = 0; i < RTE_MAX_LCORE; i++) {
509 lcore_states[i].service_mask = 0;
510 lcore_states[i].is_service_core = 0;
511 lcore_states[i].runstate = RUNSTATE_STOPPED;
513 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++)
514 rte_services[i].num_mapped_cores = 0;
522 set_lcore_state(uint32_t lcore, int32_t state)
524 /* mark core state in hugepage backed config */
525 struct rte_config *cfg = rte_eal_get_configuration();
526 cfg->lcore_role[lcore] = state;
528 /* mark state in process local lcore_config */
529 lcore_config[lcore].core_role = state;
531 /* update per-lcore optimized state tracking */
532 lcore_states[lcore].is_service_core = (state == ROLE_SERVICE);
536 rte_service_lcore_add(uint32_t lcore)
538 if (lcore >= RTE_MAX_LCORE)
540 if (lcore_states[lcore].is_service_core)
543 set_lcore_state(lcore, ROLE_SERVICE);
545 /* ensure that after adding a core the mask and state are defaults */
546 lcore_states[lcore].service_mask = 0;
547 lcore_states[lcore].runstate = RUNSTATE_STOPPED;
554 rte_service_lcore_del(uint32_t lcore)
556 if (lcore >= RTE_MAX_LCORE)
559 struct core_state *cs = &lcore_states[lcore];
560 if (!cs->is_service_core)
563 if (cs->runstate != RUNSTATE_STOPPED)
566 set_lcore_state(lcore, ROLE_RTE);
573 rte_service_lcore_start(uint32_t lcore)
575 if (lcore >= RTE_MAX_LCORE)
578 struct core_state *cs = &lcore_states[lcore];
579 if (!cs->is_service_core)
582 if (cs->runstate == RUNSTATE_RUNNING)
585 /* set core to run state first, and then launch otherwise it will
586 * return immediately as runstate keeps it in the service poll loop
588 lcore_states[lcore].runstate = RUNSTATE_RUNNING;
590 int ret = rte_eal_remote_launch(rte_service_runner_func, 0, lcore);
591 /* returns -EBUSY if the core is already launched, 0 on success */
596 rte_service_lcore_stop(uint32_t lcore)
598 if (lcore >= RTE_MAX_LCORE)
601 if (lcore_states[lcore].runstate == RUNSTATE_STOPPED)
605 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
607 lcore_states[i].service_mask & (UINT64_C(1) << i);
608 int32_t service_running = rte_services[i].runstate !=
610 int32_t only_core = rte_services[i].num_mapped_cores == 1;
612 /* if the core is mapped, and the service is running, and this
613 * is the only core that is mapped, the service would cease to
614 * run if this core stopped, so fail instead.
616 if (enabled && service_running && only_core)
620 lcore_states[lcore].runstate = RUNSTATE_STOPPED;
626 rte_service_dump_one(FILE *f, struct rte_service_spec_impl *s,
627 uint64_t all_cycles, uint32_t reset)
629 /* avoid divide by zero */
637 fprintf(f, " %s: stats %d\tcalls %"PRIu64"\tcycles %"
638 PRIu64"\tavg: %"PRIu64"\n",
639 s->spec.name, service_stats_enabled(s), s->calls,
640 s->cycles_spent, s->cycles_spent / calls);
649 service_dump_calls_per_lcore(FILE *f, uint32_t lcore, uint32_t reset)
652 struct core_state *cs = &lcore_states[lcore];
654 fprintf(f, "%02d\t", lcore);
655 for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
656 if (!service_valid(i))
658 fprintf(f, "%"PRIu64"\t", cs->calls_per_service[i]);
660 cs->calls_per_service[i] = 0;
665 int32_t rte_service_dump(FILE *f, uint32_t id)
668 int print_one = (id != UINT32_MAX);
670 uint64_t total_cycles = 0;
671 for (i = 0; i < rte_service_count; i++) {
672 if (!service_valid(i))
674 total_cycles += rte_services[i].cycles_spent;
677 /* print only the specified service */
679 struct rte_service_spec_impl *s;
680 SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
681 fprintf(f, "Service %s Summary\n", s->spec.name);
683 rte_service_dump_one(f, s, total_cycles, reset);
687 /* print all services, as UINT32_MAX was passed as id */
688 fprintf(f, "Services Summary\n");
689 for (i = 0; i < rte_service_count; i++) {
691 rte_service_dump_one(f, &rte_services[i], total_cycles, reset);
694 fprintf(f, "Service Cores Summary\n");
695 for (i = 0; i < RTE_MAX_LCORE; i++) {
696 if (lcore_config[i].core_role != ROLE_SERVICE)
700 service_dump_calls_per_lcore(f, i, reset);