From b0a1502a277cafe29e647d74f5fbbb3a153c63c7 Mon Sep 17 00:00:00 2001 From: Anatoly Burakov Date: Thu, 26 Apr 2018 14:42:31 +0100 Subject: [PATCH] eal: make semantics of lcore role function more intuitive rte_lcore_has_role() returns 0 if role of lcore matches requested role. The return value of the API is confusing, and this is a known problem with a deprecation notice announcing the change to more intuitive semantics: Commit 064518f68d48 ("doc: announce EAL API change to lcore role function") Implement changes announced in the deprecation notice, and remove it. Also, fix usages of this API to reflect the change. Control thread patches expected new behavior and were broken before, now they are fixed as well. Fixes: d651ee4919cd ("eal: set affinity for control threads") Signed-off-by: Anatoly Burakov Signed-off-by: Erik Gabriel Carrillo Signed-off-by: Thomas Monjalon --- doc/guides/rel_notes/deprecation.rst | 5 ----- doc/guides/rel_notes/release_18_05.rst | 6 ++++++ lib/librte_eal/common/eal_common_thread.c | 5 +---- lib/librte_eal/common/include/rte_lcore.h | 2 +- lib/librte_timer/rte_timer.c | 2 +- 5 files changed, 9 insertions(+), 11 deletions(-) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 72ab33cb7e..3353519583 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -28,11 +28,6 @@ Deprecation Notices - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse`` - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` -* eal: The semantics of the return value for the ``rte_lcore_has_role`` function - are planned to change in v18.05. The function currently returns 0 and <0 for - success and failure, respectively. This will change to 1 and 0 for true and - false, respectively, to make use of the function more intuitive. - * eal: a new set of mbuf mempool ops name APIs for user, platform and best mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst index 7c135a1614..5408645bf2 100644 --- a/doc/guides/rel_notes/release_18_05.rst +++ b/doc/guides/rel_notes/release_18_05.rst @@ -161,6 +161,12 @@ API Changes announced at least one release before the ABI change is made. There are no ABI breaking changes planned. +* eal: ``rte_lcore_has_role()`` return value changed. + + This function now returns true or false, respectively, + rather than 0 or <0 for success or failure. + It makes use of the function more intuitive. + * mempool: capability flags and related functions have been removed. Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and diff --git a/lib/librte_eal/common/eal_common_thread.c b/lib/librte_eal/common/eal_common_thread.c index 4e75cb81f5..fcf00cd023 100644 --- a/lib/librte_eal/common/eal_common_thread.c +++ b/lib/librte_eal/common/eal_common_thread.c @@ -34,10 +34,7 @@ rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role) if (lcore_id >= RTE_MAX_LCORE) return -EINVAL; - if (cfg->lcore_role[lcore_id] == role) - return 0; - - return -EINVAL; + return cfg->lcore_role[lcore_id] == role; } int eal_cpuset_socket_id(rte_cpuset_t *cpusetp) diff --git a/lib/librte_eal/common/include/rte_lcore.h b/lib/librte_eal/common/include/rte_lcore.h index 334a0629e3..1a2f37eaa4 100644 --- a/lib/librte_eal/common/include/rte_lcore.h +++ b/lib/librte_eal/common/include/rte_lcore.h @@ -311,7 +311,7 @@ rte_ctrl_thread_create(pthread_t *thread, const char *name, * @param role * The role to be checked against. * @return - * On success, return 0; otherwise return a negative value. + * Boolean value: positive if test is true; otherwise returns 0. */ int rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role); diff --git a/lib/librte_timer/rte_timer.c b/lib/librte_timer/rte_timer.c index 4bbcd067b3..590488c7e8 100644 --- a/lib/librte_timer/rte_timer.c +++ b/lib/librte_timer/rte_timer.c @@ -403,7 +403,7 @@ rte_timer_reset(struct rte_timer *tim, uint64_t ticks, if (unlikely((tim_lcore != (unsigned)LCORE_ID_ANY) && !(rte_lcore_is_enabled(tim_lcore) || - rte_lcore_has_role(tim_lcore, ROLE_SERVICE) == 0))) + rte_lcore_has_role(tim_lcore, ROLE_SERVICE)))) return -1; if (type == PERIODICAL) -- 2.20.1