[Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Patch v5] net/netvsc: fix number Tx queues > Rx queues

[longli]

From: Alan Elder <alan.elder@microsoft.com>

The previous code allowed the number of Tx queues to be set higher than
the number of Rx queues.  If a packet was sent on a Tx queue with index
>= number Rx queues there was a segfault due to accessing beyond the end
of the dev->data->rx_queues[] array.

This commit fixes the issue by creating an Rx queue for every Tx queue
meaning that an event buffer is allocated to handle receiving Tx
completion messages.

mbuf pool and Rx ring are not allocated for these additional Rx queues
and RSS configuration ensures that no packets are received on them.

Fixes: 4e9c73e96e83 ("net/netvsc: add Hyper-V network device")
Cc: sthemmin@microsoft.com
Cc: stable@dpdk.org

Signed-off-by: Alan Elder <alan.elder@microsoft.com>
Signed-off-by: Long Li <longli@microsoft.com>
---
v5:
* Resend/fixed up the last verison of the patch garbled in patchwork

v4:
* Include segfault core stack in commit message

v3:
* Handle case of Rx queue creation failure in hn_dev_tx_queue_setup.
* Re-use rx queue if it has already been allocated.
* Don't allocate an mbuf if pool is NULL.  This avoids segfault if RSS
  configuration is incorrect.

v2:
* Remove function declaration for static non-member function

 drivers/net/netvsc/hn_ethdev.c |  9 +++++
 drivers/net/netvsc/hn_rxtx.c   | 68 +++++++++++++++++++++++++++++-----
 2 files changed, 68 insertions(+), 9 deletions(-)

diff --git a/drivers/net/netvsc/hn_ethdev.c b/drivers/net/netvsc/hn_ethdev.c
index f8cb05a118..1736cb5d07 100644
--- a/drivers/net/netvsc/hn_ethdev.c
+++ b/drivers/net/netvsc/hn_ethdev.c
@@ -313,6 +313,15 @@ static int hn_rss_reta_update(struct rte_eth_dev *dev,
 
 		if (reta_conf[idx].mask & mask)
 			hv->rss_ind[i] = reta_conf[idx].reta[shift];
+
+		/*
+		 * Ensure we don't allow config that directs traffic to an Rx
+		 * queue that we aren't going to poll
+		 */
+		if (hv->rss_ind[i] >=  dev->data->nb_rx_queues) {
+			PMD_DRV_LOG(ERR, "RSS distributing traffic to invalid Rx queue");
+			return -EINVAL;
+		}
 	}
 
 	err = hn_rndis_conf_rss(hv, NDIS_RSS_FLAG_DISABLE);
diff --git a/drivers/net/netvsc/hn_rxtx.c b/drivers/net/netvsc/hn_rxtx.c
index 870f62e5fa..3e5386aaf1 100644
--- a/drivers/net/netvsc/hn_rxtx.c
+++ b/drivers/net/netvsc/hn_rxtx.c
@@ -222,6 +222,16 @@ static void hn_reset_txagg(struct hn_tx_queue *txq)
 	txq->agg_prevpkt = NULL;
 }
 
+static void
+hn_rx_queue_free_common(struct hn_rx_queue *rxq) {
+	if (!rxq)
+		return;
+
+	rte_free(rxq->rxbuf_info);
+	rte_free(rxq->event_buf);
+	rte_free(rxq);
+}
+
 int
 hn_dev_tx_queue_setup(struct rte_eth_dev *dev,
 		      uint16_t queue_idx, uint16_t nb_desc,
@@ -231,6 +241,7 @@ hn_dev_tx_queue_setup(struct rte_eth_dev *dev,
 {
 	struct hn_data *hv = dev->data->dev_private;
 	struct hn_tx_queue *txq;
+	struct hn_rx_queue *rxq = NULL;
 	char name[RTE_MEMPOOL_NAMESIZE];
 	uint32_t tx_free_thresh;
 	int err = -ENOMEM;
@@ -289,6 +300,27 @@ hn_dev_tx_queue_setup(struct rte_eth_dev *dev,
 		goto error;
 	}
 
+	/*
+	 * If there are more Tx queues than Rx queues, allocate rx_queues
+	 * with event buffer so that Tx completion messages can still be
+	 * received
+	 */
+	if (queue_idx >= dev->data->nb_rx_queues) {
+		rxq = hn_rx_queue_alloc(hv, queue_idx, socket_id);
+
+		if (!rxq) {
+			err = -ENOMEM;
+			goto error;
+		}
+
+		/*
+		 * Don't allocate mbuf pool or rx ring.  RSS is always configured
+		 * to ensure packets aren't received by this Rx queue.
+		 */
+		rxq->mb_pool = NULL;
+		rxq->rx_ring = NULL;
+	}
+
 	txq->agg_szmax  = RTE_MIN(hv->chim_szmax, hv->rndis_agg_size);
 	txq->agg_pktmax = hv->rndis_agg_pkts;
 	txq->agg_align  = hv->rndis_agg_align;
@@ -299,12 +331,15 @@ hn_dev_tx_queue_setup(struct rte_eth_dev *dev,
 				     socket_id, tx_conf);
 	if (err == 0) {
 		dev->data->tx_queues[queue_idx] = txq;
+		if (rxq != NULL)
+			dev->data->rx_queues[queue_idx] = rxq;
 		return 0;
 	}
 
 error:
 	rte_mempool_free(txq->txdesc_pool);
 	rte_memzone_free(txq->tx_rndis_mz);
+	hn_rx_queue_free_common(rxq);
 	rte_free(txq);
 	return err;
 }
@@ -351,6 +386,12 @@ hn_dev_tx_queue_release(struct rte_eth_dev *dev, uint16_t qid)
 
 	if (!txq)
 		return;
+	/*
+	 * Free any Rx queues allocated for a Tx queue without a corresponding
+	 * Rx queue
+	 */
+	if (qid >= dev->data->nb_rx_queues)
+		hn_rx_queue_free_common(dev->data->rx_queues[qid]);
 
 	rte_mempool_free(txq->txdesc_pool);
 
@@ -540,10 +581,12 @@ static void hn_rxpkt(struct hn_rx_queue *rxq, struct hn_rx_bufinfo *rxb,
 		     const struct hn_rxinfo *info)
 {
 	struct hn_data *hv = rxq->hv;
-	struct rte_mbuf *m;
+	struct rte_mbuf *m = NULL;
 	bool use_extbuf = false;
 
-	m = rte_pktmbuf_alloc(rxq->mb_pool);
+	if (likely(rxq->mb_pool != NULL))
+		m = rte_pktmbuf_alloc(rxq->mb_pool);
+
 	if (unlikely(!m)) {
 		struct rte_eth_dev *dev =
 			&rte_eth_devices[rxq->port_id];
@@ -930,7 +973,15 @@ hn_dev_rx_queue_setup(struct rte_eth_dev *dev,
 	if (queue_idx == 0) {
 		rxq = hv->primary;
 	} else {
-		rxq = hn_rx_queue_alloc(hv, queue_idx, socket_id);
+		/*
+		 * If the number of Tx queues was previously greater than the
+		 * number of Rx queues, we may already have allocated an rxq.
+		 */
+		if (!dev->data->rx_queues[queue_idx])
+			rxq = hn_rx_queue_alloc(hv, queue_idx, socket_id);
+		else
+			rxq = dev->data->rx_queues[queue_idx];
+
 		if (!rxq)
 			return -ENOMEM;
 	}
@@ -963,9 +1014,10 @@ hn_dev_rx_queue_setup(struct rte_eth_dev *dev,
 
 fail:
 	rte_ring_free(rxq->rx_ring);
-	rte_free(rxq->rxbuf_info);
-	rte_free(rxq->event_buf);
-	rte_free(rxq);
+	/* Only free rxq if it was created in this function. */
+	if (!dev->data->rx_queues[queue_idx])
+		hn_rx_queue_free_common(rxq);
+
 	return error;
 }
 
@@ -986,9 +1038,7 @@ hn_rx_queue_free(struct hn_rx_queue *rxq, bool keep_primary)
 	if (keep_primary && rxq == rxq->hv->primary)
 		return;
 
-	rte_free(rxq->rxbuf_info);
-	rte_free(rxq->event_buf);
-	rte_free(rxq);
+	hn_rx_queue_free_common(rxq);
 }
 
 void
-- 
2.25.1

Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Stephen Hemminger]

On Thu, 17 Oct 2024 12:20:29 -0700
longli@linuxonhyperv.com wrote:

> +static void
> +hn_rx_queue_free_common(struct hn_rx_queue *rxq) {
> +	if (!rxq)
> +		return;
> +
> +	rte_free(rxq->rxbuf_info);
> +	rte_free(rxq->event_buf);
> +	rte_free(rxq);
> +}

Minor nit, DPDK style is for the bracket on the next line.
Checkpatch will complain about this.

RE: [Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Long Li]

> Subject: Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues
> 
> On Thu, 17 Oct 2024 12:20:29 -0700
> longli@linuxonhyperv.com wrote:
> 
> > +static void
> > +hn_rx_queue_free_common(struct hn_rx_queue *rxq) {
> > +	if (!rxq)
> > +		return;
> > +
> > +	rte_free(rxq->rxbuf_info);
> > +	rte_free(rxq->event_buf);
> > +	rte_free(rxq);
> > +}
> 
> Minor nit, DPDK style is for the bracket on the next line.
> Checkpatch will complain about this.

Is it okay to take the patch as is, or should I send a v6 to have it fixed?

Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Stephen Hemminger]

On Thu, 17 Oct 2024 22:38:49 +0000
Long Li <longli@microsoft.com> wrote:

> > Subject: Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues
> > 
> > On Thu, 17 Oct 2024 12:20:29 -0700
> > longli@linuxonhyperv.com wrote:
> >   
> > > +static void
> > > +hn_rx_queue_free_common(struct hn_rx_queue *rxq) {
> > > +	if (!rxq)
> > > +		return;
> > > +
> > > +	rte_free(rxq->rxbuf_info);
> > > +	rte_free(rxq->event_buf);
> > > +	rte_free(rxq);
> > > +}  
> > 
> > Minor nit, DPDK style is for the bracket on the next line.
> > Checkpatch will complain about this.  
> 
> Is it okay to take the patch as is, or should I send a v6 to have it fixed?

It is ok as is, but followup to fix the minor stuff like this would be good.

Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Ferruh Yigit]

On 10/18/2024 12:02 AM, Stephen Hemminger wrote:
> On Thu, 17 Oct 2024 22:38:49 +0000
> Long Li <longli@microsoft.com> wrote:
> 
>>> Subject: Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues
>>>
>>> On Thu, 17 Oct 2024 12:20:29 -0700
>>> longli@linuxonhyperv.com wrote:
>>>   
>>>> +static void
>>>> +hn_rx_queue_free_common(struct hn_rx_queue *rxq) {
>>>> +	if (!rxq)
>>>> +		return;
>>>> +
>>>> +	rte_free(rxq->rxbuf_info);
>>>> +	rte_free(rxq->event_buf);
>>>> +	rte_free(rxq);
>>>> +}  
>>>
>>> Minor nit, DPDK style is for the bracket on the next line.
>>> Checkpatch will complain about this.  
>>
>> Is it okay to take the patch as is, or should I send a v6 to have it fixed?
> 
> It is ok as is, but followup to fix the minor stuff like this would be good.
>

I will fix this one while merging.

Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Ferruh Yigit]

Recheck-request: intel-Functional, intel-Testing

Re: [Patch v5] net/netvsc: fix number Tx queues > Rx queues

[Ferruh Yigit]

On 10/17/2024 8:20 PM, longli@linuxonhyperv.com wrote:
> From: Alan Elder <alan.elder@microsoft.com>
> 
> The previous code allowed the number of Tx queues to be set higher than
> the number of Rx queues.  If a packet was sent on a Tx queue with index
>> = number Rx queues there was a segfault due to accessing beyond the end
> of the dev->data->rx_queues[] array.
> 
> This commit fixes the issue by creating an Rx queue for every Tx queue
> meaning that an event buffer is allocated to handle receiving Tx
> completion messages.
> 
> mbuf pool and Rx ring are not allocated for these additional Rx queues
> and RSS configuration ensures that no packets are received on them.
> 
> Fixes: 4e9c73e96e83 ("net/netvsc: add Hyper-V network device")
> Cc: sthemmin@microsoft.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Alan Elder <alan.elder@microsoft.com>
> Signed-off-by: Long Li <longli@microsoft.com>
>

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

Checkpatch warning fixed while merging.