[v7,1/2] examples/multi_process/client_server_mp: check port validity

Message ID 20190805163817.3713-2-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series examples/client_server_mp: port id (fixes only) |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/iol-Compile-Testing success Compile Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

Stephen Hemminger Aug. 5, 2019, 4:38 p.m. UTC
  From: Stephen Hemminger <sthemmin@microsoft.com>

The mp_server incorrectly allows a port mask that included hidden
ports and which later caused either lost packets or failed initialization.

This fixes explicitly checking that each bit in portmask is a
valid port before using it.

Fixes: 5b7ba31148a8 ("ethdev: add port ownership")
Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
---
 .../client_server_mp/mp_server/args.c         | 40 ++++++++++---------
 .../client_server_mp/mp_server/args.h         |  2 +-
 .../client_server_mp/mp_server/init.c         |  7 +---
 3 files changed, 25 insertions(+), 24 deletions(-)
  

Comments

Matan Azrad Aug. 6, 2019, 12:07 p.m. UTC | #1
Hi


> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Stephen Hemminger
> Sent: Monday, August 5, 2019 7:38 PM
> To: dev@dpdk.org
> Cc: Stephen Hemminger <sthemmin@microsoft.com>
> Subject: [dpdk-dev] [PATCH v7 1/2]
> examples/multi_process/client_server_mp: check port validity
> 
> From: Stephen Hemminger <sthemmin@microsoft.com>
> 
> The mp_server incorrectly allows a port mask that included hidden ports and
> which later caused either lost packets or failed initialization.
> 
> This fixes explicitly checking that each bit in portmask is a valid port before
> using it.
> 
> Fixes: 5b7ba31148a8 ("ethdev: add port ownership")
> Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
> ---
>  .../client_server_mp/mp_server/args.c         | 40 ++++++++++---------
>  .../client_server_mp/mp_server/args.h         |  2 +-
>  .../client_server_mp/mp_server/init.c         |  7 +---
>  3 files changed, 25 insertions(+), 24 deletions(-)
> 
> diff --git a/examples/multi_process/client_server_mp/mp_server/args.c
> b/examples/multi_process/client_server_mp/mp_server/args.c
> index b0d8d7665c85..3c2ca266b096 100644
> --- a/examples/multi_process/client_server_mp/mp_server/args.c
> +++ b/examples/multi_process/client_server_mp/mp_server/args.c
> @@ -10,6 +10,7 @@
>  #include <errno.h>
> 
>  #include <rte_memory.h>
> +#include <rte_ethdev.h>
>  #include <rte_string_fns.h>
> 
>  #include "common.h"
> @@ -41,31 +42,34 @@ usage(void)
>   * array variable
>   */
>  static int
> -parse_portmask(uint8_t max_ports, const char *portmask)
> +parse_portmask(const char *portmask)
>  {
>  	char *end = NULL;
> -	unsigned long pm;
> -	uint16_t count = 0;
> +	unsigned long long pm;
> +	uint16_t id;
> 
>  	if (portmask == NULL || *portmask == '\0')
>  		return -1;
> 
>  	/* convert parameter to a number and verify */
> -	pm = strtoul(portmask, &end, 16);
> -	if (end == NULL || *end != '\0' || pm == 0)
> +	errno = 0;
> +	pm = strtoull(portmask, &end, 16);
> +	if (errno != 0 || end == NULL || *end != '\0')
>  		return -1;
> 
Please Continue discussion on this on V5 thread.

> -	/* loop through bits of the mask and mark ports */
> -	while (pm != 0){
> -		if (pm & 0x01){ /* bit is set in mask, use port */
> -			if (count >= max_ports)
> -				printf("WARNING: requested port %u not
> present"
> -				" - ignoring\n", (unsigned)count);
> -			else
> -			    ports->id[ports->num_ports++] = count;
> -		}
> -		pm = (pm >> 1);
> -		count++;
> +	RTE_ETH_FOREACH_DEV(id) {
> +		unsigned long msk = 1u << id;
> +
> +		if ((pm & msk) == 0)
> +			continue;
> +
> +		pm &= ~msk;
> +		ports->id[ports->num_ports++] = id;
> +	}
> +
> +	if (pm != 0) {
> +		printf("WARNING: leftover ports in mask %#llx - ignoring\n",
> +		       pm);
>  	}
> 
>  	return 0;
> @@ -99,7 +103,7 @@ parse_num_clients(const char *clients)
>   * on error.
>   */
>  int
> -parse_app_args(uint16_t max_ports, int argc, char *argv[])
> +parse_app_args(int argc, char *argv[])
>  {
>  	int option_index, opt;
>  	char **argvopt = argv;
> @@ -112,7 +116,7 @@ parse_app_args(uint16_t max_ports, int argc, char
> *argv[])
>  		&option_index)) != EOF){
>  		switch (opt){
>  			case 'p':
> -				if (parse_portmask(max_ports, optarg) != 0){
> +				if (parse_portmask(optarg) != 0) {
>  					usage();
>  					return -1;
>  				}
> diff --git a/examples/multi_process/client_server_mp/mp_server/args.h
> b/examples/multi_process/client_server_mp/mp_server/args.h
> index 79c190a33a37..52c8cc86e6f0 100644
> --- a/examples/multi_process/client_server_mp/mp_server/args.h
> +++ b/examples/multi_process/client_server_mp/mp_server/args.h
> @@ -5,6 +5,6 @@
>  #ifndef _ARGS_H_
>  #define _ARGS_H_
> 
> -int parse_app_args(uint16_t max_ports, int argc, char *argv[]);
> +int parse_app_args(int argc, char *argv[]);
> 
>  #endif /* ifndef _ARGS_H_ */
> diff --git a/examples/multi_process/client_server_mp/mp_server/init.c
> b/examples/multi_process/client_server_mp/mp_server/init.c
> index 3af5dc6994bf..1b0569937b51 100644
> --- a/examples/multi_process/client_server_mp/mp_server/init.c
> +++ b/examples/multi_process/client_server_mp/mp_server/init.c
> @@ -238,7 +238,7 @@ init(int argc, char *argv[])  {
>  	int retval;
>  	const struct rte_memzone *mz;
> -	uint16_t i, total_ports;
> +	uint16_t i;
> 
>  	/* init EAL, parsing EAL args */
>  	retval = rte_eal_init(argc, argv);
> @@ -247,9 +247,6 @@ init(int argc, char *argv[])
>  	argc -= retval;
>  	argv += retval;
> 
> -	/* get total number of ports */
> -	total_ports = rte_eth_dev_count_total();
> -
>  	/* set up array for port data */
>  	mz = rte_memzone_reserve(MZ_PORT_INFO, sizeof(*ports),
>  				rte_socket_id(), NO_FLAGS);
> @@ -259,7 +256,7 @@ init(int argc, char *argv[])
>  	ports = mz->addr;
> 
>  	/* parse additional, application arguments */
> -	retval = parse_app_args(total_ports, argc, argv);
> +	retval = parse_app_args(argc, argv);
>  	if (retval != 0)
>  		return -1;
> 
> --
> 2.20.1
  
Stephen Hemminger Nov. 13, 2019, 6:53 p.m. UTC | #2
On Tue, 6 Aug 2019 12:07:25 +0000
Matan Azrad <matan@mellanox.com> wrote:

> Hi
> 
> 
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Stephen Hemminger
> > Sent: Monday, August 5, 2019 7:38 PM
> > To: dev@dpdk.org
> > Cc: Stephen Hemminger <sthemmin@microsoft.com>
> > Subject: [dpdk-dev] [PATCH v7 1/2]
> > examples/multi_process/client_server_mp: check port validity
> > 
> > From: Stephen Hemminger <sthemmin@microsoft.com>
> > 
> > The mp_server incorrectly allows a port mask that included hidden ports and
> > which later caused either lost packets or failed initialization.
> > 
> > This fixes explicitly checking that each bit in portmask is a valid port before
> > using it.
> > 
> > Fixes: 5b7ba31148a8 ("ethdev: add port ownership")
> > Signed-off-by: Stephen Hemminger <sthemmin@microsoft.com>
> > ---
> >  .../client_server_mp/mp_server/args.c         | 40 ++++++++++---------
> >  .../client_server_mp/mp_server/args.h         |  2 +-
> >  .../client_server_mp/mp_server/init.c         |  7 +---
> >  3 files changed, 25 insertions(+), 24 deletions(-)
> > 
> > diff --git a/examples/multi_process/client_server_mp/mp_server/args.c
> > b/examples/multi_process/client_server_mp/mp_server/args.c
> > index b0d8d7665c85..3c2ca266b096 100644
> > --- a/examples/multi_process/client_server_mp/mp_server/args.c
> > +++ b/examples/multi_process/client_server_mp/mp_server/args.c
> > @@ -10,6 +10,7 @@
> >  #include <errno.h>
> > 
> >  #include <rte_memory.h>
> > +#include <rte_ethdev.h>
> >  #include <rte_string_fns.h>
> > 
> >  #include "common.h"
> > @@ -41,31 +42,34 @@ usage(void)
> >   * array variable
> >   */
> >  static int
> > -parse_portmask(uint8_t max_ports, const char *portmask)
> > +parse_portmask(const char *portmask)
> >  {
> >  	char *end = NULL;
> > -	unsigned long pm;
> > -	uint16_t count = 0;
> > +	unsigned long long pm;
> > +	uint16_t id;
> > 
> >  	if (portmask == NULL || *portmask == '\0')
> >  		return -1;
> > 
> >  	/* convert parameter to a number and verify */
> > -	pm = strtoul(portmask, &end, 16);
> > -	if (end == NULL || *end != '\0' || pm == 0)
> > +	errno = 0;
> > +	pm = strtoull(portmask, &end, 16);
> > +	if (errno != 0 || end == NULL || *end != '\0')
> >  		return -1;
> >   
> Please Continue discussion on this on V5 thread.

The V5 thread degenerated into "applications should not use portmask".
That is a valid discussion but out of scope for this patch which is a bug
fix for users.
  

Patch

diff --git a/examples/multi_process/client_server_mp/mp_server/args.c b/examples/multi_process/client_server_mp/mp_server/args.c
index b0d8d7665c85..3c2ca266b096 100644
--- a/examples/multi_process/client_server_mp/mp_server/args.c
+++ b/examples/multi_process/client_server_mp/mp_server/args.c
@@ -10,6 +10,7 @@ 
 #include <errno.h>
 
 #include <rte_memory.h>
+#include <rte_ethdev.h>
 #include <rte_string_fns.h>
 
 #include "common.h"
@@ -41,31 +42,34 @@  usage(void)
  * array variable
  */
 static int
-parse_portmask(uint8_t max_ports, const char *portmask)
+parse_portmask(const char *portmask)
 {
 	char *end = NULL;
-	unsigned long pm;
-	uint16_t count = 0;
+	unsigned long long pm;
+	uint16_t id;
 
 	if (portmask == NULL || *portmask == '\0')
 		return -1;
 
 	/* convert parameter to a number and verify */
-	pm = strtoul(portmask, &end, 16);
-	if (end == NULL || *end != '\0' || pm == 0)
+	errno = 0;
+	pm = strtoull(portmask, &end, 16);
+	if (errno != 0 || end == NULL || *end != '\0')
 		return -1;
 
-	/* loop through bits of the mask and mark ports */
-	while (pm != 0){
-		if (pm & 0x01){ /* bit is set in mask, use port */
-			if (count >= max_ports)
-				printf("WARNING: requested port %u not present"
-				" - ignoring\n", (unsigned)count);
-			else
-			    ports->id[ports->num_ports++] = count;
-		}
-		pm = (pm >> 1);
-		count++;
+	RTE_ETH_FOREACH_DEV(id) {
+		unsigned long msk = 1u << id;
+
+		if ((pm & msk) == 0)
+			continue;
+
+		pm &= ~msk;
+		ports->id[ports->num_ports++] = id;
+	}
+
+	if (pm != 0) {
+		printf("WARNING: leftover ports in mask %#llx - ignoring\n",
+		       pm);
 	}
 
 	return 0;
@@ -99,7 +103,7 @@  parse_num_clients(const char *clients)
  * on error.
  */
 int
-parse_app_args(uint16_t max_ports, int argc, char *argv[])
+parse_app_args(int argc, char *argv[])
 {
 	int option_index, opt;
 	char **argvopt = argv;
@@ -112,7 +116,7 @@  parse_app_args(uint16_t max_ports, int argc, char *argv[])
 		&option_index)) != EOF){
 		switch (opt){
 			case 'p':
-				if (parse_portmask(max_ports, optarg) != 0){
+				if (parse_portmask(optarg) != 0) {
 					usage();
 					return -1;
 				}
diff --git a/examples/multi_process/client_server_mp/mp_server/args.h b/examples/multi_process/client_server_mp/mp_server/args.h
index 79c190a33a37..52c8cc86e6f0 100644
--- a/examples/multi_process/client_server_mp/mp_server/args.h
+++ b/examples/multi_process/client_server_mp/mp_server/args.h
@@ -5,6 +5,6 @@ 
 #ifndef _ARGS_H_
 #define _ARGS_H_
 
-int parse_app_args(uint16_t max_ports, int argc, char *argv[]);
+int parse_app_args(int argc, char *argv[]);
 
 #endif /* ifndef _ARGS_H_ */
diff --git a/examples/multi_process/client_server_mp/mp_server/init.c b/examples/multi_process/client_server_mp/mp_server/init.c
index 3af5dc6994bf..1b0569937b51 100644
--- a/examples/multi_process/client_server_mp/mp_server/init.c
+++ b/examples/multi_process/client_server_mp/mp_server/init.c
@@ -238,7 +238,7 @@  init(int argc, char *argv[])
 {
 	int retval;
 	const struct rte_memzone *mz;
-	uint16_t i, total_ports;
+	uint16_t i;
 
 	/* init EAL, parsing EAL args */
 	retval = rte_eal_init(argc, argv);
@@ -247,9 +247,6 @@  init(int argc, char *argv[])
 	argc -= retval;
 	argv += retval;
 
-	/* get total number of ports */
-	total_ports = rte_eth_dev_count_total();
-
 	/* set up array for port data */
 	mz = rte_memzone_reserve(MZ_PORT_INFO, sizeof(*ports),
 				rte_socket_id(), NO_FLAGS);
@@ -259,7 +256,7 @@  init(int argc, char *argv[])
 	ports = mz->addr;
 
 	/* parse additional, application arguments */
-	retval = parse_app_args(total_ports, argc, argv);
+	retval = parse_app_args(argc, argv);
 	if (retval != 0)
 		return -1;