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