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;
29 udp_dst_port_info_t *pi;
32 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
35 udp_add_dst_port (um, lcl_port, 0, is_ip4);
36 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
37 pi->n_connections = 1;
41 pi->n_connections += 1;
42 /* Do not return. The fact that the pi is valid does not mean
46 pi->node_index = is_ip4 ? udp4_input_node.index : udp6_input_node.index;
47 pi->next_index = um->local_to_input_edge[is_ip4];
49 /* Setup udp protocol -> next index sparse vector mapping. */
51 n = sparse_vec_validate (um->next_by_dst_port4,
52 clib_host_to_net_u16 (lcl_port));
54 n = sparse_vec_validate (um->next_by_dst_port6,
55 clib_host_to_net_u16 (lcl_port));
57 n[0] = pi->next_index;
61 udp_connection_unregister_port (u16 lcl_port, u8 is_ip4)
63 udp_main_t *um = &udp_main;
64 udp_dst_port_info_t *pi;
66 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
70 if (!pi->n_connections)
72 clib_warning ("no connections using port %u", lcl_port);
76 if (!clib_atomic_sub_fetch (&pi->n_connections, 1))
77 udp_unregister_dst_port (0, lcl_port, is_ip4);
81 udp_connection_share_port (u16 lcl_port, u8 is_ip4)
83 udp_main_t *um = &udp_main;
84 udp_dst_port_info_t *pi;
86 /* Done without a lock but the operation is atomic. Writers to pi hash
87 * table and vector should be guarded by a barrier sync */
88 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
89 clib_atomic_fetch_add_rel (&pi->n_connections, 1);
93 udp_connection_alloc (u32 thread_index)
95 udp_main_t *um = &udp_main;
98 pool_get_aligned_safe (um->connections[thread_index], uc,
99 CLIB_CACHE_LINE_BYTES);
101 clib_memset (uc, 0, sizeof (*uc));
102 uc->c_c_index = uc - um->connections[thread_index];
103 uc->c_thread_index = thread_index;
104 uc->c_proto = TRANSPORT_PROTO_UDP;
109 udp_connection_free (udp_connection_t * uc)
111 u32 thread_index = uc->c_thread_index;
112 clib_spinlock_free (&uc->rx_lock);
114 clib_memset (uc, 0xFA, sizeof (*uc));
115 pool_put (udp_main.connections[thread_index], uc);
119 udp_connection_cleanup (udp_connection_t * uc)
121 transport_endpoint_cleanup (TRANSPORT_PROTO_UDP, &uc->c_lcl_ip,
123 udp_connection_unregister_port (clib_net_to_host_u16 (uc->c_lcl_port),
125 udp_connection_free (uc);
129 udp_connection_delete (udp_connection_t * uc)
131 session_transport_delete_notify (&uc->connection);
132 udp_connection_cleanup (uc);
136 udp_handle_cleanups (void *args)
138 u32 thread_index = (u32) pointer_to_uword (args);
139 udp_connection_t *uc;
143 wrk = udp_worker_get (thread_index);
144 vec_foreach (uc_index, wrk->pending_cleanups)
146 uc = udp_connection_get (*uc_index, thread_index);
147 udp_connection_delete (uc);
149 vec_reset_length (wrk->pending_cleanups);
153 udp_connection_program_cleanup (udp_connection_t *uc)
155 uword thread_index = uc->c_thread_index;
158 wrk = udp_worker_get (uc->c_thread_index);
159 vec_add1 (wrk->pending_cleanups, uc->c_c_index);
161 if (vec_len (wrk->pending_cleanups) == 1)
162 session_send_rpc_evt_to_thread_force (
163 thread_index, udp_handle_cleanups,
164 uword_to_pointer (thread_index, void *));
168 udp_connection_port_used_extern (u16 lcl_port, u8 is_ip4)
170 udp_main_t *um = vnet_get_udp_main ();
171 udp_dst_port_info_t *pi;
173 pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
174 return (pi && !pi->n_connections
175 && udp_is_valid_dst_port (lcl_port, is_ip4));
179 udp_default_mtu (udp_main_t * um, u8 is_ip4)
181 u16 ip_hlen = is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
182 return (um->default_mtu - sizeof (udp_header_t) - ip_hlen);
186 udp_session_bind (u32 session_index, transport_endpoint_cfg_t *lcl)
188 udp_main_t *um = vnet_get_udp_main ();
189 transport_endpoint_cfg_t *lcl_ext;
190 udp_connection_t *listener;
194 lcl_port_ho = clib_net_to_host_u16 (lcl->port);
196 if (udp_connection_port_used_extern (lcl_port_ho, lcl->is_ip4))
198 clib_warning ("port already used");
199 return SESSION_E_PORTINUSE;
202 pool_get (um->listener_pool, listener);
203 clib_memset (listener, 0, sizeof (udp_connection_t));
205 listener->c_lcl_port = lcl->port;
206 listener->c_c_index = listener - um->listener_pool;
208 /* If we are provided a sw_if_index, bind using one of its ips */
209 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
211 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
213 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
215 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
216 listener->c_is_ip4 = lcl->is_ip4;
217 listener->c_proto = TRANSPORT_PROTO_UDP;
218 listener->c_s_index = session_index;
219 listener->c_fib_index = lcl->fib_index;
221 lcl->mss ? lcl->mss : udp_default_mtu (um, listener->c_is_ip4);
222 listener->flags |= UDP_CONN_F_OWNS_PORT | UDP_CONN_F_LISTEN;
223 lcl_ext = (transport_endpoint_cfg_t *) lcl;
224 if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
225 listener->flags |= UDP_CONN_F_CONNECTED;
227 listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
228 clib_spinlock_init (&listener->rx_lock);
229 if (!um->csum_offload)
230 listener->cfg_flags |= UDP_CFG_F_NO_CSUM_OFFLOAD;
232 udp_connection_register_port (lcl_port_ho, lcl->is_ip4);
233 return listener->c_c_index;
237 udp_session_unbind (u32 listener_index)
239 udp_main_t *um = &udp_main;
240 udp_connection_t *listener;
242 listener = udp_listener_get (listener_index);
243 udp_connection_unregister_port (clib_net_to_host_u16 (listener->c_lcl_port),
245 clib_spinlock_free (&listener->rx_lock);
246 pool_put (um->listener_pool, listener);
250 static transport_connection_t *
251 udp_session_get_listener (u32 listener_index)
253 udp_connection_t *us;
255 us = udp_listener_get (listener_index);
256 return &us->connection;
260 udp_push_one_header (vlib_main_t *vm, udp_connection_t *uc, vlib_buffer_t *b)
262 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port,
263 udp_csum_offload (uc));
264 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
265 /* reuse tcp medatada for now */
266 vnet_buffer (b)->tcp.connection_index = uc->c_c_index;
272 udp_push_header (transport_connection_t *tc, vlib_buffer_t **bs, u32 n_bufs)
274 vlib_main_t *vm = vlib_get_main ();
275 udp_connection_t *uc;
277 uc = udp_connection_from_transport (tc);
281 vlib_prefetch_buffer_header (bs[2], STORE);
282 vlib_prefetch_buffer_header (bs[3], STORE);
284 udp_push_one_header (vm, uc, bs[0]);
285 udp_push_one_header (vm, uc, bs[1]);
293 vlib_prefetch_buffer_header (bs[1], STORE);
295 udp_push_one_header (vm, uc, bs[0]);
301 if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
303 if (!transport_max_tx_dequeue (&uc->connection))
304 udp_connection_program_cleanup (uc);
310 static transport_connection_t *
311 udp_session_get (u32 connection_index, u32 thread_index)
313 udp_connection_t *uc;
314 uc = udp_connection_get (connection_index, thread_index);
316 return &uc->connection;
321 udp_session_close (u32 connection_index, u32 thread_index)
323 udp_connection_t *uc;
325 uc = udp_connection_get (connection_index, thread_index);
326 if (!uc || (uc->flags & UDP_CONN_F_MIGRATED))
329 if (!transport_max_tx_dequeue (&uc->connection))
330 udp_connection_program_cleanup (uc);
332 uc->flags |= UDP_CONN_F_CLOSING;
336 udp_session_cleanup (u32 connection_index, u32 thread_index)
338 udp_connection_t *uc;
339 uc = udp_connection_get (connection_index, thread_index);
342 if (uc->flags & UDP_CONN_F_MIGRATED)
343 udp_connection_free (uc);
345 udp_connection_cleanup (uc);
349 udp_session_send_params (transport_connection_t * tconn,
350 transport_send_params_t * sp)
352 udp_connection_t *uc;
354 uc = udp_connection_from_transport (tconn);
356 /* No constraint on TX window */
358 /* TODO figure out MTU of output interface */
359 sp->snd_mss = uc->mss;
366 udp_open_connection (transport_endpoint_cfg_t * rmt)
368 udp_main_t *um = &udp_main;
369 ip46_address_t lcl_addr;
370 udp_connection_t *uc;
375 rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
379 if (rv != SESSION_E_PORTINUSE)
382 if (udp_connection_port_used_extern (lcl_port, rmt->is_ip4))
383 return SESSION_E_PORTINUSE;
385 /* If port in use, check if 5-tuple is also in use */
386 if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
387 lcl_port, rmt->port, TRANSPORT_PROTO_UDP,
389 return SESSION_E_PORTINUSE;
391 /* 5-tuple is available so increase lcl endpoint refcount and proceed
392 * with connection allocation */
393 transport_share_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
398 if (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
400 /* If specific source port was requested abort */
402 return SESSION_E_PORTINUSE;
404 /* Try to find a port that's not used */
405 while (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
407 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP,
410 return SESSION_E_PORTINUSE;
416 udp_connection_register_port (lcl_port, rmt->is_ip4);
418 /* We don't poll main thread if we have workers */
419 thread_index = transport_cl_thread ();
421 uc = udp_connection_alloc (thread_index);
422 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
423 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
424 uc->c_rmt_port = rmt->port;
425 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
426 uc->c_is_ip4 = rmt->is_ip4;
427 uc->c_proto = TRANSPORT_PROTO_UDP;
428 uc->c_fib_index = rmt->fib_index;
429 uc->c_dscp = rmt->dscp;
430 uc->mss = rmt->mss ? rmt->mss : udp_default_mtu (um, uc->c_is_ip4);
431 if (rmt->peer.sw_if_index != ENDPOINT_INVALID_INDEX)
432 uc->sw_if_index = rmt->peer.sw_if_index;
433 uc->flags |= UDP_CONN_F_OWNS_PORT;
434 if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
436 uc->flags |= UDP_CONN_F_CONNECTED;
440 clib_spinlock_init (&uc->rx_lock);
441 uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
443 if (!um->csum_offload)
444 uc->cfg_flags |= UDP_CFG_F_NO_CSUM_OFFLOAD;
445 uc->next_node_index = rmt->next_node_index;
446 uc->next_node_opaque = rmt->next_node_opaque;
448 return uc->c_c_index;
451 static transport_connection_t *
452 udp_session_get_half_open (u32 conn_index)
454 udp_connection_t *uc;
457 /* We don't poll main thread if we have workers */
458 thread_index = transport_cl_thread ();
459 uc = udp_connection_get (conn_index, thread_index);
462 return &uc->connection;
466 format_udp_session (u8 * s, va_list * args)
468 u32 uci = va_arg (*args, u32);
469 u32 thread_index = va_arg (*args, u32);
470 u32 verbose = va_arg (*args, u32);
471 udp_connection_t *uc;
473 uc = udp_connection_get (uci, thread_index);
474 return format (s, "%U", format_udp_connection, uc, verbose);
478 format_udp_half_open_session (u8 * s, va_list * args)
480 u32 __clib_unused tci = va_arg (*args, u32);
481 u32 __clib_unused thread_index = va_arg (*args, u32);
482 clib_warning ("BUG");
487 format_udp_listener_session (u8 * s, va_list * args)
489 u32 tci = va_arg (*args, u32);
490 u32 __clib_unused thread_index = va_arg (*args, u32);
491 u32 verbose = va_arg (*args, u32);
492 udp_connection_t *uc = udp_listener_get (tci);
493 return format (s, "%U", format_udp_connection, uc, verbose);
497 static const transport_proto_vft_t udp_proto = {
498 .start_listen = udp_session_bind,
499 .connect = udp_open_connection,
500 .stop_listen = udp_session_unbind,
501 .push_header = udp_push_header,
502 .get_connection = udp_session_get,
503 .get_listener = udp_session_get_listener,
504 .get_half_open = udp_session_get_half_open,
505 .close = udp_session_close,
506 .cleanup = udp_session_cleanup,
507 .send_params = udp_session_send_params,
508 .format_connection = format_udp_session,
509 .format_half_open = format_udp_half_open_session,
510 .format_listener = format_udp_listener_session,
511 .transport_options = {
514 .tx_type = TRANSPORT_TX_DGRAM,
515 .service_type = TRANSPORT_SERVICE_CL,
520 static clib_error_t *
521 udp_init (vlib_main_t * vm)
523 udp_main_t *um = vnet_get_udp_main ();
524 ip_main_t *im = &ip_main;
525 vlib_thread_main_t *tm = vlib_get_thread_main ();
527 ip_protocol_info_t *pi;
533 /* IP registration */
534 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
536 return clib_error_return (0, "UDP protocol info AWOL");
537 pi->format_header = format_udp_header;
538 pi->unformat_pg_edit = unformat_pg_udp_header;
540 /* Register as transport with session layer */
541 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
542 FIB_PROTOCOL_IP4, udp4_output_node.index);
543 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
544 FIB_PROTOCOL_IP6, udp6_output_node.index);
547 * Initialize data structures
550 num_threads = 1 /* main thread */ + tm->n_threads;
551 vec_validate (um->connections, num_threads - 1);
552 vec_validate (um->wrk, num_threads - 1);
554 um->local_to_input_edge[UDP_IP4] =
555 vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
556 um->local_to_input_edge[UDP_IP6] =
557 vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
559 um->default_mtu = 1500;
560 um->csum_offload = 1;
565 VLIB_INIT_FUNCTION (udp_init) =
567 .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
573 * fd.io coding-style-patch-verification: ON
576 * eval: (c-set-style "gnu")