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