d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ethdev: fix documentation for fuzzy match

Browse Source 
Fix document for fuzzy match and GRE

Fixes: a3a2e2c8f7de ("ethdev: add fuzzy match in flow API")
Fixes: 7cd048321d1d ("ethdev: add MPLS and GRE flow API items")

Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
Acked-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
This commit is contained in:
Qi Zhang 2017-07-06 02:32:19 -04:00 committed by Thomas Monjalon
parent 18da437b5f
commit 92f4bf0396
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/guides/prog_guide/rte_flow.rst
View File

@ -898,7 +898,7 @@ Matches a MPLS header.
- Default ``mask`` matches label only.
Item: ``GRE``
^^^^^^^^^^^^^^
^^^^^^^^^^^^^
Matches a GRE header.
@ -907,7 +907,7 @@ Matches a GRE header.
- Default ``mask`` matches protocol only.
Item: ``FUZZY``
^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^
Fuzzy pattern match, expect faster than default.
@ -918,19 +918,22 @@ value, but it is possible two different patterns have the same hash value.
Matching accuracy level can be configured by threshold. Driver can divide the
range of threshold and map to different accuracy levels that device support.
Threshold 0 means perfect match (no fuzziness), while threshold 0xffffffff
means fuzziest match.
.. _table_rte_flow_item_fuzzy:
.. table:: FUZZY
+----------+---------------+--------------------------------------------------+
| Field | Subfield | Value |
+==========+===========+======================================================+
+==========+===============+==================================================+
| ``spec`` | ``threshold`` | 0 as perfect match, 0xffffffff as fuzziest match |
+----------+---------------+--------------------------------------------------+
| ``last`` | ``threshold`` | upper range value |
+----------+-----------+------------------------------------------------------+
+----------+---------------+--------------------------------------------------+
| ``mask`` | ``threshold`` | bit-mask apply to "spec" and "last" |
+----------+-----------+------------------------------------------------------+
+----------+---------------+--------------------------------------------------+
Usage example, fuzzy match a TCPv4 packets:

5
lib/librte_ether/rte_flow.h
View File

@ -719,9 +719,12 @@ static const struct rte_flow_item_gre rte_flow_item_gre_mask = {
* Matching accuracy level can be configure by threshold.
* Driver can divide the range of threshold and map to different
* accuracy levels that device support.
*
* Threshold 0 means perfect match (no fuzziness), while threshold
* 0xffffffff means fuzziest match.
*/
struct rte_flow_item_fuzzy {
uint32_t thresh; /**< Accuracy threshold*/
uint32_t thresh; /**< Accuracy threshold. */
};
/** Default mask for RTE_FLOW_ITEM_TYPE_FUZZY. */