doc: add PMD filtering features back
PATCH 1/2 doc: add PMD filtering features back
What has been deprecated is enabling filtering support using the 'filter_ctrl' APIs [1], now same filtering features can be implemented using rte_flow APIs and this is the preferred way for DPDK.
Since those filtering features can be enabled via rte_flow too, better to keep them in the feature list, and mark them enabled for the PMDs that enabled features via rte_flow API.
That is why PMD feature announcements not added back, they can announce the feature again when 'filter_ctrl' implementation replaced with 'rte_flow" ones.
Also filter definitions should be clarified more in the features documentation so that all PMDs can easily figure out to announce or not these filtering features, also users can understand better what to expect from this feature.
[1]rte_eth_dev_filter_ctrl() rte_eth_dev_filter_supported()
These APIs were passing using input related to the filtering by 'filter_type' and type specific structs.
---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>
--- doc/guides/nics/features.rst | 78 ++++++++++++++++++++++++++++ doc/guides/nics/features/default.ini | 7 +++ 2 files changed, 85 insertions(+)
doc/guides/nics/features.rst +78 -0
@@ -366,6 +366,84 @@ Supports filtering of a VLAN Tag identifier. * **[related] API**: ``rte_eth_dev_vlan_filter()``. +.. _nic_features_ethertype_filter: + +Ethertype filter +---------------- + +Supports filtering on Ethernet type. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_ETHERTYPE``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + +.. _nic_features_ntuple_filter: + +N-tuple filter +-------------- + +Supports filtering on N-tuple values. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_NTUPLE``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + + +.. _nic_features_syn_filter: + +SYN filter +---------- + +Supports TCP syn filtering. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_SYN``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + + +.. _nic_features_tunnel_filter: + +Tunnel filter +------------- + +Supports tunnel filtering. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_TUNNEL``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + + +.. _nic_features_flexible_filter: + +Flexible filter +--------------- + +Supports a flexible (non-tuple or Ethertype) filter. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FLEXIBLE``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + + +.. _nic_features_hash_filter: + +Hash filter +----------- + +Supports Hash filtering. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_HASH``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + + +.. _nic_features_flow_director: + +Flow director +------------- + +Supports Flow Director style filtering to queues. + +* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FDIR``. +* **[provides] mbuf**: ``mbuf.ol_flags:`` ``PKT_RX_FDIR``, ``PKT_RX_FDIR_ID``, + ``PKT_RX_FDIR_FLX``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``. + + .. _nic_features_flow_control: Flow control
doc/guides/nics/features/default.ini +7 -0
@@ -37,6 +37,13 @@ VMDq = SR-IOV = DCB = VLAN filter = +Ethertype filter = +N-tuple filter = +SYN filter = +Tunnel filter = +Flexible filter = +Hash filter = +Flow director = Flow control = Flow API = Rate limitation =
Signature · 1 line
2.21.0
PATCH 2/2 doc: remove flow API from the feature list
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, 'filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.
---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>
--- doc/guides/nics/features/default.ini | 1 - 1 file changed, 1 deletion(-)
doc/guides/nics/features/default.ini +0 -1
@@ -45,7 +45,6 @@ Flexible filter = Hash filter = Flow director = Flow control = -Flow API = Rate limitation = Traffic mirroring = Inline crypto =
Signature · 1 line
2.21.0
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.
I fully agree with this explanation.rte_flow is the only supported API for flow offloads. That's why we must remove the legacy API.
doc/guides/nics/features/default.ini Flexible filter = · line 48
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
Quoted 15 lines · Thomas Monjalon
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.I fully agree with this explanation.
rte_flowis the only supported API for flow offloads. That's why we must remove the legacy API.
Quoted 7 lines
doc/guides/nics/features/default.ini Flexible filter = · line 48
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =Acked-by Thomas Monjalon <[email protected]>
# Need to remove "Flow API" from doc/guides/nics/features.rst
# Need to remove refference of "Flow API" from "doc/guides/nics/*" as well.
Not specific to this patch,
Probably we need to add a new matrix to enumerate PATTERN and ACTIONS supported by each PMD as a rte_flow feature matrix.
That some else can take it up if everyone agrees the semantics.
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
Quoted 24 lines · Jerin Jacob
Quoted 15 lines · Thomas Monjalon
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.I fully agree with this explanation.
rte_flowis the only supported API for flow offloads. That's why we must remove the legacy API.Quoted 7 lines
doc/guides/nics/features/default.ini Flexible filter = · line 48
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =Acked-by Thomas Monjalon <[email protected]>
Quoted 1 line
# Need to remove "Flow API" from
doc/guides/nics/features.rst
+1
Quoted 1 line
# Need to remove refference of "Flow API" from "doc/guides/nics/*" as well.
"Flow API" is the implementation of the filtering, it may exist in the nic documentation, only it is not a feature on itself. I will scan the docs for usage.
Quoted 6 lines
Not specific to this patch,
Probably we need to add a new matrix to enumerate PATTERN and ACTIONS supported by each PMD as arte_flowfeature matrix.
That some else can take it up if everyone agrees the semantics.
+1, there needs a way to figure out which filtering is supported by a device/driver. It is not documented and it is very hard to got it from the code.
Not sure if a new matrix is the good way to go, but I agree we need some way to clarify it.
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
10/04/2020 10:44, Ferruh Yigit:
Quoted 41 lines · Jerin Jacob
Quoted 24 lines · Thomas Monjalon
Quoted 15 lines
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.I fully agree with this explanation.
rte_flowis the only supported API for flow offloads. That's why we must remove the legacy API.Quoted 7 lines
doc/guides/nics/features/default.ini Flexible filter = · line 48
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =Acked-by Thomas Monjalon <[email protected]>Quoted 1 line
# Need to remove "Flow API" from
doc/guides/nics/features.rst+1
Quoted 1 line
# Need to remove refference of "Flow API" from "doc/guides/nics/*" as well.
"Flow API" is the implementation of the filtering, it may exist in the nic documentation, only it is not a feature on itself. I will scan the docs for usage.
Quoted 6 lines
Not specific to this patch,
Probably we need to add a new matrix to enumerate PATTERN and ACTIONS supported by each PMD as arte_flowfeature matrix.
That some else can take it up if everyone agrees the semantics.
Quoted 5 lines
+1, there needs a way to figure out which filtering is supported by a device/driver. It is not documented and it is very hard to got it from the code.
Not sure if a new matrix is the good way to go, but I agree we need some way to clarify it.
I think we should split the matrix.
Adding a new matrix for flow offloads looks the way to go. I suggest 3 matrices:
- port-level features
- queue-level features
- flow-level features
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
Quoted 49 lines · Thomas Monjalon
10/04/2020 10:44, Ferruh Yigit:
Quoted 41 lines · Jerin Jacob
Quoted 24 lines · Thomas Monjalon
Quoted 15 lines
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.I fully agree with this explanation.
rte_flowis the only supported API for flow offloads. That's why we must remove the legacy API.Quoted 7 lines
doc/guides/nics/features/default.ini Flexible filter = · line 48
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =Acked-by Thomas Monjalon <[email protected]>Quoted 1 line
# Need to remove "Flow API" from
doc/guides/nics/features.rst+1
Quoted 1 line
# Need to remove refference of "Flow API" from "doc/guides/nics/*" as well.
"Flow API" is the implementation of the filtering, it may exist in the nic documentation, only it is not a feature on itself. I will scan the docs for usage.
Quoted 6 lines
Not specific to this patch,
Probably we need to add a new matrix to enumerate PATTERN and ACTIONS supported by each PMD as arte_flowfeature matrix.
That some else can take it up if everyone agrees the semantics.Quoted 5 lines
+1, there needs a way to figure out which filtering is supported by a device/driver. It is not documented and it is very hard to got it from the code.
Not sure if a new matrix is the good way to go, but I agree we need some way to clarify it.
Quoted 6 lines
I think we should split the matrix.
Adding a new matrix for flow offloads looks the way to go. I suggest 3 matrices:
- port-level features
- queue-level features
- flow-level features
Not sure what will be the details in "flow-level features".
IMO, We need to have a separate matrix for subdomain features for rte_flow, rte_tm, rte_mtr, etc which part of ethdev. For instance, rte_flow features can be translated into a matrix of supported PATTERN and ACTIONS.
Quoted 2 lines
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
10/04/2020 11:04, Jerin Jacob:
Quoted 56 lines · Thomas Monjalon
Quoted 48 lines
10/04/2020 10:44, Ferruh Yigit:
Quoted 41 lines · Jerin Jacob
Quoted 24 lines · Thomas Monjalon
Quoted 15 lines
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.I fully agree with this explanation.
rte_flowis the only supported API for flow offloads. That's why we must remove the legacy API.Quoted 7 lines
doc/guides/nics/features/default.ini Flexible filter = · line 48
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =Acked-by Thomas Monjalon <[email protected]>Quoted 1 line
# Need to remove "Flow API" from
doc/guides/nics/features.rst+1
Quoted 1 line
# Need to remove refference of "Flow API" from "doc/guides/nics/*" as well.
"Flow API" is the implementation of the filtering, it may exist in the nic documentation, only it is not a feature on itself. I will scan the docs for usage.
Quoted 6 lines
Not specific to this patch,
Probably we need to add a new matrix to enumerate PATTERN and ACTIONS supported by each PMD as arte_flowfeature matrix.
That some else can take it up if everyone agrees the semantics.Quoted 5 lines
+1, there needs a way to figure out which filtering is supported by a device/driver. It is not documented and it is very hard to got it from the code.
Not sure if a new matrix is the good way to go, but I agree we need some way to clarify it.
Quoted 6 lines
I think we should split the matrix.
Adding a new matrix for flow offloads looks the way to go. I suggest 3 matrices:
- port-level features
- queue-level features
- flow-level features
Quoted 6 lines
Not sure what will be the details in "flow-level features".
IMO, We need to have a separate matrix for subdomain features for
rte_flow,rte_tm,rte_mtr, etc which part of ethdev. For instance,rte_flowfeatures can be translated into a matrix of supported PATTERN and ACTIONS.
Yes I'm also fine with this proposal.
Re: [dpdk-dev] [PATCH 2/2] doc: remove flow API from the feature list
Quoted 57 lines · Thomas Monjalon
10/04/2020 11:04, Jerin Jacob:
Quoted 56 lines · Thomas Monjalon
Quoted 54 lines
10/04/2020 10:44, Ferruh Yigit:
Quoted 41 lines · Jerin Jacob
Quoted 24 lines · Thomas Monjalon
Quoted 15 lines
25/10/2019 14:51, Ferruh Yigit:
Quoted 8 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.I fully agree with this explanation.
rte_flowis the only supported API for flow offloads. That's why we must remove the legacy API.Quoted 7 lines
doc/guides/nics/features/default.ini
Quoted 5 lines
Signed-off-by Ferruh Yigit <[email protected]>---
doc/guides/nics/features/default.ini +0
-1-Flow API =Acked-by Thomas Monjalon <[email protected]>Quoted 1 line
# Need to remove "Flow API" from
doc/guides/nics/features.rst+1
Quoted 1 line
# Need to remove refference of "Flow API" from "doc/guides/nics/*" as well.
"Flow API" is the implementation of the filtering, it may exist in the nic documentation, only it is not a feature on itself. I will scan the docs for usage.
Quoted 6 lines
Not specific to this patch,
Probably we need to add a new matrix to enumerate PATTERN and ACTIONS supported by each PMD as arte_flowfeature matrix.
That some else can take it up if everyone agrees the semantics.Quoted 5 lines
+1, there needs a way to figure out which filtering is supported by a device/driver. It is not documented and it is very hard to got it from the code.
Not sure if a new matrix is the good way to go, but I agree we need some way to clarify it.
I think we should split the matrix.
Adding a new matrix for flow offloads looks the way to go. I suggest 3 matrices:
- port-level features
- queue-level features
- flow-level features
Quoted 9 lines
Quoted 6 lines
Not sure what will be the details in "flow-level features".
IMO, We need to have a separate matrix for subdomain features for
rte_flow,rte_tm,rte_mtr, etc which part of ethdev. For instance,rte_flowfeatures can be translated into a matrix of supported PATTERN and ACTIONS.Yes I'm also fine with this proposal.
My concern is it will be too big and detailed, also hard to maintain which means it will be out dated a while later.
After above said, I don't have a better solution right now ...
25/10/2019 14:51, Ferruh Yigit:
Quoted 4 lines
Also filter definitions should be clarified more in the features documentation so that all PMDs can easily figure out to announce or not these filtering features, also users can understand better what to expect from this feature.
OK let's try to dig in some descriptions.
[...]
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 384
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+N-tuple filter +-------------- + +Supports filtering on N-tuple values.
What is n-tuple? 3-tuple is enough?
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 406
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+Tunnel filter +------------- + +Supports tunnel filtering.
There are so many kinds of tunnels and filtering. What is minimum to declare such feature? Isn't it more relevant to list the supported tunnels?
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 417
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+Flexible filter +--------------- + +Supports a flexible (non-tuple or Ethertype) filter.
This is meaningless and should be dropped for sure.
Review
Quoted 2 lines
(quoted diff) +2
-0+* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FLEXIBLE``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
You are referring to the deprecated API here and in other places.
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 428
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+Hash filter +----------- + +Supports Hash filtering.
Which hash?
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 439
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+Flow director +------------- + +Supports Flow Director style filtering to queues.
I think it is an Intel wording.
Could you describe it with networking words?
Quoted 8 lines · Thomas Monjalon
25/10/2019 14:51, Ferruh Yigit:
Quoted 4 lines
Also filter definitions should be clarified more in the features documentation so that all PMDs can easily figure out to announce or not these filtering features, also users can understand better what to expect from this feature.
OK let's try to dig in some descriptions.
Quoted 7 lines
[...]
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 384
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+N-tuple filter +-------------- + +Supports filtering on N-tuple values.What is n-tuple? 3-tuple is enough?
I don't know why these are added historically, and myself not aware of the all filtering to classify them properly.
Just saying "Flow API" is supported is not really says anything, either we can try to group the filtering features, as done here and advertise these filtering features, or create a rte flow based pattern/action documentation which I believe will be too big and detailed.
So I think it is good to have some grouping for the filtering features, but if current grouping is not good, what it should be like, and how we can define them?
I will send a v2 based on other comments, but it won't be addressing the groping questions.
Quoted 17 lines
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 406
Quoted 5 lines
doc/guides/nics/features.rst +4
-0+Tunnel filter +------------- + +Supports tunnel filtering.There are so many kinds of tunnels and filtering. What is minimum to declare such feature? Isn't it more relevant to list the supported tunnels?
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 417
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+Flexible filter +--------------- + +Supports a flexible (non-tuple or Ethertype) filter.This is meaningless and should be dropped for sure.
Quoted 4 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FLEXIBLE``. +* **[related] API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.You are referring to the deprecated API here and in other places.
+1 to remove the deprecated APIs, I will convert them to rte flow.
Quoted 18 lines
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 428
Quoted 5 lines
doc/guides/nics/features.rst +4
-0+Hash filter +----------- + +Supports Hash filtering.Which hash?
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 439
Quoted 4 lines
doc/guides/nics/features.rst +4
-0+Flow director +------------- + +Supports Flow Director style filtering to queues.I think it is an Intel wording.
Could you describe it with networking words?
PATCH v2 1/1 doc: remove flow API from the feature list
In reply to Ferruh Yigit"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, 'filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.
---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>
v2:
* Removed feature from all .ini files
* Removed some references from nic guides
--- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/enic.rst | 6 +++--- doc/guides/nics/features.rst | 11 ----------- doc/guides/nics/features/bnxt.ini | 1 - doc/guides/nics/features/cxgbe.ini | 1 - doc/guides/nics/features/default.ini | 1 - doc/guides/nics/features/enic.ini | 1 - doc/guides/nics/features/failsafe.ini | 1 - doc/guides/nics/features/hinic.ini | 1 - doc/guides/nics/features/hns3.ini | 1 - doc/guides/nics/features/hns3_vf.ini | 1 - doc/guides/nics/features/i40e.ini | 1 - doc/guides/nics/features/iavf.ini | 1 - doc/guides/nics/features/ice.ini | 1 - doc/guides/nics/features/igb.ini | 1 - doc/guides/nics/features/ipn3ke.ini | 1 - doc/guides/nics/features/ixgbe.ini | 1 - doc/guides/nics/features/mlx4.ini | 1 - doc/guides/nics/features/mlx5.ini | 1 - doc/guides/nics/features/octeontx2.ini | 1 - doc/guides/nics/features/octeontx2_vec.ini | 1 - doc/guides/nics/features/octeontx2_vf.ini | 1 - doc/guides/nics/features/qede.ini | 1 - doc/guides/nics/features/sfc_efx.ini | 1 - doc/guides/nics/features/tap.ini | 1 - doc/guides/nics/hinic.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/mvpp2.rst | 6 +++--- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 4 ++-- 30 files changed, 12 insertions(+), 45 deletions(-)
doc/guides/nics/cxgbe.rst +1 -1
@@ -30,7 +30,7 @@ CXGBE and CXGBEVF PMD has support for: - All multicast mode - Port hardware statistics - Jumbo frames -- Flow API - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters. +- Packet filtering - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters. Limitations -----------
doc/guides/nics/enic.rst +3 -3
@@ -208,8 +208,8 @@ the use of SR-IOV. .. _enic-generic-flow-api: -Generic Flow API support ------------------------- +Generic packet filtering support +-------------------------------- Generic Flow API (also called "rte_flow" API) is supported. More advanced capabilities are available when "Advanced Filtering" is enabled on the adapter.
@@ -524,7 +524,7 @@ Supported features - Scattered Rx - MTU update - SR-IOV on UCS managed servers connected to Fabric Interconnects -- Flow API +- Packet filtering via Flow API - Overlay offload - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
doc/guides/nics/features.rst +0 -11
@@ -453,17 +453,6 @@ Supports configuring link flow control. ``rte_eth_dev_priority_flow_ctrl_set()``. -.. _nic_features_flow_api: - -Flow API --------- - -Supports the DPDK Flow API for generic filtering. - -* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``. -* **[implements] rte_flow_ops**: ``All``. - - .. _nic_features_rate_limitation: Rate limitation
doc/guides/nics/features/bnxt.ini +0 -1
@@ -28,7 +28,6 @@ Ethertype filter = Y N-tuple filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/cxgbe.ini +0 -1
@@ -16,7 +16,6 @@ Allmulticast mode = Y RSS hash = Y RSS key update = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/default.ini +0 -1
@@ -45,7 +45,6 @@ Flexible filter = Hash filter = Flow director = Flow control = -Flow API = Rate limitation = Traffic mirroring = Inline crypto =
doc/guides/nics/features/enic.ini +0 -1
@@ -25,7 +25,6 @@ SR-IOV = Y CRC offload = Y VLAN offload = Y Flow director = Y -Flow API = Y L3 checksum offload = Y L4 checksum offload = Y Inner L3 checksum = Y
doc/guides/nics/features/failsafe.ini +0 -1
@@ -19,7 +19,6 @@ Unicast MAC filter = Y Multicast MAC filter = Y VLAN filter = Y Flow control = Y -Flow API = Y Packet type parsing = Y Basic stats = Y Stats per queue = Y
doc/guides/nics/features/hinic.ini +0 -1
@@ -32,7 +32,6 @@ Inner L4 checksum = Y Basic stats = Y Extended stats = Y Stats per queue = Y -Flow API = Y Flow control = Y FW version = Y Multiprocess aware = Y
doc/guides/nics/features/hns3.ini +0 -1
@@ -19,7 +19,6 @@ RSS reta update = Y DCB = Y VLAN filter = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/hns3_vf.ini +0 -1
@@ -17,7 +17,6 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/i40e.ini +0 -1
@@ -28,7 +28,6 @@ SR-IOV = Y DCB = Y VLAN filter = Y Flow control = Y -Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/iavf.ini +0 -1
@@ -19,7 +19,6 @@ Multicast MAC filter = Y RSS hash = Y RSS key update = Y RSS reta update = Y -Flow API = Y VLAN filter = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/ice.ini +0 -1
@@ -22,7 +22,6 @@ Multicast MAC filter = Y RSS hash = Y RSS key update = Y RSS reta update = Y -Flow API = Y VLAN filter = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/igb.ini +0 -1
@@ -27,7 +27,6 @@ N-tuple filter = Y SYN filter = Y Flexible filter = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y QinQ offload = Y
doc/guides/nics/features/ipn3ke.ini +0 -1
@@ -30,7 +30,6 @@ Tunnel filter = Y Hash filter = Y Flow director = Y Flow control = Y -Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/ixgbe.ini +0 -1
@@ -30,7 +30,6 @@ SYN filter = Y Tunnel filter = Y Flow director = Y Flow control = Y -Flow API = Y Rate limitation = Y Traffic mirroring = Y Inline crypto = Y
doc/guides/nics/features/mlx4.ini +0 -1
@@ -22,7 +22,6 @@ RSS hash = Y SR-IOV = Y VLAN filter = Y Flow control = Y -Flow API = Y CRC offload = Y L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/mlx5.ini +0 -1
@@ -28,7 +28,6 @@ SR-IOV = Y VLAN filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/octeontx2.ini +0 -1
@@ -30,7 +30,6 @@ Inner RSS = Y Inline protocol = Y VLAN filter = Y Flow control = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y Scattered Rx = Y
doc/guides/nics/features/octeontx2_vec.ini +0 -1
@@ -27,7 +27,6 @@ RSS reta update = Y Inner RSS = Y VLAN filter = Y Flow control = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y VLAN offload = Y
doc/guides/nics/features/octeontx2_vf.ini +0 -1
@@ -23,7 +23,6 @@ RSS reta update = Y Inner RSS = Y Inline protocol = Y VLAN filter = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y Scattered Rx = Y
doc/guides/nics/features/qede.ini +0 -1
@@ -23,7 +23,6 @@ N-tuple filter = Y Tunnel filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/sfc_efx.ini +0 -1
@@ -24,7 +24,6 @@ RSS key update = Y RSS reta update = Y SR-IOV = Y Flow control = Y -Flow API = Y VLAN offload = P L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/tap.ini +0 -1
@@ -11,7 +11,6 @@ Rx interrupt = Y Promiscuous mode = Y Allmulticast mode = Y Basic stats = Y -Flow API = Y L3 checksum offload = Y L4 checksum offload = Y MTU update = Y
doc/guides/nics/hinic.rst +1 -1
@@ -30,7 +30,7 @@ Features - MTU update - Unicast MAC filter - Multicast MAC filter -- Flow API +- Packet filtering via Flow API - Set Link down or up - FW version - LRO
doc/guides/nics/mlx5.rst +1 -1
@@ -82,7 +82,7 @@ Features - Hardware checksum offloads. - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and RTE_ETH_FDIR_REJECT). -- Flow API, including :ref:`flow_isolated_mode`. +- Packet filtering via Flow API, including :ref:`flow_isolated_mode`. - Multiple process. - KVM and VMware ESX SR-IOV modes are supported. - RSS hash result is supported.
doc/guides/nics/mvpp2.rst +3 -3
@@ -47,7 +47,7 @@ Features of the MVPP2 PMD are: - RX flow control - Scattered TX frames - :ref:`QoS <qossupport>` -- :ref:`Flow API <flowapi>` +- :ref:`Packet filtering via Flow API <flowapi>` - :ref:`Traffic metering and policing <mtrapi>` - :ref:`Traffic Management API <tmapi>`
@@ -378,8 +378,8 @@ Usage example .. _flowapi: -Flow API --------- +Packet filtering +---------------- PPv2 offers packet classification capabilities via classifier engine which can be configured via generic flow API offered by DPDK.
doc/guides/nics/sfc_efx.rst +1 -1
@@ -67,7 +67,7 @@ SFC EFX PMD has support for: - Transmit VLAN insertion (if running firmware variant supports it) -- Flow API +- Packet filtering via Flow API - Loopback
doc/guides/nics/tap.rst +2 -2
@@ -94,8 +94,8 @@ where X stands for unique id, example:: Unlike TAP PMD, TUN PMD does not support user arguments as ``MAC`` or ``remote`` user options. Default interface name is ``dtunX``, where X stands for unique id. -Flow API support ----------------- +Packet filtering support +------------------------ The tap PMD supports major flow API pattern items and actions, when running on linux kernels above 4.2 ("Flower" classifier required).
Signature · 1 line
2.25.2
PATCH v2 1/2 doc: add PMD filtering features back
In reply to Ferruh YigitWhat has been deprecated is enabling filtering support using the 'filter_ctrl' APIs [1], now same filtering features can be implemented using rte_flow APIs and this is the preferred way for DPDK.
Since those filtering features can be enabled via rte_flow too, better to keep them in the feature list, and mark them enabled for the PMDs that enabled features via rte_flow API.
That is why PMD feature announcements not added back, they can announce the feature again when 'filter_ctrl' implementation replaced with 'rte_flow" ones.
Also filter definitions should be clarified more in the features documentation so that all PMDs can easily figure out to announce or not these filtering features, also users can understand better what to expect from this feature.
[1]rte_eth_dev_filter_ctrl() rte_eth_dev_filter_supported()
These APIs were passing using input related to the filtering by 'filter_type' and type specific structs.
---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>
v2:
* Remove deprecated API references
* Add previously removed filter features back to nic .ini files
--- doc/guides/nics/features.rst | 70 ++++++++++++++++++++++++++++ doc/guides/nics/features/bnxt.ini | 3 ++ doc/guides/nics/features/default.ini | 7 +++ doc/guides/nics/features/enic.ini | 1 + doc/guides/nics/features/i40e.ini | 4 ++ doc/guides/nics/features/i40e_vf.ini | 1 + doc/guides/nics/features/igb.ini | 4 ++ doc/guides/nics/features/ipn3ke.ini | 4 ++ doc/guides/nics/features/ixgbe.ini | 5 ++ doc/guides/nics/features/mlx5.ini | 1 + doc/guides/nics/features/qede.ini | 3 ++ 11 files changed, 103 insertions(+)
doc/guides/nics/features.rst +70 -0
@@ -370,6 +370,76 @@ Supports filtering of a VLAN Tag identifier. * **[related] API**: ``rte_eth_dev_vlan_filter()``. +.. _nic_features_ethertype_filter: + +Ethertype filter +---------------- + +Supports filtering on Ethernet type. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_ntuple_filter: + +N-tuple filter +-------------- + +Supports filtering on N-tuple values. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_syn_filter: + +SYN filter +---------- + +Supports TCP syn filtering. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_tunnel_filter: + +Tunnel filter +------------- + +Supports tunnel filtering. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_flexible_filter: + +Flexible filter +--------------- + +Supports a flexible (non-tuple or Ethertype) filter. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_hash_filter: + +Hash filter +----------- + +Supports Hash filtering. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_flow_director: + +Flow director +------------- + +Supports Flow Director style filtering to queues. + +* **[implements] Related Flow API pattern and actions.** + + .. _nic_features_flow_control: Flow control
doc/guides/nics/features/bnxt.ini +3 -0
@@ -24,6 +24,9 @@ RSS reta update = Y VMDq = Y SR-IOV = Y VLAN filter = Y +Ethertype filter = Y +N-tuple filter = Y +Flow director = Y Flow control = Y Flow API = Y CRC offload = Y
doc/guides/nics/features/default.ini +7 -0
@@ -37,6 +37,13 @@ VMDq = SR-IOV = DCB = VLAN filter = +Ethertype filter = +N-tuple filter = +SYN filter = +Tunnel filter = +Flexible filter = +Hash filter = +Flow director = Flow control = Flow API = Rate limitation =
doc/guides/nics/features/enic.ini +1 -0
@@ -24,6 +24,7 @@ Inner RSS = Y SR-IOV = Y CRC offload = Y VLAN offload = Y +Flow director = Y Flow API = Y L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/i40e.ini +4 -0
@@ -32,6 +32,10 @@ Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y +Ethertype filter = Y +Tunnel filter = Y +Hash filter = Y +Flow director = Y QinQ offload = P L3 checksum offload = P L4 checksum offload = P
doc/guides/nics/features/i40e_vf.ini +1 -0
@@ -19,6 +19,7 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y +Hash filter = Y CRC offload = Y VLAN offload = Y QinQ offload = P
doc/guides/nics/features/igb.ini +4 -0
@@ -22,6 +22,10 @@ VMDq = Y SR-IOV = Y DCB = Y VLAN filter = Y +Ethertype filter = Y +N-tuple filter = Y +SYN filter = Y +Flexible filter = Y Flow control = Y Flow API = Y CRC offload = Y
doc/guides/nics/features/ipn3ke.ini +4 -0
@@ -25,6 +25,10 @@ VMDq = Y SR-IOV = Y DCB = Y VLAN filter = Y +Ethertype filter = Y +Tunnel filter = Y +Hash filter = Y +Flow director = Y Flow control = Y Flow API = Y Traffic mirroring = Y
doc/guides/nics/features/ixgbe.ini +5 -0
@@ -24,6 +24,11 @@ VMDq = Y SR-IOV = Y DCB = Y VLAN filter = Y +Ethertype filter = Y +N-tuple filter = Y +SYN filter = Y +Tunnel filter = Y +Flow director = Y Flow control = Y Flow API = Y Rate limitation = Y
doc/guides/nics/features/mlx5.ini +1 -0
@@ -26,6 +26,7 @@ RSS reta update = Y Inner RSS = Y SR-IOV = Y VLAN filter = Y +Flow director = Y Flow control = Y Flow API = Y CRC offload = Y
doc/guides/nics/features/qede.ini +3 -0
@@ -19,6 +19,9 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y +N-tuple filter = Y +Tunnel filter = Y +Flow director = Y Flow control = Y Flow API = Y CRC offload = Y
Signature · 1 line
2.25.2
PATCH v2 2/2 doc: remove flow API from the feature list
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, 'filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.
---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>
v2:
* Removed feature from all .ini files
* Removed some references from nic guides
--- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/enic.rst | 6 +++--- doc/guides/nics/features.rst | 11 ----------- doc/guides/nics/features/bnxt.ini | 1 - doc/guides/nics/features/cxgbe.ini | 1 - doc/guides/nics/features/default.ini | 1 - doc/guides/nics/features/enic.ini | 1 - doc/guides/nics/features/failsafe.ini | 1 - doc/guides/nics/features/hinic.ini | 1 - doc/guides/nics/features/hns3.ini | 1 - doc/guides/nics/features/hns3_vf.ini | 1 - doc/guides/nics/features/i40e.ini | 1 - doc/guides/nics/features/iavf.ini | 1 - doc/guides/nics/features/ice.ini | 1 - doc/guides/nics/features/igb.ini | 1 - doc/guides/nics/features/ipn3ke.ini | 1 - doc/guides/nics/features/ixgbe.ini | 1 - doc/guides/nics/features/mlx4.ini | 1 - doc/guides/nics/features/mlx5.ini | 1 - doc/guides/nics/features/octeontx2.ini | 1 - doc/guides/nics/features/octeontx2_vec.ini | 1 - doc/guides/nics/features/octeontx2_vf.ini | 1 - doc/guides/nics/features/qede.ini | 1 - doc/guides/nics/features/sfc_efx.ini | 1 - doc/guides/nics/features/tap.ini | 1 - doc/guides/nics/hinic.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/mvpp2.rst | 6 +++--- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 4 ++-- 30 files changed, 12 insertions(+), 45 deletions(-)
doc/guides/nics/cxgbe.rst +1 -1
@@ -30,7 +30,7 @@ CXGBE and CXGBEVF PMD has support for: - All multicast mode - Port hardware statistics - Jumbo frames -- Flow API - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters. +- Packet filtering - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters. Limitations -----------
doc/guides/nics/enic.rst +3 -3
@@ -208,8 +208,8 @@ the use of SR-IOV. .. _enic-generic-flow-api: -Generic Flow API support ------------------------- +Generic packet filtering support +-------------------------------- Generic Flow API (also called "rte_flow" API) is supported. More advanced capabilities are available when "Advanced Filtering" is enabled on the adapter.
@@ -524,7 +524,7 @@ Supported features - Scattered Rx - MTU update - SR-IOV on UCS managed servers connected to Fabric Interconnects -- Flow API +- Packet filtering via Flow API - Overlay offload - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
doc/guides/nics/features.rst +0 -11
@@ -453,17 +453,6 @@ Supports configuring link flow control. ``rte_eth_dev_priority_flow_ctrl_set()``. -.. _nic_features_flow_api: - -Flow API --------- - -Supports the DPDK Flow API for generic filtering. - -* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``. -* **[implements] rte_flow_ops**: ``All``. - - .. _nic_features_rate_limitation: Rate limitation
doc/guides/nics/features/bnxt.ini +0 -1
@@ -28,7 +28,6 @@ Ethertype filter = Y N-tuple filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/cxgbe.ini +0 -1
@@ -16,7 +16,6 @@ Allmulticast mode = Y RSS hash = Y RSS key update = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/default.ini +0 -1
@@ -45,7 +45,6 @@ Flexible filter = Hash filter = Flow director = Flow control = -Flow API = Rate limitation = Traffic mirroring = Inline crypto =
doc/guides/nics/features/enic.ini +0 -1
@@ -25,7 +25,6 @@ SR-IOV = Y CRC offload = Y VLAN offload = Y Flow director = Y -Flow API = Y L3 checksum offload = Y L4 checksum offload = Y Inner L3 checksum = Y
doc/guides/nics/features/failsafe.ini +0 -1
@@ -19,7 +19,6 @@ Unicast MAC filter = Y Multicast MAC filter = Y VLAN filter = Y Flow control = Y -Flow API = Y Packet type parsing = Y Basic stats = Y Stats per queue = Y
doc/guides/nics/features/hinic.ini +0 -1
@@ -32,7 +32,6 @@ Inner L4 checksum = Y Basic stats = Y Extended stats = Y Stats per queue = Y -Flow API = Y Flow control = Y FW version = Y Multiprocess aware = Y
doc/guides/nics/features/hns3.ini +0 -1
@@ -19,7 +19,6 @@ RSS reta update = Y DCB = Y VLAN filter = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/hns3_vf.ini +0 -1
@@ -17,7 +17,6 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/i40e.ini +0 -1
@@ -28,7 +28,6 @@ SR-IOV = Y DCB = Y VLAN filter = Y Flow control = Y -Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/iavf.ini +0 -1
@@ -19,7 +19,6 @@ Multicast MAC filter = Y RSS hash = Y RSS key update = Y RSS reta update = Y -Flow API = Y VLAN filter = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/ice.ini +0 -1
@@ -22,7 +22,6 @@ Multicast MAC filter = Y RSS hash = Y RSS key update = Y RSS reta update = Y -Flow API = Y VLAN filter = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/igb.ini +0 -1
@@ -27,7 +27,6 @@ N-tuple filter = Y SYN filter = Y Flexible filter = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y QinQ offload = Y
doc/guides/nics/features/ipn3ke.ini +0 -1
@@ -30,7 +30,6 @@ Tunnel filter = Y Hash filter = Y Flow director = Y Flow control = Y -Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y
doc/guides/nics/features/ixgbe.ini +0 -1
@@ -30,7 +30,6 @@ SYN filter = Y Tunnel filter = Y Flow director = Y Flow control = Y -Flow API = Y Rate limitation = Y Traffic mirroring = Y Inline crypto = Y
doc/guides/nics/features/mlx4.ini +0 -1
@@ -22,7 +22,6 @@ RSS hash = Y SR-IOV = Y VLAN filter = Y Flow control = Y -Flow API = Y CRC offload = Y L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/mlx5.ini +0 -1
@@ -28,7 +28,6 @@ SR-IOV = Y VLAN filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/octeontx2.ini +0 -1
@@ -30,7 +30,6 @@ Inner RSS = Y Inline protocol = Y VLAN filter = Y Flow control = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y Scattered Rx = Y
doc/guides/nics/features/octeontx2_vec.ini +0 -1
@@ -27,7 +27,6 @@ RSS reta update = Y Inner RSS = Y VLAN filter = Y Flow control = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y VLAN offload = Y
doc/guides/nics/features/octeontx2_vf.ini +0 -1
@@ -23,7 +23,6 @@ RSS reta update = Y Inner RSS = Y Inline protocol = Y VLAN filter = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y Scattered Rx = Y
doc/guides/nics/features/qede.ini +0 -1
@@ -23,7 +23,6 @@ N-tuple filter = Y Tunnel filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y
doc/guides/nics/features/sfc_efx.ini +0 -1
@@ -24,7 +24,6 @@ RSS key update = Y RSS reta update = Y SR-IOV = Y Flow control = Y -Flow API = Y VLAN offload = P L3 checksum offload = Y L4 checksum offload = Y
doc/guides/nics/features/tap.ini +0 -1
@@ -11,7 +11,6 @@ Rx interrupt = Y Promiscuous mode = Y Allmulticast mode = Y Basic stats = Y -Flow API = Y L3 checksum offload = Y L4 checksum offload = Y MTU update = Y
doc/guides/nics/hinic.rst +1 -1
@@ -30,7 +30,7 @@ Features - MTU update - Unicast MAC filter - Multicast MAC filter -- Flow API +- Packet filtering via Flow API - Set Link down or up - FW version - LRO
doc/guides/nics/mlx5.rst +1 -1
@@ -82,7 +82,7 @@ Features - Hardware checksum offloads. - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and RTE_ETH_FDIR_REJECT). -- Flow API, including :ref:`flow_isolated_mode`. +- Packet filtering via Flow API, including :ref:`flow_isolated_mode`. - Multiple process. - KVM and VMware ESX SR-IOV modes are supported. - RSS hash result is supported.
doc/guides/nics/mvpp2.rst +3 -3
@@ -47,7 +47,7 @@ Features of the MVPP2 PMD are: - RX flow control - Scattered TX frames - :ref:`QoS <qossupport>` -- :ref:`Flow API <flowapi>` +- :ref:`Packet filtering via Flow API <flowapi>` - :ref:`Traffic metering and policing <mtrapi>` - :ref:`Traffic Management API <tmapi>`
@@ -378,8 +378,8 @@ Usage example .. _flowapi: -Flow API --------- +Packet filtering +---------------- PPv2 offers packet classification capabilities via classifier engine which can be configured via generic flow API offered by DPDK.
doc/guides/nics/sfc_efx.rst +1 -1
@@ -67,7 +67,7 @@ SFC EFX PMD has support for: - Transmit VLAN insertion (if running firmware variant supports it) -- Flow API +- Packet filtering via Flow API - Loopback
doc/guides/nics/tap.rst +2 -2
@@ -94,8 +94,8 @@ where X stands for unique id, example:: Unlike TAP PMD, TUN PMD does not support user arguments as ``MAC`` or ``remote`` user options. Default interface name is ``dtunX``, where X stands for unique id. -Flow API support ----------------- +Packet filtering support +------------------------ The tap PMD supports major flow API pattern items and actions, when running on linux kernels above 4.2 ("Flower" classifier required).
Signature · 1 line
2.25.2
Re: [dpdk-dev] [PATCH v2 2/2] doc: remove flow API from the feature list
Quoted 44 lines · Ferruh Yigit
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.Signed-off-by Ferruh Yigit <[email protected]>---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>v2:
* Removed feature from all .ini files
* Removed some references from nic guides--- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/enic.rst | 6 +++--- doc/guides/nics/features.rst | 11 ----------- doc/guides/nics/features/bnxt.ini | 1 - doc/guides/nics/features/cxgbe.ini | 1 - doc/guides/nics/features/default.ini | 1 - doc/guides/nics/features/enic.ini | 1 - doc/guides/nics/features/failsafe.ini | 1 - doc/guides/nics/features/hinic.ini | 1 - doc/guides/nics/features/hns3.ini | 1 - doc/guides/nics/features/hns3_vf.ini | 1 - doc/guides/nics/features/i40e.ini | 1 - doc/guides/nics/features/iavf.ini | 1 - doc/guides/nics/features/ice.ini | 1 - doc/guides/nics/features/igb.ini | 1 - doc/guides/nics/features/ipn3ke.ini | 1 - doc/guides/nics/features/ixgbe.ini | 1 - doc/guides/nics/features/mlx4.ini | 1 - doc/guides/nics/features/mlx5.ini | 1 - doc/guides/nics/features/octeontx2.ini | 1 - doc/guides/nics/features/octeontx2_vec.ini | 1 - doc/guides/nics/features/octeontx2_vf.ini | 1 -
Quoted 8 lines
doc/guides/nics/features/qede.ini | 1 - doc/guides/nics/features/sfc_efx.ini | 1 - doc/guides/nics/features/tap.ini | 1 - doc/guides/nics/hinic.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/mvpp2.rst | 6 +++--- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 4 ++--
Since you are changing "Flow API" to "Packet filtering via Flow API" to all the .rst file,
Could update doc/guides/nics/octeontx2.rst, From "Generic flow API" to "Packet filtering via Flow API"
Re: [dpdk-dev] [PATCH v2 2/2] doc: remove flow API from the feature list
10/04/2020 14:10, Jerin Jacob:
Quoted 11 lines · Ferruh Yigit
Quoted 10 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.
Quoted 6 lines
Quoted 1 line
Signed-off-by Ferruh Yigit <[email protected]>Since you are changing "Flow API" to "Packet filtering via Flow API" to all the .rst file,
Could updatedoc/guides/nics/octeontx2.rst, From "Generic flow API" to "Packet filtering via Flow API"
Waitrte_flow is not only about filtering.rte_flow can configure any flow-related offload,
including encapsulation or header update.
Re: [dpdk-dev] [PATCH v2 2/2] doc: remove flow API from the feature list
Quoted 20 lines · Thomas Monjalon
10/04/2020 14:10, Jerin Jacob:
Quoted 11 lines · Ferruh Yigit
Quoted 10 lines
"Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table.
Also since other filtering related APIs, '
filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information.Quoted 6 lines
Quoted 1 line
Signed-off-by Ferruh Yigit <[email protected]>Since you are changing "Flow API" to "Packet filtering via Flow API" to all the .rst file,
Could updatedoc/guides/nics/octeontx2.rst, From "Generic flow API" to "Packet filtering via Flow API"
Quoted 4 lines
Wait
rte_flowis not only about filtering.rte_flowcan configure any flow-related offload,
including encapsulation or header update.
Agree. Then it better to change to "Generic flow API" in all the docs.
Quoted 2 lines
Quoted 56 lines · Ferruh Yigit
What has been deprecated is enabling filtering support using the '
filter_ctrl' APIs [1], now same filtering features can be implemented usingrte_flowAPIs and this is the preferred way for DPDK.Since those filtering features can be enabled via
rte_flowtoo, better to keep them in the feature list, and mark them enabled for the PMDs that enabled features viarte_flowAPI.
That is why PMD feature announcements not added back, they can announce the feature again when 'filter_ctrl' implementation replaced with 'rte_flow" ones.Also filter definitions should be clarified more in the features documentation so that all PMDs can easily figure out to announce or not these filtering features, also users can understand better what to expect from this feature.
Fixes 030febb6642c ("doc: remove deprecated ethdev features")[1]
rte_eth_dev_filter_ctrl()rte_eth_dev_filter_supported()
These APIs were passing using input related to the filtering by 'filter_type' and type specific structs.Signed-off-by Ferruh Yigit <[email protected]>---
Cc: Thomas Monjalon <[email protected]>
Cc: Andrew Rybchenko <[email protected]>
Cc: Adrien Mazarguil <[email protected]>
Cc: Ajit Khaparde <[email protected]>
Cc: Jerin Jacob <[email protected]>v2:
* Remove deprecated API references
* Add previously removed filter features back to nic .ini files--- doc/guides/nics/features.rst | 70 ++++++++++++++++++++++++++++ doc/guides/nics/features/bnxt.ini | 3 ++ doc/guides/nics/features/default.ini | 7 +++ doc/guides/nics/features/enic.ini | 1 + doc/guides/nics/features/i40e.ini | 4 ++ doc/guides/nics/features/i40e_vf.ini | 1 + doc/guides/nics/features/igb.ini | 4 ++ doc/guides/nics/features/ipn3ke.ini | 4 ++ doc/guides/nics/features/ixgbe.ini | 5 ++ doc/guides/nics/features/mlx5.ini | 1 + doc/guides/nics/features/qede.ini | 3 ++ 11 files changed, 103 insertions(+)doc/guides/nics/features.rst +0
-0
doc/guides/nics/features.rst Supports filtering of a VLAN Tag identifier. · line 371
Quoted 2 lines
doc/guides/nics/features.rst +0
-0@@ -370,6 +370,76 @@ Supports filtering of a VLAN Tag identifier. * **[related] API**: ``rte_eth_dev_vlan_filter()``.
IMO, Following enumeration is just a subset, I think, we should express the FLOW API
capabilities in flow API semantics.
It is a finite set of ACTIONS and PATTERNS. I think it should be easy to make Matrix.
Please see: "40.8. RTE Flow Support" section in
https://doc.dpdk.org/guides/nics/octeontx2.html as reference.
Quoted 219 lines
doc/guides/nics/features.rst +70
-0+.. _nic_features_ethertype_filter: + +Ethertype filter +---------------- + +Supports filtering on Ethernet type. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_ntuple_filter: + +N-tuple filter +-------------- + +Supports filtering on N-tuple values. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_syn_filter: + +SYN filter +---------- + +Supports TCP syn filtering. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_tunnel_filter: + +Tunnel filter +------------- + +Supports tunnel filtering. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_flexible_filter: + +Flexible filter +--------------- + +Supports a flexible (non-tuple or Ethertype) filter. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_hash_filter: + +Hash filter +----------- + +Supports Hash filtering. + +* **[implements] Related Flow API pattern and actions.** + + +.. _nic_features_flow_director: + +Flow director +------------- + +Supports Flow Director style filtering to queues. + +* **[implements] Related Flow API pattern and actions.** + + .. _nic_features_flow_control: Flow controldoc/guides/nics/features/bnxt.ini +3
-0@@ -24,6 +24,9 @@ RSS reta update = Y VMDq = Y SR-IOV = Y VLAN filter = Y +Ethertype filter = Y +N-tuple filter = Y +Flow director = Y Flow control = Y Flow API = Y CRC offload = Ydoc/guides/nics/features/default.ini +7
-0@@ -37,6 +37,13 @@ VMDq = SR-IOV = DCB = VLAN filter = +Ethertype filter = +N-tuple filter = +SYN filter = +Tunnel filter = +Flexible filter = +Hash filter = +Flow director = Flow control = Flow API = Rate limitation =doc/guides/nics/features/enic.ini +1
-0@@ -24,6 +24,7 @@ Inner RSS = Y SR-IOV = Y CRC offload = Y VLAN offload = Y +Flow director = Y Flow API = Y L3 checksum offload = Y L4 checksum offload = Ydoc/guides/nics/features/i40e.ini +4
-0@@ -32,6 +32,10 @@ Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y +Ethertype filter = Y +Tunnel filter = Y +Hash filter = Y +Flow director = Y QinQ offload = P L3 checksum offload = P L4 checksum offload = Pdoc/guides/nics/features/i40e_vf.ini +1
-0@@ -19,6 +19,7 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y +Hash filter = Y CRC offload = Y VLAN offload = Y QinQ offload = Pdoc/guides/nics/features/igb.ini +4
-0@@ -22,6 +22,10 @@ VMDq = Y SR-IOV = Y DCB = Y VLAN filter = Y +Ethertype filter = Y +N-tuple filter = Y +SYN filter = Y +Flexible filter = Y Flow control = Y Flow API = Y CRC offload = Ydoc/guides/nics/features/ipn3ke.ini +4
-0@@ -25,6 +25,10 @@ VMDq = Y SR-IOV = Y DCB = Y VLAN filter = Y +Ethertype filter = Y +Tunnel filter = Y +Hash filter = Y +Flow director = Y Flow control = Y Flow API = Y Traffic mirroring = Ydoc/guides/nics/features/ixgbe.ini +5
-0@@ -24,6 +24,11 @@ VMDq = Y SR-IOV = Y DCB = Y VLAN filter = Y +Ethertype filter = Y +N-tuple filter = Y +SYN filter = Y +Tunnel filter = Y +Flow director = Y Flow control = Y Flow API = Y Rate limitation = Ydoc/guides/nics/features/mlx5.ini +1
-0@@ -26,6 +26,7 @@ RSS reta update = Y Inner RSS = Y SR-IOV = Y VLAN filter = Y +Flow director = Y Flow control = Y Flow API = Y CRC offload = Ydoc/guides/nics/features/qede.ini +3
-1@@ -19,6 +19,9 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y +N-tuple filter = Y +Tunnel filter = Y +Flow director = Y Flow control = Y Flow API = Y CRC offload = Y --2.25.2