lib/librte_cmdline/cmdline_parse_ipaddr.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 #ifndef _PARSE_IPADDR_H_
  62 #define _PARSE_IPADDR_H_
  63
  64 #include <netinet/in.h>
  65
  66 #ifdef __cplusplus
  67 extern "C" {
  68 #endif
  69
  70 #define CMDLINE_IPADDR_V4      0x01
  71 #define CMDLINE_IPADDR_V6      0x02
  72 #define CMDLINE_IPADDR_NETWORK 0x04
  73
  74 struct cmdline_ipaddr {
  75         uint8_t family;
  76         union {
  77                 struct in_addr ipv4;
  78                 struct in6_addr ipv6;
  79         } addr;
  80         unsigned int prefixlen; /* in case of network only */
  81 };
  82 typedef struct cmdline_ipaddr cmdline_ipaddr_t;
  83
  84 struct cmdline_token_ipaddr_data {
  85         uint8_t flags;
  86 };
  87
  88 struct cmdline_token_ipaddr {
  89         struct cmdline_token_hdr hdr;
  90         struct cmdline_token_ipaddr_data ipaddr_data;
  91 };
  92 typedef struct cmdline_token_ipaddr cmdline_parse_token_ipaddr_t;
  93
  94 extern struct cmdline_token_ops cmdline_token_ipaddr_ops;
  95
  96 int cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *srcbuf,
  97         void *res, unsigned ressize);
  98 int cmdline_get_help_ipaddr(cmdline_parse_token_hdr_t *tk, char *dstbuf,
  99         unsigned int size);
 100
 101 #define TOKEN_IPADDR_INITIALIZER(structure, field)      \
 102 {                                                       \
 103         /* hdr */                                           \
 104         {                                                   \
 105                 &cmdline_token_ipaddr_ops,      /* ops */       \
 106                 offsetof(structure, field),     /* offset */    \
 107         },                                                  \
 108         /* ipaddr_data */                                   \
 109         {                                                   \
 110                 CMDLINE_IPADDR_V4 |             /* flags */     \
 111                 CMDLINE_IPADDR_V6,                              \
 112         },                                                  \
 113 }
 114
 115 #define TOKEN_IPV4_INITIALIZER(structure, field)        \
 116 {                                                       \
 117         /* hdr */                                           \
 118         {                                                   \
 119                 &cmdline_token_ipaddr_ops,      /* ops */       \
 120                 offsetof(structure, field),     /* offset */    \
 121         },                                                  \
 122         /* ipaddr_data */                                   \
 123         {                                                   \
 124                 CMDLINE_IPADDR_V4,              /* flags */     \
 125         },                                                  \
 126 }
 127
 128 #define TOKEN_IPV6_INITIALIZER(structure, field)        \
 129 {                                                       \
 130         /* hdr */                                           \
 131         {                                                   \
 132                 &cmdline_token_ipaddr_ops,      /* ops */       \
 133                 offsetof(structure, field),     /* offset */    \
 134         },                                                  \
 135         /* ipaddr_data */                                   \
 136         {                                                   \
 137                 CMDLINE_IPADDR_V6,              /* flags */     \
 138         },                                                  \
 139 }
 140
 141 #define TOKEN_IPNET_INITIALIZER(structure, field)       \
 142 {                                                       \
 143         /* hdr */                                           \
 144         {                                                   \
 145                 &cmdline_token_ipaddr_ops,      /* ops */       \
 146                 offsetof(structure, field),     /* offset */    \
 147         },                                                  \
 148         /* ipaddr_data */                                   \
 149         {                                                   \
 150                 CMDLINE_IPADDR_V4 |             /* flags */     \
 151                 CMDLINE_IPADDR_V6 |                             \
 152                 CMDLINE_IPADDR_NETWORK,                         \
 153         },                                                  \
 154 }
 155
 156 #define TOKEN_IPV4NET_INITIALIZER(structure, field)     \
 157 {                                                       \
 158         /* hdr */                                           \
 159         {                                                   \
 160                 &cmdline_token_ipaddr_ops,      /* ops */       \
 161                 offsetof(structure, field),     /* offset */    \
 162         },                                                  \
 163         /* ipaddr_data */                                   \
 164         {                                                   \
 165                 CMDLINE_IPADDR_V4 |             /* flags */     \
 166                 CMDLINE_IPADDR_NETWORK,                         \
 167         },                                                  \
 168 }
 169
 170 #define TOKEN_IPV6NET_INITIALIZER(structure, field)     \
 171 {                                                       \
 172         /* hdr */                                           \
 173         {                                                   \
 174                 &cmdline_token_ipaddr_ops,      /* ops */       \
 175                 offsetof(structure, field),     /* offset */    \
 176         },                                                  \
 177         /* ipaddr_data */                                   \
 178         {                                                   \
 179                 CMDLINE_IPADDR_V4 |             /* flags */     \
 180                 CMDLINE_IPADDR_NETWORK,                         \
 181         },                                                  \
 182 }
 183
 184 #ifdef __cplusplus
 185 }
 186 #endif
 187
 188 #endif /* _PARSE_IPADDR_H_ */