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