Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/138471/?format=api
{ "id": 138471, "url": "https://patches.dpdk.org/api/patches/138471/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20240318184553.2770394-1-amitprakashs@marvell.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": "<20240318184553.2770394-1-amitprakashs@marvell.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240318184553.2770394-1-amitprakashs@marvell.com", "date": "2024-03-18T18:45:52", "name": "[v2] doc: add dma perf feature details", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "fe06267df86b8c091e2337d321e4c819cb135595", "submitter": { "id": 2699, "url": "https://patches.dpdk.org/api/people/2699/?format=api", "name": "Amit Prakash Shukla", "email": "amitprakashs@marvell.com" }, "delegate": { "id": 1, "url": "https://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20240318184553.2770394-1-amitprakashs@marvell.com/mbox/", "series": [ { "id": 31550, "url": "https://patches.dpdk.org/api/series/31550/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=31550", "date": "2024-03-18T18:45:52", "name": "[v2] doc: add dma perf feature details", "version": 2, "mbox": "https://patches.dpdk.org/series/31550/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/138471/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/138471/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 mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id D8A4C43CE8;\n\tMon, 18 Mar 2024 19:46:02 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 67AAF40289;\n\tMon, 18 Mar 2024 19:46:02 +0100 (CET)", "from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com\n [67.231.156.173])\n by mails.dpdk.org (Postfix) with ESMTP id 0F55A4027F\n for <dev@dpdk.org>; Mon, 18 Mar 2024 19:45:59 +0100 (CET)", "from pps.filterd (m0045851.ppops.net [127.0.0.1])\n by mx0b-0016f401.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id\n 42I9m6Ue010310; Mon, 18 Mar 2024 11:45:59 -0700", "from dc6wp-exch02.marvell.com ([4.21.29.225])\n by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3wxka4spfk-1\n (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT);\n Mon, 18 Mar 2024 11:45:59 -0700 (PDT)", "from DC6WP-EXCH02.marvell.com (10.76.176.209) by\n DC6WP-EXCH02.marvell.com (10.76.176.209) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id\n 15.2.1258.32; Mon, 18 Mar 2024 11:45:58 -0700", "from maili.marvell.com (10.69.176.80) by DC6WP-EXCH02.marvell.com\n (10.76.176.209) with Microsoft SMTP Server id 15.2.1258.32 via Frontend\n Transport; Mon, 18 Mar 2024 11:45:58 -0700", "from cavium-OptiPlex-5090-BM14.. (unknown [10.28.36.157])\n by maili.marvell.com (Postfix) with ESMTP id BC2803F7041;\n Mon, 18 Mar 2024 11:45:55 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=\n from:to:cc:subject:date:message-id:in-reply-to:references\n :mime-version:content-transfer-encoding:content-type; s=\n pfpt0220; bh=7A5q0RqN+E/wkw1lBhux7rGKlHZVUTjWd9YZ4SE+qmI=; b=dlv\n 7+pWXRya/FZfSO9nOwLsia7zLjvQTgdMWWbFyIs6Ptl+bo7tYOEX3+vTS0y94Cwm\n KHVBi0oob1Nymi++7yw654LbUqdXGjxaD7j0U08fOJF7EaNFAUyzIn8OspaVdexm\n sinE2S5yX4LbfMSZctFpmsGiKHplmL6LDE/SxwxK71GAIQyYvA8lcDfmd9yjoaLu\n Q8oSovfSy1nOPHyPlxvtWntfAgtageqxLAJZtFsGVifXEmqKlTTn7s9tPzRFCfkA\n FYe33yIOvHmlPNiHds72hFf0L+WGKBMSe4A5hb3vYV16nBHpMUQFlcwIVXpsqmTA\n sJVrU4SCBdNs+9lyMTQ==", "From": "Amit Prakash Shukla <amitprakashs@marvell.com>", "To": "Cheng Jiang <honest.jiang@foxmail.com>, Chengwen Feng\n <fengchengwen@huawei.com>", "CC": "<dev@dpdk.org>, <jerinj@marvell.com>, <vattunuru@marvell.com>,\n <anoobj@marvell.com>, <gmuthukrishn@marvell.com>, Amit Prakash Shukla\n <amitprakashs@marvell.com>", "Subject": "[PATCH v2] doc: add dma perf feature details", "Date": "Tue, 19 Mar 2024 00:15:52 +0530", "Message-ID": "<20240318184553.2770394-1-amitprakashs@marvell.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240318181730.2725829-1-amitprakashs@marvell.com>", "References": "<20240318181730.2725829-1-amitprakashs@marvell.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Content-Type": "text/plain", "X-Proofpoint-GUID": "z4eGd8KyeLDYDAgeVF8SOP6JWrCJhXoh", "X-Proofpoint-ORIG-GUID": "z4eGd8KyeLDYDAgeVF8SOP6JWrCJhXoh", "X-Proofpoint-Virus-Version": "vendor=baseguard\n engine=ICAP:2.0.272,Aquarius:18.0.1011,Hydra:6.0.619,FMLib:17.11.176.26\n definitions=2024-03-18_12,2024-03-18_03,2023-05-22_02", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "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" }, "content": "Update dma perf test document with below support features:\n1. Memory-to-device and device-to-memory copy.\n2. Skip support.\n3. Scatter-gather support.\n\nSigned-off-by: Amit Prakash Shukla <amitprakashs@marvell.com>\n---\nv2:\n- Rebased the patch.\n\n doc/guides/tools/dmaperf.rst | 89 ++++++++++++++++++++++++++----------\n 1 file changed, 64 insertions(+), 25 deletions(-)", "diff": "diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst\nindex 6f85fceb8a..dadcc97530 100644\n--- a/doc/guides/tools/dmaperf.rst\n+++ b/doc/guides/tools/dmaperf.rst\n@@ -5,27 +5,23 @@ dpdk-test-dma-perf Application\n ==============================\n \n The ``dpdk-test-dma-perf`` tool is a Data Plane Development Kit (DPDK) application\n-that enables testing the performance of DMA (Direct Memory Access) devices available within DPDK.\n-It provides a test framework to assess the performance of CPU and DMA devices\n-under various scenarios, such as varying buffer lengths.\n-Doing so provides insight into the potential performance\n-when using these DMA devices for acceleration in DPDK applications.\n+that evaluates the performance of DMA (Direct Memory Access) devices accessible in DPDK environment.\n+It provides a benchmark framework to assess the performance of CPU and DMA devices\n+under various combinations, such as varying buffer lengths, scatter-gather copy, copying in remote\n+memory etc. It helps in evaluating performance of DMA device as hardware acceleration vehicle in\n+DPDK application.\n \n-It supports memory copy performance tests for now,\n-comparing the performance of CPU and DMA automatically in various conditions\n-with the help of a pre-set configuration file.\n+In addition, this tool supports memory-to-memory, memory-to-device and device-to-memory copy tests,\n+to compare the performance of CPU and DMA capabilities under various conditions with the help of a\n+pre-set configuration file.\n \n \n Configuration\n -------------\n \n-This application uses inherent DPDK EAL command-line options\n-as well as custom command-line options in the application.\n-An example configuration file for the application is provided\n-and gives the meanings for each parameter.\n-\n-Here is an extracted sample from the configuration file\n-(the complete sample can be found in the application source directory):\n+Along with EAL command-line arguments, this application supports various parameters for the\n+benchmarking through a configuration file. An example configuration file is provided below along\n+with the application to demonstrate all the parameters.\n \n .. code-block:: ini\n \n@@ -53,14 +49,35 @@ Here is an extracted sample from the configuration file\n lcore = 3, 4\n eal_args=--in-memory --no-pci\n \n+ [case3]\n+ skip=1\n+ type=DMA_MEM_COPY\n+ direction=mem2dev\n+ vchan_dev=raddr=0x200000000,coreid=1,pfid=2,vfid=3\n+ dma_src_sge=4\n+ dma_dst_sge=1\n+ mem_size=10\n+ buf_size=64,8192,2,MUL\n+ dma_ring_size=1024\n+ kick_batch=32\n+ src_numa_node=0\n+ dst_numa_node=0\n+ cache_flush=0\n+ test_seconds=2\n+ lcore_dma=lcore10@0000:00:04.2, lcore11@0000:00:04.3\n+ eal_args=--in-memory --file-prefix=test\n+\n The configuration file is divided into multiple sections, each section represents a test case.\n-The four variables ``mem_size``, ``buf_size``, ``dma_ring_size``, and ``kick_batch``\n-can vary in each test case.\n-The format for this is ``variable=first,last,increment,ADD|MUL``.\n-This means that the first value of the variable is 'first',\n-the last value is 'last',\n-'increment' is the step size,\n-and 'ADD|MUL' indicates whether the change is by addition or multiplication.\n+The four mandatory variables ``mem_size``, ``buf_size``, ``dma_ring_size``, and ``kick_batch``\n+can vary in each test case. The format for this is ``variable=first,last,increment,ADD|MUL``.\n+This means that the first value of the variable is 'first', the last value is 'last',\n+'increment' is the step size, and 'ADD|MUL' indicates whether the change is by addition or\n+multiplication.\n+\n+The variables for mem2dev and dev2mem copy are ``direction``, ``vchan_dev`` and can vary in each\n+test case. If the direction is not configured, the default is mem2mem copy.\n+\n+For scatter-gather copy test ``dma_src_sge``, ``dma_dst_sge`` must be configured.\n \n Each case can only have one variable change,\n and each change will generate a scenario, so each case can have multiple scenarios.\n@@ -69,10 +86,32 @@ and each change will generate a scenario, so each case can have multiple scenari\n Configuration Parameters\n ~~~~~~~~~~~~~~~~~~~~~~~~\n \n+``skip``\n+ To skip a test-case, must be configured as ``1``\n+\n ``type``\n The type of the test.\n Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``.\n \n+``direction``\n+ The direction of data transfer.\n+ Currently supported directions:\n+\n+ * ``mem2mem`` - memory to memory copy\n+\n+ * ``mem2dev`` - memory to device copy\n+\n+ * ``dev2mem`` - device to memory copy\n+\n+``vchan_dev``\n+ Comma separated bus related parameters for ``mem2dev`` and ``dev2mem`` copy.\n+\n+``dma_src_sge``\n+ Number of source segments for scatter-gather.\n+\n+``dma_dst_sge``\n+ Number of destination segments for scatter-gather.\n+\n ``mem_size``\n The size of the memory footprint in megabytes (MB) for source and destination.\n \n@@ -131,6 +170,6 @@ with the same name as the configuration file with the addition of ``_result.csv`\n Limitations\n -----------\n \n-Currently, this tool only supports memory copy performance tests.\n-Additional enhancements are possible in the future\n-to support more types of tests for DMA devices and CPUs.\n+DMA copy to/from remote memory address has following limitations:\n+\n+ * ``vchan_dev`` config will be same for all the configured DMA devices.\n", "prefixes": [ "v2" ] }