[dpdk-dev] [PATCH v1 0/4] doc: announce API changes for flow rules

[dpdk-dev] [PATCH v1 0/4] doc: announce API changes for flow rules

[Adrien Mazarguil]

Series of API/ABI change announcements for rte_flow to enable proper
encap/decap support and address various design issues that can't be
addressed without ABI impact.

Adrien Mazarguil (4):
  doc: announce API change for flow actions
  doc: announce API change for flow RSS action
  doc: announce API change for flow RSS/RAW actions
  doc: announce API change for flow VLAN pattern item

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

-- 
2.11.0

[dpdk-dev] [PATCH v1 1/4] doc: announce API change for flow actions

[Adrien Mazarguil]

This announce is related to the discussion regarding TEP and the need for
encap/decap support in rte_flow [1].

It's now clear that PMD support for chaining multiple non-terminating flow
rules of varying priority levels is prohibitively difficult to implement
compared to simply allowing multiple identical actions performed in a
defined order by a single flow rule.

[1] http://dpdk.org/ml/archives/dev/2017-December/084676.html

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d59ad5988..663550acb 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -59,3 +59,11 @@ Deprecation Notices
   be added between the producer and consumer structures. The size of the
   structure and the offset of the fields will remain the same on
   platforms with 64B cache line, but will change on other platforms.
+
+* rte_flow: flow rule action semantics will be modified to enable support
+  for encap/decap. All actions part of a flow rule will be taken into
+  account; not only the last one in case of repeated actions. Their order
+  will matter. This change will make the DUP action redundant, and the
+  (non-)terminating property of actions will be discarded. Instead, flow
+  rules themselves will be considered terminating by default unless a
+  PASSTHRU action is also specified.
-- 
2.11.0

[dpdk-dev] [PATCH v1 2/4] doc: announce API change for flow RSS action

[Adrien Mazarguil]

Since its inception, the rte_flow RSS action has been relying in part on
struct rte_eth_rss_conf for compatibility with the legacy RSS API. This
structure lacks parameters such as the hash function to use, and more
recently, a method to tell which layer RSS should be performed on [1].

Given struct rte_eth_rss_conf will never be flexible enough to represent a
complete RSS configuration (e.g. RETA table), struct rte_flow_action_rss
will be extended instead.

Depending on the outcome of RSS level implementation work, this deprecation
notice may either cancel or come in conjunction with [1].

[1] http://dpdk.org/ml/archives/dev/2018-February/090359.html

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 663550acb..40b76b391 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -67,3 +67,8 @@ Deprecation Notices
   (non-)terminating property of actions will be discarded. Instead, flow
   rules themselves will be considered terminating by default unless a
   PASSTHRU action is also specified.
+
+* rte_flow: RSS action will stop relying on the legacy ``struct
+  rte_eth_rss_conf`` due to its limitations. All parameters, including the
+  currently missing hash function to use will be made part of ``struct
+  rte_flow_action_rss`` directly.
-- 
2.11.0

[dpdk-dev] [PATCH v1 3/4] doc: announce API change for flow RSS/RAW actions

[Adrien Mazarguil]

C99-style flexible arrays were a bad idea for this API. This announces a
minor API/ABI change to remove them.

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 40b76b391..77390ce9f 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -72,3 +72,8 @@ Deprecation Notices
   rte_eth_rss_conf`` due to its limitations. All parameters, including the
   currently missing hash function to use will be made part of ``struct
   rte_flow_action_rss`` directly.
+
+* rte_flow: C99-style flexible arrays in ``struct rte_flow_action_rss`` and
+  ``struct rte_flow_item_raw`` will be replaced by standard pointers to the
+  same data. They proved difficult to use in the field (e.g. no possibility
+  of static initialization) and are unsuitable for C++ applications.
-- 
2.11.0

[dpdk-dev] [PATCH v1 4/4] doc: announce API change for flow VLAN pattern item

[Adrien Mazarguil]

This will finally bring consistency to the VLAN pattern item definition,
particularly when attempting to match QinQ traffic. Applications relying on
TCI and no QinQ shouldn't notice a difference.

On the other hand, applications relying on EtherType matching will have to
adapt their patterns so they match from outermost to innermost (as on the
wire) instead of the current mess (innermost, then outermost to innermost
in case of QinQ).

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 77390ce9f..5cd337807 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -77,3 +77,8 @@ Deprecation Notices
   ``struct rte_flow_item_raw`` will be replaced by standard pointers to the
   same data. They proved difficult to use in the field (e.g. no possibility
   of static initialization) and are unsuitable for C++ applications.
+
+* rte_flow: VLAN pattern item (``struct rte_flow_item_vlan``) will be
+  redefined more logically with TCI followed by inner EtherType (wire order)
+  instead of outer TPID followed by TCI (with inner EtherType part of the
+  previous pattern item), as the latter results in much confusion.
-- 
2.11.0

Re: [dpdk-dev] [PATCH v1 0/4] doc: announce API changes for flow rules

[Nélio Laranjeiro]

On Wed, Feb 14, 2018 at 04:37:26PM +0100, Adrien Mazarguil wrote:
> Series of API/ABI change announcements for rte_flow to enable proper
> encap/decap support and address various design issues that can't be
> addressed without ABI impact.
> 
> Adrien Mazarguil (4):
>   doc: announce API change for flow actions
>   doc: announce API change for flow RSS action
>   doc: announce API change for flow RSS/RAW actions
>   doc: announce API change for flow VLAN pattern item
> 
>  doc/guides/rel_notes/deprecation.rst | 23 +++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
> 
> -- 
> 2.11.0

For the series,

Acked-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>

-- 
Nélio Laranjeiro
6WIND

Re: [dpdk-dev] [PATCH v1 0/4] doc: announce API changes for flow rules

[Andrew Rybchenko]

On 02/14/2018 06:55 PM, Nélio Laranjeiro wrote:
> On Wed, Feb 14, 2018 at 04:37:26PM +0100, Adrien Mazarguil wrote:
>> Series of API/ABI change announcements for rte_flow to enable proper
>> encap/decap support and address various design issues that can't be
>> addressed without ABI impact.
>>
>> Adrien Mazarguil (4):
>>    doc: announce API change for flow actions
>>    doc: announce API change for flow RSS action
>>    doc: announce API change for flow RSS/RAW actions
>>    doc: announce API change for flow VLAN pattern item
>>
>>   doc/guides/rel_notes/deprecation.rst | 23 +++++++++++++++++++++++
>>   1 file changed, 23 insertions(+)
>>
>> -- 
>> 2.11.0
> For the series,
>
> Acked-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>

For the series,

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>