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