2 * Copyright (c) 2016-2020 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.
16 #include <vnet/udp/udp.h>
17 #include <vnet/session/session.h>
18 #include <vnet/dpo/load_balance.h>
19 #include <vnet/ip/ip4_inlines.h>
20 #include <vnet/ip/ip6_inlines.h>
21 #include <vppinfra/sparse_vec.h>
26 udp_connection_register_port (u16 lcl_port, u8 is_ip4)
28 udp_main_t *um = &udp_main;
31 /* Setup udp protocol -> next index sparse vector mapping. Do not setup
32 * udp_dst_port_info_t as that is used to distinguish between external
33 * and transport consumed ports */
36 n = sparse_vec_validate (um->next_by_dst_port4, lcl_port);
38 n = sparse_vec_validate (um->next_by_dst_port6, lcl_port);
40 n[0] = um->local_to_input_edge[is_ip4];
42 __atomic_add_fetch (&um->transport_ports_refcnt[is_ip4][lcl_port], 1,
47 udp_connection_unregister_port (u16 lcl_port, u8 is_ip4)
49 udp_main_t *um = &udp_main;
52 /* Needed because listeners are not tracked as local endpoints */
53 if (__atomic_sub_fetch (&um->transport_ports_refcnt[is_ip4][lcl_port], 1,
58 n = sparse_vec_validate (um->next_by_dst_port4, lcl_port);
60 n = sparse_vec_validate (um->next_by_dst_port6, lcl_port);
62 n[0] = UDP_NO_NODE_SET;
66 udp_connection_alloc (u32 thread_index)
68 udp_worker_t *wrk = udp_worker_get (thread_index);
71 pool_get_aligned_safe (wrk->connections, uc, CLIB_CACHE_LINE_BYTES);
73 clib_memset (uc, 0, sizeof (*uc));
74 uc->c_c_index = uc - wrk->connections;
75 uc->c_thread_index = thread_index;
76 uc->c_proto = TRANSPORT_PROTO_UDP;
81 udp_connection_free (udp_connection_t * uc)
83 udp_worker_t *wrk = udp_worker_get (uc->c_thread_index);
85 clib_spinlock_free (&uc->rx_lock);
87 clib_memset (uc, 0xFA, sizeof (*uc));
88 pool_put (wrk->connections, uc);
92 udp_connection_cleanup (udp_connection_t * uc)
94 transport_release_local_endpoint (TRANSPORT_PROTO_UDP, &uc->c_lcl_ip,
96 udp_connection_unregister_port (uc->c_lcl_port, uc->c_is_ip4);
97 udp_connection_free (uc);
101 udp_connection_delete (udp_connection_t * uc)
103 session_transport_delete_notify (&uc->connection);
104 udp_connection_cleanup (uc);
108 udp_handle_cleanups (void *args)
110 u32 thread_index = (u32) pointer_to_uword (args);
111 udp_connection_t *uc;
115 wrk = udp_worker_get (thread_index);
116 vec_foreach (uc_index, wrk->pending_cleanups)
118 uc = udp_connection_get (*uc_index, thread_index);
119 udp_connection_delete (uc);
121 vec_reset_length (wrk->pending_cleanups);
125 udp_connection_program_cleanup (udp_connection_t *uc)
127 uword thread_index = uc->c_thread_index;
130 wrk = udp_worker_get (uc->c_thread_index);
131 vec_add1 (wrk->pending_cleanups, uc->c_c_index);
133 if (vec_len (wrk->pending_cleanups) == 1)
134 session_send_rpc_evt_to_thread_force (
135 thread_index, udp_handle_cleanups,
136 uword_to_pointer (thread_index, void *));
140 udp_connection_port_used_extern (u16 lcl_port, u8 is_ip4)
142 udp_main_t *um = vnet_get_udp_main ();
143 udp_dst_port_info_t *pi;
145 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
146 return (pi && udp_is_valid_dst_port (lcl_port, is_ip4));
150 udp_default_mtu (udp_main_t * um, u8 is_ip4)
152 u16 ip_hlen = is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
153 return (um->default_mtu - sizeof (udp_header_t) - ip_hlen);
157 udp_session_bind (u32 session_index, transport_endpoint_cfg_t *lcl)
159 udp_main_t *um = vnet_get_udp_main ();
160 transport_endpoint_cfg_t *lcl_ext;
161 udp_connection_t *listener;
164 if (udp_connection_port_used_extern (clib_net_to_host_u16 (lcl->port),
167 clib_warning ("port already used");
168 return SESSION_E_PORTINUSE;
171 pool_get (um->listener_pool, listener);
172 clib_memset (listener, 0, sizeof (udp_connection_t));
174 listener->c_lcl_port = lcl->port;
175 listener->c_c_index = listener - um->listener_pool;
177 /* If we are provided a sw_if_index, bind using one of its ips */
178 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
180 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
182 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
184 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
185 listener->c_is_ip4 = lcl->is_ip4;
186 listener->c_proto = TRANSPORT_PROTO_UDP;
187 listener->c_s_index = session_index;
188 listener->c_fib_index = lcl->fib_index;
190 lcl->mss ? lcl->mss : udp_default_mtu (um, listener->c_is_ip4);
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);
198 if (!um->csum_offload)
199 listener->cfg_flags |= UDP_CFG_F_NO_CSUM_OFFLOAD;
201 udp_connection_register_port (listener->c_lcl_port, lcl->is_ip4);
202 return listener->c_c_index;
206 udp_session_unbind (u32 listener_index)
208 udp_main_t *um = &udp_main;
209 udp_connection_t *listener;
211 listener = udp_listener_get (listener_index);
212 udp_connection_unregister_port (listener->c_lcl_port, listener->c_is_ip4);
213 clib_spinlock_free (&listener->rx_lock);
214 pool_put (um->listener_pool, listener);
218 static transport_connection_t *
219 udp_session_get_listener (u32 listener_index)
221 udp_connection_t *us;
223 us = udp_listener_get (listener_index);
224 return &us->connection;
228 udp_push_one_header (vlib_main_t *vm, udp_connection_t *uc, vlib_buffer_t *b,
231 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
232 /* reuse tcp medatada for now */
233 vnet_buffer (b)->tcp.connection_index = uc->c_c_index;
237 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port,
238 udp_csum_offload (uc));
241 vlib_buffer_push_ip4_custom (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
242 IP_PROTOCOL_UDP, udp_csum_offload (uc),
243 0 /* is_df */, uc->c_dscp);
245 vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
248 vnet_buffer (b)->tcp.flags = 0;
252 u8 *data = vlib_buffer_get_current (b);
253 session_dgram_hdr_t hdr;
255 hdr = *(session_dgram_hdr_t *) (data - sizeof (hdr));
257 /* Local port assumed to be bound, not overwriting it */
258 vlib_buffer_push_udp (b, uc->c_lcl_port, hdr.rmt_port,
259 udp_csum_offload (uc));
262 vlib_buffer_push_ip4_custom (vm, b, &hdr.lcl_ip.ip4, &hdr.rmt_ip.ip4,
263 IP_PROTOCOL_UDP, udp_csum_offload (uc),
264 0 /* is_df */, uc->c_dscp);
266 vlib_buffer_push_ip6 (vm, b, &hdr.lcl_ip.ip6, &hdr.rmt_ip.ip6,
269 /* Not connected udp session. Mark buffer for custom handling in
271 vnet_buffer (b)->tcp.flags |= UDP_CONN_F_LISTEN;
278 udp_push_header_batch (udp_connection_t *uc, vlib_buffer_t **bs, u32 n_bufs,
281 vlib_main_t *vm = vlib_get_main ();
285 vlib_prefetch_buffer_header (bs[2], STORE);
286 vlib_prefetch_buffer_header (bs[3], STORE);
288 udp_push_one_header (vm, uc, bs[0], is_cless);
289 udp_push_one_header (vm, uc, bs[1], is_cless);
297 vlib_prefetch_buffer_header (bs[1], STORE);
299 udp_push_one_header (vm, uc, bs[0], is_cless);
307 udp_push_header (transport_connection_t *tc, vlib_buffer_t **bs, u32 n_bufs)
309 udp_connection_t *uc;
311 uc = udp_connection_from_transport (tc);
312 if (uc->flags & UDP_CONN_F_CONNECTED)
313 udp_push_header_batch (uc, bs, n_bufs, 0 /* is_cless */);
315 udp_push_header_batch (uc, bs, n_bufs, 1 /* is_cless */);
317 if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
319 if (!transport_tx_fifo_has_dgram (&uc->connection))
320 udp_connection_program_cleanup (uc);
326 static transport_connection_t *
327 udp_session_get (u32 connection_index, u32 thread_index)
329 udp_connection_t *uc;
330 uc = udp_connection_get (connection_index, thread_index);
332 return &uc->connection;
337 udp_session_close (u32 connection_index, u32 thread_index)
339 udp_connection_t *uc;
341 uc = udp_connection_get (connection_index, thread_index);
342 if (!uc || (uc->flags & UDP_CONN_F_MIGRATED))
345 if (!transport_tx_fifo_has_dgram (&uc->connection))
346 udp_connection_program_cleanup (uc);
348 uc->flags |= UDP_CONN_F_CLOSING;
352 udp_session_cleanup (u32 connection_index, u32 thread_index)
354 udp_connection_t *uc;
355 uc = udp_connection_get (connection_index, thread_index);
358 if (uc->flags & UDP_CONN_F_MIGRATED)
359 udp_connection_free (uc);
361 udp_connection_cleanup (uc);
365 udp_session_send_params (transport_connection_t * tconn,
366 transport_send_params_t * sp)
368 udp_connection_t *uc;
370 uc = udp_connection_from_transport (tconn);
372 /* No constraint on TX window */
374 /* TODO figure out MTU of output interface */
375 sp->snd_mss = uc->mss;
382 udp_open_connection (transport_endpoint_cfg_t * rmt)
384 udp_main_t *um = &udp_main;
385 ip46_address_t lcl_addr;
386 udp_connection_t *uc;
391 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
396 if (udp_connection_port_used_extern (clib_net_to_host_u16 (lcl_port),
399 /* If specific source port was requested abort */
402 transport_release_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
404 return SESSION_E_PORTINUSE;
407 /* Try to find a port that's not used */
408 while (udp_connection_port_used_extern (clib_net_to_host_u16 (lcl_port),
411 transport_release_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
414 transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr, rmt);
416 return SESSION_E_PORTINUSE;
420 /* We don't poll main thread if we have workers */
421 thread_index = transport_cl_thread ();
423 uc = udp_connection_alloc (thread_index);
424 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
425 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
426 uc->c_rmt_port = rmt->port;
427 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
428 uc->c_is_ip4 = rmt->is_ip4;
429 uc->c_proto = TRANSPORT_PROTO_UDP;
430 uc->c_fib_index = rmt->fib_index;
431 uc->c_dscp = rmt->dscp;
432 uc->mss = rmt->mss ? rmt->mss : udp_default_mtu (um, uc->c_is_ip4);
433 if (rmt->peer.sw_if_index != ENDPOINT_INVALID_INDEX)
434 uc->sw_if_index = rmt->peer.sw_if_index;
435 uc->flags |= UDP_CONN_F_OWNS_PORT;
436 if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
438 uc->flags |= UDP_CONN_F_CONNECTED;
442 clib_spinlock_init (&uc->rx_lock);
443 uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
445 if (!um->csum_offload)
446 uc->cfg_flags |= UDP_CFG_F_NO_CSUM_OFFLOAD;
447 uc->next_node_index = rmt->next_node_index;
448 uc->next_node_opaque = rmt->next_node_opaque;
450 udp_connection_register_port (uc->c_lcl_port, rmt->is_ip4);
452 return uc->c_c_index;
455 static transport_connection_t *
456 udp_session_get_half_open (u32 conn_index)
458 udp_connection_t *uc;
461 /* We don't poll main thread if we have workers */
462 thread_index = transport_cl_thread ();
463 uc = udp_connection_get (conn_index, thread_index);
466 return &uc->connection;
470 format_udp_session (u8 * s, va_list * args)
472 u32 uci = va_arg (*args, u32);
473 u32 thread_index = va_arg (*args, u32);
474 u32 verbose = va_arg (*args, u32);
475 udp_connection_t *uc;
477 uc = udp_connection_get (uci, thread_index);
478 return format (s, "%U", format_udp_connection, uc, verbose);
482 format_udp_half_open_session (u8 * s, va_list * args)
484 u32 __clib_unused tci = va_arg (*args, u32);
485 u32 __clib_unused thread_index = va_arg (*args, u32);
486 clib_warning ("BUG");
491 format_udp_listener_session (u8 * s, va_list * args)
493 u32 tci = va_arg (*args, u32);
494 u32 __clib_unused thread_index = va_arg (*args, u32);
495 u32 verbose = va_arg (*args, u32);
496 udp_connection_t *uc = udp_listener_get (tci);
497 return format (s, "%U", format_udp_connection, uc, verbose);
501 udp_realloc_ports_sv (u16 **ports_nh_svp)
503 u16 port, port_no, *ports_nh_sv, *mc;
504 u32 *ports = 0, *nh = 0, msum, i;
505 sparse_vec_header_t *h;
508 ports_nh_sv = *ports_nh_svp;
510 for (port = 1; port < 65535; port++)
512 port_no = clib_host_to_net_u16 (port);
514 sv_index = sparse_vec_index (ports_nh_sv, port_no);
515 if (sv_index != SPARSE_VEC_INVALID_INDEX)
517 vec_add1 (ports, port_no);
518 vec_add1 (nh, ports_nh_sv[sv_index]);
522 sparse_vec_free (ports_nh_sv);
525 sparse_vec_new (/* elt bytes */ sizeof (ports_nh_sv[0]),
526 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
528 vec_resize (ports_nh_sv, 65535);
530 for (port = 1; port < 65535; port++)
531 ports_nh_sv[port] = UDP_NO_NODE_SET;
533 for (i = 0; i < vec_len (ports); i++)
534 ports_nh_sv[ports[i]] = nh[i];
536 h = sparse_vec_header (ports_nh_sv);
537 vec_foreach (mb, h->is_member_bitmap)
541 vec_foreach (mc, h->member_counts)
544 msum += msum == 0 ? 63 : 64;
550 *ports_nh_svp = ports_nh_sv;
553 static clib_error_t *
554 udp_enable_disable (vlib_main_t *vm, u8 is_en)
556 udp_main_t *um = &udp_main;
558 /* Not ideal. The sparse vector used to map ports to next nodes assumes
559 * only a few ports are ever used. When udp transport is enabled this does
560 * not hold and, to make matters worse, ports are consumed in a random
563 * This can lead to a lot of slow updates to internal data structures
564 * which in turn can slow udp connection allocations until all ports are
565 * eventually consumed.
567 * Consequently, reallocate sparse vector, preallocate all ports and have
568 * them point to UDP_NO_NODE_SET. We could consider switching the sparse
569 * vector to a preallocated vector but that would increase memory
570 * consumption for vpp deployments that do not rely on host stack.
573 udp_realloc_ports_sv (&um->next_by_dst_port4);
574 udp_realloc_ports_sv (&um->next_by_dst_port6);
576 vec_validate (um->transport_ports_refcnt[0], 65535);
577 vec_validate (um->transport_ports_refcnt[1], 65535);
582 static const transport_proto_vft_t udp_proto = {
583 .enable = udp_enable_disable,
584 .start_listen = udp_session_bind,
585 .connect = udp_open_connection,
586 .stop_listen = udp_session_unbind,
587 .push_header = udp_push_header,
588 .get_connection = udp_session_get,
589 .get_listener = udp_session_get_listener,
590 .get_half_open = udp_session_get_half_open,
591 .close = udp_session_close,
592 .cleanup = udp_session_cleanup,
593 .send_params = udp_session_send_params,
594 .format_connection = format_udp_session,
595 .format_half_open = format_udp_half_open_session,
596 .format_listener = format_udp_listener_session,
597 .transport_options = {
600 .tx_type = TRANSPORT_TX_DGRAM,
601 .service_type = TRANSPORT_SERVICE_CL,
605 static clib_error_t *
606 udp_init (vlib_main_t * vm)
608 udp_main_t *um = vnet_get_udp_main ();
609 ip_main_t *im = &ip_main;
610 vlib_thread_main_t *tm = vlib_get_thread_main ();
612 ip_protocol_info_t *pi;
618 /* IP registration */
619 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
621 return clib_error_return (0, "UDP protocol info AWOL");
622 pi->format_header = format_udp_header;
623 pi->unformat_pg_edit = unformat_pg_udp_header;
625 /* Register as transport with session layer */
626 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
627 FIB_PROTOCOL_IP4, udp4_output_node.index);
628 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
629 FIB_PROTOCOL_IP6, udp6_output_node.index);
632 * Initialize data structures
635 num_threads = 1 /* main thread */ + tm->n_threads;
636 vec_validate (um->wrk, num_threads - 1);
638 um->local_to_input_edge[UDP_IP4] =
639 vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
640 um->local_to_input_edge[UDP_IP6] =
641 vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
643 um->default_mtu = 1500;
644 um->csum_offload = 1;
649 VLIB_INIT_FUNCTION (udp_init) =
651 .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
657 * fd.io coding-style-patch-verification: ON
660 * eval: (c-set-style "gnu")