[PATCH dpdk] rel_notes: announce 24.11 ipv6 api breakage

[PATCH dpdk] rel_notes: announce 24.11 ipv6 api breakage

[Robin Jarry]

In 24.11, all IPv6 public APIs will be modified to use a structure
instead of fixed size arrays.

Cc: Bruce Richardson <bruce.richardson@intel.com>
Cc: Morten Brørup <mb@smartsharesystems.com>
Cc: Stephen Hemminger <stephen@networkplumber.org>
Cc: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
Cc: Konstantin Ananyev <konstantin.ananyev@huawei.com>
Signed-off-by: Robin Jarry <rjarry@redhat.com>
---
 doc/guides/rel_notes/deprecation.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff69b..0d7da802382e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -147,3 +147,19 @@ Deprecation Notices
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status.
+
+* net: A new IPv6 address structure will be introduced in DPDK 24.11.
+  It will replace all ad-hoc ``uint8_t[16]`` arrays in all public APIs and structures.
+  The following libraries are expected to be affected:
+
+  - ethdev (rte_flow)
+  - fib
+  - gro (tcp6_flow_key)
+  - hash (rte_ipv6_tuple)
+  - ipsec (rte_ipsec_sadv6_key)
+  - lpm (
+  - net (rte_ipv6_hdr)
+  - node
+  - pipeline (rte_table_action_ipv6_header)
+  - rib
+  - table (rte_table_lpm_ipv6_key)
-- 
2.45.2

RE: [PATCH dpdk] rel_notes: announce 24.11 ipv6 api breakage

[Morten Brørup]

> From: Robin Jarry [mailto:rjarry@redhat.com]
> Sent: Monday, 22 July 2024 19.40
> 
> In 24.11, all IPv6 public APIs will be modified to use a structure
> instead of fixed size arrays.

[...]

> +  - lpm (

Remove "(" or add something here.

With that fixed,
Acked-by: Morten Brørup <mb@smartsharesystems.com>

[PATCH dpdk v2] rel_notes: announce 24.11 ipv6 api breakage

[Robin Jarry]

In 24.11, all IPv6 public APIs will be modified to use a structure
instead of fixed size arrays.

Signed-off-by: Robin Jarry <rjarry@redhat.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
---

Notes:
    v2: updated with the exhaustive list of symbols

 doc/guides/rel_notes/deprecation.rst | 42 ++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff69b..bb17b78d193a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -147,3 +147,45 @@ Deprecation Notices
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status.
+
+* net: A new IPv6 address structure will be introduced in DPDK 24.11.
+  It will replace all ad-hoc ``uint8_t[16]`` arrays in all public APIs and structures.
+  The following libraries and symbols are expected to be affected:
+
+  ethdev
+    - ``struct rte_flow_item_icmp6_nd_ns``
+    - ``struct rte_flow_item_icmp6_nd_na``
+    - ``struct rte_flow_action_set_ipv6``
+    - ``struct rte_flow_tunnel``
+  fib
+    - ``rte_fib6_add()``
+    - ``rte_fib6_delete()``
+    - ``rte_fib6_lookup_bulk()``
+  gro
+    - ``struct tcp6_flow_key``
+  hash
+    - ``struct rte_ipv6_tuple``
+  ipsec
+    - ``struct rte_ipsec_sadv6_key``
+  lpm
+    - ``rte_lpm6_add()``
+    - ``rte_lpm6_is_rule_present()``
+    - ``rte_lpm6_delete()``
+    - ``rte_lpm6_delete_bulk_func()``
+    - ``rte_lpm6_lookup()``
+    - ``rte_lpm6_lookup_bulk_func()``
+  net
+    - ``struct rte_ipv6_hdr``
+  node
+    - ``rte_node_ip6_route_add()``
+  pipeline
+    - ``struct rte_table_action_ipv6_header``
+  rib
+    - ``rte_rib6_lookup()``
+    - ``rte_rib6_lookup_exact()``
+    - ``rte_rib6_get_nxt()``
+    - ``rte_rib6_insert()``
+    - ``rte_rib6_remove()``
+    - ``rte_rib6_get_ip()``
+  table
+    - ``struct rte_table_lpm_ipv6_key``
-- 
2.45.2

Re: [PATCH dpdk v2] rel_notes: announce 24.11 ipv6 api breakage

[Bruce Richardson]

On Tue, Jul 23, 2024 at 10:27:46AM +0200, Robin Jarry wrote:
> In 24.11, all IPv6 public APIs will be modified to use a structure
> instead of fixed size arrays.
> 
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> Acked-by: Morten Brørup <mb@smartsharesystems.com>
> ---
> 
Acked-by: Bruce Richardson <bruce.richardson@intel.com>

RE: [PATCH dpdk v2] rel_notes: announce 24.11 ipv6 api breakage

[Konstantin Ananyev]

> In 24.11, all IPv6 public APIs will be modified to use a structure
> instead of fixed size arrays.
> 
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> Acked-by: Morten Brørup <mb@smartsharesystems.com>
> ---
> 
> Notes:
>     v2: updated with the exhaustive list of symbols
> 
>  doc/guides/rel_notes/deprecation.rst | 42 ++++++++++++++++++++++++++++
>  1 file changed, 42 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 6948641ff69b..bb17b78d193a 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -147,3 +147,45 @@ Deprecation Notices
>    will be deprecated and subsequently removed in DPDK 24.11 release.
>    Before this, the new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status.
> +
> +* net: A new IPv6 address structure will be introduced in DPDK 24.11.
> +  It will replace all ad-hoc ``uint8_t[16]`` arrays in all public APIs and structures.
> +  The following libraries and symbols are expected to be affected:
> +
> +  ethdev
> +    - ``struct rte_flow_item_icmp6_nd_ns``
> +    - ``struct rte_flow_item_icmp6_nd_na``
> +    - ``struct rte_flow_action_set_ipv6``
> +    - ``struct rte_flow_tunnel``
> +  fib
> +    - ``rte_fib6_add()``
> +    - ``rte_fib6_delete()``
> +    - ``rte_fib6_lookup_bulk()``
> +  gro
> +    - ``struct tcp6_flow_key``
> +  hash
> +    - ``struct rte_ipv6_tuple``
> +  ipsec
> +    - ``struct rte_ipsec_sadv6_key``
> +  lpm
> +    - ``rte_lpm6_add()``
> +    - ``rte_lpm6_is_rule_present()``
> +    - ``rte_lpm6_delete()``
> +    - ``rte_lpm6_delete_bulk_func()``
> +    - ``rte_lpm6_lookup()``
> +    - ``rte_lpm6_lookup_bulk_func()``
> +  net
> +    - ``struct rte_ipv6_hdr``
> +  node
> +    - ``rte_node_ip6_route_add()``
> +  pipeline
> +    - ``struct rte_table_action_ipv6_header``
> +  rib
> +    - ``rte_rib6_lookup()``
> +    - ``rte_rib6_lookup_exact()``
> +    - ``rte_rib6_get_nxt()``
> +    - ``rte_rib6_insert()``
> +    - ``rte_rib6_remove()``
> +    - ``rte_rib6_get_ip()``
> +  table
> +    - ``struct rte_table_lpm_ipv6_key``
> --
Acked-by: Konstantin Ananyev <konstantin.ananyev@huawei.com>
> 2.45.2
> 

Re: [PATCH dpdk v2] rel_notes: announce 24.11 ipv6 api breakage

[Medvedkin, Vladimir]

Acked-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>

On 23/07/2024 09:27, Robin Jarry wrote:
> In 24.11, all IPv6 public APIs will be modified to use a structure
> instead of fixed size arrays.
>
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> Acked-by: Morten Brørup <mb@smartsharesystems.com>
> ---
>
> Notes:
>      v2: updated with the exhaustive list of symbols
>
>   doc/guides/rel_notes/deprecation.rst | 42 ++++++++++++++++++++++++++++
>   1 file changed, 42 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 6948641ff69b..bb17b78d193a 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -147,3 +147,45 @@ Deprecation Notices
>     will be deprecated and subsequently removed in DPDK 24.11 release.
>     Before this, the new port library API (functions rte_swx_port_*)
>     will gradually transition from experimental to stable status.
> +
> +* net: A new IPv6 address structure will be introduced in DPDK 24.11.
> +  It will replace all ad-hoc ``uint8_t[16]`` arrays in all public APIs and structures.
> +  The following libraries and symbols are expected to be affected:
> +
> +  ethdev
> +    - ``struct rte_flow_item_icmp6_nd_ns``
> +    - ``struct rte_flow_item_icmp6_nd_na``
> +    - ``struct rte_flow_action_set_ipv6``
> +    - ``struct rte_flow_tunnel``
> +  fib
> +    - ``rte_fib6_add()``
> +    - ``rte_fib6_delete()``
> +    - ``rte_fib6_lookup_bulk()``
> +  gro
> +    - ``struct tcp6_flow_key``
> +  hash
> +    - ``struct rte_ipv6_tuple``
> +  ipsec
> +    - ``struct rte_ipsec_sadv6_key``
> +  lpm
> +    - ``rte_lpm6_add()``
> +    - ``rte_lpm6_is_rule_present()``
> +    - ``rte_lpm6_delete()``
> +    - ``rte_lpm6_delete_bulk_func()``
> +    - ``rte_lpm6_lookup()``
> +    - ``rte_lpm6_lookup_bulk_func()``
> +  net
> +    - ``struct rte_ipv6_hdr``
> +  node
> +    - ``rte_node_ip6_route_add()``
> +  pipeline
> +    - ``struct rte_table_action_ipv6_header``
> +  rib
> +    - ``rte_rib6_lookup()``
> +    - ``rte_rib6_lookup_exact()``
> +    - ``rte_rib6_get_nxt()``
> +    - ``rte_rib6_insert()``
> +    - ``rte_rib6_remove()``
> +    - ``rte_rib6_get_ip()``
> +  table
> +    - ``struct rte_table_lpm_ipv6_key``

-- 
Regards,
Vladimir

Re: [PATCH dpdk v2] rel_notes: announce 24.11 ipv6 api breakage

[Thomas Monjalon]

23/07/2024 10:27, Robin Jarry:
> In 24.11, all IPv6 public APIs will be modified to use a structure
> instead of fixed size arrays.
> 
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> Acked-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@huawei.com>
Acked-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>

Applied, thanks.