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