net/pcap: fix infinite Rx with large files

Message ID 20210203154920.2449179-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series net/pcap: fix infinite Rx with large files |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing warning Testing issues

Commit Message

Ferruh Yigit Feb. 3, 2021, 3:49 p.m. UTC
  Packet forwarding is not working when infinite Rx feature is used with
large .pcap files that has high number of packets.

The problem is number of allocated mbufs are less than the infinite Rx
ring size, and all mbufs consumed to fill the ring, so there is no mbuf
left for forwarding.

Current logic can not detect that infinite Rx ring is not filled
completely and no more mbufs left, and setup continues which leads
silent fail on packet forwarding.

There isn't much can be done when there is not enough mbuf for the given
.pcap file, so additional checks added to detect the case and fail
explicitly with an error log.

Bugzilla ID: 595
Fixes: a3f5252e5cbd ("net/pcap: enable infinitely Rx a pcap file")
Cc: stable@dpdk.org

Reported-by: Cian Ferriter <cian.ferriter@intel.com>
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 drivers/net/pcap/rte_eth_pcap.c | 40 ++++++++++++++++++++-------------
 1 file changed, 25 insertions(+), 15 deletions(-)
  

Comments

Cian Ferriter Feb. 4, 2021, 4:03 p.m. UTC | #1
Hi Ferruh,

This fixes the issue I was seeing. Now an error is reported, rather than silent failure.

I have one piece of feedback about the particular error message below inline which you can take or leave, I'm happy for you to upstream this fix either way.

Acked-by: Cian Ferriter <cian.ferriter@intel.com>

> -----Original Message-----
> From: Yigit, Ferruh <ferruh.yigit@intel.com>
> Sent: Wednesday 3 February 2021 15:49
> To: Ferriter, Cian <cian.ferriter@intel.com>
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org; stable@dpdk.org
> Subject: [PATCH] net/pcap: fix infinite Rx with large files
> 
> Packet forwarding is not working when infinite Rx feature is used with
> large .pcap files that has high number of packets.
> 
> The problem is number of allocated mbufs are less than the infinite Rx
> ring size, and all mbufs consumed to fill the ring, so there is no mbuf
> left for forwarding.
> 
> Current logic can not detect that infinite Rx ring is not filled
> completely and no more mbufs left, and setup continues which leads
> silent fail on packet forwarding.
> 
> There isn't much can be done when there is not enough mbuf for the given
> .pcap file, so additional checks added to detect the case and fail
> explicitly with an error log.
> 
> Bugzilla ID: 595
> Fixes: a3f5252e5cbd ("net/pcap: enable infinitely Rx a pcap file")
> Cc: stable@dpdk.org
> 
> Reported-by: Cian Ferriter <cian.ferriter@intel.com>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
>  drivers/net/pcap/rte_eth_pcap.c | 40 ++++++++++++++++++++-------------
>  1 file changed, 25 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/net/pcap/rte_eth_pcap.c
> b/drivers/net/pcap/rte_eth_pcap.c
> index ff02ade70d1a..98f80368ca1d 100644
> --- a/drivers/net/pcap/rte_eth_pcap.c
> +++ b/drivers/net/pcap/rte_eth_pcap.c
> @@ -735,6 +735,17 @@ eth_stats_reset(struct rte_eth_dev *dev)
>  	return 0;
>  }
> 
> +static inline void
> +infinite_rx_ring_free(struct rte_ring *pkts)
> +{
> +	struct rte_mbuf *bufs;
> +
> +	while (!rte_ring_dequeue(pkts, (void **)&bufs))
> +		rte_pktmbuf_free(bufs);
> +
> +	rte_ring_free(pkts);
> +}
> +
>  static int
>  eth_dev_close(struct rte_eth_dev *dev)
>  {
> @@ -753,7 +764,6 @@ eth_dev_close(struct rte_eth_dev *dev)
>  	if (internals->infinite_rx) {
>  		for (i = 0; i < dev->data->nb_rx_queues; i++) {
>  			struct pcap_rx_queue *pcap_q = &internals-
> >rx_queue[i];
> -			struct rte_mbuf *pcap_buf;
> 
>  			/*
>  			 * 'pcap_q->pkts' can be NULL if 'eth_dev_close()'
> @@ -762,11 +772,7 @@ eth_dev_close(struct rte_eth_dev *dev)
>  			if (pcap_q->pkts == NULL)
>  				continue;
> 
> -			while (!rte_ring_dequeue(pcap_q->pkts,
> -					(void **)&pcap_buf))
> -				rte_pktmbuf_free(pcap_buf);
> -
> -			rte_ring_free(pcap_q->pkts);
> +			infinite_rx_ring_free(pcap_q->pkts);
>  		}
>  	}
> 
> @@ -835,21 +841,25 @@ eth_rx_queue_setup(struct rte_eth_dev *dev,
>  		while (eth_pcap_rx(pcap_q, bufs, 1)) {
>  			/* Check for multiseg mbufs. */
>  			if (bufs[0]->nb_segs != 1) {
> -				rte_pktmbuf_free(*bufs);
> -
> -				while (!rte_ring_dequeue(pcap_q->pkts,
> -						(void **)bufs))
> -					rte_pktmbuf_free(*bufs);
> -
> -				rte_ring_free(pcap_q->pkts);
> -				PMD_LOG(ERR, "Multiseg mbufs are not
> supported in infinite_rx "
> -						"mode.");
> +				infinite_rx_ring_free(pcap_q->pkts);
> +				PMD_LOG(ERR,
> +					"Multiseg mbufs are not supported in
> infinite_rx mode.");
>  				return -EINVAL;
>  			}
> 
>  			rte_ring_enqueue_bulk(pcap_q->pkts,
>  					(void * const *)bufs, 1, NULL);
>  		}
> +
> +		if (rte_ring_count(pcap_q->pkts) < pcap_pkt_count) {
> +			infinite_rx_ring_free(pcap_q->pkts);
> +			PMD_LOG(ERR,
> +				"Not enough mbuf to fill the infinite_rx ring. "
> +				"At least %" PRIu64 " mbufs per queue is
> required to fill the ring",
> +				pcap_pkt_count);

[Cian Ferriter] 
So we can say that the issue is either too many packets in the PCAP or too few mbufs for the ring. What can the user do about this?
They can use a PCAP with less packets.
Can they change how many mbufs are available by passing more memory or any other method?

Should be mention these remedies, or is this outside the scope for an error message?

As I mentioned, I'm happy for you to upstream either way.

> +			return -EINVAL;
> +		}
> +
>  		/*
>  		 * Reset the stats for this queue since eth_pcap_rx calls
> above
>  		 * didn't result in the application receiving packets.
> --
> 2.29.2
  
Ferruh Yigit Feb. 4, 2021, 4:28 p.m. UTC | #2
On 2/4/2021 4:03 PM, Ferriter, Cian wrote:
> Hi Ferruh,
> 
> This fixes the issue I was seeing. Now an error is reported, rather than silent failure.
> 
> I have one piece of feedback about the particular error message below inline which you can take or leave, I'm happy for you to upstream this fix either way.
> 
> Acked-by: Cian Ferriter <cian.ferriter@intel.com>
> 
>> -----Original Message-----
>> From: Yigit, Ferruh <ferruh.yigit@intel.com>
>> Sent: Wednesday 3 February 2021 15:49
>> To: Ferriter, Cian <cian.ferriter@intel.com>
>> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org; stable@dpdk.org
>> Subject: [PATCH] net/pcap: fix infinite Rx with large files
>>
>> Packet forwarding is not working when infinite Rx feature is used with
>> large .pcap files that has high number of packets.
>>
>> The problem is number of allocated mbufs are less than the infinite Rx
>> ring size, and all mbufs consumed to fill the ring, so there is no mbuf
>> left for forwarding.
>>
>> Current logic can not detect that infinite Rx ring is not filled
>> completely and no more mbufs left, and setup continues which leads
>> silent fail on packet forwarding.
>>
>> There isn't much can be done when there is not enough mbuf for the given
>> .pcap file, so additional checks added to detect the case and fail
>> explicitly with an error log.
>>
>> Bugzilla ID: 595
>> Fixes: a3f5252e5cbd ("net/pcap: enable infinitely Rx a pcap file")
>> Cc: stable@dpdk.org
>>
>> Reported-by: Cian Ferriter <cian.ferriter@intel.com>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> ---
>>   drivers/net/pcap/rte_eth_pcap.c | 40 ++++++++++++++++++++-------------
>>   1 file changed, 25 insertions(+), 15 deletions(-)
>>
>> diff --git a/drivers/net/pcap/rte_eth_pcap.c
>> b/drivers/net/pcap/rte_eth_pcap.c
>> index ff02ade70d1a..98f80368ca1d 100644
>> --- a/drivers/net/pcap/rte_eth_pcap.c
>> +++ b/drivers/net/pcap/rte_eth_pcap.c
>> @@ -735,6 +735,17 @@ eth_stats_reset(struct rte_eth_dev *dev)
>>   return 0;
>>   }
>>
>> +static inline void
>> +infinite_rx_ring_free(struct rte_ring *pkts)
>> +{
>> +struct rte_mbuf *bufs;
>> +
>> +while (!rte_ring_dequeue(pkts, (void **)&bufs))
>> +rte_pktmbuf_free(bufs);
>> +
>> +rte_ring_free(pkts);
>> +}
>> +
>>   static int
>>   eth_dev_close(struct rte_eth_dev *dev)
>>   {
>> @@ -753,7 +764,6 @@ eth_dev_close(struct rte_eth_dev *dev)
>>   if (internals->infinite_rx) {
>>   for (i = 0; i < dev->data->nb_rx_queues; i++) {
>>   struct pcap_rx_queue *pcap_q = &internals-
>>> rx_queue[i];
>> -struct rte_mbuf *pcap_buf;
>>
>>   /*
>>    * 'pcap_q->pkts' can be NULL if 'eth_dev_close()'
>> @@ -762,11 +772,7 @@ eth_dev_close(struct rte_eth_dev *dev)
>>   if (pcap_q->pkts == NULL)
>>   continue;
>>
>> -while (!rte_ring_dequeue(pcap_q->pkts,
>> -(void **)&pcap_buf))
>> -rte_pktmbuf_free(pcap_buf);
>> -
>> -rte_ring_free(pcap_q->pkts);
>> +infinite_rx_ring_free(pcap_q->pkts);
>>   }
>>   }
>>
>> @@ -835,21 +841,25 @@ eth_rx_queue_setup(struct rte_eth_dev *dev,
>>   while (eth_pcap_rx(pcap_q, bufs, 1)) {
>>   /* Check for multiseg mbufs. */
>>   if (bufs[0]->nb_segs != 1) {
>> -rte_pktmbuf_free(*bufs);
>> -
>> -while (!rte_ring_dequeue(pcap_q->pkts,
>> -(void **)bufs))
>> -rte_pktmbuf_free(*bufs);
>> -
>> -rte_ring_free(pcap_q->pkts);
>> -PMD_LOG(ERR, "Multiseg mbufs are not
>> supported in infinite_rx "
>> -"mode.");
>> +infinite_rx_ring_free(pcap_q->pkts);
>> +PMD_LOG(ERR,
>> +"Multiseg mbufs are not supported in
>> infinite_rx mode.");
>>   return -EINVAL;
>>   }
>>
>>   rte_ring_enqueue_bulk(pcap_q->pkts,
>>   (void * const *)bufs, 1, NULL);
>>   }
>> +
>> +if (rte_ring_count(pcap_q->pkts) < pcap_pkt_count) {
>> +infinite_rx_ring_free(pcap_q->pkts);
>> +PMD_LOG(ERR,
>> +"Not enough mbuf to fill the infinite_rx ring. "
>> +"At least %" PRIu64 " mbufs per queue is
>> required to fill the ring",
>> +pcap_pkt_count);
> 
> [Cian Ferriter]
> So we can say that the issue is either too many packets in the PCAP or too few mbufs for the ring. What can the user do about this?
> They can use a PCAP with less packets.
> Can they change how many mbufs are available by passing more memory or any other method?
> 
> Should be mention these remedies, or is this outside the scope for an error message?

User can change the number of allocated mbuf easily, like this is done in the 
testpmd via '--total-num-mbufs=N' command in testpmd.

Assuming user would like to use the bigger .pcap file, I go with too few mbufs 
for the ring.

But "infinite_rx ring" can be implementation detail, is following more clear 
message:
"Not enough mbufs to accommodate packets in pcap file.
At least %" PRIu64 " mbufs per queue is required."

> 
> As I mentioned, I'm happy for you to upstream either way.
> 
>> +return -EINVAL;
>> +}
>> +
>>   /*
>>    * Reset the stats for this queue since eth_pcap_rx calls
>> above
>>    * didn't result in the application receiving packets.
>> --
>> 2.29.2
>
  
Cian Ferriter Feb. 4, 2021, 5:01 p.m. UTC | #3
> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@intel.com>
> Sent: Thursday 4 February 2021 16:29
> To: Ferriter, Cian <cian.ferriter@intel.com>
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: Re: [PATCH] net/pcap: fix infinite Rx with large files
> 
> On 2/4/2021 4:03 PM, Ferriter, Cian wrote:
> > Hi Ferruh,
> >
> > This fixes the issue I was seeing. Now an error is reported, rather than
> silent failure.
> >
> > I have one piece of feedback about the particular error message below
> inline which you can take or leave, I'm happy for you to upstream this fix
> either way.
> >
> > Acked-by: Cian Ferriter <cian.ferriter@intel.com>
> >
> >> -----Original Message-----
> >> From: Yigit, Ferruh <ferruh.yigit@intel.com>
> >> Sent: Wednesday 3 February 2021 15:49
> >> To: Ferriter, Cian <cian.ferriter@intel.com>
> >> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org;
> stable@dpdk.org
> >> Subject: [PATCH] net/pcap: fix infinite Rx with large files
> >>
> >> Packet forwarding is not working when infinite Rx feature is used with
> >> large .pcap files that has high number of packets.
> >>
> >> The problem is number of allocated mbufs are less than the infinite Rx
> >> ring size, and all mbufs consumed to fill the ring, so there is no mbuf
> >> left for forwarding.
> >>
> >> Current logic can not detect that infinite Rx ring is not filled
> >> completely and no more mbufs left, and setup continues which leads
> >> silent fail on packet forwarding.
> >>
> >> There isn't much can be done when there is not enough mbuf for the
> given
> >> .pcap file, so additional checks added to detect the case and fail
> >> explicitly with an error log.
> >>
> >> Bugzilla ID: 595
> >> Fixes: a3f5252e5cbd ("net/pcap: enable infinitely Rx a pcap file")
> >> Cc: stable@dpdk.org
> >>
> >> Reported-by: Cian Ferriter <cian.ferriter@intel.com>
> >> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> >> ---
> >>   drivers/net/pcap/rte_eth_pcap.c | 40 ++++++++++++++++++++----------
> ---
> >>   1 file changed, 25 insertions(+), 15 deletions(-)
> >>
> >> diff --git a/drivers/net/pcap/rte_eth_pcap.c
> >> b/drivers/net/pcap/rte_eth_pcap.c
> >> index ff02ade70d1a..98f80368ca1d 100644
> >> --- a/drivers/net/pcap/rte_eth_pcap.c
> >> +++ b/drivers/net/pcap/rte_eth_pcap.c
> >> @@ -735,6 +735,17 @@ eth_stats_reset(struct rte_eth_dev *dev)
> >>   return 0;
> >>   }
> >>
> >> +static inline void
> >> +infinite_rx_ring_free(struct rte_ring *pkts)
> >> +{
> >> +struct rte_mbuf *bufs;
> >> +
> >> +while (!rte_ring_dequeue(pkts, (void **)&bufs))
> >> +rte_pktmbuf_free(bufs);
> >> +
> >> +rte_ring_free(pkts);
> >> +}
> >> +
> >>   static int
> >>   eth_dev_close(struct rte_eth_dev *dev)
> >>   {
> >> @@ -753,7 +764,6 @@ eth_dev_close(struct rte_eth_dev *dev)
> >>   if (internals->infinite_rx) {
> >>   for (i = 0; i < dev->data->nb_rx_queues; i++) {
> >>   struct pcap_rx_queue *pcap_q = &internals-
> >>> rx_queue[i];
> >> -struct rte_mbuf *pcap_buf;
> >>
> >>   /*
> >>    * 'pcap_q->pkts' can be NULL if 'eth_dev_close()'
> >> @@ -762,11 +772,7 @@ eth_dev_close(struct rte_eth_dev *dev)
> >>   if (pcap_q->pkts == NULL)
> >>   continue;
> >>
> >> -while (!rte_ring_dequeue(pcap_q->pkts,
> >> -(void **)&pcap_buf))
> >> -rte_pktmbuf_free(pcap_buf);
> >> -
> >> -rte_ring_free(pcap_q->pkts);
> >> +infinite_rx_ring_free(pcap_q->pkts);
> >>   }
> >>   }
> >>
> >> @@ -835,21 +841,25 @@ eth_rx_queue_setup(struct rte_eth_dev *dev,
> >>   while (eth_pcap_rx(pcap_q, bufs, 1)) {
> >>   /* Check for multiseg mbufs. */
> >>   if (bufs[0]->nb_segs != 1) {
> >> -rte_pktmbuf_free(*bufs);
> >> -
> >> -while (!rte_ring_dequeue(pcap_q->pkts,
> >> -(void **)bufs))
> >> -rte_pktmbuf_free(*bufs);
> >> -
> >> -rte_ring_free(pcap_q->pkts);
> >> -PMD_LOG(ERR, "Multiseg mbufs are not
> >> supported in infinite_rx "
> >> -"mode.");
> >> +infinite_rx_ring_free(pcap_q->pkts);
> >> +PMD_LOG(ERR,
> >> +"Multiseg mbufs are not supported in
> >> infinite_rx mode.");
> >>   return -EINVAL;
> >>   }
> >>
> >>   rte_ring_enqueue_bulk(pcap_q->pkts,
> >>   (void * const *)bufs, 1, NULL);
> >>   }
> >> +
> >> +if (rte_ring_count(pcap_q->pkts) < pcap_pkt_count) {
> >> +infinite_rx_ring_free(pcap_q->pkts);
> >> +PMD_LOG(ERR,
> >> +"Not enough mbuf to fill the infinite_rx ring. "
> >> +"At least %" PRIu64 " mbufs per queue is
> >> required to fill the ring",
> >> +pcap_pkt_count);
> >
> > [Cian Ferriter]
> > So we can say that the issue is either too many packets in the PCAP or too
> few mbufs for the ring. What can the user do about this?
> > They can use a PCAP with less packets.
> > Can they change how many mbufs are available by passing more memory
> or any other method?
> >
> > Should be mention these remedies, or is this outside the scope for an error
> message?
> 
> User can change the number of allocated mbuf easily, like this is done in the
> testpmd via '--total-num-mbufs=N' command in testpmd.
> 
> Assuming user would like to use the bigger .pcap file, I go with too few mbufs
> for the ring.
> 
> But "infinite_rx ring" can be implementation detail, is following more clear
> message:
> "Not enough mbufs to accommodate packets in pcap file.
> At least %" PRIu64 " mbufs per queue is required."
> 

[Cian Ferriter] I agree, mentioning the number of packets makes the message clearer.

Thanks for updating the message! 😊

> >
> > As I mentioned, I'm happy for you to upstream either way.
> >
> >> +return -EINVAL;
> >> +}
> >> +
> >>   /*
> >>    * Reset the stats for this queue since eth_pcap_rx calls
> >> above
> >>    * didn't result in the application receiving packets.
> >> --
> >> 2.29.2
> >
  

Patch

diff --git a/drivers/net/pcap/rte_eth_pcap.c b/drivers/net/pcap/rte_eth_pcap.c
index ff02ade70d1a..98f80368ca1d 100644
--- a/drivers/net/pcap/rte_eth_pcap.c
+++ b/drivers/net/pcap/rte_eth_pcap.c
@@ -735,6 +735,17 @@  eth_stats_reset(struct rte_eth_dev *dev)
 	return 0;
 }
 
+static inline void
+infinite_rx_ring_free(struct rte_ring *pkts)
+{
+	struct rte_mbuf *bufs;
+
+	while (!rte_ring_dequeue(pkts, (void **)&bufs))
+		rte_pktmbuf_free(bufs);
+
+	rte_ring_free(pkts);
+}
+
 static int
 eth_dev_close(struct rte_eth_dev *dev)
 {
@@ -753,7 +764,6 @@  eth_dev_close(struct rte_eth_dev *dev)
 	if (internals->infinite_rx) {
 		for (i = 0; i < dev->data->nb_rx_queues; i++) {
 			struct pcap_rx_queue *pcap_q = &internals->rx_queue[i];
-			struct rte_mbuf *pcap_buf;
 
 			/*
 			 * 'pcap_q->pkts' can be NULL if 'eth_dev_close()'
@@ -762,11 +772,7 @@  eth_dev_close(struct rte_eth_dev *dev)
 			if (pcap_q->pkts == NULL)
 				continue;
 
-			while (!rte_ring_dequeue(pcap_q->pkts,
-					(void **)&pcap_buf))
-				rte_pktmbuf_free(pcap_buf);
-
-			rte_ring_free(pcap_q->pkts);
+			infinite_rx_ring_free(pcap_q->pkts);
 		}
 	}
 
@@ -835,21 +841,25 @@  eth_rx_queue_setup(struct rte_eth_dev *dev,
 		while (eth_pcap_rx(pcap_q, bufs, 1)) {
 			/* Check for multiseg mbufs. */
 			if (bufs[0]->nb_segs != 1) {
-				rte_pktmbuf_free(*bufs);
-
-				while (!rte_ring_dequeue(pcap_q->pkts,
-						(void **)bufs))
-					rte_pktmbuf_free(*bufs);
-
-				rte_ring_free(pcap_q->pkts);
-				PMD_LOG(ERR, "Multiseg mbufs are not supported in infinite_rx "
-						"mode.");
+				infinite_rx_ring_free(pcap_q->pkts);
+				PMD_LOG(ERR,
+					"Multiseg mbufs are not supported in infinite_rx mode.");
 				return -EINVAL;
 			}
 
 			rte_ring_enqueue_bulk(pcap_q->pkts,
 					(void * const *)bufs, 1, NULL);
 		}
+
+		if (rte_ring_count(pcap_q->pkts) < pcap_pkt_count) {
+			infinite_rx_ring_free(pcap_q->pkts);
+			PMD_LOG(ERR,
+				"Not enough mbuf to fill the infinite_rx ring. "
+				"At least %" PRIu64 " mbufs per queue is required to fill the ring",
+				pcap_pkt_count);
+			return -EINVAL;
+		}
+
 		/*
 		 * Reset the stats for this queue since eth_pcap_rx calls above
 		 * didn't result in the application receiving packets.