src/vnet/session/transport.c

   1 /*
   2  * Copyright (c) 2017-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 #include <vnet/session/transport.h>
  17 #include <vnet/session/session.h>
  18 #include <vnet/fib/fib.h>
  19
  20 /**
  21  * Per-type vector of transport protocol virtual function tables
  22  */
  23 transport_proto_vft_t *tp_vfts;
  24
  25 typedef struct local_endpoint_
  26 {
  27   transport_endpoint_t ep;
  28   transport_proto_t proto;
  29   int refcnt;
  30 } local_endpoint_t;
  31
  32 typedef struct transport_main_
  33 {
  34   transport_endpoint_table_t local_endpoints_table;
  35   local_endpoint_t *local_endpoints;
  36   u32 *lcl_endpts_freelist;
  37   u32 port_allocator_seed;
  38   u16 port_allocator_min_src_port;
  39   u16 port_allocator_max_src_port;
  40   u8 lcl_endpts_cleanup_pending;
  41   clib_spinlock_t local_endpoints_lock;
  42 } transport_main_t;
  43
  44 static transport_main_t tp_main;
  45
  46 u8 *
  47 format_transport_proto (u8 * s, va_list * args)
  48 {
  49   u32 transport_proto = va_arg (*args, u32);
  50
  51   if (tp_vfts[transport_proto].transport_options.name)
  52     s = format (s, "%s", tp_vfts[transport_proto].transport_options.name);
  53   else
  54     s = format (s, "n/a");
  55
  56   return s;
  57 }
  58
  59 u8 *
  60 format_transport_proto_short (u8 * s, va_list * args)
  61 {
  62   u32 transport_proto = va_arg (*args, u32);
  63   char *short_name;
  64
  65   short_name = tp_vfts[transport_proto].transport_options.short_name;
  66   if (short_name)
  67     s = format (s, "%s", short_name);
  68   else
  69     s = format (s, "NA");
  70
  71   return s;
  72 }
  73
  74 const char *transport_flags_str[] = {
  75 #define _(sym, str) str,
  76   foreach_transport_connection_flag
  77 #undef _
  78 };
  79
  80 u8 *
  81 format_transport_flags (u8 *s, va_list *args)
  82 {
  83   transport_connection_flags_t flags;
  84   int i, last = -1;
  85
  86   flags = va_arg (*args, transport_connection_flags_t);
  87
  88   for (i = 0; i < TRANSPORT_CONNECTION_N_FLAGS; i++)
  89     if (flags & (1 << i))
  90       last = i;
  91
  92   for (i = 0; i < last; i++)
  93     {
  94       if (flags & (1 << i))
  95         s = format (s, "%s, ", transport_flags_str[i]);
  96     }
  97   if (last >= 0)
  98     s = format (s, "%s", transport_flags_str[last]);
  99
 100   return s;
 101 }
 102
 103 u8 *
 104 format_transport_connection (u8 * s, va_list * args)
 105 {
 106   u32 transport_proto = va_arg (*args, u32);
 107   u32 conn_index = va_arg (*args, u32);
 108   u32 thread_index = va_arg (*args, u32);
 109   u32 verbose = va_arg (*args, u32);
 110   transport_proto_vft_t *tp_vft;
 111   transport_connection_t *tc;
 112   u32 indent;
 113
 114   tp_vft = transport_protocol_get_vft (transport_proto);
 115   if (!tp_vft)
 116     return s;
 117
 118   s = format (s, "%U", tp_vft->format_connection, conn_index, thread_index,
 119               verbose);
 120   tc = tp_vft->get_connection (conn_index, thread_index);
 121   if (tc && verbose > 1)
 122     {
 123       indent = format_get_indent (s) + 1;
 124       if (transport_connection_is_tx_paced (tc))
 125         s = format (s, "%Upacer: %U\n", format_white_space, indent,
 126                     format_transport_pacer, &tc->pacer, tc->thread_index);
 127       s = format (s, "%Utransport: flags: %U\n", format_white_space, indent,
 128                   format_transport_flags, tc->flags);
 129     }
 130   return s;
 131 }
 132
 133 u8 *
 134 format_transport_listen_connection (u8 * s, va_list * args)
 135 {
 136   u32 transport_proto = va_arg (*args, u32);
 137   transport_proto_vft_t *tp_vft;
 138
 139   tp_vft = transport_protocol_get_vft (transport_proto);
 140   if (!tp_vft)
 141     return s;
 142
 143   s = (tp_vft->format_listener) (s, args);
 144   return s;
 145 }
 146
 147 u8 *
 148 format_transport_half_open_connection (u8 * s, va_list * args)
 149 {
 150   u32 transport_proto = va_arg (*args, u32);
 151   transport_proto_vft_t *tp_vft;
 152
 153   tp_vft = transport_protocol_get_vft (transport_proto);
 154   if (!tp_vft)
 155     return s;
 156
 157   s = (tp_vft->format_half_open) (s, args);
 158   return s;
 159 }
 160
 161 static u8
 162 unformat_transport_str_match (unformat_input_t * input, const char *str)
 163 {
 164   int i;
 165
 166   if (strlen (str) > vec_len (input->buffer) - input->index)
 167     return 0;
 168
 169   for (i = 0; i < strlen (str); i++)
 170     {
 171       if (input->buffer[i + input->index] != str[i])
 172         return 0;
 173     }
 174   return 1;
 175 }
 176
 177 uword
 178 unformat_transport_proto (unformat_input_t * input, va_list * args)
 179 {
 180   u32 *proto = va_arg (*args, u32 *);
 181   transport_proto_vft_t *tp_vft;
 182   u8 longest_match = 0, match;
 183   char *str, *str_match = 0;
 184   transport_proto_t tp;
 185
 186   for (tp = 0; tp < vec_len (tp_vfts); tp++)
 187     {
 188       tp_vft = &tp_vfts[tp];
 189       str = tp_vft->transport_options.name;
 190       if (!str)
 191         continue;
 192       if (unformat_transport_str_match (input, str))
 193         {
 194           match = strlen (str);
 195           if (match > longest_match)
 196             {
 197               *proto = tp;
 198               longest_match = match;
 199               str_match = str;
 200             }
 201         }
 202     }
 203   if (longest_match)
 204     {
 205       (void) unformat (input, str_match);
 206       return 1;
 207     }
 208
 209   return 0;
 210 }
 211
 212 u8 *
 213 format_transport_protos (u8 * s, va_list * args)
 214 {
 215   transport_proto_vft_t *tp_vft;
 216
 217   vec_foreach (tp_vft, tp_vfts)
 218     s = format (s, "%s\n", tp_vft->transport_options.name);
 219
 220   return s;
 221 }
 222
 223 u32
 224 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
 225                            ip46_address_t * ip, u16 port)
 226 {
 227   clib_bihash_kv_24_8_t kv;
 228   int rv;
 229
 230   kv.key[0] = ip->as_u64[0];
 231   kv.key[1] = ip->as_u64[1];
 232   kv.key[2] = (u64) port << 8 | (u64) proto;
 233
 234   rv = clib_bihash_search_inline_24_8 (ht, &kv);
 235   if (rv == 0)
 236     return kv.value;
 237
 238   return ENDPOINT_INVALID_INDEX;
 239 }
 240
 241 void
 242 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
 243                               transport_endpoint_t * te, u32 value)
 244 {
 245   clib_bihash_kv_24_8_t kv;
 246
 247   kv.key[0] = te->ip.as_u64[0];
 248   kv.key[1] = te->ip.as_u64[1];
 249   kv.key[2] = (u64) te->port << 8 | (u64) proto;
 250   kv.value = value;
 251
 252   clib_bihash_add_del_24_8 (ht, &kv, 1);
 253 }
 254
 255 void
 256 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
 257                               transport_endpoint_t * te)
 258 {
 259   clib_bihash_kv_24_8_t kv;
 260
 261   kv.key[0] = te->ip.as_u64[0];
 262   kv.key[1] = te->ip.as_u64[1];
 263   kv.key[2] = (u64) te->port << 8 | (u64) proto;
 264
 265   clib_bihash_add_del_24_8 (ht, &kv, 0);
 266 }
 267
 268 void
 269 transport_register_protocol (transport_proto_t transport_proto,
 270                              const transport_proto_vft_t * vft,
 271                              fib_protocol_t fib_proto, u32 output_node)
 272 {
 273   u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
 274
 275   vec_validate (tp_vfts, transport_proto);
 276   tp_vfts[transport_proto] = *vft;
 277
 278   session_register_transport (transport_proto, vft, is_ip4, output_node);
 279 }
 280
 281 transport_proto_t
 282 transport_register_new_protocol (const transport_proto_vft_t * vft,
 283                                  fib_protocol_t fib_proto, u32 output_node)
 284 {
 285   transport_proto_t transport_proto;
 286   u8 is_ip4;
 287
 288   transport_proto = session_add_transport_proto ();
 289   is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
 290
 291   vec_validate (tp_vfts, transport_proto);
 292   tp_vfts[transport_proto] = *vft;
 293
 294   session_register_transport (transport_proto, vft, is_ip4, output_node);
 295
 296   return transport_proto;
 297 }
 298
 299 /**
 300  * Get transport virtual function table
 301  *
 302  * @param type - session type (not protocol type)
 303  */
 304 transport_proto_vft_t *
 305 transport_protocol_get_vft (transport_proto_t transport_proto)
 306 {
 307   if (transport_proto >= vec_len (tp_vfts))
 308     return 0;
 309   return &tp_vfts[transport_proto];
 310 }
 311
 312 transport_service_type_t
 313 transport_protocol_service_type (transport_proto_t tp)
 314 {
 315   return tp_vfts[tp].transport_options.service_type;
 316 }
 317
 318 transport_tx_fn_type_t
 319 transport_protocol_tx_fn_type (transport_proto_t tp)
 320 {
 321   return tp_vfts[tp].transport_options.tx_type;
 322 }
 323
 324 void
 325 transport_cleanup (transport_proto_t tp, u32 conn_index, u8 thread_index)
 326 {
 327   tp_vfts[tp].cleanup (conn_index, thread_index);
 328 }
 329
 330 void
 331 transport_cleanup_half_open (transport_proto_t tp, u32 conn_index)
 332 {
 333   if (tp_vfts[tp].cleanup_ho)
 334     tp_vfts[tp].cleanup_ho (conn_index);
 335 }
 336
 337 int
 338 transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep)
 339 {
 340   if (PREDICT_FALSE (!tp_vfts[tp].connect))
 341     return SESSION_E_TRANSPORT_NO_REG;
 342   return tp_vfts[tp].connect (tep);
 343 }
 344
 345 void
 346 transport_half_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
 347 {
 348   if (tp_vfts[tp].half_close)
 349     tp_vfts[tp].half_close (conn_index, thread_index);
 350 }
 351
 352 void
 353 transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
 354 {
 355   tp_vfts[tp].close (conn_index, thread_index);
 356 }
 357
 358 void
 359 transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index)
 360 {
 361   if (tp_vfts[tp].reset)
 362     tp_vfts[tp].reset (conn_index, thread_index);
 363   else
 364     tp_vfts[tp].close (conn_index, thread_index);
 365 }
 366
 367 u32
 368 transport_start_listen (transport_proto_t tp, u32 session_index,
 369                         transport_endpoint_cfg_t *tep)
 370 {
 371   if (PREDICT_FALSE (!tp_vfts[tp].start_listen))
 372     return SESSION_E_TRANSPORT_NO_REG;
 373   return tp_vfts[tp].start_listen (session_index, tep);
 374 }
 375
 376 u32
 377 transport_stop_listen (transport_proto_t tp, u32 conn_index)
 378 {
 379   return tp_vfts[tp].stop_listen (conn_index);
 380 }
 381
 382 u8
 383 transport_protocol_is_cl (transport_proto_t tp)
 384 {
 385   return (tp_vfts[tp].transport_options.service_type == TRANSPORT_SERVICE_CL);
 386 }
 387
 388 always_inline void
 389 default_get_transport_endpoint (transport_connection_t * tc,
 390                                 transport_endpoint_t * tep, u8 is_lcl)
 391 {
 392   if (is_lcl)
 393     {
 394       tep->port = tc->lcl_port;
 395       tep->is_ip4 = tc->is_ip4;
 396       clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
 397     }
 398   else
 399     {
 400       tep->port = tc->rmt_port;
 401       tep->is_ip4 = tc->is_ip4;
 402       clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
 403     }
 404 }
 405
 406 void
 407 transport_get_endpoint (transport_proto_t tp, u32 conn_index,
 408                         u32 thread_index, transport_endpoint_t * tep,
 409                         u8 is_lcl)
 410 {
 411   if (tp_vfts[tp].get_transport_endpoint)
 412     tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
 413                                         is_lcl);
 414   else
 415     {
 416       transport_connection_t *tc;
 417       tc = transport_get_connection (tp, conn_index, thread_index);
 418       default_get_transport_endpoint (tc, tep, is_lcl);
 419     }
 420 }
 421
 422 void
 423 transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
 424                                  transport_endpoint_t * tep, u8 is_lcl)
 425 {
 426   if (tp_vfts[tp].get_transport_listener_endpoint)
 427     tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
 428   else
 429     {
 430       transport_connection_t *tc;
 431       tc = transport_get_listener (tp, conn_index);
 432       default_get_transport_endpoint (tc, tep, is_lcl);
 433     }
 434 }
 435
 436 int
 437 transport_connection_attribute (transport_proto_t tp, u32 conn_index,
 438                                 u8 thread_index, u8 is_get,
 439                                 transport_endpt_attr_t *attr)
 440 {
 441   if (!tp_vfts[tp].attribute)
 442     return -1;
 443
 444   return tp_vfts[tp].attribute (conn_index, thread_index, is_get, attr);
 445 }
 446
 447 #define PORT_MASK ((1 << 16)- 1)
 448
 449 void
 450 transport_endpoint_free (u32 tepi)
 451 {
 452   transport_main_t *tm = &tp_main;
 453   pool_put_index (tm->local_endpoints, tepi);
 454 }
 455
 456 always_inline local_endpoint_t *
 457 transport_endpoint_alloc (void)
 458 {
 459   transport_main_t *tm = &tp_main;
 460   local_endpoint_t *lep;
 461
 462   ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
 463
 464   pool_get_aligned_safe (tm->local_endpoints, lep, 0);
 465   return lep;
 466 }
 467
 468 static void
 469 transport_cleanup_freelist (void)
 470 {
 471   transport_main_t *tm = &tp_main;
 472   local_endpoint_t *lep;
 473   u32 *lep_indexp;
 474
 475   clib_spinlock_lock (&tm->local_endpoints_lock);
 476
 477   vec_foreach (lep_indexp, tm->lcl_endpts_freelist)
 478     {
 479       lep = pool_elt_at_index (tm->local_endpoints, *lep_indexp);
 480
 481       /* Port re-shared after attempt to cleanup */
 482       if (lep->refcnt > 0)
 483         continue;
 484
 485       transport_endpoint_table_del (&tm->local_endpoints_table, lep->proto,
 486                                     &lep->ep);
 487       transport_endpoint_free (*lep_indexp);
 488     }
 489
 490   vec_reset_length (tm->lcl_endpts_freelist);
 491
 492   tm->lcl_endpts_cleanup_pending = 0;
 493
 494   clib_spinlock_unlock (&tm->local_endpoints_lock);
 495 }
 496
 497 void
 498 transport_program_endpoint_cleanup (u32 lepi)
 499 {
 500   transport_main_t *tm = &tp_main;
 501   u8 flush_fl = 0;
 502
 503   /* All workers can free connections. Synchronize access to freelist */
 504   clib_spinlock_lock (&tm->local_endpoints_lock);
 505
 506   vec_add1 (tm->lcl_endpts_freelist, lepi);
 507
 508   /* Avoid accumulating lots of endpoints for cleanup */
 509   if (!tm->lcl_endpts_cleanup_pending &&
 510       vec_len (tm->lcl_endpts_freelist) > 32)
 511     {
 512       tm->lcl_endpts_cleanup_pending = 1;
 513       flush_fl = 1;
 514     }
 515
 516   clib_spinlock_unlock (&tm->local_endpoints_lock);
 517
 518   if (flush_fl)
 519     session_send_rpc_evt_to_thread_force (transport_cl_thread (),
 520                                           transport_cleanup_freelist, 0);
 521 }
 522
 523 int
 524 transport_release_local_endpoint (u8 proto, ip46_address_t *lcl_ip, u16 port)
 525 {
 526   transport_main_t *tm = &tp_main;
 527   local_endpoint_t *lep;
 528   u32 lepi;
 529
 530   lepi = transport_endpoint_lookup (&tm->local_endpoints_table, proto, lcl_ip,
 531                                     port);
 532   if (lepi == ENDPOINT_INVALID_INDEX)
 533     return -1;
 534
 535   /* First worker may be cleaning up ports so avoid touching free bitmap */
 536   lep = &tm->local_endpoints[lepi];
 537   ASSERT (lep->refcnt >= 1);
 538
 539   /* Local endpoint no longer in use, program cleanup */
 540   if (!clib_atomic_sub_fetch (&lep->refcnt, 1))
 541     {
 542       transport_program_endpoint_cleanup (lepi);
 543       return 0;
 544     }
 545
 546   /* Not an error, just in idication that endpoint was not cleaned up */
 547   return -1;
 548 }
 549
 550 static int
 551 transport_endpoint_mark_used (u8 proto, ip46_address_t *ip, u16 port)
 552 {
 553   transport_main_t *tm = &tp_main;
 554   local_endpoint_t *lep;
 555   u32 tei;
 556
 557   ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
 558
 559   tei =
 560     transport_endpoint_lookup (&tm->local_endpoints_table, proto, ip, port);
 561   if (tei != ENDPOINT_INVALID_INDEX)
 562     return SESSION_E_PORTINUSE;
 563
 564   /* Pool reallocs with worker barrier */
 565   lep = transport_endpoint_alloc ();
 566   clib_memcpy_fast (&lep->ep.ip, ip, sizeof (*ip));
 567   lep->ep.port = port;
 568   lep->proto = proto;
 569   lep->refcnt = 1;
 570
 571   transport_endpoint_table_add (&tm->local_endpoints_table, proto, &lep->ep,
 572                                 lep - tm->local_endpoints);
 573
 574   return 0;
 575 }
 576
 577 void
 578 transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip, u16 port)
 579 {
 580   transport_main_t *tm = &tp_main;
 581   local_endpoint_t *lep;
 582   u32 lepi;
 583
 584   /* Active opens should call this only from a control thread, which are also
 585    * used to allocate and free ports. So, pool has only one writer and
 586    * potentially many readers. Listeners are allocated with barrier */
 587   lepi = transport_endpoint_lookup (&tm->local_endpoints_table, proto, lcl_ip,
 588                                     port);
 589   if (lepi != ENDPOINT_INVALID_INDEX)
 590     {
 591       lep = pool_elt_at_index (tm->local_endpoints, lepi);
 592       clib_atomic_add_fetch (&lep->refcnt, 1);
 593     }
 594 }
 595
 596 /**
 597  * Allocate local port and add if successful add entry to local endpoint
 598  * table to mark the pair as used.
 599  *
 600  * @return port in net order or -1 if port cannot be allocated
 601  */
 602 int
 603 transport_alloc_local_port (u8 proto, ip46_address_t *lcl_addr,
 604                             transport_endpoint_cfg_t *rmt)
 605 {
 606   transport_main_t *tm = &tp_main;
 607   u16 min = tm->port_allocator_min_src_port;
 608   u16 max = tm->port_allocator_max_src_port;
 609   int tries, limit;
 610
 611   limit = max - min;
 612
 613   /* Only support active opens from one of ctrl threads */
 614   ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
 615
 616   /* Search for first free slot */
 617   for (tries = 0; tries < limit; tries++)
 618     {
 619       u16 port = 0;
 620
 621       /* Find a port in the specified range */
 622       while (1)
 623         {
 624           port = random_u32 (&tm->port_allocator_seed) & PORT_MASK;
 625           if (PREDICT_TRUE (port >= min && port < max))
 626             {
 627               port = clib_host_to_net_u16 (port);
 628               break;
 629             }
 630         }
 631
 632       if (!transport_endpoint_mark_used (proto, lcl_addr, port))
 633         return port;
 634
 635       /* IP:port pair already in use, check if 6-tuple available */
 636       if (session_lookup_connection (rmt->fib_index, lcl_addr, &rmt->ip, port,
 637                                      rmt->port, proto, rmt->is_ip4))
 638         continue;
 639
 640       /* 6-tuple is available so increment lcl endpoint refcount */
 641       transport_share_local_endpoint (proto, lcl_addr, port);
 642
 643       return port;
 644     }
 645   return -1;
 646 }
 647
 648 static session_error_t
 649 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
 650 {
 651   if (is_ip4)
 652     {
 653       ip4_address_t *ip4;
 654       ip4 = ip_interface_get_first_ip (sw_if_index, 1);
 655       if (!ip4)
 656         return SESSION_E_NOIP;
 657       addr->ip4.as_u32 = ip4->as_u32;
 658     }
 659   else
 660     {
 661       ip6_address_t *ip6;
 662       ip6 = ip_interface_get_first_ip (sw_if_index, 0);
 663       if (ip6 == 0)
 664         return SESSION_E_NOIP;
 665       clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
 666     }
 667   return 0;
 668 }
 669
 670 static session_error_t
 671 transport_find_local_ip_for_remote (u32 *sw_if_index,
 672                                     transport_endpoint_t *rmt,
 673                                     ip46_address_t *lcl_addr)
 674 {
 675   fib_node_index_t fei;
 676   fib_prefix_t prefix;
 677
 678   if (*sw_if_index == ENDPOINT_INVALID_INDEX)
 679     {
 680       /* Find a FIB path to the destination */
 681       clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
 682       prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 683       prefix.fp_len = rmt->is_ip4 ? 32 : 128;
 684
 685       ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
 686       fei = fib_table_lookup (rmt->fib_index, &prefix);
 687
 688       /* Couldn't find route to destination. Bail out. */
 689       if (fei == FIB_NODE_INDEX_INVALID)
 690         return SESSION_E_NOROUTE;
 691
 692       *sw_if_index = fib_entry_get_resolving_interface (fei);
 693       if (*sw_if_index == ENDPOINT_INVALID_INDEX)
 694         return SESSION_E_NOINTF;
 695     }
 696
 697   clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
 698   return transport_get_interface_ip (*sw_if_index, rmt->is_ip4, lcl_addr);
 699 }
 700
 701 int
 702 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
 703                                 ip46_address_t * lcl_addr, u16 * lcl_port)
 704 {
 705   transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
 706   transport_main_t *tm = &tp_main;
 707   session_error_t error;
 708   int port;
 709
 710   /*
 711    * Find the local address
 712    */
 713   if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
 714     {
 715       error = transport_find_local_ip_for_remote (&rmt_cfg->peer.sw_if_index,
 716                                                   rmt, lcl_addr);
 717       if (error)
 718         return error;
 719     }
 720   else
 721     {
 722       /* Assume session layer vetted this address */
 723       clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
 724                         sizeof (rmt_cfg->peer.ip));
 725     }
 726
 727   /* Cleanup freelist if need be */
 728   if (vec_len (tm->lcl_endpts_freelist))
 729     transport_cleanup_freelist ();
 730
 731   /*
 732    * Allocate source port
 733    */
 734   if (rmt_cfg->peer.port == 0)
 735     {
 736       port = transport_alloc_local_port (proto, lcl_addr, rmt_cfg);
 737       if (port < 1)
 738         return SESSION_E_NOPORT;
 739       *lcl_port = port;
 740     }
 741   else
 742     {
 743       *lcl_port = rmt_cfg->peer.port;
 744
 745       if (!transport_endpoint_mark_used (proto, lcl_addr, rmt_cfg->peer.port))
 746         return 0;
 747
 748       /* IP:port pair already in use, check if 6-tuple available */
 749       if (session_lookup_connection (rmt->fib_index, lcl_addr, &rmt->ip,
 750                                      rmt_cfg->peer.port, rmt->port, proto,
 751                                      rmt->is_ip4))
 752         return SESSION_E_PORTINUSE;
 753
 754       /* 6-tuple is available so increment lcl endpoint refcount */
 755       transport_share_local_endpoint (proto, lcl_addr, rmt_cfg->peer.port);
 756
 757       return 0;
 758     }
 759
 760   return 0;
 761 }
 762
 763 u8 *
 764 format_clib_us_time (u8 * s, va_list * args)
 765 {
 766   clib_us_time_t t = va_arg (*args, clib_us_time_t);
 767   if (t < 1e3)
 768     s = format (s, "%u us", t);
 769   else
 770     s = format (s, "%.3f s", (f64) t * CLIB_US_TIME_PERIOD);
 771   return s;
 772 }
 773
 774 u8 *
 775 format_transport_pacer (u8 * s, va_list * args)
 776 {
 777   spacer_t *pacer = va_arg (*args, spacer_t *);
 778   u32 thread_index = va_arg (*args, int);
 779   clib_us_time_t now, diff;
 780
 781   now = transport_us_time_now (thread_index);
 782   diff = now - pacer->last_update;
 783   s = format (s, "rate %lu bucket %ld t/p %.3f last_update %U burst %u",
 784               pacer->bytes_per_sec, pacer->bucket, pacer->tokens_per_period,
 785               format_clib_us_time, diff, pacer->max_burst);
 786   return s;
 787 }
 788
 789 static inline u32
 790 spacer_max_burst (spacer_t * pacer, clib_us_time_t time_now)
 791 {
 792   u64 n_periods = (time_now - pacer->last_update);
 793   i64 inc;
 794
 795   if ((inc = (f32) n_periods * pacer->tokens_per_period) > 10)
 796     {
 797       pacer->last_update = time_now;
 798       pacer->bucket = clib_min (pacer->bucket + inc, (i64) pacer->max_burst);
 799     }
 800
 801   return pacer->bucket >= 0 ? pacer->max_burst : 0;
 802 }
 803
 804 static inline void
 805 spacer_update_bucket (spacer_t * pacer, u32 bytes)
 806 {
 807   pacer->bucket -= bytes;
 808 }
 809
 810 static inline void
 811 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec,
 812                       clib_us_time_t rtt, clib_time_type_t sec_per_loop)
 813 {
 814   clib_us_time_t max_time;
 815
 816   ASSERT (rate_bytes_per_sec != 0);
 817   pacer->bytes_per_sec = rate_bytes_per_sec;
 818   pacer->tokens_per_period = rate_bytes_per_sec * CLIB_US_TIME_PERIOD;
 819
 820   /* Allow a min number of bursts per rtt, if their size is acceptable. Goal
 821    * is to spread the sending of data over the rtt but to also allow for some
 822    * coalescing that can potentially
 823    * 1) reduce load on session layer by reducing scheduling frequency for a
 824    *    session and
 825    * 2) optimize sending when tso if available
 826    *
 827    * Max "time-length" of a burst cannot be less than 1us or more than 1ms.
 828    */
 829   max_time = clib_max (rtt / TRANSPORT_PACER_BURSTS_PER_RTT,
 830                        (clib_us_time_t) (sec_per_loop * CLIB_US_TIME_FREQ));
 831   max_time = clib_clamp (max_time, 1 /* 1us */ , 1000 /* 1ms */ );
 832   pacer->max_burst = (rate_bytes_per_sec * max_time) * CLIB_US_TIME_PERIOD;
 833   pacer->max_burst = clib_clamp (pacer->max_burst, TRANSPORT_PACER_MIN_BURST,
 834                                  TRANSPORT_PACER_MAX_BURST);
 835 }
 836
 837 static inline u64
 838 spacer_pace_rate (spacer_t * pacer)
 839 {
 840   return pacer->bytes_per_sec;
 841 }
 842
 843 static inline void
 844 spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
 845 {
 846   pacer->last_update = time_now;
 847   pacer->bucket = bucket;
 848 }
 849
 850 void
 851 transport_connection_tx_pacer_reset (transport_connection_t * tc,
 852                                      u64 rate_bytes_per_sec, u32 start_bucket,
 853                                      clib_us_time_t rtt)
 854 {
 855   spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec, rtt,
 856                         transport_seconds_per_loop (tc->thread_index));
 857   spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
 858                 start_bucket);
 859 }
 860
 861 void
 862 transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
 863                                             u32 bucket)
 864 {
 865   spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index), bucket);
 866 }
 867
 868 void
 869 transport_connection_tx_pacer_init (transport_connection_t * tc,
 870                                     u64 rate_bytes_per_sec,
 871                                     u32 initial_bucket)
 872 {
 873   tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
 874   transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
 875                                        initial_bucket, 1e6);
 876 }
 877
 878 void
 879 transport_connection_tx_pacer_update (transport_connection_t * tc,
 880                                       u64 bytes_per_sec, clib_us_time_t rtt)
 881 {
 882   spacer_set_pace_rate (&tc->pacer, bytes_per_sec, rtt,
 883                         transport_seconds_per_loop (tc->thread_index));
 884 }
 885
 886 u32
 887 transport_connection_tx_pacer_burst (transport_connection_t * tc)
 888 {
 889   return spacer_max_burst (&tc->pacer,
 890                            transport_us_time_now (tc->thread_index));
 891 }
 892
 893 u64
 894 transport_connection_tx_pacer_rate (transport_connection_t * tc)
 895 {
 896   return spacer_pace_rate (&tc->pacer);
 897 }
 898
 899 void
 900 transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes)
 901 {
 902   if (transport_connection_is_tx_paced (tc))
 903     spacer_update_bucket (&tc->pacer, bytes);
 904 }
 905
 906 void
 907 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
 908                                             u32 bytes)
 909 {
 910   spacer_update_bucket (&tc->pacer, bytes);
 911 }
 912
 913 void
 914 transport_update_pacer_time (u32 thread_index, clib_time_type_t now)
 915 {
 916   session_wrk_update_time (session_main_get_worker (thread_index), now);
 917 }
 918
 919 void
 920 transport_connection_reschedule (transport_connection_t * tc)
 921 {
 922   tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
 923   transport_connection_tx_pacer_reset_bucket (tc, 0 /* bucket */);
 924   if (transport_max_tx_dequeue (tc))
 925     sesssion_reschedule_tx (tc);
 926   else
 927     {
 928       session_t *s = session_get (tc->s_index, tc->thread_index);
 929       svm_fifo_unset_event (s->tx_fifo);
 930       if (svm_fifo_max_dequeue_cons (s->tx_fifo))
 931         if (svm_fifo_set_event (s->tx_fifo))
 932           sesssion_reschedule_tx (tc);
 933     }
 934 }
 935
 936 void
 937 transport_fifos_init_ooo (transport_connection_t * tc)
 938 {
 939   session_t *s = session_get (tc->s_index, tc->thread_index);
 940   svm_fifo_init_ooo_lookup (s->rx_fifo, 0 /* ooo enq */ );
 941   svm_fifo_init_ooo_lookup (s->tx_fifo, 1 /* ooo deq */ );
 942 }
 943
 944 void
 945 transport_update_time (clib_time_type_t time_now, u8 thread_index)
 946 {
 947   transport_proto_vft_t *vft;
 948   vec_foreach (vft, tp_vfts)
 949   {
 950     if (vft->update_time)
 951       (vft->update_time) (time_now, thread_index);
 952   }
 953 }
 954
 955 void
 956 transport_enable_disable (vlib_main_t * vm, u8 is_en)
 957 {
 958   transport_proto_vft_t *vft;
 959   vec_foreach (vft, tp_vfts)
 960   {
 961     if (vft->enable)
 962       (vft->enable) (vm, is_en);
 963
 964     if (vft->update_time)
 965       session_register_update_time_fn (vft->update_time, is_en);
 966   }
 967 }
 968
 969 void
 970 transport_init (void)
 971 {
 972   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 973   session_main_t *smm = vnet_get_session_main ();
 974   transport_main_t *tm = &tp_main;
 975   u32 num_threads;
 976
 977   if (smm->local_endpoints_table_buckets == 0)
 978     smm->local_endpoints_table_buckets = 250000;
 979   if (smm->local_endpoints_table_memory == 0)
 980     smm->local_endpoints_table_memory = 512 << 20;
 981
 982   /* Initialize [port-allocator] random number seed */
 983   tm->port_allocator_seed = (u32) clib_cpu_time_now ();
 984   tm->port_allocator_min_src_port = smm->port_allocator_min_src_port;
 985   tm->port_allocator_max_src_port = smm->port_allocator_max_src_port;
 986
 987   clib_bihash_init_24_8 (&tm->local_endpoints_table, "local endpoints table",
 988                          smm->local_endpoints_table_buckets,
 989                          smm->local_endpoints_table_memory);
 990   clib_spinlock_init (&tm->local_endpoints_lock);
 991
 992   num_threads = 1 /* main thread */  + vtm->n_threads;
 993   if (num_threads > 1)
 994     {
 995       /* Main not polled if there are workers */
 996       smm->transport_cl_thread = 1;
 997     }
 998 }
 999
1000 /*
1001  * fd.io coding-style-patch-verification: ON
1002  *
1003  * Local Variables:
1004  * eval: (c-set-style "gnu")
1005  * End:
1006  */