doc: update flow non-cached mode notes
Checks
Commit Message
This patch updates the MLX5 PMD and release notes documentations.
Adding the notes of the behavior change that rte flows organization
is switched into non-cached mode for applications.
Signed-off-by: Bing Zhao <bingz@mellanox.com>
---
doc/guides/nics/mlx5.rst | 10 ++++++++++
doc/guides/rel_notes/release_20_05.rst | 1 +
2 files changed, 11 insertions(+)
Comments
10/04/2020 11:36, Bing Zhao:
> This patch updates the MLX5 PMD and release notes documentations.
> Adding the notes of the behavior change that rte flows organization
> is switched into non-cached mode for applications.
Please, can it be squashed in the patch doing this change?
> + * Flows organization changed from cached mode to non-cached mode.
I suggest this wording:
Flow rules caching removed from the driver for memory saving.
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Friday, April 10, 2020 6:10 PM
> To: john.mcnamara@intel.com; marko.kovacevic@intel.com; Slava
> Ovsiienko <viacheslavo@mellanox.com>; Matan Azrad
> <matan@mellanox.com>; Bing Zhao <bingz@mellanox.com>
> Cc: Shahaf Shuler <shahafs@mellanox.com>; Raslan Darawsheh
> <rasland@mellanox.com>; Ori Kam <orika@mellanox.com>;
> dev@dpdk.org
> Subject: Re: [PATCH] doc: update flow non-cached mode notes
>
> 10/04/2020 11:36, Bing Zhao:
> > This patch updates the MLX5 PMD and release notes
> documentations.
> > Adding the notes of the behavior change that rte flows organization
> is
> > switched into non-cached mode for applications.
>
> Please, can it be squashed in the patch doing this change?
>
Hi Thomas, the PMD change was already integrated Into the branch.
I am afraid this couldn't be squashed into the PMD patch.
And this patch is for the notes to the application.
>
> > + * Flows organization changed from cached mode to non-cached
> mode.
>
> I suggest this wording:
>
> Flow rules caching removed from the driver for memory saving.
>
OK, I will change it. Thanks
>
@@ -1287,6 +1287,16 @@ set, and we should allow to specify zero values as rte_flow parameters for the
META and MARK items and actions. In the same time zero mask has no meaning and
should be rejected on validation stage.
+Notes for rte_flow
+------------------
+Implementation of flows organization is in non-cached mode. When stopping a
+device, all the flows inserted from application will be considered invalid and
+flushed automatically in the background. After restarting of the device, no
+application's flow exists in the system.
+
+The application should re-insert the flows as required after device restarting,
+and must not try to destroy or flush the invalid flows before stopping.
+
Notes for testpmd
-----------------
@@ -62,6 +62,7 @@ New Features
* Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
* Added support for creating Relaxed Ordering Memory Regions.
+ * Flows organization changed from cached mode to non-cached mode.
* **Updated the Intel ice driver.**