Enhance rawdev APIs
cover Enhance rawdev APIs
This patchset proposes some internal and externally-visible changes to the rawdev API. If consensus is in favour, I will submit a deprecation notice for the changes for the 20.08 release, so that these ABI/API-breaking changes can be merged in 20.11
The changes are in two areas:
* For any APIs which take a void * parameter for driver-specific structs, add an additional parameter to provide the struct length. This allows some runtime type-checking, as well as possible ABI-compatibility support in the future as structure change generally involve a change in the size of the structure.
* Ensure all APIs which can return error values have int type, rather than void. Since functions like info_get and queue_default_get can now do some typechecking, they need to be modified to allow them to return error codes on failure.
Bruce Richardson (5):
rawdev: add private data length parameter to info fn
rawdev: allow drivers to return error from info function
rawdev: add private data length parameter to config fn
rawdev: add private data length parameter to queue fns
rawdev: allow queue default config query to return error
drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 23 +++++----- drivers/raw/ioat/ioat_rawdev.c | 17 ++++--- drivers/raw/ioat/ioat_rawdev_test.c | 6 +-- drivers/raw/ntb/ntb.c | 49 ++++++++++++++++----- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 +-- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 +- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 +-- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 34 ++++++++------ drivers/raw/skeleton/skeleton_rawdev_test.c | 32 ++++++++------ examples/ioat/ioatfwd.c | 4 +- examples/ntb/ntb_fwd.c | 7 +-- lib/librte_rawdev/rte_rawdev.c | 27 +++++++----- lib/librte_rawdev/rte_rawdev.h | 27 ++++++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 22 ++++++--- 16 files changed, 178 insertions(+), 91 deletions(-)
Signature · 1 line
2.25.1
PATCH 1/5 rawdev: add private data length parameter to info fn
Currently with the rawdev API there is no way to check that the structure passed in via the dev_private pointer in the dev_info structure is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
--- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 4 ++-- drivers/raw/ntb/ntb.c | 8 +++++++- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 19 ++++++++++++------- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 9 ++++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 5 ++++- 12 files changed, 49 insertions(+), 23 deletions(-)
drivers/bus/ifpga/ifpga_bus.c +1 -1
@@ -162,7 +162,7 @@ ifpga_scan_one(struct rte_rawdev *rawdev, afu_dev->id.port = afu_pr_conf.afu_id.port;if (rawdev->dev_ops && rawdev->dev_ops->dev_info_get) - rawdev->dev_ops->dev_info_get (rawdev, afu_dev); + rawdev->dev_ops->dev_info_get (rawdev, afu_dev,sizeof (*afu_dev)); if (rawdev->dev_ops && rawdev->dev_ops->dev_start &&
drivers/raw/ifpga/ifpga_rawdev.c +3 -2
@@ -605,7 +605,8 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,static void ifpga_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct opae_adapter *adapter;struct opae_accelerator *acc;
@@ -617,7 +618,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,IFPGA_RAWDEV_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" );return ; }
drivers/raw/ioat/ioat_rawdev.c +3 -2
@@ -113,12 +113,13 @@ ioat_dev_stop(struct rte_rawdev *dev) }static void -ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL ) +if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) cfg->ring_size = ioat->ring_size; }
drivers/raw/ioat/ioat_rawdev_test.c +2 -2
@@ -157,7 +157,7 @@ ioat_rawdev_test(uint16_t dev_id)return TEST_SKIPPED ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size != expected_ring_size[dev_id]) {printf ("Error, initial ring size is not as expected (Actual: %d, Expected: %d)\n" , (int )p.ring_size, expected_ring_size[dev_id]);
@@ -169,7 +169,7 @@ ioat_rawdev_test(uint16_t dev_id)printf ("Error with rte_rawdev_configure()\n" );return -1 ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size !=IOAT_TEST_RINGSIZE ) {printf ("Error, ring size is not %d (%d)\n" ,IOAT_TEST_RINGSIZE , (int )p.ring_size);
drivers/raw/ntb/ntb.c +7 -1
@@ -801,11 +801,17 @@ ntb_dequeue_bufs(struct rte_rawdev *dev, }static void -ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct ntb_hw *hw = dev->dev_private;struct ntb_dev_info *info = dev_info; +if (dev_info_size !=sizeof (*info)){ +NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); +return ; + } + info->mw_cnt = hw->mw_cnt; info->mw_size = hw->mw_size;
drivers/raw/skeleton/skeleton_rawdev.c +3 -2
@@ -42,14 +42,15 @@ static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES] = {};static void clear_queue_bufs (int queue_id);static void skeleton_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;SKELETON_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" );return ; }
drivers/raw/skeleton/skeleton_rawdev_test.c +12 -7
@@ -106,12 +106,12 @@ test_rawdev_info_get(void)struct rte_rawdev_info rdev_info = {0 };struct skeleton_rawdev_conf skel_conf = {0 }; - ret =rte_rawdev_info_get (test_dev_id,NULL ); + ret =rte_rawdev_info_get (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Expected -EINVAL, %d" , ret); rdev_info.dev_private = &skel_conf; - ret =rte_rawdev_info_get (test_dev_id, &rdev_info); + ret =rte_rawdev_info_get (test_dev_id, &rdev_info,sizeof (skel_conf));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get raw dev info" );return TEST_SUCCESS ;
@@ -142,7 +142,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -170,7 +171,8 @@ test_rawdev_queue_default_conf_get(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -218,7 +220,8 @@ test_rawdev_queue_setup(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -327,7 +330,8 @@ test_rawdev_start_stop(void) dummy_firmware =NULL ;rte_rawdev_start (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -336,7 +340,8 @@ test_rawdev_start_stop(void) rdev_conf_get.device_state);rte_rawdev_stop (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
examples/ioat/ioatfwd.c +1 -1
@@ -757,7 +757,7 @@ assign_rawdevs(void)do {if (rdev_id ==rte_rawdev_count ()) goto end; -rte_rawdev_info_get (rdev_id++, &rdev_info); +rte_rawdev_info_get (rdev_id++, &rdev_info,0 ); }while (rdev_info.driver_name ==NULL ||strcmp (rdev_info.driver_name,IOAT_PMD_RAWDEV_NAME_STR ) !=0 );
examples/ntb/ntb_fwd.c +1 -1
@@ -1389,7 +1389,7 @@ main(int argc, char **argv)rte_rawdev_set_attr (dev_id,NTB_QUEUE_NUM_NAME , num_queues);printf ("Set queue number as %u.\n" , num_queues); ntb_rawdev_info.dev_private = (rte_rawdev_obj_t)(&ntb_info); -rte_rawdev_info_get (dev_id, &ntb_rawdev_info); +rte_rawdev_info_get (dev_id, &ntb_rawdev_info,sizeof (ntb_info)); nb_mbuf = nb_desc * num_queues *2 *2 +rte_lcore_count () *MEMPOOL_CACHE_SIZE ;
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -78,7 +78,8 @@ rte_rawdev_socket_id(uint16_t dev_id) }int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info) +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size) {struct rte_rawdev *rawdev;
@@ -89,7 +90,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops->dev_info_get, -ENOTSUP ); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private); + (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private, + dev_private_size); } dev_info->driver_name = rawdev->driver_name;
lib/librte_rawdev/rte_rawdev.h +8 -1
@@ -82,13 +82,20 @@ struct rte_rawdev_info;* will be returned. This can be used to safely query the type of a rawdev * instance without needing to know the size of the private data to return. * +* @param dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* returned, and may be checked by drivers to ensure the expected struct +* type is provided. +* * @return * - 0: Success, driver updates the contextual information of the raw device * - <0: Error code returned by the driver info get function. * */ int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info); +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size);/** * Configure a raw device.
lib/librte_rawdev/rte_rawdev_pmd.h +4 -1
@@ -138,12 +138,15 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* Raw device pointer * @param dev_info * Raw device information structure +* @param dev_private_size +* The size of the structure pointed to by dev_info->dev_private * * @return * Returns 0 on success */ typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info); +rte_rawdev_obj_t dev_info, +size_t dev_private_size);/** * Configure a device.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 20.11 1/5] rawdev: add private data length parameter to info fn
Hi,
Quoted 346 lines
-----Original Message-----
From: Richardson, Bruce <[email protected]>
Sent: Thursday, July 09, 2020 23:21
To: Nipun Gupta <[email protected]>; Hemant Agrawal <[email protected]>
Cc: [email protected]; Xu, Rosen <[email protected]>; Zhang, Tianfei <[email protected]>; Li, Xiaoyun <[email protected]>; Wu, Jingjing <[email protected]>; Satha Rao <[email protected]>; Mahipal Challa <[email protected]>; Jerin Jacob <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH 20.11 1/5] rawdev: add private data length parameter to info fnCurrently with the rawdev API there is no way to check that the structure passed in via the
dev_privatepointer in thedev_infostructure is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.Signed-off-by Bruce Richardson <[email protected]>--- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 4 ++-- drivers/raw/ntb/ntb.c | 8 +++++++- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 19 ++++++++++++------- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 9 ++++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 5 ++++- 12 files changed, 49 insertions(+), 23 deletions(-)drivers/bus/ifpga/ifpga_bus.c +1
-1@@ -162,7 +162,7 @@ ifpga_scan_one(struct rte_rawdev *rawdev, afu_dev->id.port = afu_pr_conf.afu_id.port;if (rawdev->dev_ops && rawdev->dev_ops->dev_info_get) - rawdev->dev_ops->dev_info_get (rawdev, afu_dev); + rawdev->dev_ops->dev_info_get (rawdev, afu_dev,sizeof (*afu_dev)); if (rawdev->dev_ops &&drivers/bus/ifpga/ifpga_bus.c +0
-0rawdev->dev_ops->dev_start &&drivers/raw/ifpga/ifpga_rawdev.c +3
-2@@ -605,7 +605,8 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,static void ifpga_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct opae_adapter *adapter;struct opae_accelerator *acc;@@ -617,7 +618,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,IFPGA_RAWDEV_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" );return ; }drivers/raw/ioat/ioat_rawdev.c +3
-2@@ -113,12 +113,13 @@ ioat_dev_stop(struct rte_rawdev *dev) }static void -ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL ) +if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) cfg->ring_size = ioat->ring_size; }drivers/raw/ioat/ioat_rawdev_test.c +1
-1@@ -157,7 +157,7 @@ ioat_rawdev_test(uint16_t dev_id)return TEST_SKIPPED ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size != expected_ring_size[dev_id]) { printf("Error, initial ring size is not as expected (Actual: %d, Expected: %d)\n",drivers/raw/ioat/ioat_rawdev_test.c +1
-1(int)p.ring_size, expected_ring_size[dev_id]);@@ -169,7 +169,7 @@ ioat_rawdev_test(uint16_t dev_id)printf ("Error with rte_rawdev_configure()\n" );return -1 ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size !=IOAT_TEST_RINGSIZE ) {printf ("Error, ring size is not %d (%d)\n" ,IOAT_TEST_RINGSIZE , (int )p.ring_size); diff --git
a/drivers/raw/ntb/ntb.cb/drivers/raw/ntb/ntb.cindexe40412bb7..4676c6f8f100644drivers/raw/ntb/ntb.c +7
-1@@ -801,11 +801,17 @@ ntb_dequeue_bufs(struct rte_rawdev *dev, }static void -ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct ntb_hw *hw = dev->dev_private;struct ntb_dev_info *info = dev_info; +if (dev_info_size !=sizeof (*info)){ +NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); +return ; + } + info->mw_cnt = hw->mw_cnt; info->mw_size = hw->mw_size;drivers/raw/skeleton/skeleton_rawdev.c +0
-0@@ -42,14 +42,15 @@ static struct queue_buffersqueue_buf[SKELETON_MAX_QUEUES] = {}; static void
clear_queue_bufs(int queue_id);static void skeleton_rawdev_info_get(struct
rte_rawdev*dev,drivers/raw/skeleton/skeleton_rawdev.c +3
-2- rte_rawdev_obj_t dev_info) + rte_rawdev_obj_t dev_info, + size_t dev_info_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;SKELETON_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" );return ; }drivers/raw/skeleton/skeleton_rawdev_test.c +2
-2@@ -106,12 +106,12 @@ test_rawdev_info_get(void)struct rte_rawdev_info rdev_info = {0 };struct skeleton_rawdev_conf skel_conf = {0 }; - ret =rte_rawdev_info_get (test_dev_id,NULL ); + ret =rte_rawdev_info_get (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Expected -EINVAL, %d" , ret); rdev_info.dev_private = &skel_conf; - ret =rte_rawdev_info_get (test_dev_id, &rdev_info); + ret =rte_rawdev_info_get (test_dev_id, &rdev_info,sizeof (skel_conf));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get raw dev info" );drivers/raw/skeleton/skeleton_rawdev_test.c +8
-4return TEST_SUCCESS ;@@ -142,7 +142,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);@@ -170,7 +171,8 @@ test_rawdev_queue_default_conf_get(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get)); RTE_TEST_ASSERT_SUCCESS(ret, "Failed to obtain rawdev configuration (%d)", ret);@@ -218,7 +220,8 @@ test_rawdev_queue_setup(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);@@ -327,7 +330,8 @@ test_rawdev_start_stop(void) dummy_firmware =NULL ;rte_rawdev_start (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get)); RTE_TEST_ASSERT_SUCCESS(ret,drivers/raw/skeleton/skeleton_rawdev_test.c +2
-1"Failed to obtain rawdev configuration (%d)" , ret);@@ -336,7 +340,8 @@ test_rawdev_start_stop(void) rdev_conf_get.device_state);rte_rawdev_stop (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get)); RTE_TEST_ASSERT_SUCCESS(ret,drivers/raw/skeleton/skeleton_rawdev_test.c +0
-0"Failed to obtain rawdev configuration (%d)" , ret);examples/ioat/ioatfwd.c index renamed from examples/ioat/ioatfwd.c +0
-0
b66ee73bc..5c631da1b100644examples/ioat/ioatfwd.c +1
-1@@ -757,7 +757,7 @@ assign_rawdevs(void) do { if (rdev_id == rte_rawdev_count()) goto end; - rte_rawdev_info_get(rdev_id++, &rdev_info); + rte_rawdev_info_get(rdev_id++, &rdev_info, 0); } while (rdev_info.driver_name == NULL ||strcmp(rdev_info.driver_name,
IOAT_PMD_RAWDEV_NAME_STR) != 0);examples/ntb/ntb_fwd.c index renamed from examples/ntb/ntb_fwd.c +0
-0
eba8ebf9f..11e224451100644examples/ntb/ntb_fwd.c +1
-1@@ -1389,7 +1389,7 @@ main(int argc, char **argv)rte_rawdev_set_attr (dev_id,NTB_QUEUE_NUM_NAME , num_queues);printf ("Set queue number as %u.\n" , num_queues); ntb_rawdev_info.dev_private = (rte_rawdev_obj_t)(&ntb_info); -rte_rawdev_info_get (dev_id, &ntb_rawdev_info); +rte_rawdev_info_get (dev_id, &ntb_rawdev_info,sizeof (ntb_info)); nb_mbuf = nb_desc * num_queues * 2 * 2 + rte_lcore_count() *examples/ntb/ntb_fwd.c +0
-0MEMPOOL_CACHE_SIZE ;lib/librte_rawdev/rte_rawdev.c +3
-2@@ -78,7 +78,8 @@ rte_rawdev_socket_id(uint16_t dev_id) }int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info) +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size) {struct rte_rawdev *rawdev;@@ -89,7 +90,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops- >dev_info_get, -ENOTSUP); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info- >dev_private); + (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info-Quoted 1 line
dev_private,lib/librte_rawdev/rte_rawdev.c +1
-0+ dev_private_size); } dev_info->driver_name = rawdev->driver_name; diff --git
a/lib/librte_rawdev/rte_rawdev.hb/lib/librte_rawdev/rte_rawdev.hindex32f6b8bb0..cf6acfd26100644lib/librte_rawdev/rte_rawdev.h +8
-1@@ -82,13 +82,20 @@ struct rte_rawdev_info;* will be returned. This can be used to safely query the type of a rawdev * instance without needing to know the size of the private data to return. * +* @param dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* returned, and may be checked by drivers to ensure the expected struct +* type is provided. +* * @return * - 0: Success, driver updates the contextual information of the raw device * - <0: Error code returned by the driver info get function. * */ int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info); +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size);/** * Configure a raw device. lib/librte_rawdev/rte_rawdev_pmd.h +4
-2@@ -138,12 +138,15 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* Raw device pointer * @param dev_info * Raw device information structure +* @param dev_private_size +* The size of the structure pointed to by dev_info->dev_private * * @return * Returns 0 on success */ typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info); +rte_rawdev_obj_t dev_info, +size_t dev_private_size);/** * Configure a device. -- 2.25.1
PATCH 2/5 rawdev: allow drivers to return error from info function
In reply to Bruce RichardsonSince we now allow some parameter checking inside the driver info_get() functions, it makes sense to allow error return from those functions to the caller. Therefore we change the driver callback return type from void to int.
--- drivers/raw/ifpga/ifpga_rawdev.c | 15 ++++++++------- drivers/raw/ioat/ioat_rawdev.c | 9 ++++++--- drivers/raw/ntb/ntb.c | 8 +++++--- drivers/raw/skeleton/skeleton_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 ++-- 6 files changed, 29 insertions(+), 19 deletions(-)
drivers/raw/ifpga/ifpga_rawdev.c +8 -7
@@ -603,7 +603,7 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,return 0 ; } -static void +static int ifpga_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size)
@@ -620,12 +620,12 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } adapter =ifpga_rawdev_get_priv (dev);if (!adapter) -return ; +return -ENOENT ; afu_dev = dev_info; afu_dev->rawdev = dev;
@@ -637,7 +637,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (ifpga_fill_afu_dev (acc, afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("cannot get info\n" ); -return ; +return -ENOENT ; } }
@@ -647,21 +647,21 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,/* get LineSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,0 , &opae_lside_eth_info)) { -return ; +return -ENOENT ; } lside_bar_idx = opae_lside_eth_info.mem_idx;/* get NICSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,1 , &opae_nside_eth_info)) { -return ; +return -ENOENT ; } nside_bar_idx = opae_nside_eth_info.mem_idx;if (lside_bar_idx >=PCI_MAX_RESOURCE || nside_bar_idx >=PCI_MAX_RESOURCE || lside_bar_idx == nside_bar_idx) -return ; +return -ENOENT ;/* fill LineSide BAR Index */ afu_dev->mem_resource[lside_bar_idx].phys_addr =
@@ -679,6 +679,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev, afu_dev->mem_resource[nside_bar_idx].addr = opae_nside_eth_info.addr; } +return 0 ; } static int
drivers/raw/ioat/ioat_rawdev.c +6 -3
@@ -112,15 +112,18 @@ ioat_dev_stop(struct rte_rawdev *dev)RTE_SET_USED (dev); } -static void +static int ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) - cfg->ring_size = ioat->ring_size; +if (dev_info ==NULL || dev_info_size !=sizeof (*cfg)) +return -EINVAL ; + + cfg->ring_size = ioat->ring_size; +return 0 ; }static const char *const xstat_names[] = {
drivers/raw/ntb/ntb.c +5 -3
@@ -800,7 +800,7 @@ ntb_dequeue_bufs(struct rte_rawdev *dev,return nb_rx; } -static void +static int ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {
@@ -809,7 +809,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info,if (dev_info_size !=sizeof (*info)){NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); -return ; +return -EINVAL ; } info->mw_cnt = hw->mw_cnt;
@@ -824,7 +824,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info,if (!hw->queue_size || !hw->queue_pairs) {NTB_LOG (ERR ,"No queue size and queue num assigned." ); -return ; +return -EAGAIN ; } hw->hdr_size_per_queue = RTE_ALIGN(sizeof(struct ntb_header) +
@@ -832,6 +832,8 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, hw->queue_size *sizeof (struct ntb_used ), RTE_CACHE_LINE_SIZE); info->ntb_hdr_size = hw->hdr_size_per_queue * hw->queue_pairs; + +return 0 ; } static int
drivers/raw/skeleton/skeleton_rawdev.c +4 -2
@@ -41,7 +41,7 @@ struct queue_buffers {static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES ] = {};static void clear_queue_bufs (int queue_id); -static void skeleton_rawdev_info_get (struct rte_rawdev *dev, +static int skeleton_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {
@@ -52,7 +52,7 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } skeldev =skeleton_rawdev_get_priv (dev);
@@ -63,6 +63,8 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev, skeldev_conf->capabilities = skeldev->capabilities; skeldev_conf->device_state = skeldev->device_state; skeldev_conf->firmware_state = skeldev->fw.firmware_state; + +return 0 ; } static int skeleton_rawdev_configure(const struct rte_rawdev *dev,
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -82,6 +82,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, size_t dev_private_size) {struct rte_rawdev *rawdev; +int ret =0 ;RTE_RAWDEV_VALID_DEVID_OR_ERR_RET (dev_id, -EINVAL );RTE_FUNC_PTR_OR_ERR_RET (dev_info, -EINVAL );
@@ -90,7 +91,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops->dev_info_get, -ENOTSUP ); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private, + ret = (*rawdev->dev_ops->dev_info_get)(rawdev, + dev_info->dev_private, dev_private_size); }
@@ -98,7 +100,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, dev_info->device = rawdev->device; dev_info->socket_id = rawdev->socket_id; -return 0 ; +return ret; }int
lib/librte_rawdev/rte_rawdev_pmd.h +2 -2
@@ -142,9 +142,9 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* The size of the structure pointed to by dev_info->dev_private * * @return -* Returns 0 on success +* Returns 0 on success, negative error code on failure */ -typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_info_get_t )(struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_private_size);
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 20.11 2/5] rawdev: allow drivers to return error from info function
Hi,
Quoted 254 lines
-----Original Message-----
From: Richardson, Bruce <[email protected]>
Sent: Thursday, July 09, 2020 23:21
To: Nipun Gupta <[email protected]>; Hemant Agrawal <[email protected]>
Cc: [email protected]; Xu, Rosen <[email protected]>; Zhang, Tianfei <[email protected]>; Li, Xiaoyun <[email protected]>; Wu, Jingjing <[email protected]>; Satha Rao <[email protected]>; Mahipal Challa <[email protected]>; Jerin Jacob <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH 20.11 2/5] rawdev: allow drivers to return error from info functionSince we now allow some parameter checking inside the driver
info_get()functions, it makes sense to allow error return from those functions to the caller. Therefore we change the driver callback return type from void to int.Signed-off-by Bruce Richardson <[email protected]>--- drivers/raw/ifpga/ifpga_rawdev.c | 15 ++++++++------- drivers/raw/ioat/ioat_rawdev.c | 9 ++++++--- drivers/raw/ntb/ntb.c | 8 +++++--- drivers/raw/skeleton/skeleton_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 ++-- 6 files changed, 29 insertions(+), 19 deletions(-)drivers/raw/ifpga/ifpga_rawdev.c +7
-7@@ -603,7 +603,7 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,return 0 ; } -static void +static int ifpga_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size)@@ -620,12 +620,12 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } adapter =ifpga_rawdev_get_priv (dev);if (!adapter) -return ; +return -ENOENT ; afu_dev = dev_info; afu_dev->rawdev = dev;@@ -637,7 +637,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (ifpga_fill_afu_dev (acc, afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("cannot get info\n" ); -return ; +return -ENOENT ; } }@@ -647,21 +647,21 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,/* get LineSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,0 , &opae_lside_eth_info)) { -return ; +return -ENOENT ; } lside_bar_idx = opae_lside_eth_info.mem_idx;/* get NICSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,1 , &opae_nside_eth_info)) { -return ; +return -ENOENT ; } nside_bar_idx = opae_nside_eth_info.mem_idx;if (lside_bar_idx >=PCI_MAX_RESOURCE || nside_bar_idx >=PCI_MAX_RESOURCE || lside_bar_idx == nside_bar_idx) -return ; +return -ENOENT ;/* fill LineSide BAR Index */ afu_dev->mem_resource[lside_bar_idx].phys_addr = @@ -679,6 +679,7 @@ ifpga_rawdev_info_get(struct
rte_rawdev*dev,drivers/raw/ifpga/ifpga_rawdev.c +1
-0afu_dev->mem_resource[nside_bar_idx].addr = opae_nside_eth_info.addr; } +return 0 ; } static intdrivers/raw/ioat/ioat_rawdev.c +6
-3@@ -112,15 +112,18 @@ ioat_dev_stop(struct rte_rawdev *dev)RTE_SET_USED (dev); } -static void +static int ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) - cfg->ring_size = ioat->ring_size; +if (dev_info ==NULL || dev_info_size !=sizeof (*cfg)) +return -EINVAL ; + + cfg->ring_size = ioat->ring_size; +return 0 ; } static const char * const xstat_names[] = { diff --git a/drivers/raw/ntb/ntb.c
b/drivers/raw/ntb/ntb.cindex4676c6f8f..eaeb67b74100644drivers/raw/ntb/ntb.c +2
-2@@ -800,7 +800,7 @@ ntb_dequeue_bufs(struct rte_rawdev *dev,return nb_rx; } -static void +static int ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {@@ -809,7 +809,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, if (dev_info_size != sizeof(*info)){ NTB_LOG(ERR, "Invalid size parameter to %s", __func__); -return ; +return -EINVAL ; }drivers/raw/ntb/ntb.c +1
-1info->mw_cnt = hw->mw_cnt;@@ -824,7 +824,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, if (!hw->queue_size || !hw->queue_pairs) { NTB_LOG(ERR, "No queue size and queue num assigned."); -return ; +return -EAGAIN ; }drivers/raw/ntb/ntb.c +2
-0hw->hdr_size_per_queue = RTE_ALIGN(sizeof(struct ntb_header) +@@ -832,6 +832,8 @@ ntb_dev_info_get(struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, hw->queue_size * sizeof(struct ntb_used), RTE_CACHE_LINE_SIZE); info->ntb_hdr_size = hw->hdr_size_per_queue * hw->queue_pairs; + +return 0 ; }static int
drivers/raw/skeleton/skeleton_rawdev.c +0
-0@@ -41,7 +41,7 @@ struct queue_buffers { static struct queue_buffersqueue_buf[SKELETON_MAX_QUEUES] = {}; static void
clear_queue_bufs(int queue_id);drivers/raw/skeleton/skeleton_rawdev.c +2
-2-static void skeleton_rawdev_info_get (struct rte_rawdev *dev, +static int skeleton_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {@@ -52,7 +52,7 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev, if (!dev_info || dev_info_size != sizeof(*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; }skeldev =
skeleton_rawdev_get_priv(dev); @@ -63,6 +63,8 @@
static void skeleton_rawdev_info_get(structrte_rawdev*dev,drivers/raw/skeleton/skeleton_rawdev.c +2
-0skeldev_conf->capabilities = skeldev->capabilities; skeldev_conf->device_state = skeldev->device_state; skeldev_conf->firmware_state = skeldev->fw.firmware_state; + +return 0 ; } static int skeleton_rawdev_configure(const struct rte_rawdev *dev, diff --git
a/lib/librte_rawdev/rte_rawdev.cb/lib/librte_rawdev/rte_rawdev.cindexa57689035..bde33763e100644lib/librte_rawdev/rte_rawdev.c +1
-0@@ -82,6 +82,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, size_t dev_private_size) {struct rte_rawdev *rawdev; +int ret =0 ;RTE_RAWDEV_VALID_DEVID_OR_ERR_RET (dev_id, -EINVAL );
RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL); @@ -90,7 +91,8
@@ rte_rawdev_info_get(uint16_tdev_id, structrte_rawdev_info*dev_info,lib/librte_rawdev/rte_rawdev.c +0
-0if (dev_info->dev_private !=NULL ) { RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops-Quoted 1 line
dev_info_get,-ENOTSUP);lib/librte_rawdev/rte_rawdev.c +0
-1- (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info-Quoted 1 line
dev_private,lib/librte_rawdev/rte_rawdev.c +3
-1+ ret = (*rawdev->dev_ops->dev_info_get)(rawdev, + dev_info->dev_private, dev_private_size); }@@ -98,7 +100,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, dev_info->device = rawdev->device; dev_info->socket_id = rawdev->socket_id; -return 0 ; +return ret; }int
lib/librte_rawdev/rte_rawdev_pmd.h +2
-3@@ -142,9 +142,9 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* The size of the structure pointed to by dev_info->dev_private * * @return -* Returns 0 on success +* Returns 0 on success, negative error code on failure */ -typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_info_get_t )(struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_private_size); --2.25.1
PATCH 3/5 rawdev: add private data length parameter to config fn
In reply to Bruce RichardsonCurrently with the rawdev API there is no way to check that the structure passed in via the dev_private pointer in the structure passed to configure API is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
--- drivers/raw/ifpga/ifpga_rawdev.c | 3 ++- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 2 +- drivers/raw/ntb/ntb.c | 6 +++++- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 ++++--- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 ++- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 ++++--- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 5 +++-- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 8 +++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 3 ++- 15 files changed, 43 insertions(+), 23 deletions(-)
drivers/raw/ifpga/ifpga_rawdev.c +2 -1
@@ -684,7 +684,8 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,static int ifpga_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, + size_t config_size __rte_unused) {IFPGA_RAWDEV_PMD_FUNC_TRACE ();
drivers/raw/ioat/ioat_rawdev.c +3 -2
@@ -41,7 +41,8 @@ RTE_LOG_REGISTER(ioat_pmd_logtype, rawdev.ioat, INFO);#define COMPLETION_SZ sizeof(__m128i)static int -ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct rte_ioat_rawdev_config *params = config;struct rte_ioat_rawdev *ioat = dev->dev_private;
@@ -51,7 +52,7 @@ ioat_dev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)if (dev->started)return -EBUSY ; -if (params ==NULL ) +if (params ==NULL || config_size !=sizeof (*params))return -EINVAL ; if (params->ring_size > 4096 || params->ring_size < 64 ||
drivers/raw/ioat/ioat_rawdev_test.c +1 -1
@@ -165,7 +165,7 @@ ioat_rawdev_test(uint16_t dev_id) } p.ring_size =IOAT_TEST_RINGSIZE ; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (p)) !=0 ) {printf ("Error with rte_rawdev_configure()\n" );return -1 ; }
drivers/raw/ntb/ntb.c +5 -1
@@ -837,13 +837,17 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, }static int -ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct ntb_dev_config *conf = config;struct ntb_hw *hw = dev->dev_private;uint32_t xstats_num;int ret; +if (conf ==NULL || config_size !=sizeof (*conf)) +return -EINVAL ; + hw->queue_pairs = conf->num_queues; hw->queue_size = conf->queue_size; hw->used_mw_num = conf->mz_num;
drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c +4 -3
@@ -294,7 +294,8 @@ otx2_dpi_rawdev_reset(struct rte_rawdev *dev) }static int -otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct dpi_rawdev_conf_s *conf = config;struct dpi_vf_s *dpivf =NULL ;
@@ -302,8 +303,8 @@ otx2_dpi_rawdev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)uintptr_t pool;uint32_t gaura; -if (conf ==NULL ) { -otx2_dpi_dbg ("NULL configuration" ); +if (conf ==NULL || config_size !=sizeof (*conf)) { +otx2_dpi_dbg ("NULL or invalid configuration" );return -EINVAL ; } dpivf = (struct dpi_vf_s *)dev->dev_private;
drivers/raw/octeontx2_dma/otx2_dpi_test.c +2 -1
@@ -182,7 +182,8 @@ test_otx2_dma_rawdev(uint16_t val)/* Configure rawdev ports */ conf.chunk_pool =dpi_create_mempool (); rdev_info.dev_private = &conf; - ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info, +sizeof (conf));if (ret) {otx2_dpi_dbg ("Unable to configure DPIVF %d" , i);return -ENODEV ;
drivers/raw/octeontx2_ep/otx2_ep_rawdev.c +4 -3
@@ -224,13 +224,14 @@ sdp_rawdev_close(struct rte_rawdev *dev) }static int -sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct sdp_rawdev_info *app_info = (struct sdp_rawdev_info *)config;struct sdp_device *sdpvf; -if (app_info ==NULL ) { -otx2_err ("Application config info [NULL]" ); +if (app_info ==NULL || config_size !=sizeof (*app_info)) { +otx2_err ("Application config info [NULL] or incorrect size" );return -EINVAL ; }
drivers/raw/octeontx2_ep/otx2_ep_test.c +1 -1
@@ -108,7 +108,7 @@ sdp_rawdev_selftest(uint16_t dev_id) dev_info.dev_private = &app_info; - ret =rte_rawdev_configure (dev_id, &dev_info); + ret =rte_rawdev_configure (dev_id, &dev_info,sizeof (app_info));if (ret) {otx2_err ("Unable to configure SDP_VF %d" , dev_id);rte_mempool_free (ioq_mpool);
drivers/raw/skeleton/skeleton_rawdev.c +3 -2
@@ -68,7 +68,8 @@ static int skeleton_rawdev_info_get(struct rte_rawdev *dev, }static int skeleton_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, +size_t config_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;
@@ -77,7 +78,7 @@ static int skeleton_rawdev_configure(const struct rte_rawdev *dev,RTE_FUNC_PTR_OR_ERR_RET (dev, -EINVAL ); -if (!config) { +if (config ==NULL || config_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid configuration" );return -EINVAL ; }
drivers/raw/skeleton/skeleton_rawdev_test.c +3 -2
@@ -126,7 +126,7 @@ test_rawdev_configure(void)struct skeleton_rawdev_conf rdev_conf_get = {0 };/* Check invalid configuration */ - ret =rte_rawdev_configure (test_dev_id,NULL ); + ret =rte_rawdev_configure (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Null configure; Expected -EINVAL, got %d" , ret);
@@ -137,7 +137,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_set; ret =rte_rawdev_configure (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_set));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to configure rawdev (%d)" , ret); rdev_info.dev_private = &rdev_conf_get;
examples/ioat/ioatfwd.c +1 -1
@@ -734,7 +734,7 @@ configure_rawdev_queue(uint32_t dev_id)struct rte_ioat_rawdev_config dev_config = { .ring_size = ring_size };struct rte_rawdev_info info = { .dev_private = &dev_config }; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (dev_config)) !=0 ) {rte_exit (EXIT_FAILURE ,"Error with rte_rawdev_configure()\n" ); }
examples/ntb/ntb_fwd.c +1 -1
@@ -1401,7 +1401,7 @@ main(int argc, char **argv) ntb_conf.num_queues = num_queues; ntb_conf.queue_size = nb_desc; ntb_rawdev_conf.dev_private = (rte_rawdev_obj_t)(&ntb_conf); - ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf); + ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf,sizeof (ntb_conf));if (ret)rte_exit (EXIT_FAILURE ,"Can't config ntb dev: err=%d, " "port=%u\n" , ret, dev_id);
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -104,7 +104,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, }int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf) +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size) {struct rte_rawdev *dev;int diag;
@@ -123,7 +124,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf) }/* Configure the device */ - diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private); + diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private, + dev_private_size);if (diag !=0 )RTE_RDEV_ERR ("dev%d dev_configure = %d" , dev_id, diag);else
lib/librte_rawdev/rte_rawdev.h +7 -1
@@ -116,13 +116,19 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,* driver/implementation can use to configure the device. It is also assumed * that once the configuration is done, a `queue_id` type field can be used * to refer to some arbitrary internal representation of a queue. +* @dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* used by the driver, and may be checked by drivers to ensure the expected +* struct type is provided. * * @return * - 0: Success, device configured. * - <0: Error code returned by the driver configuration function. */ int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf); +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size);/**
lib/librte_rawdev/rte_rawdev_pmd.h +2 -1
@@ -160,7 +160,8 @@ typedef int (*rawdev_info_get_t)(struct rte_rawdev *dev,* Returns 0 on success */ typedef int (*rawdev_configure_t )(const struct rte_rawdev *dev, -rte_rawdev_obj_t config); +rte_rawdev_obj_t config, +size_t config_size);/** * Start a configured device.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 20.11 3/5] rawdev: add private data length parameter to config fn
Hi,
Quoted 347 lines
-----Original Message-----
From: Richardson, Bruce <[email protected]>
Sent: Thursday, July 09, 2020 23:21
To: Nipun Gupta <[email protected]>; Hemant Agrawal <[email protected]>
Cc: [email protected]; Xu, Rosen <[email protected]>; Zhang, Tianfei <[email protected]>; Li, Xiaoyun <[email protected]>; Wu, Jingjing <[email protected]>; Satha Rao <[email protected]>; Mahipal Challa <[email protected]>; Jerin Jacob <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH 20.11 3/5] rawdev: add private data length parameter to config fnCurrently with the rawdev API there is no way to check that the structure passed in via the
dev_privatepointer in the structure passed to configure API is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.Signed-off-by Bruce Richardson <[email protected]>--- drivers/raw/ifpga/ifpga_rawdev.c | 3 ++- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 2 +- drivers/raw/ntb/ntb.c | 6 +++++- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 ++++--- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 ++- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 ++++--- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 5 +++-- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 8 +++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 3 ++- 15 files changed, 43 insertions(+), 23 deletions(-)drivers/raw/ifpga/ifpga_rawdev.c +2
-1@@ -684,7 +684,8 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,static int ifpga_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, + size_t config_size __rte_unused) {IFPGA_RAWDEV_PMD_FUNC_TRACE ();drivers/raw/ioat/ioat_rawdev.c +2
-1@@ -41,7 +41,8 @@ RTE_LOG_REGISTER(ioat_pmd_logtype, rawdev.ioat, INFO); #define COMPLETION_SZ sizeof(__m128i)static int -ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct rte_ioat_rawdev_config *params = config;struct
rte_ioat_rawdev*ioat =dev->dev_private; @@ -51,7 +52,7
@@ioat_dev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)drivers/raw/ioat/ioat_rawdev.c +1
-1if (dev->started)return -EBUSY ; -if (params ==NULL ) +if (params ==NULL || config_size !=sizeof (*params))return -EINVAL ; if (params->ring_size > 4096 || params->ring_size < 64 || diff --git
a/drivers/raw/ioat/ioat_rawdev_test.cb/drivers/raw/ioat/ioat_rawdev_test.c
index90f5974cd..e5b50ae9f100644drivers/raw/ioat/ioat_rawdev_test.c +1
-1@@ -165,7 +165,7 @@ ioat_rawdev_test(uint16_t dev_id) } p.ring_size =IOAT_TEST_RINGSIZE ; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (p)) !=0 ) {printf ("Error with rte_rawdev_configure()\n" );return -1 ; }drivers/raw/ntb/ntb.c index renamed from drivers/raw/ntb/ntb.c +0
-0
eaeb67b74..c181094d5100644drivers/raw/ntb/ntb.c +5
-1@@ -837,13 +837,17 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, }static int -ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct ntb_dev_config *conf = config;struct ntb_hw *hw = dev->dev_private;uint32_t xstats_num;int ret; +if (conf ==NULL || config_size !=sizeof (*conf)) +return -EINVAL ; + hw->queue_pairs = conf->num_queues; hw->queue_size = conf->queue_size;drivers/raw/ntb/ntb.c +0
-0hw->used_mw_num = conf->mz_num;drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c +2
-1@@ -294,7 +294,8 @@ otx2_dpi_rawdev_reset(struct rte_rawdev *dev) }static int -otx2_dpi_rawdev_configure (const struct rte_rawdev *dev, rte_rawdev_obj_t config) +otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct dpi_rawdev_conf_s *conf = config;drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c +2
-2struct dpi_vf_s *dpivf =NULL ;@@ -302,8 +303,8 @@ otx2_dpi_rawdev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)uintptr_t pool;uint32_t gaura; -if (conf ==NULL ) { -otx2_dpi_dbg ("NULL configuration" ); +if (conf ==NULL || config_size !=sizeof (*conf)) { +otx2_dpi_dbg ("NULL or invalid configuration" );return -EINVAL ; }dpivf = (struct
dpi_vf_s*)dev->dev_private; diff --gita/drivers/raw/octeontx2_dma/otx2_dpi_test.cb/drivers/raw/octeontx2_dma/otx2_dpi_test.c
index276658af0..cec6ca91b100644drivers/raw/octeontx2_dma/otx2_dpi_test.c +2
-1@@ -182,7 +182,8 @@ test_otx2_dma_rawdev(uint16_t val)/* Configure rawdev ports */ conf.chunk_pool =dpi_create_mempool (); rdev_info.dev_private = &conf; - ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info, +sizeof (conf));if (ret) {otx2_dpi_dbg ("Unable to configure DPIVF %d" , i);return -ENODEV ;drivers/raw/octeontx2_ep/otx2_ep_rawdev.c +4
-3@@ -224,13 +224,14 @@ sdp_rawdev_close(struct rte_rawdev *dev) }static int -sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct sdp_rawdev_info *app_info = (struct sdp_rawdev_info *)config;struct sdp_device *sdpvf; -if (app_info ==NULL ) { -otx2_err ("Application config info [NULL]" ); +if (app_info ==NULL || config_size !=sizeof (*app_info)) { +otx2_err ("Application config info [NULL] or incorrect size" );return -EINVAL ;drivers/raw/octeontx2_ep/otx2_ep_rawdev.c +0
-0}drivers/raw/octeontx2_ep/otx2_ep_test.c +1
-1@@ -108,7 +108,7 @@ sdp_rawdev_selftest(uint16_t dev_id) dev_info.dev_private = &app_info; - ret =rte_rawdev_configure (dev_id, &dev_info); + ret =rte_rawdev_configure (dev_id, &dev_info,sizeof (app_info));if (ret) {otx2_err ("Unable to configure SDP_VF %d" , dev_id);rte_mempool_free (ioq_mpool);drivers/raw/skeleton/skeleton_rawdev.c +2
-1@@ -68,7 +68,8 @@ static int skeleton_rawdev_info_get(struct rte_rawdev *dev, }static int skeleton_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, +size_t config_size) {struct skeleton_rawdev *skeldev; struct skeleton_rawdev_conf *skeldev_conf; @@ -77,7 +78,7 @@static int skeleton_rawdev_configure(const struct
rte_rawdev*dev,drivers/raw/skeleton/skeleton_rawdev.c +1
-1RTE_FUNC_PTR_OR_ERR_RET (dev, -EINVAL ); -if (!config) { +if (config ==NULL || config_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid configuration" );return -EINVAL ; }drivers/raw/skeleton/skeleton_rawdev_test.c +3
-2@@ -126,7 +126,7 @@ test_rawdev_configure(void)struct skeleton_rawdev_conf rdev_conf_get = {0 };/* Check invalid configuration */ - ret =rte_rawdev_configure (test_dev_id,NULL ); + ret =rte_rawdev_configure (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Null configure; Expected -EINVAL, got %d" , ret);@@ -137,7 +137,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_set; ret =rte_rawdev_configure (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_set));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to configure rawdev (%d)" , ret);rdev_info.dev_private =
&rdev_conf_get; diff --gita/examples/ioat/ioatfwd.cb/examples/ioat/ioatfwd.cindex5c631da1b..8e9513e44100644examples/ioat/ioatfwd.c +1
-1@@ -734,7 +734,7 @@ configure_rawdev_queue(uint32_t dev_id)struct rte_ioat_rawdev_config dev_config = { .ring_size = ring_size };struct rte_rawdev_info info = { .dev_private = &dev_config }; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (dev_config)) !=0 ) {rte_exit (EXIT_FAILURE ,"Error with rte_rawdev_configure()\n" ); }examples/ntb/ntb_fwd.c index renamed from examples/ntb/ntb_fwd.c +0
-0
11e224451..656f73659100644examples/ntb/ntb_fwd.c +2
-1@@ -1401,7 +1401,7 @@ main(int argc, char **argv) ntb_conf.num_queues = num_queues; ntb_conf.queue_size = nb_desc; ntb_rawdev_conf.dev_private = (rte_rawdev_obj_t)(&ntb_conf); - ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf); + ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf, +sizeof (ntb_conf));if (ret)rte_exit (EXIT_FAILURE ,"Can't config ntb dev: err=%d, " "port=%u\n" , ret, dev_id);lib/librte_rawdev/rte_rawdev.c +4
-2@@ -104,7 +104,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, }int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf) +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size) {struct rte_rawdev *dev;int diag;@@ -123,7 +124,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf) } /* Configure the device */ - diag = (*dev->dev_ops->dev_configure)(dev, dev_conf- >dev_private); + diag = (*dev->dev_ops->dev_configure)(dev, dev_conf- >dev_private, + dev_private_size);lib/librte_rawdev/rte_rawdev.c +0
-0if (diag !=0 )RTE_RDEV_ERR ("dev%d dev_configure = %d" , dev_id, diag);else (quoted diff) +0
-0
b/lib/librte_rawdev/rte_rawdev.hindexcf6acfd26..73e3bd5ae100644lib/librte_rawdev/rte_rawdev.h +4
-0@@ -116,13 +116,19 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, * driver/implementation can use to configure the device. It is also assumed * that once the configuration is done, a `queue_id` type field can be used * to refer to some arbitrary internal representation of a queue. + * @dev_private_size + * The length of the memory space pointed to by dev_private in dev_info. + * This should be set to the size of the expected private structure to be + * used by the driver, and may be checked by drivers to ensure theexpected
+ * struct type is provided.
*
* @return
* - 0: Success, device configured.
* - <0: Error code returned by the driver configuration function.
*/
intlib/librte_rawdev/rte_rawdev.h +2
-1-rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf); +rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf, + size_t dev_private_size);/** lib/librte_rawdev/rte_rawdev_pmd.h +2
-1@@ -160,7 +160,8 @@ typedef int (*rawdev_info_get_t)(struct rte_rawdev*dev, * Returns 0 on success */ typedef int (*rawdev_configure_t )(const struct rte_rawdev *dev, -rte_rawdev_obj_t config); +rte_rawdev_obj_t config, +size_t config_size);/** * Start a configured device.
--
2.25.1
PATCH 4/5 rawdev: add private data length parameter to queue fns
In reply to Bruce RichardsonThe queue setup and queue defaults query functions take a void * parameter as configuration data, preventing any compile-time checking of the parameters and limiting runtime checks. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
--- drivers/raw/ntb/ntb.c | 25 ++++++++++++++++----- drivers/raw/skeleton/skeleton_rawdev.c | 10 +++++---- drivers/raw/skeleton/skeleton_rawdev_test.c | 8 +++---- examples/ntb/ntb_fwd.c | 3 ++- lib/librte_rawdev/rte_rawdev.c | 10 +++++---- lib/librte_rawdev/rte_rawdev.h | 10 +++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 6 +++-- 7 files changed, 49 insertions(+), 23 deletions(-)
drivers/raw/ntb/ntb.c +19 -6
@@ -249,11 +249,15 @@ ntb_dev_intr_handler(void *param)static void ntb_queue_conf_get (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *q_conf = queue_conf;struct ntb_hw *hw = dev->dev_private; +if (conf_size !=sizeof (*q_conf)) +return ; + q_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh; q_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc; q_conf->rx_mp = hw->rx_queues[queue_id]->mpool;
@@ -294,12 +298,16 @@ ntb_rxq_release(struct ntb_rx_queue *rxq)static int ntb_rxq_setup (struct rte_rawdev *dev,uint16_t qp_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *rxq_conf = queue_conf;struct ntb_hw *hw = dev->dev_private;struct ntb_rx_queue *rxq; +if (conf_size !=sizeof (*rxq_conf)) +return -EINVAL ; +/* Allocate the rx queue data structure */ rxq = rte_zmalloc_socket("ntb rx queue", sizeof(struct ntb_rx_queue),
@@ -375,13 +383,17 @@ ntb_txq_release(struct ntb_tx_queue *txq)static int ntb_txq_setup (struct rte_rawdev *dev,uint16_t qp_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *txq_conf = queue_conf;struct ntb_hw *hw = dev->dev_private;struct ntb_tx_queue *txq;uint16_t i, prev; +if (conf_size !=sizeof (*txq_conf)) +return -EINVAL ; +/* Allocate the TX queue data structure. */ txq = rte_zmalloc_socket("ntb tx queue", sizeof(struct ntb_tx_queue),
@@ -439,7 +451,8 @@ ntb_txq_setup(struct rte_rawdev *dev,static int ntb_queue_setup (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_hw *hw = dev->dev_private;int ret;
@@ -447,11 +460,11 @@ ntb_queue_setup(struct rte_rawdev *dev,if (queue_id >= hw->queue_pairs)return -EINVAL ; - ret =ntb_txq_setup (dev, queue_id, queue_conf); + ret =ntb_txq_setup (dev, queue_id, queue_conf, conf_size);if (ret <0 )return ret; - ret =ntb_rxq_setup (dev, queue_id, queue_conf); + ret =ntb_rxq_setup (dev, queue_id, queue_conf, conf_size);return ret; }
drivers/raw/skeleton/skeleton_rawdev.c +6 -4
@@ -222,14 +222,15 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)static void skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_queue *skelq;SKELETON_PMD_FUNC_TRACE (); -if (!dev || !queue_conf) +if (!dev || !queue_conf || conf_size !=sizeof (struct skeleton_rawdev_queue ))return ; skeldev =skeleton_rawdev_get_priv (dev);
@@ -252,7 +253,8 @@ clear_queue_bufs(int queue_id)static int skeleton_rawdev_queue_setup (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {int ret =0 ;struct skeleton_rawdev *skeldev;
@@ -260,7 +262,7 @@ static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,SKELETON_PMD_FUNC_TRACE (); -if (!dev || !queue_conf) +if (!dev || !queue_conf || conf_size !=sizeof (struct skeleton_rawdev_queue ))return -EINVAL ; skeldev =skeleton_rawdev_get_priv (dev);
drivers/raw/skeleton/skeleton_rawdev_test.c +4 -4
@@ -185,7 +185,7 @@ test_rawdev_queue_default_conf_get(void)* depth = DEF_DEPTH */ for (i =0 ; i < rdev_conf_get.num_queues; i++) { -rte_rawdev_queue_conf_get (test_dev_id, i, &q); +rte_rawdev_queue_conf_get (test_dev_id, i, &q,sizeof (q));RTE_TEST_ASSERT_EQUAL (q.depth,SKELETON_QUEUE_DEF_DEPTH ,"Invalid default depth of queue (%d)" , q.depth);
@@ -235,11 +235,11 @@ test_rawdev_queue_setup(void)/* Modify the queue depth for Queue 0 and attach it */ qset.depth =15 ; qset.state =SKELETON_QUEUE_ATTACH ; - ret =rte_rawdev_queue_setup (test_dev_id,0 , &qset); + ret =rte_rawdev_queue_setup (test_dev_id,0 , &qset,sizeof (qset));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to setup queue (%d)" , ret);/* Now, fetching the queue 0 should show depth as 15 */ - ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget); + ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget,sizeof (qget));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get queue config (%d)" , ret); RTE_TEST_ASSERT_EQUAL(qset.depth, qget.depth,
@@ -263,7 +263,7 @@ test_rawdev_queue_release(void)RTE_TEST_ASSERT_SUCCESS (ret,"Failed to release queue 0; (%d)" , ret);/* Now, fetching the queue 0 should show depth as default */ - ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget); + ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget,sizeof (qget));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get queue config (%d)" , ret); RTE_TEST_ASSERT_EQUAL(qget.depth, SKELETON_QUEUE_DEF_DEPTH,
examples/ntb/ntb_fwd.c +2 -1
@@ -1411,7 +1411,8 @@ main(int argc, char **argv) ntb_q_conf.rx_mp = mbuf_pool;for (i =0 ; i < num_queues; i++) {/* Setup rawdev queue */ - ret =rte_rawdev_queue_setup (dev_id, i, &ntb_q_conf); + ret =rte_rawdev_queue_setup (dev_id, i, &ntb_q_conf, +sizeof (ntb_q_conf));if (ret <0 )rte_exit (EXIT_FAILURE ,"Failed to setup ntb queue %u.\n" , i);
lib/librte_rawdev/rte_rawdev.c +6 -4
@@ -137,7 +137,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,int rte_rawdev_queue_conf_get (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size) {struct rte_rawdev *dev;
@@ -145,14 +146,15 @@ rte_rawdev_queue_conf_get(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_def_conf, -ENOTSUP ); - (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf); + (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, queue_conf_size);return 0 ; }int rte_rawdev_queue_setup (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size) {struct rte_rawdev *dev;
@@ -160,7 +162,7 @@ rte_rawdev_queue_setup(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_setup, -ENOTSUP ); -return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf); +return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf, queue_conf_size); }int
lib/librte_rawdev/rte_rawdev.h +8 -2
@@ -146,6 +146,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,* previously supplied to rte_rawdev_configure(). * @param[out] queue_conf * The pointer to the default raw queue configuration data. +* @param queue_conf_size +* The size of the structure pointed to by queue_conf * @return * - 0: Success, driver updates the default raw queue configuration data. * - <0: Error code returned by the driver info get function.
@@ -156,7 +158,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,int rte_rawdev_queue_conf_get (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Allocate and set up a raw queue for a raw device.
@@ -169,6 +172,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,* @param queue_conf * The pointer to the configuration data to be used for the raw queue. * NULL value is allowed, in which case default configuration used. +* @param queue_conf_size +* The size of the structure pointed to by queue_conf * * @see rte_rawdev_queue_conf_get() *
@@ -179,7 +184,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,int rte_rawdev_queue_setup (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Release and deallocate a raw queue from a raw device.
lib/librte_rawdev/rte_rawdev_pmd.h +4 -2
@@ -218,7 +218,8 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);*/ typedef void (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Setup an raw queue.
@@ -235,7 +236,8 @@ typedef void (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,*/ typedef int (*rawdev_queue_setup_t )(struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Release resources allocated by given raw queue.
Signature · 1 line
2.25.1
PATCH 5/5 rawdev: allow queue default config query to return error
In reply to Bruce RichardsonThe driver APIs for returning the queue default config can fail if the parameters are invalid, or other reasons, so allow them to return error codes to the rawdev layer and from hence to the app.
--- drivers/raw/ntb/ntb.c | 6 ++++-- drivers/raw/skeleton/skeleton_rawdev.c | 12 +++++++----- lib/librte_rawdev/rte_rawdev.c | 3 +-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 +++- 4 files changed, 15 insertions(+), 10 deletions(-)
drivers/raw/ntb/ntb.c +4 -2
@@ -246,7 +246,7 @@ ntb_dev_intr_handler(void *param) } } -static void +static int ntb_queue_conf_get(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf,
@@ -256,11 +256,13 @@ ntb_queue_conf_get(struct rte_rawdev *dev,struct ntb_hw *hw = dev->dev_private;if (conf_size !=sizeof (*q_conf)) -return ; +return -EINVAL ; q_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh; q_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc; q_conf->rx_mp = hw->rx_queues[queue_id]->mpool; + +return 0 ; } static void
drivers/raw/skeleton/skeleton_rawdev.c +7 -5
@@ -220,10 +220,10 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)return 0 ; } -static void skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev, -uint16_t queue_id, -rte_rawdev_obj_t queue_conf, -size_t conf_size) +static int skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev, +uint16_t queue_id, +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_queue *skelq;
@@ -231,7 +231,7 @@ static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,SKELETON_PMD_FUNC_TRACE ();if (!dev || !queue_conf || conf_size !=sizeof (struct skeleton_rawdev_queue )) -return ; +return -EINVAL ; skeldev =skeleton_rawdev_get_priv (dev); skelq = &skeldev->queues[queue_id];
@@ -239,6 +239,8 @@ static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,if (queue_id <SKELETON_MAX_QUEUES )rte_memcpy (queue_conf, skelq,sizeof (struct skeleton_rawdev_queue )); + +return 0 ; } static void
lib/librte_rawdev/rte_rawdev.c +1 -2
@@ -146,8 +146,7 @@ rte_rawdev_queue_conf_get(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_def_conf, -ENOTSUP ); - (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, queue_conf_size); -return 0 ; +return (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, queue_conf_size); }int
lib/librte_rawdev/rte_rawdev_pmd.h +3 -1
@@ -215,8 +215,10 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);* @param[out] queue_conf * Raw device queue configuration structure * +* @return +* Returns 0 on success, negative errno on failure */ -typedef void (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev,uint16_t queue_id,rte_rawdev_obj_t queue_conf,size_t queue_conf_size);
Signature · 1 line
2.25.1
v2 cover Enhance rawdev APIs
In reply to Bruce RichardsonThis patchset proposes some internal and externally-visible changes to the rawdev API, the ABI change of which were previously announced.
The changes are in two main areas:
* For any APIs which take a void * parameter for driver-specific structs, add an additional parameter to provide the struct length. This allows some runtime type-checking, as well as possible ABI-compatibility support in the future as structure change generally involve a change in the size of the structure.
* Ensure all APIs which can return error values have int type, rather than void. Since functions like info_get and queue_default_get can now do some typechecking, they need to be modified to allow them to return error codes on failure.
V2:
- add additional patch to make start/stop functions optional
- remove deprecation notice once changes applied
Bruce Richardson (7):
rawdev: add private data length parameter to info fn
rawdev: allow drivers to return error from info function
rawdev: add private data length parameter to config fn
rawdev: add private data length parameter to queue fns
rawdev: allow queue default config query to return error
rawdev: mark start and stop functions optional
doc: remove rawdev deprecation notice
app/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 4 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 +- doc/guides/rel_notes/deprecation.rst | 7 --- doc/guides/sample_app_ug/ioat.rst | 4 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 23 +++++----- drivers/raw/ioat/ioat_rawdev.c | 17 ++++--- drivers/raw/ioat/ioat_rawdev_test.c | 6 +-- drivers/raw/ntb/ntb.c | 49 ++++++++++++++++----- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 +-- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 +- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 +-- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 36 +++++++++------ drivers/raw/skeleton/skeleton_rawdev_test.c | 32 ++++++++------ examples/ioat/ioatfwd.c | 4 +- examples/ntb/ntb_fwd.c | 7 +-- lib/librte_rawdev/rte_rawdev.c | 47 +++++++++++++------- lib/librte_rawdev/rte_rawdev.h | 27 ++++++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 22 ++++++--- 22 files changed, 201 insertions(+), 112 deletions(-)
Signature · 1 line
2.25.1
PATCH v2 1/7 rawdev: add private data length parameter to info fn
Currently with the rawdev API there is no way to check that the structure passed in via the dev_private pointer in the dev_info structure is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
--- app/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 2 +- doc/guides/sample_app_ug/ioat.rst | 2 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 4 ++-- drivers/raw/ntb/ntb.c | 8 +++++++- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 19 ++++++++++++------- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 9 ++++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 5 ++++- 15 files changed, 52 insertions(+), 26 deletions(-)
app/test/test_rawdev.c +1 -1
@@ -34,7 +34,7 @@ test_rawdev_selftest_ioat(void)for (i =0 ; i < count; i++) {struct rte_rawdev_info info = { .dev_private =NULL }; -if (rte_rawdev_info_get (i, &info) ==0 && +if (rte_rawdev_info_get (i, &info,0 ) ==0 &&strstr (info.driver_name,"ioat" ) !=NULL )return rte_rawdev_selftest (i) ==0 ?TEST_SUCCESS :TEST_FAILED ;
doc/guides/rawdevs/ioat.rst +1 -1
@@ -107,7 +107,7 @@ rawdev device for use by an application: for (i = 0; i < count && !found; i++) { struct rte_rawdev_info info = { .dev_private = NULL }; - found = (rte_rawdev_info_get(i, &info) == 0 && + found = (rte_rawdev_info_get(i, &info, 0) == 0 && strcmp(info.driver_name, IOAT_PMD_RAWDEV_NAME_STR) == 0); }
doc/guides/sample_app_ug/ioat.rst +1 -1
@@ -265,7 +265,7 @@ functions: do { if (rdev_id == rte_rawdev_count()) goto end; - rte_rawdev_info_get(rdev_id++, &rdev_info); + rte_rawdev_info_get(rdev_id++, &rdev_info, 0); } while (strcmp(rdev_info.driver_name, IOAT_PMD_RAWDEV_NAME_STR) != 0);
drivers/bus/ifpga/ifpga_bus.c +1 -1
@@ -162,7 +162,7 @@ ifpga_scan_one(struct rte_rawdev *rawdev, afu_dev->id.port = afu_pr_conf.afu_id.port;if (rawdev->dev_ops && rawdev->dev_ops->dev_info_get) - rawdev->dev_ops->dev_info_get (rawdev, afu_dev); + rawdev->dev_ops->dev_info_get (rawdev, afu_dev,sizeof (*afu_dev)); if (rawdev->dev_ops && rawdev->dev_ops->dev_start &&
drivers/raw/ifpga/ifpga_rawdev.c +3 -2
@@ -605,7 +605,8 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,static void ifpga_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct opae_adapter *adapter;struct opae_accelerator *acc;
@@ -617,7 +618,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,IFPGA_RAWDEV_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" );return ; }
drivers/raw/ioat/ioat_rawdev.c +3 -2
@@ -111,12 +111,13 @@ ioat_dev_stop(struct rte_rawdev *dev) }static void -ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL ) +if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) cfg->ring_size = ioat->ring_size; }
drivers/raw/ioat/ioat_rawdev_test.c +2 -2
@@ -148,7 +148,7 @@ ioat_rawdev_test(uint16_t dev_id)unsigned int nb_xstats;unsigned int i; -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size != expected_ring_size) {printf ("Error, initial ring size is not as expected (Actual: %d, Expected: %d)\n" , (int )p.ring_size, expected_ring_size);
@@ -160,7 +160,7 @@ ioat_rawdev_test(uint16_t dev_id)printf ("Error with rte_rawdev_configure()\n" );return -1 ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size !=IOAT_TEST_RINGSIZE ) {printf ("Error, ring size is not %d (%d)\n" ,IOAT_TEST_RINGSIZE , (int )p.ring_size);
drivers/raw/ntb/ntb.c +7 -1
@@ -801,11 +801,17 @@ ntb_dequeue_bufs(struct rte_rawdev *dev, }static void -ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct ntb_hw *hw = dev->dev_private;struct ntb_dev_info *info = dev_info; +if (dev_info_size !=sizeof (*info)) { +NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); +return ; + } + info->mw_cnt = hw->mw_cnt; info->mw_size = hw->mw_size;
drivers/raw/skeleton/skeleton_rawdev.c +3 -2
@@ -42,14 +42,15 @@ static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES] = {};static void clear_queue_bufs (int queue_id);static void skeleton_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;SKELETON_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" );return ; }
drivers/raw/skeleton/skeleton_rawdev_test.c +12 -7
@@ -106,12 +106,12 @@ test_rawdev_info_get(void)struct rte_rawdev_info rdev_info = {0 };struct skeleton_rawdev_conf skel_conf = {0 }; - ret =rte_rawdev_info_get (test_dev_id,NULL ); + ret =rte_rawdev_info_get (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Expected -EINVAL, %d" , ret); rdev_info.dev_private = &skel_conf; - ret =rte_rawdev_info_get (test_dev_id, &rdev_info); + ret =rte_rawdev_info_get (test_dev_id, &rdev_info,sizeof (skel_conf));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get raw dev info" );return TEST_SUCCESS ;
@@ -142,7 +142,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -170,7 +171,8 @@ test_rawdev_queue_default_conf_get(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -218,7 +220,8 @@ test_rawdev_queue_setup(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -327,7 +330,8 @@ test_rawdev_start_stop(void) dummy_firmware =NULL ;rte_rawdev_start (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -336,7 +340,8 @@ test_rawdev_start_stop(void) rdev_conf_get.device_state);rte_rawdev_stop (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
examples/ioat/ioatfwd.c +1 -1
@@ -757,7 +757,7 @@ assign_rawdevs(void)do {if (rdev_id ==rte_rawdev_count ()) goto end; -rte_rawdev_info_get (rdev_id++, &rdev_info); +rte_rawdev_info_get (rdev_id++, &rdev_info,0 ); }while (rdev_info.driver_name ==NULL ||strcmp (rdev_info.driver_name,IOAT_PMD_RAWDEV_NAME_STR ) !=0 );
examples/ntb/ntb_fwd.c +1 -1
@@ -1389,7 +1389,7 @@ main(int argc, char **argv)rte_rawdev_set_attr (dev_id,NTB_QUEUE_NUM_NAME , num_queues);printf ("Set queue number as %u.\n" , num_queues); ntb_rawdev_info.dev_private = (rte_rawdev_obj_t)(&ntb_info); -rte_rawdev_info_get (dev_id, &ntb_rawdev_info); +rte_rawdev_info_get (dev_id, &ntb_rawdev_info,sizeof (ntb_info)); nb_mbuf = nb_desc * num_queues *2 *2 +rte_lcore_count () *MEMPOOL_CACHE_SIZE ;
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -78,7 +78,8 @@ rte_rawdev_socket_id(uint16_t dev_id) }int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info) +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size) {struct rte_rawdev *rawdev;
@@ -89,7 +90,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops->dev_info_get, -ENOTSUP ); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private); + (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private, + dev_private_size); } dev_info->driver_name = rawdev->driver_name;
lib/librte_rawdev/rte_rawdev.h +8 -1
@@ -82,13 +82,20 @@ struct rte_rawdev_info;* will be returned. This can be used to safely query the type of a rawdev * instance without needing to know the size of the private data to return. * +* @param dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* returned, and may be checked by drivers to ensure the expected struct +* type is provided. +* * @return * - 0: Success, driver updates the contextual information of the raw device * - <0: Error code returned by the driver info get function. * */ int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info); +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size);/** * Configure a raw device.
lib/librte_rawdev/rte_rawdev_pmd.h +4 -1
@@ -138,12 +138,15 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* Raw device pointer * @param dev_info * Raw device information structure +* @param dev_private_size +* The size of the structure pointed to by dev_info->dev_private * * @return * Returns 0 on success */ typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info); +rte_rawdev_obj_t dev_info, +size_t dev_private_size);/** * Configure a device.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v2 1/7] rawdev: add private data length parameter to info fn
Hi,
Quoted 387 lines
-----Original Message-----
From: Richardson, Bruce <[email protected]>
Sent: Thursday, August 13, 2020 19:28
To: Nipun Gupta <[email protected]>; Hemant Agrawal <[email protected]>
Cc: [email protected]; Richardson, Bruce <[email protected]>; Xu, Rosen <[email protected]>; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; Zhang, Tianfei <[email protected]>; Li, Xiaoyun <[email protected]>; Wu, Jingjing <[email protected]>
Subject: [PATCH v2 1/7] rawdev: add private data length parameter to info fnCurrently with the rawdev API there is no way to check that the structure passed in via the
dev_privatepointer in thedev_infostructure is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.Signed-off-by Bruce Richardson <[email protected]>Reviewed-by Rosen Xu <[email protected]>--- app/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 2 +- doc/guides/sample_app_ug/ioat.rst | 2 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 4 ++-- drivers/raw/ntb/ntb.c | 8 +++++++- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 19 ++++++++++++------- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 9 ++++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 5 ++++- 15 files changed, 52 insertions(+), 26 deletions(-)app/test/test_rawdev.c index renamed from app/test/test_rawdev.c +0
-0
524a9d5f3b..d8d9595be1100644app/test/test_rawdev.c +1
-1@@ -34,7 +34,7 @@ test_rawdev_selftest_ioat(void)for (i =0 ; i < count; i++) {struct rte_rawdev_info info = { .dev_private =NULL }; -if (rte_rawdev_info_get (i, &info) ==0 && +if (rte_rawdev_info_get (i, &info,0 ) ==0 &&strstr (info.driver_name,"ioat" ) !=NULL )return rte_rawdev_selftest (i) ==0 ?TEST_SUCCESS :TEST_FAILED ;doc/guides/rawdevs/ioat.rst index renamed from doc/guides/rawdevs/ioat.rst +0
-0
d0eee5e237..dac52fabf1100644doc/guides/rawdevs/ioat.rst +1
-1@@ -107,7 +107,7 @@ rawdev device for use by an application: for (i = 0; i < count && !found; i++) { struct rte_rawdev_info info = { .dev_private = NULL }; - found = (rte_rawdev_info_get(i, &info) == 0 && + found = (rte_rawdev_info_get(i, &info, 0) == 0 && strcmp(info.driver_name, IOAT_PMD_RAWDEV_NAME_STR) == 0); }doc/guides/sample_app_ug/ioat.rst +1
-1@@ -265,7 +265,7 @@ functions: do { if (rdev_id == rte_rawdev_count()) goto end; - rte_rawdev_info_get(rdev_id++, &rdev_info); + rte_rawdev_info_get(rdev_id++, &rdev_info, 0); } while (strcmp(rdev_info.driver_name, IOAT_PMD_RAWDEV_NAME_STR) != 0);drivers/bus/ifpga/ifpga_bus.c +1
-1@@ -162,7 +162,7 @@ ifpga_scan_one(struct rte_rawdev *rawdev, afu_dev->id.port = afu_pr_conf.afu_id.port;if (rawdev->dev_ops && rawdev->dev_ops->dev_info_get) - rawdev->dev_ops->dev_info_get (rawdev, afu_dev); + rawdev->dev_ops->dev_info_get (rawdev, afu_dev,sizeof (*afu_dev)); if (rawdev->dev_ops &&drivers/bus/ifpga/ifpga_bus.c +0
-0rawdev->dev_ops->dev_start &&drivers/raw/ifpga/ifpga_rawdev.c +3
-2@@ -605,7 +605,8 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,static void ifpga_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct opae_adapter *adapter;struct opae_accelerator *acc;@@ -617,7 +618,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,IFPGA_RAWDEV_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" );return ; }drivers/raw/ioat/ioat_rawdev.c +3
-2@@ -111,12 +111,13 @@ ioat_dev_stop(struct rte_rawdev *dev) }static void -ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL ) +if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) cfg->ring_size = ioat->ring_size; }drivers/raw/ioat/ioat_rawdev_test.c +1
-1@@ -148,7 +148,7 @@ ioat_rawdev_test(uint16_t dev_id)unsigned int nb_xstats;unsigned int i; -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size != expected_ring_size) { printf("Error, initial ring size is not as expected (Actual: %d, Expected: %d)\n",(int)p.ring_size,
expected_ring_size); @@ -
160,7 +160,7 @@ioat_rawdev_test(uint16_t dev_id)drivers/raw/ioat/ioat_rawdev_test.c +1
-1printf ("Error with rte_rawdev_configure()\n" );return -1 ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size !=IOAT_TEST_RINGSIZE ) {printf ("Error, ring size is not %d (%d)\n" ,IOAT_TEST_RINGSIZE , (int )p.ring_size); diff --git
a/drivers/raw/ntb/ntb.cb/drivers/raw/ntb/ntb.cindexe40412bb7e..c890c43a32100644drivers/raw/ntb/ntb.c +7
-1@@ -801,11 +801,17 @@ ntb_dequeue_bufs(struct rte_rawdev *dev, }static void -ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct ntb_hw *hw = dev->dev_private;struct ntb_dev_info *info = dev_info; +if (dev_info_size !=sizeof (*info)) { +NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); +return ; + } + info->mw_cnt = hw->mw_cnt; info->mw_size = hw->mw_size;drivers/raw/skeleton/skeleton_rawdev.c +0
-0@@ -42,14 +42,15 @@ static struct queue_buffersqueue_buf[SKELETON_MAX_QUEUES] = {}; static void
clear_queue_bufs(int queue_id);static void skeleton_rawdev_info_get(struct
rte_rawdev*dev,drivers/raw/skeleton/skeleton_rawdev.c +3
-2- rte_rawdev_obj_t dev_info) + rte_rawdev_obj_t dev_info, + size_t dev_info_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;SKELETON_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" );return ; }drivers/raw/skeleton/skeleton_rawdev_test.c +2
-2@@ -106,12 +106,12 @@ test_rawdev_info_get(void)struct rte_rawdev_info rdev_info = {0 };struct skeleton_rawdev_conf skel_conf = {0 }; - ret =rte_rawdev_info_get (test_dev_id,NULL ); + ret =rte_rawdev_info_get (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Expected -EINVAL, %d" , ret); rdev_info.dev_private = &skel_conf; - ret =rte_rawdev_info_get (test_dev_id, &rdev_info); + ret =rte_rawdev_info_get (test_dev_id, &rdev_info,sizeof (skel_conf));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get raw dev info" );drivers/raw/skeleton/skeleton_rawdev_test.c +8
-4return TEST_SUCCESS ;@@ -142,7 +142,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);@@ -170,7 +171,8 @@ test_rawdev_queue_default_conf_get(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get)); RTE_TEST_ASSERT_SUCCESS(ret, "Failed to obtain rawdev configuration (%d)", ret);@@ -218,7 +220,8 @@ test_rawdev_queue_setup(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);@@ -327,7 +330,8 @@ test_rawdev_start_stop(void) dummy_firmware =NULL ;rte_rawdev_start (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get)); RTE_TEST_ASSERT_SUCCESS(ret,drivers/raw/skeleton/skeleton_rawdev_test.c +2
-1"Failed to obtain rawdev configuration (%d)" , ret);@@ -336,7 +340,8 @@ test_rawdev_start_stop(void) rdev_conf_get.device_state);rte_rawdev_stop (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get)); RTE_TEST_ASSERT_SUCCESS(ret,drivers/raw/skeleton/skeleton_rawdev_test.c +0
-0"Failed to obtain rawdev configuration (%d)" , ret);examples/ioat/ioatfwd.c index renamed from examples/ioat/ioatfwd.c +0
-0
75d8d5b9fe..76932d3dd2100644examples/ioat/ioatfwd.c +1
-1@@ -757,7 +757,7 @@ assign_rawdevs(void)do {if (rdev_id ==rte_rawdev_count ()) goto end; -rte_rawdev_info_get (rdev_id++, &rdev_info); +rte_rawdev_info_get (rdev_id++, &rdev_info,0 ); }while (rdev_info.driver_name ==NULL || strcmp(rdev_info.driver_name,IOAT_PMD_RAWDEV_NAME_STR) != 0);examples/ntb/ntb_fwd.c index renamed from examples/ntb/ntb_fwd.c +0
-0
eba8ebf9fa..11e224451c100644examples/ntb/ntb_fwd.c +1
-1@@ -1389,7 +1389,7 @@ main(int argc, char **argv)rte_rawdev_set_attr (dev_id,NTB_QUEUE_NUM_NAME , num_queues);printf ("Set queue number as %u.\n" , num_queues); ntb_rawdev_info.dev_private = (rte_rawdev_obj_t)(&ntb_info); -rte_rawdev_info_get (dev_id, &ntb_rawdev_info); +rte_rawdev_info_get (dev_id, &ntb_rawdev_info,sizeof (ntb_info)); nb_mbuf = nb_desc * num_queues * 2 * 2 + rte_lcore_count() *examples/ntb/ntb_fwd.c +0
-0MEMPOOL_CACHE_SIZE ;lib/librte_rawdev/rte_rawdev.c +3
-2@@ -78,7 +78,8 @@ rte_rawdev_socket_id(uint16_t dev_id) }int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info) +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size) {struct rte_rawdev *rawdev;@@ -89,7 +90,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops- >dev_info_get, -ENOTSUP); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info- >dev_private); + (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info-Quoted 1 line
dev_private,lib/librte_rawdev/rte_rawdev.c +1
-0+ dev_private_size); } dev_info->driver_name = rawdev->driver_name; diff --git
a/lib/librte_rawdev/rte_rawdev.hb/lib/librte_rawdev/rte_rawdev.hindex32f6b8bb03..cf6acfd261100644lib/librte_rawdev/rte_rawdev.h +8
-1@@ -82,13 +82,20 @@ struct rte_rawdev_info;* will be returned. This can be used to safely query the type of a rawdev * instance without needing to know the size of the private data to return. * +* @param dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* returned, and may be checked by drivers to ensure the expected struct +* type is provided. +* * @return * - 0: Success, driver updates the contextual information of the raw device * - <0: Error code returned by the driver info get function. * */ int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info); +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size);/** * Configure a raw device. lib/librte_rawdev/rte_rawdev_pmd.h +4
-2@@ -138,12 +138,15 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* Raw device pointer * @param dev_info * Raw device information structure +* @param dev_private_size +* The size of the structure pointed to by dev_info->dev_private * * @return * Returns 0 on success */ typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info); +rte_rawdev_obj_t dev_info, +size_t dev_private_size);/** * Configure a device. --
Quoted 1 line
2.25.1
PATCH v2 2/7 rawdev: allow drivers to return error from info function
In reply to Bruce RichardsonSince we now allow some parameter checking inside the driver info_get() functions, it makes sense to allow error return from those functions to the caller. Therefore we change the driver callback return type from void to int.
--- drivers/raw/ifpga/ifpga_rawdev.c | 15 ++++++++------- drivers/raw/ioat/ioat_rawdev.c | 9 ++++++--- drivers/raw/ntb/ntb.c | 8 +++++--- drivers/raw/skeleton/skeleton_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 ++-- 6 files changed, 29 insertions(+), 19 deletions(-)
drivers/raw/ifpga/ifpga_rawdev.c +8 -7
@@ -603,7 +603,7 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,return 0 ; } -static void +static int ifpga_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size)
@@ -620,12 +620,12 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } adapter =ifpga_rawdev_get_priv (dev);if (!adapter) -return ; +return -ENOENT ; afu_dev = dev_info; afu_dev->rawdev = dev;
@@ -637,7 +637,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (ifpga_fill_afu_dev (acc, afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("cannot get info\n" ); -return ; +return -ENOENT ; } }
@@ -647,21 +647,21 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,/* get LineSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,0 , &opae_lside_eth_info)) { -return ; +return -ENOENT ; } lside_bar_idx = opae_lside_eth_info.mem_idx;/* get NICSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,1 , &opae_nside_eth_info)) { -return ; +return -ENOENT ; } nside_bar_idx = opae_nside_eth_info.mem_idx;if (lside_bar_idx >=PCI_MAX_RESOURCE || nside_bar_idx >=PCI_MAX_RESOURCE || lside_bar_idx == nside_bar_idx) -return ; +return -ENOENT ;/* fill LineSide BAR Index */ afu_dev->mem_resource[lside_bar_idx].phys_addr =
@@ -679,6 +679,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev, afu_dev->mem_resource[nside_bar_idx].addr = opae_nside_eth_info.addr; } +return 0 ; } static int
drivers/raw/ioat/ioat_rawdev.c +6 -3
@@ -110,15 +110,18 @@ ioat_dev_stop(struct rte_rawdev *dev)RTE_SET_USED (dev); } -static void +static int ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) - cfg->ring_size = ioat->ring_size; +if (dev_info ==NULL || dev_info_size !=sizeof (*cfg)) +return -EINVAL ; + + cfg->ring_size = ioat->ring_size; +return 0 ; }static const char *const xstat_names[] = {
drivers/raw/ntb/ntb.c +5 -3
@@ -800,7 +800,7 @@ ntb_dequeue_bufs(struct rte_rawdev *dev,return nb_rx; } -static void +static int ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {
@@ -809,7 +809,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info,if (dev_info_size !=sizeof (*info)) {NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); -return ; +return -EINVAL ; } info->mw_cnt = hw->mw_cnt;
@@ -824,7 +824,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info,if (!hw->queue_size || !hw->queue_pairs) {NTB_LOG (ERR ,"No queue size and queue num assigned." ); -return ; +return -EAGAIN ; } hw->hdr_size_per_queue = RTE_ALIGN(sizeof(struct ntb_header) +
@@ -832,6 +832,8 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, hw->queue_size *sizeof (struct ntb_used ), RTE_CACHE_LINE_SIZE); info->ntb_hdr_size = hw->hdr_size_per_queue * hw->queue_pairs; + +return 0 ; } static int
drivers/raw/skeleton/skeleton_rawdev.c +4 -2
@@ -41,7 +41,7 @@ struct queue_buffers {static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES ] = {};static void clear_queue_bufs (int queue_id); -static void skeleton_rawdev_info_get (struct rte_rawdev *dev, +static int skeleton_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {
@@ -52,7 +52,7 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } skeldev =skeleton_rawdev_get_priv (dev);
@@ -63,6 +63,8 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev, skeldev_conf->capabilities = skeldev->capabilities; skeldev_conf->device_state = skeldev->device_state; skeldev_conf->firmware_state = skeldev->fw.firmware_state; + +return 0 ; } static int skeleton_rawdev_configure(const struct rte_rawdev *dev,
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -82,6 +82,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, size_t dev_private_size) {struct rte_rawdev *rawdev; +int ret =0 ;RTE_RAWDEV_VALID_DEVID_OR_ERR_RET (dev_id, -EINVAL );RTE_FUNC_PTR_OR_ERR_RET (dev_info, -EINVAL );
@@ -90,7 +91,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops->dev_info_get, -ENOTSUP ); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private, + ret = (*rawdev->dev_ops->dev_info_get)(rawdev, + dev_info->dev_private, dev_private_size); }
@@ -98,7 +100,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, dev_info->device = rawdev->device; dev_info->socket_id = rawdev->socket_id; -return 0 ; +return ret; }int
lib/librte_rawdev/rte_rawdev_pmd.h +2 -2
@@ -142,9 +142,9 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* The size of the structure pointed to by dev_info->dev_private * * @return -* Returns 0 on success +* Returns 0 on success, negative error code on failure */ -typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_info_get_t )(struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_private_size);
Signature · 1 line
2.25.1
PATCH v2 3/7 rawdev: add private data length parameter to config fn
In reply to Bruce RichardsonCurrently with the rawdev API there is no way to check that the structure passed in via the dev_private pointer in the structure passed to configure API is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
--- doc/guides/rawdevs/ioat.rst | 2 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 ++- doc/guides/sample_app_ug/ioat.rst | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 3 ++- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 2 +- drivers/raw/ntb/ntb.c | 6 +++++- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 ++++--- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 ++- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 ++++--- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 5 +++-- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 8 +++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 3 ++- 19 files changed, 48 insertions(+), 27 deletions(-)
doc/guides/rawdevs/ioat.rst +1 -1
@@ -142,7 +142,7 @@ The following code shows how the device is configured in /* ... */ p.ring_size = IOAT_TEST_RINGSIZE; - if (rte_rawdev_configure(dev_id, &info) != 0) { + if (rte_rawdev_configure(dev_id, &info, sizeof(p)) != 0) { printf("Error with rte_rawdev_configure()\n"); return -1; }
doc/guides/rawdevs/octeontx2_dma.rst +1 -1
@@ -92,7 +92,7 @@ The following code shows how the device is configured rte_mempool_set_ops_byname(conf.chunk_pool, rte_mbuf_platform_mempool_ops(), NULL); rte_mempool_populate_default(conf.chunk_pool); - rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info); + rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info, sizeof(conf)); Performing Data Transfer ------------------------
doc/guides/rawdevs/octeontx2_ep.rst +2 -1
@@ -66,7 +66,8 @@ The following code shows how the device is configured struct rte_rawdev_info rdev_info = {.dev_private = &config}; config.enqdeq_mpool = (void *)rte_mempool_create(...); - rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info); + rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info, + sizeof(config)); Performing Data Transfer ------------------------
doc/guides/sample_app_ug/ioat.rst +1 -1
@@ -296,7 +296,7 @@ is done in ``configure_rawdev_queue()``. struct rte_ioat_rawdev_config dev_config = { .ring_size = ring_size }; struct rte_rawdev_info info = { .dev_private = &dev_config }; - if (rte_rawdev_configure(dev_id, &info) != 0) { + if (rte_rawdev_configure(dev_id, &info, sizeof(dev_config)) != 0) { rte_exit(EXIT_FAILURE, "Error with rte_rawdev_configure()\n"); }
drivers/raw/ifpga/ifpga_rawdev.c +2 -1
@@ -684,7 +684,8 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,static int ifpga_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, + size_t config_size __rte_unused) {IFPGA_RAWDEV_PMD_FUNC_TRACE ();
drivers/raw/ioat/ioat_rawdev.c +3 -2
@@ -39,7 +39,8 @@ RTE_LOG_REGISTER(ioat_pmd_logtype, rawdev.ioat, INFO);#define COMPLETION_SZ sizeof(__m128i)static int -ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct rte_ioat_rawdev_config *params = config;struct rte_ioat_rawdev *ioat = dev->dev_private;
@@ -49,7 +50,7 @@ ioat_dev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)if (dev->started)return -EBUSY ; -if (params ==NULL ) +if (params ==NULL || config_size !=sizeof (*params))return -EINVAL ; if (params->ring_size > 4096 || params->ring_size < 64 ||
drivers/raw/ioat/ioat_rawdev_test.c +1 -1
@@ -156,7 +156,7 @@ ioat_rawdev_test(uint16_t dev_id) } p.ring_size =IOAT_TEST_RINGSIZE ; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (p)) !=0 ) {printf ("Error with rte_rawdev_configure()\n" );return -1 ; }
drivers/raw/ntb/ntb.c +5 -1
@@ -837,13 +837,17 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, }static int -ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct ntb_dev_config *conf = config;struct ntb_hw *hw = dev->dev_private;uint32_t xstats_num;int ret; +if (conf ==NULL || config_size !=sizeof (*conf)) +return -EINVAL ; + hw->queue_pairs = conf->num_queues; hw->queue_size = conf->queue_size; hw->used_mw_num = conf->mz_num;
drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c +4 -3
@@ -294,7 +294,8 @@ otx2_dpi_rawdev_reset(struct rte_rawdev *dev) }static int -otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct dpi_rawdev_conf_s *conf = config;struct dpi_vf_s *dpivf =NULL ;
@@ -302,8 +303,8 @@ otx2_dpi_rawdev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)uintptr_t pool;uint32_t gaura; -if (conf ==NULL ) { -otx2_dpi_dbg ("NULL configuration" ); +if (conf ==NULL || config_size !=sizeof (*conf)) { +otx2_dpi_dbg ("NULL or invalid configuration" );return -EINVAL ; } dpivf = (struct dpi_vf_s *)dev->dev_private;
drivers/raw/octeontx2_dma/otx2_dpi_test.c +2 -1
@@ -182,7 +182,8 @@ test_otx2_dma_rawdev(uint16_t val)/* Configure rawdev ports */ conf.chunk_pool =dpi_create_mempool (); rdev_info.dev_private = &conf; - ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info, +sizeof (conf));if (ret) {otx2_dpi_dbg ("Unable to configure DPIVF %d" , i);return -ENODEV ;
drivers/raw/octeontx2_ep/otx2_ep_rawdev.c +4 -3
@@ -224,13 +224,14 @@ sdp_rawdev_close(struct rte_rawdev *dev) }static int -sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct sdp_rawdev_info *app_info = (struct sdp_rawdev_info *)config;struct sdp_device *sdpvf; -if (app_info ==NULL ) { -otx2_err ("Application config info [NULL]" ); +if (app_info ==NULL || config_size !=sizeof (*app_info)) { +otx2_err ("Application config info [NULL] or incorrect size" );return -EINVAL ; }
drivers/raw/octeontx2_ep/otx2_ep_test.c +1 -1
@@ -108,7 +108,7 @@ sdp_rawdev_selftest(uint16_t dev_id) dev_info.dev_private = &app_info; - ret =rte_rawdev_configure (dev_id, &dev_info); + ret =rte_rawdev_configure (dev_id, &dev_info,sizeof (app_info));if (ret) {otx2_err ("Unable to configure SDP_VF %d" , dev_id);rte_mempool_free (ioq_mpool);
drivers/raw/skeleton/skeleton_rawdev.c +3 -2
@@ -68,7 +68,8 @@ static int skeleton_rawdev_info_get(struct rte_rawdev *dev, }static int skeleton_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, +size_t config_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;
@@ -77,7 +78,7 @@ static int skeleton_rawdev_configure(const struct rte_rawdev *dev,RTE_FUNC_PTR_OR_ERR_RET (dev, -EINVAL ); -if (!config) { +if (config ==NULL || config_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid configuration" );return -EINVAL ; }
drivers/raw/skeleton/skeleton_rawdev_test.c +3 -2
@@ -126,7 +126,7 @@ test_rawdev_configure(void)struct skeleton_rawdev_conf rdev_conf_get = {0 };/* Check invalid configuration */ - ret =rte_rawdev_configure (test_dev_id,NULL ); + ret =rte_rawdev_configure (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Null configure; Expected -EINVAL, got %d" , ret);
@@ -137,7 +137,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_set; ret =rte_rawdev_configure (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_set));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to configure rawdev (%d)" , ret); rdev_info.dev_private = &rdev_conf_get;
examples/ioat/ioatfwd.c +1 -1
@@ -734,7 +734,7 @@ configure_rawdev_queue(uint32_t dev_id)struct rte_ioat_rawdev_config dev_config = { .ring_size = ring_size };struct rte_rawdev_info info = { .dev_private = &dev_config }; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (dev_config)) !=0 ) {rte_exit (EXIT_FAILURE ,"Error with rte_rawdev_configure()\n" ); }
examples/ntb/ntb_fwd.c +1 -1
@@ -1401,7 +1401,7 @@ main(int argc, char **argv) ntb_conf.num_queues = num_queues; ntb_conf.queue_size = nb_desc; ntb_rawdev_conf.dev_private = (rte_rawdev_obj_t)(&ntb_conf); - ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf); + ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf,sizeof (ntb_conf));if (ret)rte_exit (EXIT_FAILURE ,"Can't config ntb dev: err=%d, " "port=%u\n" , ret, dev_id);
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -104,7 +104,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, }int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf) +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size) {struct rte_rawdev *dev;int diag;
@@ -123,7 +124,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf) }/* Configure the device */ - diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private); + diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private, + dev_private_size);if (diag !=0 )RTE_RDEV_ERR ("dev%d dev_configure = %d" , dev_id, diag);else
lib/librte_rawdev/rte_rawdev.h +7 -1
@@ -116,13 +116,19 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,* driver/implementation can use to configure the device. It is also assumed * that once the configuration is done, a `queue_id` type field can be used * to refer to some arbitrary internal representation of a queue. +* @dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* used by the driver, and may be checked by drivers to ensure the expected +* struct type is provided. * * @return * - 0: Success, device configured. * - <0: Error code returned by the driver configuration function. */ int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf); +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size);/**
lib/librte_rawdev/rte_rawdev_pmd.h +2 -1
@@ -160,7 +160,8 @@ typedef int (*rawdev_info_get_t)(struct rte_rawdev *dev,* Returns 0 on success */ typedef int (*rawdev_configure_t )(const struct rte_rawdev *dev, -rte_rawdev_obj_t config); +rte_rawdev_obj_t config, +size_t config_size);/** * Start a configured device.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v2 3/7] rawdev: add private data length parameter to config fn
Quoted 31 lines · Bruce Richardson
Currently with the rawdev API there is no way to check that the structure passed in via the
dev_privatepointer in the structure passed to configure API is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.Signed-off-by Bruce Richardson <[email protected]>Reviewed-by Rosen Xu <[email protected]>--- doc/guides/rawdevs/ioat.rst | 2 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 ++- doc/guides/sample_app_ug/ioat.rst | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 3 ++- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 2 +- drivers/raw/ntb/ntb.c | 6 +++++- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 ++++--- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 ++- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 ++++--- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 5 +++-- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 8 +++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 3 ++- 19 files changed, 48 insertions(+), 27 deletions(-)
<snip>
lib/librte_rawdev/rte_rawdev.h rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, · line 119
Quoted 9 lines
lib/librte_rawdev/rte_rawdev.h +1
-0@@ -116,13 +116,19 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,* driver/implementation can use to configure the device. It is also assumed * that once the configuration is done, a `queue_id` type field can be used * to refer to some arbitrary internal representation of a queue. +* @dev_private_size
Small mistake here I just spotted. This should be "@param dev_private_size", otherwise we get doc build warnings. Will fix in V3 if one is needed, otherwise I'd ask that this just be fixed on apply.
Thanks,
/Bruce
PATCH v2 4/7 rawdev: add private data length parameter to queue fns
In reply to Bruce RichardsonThe queue setup and queue defaults query functions take a void * parameter as configuration data, preventing any compile-time checking of the parameters and limiting runtime checks. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
--- drivers/raw/ntb/ntb.c | 25 ++++++++++++++++----- drivers/raw/skeleton/skeleton_rawdev.c | 12 ++++++---- drivers/raw/skeleton/skeleton_rawdev_test.c | 8 +++---- examples/ntb/ntb_fwd.c | 3 ++- lib/librte_rawdev/rte_rawdev.c | 12 ++++++---- lib/librte_rawdev/rte_rawdev.h | 10 +++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 6 +++-- 7 files changed, 53 insertions(+), 23 deletions(-)
drivers/raw/ntb/ntb.c +19 -6
@@ -249,11 +249,15 @@ ntb_dev_intr_handler(void *param)static void ntb_queue_conf_get (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *q_conf = queue_conf;struct ntb_hw *hw = dev->dev_private; +if (conf_size !=sizeof (*q_conf)) +return ; + q_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh; q_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc; q_conf->rx_mp = hw->rx_queues[queue_id]->mpool;
@@ -294,12 +298,16 @@ ntb_rxq_release(struct ntb_rx_queue *rxq)static int ntb_rxq_setup (struct rte_rawdev *dev,uint16_t qp_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *rxq_conf = queue_conf;struct ntb_hw *hw = dev->dev_private;struct ntb_rx_queue *rxq; +if (conf_size !=sizeof (*rxq_conf)) +return -EINVAL ; +/* Allocate the rx queue data structure */ rxq = rte_zmalloc_socket("ntb rx queue", sizeof(struct ntb_rx_queue),
@@ -375,13 +383,17 @@ ntb_txq_release(struct ntb_tx_queue *txq)static int ntb_txq_setup (struct rte_rawdev *dev,uint16_t qp_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *txq_conf = queue_conf;struct ntb_hw *hw = dev->dev_private;struct ntb_tx_queue *txq;uint16_t i, prev; +if (conf_size !=sizeof (*txq_conf)) +return -EINVAL ; +/* Allocate the TX queue data structure. */ txq = rte_zmalloc_socket("ntb tx queue", sizeof(struct ntb_tx_queue),
@@ -439,7 +451,8 @@ ntb_txq_setup(struct rte_rawdev *dev,static int ntb_queue_setup (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_hw *hw = dev->dev_private;int ret;
@@ -447,11 +460,11 @@ ntb_queue_setup(struct rte_rawdev *dev,if (queue_id >= hw->queue_pairs)return -EINVAL ; - ret =ntb_txq_setup (dev, queue_id, queue_conf); + ret =ntb_txq_setup (dev, queue_id, queue_conf, conf_size);if (ret <0 )return ret; - ret =ntb_rxq_setup (dev, queue_id, queue_conf); + ret =ntb_rxq_setup (dev, queue_id, queue_conf, conf_size);return ret; }
drivers/raw/skeleton/skeleton_rawdev.c +8 -4
@@ -222,14 +222,16 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)static void skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_queue *skelq;SKELETON_PMD_FUNC_TRACE (); -if (!dev || !queue_conf) +if (!dev || !queue_conf || + conf_size !=sizeof (struct skeleton_rawdev_queue ))return ; skeldev =skeleton_rawdev_get_priv (dev);
@@ -252,7 +254,8 @@ clear_queue_bufs(int queue_id)static int skeleton_rawdev_queue_setup (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {int ret =0 ;struct skeleton_rawdev *skeldev;
@@ -260,7 +263,8 @@ static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,SKELETON_PMD_FUNC_TRACE (); -if (!dev || !queue_conf) +if (!dev || !queue_conf || + conf_size !=sizeof (struct skeleton_rawdev_queue ))return -EINVAL ; skeldev =skeleton_rawdev_get_priv (dev);
drivers/raw/skeleton/skeleton_rawdev_test.c +4 -4
@@ -185,7 +185,7 @@ test_rawdev_queue_default_conf_get(void)* depth = DEF_DEPTH */ for (i =0 ; i < rdev_conf_get.num_queues; i++) { -rte_rawdev_queue_conf_get (test_dev_id, i, &q); +rte_rawdev_queue_conf_get (test_dev_id, i, &q,sizeof (q));RTE_TEST_ASSERT_EQUAL (q.depth,SKELETON_QUEUE_DEF_DEPTH ,"Invalid default depth of queue (%d)" , q.depth);
@@ -235,11 +235,11 @@ test_rawdev_queue_setup(void)/* Modify the queue depth for Queue 0 and attach it */ qset.depth =15 ; qset.state =SKELETON_QUEUE_ATTACH ; - ret =rte_rawdev_queue_setup (test_dev_id,0 , &qset); + ret =rte_rawdev_queue_setup (test_dev_id,0 , &qset,sizeof (qset));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to setup queue (%d)" , ret);/* Now, fetching the queue 0 should show depth as 15 */ - ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget); + ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget,sizeof (qget));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get queue config (%d)" , ret); RTE_TEST_ASSERT_EQUAL(qset.depth, qget.depth,
@@ -263,7 +263,7 @@ test_rawdev_queue_release(void)RTE_TEST_ASSERT_SUCCESS (ret,"Failed to release queue 0; (%d)" , ret);/* Now, fetching the queue 0 should show depth as default */ - ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget); + ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget,sizeof (qget));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get queue config (%d)" , ret); RTE_TEST_ASSERT_EQUAL(qget.depth, SKELETON_QUEUE_DEF_DEPTH,
examples/ntb/ntb_fwd.c +2 -1
@@ -1411,7 +1411,8 @@ main(int argc, char **argv) ntb_q_conf.rx_mp = mbuf_pool;for (i =0 ; i < num_queues; i++) {/* Setup rawdev queue */ - ret =rte_rawdev_queue_setup (dev_id, i, &ntb_q_conf); + ret =rte_rawdev_queue_setup (dev_id, i, &ntb_q_conf, +sizeof (ntb_q_conf));if (ret <0 )rte_exit (EXIT_FAILURE ,"Failed to setup ntb queue %u.\n" , i);
lib/librte_rawdev/rte_rawdev.c +8 -4
@@ -137,7 +137,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,int rte_rawdev_queue_conf_get (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size) {struct rte_rawdev *dev;
@@ -145,14 +146,16 @@ rte_rawdev_queue_conf_get(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_def_conf, -ENOTSUP ); - (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf); + (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, + queue_conf_size);return 0 ; }int rte_rawdev_queue_setup (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size) {struct rte_rawdev *dev;
@@ -160,7 +163,8 @@ rte_rawdev_queue_setup(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_setup, -ENOTSUP ); -return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf); +return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf, + queue_conf_size); }int
lib/librte_rawdev/rte_rawdev.h +8 -2
@@ -146,6 +146,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,* previously supplied to rte_rawdev_configure(). * @param[out] queue_conf * The pointer to the default raw queue configuration data. +* @param queue_conf_size +* The size of the structure pointed to by queue_conf * @return * - 0: Success, driver updates the default raw queue configuration data. * - <0: Error code returned by the driver info get function.
@@ -156,7 +158,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,int rte_rawdev_queue_conf_get (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Allocate and set up a raw queue for a raw device.
@@ -169,6 +172,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,* @param queue_conf * The pointer to the configuration data to be used for the raw queue. * NULL value is allowed, in which case default configuration used. +* @param queue_conf_size +* The size of the structure pointed to by queue_conf * * @see rte_rawdev_queue_conf_get() *
@@ -179,7 +184,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,int rte_rawdev_queue_setup (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Release and deallocate a raw queue from a raw device.
lib/librte_rawdev/rte_rawdev_pmd.h +4 -2
@@ -218,7 +218,8 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);*/ typedef void (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Setup an raw queue.
@@ -235,7 +236,8 @@ typedef void (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,*/ typedef int (*rawdev_queue_setup_t )(struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Release resources allocated by given raw queue.
Signature · 1 line
2.25.1
PATCH v2 5/7 rawdev: allow queue default config query to return error
In reply to Bruce RichardsonThe driver APIs for returning the queue default config can fail if the parameters are invalid, or other reasons, so allow them to return error codes to the rawdev layer and from hence to the app.
--- drivers/raw/ntb/ntb.c | 6 ++++-- drivers/raw/skeleton/skeleton_rawdev.c | 12 +++++++----- lib/librte_rawdev/rte_rawdev.c | 3 +-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 +++- 4 files changed, 15 insertions(+), 10 deletions(-)
drivers/raw/ntb/ntb.c +4 -2
@@ -246,7 +246,7 @@ ntb_dev_intr_handler(void *param) } } -static void +static int ntb_queue_conf_get(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf,
@@ -256,11 +256,13 @@ ntb_queue_conf_get(struct rte_rawdev *dev,struct ntb_hw *hw = dev->dev_private;if (conf_size !=sizeof (*q_conf)) -return ; +return -EINVAL ; q_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh; q_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc; q_conf->rx_mp = hw->rx_queues[queue_id]->mpool; + +return 0 ; } static void
drivers/raw/skeleton/skeleton_rawdev.c +7 -5
@@ -220,10 +220,10 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)return 0 ; } -static void skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev, -uint16_t queue_id, -rte_rawdev_obj_t queue_conf, -size_t conf_size) +static int skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev, +uint16_t queue_id, +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_queue *skelq;
@@ -232,7 +232,7 @@ static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,if (!dev || !queue_conf || conf_size !=sizeof (struct skeleton_rawdev_queue )) -return ; +return -EINVAL ; skeldev =skeleton_rawdev_get_priv (dev); skelq = &skeldev->queues[queue_id];
@@ -240,6 +240,8 @@ static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,if (queue_id <SKELETON_MAX_QUEUES )rte_memcpy (queue_conf, skelq,sizeof (struct skeleton_rawdev_queue )); + +return 0 ; } static void
lib/librte_rawdev/rte_rawdev.c +1 -2
@@ -146,9 +146,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_def_conf, -ENOTSUP ); - (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, +return (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, queue_conf_size); -return 0 ; }int
lib/librte_rawdev/rte_rawdev_pmd.h +3 -1
@@ -215,8 +215,10 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);* @param[out] queue_conf * Raw device queue configuration structure * +* @return +* Returns 0 on success, negative errno on failure */ -typedef void (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev,uint16_t queue_id,rte_rawdev_obj_t queue_conf,size_t queue_conf_size);
Signature · 1 line
2.25.1
PATCH v2 6/7 rawdev: mark start and stop functions optional
In reply to Bruce RichardsonNot all rawdevs will require a device start/stop function, so rather than requiring such drivers to provide dummy functions, just set the started/stopped rawdev flag from the rawdev layer and return success.
--- lib/librte_rawdev/rte_rawdev.c | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-)
lib/librte_rawdev/rte_rawdev.c +11 -7
@@ -398,20 +398,21 @@ rte_rawdev_start(uint16_t dev_id)RTE_RAWDEV_VALID_DEVID_OR_ERR_RET (dev_id, -EINVAL ); dev = &rte_rawdevs[dev_id]; -RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->dev_start, -ENOTSUP ); -if (dev->started !=0 ) {RTE_RDEV_ERR ("Device with dev_id=%" PRIu8"already started" , dev_id);return 0 ; } +if (dev->dev_ops->dev_start ==NULL ) + goto mark_started; + diag = (*dev->dev_ops->dev_start)(dev); -if (diag ==0 ) - dev->started =1 ; -else +if (diag !=0 )return diag; +mark_started: + dev->started =1 ;return 0 ; }
@@ -425,15 +426,18 @@ rte_rawdev_stop(uint16_t dev_id)RTE_RAWDEV_VALID_DEVID_OR_RET (dev_id); dev = &rte_rawdevs[dev_id]; -RTE_FUNC_PTR_OR_RET (*dev->dev_ops->dev_stop); -if (dev->started ==0 ) {RTE_RDEV_ERR ("Device with dev_id=%" PRIu8"already stopped" , dev_id);return ; } +if (dev->dev_ops->dev_stop ==NULL ) + goto mark_stopped; + (*dev->dev_ops->dev_stop)(dev); + +mark_stopped: dev->started =0 ; }
Signature · 1 line
2.25.1
PATCH v2 7/7 doc: remove rawdev deprecation notice
In reply to Bruce RichardsonSince all changes covered by the deprecation notice have been applied, the notice can be removed.
--- doc/guides/rel_notes/deprecation.rst | 7 ------- 1 file changed, 7 deletions(-)
doc/guides/rel_notes/deprecation.rst +0 -7
@@ -301,13 +301,6 @@ Deprecation Notices - https://patches.dpdk.org/patch/71457/ - https://patches.dpdk.org/patch/71456/ -* rawdev: The rawdev APIs which take a device-specific structure as - parameter directly, or indirectly via a "private" pointer inside another - structure, will be modified to take an additional parameter of the - structure size. The affected APIs will include ``rte_rawdev_info_get``, - ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and - ``rte_rawdev_queue_setup``. - * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value will be removed. This enum value is not used inside DPDK, while it prevents to add new classify algorithms without causing an ABI breakage.
Signature · 1 line
2.25.1
Series
Quoted 61 lines
-----Original Message-----
From: Bruce Richardson <[email protected]>
Sent: Thursday, August 13, 2020 4:58 PM
To: Nipun Gupta <[email protected]>; Hemant Agrawal <[email protected]>
Cc: [email protected]; Bruce Richardson <[email protected]>
Subject: [PATCH v2 0/7] Enhance rawdev APIsThis patchset proposes some internal and externally-visible changes to the rawdev API, the ABI change of which were previously announced.
The changes are in two main areas:
* For any APIs which take a void * parameter for driver-specific structs, add an additional parameter to provide the struct length. This allows some runtime type-checking, as well as possible ABI-compatibility support in the future as structure change generally involve a change in the size of the structure.
* Ensure all APIs which can return error values have int type, rather than void. Since functions likeinfo_getandqueue_default_getcan now do some typechecking, they need to be modified to allow them to return error codes on failure.V2:
- add additional patch to make start/stop functions optional
- remove deprecation notice once changes appliedBruce Richardson (7):
rawdev: add private data length parameter to info fn
rawdev: allow drivers to return error from info function
rawdev: add private data length parameter to config fn
rawdev: add private data length parameter to queue fns
rawdev: allow queue default config query to return error
rawdev: mark start and stop functions optional
doc: remove rawdev deprecation noticeapp/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 4 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 +- doc/guides/rel_notes/deprecation.rst | 7 --- doc/guides/sample_app_ug/ioat.rst | 4 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 23 +++++----- drivers/raw/ioat/ioat_rawdev.c | 17 ++++--- drivers/raw/ioat/ioat_rawdev_test.c | 6 +-- drivers/raw/ntb/ntb.c | 49 ++++++++++++++++----- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 +-- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 +- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 +-- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 36 +++++++++------ drivers/raw/skeleton/skeleton_rawdev_test.c | 32 ++++++++------ examples/ioat/ioatfwd.c | 4 +- examples/ntb/ntb_fwd.c | 7 +-- lib/librte_rawdev/rte_rawdev.c | 47 +++++++++++++------- lib/librte_rawdev/rte_rawdev.h | 27 ++++++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 22 ++++++--- 22 files changed, 201 insertions(+), 112 deletions(-)--
2.25.1
Quoted 15 lines
app/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 4 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 +- doc/guides/rel_notes/deprecation.rst | 7 --- doc/guides/sample_app_ug/ioat.rst | 4 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 23 +++++----- drivers/raw/ioat/ioat_rawdev.c | 17 ++++--- drivers/raw/ioat/ioat_rawdev_test.c | 6 +-- drivers/raw/ntb/ntb.c | 49 ++++++++++++++++----- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 +-- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 +- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 +-- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +-
Quoted 8 lines
drivers/raw/skeleton/skeleton_rawdev.c | 36 +++++++++------ drivers/raw/skeleton/skeleton_rawdev_test.c | 32 ++++++++------ examples/ioat/ioatfwd.c | 4 +- examples/ntb/ntb_fwd.c | 7 +-- lib/librte_rawdev/rte_rawdev.c | 47 +++++++++++++------- lib/librte_rawdev/rte_rawdev.h | 27 ++++++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 22 ++++++--- 22 files changed, 201 insertions(+), 112 deletions(-)
It is missing updates of the release notes in each patch changing the API.
v3 cover Enhance rawdev APIs
In reply to Bruce RichardsonThis patchset proposes some internal and externally-visible changes to the rawdev API, the ABI change of which were previously announced.
The changes are in two main areas:
* For any APIs which take a void * parameter for driver-specific structs, add an additional parameter to provide the struct length. This allows some runtime type-checking, as well as possible ABI-compatibility support in the future as structure change generally involve a change in the size of the structure.
* Ensure all APIs which can return error values have int type, rather than void. Since functions like info_get and queue_default_get can now do some typechecking, they need to be modified to allow them to return error codes on failure.
V3:
- fix doxygen error
- add release note update for changes to public APIs
V2:
- add additional patch to make start/stop functions optional
- remove deprecation notice once changes applied
Bruce Richardson (7):
rawdev: add private data length parameter to info fn
rawdev: allow drivers to return error from info function
rawdev: add private data length parameter to config fn
rawdev: add private data length parameter to queue fns
rawdev: allow queue config query to return error
rawdev: mark start and stop functions optional
doc: remove rawdev deprecation notice
app/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 4 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 +- doc/guides/rel_notes/deprecation.rst | 7 --- doc/guides/rel_notes/release_20_11.rst | 9 ++++ doc/guides/sample_app_ug/ioat.rst | 4 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 23 +++++----- drivers/raw/ioat/ioat_rawdev.c | 17 ++++--- drivers/raw/ioat/ioat_rawdev_test.c | 6 +-- drivers/raw/ntb/ntb.c | 49 ++++++++++++++++----- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 +-- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 +- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 +-- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 36 +++++++++------ drivers/raw/skeleton/skeleton_rawdev_test.c | 32 ++++++++------ examples/ioat/ioatfwd.c | 4 +- examples/ntb/ntb_fwd.c | 7 +-- lib/librte_rawdev/rte_rawdev.c | 47 +++++++++++++------- lib/librte_rawdev/rte_rawdev.h | 27 ++++++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 22 ++++++--- 23 files changed, 210 insertions(+), 112 deletions(-)
Signature · 1 line
2.25.1
PATCH v3 1/7 rawdev: add private data length parameter to info fn
Currently with the rawdev API there is no way to check that the structure passed in via the dev_private pointer in the dev_info structure is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
---
V3: Added short release-note item describing the change.
--- app/test/test_rawdev.c | 2 +- doc/guides/rawdevs/ioat.rst | 2 +- doc/guides/rel_notes/release_20_11.rst | 4 ++++ doc/guides/sample_app_ug/ioat.rst | 2 +- drivers/bus/ifpga/ifpga_bus.c | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 4 ++-- drivers/raw/ntb/ntb.c | 8 +++++++- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 19 ++++++++++++------- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 9 ++++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 5 ++++- 16 files changed, 56 insertions(+), 26 deletions(-)
app/test/test_rawdev.c +1 -1
@@ -34,7 +34,7 @@ test_rawdev_selftest_ioat(void)for (i =0 ; i < count; i++) {struct rte_rawdev_info info = { .dev_private =NULL }; -if (rte_rawdev_info_get (i, &info) ==0 && +if (rte_rawdev_info_get (i, &info,0 ) ==0 &&strstr (info.driver_name,"ioat" ) !=NULL )return rte_rawdev_selftest (i) ==0 ?TEST_SUCCESS :TEST_FAILED ;
doc/guides/rawdevs/ioat.rst +1 -1
@@ -107,7 +107,7 @@ rawdev device for use by an application: for (i = 0; i < count && !found; i++) { struct rte_rawdev_info info = { .dev_private = NULL }; - found = (rte_rawdev_info_get(i, &info) == 0 && + found = (rte_rawdev_info_get(i, &info, 0) == 0 && strcmp(info.driver_name, IOAT_PMD_RAWDEV_NAME_STR) == 0); }
doc/guides/rel_notes/release_20_11.rst +4 -0
@@ -84,6 +84,10 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* rawdev: Added a structure size parameter to the function + ``rte_rawdev_info_get()``, + allowing limited driver type-checking and ABI compatibility. + ABI Changes -----------
doc/guides/sample_app_ug/ioat.rst +1 -1
@@ -265,7 +265,7 @@ functions: do { if (rdev_id == rte_rawdev_count()) goto end; - rte_rawdev_info_get(rdev_id++, &rdev_info); + rte_rawdev_info_get(rdev_id++, &rdev_info, 0); } while (strcmp(rdev_info.driver_name, IOAT_PMD_RAWDEV_NAME_STR) != 0);
drivers/bus/ifpga/ifpga_bus.c +1 -1
@@ -162,7 +162,7 @@ ifpga_scan_one(struct rte_rawdev *rawdev, afu_dev->id.port = afu_pr_conf.afu_id.port;if (rawdev->dev_ops && rawdev->dev_ops->dev_info_get) - rawdev->dev_ops->dev_info_get (rawdev, afu_dev); + rawdev->dev_ops->dev_info_get (rawdev, afu_dev,sizeof (*afu_dev)); if (rawdev->dev_ops && rawdev->dev_ops->dev_start &&
drivers/raw/ifpga/ifpga_rawdev.c +3 -2
@@ -605,7 +605,8 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,static void ifpga_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct opae_adapter *adapter;struct opae_accelerator *acc;
@@ -617,7 +618,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,IFPGA_RAWDEV_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" );return ; }
drivers/raw/ioat/ioat_rawdev.c +3 -2
@@ -111,12 +111,13 @@ ioat_dev_stop(struct rte_rawdev *dev) }static void -ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL ) +if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) cfg->ring_size = ioat->ring_size; }
drivers/raw/ioat/ioat_rawdev_test.c +2 -2
@@ -148,7 +148,7 @@ ioat_rawdev_test(uint16_t dev_id)unsigned int nb_xstats;unsigned int i; -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size != expected_ring_size) {printf ("Error, initial ring size is not as expected (Actual: %d, Expected: %d)\n" , (int )p.ring_size, expected_ring_size);
@@ -160,7 +160,7 @@ ioat_rawdev_test(uint16_t dev_id)printf ("Error with rte_rawdev_configure()\n" );return -1 ; } -rte_rawdev_info_get (dev_id, &info); +rte_rawdev_info_get (dev_id, &info,sizeof (p));if (p.ring_size !=IOAT_TEST_RINGSIZE ) {printf ("Error, ring size is not %d (%d)\n" ,IOAT_TEST_RINGSIZE , (int )p.ring_size);
drivers/raw/ntb/ntb.c +7 -1
@@ -801,11 +801,17 @@ ntb_dequeue_bufs(struct rte_rawdev *dev, }static void -ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info) +ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct ntb_hw *hw = dev->dev_private;struct ntb_dev_info *info = dev_info; +if (dev_info_size !=sizeof (*info)) { +NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); +return ; + } + info->mw_cnt = hw->mw_cnt; info->mw_size = hw->mw_size;
drivers/raw/skeleton/skeleton_rawdev.c +3 -2
@@ -42,14 +42,15 @@ static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES] = {};static void clear_queue_bufs (int queue_id);static void skeleton_rawdev_info_get (struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info) +rte_rawdev_obj_t dev_info, +size_t dev_info_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;SKELETON_PMD_FUNC_TRACE (); -if (!dev_info) { +if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" );return ; }
drivers/raw/skeleton/skeleton_rawdev_test.c +12 -7
@@ -106,12 +106,12 @@ test_rawdev_info_get(void)struct rte_rawdev_info rdev_info = {0 };struct skeleton_rawdev_conf skel_conf = {0 }; - ret =rte_rawdev_info_get (test_dev_id,NULL ); + ret =rte_rawdev_info_get (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Expected -EINVAL, %d" , ret); rdev_info.dev_private = &skel_conf; - ret =rte_rawdev_info_get (test_dev_id, &rdev_info); + ret =rte_rawdev_info_get (test_dev_id, &rdev_info,sizeof (skel_conf));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get raw dev info" );return TEST_SUCCESS ;
@@ -142,7 +142,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -170,7 +171,8 @@ test_rawdev_queue_default_conf_get(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -218,7 +220,8 @@ test_rawdev_queue_setup(void)/* Get the current configuration */ rdev_info.dev_private = &rdev_conf_get; ret =rte_rawdev_info_get (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -327,7 +330,8 @@ test_rawdev_start_stop(void) dummy_firmware =NULL ;rte_rawdev_start (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
@@ -336,7 +340,8 @@ test_rawdev_start_stop(void) rdev_conf_get.device_state);rte_rawdev_stop (test_dev_id); - ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_info_get (test_dev_id, (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_get));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to obtain rawdev configuration (%d)" , ret);
examples/ioat/ioatfwd.c +1 -1
@@ -757,7 +757,7 @@ assign_rawdevs(void)do {if (rdev_id ==rte_rawdev_count ()) goto end; -rte_rawdev_info_get (rdev_id++, &rdev_info); +rte_rawdev_info_get (rdev_id++, &rdev_info,0 ); }while (rdev_info.driver_name ==NULL ||strcmp (rdev_info.driver_name,IOAT_PMD_RAWDEV_NAME_STR ) !=0 );
examples/ntb/ntb_fwd.c +1 -1
@@ -1389,7 +1389,7 @@ main(int argc, char **argv)rte_rawdev_set_attr (dev_id,NTB_QUEUE_NUM_NAME , num_queues);printf ("Set queue number as %u.\n" , num_queues); ntb_rawdev_info.dev_private = (rte_rawdev_obj_t)(&ntb_info); -rte_rawdev_info_get (dev_id, &ntb_rawdev_info); +rte_rawdev_info_get (dev_id, &ntb_rawdev_info,sizeof (ntb_info)); nb_mbuf = nb_desc * num_queues *2 *2 +rte_lcore_count () *MEMPOOL_CACHE_SIZE ;
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -78,7 +78,8 @@ rte_rawdev_socket_id(uint16_t dev_id) }int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info) +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size) {struct rte_rawdev *rawdev;
@@ -89,7 +90,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops->dev_info_get, -ENOTSUP ); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private); + (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private, + dev_private_size); } dev_info->driver_name = rawdev->driver_name;
lib/librte_rawdev/rte_rawdev.h +8 -1
@@ -82,13 +82,20 @@ struct rte_rawdev_info;* will be returned. This can be used to safely query the type of a rawdev * instance without needing to know the size of the private data to return. * +* @param dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* returned, and may be checked by drivers to ensure the expected struct +* type is provided. +* * @return * - 0: Success, driver updates the contextual information of the raw device * - <0: Error code returned by the driver info get function. * */ int -rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info); +rte_rawdev_info_get (uint16_t dev_id,struct rte_rawdev_info *dev_info, +size_t dev_private_size);/** * Configure a raw device.
lib/librte_rawdev/rte_rawdev_pmd.h +4 -1
@@ -138,12 +138,15 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* Raw device pointer * @param dev_info * Raw device information structure +* @param dev_private_size +* The size of the structure pointed to by dev_info->dev_private * * @return * Returns 0 on success */ typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, -rte_rawdev_obj_t dev_info); +rte_rawdev_obj_t dev_info, +size_t dev_private_size);/** * Configure a device.
Signature · 1 line
2.25.1
PATCH v3 2/7 rawdev: allow drivers to return error from info function
In reply to Bruce RichardsonSince we now allow some parameter checking inside the driver info_get() functions, it makes sense to allow error return from those functions to the caller. Therefore we change the driver callback return type from void to int.
---
v3: Add release note entry for change
--- doc/guides/rel_notes/release_20_11.rst | 3 +++ drivers/raw/ifpga/ifpga_rawdev.c | 15 ++++++++------- drivers/raw/ioat/ioat_rawdev.c | 9 ++++++--- drivers/raw/ntb/ntb.c | 8 +++++--- drivers/raw/skeleton/skeleton_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 ++-- 7 files changed, 32 insertions(+), 19 deletions(-)
doc/guides/rel_notes/release_20_11.rst +3 -0
@@ -88,6 +88,9 @@ API Changes ``rte_rawdev_info_get()``, allowing limited driver type-checking and ABI compatibility. +* rawdev: Changed the return type of the function ``rte_dev_info_get()`` + from ``void`` to ``int`` allowing the return of error codes from drivers. + ABI Changes -----------
drivers/raw/ifpga/ifpga_rawdev.c +8 -7
@@ -603,7 +603,7 @@ ifpga_fill_afu_dev(struct opae_accelerator *acc,return 0 ; } -static void +static int ifpga_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size)
@@ -620,12 +620,12 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } adapter =ifpga_rawdev_get_priv (dev);if (!adapter) -return ; +return -ENOENT ; afu_dev = dev_info; afu_dev->rawdev = dev;
@@ -637,7 +637,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,if (ifpga_fill_afu_dev (acc, afu_dev)) {IFPGA_RAWDEV_PMD_ERR ("cannot get info\n" ); -return ; +return -ENOENT ; } }
@@ -647,21 +647,21 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,/* get LineSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,0 , &opae_lside_eth_info)) { -return ; +return -ENOENT ; } lside_bar_idx = opae_lside_eth_info.mem_idx;/* get NICSide BAR Index */ if (opae_manager_get_eth_group_region_info (mgr,1 , &opae_nside_eth_info)) { -return ; +return -ENOENT ; } nside_bar_idx = opae_nside_eth_info.mem_idx;if (lside_bar_idx >=PCI_MAX_RESOURCE || nside_bar_idx >=PCI_MAX_RESOURCE || lside_bar_idx == nside_bar_idx) -return ; +return -ENOENT ;/* fill LineSide BAR Index */ afu_dev->mem_resource[lside_bar_idx].phys_addr =
@@ -679,6 +679,7 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev, afu_dev->mem_resource[nside_bar_idx].addr = opae_nside_eth_info.addr; } +return 0 ; } static int
drivers/raw/ioat/ioat_rawdev.c +6 -3
@@ -110,15 +110,18 @@ ioat_dev_stop(struct rte_rawdev *dev)RTE_SET_USED (dev); } -static void +static int ioat_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {struct rte_ioat_rawdev_config *cfg = dev_info;struct rte_ioat_rawdev *ioat = dev->dev_private; -if (cfg !=NULL && dev_info_size ==sizeof (*cfg)) - cfg->ring_size = ioat->ring_size; +if (dev_info ==NULL || dev_info_size !=sizeof (*cfg)) +return -EINVAL ; + + cfg->ring_size = ioat->ring_size; +return 0 ; }static const char *const xstat_names[] = {
drivers/raw/ntb/ntb.c +5 -3
@@ -800,7 +800,7 @@ ntb_dequeue_bufs(struct rte_rawdev *dev,return nb_rx; } -static void +static int ntb_dev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {
@@ -809,7 +809,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info,if (dev_info_size !=sizeof (*info)) {NTB_LOG (ERR ,"Invalid size parameter to %s" , __func__); -return ; +return -EINVAL ; } info->mw_cnt = hw->mw_cnt;
@@ -824,7 +824,7 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info,if (!hw->queue_size || !hw->queue_pairs) {NTB_LOG (ERR ,"No queue size and queue num assigned." ); -return ; +return -EAGAIN ; } hw->hdr_size_per_queue = RTE_ALIGN(sizeof(struct ntb_header) +
@@ -832,6 +832,8 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, hw->queue_size *sizeof (struct ntb_used ), RTE_CACHE_LINE_SIZE); info->ntb_hdr_size = hw->hdr_size_per_queue * hw->queue_pairs; + +return 0 ; } static int
drivers/raw/skeleton/skeleton_rawdev.c +4 -2
@@ -41,7 +41,7 @@ struct queue_buffers {static struct queue_buffers queue_buf[SKELETON_MAX_QUEUES ] = {};static void clear_queue_bufs (int queue_id); -static void skeleton_rawdev_info_get (struct rte_rawdev *dev, +static int skeleton_rawdev_info_get (struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_info_size) {
@@ -52,7 +52,7 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev,if (!dev_info || dev_info_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid request" ); -return ; +return -EINVAL ; } skeldev =skeleton_rawdev_get_priv (dev);
@@ -63,6 +63,8 @@ static void skeleton_rawdev_info_get(struct rte_rawdev *dev, skeldev_conf->capabilities = skeldev->capabilities; skeldev_conf->device_state = skeldev->device_state; skeldev_conf->firmware_state = skeldev->fw.firmware_state; + +return 0 ; } static int skeleton_rawdev_configure(const struct rte_rawdev *dev,
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -82,6 +82,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, size_t dev_private_size) {struct rte_rawdev *rawdev; +int ret =0 ;RTE_RAWDEV_VALID_DEVID_OR_ERR_RET (dev_id, -EINVAL );RTE_FUNC_PTR_OR_ERR_RET (dev_info, -EINVAL );
@@ -90,7 +91,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,if (dev_info->dev_private !=NULL ) {RTE_FUNC_PTR_OR_ERR_RET (*rawdev->dev_ops->dev_info_get, -ENOTSUP ); - (*rawdev->dev_ops->dev_info_get)(rawdev, dev_info->dev_private, + ret = (*rawdev->dev_ops->dev_info_get)(rawdev, + dev_info->dev_private, dev_private_size); }
@@ -98,7 +100,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, dev_info->device = rawdev->device; dev_info->socket_id = rawdev->socket_id; -return 0 ; +return ret; }int
lib/librte_rawdev/rte_rawdev_pmd.h +2 -2
@@ -142,9 +142,9 @@ rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)* The size of the structure pointed to by dev_info->dev_private * * @return -* Returns 0 on success +* Returns 0 on success, negative error code on failure */ -typedef void (*rawdev_info_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_info_get_t )(struct rte_rawdev *dev,rte_rawdev_obj_t dev_info,size_t dev_private_size);
Signature · 1 line
2.25.1
PATCH v3 3/7 rawdev: add private data length parameter to config fn
In reply to Bruce RichardsonCurrently with the rawdev API there is no way to check that the structure passed in via the dev_private pointer in the structure passed to configure API is of the correct type - it's just checked that it is non-NULL. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
---
V3: fixed doxygen comment.
add release note update
--- doc/guides/rawdevs/ioat.rst | 2 +- doc/guides/rawdevs/octeontx2_dma.rst | 2 +- doc/guides/rawdevs/octeontx2_ep.rst | 3 ++- doc/guides/rel_notes/release_20_11.rst | 4 ++-- doc/guides/sample_app_ug/ioat.rst | 2 +- drivers/raw/ifpga/ifpga_rawdev.c | 3 ++- drivers/raw/ioat/ioat_rawdev.c | 5 +++-- drivers/raw/ioat/ioat_rawdev_test.c | 2 +- drivers/raw/ntb/ntb.c | 6 +++++- drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c | 7 ++++--- drivers/raw/octeontx2_dma/otx2_dpi_test.c | 3 ++- drivers/raw/octeontx2_ep/otx2_ep_rawdev.c | 7 ++++--- drivers/raw/octeontx2_ep/otx2_ep_test.c | 2 +- drivers/raw/skeleton/skeleton_rawdev.c | 5 +++-- drivers/raw/skeleton/skeleton_rawdev_test.c | 5 +++-- examples/ioat/ioatfwd.c | 2 +- examples/ntb/ntb_fwd.c | 2 +- lib/librte_rawdev/rte_rawdev.c | 6 ++++-- lib/librte_rawdev/rte_rawdev.h | 8 +++++++- lib/librte_rawdev/rte_rawdev_pmd.h | 3 ++- 20 files changed, 50 insertions(+), 29 deletions(-)
doc/guides/rawdevs/ioat.rst +1 -1
@@ -142,7 +142,7 @@ The following code shows how the device is configured in /* ... */ p.ring_size = IOAT_TEST_RINGSIZE; - if (rte_rawdev_configure(dev_id, &info) != 0) { + if (rte_rawdev_configure(dev_id, &info, sizeof(p)) != 0) { printf("Error with rte_rawdev_configure()\n"); return -1; }
doc/guides/rawdevs/octeontx2_dma.rst +1 -1
@@ -92,7 +92,7 @@ The following code shows how the device is configured rte_mempool_set_ops_byname(conf.chunk_pool, rte_mbuf_platform_mempool_ops(), NULL); rte_mempool_populate_default(conf.chunk_pool); - rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info); + rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info, sizeof(conf)); Performing Data Transfer ------------------------
doc/guides/rawdevs/octeontx2_ep.rst +2 -1
@@ -66,7 +66,8 @@ The following code shows how the device is configured struct rte_rawdev_info rdev_info = {.dev_private = &config}; config.enqdeq_mpool = (void *)rte_mempool_create(...); - rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info); + rte_rawdev_configure(dev_id, (rte_rawdev_obj_t)&rdev_info, + sizeof(config)); Performing Data Transfer ------------------------
doc/guides/rel_notes/release_20_11.rst +2 -2
@@ -84,8 +84,8 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= -* rawdev: Added a structure size parameter to the function - ``rte_rawdev_info_get()``, +* rawdev: Added a structure size parameter to the functions + ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``, allowing limited driver type-checking and ABI compatibility. * rawdev: Changed the return type of the function ``rte_dev_info_get()``
doc/guides/sample_app_ug/ioat.rst +1 -1
@@ -296,7 +296,7 @@ is done in ``configure_rawdev_queue()``. struct rte_ioat_rawdev_config dev_config = { .ring_size = ring_size }; struct rte_rawdev_info info = { .dev_private = &dev_config }; - if (rte_rawdev_configure(dev_id, &info) != 0) { + if (rte_rawdev_configure(dev_id, &info, sizeof(dev_config)) != 0) { rte_exit(EXIT_FAILURE, "Error with rte_rawdev_configure()\n"); }
drivers/raw/ifpga/ifpga_rawdev.c +2 -1
@@ -684,7 +684,8 @@ ifpga_rawdev_info_get(struct rte_rawdev *dev,static int ifpga_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, + size_t config_size __rte_unused) {IFPGA_RAWDEV_PMD_FUNC_TRACE ();
drivers/raw/ioat/ioat_rawdev.c +3 -2
@@ -39,7 +39,8 @@ RTE_LOG_REGISTER(ioat_pmd_logtype, rawdev.ioat, INFO);#define COMPLETION_SZ sizeof(__m128i)static int -ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ioat_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct rte_ioat_rawdev_config *params = config;struct rte_ioat_rawdev *ioat = dev->dev_private;
@@ -49,7 +50,7 @@ ioat_dev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)if (dev->started)return -EBUSY ; -if (params ==NULL ) +if (params ==NULL || config_size !=sizeof (*params))return -EINVAL ; if (params->ring_size > 4096 || params->ring_size < 64 ||
drivers/raw/ioat/ioat_rawdev_test.c +1 -1
@@ -156,7 +156,7 @@ ioat_rawdev_test(uint16_t dev_id) } p.ring_size =IOAT_TEST_RINGSIZE ; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (p)) !=0 ) {printf ("Error with rte_rawdev_configure()\n" );return -1 ; }
drivers/raw/ntb/ntb.c +5 -1
@@ -837,13 +837,17 @@ ntb_dev_info_get(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info, }static int -ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +ntb_dev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct ntb_dev_config *conf = config;struct ntb_hw *hw = dev->dev_private;uint32_t xstats_num;int ret; +if (conf ==NULL || config_size !=sizeof (*conf)) +return -EINVAL ; + hw->queue_pairs = conf->num_queues; hw->queue_size = conf->queue_size; hw->used_mw_num = conf->mz_num;
drivers/raw/octeontx2_dma/otx2_dpi_rawdev.c +4 -3
@@ -294,7 +294,8 @@ otx2_dpi_rawdev_reset(struct rte_rawdev *dev) }static int -otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +otx2_dpi_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct dpi_rawdev_conf_s *conf = config;struct dpi_vf_s *dpivf =NULL ;
@@ -302,8 +303,8 @@ otx2_dpi_rawdev_configure(const struct rte_rawdev *dev, rte_rawdev_obj_t config)uintptr_t pool;uint32_t gaura; -if (conf ==NULL ) { -otx2_dpi_dbg ("NULL configuration" ); +if (conf ==NULL || config_size !=sizeof (*conf)) { +otx2_dpi_dbg ("NULL or invalid configuration" );return -EINVAL ; } dpivf = (struct dpi_vf_s *)dev->dev_private;
drivers/raw/octeontx2_dma/otx2_dpi_test.c +2 -1
@@ -182,7 +182,8 @@ test_otx2_dma_rawdev(uint16_t val)/* Configure rawdev ports */ conf.chunk_pool =dpi_create_mempool (); rdev_info.dev_private = &conf; - ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info); + ret =rte_rawdev_configure (i, (rte_rawdev_obj_t)&rdev_info, +sizeof (conf));if (ret) {otx2_dpi_dbg ("Unable to configure DPIVF %d" , i);return -ENODEV ;
drivers/raw/octeontx2_ep/otx2_ep_rawdev.c +4 -3
@@ -224,13 +224,14 @@ sdp_rawdev_close(struct rte_rawdev *dev) }static int -sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config) +sdp_rawdev_configure (const struct rte_rawdev *dev,rte_rawdev_obj_t config, +size_t config_size) {struct sdp_rawdev_info *app_info = (struct sdp_rawdev_info *)config;struct sdp_device *sdpvf; -if (app_info ==NULL ) { -otx2_err ("Application config info [NULL]" ); +if (app_info ==NULL || config_size !=sizeof (*app_info)) { +otx2_err ("Application config info [NULL] or incorrect size" );return -EINVAL ; }
drivers/raw/octeontx2_ep/otx2_ep_test.c +1 -1
@@ -108,7 +108,7 @@ sdp_rawdev_selftest(uint16_t dev_id) dev_info.dev_private = &app_info; - ret =rte_rawdev_configure (dev_id, &dev_info); + ret =rte_rawdev_configure (dev_id, &dev_info,sizeof (app_info));if (ret) {otx2_err ("Unable to configure SDP_VF %d" , dev_id);rte_mempool_free (ioq_mpool);
drivers/raw/skeleton/skeleton_rawdev.c +3 -2
@@ -68,7 +68,8 @@ static int skeleton_rawdev_info_get(struct rte_rawdev *dev, }static int skeleton_rawdev_configure (const struct rte_rawdev *dev, -rte_rawdev_obj_t config) +rte_rawdev_obj_t config, +size_t config_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_conf *skeldev_conf;
@@ -77,7 +78,7 @@ static int skeleton_rawdev_configure(const struct rte_rawdev *dev,RTE_FUNC_PTR_OR_ERR_RET (dev, -EINVAL ); -if (!config) { +if (config ==NULL || config_size !=sizeof (*skeldev_conf)) {SKELETON_PMD_ERR ("Invalid configuration" );return -EINVAL ; }
drivers/raw/skeleton/skeleton_rawdev_test.c +3 -2
@@ -126,7 +126,7 @@ test_rawdev_configure(void)struct skeleton_rawdev_conf rdev_conf_get = {0 };/* Check invalid configuration */ - ret =rte_rawdev_configure (test_dev_id,NULL ); + ret =rte_rawdev_configure (test_dev_id,NULL ,0 );RTE_TEST_ASSERT (ret == -EINVAL ,"Null configure; Expected -EINVAL, got %d" , ret);
@@ -137,7 +137,8 @@ test_rawdev_configure(void) rdev_info.dev_private = &rdev_conf_set; ret =rte_rawdev_configure (test_dev_id, - (rte_rawdev_obj_t)&rdev_info); + (rte_rawdev_obj_t)&rdev_info, +sizeof (rdev_conf_set));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to configure rawdev (%d)" , ret); rdev_info.dev_private = &rdev_conf_get;
examples/ioat/ioatfwd.c +1 -1
@@ -734,7 +734,7 @@ configure_rawdev_queue(uint32_t dev_id)struct rte_ioat_rawdev_config dev_config = { .ring_size = ring_size };struct rte_rawdev_info info = { .dev_private = &dev_config }; -if (rte_rawdev_configure (dev_id, &info) !=0 ) { +if (rte_rawdev_configure (dev_id, &info,sizeof (dev_config)) !=0 ) {rte_exit (EXIT_FAILURE ,"Error with rte_rawdev_configure()\n" ); }
examples/ntb/ntb_fwd.c +1 -1
@@ -1401,7 +1401,7 @@ main(int argc, char **argv) ntb_conf.num_queues = num_queues; ntb_conf.queue_size = nb_desc; ntb_rawdev_conf.dev_private = (rte_rawdev_obj_t)(&ntb_conf); - ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf); + ret =rte_rawdev_configure (dev_id, &ntb_rawdev_conf,sizeof (ntb_conf));if (ret)rte_exit (EXIT_FAILURE ,"Can't config ntb dev: err=%d, " "port=%u\n" , ret, dev_id);
lib/librte_rawdev/rte_rawdev.c +4 -2
@@ -104,7 +104,8 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info, }int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf) +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size) {struct rte_rawdev *dev;int diag;
@@ -123,7 +124,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf) }/* Configure the device */ - diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private); + diag = (*dev->dev_ops->dev_configure)(dev, dev_conf->dev_private, + dev_private_size);if (diag !=0 )RTE_RDEV_ERR ("dev%d dev_configure = %d" , dev_id, diag);else
lib/librte_rawdev/rte_rawdev.h +7 -1
@@ -116,13 +116,19 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,* driver/implementation can use to configure the device. It is also assumed * that once the configuration is done, a `queue_id` type field can be used * to refer to some arbitrary internal representation of a queue. +* @param dev_private_size +* The length of the memory space pointed to by dev_private in dev_info. +* This should be set to the size of the expected private structure to be +* used by the driver, and may be checked by drivers to ensure the expected +* struct type is provided. * * @return * - 0: Success, device configured. * - <0: Error code returned by the driver configuration function. */ int -rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf); +rte_rawdev_configure (uint16_t dev_id,struct rte_rawdev_info *dev_conf, +size_t dev_private_size);/**
lib/librte_rawdev/rte_rawdev_pmd.h +2 -1
@@ -160,7 +160,8 @@ typedef int (*rawdev_info_get_t)(struct rte_rawdev *dev,* Returns 0 on success */ typedef int (*rawdev_configure_t )(const struct rte_rawdev *dev, -rte_rawdev_obj_t config); +rte_rawdev_obj_t config, +size_t config_size);/** * Start a configured device.
Signature · 1 line
2.25.1
PATCH v3 4/7 rawdev: add private data length parameter to queue fns
In reply to Bruce RichardsonThe queue setup and queue defaults query functions take a void * parameter as configuration data, preventing any compile-time checking of the parameters and limiting runtime checks. Adding in the length of the expected structure provides a measure of typechecking, and can also be used for ABI compatibility in future, since ABI changes involving structs almost always involve a change in size.
---
V3: Added release note entry
--- doc/guides/rel_notes/release_20_11.rst | 1 + drivers/raw/ntb/ntb.c | 25 ++++++++++++++++----- drivers/raw/skeleton/skeleton_rawdev.c | 12 ++++++---- drivers/raw/skeleton/skeleton_rawdev_test.c | 8 +++---- examples/ntb/ntb_fwd.c | 3 ++- lib/librte_rawdev/rte_rawdev.c | 12 ++++++---- lib/librte_rawdev/rte_rawdev.h | 10 +++++++-- lib/librte_rawdev/rte_rawdev_pmd.h | 6 +++-- 8 files changed, 54 insertions(+), 23 deletions(-)
doc/guides/rel_notes/release_20_11.rst +1 -0
@@ -85,6 +85,7 @@ API Changes ======================================================= * rawdev: Added a structure size parameter to the functions + ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``, ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``, allowing limited driver type-checking and ABI compatibility.
drivers/raw/ntb/ntb.c +19 -6
@@ -249,11 +249,15 @@ ntb_dev_intr_handler(void *param)static void ntb_queue_conf_get (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *q_conf = queue_conf;struct ntb_hw *hw = dev->dev_private; +if (conf_size !=sizeof (*q_conf)) +return ; + q_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh; q_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc; q_conf->rx_mp = hw->rx_queues[queue_id]->mpool;
@@ -294,12 +298,16 @@ ntb_rxq_release(struct ntb_rx_queue *rxq)static int ntb_rxq_setup (struct rte_rawdev *dev,uint16_t qp_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *rxq_conf = queue_conf;struct ntb_hw *hw = dev->dev_private;struct ntb_rx_queue *rxq; +if (conf_size !=sizeof (*rxq_conf)) +return -EINVAL ; +/* Allocate the rx queue data structure */ rxq = rte_zmalloc_socket("ntb rx queue", sizeof(struct ntb_rx_queue),
@@ -375,13 +383,17 @@ ntb_txq_release(struct ntb_tx_queue *txq)static int ntb_txq_setup (struct rte_rawdev *dev,uint16_t qp_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_queue_conf *txq_conf = queue_conf;struct ntb_hw *hw = dev->dev_private;struct ntb_tx_queue *txq;uint16_t i, prev; +if (conf_size !=sizeof (*txq_conf)) +return -EINVAL ; +/* Allocate the TX queue data structure. */ txq = rte_zmalloc_socket("ntb tx queue", sizeof(struct ntb_tx_queue),
@@ -439,7 +451,8 @@ ntb_txq_setup(struct rte_rawdev *dev,static int ntb_queue_setup (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct ntb_hw *hw = dev->dev_private;int ret;
@@ -447,11 +460,11 @@ ntb_queue_setup(struct rte_rawdev *dev,if (queue_id >= hw->queue_pairs)return -EINVAL ; - ret =ntb_txq_setup (dev, queue_id, queue_conf); + ret =ntb_txq_setup (dev, queue_id, queue_conf, conf_size);if (ret <0 )return ret; - ret =ntb_rxq_setup (dev, queue_id, queue_conf); + ret =ntb_rxq_setup (dev, queue_id, queue_conf, conf_size);return ret; }
drivers/raw/skeleton/skeleton_rawdev.c +8 -4
@@ -222,14 +222,16 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)static void skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_queue *skelq;SKELETON_PMD_FUNC_TRACE (); -if (!dev || !queue_conf) +if (!dev || !queue_conf || + conf_size !=sizeof (struct skeleton_rawdev_queue ))return ; skeldev =skeleton_rawdev_get_priv (dev);
@@ -252,7 +254,8 @@ clear_queue_bufs(int queue_id)static int skeleton_rawdev_queue_setup (struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t conf_size) {int ret =0 ;struct skeleton_rawdev *skeldev;
@@ -260,7 +263,8 @@ static int skeleton_rawdev_queue_setup(struct rte_rawdev *dev,SKELETON_PMD_FUNC_TRACE (); -if (!dev || !queue_conf) +if (!dev || !queue_conf || + conf_size !=sizeof (struct skeleton_rawdev_queue ))return -EINVAL ; skeldev =skeleton_rawdev_get_priv (dev);
drivers/raw/skeleton/skeleton_rawdev_test.c +4 -4
@@ -185,7 +185,7 @@ test_rawdev_queue_default_conf_get(void)* depth = DEF_DEPTH */ for (i =0 ; i < rdev_conf_get.num_queues; i++) { -rte_rawdev_queue_conf_get (test_dev_id, i, &q); +rte_rawdev_queue_conf_get (test_dev_id, i, &q,sizeof (q));RTE_TEST_ASSERT_EQUAL (q.depth,SKELETON_QUEUE_DEF_DEPTH ,"Invalid default depth of queue (%d)" , q.depth);
@@ -235,11 +235,11 @@ test_rawdev_queue_setup(void)/* Modify the queue depth for Queue 0 and attach it */ qset.depth =15 ; qset.state =SKELETON_QUEUE_ATTACH ; - ret =rte_rawdev_queue_setup (test_dev_id,0 , &qset); + ret =rte_rawdev_queue_setup (test_dev_id,0 , &qset,sizeof (qset));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to setup queue (%d)" , ret);/* Now, fetching the queue 0 should show depth as 15 */ - ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget); + ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget,sizeof (qget));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get queue config (%d)" , ret); RTE_TEST_ASSERT_EQUAL(qset.depth, qget.depth,
@@ -263,7 +263,7 @@ test_rawdev_queue_release(void)RTE_TEST_ASSERT_SUCCESS (ret,"Failed to release queue 0; (%d)" , ret);/* Now, fetching the queue 0 should show depth as default */ - ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget); + ret =rte_rawdev_queue_conf_get (test_dev_id,0 , &qget,sizeof (qget));RTE_TEST_ASSERT_SUCCESS (ret,"Failed to get queue config (%d)" , ret); RTE_TEST_ASSERT_EQUAL(qget.depth, SKELETON_QUEUE_DEF_DEPTH,
examples/ntb/ntb_fwd.c +2 -1
@@ -1411,7 +1411,8 @@ main(int argc, char **argv) ntb_q_conf.rx_mp = mbuf_pool;for (i =0 ; i < num_queues; i++) {/* Setup rawdev queue */ - ret =rte_rawdev_queue_setup (dev_id, i, &ntb_q_conf); + ret =rte_rawdev_queue_setup (dev_id, i, &ntb_q_conf, +sizeof (ntb_q_conf));if (ret <0 )rte_exit (EXIT_FAILURE ,"Failed to setup ntb queue %u.\n" , i);
lib/librte_rawdev/rte_rawdev.c +8 -4
@@ -137,7 +137,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,int rte_rawdev_queue_conf_get (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size) {struct rte_rawdev *dev;
@@ -145,14 +146,16 @@ rte_rawdev_queue_conf_get(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_def_conf, -ENOTSUP ); - (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf); + (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, + queue_conf_size);return 0 ; }int rte_rawdev_queue_setup (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf) +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size) {struct rte_rawdev *dev;
@@ -160,7 +163,8 @@ rte_rawdev_queue_setup(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_setup, -ENOTSUP ); -return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf); +return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf, + queue_conf_size); }int
lib/librte_rawdev/rte_rawdev.h +8 -2
@@ -146,6 +146,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,* previously supplied to rte_rawdev_configure(). * @param[out] queue_conf * The pointer to the default raw queue configuration data. +* @param queue_conf_size +* The size of the structure pointed to by queue_conf * @return * - 0: Success, driver updates the default raw queue configuration data. * - <0: Error code returned by the driver info get function.
@@ -156,7 +158,8 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,int rte_rawdev_queue_conf_get (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Allocate and set up a raw queue for a raw device.
@@ -169,6 +172,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,* @param queue_conf * The pointer to the configuration data to be used for the raw queue. * NULL value is allowed, in which case default configuration used. +* @param queue_conf_size +* The size of the structure pointed to by queue_conf * * @see rte_rawdev_queue_conf_get() *
@@ -179,7 +184,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,int rte_rawdev_queue_setup (uint16_t dev_id,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Release and deallocate a raw queue from a raw device.
lib/librte_rawdev/rte_rawdev_pmd.h +4 -2
@@ -218,7 +218,8 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);*/ typedef void (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Setup an raw queue.
@@ -235,7 +236,8 @@ typedef void (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,*/ typedef int (*rawdev_queue_setup_t )(struct rte_rawdev *dev,uint16_t queue_id, -rte_rawdev_obj_t queue_conf); +rte_rawdev_obj_t queue_conf, +size_t queue_conf_size);/** * Release resources allocated by given raw queue.
Signature · 1 line
2.25.1
PATCH v3 5/7 rawdev: allow queue config query to return error
In reply to Bruce RichardsonThe driver APIs for returning the queue default config can fail if the parameters are invalid, or other reasons, so allow them to return error codes to the rawdev layer and from hence to the app.
---
v3: add release note update
--- doc/guides/rel_notes/release_20_11.rst | 1 + drivers/raw/ntb/ntb.c | 6 ++++-- drivers/raw/skeleton/skeleton_rawdev.c | 12 +++++++----- lib/librte_rawdev/rte_rawdev.c | 3 +-- lib/librte_rawdev/rte_rawdev_pmd.h | 4 +++- 5 files changed, 16 insertions(+), 10 deletions(-)
doc/guides/rel_notes/release_20_11.rst +1 -0
@@ -90,6 +90,7 @@ API Changes allowing limited driver type-checking and ABI compatibility. * rawdev: Changed the return type of the function ``rte_dev_info_get()`` + and the function ``rte_rawdev_queue_conf_get()`` from ``void`` to ``int`` allowing the return of error codes from drivers.
drivers/raw/ntb/ntb.c +4 -2
@@ -246,7 +246,7 @@ ntb_dev_intr_handler(void *param) } } -static void +static int ntb_queue_conf_get(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf,
@@ -256,11 +256,13 @@ ntb_queue_conf_get(struct rte_rawdev *dev,struct ntb_hw *hw = dev->dev_private;if (conf_size !=sizeof (*q_conf)) -return ; +return -EINVAL ; q_conf->tx_free_thresh = hw->tx_queues[queue_id]->tx_free_thresh; q_conf->nb_desc = hw->rx_queues[queue_id]->nb_rx_desc; q_conf->rx_mp = hw->rx_queues[queue_id]->mpool; + +return 0 ; } static void
drivers/raw/skeleton/skeleton_rawdev.c +7 -5
@@ -220,10 +220,10 @@ static int skeleton_rawdev_reset(struct rte_rawdev *dev)return 0 ; } -static void skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev, -uint16_t queue_id, -rte_rawdev_obj_t queue_conf, -size_t conf_size) +static int skeleton_rawdev_queue_def_conf (struct rte_rawdev *dev, +uint16_t queue_id, +rte_rawdev_obj_t queue_conf, +size_t conf_size) {struct skeleton_rawdev *skeldev;struct skeleton_rawdev_queue *skelq;
@@ -232,7 +232,7 @@ static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,if (!dev || !queue_conf || conf_size !=sizeof (struct skeleton_rawdev_queue )) -return ; +return -EINVAL ; skeldev =skeleton_rawdev_get_priv (dev); skelq = &skeldev->queues[queue_id];
@@ -240,6 +240,8 @@ static void skeleton_rawdev_queue_def_conf(struct rte_rawdev *dev,if (queue_id <SKELETON_MAX_QUEUES )rte_memcpy (queue_conf, skelq,sizeof (struct skeleton_rawdev_queue )); + +return 0 ; } static void
lib/librte_rawdev/rte_rawdev.c +1 -2
@@ -146,9 +146,8 @@ rte_rawdev_queue_conf_get(uint16_t dev_id, dev = &rte_rawdevs[dev_id];RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->queue_def_conf, -ENOTSUP ); - (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, +return (*dev->dev_ops->queue_def_conf)(dev, queue_id, queue_conf, queue_conf_size); -return 0 ; }int
lib/librte_rawdev/rte_rawdev_pmd.h +3 -1
@@ -215,8 +215,10 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);* @param[out] queue_conf * Raw device queue configuration structure * +* @return +* Returns 0 on success, negative errno on failure */ -typedef void (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev, +typedef int (*rawdev_queue_conf_get_t )(struct rte_rawdev *dev,uint16_t queue_id,rte_rawdev_obj_t queue_conf,size_t queue_conf_size);
Signature · 1 line
2.25.1
PATCH v3 6/7 rawdev: mark start and stop functions optional
In reply to Bruce RichardsonNot all rawdevs will require a device start/stop function, so rather than requiring such drivers to provide dummy functions, just set the started/stopped rawdev flag from the rawdev layer and return success.
--- lib/librte_rawdev/rte_rawdev.c | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-)
lib/librte_rawdev/rte_rawdev.c +11 -7
@@ -398,20 +398,21 @@ rte_rawdev_start(uint16_t dev_id)RTE_RAWDEV_VALID_DEVID_OR_ERR_RET (dev_id, -EINVAL ); dev = &rte_rawdevs[dev_id]; -RTE_FUNC_PTR_OR_ERR_RET (*dev->dev_ops->dev_start, -ENOTSUP ); -if (dev->started !=0 ) {RTE_RDEV_ERR ("Device with dev_id=%" PRIu8"already started" , dev_id);return 0 ; } +if (dev->dev_ops->dev_start ==NULL ) + goto mark_started; + diag = (*dev->dev_ops->dev_start)(dev); -if (diag ==0 ) - dev->started =1 ; -else +if (diag !=0 )return diag; +mark_started: + dev->started =1 ;return 0 ; }
@@ -425,15 +426,18 @@ rte_rawdev_stop(uint16_t dev_id)RTE_RAWDEV_VALID_DEVID_OR_RET (dev_id); dev = &rte_rawdevs[dev_id]; -RTE_FUNC_PTR_OR_RET (*dev->dev_ops->dev_stop); -if (dev->started ==0 ) {RTE_RDEV_ERR ("Device with dev_id=%" PRIu8"already stopped" , dev_id);return ; } +if (dev->dev_ops->dev_stop ==NULL ) + goto mark_stopped; + (*dev->dev_ops->dev_stop)(dev); + +mark_stopped: dev->started =0 ; }
Signature · 1 line
2.25.1
PATCH v3 7/7 doc: remove rawdev deprecation notice
In reply to Bruce RichardsonSince all changes covered by the deprecation notice have been applied, the notice can be removed.
--- doc/guides/rel_notes/deprecation.rst | 7 ------- 1 file changed, 7 deletions(-)
doc/guides/rel_notes/deprecation.rst +0 -7
@@ -294,13 +294,6 @@ Deprecation Notices - https://patches.dpdk.org/patch/71457/ - https://patches.dpdk.org/patch/71456/ -* rawdev: The rawdev APIs which take a device-specific structure as - parameter directly, or indirectly via a "private" pointer inside another - structure, will be modified to take an additional parameter of the - structure size. The affected APIs will include ``rte_rawdev_info_get``, - ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and - ``rte_rawdev_queue_setup``. - * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value will be removed. This enum value is not used inside DPDK, while it prevents to add new classify algorithms without causing an ABI breakage.
Signature · 1 line
2.25.1
Thomas Monjalon
AppliedQuoted 17 lines · Bruce Richardson
This patchset proposes some internal and externally-visible changes to the rawdev API, the ABI change of which were previously announced.
The changes are in two main areas:
* For any APIs which take a void * parameter for driver-specific structs,add an additional parameter to provide the struct length. This allows some runtime type-checking, as well as possible ABI-compatibility support in the future as structure change generally involve a change in the size of the structure.
* Ensure all APIs which can return error values have int type, rather than
void. Since functions like
info_getandqueue_default_getcan now do some typechecking, they need to be modified to allow them to return error codes on failure.
Quoted 7 lines
V3:
- fix doxygen error
- add release note update for changes to public APIsV2:
- add additional patch to make start/stop functions optional
- remove deprecation notice once changes applied
Applied, thanks