Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/77156/?format=api
{ "id": 77156, "url": "http://patches.dpdk.org/api/patches/77156/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20200910143609.986696-5-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://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": "<20200910143609.986696-5-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20200910143609.986696-5-bruce.richardson@intel.com", "date": "2020-09-10T14:36:06", "name": "[v3,4/7] rawdev: add private data length parameter to queue fns", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "4640d22a5910bab17cbf8a1eca6d42e40d7c8e35", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20200910143609.986696-5-bruce.richardson@intel.com/mbox/", "series": [ { "id": 12105, "url": "http://patches.dpdk.org/api/series/12105/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=12105", "date": "2020-09-10T14:36:02", "name": "Enhance rawdev APIs", "version": 3, "mbox": "http://patches.dpdk.org/series/12105/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/77156/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/77156/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 056B2A04B5;\n\tThu, 10 Sep 2020 16:37:17 +0200 (CEST)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 765AB1C0D1;\n\tThu, 10 Sep 2020 16:37:14 +0200 (CEST)", "from mga12.intel.com (mga12.intel.com [192.55.52.136])\n by dpdk.org (Postfix) with ESMTP id 7A4EE1BF8D\n for <dev@dpdk.org>; Thu, 10 Sep 2020 16:37:12 +0200 (CEST)", "from orsmga006.jf.intel.com ([10.7.209.51])\n by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 10 Sep 2020 07:37:11 -0700", "from silpixa00399126.ir.intel.com ([10.237.222.27])\n by orsmga006.jf.intel.com with ESMTP; 10 Sep 2020 07:37:05 -0700" ], "IronPort-SDR": [ "\n cTKyXmU35Wi3TZnw0lQ8qkOzQ3Le1kFpINuDLDHtpO8XNpQcUnU8WtA+DXB1QEWvjX6j7toaIi\n GhFbcJYOGxIQ==", "\n B81DGKzqGPmOlL+5tjBj39GM8pXsi1GmTLFwv3EhDn71yKty/Fn3Gx49BEB/hkeyHDaa1Zfa1e\n XXCgpEvrZADQ==" ], "X-IronPort-AV": [ "E=McAfee;i=\"6000,8403,9739\"; a=\"138058412\"", "E=Sophos;i=\"5.76,413,1592895600\"; d=\"scan'208\";a=\"138058412\"", "E=Sophos;i=\"5.76,413,1592895600\"; d=\"scan'208\";a=\"304900385\"" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "thomas@monjalon.net, Bruce Richardson <bruce.richardson@intel.com>,\n Nipun Gupta <nipun.gupta@nxp.com>, John McNamara <john.mcnamara@intel.com>,\n Marko Kovacevic <marko.kovacevic@intel.com>,\n Xiaoyun Li <xiaoyun.li@intel.com>, Jingjing Wu <jingjing.wu@intel.com>,\n Hemant Agrawal <hemant.agrawal@nxp.com>", "Date": "Thu, 10 Sep 2020 15:36:06 +0100", "Message-Id": "<20200910143609.986696-5-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.25.1", "In-Reply-To": "<20200910143609.986696-1-bruce.richardson@intel.com>", "References": "<20200709152047.167730-1-bruce.richardson@intel.com>\n <20200910143609.986696-1-bruce.richardson@intel.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH v3 4/7] rawdev: add private data length parameter\n\tto queue fns", "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": "The queue setup and queue defaults query functions take a void * parameter\nas configuration data, preventing any compile-time checking of the\nparameters and limiting runtime checks. Adding in the length of the\nexpected structure provides a measure of typechecking, and can also be used\nfor ABI compatibility in future, since ABI changes involving structs almost\nalways involve a change in size.\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\nAcked-by: Nipun Gupta <nipun.gupta@nxp.com>\n\n---\nV3: Added release note entry\n---\n doc/guides/rel_notes/release_20_11.rst | 1 +\n drivers/raw/ntb/ntb.c | 25 ++++++++++++++++-----\n drivers/raw/skeleton/skeleton_rawdev.c | 12 ++++++----\n drivers/raw/skeleton/skeleton_rawdev_test.c | 8 +++----\n examples/ntb/ntb_fwd.c | 3 ++-\n lib/librte_rawdev/rte_rawdev.c | 12 ++++++----\n lib/librte_rawdev/rte_rawdev.h | 10 +++++++--\n lib/librte_rawdev/rte_rawdev_pmd.h | 6 +++--\n 8 files changed, 54 insertions(+), 23 deletions(-)", "diff": "diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst\nindex 9543e7e98b..e79b88641b 100644\n--- a/doc/guides/rel_notes/release_20_11.rst\n+++ b/doc/guides/rel_notes/release_20_11.rst\n@@ -85,6 +85,7 @@ API Changes\n =======================================================\n \n * rawdev: Added a structure size parameter to the functions\n+ ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,\n ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,\n allowing limited driver type-checking and ABI compatibility.\n \ndiff --git a/drivers/raw/ntb/ntb.c b/drivers/raw/ntb/ntb.c\nindex 7f6b835a4b..ad10857991 100644\n--- a/drivers/raw/ntb/ntb.c\n+++ b/drivers/raw/ntb/ntb.c\n@@ -249,11 +249,15 @@ ntb_dev_intr_handler(void *param)\n static void\n ntb_queue_conf_get(struct rte_rawdev *dev,\n \t\t uint16_t queue_id,\n-\t\t rte_rawdev_obj_t queue_conf)\n+\t\t rte_rawdev_obj_t queue_conf,\n+\t\t size_t conf_size)\n {\n \tstruct ntb_queue_conf *q_conf = queue_conf;\n \tstruct ntb_hw *hw = dev->dev_private;\n \n+\tif (conf_size != sizeof(*q_conf))\n+\t\treturn;\n+\n \tq_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh;\n \tq_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc;\n \tq_conf->rx_mp = hw->rx_queues[queue_id]->mpool;\n@@ -294,12 +298,16 @@ ntb_rxq_release(struct ntb_rx_queue *rxq)\n static int\n ntb_rxq_setup(struct rte_rawdev *dev,\n \t uint16_t qp_id,\n-\t rte_rawdev_obj_t queue_conf)\n+\t rte_rawdev_obj_t queue_conf,\n+\t size_t conf_size)\n {\n \tstruct ntb_queue_conf *rxq_conf = queue_conf;\n \tstruct ntb_hw *hw = dev->dev_private;\n \tstruct ntb_rx_queue *rxq;\n \n+\tif (conf_size != sizeof(*rxq_conf))\n+\t\treturn -EINVAL;\n+\n \t/* Allocate the rx queue data structure */\n \trxq = rte_zmalloc_socket(\"ntb rx queue\",\n \t\t\t\t sizeof(struct ntb_rx_queue),\n@@ -375,13 +383,17 @@ ntb_txq_release(struct ntb_tx_queue *txq)\n static int\n ntb_txq_setup(struct rte_rawdev *dev,\n \t uint16_t qp_id,\n-\t rte_rawdev_obj_t queue_conf)\n+\t rte_rawdev_obj_t queue_conf,\n+\t size_t conf_size)\n {\n \tstruct ntb_queue_conf *txq_conf = queue_conf;\n \tstruct ntb_hw *hw = dev->dev_private;\n \tstruct ntb_tx_queue *txq;\n \tuint16_t i, prev;\n \n+\tif (conf_size != sizeof(*txq_conf))\n+\t\treturn -EINVAL;\n+\n \t/* Allocate the TX queue data structure. */\n \ttxq = rte_zmalloc_socket(\"ntb tx queue\",\n \t\t\t\t sizeof(struct ntb_tx_queue),\n@@ -439,7 +451,8 @@ ntb_txq_setup(struct rte_rawdev *dev,\n static int\n ntb_queue_setup(struct rte_rawdev *dev,\n \t\tuint16_t queue_id,\n-\t\trte_rawdev_obj_t queue_conf)\n+\t\trte_rawdev_obj_t queue_conf,\n+\t\tsize_t conf_size)\n {\n \tstruct ntb_hw *hw = dev->dev_private;\n \tint ret;\n@@ -447,11 +460,11 @@ ntb_queue_setup(struct rte_rawdev *dev,\n \tif (queue_id >= hw->queue_pairs)\n \t\treturn -EINVAL;\n \n-\tret = ntb_txq_setup(dev, queue_id, queue_conf);\n+\tret = ntb_txq_setup(dev, queue_id, queue_conf, conf_size);\n \tif (ret < 0)\n \t\treturn ret;\n \n-\tret = ntb_rxq_setup(dev, queue_id, queue_conf);\n+\tret = ntb_rxq_setup(dev, queue_id, queue_conf, conf_size);\n \n \treturn ret;\n }\ndiff --git a/drivers/raw/skeleton/skeleton_rawdev.c b/drivers/raw/skeleton/skeleton_rawdev.c\nindex 531d0450c8..801c707fb9 100644\n--- a/drivers/raw/skeleton/skeleton_rawdev.c\n+++ b/drivers/raw/skeleton/skeleton_rawdev.c\n@@ -222,14 +222,16 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)\n \n static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,\n \t\t\t\t\t uint16_t queue_id,\n-\t\t\t\t\t rte_rawdev_obj_t queue_conf)\n+\t\t\t\t\t rte_rawdev_obj_t queue_conf,\n+\t\t\t\t\t size_t conf_size)\n {\n \tstruct skeleton_rawdev *skeldev;\n \tstruct skeleton_rawdev_queue *skelq;\n \n \tSKELETON_PMD_FUNC_TRACE();\n \n-\tif (!dev || !queue_conf)\n+\tif (!dev || !queue_conf ||\n+\t\t\tconf_size != sizeof(struct skeleton_rawdev_queue))\n \t\treturn;\n \n \tskeldev = skeleton_rawdev_get_priv(dev);\n@@ -252,7 +254,8 @@ clear_queue_bufs(int queue_id)\n \n static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,\n \t\t\t\t uint16_t queue_id,\n-\t\t\t\t rte_rawdev_obj_t queue_conf)\n+\t\t\t\t rte_rawdev_obj_t queue_conf,\n+\t\t\t\t size_t conf_size)\n {\n \tint ret = 0;\n \tstruct skeleton_rawdev *skeldev;\n@@ -260,7 +263,8 @@ static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,\n \n \tSKELETON_PMD_FUNC_TRACE();\n \n-\tif (!dev || !queue_conf)\n+\tif (!dev || !queue_conf ||\n+\t\t\tconf_size != sizeof(struct skeleton_rawdev_queue))\n \t\treturn -EINVAL;\n \n \tskeldev = skeleton_rawdev_get_priv(dev);\ndiff --git a/drivers/raw/skeleton/skeleton_rawdev_test.c b/drivers/raw/skeleton/skeleton_rawdev_test.c\nindex 7dc7c76847..bb4b6efe40 100644\n--- a/drivers/raw/skeleton/skeleton_rawdev_test.c\n+++ b/drivers/raw/skeleton/skeleton_rawdev_test.c\n@@ -185,7 +185,7 @@ test_rawdev_queue_default_conf_get(void)\n \t * depth = DEF_DEPTH\n \t */\n \tfor (i = 0; i < rdev_conf_get.num_queues; i++) {\n-\t\trte_rawdev_queue_conf_get(test_dev_id, i, &q);\n+\t\trte_rawdev_queue_conf_get(test_dev_id, i, &q, sizeof(q));\n \t\tRTE_TEST_ASSERT_EQUAL(q.depth, SKELETON_QUEUE_DEF_DEPTH,\n \t\t\t\t \"Invalid default depth of queue (%d)\",\n \t\t\t\t q.depth);\n@@ -235,11 +235,11 @@ test_rawdev_queue_setup(void)\n \t/* Modify the queue depth for Queue 0 and attach it */\n \tqset.depth = 15;\n \tqset.state = SKELETON_QUEUE_ATTACH;\n-\tret = rte_rawdev_queue_setup(test_dev_id, 0, &qset);\n+\tret = rte_rawdev_queue_setup(test_dev_id, 0, &qset, sizeof(qset));\n \tRTE_TEST_ASSERT_SUCCESS(ret, \"Failed to setup queue (%d)\", ret);\n \n \t/* Now, fetching the queue 0 should show depth as 15 */\n-\tret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget);\n+\tret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget, sizeof(qget));\n \tRTE_TEST_ASSERT_SUCCESS(ret, \"Failed to get queue config (%d)\", ret);\n \n \tRTE_TEST_ASSERT_EQUAL(qset.depth, qget.depth,\n@@ -263,7 +263,7 @@ test_rawdev_queue_release(void)\n \tRTE_TEST_ASSERT_SUCCESS(ret, \"Failed to release queue 0; (%d)\", ret);\n \n \t/* Now, fetching the queue 0 should show depth as default */\n-\tret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget);\n+\tret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget, sizeof(qget));\n \tRTE_TEST_ASSERT_SUCCESS(ret, \"Failed to get queue config (%d)\", ret);\n \n \tRTE_TEST_ASSERT_EQUAL(qget.depth, SKELETON_QUEUE_DEF_DEPTH,\ndiff --git a/examples/ntb/ntb_fwd.c b/examples/ntb/ntb_fwd.c\nindex 656f736594..5a8439b8d3 100644\n--- a/examples/ntb/ntb_fwd.c\n+++ b/examples/ntb/ntb_fwd.c\n@@ -1411,7 +1411,8 @@ main(int argc, char **argv)\n \tntb_q_conf.rx_mp = mbuf_pool;\n \tfor (i = 0; i < num_queues; i++) {\n \t\t/* Setup rawdev queue */\n-\t\tret = rte_rawdev_queue_setup(dev_id, i, &ntb_q_conf);\n+\t\tret = rte_rawdev_queue_setup(dev_id, i, &ntb_q_conf,\n+\t\t\t\tsizeof(ntb_q_conf));\n \t\tif (ret < 0)\n \t\t\trte_exit(EXIT_FAILURE,\n \t\t\t\t\"Failed to setup ntb queue %u.\\n\", i);\ndiff --git a/lib/librte_rawdev/rte_rawdev.c b/lib/librte_rawdev/rte_rawdev.c\nindex 6c4d783cc5..f48d8cf10b 100644\n--- a/lib/librte_rawdev/rte_rawdev.c\n+++ b/lib/librte_rawdev/rte_rawdev.c\n@@ -137,7 +137,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,\n int\n rte_rawdev_queue_conf_get(uint16_t dev_id,\n \t\t\t uint16_t queue_id,\n-\t\t\t rte_rawdev_obj_t queue_conf)\n+\t\t\t rte_rawdev_obj_t queue_conf,\n+\t\t\t size_t queue_conf_size)\n {\n \tstruct rte_rawdev *dev;\n \n@@ -145,14 +146,16 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,\n \tdev = &rte_rawdevs[dev_id];\n \n \tRTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_def_conf, -ENOTSUP);\n-\t(*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf);\n+\t(*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf,\n+\t\t\tqueue_conf_size);\n \treturn 0;\n }\n \n int\n rte_rawdev_queue_setup(uint16_t dev_id,\n \t\t uint16_t queue_id,\n-\t\t rte_rawdev_obj_t queue_conf)\n+\t\t rte_rawdev_obj_t queue_conf,\n+\t\t size_t queue_conf_size)\n {\n \tstruct rte_rawdev *dev;\n \n@@ -160,7 +163,8 @@ rte_rawdev_queue_setup(uint16_t dev_id,\n \tdev = &rte_rawdevs[dev_id];\n \n \tRTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_setup, -ENOTSUP);\n-\treturn (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);\n+\treturn (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf,\n+\t\t\tqueue_conf_size);\n }\n \n int\ndiff --git a/lib/librte_rawdev/rte_rawdev.h b/lib/librte_rawdev/rte_rawdev.h\nindex 1720f1dd6b..14e8eb972f 100644\n--- a/lib/librte_rawdev/rte_rawdev.h\n+++ b/lib/librte_rawdev/rte_rawdev.h\n@@ -146,6 +146,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,\n * previously supplied to rte_rawdev_configure().\n * @param[out] queue_conf\n * The pointer to the default raw queue configuration data.\n+ * @param queue_conf_size\n+ * The size of the structure pointed to by queue_conf\n * @return\n * - 0: Success, driver updates the default raw queue configuration data.\n * - <0: Error code returned by the driver info get function.\n@@ -156,7 +158,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,\n int\n rte_rawdev_queue_conf_get(uint16_t dev_id,\n \t\t\t uint16_t queue_id,\n-\t\t\t rte_rawdev_obj_t queue_conf);\n+\t\t\t rte_rawdev_obj_t queue_conf,\n+\t\t\t size_t queue_conf_size);\n \n /**\n * Allocate and set up a raw queue for a raw device.\n@@ -169,6 +172,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,\n * @param queue_conf\n * The pointer to the configuration data to be used for the raw queue.\n * NULL value is allowed, in which case default configuration\tused.\n+ * @param queue_conf_size\n+ * The size of the structure pointed to by queue_conf\n *\n * @see rte_rawdev_queue_conf_get()\n *\n@@ -179,7 +184,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,\n int\n rte_rawdev_queue_setup(uint16_t dev_id,\n \t\t uint16_t queue_id,\n-\t\t rte_rawdev_obj_t queue_conf);\n+\t\t rte_rawdev_obj_t queue_conf,\n+\t\t size_t queue_conf_size);\n \n /**\n * Release and deallocate a raw queue from a raw device.\ndiff --git a/lib/librte_rawdev/rte_rawdev_pmd.h b/lib/librte_rawdev/rte_rawdev_pmd.h\nindex 050f8b0292..34eb667f62 100644\n--- a/lib/librte_rawdev/rte_rawdev_pmd.h\n+++ b/lib/librte_rawdev/rte_rawdev_pmd.h\n@@ -218,7 +218,8 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);\n */\n typedef void (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,\n \t\t\t\t\tuint16_t queue_id,\n-\t\t\t\t\trte_rawdev_obj_t queue_conf);\n+\t\t\t\t\trte_rawdev_obj_t queue_conf,\n+\t\t\t\t\tsize_t queue_conf_size);\n \n /**\n * Setup an raw queue.\n@@ -235,7 +236,8 @@ typedef void (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,\n */\n typedef int (*rawdev_queue_setup_t)(struct rte_rawdev *dev,\n \t\t\t\t uint16_t queue_id,\n-\t\t\t\t rte_rawdev_obj_t queue_conf);\n+\t\t\t\t rte_rawdev_obj_t queue_conf,\n+\t\t\t\t size_t queue_conf_size);\n \n /**\n * Release resources allocated by given raw queue.\n", "prefixes": [ "v3", "4/7" ] }