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