Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/23800/?format=api
{ "id": 23800, "url": "https://patches.dpdk.org/api/patches/23800/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1492768299-84016-3-git-send-email-harry.van.haaren@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": "<1492768299-84016-3-git-send-email-harry.van.haaren@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1492768299-84016-3-git-send-email-harry.van.haaren@intel.com", "date": "2017-04-21T09:51:38", "name": "[dpdk-dev,2/3] doc: add eventdev pipeline to sample app ug", "commit_ref": null, "pull_url": null, "state": "changes-requested", "archived": true, "hash": "2acfd723cecd05c431f6bf7a656414c432d91251", "submitter": { "id": 317, "url": "https://patches.dpdk.org/api/people/317/?format=api", "name": "Van Haaren, Harry", "email": "harry.van.haaren@intel.com" }, "delegate": { "id": 310, "url": "https://patches.dpdk.org/api/users/310/?format=api", "username": "jerin", "first_name": "Jerin", "last_name": "Jacob", "email": "jerinj@marvell.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1492768299-84016-3-git-send-email-harry.van.haaren@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/23800/comments/", "check": "warning", "checks": "https://patches.dpdk.org/api/patches/23800/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id 08F4B58CE;\n\tFri, 21 Apr 2017 11:52:33 +0200 (CEST)", "from mga05.intel.com (mga05.intel.com [192.55.52.43])\n\tby dpdk.org (Postfix) with ESMTP id E879E58CD\n\tfor <dev@dpdk.org>; Fri, 21 Apr 2017 11:52:30 +0200 (CEST)", "from orsmga005.jf.intel.com ([10.7.209.41])\n\tby fmsmga105.fm.intel.com with ESMTP; 21 Apr 2017 02:52:29 -0700", "from silpixa00398672.ir.intel.com ([10.237.223.128])\n\tby orsmga005.jf.intel.com with ESMTP; 21 Apr 2017 02:52:28 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.37,229,1488873600\"; d=\"scan'208\";a=\"90572723\"", "From": "Harry van Haaren <harry.van.haaren@intel.com>", "To": "dev@dpdk.org", "Cc": "jerin.jacob@caviumnetworks.com,\n\tHarry van Haaren <harry.van.haaren@intel.com>", "Date": "Fri, 21 Apr 2017 10:51:38 +0100", "Message-Id": "<1492768299-84016-3-git-send-email-harry.van.haaren@intel.com>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1492768299-84016-1-git-send-email-harry.van.haaren@intel.com>", "References": "<1492768299-84016-1-git-send-email-harry.van.haaren@intel.com>", "Subject": "[dpdk-dev] [PATCH 2/3] doc: add eventdev pipeline to sample app ug", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Add a new entry in the sample app user-guides,\nwhich details the working of the eventdev_pipeline.\n\nSigned-off-by: Harry van Haaren <harry.van.haaren@intel.com>\n---\n doc/guides/sample_app_ug/eventdev_pipeline.rst | 188 +++++++++++++++++++++++++\n doc/guides/sample_app_ug/index.rst | 1 +\n 2 files changed, 189 insertions(+)\n create mode 100644 doc/guides/sample_app_ug/eventdev_pipeline.rst", "diff": "diff --git a/doc/guides/sample_app_ug/eventdev_pipeline.rst b/doc/guides/sample_app_ug/eventdev_pipeline.rst\nnew file mode 100644\nindex 0000000..31d1006\n--- /dev/null\n+++ b/doc/guides/sample_app_ug/eventdev_pipeline.rst\n@@ -0,0 +1,188 @@\n+\n+.. BSD LICENSE\n+ Copyright(c) 2017 Intel Corporation. All rights reserved.\n+ All rights reserved.\n+\n+ Redistribution and use in source and binary forms, with or without\n+ modification, are permitted provided that the following conditions\n+ are met:\n+\n+ * Redistributions of source code must retain the above copyright\n+ notice, this list of conditions and the following disclaimer.\n+ * Redistributions in binary form must reproduce the above copyright\n+ notice, this list of conditions and the following disclaimer in\n+ the documentation and/or other materials provided with the\n+ distribution.\n+ * Neither the name of Intel Corporation nor the names of its\n+ contributors may be used to endorse or promote products derived\n+ from this software without specific prior written permission.\n+\n+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+Eventdev Pipeline Sample Application\n+====================================\n+\n+The eventdev pipeline sample application is a sample app that demonstrates\n+the usage of the eventdev API. It shows how an application can configure\n+a pipeline and assign a set of worker cores to perform the processing required.\n+\n+The application has a range of command line arguments allowing it to be\n+configured for various numbers worker cores, stages,queue depths and cycles per\n+stage of work. This is useful for performance testing as well as quickly testing\n+a particular pipeline configuration.\n+\n+\n+Compiling the Application\n+-------------------------\n+\n+To compile the application:\n+\n+#. Go to the sample application directory:\n+\n+ .. code-block:: console\n+\n+ export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/eventdev_pipeline\n+\n+#. Set the target (a default target is used if not specified). For example:\n+\n+ .. code-block:: console\n+\n+ export RTE_TARGET=x86_64-native-linuxapp-gcc\n+\n+ See the *DPDK Getting Started Guide* for possible RTE_TARGET values.\n+\n+#. Build the application:\n+\n+ .. code-block:: console\n+\n+ make\n+\n+Running the Application\n+-----------------------\n+\n+The application has a lot of command line options. This allows specification of\n+the eventdev PMD to use, and a number of attributes of the processing pipeline\n+options.\n+\n+An example eventdev pipeline running with the software eventdev PMD using\n+these settings is shown below:\n+\n+ * ``-r1``: core mask 0x1 for RX\n+ * ``-t1``: core mask 0x1 for TX\n+ * ``-e4``: core mask 0x4 for the software scheduler\n+ * ``-w FF00``: core mask for worker cores, 8 cores from 8th to 16th\n+ * ``-s4``: 4 atomic stages\n+ * ``-n0``: process infinite packets (run forever)\n+ * ``-c32``: worker dequeue depth of 32\n+ * ``-W1000``: do 1000 cycles of work per packet in each stage\n+ * ``-D``: dump statistics on exit\n+\n+.. code-block:: console\n+\n+ ./build/eventdev_pipeline --vdev event_sw0 -- -r1 -t1 -e4 -w FF00 -s4 -n0 -c32 -W1000 -D\n+\n+The application has some sanity checking built-in, so if there is a function\n+(eg; the RX core) which doesn't have a cpu core mask assigned, the application\n+will print an error message:\n+\n+.. code-block:: console\n+\n+ Core part of pipeline was not assigned any cores. This will stall the\n+ pipeline, please check core masks (use -h for details on setting core masks):\n+ rx: 0\n+ tx: 1\n+\n+Configuration of the eventdev is covered in detail in the programmers guide,\n+see the Event Device Library section.\n+\n+\n+Observing the Application\n+-------------------------\n+\n+At runtime the eventdev pipeline application prints out a summary of the\n+configuration, and some runtime statistics like packets per second. On exit the\n+worker statistics are printed, along with a full dump of the PMD statistics if\n+required. The following sections show sample output for each of the output\n+types.\n+\n+Configuration\n+~~~~~~~~~~~~~\n+\n+This provides an overview of the pipeline,\n+scheduling type at each stage, and parameters to options such as how many\n+flows to use and what eventdev PMD is in use. See the following sample output\n+for details:\n+\n+.. code-block:: console\n+\n+ Config:\n+ ports: 2\n+ workers: 8\n+ packets: 0\n+ priorities: 1\n+ Queue-prio: 0\n+ qid0 type: atomic\n+ Cores available: 44\n+ Cores used: 10\n+ Eventdev 0: event_sw\n+ Stages:\n+ Stage 0, Type Atomic Priority = 128\n+ Stage 1, Type Atomic Priority = 128\n+ Stage 2, Type Atomic Priority = 128\n+ Stage 3, Type Atomic Priority = 128\n+\n+Runtime\n+~~~~~~~\n+\n+At runtime, the statistics of the consumer are printed, stating the number of\n+packets recieved, runtime in milliseconds, average mpps, and current mpps.\n+\n+.. code-block:: console\n+\n+ # consumer RX= xxxxxxx, time yyyy ms, avg z.zzz mpps [current w.www mpps]\n+\n+Shutdown\n+~~~~~~~~\n+\n+At shutdown, the application prints the number of packets recieved and\n+transmitted, and an overview of the distribution of work across worker cores.\n+\n+.. code-block:: console\n+\n+ Signal 2 received, preparing to exit...\n+ worker 12 thread done. RX=4966581 TX=4966581\n+ worker 13 thread done. RX=4963329 TX=4963329\n+ worker 14 thread done. RX=4953614 TX=4953614\n+ worker 0 thread done. RX=0 TX=0\n+ worker 11 thread done. RX=4970549 TX=4970549\n+ worker 10 thread done. RX=4986391 TX=4986391\n+ worker 9 thread done. RX=4970528 TX=4970528\n+ worker 15 thread done. RX=4974087 TX=4974087\n+ worker 8 thread done. RX=4979908 TX=4979908\n+ worker 2 thread done. RX=0 TX=0\n+\n+ Port Workload distribution:\n+ worker 0 : 12.5 % (4979876 pkts)\n+ worker 1 : 12.5 % (4970497 pkts)\n+ worker 2 : 12.5 % (4986359 pkts)\n+ worker 3 : 12.5 % (4970517 pkts)\n+ worker 4 : 12.5 % (4966566 pkts)\n+ worker 5 : 12.5 % (4963297 pkts)\n+ worker 6 : 12.5 % (4953598 pkts)\n+ worker 7 : 12.5 % (4974055 pkts)\n+\n+To get a full dump of the state of the eventdev PMD, pass the ``-D`` flag to\n+this application. When the app is terminated using ``Ctrl+C``, the\n+``rte_event_dev_dump()`` function is called, resulting in a dump of the\n+statistics that the PMD provides. The statistics provided depend on the PMD\n+used, see the Event Device Drivers section for a list of eventdev PMDs.\ndiff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst\nindex 02611ef..11f5781 100644\n--- a/doc/guides/sample_app_ug/index.rst\n+++ b/doc/guides/sample_app_ug/index.rst\n@@ -69,6 +69,7 @@ Sample Applications User Guides\n netmap_compatibility\n ip_pipeline\n test_pipeline\n+ eventdev_pipeline\n dist_app\n vm_power_management\n tep_termination\n", "prefixes": [ "dpdk-dev", "2/3" ] }