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_session_bind (u32 session_index, transport_endpoint_t * lcl)
155 udp_main_t *um = vnet_get_udp_main ();
156 vlib_main_t *vm = vlib_get_main ();
157 transport_endpoint_cfg_t *lcl_ext;
158 udp_connection_t *listener;
159 udp_dst_port_info_t *pi;
163 lcl_port_ho = clib_net_to_host_u16 (lcl->port);
164 pi = udp_get_dst_port_info (um, lcl_port_ho, lcl->is_ip4);
166 if (pi && !pi->n_connections
167 && udp_is_valid_dst_port (lcl_port_ho, lcl->is_ip4))
169 clib_warning ("port already used");
173 pool_get (um->listener_pool, listener);
174 clib_memset (listener, 0, sizeof (udp_connection_t));
176 listener->c_lcl_port = lcl->port;
177 listener->c_c_index = listener - um->listener_pool;
179 /* If we are provided a sw_if_index, bind using one of its ips */
180 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
182 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
184 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
186 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
187 listener->c_is_ip4 = lcl->is_ip4;
188 listener->c_proto = TRANSPORT_PROTO_UDP;
189 listener->c_s_index = session_index;
190 listener->c_fib_index = lcl->fib_index;
191 listener->flags |= UDP_CONN_F_OWNS_PORT | UDP_CONN_F_LISTEN;
192 lcl_ext = (transport_endpoint_cfg_t *) lcl;
193 if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
194 listener->flags |= UDP_CONN_F_CONNECTED;
196 listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
197 clib_spinlock_init (&listener->rx_lock);
199 udp_connection_register_port (vm, lcl_port_ho, lcl->is_ip4);
200 return listener->c_c_index;
204 udp_session_unbind (u32 listener_index)
206 udp_main_t *um = &udp_main;
207 udp_connection_t *listener;
209 listener = udp_listener_get (listener_index);
210 udp_connection_unregister_port (clib_net_to_host_u16 (listener->c_lcl_port),
212 pool_put (um->listener_pool, listener);
216 transport_connection_t *
217 udp_session_get_listener (u32 listener_index)
219 udp_connection_t *us;
221 us = udp_listener_get (listener_index);
222 return &us->connection;
226 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
228 udp_connection_t *uc;
229 vlib_main_t *vm = vlib_get_main ();
231 uc = udp_get_connection_from_transport (tc);
233 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
235 vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
240 ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
242 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
244 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
245 vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
246 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
248 if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
250 if (!transport_max_tx_dequeue (&uc->connection))
251 udp_connection_delete (uc);
257 transport_connection_t *
258 udp_session_get (u32 connection_index, u32 thread_index)
260 udp_connection_t *uc;
261 uc = udp_connection_get (connection_index, thread_index);
263 return &uc->connection;
268 udp_session_close (u32 connection_index, u32 thread_index)
270 udp_connection_t *uc;
272 uc = udp_connection_get (connection_index, thread_index);
276 if (!transport_max_tx_dequeue (&uc->connection))
277 udp_connection_delete (uc);
279 uc->flags |= UDP_CONN_F_CLOSING;
283 udp_session_cleanup (u32 connection_index, u32 thread_index)
285 udp_connection_t *uc;
286 uc = udp_connection_get (connection_index, thread_index);
289 if (uc->flags & UDP_CONN_F_MIGRATED)
290 udp_connection_free (uc);
292 udp_connection_cleanup (uc);
296 format_udp_connection_id (u8 * s, va_list * args)
298 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
302 s = format (s, "[%u:%u][%s] %U:%d->%U:%d", uc->c_thread_index,
303 uc->c_s_index, "U", format_ip4_address, &uc->c_lcl_ip4,
304 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
305 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
307 s = format (s, "[%u:%u][%s] %U:%d->%U:%d", uc->c_thread_index,
308 uc->c_s_index, "U", format_ip6_address, &uc->c_lcl_ip6,
309 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
310 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
314 const char *udp_connection_flags_str[] = {
315 #define _(sym, str) str,
316 foreach_udp_connection_flag
321 format_udp_connection_flags (u8 * s, va_list * args)
323 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
326 for (i = 0; i < UDP_CONN_N_FLAGS; i++)
327 if (uc->flags & (1 << i))
329 for (i = 0; i < last; i++)
331 if (uc->flags & (1 << i))
332 s = format (s, "%s, ", udp_connection_flags_str[i]);
335 s = format (s, "%s", udp_connection_flags_str[last]);
340 format_udp_vars (u8 * s, va_list * args)
342 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
343 s = format (s, " index %u flags: %U", uc->c_c_index,
344 format_udp_connection_flags, uc);
346 if (!(uc->flags & UDP_CONN_F_LISTEN))
347 s = format (s, "\n");
352 format_udp_connection (u8 * s, va_list * args)
354 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
355 u32 verbose = va_arg (*args, u32);
358 s = format (s, "%-50U", format_udp_connection_id, uc);
361 s = format (s, "%-15s",
362 (uc->flags & UDP_CONN_F_LISTEN) ? "LISTEN" : "OPENED", uc);
364 s = format (s, "\n%U", format_udp_vars, uc);
370 format_udp_session (u8 * s, va_list * args)
372 u32 uci = va_arg (*args, u32);
373 u32 thread_index = va_arg (*args, u32);
374 u32 verbose = va_arg (*args, u32);
375 udp_connection_t *uc;
377 uc = udp_connection_get (uci, thread_index);
378 return format (s, "%U", format_udp_connection, uc, verbose);
382 format_udp_half_open_session (u8 * s, va_list * args)
384 u32 __clib_unused tci = va_arg (*args, u32);
385 u32 __clib_unused thread_index = va_arg (*args, u32);
386 clib_warning ("BUG");
391 format_udp_listener_session (u8 * s, va_list * args)
393 u32 tci = va_arg (*args, u32);
394 u32 __clib_unused thread_index = va_arg (*args, u32);
395 u32 verbose = va_arg (*args, u32);
396 udp_connection_t *uc = udp_listener_get (tci);
397 return format (s, "%U", format_udp_connection, uc, verbose);
401 udp_session_send_params (transport_connection_t * tconn,
402 transport_send_params_t * sp)
404 /* No constraint on TX window */
406 /* TODO figure out MTU of output interface */
414 udp_open_connection (transport_endpoint_cfg_t * rmt)
416 vlib_main_t *vm = vlib_get_main ();
417 u32 thread_index = vm->thread_index;
418 udp_connection_t *uc;
419 ip46_address_t lcl_addr;
422 if (transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
426 if (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
428 /* If specific source port was requested abort */
432 /* Try to find a port that's not used */
433 while (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
435 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP,
439 clib_warning ("Failed to allocate src port");
445 udp_connection_register_port (vm, lcl_port, rmt->is_ip4);
447 /* We don't poll main thread if we have workers */
448 if (vlib_num_workers ())
451 uc = udp_connection_alloc (thread_index);
452 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
453 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
454 uc->c_rmt_port = rmt->port;
455 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
456 uc->c_is_ip4 = rmt->is_ip4;
457 uc->c_proto = TRANSPORT_PROTO_UDP;
458 uc->c_fib_index = rmt->fib_index;
459 uc->flags |= UDP_CONN_F_OWNS_PORT;
460 if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
461 uc->flags |= UDP_CONN_F_CONNECTED;
463 uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
465 return uc->c_c_index;
468 transport_connection_t *
469 udp_session_get_half_open (u32 conn_index)
471 udp_connection_t *uc;
474 /* We don't poll main thread if we have workers */
475 thread_index = vlib_num_workers ()? 1 : 0;
476 uc = udp_connection_get (conn_index, thread_index);
479 return &uc->connection;
483 static const transport_proto_vft_t udp_proto = {
484 .start_listen = udp_session_bind,
485 .connect = udp_open_connection,
486 .stop_listen = udp_session_unbind,
487 .push_header = udp_push_header,
488 .get_connection = udp_session_get,
489 .get_listener = udp_session_get_listener,
490 .get_half_open = udp_session_get_half_open,
491 .close = udp_session_close,
492 .cleanup = udp_session_cleanup,
493 .send_params = udp_session_send_params,
494 .format_connection = format_udp_session,
495 .format_half_open = format_udp_half_open_session,
496 .format_listener = format_udp_listener_session,
497 .transport_options = {
500 .tx_type = TRANSPORT_TX_DGRAM,
501 .service_type = TRANSPORT_SERVICE_CL,
508 udpc_connection_open (transport_endpoint_cfg_t * rmt)
510 udp_connection_t *uc;
511 /* Reproduce the logic of udp_open_connection to find the correct thread */
512 u32 thread_index = vlib_num_workers ()? 1 : vlib_get_main ()->thread_index;
514 uc_index = udp_open_connection (rmt);
515 if (uc_index == (u32) ~ 0)
517 uc = udp_connection_get (uc_index, thread_index);
518 uc->flags |= UDP_CONN_F_CONNECTED;
523 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
525 udp_connection_t *listener;
527 li_index = udp_session_bind (session_index, lcl);
528 if (li_index == (u32) ~ 0)
530 listener = udp_listener_get (li_index);
531 listener->flags |= UDP_CONN_F_CONNECTED;
532 /* Fake udp listener, i.e., make sure session layer adds a udp instead of
533 * udpc listener to the lookup table */
534 ((session_endpoint_cfg_t *) lcl)->transport_proto = TRANSPORT_PROTO_UDP;
539 static const transport_proto_vft_t udpc_proto = {
540 .start_listen = udpc_connection_listen,
541 .stop_listen = udp_session_unbind,
542 .connect = udpc_connection_open,
543 .push_header = udp_push_header,
544 .get_connection = udp_session_get,
545 .get_listener = udp_session_get_listener,
546 .get_half_open = udp_session_get_half_open,
547 .close = udp_session_close,
548 .cleanup = udp_session_cleanup,
549 .send_params = udp_session_send_params,
550 .format_connection = format_udp_session,
551 .format_half_open = format_udp_half_open_session,
552 .format_listener = format_udp_listener_session,
553 .transport_options = {
556 .tx_type = TRANSPORT_TX_DGRAM,
557 .service_type = TRANSPORT_SERVICE_VC,
558 .half_open_has_fifos = 1
563 static clib_error_t *
564 udp_init (vlib_main_t * vm)
566 udp_main_t *um = vnet_get_udp_main ();
567 ip_main_t *im = &ip_main;
568 vlib_thread_main_t *tm = vlib_get_thread_main ();
570 ip_protocol_info_t *pi;
577 /* IP registration */
578 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
580 return clib_error_return (0, "UDP protocol info AWOL");
581 pi->format_header = format_udp_header;
582 pi->unformat_pg_edit = unformat_pg_udp_header;
584 /* Register as transport with URI */
585 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
586 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
587 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
588 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
589 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
590 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
591 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
592 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
595 * Initialize data structures
598 num_threads = 1 /* main thread */ + tm->n_threads;
599 vec_validate (um->connections, num_threads - 1);
600 vec_validate (um->connection_peekers, num_threads - 1);
601 vec_validate (um->peekers_readers_locks, num_threads - 1);
602 vec_validate (um->peekers_write_locks, num_threads - 1);
605 for (i = 0; i < num_threads; i++)
607 clib_spinlock_init (&um->peekers_readers_locks[i]);
608 clib_spinlock_init (&um->peekers_write_locks[i]);
611 um->local_to_input_edge[UDP_IP4] =
612 vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
613 um->local_to_input_edge[UDP_IP6] =
614 vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
619 VLIB_INIT_FUNCTION (udp_init) =
621 .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
627 static clib_error_t *
628 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
629 vlib_cli_command_t * cmd_arg)
631 udp_main_t *um = vnet_get_udp_main ();
633 clib_error_t *error = NULL;
635 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
636 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
639 udp_dst_port_info_t *port_info;
640 if (um->punt_unknown4)
642 vlib_cli_output (vm, "IPv4 UDP punt: enabled");
647 vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
649 if (udp_is_valid_dst_port (port_info->dst_port, 1))
651 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
654 s = format (s, "%c", 0);
655 vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
658 if (um->punt_unknown6)
660 vlib_cli_output (vm, "IPv6 UDP punt: enabled");
665 vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
667 if (udp_is_valid_dst_port (port_info->dst_port, 01))
669 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
672 s = format (s, "%c", 0);
673 vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
679 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
681 .path = "show udp punt",
682 .short_help = "show udp punt [ipv4|ipv6]",
683 .function = show_udp_punt_fn,
688 * fd.io coding-style-patch-verification: ON
691 * eval: (c-set-style "gnu")