src/plugins/perfmon/cli.c

   1 /*
   2  * Copyright (c) 2020 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/vnet.h>
  17 #include <perfmon/perfmon.h>
  18 #include <perfmon/table.h>
  19
  20 uword
  21 unformat_perfmon_bundle_name (unformat_input_t *input, va_list *args)
  22 {
  23   perfmon_main_t *pm = &perfmon_main;
  24   perfmon_bundle_t **b = va_arg (*args, perfmon_bundle_t **);
  25   uword *p;
  26   u8 *str = 0;
  27
  28   if (unformat (input, "%s", &str) == 0)
  29     return 0;
  30
  31   p = hash_get_mem (pm->bundle_by_name, str);
  32
  33   if (p)
  34     b[0] = (perfmon_bundle_t *) p[0];
  35
  36   vec_free (str);
  37   return p ? 1 : 0;
  38 }
  39
  40 uword
  41 unformat_perfmon_source_name (unformat_input_t *input, va_list *args)
  42 {
  43   perfmon_main_t *pm = &perfmon_main;
  44   perfmon_source_t **b = va_arg (*args, perfmon_source_t **);
  45   uword *p;
  46   u8 *str = 0;
  47
  48   if (unformat (input, "%s", &str) == 0)
  49     return 0;
  50
  51   p = hash_get_mem (pm->source_by_name, str);
  52
  53   if (p)
  54     b[0] = (perfmon_source_t *) p[0];
  55
  56   vec_free (str);
  57   return p ? 1 : 0;
  58 }
  59
  60 u8 *
  61 format_perfmon_bundle (u8 *s, va_list *args)
  62 {
  63   perfmon_bundle_t *b = va_arg (*args, perfmon_bundle_t *);
  64   int verbose = va_arg (*args, int);
  65
  66   const char *bundle_type[] = {
  67     [PERFMON_BUNDLE_TYPE_NODE] = "node",
  68     [PERFMON_BUNDLE_TYPE_THREAD] = "thread",
  69     [PERFMON_BUNDLE_TYPE_SYSTEM] = "system",
  70   };
  71
  72   if (b == 0)
  73     return format (s, "%-20s%-10s%-20s%s", "Name", "Type", "Source",
  74                    "Description");
  75
  76   if (verbose)
  77     {
  78       s = format (s, "name: %s\n", b->name);
  79       s = format (s, "description: %s\n", b->description);
  80       s = format (s, "source: %s\n", b->src->name);
  81       for (int i = 0; i < b->n_events; i++)
  82         {
  83           perfmon_event_t *e = b->src->events + b->events[i];
  84           s = format (s, "event %u: %s\n", i, e->name);
  85         }
  86     }
  87   else
  88     s = format (s, "%-20s%-10s%-20s%s", b->name, bundle_type[b->type],
  89                 b->src->name, b->description);
  90
  91   return s;
  92 }
  93
  94 static clib_error_t *
  95 show_perfmon_bundle_command_fn (vlib_main_t *vm, unformat_input_t *input,
  96                                 vlib_cli_command_t *cmd)
  97 {
  98   perfmon_main_t *pm = &perfmon_main;
  99   unformat_input_t _line_input, *line_input = &_line_input;
 100   perfmon_bundle_t *b = 0, **vb = 0;
 101   int verbose = 0;
 102
 103   if (unformat_user (input, unformat_line_input, line_input))
 104     {
 105       while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 106         {
 107           if (unformat (line_input, "verbose"))
 108             verbose = 1;
 109           else if (unformat (line_input, "%U", unformat_perfmon_bundle_name,
 110                              &b))
 111             vec_add (vb, &b, 1);
 112           else
 113             return clib_error_return (0, "unknown input `%U'",
 114                                       format_unformat_error, line_input);
 115         }
 116       unformat_free (line_input);
 117     }
 118
 119   if (vb == 0)
 120     {
 121       char *key;
 122       hash_foreach_mem (key, b, pm->bundle_by_name, vec_add (vb, &b, 1););
 123     }
 124   else
 125     verbose = 1;
 126
 127   if (verbose == 0)
 128     vlib_cli_output (vm, "%U\n", format_perfmon_bundle, 0, 0);
 129
 130   for (int i = 0; i < vec_len (vb); i++)
 131     vlib_cli_output (vm, "%U\n", format_perfmon_bundle, vb[i], verbose);
 132
 133   vec_free (vb);
 134   return 0;
 135 }
 136
 137 VLIB_CLI_COMMAND (show_perfmon_bundle_command, static) = {
 138   .path = "show perfmon bundle",
 139   .short_help = "show perfmon bundle [<bundle-name>] [verbose]",
 140   .function = show_perfmon_bundle_command_fn,
 141   .is_mp_safe = 1,
 142 };
 143
 144 u8 *
 145 format_perfmon_source (u8 *s, va_list *args)
 146 {
 147   perfmon_source_t *src = va_arg (*args, perfmon_source_t *);
 148   int verbose = va_arg (*args, int);
 149
 150   if (src == 0)
 151     return format (s, "%-20s%-9s %s", "Name", "NumEvents", "Description");
 152
 153   if (verbose)
 154     {
 155       s = format (s, "name:        %s\n", src->name);
 156       s = format (s, "description: %s\n", src->description);
 157       s = format (s, "Events:\n");
 158       for (int i = 0; i < src->n_events; i++)
 159         {
 160           perfmon_event_t *e = src->events + i;
 161           s = format (s, "  %s", e->name);
 162           if (src->format_config)
 163             s = format (s, " (%U)\n", src->format_config, e->config);
 164           else
 165             s = format (s, " (0x%x)\n", e->config);
 166           if (e->description)
 167             s = format (s, "    %s\n", e->description);
 168         }
 169
 170       if (src->instances_by_type)
 171         {
 172           s = format (s, "Instances:\n");
 173           for (int i = 0; i < vec_len (src->instances_by_type); i++)
 174             {
 175               perfmon_instance_type_t *it;
 176               it = vec_elt_at_index (src->instances_by_type, i);
 177               if (vec_len (it->instances) == 0)
 178                 continue;
 179               s = format (s, "  %s:\n   ", it->name);
 180               for (int j = 0; j < vec_len (it->instances); j++)
 181                 {
 182                   perfmon_instance_t *in = vec_elt_at_index (it->instances, j);
 183                   s = format (s, " %s", in->name);
 184                 }
 185               s = format (s, "\n");
 186             }
 187         }
 188     }
 189   else
 190     s = format (s, "%-20s%9u %s", src->name, src->n_events, src->description);
 191
 192   return s;
 193 }
 194
 195 static clib_error_t *
 196 show_perfmon_source_command_fn (vlib_main_t *vm, unformat_input_t *input,
 197                                 vlib_cli_command_t *cmd)
 198 {
 199   perfmon_main_t *pm = &perfmon_main;
 200   unformat_input_t _line_input, *line_input = &_line_input;
 201   perfmon_source_t *s = 0, **vs = 0;
 202   int verbose = 0;
 203
 204   if (unformat_user (input, unformat_line_input, line_input))
 205     {
 206       while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 207         {
 208           if (unformat (line_input, "verbose"))
 209             verbose = 1;
 210           else if (unformat (line_input, "%U", unformat_perfmon_source_name,
 211                              &s))
 212             vec_add (vs, &s, 1);
 213           else
 214             return clib_error_return (0, "unknown input `%U'",
 215                                       format_unformat_error, line_input);
 216         }
 217       unformat_free (line_input);
 218     }
 219
 220   if (vs == 0)
 221     {
 222       char *key;
 223       hash_foreach_mem (key, s, pm->source_by_name, vec_add (vs, &s, 1););
 224     }
 225   else
 226     verbose = 1;
 227
 228   if (verbose == 0)
 229     vlib_cli_output (vm, "%U\n", format_perfmon_source, 0, 0);
 230
 231   for (int i = 0; i < vec_len (vs); i++)
 232     vlib_cli_output (vm, "%U\n", format_perfmon_source, vs[i], verbose);
 233
 234   vec_free (vs);
 235   return 0;
 236 }
 237
 238 VLIB_CLI_COMMAND (show_perfmon_source_command, static) = {
 239   .path = "show perfmon source",
 240   .short_help = "show perfmon source [<source-name>] [verbose]",
 241   .function = show_perfmon_source_command_fn,
 242   .is_mp_safe = 1,
 243 };
 244
 245 static clib_error_t *
 246 show_perfmon_active_bundle_command_fn (vlib_main_t *vm,
 247                                        unformat_input_t *input,
 248                                        vlib_cli_command_t *cmd)
 249 {
 250   perfmon_main_t *pm = &perfmon_main;
 251
 252   vlib_cli_output (vm, "%U\n", format_perfmon_bundle, pm->active_bundle, 1);
 253   return 0;
 254 }
 255
 256 VLIB_CLI_COMMAND (show_perfmon_active_bundle_command, static) = {
 257   .path = "show perfmon active-bundle",
 258   .short_help = "show perfmon active-bundle",
 259   .function = show_perfmon_active_bundle_command_fn,
 260   .is_mp_safe = 1,
 261 };
 262
 263 static clib_error_t *
 264 show_perfmon_stats_command_fn (vlib_main_t *vm, unformat_input_t *input,
 265                                vlib_cli_command_t *cmd)
 266 {
 267   perfmon_main_t *pm = &perfmon_main;
 268   perfmon_bundle_t *b = pm->active_bundle;
 269   clib_error_t *err = 0;
 270   table_t table = {}, *t = &table;
 271   u32 n_instances;
 272   perfmon_reading_t *r, *readings = 0;
 273   perfmon_instance_type_t *it = pm->active_instance_type;
 274   perfmon_instance_t *in;
 275   u8 *s = 0;
 276   int n_row = 0;
 277   u8 raw = 0;
 278
 279   if (b == 0)
 280     return clib_error_return (0, "no bundle selected");
 281
 282   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 283     {
 284       if (unformat (input, "raw"))
 285         raw = 1;
 286       else
 287         break;
 288     }
 289
 290   n_instances = vec_len (it->instances);
 291   vec_validate (readings, n_instances - 1);
 292
 293   for (int i = 0; i < n_instances; i++)
 294     {
 295       in = vec_elt_at_index (it->instances, i);
 296       r = vec_elt_at_index (readings, i);
 297
 298       if (read (pm->group_fds[i], r, (b->n_events + 3) * sizeof (u64)) == -1)
 299         {
 300           err = clib_error_return_unix (0, "read");
 301           goto done;
 302         }
 303     }
 304
 305   table_format_title (t, "%s", b->description);
 306
 307   table_add_header_col (t, 0);
 308   table_add_header_row (t, 0);
 309
 310   if (b->column_headers)
 311     {
 312       char **hdr = b->column_headers;
 313       while (hdr[0])
 314         table_format_cell (t, -1, n_row++, "%s", hdr++[0]);
 315
 316       if (b->raw_column_headers && raw)
 317         {
 318           hdr = b->raw_column_headers;
 319           while (hdr[0])
 320             table_format_cell (t, -1, n_row++, "%s", hdr++[0]);
 321         }
 322     }
 323
 324   int col = 0;
 325   for (int i = 0; i < n_instances; i++)
 326     {
 327       in = vec_elt_at_index (it->instances, i);
 328       r = vec_elt_at_index (readings, i);
 329       table_format_cell (t, col, -1, "%s", in->name);
 330       if (b->type == PERFMON_BUNDLE_TYPE_NODE)
 331         {
 332           perfmon_thread_runtime_t *tr;
 333           tr = vec_elt_at_index (pm->thread_runtimes, i);
 334           for (int j = 0; j < tr->n_nodes; j++)
 335             if (tr->node_stats[j].n_calls)
 336               {
 337                 perfmon_node_stats_t ns;
 338                 table_format_cell (t, ++col, -1, "%U", format_vlib_node_name,
 339                                    vm, j);
 340                 table_set_cell_align (t, col, -1, TTAA_RIGHT);
 341                 table_set_cell_fg_color (t, col, -1, TTAC_CYAN);
 342                 clib_memcpy_fast (&ns, tr->node_stats + j, sizeof (ns));
 343                 for (int j = 0; j < n_row; j++)
 344                   table_format_cell (t, col, j, "%U", b->format_fn, &ns, j);
 345               }
 346         }
 347       else
 348         {
 349           for (int j = 0; j < n_row; j++)
 350             table_format_cell (t, i, j, "%U", b->format_fn, r, j);
 351         }
 352       col++;
 353     }
 354
 355   vlib_cli_output (vm, "%U\n", format_table, t);
 356   table_free (t);
 357
 358   if (raw)
 359     vlib_cli_output (vm, "Sample time is %.4f seconds \n", pm->sample_time);
 360
 361   if (b->footer)
 362     vlib_cli_output (vm, "\n%s\n", b->footer);
 363
 364 done:
 365   vec_free (readings);
 366   vec_free (s);
 367   return err;
 368 }
 369
 370 VLIB_CLI_COMMAND (show_perfmon_stats_command, static) = {
 371   .path = "show perfmon statistics",
 372   .short_help = "show perfmon statistics [raw]",
 373   .function = show_perfmon_stats_command_fn,
 374   .is_mp_safe = 1,
 375 };
 376
 377 static clib_error_t *
 378 perfmon_reset_command_fn (vlib_main_t *vm, unformat_input_t *input,
 379                           vlib_cli_command_t *cmd)
 380 {
 381   perfmon_reset (vm);
 382   return 0;
 383 }
 384
 385 VLIB_CLI_COMMAND (perfmon_reset_command, static) = {
 386   .path = "perfmon reset",
 387   .short_help = "perfmon reset",
 388   .function = perfmon_reset_command_fn,
 389   .is_mp_safe = 1,
 390 };
 391
 392 static clib_error_t *
 393 perfmon_start_command_fn (vlib_main_t *vm, unformat_input_t *input,
 394                           vlib_cli_command_t *cmd)
 395 {
 396   perfmon_main_t *pm = &perfmon_main;
 397   unformat_input_t _line_input, *line_input = &_line_input;
 398   perfmon_bundle_t *b = 0;
 399
 400   if (pm->is_running)
 401     return clib_error_return (0, "please stop first");
 402
 403   if (unformat_user (input, unformat_line_input, line_input) == 0)
 404     return clib_error_return (0, "please specify bundle name");
 405
 406   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 407     {
 408       if (unformat (line_input, "bundle %U", unformat_perfmon_bundle_name, &b))
 409         ;
 410       else
 411         return clib_error_return (0, "unknown input '%U'",
 412                                   format_unformat_error, line_input);
 413     }
 414   unformat_free (line_input);
 415
 416   if (b == 0)
 417     return clib_error_return (0, "please specify bundle name");
 418
 419   return perfmon_start (vm, b);
 420 }
 421
 422 VLIB_CLI_COMMAND (perfmon_start_command, static) = {
 423   .path = "perfmon start",
 424   .short_help = "perfmon start bundle [<bundle-name>]",
 425   .function = perfmon_start_command_fn,
 426   .is_mp_safe = 1,
 427 };
 428
 429 static clib_error_t *
 430 perfmon_stop_command_fn (vlib_main_t *vm, unformat_input_t *input,
 431                          vlib_cli_command_t *cmd)
 432 {
 433   return perfmon_stop (vm);
 434 }
 435
 436 VLIB_CLI_COMMAND (perfmon_stop_command, static) = {
 437   .path = "perfmon stop",
 438   .short_help = "perfmon stop",
 439   .function = perfmon_stop_command_fn,
 440   .is_mp_safe = 1,
 441 };