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