[PATCH v5 4/4] eal: deprecate rte thread setname API

[David Marchand]

On Tue, Jan 17, 2023 at 7:21 PM Tyler Retzlaff
<roretzla at linux.microsoft.com> wrote:
>
> Notify deprecation of rte_thread_setname API, it is being removed as it
> exposes platform-specific thread details. The functionality it provided
> is now implicitly provided via the rte_lcore_set_name API if the
> underlying platform supports it.
>
> Signed-off-by: Tyler Retzlaff <roretzla at linux.microsoft.com>

I counted one ack from Morten.
With mine (for the notice part, see comment below), that makes two.
Acked-by: David Marchand <david.marchand at redhat.com>

We need one more ack (Cc: techboard, hoping that some kind member will ack).


> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  lib/eal/include/rte_lcore.h          | 2 ++
>  2 files changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index e18ac34..2990bb1 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -126,3 +126,7 @@ Deprecation Notices
>    Its removal has been postponed to let potential users report interest
>    in maintaining it.
>    In the absence of such interest, this library will be removed in DPDK 23.11.
> +
> +* eal: The function ``rte_thread_setname`` will be removed, continuing
> +  the effort to decouple EAL from platform-specific thread
> +  implementations.
> diff --git a/lib/eal/include/rte_lcore.h b/lib/eal/include/rte_lcore.h
> index 9c78650..2fb3091 100644
> --- a/lib/eal/include/rte_lcore.h
> +++ b/lib/eal/include/rte_lcore.h
> @@ -13,6 +13,7 @@
>   */
>  #include <stdio.h>
>
> +#include <rte_common.h>
>  #include <rte_compat.h>
>  #include <rte_config.h>
>  #include <rte_per_lcore.h>
> @@ -349,6 +350,7 @@ enum rte_lcore_role_t {
>   * @return
>   *   On success, return 0; otherwise return a negative value.
>   */
> +__rte_deprecated
>  int rte_thread_setname(pthread_t id, const char *name);

However, this part should be removed and postponed to when
rte_thread_set_name is marked stable.
As long as the set_name new symbol is experimental, we can't mark as
deprecated as users would be left with no stable API.


-- 
David Marchand