2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ip/ip6_format.c: ip6 formatting
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vnet/ip/ip.h>
42 /* Format an IP6 address. */
44 format_ip6_address (u8 * s, va_list * args)
46 ip6_address_t *a = va_arg (*args, ip6_address_t *);
47 u32 max_zero_run = 0, this_zero_run = 0;
48 int max_zero_run_index = -1, this_zero_run_index = 0;
49 int in_zero_run = 0, i;
50 int last_double_colon = 0;
52 /* Ugh, this is a pain. Scan forward looking for runs of 0's */
53 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
55 if (a->as_u16[i] == 0)
63 this_zero_run_index = i;
70 /* offer to compress the biggest run of > 1 zero */
71 if (this_zero_run > max_zero_run && this_zero_run > 1)
73 max_zero_run_index = this_zero_run_index;
74 max_zero_run = this_zero_run;
84 if (this_zero_run > max_zero_run && this_zero_run > 1)
86 max_zero_run_index = this_zero_run_index;
87 max_zero_run = this_zero_run;
91 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
93 if (i == max_zero_run_index)
96 i += max_zero_run - 1;
97 last_double_colon = 1;
101 s = format (s, "%s%x",
102 (last_double_colon || i == 0) ? "" : ":",
103 clib_net_to_host_u16 (a->as_u16[i]));
104 last_double_colon = 0;
111 /* Format an IP6 route destination and length. */
113 format_ip6_address_and_length (u8 * s, va_list * args)
115 ip6_address_t *a = va_arg (*args, ip6_address_t *);
116 u8 l = va_arg (*args, u32);
117 return format (s, "%U/%d", format_ip6_address, a, l);
121 format_ip6_address_and_mask (u8 * s, va_list * args)
123 ip6_address_and_mask_t *am = va_arg (*args, ip6_address_and_mask_t *);
125 if (am->addr.as_u64[0] == 0 && am->addr.as_u64[1] == 0 &&
126 am->mask.as_u64[0] == 0 && am->mask.as_u64[1] == 0)
127 return format (s, "any");
129 if (am->mask.as_u64[0] == ~0 && am->mask.as_u64[1] == ~0)
130 return format (s, "%U", format_ip4_address, &am->addr);
132 return format (s, "%U/%U", format_ip6_address, &am->addr,
133 format_ip4_address, &am->mask);
137 /* Parse an IP6 address. */
139 unformat_ip6_address (unformat_input_t * input, va_list * args)
141 ip6_address_t *result = va_arg (*args, ip6_address_t *);
143 uword hex_quad, n_hex_quads, hex_digit, n_hex_digits;
144 uword c, n_colon, double_colon_index;
146 n_hex_quads = hex_quad = n_hex_digits = n_colon = 0;
147 double_colon_index = ARRAY_LEN (hex_quads);
148 while ((c = unformat_get_input (input)) != UNFORMAT_END_OF_INPUT)
151 if (c >= '0' && c <= '9')
153 else if (c >= 'a' && c <= 'f')
154 hex_digit = c + 10 - 'a';
155 else if (c >= 'A' && c <= 'F')
156 hex_digit = c + 10 - 'A';
157 else if (c == ':' && n_colon < 2)
161 unformat_put_input (input);
165 /* Too many hex quads. */
166 if (n_hex_quads >= ARRAY_LEN (hex_quads))
171 hex_quad = (hex_quad << 4) | hex_digit;
173 /* Hex quad must fit in 16 bits. */
174 if (n_hex_digits >= 4)
181 /* Save position of :: */
184 /* More than one :: ? */
185 if (double_colon_index < ARRAY_LEN (hex_quads))
187 double_colon_index = n_hex_quads;
190 if (n_colon > 0 && n_hex_digits > 0)
192 hex_quads[n_hex_quads++] = hex_quad;
198 if (n_hex_digits > 0)
199 hex_quads[n_hex_quads++] = hex_quad;
204 /* Expand :: to appropriate number of zero hex quads. */
205 if (double_colon_index < ARRAY_LEN (hex_quads))
207 word n_zero = ARRAY_LEN (hex_quads) - n_hex_quads;
209 for (i = n_hex_quads - 1; i >= (signed) double_colon_index; i--)
210 hex_quads[n_zero + i] = hex_quads[i];
212 for (i = 0; i < n_zero; i++)
214 ASSERT ((double_colon_index + i) < ARRAY_LEN (hex_quads));
215 hex_quads[double_colon_index + i] = 0;
218 n_hex_quads = ARRAY_LEN (hex_quads);
221 /* Too few hex quads given. */
222 if (n_hex_quads < ARRAY_LEN (hex_quads))
225 for (i = 0; i < ARRAY_LEN (hex_quads); i++)
226 result->as_u16[i] = clib_host_to_net_u16 (hex_quads[i]);
233 unformat_ip6_address_and_mask (unformat_input_t * input, va_list * args)
235 ip6_address_and_mask_t *am = va_arg (*args, ip6_address_and_mask_t *);
236 ip6_address_t addr, mask;
238 clib_memset (&addr, 0, sizeof (ip6_address_t));
239 clib_memset (&mask, 0, sizeof (ip6_address_t));
241 if (unformat (input, "any"))
243 else if (unformat (input, "%U/%U", unformat_ip6_address, &addr,
244 unformat_ip6_address, &mask))
246 else if (unformat (input, "%U", unformat_ip6_address, &addr))
247 mask.as_u64[0] = mask.as_u64[1] = ~0;
251 am->addr.as_u64[0] = addr.as_u64[0];
252 am->addr.as_u64[1] = addr.as_u64[1];
253 am->mask.as_u64[0] = mask.as_u64[0];
254 am->mask.as_u64[1] = mask.as_u64[1];
258 /* Format an IP6 header. */
260 format_ip6_header (u8 * s, va_list * args)
262 ip6_header_t *ip = va_arg (*args, ip6_header_t *);
263 u32 max_header_bytes = va_arg (*args, u32);
264 u32 i, ip_version, traffic_class, flow_label;
268 if (max_header_bytes < sizeof (ip[0]))
269 return format (s, "IP header truncated");
271 indent = format_get_indent (s);
274 s = format (s, "%U: %U -> %U",
275 format_ip_protocol, ip->protocol,
276 format_ip6_address, &ip->src_address,
277 format_ip6_address, &ip->dst_address);
279 i = clib_net_to_host_u32 (ip->ip_version_traffic_class_and_flow_label);
280 ip_version = (i >> 28);
281 traffic_class = (i >> 20) & 0xff;
282 flow_label = i & pow2_mask (20);
285 s = format (s, "\n%Uversion %d", format_white_space, indent, ip_version);
289 "\n%Utos 0x%02x, flow label 0x%x, hop limit %d, payload length %d",
290 format_white_space, indent, traffic_class, flow_label,
291 ip->hop_limit, clib_net_to_host_u16 (ip->payload_length));
293 /* Recurse into next protocol layer. */
294 if (max_header_bytes != 0 && sizeof (ip[0]) < max_header_bytes)
296 ip_main_t *im = &ip_main;
297 ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol);
299 if (pi && pi->format_header)
300 s = format (s, "\n%U%U",
301 format_white_space, indent - 2, pi->format_header,
302 /* next protocol header */ (void *) (ip + 1),
303 max_header_bytes - sizeof (ip[0]));
309 /* Parse an IP6 header. */
311 unformat_ip6_header (unformat_input_t * input, va_list * args)
313 u8 **result = va_arg (*args, u8 **);
317 /* Allocate space for IP header. */
321 old_length = vec_len (*result);
322 vec_add2 (*result, p, sizeof (ip[0]));
326 clib_memset (ip, 0, sizeof (ip[0]));
327 ip->ip_version_traffic_class_and_flow_label =
328 clib_host_to_net_u32 (6 << 28);
330 if (!unformat (input, "%U: %U -> %U",
331 unformat_ip_protocol, &ip->protocol,
332 unformat_ip6_address, &ip->src_address,
333 unformat_ip6_address, &ip->dst_address))
341 if (unformat (input, "tos %U", unformat_vlib_number, &i))
342 ip->ip_version_traffic_class_and_flow_label |=
343 clib_host_to_net_u32 ((i & 0xff) << 20);
345 else if (unformat (input, "hop-limit %U", unformat_vlib_number, &i))
348 /* Can't parse input: try next protocol level. */
353 /* Recurse into next protocol layer. */
355 ip_main_t *im = &ip_main;
356 ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol);
358 if (pi && pi->unformat_header)
360 if (!unformat_user (input, pi->unformat_header, result))
363 /* Result may have moved. */
364 ip = (void *) *result + old_length;
369 clib_host_to_net_u16 (vec_len (*result) - (old_length + sizeof (ip[0])));
374 /* Parse an IP46 address. */
376 unformat_ip46_address (unformat_input_t * input, va_list * args)
378 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
379 ip46_type_t type = va_arg (*args, ip46_type_t);
380 if ((type != IP46_TYPE_IP6) &&
381 unformat (input, "%U", unformat_ip4_address, &ip46->ip4))
383 ip46_address_mask_ip4 (ip46);
386 else if ((type != IP46_TYPE_IP4) &&
387 unformat (input, "%U", unformat_ip6_address, &ip46->ip6))
394 /* Format an IP46 address. */
396 format_ip46_address (u8 * s, va_list * args)
398 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
399 ip46_type_t type = va_arg (*args, ip46_type_t);
405 is_ip4 = ip46_address_is_ip4 (ip46);
416 format (s, "%U", format_ip4_address, &ip46->ip4) :
417 format (s, "%U", format_ip6_address, &ip46->ip6);
421 * fd.io coding-style-patch-verification: ON
424 * eval: (c-set-style "gnu")