2 * perfmon.c - skeleton vpp engine plug-in
4 * Copyright (c) <current-year> <your-organization>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <perfmon/perfmon.h>
20 #include <perfmon/perfmon_intel.h>
22 #include <vlibapi/api.h>
23 #include <vlibmemory/api.h>
24 #include <vpp/app/version.h>
25 #include <linux/limits.h>
27 perfmon_main_t perfmon_main;
30 perfmon_register_intel_pmc (perfmon_intel_pmc_cpu_model_t * m, int n_models,
31 perfmon_intel_pmc_event_t * e, int n_events)
33 perfmon_main_t *pm = &perfmon_main;
34 perfmon_intel_pmc_registration_t r;
38 r.n_events = n_events;
39 r.n_models = n_models;
41 vec_add1 (pm->perfmon_tables, r);
47 #if defined(__x86_64__)
49 asm volatile ("mov $1, %%eax; cpuid; mov %%eax, %0":"=r" (cpuid)::"%eax",
50 "%edx", "%ecx", "%rbx");
58 perfmon_cpu_model_matches (perfmon_intel_pmc_cpu_model_t * mt,
59 u32 n_models, u8 model, u8 stepping)
62 for (i = 0; i < n_models; i++)
64 if (mt[i].model != model)
67 if (mt[i].has_stepping)
69 if (mt[i].stepping != stepping)
78 static perfmon_intel_pmc_event_t *
79 perfmon_find_table_by_model_stepping (perfmon_main_t * pm,
80 u8 model, u8 stepping)
82 perfmon_intel_pmc_registration_t *rt;
84 vec_foreach (rt, pm->perfmon_tables)
86 if (perfmon_cpu_model_matches (rt->models, rt->n_models, model, stepping))
93 perfmon_init (vlib_main_t * vm)
95 perfmon_main_t *pm = &perfmon_main;
96 clib_error_t *error = 0;
99 perfmon_intel_pmc_event_t *ev;
103 pm->vnet_main = vnet_get_main ();
105 pm->capture_by_thread_and_node_name =
106 hash_create_string (0, sizeof (uword));
108 pm->log_class = vlib_log_register_class ("perfmon", 0);
110 /* Default data collection interval */
111 pm->timeout_interval = 2.0; /* seconds */
113 vec_validate (pm->threads, vlib_get_thread_main ()->n_vlib_mains - 1);
114 for (i = 0; i < vec_len (pm->threads); i++)
116 perfmon_thread_t *pt = clib_mem_alloc_aligned
117 (sizeof (perfmon_thread_t), CLIB_CACHE_LINE_BYTES);
118 clib_memset (pt, 0, sizeof (*pt));
123 pm->page_size = getpagesize ();
125 pm->perfmon_table = 0;
126 pm->pmc_event_by_name = 0;
128 cpuid = get_cpuid ();
129 model = ((cpuid >> 12) & 0xf0) | ((cpuid >> 4) & 0xf);
130 stepping = cpuid & 0xf;
132 pm->perfmon_table = perfmon_find_table_by_model_stepping (pm,
135 if (pm->perfmon_table == 0)
137 vlib_log_err (pm->log_class, "No table for cpuid %x", cpuid);
138 vlib_log_err (pm->log_class, " model %x, stepping %x",
143 pm->pmc_event_by_name = hash_create_string (0, sizeof (u32));
144 ev = pm->perfmon_table;
146 for (; ev->event_name; ev++)
148 hash_set_mem (pm->pmc_event_by_name, ev->event_name,
149 ev - pm->perfmon_table);
156 VLIB_INIT_FUNCTION (perfmon_init);
159 unformat_processor_event (unformat_input_t * input, va_list * args)
161 perfmon_main_t *pm = va_arg (*args, perfmon_main_t *);
162 perfmon_event_config_t *ep = va_arg (*args, perfmon_event_config_t *);
168 if (pm->perfmon_table == 0 || pm->pmc_event_by_name == 0)
171 if (!unformat (input, "%s", &s))
174 hp = hash_get_pair_mem (pm->pmc_event_by_name, s);
181 idx = (u32) (hp->value[0]);
183 pe_config |= pm->perfmon_table[idx].event_code[0];
184 pe_config |= pm->perfmon_table[idx].umask << 8;
185 pe_config |= pm->perfmon_table[idx].edge << 18;
186 pe_config |= pm->perfmon_table[idx].anyt << 21;
187 pe_config |= pm->perfmon_table[idx].inv << 23;
188 pe_config |= pm->perfmon_table[idx].cmask << 24;
190 ep->name = (char *) hp->key;
191 ep->pe_type = PERF_TYPE_RAW;
192 ep->pe_config = pe_config;
196 static clib_error_t *
197 set_pmc_command_fn (vlib_main_t * vm,
198 unformat_input_t * input, vlib_cli_command_t * cmd)
200 perfmon_main_t *pm = &perfmon_main;
201 vlib_thread_main_t *vtm = vlib_get_thread_main ();
202 int num_threads = 1 + vtm->n_threads;
203 unformat_input_t _line_input, *line_input = &_line_input;
204 perfmon_event_config_t ec;
211 vec_reset_length (pm->single_events_to_collect);
212 vec_reset_length (pm->paired_events_to_collect);
213 pm->ipc_event_index = ~0;
214 pm->mispredict_event_index = ~0;
216 if (!unformat_user (input, unformat_line_input, line_input))
217 return clib_error_return (0, "counter names required...");
219 clib_bitmap_zero (pm->thread_bitmap);
221 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
223 if (unformat (line_input, "timeout %u", &timeout_seconds))
224 pm->timeout_interval = (f64) timeout_seconds;
225 else if (unformat (line_input, "instructions-per-clock"))
227 ec.name = "instructions";
228 ec.pe_type = PERF_TYPE_HARDWARE;
229 ec.pe_config = PERF_COUNT_HW_INSTRUCTIONS;
230 pm->ipc_event_index = vec_len (pm->paired_events_to_collect);
231 vec_add1 (pm->paired_events_to_collect, ec);
232 ec.name = "cpu-cycles";
233 ec.pe_type = PERF_TYPE_HARDWARE;
234 ec.pe_config = PERF_COUNT_HW_CPU_CYCLES;
235 vec_add1 (pm->paired_events_to_collect, ec);
237 else if (unformat (line_input, "branch-mispredict-rate"))
239 ec.name = "branch-misses";
240 ec.pe_type = PERF_TYPE_HARDWARE;
241 ec.pe_config = PERF_COUNT_HW_BRANCH_MISSES;
242 pm->mispredict_event_index = vec_len (pm->paired_events_to_collect);
243 vec_add1 (pm->paired_events_to_collect, ec);
244 ec.name = "branches";
245 ec.pe_type = PERF_TYPE_HARDWARE;
246 ec.pe_config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS;
247 vec_add1 (pm->paired_events_to_collect, ec);
249 else if (unformat (line_input, "threads %U",
250 unformat_bitmap_list, &pm->thread_bitmap))
252 else if (unformat (line_input, "thread %U",
253 unformat_bitmap_list, &pm->thread_bitmap))
255 else if (unformat (line_input, "%U", unformat_processor_event, pm, &ec))
257 vec_add1 (pm->single_events_to_collect, ec);
259 #define _(type,event,str) \
260 else if (unformat (line_input, str)) \
264 ec.pe_config = event; \
265 vec_add1 (pm->single_events_to_collect, ec); \
267 foreach_perfmon_event
271 error = clib_error_return (0, "unknown input '%U'",
272 format_unformat_error, line_input);
273 unformat_free (line_input);
278 unformat_free (line_input);
280 last_set = clib_bitmap_last_set (pm->thread_bitmap);
281 if (last_set != ~0 && last_set >= num_threads)
282 return clib_error_return (0, "thread %d does not exist", last_set);
284 /* Stick paired events at the front of the (unified) list */
285 if (vec_len (pm->paired_events_to_collect) > 0)
287 perfmon_event_config_t *tmp;
288 /* first 2n events are pairs... */
289 vec_append (pm->paired_events_to_collect, pm->single_events_to_collect);
290 tmp = pm->single_events_to_collect;
291 pm->single_events_to_collect = pm->paired_events_to_collect;
292 pm->paired_events_to_collect = tmp;
295 if (vec_len (pm->single_events_to_collect) == 0)
296 return clib_error_return (0, "no events specified...");
298 /* Figure out how long data collection will take */
300 ((f64) vec_len (pm->single_events_to_collect)) * pm->timeout_interval;
301 delay /= 2.0; /* collect 2 stats at once */
303 vlib_cli_output (vm, "Start collection for %d events, wait %.2f seconds",
304 vec_len (pm->single_events_to_collect), delay);
306 vlib_process_signal_event (pm->vlib_main, perfmon_periodic_node.index,
309 /* Coarse-grained wait */
310 vlib_process_suspend (vm, delay);
313 /* Reasonable to guess that collection may not be quite done... */
314 while (pm->state == PERFMON_STATE_RUNNING)
316 vlib_process_suspend (vm, 10e-3);
319 vlib_cli_output (vm, "DEADMAN: collection still running...");
324 vlib_cli_output (vm, "Data collection complete...");
329 VLIB_CLI_COMMAND (set_pmc_command, static) =
332 .short_help = "set pmc [threads n,n1-n2] c1... [see \"show pmc events\"]",
333 .function = set_pmc_command_fn,
339 capture_name_sort (void *a1, void *a2)
341 perfmon_capture_t *c1 = a1;
342 perfmon_capture_t *c2 = a2;
344 return strcmp ((char *) c1->thread_and_node_name,
345 (char *) c2->thread_and_node_name);
349 format_capture (u8 * s, va_list * args)
351 perfmon_main_t *pm = va_arg (*args, perfmon_main_t *);
352 perfmon_capture_t *c = va_arg (*args, perfmon_capture_t *);
353 int verbose __attribute__ ((unused)) = va_arg (*args, int);
359 s = format (s, "%=40s%=20s%=16s%=16s%=16s",
360 "Name", "Counter", "Count", "Pkts", "Counts/Pkt");
364 for (i = 0; i < vec_len (c->counter_names); i++)
369 name = c->thread_and_node_name;
376 /* Deal with synthetic events right here */
377 if (i == pm->ipc_event_index)
380 ASSERT ((i + 1) < vec_len (c->counter_names));
382 if (c->counter_values[i + 1] > 0)
383 ipc_rate = (f64) c->counter_values[i]
384 / (f64) c->counter_values[i + 1];
388 s = format (s, "%-40s%+20s%+16llu%+16llu%+16.2e\n",
389 name, "instructions-per-clock",
390 c->counter_values[i],
391 c->counter_values[i + 1], ipc_rate);
395 if (i == pm->mispredict_event_index)
398 ASSERT (i + 1 < vec_len (c->counter_names));
400 if (c->counter_values[i + 1] > 0)
401 mispredict_rate = (f64) c->counter_values[i]
402 / (f64) c->counter_values[i + 1];
404 mispredict_rate = 0.0;
406 s = format (s, "%-40s%+20s%+16llu%+16llu%+16.2e\n",
407 name, "branch-mispredict-rate",
408 c->counter_values[i],
409 c->counter_values[i + 1], mispredict_rate);
413 if (c->vectors_this_counter[i])
415 ((f64) c->counter_values[i]) / ((f64) c->vectors_this_counter[i]);
419 s = format (s, "%-40s%+20s%+16llu%+16llu%+16.2e",
420 name, c->counter_names[i],
421 c->counter_values[i],
422 c->vectors_this_counter[i], ticks_per_pkt);
428 format_generic_events (u8 * s, va_list * args)
430 int verbose = va_arg (*args, int);
432 #define _(type,config,name) \
434 s = format (s, "\n %s", name); \
436 s = format (s, "\n %s (%d, %d)", name, type, config);
437 foreach_perfmon_event;
449 sort_nvps_by_name (void *a1, void *a2)
451 sort_nvp_t *nvp1 = a1;
452 sort_nvp_t *nvp2 = a2;
454 return strcmp ((char *) nvp1->name, (char *) nvp2->name);
458 format_pmc_event (u8 * s, va_list * args)
460 perfmon_intel_pmc_event_t *ev = va_arg (*args, perfmon_intel_pmc_event_t *);
462 s = format (s, "%s\n", ev->event_name);
463 s = format (s, " umask: 0x%x\n", ev->umask);
464 s = format (s, " code: 0x%x", ev->event_code[0]);
466 if (ev->event_code[1])
467 s = format (s, " , 0x%x\n", ev->event_code[1]);
469 s = format (s, "\n");
475 format_processor_events (u8 * s, va_list * args)
477 perfmon_main_t *pm = va_arg (*args, perfmon_main_t *);
478 int verbose = va_arg (*args, int);
479 sort_nvp_t *sort_nvps = 0;
485 hash_foreach_mem (key, value, pm->pmc_event_by_name,
487 vec_add2 (sort_nvps, sn, 1);
492 vec_sort_with_function (sort_nvps, sort_nvps_by_name);
496 vec_foreach (sn, sort_nvps)
497 s = format (s, "\n %s ", sn->name);
501 vec_foreach (sn, sort_nvps)
502 s = format(s, "%U", format_pmc_event, &pm->perfmon_table[sn->index]);
504 vec_free (sort_nvps);
509 static clib_error_t *
510 show_pmc_command_fn (vlib_main_t * vm,
511 unformat_input_t * input, vlib_cli_command_t * cmd)
513 perfmon_main_t *pm = &perfmon_main;
517 perfmon_capture_t *c;
518 perfmon_capture_t *captures = 0;
520 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
522 if (unformat (input, "events"))
524 else if (unformat (input, "verbose"))
532 vlib_cli_output (vm, "Generic Events %U",
533 format_generic_events, verbose);
534 vlib_cli_output (vm, "Synthetic Events");
535 vlib_cli_output (vm, " instructions-per-clock");
536 vlib_cli_output (vm, " branch-mispredict-rate");
537 if (pm->perfmon_table)
538 vlib_cli_output (vm, "Processor Events %U",
539 format_processor_events, pm, verbose);
543 if (pm->state == PERFMON_STATE_RUNNING)
545 vlib_cli_output (vm, "Data collection in progress...");
549 if (pool_elts (pm->capture_pool) == 0)
551 vlib_cli_output (vm, "No data...");
556 pool_foreach (c, pm->capture_pool)
558 vec_add1 (captures, *c);
562 vec_sort_with_function (captures, capture_name_sort);
564 vlib_cli_output (vm, "%U", format_capture, pm, 0 /* header */ ,
567 for (i = 0; i < vec_len (captures); i++)
571 vlib_cli_output (vm, "%U", format_capture, pm, c, verbose);
580 VLIB_CLI_COMMAND (show_pmc_command, static) =
583 .short_help = "show pmc [verbose]",
584 .function = show_pmc_command_fn,
589 static clib_error_t *
590 clear_pmc_command_fn (vlib_main_t * vm,
591 unformat_input_t * input, vlib_cli_command_t * cmd)
593 perfmon_main_t *pm = &perfmon_main;
597 if (pm->state == PERFMON_STATE_RUNNING)
599 vlib_cli_output (vm, "Performance monitor is still running...");
603 pool_free (pm->capture_pool);
606 hash_foreach_mem (key, value, pm->capture_by_thread_and_node_name,
611 hash_free (pm->capture_by_thread_and_node_name);
612 pm->capture_by_thread_and_node_name =
613 hash_create_string (0, sizeof (uword));
618 VLIB_CLI_COMMAND (clear_pmc_command, static) =
621 .short_help = "clear the performance monitor counters",
622 .function = clear_pmc_command_fn,
628 * fd.io coding-style-patch-verification: ON
631 * eval: (c-set-style "gnu")