src/vnet/session/application_local.c

   1 /*
   2  * Copyright (c) 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/application_local.h>
  17 #include <vnet/session/session.h>
  18
  19 static ct_connection_t *connections;
  20
  21 static void
  22 ct_enable_disable_main_pre_input_node (u8 is_add)
  23 {
  24   u32 n_conns;
  25
  26   if (!vlib_num_workers ())
  27     return;
  28
  29   n_conns = pool_elts (connections);
  30   if (n_conns > 2)
  31     return;
  32
  33   if (n_conns > 0 && is_add)
  34     vlib_node_set_state (vlib_get_main (),
  35                          session_queue_pre_input_node.index,
  36                          VLIB_NODE_STATE_POLLING);
  37   else if (n_conns == 0)
  38     vlib_node_set_state (vlib_get_main (),
  39                          session_queue_pre_input_node.index,
  40                          VLIB_NODE_STATE_DISABLED);
  41 }
  42
  43 static ct_connection_t *
  44 ct_connection_alloc (void)
  45 {
  46   ct_connection_t *ct;
  47
  48   pool_get_zero (connections, ct);
  49   ct->c_c_index = ct - connections;
  50   ct->c_thread_index = 0;
  51   ct->client_wrk = ~0;
  52   ct->server_wrk = ~0;
  53   return ct;
  54 }
  55
  56 static ct_connection_t *
  57 ct_connection_get (u32 ct_index)
  58 {
  59   if (pool_is_free_index (connections, ct_index))
  60     return 0;
  61   return pool_elt_at_index (connections, ct_index);
  62 }
  63
  64 static void
  65 ct_connection_free (ct_connection_t * ct)
  66 {
  67   if (CLIB_DEBUG)
  68     memset (ct, 0xfc, sizeof (*ct));
  69   pool_put (connections, ct);
  70 }
  71
  72 session_t *
  73 ct_session_get_peer (session_t * s)
  74 {
  75   ct_connection_t *ct, *peer_ct;
  76   ct = ct_connection_get (s->connection_index);
  77   peer_ct = ct_connection_get (ct->peer_index);
  78   return session_get (peer_ct->c_s_index, 0);
  79 }
  80
  81 void
  82 ct_session_endpoint (session_t * ll, session_endpoint_t * sep)
  83 {
  84   ct_connection_t *ct;
  85   ct = (ct_connection_t *) session_get_transport (ll);
  86   sep->transport_proto = ct->actual_tp;
  87   sep->port = ct->c_lcl_port;
  88   sep->is_ip4 = ct->c_is_ip4;
  89   ip_copy (&sep->ip, &ct->c_lcl_ip, ct->c_is_ip4);
  90 }
  91
  92 int
  93 ct_session_connect_notify (session_t * ss)
  94 {
  95   ct_connection_t *sct, *cct;
  96   app_worker_t *client_wrk;
  97   segment_manager_t *sm;
  98   u32 ss_index, opaque;
  99   fifo_segment_t *seg;
 100   u64 segment_handle;
 101   int err = 0;
 102   session_t *cs;
 103
 104   ss_index = ss->session_index;
 105   sct = (ct_connection_t *) session_get_transport (ss);
 106   client_wrk = app_worker_get (sct->client_wrk);
 107   opaque = sct->client_opaque;
 108
 109   sm = segment_manager_get (ss->rx_fifo->segment_manager);
 110   seg = segment_manager_get_segment_w_lock (sm, ss->rx_fifo->segment_index);
 111   segment_handle = segment_manager_segment_handle (sm, seg);
 112
 113   if ((err = app_worker_add_segment_notify (client_wrk, segment_handle)))
 114     {
 115       clib_warning ("failed to notify client %u of new segment",
 116                     sct->client_wrk);
 117       segment_manager_segment_reader_unlock (sm);
 118       session_close (ss);
 119       goto error;
 120     }
 121   else
 122     {
 123       segment_manager_segment_reader_unlock (sm);
 124     }
 125
 126   /* Alloc client session */
 127   cct = ct_connection_get (sct->peer_index);
 128
 129   cs = session_alloc (0);
 130   ss = session_get (ss_index, 0);
 131   cs->session_type = ss->session_type;
 132   cs->connection_index = sct->c_c_index;
 133   cs->listener_handle = SESSION_INVALID_HANDLE;
 134   cs->session_state = SESSION_STATE_CONNECTING;
 135   cs->app_wrk_index = client_wrk->wrk_index;
 136   cs->connection_index = cct->c_c_index;
 137
 138   cct->c_s_index = cs->session_index;
 139   cct->client_rx_fifo = ss->tx_fifo;
 140   cct->client_tx_fifo = ss->rx_fifo;
 141
 142   cct->client_rx_fifo->refcnt++;
 143   cct->client_tx_fifo->refcnt++;
 144
 145   /* This will allocate fifos for the session. They won't be used for
 146    * exchanging data but they will be used to close the connection if
 147    * the segment manager/worker is freed */
 148   if ((err = app_worker_init_connected (client_wrk, cs)))
 149     {
 150       session_close (ss);
 151       session_free (cs);
 152       goto error;
 153     }
 154
 155   cs->session_state = SESSION_STATE_CONNECTING;
 156
 157   if (app_worker_connect_notify (client_wrk, cs, err, opaque))
 158     {
 159       session_close (ss);
 160       segment_manager_dealloc_fifos (cs->rx_fifo, cs->tx_fifo);
 161       session_free (cs);
 162       return -1;
 163     }
 164
 165   cs = session_get (cct->c_s_index, 0);
 166   cs->session_state = SESSION_STATE_READY;
 167
 168   return 0;
 169
 170 error:
 171   app_worker_connect_notify (client_wrk, 0, err, opaque);
 172   return -1;
 173 }
 174
 175 static int
 176 ct_init_local_session (app_worker_t * client_wrk, app_worker_t * server_wrk,
 177                        ct_connection_t * ct, session_t * ls, session_t * ll)
 178 {
 179   u32 round_rx_fifo_sz, round_tx_fifo_sz, sm_index, seg_size;
 180   segment_manager_props_t *props;
 181   application_t *server;
 182   segment_manager_t *sm;
 183   u32 margin = 16 << 10;
 184   fifo_segment_t *seg;
 185   u64 segment_handle;
 186   int seg_index, rv;
 187
 188   server = application_get (server_wrk->app_index);
 189
 190   props = application_segment_manager_properties (server);
 191   round_rx_fifo_sz = 1 << max_log2 (props->rx_fifo_size);
 192   round_tx_fifo_sz = 1 << max_log2 (props->tx_fifo_size);
 193   /* Increase size because of inefficient chunk allocations. Depending on
 194    * how data is consumed, it may happen that more chunks than needed are
 195    * allocated.
 196    * TODO should remove once allocations are done more efficiently */
 197   seg_size = 4 * (round_rx_fifo_sz + round_tx_fifo_sz + margin);
 198
 199   sm = app_worker_get_listen_segment_manager (server_wrk, ll);
 200   seg_index = segment_manager_add_segment (sm, seg_size);
 201   if (seg_index < 0)
 202     {
 203       clib_warning ("failed to add new cut-through segment");
 204       return seg_index;
 205     }
 206   seg = segment_manager_get_segment_w_lock (sm, seg_index);
 207
 208   rv = segment_manager_try_alloc_fifos (seg, ls->thread_index,
 209                                         props->rx_fifo_size,
 210                                         props->tx_fifo_size, &ls->rx_fifo,
 211                                         &ls->tx_fifo);
 212   if (rv)
 213     {
 214       clib_warning ("failed to add fifos in cut-through segment");
 215       segment_manager_segment_reader_unlock (sm);
 216       goto failed;
 217     }
 218
 219   sm_index = segment_manager_index (sm);
 220   ls->rx_fifo->master_session_index = ls->session_index;
 221   ls->tx_fifo->master_session_index = ls->session_index;
 222   ls->rx_fifo->segment_manager = sm_index;
 223   ls->tx_fifo->segment_manager = sm_index;
 224   ls->rx_fifo->segment_index = seg_index;
 225   ls->tx_fifo->segment_index = seg_index;
 226
 227   /* Disable ooo lookups on the cut-through fifos. TODO remove once init of
 228    * chunk lookup rbtrees is delegated to transports */
 229   svm_fifo_free_chunk_lookup (ls->tx_fifo);
 230
 231   segment_handle = segment_manager_segment_handle (sm, seg);
 232   if ((rv = app_worker_add_segment_notify (server_wrk, segment_handle)))
 233     {
 234       clib_warning ("failed to notify server of new segment");
 235       segment_manager_segment_reader_unlock (sm);
 236       goto failed;
 237     }
 238   segment_manager_segment_reader_unlock (sm);
 239   ct->segment_handle = segment_handle;
 240
 241   return 0;
 242
 243 failed:
 244   segment_manager_del_segment (sm, seg);
 245   return rv;
 246 }
 247
 248 static int
 249 ct_connect (app_worker_t * client_wrk, session_t * ll,
 250             session_endpoint_cfg_t * sep)
 251 {
 252   u32 cct_index, ll_index, ll_ct_index;
 253   ct_connection_t *sct, *cct, *ll_ct;
 254   app_worker_t *server_wrk;
 255   session_t *ss;
 256
 257   ll_index = ll->session_index;
 258   ll_ct_index = ll->connection_index;
 259
 260   cct = ct_connection_alloc ();
 261   cct_index = cct->c_c_index;
 262   sct = ct_connection_alloc ();
 263   ll_ct = ct_connection_get (ll_ct_index);
 264
 265   /*
 266    * Alloc and init client transport
 267    */
 268   cct = ct_connection_get (cct_index);
 269   cct->c_thread_index = 0;
 270   cct->c_rmt_port = sep->port;
 271   cct->c_lcl_port = 0;
 272   cct->c_is_ip4 = sep->is_ip4;
 273   clib_memcpy (&cct->c_rmt_ip, &sep->ip, sizeof (sep->ip));
 274   cct->actual_tp = ll_ct->actual_tp;
 275   cct->is_client = 1;
 276
 277   /*
 278    * Init server transport
 279    */
 280   sct->c_thread_index = 0;
 281   sct->c_rmt_port = 0;
 282   sct->c_lcl_port = ll_ct->c_lcl_port;
 283   sct->c_is_ip4 = sep->is_ip4;
 284   clib_memcpy (&sct->c_lcl_ip, &ll_ct->c_lcl_ip, sizeof (ll_ct->c_lcl_ip));
 285   sct->client_wrk = client_wrk->wrk_index;
 286   sct->c_proto = TRANSPORT_PROTO_NONE;
 287   sct->client_opaque = sep->opaque;
 288   sct->actual_tp = ll_ct->actual_tp;
 289
 290   sct->peer_index = cct->c_c_index;
 291   cct->peer_index = sct->c_c_index;
 292
 293   /*
 294    * Accept server session. Client session is created only after
 295    * server confirms accept.
 296    */
 297   ss = session_alloc (0);
 298   ll = listen_session_get (ll_index);
 299   ss->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
 300                                                      sct->c_is_ip4);
 301   ss->connection_index = sct->c_c_index;
 302   ss->listener_handle = listen_session_get_handle (ll);
 303   ss->session_state = SESSION_STATE_CREATED;
 304
 305   server_wrk = application_listener_select_worker (ll);
 306   ss->app_wrk_index = server_wrk->wrk_index;
 307
 308   sct->c_s_index = ss->session_index;
 309   sct->server_wrk = ss->app_wrk_index;
 310
 311   if (ct_init_local_session (client_wrk, server_wrk, sct, ss, ll))
 312     {
 313       ct_connection_free (sct);
 314       session_free (ss);
 315       return -1;
 316     }
 317
 318   ss->session_state = SESSION_STATE_ACCEPTING;
 319   if (app_worker_accept_notify (server_wrk, ss))
 320     {
 321       ct_connection_free (sct);
 322       segment_manager_dealloc_fifos (ss->rx_fifo, ss->tx_fifo);
 323       session_free (ss);
 324       return -1;
 325     }
 326
 327   cct->segment_handle = sct->segment_handle;
 328   ct_enable_disable_main_pre_input_node (1 /* is_add */ );
 329   return 0;
 330 }
 331
 332 static u32
 333 ct_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
 334 {
 335   session_endpoint_cfg_t *sep;
 336   ct_connection_t *ct;
 337
 338   sep = (session_endpoint_cfg_t *) tep;
 339   ct = ct_connection_alloc ();
 340   ct->server_wrk = sep->app_wrk_index;
 341   ct->c_is_ip4 = sep->is_ip4;
 342   clib_memcpy (&ct->c_lcl_ip, &sep->ip, sizeof (sep->ip));
 343   ct->c_lcl_port = sep->port;
 344   ct->c_s_index = app_listener_index;
 345   ct->actual_tp = sep->transport_proto;
 346   ct_enable_disable_main_pre_input_node (1 /* is_add */ );
 347   return ct->c_c_index;
 348 }
 349
 350 static u32
 351 ct_stop_listen (u32 ct_index)
 352 {
 353   ct_connection_t *ct;
 354   ct = ct_connection_get (ct_index);
 355   ct_connection_free (ct);
 356   ct_enable_disable_main_pre_input_node (0 /* is_add */ );
 357   return 0;
 358 }
 359
 360 static transport_connection_t *
 361 ct_listener_get (u32 ct_index)
 362 {
 363   return (transport_connection_t *) ct_connection_get (ct_index);
 364 }
 365
 366 static int
 367 ct_session_connect (transport_endpoint_cfg_t * tep)
 368 {
 369   session_endpoint_cfg_t *sep_ext;
 370   session_endpoint_t *sep;
 371   app_worker_t *app_wrk;
 372   session_handle_t lh;
 373   application_t *app;
 374   app_listener_t *al;
 375   u32 table_index;
 376   session_t *ll;
 377   u8 fib_proto;
 378
 379   sep_ext = (session_endpoint_cfg_t *) tep;
 380   sep = (session_endpoint_t *) tep;
 381   app_wrk = app_worker_get (sep_ext->app_wrk_index);
 382   app = application_get (app_wrk->app_index);
 383
 384   sep->transport_proto = sep_ext->original_tp;
 385   table_index = application_local_session_table (app);
 386   lh = session_lookup_local_endpoint (table_index, sep);
 387   if (lh == SESSION_DROP_HANDLE)
 388     return SESSION_E_FILTERED;
 389
 390   if (lh == SESSION_INVALID_HANDLE)
 391     goto global_scope;
 392
 393   ll = listen_session_get_from_handle (lh);
 394   al = app_listener_get_w_session (ll);
 395
 396   /*
 397    * Break loop if rule in local table points to connecting app. This
 398    * can happen if client is a generic proxy. Route connect through
 399    * global table instead.
 400    */
 401   if (al->app_index == app->app_index)
 402     goto global_scope;
 403
 404   return ct_connect (app_wrk, ll, sep_ext);
 405
 406   /*
 407    * If nothing found, check the global scope for locally attached
 408    * destinations. Make sure first that we're allowed to.
 409    */
 410
 411 global_scope:
 412   if (session_endpoint_is_local (sep))
 413     return SESSION_E_NOROUTE;
 414
 415   if (!application_has_global_scope (app))
 416     return SESSION_E_SCOPE;
 417
 418   fib_proto = session_endpoint_fib_proto (sep);
 419   table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
 420   ll = session_lookup_listener_wildcard (table_index, sep);
 421
 422   if (ll)
 423     return ct_connect (app_wrk, ll, sep_ext);
 424
 425   /* Failed to connect but no error */
 426   return 1;
 427 }
 428
 429 static void
 430 ct_session_close (u32 ct_index, u32 thread_index)
 431 {
 432   ct_connection_t *ct, *peer_ct;
 433   app_worker_t *app_wrk;
 434   session_t *s;
 435
 436   ct = ct_connection_get (ct_index);
 437   peer_ct = ct_connection_get (ct->peer_index);
 438   if (peer_ct)
 439     {
 440       peer_ct->peer_index = ~0;
 441       session_transport_closing_notify (&peer_ct->connection);
 442     }
 443
 444   s = session_get (ct->c_s_index, 0);
 445   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
 446   if (app_wrk)
 447     app_worker_del_segment_notify (app_wrk, ct->segment_handle);
 448   session_free_w_fifos (s);
 449   if (ct->is_client)
 450     segment_manager_dealloc_fifos (ct->client_rx_fifo, ct->client_tx_fifo);
 451
 452   ct_connection_free (ct);
 453   ct_enable_disable_main_pre_input_node (0 /* is_add */ );
 454 }
 455
 456 static transport_connection_t *
 457 ct_session_get (u32 ct_index, u32 thread_index)
 458 {
 459   return (transport_connection_t *) ct_connection_get (ct_index);
 460 }
 461
 462 static u8 *
 463 format_ct_connection_id (u8 * s, va_list * args)
 464 {
 465   ct_connection_t *ct = va_arg (*args, ct_connection_t *);
 466   if (!ct)
 467     return s;
 468   if (ct->c_is_ip4)
 469     {
 470       s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
 471                   ct->c_s_index, format_transport_proto_short, ct->actual_tp,
 472                   format_ip4_address, &ct->c_lcl_ip4,
 473                   clib_net_to_host_u16 (ct->c_lcl_port), format_ip4_address,
 474                   &ct->c_rmt_ip4, clib_net_to_host_u16 (ct->c_rmt_port));
 475     }
 476   else
 477     {
 478       s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
 479                   ct->c_s_index, format_transport_proto_short, ct->actual_tp,
 480                   format_ip6_address, &ct->c_lcl_ip6,
 481                   clib_net_to_host_u16 (ct->c_lcl_port), format_ip6_address,
 482                   &ct->c_rmt_ip6, clib_net_to_host_u16 (ct->c_rmt_port));
 483     }
 484
 485   return s;
 486 }
 487
 488 static int
 489 ct_custom_tx (void *session, transport_send_params_t * sp)
 490 {
 491   session_t *s = (session_t *) session;
 492   if (session_has_transport (s))
 493     return 0;
 494   /* As all other sessions, cut-throughs are scheduled by vpp for tx so let
 495    * the scheduler's custom tx logic decide when to deschedule, i.e., after
 496    * fifo is emptied. */
 497   return ct_session_tx (s);
 498 }
 499
 500 static int
 501 ct_app_rx_evt (transport_connection_t * tc)
 502 {
 503   ct_connection_t *ct = (ct_connection_t *) tc, *peer_ct;
 504   session_t *ps;
 505
 506   peer_ct = ct_connection_get (ct->peer_index);
 507   if (!peer_ct)
 508     return -1;
 509   ps = session_get (peer_ct->c_s_index, peer_ct->c_thread_index);
 510   return session_dequeue_notify (ps);
 511 }
 512
 513 static u8 *
 514 format_ct_listener (u8 * s, va_list * args)
 515 {
 516   u32 tc_index = va_arg (*args, u32);
 517   u32 __clib_unused thread_index = va_arg (*args, u32);
 518   u32 __clib_unused verbose = va_arg (*args, u32);
 519   ct_connection_t *ct = ct_connection_get (tc_index);
 520   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
 521   if (verbose)
 522     s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "LISTEN");
 523   return s;
 524 }
 525
 526 static u8 *
 527 format_ct_connection (u8 * s, va_list * args)
 528 {
 529   ct_connection_t *ct = va_arg (*args, ct_connection_t *);
 530   u32 verbose = va_arg (*args, u32);
 531
 532   if (!ct)
 533     return s;
 534   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
 535   if (verbose)
 536     {
 537       s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "ESTABLISHED");
 538       if (verbose > 1)
 539         {
 540           s = format (s, "\n");
 541         }
 542     }
 543   return s;
 544 }
 545
 546 static u8 *
 547 format_ct_session (u8 * s, va_list * args)
 548 {
 549   u32 ct_index = va_arg (*args, u32);
 550   u32 __clib_unused thread_index = va_arg (*args, u32);
 551   u32 verbose = va_arg (*args, u32);
 552   ct_connection_t *ct;
 553
 554   ct = ct_connection_get (ct_index);
 555   if (!ct)
 556     {
 557       s = format (s, "empty\n");
 558       return s;
 559     }
 560
 561   s = format (s, "%U", format_ct_connection, ct, verbose);
 562   return s;
 563 }
 564
 565 /* *INDENT-OFF* */
 566 static const transport_proto_vft_t cut_thru_proto = {
 567   .start_listen = ct_start_listen,
 568   .stop_listen = ct_stop_listen,
 569   .get_listener = ct_listener_get,
 570   .connect = ct_session_connect,
 571   .close = ct_session_close,
 572   .get_connection = ct_session_get,
 573   .custom_tx = ct_custom_tx,
 574   .app_rx_evt = ct_app_rx_evt,
 575   .format_listener = format_ct_listener,
 576   .format_connection = format_ct_session,
 577   .transport_options = {
 578     .name = "ct",
 579     .short_name = "C",
 580     .tx_type = TRANSPORT_TX_INTERNAL,
 581     .service_type = TRANSPORT_SERVICE_APP,
 582   },
 583 };
 584 /* *INDENT-ON* */
 585
 586 int
 587 ct_session_tx (session_t * s)
 588 {
 589   ct_connection_t *ct, *peer_ct;
 590   session_t *peer_s;
 591
 592   ct = (ct_connection_t *) session_get_transport (s);
 593   peer_ct = ct_connection_get (ct->peer_index);
 594   if (!peer_ct)
 595     return 0;
 596   peer_s = session_get (peer_ct->c_s_index, 0);
 597   if (peer_s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
 598     return 0;
 599   session_enqueue_notify (peer_s);
 600   /* The scheduler uses packet count as a means of upper bounding the amount
 601    * of work done per dispatch. So make it look like we have sent something */
 602   return 1;
 603 }
 604
 605 static clib_error_t *
 606 ct_transport_init (vlib_main_t * vm)
 607 {
 608   transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
 609                                FIB_PROTOCOL_IP4, ~0);
 610   transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
 611                                FIB_PROTOCOL_IP6, ~0);
 612   return 0;
 613 }
 614
 615 VLIB_INIT_FUNCTION (ct_transport_init);
 616
 617 /*
 618  * fd.io coding-style-patch-verification: ON
 619  *
 620  * Local Variables:
 621  * eval: (c-set-style "gnu")
 622  * End:
 623  */