lib/librte_cmdline/cmdline_parse_etheraddr.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  36  * All rights reserved.
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions are met:
  39  *
  40  *     * Redistributions of source code must retain the above copyright
  41  *       notice, this list of conditions and the following disclaimer.
  42  *     * Redistributions in binary form must reproduce the above copyright
  43  *       notice, this list of conditions and the following disclaimer in the
  44  *       documentation and/or other materials provided with the distribution.
  45  *     * Neither the name of the University of California, Berkeley nor the
  46  *       names of its contributors may be used to endorse or promote products
  47  *       derived from this software without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  50  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  51  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  52  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  53  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  54  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  55  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  56  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  57  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  58  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  59  */
  60
  61 #include <stdio.h>
  62 #include <stdlib.h>
  63 #include <stdarg.h>
  64 #include <errno.h>
  65 #include <inttypes.h>
  66 #include <ctype.h>
  67 #include <string.h>
  68 #include <errno.h>
  69 #include <sys/types.h>
  70 #include <net/ethernet.h>
  71
  72 #include <rte_string_fns.h>
  73
  74 #include "cmdline_parse.h"
  75 #include "cmdline_parse_etheraddr.h"
  76
  77 struct cmdline_token_ops cmdline_token_etheraddr_ops = {
  78         .parse = cmdline_parse_etheraddr,
  79         .complete_get_nb = NULL,
  80         .complete_get_elt = NULL,
  81         .get_help = cmdline_get_help_etheraddr,
  82 };
  83
  84 /* the format can be either XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX */
  85 #define ETHER_ADDRSTRLENLONG 18
  86 #define ETHER_ADDRSTRLENSHORT 15
  87
  88 #ifdef __linux__
  89 #define ea_oct ether_addr_octet
  90 #else
  91 #define ea_oct octet
  92 #endif
  93
  94
  95 static struct ether_addr *
  96 my_ether_aton(const char *a)
  97 {
  98         int i;
  99         char *end;
 100         unsigned long o[ETHER_ADDR_LEN];
 101         static struct ether_addr ether_addr;
 102
 103         i = 0;
 104         do {
 105                 errno = 0;
 106                 o[i] = strtoul(a, &end, 16);
 107                 if (errno != 0 || end == a || (end[0] != ':' && end[0] != 0))
 108                         return (NULL);
 109                 a = end + 1;
 110         } while (++i != sizeof (o) / sizeof (o[0]) && end[0] != 0);
 111
 112         /* Junk at the end of line */
 113         if (end[0] != 0)
 114                 return (NULL);
 115
 116         /* Support the format XX:XX:XX:XX:XX:XX */
 117         if (i == ETHER_ADDR_LEN) {
 118                 while (i-- != 0) {
 119                         if (o[i] > UINT8_MAX)
 120                                 return (NULL);
 121                         ether_addr.ea_oct[i] = (uint8_t)o[i];
 122                 }
 123         /* Support the format XXXX:XXXX:XXXX */
 124         } else if (i == ETHER_ADDR_LEN / 2) {
 125                 while (i-- != 0) {
 126                         if (o[i] > UINT16_MAX)
 127                                 return (NULL);
 128                         ether_addr.ea_oct[i * 2] = (uint8_t)(o[i] >> 8);
 129                         ether_addr.ea_oct[i * 2 + 1] = (uint8_t)(o[i] & 0xff);
 130                 }
 131         /* unknown format */
 132         } else
 133                 return (NULL);
 134
 135         return (struct ether_addr *)&ether_addr;
 136 }
 137
 138 int
 139 cmdline_parse_etheraddr(__attribute__((unused)) cmdline_parse_token_hdr_t *tk,
 140                         const char *buf, void *res)
 141 {
 142         unsigned int token_len = 0;
 143         char ether_str[ETHER_ADDRSTRLENLONG+1];
 144         struct ether_addr *tmp;
 145
 146         if (!buf || ! *buf)
 147                 return -1;
 148
 149         while (!cmdline_isendoftoken(buf[token_len]))
 150                 token_len++;
 151
 152         /* if token doesn't match possible string lengths... */
 153         if ((token_len != ETHER_ADDRSTRLENLONG - 1) &&
 154                         (token_len != ETHER_ADDRSTRLENSHORT - 1))
 155                 return -1;
 156
 157         rte_snprintf(ether_str, token_len+1, "%s", buf);
 158
 159         tmp = my_ether_aton(ether_str);
 160         if (tmp == NULL)
 161                 return -1;
 162         if (res)
 163                 memcpy(res, tmp, sizeof(struct ether_addr));
 164         return token_len;
 165 }
 166
 167 int
 168 cmdline_get_help_etheraddr(__attribute__((unused)) cmdline_parse_token_hdr_t *tk,
 169                                char *dstbuf, unsigned int size)
 170 {
 171         int ret;
 172
 173         ret = rte_snprintf(dstbuf, size, "Ethernet address");
 174         if (ret < 0)
 175                 return -1;
 176         return 0;
 177 }