2 * Copyright (c) 2016-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:
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.
17 udp state machine, etc.
20 #include <vnet/udp/udp.h>
21 #include <vnet/session/session.h>
22 #include <vnet/dpo/load_balance.h>
23 #include <vnet/fib/ip4_fib.h>
28 udp_connection_alloc (u32 thread_index)
30 udp_main_t *um = &udp_main;
33 pool_get_aligned_will_expand (um->connections[thread_index], will_expand,
34 CLIB_CACHE_LINE_BYTES);
36 if (PREDICT_FALSE (will_expand))
38 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks
40 pool_get_aligned (udp_main.connections[thread_index], uc,
41 CLIB_CACHE_LINE_BYTES);
42 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
47 pool_get_aligned (um->connections[thread_index], uc,
48 CLIB_CACHE_LINE_BYTES);
50 clib_memset (uc, 0, sizeof (*uc));
51 uc->c_c_index = uc - um->connections[thread_index];
52 uc->c_thread_index = thread_index;
53 uc->c_proto = TRANSPORT_PROTO_UDP;
54 clib_spinlock_init (&uc->rx_lock);
59 udp_connection_free (udp_connection_t * uc)
61 pool_put (udp_main.connections[uc->c_thread_index], uc);
63 clib_memset (uc, 0xFA, sizeof (*uc));
67 udp_session_bind (u32 session_index, transport_endpoint_t * lcl)
69 udp_main_t *um = vnet_get_udp_main ();
70 vlib_main_t *vm = vlib_get_main ();
71 udp_connection_t *listener;
74 udp_dst_port_info_t *pi;
76 pi = udp_get_dst_port_info (um, lcl->port, lcl->is_ip4);
80 pool_get (um->listener_pool, listener);
81 clib_memset (listener, 0, sizeof (udp_connection_t));
83 listener->c_lcl_port = lcl->port;
84 listener->c_c_index = listener - um->listener_pool;
86 /* If we are provided a sw_if_index, bind using one of its ips */
87 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
89 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
91 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
93 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
94 listener->c_is_ip4 = lcl->is_ip4;
95 listener->c_proto = TRANSPORT_PROTO_UDP;
96 listener->c_s_index = session_index;
97 listener->c_fib_index = lcl->fib_index;
98 listener->owns_port = 1;
99 clib_spinlock_init (&listener->rx_lock);
101 node_index = lcl->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
102 udp_register_dst_port (vm, clib_net_to_host_u16 (lcl->port), node_index,
104 return listener->c_c_index;
108 udp_session_unbind (u32 listener_index)
110 vlib_main_t *vm = vlib_get_main ();
112 udp_connection_t *listener;
113 listener = udp_listener_get (listener_index);
114 udp_unregister_dst_port (vm, clib_net_to_host_u16 (listener->c_lcl_port),
119 transport_connection_t *
120 udp_session_get_listener (u32 listener_index)
122 udp_connection_t *us;
124 us = udp_listener_get (listener_index);
125 return &us->connection;
129 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
131 udp_connection_t *uc;
132 vlib_main_t *vm = vlib_get_main ();
134 uc = udp_get_connection_from_transport (tc);
136 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
138 vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
143 ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
145 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
147 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
148 vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
149 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
154 transport_connection_t *
155 udp_session_get (u32 connection_index, u32 thread_index)
157 udp_connection_t *uc;
158 uc = udp_connection_get (connection_index, thread_index);
160 return &uc->connection;
165 udp_session_close (u32 connection_index, u32 thread_index)
167 vlib_main_t *vm = vlib_get_main ();
168 udp_connection_t *uc;
169 uc = udp_connection_get (connection_index, thread_index);
172 if (uc->owns_port || !uc->is_connected)
173 udp_unregister_dst_port (vm, clib_net_to_host_u16 (uc->c_lcl_port),
175 session_transport_delete_notify (&uc->connection);
176 udp_connection_free (uc);
181 udp_session_cleanup (u32 connection_index, u32 thread_index)
183 udp_connection_t *uc;
184 uc = udp_connection_get (connection_index, thread_index);
186 udp_connection_free (uc);
190 format_udp_connection_id (u8 * s, va_list * args)
192 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
196 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
197 format_ip4_address, &uc->c_lcl_ip4,
198 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
199 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
201 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
202 format_ip6_address, &uc->c_lcl_ip6,
203 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
204 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
209 format_udp_connection (u8 * s, va_list * args)
211 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
212 u32 verbose = va_arg (*args, u32);
215 s = format (s, "%-50U", format_udp_connection_id, uc);
219 s = format (s, "%-15s\n", "-");
221 s = format (s, "\n");
227 format_udp_session (u8 * s, va_list * args)
229 u32 uci = va_arg (*args, u32);
230 u32 thread_index = va_arg (*args, u32);
231 u32 verbose = va_arg (*args, u32);
232 udp_connection_t *uc;
234 uc = udp_connection_get (uci, thread_index);
235 return format (s, "%U", format_udp_connection, uc, verbose);
239 format_udp_half_open_session (u8 * s, va_list * args)
241 clib_warning ("BUG");
246 format_udp_listener_session (u8 * s, va_list * args)
248 u32 tci = va_arg (*args, u32);
249 udp_connection_t *uc = udp_listener_get (tci);
250 return format (s, "%U", format_udp_connection, uc);
254 udp_send_mss (transport_connection_t * t)
256 /* TODO figure out MTU of output interface */
261 udp_send_space (transport_connection_t * t)
263 /* No constraint on TX window */
268 udp_open_connection (transport_endpoint_cfg_t * rmt)
270 udp_main_t *um = vnet_get_udp_main ();
271 vlib_main_t *vm = vlib_get_main ();
272 u32 thread_index = vm->thread_index;
273 udp_connection_t *uc;
274 ip46_address_t lcl_addr;
278 if (transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
282 while (udp_get_dst_port_info (um, lcl_port, rmt->is_ip4))
284 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr);
287 clib_warning ("Failed to allocate src port");
292 node_index = rmt->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
293 udp_register_dst_port (vm, lcl_port, node_index, 1 /* is_ipv4 */ );
295 /* We don't poll main thread if we have workers */
296 if (vlib_num_workers ())
299 uc = udp_connection_alloc (thread_index);
300 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
301 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
302 uc->c_rmt_port = rmt->port;
303 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
304 uc->c_is_ip4 = rmt->is_ip4;
305 uc->c_proto = TRANSPORT_PROTO_UDP;
306 uc->c_fib_index = rmt->fib_index;
309 return uc->c_c_index;
312 transport_connection_t *
313 udp_session_get_half_open (u32 conn_index)
315 udp_connection_t *uc;
318 /* We don't poll main thread if we have workers */
319 thread_index = vlib_num_workers ()? 1 : 0;
320 uc = udp_connection_get (conn_index, thread_index);
321 return &uc->connection;
325 const static transport_proto_vft_t udp_proto = {
326 .start_listen = udp_session_bind,
327 .connect = udp_open_connection,
328 .stop_listen = udp_session_unbind,
329 .push_header = udp_push_header,
330 .get_connection = udp_session_get,
331 .get_listener = udp_session_get_listener,
332 .get_half_open = udp_session_get_half_open,
333 .close = udp_session_close,
334 .cleanup = udp_session_cleanup,
335 .send_mss = udp_send_mss,
336 .send_space = udp_send_space,
337 .format_connection = format_udp_session,
338 .format_half_open = format_udp_half_open_session,
339 .format_listener = format_udp_listener_session,
340 .tx_type = TRANSPORT_TX_DGRAM,
341 .service_type = TRANSPORT_SERVICE_CL,
347 udpc_connection_open (transport_endpoint_cfg_t * rmt)
349 udp_connection_t *uc;
350 /* Reproduce the logic of udp_open_connection to find the correct thread */
351 u32 thread_index = vlib_num_workers ()? 1 : vlib_get_main ()->thread_index;
353 uc_index = udp_open_connection (rmt);
354 uc = udp_connection_get (uc_index, thread_index);
355 uc->is_connected = 1;
360 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
362 udp_connection_t *listener;
364 li = udp_session_bind (session_index, lcl);
365 listener = udp_listener_get (li);
366 listener->is_connected = 1;
371 const static transport_proto_vft_t udpc_proto = {
372 .start_listen = udpc_connection_listen,
373 .stop_listen = udp_session_unbind,
374 .connect = udpc_connection_open,
375 .push_header = udp_push_header,
376 .get_connection = udp_session_get,
377 .get_listener = udp_session_get_listener,
378 .get_half_open = udp_session_get_half_open,
379 .close = udp_session_close,
380 .cleanup = udp_session_cleanup,
381 .send_mss = udp_send_mss,
382 .send_space = udp_send_space,
383 .format_connection = format_udp_session,
384 .format_half_open = format_udp_half_open_session,
385 .format_listener = format_udp_listener_session,
386 .tx_type = TRANSPORT_TX_DGRAM,
387 .service_type = TRANSPORT_SERVICE_CL,
391 static clib_error_t *
392 udp_init (vlib_main_t * vm)
394 udp_main_t *um = vnet_get_udp_main ();
395 ip_main_t *im = &ip_main;
396 vlib_thread_main_t *tm = vlib_get_thread_main ();
398 ip_protocol_info_t *pi;
405 /* IP registration */
406 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
408 return clib_error_return (0, "UDP protocol info AWOL");
409 pi->format_header = format_udp_header;
410 pi->unformat_pg_edit = unformat_pg_udp_header;
412 /* Register as transport with URI */
413 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
414 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
415 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
416 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
417 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
418 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
419 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
420 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
423 * Initialize data structures
426 num_threads = 1 /* main thread */ + tm->n_threads;
427 vec_validate (um->connections, num_threads - 1);
428 vec_validate (um->connection_peekers, num_threads - 1);
429 vec_validate (um->peekers_readers_locks, num_threads - 1);
430 vec_validate (um->peekers_write_locks, num_threads - 1);
433 for (i = 0; i < num_threads; i++)
435 clib_spinlock_init (&um->peekers_readers_locks[i]);
436 clib_spinlock_init (&um->peekers_write_locks[i]);
442 VLIB_INIT_FUNCTION (udp_init) =
444 .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
450 static clib_error_t *
451 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
452 vlib_cli_command_t * cmd_arg)
454 udp_main_t *um = vnet_get_udp_main ();
456 clib_error_t *error = NULL;
458 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
459 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
462 udp_dst_port_info_t *port_info;
463 if (um->punt_unknown4)
465 vlib_cli_output (vm, "IPv4 UDP punt: enabled");
470 vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
472 if (udp_is_valid_dst_port (port_info->dst_port, 1))
474 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
477 s = format (s, "%c", 0);
478 vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
481 if (um->punt_unknown6)
483 vlib_cli_output (vm, "IPv6 UDP punt: enabled");
488 vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
490 if (udp_is_valid_dst_port (port_info->dst_port, 01))
492 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
495 s = format (s, "%c", 0);
496 vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
502 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
504 .path = "show udp punt",
505 .short_help = "show udp punt [ipv4|ipv6]",
506 .function = show_udp_punt_fn,
511 * fd.io coding-style-patch-verification: ON
514 * eval: (c-set-style "gnu")