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/ip4_format.c: ip4 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 IP4 address. */
44 format_ip4_address (u8 * s, va_list * args)
46 u8 *a = va_arg (*args, u8 *);
47 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
50 /* Format an IP4 route destination and length. */
52 format_ip4_address_and_length (u8 * s, va_list * args)
54 u8 *a = va_arg (*args, u8 *);
55 u8 l = va_arg (*args, u32);
56 return format (s, "%U/%d", format_ip4_address, a, l);
59 /* Parse an IP4 address %d.%d.%d.%d. */
61 unformat_ip4_address (unformat_input_t * input, va_list * args)
63 u8 *result = va_arg (*args, u8 *);
66 if (!unformat (input, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]))
69 if (a[0] >= 256 || a[1] >= 256 || a[2] >= 256 || a[3] >= 256)
80 /* Format an IP4 header. */
82 format_ip4_header (u8 * s, va_list * args)
84 ip4_header_t *ip = va_arg (*args, ip4_header_t *);
85 u32 max_header_bytes = va_arg (*args, u32);
86 u32 ip_version, header_bytes;
90 if (max_header_bytes < sizeof (ip[0]))
91 return format (s, "IP header truncated");
93 indent = format_get_indent (s);
96 ip_version = (ip->ip_version_and_header_length >> 4);
97 header_bytes = (ip->ip_version_and_header_length & 0xf) * sizeof (u32);
99 s = format (s, "%U: %U -> %U",
100 format_ip_protocol, ip->protocol,
101 format_ip4_address, ip->src_address.data,
102 format_ip4_address, ip->dst_address.data);
104 /* Show IP version and header length only with unexpected values. */
105 if (ip_version != 4 || header_bytes != sizeof (ip4_header_t))
106 s = format (s, "\n%Uversion %d, header length %d",
107 format_white_space, indent, ip_version, header_bytes);
109 s = format (s, "\n%Utos 0x%02x, ttl %d, length %d, checksum 0x%04x",
110 format_white_space, indent,
112 clib_net_to_host_u16 (ip->length),
113 clib_net_to_host_u16 (ip->checksum));
115 /* Check and report invalid checksums. */
117 u16 c = ip4_header_checksum (ip);
118 if (c != ip->checksum)
119 s = format (s, " (should be 0x%04x)", clib_net_to_host_u16 (c));
123 u32 f = clib_net_to_host_u16 (ip->flags_and_fragment_offset);
126 s = format (s, "\n%Ufragment id 0x%04x",
127 format_white_space, indent,
128 clib_net_to_host_u16 (ip->fragment_id));
130 /* Fragment offset. */
131 o = 8 * (f & 0x1fff);
134 s = format (s, " offset %d", o);
138 s = format (s, ", flags ");
139 #define _(l) if (f & IP4_HEADER_FLAG_##l) s = format (s, #l);
147 /* Recurse into next protocol layer. */
148 if (max_header_bytes != 0 && header_bytes < max_header_bytes)
150 ip_main_t *im = &ip_main;
151 ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol);
153 if (pi && pi->format_header)
154 s = format (s, "\n%U%U",
155 format_white_space, indent - 2, pi->format_header,
156 /* next protocol header */ (void *) ip + header_bytes,
157 max_header_bytes - header_bytes);
163 /* Parse an IP4 header. */
165 unformat_ip4_header (unformat_input_t * input, va_list * args)
167 u8 **result = va_arg (*args, u8 **);
171 /* Allocate space for IP header. */
175 old_length = vec_len (*result);
176 vec_add2 (*result, p, sizeof (ip4_header_t));
180 memset (ip, 0, sizeof (ip[0]));
181 ip->ip_version_and_header_length = IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS;
183 if (!unformat (input, "%U: %U -> %U",
184 unformat_ip_protocol, &ip->protocol,
185 unformat_ip4_address, &ip->src_address,
186 unformat_ip4_address, &ip->dst_address))
194 if (unformat (input, "tos %U", unformat_vlib_number, &i))
197 else if (unformat (input, "ttl %U", unformat_vlib_number, &i))
200 else if (unformat (input, "fragment id %U offset %U",
201 unformat_vlib_number, &i, unformat_vlib_number, &j))
203 ip->fragment_id = clib_host_to_net_u16 (i);
204 ip->flags_and_fragment_offset |=
205 clib_host_to_net_u16 ((i / 8) & 0x1fff);
209 else if (unformat (input, "mf") || unformat (input, "MF"))
210 ip->flags_and_fragment_offset |=
211 clib_host_to_net_u16 (IP4_HEADER_FLAG_MORE_FRAGMENTS);
213 else if (unformat (input, "df") || unformat (input, "DF"))
214 ip->flags_and_fragment_offset |=
215 clib_host_to_net_u16 (IP4_HEADER_FLAG_DONT_FRAGMENT);
217 else if (unformat (input, "ce") || unformat (input, "CE"))
218 ip->flags_and_fragment_offset |=
219 clib_host_to_net_u16 (IP4_HEADER_FLAG_CONGESTION);
221 /* Can't parse input: try next protocol level. */
226 /* Fill in checksum. */
227 ip->checksum = ip4_header_checksum (ip);
229 /* Recurse into next protocol layer. */
231 ip_main_t *im = &ip_main;
232 ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol);
234 if (pi && pi->unformat_header)
236 if (!unformat_user (input, pi->unformat_header, result))
239 /* Result may have moved. */
240 ip = (void *) *result + old_length;
244 /* Fill in IP length. */
245 ip->length = clib_host_to_net_u16 (vec_len (*result) - old_length);
251 * fd.io coding-style-patch-verification: ON
254 * eval: (c-set-style "gnu")