1 // SPDX-License-Identifier: GPL-2.0
3 * Support for libpfm4 event encoding.
5 * Copyright 2020 Google LLC.
7 #include "util/cpumap.h"
8 #include "util/debug.h"
9 #include "util/event.h"
10 #include "util/evlist.h"
11 #include "util/evsel.h"
12 #include "util/parse-events.h"
15 #include "util/strbuf.h"
18 #include <linux/kernel.h>
19 #include <perfmon/pfmlib_perf_event.h>
21 static void libpfm_initialize(void)
25 ret = pfm_initialize();
26 if (ret != PFM_SUCCESS) {
27 ui__warning("libpfm failed to initialize: %s\n",
32 int parse_libpfm_events_option(const struct option *opt, const char *str,
33 int unset __maybe_unused)
35 struct evlist *evlist = *(struct evlist **)opt->value;
36 struct perf_event_attr attr;
38 struct evsel *evsel, *grp_leader = NULL;
46 p_orig = p = strdup(str);
50 * force loading of the PMU list
54 for (q = p; strsep(&p, ",{}"); q = p) {
55 sep = p ? str + (p - p_orig - 1) : "";
59 "nested event groups not supported\n");
69 ui__error("cannot close a non-existing event group\n");
77 memset(&attr, 0, sizeof(attr));
78 event_attr_init(&attr);
80 ret = pfm_get_perf_event_encoding(q, PFM_PLM0|PFM_PLM3,
83 if (ret != PFM_SUCCESS) {
84 ui__error("failed to parse event %s : %s\n", str,
89 pmu = perf_pmu__find_by_type((unsigned int)attr.type);
90 evsel = parse_events__add_event(evlist->core.nr_entries,
91 &attr, q, /*metric_id=*/NULL,
96 evsel->is_libpfm_event = true;
98 evlist__add(evlist, evsel);
104 evsel__set_leader(evsel, grp_leader);
105 grp_leader->core.nr_members++;
112 "cannot close a non-existing event group\n");
115 evlist->core.nr_groups++;
127 static const char *srcs[PFM_ATTR_CTRL_MAX] = {
128 [PFM_ATTR_CTRL_UNKNOWN] = "???",
129 [PFM_ATTR_CTRL_PMU] = "PMU",
130 [PFM_ATTR_CTRL_PERF_EVENT] = "perf_event",
134 print_attr_flags(struct strbuf *buf, const pfm_event_attr_info_t *info)
137 strbuf_addf(buf, "[default] ");
139 if (info->is_precise)
140 strbuf_addf(buf, "[precise] ");
144 print_libpfm_event(const struct print_callbacks *print_cb, void *print_state,
145 const pfm_pmu_info_t *pinfo, const pfm_event_info_t *info,
149 char topic[80], name[80];
151 strbuf_setlen(buf, 0);
152 snprintf(topic, sizeof(topic), "pfm %s", pinfo->name);
154 snprintf(name, sizeof(name), "%s::%s", pinfo->name, info->name);
155 strbuf_addf(buf, "Code: 0x%"PRIx64"\n", info->code);
157 pfm_for_each_event_attr(j, info) {
158 pfm_event_attr_info_t ainfo;
161 ainfo.size = sizeof(ainfo);
162 ret = pfm_get_event_attr_info(info->idx, j, PFM_OS_PERF_EVENT_EXT, &ainfo);
163 if (ret != PFM_SUCCESS)
166 if (ainfo.ctrl >= PFM_ATTR_CTRL_MAX)
167 ainfo.ctrl = PFM_ATTR_CTRL_UNKNOWN;
169 src = srcs[ainfo.ctrl];
170 switch (ainfo.type) {
171 case PFM_ATTR_UMASK: /* Ignore for now */
173 case PFM_ATTR_MOD_BOOL:
174 strbuf_addf(buf, " Modif: %s: [%s] : %s (boolean)\n", src,
175 ainfo.name, ainfo.desc);
177 case PFM_ATTR_MOD_INTEGER:
178 strbuf_addf(buf, " Modif: %s: [%s] : %s (integer)\n", src,
179 ainfo.name, ainfo.desc);
182 case PFM_ATTR_RAW_UMASK:
185 strbuf_addf(buf, " Attr: %s: [%s] : %s\n", src,
186 ainfo.name, ainfo.desc);
189 print_cb->print_event(print_state,
194 /*deprecated=*/NULL, "PFM event",
195 info->desc, /*long_desc=*/NULL,
196 /*encoding_desc=*/buf->buf);
198 pfm_for_each_event_attr(j, info) {
199 pfm_event_attr_info_t ainfo;
202 strbuf_setlen(buf, 0);
204 ainfo.size = sizeof(ainfo);
205 ret = pfm_get_event_attr_info(info->idx, j, PFM_OS_PERF_EVENT_EXT, &ainfo);
206 if (ret != PFM_SUCCESS)
209 if (ainfo.ctrl >= PFM_ATTR_CTRL_MAX)
210 ainfo.ctrl = PFM_ATTR_CTRL_UNKNOWN;
212 src = srcs[ainfo.ctrl];
213 if (ainfo.type == PFM_ATTR_UMASK) {
214 strbuf_addf(buf, "Umask: 0x%02"PRIx64" : %s: ",
216 print_attr_flags(buf, &ainfo);
217 snprintf(name, sizeof(name), "%s::%s:%s",
218 pinfo->name, info->name, ainfo.name);
219 print_cb->print_event(print_state,
222 name, /*alias=*/NULL,
224 /*deprecated=*/NULL, "PFM event",
225 ainfo.desc, /*long_desc=*/NULL,
226 /*encoding_desc=*/buf->buf);
231 void print_libpfm_events(const struct print_callbacks *print_cb, void *print_state)
233 pfm_event_info_t info;
234 pfm_pmu_info_t pinfo;
236 struct strbuf storage;
240 /* initialize to zero to indicate ABI version */
241 info.size = sizeof(info);
242 pinfo.size = sizeof(pinfo);
244 strbuf_init(&storage, 2048);
246 pfm_for_all_pmus(p) {
247 ret = pfm_get_pmu_info(p, &pinfo);
248 if (ret != PFM_SUCCESS)
251 /* only print events that are supported by host HW */
252 if (!pinfo.is_present)
255 /* handled by perf directly */
256 if (pinfo.pmu == PFM_PMU_PERF_EVENT)
259 for (int i = pinfo.first_event; i != -1; i = pfm_get_event_next(i)) {
260 ret = pfm_get_event_info(i, PFM_OS_PERF_EVENT_EXT,
262 if (ret != PFM_SUCCESS)
265 print_libpfm_event(print_cb, print_state, &pinfo, &info, &storage);
268 strbuf_release(&storage);