2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2018, Matthew Macy
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/types.h>
32 #include <sys/errno.h>
33 #include <sys/sysctl.h>
42 #include <libpmcstat.h>
43 #include "pmu-events/pmu-events.h"
45 #if defined(__amd64__) || defined(__i386__)
57 static struct pmu_alias pmu_intel_alias_table[] = {
58 {"UNHALTED_CORE_CYCLES", "CPU_CLK_UNHALTED.THREAD_P_ANY"},
59 {"UNHALTED-CORE-CYCLES", "CPU_CLK_UNHALTED.THREAD_P_ANY"},
60 {"LLC_MISSES", "LONGEST_LAT_CACHE.MISS"},
61 {"LLC-MISSES", "LONGEST_LAT_CACHE.MISS"},
62 {"LLC_REFERENCE", "LONGEST_LAT_CACHE.REFERENCE"},
63 {"LLC-REFERENCE", "LONGEST_LAT_CACHE.REFERENCE"},
64 {"LLC_MISS_RHITM", "mem_load_l3_miss_retired.remote_hitm"},
65 {"LLC-MISS-RHITM", "mem_load_l3_miss_retired.remote_hitm"},
66 {"RESOURCE_STALL", "RESOURCE_STALLS.ANY"},
67 {"RESOURCE_STALLS_ANY", "RESOURCE_STALLS.ANY"},
68 {"BRANCH_INSTRUCTION_RETIRED", "BR_INST_RETIRED.ALL_BRANCHES"},
69 {"BRANCH-INSTRUCTION-RETIRED", "BR_INST_RETIRED.ALL_BRANCHES"},
70 {"BRANCH_MISSES_RETIRED", "BR_MISP_RETIRED.ALL_BRANCHES"},
71 {"BRANCH-MISSES-RETIRED", "BR_MISP_RETIRED.ALL_BRANCHES"},
72 {"cycles", "tsc-tsc"},
73 {"unhalted-cycles", "CPU_CLK_UNHALTED.THREAD_P_ANY"},
74 {"instructions", "inst-retired.any_p"},
75 {"branch-mispredicts", "br_misp_retired.all_branches"},
76 {"branches", "br_inst_retired.all_branches"},
77 {"interrupts", "hw_interrupts.received"},
78 {"ic-misses", "frontend_retired.l1i_miss"},
82 static struct pmu_alias pmu_amd_alias_table[] = {
83 {"UNHALTED_CORE_CYCLES", "ls_not_halted_cyc"},
84 {"UNHALTED-CORE-CYCLES", "ls_not_halted_cyc"},
96 if (sysctlbyname("kern.hwpmc.cpuid", (void *)NULL, &s,
97 (void *)NULL, 0) == -1)
99 if ((buf = malloc(s + 1)) == NULL)
100 return (PMU_INVALID);
101 if (sysctlbyname("kern.hwpmc.cpuid", buf, &s,
102 (void *)NULL, 0) == -1) {
104 return (PMU_INVALID);
106 if (strcasestr(buf, "AuthenticAMD") != NULL ||
107 strcasestr(buf, "HygonGenuine") != NULL)
109 else if (strcasestr(buf, "GenuineIntel") != NULL)
118 * The Intel fixed mode counters are:
119 * "inst_retired.any",
120 * "cpu_clk_unhalted.thread",
121 * "cpu_clk_unhalted.thread_any",
122 * "cpu_clk_unhalted.ref_tsc",
127 pmu_alias_get(const char *name)
130 struct pmu_alias *pa;
131 struct pmu_alias *pmu_alias_table;
133 if ((mfr = pmu_events_mfr()) == PMU_INVALID)
136 pmu_alias_table = pmu_amd_alias_table;
137 else if (mfr == PMU_INTEL)
138 pmu_alias_table = pmu_intel_alias_table;
142 for (pa = pmu_alias_table; pa->pa_alias != NULL; pa++)
143 if (strcasecmp(name, pa->pa_alias) == 0)
144 return (pa->pa_name);
149 struct pmu_event_desc {
151 uint64_t ped_offcore_rsp;
152 uint64_t ped_l3_thread;
153 uint64_t ped_l3_slice;
155 uint32_t ped_frontend;
157 uint32_t ped_config1;
167 static const struct pmu_events_map *
168 pmu_events_map_get(const char *cpuid)
171 regmatch_t pmatch[1];
175 const struct pmu_events_map *pme;
178 memcpy(buf, cpuid, 64);
180 if (sysctlbyname("kern.hwpmc.cpuid", (void *)NULL, &s,
181 (void *)NULL, 0) == -1)
183 if (sysctlbyname("kern.hwpmc.cpuid", buf, &s,
184 (void *)NULL, 0) == -1)
187 for (pme = pmu_events_map; pme->cpuid != NULL; pme++) {
188 if (regcomp(&re, pme->cpuid, REG_EXTENDED) != 0) {
189 printf("regex '%s' failed to compile, ignoring\n",
193 match = regexec(&re, buf, 1, pmatch, 0);
196 len = pmatch[0].rm_eo - pmatch[0].rm_so;
197 if(len == strlen(buf))
204 static const struct pmu_event *
205 pmu_event_get(const char *cpuid, const char *event_name, int *idx)
207 const struct pmu_events_map *pme;
208 const struct pmu_event *pe;
211 if ((pme = pmu_events_map_get(cpuid)) == NULL)
213 for (i = 0, pe = pme->table; pe->name || pe->desc || pe->event; pe++, i++) {
214 if (pe->name == NULL)
216 if (strcasecmp(pe->name, event_name) == 0) {
226 pmc_pmu_idx_get_by_event(const char *cpuid, const char *event)
229 const char *realname;
231 realname = pmu_alias_get(event);
232 if (pmu_event_get(cpuid, realname, &idx) == NULL)
238 pmc_pmu_event_get_by_idx(const char *cpuid, int idx)
240 const struct pmu_events_map *pme;
242 if ((pme = pmu_events_map_get(cpuid)) == NULL)
244 assert(pme->table[idx].name);
245 return (pme->table[idx].name);
249 pmu_parse_event(struct pmu_event_desc *ped, const char *eventin)
252 char *kvp, *key, *value, *r;
255 if ((event = strdup(eventin)) == NULL)
258 bzero(ped, sizeof(*ped));
259 ped->ped_period = DEFAULT_SAMPLE_COUNT;
261 while ((kvp = strsep(&event, ",")) != NULL) {
262 key = strsep(&kvp, "=");
266 if (strcmp(key, "umask") == 0)
267 ped->ped_umask = strtol(value, NULL, 16);
268 else if (strcmp(key, "event") == 0)
269 ped->ped_event = strtol(value, NULL, 16);
270 else if (strcmp(key, "period") == 0)
271 ped->ped_period = strtol(value, NULL, 10);
272 else if (strcmp(key, "offcore_rsp") == 0)
273 ped->ped_offcore_rsp = strtol(value, NULL, 16);
274 else if (strcmp(key, "any") == 0)
275 ped->ped_any = strtol(value, NULL, 10);
276 else if (strcmp(key, "cmask") == 0)
277 ped->ped_cmask = strtol(value, NULL, 10);
278 else if (strcmp(key, "inv") == 0)
279 ped->ped_inv = strtol(value, NULL, 10);
280 else if (strcmp(key, "edge") == 0)
281 ped->ped_edge = strtol(value, NULL, 10);
282 else if (strcmp(key, "frontend") == 0)
283 ped->ped_frontend = strtol(value, NULL, 16);
284 else if (strcmp(key, "ldlat") == 0)
285 ped->ped_ldlat = strtol(value, NULL, 16);
286 else if (strcmp(key, "fc_mask") == 0)
287 ped->ped_fc_mask = strtol(value, NULL, 16);
288 else if (strcmp(key, "ch_mask") == 0)
289 ped->ped_ch_mask = strtol(value, NULL, 16);
290 else if (strcmp(key, "config1") == 0)
291 ped->ped_config1 = strtol(value, NULL, 16);
292 else if (strcmp(key, "l3_thread_mask") == 0)
293 ped->ped_l3_thread = strtol(value, NULL, 16);
294 else if (strcmp(key, "l3_slice_mask") == 0)
295 ped->ped_l3_slice = strtol(value, NULL, 16);
297 debug = getenv("PMUDEBUG");
298 if (debug != NULL && strcmp(debug, "true") == 0 && value != NULL)
299 printf("unrecognized kvpair: %s:%s\n", key, value);
307 pmc_pmu_sample_rate_get(const char *event_name)
309 const struct pmu_event *pe;
310 struct pmu_event_desc ped;
312 event_name = pmu_alias_get(event_name);
313 if ((pe = pmu_event_get(NULL, event_name, NULL)) == NULL)
314 return (DEFAULT_SAMPLE_COUNT);
315 if (pe->alias && (pe = pmu_event_get(NULL, pe->alias, NULL)) == NULL)
316 return (DEFAULT_SAMPLE_COUNT);
317 if (pe->event == NULL)
318 return (DEFAULT_SAMPLE_COUNT);
319 if (pmu_parse_event(&ped, pe->event))
320 return (DEFAULT_SAMPLE_COUNT);
321 return (ped.ped_period);
325 pmc_pmu_enabled(void)
328 return (pmu_events_map_get(NULL) != NULL);
332 pmc_pmu_print_counters(const char *event_name)
334 const struct pmu_events_map *pme;
335 const struct pmu_event *pe;
336 struct pmu_event_desc ped;
340 debug = getenv("PMUDEBUG");
343 if (debug != NULL && strcmp(debug, "true") == 0)
345 if ((pme = pmu_events_map_get(NULL)) == NULL)
347 for (pe = pme->table; pe->name || pe->desc || pe->event; pe++) {
348 if (pe->name == NULL)
350 if (event_name != NULL && strcasestr(pe->name, event_name) == NULL)
352 printf("\t%s\n", pe->name);
354 pmu_parse_event(&ped, pe->event);
359 pmc_pmu_print_counter_desc(const char *ev)
361 const struct pmu_events_map *pme;
362 const struct pmu_event *pe;
364 if ((pme = pmu_events_map_get(NULL)) == NULL)
366 for (pe = pme->table; pe->name || pe->desc || pe->event; pe++) {
367 if (pe->name == NULL)
369 if (strcasestr(pe->name, ev) != NULL &&
371 printf("%s:\t%s\n", pe->name, pe->desc);
376 pmc_pmu_print_counter_desc_long(const char *ev)
378 const struct pmu_events_map *pme;
379 const struct pmu_event *pe;
381 if ((pme = pmu_events_map_get(NULL)) == NULL)
383 for (pe = pme->table; pe->name || pe->desc || pe->event; pe++) {
384 if (pe->name == NULL)
386 if (strcasestr(pe->name, ev) != NULL) {
387 if (pe->long_desc != NULL)
388 printf("%s:\n%s\n", pe->name, pe->long_desc);
389 else if (pe->desc != NULL)
390 printf("%s:\t%s\n", pe->name, pe->desc);
396 pmc_pmu_print_counter_full(const char *ev)
398 const struct pmu_events_map *pme;
399 const struct pmu_event *pe;
401 if ((pme = pmu_events_map_get(NULL)) == NULL)
403 for (pe = pme->table; pe->name || pe->desc || pe->event; pe++) {
404 if (pe->name == NULL)
406 if (strcasestr(pe->name, ev) == NULL)
408 printf("name: %s\n", pe->name);
409 if (pe->long_desc != NULL)
410 printf("desc: %s\n", pe->long_desc);
411 else if (pe->desc != NULL)
412 printf("desc: %s\n", pe->desc);
413 if (pe->event != NULL)
414 printf("event: %s\n", pe->event);
415 if (pe->topic != NULL)
416 printf("topic: %s\n", pe->topic);
418 printf("pmu: %s\n", pe->pmu);
419 if (pe->unit != NULL)
420 printf("unit: %s\n", pe->unit);
421 if (pe->perpkg != NULL)
422 printf("perpkg: %s\n", pe->perpkg);
423 if (pe->metric_expr != NULL)
424 printf("metric_expr: %s\n", pe->metric_expr);
425 if (pe->metric_name != NULL)
426 printf("metric_name: %s\n", pe->metric_name);
427 if (pe->metric_group != NULL)
428 printf("metric_group: %s\n", pe->metric_group);
433 pmc_pmu_amd_pmcallocate(const char *event_name, struct pmc_op_pmcallocate *pm,
434 struct pmu_event_desc *ped)
436 struct pmc_md_amd_op_pmcallocate *amd;
437 const struct pmu_event *pe;
440 amd = &pm->pm_md.pm_amd;
441 if (ped->ped_umask > 0) {
442 pm->pm_caps |= PMC_CAP_QUALIFIER;
443 amd->pm_amd_config |= AMD_PMC_TO_UNITMASK(ped->ped_umask);
445 pm->pm_class = PMC_CLASS_K8;
446 pe = pmu_event_get(NULL, event_name, &idx);
448 if (strcmp("l3cache", pe->topic) == 0){
449 amd->pm_amd_config |= AMD_PMC_TO_EVENTMASK(ped->ped_event);
450 amd->pm_amd_sub_class = PMC_AMD_SUB_CLASS_L3_CACHE;
451 amd->pm_amd_config |= AMD_PMC_TO_L3SLICE(ped->ped_l3_slice);
452 amd->pm_amd_config |= AMD_PMC_TO_L3CORE(ped->ped_l3_thread);
454 else if (strcmp("data fabric", pe->topic) == 0){
456 amd->pm_amd_config |= AMD_PMC_TO_EVENTMASK_DF(ped->ped_event);
457 amd->pm_amd_sub_class = PMC_AMD_SUB_CLASS_DATA_FABRIC;
460 amd->pm_amd_config |= AMD_PMC_TO_EVENTMASK(ped->ped_event);
461 amd->pm_amd_sub_class = PMC_AMD_SUB_CLASS_CORE;
462 if ((pm->pm_caps & (PMC_CAP_USER|PMC_CAP_SYSTEM)) == 0 ||
463 (pm->pm_caps & (PMC_CAP_USER|PMC_CAP_SYSTEM)) ==
464 (PMC_CAP_USER|PMC_CAP_SYSTEM))
465 amd->pm_amd_config |= (AMD_PMC_USR | AMD_PMC_OS);
466 else if (pm->pm_caps & PMC_CAP_USER)
467 amd->pm_amd_config |= AMD_PMC_USR;
468 else if (pm->pm_caps & PMC_CAP_SYSTEM)
469 amd->pm_amd_config |= AMD_PMC_OS;
471 amd->pm_amd_config |= AMD_PMC_EDGE;
473 amd->pm_amd_config |= AMD_PMC_EDGE;
474 if (pm->pm_caps & PMC_CAP_INTERRUPT)
475 amd->pm_amd_config |= AMD_PMC_INT;
481 pmc_pmu_intel_pmcallocate(const char *event_name, struct pmc_op_pmcallocate *pm,
482 struct pmu_event_desc *ped)
484 struct pmc_md_iap_op_pmcallocate *iap;
488 iap = &pm->pm_md.pm_iap;
489 if (strcasestr(event_name, "UNC_") == event_name ||
490 strcasestr(event_name, "uncore") != NULL) {
491 pm->pm_class = PMC_CLASS_UCP;
492 pm->pm_caps |= PMC_CAP_QUALIFIER;
493 } else if ((ped->ped_umask == -1) ||
494 (ped->ped_event == 0x0 && ped->ped_umask == 0x3)) {
495 pm->pm_class = PMC_CLASS_IAF;
497 pm->pm_class = PMC_CLASS_IAP;
498 pm->pm_caps |= PMC_CAP_QUALIFIER;
500 iap->pm_iap_config |= IAP_EVSEL(ped->ped_event);
501 if (ped->ped_umask > 0)
502 iap->pm_iap_config |= IAP_UMASK(ped->ped_umask);
503 iap->pm_iap_config |= IAP_CMASK(ped->ped_cmask);
504 iap->pm_iap_rsp = ped->ped_offcore_rsp;
506 if ((pm->pm_caps & (PMC_CAP_USER|PMC_CAP_SYSTEM)) == 0 ||
507 (pm->pm_caps & (PMC_CAP_USER|PMC_CAP_SYSTEM)) ==
508 (PMC_CAP_USER|PMC_CAP_SYSTEM))
509 iap->pm_iap_config |= (IAP_USR | IAP_OS);
510 else if (pm->pm_caps & PMC_CAP_USER)
511 iap->pm_iap_config |= IAP_USR;
512 else if (pm->pm_caps & PMC_CAP_SYSTEM)
513 iap->pm_iap_config |= IAP_OS;
515 iap->pm_iap_config |= IAP_EDGE;
517 iap->pm_iap_config |= IAP_ANY;
519 iap->pm_iap_config |= IAP_EDGE;
520 if (pm->pm_caps & PMC_CAP_INTERRUPT)
521 iap->pm_iap_config |= IAP_INT;
526 pmc_pmu_pmcallocate(const char *event_name, struct pmc_op_pmcallocate *pm)
528 const struct pmu_event *pe;
529 struct pmu_event_desc ped;
533 if ((mfr = pmu_events_mfr()) == PMU_INVALID)
536 bzero(&pm->pm_md, sizeof(pm->pm_md));
537 pm->pm_caps |= (PMC_CAP_READ | PMC_CAP_WRITE);
538 event_name = pmu_alias_get(event_name);
539 if ((pe = pmu_event_get(NULL, event_name, &idx)) == NULL)
541 if (pe->alias && (pe = pmu_event_get(NULL, pe->alias, &idx)) == NULL)
546 if (pe->event == NULL)
548 if (pmu_parse_event(&ped, pe->event))
551 if (mfr == PMU_INTEL)
552 return (pmc_pmu_intel_pmcallocate(event_name, pm, &ped));
554 return (pmc_pmu_amd_pmcallocate(event_name, pm, &ped));
558 * Ultimately rely on AMD calling theirs the same
560 static const char *stat_mode_cntrs[] = {
561 "cpu_clk_unhalted.thread",
563 "br_inst_retired.all_branches",
564 "br_misp_retired.all_branches",
565 "longest_lat_cache.reference",
566 "longest_lat_cache.miss",
570 pmc_pmu_stat_mode(const char ***cntrs)
572 if (pmc_pmu_enabled()) {
573 *cntrs = stat_mode_cntrs;
582 pmc_pmu_sample_rate_get(const char *event_name __unused)
584 return (DEFAULT_SAMPLE_COUNT);
588 pmc_pmu_print_counters(const char *event_name __unused)
593 pmc_pmu_print_counter_desc(const char *e __unused)
598 pmc_pmu_print_counter_desc_long(const char *e __unused)
603 pmc_pmu_print_counter_full(const char *e __unused)
609 pmc_pmu_enabled(void)
615 pmc_pmu_pmcallocate(const char *e __unused, struct pmc_op_pmcallocate *p __unused)
621 pmc_pmu_event_get_by_idx(const char *c __unused, int idx __unused)
627 pmc_pmu_stat_mode(const char ***a __unused)
633 pmc_pmu_idx_get_by_event(const char *c __unused, const char *e __unused)