doc: add new feature for connection tracking

Message ID 20210518125235.90185-1-bingz@nvidia.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers
Series doc: add new feature for connection tracking |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Bing Zhao May 18, 2021, 12:52 p.m. UTC
  The feature support of connection tracking is added in the feature
table of networking drivers. The feature overview part is also
updated.

Signed-off-by: Bing Zhao <bingz@nvidia.com>
---
 doc/guides/nics/features.rst         | 12 ++++++++++++
 doc/guides/nics/features/default.ini |  1 +
 doc/guides/nics/features/mlx5.ini    |  1 +
 3 files changed, 14 insertions(+)
  

Comments

Ferruh Yigit May 18, 2021, 1:16 p.m. UTC | #1
On 5/18/2021 1:52 PM, Bing Zhao wrote:
> The feature support of connection tracking is added in the feature
> table of networking drivers. The feature overview part is also
> updated.
> 
> Signed-off-by: Bing Zhao <bingz@nvidia.com>

Hi Bing,

Thomas is suggestion another table to list flow API item/actions in separate
table, can this change can be replaced by it?
  
Thomas Monjalon May 18, 2021, 1:18 p.m. UTC | #2
18/05/2021 15:16, Ferruh Yigit:
> On 5/18/2021 1:52 PM, Bing Zhao wrote:
> > The feature support of connection tracking is added in the feature
> > table of networking drivers. The feature overview part is also
> > updated.
> > 
> > Signed-off-by: Bing Zhao <bingz@nvidia.com>
> 
> Hi Bing,
> 
> Thomas is suggestion another table to list flow API item/actions in separate
> table, can this change can be replaced by it?

Correct, I am adding conntrack as part of rte_flow features table.
Please don't add it in the global table.
  
Bing Zhao May 18, 2021, 1:33 p.m. UTC | #3
Hi Ferruh,

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@intel.com>
> Sent: Tuesday, May 18, 2021 9:16 PM
> To: Bing Zhao <bingz@nvidia.com>; Ori Kam <orika@nvidia.com>; Slava
> Ovsiienko <viacheslavo@nvidia.com>; Matan Azrad <matan@nvidia.com>;
> NBU-Contact-Thomas Monjalon <thomas@monjalon.net>
> Cc: dev@dpdk.org; Raslan Darawsheh <rasland@nvidia.com>;
> andrew.rybchenko@oktetlabs.ru
> Subject: Re: [PATCH] doc: add new feature for connection tracking
> 
> External email: Use caution opening links or attachments
> 
> 
> On 5/18/2021 1:52 PM, Bing Zhao wrote:
> > The feature support of connection tracking is added in the feature
> > table of networking drivers. The feature overview part is also
> > updated.
> >
> > Signed-off-by: Bing Zhao <bingz@nvidia.com>
> 
> Hi Bing,
> 
> Thomas is suggestion another table to list flow API item/actions in
> separate table, can this change can be replaced by it?

It is OK for me. But I might need the comments from Thomas, Ori and ETHDEV maintainers since you all are much more familiar with the documents and their scopes.

@Thomas, is it OK?

Thanks
  
Thomas Monjalon May 18, 2021, 1:44 p.m. UTC | #4
18/05/2021 15:33, Bing Zhao:
> From: Ferruh Yigit <ferruh.yigit@intel.com>
> > On 5/18/2021 1:52 PM, Bing Zhao wrote:
> > > The feature support of connection tracking is added in the feature
> > > table of networking drivers. The feature overview part is also
> > > updated.
> > >
> > > Signed-off-by: Bing Zhao <bingz@nvidia.com>
> > 
> > Hi Bing,
> > 
> > Thomas is suggestion another table to list flow API item/actions in
> > separate table, can this change can be replaced by it?
> 
> It is OK for me. But I might need the comments from Thomas, Ori and ETHDEV maintainers since you all are much more familiar with the documents and their scopes.
> 
> @Thomas, is it OK?

Yes, I mark this patch as rejected.

See how it is added in the new table:
https://patches.dpdk.org/project/dpdk/patch/20210518132844.3779728-3-thomas@monjalon.net/
  
Bing Zhao May 18, 2021, 1:49 p.m. UTC | #5
Thanks a lot to you all.

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, May 18, 2021 9:19 PM
> To: Bing Zhao <bingz@nvidia.com>; Ferruh Yigit
> <ferruh.yigit@intel.com>
> Cc: Ori Kam <orika@nvidia.com>; Slava Ovsiienko
> <viacheslavo@nvidia.com>; Matan Azrad <matan@nvidia.com>;
> dev@dpdk.org; Raslan Darawsheh <rasland@nvidia.com>;
> andrew.rybchenko@oktetlabs.ru
> Subject: Re: [PATCH] doc: add new feature for connection tracking
> 
> External email: Use caution opening links or attachments
> 
> 
> 18/05/2021 15:16, Ferruh Yigit:
> > On 5/18/2021 1:52 PM, Bing Zhao wrote:
> > > The feature support of connection tracking is added in the
> feature
> > > table of networking drivers. The feature overview part is also
> > > updated.
> > >
> > > Signed-off-by: Bing Zhao <bingz@nvidia.com>
> >
> > Hi Bing,
> >
> > Thomas is suggestion another table to list flow API item/actions
> in
> > separate table, can this change can be replaced by it?
> 
> Correct, I am adding conntrack as part of rte_flow features table.
> Please don't add it in the global table.
>
  

Patch

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index f6d30d0af3..a7b8d250a6 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -923,6 +923,18 @@  Supports to get Rx/Tx packet burst mode information.
 * **[implements] eth_dev_ops**: ``rx_burst_mode_get``, ``tx_burst_mode_get``.
 * **[related] API**: ``rte_eth_rx_burst_mode_get()``, ``rte_eth_tx_burst_mode_get()``.
 
+.. _nic_features_connection_tracking:
+
+Connection tracking
+-------------------
+
+Supports conntrack offload by HW module.
+
+* **[uses]       rte_flow_item**: ``rte_flow_item_conntrack``.
+* **[uses]       rte_flow_action**: ``rte_flow_action_conntrack``.
+* **[uses]       user config**: ``rte_flow_modify_conntrack``.
+* **[related] API**: ``rte_flow_action_handle_create()``, ``rte_flow_action_handle_destroy()``, ``rte_flow_action_handle_update()``, ``rte_flow_action_handle_query()``.
+
 .. _nic_features_other:
 
 Other dev ops not represented by a Feature
diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini
index 8046bd121e..0deb4ef547 100644
--- a/doc/guides/nics/features/default.ini
+++ b/doc/guides/nics/features/default.ini
@@ -66,6 +66,7 @@  Module EEPROM dump   =
 Registers dump       =
 LED                  =
 Multiprocess aware   =
+Connection tracking  =
 FreeBSD              =
 Linux                =
 Windows              =
diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini
index ddd131da16..45dbe75d07 100644
--- a/doc/guides/nics/features/mlx5.ini
+++ b/doc/guides/nics/features/mlx5.ini
@@ -45,6 +45,7 @@  Stats per queue      = Y
 FW version           = Y
 Module EEPROM dump   = Y
 Multiprocess aware   = Y
+Connection tracking  = Y
 Linux                = Y
 Windows              = P
 ARMv8                = Y