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