lib/librte_cmdline/cmdline_parse_ipaddr.h

   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  *  version: DPDK.L.1.2.3-3
  34  */
  35
  36 /*
  37  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  38  * All rights reserved.
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions are met:
  41  *
  42  *     * Redistributions of source code must retain the above copyright
  43  *       notice, this list of conditions and the following disclaimer.
  44  *     * Redistributions in binary form must reproduce the above copyright
  45  *       notice, this list of conditions and the following disclaimer in the
  46  *       documentation and/or other materials provided with the distribution.
  47  *     * Neither the name of the University of California, Berkeley nor the
  48  *       names of its contributors may be used to endorse or promote products
  49  *       derived from this software without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  52  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  53  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  54  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  55  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  56  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  57  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  58  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  60  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  */
  62
  63 #ifndef _PARSE_IPADDR_H_
  64 #define _PARSE_IPADDR_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);
  98 int cmdline_get_help_ipaddr(cmdline_parse_token_hdr_t *tk, char *dstbuf,
  99                             unsigned int size);
 100
 101 /*
 102  * Warning! Not compatible with C++!
 103  */
 104 #define TOKEN_IPADDR_INITIALIZER(structure, field)          \
 105 {                                                           \
 106         .hdr = {                                            \
 107                 .ops = &cmdline_token_ipaddr_ops,           \
 108                 .offset = offsetof(structure, field),       \
 109         },                                                  \
 110         .ipaddr_data = {                                    \
 111                 .flags = CMDLINE_IPADDR_V4 |                \
 112                 CMDLINE_IPADDR_V6,                          \
 113         },                                                  \
 114 }
 115
 116 /*
 117  * Warning! Not compatible with C++!
 118  */
 119 #define TOKEN_IPV4_INITIALIZER(structure, field)            \
 120 {                                                           \
 121         .hdr = {                                            \
 122                 .ops = &cmdline_token_ipaddr_ops,           \
 123                 .offset = offsetof(structure, field),       \
 124         },                                                  \
 125         .ipaddr_data = {                                    \
 126                 .flags = CMDLINE_IPADDR_V4,                 \
 127         },                                                  \
 128 }
 129
 130 /*
 131  * Warning! Not compatible with C++!
 132  */
 133 #define TOKEN_IPV6_INITIALIZER(structure, field)            \
 134 {                                                           \
 135         .hdr = {                                            \
 136                 .ops = &cmdline_token_ipaddr_ops,           \
 137                 .offset = offsetof(structure, field),       \
 138         },                                                  \
 139         .ipaddr_data = {                                    \
 140                 .flags = CMDLINE_IPADDR_V6,                 \
 141         },                                                  \
 142 }
 143
 144 /*
 145  * Warning! Not compatible with C++!
 146  */
 147 #define TOKEN_IPNET_INITIALIZER(structure, field)           \
 148 {                                                           \
 149         .hdr = {                                            \
 150                 .ops = &cmdline_token_ipaddr_ops,           \
 151                 .offset = offsetof(structure, field),       \
 152         },                                                  \
 153         .ipaddr_data = {                                    \
 154                 .flags = CMDLINE_IPADDR_V4 |                \
 155                 CMDLINE_IPADDR_V6 |                         \
 156                 CMDLINE_IPADDR_NETWORK,                     \
 157         },                                                  \
 158 }
 159
 160 /*
 161  * Warning! Not compatible with C++!
 162  */
 163 #define TOKEN_IPV4NET_INITIALIZER(structure, field)         \
 164 {                                                           \
 165         .hdr = {                                            \
 166                 .ops = &cmdline_token_ipaddr_ops,           \
 167                 .offset = offsetof(structure, field),       \
 168         },                                                  \
 169         .ipaddr_data = {                                    \
 170                 .flags = CMDLINE_IPADDR_V4 |                \
 171                 CMDLINE_IPADDR_NETWORK,                     \
 172         },                                                  \
 173 }
 174
 175 /*
 176  * Warning! Not compatible with C++!
 177  */
 178 #define TOKEN_IPV6NET_INITIALIZER(structure, field)         \
 179 {                                                           \
 180         .hdr = {                                            \
 181                 .ops = &cmdline_token_ipaddr_ops,           \
 182                 .offset = offsetof(structure, field),       \
 183         },                                                  \
 184         .ipaddr_data = {                                    \
 185                 .flags = CMDLINE_IPADDR_V4 |                \
 186                 CMDLINE_IPADDR_NETWORK,                     \
 187         },                                                  \
 188 }
 189
 190 #ifdef __cplusplus
 191 }
 192 #endif
 193
 194 #endif /* _PARSE_IPADDR_H_ */