Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/84473/?format=api
{ "id": 84473, "url": "https://patches.dpdk.org/api/patches/84473/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20201123174227.11920-1-cristian.dumitrescu@intel.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20201123174227.11920-1-cristian.dumitrescu@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20201123174227.11920-1-cristian.dumitrescu@intel.com", "date": "2020-11-23T17:42:26", "name": "doc: add pipeline example to user guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f65397ccdf4880aff6af66eee8ad5730f30aaffb", "submitter": { "id": 19, "url": "https://patches.dpdk.org/api/people/19/?format=api", "name": "Cristian Dumitrescu", "email": "cristian.dumitrescu@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20201123174227.11920-1-cristian.dumitrescu@intel.com/mbox/", "series": [ { "id": 14041, "url": "https://patches.dpdk.org/api/series/14041/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=14041", "date": "2020-11-23T17:42:26", "name": "doc: add pipeline example to user guide", "version": 1, "mbox": "https://patches.dpdk.org/series/14041/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/84473/comments/", "check": "warning", "checks": "https://patches.dpdk.org/api/patches/84473/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 20E04A04B1;\n\tMon, 23 Nov 2020 18:42:36 +0100 (CET)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id A426EC8F2;\n\tMon, 23 Nov 2020 18:42:33 +0100 (CET)", "from mga04.intel.com (mga04.intel.com [192.55.52.120])\n by dpdk.org (Postfix) with ESMTP id 36A66C8C6\n for <dev@dpdk.org>; Mon, 23 Nov 2020 18:42:31 +0100 (CET)", "from orsmga007.jf.intel.com ([10.7.209.58])\n by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 23 Nov 2020 09:42:29 -0800", "from silpixa00400573.ir.intel.com (HELO\n silpixa00400573.ger.corp.intel.com) ([10.237.223.107])\n by orsmga007.jf.intel.com with ESMTP; 23 Nov 2020 09:42:27 -0800" ], "IronPort-SDR": [ "\n gbky0pXxHcTVbqX4HUtTY+lkRDv8m1+4bH99AbExSmekBI3nrq0lEqTIXaQu+Gcm8lPBGeH7go\n 830eQwLAO2QA==", "\n a+APl5NhGyi/Iu/Qain1T3d1cqorXc/Fu0xY98okJoWM2up5GRviTEPqQuKHstm43iqnvbsKh8\n +px7dIN2+SBg==" ], "X-IronPort-AV": [ "E=McAfee;i=\"6000,8403,9814\"; a=\"169244306\"", "E=Sophos;i=\"5.78,364,1599548400\"; d=\"scan'208\";a=\"169244306\"", "E=Sophos;i=\"5.78,364,1599548400\"; d=\"scan'208\";a=\"370097855\"" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "From": "Cristian Dumitrescu <cristian.dumitrescu@intel.com>", "To": "dev@dpdk.org", "Cc": "david.marchand@redhat.com", "Date": "Mon, 23 Nov 2020 17:42:26 +0000", "Message-Id": "<20201123174227.11920-1-cristian.dumitrescu@intel.com>", "X-Mailer": "git-send-email 2.17.1", "Subject": "[dpdk-dev] [PATCH] doc: add pipeline example to user guide", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Document the pipeline example in the Sample Application User Guide.\n\nSigned-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>\n---\n doc/guides/sample_app_ug/index.rst | 1 +\n doc/guides/sample_app_ug/pipeline.rst | 118 ++++++++++++++++++++++++++\n 2 files changed, 119 insertions(+)\n create mode 100755 doc/guides/sample_app_ug/pipeline.rst", "diff": "diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst\nindex ef66e23bb..e8db83d3a 100644\n--- a/doc/guides/sample_app_ug/index.rst\n+++ b/doc/guides/sample_app_ug/index.rst\n@@ -48,6 +48,7 @@ Sample Applications User Guides\n vdpa\n ip_pipeline\n test_pipeline\n+ pipeline\n eventdev_pipeline\n dist_app\n vm_power_management\ndiff --git a/doc/guides/sample_app_ug/pipeline.rst b/doc/guides/sample_app_ug/pipeline.rst\nnew file mode 100755\nindex 000000000..9b52d8a22\n--- /dev/null\n+++ b/doc/guides/sample_app_ug/pipeline.rst\n@@ -0,0 +1,118 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2015-2018 Intel Corporation.\n+\n+Pipeline Application\n+====================\n+\n+Application overview\n+--------------------\n+\n+This application showcases the features of the Software Switch (SWX) pipeline that is aligned with the P4 language.\n+\n+Each pipeline is created using a specification file that can either be manually developed or generated using a P4 compiler.\n+\n+Each pipeline is built through the CLI, either by invoking commands one by one, or through a CLI script.\n+The CLI can also be used to update the pipeline tables or poll the pipeline statistics.\n+\n+Each pipeline is mapped to a specific application thread. Multiple pipelines can be mapped to the same thread.\n+\n+Running the application\n+-----------------------\n+\n+The application startup command line is::\n+\n+ dpdk-pipeline [EAL_ARGS] -- [-s SCRIPT_FILE] [-h HOST] [-p PORT]\n+\n+The application startup arguments are:\n+\n+``-s SCRIPT_FILE``\n+\n+ * Optional: Yes\n+\n+ * Default: Not present\n+\n+ * Argument: Path to the CLI script file to be run at application startup.\n+ No CLI script file will run at startup if this argument is not present.\n+\n+``-h HOST``\n+\n+ * Optional: Yes\n+\n+ * Default: ``0.0.0.0``\n+\n+ * Argument: IP Address of the host running the application to be used by\n+ remote TCP based client (telnet, netcat, etc.) for connection.\n+\n+``-p PORT``\n+\n+ * Optional: Yes\n+\n+ * Default: ``8086``\n+\n+ * Argument: TCP port number at which the application is running.\n+ This port number should be used by remote TCP client (such as telnet, netcat, etc.) to connect to host application.\n+\n+Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.\n+\n+The following is an example command to run the application configured for the VXLAN encapsulation example:\n+\n+.. code-block:: console\n+\n+ $ ./<build_dir>/examples/dpdk-pipeline -c 0x3 -- -s examples/vxlan.cli\n+\n+The application should start successfully and display as follows:\n+\n+.. code-block:: console\n+\n+ EAL: Detected 40 lcore(s)\n+ EAL: Detected 2 NUMA nodes\n+ EAL: Multi-process socket /var/run/.rte_unix\n+ EAL: Probing VFIO support...\n+ EAL: PCI device 0000:02:00.0 on NUMA socket 0\n+ EAL: probe driver: 8086:10fb net_ixgbe\n+ ...\n+\n+To run remote client (e.g. telnet) to communicate with the application:\n+\n+.. code-block:: console\n+\n+ $ telnet 0.0.0.0 8086\n+\n+When running a telnet client as above, command prompt is displayed:\n+\n+.. code-block:: console\n+\n+ Trying 0.0.0.0...\n+ Connected to 0.0.0.0.\n+ Escape character is '^]'.\n+\n+ Welcome!\n+\n+ pipeline>\n+\n+Once application and telnet client start running, messages can be sent from client to application.\n+\n+\n+Application stages\n+------------------\n+\n+Initialization\n+~~~~~~~~~~~~~~\n+\n+During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data structures\n+for application objects are initialized. In case of any initialization error, an error message is displayed and the application\n+is terminated.\n+\n+Run-time\n+~~~~~~~~\n+\n+The main thread is creating and managing all the application objects based on CLI input.\n+\n+Each data plane thread runs one or several pipelines previously assigned to it in round-robin order. Each data plane thread\n+executes two tasks in time-sharing mode:\n+\n+1. *Packet processing task*: Process bursts of input packets read from the pipeline input ports.\n+\n+2. *Message handling task*: Periodically, the data plane thread pauses the packet processing task and polls for request\n+ messages send by the main thread. Examples: add/remove pipeline to/from current data plane thread, add/delete rules\n+ to/from given table of a specific pipeline owned by the current data plane thread, read statistics, etc.\n", "prefixes": [] }