Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/82094/?format=api
{ "id": 82094, "url": "http://patchwork.dpdk.org/api/patches/82094/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20201025054556.14277-6-honnappa.nagarahalli@arm.com/", "project": { "id": 1, "url": "http://patchwork.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": "<20201025054556.14277-6-honnappa.nagarahalli@arm.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20201025054556.14277-6-honnappa.nagarahalli@arm.com", "date": "2020-10-25T05:45:53", "name": "[v5,5/8] doc/ring: add zero copy peek APIs", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "1c4f3c45e41610d93742c38815fef5010d66bac7", "submitter": { "id": 1045, "url": "http://patchwork.dpdk.org/api/people/1045/?format=api", "name": "Honnappa Nagarahalli", "email": "honnappa.nagarahalli@arm.com" }, "delegate": { "id": 24651, "url": "http://patchwork.dpdk.org/api/users/24651/?format=api", "username": "dmarchand", "first_name": "David", "last_name": "Marchand", "email": "david.marchand@redhat.com" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20201025054556.14277-6-honnappa.nagarahalli@arm.com/mbox/", "series": [ { "id": 13298, "url": "http://patchwork.dpdk.org/api/series/13298/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=13298", "date": "2020-10-25T05:45:48", "name": "lib/ring: add zero copy APIs", "version": 5, "mbox": "http://patchwork.dpdk.org/series/13298/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/82094/comments/", "check": "success", "checks": "http://patchwork.dpdk.org/api/patches/82094/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 F0B94A04B5;\n\tSun, 25 Oct 2020 06:47:52 +0100 (CET)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id CEA4A2BC7;\n\tSun, 25 Oct 2020 06:46:20 +0100 (CET)", "from foss.arm.com (foss.arm.com [217.140.110.172])\n by dpdk.org (Postfix) with ESMTP id 01E352B81\n for <dev@dpdk.org>; Sun, 25 Oct 2020 06:46:12 +0100 (CET)", "from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14])\n by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 6A871143D;\n Sat, 24 Oct 2020 22:46:10 -0700 (PDT)", "from qc2400f-1.austin.arm.com (qc2400f-1.austin.arm.com\n [10.118.12.27])\n by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 5901C3F66B;\n Sat, 24 Oct 2020 22:46:10 -0700 (PDT)" ], "From": "Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>", "To": "dev@dpdk.org, honnappa.nagarahalli@arm.com, konstantin.ananyev@intel.com,\n stephen@networkplumber.org", "Cc": "dharmik.thakkar@arm.com, ruifeng.wang@arm.com, olivier.matz@6wind.com,\n david.marchand@redhat.com, nd@arm.com", "Date": "Sun, 25 Oct 2020 00:45:53 -0500", "Message-Id": "<20201025054556.14277-6-honnappa.nagarahalli@arm.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20201025054556.14277-1-honnappa.nagarahalli@arm.com>", "References": "<20200224203931.21256-1-honnappa.nagarahalli@arm.com>\n <20201025054556.14277-1-honnappa.nagarahalli@arm.com>", "Subject": "[dpdk-dev] [PATCH v5 5/8] doc/ring: add zero copy peek APIs", "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": "Add zero copy peek API documentation.\n\nSigned-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>\n---\n doc/guides/prog_guide/ring_lib.rst | 41 ++++++++++++++++++++++++++\n doc/guides/rel_notes/release_20_11.rst | 9 ++++++\n 2 files changed, 50 insertions(+)", "diff": "diff --git a/doc/guides/prog_guide/ring_lib.rst b/doc/guides/prog_guide/ring_lib.rst\nindex 895484d95..247646d38 100644\n--- a/doc/guides/prog_guide/ring_lib.rst\n+++ b/doc/guides/prog_guide/ring_lib.rst\n@@ -452,6 +452,47 @@ selected. As an example of usage:\n Note that between ``_start_`` and ``_finish_`` none other thread can proceed\n with enqueue(/dequeue) operation till ``_finish_`` completes.\n \n+Ring Peek Zero Copy API\n+-----------------------\n+\n+Along with the advantages of the peek APIs, zero copy APIs provide the ability\n+to copy the data to the ring memory directly without the need for temporary\n+storage (for ex: array of mbufs on the stack).\n+\n+These APIs make it possible to split public enqueue/dequeue API into 3 phases:\n+\n+* enqueue/dequeue start\n+\n+* copy data to/from the ring\n+\n+* enqueue/dequeue finish\n+\n+Note that this API is available only for two sync modes:\n+\n+* Single Producer/Single Consumer (SP/SC)\n+\n+* Multi-producer/Multi-consumer with Head/Tail Sync (HTS)\n+\n+It is a user responsibility to create/init ring with appropriate sync modes.\n+Following is an example of usage:\n+\n+.. code-block:: c\n+\n+ /* Reserve space on the ring */\n+ n = rte_ring_enqueue_zc_burst_start(r, 32, &zcd, NULL);\n+ /* Pkt I/O core polls packets from the NIC */\n+ if (n != 0) {\n+ nb_rx = rte_eth_rx_burst(portid, queueid, zcd->ptr1, zcd->n1);\n+ if (nb_rx == zcd->n1 && n != zcd->n1)\n+ nb_rx = rte_eth_rx_burst(portid, queueid, zcd->ptr2,\n+\t\t\t\t\t\t\tn - zcd->n1);\n+ /* Provide packets to the packet processing cores */\n+ rte_ring_enqueue_zc_finish(r, nb_rx);\n+ }\n+\n+Note that between ``_start_`` and ``_finish_`` no other thread can proceed\n+with enqueue(/dequeue) operation till ``_finish_`` completes.\n+\n References\n ----------\n \ndiff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst\nindex d8ac359e5..fdc78b3da 100644\n--- a/doc/guides/rel_notes/release_20_11.rst\n+++ b/doc/guides/rel_notes/release_20_11.rst\n@@ -55,6 +55,15 @@ New Features\n Also, make sure to start the actual text at the margin.\n =======================================================\n \n+* **Added zero copy APIs for rte_ring.**\n+\n+ For rings with producer/consumer in ``RTE_RING_SYNC_ST``, ``RTE_RING_SYNC_MT_HTS``\n+ modes, these APIs split enqueue/dequeue operation into three phases\n+ (enqueue/dequeue start, copy data to/from ring, enqueue/dequeue finish).\n+ Along with the advantages of the peek APIs, these provide the ability to\n+ copy the data to the ring memory directly without the need for temporary\n+ storage.\n+\n * **Added write combining store APIs.**\n \n Added ``rte_write32_wc`` and ``rte_write32_wc_relaxed`` APIs\n", "prefixes": [ "v5", "5/8" ] }