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 pool_put (udp_main.connections[uc->c_thread_index], uc);
63 clib_memset (uc, 0xFA, sizeof (*uc));
67 udp_session_bind (u32 session_index, transport_endpoint_t * lcl)
69 udp_main_t *um = vnet_get_udp_main ();
70 vlib_main_t *vm = vlib_get_main ();
71 udp_connection_t *listener;
74 udp_dst_port_info_t *pi;
76 pi = udp_get_dst_port_info (um, lcl->port, lcl->is_ip4);
80 pool_get (um->listener_pool, listener);
81 clib_memset (listener, 0, sizeof (udp_connection_t));
83 listener->c_lcl_port = lcl->port;
84 listener->c_c_index = listener - um->listener_pool;
86 /* If we are provided a sw_if_index, bind using one of its ips */
87 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
89 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
91 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
93 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
94 listener->c_is_ip4 = lcl->is_ip4;
95 listener->c_proto = TRANSPORT_PROTO_UDP;
96 listener->c_s_index = session_index;
97 listener->c_fib_index = lcl->fib_index;
98 clib_spinlock_init (&listener->rx_lock);
100 node_index = lcl->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
101 udp_register_dst_port (vm, clib_net_to_host_u16 (lcl->port), node_index,
103 return listener->c_c_index;
107 udp_session_unbind (u32 listener_index)
109 vlib_main_t *vm = vlib_get_main ();
111 udp_connection_t *listener;
112 listener = udp_listener_get (listener_index);
113 udp_unregister_dst_port (vm, clib_net_to_host_u16 (listener->c_lcl_port),
118 transport_connection_t *
119 udp_session_get_listener (u32 listener_index)
121 udp_connection_t *us;
123 us = udp_listener_get (listener_index);
124 return &us->connection;
128 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
130 udp_connection_t *uc;
131 vlib_main_t *vm = vlib_get_main ();
133 uc = udp_get_connection_from_transport (tc);
135 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
137 vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
142 ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
144 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
146 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
147 vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
148 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
153 transport_connection_t *
154 udp_session_get (u32 connection_index, u32 thread_index)
156 udp_connection_t *uc;
157 uc = udp_connection_get (connection_index, thread_index);
159 return &uc->connection;
164 udp_session_close (u32 connection_index, u32 thread_index)
166 vlib_main_t *vm = vlib_get_main ();
167 udp_connection_t *uc;
168 uc = udp_connection_get (connection_index, thread_index);
171 udp_unregister_dst_port (vm, clib_net_to_host_u16 (uc->c_lcl_port),
173 session_transport_delete_notify (&uc->connection);
174 udp_connection_free (uc);
179 udp_session_cleanup (u32 connection_index, u32 thread_index)
181 udp_connection_t *uc;
182 uc = udp_connection_get (connection_index, thread_index);
184 udp_connection_free (uc);
188 format_udp_connection_id (u8 * s, va_list * args)
190 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
194 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
195 format_ip4_address, &uc->c_lcl_ip4,
196 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
197 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
199 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
200 format_ip6_address, &uc->c_lcl_ip6,
201 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
202 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
207 format_udp_connection (u8 * s, va_list * args)
209 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
210 u32 verbose = va_arg (*args, u32);
213 s = format (s, "%-50U", format_udp_connection_id, uc);
217 s = format (s, "%-15s\n", "-");
219 s = format (s, "\n");
225 format_udp_session (u8 * s, va_list * args)
227 u32 uci = va_arg (*args, u32);
228 u32 thread_index = va_arg (*args, u32);
229 u32 verbose = va_arg (*args, u32);
230 udp_connection_t *uc;
232 uc = udp_connection_get (uci, thread_index);
233 return format (s, "%U", format_udp_connection, uc, verbose);
237 format_udp_half_open_session (u8 * s, va_list * args)
239 clib_warning ("BUG");
244 format_udp_listener_session (u8 * s, va_list * args)
246 u32 tci = va_arg (*args, u32);
247 udp_connection_t *uc = udp_listener_get (tci);
248 return format (s, "%U", format_udp_connection, uc);
252 udp_send_mss (transport_connection_t * t)
254 /* TODO figure out MTU of output interface */
259 udp_send_space (transport_connection_t * t)
261 /* No constraint on TX window */
266 udp_open_connection (transport_endpoint_cfg_t * rmt)
268 udp_main_t *um = vnet_get_udp_main ();
269 vlib_main_t *vm = vlib_get_main ();
270 u32 thread_index = vm->thread_index;
271 udp_connection_t *uc;
272 ip46_address_t lcl_addr;
276 if (transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
280 while (udp_get_dst_port_info (um, lcl_port, rmt->is_ip4))
282 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr);
285 clib_warning ("Failed to allocate src port");
290 node_index = rmt->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
291 udp_register_dst_port (vm, lcl_port, node_index, 1 /* is_ipv4 */ );
293 /* We don't poll main thread if we have workers */
294 if (vlib_num_workers ())
297 uc = udp_connection_alloc (thread_index);
298 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
299 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
300 uc->c_rmt_port = rmt->port;
301 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
302 uc->c_is_ip4 = rmt->is_ip4;
303 uc->c_proto = TRANSPORT_PROTO_UDP;
304 uc->c_fib_index = rmt->fib_index;
306 return uc->c_c_index;
309 transport_connection_t *
310 udp_session_get_half_open (u32 conn_index)
312 udp_connection_t *uc;
315 /* We don't poll main thread if we have workers */
316 thread_index = vlib_num_workers ()? 1 : 0;
317 uc = udp_connection_get (conn_index, thread_index);
318 return &uc->connection;
322 const static transport_proto_vft_t udp_proto = {
323 .start_listen = udp_session_bind,
324 .connect = udp_open_connection,
325 .stop_listen = udp_session_unbind,
326 .push_header = udp_push_header,
327 .get_connection = udp_session_get,
328 .get_listener = udp_session_get_listener,
329 .get_half_open = udp_session_get_half_open,
330 .close = udp_session_close,
331 .cleanup = udp_session_cleanup,
332 .send_mss = udp_send_mss,
333 .send_space = udp_send_space,
334 .format_connection = format_udp_session,
335 .format_half_open = format_udp_half_open_session,
336 .format_listener = format_udp_listener_session,
337 .tx_type = TRANSPORT_TX_DGRAM,
338 .service_type = TRANSPORT_SERVICE_CL,
344 udpc_connection_open (transport_endpoint_cfg_t * rmt)
346 udp_connection_t *uc;
348 uc_index = udp_open_connection (rmt);
349 uc = udp_connection_get (uc_index, vlib_get_thread_index ());
350 uc->is_connected = 1;
355 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
357 udp_connection_t *listener;
359 li = udp_session_bind (session_index, lcl);
360 listener = udp_listener_get (li);
361 listener->is_connected = 1;
366 const static transport_proto_vft_t udpc_proto = {
367 .start_listen = udpc_connection_listen,
368 .stop_listen = udp_session_unbind,
369 .connect = udpc_connection_open,
370 .push_header = udp_push_header,
371 .get_connection = udp_session_get,
372 .get_listener = udp_session_get_listener,
373 .get_half_open = udp_session_get_half_open,
374 .close = udp_session_close,
375 .cleanup = udp_session_cleanup,
376 .send_mss = udp_send_mss,
377 .send_space = udp_send_space,
378 .format_connection = format_udp_session,
379 .format_half_open = format_udp_half_open_session,
380 .format_listener = format_udp_listener_session,
381 .tx_type = TRANSPORT_TX_DEQUEUE,
382 .service_type = TRANSPORT_SERVICE_CL,
386 static clib_error_t *
387 udp_init (vlib_main_t * vm)
389 udp_main_t *um = vnet_get_udp_main ();
390 ip_main_t *im = &ip_main;
391 vlib_thread_main_t *tm = vlib_get_thread_main ();
393 clib_error_t *error = 0;
394 ip_protocol_info_t *pi;
397 if ((error = vlib_call_init_function (vm, ip_main_init)))
399 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
401 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
408 /* IP registration */
409 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
411 return clib_error_return (0, "UDP protocol info AWOL");
412 pi->format_header = format_udp_header;
413 pi->unformat_pg_edit = unformat_pg_udp_header;
415 /* Register as transport with URI */
416 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
417 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
418 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
419 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
420 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
421 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
422 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
423 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
426 * Initialize data structures
429 num_threads = 1 /* main thread */ + tm->n_threads;
430 vec_validate (um->connections, num_threads - 1);
431 vec_validate (um->connection_peekers, num_threads - 1);
432 vec_validate (um->peekers_readers_locks, num_threads - 1);
433 vec_validate (um->peekers_write_locks, num_threads - 1);
436 for (i = 0; i < num_threads; i++)
438 clib_spinlock_init (&um->peekers_readers_locks[i]);
439 clib_spinlock_init (&um->peekers_write_locks[i]);
444 VLIB_INIT_FUNCTION (udp_init);
446 static clib_error_t *
447 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
448 vlib_cli_command_t * cmd_arg)
450 udp_main_t *um = vnet_get_udp_main ();
452 clib_error_t *error = NULL;
454 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
455 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
458 udp_dst_port_info_t *port_info;
459 if (um->punt_unknown4)
461 vlib_cli_output (vm, "IPv4 UDP punt: enabled");
466 vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
468 if (udp_is_valid_dst_port (port_info->dst_port, 1))
470 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
473 s = format (s, "%c", 0);
474 vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
477 if (um->punt_unknown6)
479 vlib_cli_output (vm, "IPv6 UDP punt: enabled");
484 vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
486 if (udp_is_valid_dst_port (port_info->dst_port, 01))
488 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
491 s = format (s, "%c", 0);
492 vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
498 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
500 .path = "show udp punt",
501 .short_help = "show udp punt [ipv4|ipv6]",
502 .function = show_udp_punt_fn,
507 * fd.io coding-style-patch-verification: ON
510 * eval: (c-set-style "gnu")