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 }
  90
  91 int
  92 ct_session_connect_notify (session_t * ss)
  93 {
  94   ct_connection_t *sct, *cct;
  95   app_worker_t *client_wrk;
  96   segment_manager_t *sm;
  97   fifo_segment_t *seg;
  98   u64 segment_handle;
  99   int is_fail = 0;
 100   session_t *cs;
 101   u32 ss_index;
 102
 103   ss_index = ss->session_index;
 104   sct = (ct_connection_t *) session_get_transport (ss);
 105   client_wrk = app_worker_get (sct->client_wrk);
 106
 107   sm = segment_manager_get (ss->rx_fifo->segment_manager);
 108   seg = segment_manager_get_segment_w_lock (sm, ss->rx_fifo->segment_index);
 109   segment_handle = segment_manager_segment_handle (sm, seg);
 110
 111   if (app_worker_add_segment_notify (client_wrk, segment_handle))
 112     {
 113       clib_warning ("failed to notify client %u of new segment",
 114                     sct->client_wrk);
 115       segment_manager_segment_reader_unlock (sm);
 116       session_close (ss);
 117       is_fail = 1;
 118     }
 119   else
 120     {
 121       segment_manager_segment_reader_unlock (sm);
 122     }
 123
 124   /* Alloc client session */
 125   cct = ct_connection_get (sct->peer_index);
 126
 127   cs = session_alloc (0);
 128   ss = session_get (ss_index, 0);
 129   cs->session_type = ss->session_type;
 130   cs->connection_index = sct->c_c_index;
 131   cs->listener_handle = SESSION_INVALID_HANDLE;
 132   cs->session_state = SESSION_STATE_CONNECTING;
 133   cs->app_wrk_index = client_wrk->wrk_index;
 134   cs->connection_index = cct->c_c_index;
 135
 136   cct->c_s_index = cs->session_index;
 137   cct->client_rx_fifo = ss->tx_fifo;
 138   cct->client_tx_fifo = ss->rx_fifo;
 139
 140   cct->client_rx_fifo->refcnt++;
 141   cct->client_tx_fifo->refcnt++;
 142
 143   /* This will allocate fifos for the session. They won't be used for
 144    * exchanging data but they will be used to close the connection if
 145    * the segment manager/worker is freed */
 146   if (app_worker_init_connected (client_wrk, cs))
 147     {
 148       session_close (ss);
 149       return -1;
 150     }
 151
 152   if (app_worker_connect_notify (client_wrk, is_fail ? 0 : cs,
 153                                  sct->client_opaque))
 154     {
 155       session_close (ss);
 156       return -1;
 157     }
 158
 159   cs = session_get (cct->c_s_index, 0);
 160   cs->session_state = SESSION_STATE_READY;
 161
 162   return 0;
 163 }
 164
 165 static int
 166 ct_init_local_session (app_worker_t * client_wrk, app_worker_t * server_wrk,
 167                        ct_connection_t * ct, session_t * ls, session_t * ll)
 168 {
 169   u32 round_rx_fifo_sz, round_tx_fifo_sz, sm_index, seg_size;
 170   segment_manager_props_t *props;
 171   application_t *server;
 172   segment_manager_t *sm;
 173   u32 margin = 16 << 10;
 174   fifo_segment_t *seg;
 175   u64 segment_handle;
 176   int seg_index, rv;
 177
 178   server = application_get (server_wrk->app_index);
 179
 180   props = application_segment_manager_properties (server);
 181   round_rx_fifo_sz = 1 << max_log2 (props->rx_fifo_size);
 182   round_tx_fifo_sz = 1 << max_log2 (props->tx_fifo_size);
 183   seg_size = round_rx_fifo_sz + round_tx_fifo_sz + margin;
 184
 185   sm = app_worker_get_listen_segment_manager (server_wrk, ll);
 186   seg_index = segment_manager_add_segment (sm, seg_size);
 187   if (seg_index < 0)
 188     {
 189       clib_warning ("failed to add new cut-through segment");
 190       return seg_index;
 191     }
 192   seg = segment_manager_get_segment_w_lock (sm, seg_index);
 193
 194   rv = segment_manager_try_alloc_fifos (seg, ls->thread_index,
 195                                         props->rx_fifo_size,
 196                                         props->tx_fifo_size, &ls->rx_fifo,
 197                                         &ls->tx_fifo);
 198   if (rv)
 199     {
 200       clib_warning ("failed to add fifos in cut-through segment");
 201       segment_manager_segment_reader_unlock (sm);
 202       goto failed;
 203     }
 204
 205   sm_index = segment_manager_index (sm);
 206   ls->rx_fifo->master_session_index = ls->session_index;
 207   ls->tx_fifo->master_session_index = ls->session_index;
 208   ls->rx_fifo->segment_manager = sm_index;
 209   ls->tx_fifo->segment_manager = sm_index;
 210   ls->rx_fifo->segment_index = seg_index;
 211   ls->tx_fifo->segment_index = seg_index;
 212
 213   segment_handle = segment_manager_segment_handle (sm, seg);
 214   if ((rv = app_worker_add_segment_notify (server_wrk, segment_handle)))
 215     {
 216       clib_warning ("failed to notify server of new segment");
 217       segment_manager_segment_reader_unlock (sm);
 218       goto failed;
 219     }
 220   segment_manager_segment_reader_unlock (sm);
 221   ct->segment_handle = segment_handle;
 222
 223   return 0;
 224
 225 failed:
 226   segment_manager_del_segment (sm, seg);
 227   return rv;
 228 }
 229
 230 static int
 231 ct_connect (app_worker_t * client_wrk, session_t * ll,
 232             session_endpoint_cfg_t * sep)
 233 {
 234   u32 cct_index, ll_index, ll_ct_index;
 235   ct_connection_t *sct, *cct, *ll_ct;
 236   app_worker_t *server_wrk;
 237   session_t *ss;
 238
 239   ll_index = ll->session_index;
 240   ll_ct_index = ll->connection_index;
 241
 242   cct = ct_connection_alloc ();
 243   cct_index = cct->c_c_index;
 244   sct = ct_connection_alloc ();
 245   ll_ct = ct_connection_get (ll_ct_index);
 246
 247   /*
 248    * Alloc and init client transport
 249    */
 250   cct = ct_connection_get (cct_index);
 251   cct->c_thread_index = 0;
 252   cct->c_rmt_port = sep->port;
 253   cct->c_lcl_port = 0;
 254   cct->c_is_ip4 = sep->is_ip4;
 255   clib_memcpy (&cct->c_rmt_ip, &sep->ip, sizeof (sep->ip));
 256   cct->actual_tp = ll_ct->actual_tp;
 257   cct->is_client = 1;
 258
 259   /*
 260    * Init server transport
 261    */
 262   sct->c_thread_index = 0;
 263   sct->c_rmt_port = 0;
 264   sct->c_lcl_port = ll_ct->c_lcl_port;
 265   sct->c_is_ip4 = sep->is_ip4;
 266   clib_memcpy (&sct->c_lcl_ip, &ll_ct->c_lcl_ip, sizeof (ll_ct->c_lcl_ip));
 267   sct->client_wrk = client_wrk->wrk_index;
 268   sct->c_proto = TRANSPORT_PROTO_NONE;
 269   sct->client_opaque = sep->opaque;
 270   sct->actual_tp = ll_ct->actual_tp;
 271
 272   sct->peer_index = cct->c_c_index;
 273   cct->peer_index = sct->c_c_index;
 274
 275   /*
 276    * Accept server session. Client session is created only after
 277    * server confirms accept.
 278    */
 279   ss = session_alloc (0);
 280   ll = listen_session_get (ll_index);
 281   ss->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
 282                                                      sct->c_is_ip4);
 283   ss->connection_index = sct->c_c_index;
 284   ss->listener_handle = listen_session_get_handle (ll);
 285   ss->session_state = SESSION_STATE_CREATED;
 286
 287   server_wrk = application_listener_select_worker (ll);
 288   ss->app_wrk_index = server_wrk->wrk_index;
 289
 290   sct->c_s_index = ss->session_index;
 291   sct->server_wrk = ss->app_wrk_index;
 292
 293   if (ct_init_local_session (client_wrk, server_wrk, sct, ss, ll))
 294     {
 295       clib_warning ("failed");
 296       ct_connection_free (sct);
 297       session_free (ss);
 298       return -1;
 299     }
 300
 301   ss->session_state = SESSION_STATE_ACCEPTING;
 302   if (app_worker_accept_notify (server_wrk, ss))
 303     {
 304       clib_warning ("failed");
 305       ct_connection_free (sct);
 306       session_free_w_fifos (ss);
 307       return -1;
 308     }
 309
 310   cct->segment_handle = sct->segment_handle;
 311   ct_enable_disable_main_pre_input_node (1 /* is_add */ );
 312   return 0;
 313 }
 314
 315 static u32
 316 ct_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
 317 {
 318   session_endpoint_cfg_t *sep;
 319   ct_connection_t *ct;
 320
 321   sep = (session_endpoint_cfg_t *) tep;
 322   ct = ct_connection_alloc ();
 323   ct->server_wrk = sep->app_wrk_index;
 324   ct->c_is_ip4 = sep->is_ip4;
 325   clib_memcpy (&ct->c_lcl_ip, &sep->ip, sizeof (sep->ip));
 326   ct->c_lcl_port = sep->port;
 327   ct->actual_tp = sep->transport_proto;
 328   ct_enable_disable_main_pre_input_node (1 /* is_add */ );
 329   return ct->c_c_index;
 330 }
 331
 332 static u32
 333 ct_stop_listen (u32 ct_index)
 334 {
 335   ct_connection_t *ct;
 336   ct = ct_connection_get (ct_index);
 337   ct_connection_free (ct);
 338   ct_enable_disable_main_pre_input_node (0 /* is_add */ );
 339   return 0;
 340 }
 341
 342 static transport_connection_t *
 343 ct_listener_get (u32 ct_index)
 344 {
 345   return (transport_connection_t *) ct_connection_get (ct_index);
 346 }
 347
 348 static int
 349 ct_session_connect (transport_endpoint_cfg_t * tep)
 350 {
 351   session_endpoint_cfg_t *sep_ext;
 352   session_endpoint_t *sep;
 353   app_worker_t *app_wrk;
 354   session_handle_t lh;
 355   application_t *app;
 356   app_listener_t *al;
 357   u32 table_index;
 358   session_t *ll;
 359   u8 fib_proto;
 360
 361   sep_ext = (session_endpoint_cfg_t *) tep;
 362   sep = (session_endpoint_t *) tep;
 363   app_wrk = app_worker_get (sep_ext->app_wrk_index);
 364   app = application_get (app_wrk->app_index);
 365
 366   sep->transport_proto = sep_ext->original_tp;
 367   table_index = application_local_session_table (app);
 368   lh = session_lookup_local_endpoint (table_index, sep);
 369   if (lh == SESSION_DROP_HANDLE)
 370     return VNET_API_ERROR_APP_CONNECT_FILTERED;
 371
 372   if (lh == SESSION_INVALID_HANDLE)
 373     goto global_scope;
 374
 375   ll = listen_session_get_from_handle (lh);
 376   al = app_listener_get_w_session (ll);
 377
 378   /*
 379    * Break loop if rule in local table points to connecting app. This
 380    * can happen if client is a generic proxy. Route connect through
 381    * global table instead.
 382    */
 383   if (al->app_index == app->app_index)
 384     goto global_scope;
 385
 386   return ct_connect (app_wrk, ll, sep_ext);
 387
 388   /*
 389    * If nothing found, check the global scope for locally attached
 390    * destinations. Make sure first that we're allowed to.
 391    */
 392
 393 global_scope:
 394   if (session_endpoint_is_local (sep))
 395     return VNET_API_ERROR_SESSION_CONNECT;
 396
 397   if (!application_has_global_scope (app))
 398     return VNET_API_ERROR_APP_CONNECT_SCOPE;
 399
 400   fib_proto = session_endpoint_fib_proto (sep);
 401   table_index = application_session_table (app, fib_proto);
 402   ll = session_lookup_listener_wildcard (table_index, sep);
 403
 404   if (ll)
 405     return ct_connect (app_wrk, ll, sep_ext);
 406
 407   /* Failed to connect but no error */
 408   return 1;
 409 }
 410
 411 static void
 412 ct_session_close (u32 ct_index, u32 thread_index)
 413 {
 414   ct_connection_t *ct, *peer_ct;
 415   app_worker_t *app_wrk;
 416   session_t *s;
 417
 418   ct = ct_connection_get (ct_index);
 419   peer_ct = ct_connection_get (ct->peer_index);
 420   if (peer_ct)
 421     {
 422       peer_ct->peer_index = ~0;
 423       session_transport_closing_notify (&peer_ct->connection);
 424     }
 425
 426   s = session_get (ct->c_s_index, 0);
 427   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
 428   if (app_wrk)
 429     app_worker_del_segment_notify (app_wrk, ct->segment_handle);
 430   session_free_w_fifos (s);
 431   if (ct->is_client)
 432     segment_manager_dealloc_fifos (ct->client_rx_fifo, ct->client_tx_fifo);
 433
 434   ct_connection_free (ct);
 435   ct_enable_disable_main_pre_input_node (0 /* is_add */ );
 436 }
 437
 438 static transport_connection_t *
 439 ct_session_get (u32 ct_index, u32 thread_index)
 440 {
 441   return (transport_connection_t *) ct_connection_get (ct_index);
 442 }
 443
 444 static u8 *
 445 format_ct_connection_id (u8 * s, va_list * args)
 446 {
 447   ct_connection_t *ct = va_arg (*args, ct_connection_t *);
 448   if (!ct)
 449     return s;
 450   if (ct->c_is_ip4)
 451     {
 452       s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
 453                   ct->c_s_index, format_transport_proto_short, ct->actual_tp,
 454                   format_ip4_address, &ct->c_lcl_ip4,
 455                   clib_net_to_host_u16 (ct->c_lcl_port), format_ip4_address,
 456                   &ct->c_rmt_ip4, clib_net_to_host_u16 (ct->c_rmt_port));
 457     }
 458   else
 459     {
 460       s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
 461                   ct->c_s_index, format_transport_proto_short, ct->actual_tp,
 462                   format_ip6_address, &ct->c_lcl_ip6,
 463                   clib_net_to_host_u16 (ct->c_lcl_port), format_ip6_address,
 464                   &ct->c_rmt_ip6, clib_net_to_host_u16 (ct->c_rmt_port));
 465     }
 466
 467   return s;
 468 }
 469
 470 static int
 471 ct_custom_tx (void *session, u32 max_burst_size)
 472 {
 473   session_t *s = (session_t *) session;
 474   if (session_has_transport (s))
 475     return 0;
 476   return ct_session_tx (s);
 477 }
 478
 479 static int
 480 ct_app_rx_evt (transport_connection_t * tc)
 481 {
 482   ct_connection_t *ct = (ct_connection_t *) tc, *peer_ct;
 483   session_t *ps;
 484
 485   peer_ct = ct_connection_get (ct->peer_index);
 486   if (!peer_ct)
 487     return -1;
 488   ps = session_get (peer_ct->c_s_index, peer_ct->c_thread_index);
 489   return session_dequeue_notify (ps);
 490 }
 491
 492 static u8 *
 493 format_ct_listener (u8 * s, va_list * args)
 494 {
 495   u32 tc_index = va_arg (*args, u32);
 496   u32 __clib_unused thread_index = va_arg (*args, u32);
 497   u32 __clib_unused verbose = va_arg (*args, u32);
 498   ct_connection_t *ct = ct_connection_get (tc_index);
 499   s = format (s, "%-50U", format_ct_connection_id, ct);
 500   if (verbose)
 501     s = format (s, "%-15s", "LISTEN");
 502   return s;
 503 }
 504
 505 static u8 *
 506 format_ct_connection (u8 * s, va_list * args)
 507 {
 508   ct_connection_t *ct = va_arg (*args, ct_connection_t *);
 509   u32 verbose = va_arg (*args, u32);
 510
 511   if (!ct)
 512     return s;
 513   s = format (s, "%-50U", format_ct_connection_id, ct);
 514   if (verbose)
 515     {
 516       s = format (s, "%-15s", "ESTABLISHED");
 517       if (verbose > 1)
 518         {
 519           s = format (s, "\n");
 520         }
 521     }
 522   return s;
 523 }
 524
 525 static u8 *
 526 format_ct_session (u8 * s, va_list * args)
 527 {
 528   u32 ct_index = va_arg (*args, u32);
 529   u32 __clib_unused thread_index = va_arg (*args, u32);
 530   u32 verbose = va_arg (*args, u32);
 531   ct_connection_t *ct;
 532
 533   ct = ct_connection_get (ct_index);
 534   if (!ct)
 535     {
 536       s = format (s, "empty\n");
 537       return s;
 538     }
 539
 540   s = format (s, "%U", format_ct_connection, ct, verbose);
 541   return s;
 542 }
 543
 544 /* *INDENT-OFF* */
 545 static const transport_proto_vft_t cut_thru_proto = {
 546   .start_listen = ct_start_listen,
 547   .stop_listen = ct_stop_listen,
 548   .get_listener = ct_listener_get,
 549   .connect = ct_session_connect,
 550   .close = ct_session_close,
 551   .get_connection = ct_session_get,
 552   .custom_tx = ct_custom_tx,
 553   .app_rx_evt = ct_app_rx_evt,
 554   .format_listener = format_ct_listener,
 555   .format_connection = format_ct_session,
 556   .transport_options = {
 557     .tx_type = TRANSPORT_TX_INTERNAL,
 558     .service_type = TRANSPORT_SERVICE_APP,
 559   },
 560 };
 561 /* *INDENT-ON* */
 562
 563 int
 564 ct_session_tx (session_t * s)
 565 {
 566   ct_connection_t *ct, *peer_ct;
 567   session_t *peer_s;
 568
 569   ct = (ct_connection_t *) session_get_transport (s);
 570   peer_ct = ct_connection_get (ct->peer_index);
 571   if (!peer_ct)
 572     return -1;
 573   peer_s = session_get (peer_ct->c_s_index, 0);
 574   if (peer_s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
 575     return 0;
 576   return session_enqueue_notify (peer_s);
 577 }
 578
 579 static clib_error_t *
 580 ct_transport_init (vlib_main_t * vm)
 581 {
 582   transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
 583                                FIB_PROTOCOL_IP4, ~0);
 584   transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
 585                                FIB_PROTOCOL_IP6, ~0);
 586   return 0;
 587 }
 588
 589 VLIB_INIT_FUNCTION (ct_transport_init);
 590
 591 /*
 592  * fd.io coding-style-patch-verification: ON
 593  *
 594  * Local Variables:
 595  * eval: (c-set-style "gnu")
 596  * End:
 597  */