doc: add information for Rx burst functions in mlx5
PATCH 1/1 doc: add information for Rx burst functions in mlx5
mlx5 pmd supports various rx_burst functions.
Each function is enabled differently and supports different features.
Add more comprehensive information about each function.
--- doc/guides/nics/mlx5.rst | 55 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+)
doc/guides/nics/mlx5.rst +55 -0
@@ -1645,3 +1645,58 @@ all flows with assistance of external tools. .. code-block:: console mlx_steering_dump.py -f <output_file> + +RX burst functions +------------------ + +This section describes the different rx_burst functions and provides an +elaborated information. + +#. Function name - rx_burst + How to enable - rx_vec_en=0 + Scatter support - Yes + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - The maximal packet size should be set to be the + same as the MTU size. The mbuf size can be + according to the application needs since the + pmd can perform the scatter. + +#. Function name - rx_burst_vec + How to enable - rx_vec_en=1 (default value) + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - No. Scatter is not supported, so it means + that the mbuf must be with the same size of + the MTU. In this case, maximal packet size == + mbuf size == MTU size + Fallback - In scatter or LRO fallback to rx_burst + Notes - Improves CPU utilization for single-core and + improves performance + +#. Function name - rx_burst_mprq + How to enable - mprq_en=1 + Scatter support - No + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Notes - Saving PCI bandwidth and getting higher + performance, especially for small packets. + Used mainly for multi-core use cases. + Uses externally attached buffers only. + +#. Function name - rx_burst_mprq_vec + How to enable - rx_vec_en=1 (default mode) and mprq_en=1 + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Fallback - In scatter or LRO fallback to rx_burst_mprq + Notes - Improves CPU utilization of regular + rx_burst_mprq for multi-core and improves + performance. + Used mainly for multi-core use cases. + Uses externally attached buffers only.
Signature · 1 line
1.8.3.1
Hi, Asaf
There is one more devargs to manage MPRQ enable: "rxqs_min_mprq". This parameters defines the number of Rx queues limit to enable MPRQ. If there is not enough Rx queues (below the limit) then MPRQ is disabled. By default, "rxqs_min_mprq" is 12. I suppose we should mention this in the list being added.
With best regards, Slava
Quoted 86 lines
-----Original Message-----
From: Asaf Penso <[email protected]>
Sent: Sunday, November 22, 2020 14:36
To: [email protected]
Cc: NBU-Contact-Thomas Monjalon <[email protected]>; Slava Ovsiienko <[email protected]>; Matan Azrad <[email protected]>; Raslan Darawsheh <[email protected]>
Subject: [PATCH] doc: add information for Rx burst functions in mlx5mlx5 pmd supports various
rx_burstfunctions.
Each function is enabled differently and supports different features.Add more comprehensive information about each function.
Signed-off-by Asaf Penso <[email protected]>--- doc/guides/nics/mlx5.rst | 55 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+)doc/guides/nics/mlx5.rst index renamed from doc/guides/nics/mlx5.rst +0
-0205e5ba..8c1ce15 100644
doc/guides/nics/mlx5.rst +55
-1@@ -1645,3 +1645,58 @@ all flows with assistance of external tools. .. code-block:: console mlx_steering_dump.py -f <output_file> + +RX burst functions +------------------ + +This section describes the different rx_burst functions and provides an +elaborated information. + +#. Function name - rx_burst + How to enable - rx_vec_en=0 + Scatter support - Yes + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - The maximal packet size should be set to be the + same as the MTU size. The mbuf size can be + according to the application needs since the + pmd can perform the scatter. + +#. Function name - rx_burst_vec + How to enable - rx_vec_en=1 (default value) + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - No. Scatter is not supported, so it means + that the mbuf must be with the same size of + the MTU. In this case, maximal packet size == + mbuf size == MTU size + Fallback - In scatter or LRO fallback to rx_burst + Notes - Improves CPU utilization for single-core and + improves performance + +#. Function name - rx_burst_mprq + How to enable - mprq_en=1 + Scatter support - No + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Notes - Saving PCI bandwidth and getting higher + performance, especially for small packets. + Used mainly for multi-core use cases. + Uses externally attached buffers only. + +#. Function name - rx_burst_mprq_vec + How to enable - rx_vec_en=1 (default mode) and mprq_en=1 + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Fallback - In scatter or LRO fallback to rx_burst_mprq + Notes - Improves CPU utilization of regular + rx_burst_mprq for multi-core and improves + performance. + Used mainly for multi-core use cases. + Uses externally attached buffers only. --1.8.3.1
PATCH v2 1/1 doc: add information for Rx burst functions in mlx5
In reply to Asaf Pensomlx5 pmd supports various rx_burst functions.
Each function is enabled differently and supports different features.
Add more comprehensive information about each function.
---
v2: for mprq added note for rxqs_min_mprq
--- doc/guides/nics/mlx5.rst | 57 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+)
doc/guides/nics/mlx5.rst +57 -0
@@ -1645,3 +1645,60 @@ all flows with assistance of external tools. .. code-block:: console mlx_steering_dump.py -f <output_file> + +RX burst functions +------------------ + +This section describes the different rx_burst functions and provides an +elaborated information. + +#. Function name - rx_burst + How to enable - rx_vec_en=0 + Scatter support - Yes + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - The maximal packet size should be set to be the + same as the MTU size. The mbuf size can be + according to the application needs since the + pmd can perform the scatter. + +#. Function name - rx_burst_vec + How to enable - rx_vec_en=1 (default value) + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - No. Scatter is not supported, so it means + that the mbuf must be with the same size of + the MTU. In this case, maximal packet size == + mbuf size == MTU size + Fallback - In scatter or LRO fallback to rx_burst + Notes - Improves CPU utilization for single-core and + improves performance + +#. Function name - rx_burst_mprq + How to enable - mprq_en=1 + - RX queues number should be >= rxqs_min_mprq + Scatter support - No + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Notes - Saving PCI bandwidth and getting higher + performance, especially for small packets. + Used mainly for multi-core use cases. + Uses externally attached buffers only. + +#. Function name - rx_burst_mprq_vec + How to enable - rx_vec_en=1 (default mode) and mprq_en=1 + - RX queues number should be >= rxqs_min_mprq + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Fallback - In scatter or LRO fallback to rx_burst_mprq + Notes - Improves CPU utilization of regular + rx_burst_mprq for multi-core and improves + performance. + Used mainly for multi-core use cases. + Uses externally attached buffers only.
Signature · 1 line
1.8.3.1
PATCH v3 1/1 doc: add information for Rx burst functions in mlx5
mlx5 pmd supports various rx_burst functions.
Each function is enabled differently and supports different features.
Add more comprehensive information about each function.
---
v3: checkpatch cleanup
v2: for mprq added note for rxqs_min_mprq
--- doc/guides/nics/mlx5.rst | 57 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+)
doc/guides/nics/mlx5.rst +57 -0
@@ -1645,3 +1645,60 @@ all flows with assistance of external tools. .. code-block:: console mlx_steering_dump.py -f <output_file> + +RX burst functions +------------------ + +This section describes the different rx_burst functions and provides an +elaborated information. + +#. Function name - rx_burst + How to enable - rx_vec_en=0 + Scatter support - Yes + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - The maximal packet size should be set to be the + same as the MTU size. The mbuf size can be + according to the application needs since the + pmd can perform the scatter. + +#. Function name - rx_burst_vec + How to enable - rx_vec_en=1 (default value) + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - No. Scatter is not supported, so it means + that the mbuf must be with the same size of + the MTU. In this case, maximal packet size == + mbuf size == MTU size + Fallback - In scatter or LRO fallback to rx_burst + Notes - Improves CPU utilization for single-core and + improves performance + +#. Function name - rx_burst_mprq + How to enable - mprq_en=1 + - RX queues number should be >= rxqs_min_mprq + Scatter support - No + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Notes - Saving PCI bandwidth and getting higher + performance, especially for small packets. + Used mainly for multi-core use cases. + Uses externally attached buffers only. + +#. Function name - rx_burst_mprq_vec + How to enable - rx_vec_en=1 (default mode) and mprq_en=1 + - RX queues number should be >= rxqs_min_mprq + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Fallback - In scatter or LRO fallback to rx_burst_mprq + Notes - Improves CPU utilization of regular + rx_burst_mprq for multi-core and improves + performance. + Used mainly for multi-core use cases. + Uses externally attached buffers only.
Signature · 1 line
1.8.3.1
Quoted 9 lines
-----Original Message-----
From: Asaf Penso <[email protected]>
Sent: Monday, November 23, 2020 10:05
To: [email protected]
Cc: NBU-Contact-Thomas Monjalon <[email protected]>; Slava Ovsiienko <[email protected]>; Matan Azrad <[email protected]>; Raslan Darawsheh <[email protected]>
Subject: [PATCH v3] doc: add information for Rx burst functions in mlx5
Quoted 6 lines
mlx5 pmd supports various
rx_burstfunctions.
Each function is enabled differently and supports different features.Add more comprehensive information about each function.
Signed-off-by Asaf Penso <[email protected]>
PATCH v4 1/1 doc: add information for Rx burst functions in mlx5
In reply to Asaf Pensomlx5 pmd supports various rx_burst functions.
Each function is enabled differently and supports different features.
Add more comprehensive information about each function.
---
v4: update the fallback for mprq burst functions
v3: checkpatch cleanup
v2: for mprq added note for rxqs_min_mprq
--- doc/guides/nics/mlx5.rst | 59 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+)
doc/guides/nics/mlx5.rst +59 -0
@@ -1645,3 +1645,62 @@ all flows with assistance of external tools. .. code-block:: console mlx_steering_dump.py -f <output_file> + +RX burst functions +------------------ + +This section describes the different rx_burst functions and provides an +elaborated information. + +#. Function name - rx_burst + How to enable - rx_vec_en=0 + Scatter support - Yes + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - The maximal packet size should be set to be the + same as the MTU size. The mbuf size can be + according to the application needs since the + pmd can perform the scatter. + +#. Function name - rx_burst_vec + How to enable - rx_vec_en=1 (default value) + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - No. Scatter is not supported, so it means + that the mbuf must be with the same size of + the MTU. In this case, maximal packet size == + mbuf size == MTU size + Fallback - In scatter or LRO fallback to rx_burst + Notes - Improves CPU utilization for single-core and + improves performance + +#. Function name - rx_burst_mprq + How to enable - mprq_en=1 + - RX queues number should be >= rxqs_min_mprq + Scatter support - No + RX error recovery support - Yes + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Fallback - In scatter fallback to rx_burst + Notes - Saving PCI bandwidth and getting higher + performance, especially for small packets. + Used mainly for multi-core use cases. + Uses externally attached buffers only. + +#. Function name - rx_burst_mprq_vec + How to enable - rx_vec_en=1 (default mode) and mprq_en=1 + - RX queues number should be >= rxqs_min_mprq + Scatter support - No + RX error recovery support - Supported only in case CQE compression is off + CQE compression support - Yes + Large MTU support - Yes. Needs to be turned on by specifying the + stride size + Fallback - In scatter fallback to rx_burst. + In LRO fallback to rx_burst_mprq. + Notes - Improves CPU utilization of regular + rx_burst_mprq for multi-core and improves + performance. + Used mainly for multi-core use cases. + Uses externally attached buffers only.
Signature · 1 line
1.8.3.1
PATCH v5 1/1 doc: add Rx functions limitations in mlx5 guide
From: Asaf Penso <[email protected]>
The mlx5 PMD supports various Rx burst functions.
Each function is enabled differently and supports different features.
---
v5: fix formatting by using a table
--- doc/guides/nics/mlx5.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)
doc/guides/nics/mlx5.rst +23 -0
@@ -1345,6 +1345,29 @@ Performance tuning - Configure per-lcore cache when creating Mempools for packet buffer. - Refrain from dynamically allocating/freeing memory in run-time. +Rx burst functions +------------------ + +There are multiple Rx burst functions with different advantages and limitations. + +.. table:: Rx burst functions + + +-------------------+------------------------+---------+-----------------+------+-------+ + || Function Name || Enabler || Scatter|| Error Recovery || CQE || Large| + | | | | || comp|| MTU | + +===================+========================+=========+=================+======+=======+ + | rx_burst | rx_vec_en=0 | Yes | Yes | Yes | Yes | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_vec | rx_vec_en=1 (default) | No | if CQE comp off | Yes | No | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_mprq || mprq_en=1 | No | Yes | Yes | Yes | + | || RxQs >= rxqs_min_mprq | | | | | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_mprq_vec || rx_vec_en=1 (default) | No | if CQE comp off | Yes | Yes | + | || mprq_en=1 | | | | | + | || RxQs >= rxqs_min_mprq | | | | | + +-------------------+------------------------+---------+-----------------+------+-------+ + .. _mlx5_offloads_support: Supported hardware offloads
Signature · 1 line
2.28.0
Thomas Monjalon
AppliedRe: [dpdk-dev] [PATCH v5] doc: add Rx functions limitations in mlx5 guide
27/11/2020 00:55, Thomas Monjalon:
Quoted 9 lines
From: Asaf Penso <[email protected]>
The mlx5 PMD supports various Rx burst functions.
Each function is enabled differently and supports different features.Signed-off-by Asaf Penso <[email protected]>Signed-off-by Thomas Monjalon <[email protected]>---
v5: fix formatting by using a table
Applied