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 =
 189     lcl->mss ? lcl->mss : udp_default_mtu (um, listener->c_is_ip4);
 190   listener->flags |= UDP_CONN_F_OWNS_PORT | UDP_CONN_F_LISTEN;
 191   lcl_ext = (transport_endpoint_cfg_t *) lcl;
 192   if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
 193     listener->flags |= UDP_CONN_F_CONNECTED;
 194   else
 195     listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
 196   clib_spinlock_init (&listener->rx_lock);
 197
 198   udp_connection_register_port (lcl_port_ho, lcl->is_ip4);
 199   return listener->c_c_index;
 200 }
 201
 202 static u32
 203 udp_session_unbind (u32 listener_index)
 204 {
 205   udp_main_t *um = &udp_main;
 206   udp_connection_t *listener;
 207
 208   listener = udp_listener_get (listener_index);
 209   udp_connection_unregister_port (clib_net_to_host_u16 (listener->c_lcl_port),
 210                                   listener->c_is_ip4);
 211   clib_spinlock_free (&listener->rx_lock);
 212   pool_put (um->listener_pool, listener);
 213   return 0;
 214 }
 215
 216 static transport_connection_t *
 217 udp_session_get_listener (u32 listener_index)
 218 {
 219   udp_connection_t *us;
 220
 221   us = udp_listener_get (listener_index);
 222   return &us->connection;
 223 }
 224
 225 always_inline u32
 226 udp_push_one_header (vlib_main_t *vm, udp_connection_t *uc, vlib_buffer_t *b)
 227 {
 228   vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
 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, 1 /* csum offload */,
 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   vnet_buffer (b)->sw_if_index[VLIB_RX] = uc->sw_if_index;
 237   vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
 238   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 239
 240   return 0;
 241 }
 242
 243 static u32
 244 udp_push_header (transport_connection_t *tc, vlib_buffer_t **bs, u32 n_bufs)
 245 {
 246   vlib_main_t *vm = vlib_get_main ();
 247   udp_connection_t *uc;
 248
 249   uc = udp_connection_from_transport (tc);
 250
 251   while (n_bufs >= 4)
 252     {
 253       vlib_prefetch_buffer_header (bs[2], STORE);
 254       vlib_prefetch_buffer_header (bs[3], STORE);
 255
 256       udp_push_one_header (vm, uc, bs[0]);
 257       udp_push_one_header (vm, uc, bs[1]);
 258
 259       n_bufs -= 2;
 260       bs += 2;
 261     }
 262   while (n_bufs)
 263     {
 264       if (n_bufs > 1)
 265         vlib_prefetch_buffer_header (bs[1], STORE);
 266
 267       udp_push_one_header (vm, uc, bs[0]);
 268
 269       n_bufs -= 1;
 270       bs += 1;
 271     }
 272
 273   if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
 274     {
 275       if (!transport_max_tx_dequeue (&uc->connection))
 276         udp_connection_delete (uc);
 277     }
 278
 279   return 0;
 280 }
 281
 282 static transport_connection_t *
 283 udp_session_get (u32 connection_index, u32 thread_index)
 284 {
 285   udp_connection_t *uc;
 286   uc = udp_connection_get (connection_index, thread_index);
 287   if (uc)
 288     return &uc->connection;
 289   return 0;
 290 }
 291
 292 static void
 293 udp_session_close (u32 connection_index, u32 thread_index)
 294 {
 295   udp_connection_t *uc;
 296
 297   uc = udp_connection_get (connection_index, thread_index);
 298   if (!uc || (uc->flags & UDP_CONN_F_MIGRATED))
 299     return;
 300
 301   if (!transport_max_tx_dequeue (&uc->connection))
 302     udp_connection_delete (uc);
 303   else
 304     uc->flags |= UDP_CONN_F_CLOSING;
 305 }
 306
 307 static void
 308 udp_session_cleanup (u32 connection_index, u32 thread_index)
 309 {
 310   udp_connection_t *uc;
 311   uc = udp_connection_get (connection_index, thread_index);
 312   if (!uc)
 313     return;
 314   if (uc->flags & UDP_CONN_F_MIGRATED)
 315     udp_connection_free (uc);
 316   else
 317     udp_connection_cleanup (uc);
 318 }
 319
 320 static int
 321 udp_session_send_params (transport_connection_t * tconn,
 322                          transport_send_params_t * sp)
 323 {
 324   udp_connection_t *uc;
 325
 326   uc = udp_connection_from_transport (tconn);
 327
 328   /* No constraint on TX window */
 329   sp->snd_space = ~0;
 330   /* TODO figure out MTU of output interface */
 331   sp->snd_mss = uc->mss;
 332   sp->tx_offset = 0;
 333   sp->flags = 0;
 334   return 0;
 335 }
 336
 337 static int
 338 udp_open_connection (transport_endpoint_cfg_t * rmt)
 339 {
 340   udp_main_t *um = &udp_main;
 341   ip46_address_t lcl_addr;
 342   udp_connection_t *uc;
 343   u32 thread_index;
 344   u16 lcl_port;
 345   int rv;
 346
 347   rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
 348                                        &lcl_port);
 349   if (rv)
 350     {
 351       if (rv != SESSION_E_PORTINUSE)
 352         return rv;
 353
 354       if (udp_connection_port_used_extern (lcl_port, rmt->is_ip4))
 355         return SESSION_E_PORTINUSE;
 356
 357       /* If port in use, check if 5-tuple is also in use */
 358       if (session_lookup_connection (rmt->fib_index, &lcl_addr, &rmt->ip,
 359                                      lcl_port, rmt->port, TRANSPORT_PROTO_UDP,
 360                                      rmt->is_ip4))
 361         return SESSION_E_PORTINUSE;
 362
 363       /* 5-tuple is available so increase lcl endpoint refcount and proceed
 364        * with connection allocation */
 365       transport_share_local_endpoint (TRANSPORT_PROTO_UDP, &lcl_addr,
 366                                       lcl_port);
 367       goto conn_alloc;
 368     }
 369
 370   if (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
 371     {
 372       /* If specific source port was requested abort */
 373       if (rmt->peer.port)
 374         return SESSION_E_PORTINUSE;
 375
 376       /* Try to find a port that's not used */
 377       while (udp_is_valid_dst_port (lcl_port, rmt->is_ip4))
 378         {
 379           lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP,
 380                                                  &lcl_addr);
 381           if (lcl_port < 1)
 382             return SESSION_E_PORTINUSE;
 383         }
 384     }
 385
 386 conn_alloc:
 387
 388   udp_connection_register_port (lcl_port, rmt->is_ip4);
 389
 390   /* We don't poll main thread if we have workers */
 391   thread_index = transport_cl_thread ();
 392
 393   uc = udp_connection_alloc (thread_index);
 394   ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
 395   ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
 396   uc->c_rmt_port = rmt->port;
 397   uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
 398   uc->c_is_ip4 = rmt->is_ip4;
 399   uc->c_proto = TRANSPORT_PROTO_UDP;
 400   uc->c_fib_index = rmt->fib_index;
 401   uc->c_dscp = rmt->dscp;
 402   uc->mss = rmt->mss ? rmt->mss : udp_default_mtu (um, uc->c_is_ip4);
 403   if (rmt->peer.sw_if_index != ENDPOINT_INVALID_INDEX)
 404     uc->sw_if_index = rmt->peer.sw_if_index;
 405   uc->flags |= UDP_CONN_F_OWNS_PORT;
 406   if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
 407     {
 408       uc->flags |= UDP_CONN_F_CONNECTED;
 409     }
 410   else
 411     {
 412       clib_spinlock_init (&uc->rx_lock);
 413       uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
 414     }
 415
 416   return uc->c_c_index;
 417 }
 418
 419 static transport_connection_t *
 420 udp_session_get_half_open (u32 conn_index)
 421 {
 422   udp_connection_t *uc;
 423   u32 thread_index;
 424
 425   /* We don't poll main thread if we have workers */
 426   thread_index = transport_cl_thread ();
 427   uc = udp_connection_get (conn_index, thread_index);
 428   if (!uc)
 429     return 0;
 430   return &uc->connection;
 431 }
 432
 433 static u8 *
 434 format_udp_session (u8 * s, va_list * args)
 435 {
 436   u32 uci = va_arg (*args, u32);
 437   u32 thread_index = va_arg (*args, u32);
 438   u32 verbose = va_arg (*args, u32);
 439   udp_connection_t *uc;
 440
 441   uc = udp_connection_get (uci, thread_index);
 442   return format (s, "%U", format_udp_connection, uc, verbose);
 443 }
 444
 445 static u8 *
 446 format_udp_half_open_session (u8 * s, va_list * args)
 447 {
 448   u32 __clib_unused tci = va_arg (*args, u32);
 449   u32 __clib_unused thread_index = va_arg (*args, u32);
 450   clib_warning ("BUG");
 451   return 0;
 452 }
 453
 454 static u8 *
 455 format_udp_listener_session (u8 * s, va_list * args)
 456 {
 457   u32 tci = va_arg (*args, u32);
 458   u32 __clib_unused thread_index = va_arg (*args, u32);
 459   u32 verbose = va_arg (*args, u32);
 460   udp_connection_t *uc = udp_listener_get (tci);
 461   return format (s, "%U", format_udp_connection, uc, verbose);
 462 }
 463
 464 /* *INDENT-OFF* */
 465 static const transport_proto_vft_t udp_proto = {
 466   .start_listen = udp_session_bind,
 467   .connect = udp_open_connection,
 468   .stop_listen = udp_session_unbind,
 469   .push_header = udp_push_header,
 470   .get_connection = udp_session_get,
 471   .get_listener = udp_session_get_listener,
 472   .get_half_open = udp_session_get_half_open,
 473   .close = udp_session_close,
 474   .cleanup = udp_session_cleanup,
 475   .send_params = udp_session_send_params,
 476   .format_connection = format_udp_session,
 477   .format_half_open = format_udp_half_open_session,
 478   .format_listener = format_udp_listener_session,
 479   .transport_options = {
 480     .name = "udp",
 481     .short_name = "U",
 482     .tx_type = TRANSPORT_TX_DGRAM,
 483     .service_type = TRANSPORT_SERVICE_CL,
 484   },
 485 };
 486 /* *INDENT-ON* */
 487
 488 static clib_error_t *
 489 udp_init (vlib_main_t * vm)
 490 {
 491   udp_main_t *um = vnet_get_udp_main ();
 492   ip_main_t *im = &ip_main;
 493   vlib_thread_main_t *tm = vlib_get_thread_main ();
 494   u32 num_threads;
 495   ip_protocol_info_t *pi;
 496
 497   /*
 498    * Registrations
 499    */
 500
 501   /* IP registration */
 502   pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
 503   if (pi == 0)
 504     return clib_error_return (0, "UDP protocol info AWOL");
 505   pi->format_header = format_udp_header;
 506   pi->unformat_pg_edit = unformat_pg_udp_header;
 507
 508   /* Register as transport with URI */
 509   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
 510                                FIB_PROTOCOL_IP4, ip4_lookup_node.index);
 511   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
 512                                FIB_PROTOCOL_IP6, ip6_lookup_node.index);
 513
 514   /*
 515    * Initialize data structures
 516    */
 517
 518   num_threads = 1 /* main thread */  + tm->n_threads;
 519   vec_validate (um->connections, num_threads - 1);
 520
 521   um->local_to_input_edge[UDP_IP4] =
 522     vlib_node_add_next (vm, udp4_local_node.index, udp4_input_node.index);
 523   um->local_to_input_edge[UDP_IP6] =
 524     vlib_node_add_next (vm, udp6_local_node.index, udp6_input_node.index);
 525
 526   um->default_mtu = 1500;
 527   return 0;
 528 }
 529
 530 /* *INDENT-OFF* */
 531 VLIB_INIT_FUNCTION (udp_init) =
 532 {
 533   .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
 534                            "ip6_lookup_init"),
 535 };
 536 /* *INDENT-ON* */
 537
 538 /*
 539  * fd.io coding-style-patch-verification: ON
 540  *
 541  * Local Variables:
 542  * eval: (c-set-style "gnu")
 543  * End:
 544  */