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   udp_dst_port_info_t *pi;
  30   u16 *n;
  31
  32   pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
  33   if (!pi)
  34     {
  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;
  38     }
  39   else
  40     {
  41       pi->n_connections += 1;
  42       /* Do not return. The fact that the pi is valid does not mean
  43        * it's up to date */
  44     }
  45
  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];
  48
  49   /* Setup udp protocol -> next index sparse vector mapping. */
  50   if (is_ip4)
  51     n = sparse_vec_validate (um->next_by_dst_port4,
  52                              clib_host_to_net_u16 (lcl_port));
  53   else
  54     n = sparse_vec_validate (um->next_by_dst_port6,
  55                              clib_host_to_net_u16 (lcl_port));
  56
  57   n[0] = pi->next_index;
  58 }
  59
  60 static void
  61 udp_connection_unregister_port (u16 lcl_port, u8 is_ip4)
  62 {
  63   udp_main_t *um = &udp_main;
  64   udp_dst_port_info_t *pi;
  65
  66   pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
  67   if (!pi)
  68     return;
  69
  70   if (!pi->n_connections)
  71     {
  72       clib_warning ("no connections using port %u", lcl_port);
  73       return;
  74     }
  75
  76   if (!clib_atomic_sub_fetch (&pi->n_connections, 1))
  77     udp_unregister_dst_port (0, lcl_port, is_ip4);
  78 }
  79
  80 void
  81 udp_connection_share_port (u16 lcl_port, u8 is_ip4)
  82 {
  83   udp_main_t *um = &udp_main;
  84   udp_dst_port_info_t *pi;
  85
  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);
  90 }
  91
  92 udp_connection_t *
  93 udp_connection_alloc (u32 thread_index)
  94 {
  95   udp_main_t *um = &udp_main;
  96   udp_connection_t *uc;
  97
  98   pool_get_aligned_safe (um->connections[thread_index], uc,
  99                          CLIB_CACHE_LINE_BYTES);
 100
 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;
 105   return uc;
 106 }
 107
 108 void
 109 udp_connection_free (udp_connection_t * uc)
 110 {
 111   u32 thread_index = uc->c_thread_index;
 112   clib_spinlock_free (&uc->rx_lock);
 113   if (CLIB_DEBUG)
 114     clib_memset (uc, 0xFA, sizeof (*uc));
 115   pool_put (udp_main.connections[thread_index], uc);
 116 }
 117
 118 static void
 119 udp_connection_cleanup (udp_connection_t * uc)
 120 {
 121   transport_endpoint_cleanup (TRANSPORT_PROTO_UDP, &uc->c_lcl_ip,
 122                               uc->c_lcl_port);
 123   udp_connection_unregister_port (clib_net_to_host_u16 (uc->c_lcl_port),
 124                                   uc->c_is_ip4);
 125   udp_connection_free (uc);
 126 }
 127
 128 void
 129 udp_connection_delete (udp_connection_t * uc)
 130 {
 131   session_transport_delete_notify (&uc->connection);
 132   udp_connection_cleanup (uc);
 133 }
 134
 135 static u8
 136 udp_connection_port_used_extern (u16 lcl_port, u8 is_ip4)
 137 {
 138   udp_main_t *um = vnet_get_udp_main ();
 139   udp_dst_port_info_t *pi;
 140
 141   pi = udp_get_dst_port_info (um, lcl_port, is_ip4);
 142   return (pi && !pi->n_connections
 143           && udp_is_valid_dst_port (lcl_port, is_ip4));
 144 }
 145
 146 static u16
 147 udp_default_mtu (udp_main_t * um, u8 is_ip4)
 148 {
 149   u16 ip_hlen = is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
 150   return (um->default_mtu - sizeof (udp_header_t) - ip_hlen);
 151 }
 152
 153 static u32
 154 udp_session_bind (u32 session_index, transport_endpoint_cfg_t *lcl)
 155 {
 156   udp_main_t *um = vnet_get_udp_main ();
 157   transport_endpoint_cfg_t *lcl_ext;
 158   udp_connection_t *listener;
 159   u16 lcl_port_ho;
 160   void *iface_ip;
 161
 162   lcl_port_ho = clib_net_to_host_u16 (lcl->port);
 163
 164   if (udp_connection_port_used_extern (lcl_port_ho, lcl->is_ip4))
 165     {
 166       clib_warning ("port already used");
 167       return SESSION_E_PORTINUSE;
 168     }
 169
 170   pool_get (um->listener_pool, listener);
 171   clib_memset (listener, 0, sizeof (udp_connection_t));
 172
 173   listener->c_lcl_port = lcl->port;
 174   listener->c_c_index = listener - um->listener_pool;
 175
 176   /* If we are provided a sw_if_index, bind using one of its ips */
 177   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
 178     {
 179       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
 180                                                  lcl->is_ip4)))
 181         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
 182     }
 183   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
 184   listener->c_is_ip4 = lcl->is_ip4;
 185   listener->c_proto = TRANSPORT_PROTO_UDP;
 186   listener->c_s_index = session_index;
 187   listener->c_fib_index = lcl->fib_index;
 188   listener->mss = udp_default_mtu (um, listener->c_is_ip4);
 189   listener->flags |= UDP_CONN_F_OWNS_PORT | UDP_CONN_F_LISTEN;
 190   lcl_ext = (transport_endpoint_cfg_t *) lcl;
 191   if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
 192     listener->flags |= UDP_CONN_F_CONNECTED;
 193   else
 194     listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
 195   clib_spinlock_init (&listener->rx_lock);
 196
 197   udp_connection_register_port (lcl_port_ho, lcl->is_ip4);
 198   return listener->c_c_index;
 199 }
 200
 201 static u32
 202 udp_session_unbind (u32 listener_index)
 203 {
 204   udp_main_t *um = &udp_main;
 205   udp_connection_t *listener;
 206
 207   listener = udp_listener_get (listener_index);
 208   udp_connection_unregister_port (clib_net_to_host_u16 (listener->c_lcl_port),
 209                                   listener->c_is_ip4);
 210   clib_spinlock_free (&listener->rx_lock);
 211   pool_put (um->listener_pool, listener);
 212   return 0;
 213 }
 214
 215 static transport_connection_t *
 216 udp_session_get_listener (u32 listener_index)
 217 {
 218   udp_connection_t *us;
 219
 220   us = udp_listener_get (listener_index);
 221   return &us->connection;
 222 }
 223
 224 always_inline u32
 225 udp_push_one_header (vlib_main_t *vm, udp_connection_t *uc, vlib_buffer_t *b)
 226 {
 227   vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
 228   if (uc->c_is_ip4)
 229     vlib_buffer_push_ip4_custom (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
 230                                  IP_PROTOCOL_UDP, 1 /* csum offload */,
 231                                  0 /* is_df */, uc->c_dscp);
 232   else
 233     vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
 234                           IP_PROTOCOL_UDP);
 235   vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
 236   vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
 237   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 238
 239   return 0;
 240 }
 241
 242 static u32
 243 udp_push_header (transport_connection_t *tc, vlib_buffer_t **bs, u32 n_bufs)
 244 {
 245   vlib_main_t *vm = vlib_get_main ();
 246   udp_connection_t *uc;
 247
 248   uc = udp_connection_from_transport (tc);
 249
 250   while (n_bufs >= 4)
 251     {
 252       vlib_prefetch_buffer_header (bs[2], STORE);
 253       vlib_prefetch_buffer_header (bs[3], STORE);
 254
 255       udp_push_one_header (vm, uc, bs[0]);
 256       udp_push_one_header (vm, uc, bs[1]);
 257
 258       n_bufs -= 2;
 259       bs += 2;
 260     }
 261   while (n_bufs)
 262     {
 263       if (n_bufs > 1)
 264         vlib_prefetch_buffer_header (bs[1], STORE);
 265
 266       udp_push_one_header (vm, uc, bs[0]);
 267
 268       n_bufs -= 1;
 269       bs += 1;
 270     }
 271
 272   if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
 273     {
 274       if (!transport_max_tx_dequeue (&uc->connection))
 275         udp_connection_delete (uc);
 276     }
 277
 278   return 0;
 279 }
 280
 281 static transport_connection_t *
 282 udp_session_get (u32 connection_index, u32 thread_index)
 283 {
 284   udp_connection_t *uc;
 285   uc = udp_connection_get (connection_index, thread_index);
 286   if (uc)
 287     return &uc->connection;
 288   return 0;
 289 }
 290
 291 static void
 292 udp_session_close (u32 connection_index, u32 thread_index)
 293 {
 294   udp_connection_t *uc;
 295
 296   uc = udp_connection_get (connection_index, thread_index);
 297   if (!uc || (uc->flags & UDP_CONN_F_MIGRATED))
 298     return;
 299
 300   if (!transport_max_tx_dequeue (&uc->connection))
 301     udp_connection_delete (uc);
 302   else
 303     uc->flags |= UDP_CONN_F_CLOSING;
 304 }
 305
 306 static void
 307 udp_session_cleanup (u32 connection_index, u32 thread_index)
 308 {
 309   udp_connection_t *uc;
 310   uc = udp_connection_get (connection_index, thread_index);
 311   if (!uc)
 312     return;
 313   if (uc->flags & UDP_CONN_F_MIGRATED)
 314     udp_connection_free (uc);
 315   else
 316     udp_connection_cleanup (uc);
 317 }
 318
 319 static int
 320 udp_session_send_params (transport_connection_t * tconn,
 321                          transport_send_params_t * sp)
 322 {
 323   udp_connection_t *uc;
 324
 325   uc = udp_connection_from_transport (tconn);
 326
 327   /* No constraint on TX window */
 328   sp->snd_space = ~0;
 329   /* TODO figure out MTU of output interface */
 330   sp->snd_mss = uc->mss;
 331   sp->tx_offset = 0;
 332   sp->flags = 0;
 333   return 0;
 334 }
 335
 336 static int
 337 udp_open_connection (transport_endpoint_cfg_t * rmt)
 338 {
 339   udp_main_t *um = &udp_main;
 340   ip46_address_t lcl_addr;
 341   udp_connection_t *uc;
 342   u32 thread_index;
 343   u16 lcl_port;
 344   int rv;
 345
 346   rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
 347                                        &lcl_port);
 348   if (rv)
 349     {
 350       if (rv != SESSION_E_PORTINUSE)
 351         return rv;
 352
 353       if (udp_connection_port_used_extern (lcl_port, rmt->is_ip4))
 354         return SESSION_E_PORTINUSE;
 355
 356       /* If port in use, check if 5-tuple is also in use */
 357       if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
 358                                      lcl_port, rmt->port, TRANSPORT_PROTO_UDP,
 359                                      rmt->is_ip4))
 360         return SESSION_E_PORTINUSE;
 361
 362       /* 5-tuple is available so increase lcl endpoint refcount and proceed
 363        * with connection allocation */
 364       transport_share_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
 365                                       lcl_port);
 366       goto conn_alloc;
 367     }
 368
 369   if (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
 370     {
 371       /* If specific source port was requested abort */
 372       if (rmt->peer.port)
 373         return SESSION_E_PORTINUSE;
 374
 375       /* Try to find a port that's not used */
 376       while (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
 377         {
 378           lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP,
 379                                                  &lcl_addr);
 380           if (lcl_port < 1)
 381             return SESSION_E_PORTINUSE;
 382         }
 383     }
 384
 385 conn_alloc:
 386
 387   udp_connection_register_port (lcl_port, rmt->is_ip4);
 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   uc->flags |= UDP_CONN_F_OWNS_PORT;
 403   if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
 404     {
 405       uc->flags |= UDP_CONN_F_CONNECTED;
 406     }
 407   else
 408     {
 409       clib_spinlock_init (&uc->rx_lock);
 410       uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
 411     }
 412
 413   return uc->c_c_index;
 414 }
 415
 416 static transport_connection_t *
 417 udp_session_get_half_open (u32 conn_index)
 418 {
 419   udp_connection_t *uc;
 420   u32 thread_index;
 421
 422   /* We don't poll main thread if we have workers */
 423   thread_index = transport_cl_thread ();
 424   uc = udp_connection_get (conn_index, thread_index);
 425   if (!uc)
 426     return 0;
 427   return &uc->connection;
 428 }
 429
 430 static u8 *
 431 format_udp_session (u8 * s, va_list * args)
 432 {
 433   u32 uci = va_arg (*args, u32);
 434   u32 thread_index = va_arg (*args, u32);
 435   u32 verbose = va_arg (*args, u32);
 436   udp_connection_t *uc;
 437
 438   uc = udp_connection_get (uci, thread_index);
 439   return format (s, "%U", format_udp_connection, uc, verbose);
 440 }
 441
 442 static u8 *
 443 format_udp_half_open_session (u8 * s, va_list * args)
 444 {
 445   u32 __clib_unused tci = va_arg (*args, u32);
 446   u32 __clib_unused thread_index = va_arg (*args, u32);
 447   clib_warning ("BUG");
 448   return 0;
 449 }
 450
 451 static u8 *
 452 format_udp_listener_session (u8 * s, va_list * args)
 453 {
 454   u32 tci = va_arg (*args, u32);
 455   u32 __clib_unused thread_index = va_arg (*args, u32);
 456   u32 verbose = va_arg (*args, u32);
 457   udp_connection_t *uc = udp_listener_get (tci);
 458   return format (s, "%U", format_udp_connection, uc, verbose);
 459 }
 460
 461 /* *INDENT-OFF* */
 462 static const transport_proto_vft_t udp_proto = {
 463   .start_listen = udp_session_bind,
 464   .connect = udp_open_connection,
 465   .stop_listen = udp_session_unbind,
 466   .push_header = udp_push_header,
 467   .get_connection = udp_session_get,
 468   .get_listener = udp_session_get_listener,
 469   .get_half_open = udp_session_get_half_open,
 470   .close = udp_session_close,
 471   .cleanup = udp_session_cleanup,
 472   .send_params = udp_session_send_params,
 473   .format_connection = format_udp_session,
 474   .format_half_open = format_udp_half_open_session,
 475   .format_listener = format_udp_listener_session,
 476   .transport_options = {
 477     .name = "udp",
 478     .short_name = "U",
 479     .tx_type = TRANSPORT_TX_DGRAM,
 480     .service_type = TRANSPORT_SERVICE_CL,
 481   },
 482 };
 483 /* *INDENT-ON* */
 484
 485 static clib_error_t *
 486 udp_init (vlib_main_t * vm)
 487 {
 488   udp_main_t *um = vnet_get_udp_main ();
 489   ip_main_t *im = &ip_main;
 490   vlib_thread_main_t *tm = vlib_get_thread_main ();
 491   u32 num_threads;
 492   ip_protocol_info_t *pi;
 493
 494   /*
 495    * Registrations
 496    */
 497
 498   /* IP registration */
 499   pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
 500   if (pi == 0)
 501     return clib_error_return (0, "UDP protocol info AWOL");
 502   pi->format_header = format_udp_header;
 503   pi->unformat_pg_edit = unformat_pg_udp_header;
 504
 505   /* Register as transport with URI */
 506   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
 507                                FIB_PROTOCOL_IP4, ip4_lookup_node.index);
 508   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
 509                                FIB_PROTOCOL_IP6, ip6_lookup_node.index);
 510
 511   /*
 512    * Initialize data structures
 513    */
 514
 515   num_threads = 1 /* main thread */  + tm->n_threads;
 516   vec_validate (um->connections, num_threads - 1);
 517
 518   um->local_to_input_edge[UDP_IP4] =
 519     vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
 520   um->local_to_input_edge[UDP_IP6] =
 521     vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
 522
 523   um->default_mtu = 1500;
 524   return 0;
 525 }
 526
 527 /* *INDENT-OFF* */
 528 VLIB_INIT_FUNCTION (udp_init) =
 529 {
 530   .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
 531                            "ip6_lookup_init"),
 532 };
 533 /* *INDENT-ON* */
 534
 535 /*
 536  * fd.io coding-style-patch-verification: ON
 537  *
 538  * Local Variables:
 539  * eval: (c-set-style "gnu")
 540  * End:
 541  */