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