service: fix core mapping reset
[dpdk.git] / lib / librte_eal / common / rte_service.c
index 70d17a5..6a0e0ff 100644 (file)
@@ -20,6 +20,7 @@
 #include <rte_atomic.h>
 #include <rte_memory.h>
 #include <rte_malloc.h>
+#include <rte_spinlock.h>
 
 #include "eal_private.h"
 
@@ -38,11 +39,11 @@ struct rte_service_spec_impl {
        /* public part of the struct */
        struct rte_service_spec spec;
 
-       /* atomic lock that when set indicates a service core is currently
+       /* spin lock that when set indicates a service core is currently
         * running this service callback. When not set, a core may take the
         * lock and then run the service callback.
         */
-       rte_atomic32_t execute_lock;
+       rte_spinlock_t execute_lock;
 
        /* API set/get-able variables */
        int8_t app_runstate;
@@ -50,7 +51,11 @@ struct rte_service_spec_impl {
        uint8_t internal_flags;
 
        /* per service statistics */
-       rte_atomic32_t num_mapped_cores;
+       /* Indicates how many cores the service is mapped to run on.
+        * It does not indicate the number of cores the service is running
+        * on currently.
+        */
+       uint32_t num_mapped_cores;
        uint64_t calls;
        uint64_t cycles_spent;
 } __rte_cache_aligned;
@@ -260,7 +265,6 @@ rte_service_component_register(const struct rte_service_spec *spec,
        s->spec = *spec;
        s->internal_flags |= SERVICE_F_REGISTERED | SERVICE_F_START_CHECK;
 
-       rte_smp_wmb();
        rte_service_count++;
 
        if (id_ptr)
@@ -277,7 +281,6 @@ rte_service_component_unregister(uint32_t id)
        SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
 
        rte_service_count--;
-       rte_smp_wmb();
 
        s->internal_flags &= ~(SERVICE_F_REGISTERED);
 
@@ -296,12 +299,17 @@ rte_service_component_runstate_set(uint32_t id, uint32_t runstate)
        struct rte_service_spec_impl *s;
        SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
 
+       /* comp_runstate act as the guard variable. Use store-release
+        * memory order. This synchronizes with load-acquire in
+        * service_run and service_runstate_get function.
+        */
        if (runstate)
-               s->comp_runstate = RUNSTATE_RUNNING;
+               __atomic_store_n(&s->comp_runstate, RUNSTATE_RUNNING,
+                       __ATOMIC_RELEASE);
        else
-               s->comp_runstate = RUNSTATE_STOPPED;
+               __atomic_store_n(&s->comp_runstate, RUNSTATE_STOPPED,
+                       __ATOMIC_RELEASE);
 
-       rte_smp_wmb();
        return 0;
 }
 
@@ -311,12 +319,17 @@ rte_service_runstate_set(uint32_t id, uint32_t runstate)
        struct rte_service_spec_impl *s;
        SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
 
+       /* app_runstate act as the guard variable. Use store-release
+        * memory order. This synchronizes with load-acquire in
+        * service_run runstate_get function.
+        */
        if (runstate)
-               s->app_runstate = RUNSTATE_RUNNING;
+               __atomic_store_n(&s->app_runstate, RUNSTATE_RUNNING,
+                       __ATOMIC_RELEASE);
        else
-               s->app_runstate = RUNSTATE_STOPPED;
+               __atomic_store_n(&s->app_runstate, RUNSTATE_STOPPED,
+                       __ATOMIC_RELEASE);
 
-       rte_smp_wmb();
        return 0;
 }
 
@@ -325,19 +338,29 @@ rte_service_runstate_get(uint32_t id)
 {
        struct rte_service_spec_impl *s;
        SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
-       rte_smp_rmb();
 
-       int check_disabled = !(s->internal_flags & SERVICE_F_START_CHECK);
-       int lcore_mapped = (rte_atomic32_read(&s->num_mapped_cores) > 0);
+       /* comp_runstate and app_runstate act as the guard variables.
+        * Use load-acquire memory order. This synchronizes with
+        * store-release in service state set functions.
+        */
+       if (__atomic_load_n(&s->comp_runstate, __ATOMIC_ACQUIRE) ==
+                       RUNSTATE_RUNNING &&
+           __atomic_load_n(&s->app_runstate, __ATOMIC_ACQUIRE) ==
+                       RUNSTATE_RUNNING) {
+               int check_disabled = !(s->internal_flags &
+                       SERVICE_F_START_CHECK);
+               int lcore_mapped = (__atomic_load_n(&s->num_mapped_cores,
+                       __ATOMIC_RELAXED) > 0);
+
+               return (check_disabled | lcore_mapped);
+       } else
+               return 0;
 
-       return (s->app_runstate == RUNSTATE_RUNNING) &&
-               (s->comp_runstate == RUNSTATE_RUNNING) &&
-               (check_disabled | lcore_mapped);
 }
 
 static inline void
-rte_service_runner_do_callback(struct rte_service_spec_impl *s,
-                              struct core_state *cs, uint32_t service_idx)
+service_runner_do_callback(struct rte_service_spec_impl *s,
+                          struct core_state *cs, uint32_t service_idx)
 {
        void *userdata = s->spec.callback_userdata;
 
@@ -356,33 +379,34 @@ rte_service_runner_do_callback(struct rte_service_spec_impl *s,
 /* Expects the service 's' is valid. */
 static int32_t
 service_run(uint32_t i, struct core_state *cs, uint64_t service_mask,
-           struct rte_service_spec_impl *s)
+           struct rte_service_spec_impl *s, uint32_t serialize_mt_unsafe)
 {
        if (!s)
                return -EINVAL;
 
-       if (s->comp_runstate != RUNSTATE_RUNNING ||
-                       s->app_runstate != RUNSTATE_RUNNING ||
-                       !(service_mask & (UINT64_C(1) << i))) {
+       /* comp_runstate and app_runstate act as the guard variables.
+        * Use load-acquire memory order. This synchronizes with
+        * store-release in service state set functions.
+        */
+       if (__atomic_load_n(&s->comp_runstate, __ATOMIC_ACQUIRE) !=
+                       RUNSTATE_RUNNING ||
+           __atomic_load_n(&s->app_runstate, __ATOMIC_ACQUIRE) !=
+                       RUNSTATE_RUNNING ||
+           !(service_mask & (UINT64_C(1) << i))) {
                cs->service_active_on_lcore[i] = 0;
                return -ENOEXEC;
        }
 
        cs->service_active_on_lcore[i] = 1;
 
-       /* check do we need cmpset, if MT safe or <= 1 core
-        * mapped, atomic ops are not required.
-        */
-       const int use_atomics = (service_mt_safe(s) == 0) &&
-                               (rte_atomic32_read(&s->num_mapped_cores) > 1);
-       if (use_atomics) {
-               if (!rte_atomic32_cmpset((uint32_t *)&s->execute_lock, 0, 1))
+       if ((service_mt_safe(s) == 0) && (serialize_mt_unsafe == 1)) {
+               if (!rte_spinlock_trylock(&s->execute_lock))
                        return -EBUSY;
 
-               rte_service_runner_do_callback(s, cs, i);
-               rte_atomic32_clear(&s->execute_lock);
+               service_runner_do_callback(s, cs, i);
+               rte_spinlock_unlock(&s->execute_lock);
        } else
-               rte_service_runner_do_callback(s, cs, i);
+               service_runner_do_callback(s, cs, i);
 
        return 0;
 }
@@ -398,7 +422,7 @@ rte_service_may_be_active(uint32_t id)
                return -EINVAL;
 
        for (i = 0; i < lcore_count; i++) {
-               if (lcore_states[i].service_active_on_lcore[id])
+               if (lcore_states[ids[i]].service_active_on_lcore[id])
                        return 1;
        }
 
@@ -413,53 +437,44 @@ rte_service_run_iter_on_app_lcore(uint32_t id, uint32_t serialize_mt_unsafe)
 
        SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
 
-       /* Atomically add this core to the mapped cores first, then examine if
-        * we can run the service. This avoids a race condition between
-        * checking the value, and atomically adding to the mapped count.
+       /* Increment num_mapped_cores to reflect that this core is
+        * now mapped capable of running the service.
         */
-       if (serialize_mt_unsafe)
-               rte_atomic32_inc(&s->num_mapped_cores);
+       __atomic_add_fetch(&s->num_mapped_cores, 1, __ATOMIC_RELAXED);
 
-       if (service_mt_safe(s) == 0 &&
-                       rte_atomic32_read(&s->num_mapped_cores) > 1) {
-               if (serialize_mt_unsafe)
-                       rte_atomic32_dec(&s->num_mapped_cores);
-               return -EBUSY;
-       }
-
-       int ret = service_run(id, cs, UINT64_MAX, s);
+       int ret = service_run(id, cs, UINT64_MAX, s, serialize_mt_unsafe);
 
-       if (serialize_mt_unsafe)
-               rte_atomic32_dec(&s->num_mapped_cores);
+       __atomic_sub_fetch(&s->num_mapped_cores, 1, __ATOMIC_RELAXED);
 
        return ret;
 }
 
 static int32_t
-rte_service_runner_func(void *arg)
+service_runner_func(void *arg)
 {
        RTE_SET_USED(arg);
        uint32_t i;
        const int lcore = rte_lcore_id();
        struct core_state *cs = &lcore_states[lcore];
 
-       while (lcore_states[lcore].runstate == RUNSTATE_RUNNING) {
+       /* runstate act as the guard variable. Use load-acquire
+        * memory order here to synchronize with store-release
+        * in runstate update functions.
+        */
+       while (__atomic_load_n(&cs->runstate, __ATOMIC_ACQUIRE) ==
+                       RUNSTATE_RUNNING) {
                const uint64_t service_mask = cs->service_mask;
 
                for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
                        if (!service_valid(i))
                                continue;
                        /* return value ignored as no change to code flow */
-                       service_run(i, cs, service_mask, service_get(i));
+                       service_run(i, cs, service_mask, service_get(i), 1);
                }
 
                cs->loops++;
-
-               rte_smp_rmb();
        }
 
-       lcore_config[lcore].state = WAIT;
-
        return 0;
 }
 
@@ -552,24 +567,11 @@ rte_service_start_with_defaults(void)
 }
 
 static int32_t
-service_update(struct rte_service_spec *service, uint32_t lcore,
-               uint32_t *set, uint32_t *enabled)
+service_update(uint32_t sid, uint32_t lcore, uint32_t *set, uint32_t *enabled)
 {
-       uint32_t i;
-       int32_t sid = -1;
-
-       for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
-               if ((struct rte_service_spec *)&rte_services[i] == service &&
-                               service_valid(i)) {
-                       sid = i;
-                       break;
-               }
-       }
-
-       if (sid == -1 || lcore >= RTE_MAX_LCORE)
-               return -EINVAL;
-
-       if (!lcore_states[lcore].is_service_core)
+       /* validate ID, or return error value */
+       if (sid >= RTE_SERVICE_NUM_MAX || !service_valid(sid) ||
+           lcore >= RTE_MAX_LCORE || !lcore_states[lcore].is_service_core)
                return -EINVAL;
 
        uint64_t sid_mask = UINT64_C(1) << sid;
@@ -579,38 +581,34 @@ service_update(struct rte_service_spec *service, uint32_t lcore,
 
                if (*set && !lcore_mapped) {
                        lcore_states[lcore].service_mask |= sid_mask;
-                       rte_atomic32_inc(&rte_services[sid].num_mapped_cores);
+                       __atomic_add_fetch(&rte_services[sid].num_mapped_cores,
+                               1, __ATOMIC_RELAXED);
                }
                if (!*set && lcore_mapped) {
                        lcore_states[lcore].service_mask &= ~(sid_mask);
-                       rte_atomic32_dec(&rte_services[sid].num_mapped_cores);
+                       __atomic_sub_fetch(&rte_services[sid].num_mapped_cores,
+                               1, __ATOMIC_RELAXED);
                }
        }
 
        if (enabled)
                *enabled = !!(lcore_states[lcore].service_mask & (sid_mask));
 
-       rte_smp_wmb();
-
        return 0;
 }
 
 int32_t
 rte_service_map_lcore_set(uint32_t id, uint32_t lcore, uint32_t enabled)
 {
-       struct rte_service_spec_impl *s;
-       SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
        uint32_t on = enabled > 0;
-       return service_update(&s->spec, lcore, &on, 0);
+       return service_update(id, lcore, &on, 0);
 }
 
 int32_t
 rte_service_map_lcore_get(uint32_t id, uint32_t lcore)
 {
-       struct rte_service_spec_impl *s;
-       SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
        uint32_t enabled;
-       int ret = service_update(&s->spec, lcore, 0, &enabled);
+       int ret = service_update(id, lcore, 0, &enabled);
        if (ret == 0)
                return enabled;
        return ret;
@@ -639,13 +637,17 @@ rte_service_lcore_reset_all(void)
                if (lcore_states[i].is_service_core) {
                        lcore_states[i].service_mask = 0;
                        set_lcore_state(i, ROLE_RTE);
-                       lcore_states[i].runstate = RUNSTATE_STOPPED;
+                       /* runstate act as guard variable Use
+                        * store-release memory order here to synchronize
+                        * with load-acquire in runstate read functions.
+                        */
+                       __atomic_store_n(&lcore_states[i].runstate,
+                               RUNSTATE_STOPPED, __ATOMIC_RELEASE);
                }
        }
        for (i = 0; i < RTE_SERVICE_NUM_MAX; i++)
-               rte_atomic32_set(&rte_services[i].num_mapped_cores, 0);
-
-       rte_smp_wmb();
+               __atomic_store_n(&rte_services[i].num_mapped_cores, 0,
+                       __ATOMIC_RELAXED);
 
        return 0;
 }
@@ -662,9 +664,11 @@ rte_service_lcore_add(uint32_t lcore)
 
        /* ensure that after adding a core the mask and state are defaults */
        lcore_states[lcore].service_mask = 0;
-       lcore_states[lcore].runstate = RUNSTATE_STOPPED;
-
-       rte_smp_wmb();
+       /* Use store-release memory order here to synchronize with
+        * load-acquire in runstate read functions.
+        */
+       __atomic_store_n(&lcore_states[lcore].runstate, RUNSTATE_STOPPED,
+               __ATOMIC_RELEASE);
 
        return rte_eal_wait_lcore(lcore);
 }
@@ -679,7 +683,12 @@ rte_service_lcore_del(uint32_t lcore)
        if (!cs->is_service_core)
                return -EINVAL;
 
-       if (cs->runstate != RUNSTATE_STOPPED)
+       /* runstate act as the guard variable. Use load-acquire
+        * memory order here to synchronize with store-release
+        * in runstate update functions.
+        */
+       if (__atomic_load_n(&cs->runstate, __ATOMIC_ACQUIRE) !=
+                       RUNSTATE_STOPPED)
                return -EBUSY;
 
        set_lcore_state(lcore, ROLE_RTE);
@@ -698,15 +707,23 @@ rte_service_lcore_start(uint32_t lcore)
        if (!cs->is_service_core)
                return -EINVAL;
 
-       if (cs->runstate == RUNSTATE_RUNNING)
+       /* runstate act as the guard variable. Use load-acquire
+        * memory order here to synchronize with store-release
+        * in runstate update functions.
+        */
+       if (__atomic_load_n(&cs->runstate, __ATOMIC_ACQUIRE) ==
+                       RUNSTATE_RUNNING)
                return -EALREADY;
 
        /* set core to run state first, and then launch otherwise it will
         * return immediately as runstate keeps it in the service poll loop
         */
-       lcore_states[lcore].runstate = RUNSTATE_RUNNING;
+       /* Use load-acquire memory order here to synchronize with
+        * store-release in runstate update functions.
+        */
+       __atomic_store_n(&cs->runstate, RUNSTATE_RUNNING, __ATOMIC_RELEASE);
 
-       int ret = rte_eal_remote_launch(rte_service_runner_func, 0, lcore);
+       int ret = rte_eal_remote_launch(service_runner_func, 0, lcore);
        /* returns -EBUSY if the core is already launched, 0 on success */
        return ret;
 }
@@ -717,7 +734,12 @@ rte_service_lcore_stop(uint32_t lcore)
        if (lcore >= RTE_MAX_LCORE)
                return -EINVAL;
 
-       if (lcore_states[lcore].runstate == RUNSTATE_STOPPED)
+       /* runstate act as the guard variable. Use load-acquire
+        * memory order here to synchronize with store-release
+        * in runstate update functions.
+        */
+       if (__atomic_load_n(&lcore_states[lcore].runstate, __ATOMIC_ACQUIRE) ==
+                       RUNSTATE_STOPPED)
                return -EALREADY;
 
        uint32_t i;
@@ -726,7 +748,8 @@ rte_service_lcore_stop(uint32_t lcore)
                int32_t enabled = service_mask & (UINT64_C(1) << i);
                int32_t service_running = rte_service_runstate_get(i);
                int32_t only_core = (1 ==
-                       rte_atomic32_read(&rte_services[i].num_mapped_cores));
+                       __atomic_load_n(&rte_services[i].num_mapped_cores,
+                               __ATOMIC_RELAXED));
 
                /* if the core is mapped, and the service is running, and this
                 * is the only core that is mapped, the service would cease to
@@ -736,7 +759,11 @@ rte_service_lcore_stop(uint32_t lcore)
                        return -EBUSY;
        }
 
-       lcore_states[lcore].runstate = RUNSTATE_STOPPED;
+       /* Use store-release memory order here to synchronize with
+        * load-acquire in runstate read functions.
+        */
+       __atomic_store_n(&lcore_states[lcore].runstate, RUNSTATE_STOPPED,
+               __ATOMIC_RELEASE);
 
        return 0;
 }
@@ -785,13 +812,9 @@ rte_service_lcore_attr_get(uint32_t lcore, uint32_t attr_id,
 }
 
 static void
-rte_service_dump_one(FILE *f, struct rte_service_spec_impl *s,
-                    uint64_t all_cycles, uint32_t reset)
+service_dump_one(FILE *f, struct rte_service_spec_impl *s, uint32_t reset)
 {
        /* avoid divide by zero */
-       if (all_cycles == 0)
-               all_cycles = 1;
-
        int calls = 1;
        if (s->calls != 0)
                calls = s->calls;
@@ -818,7 +841,7 @@ rte_service_attr_reset_all(uint32_t id)
        SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
 
        int reset = 1;
-       rte_service_dump_one(NULL, s, 0, reset);
+       service_dump_one(NULL, s, reset);
        return 0;
 }
 
@@ -862,21 +885,13 @@ rte_service_dump(FILE *f, uint32_t id)
        uint32_t i;
        int print_one = (id != UINT32_MAX);
 
-       uint64_t total_cycles = 0;
-
-       for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
-               if (!service_valid(i))
-                       continue;
-               total_cycles += rte_services[i].cycles_spent;
-       }
-
        /* print only the specified service */
        if (print_one) {
                struct rte_service_spec_impl *s;
                SERVICE_VALID_GET_OR_ERR_RET(id, s, -EINVAL);
                fprintf(f, "Service %s Summary\n", s->spec.name);
                uint32_t reset = 0;
-               rte_service_dump_one(f, s, total_cycles, reset);
+               service_dump_one(f, s, reset);
                return 0;
        }
 
@@ -886,7 +901,7 @@ rte_service_dump(FILE *f, uint32_t id)
                if (!service_valid(i))
                        continue;
                uint32_t reset = 0;
-               rte_service_dump_one(f, &rte_services[i], total_cycles, reset);
+               service_dump_one(f, &rte_services[i], reset);
        }
 
        fprintf(f, "Service Cores Summary\n");