lib/librte_cmdline/cmdline_parse_etheraddr.c

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