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   if (PREDICT_FALSE (!tp_vfts[tp].connect))
 318     return SESSION_E_TRANSPORT_NO_REG;
 319   return tp_vfts[tp].connect (tep);
 320 }
 321
 322 void
 323 transport_half_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
 324 {
 325   if (tp_vfts[tp].half_close)
 326     tp_vfts[tp].half_close (conn_index, thread_index);
 327 }
 328
 329 void
 330 transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
 331 {
 332   tp_vfts[tp].close (conn_index, thread_index);
 333 }
 334
 335 void
 336 transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index)
 337 {
 338   if (tp_vfts[tp].reset)
 339     tp_vfts[tp].reset (conn_index, thread_index);
 340   else
 341     tp_vfts[tp].close (conn_index, thread_index);
 342 }
 343
 344 u32
 345 transport_start_listen (transport_proto_t tp, u32 session_index,
 346                         transport_endpoint_cfg_t *tep)
 347 {
 348   if (PREDICT_FALSE (!tp_vfts[tp].start_listen))
 349     return SESSION_E_TRANSPORT_NO_REG;
 350   return tp_vfts[tp].start_listen (session_index, tep);
 351 }
 352
 353 u32
 354 transport_stop_listen (transport_proto_t tp, u32 conn_index)
 355 {
 356   return tp_vfts[tp].stop_listen (conn_index);
 357 }
 358
 359 u8
 360 transport_protocol_is_cl (transport_proto_t tp)
 361 {
 362   return (tp_vfts[tp].transport_options.service_type == TRANSPORT_SERVICE_CL);
 363 }
 364
 365 always_inline void
 366 default_get_transport_endpoint (transport_connection_t * tc,
 367                                 transport_endpoint_t * tep, u8 is_lcl)
 368 {
 369   if (is_lcl)
 370     {
 371       tep->port = tc->lcl_port;
 372       tep->is_ip4 = tc->is_ip4;
 373       clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
 374     }
 375   else
 376     {
 377       tep->port = tc->rmt_port;
 378       tep->is_ip4 = tc->is_ip4;
 379       clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
 380     }
 381 }
 382
 383 void
 384 transport_get_endpoint (transport_proto_t tp, u32 conn_index,
 385                         u32 thread_index, transport_endpoint_t * tep,
 386                         u8 is_lcl)
 387 {
 388   if (tp_vfts[tp].get_transport_endpoint)
 389     tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
 390                                         is_lcl);
 391   else
 392     {
 393       transport_connection_t *tc;
 394       tc = transport_get_connection (tp, conn_index, thread_index);
 395       default_get_transport_endpoint (tc, tep, is_lcl);
 396     }
 397 }
 398
 399 void
 400 transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
 401                                  transport_endpoint_t * tep, u8 is_lcl)
 402 {
 403   if (tp_vfts[tp].get_transport_listener_endpoint)
 404     tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
 405   else
 406     {
 407       transport_connection_t *tc;
 408       tc = transport_get_listener (tp, conn_index);
 409       default_get_transport_endpoint (tc, tep, is_lcl);
 410     }
 411 }
 412
 413 int
 414 transport_connection_attribute (transport_proto_t tp, u32 conn_index,
 415                                 u8 thread_index, u8 is_get,
 416                                 transport_endpt_attr_t *attr)
 417 {
 418   if (!tp_vfts[tp].attribute)
 419     return -1;
 420
 421   return tp_vfts[tp].attribute (conn_index, thread_index, is_get, attr);
 422 }
 423
 424 #define PORT_MASK ((1 << 16)- 1)
 425
 426 void
 427 transport_endpoint_free (u32 tepi)
 428 {
 429   pool_put_index (local_endpoints, tepi);
 430 }
 431
 432 always_inline local_endpoint_t *
 433 transport_endpoint_alloc (void)
 434 {
 435   local_endpoint_t *lep;
 436
 437   ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
 438   pool_get_aligned_safe (local_endpoints, lep, 0);
 439   return lep;
 440 }
 441
 442 void
 443 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
 444 {
 445   local_endpoint_t *lep;
 446   u32 lepi;
 447
 448   /* Cleanup local endpoint if this was an active connect */
 449   lepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
 450                                     clib_net_to_host_u16 (port));
 451   if (lepi == ENDPOINT_INVALID_INDEX)
 452     return;
 453
 454   lep = pool_elt_at_index (local_endpoints, lepi);
 455   if (!clib_atomic_sub_fetch (&lep->refcnt, 1))
 456     {
 457       transport_endpoint_table_del (&local_endpoints_table, proto, &lep->ep);
 458
 459       /* All workers can free connections. Synchronize access to pool */
 460       clib_spinlock_lock (&local_endpoints_lock);
 461       transport_endpoint_free (lepi);
 462       clib_spinlock_unlock (&local_endpoints_lock);
 463     }
 464 }
 465
 466 static int
 467 transport_endpoint_mark_used (u8 proto, ip46_address_t *ip, u16 port)
 468 {
 469   local_endpoint_t *lep;
 470   u32 tei;
 471
 472   ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
 473
 474   tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip, port);
 475   if (tei != ENDPOINT_INVALID_INDEX)
 476     return SESSION_E_PORTINUSE;
 477
 478   /* Pool reallocs with worker barrier */
 479   lep = transport_endpoint_alloc ();
 480   clib_memcpy_fast (&lep->ep.ip, ip, sizeof (*ip));
 481   lep->ep.port = port;
 482   lep->refcnt = 1;
 483
 484   transport_endpoint_table_add (&local_endpoints_table, proto, &lep->ep,
 485                                 lep - local_endpoints);
 486
 487   return 0;
 488 }
 489
 490 void
 491 transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip, u16 port)
 492 {
 493   local_endpoint_t *lep;
 494   u32 lepi;
 495
 496   lepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
 497                                     clib_net_to_host_u16 (port));
 498   if (lepi != ENDPOINT_INVALID_INDEX)
 499     {
 500       lep = pool_elt_at_index (local_endpoints, lepi);
 501       clib_atomic_add_fetch (&lep->refcnt, 1);
 502     }
 503 }
 504
 505 /**
 506  * Allocate local port and add if successful add entry to local endpoint
 507  * table to mark the pair as used.
 508  */
 509 int
 510 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
 511 {
 512   u16 min = 1024, max = 65535;  /* XXX configurable ? */
 513   int tries, limit;
 514
 515   limit = max - min;
 516
 517   /* Only support active opens from one of ctrl threads */
 518   ASSERT (vlib_get_thread_index () <= transport_cl_thread ());
 519
 520   /* Search for first free slot */
 521   for (tries = 0; tries < limit; tries++)
 522     {
 523       u16 port = 0;
 524
 525       /* Find a port in the specified range */
 526       while (1)
 527         {
 528           port = random_u32 (&port_allocator_seed) & PORT_MASK;
 529           if (PREDICT_TRUE (port >= min && port < max))
 530             break;
 531         }
 532
 533       if (!transport_endpoint_mark_used (proto, ip, port))
 534         return port;
 535     }
 536   return -1;
 537 }
 538
 539 static session_error_t
 540 transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
 541 {
 542   if (is_ip4)
 543     {
 544       ip4_address_t *ip4;
 545       ip4 = ip_interface_get_first_ip (sw_if_index, 1);
 546       if (!ip4)
 547         return SESSION_E_NOIP;
 548       addr->ip4.as_u32 = ip4->as_u32;
 549     }
 550   else
 551     {
 552       ip6_address_t *ip6;
 553       ip6 = ip_interface_get_first_ip (sw_if_index, 0);
 554       if (ip6 == 0)
 555         return SESSION_E_NOIP;
 556       clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
 557     }
 558   return 0;
 559 }
 560
 561 static session_error_t
 562 transport_find_local_ip_for_remote (u32 *sw_if_index,
 563                                     transport_endpoint_t *rmt,
 564                                     ip46_address_t *lcl_addr)
 565 {
 566   fib_node_index_t fei;
 567   fib_prefix_t prefix;
 568
 569   if (*sw_if_index == ENDPOINT_INVALID_INDEX)
 570     {
 571       /* Find a FIB path to the destination */
 572       clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
 573       prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 574       prefix.fp_len = rmt->is_ip4 ? 32 : 128;
 575
 576       ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
 577       fei = fib_table_lookup (rmt->fib_index, &prefix);
 578
 579       /* Couldn't find route to destination. Bail out. */
 580       if (fei == FIB_NODE_INDEX_INVALID)
 581         return SESSION_E_NOROUTE;
 582
 583       *sw_if_index = fib_entry_get_resolving_interface (fei);
 584       if (*sw_if_index == ENDPOINT_INVALID_INDEX)
 585         return SESSION_E_NOINTF;
 586     }
 587
 588   clib_memset (lcl_addr, 0, sizeof (*lcl_addr));
 589   return transport_get_interface_ip (*sw_if_index, rmt->is_ip4, lcl_addr);
 590 }
 591
 592 int
 593 transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
 594                                 ip46_address_t * lcl_addr, u16 * lcl_port)
 595 {
 596   transport_endpoint_t *rmt = (transport_endpoint_t *) rmt_cfg;
 597   session_error_t error;
 598   int port;
 599
 600   /*
 601    * Find the local address
 602    */
 603   if (ip_is_zero (&rmt_cfg->peer.ip, rmt_cfg->peer.is_ip4))
 604     {
 605       error = transport_find_local_ip_for_remote (&rmt_cfg->peer.sw_if_index,
 606                                                   rmt, lcl_addr);
 607       if (error)
 608         return error;
 609     }
 610   else
 611     {
 612       /* Assume session layer vetted this address */
 613       clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
 614                         sizeof (rmt_cfg->peer.ip));
 615     }
 616
 617   /*
 618    * Allocate source port
 619    */
 620   if (rmt_cfg->peer.port == 0)
 621     {
 622       port = transport_alloc_local_port (proto, lcl_addr);
 623       if (port < 1)
 624         return SESSION_E_NOPORT;
 625       *lcl_port = port;
 626     }
 627   else
 628     {
 629       port = clib_net_to_host_u16 (rmt_cfg->peer.port);
 630       *lcl_port = port;
 631
 632       return transport_endpoint_mark_used (proto, lcl_addr, port);
 633     }
 634
 635   return 0;
 636 }
 637
 638 u8 *
 639 format_clib_us_time (u8 * s, va_list * args)
 640 {
 641   clib_us_time_t t = va_arg (*args, clib_us_time_t);
 642   if (t < 1e3)
 643     s = format (s, "%u us", t);
 644   else
 645     s = format (s, "%.3f s", (f64) t * CLIB_US_TIME_PERIOD);
 646   return s;
 647 }
 648
 649 u8 *
 650 format_transport_pacer (u8 * s, va_list * args)
 651 {
 652   spacer_t *pacer = va_arg (*args, spacer_t *);
 653   u32 thread_index = va_arg (*args, int);
 654   clib_us_time_t now, diff;
 655
 656   now = transport_us_time_now (thread_index);
 657   diff = now - pacer->last_update;
 658   s = format (s, "rate %lu bucket %ld t/p %.3f last_update %U burst %u",
 659               pacer->bytes_per_sec, pacer->bucket, pacer->tokens_per_period,
 660               format_clib_us_time, diff, pacer->max_burst);
 661   return s;
 662 }
 663
 664 static inline u32
 665 spacer_max_burst (spacer_t * pacer, clib_us_time_t time_now)
 666 {
 667   u64 n_periods = (time_now - pacer->last_update);
 668   i64 inc;
 669
 670   if ((inc = (f32) n_periods * pacer->tokens_per_period) > 10)
 671     {
 672       pacer->last_update = time_now;
 673       pacer->bucket = clib_min (pacer->bucket + inc, (i64) pacer->max_burst);
 674     }
 675
 676   return pacer->bucket >= 0 ? pacer->max_burst : 0;
 677 }
 678
 679 static inline void
 680 spacer_update_bucket (spacer_t * pacer, u32 bytes)
 681 {
 682   pacer->bucket -= bytes;
 683 }
 684
 685 static inline void
 686 spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec,
 687                       clib_us_time_t rtt, clib_time_type_t sec_per_loop)
 688 {
 689   clib_us_time_t max_time;
 690
 691   ASSERT (rate_bytes_per_sec != 0);
 692   pacer->bytes_per_sec = rate_bytes_per_sec;
 693   pacer->tokens_per_period = rate_bytes_per_sec * CLIB_US_TIME_PERIOD;
 694
 695   /* Allow a min number of bursts per rtt, if their size is acceptable. Goal
 696    * is to spread the sending of data over the rtt but to also allow for some
 697    * coalescing that can potentially
 698    * 1) reduce load on session layer by reducing scheduling frequency for a
 699    *    session and
 700    * 2) optimize sending when tso if available
 701    *
 702    * Max "time-length" of a burst cannot be less than 1us or more than 1ms.
 703    */
 704   max_time = clib_max (rtt / TRANSPORT_PACER_BURSTS_PER_RTT,
 705                        (clib_us_time_t) (sec_per_loop * CLIB_US_TIME_FREQ));
 706   max_time = clib_clamp (max_time, 1 /* 1us */ , 1000 /* 1ms */ );
 707   pacer->max_burst = (rate_bytes_per_sec * max_time) * CLIB_US_TIME_PERIOD;
 708   pacer->max_burst = clib_clamp (pacer->max_burst, TRANSPORT_PACER_MIN_BURST,
 709                                  TRANSPORT_PACER_MAX_BURST);
 710 }
 711
 712 static inline u64
 713 spacer_pace_rate (spacer_t * pacer)
 714 {
 715   return pacer->bytes_per_sec;
 716 }
 717
 718 static inline void
 719 spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
 720 {
 721   pacer->last_update = time_now;
 722   pacer->bucket = bucket;
 723 }
 724
 725 void
 726 transport_connection_tx_pacer_reset (transport_connection_t * tc,
 727                                      u64 rate_bytes_per_sec, u32 start_bucket,
 728                                      clib_us_time_t rtt)
 729 {
 730   spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec, rtt,
 731                         transport_seconds_per_loop (tc->thread_index));
 732   spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
 733                 start_bucket);
 734 }
 735
 736 void
 737 transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
 738                                             u32 bucket)
 739 {
 740   spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index), bucket);
 741 }
 742
 743 void
 744 transport_connection_tx_pacer_init (transport_connection_t * tc,
 745                                     u64 rate_bytes_per_sec,
 746                                     u32 initial_bucket)
 747 {
 748   tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
 749   transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
 750                                        initial_bucket, 1e6);
 751 }
 752
 753 void
 754 transport_connection_tx_pacer_update (transport_connection_t * tc,
 755                                       u64 bytes_per_sec, clib_us_time_t rtt)
 756 {
 757   spacer_set_pace_rate (&tc->pacer, bytes_per_sec, rtt,
 758                         transport_seconds_per_loop (tc->thread_index));
 759 }
 760
 761 u32
 762 transport_connection_tx_pacer_burst (transport_connection_t * tc)
 763 {
 764   return spacer_max_burst (&tc->pacer,
 765                            transport_us_time_now (tc->thread_index));
 766 }
 767
 768 u64
 769 transport_connection_tx_pacer_rate (transport_connection_t * tc)
 770 {
 771   return spacer_pace_rate (&tc->pacer);
 772 }
 773
 774 void
 775 transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes)
 776 {
 777   if (transport_connection_is_tx_paced (tc))
 778     spacer_update_bucket (&tc->pacer, bytes);
 779 }
 780
 781 void
 782 transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
 783                                             u32 bytes)
 784 {
 785   spacer_update_bucket (&tc->pacer, bytes);
 786 }
 787
 788 void
 789 transport_update_pacer_time (u32 thread_index, clib_time_type_t now)
 790 {
 791   session_wrk_update_time (session_main_get_worker (thread_index), now);
 792 }
 793
 794 void
 795 transport_connection_reschedule (transport_connection_t * tc)
 796 {
 797   tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
 798   transport_connection_tx_pacer_reset_bucket (tc, 0 /* bucket */);
 799   if (transport_max_tx_dequeue (tc))
 800     sesssion_reschedule_tx (tc);
 801   else
 802     {
 803       session_t *s = session_get (tc->s_index, tc->thread_index);
 804       svm_fifo_unset_event (s->tx_fifo);
 805       if (svm_fifo_max_dequeue_cons (s->tx_fifo))
 806         if (svm_fifo_set_event (s->tx_fifo))
 807           sesssion_reschedule_tx (tc);
 808     }
 809 }
 810
 811 void
 812 transport_fifos_init_ooo (transport_connection_t * tc)
 813 {
 814   session_t *s = session_get (tc->s_index, tc->thread_index);
 815   svm_fifo_init_ooo_lookup (s->rx_fifo, 0 /* ooo enq */ );
 816   svm_fifo_init_ooo_lookup (s->tx_fifo, 1 /* ooo deq */ );
 817 }
 818
 819 void
 820 transport_update_time (clib_time_type_t time_now, u8 thread_index)
 821 {
 822   transport_proto_vft_t *vft;
 823   vec_foreach (vft, tp_vfts)
 824   {
 825     if (vft->update_time)
 826       (vft->update_time) (time_now, thread_index);
 827   }
 828 }
 829
 830 void
 831 transport_enable_disable (vlib_main_t * vm, u8 is_en)
 832 {
 833   transport_proto_vft_t *vft;
 834   vec_foreach (vft, tp_vfts)
 835   {
 836     if (vft->enable)
 837       (vft->enable) (vm, is_en);
 838
 839     if (vft->update_time)
 840       session_register_update_time_fn (vft->update_time, is_en);
 841   }
 842 }
 843
 844 void
 845 transport_init (void)
 846 {
 847   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 848   session_main_t *smm = vnet_get_session_main ();
 849   u32 num_threads;
 850
 851   if (smm->local_endpoints_table_buckets == 0)
 852     smm->local_endpoints_table_buckets = 250000;
 853   if (smm->local_endpoints_table_memory == 0)
 854     smm->local_endpoints_table_memory = 512 << 20;
 855
 856   /* Initialize [port-allocator] random number seed */
 857   port_allocator_seed = (u32) clib_cpu_time_now ();
 858
 859   clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
 860                          smm->local_endpoints_table_buckets,
 861                          smm->local_endpoints_table_memory);
 862   clib_spinlock_init (&local_endpoints_lock);
 863
 864   num_threads = 1 /* main thread */  + vtm->n_threads;
 865   if (num_threads > 1)
 866     {
 867       /* Main not polled if there are workers */
 868       smm->transport_cl_thread = 1;
 869     }
 870 }
 871
 872 /*
 873  * fd.io coding-style-patch-verification: ON
 874  *
 875  * Local Variables:
 876  * eval: (c-set-style "gnu")
 877  * End:
 878  */