lib: use SPDX tag for Intel copyright files
[dpdk.git] / lib / librte_eal / common / rte_service.c
index 2b5f9bd..372d0bb 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2017 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2017 Intel Corporation
  */
 
 #include <stdio.h>
@@ -54,6 +25,7 @@
 
 #define SERVICE_F_REGISTERED    (1 << 0)
 #define SERVICE_F_STATS_ENABLED (1 << 1)
+#define SERVICE_F_START_CHECK   (1 << 2)
 
 /* runstates for services and lcores, denoting if they are active or not */
 #define RUNSTATE_STOPPED 0
@@ -76,7 +48,7 @@ struct rte_service_spec_impl {
        uint8_t internal_flags;
 
        /* per service statistics */
-       uint32_t num_mapped_cores;
+       rte_atomic32_t num_mapped_cores;
        uint64_t calls;
        uint64_t cycles_spent;
 } __rte_cache_aligned;
@@ -152,7 +124,7 @@ service_valid(uint32_t id)
        service = &rte_services[id];                                    \
 } while (0)
 
-/* returns 1 if statistics should be colleced for service
+/* returns 1 if statistics should be collected for service
  * Returns 0 if statistics should not be collected for service
  */
 static inline int
@@ -180,6 +152,19 @@ int32_t rte_service_set_stats_enable(uint32_t id, int32_t enabled)
        return 0;
 }
 
+int32_t rte_service_set_runstate_mapped_check(uint32_t id, int32_t enabled)
+{
+       struct rte_service_spec_impl *s;
+       SERVICE_VALID_GET_OR_ERR_RET(id, s, 0);
+
+       if (enabled)
+               s->internal_flags |= SERVICE_F_START_CHECK;
+       else
+               s->internal_flags &= ~(SERVICE_F_START_CHECK);
+
+       return 0;
+}
+
 uint32_t
 rte_service_get_count(void)
 {
@@ -241,7 +226,7 @@ rte_service_component_register(const struct rte_service_spec *spec,
 
        struct rte_service_spec_impl *s = &rte_services[free_slot];
        s->spec = *spec;
-       s->internal_flags |= SERVICE_F_REGISTERED;
+       s->internal_flags |= SERVICE_F_REGISTERED | SERVICE_F_START_CHECK;
 
        rte_smp_wmb();
        rte_service_count++;
@@ -309,9 +294,13 @@ 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);
+
        return (s->app_runstate == RUNSTATE_RUNNING) &&
                (s->comp_runstate == RUNSTATE_RUNNING) &&
-               (s->num_mapped_cores > 0);
+               (check_disabled | lcore_mapped);
 }
 
 static inline void
@@ -331,6 +320,67 @@ rte_service_runner_do_callback(struct rte_service_spec_impl *s,
                s->spec.callback(userdata);
 }
 
+
+static inline int32_t
+service_run(uint32_t i, struct core_state *cs, uint64_t service_mask)
+{
+       if (!service_valid(i))
+               return -EINVAL;
+       struct rte_service_spec_impl *s = &rte_services[i];
+       if (s->comp_runstate != RUNSTATE_RUNNING ||
+                       s->app_runstate != RUNSTATE_RUNNING ||
+                       !(service_mask & (UINT64_C(1) << i)))
+               return -ENOEXEC;
+
+       /* 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))
+                       return -EBUSY;
+
+               rte_service_runner_do_callback(s, cs, i);
+               rte_atomic32_clear(&s->execute_lock);
+       } else
+               rte_service_runner_do_callback(s, cs, i);
+
+       return 0;
+}
+
+int32_t rte_service_run_iter_on_app_lcore(uint32_t id,
+               uint32_t serialize_mt_unsafe)
+{
+       /* run service on calling core, using all-ones as the service mask */
+       if (!service_valid(id))
+               return -EINVAL;
+
+       struct core_state *cs = &lcore_states[rte_lcore_id()];
+       struct rte_service_spec_impl *s = &rte_services[id];
+
+       /* 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.
+        */
+       if (serialize_mt_unsafe)
+               rte_atomic32_inc(&s->num_mapped_cores);
+
+       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);
+
+       if (serialize_mt_unsafe)
+               rte_atomic32_dec(&s->num_mapped_cores);
+
+       return ret;
+}
+
 static int32_t
 rte_service_runner_func(void *arg)
 {
@@ -343,27 +393,8 @@ rte_service_runner_func(void *arg)
                const uint64_t service_mask = cs->service_mask;
 
                for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
-                       if (!service_valid(i))
-                               continue;
-                       struct rte_service_spec_impl *s = &rte_services[i];
-                       if (s->comp_runstate != RUNSTATE_RUNNING ||
-                                       s->app_runstate != RUNSTATE_RUNNING ||
-                                       !(service_mask & (UINT64_C(1) << i)))
-                               continue;
-
-                       /* 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) &&
-                                               (s->num_mapped_cores > 1);
-                       if (use_atomics) {
-                               uint32_t *lock = (uint32_t *)&s->execute_lock;
-                               if (rte_atomic32_cmpset(lock, 0, 1)) {
-                                       rte_service_runner_do_callback(s, cs, i);
-                                       rte_atomic32_clear(&s->execute_lock);
-                               }
-                       } else
-                               rte_service_runner_do_callback(s, cs, i);
+                       /* return value ignored as no change to code flow */
+                       service_run(i, cs, service_mask);
                }
 
                rte_smp_rmb();
@@ -431,7 +462,7 @@ rte_service_start_with_defaults(void)
        uint32_t count = rte_service_get_count();
 
        int32_t lcore_iter = 0;
-       uint32_t ids[RTE_MAX_LCORE];
+       uint32_t ids[RTE_MAX_LCORE] = {0};
        int32_t lcore_count = rte_service_lcore_list(ids, RTE_MAX_LCORE);
 
        if (lcore_count == 0)
@@ -487,10 +518,10 @@ service_update(struct rte_service_spec *service, uint32_t lcore,
        if (set) {
                if (*set) {
                        lcore_states[lcore].service_mask |= sid_mask;
-                       rte_services[sid].num_mapped_cores++;
+                       rte_atomic32_inc(&rte_services[sid].num_mapped_cores);
                } else {
                        lcore_states[lcore].service_mask &= ~(sid_mask);
-                       rte_services[sid].num_mapped_cores--;
+                       rte_atomic32_dec(&rte_services[sid].num_mapped_cores);
                }
        }
 
@@ -533,7 +564,7 @@ int32_t rte_service_lcore_reset_all(void)
                lcore_states[i].runstate = RUNSTATE_STOPPED;
        }
        for (i = 0; i < RTE_SERVICE_NUM_MAX; i++)
-               rte_services[i].num_mapped_cores = 0;
+               rte_atomic32_set(&rte_services[i].num_mapped_cores, 0);
 
        rte_smp_wmb();
 
@@ -625,11 +656,12 @@ rte_service_lcore_stop(uint32_t lcore)
                return -EALREADY;
 
        uint32_t i;
+       uint64_t service_mask = lcore_states[lcore].service_mask;
        for (i = 0; i < RTE_SERVICE_NUM_MAX; i++) {
-               int32_t enabled =
-                       lcore_states[i].service_mask & (UINT64_C(1) << i);
+               int32_t enabled = service_mask & (UINT64_C(1) << i);
                int32_t service_running = rte_service_runstate_get(i);
-               int32_t only_core = rte_services[i].num_mapped_cores == 1;
+               int32_t only_core = (1 ==
+                       rte_atomic32_read(&rte_services[i].num_mapped_cores));
 
                /* if the core is mapped, and the service is running, and this
                 * is the only core that is mapped, the service would cease to