From patchwork Sat Apr 10 14:03:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bing Zhao X-Patchwork-Id: 91030 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B3298A0546; Sat, 10 Apr 2021 16:04:24 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0745614127F; Sat, 10 Apr 2021 16:04:12 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id 33A5714127E for ; Sat, 10 Apr 2021 16:04:11 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from bingz@nvidia.com) with SMTP; 10 Apr 2021 17:04:07 +0300 Received: from nvidia.com (mtbc-r640-01.mtbc.labs.mlnx [10.75.70.6]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 13AE3rtA028997; Sat, 10 Apr 2021 17:04:05 +0300 From: Bing Zhao To: orika@nvidia.com, thomas@monjalon.net, ferruh.yigit@intel.com, andrew.rybchenko@oktetlabs.ru, matan@nvidia.com, viacheslavo@nvidia.com Cc: dev@dpdk.org, ajit.khaparde@broadcom.com, getelson@nvidia.com, andreyv@nvidia.com Date: Sat, 10 Apr 2021 22:03:47 +0800 Message-Id: <1618063428-206842-4-git-send-email-bingz@nvidia.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1618063428-206842-1-git-send-email-bingz@nvidia.com> References: <1617940481-125528-1-git-send-email-bingz@nvidia.com> <1618063428-206842-1-git-send-email-bingz@nvidia.com> Subject: [dpdk-dev] [PATCH v2 3/4] doc: update user guide for indirect action X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The testpmd application user guide is updated. All the "shared action" related parts are replaced with "indirect action" to have a correct explanation. Signed-off-by: Bing Zhao --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 94 ++++++++++++++--------------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 2b407a3..42d3d23 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -4049,10 +4049,10 @@ This section lists supported actions and their attributes, if any. - ``dscp_value {unsigned}``: The new DSCP value to be set -- ``shared``: Use shared action created via - ``flow shared_action {port_id} create`` +- ``indirect``: Use indirect action created via + ``flow indirect_action {port_id} create`` - - ``shared_action_id {unsigned}``: Shared action ID to use + - ``indirect_action_id {unsigned}``: Indirect action ID to use Destroying flow rules ~~~~~~~~~~~~~~~~~~~~~ @@ -4343,113 +4343,113 @@ If attach ``destroy`` parameter, the command will destroy all the list aged flow testpmd> flow aged 0 Port 0 total aged flows: 0 -Creating shared actions +Creating indirect actions ~~~~~~~~~~~~~~~~~~~~~~~ -``flow shared_action {port_id} create`` creates shared action with optional -shared action ID. It is bound to ``rte_flow_shared_action_create()``:: +``flow indirect_action {port_id} create`` creates indirect action with optional +indirect action ID. It is bound to ``rte_flow_action_handle_create()``:: - flow shared_action {port_id} create [action_id {shared_action_id}] + flow indirect_action {port_id} create [action_id {indirect_action_id}] [ingress] [egress] [transfer] action {action} / end If successful, it will show:: - Shared action #[...] created + Indirect action #[...] created -Otherwise, it will complain either that shared action already exists or that +Otherwise, it will complain either that indirect action already exists or that some error occurred:: - Shared action #[...] is already assigned, delete it first + Indirect action #[...] is already assigned, delete it first :: Caught error type [...] ([...]): [...] -Create shared rss action with id 100 to queues 1 and 2 on port 0:: +Create indirect rss action with id 100 to queues 1 and 2 on port 0:: - testpmd> flow shared_action 0 create action_id 100 \ + testpmd> flow indirect_action 0 create action_id 100 \ ingress action rss queues 1 2 end / end -Create shared rss action with id assigned by testpmd to queues 1 and 2 on +Create indirect rss action with id assigned by testpmd to queues 1 and 2 on port 0:: - testpmd> flow shared_action 0 create action_id \ + testpmd> flow indirect_action 0 create action_id \ ingress action rss queues 0 1 end / end -Updating shared actions +Updating indirect actions ~~~~~~~~~~~~~~~~~~~~~~~ -``flow shared_action {port_id} update`` updates configuration of the shared -action from its shared action ID (as returned by -``flow shared_action {port_id} create``). It is bound to -``rte_flow_shared_action_update()``:: +``flow indirect_action {port_id} update`` updates configuration of the indirect +action from its indirect action ID (as returned by +``flow indirect_action {port_id} create``). It is bound to +``rte_flow_action_handle_update()``:: - flow shared_action {port_id} update {shared_action_id} + flow indirect_action {port_id} update {indirect_action_id} action {action} / end If successful, it will show:: - Shared action #[...] updated + Indirect action #[...] updated -Otherwise, it will complain either that shared action not found or that some +Otherwise, it will complain either that indirect action not found or that some error occurred:: - Failed to find shared action #[...] on port [...] + Failed to find indirect action #[...] on port [...] :: Caught error type [...] ([...]): [...] -Update shared rss action having id 100 on port 0 with rss to queues 0 and 3 +Update indirect rss action having id 100 on port 0 with rss to queues 0 and 3 (in create example above rss queues were 1 and 2):: - testpmd> flow shared_action 0 update 100 action rss queues 0 3 end / end + testpmd> flow indirect_action 0 update 100 action rss queues 0 3 end / end -Destroying shared actions +Destroying indirect actions ~~~~~~~~~~~~~~~~~~~~~~~~~ -``flow shared_action {port_id} update`` destroys one or more shared actions -from their shared action IDs (as returned by -``flow shared_action {port_id} create``). It is bound to -``rte_flow_shared_action_destroy()``:: +``flow indirect_action {port_id} destroy`` destroys one or more indirect actions +from their indirect action IDs (as returned by +``flow indirect_action {port_id} create``). It is bound to +``rte_flow_action_handle_destroy()``:: - flow shared_action {port_id} destroy action_id {shared_action_id} [...] + flow indirect_action {port_id} destroy action_id {indirect_action_id} [...] If successful, it will show:: - Shared action #[...] destroyed + Indirect action #[...] destroyed -It does not report anything for shared action IDs that do not exist. -The usual error message is shown when a shared action cannot be destroyed:: +It does not report anything for indirect action IDs that do not exist. +The usual error message is shown when a indirect action cannot be destroyed:: Caught error type [...] ([...]): [...] -Destroy shared actions having id 100 & 101:: +Destroy indirect actions having id 100 & 101:: - testpmd> flow shared_action 0 destroy action_id 100 action_id 101 + testpmd> flow indirect_action 0 destroy action_id 100 action_id 101 -Query shared actions +Query indirect actions ~~~~~~~~~~~~~~~~~~~~ -``flow shared_action {port_id} query`` queries the shared action from its -shared action ID (as returned by ``flow shared_action {port_id} create``). -It is bound to ``rte_flow_shared_action_query()``:: +``flow indirect_action {port_id} query`` queries the indirect action from its +indirect action ID (as returned by ``flow indirect_action {port_id} create``). +It is bound to ``rte_flow_action_handle_query()``:: - flow shared_action {port_id} query {shared_action_id} + flow indirect_action {port_id} query {indirect_action_id} -Currently only rss shared action supported. If successful, it will show:: +Currently only rss indirect action supported. If successful, it will show:: - Shared RSS action: + Indirect RSS action: refs:[...] -Otherwise, it will complain either that shared action not found or that some +Otherwise, it will complain either that indirect action not found or that some error occurred:: - Failed to find shared action #[...] on port [...] + Failed to find indirect action #[...] on port [...] :: Caught error type [...] ([...]): [...] -Query shared action having id 100:: +Query indirect action having id 100:: - testpmd> flow shared_action 0 query 100 + testpmd> flow indirect_action 0 query 100 Sample QinQ flow rules ~~~~~~~~~~~~~~~~~~~~~~