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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <vppinfra/format.h>
18 #include <vlib/vlib.h>
20 #include <vlib/threads.h>
21 #include <vlib/unix/unix.h>
24 format_sched_policy_and_priority (u8 * s, va_list * args)
26 long i = va_arg (*args, long);
27 struct sched_param sched_param;
30 switch (sched_getscheduler (i))
32 #define _(v,f,str) case SCHED_POLICY_##f: t = (u8 *) str; break;
36 if (sched_getparam (i, &sched_param) == 0)
37 return format (s, "%s (%d)", t, sched_param.sched_priority);
39 return format (s, "%s (n/a)", t);
43 show_threads_fn (vlib_main_t * vm,
44 unformat_input_t * input, vlib_cli_command_t * cmd)
46 vlib_worker_thread_t *w;
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");
53 #if !defined(__powerpc64__)
54 for (i = 0; i < vec_len (vlib_worker_threads); i++)
56 w = vlib_worker_threads + i;
59 line = format (line, "%-7d%-20s%-12s%-8d",
61 w->name ? w->name : (u8 *) "",
62 w->registration ? w->registration->name : "", w->lwp);
64 line = format (line, "%-25U", format_sched_policy_and_priority, w->lwp);
72 pthread_getaffinity_np (w->thread_id, sizeof (cpu_set_t), &cpuset);
76 for (c = 0; c < CPU_SETSIZE; c++)
77 if (CPU_ISSET (c, &cpuset))
94 const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
99 p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, lcore, 0);
100 vlib_sysfs_read ((char *) p, "%d", &core_id);
102 vec_reset_length (p);
105 "%s%u/topology/physical_package_id%c",
106 sys_cpu_path, lcore, 0);
107 vlib_sysfs_read ((char *) p, "%d", &socket_id);
110 line = format (line, "%-7u%-7u%-7u%", lcore, core_id, socket_id);
115 format (line, "%-7s%-7s%-7s%", (lcore == -2) ? "M" : "n/a", "n/a",
119 vlib_cli_output (vm, "%v", line);
129 VLIB_CLI_COMMAND (show_threads_command, static) = {
130 .path = "show threads",
131 .short_help = "Show threads",
132 .function = show_threads_fn,
137 * Trigger threads to grab frame queue trace data
139 static clib_error_t *
140 trace_frame_queue (vlib_main_t * vm, unformat_input_t * input,
141 vlib_cli_command_t * cmd)
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;
152 u32 index = ~(u32) 0;
154 if (!unformat_user (input, unformat_line_input, line_input))
157 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
159 if (unformat (line_input, "on"))
161 else if (unformat (line_input, "off"))
163 else if (unformat (line_input, "index %u", &index))
167 error = clib_error_return (0, "parse error: '%U'",
168 format_unformat_error, line_input);
175 error = clib_error_return (0, "expecting on or off");
179 if (vec_len (tm->frame_queue_mains) == 0)
181 error = clib_error_return (0, "no worker handoffs exist");
185 if (index > vec_len (tm->frame_queue_mains) - 1)
187 error = clib_error_return (0,
188 "expecting valid worker handoff queue index");
192 fqm = vec_elt_at_index (tm->frame_queue_mains, index);
194 num_fq = vec_len (fqm->vlib_frame_queues);
197 vlib_cli_output (vm, "No frame queues exist\n");
201 // Allocate storage for trace if necessary
202 vec_validate_aligned (fqm->frame_queue_traces, num_fq - 1,
203 CLIB_CACHE_LINE_BYTES);
204 vec_validate_aligned (fqm->frame_queue_histogram, num_fq - 1,
205 CLIB_CACHE_LINE_BYTES);
207 for (fqix = 0; fqix < num_fq; fqix++)
209 fqt = &fqm->frame_queue_traces[fqix];
210 fqh = &fqm->frame_queue_histogram[fqix];
212 memset (fqt->n_vectors, 0xff, sizeof (fqt->n_vectors));
214 memset (fqh, 0, sizeof (*fqh));
215 fqm->vlib_frame_queues[fqix]->trace = enable;
219 unformat_free (line_input);
225 VLIB_CLI_COMMAND (cmd_trace_frame_queue,static) = {
226 .path = "trace frame-queue",
227 .short_help = "trace frame-queue (on|off)",
228 .function = trace_frame_queue,
235 * Adding two counters and compute percent of total
236 * Round up, e.g. 0.000001 => 1%
239 compute_percent (u64 * two_counters, u64 total)
247 return (((two_counters[0] + two_counters[1]) * 100) +
248 (total - 1)) / total;
253 * Display frame queue trace data gathered by threads.
255 static clib_error_t *
256 show_frame_queue_internal (vlib_main_t * vm,
257 vlib_frame_queue_main_t * fqm, u32 histogram)
259 clib_error_t *error = NULL;
260 frame_queue_trace_t *fqt;
261 frame_queue_nelt_counter_t *fqh;
265 num_fq = vec_len (fqm->frame_queue_traces);
268 vlib_cli_output (vm, "No trace data for frame queues\n");
274 vlib_cli_output (vm, "0-1 2-3 4-5 6-7 8-9 10-11 12-13 14-15 "
275 "16-17 18-19 20-21 22-23 24-25 26-27 28-29 30-31\n");
278 for (fqix = 0; fqix < num_fq; fqix++)
280 fqt = &(fqm->frame_queue_traces[fqix]);
282 vlib_cli_output (vm, "Thread %d %v\n", fqix,
283 vlib_worker_threads[fqix].name);
285 if (fqt->written == 0)
287 vlib_cli_output (vm, " no trace data\n");
293 fqh = &(fqm->frame_queue_histogram[fqix]);
297 for (nelt = 0; nelt < FRAME_QUEUE_MAX_NELTS; nelt++)
299 total += fqh->count[nelt];
303 * Print in pairs to condense the output.
304 * Allow entries with 0 counts to be clearly identified, by rounding up.
305 * Any non-zero value will be displayed as at least one percent. This
306 * also means the sum of percentages can be > 100, but that is fine. The
307 * histogram is counted from the last time "trace frame on" was issued.
310 "%3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% "
311 "%3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%%\n",
312 compute_percent (&fqh->count[0], total),
313 compute_percent (&fqh->count[2], total),
314 compute_percent (&fqh->count[4], total),
315 compute_percent (&fqh->count[6], total),
316 compute_percent (&fqh->count[8], total),
317 compute_percent (&fqh->count[10], total),
318 compute_percent (&fqh->count[12], total),
319 compute_percent (&fqh->count[14], total),
320 compute_percent (&fqh->count[16], total),
321 compute_percent (&fqh->count[18], total),
322 compute_percent (&fqh->count[20], total),
323 compute_percent (&fqh->count[22], total),
324 compute_percent (&fqh->count[24], total),
325 compute_percent (&fqh->count[26], total),
326 compute_percent (&fqh->count[28], total),
327 compute_percent (&fqh->count[30], total));
332 " vector-threshold %d ring size %d in use %d\n",
333 fqt->threshold, fqt->nelts, fqt->n_in_use);
334 vlib_cli_output (vm, " head %12d head_hint %12d tail %12d\n",
335 fqt->head, fqt->head_hint, fqt->tail);
337 " %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n",
338 fqt->n_vectors[0], fqt->n_vectors[1],
339 fqt->n_vectors[2], fqt->n_vectors[3],
340 fqt->n_vectors[4], fqt->n_vectors[5],
341 fqt->n_vectors[6], fqt->n_vectors[7],
342 fqt->n_vectors[8], fqt->n_vectors[9],
343 fqt->n_vectors[10], fqt->n_vectors[11],
344 fqt->n_vectors[12], fqt->n_vectors[13],
345 fqt->n_vectors[14], fqt->n_vectors[15]);
350 " %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n",
351 fqt->n_vectors[16], fqt->n_vectors[17],
352 fqt->n_vectors[18], fqt->n_vectors[19],
353 fqt->n_vectors[20], fqt->n_vectors[21],
354 fqt->n_vectors[22], fqt->n_vectors[23],
355 fqt->n_vectors[24], fqt->n_vectors[25],
356 fqt->n_vectors[26], fqt->n_vectors[27],
357 fqt->n_vectors[28], fqt->n_vectors[29],
358 fqt->n_vectors[30], fqt->n_vectors[31]);
366 static clib_error_t *
367 show_frame_queue_trace (vlib_main_t * vm, unformat_input_t * input,
368 vlib_cli_command_t * cmd)
370 vlib_thread_main_t *tm = vlib_get_thread_main ();
371 vlib_frame_queue_main_t *fqm;
374 vec_foreach (fqm, tm->frame_queue_mains)
376 vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):",
377 fqm - tm->frame_queue_mains,
378 format_vlib_node_name, vm, fqm->node_index);
379 error = show_frame_queue_internal (vm, fqm, 0);
386 static clib_error_t *
387 show_frame_queue_histogram (vlib_main_t * vm, unformat_input_t * input,
388 vlib_cli_command_t * cmd)
390 vlib_thread_main_t *tm = vlib_get_thread_main ();
391 vlib_frame_queue_main_t *fqm;
394 vec_foreach (fqm, tm->frame_queue_mains)
396 vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):",
397 fqm - tm->frame_queue_mains,
398 format_vlib_node_name, vm, fqm->node_index);
399 error = show_frame_queue_internal (vm, fqm, 1);
407 VLIB_CLI_COMMAND (cmd_show_frame_queue_trace,static) = {
408 .path = "show frame-queue",
409 .short_help = "show frame-queue trace",
410 .function = show_frame_queue_trace,
415 VLIB_CLI_COMMAND (cmd_show_frame_queue_histogram,static) = {
416 .path = "show frame-queue histogram",
417 .short_help = "show frame-queue histogram",
418 .function = show_frame_queue_histogram,
424 * Modify the number of elements on the frame_queues
426 static clib_error_t *
427 test_frame_queue_nelts (vlib_main_t * vm, unformat_input_t * input,
428 vlib_cli_command_t * cmd)
430 unformat_input_t _line_input, *line_input = &_line_input;
431 vlib_thread_main_t *tm = vlib_get_thread_main ();
432 vlib_frame_queue_main_t *fqm;
433 clib_error_t *error = NULL;
437 u32 index = ~(u32) 0;
439 if (!unformat_user (input, unformat_line_input, line_input))
442 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
444 if (unformat (line_input, "nelts %u", &nelts))
446 else if (unformat (line_input, "index %u", &index))
450 error = clib_error_return (0, "parse error: '%U'",
451 format_unformat_error, line_input);
456 if (index > vec_len (tm->frame_queue_mains) - 1)
458 error = clib_error_return (0,
459 "expecting valid worker handoff queue index");
463 fqm = vec_elt_at_index (tm->frame_queue_mains, index);
465 if ((nelts != 4) && (nelts != 8) && (nelts != 16) && (nelts != 32))
467 error = clib_error_return (0, "expecting 4,8,16,32");
471 num_fq = vec_len (fqm->vlib_frame_queues);
474 vlib_cli_output (vm, "No frame queues exist\n");
478 for (fqix = 0; fqix < num_fq; fqix++)
480 fqm->vlib_frame_queues[fqix]->nelts = nelts;
484 unformat_free (line_input);
490 VLIB_CLI_COMMAND (cmd_test_frame_queue_nelts,static) = {
491 .path = "test frame-queue nelts",
492 .short_help = "test frame-queue nelts (4,8,16,32)",
493 .function = test_frame_queue_nelts,
499 * Modify the max number of packets pulled off the frame queues
501 static clib_error_t *
502 test_frame_queue_threshold (vlib_main_t * vm, unformat_input_t * input,
503 vlib_cli_command_t * cmd)
505 unformat_input_t _line_input, *line_input = &_line_input;
506 vlib_thread_main_t *tm = vlib_get_thread_main ();
507 vlib_frame_queue_main_t *fqm;
508 clib_error_t *error = NULL;
511 u32 threshold = ~(u32) 0;
512 u32 index = ~(u32) 0;
514 if (!unformat_user (input, unformat_line_input, line_input))
517 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
519 if (unformat (line_input, "threshold %u", &threshold))
521 else if (unformat (line_input, "index %u", &index))
525 error = clib_error_return (0, "parse error: '%U'",
526 format_unformat_error, line_input);
531 if (index > vec_len (tm->frame_queue_mains) - 1)
533 error = clib_error_return (0,
534 "expecting valid worker handoff queue index");
538 fqm = vec_elt_at_index (tm->frame_queue_mains, index);
541 if (threshold == ~(u32) 0)
543 vlib_cli_output (vm, "expecting threshold value\n");
550 num_fq = vec_len (fqm->vlib_frame_queues);
553 vlib_cli_output (vm, "No frame queues exist\n");
557 for (fqix = 0; fqix < num_fq; fqix++)
559 fqm->vlib_frame_queues[fqix]->vector_threshold = threshold;
563 unformat_free (line_input);
569 VLIB_CLI_COMMAND (cmd_test_frame_queue_threshold,static) = {
570 .path = "test frame-queue threshold",
571 .short_help = "test frame-queue threshold N (0=no limit)",
572 .function = test_frame_queue_threshold,
578 * fd.io coding-style-patch-verification: ON
581 * eval: (c-set-style "gnu")