src/vnet/session/session_cli.c

   1 /*
   2  * Copyright (c) 2017 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 #include <vnet/session/application.h>
  16 #include <vnet/session/session.h>
  17
  18 u8 *
  19 format_session_fifos (u8 * s, va_list * args)
  20 {
  21   stream_session_t *ss = va_arg (*args, stream_session_t *);
  22   int verbose = va_arg (*args, int);
  23   session_event_t _e, *e = &_e;
  24   u8 found;
  25
  26   if (!ss->server_rx_fifo || !ss->server_tx_fifo)
  27     return s;
  28
  29   s = format (s, " Rx fifo: %U", format_svm_fifo, ss->server_rx_fifo,
  30               verbose);
  31   if (verbose > 2 && ss->server_rx_fifo->has_event)
  32     {
  33       found = session_node_lookup_fifo_event (ss->server_rx_fifo, e);
  34       s = format (s, " session node event: %s\n",
  35                   found ? "found" : "not found");
  36     }
  37   s = format (s, " Tx fifo: %U", format_svm_fifo, ss->server_tx_fifo,
  38               verbose);
  39   if (verbose > 2 && ss->server_tx_fifo->has_event)
  40     {
  41       found = session_node_lookup_fifo_event (ss->server_tx_fifo, e);
  42       s = format (s, " session node event: %s\n",
  43                   found ? "found" : "not found");
  44     }
  45   return s;
  46 }
  47
  48 /**
  49  * Format stream session as per the following format
  50  *
  51  * verbose:
  52  *   "Connection", "Rx fifo", "Tx fifo", "Session Index"
  53  * non-verbose:
  54  *   "Connection"
  55  */
  56 u8 *
  57 format_stream_session (u8 * s, va_list * args)
  58 {
  59   stream_session_t *ss = va_arg (*args, stream_session_t *);
  60   int verbose = va_arg (*args, int);
  61   u32 tp = session_get_transport_proto (ss);
  62   u8 *str = 0;
  63
  64   if (verbose == 1 && ss->session_state >= SESSION_STATE_ACCEPTING)
  65     str = format (0, "%-10u%-10u",
  66                   svm_fifo_max_dequeue (ss->server_rx_fifo),
  67                   svm_fifo_max_dequeue (ss->server_tx_fifo));
  68
  69   if (ss->session_state >= SESSION_STATE_ACCEPTING)
  70     {
  71       s = format (s, "%U", format_transport_connection, tp,
  72                   ss->connection_index, ss->thread_index, verbose);
  73       if (verbose == 1)
  74         s = format (s, "%v", str);
  75       if (verbose > 1)
  76         s = format (s, "%U", format_session_fifos, ss, verbose);
  77     }
  78   else if (ss->session_state == SESSION_STATE_LISTENING)
  79     {
  80       s = format (s, "%-40U%v", format_transport_listen_connection,
  81                   tp, ss->connection_index, str);
  82       if (verbose > 1)
  83         s = format (s, "\n%U", format_session_fifos, ss, verbose);
  84     }
  85   else if (ss->session_state == SESSION_STATE_CONNECTING)
  86     {
  87       s = format (s, "%-40U%v", format_transport_half_open_connection,
  88                   tp, ss->connection_index, str);
  89     }
  90   else
  91     {
  92       clib_warning ("Session in state: %d!", ss->session_state);
  93     }
  94   vec_free (str);
  95
  96   return s;
  97 }
  98
  99 uword
 100 unformat_stream_session_id (unformat_input_t * input, va_list * args)
 101 {
 102   u8 *proto = va_arg (*args, u8 *);
 103   u32 *fib_index = va_arg (*args, u32 *);
 104   ip46_address_t *lcl = va_arg (*args, ip46_address_t *);
 105   ip46_address_t *rmt = va_arg (*args, ip46_address_t *);
 106   u16 *lcl_port = va_arg (*args, u16 *);
 107   u16 *rmt_port = va_arg (*args, u16 *);
 108   u8 *is_ip4 = va_arg (*args, u8 *);
 109   u8 tuple_is_set = 0;
 110   u32 vrf = ~0;
 111
 112   clib_memset (lcl, 0, sizeof (*lcl));
 113   clib_memset (rmt, 0, sizeof (*rmt));
 114
 115   if (unformat (input, "tcp"))
 116     {
 117       *proto = TRANSPORT_PROTO_TCP;
 118     }
 119   else if (unformat (input, "udp"))
 120     {
 121       *proto = TRANSPORT_PROTO_UDP;
 122     }
 123   else
 124     return 0;
 125
 126   if (unformat (input, "vrf %u", &vrf))
 127     ;
 128
 129   if (unformat (input, "%U:%d->%U:%d", unformat_ip4_address, &lcl->ip4,
 130                 lcl_port, unformat_ip4_address, &rmt->ip4, rmt_port))
 131     {
 132       *is_ip4 = 1;
 133       tuple_is_set = 1;
 134     }
 135   else if (unformat (input, "%U:%d->%U:%d", unformat_ip6_address, &lcl->ip6,
 136                      lcl_port, unformat_ip6_address, &rmt->ip6, rmt_port))
 137     {
 138       *is_ip4 = 0;
 139       tuple_is_set = 1;
 140     }
 141
 142   if (vrf != ~0)
 143     {
 144       fib_protocol_t fib_proto;
 145       fib_proto = *is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 146       *fib_index = fib_table_find (fib_proto, vrf);
 147     }
 148
 149   return tuple_is_set;
 150 }
 151
 152 uword
 153 unformat_stream_session (unformat_input_t * input, va_list * args)
 154 {
 155   stream_session_t **result = va_arg (*args, stream_session_t **);
 156   u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
 157   ip46_address_t lcl, rmt;
 158   stream_session_t *s;
 159   u8 proto = ~0;
 160   u8 is_ip4 = 0;
 161
 162   if (!unformat (input, "%U", unformat_stream_session_id, &proto, &fib_index,
 163                  &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
 164     return 0;
 165
 166   if (is_ip4)
 167     s = session_lookup_safe4 (fib_index, &lcl.ip4, &rmt.ip4,
 168                               clib_host_to_net_u16 (lcl_port),
 169                               clib_host_to_net_u16 (rmt_port), proto);
 170   else
 171     s = session_lookup_safe6 (fib_index, &lcl.ip6, &rmt.ip6,
 172                               clib_host_to_net_u16 (lcl_port),
 173                               clib_host_to_net_u16 (rmt_port), proto);
 174   if (s)
 175     {
 176       *result = s;
 177       session_pool_remove_peeker (s->thread_index);
 178       return 1;
 179     }
 180   return 0;
 181 }
 182
 183 uword
 184 unformat_transport_connection (unformat_input_t * input, va_list * args)
 185 {
 186   transport_connection_t **result = va_arg (*args, transport_connection_t **);
 187   u32 suggested_proto = va_arg (*args, u32);
 188   transport_connection_t *tc;
 189   u8 proto = ~0;
 190   ip46_address_t lcl, rmt;
 191   u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
 192   u8 is_ip4 = 0;
 193
 194   if (!unformat (input, "%U", unformat_stream_session_id, &fib_index, &proto,
 195                  &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
 196     return 0;
 197
 198   proto = (proto == (u8) ~ 0) ? suggested_proto : proto;
 199   if (proto == (u8) ~ 0)
 200     return 0;
 201   if (is_ip4)
 202     tc = session_lookup_connection4 (fib_index, &lcl.ip4, &rmt.ip4,
 203                                      clib_host_to_net_u16 (lcl_port),
 204                                      clib_host_to_net_u16 (rmt_port), proto);
 205   else
 206     tc = session_lookup_connection6 (fib_index, &lcl.ip6, &rmt.ip6,
 207                                      clib_host_to_net_u16 (lcl_port),
 208                                      clib_host_to_net_u16 (rmt_port), proto);
 209
 210   if (tc)
 211     {
 212       *result = tc;
 213       return 1;
 214     }
 215   return 0;
 216 }
 217
 218 static clib_error_t *
 219 show_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
 220                          vlib_cli_command_t * cmd)
 221 {
 222   u8 *str = 0, one_session = 0, do_listeners = 0, sst, do_elog = 0;
 223   session_manager_main_t *smm = &session_manager_main;
 224   u32 transport_proto = ~0, track_index;
 225   stream_session_t *pool, *s;
 226   transport_connection_t *tc;
 227   app_worker_t *app_wrk;
 228   int verbose = 0, i;
 229   const u8 *app_name;
 230
 231   if (!smm->is_enabled)
 232     {
 233       return clib_error_return (0, "session layer is not enabled");
 234     }
 235
 236   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 237     {
 238       if (unformat (input, "verbose %d", &verbose))
 239         ;
 240       else if (unformat (input, "verbose"))
 241         verbose = 1;
 242       else if (unformat (input, "listeners %U", unformat_transport_proto,
 243                          &transport_proto))
 244         do_listeners = 1;
 245       else if (unformat (input, "%U", unformat_stream_session, &s))
 246         {
 247           one_session = 1;
 248         }
 249       else if (unformat (input, "elog"))
 250         do_elog = 1;
 251       else
 252         return clib_error_return (0, "unknown input `%U'",
 253                                   format_unformat_error, input);
 254     }
 255
 256   if (one_session)
 257     {
 258       str = format (0, "%U", format_stream_session, s, 3);
 259       if (do_elog && s->session_state != SESSION_STATE_LISTENING)
 260         {
 261           elog_main_t *em = &vm->elog_main;
 262           f64 dt;
 263
 264           tc = session_get_transport (s);
 265           track_index = transport_elog_track_index (tc);
 266           dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
 267             * vm->clib_time.seconds_per_clock;
 268           if (track_index != ~0)
 269             str = format (str, " session elog:\n%U", format_elog_track, em,
 270                           dt, track_index);
 271         }
 272       vlib_cli_output (vm, "%v", str);
 273       return 0;
 274     }
 275
 276   if (do_listeners)
 277     {
 278       sst = session_type_from_proto_and_ip (transport_proto, 1);
 279       vlib_cli_output (vm, "%-40s%-24s", "Listener", "App");
 280       /* *INDENT-OFF* */
 281       pool_foreach (s, smm->wrk[0].sessions, ({
 282         if (s->session_state != SESSION_STATE_LISTENING
 283             || s->session_type != sst)
 284           continue;
 285         app_wrk = app_worker_get (s->app_wrk_index);
 286         app_name = application_name_from_index (app_wrk->app_index);
 287         vlib_cli_output (vm, "%U%-25v%", format_stream_session, s, 1,
 288                          app_name);
 289       }));
 290       /* *INDENT-ON* */
 291       return 0;
 292     }
 293
 294   for (i = 0; i < vec_len (smm->wrk); i++)
 295     {
 296       u32 once_per_pool;
 297       pool = smm->wrk[i].sessions;
 298
 299       once_per_pool = 1;
 300
 301       if (pool_elts (pool))
 302         {
 303
 304           vlib_cli_output (vm, "Thread %d: %d active sessions",
 305                            i, pool_elts (pool));
 306           if (verbose)
 307             {
 308               if (once_per_pool && verbose == 1)
 309                 {
 310                   str = format (str, "%-50s%-15s%-10s%-10s",
 311                                 "Connection", "State", "Rx-f", "Tx-f");
 312                   vlib_cli_output (vm, "%v", str);
 313                   vec_reset_length (str);
 314                   once_per_pool = 0;
 315                 }
 316
 317               /* *INDENT-OFF* */
 318               pool_foreach (s, pool,
 319               ({
 320                 vec_reset_length (str);
 321                 str = format (str, "%U", format_stream_session, s, verbose);
 322                 vlib_cli_output (vm, "%v", str);
 323               }));
 324               /* *INDENT-ON* */
 325             }
 326         }
 327       else
 328         vlib_cli_output (vm, "Thread %d: no active sessions", i);
 329       vec_reset_length (str);
 330     }
 331   vec_free (str);
 332
 333   return 0;
 334 }
 335
 336 /* *INDENT-OFF* */
 337 VLIB_CLI_COMMAND (vlib_cli_show_session_command) =
 338 {
 339   .path = "show session",
 340   .short_help = "show session [verbose [nnn]]",
 341   .function = show_session_command_fn,
 342 };
 343 /* *INDENT-ON* */
 344
 345 static int
 346 clear_session (stream_session_t * s)
 347 {
 348   app_worker_t *server_wrk = app_worker_get (s->app_wrk_index);
 349   application_t *server = application_get (server_wrk->app_index);
 350   server->cb_fns.session_disconnect_callback (s);
 351   return 0;
 352 }
 353
 354 static clib_error_t *
 355 clear_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
 356                           vlib_cli_command_t * cmd)
 357 {
 358   session_manager_main_t *smm = &session_manager_main;
 359   u32 thread_index = 0, clear_all = 0;
 360   session_manager_worker_t *wrk;
 361   u32 session_index = ~0;
 362   stream_session_t *session;
 363
 364   if (!smm->is_enabled)
 365     {
 366       return clib_error_return (0, "session layer is not enabled");
 367     }
 368
 369   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 370     {
 371       if (unformat (input, "thread %d", &thread_index))
 372         ;
 373       else if (unformat (input, "session %d", &session_index))
 374         ;
 375       else if (unformat (input, "all"))
 376         clear_all = 1;
 377       else
 378         return clib_error_return (0, "unknown input `%U'",
 379                                   format_unformat_error, input);
 380     }
 381
 382   if (!clear_all && session_index == ~0)
 383     return clib_error_return (0, "session <nn> required, but not set.");
 384
 385   if (session_index != ~0)
 386     {
 387       session = session_get_if_valid (session_index, thread_index);
 388       if (!session)
 389         return clib_error_return (0, "no session %d on thread %d",
 390                                   session_index, thread_index);
 391       clear_session (session);
 392     }
 393
 394   if (clear_all)
 395     {
 396       /* *INDENT-OFF* */
 397       vec_foreach (wrk, smm->wrk)
 398         {
 399           pool_foreach(session, wrk->sessions, ({
 400             clear_session (session);
 401           }));
 402         };
 403       /* *INDENT-ON* */
 404     }
 405
 406   return 0;
 407 }
 408
 409 /* *INDENT-OFF* */
 410 VLIB_CLI_COMMAND (clear_session_command, static) =
 411 {
 412   .path = "clear session",
 413   .short_help = "clear session thread <thread> session <index>",
 414   .function = clear_session_command_fn,
 415 };
 416 /* *INDENT-ON* */
 417
 418 static clib_error_t *
 419 show_session_fifo_trace_command_fn (vlib_main_t * vm,
 420                                     unformat_input_t * input,
 421                                     vlib_cli_command_t * cmd)
 422 {
 423   stream_session_t *s = 0;
 424   u8 is_rx = 0, *str = 0;
 425
 426   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 427     {
 428       if (unformat (input, "%U", unformat_stream_session, &s))
 429         ;
 430       else if (unformat (input, "rx"))
 431         is_rx = 1;
 432       else if (unformat (input, "tx"))
 433         is_rx = 0;
 434       else
 435         return clib_error_return (0, "unknown input `%U'",
 436                                   format_unformat_error, input);
 437     }
 438
 439   if (!SVM_FIFO_TRACE)
 440     {
 441       vlib_cli_output (vm, "fifo tracing not enabled");
 442       return 0;
 443     }
 444
 445   if (!s)
 446     {
 447       vlib_cli_output (vm, "could not find session");
 448       return 0;
 449     }
 450
 451   str = is_rx ?
 452     svm_fifo_dump_trace (str, s->server_rx_fifo) :
 453     svm_fifo_dump_trace (str, s->server_tx_fifo);
 454
 455   vlib_cli_output (vm, "%v", str);
 456   return 0;
 457 }
 458
 459 /* *INDENT-OFF* */
 460 VLIB_CLI_COMMAND (show_session_fifo_trace_command, static) =
 461 {
 462   .path = "show session fifo trace",
 463   .short_help = "show session fifo trace <session>",
 464   .function = show_session_fifo_trace_command_fn,
 465 };
 466 /* *INDENT-ON* */
 467
 468 static clib_error_t *
 469 session_replay_fifo_command_fn (vlib_main_t * vm, unformat_input_t * input,
 470                                 vlib_cli_command_t * cmd)
 471 {
 472   stream_session_t *s = 0;
 473   u8 is_rx = 0, *str = 0;
 474
 475   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 476     {
 477       if (unformat (input, "%U", unformat_stream_session, &s))
 478         ;
 479       else if (unformat (input, "rx"))
 480         is_rx = 1;
 481       else
 482         return clib_error_return (0, "unknown input `%U'",
 483                                   format_unformat_error, input);
 484     }
 485
 486   if (!SVM_FIFO_TRACE)
 487     {
 488       vlib_cli_output (vm, "fifo tracing not enabled");
 489       return 0;
 490     }
 491
 492   if (!s)
 493     {
 494       vlib_cli_output (vm, "could not find session");
 495       return 0;
 496     }
 497
 498   str = is_rx ?
 499     svm_fifo_replay (str, s->server_rx_fifo, 0, 1) :
 500     svm_fifo_replay (str, s->server_tx_fifo, 0, 1);
 501
 502   vlib_cli_output (vm, "%v", str);
 503   return 0;
 504 }
 505
 506 /* *INDENT-OFF* */
 507 VLIB_CLI_COMMAND (session_replay_fifo_trace_command, static) =
 508 {
 509   .path = "session replay fifo",
 510   .short_help = "session replay fifo <session>",
 511   .function = session_replay_fifo_command_fn,
 512 };
 513 /* *INDENT-ON* */
 514
 515 static clib_error_t *
 516 session_enable_disable_fn (vlib_main_t * vm, unformat_input_t * input,
 517                            vlib_cli_command_t * cmd)
 518 {
 519   unformat_input_t _line_input, *line_input = &_line_input;
 520   u8 is_en = 1;
 521   clib_error_t *error;
 522
 523   if (!unformat_user (input, unformat_line_input, line_input))
 524     return clib_error_return (0, "expected enable | disable");
 525
 526   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 527     {
 528       if (unformat (line_input, "enable"))
 529         is_en = 1;
 530       else if (unformat (line_input, "disable"))
 531         is_en = 0;
 532       else
 533         {
 534           error = clib_error_return (0, "unknown input `%U'",
 535                                      format_unformat_error, line_input);
 536           unformat_free (line_input);
 537           return error;
 538         }
 539     }
 540
 541   unformat_free (line_input);
 542   return vnet_session_enable_disable (vm, is_en);
 543 }
 544
 545 /* *INDENT-OFF* */
 546 VLIB_CLI_COMMAND (session_enable_disable_command, static) =
 547 {
 548   .path = "session",
 549   .short_help = "session [enable|disable]",
 550   .function = session_enable_disable_fn,
 551 };
 552 /* *INDENT-ON* */
 553
 554 /*
 555  * fd.io coding-style-patch-verification: ON
 556  *
 557  * Local Variables:
 558  * eval: (c-set-style "gnu")
 559  * End:
 560  */