perf tools: add support for lipfm4
Subsystems (4)
Ian Rogers
reviewerPATCH v2 1/1 perf tools: add support for lipfm4
This patch links perf with the libpfm4 library if it is available and NO_LIBPFM4 isn't passed to the build. The libpfm4 library contains hardware event tables for all processors supported by perf_events. It is a helper library that helps convert from a symbolic event name to the event encoding required by the underlying kernel interface. This library is open-source and available from: http://perfmon2.sf.net.
With this patch, it is possible to specify full hardware events by name. Hardware filters are also supported. Events must be specified via the --pfm-events and not -e option. Both options are active at the same time and it is possible to mix and match:
$ perf stat --pfm-events inst_retired:any_p:c=1:i -e cycles ....
v2 of this patch makes the --pfm-events man page documentation conditional on libpfm4 behing configured. It tidies some of the documentation and adds the feature test missed in the v1 patch.
Author: Stephane Eranian <[email protected]>
--- tools/build/Makefile.feature | 6 +- tools/build/feature/Makefile | 7 +- tools/build/feature/test-libpfm4.c | 8 + tools/perf/Documentation/Makefile | 4 +- tools/perf/Documentation/perf-record.txt | 11 + tools/perf/Documentation/perf-stat.txt | 10 + tools/perf/Documentation/perf-top.txt | 11 + tools/perf/Makefile.config | 13 ++ tools/perf/Makefile.perf | 6 +- tools/perf/builtin-list.c | 16 ++ tools/perf/builtin-record.c | 20 ++ tools/perf/builtin-stat.c | 21 ++ tools/perf/builtin-top.c | 20 ++ tools/perf/util/evsel.c | 2 +- tools/perf/util/evsel.h | 1 + tools/perf/util/parse-events.c | 246 +++++++++++++++++++++++ tools/perf/util/parse-events.h | 5 + tools/perf/util/pmu.c | 11 + tools/perf/util/pmu.h | 1 + 19 files changed, 411 insertions(+), 8 deletions(-) create mode 100644 tools/build/feature/test-libpfm4.c
tools/build/Makefile.feature +4 -2
@@ -72,7 +72,8 @@ FEATURE_TESTS_BASIC := \ setns \ libaio \ libzstd \ - disassembler-four-args + disassembler-four-args \ + libpfm4 # FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list # of all feature tests
@@ -127,7 +128,8 @@ FEATURE_DISPLAY ?= \ bpf \ libaio \ libzstd \ - disassembler-four-args + disassembler-four-args \ + libpfm4 # Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features. # If in the future we need per-feature checks/flags for features not
tools/build/feature/Makefile +6 -1
@@ -67,7 +67,9 @@ FILES= \ test-llvm.bin \ test-llvm-version.bin \ test-libaio.bin \ - test-libzstd.bin + test-libzstd.bin \ + test-libpfm4.bin + FILES := $(addprefix $(OUTPUT),$(FILES))
@@ -321,6 +323,9 @@ $(OUTPUT)test-libaio.bin: $(OUTPUT)test-libzstd.bin: $(BUILD) -lzstd +$(OUTPUT)test-libpfm4.bin: + $(BUILD) -lpfm + ############################### clean:
tools/build/feature/test-libpfm4.c new file +8 -0
@@ -0,0 +1,8 @@ +#include <sys/types.h> +#include <perfmon/pfmlib.h> + +int main (void ) +{ +pfm_initialize (); +return 0 ; +}
tools/perf/Documentation/Makefile +2 -2
@@ -48,7 +48,7 @@ man5dir=$(mandir)/man5 man7dir=$(mandir)/man7 ASCIIDOC=asciidoc -ASCIIDOC_EXTRA = --unsafe -f asciidoc.conf +ASCIIDOC_EXTRA += --unsafe -f asciidoc.conf ASCIIDOC_HTML = xhtml11 MANPAGE_XSL = manpage-normal.xsl XMLTO_EXTRA =
@@ -59,7 +59,7 @@ HTML_REF = origin/html ifdef USE_ASCIIDOCTOR ASCIIDOC = asciidoctor -ASCIIDOC_EXTRA = -a compat-mode +ASCIIDOC_EXTRA += -a compat-mode ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions ASCIIDOC_EXTRA += -a mansource="perf" -a manmanual="perf Manual" ASCIIDOC_HTML = xhtml5
tools/perf/Documentation/perf-record.txt +11 -0
@@ -587,6 +587,17 @@ Make a copy of /proc/kcore and place it into a directory with the perf data file Limit the sample data max size, <size> is expected to be a number with appended unit character - B/K/M/G +ifdef::HAVE_LIBPFM[] +--pfm-events events:: +Select a PMU event using libpfm4 syntax (see http://perfmon2.sf.net) +including support for event filters. For example '--pfm-events +inst_retired:any_p:u:c=1:i'. More than one event can be passed to the +option using the comma separator. Hardware events and generic hardware +events cannot be mixed together. The latter must be used with the -e +option. The -e option and this one can be mixed and matched. Events +can be grouped using the {} notation. +endif::HAVE_LIBPFM[] + SEE ALSO -------- linkperf:perf-stat[1], linkperf:perf-list[1]
tools/perf/Documentation/perf-stat.txt +10 -0
@@ -71,6 +71,16 @@ report:: --tid=<tid>:: stat events on existing thread id (comma separated list) +ifdef::HAVE_LIBPFM[] +--pfm-events events:: +Select a PMU event using libpfm4 syntax (see http://perfmon2.sf.net) +including support for event filters. For example '--pfm-events +inst_retired:any_p:u:c=1:i'. More than one event can be passed to the +option using the comma separator. Hardware events and generic hardware +events cannot be mixed together. The latter must be used with the -e +option. The -e option and this one can be mixed and matched. Events +can be grouped using the {} notation. +endif::HAVE_LIBPFM[] -a:: --all-cpus::
tools/perf/Documentation/perf-top.txt +11 -0
@@ -310,6 +310,17 @@ Default is to monitor all CPUS. go straight to the histogram browser, just like 'perf top' with no events explicitely specified does. +ifdef::HAVE_LIBPFM[] +--pfm-events events:: +Select a PMU event using libpfm4 syntax (see http://perfmon2.sf.net) +including support for event filters. For example '--pfm-events +inst_retired:any_p:u:c=1:i'. More than one event can be passed to the +option using the comma separator. Hardware events and generic hardware +events cannot be mixed together. The latter must be used with the -e +option. The -e option and this one can be mixed and matched. Events +can be grouped using the {} notation. +endif::HAVE_LIBPFM[] + INTERACTIVE PROMPTING KEYS --------------------------
tools/perf/Makefile.config +13 -0
@@ -999,6 +999,19 @@ ifdef LIBCLANGLLVM endif endif +ifndef NO_LIBPFM4 + ifeq ($(feature-libpfm4), 1) + CFLAGS += -DHAVE_LIBPFM + EXTLIBS += -lpfm + ASCIIDOC_EXTRA = -aHAVE_LIBPFM=1 + msg := $(warning ASCIIDOC_EXTRA=$(ASCIIDOC_EXTRA)) + $(call detected,CONFIG_LIBPFM4) + else + msg := $(warning libpfm4 not found, disables libpfm4 support. Please install libpfm4-dev); + NO_LIBPFM4 := 1 + endif +endif + # Among the variables below, these: # perfexecdir # perf_include_dir
tools/perf/Makefile.perf +4 -2
@@ -118,6 +118,8 @@ include ../scripts/utilities.mak # # Define LIBBPF_DYNAMIC to enable libbpf dynamic linking. # +# Define NO_LIBPFM4 to disable libpfm4 extension. +# # As per kernel Makefile, avoid funny character set dependencies unexport LC_ALL
@@ -188,7 +190,7 @@ AWK = awk # non-config cases config := 1 -NON_CONFIG_TARGETS := clean python-clean TAGS tags cscope help install-doc install-man install-html install-info install-pdf doc man html info pdf +NON_CONFIG_TARGETS := clean python-clean TAGS tags cscope help ifdef MAKECMDGOALS ifeq ($(filter-out $(NON_CONFIG_TARGETS),$(MAKECMDGOALS)),)
@@ -832,7 +834,7 @@ INSTALL_DOC_TARGETS += quick-install-doc quick-install-man quick-install-html # 'make doc' should call 'make -C Documentation all' $(DOC_TARGETS): - $(QUIET_SUBDIR0)Documentation $(QUIET_SUBDIR1) $(@:doc=all) + $(QUIET_SUBDIR0)Documentation $(QUIET_SUBDIR1) $(@:doc=all) ASCIIDOC_EXTRA=$(ASCIIDOC_EXTRA) TAG_FOLDERS= . ../lib ../include TAG_FILES= ../../include/uapi/linux/perf_event.h
tools/perf/builtin-list.c +16 -0
@@ -18,6 +18,10 @@#include <subcmd/parse-options.h> #include <stdio.h> +#ifdef HAVE_LIBPFM +#include <perfmon/pfmlib.h> +#endif +static bool desc_flag = true;static bool details_flag;
@@ -56,6 +60,18 @@ int cmd_list(int argc, const char **argv)if (!raw_dump &&pager_in_use ())printf ("\nList of pre-defined events (to be used in -e):\n\n" ); +#ifdef HAVE_LIBPFM + { +int ret; + ret =pfm_initialize (); +if (ret !=PFM_SUCCESS ) { +fprintf (stderr, +"warning libpfm failed to initialize: %s\n" , +pfm_strerror (ret)); + } + } +#endif +if (argc ==0 ) {print_events (NULL , raw_dump, !desc_flag, long_desc_flag, details_flag, deprecated);
tools/perf/builtin-record.c +20 -0
@@ -64,6 +64,10 @@#include <linux/zalloc.h> #include <linux/bitmap.h> +#ifdef HAVE_LIBPFM +#include <perfmon/pfmlib.h> +#endif +struct switch_output {bool enabled;bool signal;
@@ -2405,6 +2409,11 @@ static struct option __record_options[] = {#endif OPT_CALLBACK(0, "max-size", &record.output_max_size, "size", "Limit the maximum size of the output file", parse_output_max_size), +#ifdef HAVE_LIBPFM +OPT_CALLBACK (0 ,"pfm-events" , &record.evlist,"event" , +"libpfm4 event selector. use 'perf list' to list available events" , + parse_libpfm_events_option), +#endifOPT_END () };
@@ -2445,6 +2454,17 @@ int cmd_record(int argc, const char **argv)if (rec->evlist ==NULL )return -ENOMEM ; +#ifdef HAVE_LIBPFM + { +int ret; + ret =pfm_initialize (); +if (ret !=PFM_SUCCESS ) { +ui__warning ("warning libpfm failed to initialize: %s\n" , +pfm_strerror (ret)); + } + } +#endif + err =perf_config (perf_record_config, rec);if (err)return err;
tools/perf/builtin-stat.c +21 -0
@@ -89,6 +89,10 @@#include <linux/ctype.h> #include <perf/evlist.h> +#ifdef HAVE_LIBPFM +#include <perfmon/pfmlib.h> +#endif +#define DEFAULT_SEPARATOR " "#define FREEZE_ON_SMI_PATH "devices/cpu/freeze_on_smi"
@@ -929,6 +933,11 @@ static struct option stat_options[] = { OPT_BOOLEAN_FLAG(0, "all-user", &stat_config.all_user, "Configure all used events to run in user space.", PARSE_OPT_EXCLUSIVE), +#ifdef HAVE_LIBPFM +OPT_CALLBACK (0 ,"pfm-events" , &evsel_list,"event" , +"libpfm4 event selector. use 'perf list' to list available events" , + parse_libpfm_events_option), +#endifOPT_END () };
@@ -1867,6 +1876,18 @@ int cmd_stat(int argc, const char **argv)unsigned int interval, timeout;const char *const stat_subcommands[] = {"record" ,"report" }; +#ifdef HAVE_LIBPFM + { +int ret; + ret =pfm_initialize (); +if (ret !=PFM_SUCCESS ) { +fprintf (stderr, +"warning libpfm failed to initialize: %s\n" , +pfm_strerror (ret)); + } + } +#endif +setlocale (LC_ALL ,"" ); evsel_list =evlist__new ();
tools/perf/builtin-top.c +20 -0
@@ -84,6 +84,10 @@#include <linux/ctype.h> #include <perf/mmap.h> +#ifdef HAVE_LIBPFM +#include <perfmon/pfmlib.h> +#endif +static volatile int done;static volatile int resize;
@@ -1545,6 +1549,11 @@ int cmd_top(int argc, const char **argv) "number of thread to run event synthesize"),OPT_BOOLEAN (0 ,"namespaces" , &opts->record_namespaces,"Record namespaces events" ), +#ifdef HAVE_LIBPFM +OPT_CALLBACK (0 ,"pfm-events" , &top.evlist,"event" , +"libpfm4 event selector. use 'perf list' to list available events" , + parse_libpfm_events_option), +#endifOPTS_EVSWITCH (&top.evswitch), OPT_END() };
@@ -1558,6 +1567,17 @@ int cmd_top(int argc, const char **argv)if (status <0 )return status; +#ifdef HAVE_LIBPFM + { +int ret; + ret =pfm_initialize (); +if (ret !=PFM_SUCCESS ) { +ui__warning ("warning libpfm failed to initialize: %s\n" , +pfm_strerror (ret)); + } + } +#endif + top.annotation_opts.min_pcnt =5 ; top.annotation_opts.context =4 ;
tools/perf/util/evsel.c +1 -1
@@ -2418,7 +2418,7 @@ bool perf_evsel__fallback(struct evsel *evsel, int err,/* Is there already the separator in the name. */ if (strchr (name,'/' ) || -strchr (name,':' )) + (strchr (name,':' ) && !evsel->is_libpfm_event)) sep ="" ;if (asprintf (&new_name,"%s%su" , name, sep) <0 )
tools/perf/util/evsel.h +1 -0
@@ -76,6 +76,7 @@ struct evsel {bool ignore_missing_thread;bool forced_leader;bool use_uncore_alias; +bool is_libpfm_event;/* parse modifier helper */ int exclude_GH;int sample_read;
tools/perf/util/parse-events.c +246 -0
261 lines not on this page · raw message
tools/perf/util/parse-events.h +5 -0
@@ -37,6 +37,11 @@ int parse_events_terms(struct list_head *terms, const char *str);int parse_filter (const struct option *opt,const char *str,int unset);int exclude_perf (const struct option *opt,const char *arg,int unset); +#ifdef HAVE_LIBPFM +extern int parse_libpfm_events_option (const struct option *opt,const char *str, +int unset); +#endif +#define EVENTS_HELP_MAX (128*1024)enum perf_pmu_event_symbol_type {
tools/perf/util/pmu.c +11 -0
@@ -864,6 +864,17 @@ static struct perf_pmu *pmu_find(const char *name)return NULL ; } +struct perf_pmu *perf_pmu__find_by_type (unsigned int type) +{ +struct perf_pmu *pmu; + +list_for_each_entry (pmu, &pmus, list) +if (pmu->type == type) +return pmu; + +return NULL ; +} +struct perf_pmu *perf_pmu__scan (struct perf_pmu *pmu) {/*
tools/perf/util/pmu.h +1 -0
@@ -64,6 +64,7 @@ struct perf_pmu_alias { };struct perf_pmu *perf_pmu__find (const char *name); +struct perf_pmu *perf_pmu__find_by_type (unsigned int type);int perf_pmu__config (struct perf_pmu *pmu,struct perf_event_attr *attr,struct list_head *head_terms,struct parse_events_error *error);
Signature · 1 line
2.25.1.481.gfbce0eb801-goog