2 * Copyright (c) 2016 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>
26 udp_connection_alloc (u32 thread_index)
28 udp_main_t *um = &udp_main;
31 pool_get_aligned_will_expand (um->connections[thread_index], will_expand,
32 CLIB_CACHE_LINE_BYTES);
34 if (PREDICT_FALSE (will_expand))
36 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks
38 pool_get_aligned (udp_main.connections[thread_index], uc,
39 CLIB_CACHE_LINE_BYTES);
40 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
45 pool_get_aligned (um->connections[thread_index], uc,
46 CLIB_CACHE_LINE_BYTES);
48 clib_memset (uc, 0, sizeof (*uc));
49 uc->c_c_index = uc - um->connections[thread_index];
50 uc->c_thread_index = thread_index;
51 uc->c_proto = TRANSPORT_PROTO_UDP;
52 clib_spinlock_init (&uc->rx_lock);
57 udp_connection_free (udp_connection_t * uc)
59 pool_put (udp_main.connections[uc->c_thread_index], uc);
61 clib_memset (uc, 0xFA, sizeof (*uc));
65 udp_session_bind (u32 session_index, transport_endpoint_t * lcl)
67 udp_main_t *um = vnet_get_udp_main ();
68 vlib_main_t *vm = vlib_get_main ();
69 udp_connection_t *listener;
72 udp_dst_port_info_t *pi;
74 pi = udp_get_dst_port_info (um, lcl->port, lcl->is_ip4);
78 pool_get (um->listener_pool, listener);
79 clib_memset (listener, 0, sizeof (udp_connection_t));
81 listener->c_lcl_port = lcl->port;
82 listener->c_c_index = listener - um->listener_pool;
84 /* If we are provided a sw_if_index, bind using one of its ips */
85 if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
87 if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
89 ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
91 ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
92 listener->c_is_ip4 = lcl->is_ip4;
93 listener->c_proto = TRANSPORT_PROTO_UDP;
94 listener->c_s_index = session_index;
95 listener->c_fib_index = lcl->fib_index;
96 clib_spinlock_init (&listener->rx_lock);
98 node_index = lcl->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
99 udp_register_dst_port (vm, clib_net_to_host_u16 (lcl->port), node_index,
101 return listener->c_c_index;
105 udp_session_unbind (u32 listener_index)
107 vlib_main_t *vm = vlib_get_main ();
109 udp_connection_t *listener;
110 listener = udp_listener_get (listener_index);
111 udp_unregister_dst_port (vm, clib_net_to_host_u16 (listener->c_lcl_port),
116 transport_connection_t *
117 udp_session_get_listener (u32 listener_index)
119 udp_connection_t *us;
121 us = udp_listener_get (listener_index);
122 return &us->connection;
126 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
128 udp_connection_t *uc;
129 vlib_main_t *vm = vlib_get_main ();
131 uc = udp_get_connection_from_transport (tc);
133 vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
135 vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
140 ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
142 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
144 vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
145 vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
146 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
151 transport_connection_t *
152 udp_session_get (u32 connection_index, u32 thread_index)
154 udp_connection_t *uc;
155 uc = udp_connection_get (connection_index, thread_index);
157 return &uc->connection;
162 udp_session_close (u32 connection_index, u32 thread_index)
164 vlib_main_t *vm = vlib_get_main ();
165 udp_connection_t *uc;
166 uc = udp_connection_get (connection_index, thread_index);
169 udp_unregister_dst_port (vm, clib_net_to_host_u16 (uc->c_lcl_port),
171 session_transport_delete_notify (&uc->connection);
172 udp_connection_free (uc);
177 udp_session_cleanup (u32 connection_index, u32 thread_index)
179 udp_connection_t *uc;
180 uc = udp_connection_get (connection_index, thread_index);
182 udp_connection_free (uc);
186 format_udp_connection_id (u8 * s, va_list * args)
188 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
192 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
193 format_ip4_address, &uc->c_lcl_ip4,
194 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
195 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
197 s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
198 format_ip6_address, &uc->c_lcl_ip6,
199 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
200 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
205 format_udp_connection (u8 * s, va_list * args)
207 udp_connection_t *uc = va_arg (*args, udp_connection_t *);
208 u32 verbose = va_arg (*args, u32);
211 s = format (s, "%-50U", format_udp_connection_id, uc);
215 s = format (s, "%-15s\n", "-");
217 s = format (s, "\n");
223 format_udp_session (u8 * s, va_list * args)
225 u32 uci = va_arg (*args, u32);
226 u32 thread_index = va_arg (*args, u32);
227 u32 verbose = va_arg (*args, u32);
228 udp_connection_t *uc;
230 uc = udp_connection_get (uci, thread_index);
231 return format (s, "%U", format_udp_connection, uc, verbose);
235 format_udp_half_open_session (u8 * s, va_list * args)
237 clib_warning ("BUG");
242 format_udp_listener_session (u8 * s, va_list * args)
244 u32 tci = va_arg (*args, u32);
245 udp_connection_t *uc = udp_listener_get (tci);
246 return format (s, "%U", format_udp_connection, uc);
250 udp_send_mss (transport_connection_t * t)
252 /* TODO figure out MTU of output interface */
257 udp_send_space (transport_connection_t * t)
259 /* No constraint on TX window */
264 udp_open_connection (transport_endpoint_cfg_t * rmt)
266 udp_main_t *um = vnet_get_udp_main ();
267 vlib_main_t *vm = vlib_get_main ();
268 u32 thread_index = vm->thread_index;
269 udp_connection_t *uc;
270 ip46_address_t lcl_addr;
274 if (transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
278 while (udp_get_dst_port_info (um, lcl_port, rmt->is_ip4))
280 lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr);
283 clib_warning ("Failed to allocate src port");
288 node_index = rmt->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
289 udp_register_dst_port (vm, lcl_port, node_index, 1 /* is_ipv4 */ );
291 /* We don't poll main thread if we have workers */
292 if (vlib_num_workers ())
295 uc = udp_connection_alloc (thread_index);
296 ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
297 ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
298 uc->c_rmt_port = rmt->port;
299 uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
300 uc->c_is_ip4 = rmt->is_ip4;
301 uc->c_proto = TRANSPORT_PROTO_UDP;
302 uc->c_fib_index = rmt->fib_index;
304 return uc->c_c_index;
307 transport_connection_t *
308 udp_session_get_half_open (u32 conn_index)
310 udp_connection_t *uc;
313 /* We don't poll main thread if we have workers */
314 thread_index = vlib_num_workers ()? 1 : 0;
315 uc = udp_connection_get (conn_index, thread_index);
316 return &uc->connection;
320 const static transport_proto_vft_t udp_proto = {
321 .start_listen = udp_session_bind,
322 .connect = udp_open_connection,
323 .stop_listen = udp_session_unbind,
324 .push_header = udp_push_header,
325 .get_connection = udp_session_get,
326 .get_listener = udp_session_get_listener,
327 .get_half_open = udp_session_get_half_open,
328 .close = udp_session_close,
329 .cleanup = udp_session_cleanup,
330 .send_mss = udp_send_mss,
331 .send_space = udp_send_space,
332 .format_connection = format_udp_session,
333 .format_half_open = format_udp_half_open_session,
334 .format_listener = format_udp_listener_session,
335 .tx_type = TRANSPORT_TX_DGRAM,
336 .service_type = TRANSPORT_SERVICE_CL,
342 udpc_connection_open (transport_endpoint_cfg_t * rmt)
344 udp_connection_t *uc;
346 uc_index = udp_open_connection (rmt);
347 uc = udp_connection_get (uc_index, vlib_get_thread_index ());
348 uc->is_connected = 1;
353 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
355 udp_connection_t *listener;
357 li = udp_session_bind (session_index, lcl);
358 listener = udp_listener_get (li);
359 listener->is_connected = 1;
364 const static transport_proto_vft_t udpc_proto = {
365 .start_listen = udpc_connection_listen,
366 .stop_listen = udp_session_unbind,
367 .connect = udpc_connection_open,
368 .push_header = udp_push_header,
369 .get_connection = udp_session_get,
370 .get_listener = udp_session_get_listener,
371 .get_half_open = udp_session_get_half_open,
372 .close = udp_session_close,
373 .cleanup = udp_session_cleanup,
374 .send_mss = udp_send_mss,
375 .send_space = udp_send_space,
376 .format_connection = format_udp_session,
377 .format_half_open = format_udp_half_open_session,
378 .format_listener = format_udp_listener_session,
379 .tx_type = TRANSPORT_TX_DEQUEUE,
380 .service_type = TRANSPORT_SERVICE_CL,
384 static clib_error_t *
385 udp_init (vlib_main_t * vm)
387 udp_main_t *um = vnet_get_udp_main ();
388 ip_main_t *im = &ip_main;
389 vlib_thread_main_t *tm = vlib_get_thread_main ();
391 clib_error_t *error = 0;
392 ip_protocol_info_t *pi;
395 if ((error = vlib_call_init_function (vm, ip_main_init)))
397 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
399 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
406 /* IP registration */
407 pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
409 return clib_error_return (0, "UDP protocol info AWOL");
410 pi->format_header = format_udp_header;
411 pi->unformat_pg_edit = unformat_pg_udp_header;
413 /* Register as transport with URI */
414 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
415 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
416 transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
417 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
418 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
419 FIB_PROTOCOL_IP4, ip4_lookup_node.index);
420 transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
421 FIB_PROTOCOL_IP6, ip6_lookup_node.index);
424 * Initialize data structures
427 num_threads = 1 /* main thread */ + tm->n_threads;
428 vec_validate (um->connections, num_threads - 1);
429 vec_validate (um->connection_peekers, num_threads - 1);
430 vec_validate (um->peekers_readers_locks, num_threads - 1);
431 vec_validate (um->peekers_write_locks, num_threads - 1);
434 for (i = 0; i < num_threads; i++)
436 clib_spinlock_init (&um->peekers_readers_locks[i]);
437 clib_spinlock_init (&um->peekers_write_locks[i]);
442 VLIB_INIT_FUNCTION (udp_init);
444 static clib_error_t *
445 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
446 vlib_cli_command_t * cmd_arg)
448 udp_main_t *um = vnet_get_udp_main ();
450 clib_error_t *error = NULL;
452 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
453 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
456 udp_dst_port_info_t *port_info;
457 if (um->punt_unknown4)
459 vlib_cli_output (vm, "IPv4 UDP punt: enabled");
464 vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
466 if (udp_is_valid_dst_port (port_info->dst_port, 1))
468 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
471 s = format (s, "%c", 0);
472 vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
475 if (um->punt_unknown6)
477 vlib_cli_output (vm, "IPv6 UDP punt: enabled");
482 vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
484 if (udp_is_valid_dst_port (port_info->dst_port, 01))
486 s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
489 s = format (s, "%c", 0);
490 vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
496 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
498 .path = "show udp punt",
499 .short_help = "show udp punt [ipv4|ipv6]",
500 .function = show_udp_punt_fn,
505 * fd.io coding-style-patch-verification: ON
508 * eval: (c-set-style "gnu")