src/vlib/threads_cli.c

   1 /*
   2  * Copyright (c) 2015 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 #define _GNU_SOURCE
  16
  17 #include <vppinfra/format.h>
  18 #include <vlib/vlib.h>
  19
  20 #include <vlib/threads.h>
  21 #include <vlib/unix/unix.h>
  22
  23 static u8 *
  24 format_sched_policy_and_priority (u8 * s, va_list * args)
  25 {
  26   long i = va_arg (*args, long);
  27   struct sched_param sched_param;
  28   u8 *t = 0;
  29
  30   switch (sched_getscheduler (i))
  31     {
  32 #define _(v,f,str) case SCHED_POLICY_##f: t = (u8 *) str; break;
  33       foreach_sched_policy
  34 #undef _
  35     }
  36   if (sched_getparam (i, &sched_param) == 0)
  37     return format (s, "%s (%d)", t, sched_param.sched_priority);
  38   else
  39     return format (s, "%s (n/a)", t);
  40 }
  41
  42 static clib_error_t *
  43 show_threads_fn (vlib_main_t * vm,
  44                  unformat_input_t * input, vlib_cli_command_t * cmd)
  45 {
  46   vlib_worker_thread_t *w;
  47   int i;
  48
  49   vlib_cli_output (vm, "%-7s%-20s%-12s%-8s%-25s%-7s%-7s%-7s%-10s",
  50                    "ID", "Name", "Type", "LWP", "Sched Policy (Priority)",
  51                    "lcore", "Core", "Socket", "State");
  52
  53 #if !defined(__powerpc64__)
  54   for (i = 0; i < vec_len (vlib_worker_threads); i++)
  55     {
  56       w = vlib_worker_threads + i;
  57       u8 *line = NULL;
  58
  59       line = format (line, "%-7d%-20s%-12s%-8d",
  60                      i,
  61                      w->name ? w->name : (u8 *) "",
  62                      w->registration ? w->registration->name : "", w->lwp);
  63
  64       line = format (line, "%-25U", format_sched_policy_and_priority, w->lwp);
  65
  66       int lcore = -1;
  67       cpu_set_t cpuset;
  68       CPU_ZERO (&cpuset);
  69       int ret = -1;
  70
  71       ret =
  72         pthread_getaffinity_np (w->thread_id, sizeof (cpu_set_t), &cpuset);
  73       if (!ret)
  74         {
  75           int c;
  76           for (c = 0; c < CPU_SETSIZE; c++)
  77             if (CPU_ISSET (c, &cpuset))
  78               {
  79                 if (lcore > -1)
  80                   {
  81                     lcore = -2;
  82                     break;
  83                   }
  84                 lcore = c;
  85               }
  86         }
  87       else
  88         {
  89           lcore = w->lcore_id;
  90         }
  91
  92       if (lcore > -1)
  93         {
  94           const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
  95           int socket_id = -1;
  96           int core_id = -1;
  97           u8 *p = 0;
  98
  99           p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, lcore, 0);
 100           vlib_sysfs_read ((char *) p, "%d", &core_id);
 101
 102           vec_reset_length (p);
 103           p =
 104             format (p,
 105                     "%s%u/topology/physical_package_id%c",
 106                     sys_cpu_path, lcore, 0);
 107           vlib_sysfs_read ((char *) p, "%d", &socket_id);
 108           vec_free (p);
 109
 110           line = format (line, "%-7u%-7u%-7u%", lcore, core_id, socket_id);
 111         }
 112       else
 113         {
 114           line =
 115             format (line, "%-7s%-7s%-7s%", (lcore == -2) ? "M" : "n/a", "n/a",
 116                     "n/a");
 117         }
 118
 119       vlib_cli_output (vm, "%v", line);
 120       vec_free (line);
 121     }
 122 #endif
 123
 124   return 0;
 125 }
 126
 127
 128 /* *INDENT-OFF* */
 129 VLIB_CLI_COMMAND (show_threads_command, static) = {
 130   .path = "show threads",
 131   .short_help = "Show threads",
 132   .function = show_threads_fn,
 133 };
 134 /* *INDENT-ON* */
 135
 136 /*
 137  * Trigger threads to grab frame queue trace data
 138  */
 139 static clib_error_t *
 140 trace_frame_queue (vlib_main_t * vm, unformat_input_t * input,
 141                    vlib_cli_command_t * cmd)
 142 {
 143   unformat_input_t _line_input, *line_input = &_line_input;
 144   clib_error_t *error = NULL;
 145   frame_queue_trace_t *fqt;
 146   frame_queue_nelt_counter_t *fqh;
 147   vlib_thread_main_t *tm = vlib_get_thread_main ();
 148   vlib_frame_queue_main_t *fqm;
 149   u32 num_fq;
 150   u32 fqix;
 151   u32 enable = 2;
 152   u32 index = ~(u32) 0;
 153
 154   if (!unformat_user (input, unformat_line_input, line_input))
 155     return 0;
 156
 157   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 158     {
 159       if (unformat (line_input, "on"))
 160         enable = 1;
 161       else if (unformat (line_input, "off"))
 162         enable = 0;
 163       else if (unformat (line_input, "index %u"), &index)
 164         ;
 165       else
 166         return clib_error_return (0, "parse error: '%U'",
 167                                   format_unformat_error, line_input);
 168     }
 169
 170   unformat_free (line_input);
 171
 172   if (enable > 1)
 173     return clib_error_return (0, "expecting on or off");
 174
 175   if (vec_len (tm->frame_queue_mains) == 0)
 176     return clib_error_return (0, "no worker handoffs exist");
 177
 178   if (index > vec_len (tm->frame_queue_mains) - 1)
 179     return clib_error_return (0,
 180                               "expecting valid worker handoff queue index");
 181
 182   fqm = vec_elt_at_index (tm->frame_queue_mains, index);
 183
 184   num_fq = vec_len (fqm->vlib_frame_queues);
 185   if (num_fq == 0)
 186     {
 187       vlib_cli_output (vm, "No frame queues exist\n");
 188       return error;
 189     }
 190
 191   // Allocate storage for trace if necessary
 192   vec_validate_aligned (fqm->frame_queue_traces, num_fq - 1,
 193                         CLIB_CACHE_LINE_BYTES);
 194   vec_validate_aligned (fqm->frame_queue_histogram, num_fq - 1,
 195                         CLIB_CACHE_LINE_BYTES);
 196
 197   for (fqix = 0; fqix < num_fq; fqix++)
 198     {
 199       fqt = &fqm->frame_queue_traces[fqix];
 200       fqh = &fqm->frame_queue_histogram[fqix];
 201
 202       memset (fqt->n_vectors, 0xff, sizeof (fqt->n_vectors));
 203       fqt->written = 0;
 204       memset (fqh, 0, sizeof (*fqh));
 205       fqm->vlib_frame_queues[fqix]->trace = enable;
 206     }
 207   return error;
 208 }
 209
 210 /* *INDENT-OFF* */
 211 VLIB_CLI_COMMAND (cmd_trace_frame_queue,static) = {
 212     .path = "trace frame-queue",
 213     .short_help = "trace frame-queue (on|off)",
 214     .function = trace_frame_queue,
 215     .is_mp_safe = 1,
 216 };
 217 /* *INDENT-ON* */
 218
 219
 220 /*
 221  * Adding two counters and compute percent of total
 222  * Round up, e.g. 0.000001 => 1%
 223  */
 224 static u32
 225 compute_percent (u64 * two_counters, u64 total)
 226 {
 227   if (total == 0)
 228     {
 229       return 0;
 230     }
 231   else
 232     {
 233       return (((two_counters[0] + two_counters[1]) * 100) +
 234               (total - 1)) / total;
 235     }
 236 }
 237
 238 /*
 239  * Display frame queue trace data gathered by threads.
 240  */
 241 static clib_error_t *
 242 show_frame_queue_internal (vlib_main_t * vm,
 243                            vlib_frame_queue_main_t * fqm, u32 histogram)
 244 {
 245   clib_error_t *error = NULL;
 246   frame_queue_trace_t *fqt;
 247   frame_queue_nelt_counter_t *fqh;
 248   u32 num_fq;
 249   u32 fqix;
 250
 251   num_fq = vec_len (fqm->frame_queue_traces);
 252   if (num_fq == 0)
 253     {
 254       vlib_cli_output (vm, "No trace data for frame queues\n");
 255       return error;
 256     }
 257
 258   if (histogram)
 259     {
 260       vlib_cli_output (vm, "0-1   2-3   4-5   6-7   8-9   10-11 12-13 14-15 "
 261                        "16-17 18-19 20-21 22-23 24-25 26-27 28-29 30-31\n");
 262     }
 263
 264   for (fqix = 0; fqix < num_fq; fqix++)
 265     {
 266       fqt = &(fqm->frame_queue_traces[fqix]);
 267
 268       vlib_cli_output (vm, "Thread %d %v\n", fqix,
 269                        vlib_worker_threads[fqix].name);
 270
 271       if (fqt->written == 0)
 272         {
 273           vlib_cli_output (vm, "  no trace data\n");
 274           continue;
 275         }
 276
 277       if (histogram)
 278         {
 279           fqh = &(fqm->frame_queue_histogram[fqix]);
 280           u32 nelt;
 281           u64 total = 0;
 282
 283           for (nelt = 0; nelt < FRAME_QUEUE_MAX_NELTS; nelt++)
 284             {
 285               total += fqh->count[nelt];
 286             }
 287
 288           /*
 289            * Print in pairs to condense the output.
 290            * Allow entries with 0 counts to be clearly identified, by rounding up.
 291            * Any non-zero value will be displayed as at least one percent. This
 292            * also means the sum of percentages can be > 100, but that is fine. The
 293            * histogram is counted from the last time "trace frame on" was issued.
 294            */
 295           vlib_cli_output (vm,
 296                            "%3d%%  %3d%%  %3d%%  %3d%%  %3d%%  %3d%%  %3d%%  %3d%%  "
 297                            "%3d%%  %3d%%  %3d%%  %3d%%  %3d%%  %3d%%  %3d%%  %3d%%\n",
 298                            compute_percent (&fqh->count[0], total),
 299                            compute_percent (&fqh->count[2], total),
 300                            compute_percent (&fqh->count[4], total),
 301                            compute_percent (&fqh->count[6], total),
 302                            compute_percent (&fqh->count[8], total),
 303                            compute_percent (&fqh->count[10], total),
 304                            compute_percent (&fqh->count[12], total),
 305                            compute_percent (&fqh->count[14], total),
 306                            compute_percent (&fqh->count[16], total),
 307                            compute_percent (&fqh->count[18], total),
 308                            compute_percent (&fqh->count[20], total),
 309                            compute_percent (&fqh->count[22], total),
 310                            compute_percent (&fqh->count[24], total),
 311                            compute_percent (&fqh->count[26], total),
 312                            compute_percent (&fqh->count[28], total),
 313                            compute_percent (&fqh->count[30], total));
 314         }
 315       else
 316         {
 317           vlib_cli_output (vm,
 318                            "  vector-threshold %d  ring size %d  in use %d\n",
 319                            fqt->threshold, fqt->nelts, fqt->n_in_use);
 320           vlib_cli_output (vm, "  head %12d  head_hint %12d  tail %12d\n",
 321                            fqt->head, fqt->head_hint, fqt->tail);
 322           vlib_cli_output (vm,
 323                            "  %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n",
 324                            fqt->n_vectors[0], fqt->n_vectors[1],
 325                            fqt->n_vectors[2], fqt->n_vectors[3],
 326                            fqt->n_vectors[4], fqt->n_vectors[5],
 327                            fqt->n_vectors[6], fqt->n_vectors[7],
 328                            fqt->n_vectors[8], fqt->n_vectors[9],
 329                            fqt->n_vectors[10], fqt->n_vectors[11],
 330                            fqt->n_vectors[12], fqt->n_vectors[13],
 331                            fqt->n_vectors[14], fqt->n_vectors[15]);
 332
 333           if (fqt->nelts > 16)
 334             {
 335               vlib_cli_output (vm,
 336                                "  %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n",
 337                                fqt->n_vectors[16], fqt->n_vectors[17],
 338                                fqt->n_vectors[18], fqt->n_vectors[19],
 339                                fqt->n_vectors[20], fqt->n_vectors[21],
 340                                fqt->n_vectors[22], fqt->n_vectors[23],
 341                                fqt->n_vectors[24], fqt->n_vectors[25],
 342                                fqt->n_vectors[26], fqt->n_vectors[27],
 343                                fqt->n_vectors[28], fqt->n_vectors[29],
 344                                fqt->n_vectors[30], fqt->n_vectors[31]);
 345             }
 346         }
 347
 348     }
 349   return error;
 350 }
 351
 352 static clib_error_t *
 353 show_frame_queue_trace (vlib_main_t * vm, unformat_input_t * input,
 354                         vlib_cli_command_t * cmd)
 355 {
 356   vlib_thread_main_t *tm = vlib_get_thread_main ();
 357   vlib_frame_queue_main_t *fqm;
 358   clib_error_t *error;
 359
 360   vec_foreach (fqm, tm->frame_queue_mains)
 361   {
 362     vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):",
 363                      fqm - tm->frame_queue_mains,
 364                      format_vlib_node_name, vm, fqm->node_index);
 365     error = show_frame_queue_internal (vm, fqm, 0);
 366     if (error)
 367       return error;
 368   }
 369   return 0;
 370 }
 371
 372 static clib_error_t *
 373 show_frame_queue_histogram (vlib_main_t * vm, unformat_input_t * input,
 374                             vlib_cli_command_t * cmd)
 375 {
 376   vlib_thread_main_t *tm = vlib_get_thread_main ();
 377   vlib_frame_queue_main_t *fqm;
 378   clib_error_t *error;
 379
 380   vec_foreach (fqm, tm->frame_queue_mains)
 381   {
 382     vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):",
 383                      fqm - tm->frame_queue_mains,
 384                      format_vlib_node_name, vm, fqm->node_index);
 385     error = show_frame_queue_internal (vm, fqm, 1);
 386     if (error)
 387       return error;
 388   }
 389   return 0;
 390 }
 391
 392 /* *INDENT-OFF* */
 393 VLIB_CLI_COMMAND (cmd_show_frame_queue_trace,static) = {
 394     .path = "show frame-queue",
 395     .short_help = "show frame-queue trace",
 396     .function = show_frame_queue_trace,
 397 };
 398 /* *INDENT-ON* */
 399
 400 /* *INDENT-OFF* */
 401 VLIB_CLI_COMMAND (cmd_show_frame_queue_histogram,static) = {
 402     .path = "show frame-queue histogram",
 403     .short_help = "show frame-queue histogram",
 404     .function = show_frame_queue_histogram,
 405 };
 406 /* *INDENT-ON* */
 407
 408
 409 /*
 410  * Modify the number of elements on the frame_queues
 411  */
 412 static clib_error_t *
 413 test_frame_queue_nelts (vlib_main_t * vm, unformat_input_t * input,
 414                         vlib_cli_command_t * cmd)
 415 {
 416   unformat_input_t _line_input, *line_input = &_line_input;
 417   vlib_thread_main_t *tm = vlib_get_thread_main ();
 418   vlib_frame_queue_main_t *fqm;
 419   clib_error_t *error = NULL;
 420   u32 num_fq;
 421   u32 fqix;
 422   u32 nelts = 0;
 423   u32 index = ~(u32) 0;
 424
 425   if (!unformat_user (input, unformat_line_input, line_input))
 426     return 0;
 427
 428   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 429     {
 430       if (unformat (line_input, "nelts %u", &nelts))
 431         ;
 432       else if (unformat (line_input, "index %u", &index))
 433         ;
 434       else
 435         return clib_error_return (0, "parse error: '%U'",
 436                                   format_unformat_error, line_input);
 437     }
 438
 439   unformat_free (line_input);
 440
 441   if (index > vec_len (tm->frame_queue_mains) - 1)
 442     return clib_error_return (0,
 443                               "expecting valid worker handoff queue index");
 444
 445   fqm = vec_elt_at_index (tm->frame_queue_mains, index);
 446
 447   if ((nelts != 4) && (nelts != 8) && (nelts != 16) && (nelts != 32))
 448     {
 449       return clib_error_return (0, "expecting 4,8,16,32");
 450     }
 451
 452   num_fq = vec_len (fqm->vlib_frame_queues);
 453   if (num_fq == 0)
 454     {
 455       vlib_cli_output (vm, "No frame queues exist\n");
 456       return error;
 457     }
 458
 459   for (fqix = 0; fqix < num_fq; fqix++)
 460     {
 461       fqm->vlib_frame_queues[fqix]->nelts = nelts;
 462     }
 463
 464   return error;
 465 }
 466
 467 /* *INDENT-OFF* */
 468 VLIB_CLI_COMMAND (cmd_test_frame_queue_nelts,static) = {
 469     .path = "test frame-queue nelts",
 470     .short_help = "test frame-queue nelts (4,8,16,32)",
 471     .function = test_frame_queue_nelts,
 472 };
 473 /* *INDENT-ON* */
 474
 475
 476 /*
 477  * Modify the max number of packets pulled off the frame queues
 478  */
 479 static clib_error_t *
 480 test_frame_queue_threshold (vlib_main_t * vm, unformat_input_t * input,
 481                             vlib_cli_command_t * cmd)
 482 {
 483   unformat_input_t _line_input, *line_input = &_line_input;
 484   vlib_thread_main_t *tm = vlib_get_thread_main ();
 485   vlib_frame_queue_main_t *fqm;
 486   clib_error_t *error = NULL;
 487   u32 num_fq;
 488   u32 fqix;
 489   u32 threshold = ~(u32) 0;
 490   u32 index = ~(u32) 0;
 491
 492   if (!unformat_user (input, unformat_line_input, line_input))
 493     return 0;
 494
 495   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 496     {
 497       if (unformat (line_input, "threshold %u", &threshold))
 498         ;
 499       else if (unformat (line_input, "index %u", &index))
 500         ;
 501       else
 502         return clib_error_return (0, "parse error: '%U'",
 503                                   format_unformat_error, line_input);
 504     }
 505
 506   unformat_free (line_input);
 507
 508   if (index > vec_len (tm->frame_queue_mains) - 1)
 509     return clib_error_return (0,
 510                               "expecting valid worker handoff queue index");
 511
 512   fqm = vec_elt_at_index (tm->frame_queue_mains, index);
 513
 514
 515   if (threshold == ~(u32) 0)
 516     {
 517       vlib_cli_output (vm, "expecting threshold value\n");
 518       return error;
 519     }
 520
 521   if (threshold == 0)
 522     threshold = ~0;
 523
 524   num_fq = vec_len (fqm->vlib_frame_queues);
 525   if (num_fq == 0)
 526     {
 527       vlib_cli_output (vm, "No frame queues exist\n");
 528       return error;
 529     }
 530
 531   for (fqix = 0; fqix < num_fq; fqix++)
 532     {
 533       fqm->vlib_frame_queues[fqix]->vector_threshold = threshold;
 534     }
 535
 536   return error;
 537 }
 538
 539 /* *INDENT-OFF* */
 540 VLIB_CLI_COMMAND (cmd_test_frame_queue_threshold,static) = {
 541     .path = "test frame-queue threshold",
 542     .short_help = "test frame-queue threshold N (0=no limit)",
 543     .function = test_frame_queue_threshold,
 544 };
 545 /* *INDENT-ON* */
 546
 547
 548 /*
 549  * fd.io coding-style-patch-verification: ON
 550  *
 551  * Local Variables:
 552  * eval: (c-set-style "gnu")
 553  * End:
 554  */