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 #define TOKEN_IPADDR_INITIALIZER(structure, field)      \
 101 {                                                       \
 102         /* hdr */                                           \
 103         {                                                   \
 104                 &cmdline_token_ipaddr_ops,      /* ops */       \
 105                 offsetof(structure, field),     /* offset */    \
 106         },                                                  \
 107         /* ipaddr_data */                                   \
 108         {                                                   \
 109                 CMDLINE_IPADDR_V4 |             /* flags */     \
 110                 CMDLINE_IPADDR_V6,                              \
 111         },                                                  \
 112 }
 113
 114 #define TOKEN_IPV4_INITIALIZER(structure, field)        \
 115 {                                                       \
 116         /* hdr */                                           \
 117         {                                                   \
 118                 &cmdline_token_ipaddr_ops,      /* ops */       \
 119                 offsetof(structure, field),     /* offset */    \
 120         },                                                  \
 121         /* ipaddr_data */                                   \
 122         {                                                   \
 123                 CMDLINE_IPADDR_V4,              /* flags */     \
 124         },                                                  \
 125 }
 126
 127 #define TOKEN_IPV6_INITIALIZER(structure, field)        \
 128 {                                                       \
 129         /* hdr */                                           \
 130         {                                                   \
 131                 &cmdline_token_ipaddr_ops,      /* ops */       \
 132                 offsetof(structure, field),     /* offset */    \
 133         },                                                  \
 134         /* ipaddr_data */                                   \
 135         {                                                   \
 136                 CMDLINE_IPADDR_V6,              /* flags */     \
 137         },                                                  \
 138 }
 139
 140 #define TOKEN_IPNET_INITIALIZER(structure, field)       \
 141 {                                                       \
 142         /* hdr */                                           \
 143         {                                                   \
 144                 &cmdline_token_ipaddr_ops,      /* ops */       \
 145                 offsetof(structure, field),     /* offset */    \
 146         },                                                  \
 147         /* ipaddr_data */                                   \
 148         {                                                   \
 149                 CMDLINE_IPADDR_V4 |             /* flags */     \
 150                 CMDLINE_IPADDR_V6 |                             \
 151                 CMDLINE_IPADDR_NETWORK,                         \
 152         },                                                  \
 153 }
 154
 155 #define TOKEN_IPV4NET_INITIALIZER(structure, field)     \
 156 {                                                       \
 157         /* hdr */                                           \
 158         {                                                   \
 159                 &cmdline_token_ipaddr_ops,      /* ops */       \
 160                 offsetof(structure, field),     /* offset */    \
 161         },                                                  \
 162         /* ipaddr_data */                                   \
 163         {                                                   \
 164                 CMDLINE_IPADDR_V4 |             /* flags */     \
 165                 CMDLINE_IPADDR_NETWORK,                         \
 166         },                                                  \
 167 }
 168
 169 #define TOKEN_IPV6NET_INITIALIZER(structure, field)     \
 170 {                                                       \
 171         /* hdr */                                           \
 172         {                                                   \
 173                 &cmdline_token_ipaddr_ops,      /* ops */       \
 174                 offsetof(structure, field),     /* offset */    \
 175         },                                                  \
 176         /* ipaddr_data */                                   \
 177         {                                                   \
 178                 CMDLINE_IPADDR_V4 |             /* flags */     \
 179                 CMDLINE_IPADDR_NETWORK,                         \
 180         },                                                  \
 181 }
 182
 183 #ifdef __cplusplus
 184 }
 185 #endif
 186
 187 #endif /* _PARSE_IPADDR_H_ */