[v2,4/7] ether: add eth_unformat_addr

Message ID 20190516180427.17270-5-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Headers
Series ether: improvements and optimizations |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Stephen Hemminger May 16, 2019, 6:04 p.m. UTC
  Make a function that coresponds with eth_aton_r which can
be used to convert string to ether_addr.

This also allows rte_ethdev to no longer depend on the
cmdline library.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 lib/librte_net/rte_ether.c         | 47 ++++++++++++++++++++++++++++++
 lib/librte_net/rte_ether.h         | 14 +++++++++
 lib/librte_net/rte_net_version.map |  2 +-
 3 files changed, 62 insertions(+), 1 deletion(-)
  

Comments

David Marchand May 17, 2019, 7:08 a.m. UTC | #1
On Thu, May 16, 2019 at 8:05 PM Stephen Hemminger <
stephen@networkplumber.org> wrote:

> Make a function that coresponds with eth_aton_r which can
>

corresponds

be used to convert string to ether_addr.
>
> This also allows rte_ethdev to no longer depend on the
> cmdline library.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  lib/librte_net/rte_ether.c         | 47 ++++++++++++++++++++++++++++++
>  lib/librte_net/rte_ether.h         | 14 +++++++++
>  lib/librte_net/rte_net_version.map |  2 +-
>  3 files changed, 62 insertions(+), 1 deletion(-)
>
> diff --git a/lib/librte_net/rte_ether.c b/lib/librte_net/rte_ether.c
> index d4b41f122a16..12d9af58b5c3 100644
> --- a/lib/librte_net/rte_ether.c
> +++ b/lib/librte_net/rte_ether.c
> @@ -27,3 +27,50 @@ ether_format_addr(char *buf, uint16_t size,
>                  eth_addr->addr_bytes[4],
>                  eth_addr->addr_bytes[5]);
>  }
> +
> +/*
> + * Like ether_aton_r but can handle either
> + * XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX
> + */
> +int
> +ether_unformat_addr(const char *s, struct ether_addr *ea)
> +{
> +       unsigned int o0, o1, o2, o3, o4, o5;
> +       int n;
> +
> +       n = sscanf(s, "%x:%x:%x:%x:%x:%x",
> +                   &o0, &o1, &o2, &o3, &o4, &o5);
> +
>

Still weak to trailing characters.


+       if (n == 6) {
> +               if (o0 > UINT8_MAX || o1 > UINT8_MAX || o2 > UINT8_MAX ||
> +                   o3 > UINT8_MAX || o4 > UINT8_MAX || o5 > UINT8_MAX)
> +                       return -1;
> +
> +               ea->addr_bytes[0] = o0;
> +               ea->addr_bytes[1] = o1;
> +               ea->addr_bytes[2] = o2;
> +               ea->addr_bytes[3] = o3;
> +               ea->addr_bytes[4] = o4;
> +               ea->addr_bytes[5] = o5;
> +
> +               return 0;
> +       }
> +
> +       /* Support the format XXXX:XXXX:XXXX */
> +       n = sscanf(s, "%x:%x:%x", &o0, &o1, &o2);
>

Idem trailing characters.


+       if (n == 3) {
> +               if (o0 > UINT16_MAX || o1 > UINT16_MAX || o2 > UINT16_MAX)
> +                       return -1;
> +
> +               ea->addr_bytes[0] = o0 >> 8;
> +               ea->addr_bytes[1] = o0 & 0xff;
> +               ea->addr_bytes[2] = o1 >> 8;
> +               ea->addr_bytes[3] = o1 & 0xff;
> +               ea->addr_bytes[4] = o2 >> 8;
> +               ea->addr_bytes[5] = o2 & 0xff;
> +               return 0;
> +       }
> +       /* unknown format */
> +
> +       return -1;
> +}
> diff --git a/lib/librte_net/rte_ether.h b/lib/librte_net/rte_ether.h
> index ed178a1f1736..0fa4481d266b 100644
> --- a/lib/librte_net/rte_ether.h
> +++ b/lib/librte_net/rte_ether.h
> @@ -249,6 +249,20 @@ void
>  ether_format_addr(char *buf, uint16_t size,
>                   const struct ether_addr *eth_addr);
>
> +/**
> + * Convert string with Ethernet address to an ether_addr.
> + *
> + * @param str
> + *   A pointer to buffer contains the formatted MAC address.
> + * @param eth_addr
> + *   A pointer to a ether_addr structure.
> + * @return
> + *   0 if successful
> + *   -1 and sets rte_errno if invalid string
> + */
> +int __rte_experimental
> +ether_unformat_addr(const char *str, struct ether_addr *eth_addr);
> +
>  /**
>   * Ethernet header: Contains the destination address, source address
>   * and frame type.
> diff --git a/lib/librte_net/rte_net_version.map
> b/lib/librte_net/rte_net_version.map
> index 49d34093781c..41d6a5943515 100644
> --- a/lib/librte_net/rte_net_version.map
> +++ b/lib/librte_net/rte_net_version.map
> @@ -20,10 +20,10 @@ DPDK_19.08 {
>         eth_format_addr;
>  } DPDK_17.05;
>
> -
>

And same comment on the function name than in the rfc patch.


 EXPERIMENTAL {
>         global:
>
>         rte_net_make_rarp_packet;
>         rte_net_skip_ip6_ext;
> +       eth_unformat_addr;
>  };
> --
> 2.20.1
>
>
  

Patch

diff --git a/lib/librte_net/rte_ether.c b/lib/librte_net/rte_ether.c
index d4b41f122a16..12d9af58b5c3 100644
--- a/lib/librte_net/rte_ether.c
+++ b/lib/librte_net/rte_ether.c
@@ -27,3 +27,50 @@  ether_format_addr(char *buf, uint16_t size,
 		 eth_addr->addr_bytes[4],
 		 eth_addr->addr_bytes[5]);
 }
+
+/*
+ * Like ether_aton_r but can handle either
+ * XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX
+ */
+int
+ether_unformat_addr(const char *s, struct ether_addr *ea)
+{
+	unsigned int o0, o1, o2, o3, o4, o5;
+	int n;
+
+	n = sscanf(s, "%x:%x:%x:%x:%x:%x",
+		    &o0, &o1, &o2, &o3, &o4, &o5);
+
+	if (n == 6) {
+		if (o0 > UINT8_MAX || o1 > UINT8_MAX || o2 > UINT8_MAX ||
+		    o3 > UINT8_MAX || o4 > UINT8_MAX || o5 > UINT8_MAX)
+			return -1;
+
+		ea->addr_bytes[0] = o0;
+		ea->addr_bytes[1] = o1;
+		ea->addr_bytes[2] = o2;
+		ea->addr_bytes[3] = o3;
+		ea->addr_bytes[4] = o4;
+		ea->addr_bytes[5] = o5;
+
+		return 0;
+	}
+
+	/* Support the format XXXX:XXXX:XXXX */
+	n = sscanf(s, "%x:%x:%x", &o0, &o1, &o2);
+	if (n == 3) {
+		if (o0 > UINT16_MAX || o1 > UINT16_MAX || o2 > UINT16_MAX)
+			return -1;
+
+		ea->addr_bytes[0] = o0 >> 8;
+		ea->addr_bytes[1] = o0 & 0xff;
+		ea->addr_bytes[2] = o1 >> 8;
+		ea->addr_bytes[3] = o1 & 0xff;
+		ea->addr_bytes[4] = o2 >> 8;
+		ea->addr_bytes[5] = o2 & 0xff;
+		return 0;
+	}
+	/* unknown format */
+
+	return -1;
+}
diff --git a/lib/librte_net/rte_ether.h b/lib/librte_net/rte_ether.h
index ed178a1f1736..0fa4481d266b 100644
--- a/lib/librte_net/rte_ether.h
+++ b/lib/librte_net/rte_ether.h
@@ -249,6 +249,20 @@  void
 ether_format_addr(char *buf, uint16_t size,
 		  const struct ether_addr *eth_addr);
 
+/**
+ * Convert string with Ethernet address to an ether_addr.
+ *
+ * @param str
+ *   A pointer to buffer contains the formatted MAC address.
+ * @param eth_addr
+ *   A pointer to a ether_addr structure.
+ * @return
+ *   0 if successful
+ *   -1 and sets rte_errno if invalid string
+ */
+int __rte_experimental
+ether_unformat_addr(const char *str, struct ether_addr *eth_addr);
+
 /**
  * Ethernet header: Contains the destination address, source address
  * and frame type.
diff --git a/lib/librte_net/rte_net_version.map b/lib/librte_net/rte_net_version.map
index 49d34093781c..41d6a5943515 100644
--- a/lib/librte_net/rte_net_version.map
+++ b/lib/librte_net/rte_net_version.map
@@ -20,10 +20,10 @@  DPDK_19.08 {
 	eth_format_addr;
 } DPDK_17.05;
 
-
 EXPERIMENTAL {
 	global:
 
 	rte_net_make_rarp_packet;
 	rte_net_skip_ip6_ext;
+	eth_unformat_addr;
 };