7147fa32657262eb0932c732d7beace9d0cfb5cd
[vpp.git] / src / vnet / udp / udp.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
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>
22
23 udp_main_t udp_main;
24
25 static void
26 udp_connection_register_port (u16 lcl_port, u8 is_ip4)
27 {
28   udp_main_t *um = &udp_main;
29   u16 *n;
30
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 */
34
35   if (is_ip4)
36     n = sparse_vec_validate (um->next_by_dst_port4, lcl_port);
37   else
38     n = sparse_vec_validate (um->next_by_dst_port6, lcl_port);
39
40   n[0] = um->local_to_input_edge[is_ip4];
41
42   __atomic_add_fetch (&um->transport_ports_refcnt[is_ip4][lcl_port], 1,
43                       __ATOMIC_RELAXED);
44 }
45
46 static void
47 udp_connection_unregister_port (u16 lcl_port, u8 is_ip4)
48 {
49   udp_main_t *um = &udp_main;
50   u16 *n;
51
52   /* Needed because listeners are not tracked as local endpoints */
53   if (__atomic_sub_fetch (&um->transport_ports_refcnt[is_ip4][lcl_port], 1,
54                           __ATOMIC_RELAXED))
55     return;
56
57   if (is_ip4)
58     n = sparse_vec_validate (um->next_by_dst_port4, lcl_port);
59   else
60     n = sparse_vec_validate (um->next_by_dst_port6, lcl_port);
61
62   n[0] = UDP_NO_NODE_SET;
63 }
64
65 udp_connection_t *
66 udp_connection_alloc (u32 thread_index)
67 {
68   udp_worker_t *wrk = udp_worker_get (thread_index);
69   udp_connection_t *uc;
70
71   pool_get_aligned_safe (wrk->connections, uc, CLIB_CACHE_LINE_BYTES);
72
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;
77   return uc;
78 }
79
80 void
81 udp_connection_free (udp_connection_t * uc)
82 {
83   udp_worker_t *wrk = udp_worker_get (uc->c_thread_index);
84
85   clib_spinlock_free (&uc->rx_lock);
86   if (CLIB_DEBUG)
87     clib_memset (uc, 0xFA, sizeof (*uc));
88   pool_put (wrk->connections, uc);
89 }
90
91 static void
92 udp_connection_cleanup (udp_connection_t * uc)
93 {
94   /* Unregister port from udp_local only if refcount went to zero */
95   if (!transport_release_local_endpoint (TRANSPORT_PROTO_UDP, &uc->c_lcl_ip,
96                                          uc->c_lcl_port))
97     udp_connection_unregister_port (uc->c_lcl_port, uc->c_is_ip4);
98   udp_connection_free (uc);
99 }
100
101 void
102 udp_connection_delete (udp_connection_t * uc)
103 {
104   session_transport_delete_notify (&uc->connection);
105   udp_connection_cleanup (uc);
106 }
107
108 static void
109 udp_handle_cleanups (void *args)
110 {
111   u32 thread_index = (u32) pointer_to_uword (args);
112   udp_connection_t *uc;
113   udp_worker_t *wrk;
114   u32 *uc_index;
115
116   wrk = udp_worker_get (thread_index);
117   vec_foreach (uc_index, wrk->pending_cleanups)
118     {
119       uc = udp_connection_get (*uc_index, thread_index);
120       udp_connection_delete (uc);
121     }
122   vec_reset_length (wrk->pending_cleanups);
123 }
124
125 static void
126 udp_connection_program_cleanup (udp_connection_t *uc)
127 {
128   uword thread_index = uc->c_thread_index;
129   udp_worker_t *wrk;
130
131   wrk = udp_worker_get (uc->c_thread_index);
132   vec_add1 (wrk->pending_cleanups, uc->c_c_index);
133
134   if (vec_len (wrk->pending_cleanups) == 1)
135     session_send_rpc_evt_to_thread_force (
136       thread_index, udp_handle_cleanups,
137       uword_to_pointer (thread_index, void *));
138 }
139
140 static u8
141 udp_connection_port_used_extern (u16 lcl_port, u8 is_ip4)
142 {
143   udp_main_t *um = vnet_get_udp_main ();
144   udp_dst_port_info_t *pi;
145
146   pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
147   return (pi && udp_is_valid_dst_port (lcl_port, is_ip4));
148 }
149
150 static u16
151 udp_default_mtu (udp_main_t * um, u8 is_ip4)
152 {
153   u16 ip_hlen = is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
154   return (um->default_mtu - sizeof (udp_header_t) - ip_hlen);
155 }
156
157 static u32
158 udp_session_bind (u32 session_index, transport_endpoint_cfg_t *lcl)
159 {
160   udp_main_t *um = vnet_get_udp_main ();
161   transport_endpoint_cfg_t *lcl_ext;
162   udp_connection_t *listener;
163   void *iface_ip;
164
165   if (udp_connection_port_used_extern (clib_net_to_host_u16 (lcl->port),
166                                        lcl->is_ip4))
167     {
168       clib_warning ("port already used");
169       return SESSION_E_PORTINUSE;
170     }
171
172   pool_get (um->listener_pool, listener);
173   clib_memset (listener, 0, sizeof (udp_connection_t));
174
175   listener->c_lcl_port = lcl->port;
176   listener->c_c_index = listener - um->listener_pool;
177
178   /* If we are provided a sw_if_index, bind using one of its ips */
179   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
180     {
181       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
182                                                  lcl->is_ip4)))
183         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
184     }
185   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
186   listener->c_is_ip4 = lcl->is_ip4;
187   listener->c_proto = TRANSPORT_PROTO_UDP;
188   listener->c_s_index = session_index;
189   listener->c_fib_index = lcl->fib_index;
190   listener->mss =
191     lcl->mss ? lcl->mss : udp_default_mtu (um, listener->c_is_ip4);
192   listener->flags |= UDP_CONN_F_OWNS_PORT | UDP_CONN_F_LISTEN;
193   lcl_ext = (transport_endpoint_cfg_t *) lcl;
194   if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
195     listener->flags |= UDP_CONN_F_CONNECTED;
196   else
197     listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
198   clib_spinlock_init (&listener->rx_lock);
199   if (!um->csum_offload)
200     listener->cfg_flags |= UDP_CFG_F_NO_CSUM_OFFLOAD;
201
202   udp_connection_register_port (listener->c_lcl_port, lcl->is_ip4);
203   return listener->c_c_index;
204 }
205
206 static u32
207 udp_session_unbind (u32 listener_index)
208 {
209   udp_main_t *um = &udp_main;
210   udp_connection_t *listener;
211
212   listener = udp_listener_get (listener_index);
213   udp_connection_unregister_port (listener->c_lcl_port, listener->c_is_ip4);
214   clib_spinlock_free (&listener->rx_lock);
215   pool_put (um->listener_pool, listener);
216   return 0;
217 }
218
219 static transport_connection_t *
220 udp_session_get_listener (u32 listener_index)
221 {
222   udp_connection_t *us;
223
224   us = udp_listener_get (listener_index);
225   return &us->connection;
226 }
227
228 always_inline u32
229 udp_push_one_header (vlib_main_t *vm, udp_connection_t *uc, vlib_buffer_t *b)
230 {
231   vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port,
232                         udp_csum_offload (uc));
233   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
234
235   /* Handle ip header now as session layer overwrite connection details for
236    * non-connected udp. */
237   if (uc->c_is_ip4)
238     vlib_buffer_push_ip4_custom (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
239                                  IP_PROTOCOL_UDP, udp_csum_offload (uc),
240                                  0 /* is_df */, uc->c_dscp);
241   else
242     vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
243                           IP_PROTOCOL_UDP);
244
245   /* reuse tcp medatada for now */
246   vnet_buffer (b)->tcp.connection_index = uc->c_c_index;
247
248   /* Not connected udp session. Mark buffer for custom handling in
249    * udp_output */
250   if (PREDICT_FALSE (!(uc->flags & UDP_CONN_F_CONNECTED)))
251     vnet_buffer (b)->tcp.flags |= UDP_CONN_F_LISTEN;
252   else
253     vnet_buffer (b)->tcp.flags = 0;
254
255   return 0;
256 }
257
258 static u32
259 udp_push_header (transport_connection_t *tc, vlib_buffer_t **bs, u32 n_bufs)
260 {
261   vlib_main_t *vm = vlib_get_main ();
262   udp_connection_t *uc;
263
264   uc = udp_connection_from_transport (tc);
265
266   while (n_bufs >= 4)
267     {
268       vlib_prefetch_buffer_header (bs[2], STORE);
269       vlib_prefetch_buffer_header (bs[3], STORE);
270
271       udp_push_one_header (vm, uc, bs[0]);
272       udp_push_one_header (vm, uc, bs[1]);
273
274       n_bufs -= 2;
275       bs += 2;
276     }
277   while (n_bufs)
278     {
279       if (n_bufs > 1)
280         vlib_prefetch_buffer_header (bs[1], STORE);
281
282       udp_push_one_header (vm, uc, bs[0]);
283
284       n_bufs -= 1;
285       bs += 1;
286     }
287
288   if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
289     {
290       if (!transport_max_tx_dequeue (&uc->connection))
291         udp_connection_program_cleanup (uc);
292     }
293
294   return 0;
295 }
296
297 static transport_connection_t *
298 udp_session_get (u32 connection_index, u32 thread_index)
299 {
300   udp_connection_t *uc;
301   uc = udp_connection_get (connection_index, thread_index);
302   if (uc)
303     return &uc->connection;
304   return 0;
305 }
306
307 static void
308 udp_session_close (u32 connection_index, u32 thread_index)
309 {
310   udp_connection_t *uc;
311
312   uc = udp_connection_get (connection_index, thread_index);
313   if (!uc || (uc->flags & UDP_CONN_F_MIGRATED))
314     return;
315
316   if (!transport_max_tx_dequeue (&uc->connection))
317     udp_connection_program_cleanup (uc);
318   else
319     uc->flags |= UDP_CONN_F_CLOSING;
320 }
321
322 static void
323 udp_session_cleanup (u32 connection_index, u32 thread_index)
324 {
325   udp_connection_t *uc;
326   uc = udp_connection_get (connection_index, thread_index);
327   if (!uc)
328     return;
329   if (uc->flags & UDP_CONN_F_MIGRATED)
330     udp_connection_free (uc);
331   else
332     udp_connection_cleanup (uc);
333 }
334
335 static int
336 udp_session_send_params (transport_connection_t * tconn,
337                          transport_send_params_t * sp)
338 {
339   udp_connection_t *uc;
340
341   uc = udp_connection_from_transport (tconn);
342
343   /* No constraint on TX window */
344   sp->snd_space = ~0;
345   /* TODO figure out MTU of output interface */
346   sp->snd_mss = uc->mss;
347   sp->tx_offset = 0;
348   sp->flags = 0;
349   return 0;
350 }
351
352 static int
353 udp_open_connection (transport_endpoint_cfg_t * rmt)
354 {
355   udp_main_t *um = &udp_main;
356   ip46_address_t lcl_addr;
357   udp_connection_t *uc;
358   u32 thread_index;
359   u16 lcl_port;
360   int rv;
361
362   rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
363                                        &lcl_port);
364   if (rv)
365     return rv;
366
367   if (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
368     {
369       /* If specific source port was requested abort */
370       if (rmt->peer.port)
371         {
372           transport_release_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
373                                             lcl_port);
374           return SESSION_E_PORTINUSE;
375         }
376
377       /* Try to find a port that's not used */
378       while (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
379         {
380           transport_release_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
381                                             lcl_port);
382           lcl_port =
383             transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr, rmt);
384           if (lcl_port < 1)
385             return SESSION_E_PORTINUSE;
386         }
387     }
388
389   /* We don't poll main thread if we have workers */
390   thread_index = transport_cl_thread ();
391
392   uc = udp_connection_alloc (thread_index);
393   ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
394   ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
395   uc->c_rmt_port = rmt->port;
396   uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
397   uc->c_is_ip4 = rmt->is_ip4;
398   uc->c_proto = TRANSPORT_PROTO_UDP;
399   uc->c_fib_index = rmt->fib_index;
400   uc->c_dscp = rmt->dscp;
401   uc->mss = rmt->mss ? rmt->mss : udp_default_mtu (um, uc->c_is_ip4);
402   if (rmt->peer.sw_if_index != ENDPOINT_INVALID_INDEX)
403     uc->sw_if_index = rmt->peer.sw_if_index;
404   uc->flags |= UDP_CONN_F_OWNS_PORT;
405   if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
406     {
407       uc->flags |= UDP_CONN_F_CONNECTED;
408     }
409   else
410     {
411       clib_spinlock_init (&uc->rx_lock);
412       uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
413     }
414   if (!um->csum_offload)
415     uc->cfg_flags |= UDP_CFG_F_NO_CSUM_OFFLOAD;
416   uc->next_node_index = rmt->next_node_index;
417   uc->next_node_opaque = rmt->next_node_opaque;
418
419   udp_connection_register_port (uc->c_lcl_port, rmt->is_ip4);
420
421   return uc->c_c_index;
422 }
423
424 static transport_connection_t *
425 udp_session_get_half_open (u32 conn_index)
426 {
427   udp_connection_t *uc;
428   u32 thread_index;
429
430   /* We don't poll main thread if we have workers */
431   thread_index = transport_cl_thread ();
432   uc = udp_connection_get (conn_index, thread_index);
433   if (!uc)
434     return 0;
435   return &uc->connection;
436 }
437
438 static u8 *
439 format_udp_session (u8 * s, va_list * args)
440 {
441   u32 uci = va_arg (*args, u32);
442   u32 thread_index = va_arg (*args, u32);
443   u32 verbose = va_arg (*args, u32);
444   udp_connection_t *uc;
445
446   uc = udp_connection_get (uci, thread_index);
447   return format (s, "%U", format_udp_connection, uc, verbose);
448 }
449
450 static u8 *
451 format_udp_half_open_session (u8 * s, va_list * args)
452 {
453   u32 __clib_unused tci = va_arg (*args, u32);
454   u32 __clib_unused thread_index = va_arg (*args, u32);
455   clib_warning ("BUG");
456   return 0;
457 }
458
459 static u8 *
460 format_udp_listener_session (u8 * s, va_list * args)
461 {
462   u32 tci = va_arg (*args, u32);
463   u32 __clib_unused thread_index = va_arg (*args, u32);
464   u32 verbose = va_arg (*args, u32);
465   udp_connection_t *uc = udp_listener_get (tci);
466   return format (s, "%U", format_udp_connection, uc, verbose);
467 }
468
469 static void
470 udp_realloc_ports_sv (u16 **ports_nh_svp)
471 {
472   u16 port, port_no, *ports_nh_sv, *mc;
473   u32 *ports = 0, *nh = 0, msum, i;
474   sparse_vec_header_t *h;
475   uword sv_index, *mb;
476
477   ports_nh_sv = *ports_nh_svp;
478
479   for (port = 1; port < 65535; port++)
480     {
481       port_no = clib_host_to_net_u16 (port);
482
483       sv_index = sparse_vec_index (ports_nh_sv, port_no);
484       if (sv_index != SPARSE_VEC_INVALID_INDEX)
485         {
486           vec_add1 (ports, port_no);
487           vec_add1 (nh, ports_nh_sv[sv_index]);
488         }
489     }
490
491   sparse_vec_free (ports_nh_sv);
492
493   ports_nh_sv =
494     sparse_vec_new (/* elt bytes */ sizeof (ports_nh_sv[0]),
495                     /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
496
497   vec_resize (ports_nh_sv, 65535);
498
499   for (port = 1; port < 65535; port++)
500     ports_nh_sv[port] = UDP_NO_NODE_SET;
501
502   for (i = 0; i < vec_len (ports); i++)
503     ports_nh_sv[ports[i]] = nh[i];
504
505   h = sparse_vec_header (ports_nh_sv);
506   vec_foreach (mb, h->is_member_bitmap)
507     *mb = (uword) ~0;
508
509   msum = 0;
510   vec_foreach (mc, h->member_counts)
511     {
512       *mc = msum;
513       msum += msum == 0 ? 63 : 64;
514     }
515
516   vec_free (ports);
517   vec_free (nh);
518
519   *ports_nh_svp = ports_nh_sv;
520 }
521
522 static clib_error_t *
523 udp_enable_disable (vlib_main_t *vm, u8 is_en)
524 {
525   udp_main_t *um = &udp_main;
526
527   /* Not ideal. The sparse vector used to map ports to next nodes assumes
528    * only a few ports are ever used. When udp transport is enabled this does
529    * not hold and, to make matters worse, ports are consumed in a random
530    * order.
531    *
532    * This can lead to a lot of slow updates to internal data structures
533    * which in turn can slow udp connection allocations until all ports are
534    * eventually consumed.
535    *
536    * Consequently, reallocate sparse vector, preallocate all ports and have
537    * them point to UDP_NO_NODE_SET. We could consider switching the sparse
538    * vector to a preallocated vector but that would increase memory
539    * consumption for vpp deployments that do not rely on host stack.
540    */
541
542   udp_realloc_ports_sv (&um->next_by_dst_port4);
543   udp_realloc_ports_sv (&um->next_by_dst_port6);
544
545   vec_validate (um->transport_ports_refcnt[0], 65535);
546   vec_validate (um->transport_ports_refcnt[1], 65535);
547
548   return 0;
549 }
550
551 static const transport_proto_vft_t udp_proto = {
552   .enable = udp_enable_disable,
553   .start_listen = udp_session_bind,
554   .connect = udp_open_connection,
555   .stop_listen = udp_session_unbind,
556   .push_header = udp_push_header,
557   .get_connection = udp_session_get,
558   .get_listener = udp_session_get_listener,
559   .get_half_open = udp_session_get_half_open,
560   .close = udp_session_close,
561   .cleanup = udp_session_cleanup,
562   .send_params = udp_session_send_params,
563   .format_connection = format_udp_session,
564   .format_half_open = format_udp_half_open_session,
565   .format_listener = format_udp_listener_session,
566   .transport_options = {
567     .name = "udp",
568     .short_name = "U",
569     .tx_type = TRANSPORT_TX_DGRAM,
570     .service_type = TRANSPORT_SERVICE_CL,
571   },
572 };
573
574 static clib_error_t *
575 udp_init (vlib_main_t * vm)
576 {
577   udp_main_t *um = vnet_get_udp_main ();
578   ip_main_t *im = &ip_main;
579   vlib_thread_main_t *tm = vlib_get_thread_main ();
580   u32 num_threads;
581   ip_protocol_info_t *pi;
582
583   /*
584    * Registrations
585    */
586
587   /* IP registration */
588   pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
589   if (pi == 0)
590     return clib_error_return (0, "UDP protocol info AWOL");
591   pi->format_header = format_udp_header;
592   pi->unformat_pg_edit = unformat_pg_udp_header;
593
594   /* Register as transport with session layer */
595   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
596                                FIB_PROTOCOL_IP4, udp4_output_node.index);
597   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
598                                FIB_PROTOCOL_IP6, udp6_output_node.index);
599
600   /*
601    * Initialize data structures
602    */
603
604   num_threads = 1 /* main thread */  + tm->n_threads;
605   vec_validate (um->wrk, num_threads - 1);
606
607   um->local_to_input_edge[UDP_IP4] =
608     vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
609   um->local_to_input_edge[UDP_IP6] =
610     vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
611
612   um->default_mtu = 1500;
613   um->csum_offload = 1;
614   return 0;
615 }
616
617 /* *INDENT-OFF* */
618 VLIB_INIT_FUNCTION (udp_init) =
619 {
620   .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
621                            "ip6_lookup_init"),
622 };
623 /* *INDENT-ON* */
624
625 /*
626  * fd.io coding-style-patch-verification: ON
627  *
628  * Local Variables:
629  * eval: (c-set-style "gnu")
630  * End:
631  */