FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
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/ip_format.c: ip generic (4 or 6) 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 IP protocol. */
43 u8 *
44 format_ip_protocol (u8 * s, va_list * args)
45 {
46  ip_protocol_t protocol = va_arg (*args, ip_protocol_t);
47  ip_main_t *im = &ip_main;
48  ip_protocol_info_t *pi = ip_get_protocol_info (im, protocol);
49 
50  if (pi)
51  return format (s, "%s", pi->name);
52  else
53  return format (s, "unknown %d", protocol);
54 }
55 
56 uword
57 unformat_ip_protocol (unformat_input_t * input, va_list * args)
58 {
59  u8 *result = va_arg (*args, u8 *);
60  ip_main_t *im = &ip_main;
62  int i;
63 
65  im->protocol_info_by_name, &i))
66  return 0;
67 
68  pi = vec_elt_at_index (im->protocol_infos, i);
69  *result = pi->protocol;
70  return 1;
71 }
72 
73 u8 *
74 format_tcp_udp_port (u8 * s, va_list * args)
75 {
76  int port = va_arg (*args, int);
77  ip_main_t *im = &ip_main;
79 
80  pi = ip_get_tcp_udp_port_info (im, port);
81  if (pi)
82  s = format (s, "%s", pi->name);
83  else
84  s = format (s, "%d", clib_net_to_host_u16 (port));
85 
86  return s;
87 }
88 
89 uword
90 unformat_tcp_udp_port (unformat_input_t * input, va_list * args)
91 {
92  u16 *result = va_arg (*args, u16 *);
93  ip_main_t *im = &ip_main;
95  u32 i, port;
96 
97 
99  im->port_info_by_name, &i))
100  {
101  pi = vec_elt_at_index (im->port_infos, i);
102  port = pi->port;
103  }
104  else if (unformat_user (input, unformat_vlib_number, &port)
105  && port < (1 << 16))
106  port = clib_host_to_net_u16 (port);
107 
108  else
109  return 0;
110 
111  *result = port;
112  return 1;
113 }
114 
115 /*
116  * fd.io coding-style-patch-verification: ON
117  *
118  * Local Variables:
119  * eval: (c-set-style "gnu")
120  * End:
121  */
uword * protocol_info_by_name
Definition: ip.h:116
uword * port_info_by_name
Definition: ip.h:125
int i
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:989
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
Definition: ip.h:106
unsigned char u8
Definition: types.h:56
u8 * format_tcp_udp_port(u8 *s, va_list *args)
Definition: format.c:74
ip_protocol_t protocol
Definition: ip.h:75
uword unformat_vlib_number(unformat_input_t *input, va_list *args)
Definition: format.c:148
vl_api_ip_proto_t protocol
Definition: lb_types.api:71
u8 * format_ip_protocol(u8 *s, va_list *args)
Definition: format.c:44
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned int u32
Definition: types.h:88
uword unformat_ip_protocol(unformat_input_t *input, va_list *args)
Definition: format.c:57
uword unformat_tcp_udp_port(unformat_input_t *input, va_list *args)
Definition: format.c:90
static ip_protocol_info_t * ip_get_protocol_info(ip_main_t *im, u32 protocol)
Definition: ip.h:133
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
enum ip_protocol ip_protocol_t
ip_protocol_info_t * protocol_infos
Definition: ip.h:109
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:142
uword unformat_vlib_number_by_name(unformat_input_t *input, va_list *args)
Definition: format.c:157
u64 uword
Definition: types.h:112
u8 * name
Definition: ip.h:72
u16 port
Definition: lb_types.api:72
tcp_udp_port_info_t * port_infos
Definition: ip.h:119