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