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 const vlib_thread_main_t *tm = vlib_get_thread_main ();
47 vlib_worker_thread_t *w;
50 vlib_cli_output (vm, "%-7s%-20s%-12s%-8s%-25s%-7s%-7s%-7s%-10s",
51 "ID", "Name", "Type", "LWP", "Sched Policy (Priority)",
52 "lcore", "Core", "Socket", "State");
54 #if !defined(__powerpc64__)
55 for (i = 0; i < vec_len (vlib_worker_threads); i++)
57 w = vlib_worker_threads + i;
60 line = format (line, "%-7d%-20s%-12s%-8d",
62 w->name ? w->name : (u8 *) "",
63 w->registration ? w->registration->name : "", w->lwp);
65 line = format (line, "%-25U", format_sched_policy_and_priority, w->lwp);
67 int cpu_id = w->cpu_id;
68 if (cpu_id > -1 && tm->main_lcore != ~0)
70 int core_id = w->core_id;
71 int numa_id = w->numa_id;
72 line = format (line, "%-7u%-7u%-7u%", cpu_id, core_id, numa_id);
76 line = format (line, "%-7s%-7s%-7s%", "n/a", "n/a", "n/a");
79 vlib_cli_output (vm, "%v", line);
88 VLIB_CLI_COMMAND (show_threads_command, static) = {
89 .path = "show threads",
90 .short_help = "Show threads",
91 .function = show_threads_fn,
95 * Trigger threads to grab frame queue trace data
98 trace_frame_queue (vlib_main_t * vm, unformat_input_t * input,
99 vlib_cli_command_t * cmd)
101 unformat_input_t _line_input, *line_input = &_line_input;
102 clib_error_t *error = NULL;
103 frame_queue_trace_t *fqt;
104 frame_queue_nelt_counter_t *fqh;
105 vlib_thread_main_t *tm = vlib_get_thread_main ();
106 vlib_frame_queue_main_t *fqm;
110 u32 index = ~(u32) 0;
112 if (!unformat_user (input, unformat_line_input, line_input))
115 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
117 if (unformat (line_input, "on"))
119 else if (unformat (line_input, "off"))
121 else if (unformat (line_input, "index %u", &index))
125 error = clib_error_return (0, "parse error: '%U'",
126 format_unformat_error, line_input);
133 error = clib_error_return (0, "expecting on or off");
137 if (vec_len (tm->frame_queue_mains) == 0)
139 error = clib_error_return (0, "no worker handoffs exist");
143 if (index > vec_len (tm->frame_queue_mains) - 1)
145 error = clib_error_return (0,
146 "expecting valid worker handoff queue index");
150 fqm = vec_elt_at_index (tm->frame_queue_mains, index);
152 num_fq = vec_len (fqm->vlib_frame_queues);
155 vlib_cli_output (vm, "No frame queues exist\n");
159 // Allocate storage for trace if necessary
160 vec_validate_aligned (fqm->frame_queue_traces, num_fq - 1,
161 CLIB_CACHE_LINE_BYTES);
162 vec_validate_aligned (fqm->frame_queue_histogram, num_fq - 1,
163 CLIB_CACHE_LINE_BYTES);
165 for (fqix = 0; fqix < num_fq; fqix++)
167 fqt = &fqm->frame_queue_traces[fqix];
168 fqh = &fqm->frame_queue_histogram[fqix];
170 clib_memset (fqt->n_vectors, 0xff, sizeof (fqt->n_vectors));
172 clib_memset (fqh, 0, sizeof (*fqh));
173 fqm->vlib_frame_queues[fqix]->trace = enable;
177 unformat_free (line_input);
182 VLIB_CLI_COMMAND (cmd_trace_frame_queue,static) = {
183 .path = "trace frame-queue",
184 .short_help = "trace frame-queue (on|off)",
185 .function = trace_frame_queue,
191 * Adding two counters and compute percent of total
192 * Round up, e.g. 0.000001 => 1%
195 compute_percent (u64 * two_counters, u64 total)
203 return (((two_counters[0] + two_counters[1]) * 100) +
204 (total - 1)) / total;
209 * Display frame queue trace data gathered by threads.
211 static clib_error_t *
212 show_frame_queue_internal (vlib_main_t * vm,
213 vlib_frame_queue_main_t * fqm, u32 histogram)
215 clib_error_t *error = NULL;
216 frame_queue_trace_t *fqt;
217 frame_queue_nelt_counter_t *fqh;
221 num_fq = vec_len (fqm->frame_queue_traces);
224 vlib_cli_output (vm, "No trace data for frame queues\n");
230 vlib_cli_output (vm, "0-1 2-3 4-5 6-7 8-9 10-11 12-13 14-15 "
231 "16-17 18-19 20-21 22-23 24-25 26-27 28-29 30-31\n");
234 for (fqix = 0; fqix < num_fq; fqix++)
236 fqt = &(fqm->frame_queue_traces[fqix]);
238 vlib_cli_output (vm, "Thread %d %v\n", fqix,
239 vlib_worker_threads[fqix].name);
241 if (fqt->written == 0)
243 vlib_cli_output (vm, " no trace data\n");
249 fqh = &(fqm->frame_queue_histogram[fqix]);
253 for (nelt = 0; nelt < FRAME_QUEUE_MAX_NELTS; nelt++)
255 total += fqh->count[nelt];
259 * Print in pairs to condense the output.
260 * Allow entries with 0 counts to be clearly identified, by rounding up.
261 * Any non-zero value will be displayed as at least one percent. This
262 * also means the sum of percentages can be > 100, but that is fine. The
263 * histogram is counted from the last time "trace frame on" was issued.
266 "%3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% "
267 "%3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%%\n",
268 compute_percent (&fqh->count[0], total),
269 compute_percent (&fqh->count[2], total),
270 compute_percent (&fqh->count[4], total),
271 compute_percent (&fqh->count[6], total),
272 compute_percent (&fqh->count[8], total),
273 compute_percent (&fqh->count[10], total),
274 compute_percent (&fqh->count[12], total),
275 compute_percent (&fqh->count[14], total),
276 compute_percent (&fqh->count[16], total),
277 compute_percent (&fqh->count[18], total),
278 compute_percent (&fqh->count[20], total),
279 compute_percent (&fqh->count[22], total),
280 compute_percent (&fqh->count[24], total),
281 compute_percent (&fqh->count[26], total),
282 compute_percent (&fqh->count[28], total),
283 compute_percent (&fqh->count[30], total));
288 " vector-threshold %d ring size %d in use %d\n",
289 fqt->threshold, fqt->nelts, fqt->n_in_use);
290 vlib_cli_output (vm, " head %12d tail %12d\n", fqt->head,
293 " %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n",
294 fqt->n_vectors[0], fqt->n_vectors[1],
295 fqt->n_vectors[2], fqt->n_vectors[3],
296 fqt->n_vectors[4], fqt->n_vectors[5],
297 fqt->n_vectors[6], fqt->n_vectors[7],
298 fqt->n_vectors[8], fqt->n_vectors[9],
299 fqt->n_vectors[10], fqt->n_vectors[11],
300 fqt->n_vectors[12], fqt->n_vectors[13],
301 fqt->n_vectors[14], fqt->n_vectors[15]);
306 " %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n",
307 fqt->n_vectors[16], fqt->n_vectors[17],
308 fqt->n_vectors[18], fqt->n_vectors[19],
309 fqt->n_vectors[20], fqt->n_vectors[21],
310 fqt->n_vectors[22], fqt->n_vectors[23],
311 fqt->n_vectors[24], fqt->n_vectors[25],
312 fqt->n_vectors[26], fqt->n_vectors[27],
313 fqt->n_vectors[28], fqt->n_vectors[29],
314 fqt->n_vectors[30], fqt->n_vectors[31]);
322 static clib_error_t *
323 show_frame_queue_trace (vlib_main_t * vm, unformat_input_t * input,
324 vlib_cli_command_t * cmd)
326 vlib_thread_main_t *tm = vlib_get_thread_main ();
327 vlib_frame_queue_main_t *fqm;
330 vec_foreach (fqm, tm->frame_queue_mains)
332 vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):",
333 fqm - tm->frame_queue_mains,
334 format_vlib_node_name, vm, fqm->node_index);
335 error = show_frame_queue_internal (vm, fqm, 0);
342 static clib_error_t *
343 show_frame_queue_histogram (vlib_main_t * vm, unformat_input_t * input,
344 vlib_cli_command_t * cmd)
346 vlib_thread_main_t *tm = vlib_get_thread_main ();
347 vlib_frame_queue_main_t *fqm;
350 vec_foreach (fqm, tm->frame_queue_mains)
352 vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):",
353 fqm - tm->frame_queue_mains,
354 format_vlib_node_name, vm, fqm->node_index);
355 error = show_frame_queue_internal (vm, fqm, 1);
362 VLIB_CLI_COMMAND (cmd_show_frame_queue_trace,static) = {
363 .path = "show frame-queue",
364 .short_help = "show frame-queue trace",
365 .function = show_frame_queue_trace,
368 VLIB_CLI_COMMAND (cmd_show_frame_queue_histogram,static) = {
369 .path = "show frame-queue histogram",
370 .short_help = "show frame-queue histogram",
371 .function = show_frame_queue_histogram,
376 * Modify the number of elements on the frame_queues
378 static clib_error_t *
379 test_frame_queue_nelts (vlib_main_t * vm, unformat_input_t * input,
380 vlib_cli_command_t * cmd)
382 unformat_input_t _line_input, *line_input = &_line_input;
383 vlib_thread_main_t *tm = vlib_get_thread_main ();
384 vlib_frame_queue_main_t *fqm;
385 clib_error_t *error = NULL;
389 u32 index = ~(u32) 0;
391 if (!unformat_user (input, unformat_line_input, line_input))
394 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
396 if (unformat (line_input, "nelts %u", &nelts))
398 else if (unformat (line_input, "index %u", &index))
402 error = clib_error_return (0, "parse error: '%U'",
403 format_unformat_error, line_input);
408 if (index > vec_len (tm->frame_queue_mains) - 1)
410 error = clib_error_return (0,
411 "expecting valid worker handoff queue index");
415 fqm = vec_elt_at_index (tm->frame_queue_mains, index);
417 if ((nelts != 4) && (nelts != 8) && (nelts != 16) && (nelts != 32))
419 error = clib_error_return (0, "expecting 4,8,16,32");
423 num_fq = vec_len (fqm->vlib_frame_queues);
426 vlib_cli_output (vm, "No frame queues exist\n");
430 for (fqix = 0; fqix < num_fq; fqix++)
432 fqm->vlib_frame_queues[fqix]->nelts = nelts;
436 unformat_free (line_input);
441 VLIB_CLI_COMMAND (cmd_test_frame_queue_nelts,static) = {
442 .path = "test frame-queue nelts",
443 .short_help = "test frame-queue nelts (4,8,16,32)",
444 .function = test_frame_queue_nelts,
449 * Modify the max number of packets pulled off the frame queues
451 static clib_error_t *
452 test_frame_queue_threshold (vlib_main_t * vm, unformat_input_t * input,
453 vlib_cli_command_t * cmd)
455 unformat_input_t _line_input, *line_input = &_line_input;
456 vlib_thread_main_t *tm = vlib_get_thread_main ();
457 vlib_frame_queue_main_t *fqm;
458 clib_error_t *error = NULL;
461 u32 threshold = ~(u32) 0;
462 u32 index = ~(u32) 0;
464 if (!unformat_user (input, unformat_line_input, line_input))
467 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
469 if (unformat (line_input, "threshold %u", &threshold))
471 else if (unformat (line_input, "index %u", &index))
475 error = clib_error_return (0, "parse error: '%U'",
476 format_unformat_error, line_input);
481 if (index > vec_len (tm->frame_queue_mains) - 1)
483 error = clib_error_return (0,
484 "expecting valid worker handoff queue index");
488 fqm = vec_elt_at_index (tm->frame_queue_mains, index);
491 if (threshold == ~(u32) 0)
493 vlib_cli_output (vm, "expecting threshold value\n");
500 num_fq = vec_len (fqm->vlib_frame_queues);
503 vlib_cli_output (vm, "No frame queues exist\n");
507 for (fqix = 0; fqix < num_fq; fqix++)
509 fqm->vlib_frame_queues[fqix]->vector_threshold = threshold;
513 unformat_free (line_input);
518 VLIB_CLI_COMMAND (cmd_test_frame_queue_threshold,static) = {
519 .path = "test frame-queue threshold",
520 .short_help = "test frame-queue threshold N (0=no limit)",
521 .function = test_frame_queue_threshold,
525 * fd.io coding-style-patch-verification: ON
528 * eval: (c-set-style "gnu")