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 u32 thread_index = uc->c_thread_index;
63 clib_memset (uc, 0xFA, sizeof (*uc));
64 pool_put (udp_main.connections[thread_index], uc);
68 udp_connection_delete (udp_connection_t * uc)
70 if ((uc->flags & UDP_CONN_F_OWNS_PORT)
71 || !(uc->flags & UDP_CONN_F_CONNECTED))
72 udp_unregister_dst_port (vlib_get_main (),
73 clib_net_to_host_u16 (uc->c_lcl_port),
75 session_transport_delete_notify (&uc->connection);
76 udp_connection_free (uc);
80 udp_session_bind (u32 session_index, transport_endpoint_t * lcl)
82 udp_main_t *um = vnet_get_udp_main ();
83 vlib_main_t *vm = vlib_get_main ();
84 transport_endpoint_cfg_t *lcl_ext;
85 udp_connection_t *listener;
86 udp_dst_port_info_t *pi;
90 pi = udp_get_dst_port_info (um, clib_net_to_host_u16 (lcl->port),
95 pool_get (um->listener_pool, listener);
96 clib_memset (listener, 0, sizeof (udp_connection_t));
98 listener->c_lcl_port = lcl->port;
99 listener->c_c_index = listener - um->listener_pool;
101 /* If we are provided a sw_if_index, bind using one of its ips */
102 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
104 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
106 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
108 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
109 listener->c_is_ip4 = lcl->is_ip4;
110 listener->c_proto = TRANSPORT_PROTO_UDP;
111 listener->c_s_index = session_index;
112 listener->c_fib_index = lcl->fib_index;
113 listener->flags |= UDP_CONN_F_OWNS_PORT;
114 lcl_ext = (transport_endpoint_cfg_t *) lcl;
115 if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
116 listener->flags |= UDP_CONN_F_CONNECTED;
118 listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
119 clib_spinlock_init (&listener->rx_lock);
121 node_index = lcl->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
122 udp_register_dst_port (vm, clib_net_to_host_u16 (lcl->port), node_index,
124 return listener->c_c_index;
128 udp_session_unbind (u32 listener_index)
130 vlib_main_t *vm = vlib_get_main ();
132 udp_connection_t *listener;
133 listener = udp_listener_get (listener_index);
134 udp_unregister_dst_port (vm, clib_net_to_host_u16 (listener->c_lcl_port),
139 transport_connection_t *
140 udp_session_get_listener (u32 listener_index)
142 udp_connection_t *us;
144 us = udp_listener_get (listener_index);
145 return &us->connection;
149 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
151 udp_connection_t *uc;
152 vlib_main_t *vm = vlib_get_main ();
154 uc = udp_get_connection_from_transport (tc);
156 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
158 vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
163 ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
165 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
167 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
168 vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
169 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
171 if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
173 if (!transport_max_tx_dequeue (&uc->connection))
174 udp_connection_delete (uc);
180 transport_connection_t *
181 udp_session_get (u32 connection_index, u32 thread_index)
183 udp_connection_t *uc;
184 uc = udp_connection_get (connection_index, thread_index);
186 return &uc->connection;
191 udp_session_close (u32 connection_index, u32 thread_index)
193 udp_connection_t *uc;
195 uc = udp_connection_get (connection_index, thread_index);
199 if (!transport_max_tx_dequeue (&uc->connection))
200 udp_connection_delete (uc);
202 uc->flags |= UDP_CONN_F_CLOSING;
206 udp_session_cleanup (u32 connection_index, u32 thread_index)
208 udp_connection_t *uc;
209 uc = udp_connection_get (connection_index, thread_index);
211 udp_connection_free (uc);
215 format_udp_connection_id (u8 * s, va_list * args)
217 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
221 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
222 format_ip4_address, &uc->c_lcl_ip4,
223 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
224 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
226 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
227 format_ip6_address, &uc->c_lcl_ip6,
228 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
229 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
234 format_udp_connection (u8 * s, va_list * args)
236 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
237 u32 verbose = va_arg (*args, u32);
240 s = format (s, "%-50U", format_udp_connection_id, uc);
244 s = format (s, "%-15s", "-");
246 s = format (s, "\n");
252 format_udp_session (u8 * s, va_list * args)
254 u32 uci = va_arg (*args, u32);
255 u32 thread_index = va_arg (*args, u32);
256 u32 verbose = va_arg (*args, u32);
257 udp_connection_t *uc;
259 uc = udp_connection_get (uci, thread_index);
260 return format (s, "%U", format_udp_connection, uc, verbose);
264 format_udp_half_open_session (u8 * s, va_list * args)
266 u32 __clib_unused tci = va_arg (*args, u32);
267 u32 __clib_unused thread_index = va_arg (*args, u32);
268 clib_warning ("BUG");
273 format_udp_listener_session (u8 * s, va_list * args)
275 u32 tci = va_arg (*args, u32);
276 u32 __clib_unused thread_index = va_arg (*args, u32);
277 u32 verbose = va_arg (*args, u32);
278 udp_connection_t *uc = udp_listener_get (tci);
279 return format (s, "%U", format_udp_connection, uc, verbose);
283 udp_session_send_params (transport_connection_t * tconn,
284 transport_send_params_t * sp)
286 /* No constraint on TX window */
288 /* TODO figure out MTU of output interface */
296 udp_open_connection (transport_endpoint_cfg_t * rmt)
298 udp_main_t *um = vnet_get_udp_main ();
299 vlib_main_t *vm = vlib_get_main ();
300 u32 thread_index = vm->thread_index;
301 udp_connection_t *uc;
302 ip46_address_t lcl_addr;
306 if (transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
310 while (udp_get_dst_port_info (um, lcl_port, rmt->is_ip4))
312 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr);
315 clib_warning ("Failed to allocate src port");
320 node_index = rmt->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
321 udp_register_dst_port (vm, lcl_port, node_index, 1 /* is_ipv4 */ );
323 /* We don't poll main thread if we have workers */
324 if (vlib_num_workers ())
327 uc = udp_connection_alloc (thread_index);
328 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
329 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
330 uc->c_rmt_port = rmt->port;
331 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
332 uc->c_is_ip4 = rmt->is_ip4;
333 uc->c_proto = TRANSPORT_PROTO_UDP;
334 uc->c_fib_index = rmt->fib_index;
335 uc->flags |= UDP_CONN_F_OWNS_PORT;
336 if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
337 uc->flags |= UDP_CONN_F_CONNECTED;
339 uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
341 return uc->c_c_index;
344 transport_connection_t *
345 udp_session_get_half_open (u32 conn_index)
347 udp_connection_t *uc;
350 /* We don't poll main thread if we have workers */
351 thread_index = vlib_num_workers ()? 1 : 0;
352 uc = udp_connection_get (conn_index, thread_index);
355 return &uc->connection;
359 static const transport_proto_vft_t udp_proto = {
360 .start_listen = udp_session_bind,
361 .connect = udp_open_connection,
362 .stop_listen = udp_session_unbind,
363 .push_header = udp_push_header,
364 .get_connection = udp_session_get,
365 .get_listener = udp_session_get_listener,
366 .get_half_open = udp_session_get_half_open,
367 .close = udp_session_close,
368 .cleanup = udp_session_cleanup,
369 .send_params = udp_session_send_params,
370 .format_connection = format_udp_session,
371 .format_half_open = format_udp_half_open_session,
372 .format_listener = format_udp_listener_session,
373 .transport_options = {
376 .tx_type = TRANSPORT_TX_DGRAM,
377 .service_type = TRANSPORT_SERVICE_CL,
384 udpc_connection_open (transport_endpoint_cfg_t * rmt)
386 udp_connection_t *uc;
387 /* Reproduce the logic of udp_open_connection to find the correct thread */
388 u32 thread_index = vlib_num_workers ()? 1 : vlib_get_main ()->thread_index;
390 uc_index = udp_open_connection (rmt);
391 if (uc_index == (u32) ~ 0)
393 uc = udp_connection_get (uc_index, thread_index);
394 uc->flags |= UDP_CONN_F_CONNECTED;
399 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
401 udp_connection_t *listener;
403 li_index = udp_session_bind (session_index, lcl);
404 if (li_index == (u32) ~ 0)
406 listener = udp_listener_get (li_index);
407 listener->flags |= UDP_CONN_F_CONNECTED;
408 /* Fake udp listener, i.e., make sure session layer adds a udp instead of
409 * udpc listener to the lookup table */
410 ((session_endpoint_cfg_t *) lcl)->transport_proto = TRANSPORT_PROTO_UDP;
415 static const transport_proto_vft_t udpc_proto = {
416 .start_listen = udpc_connection_listen,
417 .stop_listen = udp_session_unbind,
418 .connect = udpc_connection_open,
419 .push_header = udp_push_header,
420 .get_connection = udp_session_get,
421 .get_listener = udp_session_get_listener,
422 .get_half_open = udp_session_get_half_open,
423 .close = udp_session_close,
424 .cleanup = udp_session_cleanup,
425 .send_params = udp_session_send_params,
426 .format_connection = format_udp_session,
427 .format_half_open = format_udp_half_open_session,
428 .format_listener = format_udp_listener_session,
429 .transport_options = {
432 .tx_type = TRANSPORT_TX_DGRAM,
433 .service_type = TRANSPORT_SERVICE_VC,
434 .half_open_has_fifos = 1
439 static clib_error_t *
440 udp_init (vlib_main_t * vm)
442 udp_main_t *um = vnet_get_udp_main ();
443 ip_main_t *im = &ip_main;
444 vlib_thread_main_t *tm = vlib_get_thread_main ();
446 ip_protocol_info_t *pi;
453 /* IP registration */
454 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
456 return clib_error_return (0, "UDP protocol info AWOL");
457 pi->format_header = format_udp_header;
458 pi->unformat_pg_edit = unformat_pg_udp_header;
460 /* Register as transport with URI */
461 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
462 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
463 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
464 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
465 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
466 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
467 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
468 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
471 * Initialize data structures
474 num_threads = 1 /* main thread */ + tm->n_threads;
475 vec_validate (um->connections, num_threads - 1);
476 vec_validate (um->connection_peekers, num_threads - 1);
477 vec_validate (um->peekers_readers_locks, num_threads - 1);
478 vec_validate (um->peekers_write_locks, num_threads - 1);
481 for (i = 0; i < num_threads; i++)
483 clib_spinlock_init (&um->peekers_readers_locks[i]);
484 clib_spinlock_init (&um->peekers_write_locks[i]);
490 VLIB_INIT_FUNCTION (udp_init) =
492 .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
498 static clib_error_t *
499 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
500 vlib_cli_command_t * cmd_arg)
502 udp_main_t *um = vnet_get_udp_main ();
504 clib_error_t *error = NULL;
506 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
507 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
510 udp_dst_port_info_t *port_info;
511 if (um->punt_unknown4)
513 vlib_cli_output (vm, "IPv4 UDP punt: enabled");
518 vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
520 if (udp_is_valid_dst_port (port_info->dst_port, 1))
522 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
525 s = format (s, "%c", 0);
526 vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
529 if (um->punt_unknown6)
531 vlib_cli_output (vm, "IPv6 UDP punt: enabled");
536 vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
538 if (udp_is_valid_dst_port (port_info->dst_port, 01))
540 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
543 s = format (s, "%c", 0);
544 vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
550 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
552 .path = "show udp punt",
553 .short_help = "show udp punt [ipv4|ipv6]",
554 .function = show_udp_punt_fn,
559 * fd.io coding-style-patch-verification: ON
562 * eval: (c-set-style "gnu")