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