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>
24 #include <vppinfra/sparse_vec.h>
29 udp_connection_register_port (vlib_main_t * vm, u16 lcl_port, u8 is_ip4)
31 udp_main_t *um = &udp_main;
32 udp_dst_port_info_t *pi;
35 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
38 udp_add_dst_port (um, lcl_port, 0, is_ip4);
39 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
40 pi->n_connections = 1;
44 pi->n_connections += 1;
45 /* Do not return. The fact that the pi is valid does not mean
49 pi->node_index = is_ip4 ? udp4_input_node.index : udp6_input_node.index;
50 pi->next_index = um->local_to_input_edge[is_ip4];
52 /* Setup udp protocol -> next index sparse vector mapping. */
54 n = sparse_vec_validate (um->next_by_dst_port4,
55 clib_host_to_net_u16 (lcl_port));
57 n = sparse_vec_validate (um->next_by_dst_port6,
58 clib_host_to_net_u16 (lcl_port));
60 n[0] = pi->next_index;
64 udp_connection_unregister_port (u16 lcl_port, u8 is_ip4)
66 udp_main_t *um = &udp_main;
67 udp_dst_port_info_t *pi;
69 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
73 if (!pi->n_connections)
75 clib_warning ("no connections using port %u", lcl_port);
79 if (!clib_atomic_sub_fetch (&pi->n_connections, 1))
80 udp_unregister_dst_port (0, lcl_port, is_ip4);
84 udp_connection_share_port (u16 lcl_port, u8 is_ip4)
86 udp_main_t *um = &udp_main;
87 udp_dst_port_info_t *pi;
89 /* Done without a lock but the operation is atomic. Writers to pi hash
90 * table and vector should be guarded by a barrier sync */
91 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
92 clib_atomic_fetch_add_rel (&pi->n_connections, 1);
96 udp_connection_alloc (u32 thread_index)
98 udp_main_t *um = &udp_main;
101 pool_get_aligned_will_expand (um->connections[thread_index], will_expand,
102 CLIB_CACHE_LINE_BYTES);
104 if (PREDICT_FALSE (will_expand))
106 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks
108 pool_get_aligned (udp_main.connections[thread_index], uc,
109 CLIB_CACHE_LINE_BYTES);
110 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
115 pool_get_aligned (um->connections[thread_index], uc,
116 CLIB_CACHE_LINE_BYTES);
118 clib_memset (uc, 0, sizeof (*uc));
119 uc->c_c_index = uc - um->connections[thread_index];
120 uc->c_thread_index = thread_index;
121 uc->c_proto = TRANSPORT_PROTO_UDP;
122 clib_spinlock_init (&uc->rx_lock);
127 udp_connection_free (udp_connection_t * uc)
129 u32 thread_index = uc->c_thread_index;
131 clib_memset (uc, 0xFA, sizeof (*uc));
132 pool_put (udp_main.connections[thread_index], uc);
136 udp_connection_cleanup (udp_connection_t * uc)
138 transport_endpoint_cleanup (TRANSPORT_PROTO_UDP, &uc->c_lcl_ip,
140 udp_connection_unregister_port (clib_net_to_host_u16 (uc->c_lcl_port),
142 udp_connection_free (uc);
146 udp_connection_delete (udp_connection_t * uc)
148 session_transport_delete_notify (&uc->connection);
149 udp_connection_cleanup (uc);
153 udp_connection_port_used_extern (u16 lcl_port, u8 is_ip4)
155 udp_main_t *um = vnet_get_udp_main ();
156 udp_dst_port_info_t *pi;
158 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
159 return (pi && !pi->n_connections
160 && udp_is_valid_dst_port (lcl_port, is_ip4));
164 udp_session_bind (u32 session_index, transport_endpoint_t * lcl)
166 udp_main_t *um = vnet_get_udp_main ();
167 vlib_main_t *vm = vlib_get_main ();
168 transport_endpoint_cfg_t *lcl_ext;
169 udp_connection_t *listener;
173 lcl_port_ho = clib_net_to_host_u16 (lcl->port);
175 if (udp_connection_port_used_extern (lcl_port_ho, lcl->is_ip4))
177 clib_warning ("port already used");
178 return SESSION_E_PORTINUSE;
181 pool_get (um->listener_pool, listener);
182 clib_memset (listener, 0, sizeof (udp_connection_t));
184 listener->c_lcl_port = lcl->port;
185 listener->c_c_index = listener - um->listener_pool;
187 /* If we are provided a sw_if_index, bind using one of its ips */
188 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
190 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
192 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
194 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
195 listener->c_is_ip4 = lcl->is_ip4;
196 listener->c_proto = TRANSPORT_PROTO_UDP;
197 listener->c_s_index = session_index;
198 listener->c_fib_index = lcl->fib_index;
199 listener->mss = um->default_mtu - sizeof (udp_header_t);
200 listener->flags |= UDP_CONN_F_OWNS_PORT | UDP_CONN_F_LISTEN;
201 lcl_ext = (transport_endpoint_cfg_t *) lcl;
202 if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
203 listener->flags |= UDP_CONN_F_CONNECTED;
205 listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
206 clib_spinlock_init (&listener->rx_lock);
208 udp_connection_register_port (vm, lcl_port_ho, lcl->is_ip4);
209 return listener->c_c_index;
213 udp_session_unbind (u32 listener_index)
215 udp_main_t *um = &udp_main;
216 udp_connection_t *listener;
218 listener = udp_listener_get (listener_index);
219 udp_connection_unregister_port (clib_net_to_host_u16 (listener->c_lcl_port),
221 pool_put (um->listener_pool, listener);
225 transport_connection_t *
226 udp_session_get_listener (u32 listener_index)
228 udp_connection_t *us;
230 us = udp_listener_get (listener_index);
231 return &us->connection;
235 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
237 udp_connection_t *uc;
238 vlib_main_t *vm = vlib_get_main ();
240 uc = udp_get_connection_from_transport (tc);
242 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
244 vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
249 ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
251 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
253 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
254 vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
255 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
257 if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
259 if (!transport_max_tx_dequeue (&uc->connection))
260 udp_connection_delete (uc);
266 transport_connection_t *
267 udp_session_get (u32 connection_index, u32 thread_index)
269 udp_connection_t *uc;
270 uc = udp_connection_get (connection_index, thread_index);
272 return &uc->connection;
277 udp_session_close (u32 connection_index, u32 thread_index)
279 udp_connection_t *uc;
281 uc = udp_connection_get (connection_index, thread_index);
285 if (!transport_max_tx_dequeue (&uc->connection))
286 udp_connection_delete (uc);
288 uc->flags |= UDP_CONN_F_CLOSING;
292 udp_session_cleanup (u32 connection_index, u32 thread_index)
294 udp_connection_t *uc;
295 uc = udp_connection_get (connection_index, thread_index);
298 if (uc->flags & UDP_CONN_F_MIGRATED)
299 udp_connection_free (uc);
301 udp_connection_cleanup (uc);
305 format_udp_connection_id (u8 * s, va_list * args)
307 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
311 s = format (s, "[%u:%u][%s] %U:%d->%U:%d", uc->c_thread_index,
312 uc->c_s_index, "U", format_ip4_address, &uc->c_lcl_ip4,
313 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
314 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
316 s = format (s, "[%u:%u][%s] %U:%d->%U:%d", uc->c_thread_index,
317 uc->c_s_index, "U", format_ip6_address, &uc->c_lcl_ip6,
318 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
319 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
323 const char *udp_connection_flags_str[] = {
324 #define _(sym, str) str,
325 foreach_udp_connection_flag
330 format_udp_connection_flags (u8 * s, va_list * args)
332 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
335 for (i = 0; i < UDP_CONN_N_FLAGS; i++)
336 if (uc->flags & (1 << i))
338 for (i = 0; i < last; i++)
340 if (uc->flags & (1 << i))
341 s = format (s, "%s, ", udp_connection_flags_str[i]);
344 s = format (s, "%s", udp_connection_flags_str[last]);
349 format_udp_vars (u8 * s, va_list * args)
351 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
352 s = format (s, " index %u flags: %U", uc->c_c_index,
353 format_udp_connection_flags, uc);
355 if (!(uc->flags & UDP_CONN_F_LISTEN))
356 s = format (s, "\n");
361 format_udp_connection (u8 * s, va_list * args)
363 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
364 u32 verbose = va_arg (*args, u32);
367 s = format (s, "%-50U", format_udp_connection_id, uc);
370 s = format (s, "%-15s",
371 (uc->flags & UDP_CONN_F_LISTEN) ? "LISTEN" : "OPENED", uc);
373 s = format (s, "\n%U", format_udp_vars, uc);
379 format_udp_session (u8 * s, va_list * args)
381 u32 uci = va_arg (*args, u32);
382 u32 thread_index = va_arg (*args, u32);
383 u32 verbose = va_arg (*args, u32);
384 udp_connection_t *uc;
386 uc = udp_connection_get (uci, thread_index);
387 return format (s, "%U", format_udp_connection, uc, verbose);
391 format_udp_half_open_session (u8 * s, va_list * args)
393 u32 __clib_unused tci = va_arg (*args, u32);
394 u32 __clib_unused thread_index = va_arg (*args, u32);
395 clib_warning ("BUG");
400 format_udp_listener_session (u8 * s, va_list * args)
402 u32 tci = va_arg (*args, u32);
403 u32 __clib_unused thread_index = va_arg (*args, u32);
404 u32 verbose = va_arg (*args, u32);
405 udp_connection_t *uc = udp_listener_get (tci);
406 return format (s, "%U", format_udp_connection, uc, verbose);
410 udp_session_send_params (transport_connection_t * tconn,
411 transport_send_params_t * sp)
413 udp_connection_t *uc;
415 uc = udp_get_connection_from_transport (tconn);
417 /* No constraint on TX window */
419 /* TODO figure out MTU of output interface */
420 sp->snd_mss = uc->mss;
427 udp_open_connection (transport_endpoint_cfg_t * rmt)
429 vlib_main_t *vm = vlib_get_main ();
430 u32 thread_index = vm->thread_index;
431 udp_main_t *um = &udp_main;
432 ip46_address_t lcl_addr;
433 udp_connection_t *uc;
437 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
441 if (rv != SESSION_E_PORTINUSE)
444 if (udp_connection_port_used_extern (lcl_port, rmt->is_ip4))
445 return SESSION_E_PORTINUSE;
447 /* If port in use, check if 5-tuple is also in use */
448 if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
449 lcl_port, rmt->port, TRANSPORT_PROTO_UDP,
451 return SESSION_E_PORTINUSE;
453 /* 5-tuple is available so increase lcl endpoint refcount and proceed
454 * with connection allocation */
455 transport_share_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
460 if (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
462 /* If specific source port was requested abort */
464 return SESSION_E_PORTINUSE;
466 /* Try to find a port that's not used */
467 while (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
469 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP,
472 return SESSION_E_PORTINUSE;
478 udp_connection_register_port (vm, lcl_port, rmt->is_ip4);
480 /* We don't poll main thread if we have workers */
481 if (vlib_num_workers ())
484 uc = udp_connection_alloc (thread_index);
485 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
486 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
487 uc->c_rmt_port = rmt->port;
488 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
489 uc->c_is_ip4 = rmt->is_ip4;
490 uc->c_proto = TRANSPORT_PROTO_UDP;
491 uc->c_fib_index = rmt->fib_index;
492 uc->mss = rmt->mss ? rmt->mss : (um->default_mtu - sizeof (udp_header_t));
493 uc->flags |= UDP_CONN_F_OWNS_PORT;
494 if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
495 uc->flags |= UDP_CONN_F_CONNECTED;
497 uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
499 return uc->c_c_index;
502 transport_connection_t *
503 udp_session_get_half_open (u32 conn_index)
505 udp_connection_t *uc;
508 /* We don't poll main thread if we have workers */
509 thread_index = vlib_num_workers ()? 1 : 0;
510 uc = udp_connection_get (conn_index, thread_index);
513 return &uc->connection;
517 static const transport_proto_vft_t udp_proto = {
518 .start_listen = udp_session_bind,
519 .connect = udp_open_connection,
520 .stop_listen = udp_session_unbind,
521 .push_header = udp_push_header,
522 .get_connection = udp_session_get,
523 .get_listener = udp_session_get_listener,
524 .get_half_open = udp_session_get_half_open,
525 .close = udp_session_close,
526 .cleanup = udp_session_cleanup,
527 .send_params = udp_session_send_params,
528 .format_connection = format_udp_session,
529 .format_half_open = format_udp_half_open_session,
530 .format_listener = format_udp_listener_session,
531 .transport_options = {
534 .tx_type = TRANSPORT_TX_DGRAM,
535 .service_type = TRANSPORT_SERVICE_CL,
542 udpc_connection_open (transport_endpoint_cfg_t * rmt)
544 udp_connection_t *uc;
545 /* Reproduce the logic of udp_open_connection to find the correct thread */
546 u32 thread_index = vlib_num_workers ()? 1 : vlib_get_main ()->thread_index;
548 uc_index = udp_open_connection (rmt);
549 if (uc_index == (u32) ~ 0)
551 uc = udp_connection_get (uc_index, thread_index);
552 uc->flags |= UDP_CONN_F_CONNECTED;
557 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
559 udp_connection_t *listener;
561 li_index = udp_session_bind (session_index, lcl);
562 if (li_index == (u32) ~ 0)
564 listener = udp_listener_get (li_index);
565 listener->flags |= UDP_CONN_F_CONNECTED;
566 /* Fake udp listener, i.e., make sure session layer adds a udp instead of
567 * udpc listener to the lookup table */
568 ((session_endpoint_cfg_t *) lcl)->transport_proto = TRANSPORT_PROTO_UDP;
573 static const transport_proto_vft_t udpc_proto = {
574 .start_listen = udpc_connection_listen,
575 .stop_listen = udp_session_unbind,
576 .connect = udpc_connection_open,
577 .push_header = udp_push_header,
578 .get_connection = udp_session_get,
579 .get_listener = udp_session_get_listener,
580 .get_half_open = udp_session_get_half_open,
581 .close = udp_session_close,
582 .cleanup = udp_session_cleanup,
583 .send_params = udp_session_send_params,
584 .format_connection = format_udp_session,
585 .format_half_open = format_udp_half_open_session,
586 .format_listener = format_udp_listener_session,
587 .transport_options = {
590 .tx_type = TRANSPORT_TX_DGRAM,
591 .service_type = TRANSPORT_SERVICE_VC,
592 .half_open_has_fifos = 1
597 static clib_error_t *
598 udp_init (vlib_main_t * vm)
600 udp_main_t *um = vnet_get_udp_main ();
601 ip_main_t *im = &ip_main;
602 vlib_thread_main_t *tm = vlib_get_thread_main ();
604 ip_protocol_info_t *pi;
611 /* IP registration */
612 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
614 return clib_error_return (0, "UDP protocol info AWOL");
615 pi->format_header = format_udp_header;
616 pi->unformat_pg_edit = unformat_pg_udp_header;
618 /* Register as transport with URI */
619 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
620 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
621 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
622 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
623 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
624 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
625 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
626 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
629 * Initialize data structures
632 num_threads = 1 /* main thread */ + tm->n_threads;
633 vec_validate (um->connections, num_threads - 1);
634 vec_validate (um->connection_peekers, num_threads - 1);
635 vec_validate (um->peekers_readers_locks, num_threads - 1);
636 vec_validate (um->peekers_write_locks, num_threads - 1);
639 for (i = 0; i < num_threads; i++)
641 clib_spinlock_init (&um->peekers_readers_locks[i]);
642 clib_spinlock_init (&um->peekers_write_locks[i]);
645 um->local_to_input_edge[UDP_IP4] =
646 vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
647 um->local_to_input_edge[UDP_IP6] =
648 vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
650 um->default_mtu = 1500;
655 VLIB_INIT_FUNCTION (udp_init) =
657 .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
662 static clib_error_t *
663 udp_config_fn (vlib_main_t * vm, unformat_input_t * input)
665 udp_main_t *um = &udp_main;
668 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
670 if (unformat (input, "mtu %u", &tmp))
671 um->default_mtu = tmp;
673 return clib_error_return (0, "unknown input `%U'",
674 format_unformat_error, input);
679 VLIB_CONFIG_FUNCTION (udp_config_fn, "udp");
681 static clib_error_t *
682 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
683 vlib_cli_command_t * cmd_arg)
685 udp_main_t *um = vnet_get_udp_main ();
687 clib_error_t *error = NULL;
689 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
690 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
693 udp_dst_port_info_t *port_info;
694 if (um->punt_unknown4)
696 vlib_cli_output (vm, "IPv4 UDP punt: enabled");
701 vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
703 if (udp_is_valid_dst_port (port_info->dst_port, 1))
705 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
708 s = format (s, "%c", 0);
709 vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
712 if (um->punt_unknown6)
714 vlib_cli_output (vm, "IPv6 UDP punt: enabled");
719 vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
721 if (udp_is_valid_dst_port (port_info->dst_port, 01))
723 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
726 s = format (s, "%c", 0);
727 vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
733 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
735 .path = "show udp punt",
736 .short_help = "show udp punt [ipv4|ipv6]",
737 .function = show_udp_punt_fn,
742 * fd.io coding-style-patch-verification: ON
745 * eval: (c-set-style "gnu")