src/lib/cmdline_parse_ipaddr.h

   1 /*-
   2  * Copyright (c) <2010>, Intel Corporation
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  *
  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
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  32  * OF THE POSSIBILITY OF SUCH DAMAGE.
  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 #include "cmdline_parse.h"
  66
  67 #define CMDLINE_IPADDR_V4      0x01
  68 #define CMDLINE_IPADDR_V6      0x02
  69 #define CMDLINE_IPADDR_NETWORK 0x04
  70
  71 struct cmdline_ipaddr {
  72         uint8_t family;
  73         union {
  74                 struct in_addr ipv4;
  75                 struct in6_addr ipv6;
  76         } addr;
  77         unsigned int prefixlen; /* in case of network only */
  78 };
  79 typedef struct cmdline_ipaddr cmdline_ipaddr_t;
  80
  81 struct cmdline_token_ipaddr_data {
  82         uint8_t flags;
  83 };
  84
  85 struct cmdline_token_ipaddr {
  86         struct cmdline_token_hdr hdr;
  87         struct cmdline_token_ipaddr_data ipaddr_data;
  88 };
  89 typedef struct cmdline_token_ipaddr cmdline_parse_token_ipaddr_t;
  90
  91 extern struct cmdline_token_ops cmdline_token_ipaddr_ops;
  92
  93 int cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *srcbuf,
  94                          void *res, unsigned ressize);
  95 int cmdline_get_help_ipaddr(cmdline_parse_token_hdr_t *tk, char *dstbuf,
  96                             unsigned int size);
  97
  98 #define TOKEN_IPADDR_INITIALIZER(structure, field)          \
  99 {                                                           \
 100         .hdr = {                                            \
 101                 .ops = &cmdline_token_ipaddr_ops,           \
 102                 .offset = offsetof(structure, field),       \
 103         },                                                  \
 104         .ipaddr_data = {                                    \
 105                 .flags = CMDLINE_IPADDR_V4 |                \
 106                 CMDLINE_IPADDR_V6,                          \
 107         },                                                  \
 108 }
 109
 110 #define TOKEN_IPV4_INITIALIZER(structure, field)            \
 111 {                                                           \
 112         .hdr = {                                            \
 113                 .ops = &cmdline_token_ipaddr_ops,           \
 114                 .offset = offsetof(structure, field),       \
 115         },                                                  \
 116         .ipaddr_data = {                                    \
 117                 .flags = CMDLINE_IPADDR_V4,                 \
 118         },                                                  \
 119 }
 120
 121 #define TOKEN_IPV6_INITIALIZER(structure, field)            \
 122 {                                                           \
 123         .hdr = {                                            \
 124                 .ops = &cmdline_token_ipaddr_ops,           \
 125                 .offset = offsetof(structure, field),       \
 126         },                                                  \
 127         .ipaddr_data = {                                    \
 128                 .flags = CMDLINE_IPADDR_V6,                 \
 129         },                                                  \
 130 }
 131
 132 #define TOKEN_IPNET_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_V4 |                \
 140                 CMDLINE_IPADDR_V6 |                         \
 141                 CMDLINE_IPADDR_NETWORK,                     \
 142         },                                                  \
 143 }
 144
 145 #define TOKEN_IPV4NET_INITIALIZER(structure, field)         \
 146 {                                                           \
 147         .hdr = {                                            \
 148                 .ops = &cmdline_token_ipaddr_ops,           \
 149                 .offset = offsetof(structure, field),       \
 150         },                                                  \
 151         .ipaddr_data = {                                    \
 152                 .flags = CMDLINE_IPADDR_V4 |                \
 153                 CMDLINE_IPADDR_NETWORK,                     \
 154         },                                                  \
 155 }
 156
 157 #define TOKEN_IPV6NET_INITIALIZER(structure, field)         \
 158 {                                                           \
 159         .hdr = {                                            \
 160                 .ops = &cmdline_token_ipaddr_ops,           \
 161                 .offset = offsetof(structure, field),       \
 162         },                                                  \
 163         .ipaddr_data = {                                    \
 164                 .flags = CMDLINE_IPADDR_V4 |                \
 165                 CMDLINE_IPADDR_NETWORK,                     \
 166         },                                                  \
 167 }
 168
 169 #endif /* _PARSE_IPADDR_H_ */