From patchwork Fri Jun 23 07:36:00 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jerin Jacob Kollanukkaran X-Patchwork-Id: 128949 X-Patchwork-Delegate: thomas@monjalon.net 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 6148542D23; Fri, 23 Jun 2023 09:36:25 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D442D40E09; Fri, 23 Jun 2023 09:36:24 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 31E42400EF for ; Fri, 23 Jun 2023 09:36:24 +0200 (CEST) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 35MJu3wh025527; Fri, 23 Jun 2023 00:36:23 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=CUGNH8vmdmpEopwR06S0pKjTMD8pEFDiWRRHnRpxWi4=; b=TxiYV9Mga11WQVtI0+ACLGonVFqQJyX24XdUQGm4ld+EgtJPphpIn8qsBbTuv5Kq/Zj7 z8yyVviVrbbDP4WrNLEFY/Tybw4srkLew3CL+UiPZCEMzL7QrkG1tOQL1CLvBu2hHbvs B8Anxn55lLolcGZYkW9D3fxyhFTSsElNCPPaFm3X338KmpHDbkQFuOz9PjvT1jnX2VdQ 6NfPbZYWAa75UW1UceOwQMeIquagEcWaiVjH/K6S0ckLI5Wbhbwkt7GPIOX+2auA6Hae fv1qSHTqrsOYsjxkhOWBVIxQlbVIazxOLn6XyeQqb+F6+y557Itg8mJk70t4cXzLvI6a 3w== Received: from dc5-exch02.marvell.com ([199.233.59.182]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3rcur5j2x5-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Fri, 23 Jun 2023 00:36:22 -0700 Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server (TLS) id 15.0.1497.48; Fri, 23 Jun 2023 00:36:21 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.48 via Frontend Transport; Fri, 23 Jun 2023 00:36:21 -0700 Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14]) by maili.marvell.com (Postfix) with ESMTP id CE0655B692D; Fri, 23 Jun 2023 00:36:18 -0700 (PDT) From: To: , Jerin Jacob , Kiran Kumar K , Nithin Dabilpuram , Zhirun Yan CC: , Subject: [dpdk-dev] [PATCH v1] doc: add inbuilt graph nodes data flow Date: Fri, 23 Jun 2023 13:06:00 +0530 Message-ID: <20230623073600.1567086-1-jerinj@marvell.com> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 X-Proofpoint-ORIG-GUID: url6ksn83jZ36gXuZxWIOfEm0_XHdToJ X-Proofpoint-GUID: url6ksn83jZ36gXuZxWIOfEm0_XHdToJ X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.957,Hydra:6.0.591,FMLib:17.11.176.26 definitions=2023-06-23_02,2023-06-22_02,2023-05-22_02 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 From: Jerin Jacob Added diagram to depict the data flow between inbuilt graph nodes. In order to avoid graphviz package dependency to DPDK documentation, manual step added to create a svg file from the dot file. The details for the same is documented in graph_inbuilt_node_flow.svg as a comment. Signed-off-by: Jerin Jacob Reviewed-by: Zhirun Yan --- doc/guides/prog_guide/graph_lib.rst | 12 +- .../img/graph_inbuilt_node_flow.svg | 210 ++++++++++++++++++ 2 files changed, 220 insertions(+), 2 deletions(-) create mode 100644 doc/guides/prog_guide/img/graph_inbuilt_node_flow.svg diff --git a/doc/guides/prog_guide/graph_lib.rst b/doc/guides/prog_guide/graph_lib.rst index 307f599627..96af29e8da 100644 --- a/doc/guides/prog_guide/graph_lib.rst +++ b/doc/guides/prog_guide/graph_lib.rst @@ -394,8 +394,16 @@ to enable fastpath services. Inbuilt Nodes ------------- -DPDK provides a set of nodes for data processing. The following section -details the documentation for the same. +DPDK provides a set of nodes for data processing. The following diagram depicts +inbuilt nodes data flow. + +.. _figure_graph_inbuit_node_flow: + +.. figure:: img/graph_inbuilt_node_flow.* + + Inbuilt nodes data flow + +Following section details the documentation for individual inbuilt node. ethdev_rx ~~~~~~~~~ diff --git a/doc/guides/prog_guide/img/graph_inbuilt_node_flow.svg b/doc/guides/prog_guide/img/graph_inbuilt_node_flow.svg new file mode 100644 index 0000000000..02fe768dfe --- /dev/null +++ b/doc/guides/prog_guide/img/graph_inbuilt_node_flow.svg @@ -0,0 +1,210 @@ + + + + + + + + + + +dpdk_inbuilt_nodes_flow + + + +ethdev_rx + +ethdev_rx + + + +pkt_cls + +pkt_cls + + + +ethdev_rx->pkt_cls + + + + + +kernel_rx + +kernel_rx + + + +kernel_rx->pkt_cls + + + + + +ethdev_tx + +ethdev_tx + + + +pkt_drop + +pkt_drop + + + +ethdev_tx->pkt_drop + + + + + +kernel_tx + +kernel_tx + + + +kernel_tx->kernel_rx + + + + + +pkt_cls->pkt_drop + + + + + +pkt_cls->kernel_tx + + +exception pkts + + + +ip4_lookup + +ip4_lookup + + + +pkt_cls->ip4_lookup + + +ipv4 + + + +ip6_lookup + +ip6_lookup + + + +pkt_cls->ip6_lookup + + +ipv6 + + + +ip4_lookup->pkt_drop + + + + + +ip4_rewrite + +ip4_rewrite + + + +ip4_lookup->ip4_rewrite + + + + + +ip6_lookup->pkt_drop + + + + + +ip6_rewrite + +ip6_rewrite + + + +ip6_lookup->ip6_rewrite + + + + + +ip4_rewrite->ethdev_tx + + + + + +ip4_rewrite->pkt_drop + + + + + +ip6_rewrite->ethdev_tx + + + + + +ip6_rewrite->pkt_drop + + + + +