ethdev: rte_eth_rx_queue_count is a dataplane function

Message ID 20220818093744.76157-1-mb@smartsharesystems.com (mailing list archive)
State Accepted, archived
Delegated to: Andrew Rybchenko
Headers
Series ethdev: rte_eth_rx_queue_count is a dataplane function |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS

Commit Message

Morten Brørup Aug. 18, 2022, 9:37 a.m. UTC
Applications may use rte_eth_rx_queue_count() in the RX stage of the
dataplane, so only check the function parameters if built with
RTE_ETHDEV_DEBUG_RX.

Signed-off-by: Morten Brørup <mb@smartsharesystems.com>
---
 lib/ethdev/rte_ethdev.h | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)
  

Comments

Ferruh Yigit Aug. 18, 2022, 12:23 p.m. UTC | #1
On 8/18/2022 10:37 AM, Morten Brørup wrote:
> Applications may use rte_eth_rx_queue_count() in the RX stage of the
> dataplane, so only check the function parameters if built with
> RTE_ETHDEV_DEBUG_RX.
> 
> Signed-off-by: Morten Brørup <mb@smartsharesystems.com>

I don't remember if those checks done by default intentionally, but I 
don't think so,

And since other relevant functions do the same thing:

Acked-by: Ferruh Yigit <ferruh.yigit@xilinx.com>
  
Andrew Rybchenko Sept. 12, 2022, 2:47 p.m. UTC | #2
On 8/18/22 15:23, Ferruh Yigit wrote:
> On 8/18/2022 10:37 AM, Morten Brørup wrote:
>> Applications may use rte_eth_rx_queue_count() in the RX stage of the
>> dataplane, so only check the function parameters if built with
>> RTE_ETHDEV_DEBUG_RX.
>>
>> Signed-off-by: Morten Brørup <mb@smartsharesystems.com>
> 
> I don't remember if those checks done by default intentionally, but I 
> don't think so,
> 
> And since other relevant functions do the same thing:
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@xilinx.com>
> 

The patch itself looks good to me.
Summary should be fixed to be not a statement and should not
mention function name. Other than that:

Reviewed-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
  
Morten Brørup Sept. 22, 2022, 1:46 p.m. UTC | #3
> From: Andrew Rybchenko [mailto:andrew.rybchenko@oktetlabs.ru]
> Sent: Monday, 12 September 2022 16.47
> 
> On 8/18/22 15:23, Ferruh Yigit wrote:
> > On 8/18/2022 10:37 AM, Morten Brørup wrote:
> >> Applications may use rte_eth_rx_queue_count() in the RX stage of the
> >> dataplane, so only check the function parameters if built with
> >> RTE_ETHDEV_DEBUG_RX.
> >>
> >> Signed-off-by: Morten Brørup <mb@smartsharesystems.com>
> >
> > I don't remember if those checks done by default intentionally, but I
> > don't think so,
> >
> > And since other relevant functions do the same thing:
> >
> > Acked-by: Ferruh Yigit <ferruh.yigit@xilinx.com>
> >
> 
> The patch itself looks good to me.
> Summary should be fixed to be not a statement and should not
> mention function name.

Please feel free to fix when merging. :-)

> Other than that:
> 
> Reviewed-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>

Thank you.

-Morten
  
Andrew Rybchenko Sept. 28, 2022, 7:57 a.m. UTC | #4
On 9/22/22 16:46, Morten Brørup wrote:
>> From: Andrew Rybchenko [mailto:andrew.rybchenko@oktetlabs.ru]
>> Sent: Monday, 12 September 2022 16.47
>>
>> On 8/18/22 15:23, Ferruh Yigit wrote:
>>> On 8/18/2022 10:37 AM, Morten Brørup wrote:
>>>> Applications may use rte_eth_rx_queue_count() in the RX stage of the
>>>> dataplane, so only check the function parameters if built with
>>>> RTE_ETHDEV_DEBUG_RX.
>>>>
>>>> Signed-off-by: Morten Brørup <mb@smartsharesystems.com>
>>>
>>> I don't remember if those checks done by default intentionally, but I
>>> don't think so,
>>>
>>> And since other relevant functions do the same thing:
>>>
>>> Acked-by: Ferruh Yigit <ferruh.yigit@xilinx.com>
>>>
>>
>> The patch itself looks good to me.
>> Summary should be fixed to be not a statement and should not
>> mention function name.
> 
> Please feel free to fix when merging. :-)
> 
>> Other than that:
>>
>> Reviewed-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> 
> Thank you.
> 
> -Morten
> 

Applied to dpdk-next-net/main, thanks.
  

Patch

diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index de9e970d4d..8d5d9b42bf 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -5681,6 +5681,10 @@  rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
 /**
  * Get the number of used descriptors of a Rx queue
  *
+ * Since it's a dataplane function, no check is performed on port_id and
+ * queue_id. The caller must therefore ensure that the port is enabled
+ * and the queue is configured and running.
+ *
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param queue_id
@@ -5688,8 +5692,8 @@  rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
  * @return
  *  The number of used descriptors in the specific queue, or:
  *   - (-ENODEV) if *port_id* is invalid.
- *     (-EINVAL) if *queue_id* is invalid
- *     (-ENOTSUP) if the device does not support this function
+ *   - (-EINVAL) if *queue_id* is invalid
+ *   - (-ENOTSUP) if the device does not support this function
  */
 static inline int
 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
@@ -5697,6 +5701,7 @@  rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
 	struct rte_eth_fp_ops *p;
 	void *qd;
 
+#ifdef RTE_ETHDEV_DEBUG_RX
 	if (port_id >= RTE_MAX_ETHPORTS ||
 			queue_id >= RTE_MAX_QUEUES_PER_PORT) {
 		RTE_ETHDEV_LOG(ERR,
@@ -5704,16 +5709,19 @@  rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
 			port_id, queue_id);
 		return -EINVAL;
 	}
+#endif
 
 	/* fetch pointer to queue data */
 	p = &rte_eth_fp_ops[port_id];
 	qd = p->rxq.data[queue_id];
 
+#ifdef RTE_ETHDEV_DEBUG_RX
 	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
-	RTE_FUNC_PTR_OR_ERR_RET(*p->rx_queue_count, -ENOTSUP);
 	if (qd == NULL)
 		return -EINVAL;
+#endif
 
+	RTE_FUNC_PTR_OR_ERR_RET(*p->rx_queue_count, -ENOTSUP);
 	return (int)(*p->rx_queue_count)(qd);
 }