cmdline: standardize conversion of IP address strings
[dpdk.git] / lib / librte_cmdline / cmdline_parse_ipaddr.c
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 #include <stdio.h>
62 #include <stdlib.h>
63 #include <stdarg.h>
64 #include <inttypes.h>
65 #include <ctype.h>
66 #include <string.h>
67 #include <errno.h>
68 #include <arpa/inet.h>
69 #include <netinet/in.h>
70 #ifndef __linux__
71 #ifndef __FreeBSD__
72 #include <net/socket.h>
73 #else
74 #include <sys/socket.h>
75 #endif
76 #endif
77
78 #include <rte_string_fns.h>
79
80 #include "cmdline_parse.h"
81 #include "cmdline_parse_ipaddr.h"
82
83 struct cmdline_token_ops cmdline_token_ipaddr_ops = {
84         .parse = cmdline_parse_ipaddr,
85         .complete_get_nb = NULL,
86         .complete_get_elt = NULL,
87         .get_help = cmdline_get_help_ipaddr,
88 };
89
90 #define PREFIXMAX 128
91 #define V4PREFIXMAX 32
92
93 int
94 cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res,
95         unsigned ressize)
96 {
97         struct cmdline_token_ipaddr *tk2;
98         unsigned int token_len = 0;
99         char ip_str[INET6_ADDRSTRLEN+4+1]; /* '+4' is for prefixlen (if any) */
100         cmdline_ipaddr_t ipaddr;
101         char *prefix, *prefix_end;
102         long prefixlen = 0;
103
104         if (res && ressize < sizeof(cmdline_ipaddr_t))
105                 return -1;
106
107         if (!buf || !tk || ! *buf)
108                 return -1;
109
110         tk2 = (struct cmdline_token_ipaddr *)tk;
111
112         while (!cmdline_isendoftoken(buf[token_len]))
113                 token_len++;
114
115         /* if token is too big... */
116         if (token_len >= INET6_ADDRSTRLEN+4)
117                 return -1;
118
119         snprintf(ip_str, token_len+1, "%s", buf);
120
121         /* convert the network prefix */
122         if (tk2->ipaddr_data.flags & CMDLINE_IPADDR_NETWORK) {
123                 prefix = strrchr(ip_str, '/');
124                 if (prefix == NULL)
125                         return -1;
126                 *prefix = '\0';
127                 prefix ++;
128                 errno = 0;
129                 prefixlen = strtol(prefix, &prefix_end, 10);
130                 if (errno || (*prefix_end != '\0')
131                         || prefixlen < 0 || prefixlen > PREFIXMAX)
132                         return -1;
133                 ipaddr.prefixlen = prefixlen;
134         }
135         else {
136                 ipaddr.prefixlen = 0;
137         }
138
139         /* convert the IP addr */
140         if ((tk2->ipaddr_data.flags & CMDLINE_IPADDR_V4) &&
141             inet_pton(AF_INET, ip_str, &ipaddr.addr.ipv4) == 1 &&
142                 prefixlen <= V4PREFIXMAX) {
143                 ipaddr.family = AF_INET;
144                 if (res)
145                         memcpy(res, &ipaddr, sizeof(ipaddr));
146                 return token_len;
147         }
148         if ((tk2->ipaddr_data.flags & CMDLINE_IPADDR_V6) &&
149             inet_pton(AF_INET6, ip_str, &ipaddr.addr.ipv6) == 1) {
150                 ipaddr.family = AF_INET6;
151                 if (res)
152                         memcpy(res, &ipaddr, sizeof(ipaddr));
153                 return token_len;
154         }
155         return -1;
156
157 }
158
159 int cmdline_get_help_ipaddr(cmdline_parse_token_hdr_t *tk, char *dstbuf,
160                             unsigned int size)
161 {
162         struct cmdline_token_ipaddr *tk2;
163
164         if (!tk || !dstbuf)
165                 return -1;
166
167         tk2 = (struct cmdline_token_ipaddr *)tk;
168
169         switch (tk2->ipaddr_data.flags) {
170         case CMDLINE_IPADDR_V4:
171                 snprintf(dstbuf, size, "IPv4");
172                 break;
173         case CMDLINE_IPADDR_V6:
174                 snprintf(dstbuf, size, "IPv6");
175                 break;
176         case CMDLINE_IPADDR_V4|CMDLINE_IPADDR_V6:
177                 snprintf(dstbuf, size, "IPv4/IPv6");
178                 break;
179         case CMDLINE_IPADDR_NETWORK|CMDLINE_IPADDR_V4:
180                 snprintf(dstbuf, size, "IPv4 network");
181                 break;
182         case CMDLINE_IPADDR_NETWORK|CMDLINE_IPADDR_V6:
183                 snprintf(dstbuf, size, "IPv6 network");
184                 break;
185         case CMDLINE_IPADDR_NETWORK|CMDLINE_IPADDR_V4|CMDLINE_IPADDR_V6:
186                 snprintf(dstbuf, size, "IPv4/IPv6 network");
187                 break;
188         default:
189                 snprintf(dstbuf, size, "IPaddr (bad flags)");
190                 break;
191         }
192         return 0;
193 }