From: Chengwen Feng <[email protected]> Announce the rename of the socket_id fields of the public structures to numa_node, and the deprecation of the socket-named functions and macros across several libraries, keeping them as deprecated aliases for one release.
This notice starts the deprecation process of the NUMA node terminology migration discussed on the mailing list. The mechanical conversion will be submitted as a single patch, produced with the coccinelle script added by the next patch, once this notice completes a release cycle. Signed-off-by: Chengwen Feng <[email protected]> --- doc/guides/rel_notes/deprecation.rst | 35 ++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 02b495f6a8..f846a4c83b 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -16,6 +16,41 @@ Other API and ABI deprecation notices are to be posted below. Deprecation Notices ------------------- +* Terminology change: The public structures use ``socket_id`` to refer to a NUMA node, + which conflates CPU sockets with NUMA memory nodes. + The field is renamed to ``numa_node``, keeping ``socket_id`` + as a deprecated union alias. + Affected structures include: ``rte_acl_param``, ``rte_bbdev_data``, + ``rte_bbdev_info``, ``rte_bbdev_queue_conf``, ``rte_compressdev_config``, + ``rte_cryptodev_config``, ``rte_event_timer_adapter_conf``, + ``rte_event_vector_adapter_conf``, ``rte_fbk_hash_params``, + ``rte_graph``, ``rte_graph_cluster_stats_param``, ``rte_graph_param``, + ``rte_gro_param``, ``rte_hash_parameters``, ``rte_ipsec_sad_conf``, + ``rte_member_parameters``, ``rte_member_setsum``, ``rte_memseg``, + ``rte_memseg_list``, ``rte_memzone``, ``rte_ml_dev_config``, + ``rte_mempool``, ``rte_rawdev``, ``rte_rawdev_info`` and + ``rte_service_spec``. + The fields of ``rte_graph`` and ``rte_bbdev_queue_conf`` are named + ``socket`` rather than ``socket_id``; their deprecated aliases keep + that name. + Applications should switch to ``numa_node``. + +* Terminology change: The legacy socket-named functions + ``rte_socket_id()``, ``rte_socket_count()``, ``rte_socket_id_by_idx()``, + ``rte_cpu_socket_id()``, ``rte_lcore_to_socket_id()``, + the ``rte_malloc_socket()`` family, + ``rte_malloc_heap_get_socket()``, ``rte_malloc_get_socket_stats()``, + ``rte_malloc_heap_socket_is_external()``, ``rte_eth_dev_socket_id()``, + ``rte_cryptodev_socket_id()``, ``rte_compressdev_socket_id()``, + ``rte_event_dev_socket_id()``, ``rte_rawdev_socket_id()`` and + ``rte_ml_dev_socket_id()`` + are deprecated aliases of their NUMA-named replacements, + and will be removed in a future release. + The ``rte_malloc_socket_stats`` structure is renamed to + ``rte_malloc_numa_stats``, keeping the old name as a deprecated + typedef alias. + The ``SOCKET_ID_ANY`` macro is deprecated; use ``RTE_NUMA_NODE_ANY``. + * kvargs: The function ``rte_kvargs_process`` will get a new parameter for returning key match count. It will ease handling of no-match case. -- 2.55.0
