FD.io VPP  v21.01.1
Vector Packet Processing
udp_format.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2019 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/udp_format.c: udp 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 UDP header. */
43 u8 *
44 format_udp_header (u8 * s, va_list * args)
45 {
46  udp_header_t *udp = va_arg (*args, udp_header_t *);
47  u32 max_header_bytes = va_arg (*args, u32);
48  u32 indent;
49  u32 header_bytes = sizeof (udp[0]);
50 
51  /* Nothing to do. */
52  if (max_header_bytes < sizeof (udp[0]))
53  return format (s, "UDP header truncated");
54 
55  indent = format_get_indent (s);
56  indent += 2;
57 
58  s = format (s, "UDP: %d -> %d",
59  clib_net_to_host_u16 (udp->src_port),
60  clib_net_to_host_u16 (udp->dst_port));
61 
62  s = format (s, "\n%Ulength %d, checksum 0x%04x",
63  format_white_space, indent,
64  clib_net_to_host_u16 (udp->length),
65  clib_net_to_host_u16 (udp->checksum));
66 
67  /* Recurse into next protocol layer. */
68  if (max_header_bytes != 0 && header_bytes < max_header_bytes)
69  {
70  ip_main_t *im = &ip_main;
72 
73  pi = ip_get_tcp_udp_port_info (im, udp->dst_port);
74 
75  if (pi && pi->format_header)
76  s = format (s, "\n%U%U",
77  format_white_space, indent - 2, pi->format_header,
78  /* next protocol header */ (udp + 1),
79  max_header_bytes - sizeof (udp[0]));
80  }
81 
82  return s;
83 }
84 
85 uword
86 unformat_udp_port (unformat_input_t * input, va_list * args)
87 {
88  u16 *result = va_arg (*args, u16 *);
89  int port;
90 
91  /* Numeric type. */
92  if (unformat (input, "0x%x", &port) || unformat (input, "%d", &port))
93  {
94  if (port <= 0 || port >= (1 << 16))
95  return 0;
96  *result = port;
97  return 1;
98  }
99  return 0;
100 }
101 
102 /*
103  * fd.io coding-style-patch-verification: ON
104  *
105  * Local Variables:
106  * eval: (c-set-style "gnu")
107  * End:
108  */
uword unformat_udp_port(unformat_input_t *input, va_list *args)
Definition: udp_format.c:86
static u32 format_get_indent(u8 *s)
Definition: format.h:72
Definition: ip.h:107
unsigned char u8
Definition: types.h:56
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
description fragment has unexpected format
Definition: map.api:433
unsigned int u32
Definition: types.h:88
u8 * format_udp_header(u8 *s, va_list *args)
Definition: udp_format.c:44
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
ip_main_t ip_main
Definition: ip_init.c:42
static tcp_udp_port_info_t * ip_get_tcp_udp_port_info(ip_main_t *im, u32 port)
Definition: ip.h:143
format_function_t * format_header
Definition: ip.h:101
u64 uword
Definition: types.h:112
u16 port
Definition: lb_types.api:73
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978