FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
ip6_format.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * ip/ip6_format.c: ip6 formatting
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #include <vnet/ip/ip.h>
41 
42 /* Format an IP6 address. */
43 u8 *
44 format_ip6_address (u8 * s, va_list * args)
45 {
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;
51 
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++)
54  {
55  if (a->as_u16[i] == 0)
56  {
57  if (in_zero_run)
58  this_zero_run++;
59  else
60  {
61  in_zero_run = 1;
62  this_zero_run = 1;
63  this_zero_run_index = i;
64  }
65  }
66  else
67  {
68  if (in_zero_run)
69  {
70  /* offer to compress the biggest run of > 1 zero */
71  if (this_zero_run > max_zero_run && this_zero_run > 1)
72  {
73  max_zero_run_index = this_zero_run_index;
74  max_zero_run = this_zero_run;
75  }
76  }
77  in_zero_run = 0;
78  this_zero_run = 0;
79  }
80  }
81 
82  if (in_zero_run)
83  {
84  if (this_zero_run > max_zero_run && this_zero_run > 1)
85  {
86  max_zero_run_index = this_zero_run_index;
87  max_zero_run = this_zero_run;
88  }
89  }
90 
91  for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
92  {
93  if (i == max_zero_run_index)
94  {
95  s = format (s, "::");
96  i += max_zero_run - 1;
97  last_double_colon = 1;
98  }
99  else
100  {
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;
105  }
106  }
107 
108  return s;
109 }
110 
111 /* Format an IP6 route destination and length. */
112 u8 *
113 format_ip6_address_and_length (u8 * s, va_list * args)
114 {
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);
118 }
119 
120 /* Parse an IP6 address. */
121 uword
122 unformat_ip6_address (unformat_input_t * input, va_list * args)
123 {
124  ip6_address_t *result = va_arg (*args, ip6_address_t *);
125  u16 hex_quads[8];
126  uword hex_quad, n_hex_quads, hex_digit, n_hex_digits;
127  uword c, n_colon, double_colon_index;
128 
129  n_hex_quads = hex_quad = n_hex_digits = n_colon = 0;
130  double_colon_index = ARRAY_LEN (hex_quads);
131  while ((c = unformat_get_input (input)) != UNFORMAT_END_OF_INPUT)
132  {
133  hex_digit = 16;
134  if (c >= '0' && c <= '9')
135  hex_digit = c - '0';
136  else if (c >= 'a' && c <= 'f')
137  hex_digit = c + 10 - 'a';
138  else if (c >= 'A' && c <= 'F')
139  hex_digit = c + 10 - 'A';
140  else if (c == ':' && n_colon < 2)
141  n_colon++;
142  else
143  {
144  unformat_put_input (input);
145  break;
146  }
147 
148  /* Too many hex quads. */
149  if (n_hex_quads >= ARRAY_LEN (hex_quads))
150  return 0;
151 
152  if (hex_digit < 16)
153  {
154  hex_quad = (hex_quad << 4) | hex_digit;
155 
156  /* Hex quad must fit in 16 bits. */
157  if (n_hex_digits >= 4)
158  return 0;
159 
160  n_colon = 0;
161  n_hex_digits++;
162  }
163 
164  /* Save position of :: */
165  if (n_colon == 2)
166  {
167  /* More than one :: ? */
168  if (double_colon_index < ARRAY_LEN (hex_quads))
169  return 0;
170  double_colon_index = n_hex_quads;
171  }
172 
173  if (n_colon > 0 && n_hex_digits > 0)
174  {
175  hex_quads[n_hex_quads++] = hex_quad;
176  hex_quad = 0;
177  n_hex_digits = 0;
178  }
179  }
180 
181  if (n_hex_digits > 0)
182  hex_quads[n_hex_quads++] = hex_quad;
183 
184  {
185  word i;
186 
187  /* Expand :: to appropriate number of zero hex quads. */
188  if (double_colon_index < ARRAY_LEN (hex_quads))
189  {
190  word n_zero = ARRAY_LEN (hex_quads) - n_hex_quads;
191 
192  for (i = n_hex_quads - 1; i >= (signed) double_colon_index; i--)
193  hex_quads[n_zero + i] = hex_quads[i];
194 
195  for (i = 0; i < n_zero; i++)
196  {
197  ASSERT ((double_colon_index + i) < ARRAY_LEN (hex_quads));
198  hex_quads[double_colon_index + i] = 0;
199  }
200 
201  n_hex_quads = ARRAY_LEN (hex_quads);
202  }
203 
204  /* Too few hex quads given. */
205  if (n_hex_quads < ARRAY_LEN (hex_quads))
206  return 0;
207 
208  for (i = 0; i < ARRAY_LEN (hex_quads); i++)
209  result->as_u16[i] = clib_host_to_net_u16 (hex_quads[i]);
210 
211  return 1;
212  }
213 }
214 
215 /* Format an IP6 header. */
216 u8 *
217 format_ip6_header (u8 * s, va_list * args)
218 {
219  ip6_header_t *ip = va_arg (*args, ip6_header_t *);
220  u32 max_header_bytes = va_arg (*args, u32);
221  u32 i, ip_version, traffic_class, flow_label;
222  u32 indent;
223 
224  /* Nothing to do. */
225  if (max_header_bytes < sizeof (ip[0]))
226  return format (s, "IP header truncated");
227 
228  indent = format_get_indent (s);
229  indent += 2;
230 
231  s = format (s, "%U: %U -> %U",
235 
236  i = clib_net_to_host_u32 (ip->ip_version_traffic_class_and_flow_label);
237  ip_version = (i >> 28);
238  traffic_class = (i >> 20) & 0xff;
239  flow_label = i & pow2_mask (20);
240 
241  if (ip_version != 6)
242  s = format (s, "\n%Uversion %d", format_white_space, indent, ip_version);
243 
244  s =
245  format (s,
246  "\n%Utos 0x%02x, flow label 0x%x, hop limit %d, payload length %d",
247  format_white_space, indent, traffic_class, flow_label,
248  ip->hop_limit, clib_net_to_host_u16 (ip->payload_length));
249 
250  /* Recurse into next protocol layer. */
251  if (max_header_bytes != 0 && sizeof (ip[0]) < max_header_bytes)
252  {
253  ip_main_t *im = &ip_main;
255 
256  if (pi && pi->format_header)
257  s = format (s, "\n%U%U",
258  format_white_space, indent - 2, pi->format_header,
259  /* next protocol header */ (void *) (ip + 1),
260  max_header_bytes - sizeof (ip[0]));
261  }
262 
263  return s;
264 }
265 
266 /* Parse an IP6 header. */
267 uword
268 unformat_ip6_header (unformat_input_t * input, va_list * args)
269 {
270  u8 **result = va_arg (*args, u8 **);
271  ip6_header_t *ip;
272  int old_length;
273 
274  /* Allocate space for IP header. */
275  {
276  void *p;
277 
278  old_length = vec_len (*result);
279  vec_add2 (*result, p, sizeof (ip[0]));
280  ip = p;
281  }
282 
283  memset (ip, 0, sizeof (ip[0]));
285  clib_host_to_net_u32 (6 << 28);
286 
287  if (!unformat (input, "%U: %U -> %U",
291  return 0;
292 
293  /* Parse options. */
294  while (1)
295  {
296  int i;
297 
298  if (unformat (input, "tos %U", unformat_vlib_number, &i))
300  clib_host_to_net_u32 ((i & 0xff) << 20);
301 
302  else if (unformat (input, "hop-limit %U", unformat_vlib_number, &i))
303  ip->hop_limit = i;
304 
305  /* Can't parse input: try next protocol level. */
306  else
307  break;
308  }
309 
310  /* Recurse into next protocol layer. */
311  {
312  ip_main_t *im = &ip_main;
314 
315  if (pi && pi->unformat_header)
316  {
317  if (!unformat_user (input, pi->unformat_header, result))
318  return 0;
319 
320  /* Result may have moved. */
321  ip = (void *) *result + old_length;
322  }
323  }
324 
325  ip->payload_length =
326  clib_host_to_net_u16 (vec_len (*result) - (old_length + sizeof (ip[0])));
327 
328  return 1;
329 }
330 
331 /* Parse an IP46 address. */
332 uword
333 unformat_ip46_address (unformat_input_t * input, va_list * args)
334 {
335  ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
336  ip46_type_t type = va_arg (*args, ip46_type_t);
337  if ((type != IP46_TYPE_IP6) &&
338  unformat (input, "%U", unformat_ip4_address, &ip46->ip4))
339  {
340  ip46_address_mask_ip4 (ip46);
341  return 1;
342  }
343  else if ((type != IP46_TYPE_IP4) &&
344  unformat (input, "%U", unformat_ip6_address, &ip46->ip6))
345  {
346  return 1;
347  }
348  return 0;
349 }
350 
351 /* Format an IP46 address. */
352 u8 *
353 format_ip46_address (u8 * s, va_list * args)
354 {
355  ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
356  ip46_type_t type = va_arg (*args, ip46_type_t);
357  int is_ip4 = 1;
358 
359  switch (type)
360  {
361  case IP46_TYPE_ANY:
362  is_ip4 = ip46_address_is_ip4 (ip46);
363  break;
364  case IP46_TYPE_IP4:
365  is_ip4 = 1;
366  break;
367  case IP46_TYPE_IP6:
368  is_ip4 = 0;
369  break;
370  }
371 
372  return is_ip4 ?
373  format (s, "%U", format_ip4_address, &ip46->ip4) :
374  format (s, "%U", format_ip6_address, &ip46->ip6);
375 }
376 
377 /*
378  * fd.io coding-style-patch-verification: ON
379  *
380  * Local Variables:
381  * eval: (c-set-style "gnu")
382  * End:
383  */
format_function_t format_ip_protocol
Definition: format.h:45
unformat_function_t unformat_ip_protocol
Definition: format.h:46
ip46_type_t
Definition: format.h:63
a
Definition: bitmap.h:516
static uword unformat_get_input(unformat_input_t *input)
Definition: format.h:190
u8 * format_ip6_header(u8 *s, va_list *args)
Definition: ip6_format.c:217
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:559
int i
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
static u32 format_get_indent(u8 *s)
Definition: format.h:72
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
Definition: ip.h:109
ip6_address_t src_address
Definition: ip6_packet.h:342
uword unformat_vlib_number(unformat_input_t *input, va_list *args)
Definition: format.c:148
format_function_t format_ip4_address
Definition: format.h:79
unformat_function_t unformat_ip4_address
Definition: format.h:76
static uword pow2_mask(uword x)
Definition: clib.h:265
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:113
#define ip46_address_mask_ip4(ip46)
Definition: ip6_packet.h:77
uword unformat_ip46_address(unformat_input_t *input, va_list *args)
Definition: ip6_format.c:333
uword unformat_ip6_header(unformat_input_t *input, va_list *args)
Definition: ip6_format.c:268
static ip_protocol_info_t * ip_get_protocol_info(ip_main_t *im, u32 protocol)
Definition: ip.h:136
format_function_t * format_header
Definition: ip.h:81
struct _unformat_input_t unformat_input_t
static void unformat_put_input(unformat_input_t *input)
Definition: format.h:203
#define ip46_address_is_ip4(ip46)
Definition: ip6_packet.h:76
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
svmdb_client_t * c
ip_main_t ip_main
Definition: ip_init.c:42
uword unformat_ip6_address(unformat_input_t *input, va_list *args)
Definition: ip6_format.c:122
#define ARRAY_LEN(x)
Definition: clib.h:59
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
u8 * format_ip6_address_and_length(u8 *s, va_list *args)
Definition: ip6_format.c:113
unformat_function_t * unformat_header
Definition: ip.h:84
u8 * format_ip6_address(u8 *s, va_list *args)
Definition: ip6_format.c:44
u64 uword
Definition: types.h:112
u32 ip_version_traffic_class_and_flow_label
Definition: ip6_packet.h:329
unsigned short u16
Definition: types.h:57
u16 payload_length
Definition: ip6_packet.h:333
i64 word
Definition: types.h:111
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
u8 * format_ip46_address(u8 *s, va_list *args)
Definition: ip6_format.c:353
u16 as_u16[8]
Definition: ip6_packet.h:49
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
ip6_address_t dst_address
Definition: ip6_packet.h:342