src/vnet/udp/udp.c

   1 /*
   2  * Copyright (c) 2016-2019 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 /** @file
  17     udp state machine, etc.
  18 */
  19
  20 #include <vnet/udp/udp.h>
  21 #include <vnet/session/session.h>
  22 #include <vnet/dpo/load_balance.h>
  23 #include <vnet/fib/ip4_fib.h>
  24
  25 udp_main_t udp_main;
  26
  27 udp_connection_t *
  28 udp_connection_alloc (u32 thread_index)
  29 {
  30   udp_main_t *um = &udp_main;
  31   udp_connection_t *uc;
  32   u32 will_expand = 0;
  33   pool_get_aligned_will_expand (um->connections[thread_index], will_expand,
  34                                 CLIB_CACHE_LINE_BYTES);
  35
  36   if (PREDICT_FALSE (will_expand))
  37     {
  38       clib_spinlock_lock_if_init (&udp_main.peekers_write_locks
  39                                   [thread_index]);
  40       pool_get_aligned (udp_main.connections[thread_index], uc,
  41                         CLIB_CACHE_LINE_BYTES);
  42       clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
  43                                     [thread_index]);
  44     }
  45   else
  46     {
  47       pool_get_aligned (um->connections[thread_index], uc,
  48                         CLIB_CACHE_LINE_BYTES);
  49     }
  50   clib_memset (uc, 0, sizeof (*uc));
  51   uc->c_c_index = uc - um->connections[thread_index];
  52   uc->c_thread_index = thread_index;
  53   uc->c_proto = TRANSPORT_PROTO_UDP;
  54   clib_spinlock_init (&uc->rx_lock);
  55   return uc;
  56 }
  57
  58 void
  59 udp_connection_free (udp_connection_t * uc)
  60 {
  61   u32 thread_index = uc->c_thread_index;
  62   if (CLIB_DEBUG)
  63     clib_memset (uc, 0xFA, sizeof (*uc));
  64   pool_put (udp_main.connections[thread_index], uc);
  65 }
  66
  67 void
  68 udp_connection_delete (udp_connection_t * uc)
  69 {
  70   if ((uc->flags & UDP_CONN_F_OWNS_PORT)
  71       || !(uc->flags & UDP_CONN_F_CONNECTED))
  72     udp_unregister_dst_port (vlib_get_main (),
  73                              clib_net_to_host_u16 (uc->c_lcl_port),
  74                              uc->c_is_ip4);
  75   session_transport_delete_notify (&uc->connection);
  76   udp_connection_free (uc);
  77 }
  78
  79 u32
  80 udp_session_bind (u32 session_index, transport_endpoint_t * lcl)
  81 {
  82   udp_main_t *um = vnet_get_udp_main ();
  83   vlib_main_t *vm = vlib_get_main ();
  84   transport_endpoint_cfg_t *lcl_ext;
  85   udp_connection_t *listener;
  86   udp_dst_port_info_t *pi;
  87   u32 node_index;
  88   void *iface_ip;
  89
  90   pi = udp_get_dst_port_info (um, clib_net_to_host_u16 (lcl->port),
  91                               lcl->is_ip4);
  92   if (pi)
  93     return -1;
  94
  95   pool_get (um->listener_pool, listener);
  96   clib_memset (listener, 0, sizeof (udp_connection_t));
  97
  98   listener->c_lcl_port = lcl->port;
  99   listener->c_c_index = listener - um->listener_pool;
 100
 101   /* If we are provided a sw_if_index, bind using one of its ips */
 102   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
 103     {
 104       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
 105                                                  lcl->is_ip4)))
 106         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
 107     }
 108   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
 109   listener->c_is_ip4 = lcl->is_ip4;
 110   listener->c_proto = TRANSPORT_PROTO_UDP;
 111   listener->c_s_index = session_index;
 112   listener->c_fib_index = lcl->fib_index;
 113   listener->flags |= UDP_CONN_F_OWNS_PORT;
 114   lcl_ext = (transport_endpoint_cfg_t *) lcl;
 115   if (lcl_ext->transport_flags & TRANSPORT_CFG_F_CONNECTED)
 116     listener->flags |= UDP_CONN_F_CONNECTED;
 117   else
 118     listener->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
 119   clib_spinlock_init (&listener->rx_lock);
 120
 121   node_index = lcl->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
 122   udp_register_dst_port (vm, clib_net_to_host_u16 (lcl->port), node_index,
 123                          lcl->is_ip4);
 124   return listener->c_c_index;
 125 }
 126
 127 u32
 128 udp_session_unbind (u32 listener_index)
 129 {
 130   vlib_main_t *vm = vlib_get_main ();
 131
 132   udp_connection_t *listener;
 133   listener = udp_listener_get (listener_index);
 134   udp_unregister_dst_port (vm, clib_net_to_host_u16 (listener->c_lcl_port),
 135                            listener->c_is_ip4);
 136   return 0;
 137 }
 138
 139 transport_connection_t *
 140 udp_session_get_listener (u32 listener_index)
 141 {
 142   udp_connection_t *us;
 143
 144   us = udp_listener_get (listener_index);
 145   return &us->connection;
 146 }
 147
 148 u32
 149 udp_push_header (transport_connection_t * tc, vlib_buffer_t * b)
 150 {
 151   udp_connection_t *uc;
 152   vlib_main_t *vm = vlib_get_main ();
 153
 154   uc = udp_get_connection_from_transport (tc);
 155
 156   vlib_buffer_push_udp (b, uc->c_lcl_port, uc->c_rmt_port, 1);
 157   if (tc->is_ip4)
 158     vlib_buffer_push_ip4 (vm, b, &uc->c_lcl_ip4, &uc->c_rmt_ip4,
 159                           IP_PROTOCOL_UDP, 1);
 160   else
 161     {
 162       ip6_header_t *ih;
 163       ih = vlib_buffer_push_ip6 (vm, b, &uc->c_lcl_ip6, &uc->c_rmt_ip6,
 164                                  IP_PROTOCOL_UDP);
 165       vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
 166     }
 167   vnet_buffer (b)->sw_if_index[VLIB_RX] = 0;
 168   vnet_buffer (b)->sw_if_index[VLIB_TX] = uc->c_fib_index;
 169   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 170
 171   if (PREDICT_FALSE (uc->flags & UDP_CONN_F_CLOSING))
 172     {
 173       if (!transport_max_tx_dequeue (&uc->connection))
 174         udp_connection_delete (uc);
 175     }
 176
 177   return 0;
 178 }
 179
 180 transport_connection_t *
 181 udp_session_get (u32 connection_index, u32 thread_index)
 182 {
 183   udp_connection_t *uc;
 184   uc = udp_connection_get (connection_index, thread_index);
 185   if (uc)
 186     return &uc->connection;
 187   return 0;
 188 }
 189
 190 void
 191 udp_session_close (u32 connection_index, u32 thread_index)
 192 {
 193   udp_connection_t *uc;
 194
 195   uc = udp_connection_get (connection_index, thread_index);
 196   if (!uc)
 197     return;
 198
 199   if (!transport_max_tx_dequeue (&uc->connection))
 200     udp_connection_delete (uc);
 201   else
 202     uc->flags |= UDP_CONN_F_CLOSING;
 203 }
 204
 205 void
 206 udp_session_cleanup (u32 connection_index, u32 thread_index)
 207 {
 208   udp_connection_t *uc;
 209   uc = udp_connection_get (connection_index, thread_index);
 210   if (uc)
 211     udp_connection_free (uc);
 212 }
 213
 214 u8 *
 215 format_udp_connection_id (u8 * s, va_list * args)
 216 {
 217   udp_connection_t *uc = va_arg (*args, udp_connection_t *);
 218   if (!uc)
 219     return s;
 220   if (uc->c_is_ip4)
 221     s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
 222                 format_ip4_address, &uc->c_lcl_ip4,
 223                 clib_net_to_host_u16 (uc->c_lcl_port), format_ip4_address,
 224                 &uc->c_rmt_ip4, clib_net_to_host_u16 (uc->c_rmt_port));
 225   else
 226     s = format (s, "[#%d][%s] %U:%d->%U:%d", uc->c_thread_index, "U",
 227                 format_ip6_address, &uc->c_lcl_ip6,
 228                 clib_net_to_host_u16 (uc->c_lcl_port), format_ip6_address,
 229                 &uc->c_rmt_ip6, clib_net_to_host_u16 (uc->c_rmt_port));
 230   return s;
 231 }
 232
 233 u8 *
 234 format_udp_connection (u8 * s, va_list * args)
 235 {
 236   udp_connection_t *uc = va_arg (*args, udp_connection_t *);
 237   u32 verbose = va_arg (*args, u32);
 238   if (!uc)
 239     return s;
 240   s = format (s, "%-50U", format_udp_connection_id, uc);
 241   if (verbose)
 242     {
 243       if (verbose == 1)
 244         s = format (s, "%-15s", "-");
 245       else
 246         s = format (s, "\n");
 247     }
 248   return s;
 249 }
 250
 251 u8 *
 252 format_udp_session (u8 * s, va_list * args)
 253 {
 254   u32 uci = va_arg (*args, u32);
 255   u32 thread_index = va_arg (*args, u32);
 256   u32 verbose = va_arg (*args, u32);
 257   udp_connection_t *uc;
 258
 259   uc = udp_connection_get (uci, thread_index);
 260   return format (s, "%U", format_udp_connection, uc, verbose);
 261 }
 262
 263 u8 *
 264 format_udp_half_open_session (u8 * s, va_list * args)
 265 {
 266   u32 __clib_unused tci = va_arg (*args, u32);
 267   u32 __clib_unused thread_index = va_arg (*args, u32);
 268   clib_warning ("BUG");
 269   return 0;
 270 }
 271
 272 u8 *
 273 format_udp_listener_session (u8 * s, va_list * args)
 274 {
 275   u32 tci = va_arg (*args, u32);
 276   u32 __clib_unused thread_index = va_arg (*args, u32);
 277   u32 verbose = va_arg (*args, u32);
 278   udp_connection_t *uc = udp_listener_get (tci);
 279   return format (s, "%U", format_udp_connection, uc, verbose);
 280 }
 281
 282 static int
 283 udp_session_send_params (transport_connection_t * tconn,
 284                          transport_send_params_t * sp)
 285 {
 286   /* No constraint on TX window */
 287   sp->snd_space = ~0;
 288   /* TODO figure out MTU of output interface */
 289   sp->snd_mss = 1460;
 290   sp->tx_offset = 0;
 291   sp->flags = 0;
 292   return 0;
 293 }
 294
 295 int
 296 udp_open_connection (transport_endpoint_cfg_t * rmt)
 297 {
 298   udp_main_t *um = vnet_get_udp_main ();
 299   vlib_main_t *vm = vlib_get_main ();
 300   u32 thread_index = vm->thread_index;
 301   udp_connection_t *uc;
 302   ip46_address_t lcl_addr;
 303   u32 node_index;
 304   u16 lcl_port;
 305
 306   if (transport_alloc_local_endpoint (TRANSPORT_PROTO_UDP, rmt, &lcl_addr,
 307                                       &lcl_port))
 308     return -1;
 309
 310   while (udp_get_dst_port_info (um, lcl_port, rmt->is_ip4))
 311     {
 312       lcl_port = transport_alloc_local_port (TRANSPORT_PROTO_UDP, &lcl_addr);
 313       if (lcl_port < 1)
 314         {
 315           clib_warning ("Failed to allocate src port");
 316           return -1;
 317         }
 318     }
 319
 320   node_index = rmt->is_ip4 ? udp4_input_node.index : udp6_input_node.index;
 321   udp_register_dst_port (vm, lcl_port, node_index, 1 /* is_ipv4 */ );
 322
 323   /* We don't poll main thread if we have workers */
 324   if (vlib_num_workers ())
 325     thread_index = 1;
 326
 327   uc = udp_connection_alloc (thread_index);
 328   ip_copy (&uc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
 329   ip_copy (&uc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
 330   uc->c_rmt_port = rmt->port;
 331   uc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
 332   uc->c_is_ip4 = rmt->is_ip4;
 333   uc->c_proto = TRANSPORT_PROTO_UDP;
 334   uc->c_fib_index = rmt->fib_index;
 335   uc->flags |= UDP_CONN_F_OWNS_PORT;
 336   if (rmt->transport_flags & TRANSPORT_CFG_F_CONNECTED)
 337     uc->flags |= UDP_CONN_F_CONNECTED;
 338   else
 339     uc->c_flags |= TRANSPORT_CONNECTION_F_CLESS;
 340
 341   return uc->c_c_index;
 342 }
 343
 344 transport_connection_t *
 345 udp_session_get_half_open (u32 conn_index)
 346 {
 347   udp_connection_t *uc;
 348   u32 thread_index;
 349
 350   /* We don't poll main thread if we have workers */
 351   thread_index = vlib_num_workers ()? 1 : 0;
 352   uc = udp_connection_get (conn_index, thread_index);
 353   if (!uc)
 354     return 0;
 355   return &uc->connection;
 356 }
 357
 358 /* *INDENT-OFF* */
 359 static const transport_proto_vft_t udp_proto = {
 360   .start_listen = udp_session_bind,
 361   .connect = udp_open_connection,
 362   .stop_listen = udp_session_unbind,
 363   .push_header = udp_push_header,
 364   .get_connection = udp_session_get,
 365   .get_listener = udp_session_get_listener,
 366   .get_half_open = udp_session_get_half_open,
 367   .close = udp_session_close,
 368   .cleanup = udp_session_cleanup,
 369   .send_params = udp_session_send_params,
 370   .format_connection = format_udp_session,
 371   .format_half_open = format_udp_half_open_session,
 372   .format_listener = format_udp_listener_session,
 373   .transport_options = {
 374     .name = "udp",
 375     .short_name = "U",
 376     .tx_type = TRANSPORT_TX_DGRAM,
 377     .service_type = TRANSPORT_SERVICE_CL,
 378   },
 379 };
 380 /* *INDENT-ON* */
 381
 382
 383 int
 384 udpc_connection_open (transport_endpoint_cfg_t * rmt)
 385 {
 386   udp_connection_t *uc;
 387   /* Reproduce the logic of udp_open_connection to find the correct thread */
 388   u32 thread_index = vlib_num_workers ()? 1 : vlib_get_main ()->thread_index;
 389   u32 uc_index;
 390   uc_index = udp_open_connection (rmt);
 391   if (uc_index == (u32) ~ 0)
 392     return -1;
 393   uc = udp_connection_get (uc_index, thread_index);
 394   uc->flags |= UDP_CONN_F_CONNECTED;
 395   return uc_index;
 396 }
 397
 398 u32
 399 udpc_connection_listen (u32 session_index, transport_endpoint_t * lcl)
 400 {
 401   udp_connection_t *listener;
 402   u32 li_index;
 403   li_index = udp_session_bind (session_index, lcl);
 404   if (li_index == (u32) ~ 0)
 405     return -1;
 406   listener = udp_listener_get (li_index);
 407   listener->flags |= UDP_CONN_F_CONNECTED;
 408   /* Fake udp listener, i.e., make sure session layer adds a udp instead of
 409    * udpc listener to the lookup table */
 410   ((session_endpoint_cfg_t *) lcl)->transport_proto = TRANSPORT_PROTO_UDP;
 411   return li_index;
 412 }
 413
 414 /* *INDENT-OFF* */
 415 static const transport_proto_vft_t udpc_proto = {
 416   .start_listen = udpc_connection_listen,
 417   .stop_listen = udp_session_unbind,
 418   .connect = udpc_connection_open,
 419   .push_header = udp_push_header,
 420   .get_connection = udp_session_get,
 421   .get_listener = udp_session_get_listener,
 422   .get_half_open = udp_session_get_half_open,
 423   .close = udp_session_close,
 424   .cleanup = udp_session_cleanup,
 425   .send_params = udp_session_send_params,
 426   .format_connection = format_udp_session,
 427   .format_half_open = format_udp_half_open_session,
 428   .format_listener = format_udp_listener_session,
 429   .transport_options = {
 430     .name = "udpc",
 431     .short_name = "U",
 432     .tx_type = TRANSPORT_TX_DGRAM,
 433     .service_type = TRANSPORT_SERVICE_VC,
 434     .half_open_has_fifos = 1
 435   },
 436 };
 437 /* *INDENT-ON* */
 438
 439 static clib_error_t *
 440 udp_init (vlib_main_t * vm)
 441 {
 442   udp_main_t *um = vnet_get_udp_main ();
 443   ip_main_t *im = &ip_main;
 444   vlib_thread_main_t *tm = vlib_get_thread_main ();
 445   u32 num_threads;
 446   ip_protocol_info_t *pi;
 447   int i;
 448
 449   /*
 450    * Registrations
 451    */
 452
 453   /* IP registration */
 454   pi = ip_get_protocol_info (im, IP_PROTOCOL_UDP);
 455   if (pi == 0)
 456     return clib_error_return (0, "UDP protocol info AWOL");
 457   pi->format_header = format_udp_header;
 458   pi->unformat_pg_edit = unformat_pg_udp_header;
 459
 460   /* Register as transport with URI */
 461   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
 462                                FIB_PROTOCOL_IP4, ip4_lookup_node.index);
 463   transport_register_protocol (TRANSPORT_PROTO_UDP, &udp_proto,
 464                                FIB_PROTOCOL_IP6, ip6_lookup_node.index);
 465   transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
 466                                FIB_PROTOCOL_IP4, ip4_lookup_node.index);
 467   transport_register_protocol (TRANSPORT_PROTO_UDPC, &udpc_proto,
 468                                FIB_PROTOCOL_IP6, ip6_lookup_node.index);
 469
 470   /*
 471    * Initialize data structures
 472    */
 473
 474   num_threads = 1 /* main thread */  + tm->n_threads;
 475   vec_validate (um->connections, num_threads - 1);
 476   vec_validate (um->connection_peekers, num_threads - 1);
 477   vec_validate (um->peekers_readers_locks, num_threads - 1);
 478   vec_validate (um->peekers_write_locks, num_threads - 1);
 479
 480   if (num_threads > 1)
 481     for (i = 0; i < num_threads; i++)
 482       {
 483         clib_spinlock_init (&um->peekers_readers_locks[i]);
 484         clib_spinlock_init (&um->peekers_write_locks[i]);
 485       }
 486   return 0;
 487 }
 488
 489 /* *INDENT-OFF* */
 490 VLIB_INIT_FUNCTION (udp_init) =
 491 {
 492   .runs_after = VLIB_INITS("ip_main_init", "ip4_lookup_init",
 493                            "ip6_lookup_init"),
 494 };
 495 /* *INDENT-ON* */
 496
 497
 498 static clib_error_t *
 499 show_udp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
 500                   vlib_cli_command_t * cmd_arg)
 501 {
 502   udp_main_t *um = vnet_get_udp_main ();
 503
 504   clib_error_t *error = NULL;
 505
 506   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 507     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
 508                               input);
 509
 510   udp_dst_port_info_t *port_info;
 511   if (um->punt_unknown4)
 512     {
 513       vlib_cli_output (vm, "IPv4 UDP punt: enabled");
 514     }
 515   else
 516     {
 517       u8 *s = NULL;
 518       vec_foreach (port_info, um->dst_port_infos[UDP_IP4])
 519       {
 520         if (udp_is_valid_dst_port (port_info->dst_port, 1))
 521           {
 522             s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
 523           }
 524       }
 525       s = format (s, "%c", 0);
 526       vlib_cli_output (vm, "IPV4 UDP ports punt : %s", s);
 527     }
 528
 529   if (um->punt_unknown6)
 530     {
 531       vlib_cli_output (vm, "IPv6 UDP punt: enabled");
 532     }
 533   else
 534     {
 535       u8 *s = NULL;
 536       vec_foreach (port_info, um->dst_port_infos[UDP_IP6])
 537       {
 538         if (udp_is_valid_dst_port (port_info->dst_port, 01))
 539           {
 540             s = format (s, (!s) ? "%d" : ", %d", port_info->dst_port);
 541           }
 542       }
 543       s = format (s, "%c", 0);
 544       vlib_cli_output (vm, "IPV6 UDP ports punt : %s", s);
 545     }
 546
 547   return (error);
 548 }
 549 /* *INDENT-OFF* */
 550 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
 551 {
 552   .path = "show udp punt",
 553   .short_help = "show udp punt [ipv4|ipv6]",
 554   .function = show_udp_punt_fn,
 555 };
 556 /* *INDENT-ON* */
 557
 558 /*
 559  * fd.io coding-style-patch-verification: ON
 560  *
 561  * Local Variables:
 562  * eval: (c-set-style "gnu")
 563  * End:
 564  */