perf, tools: Add support for PMU events in JSON format
v15 cover perf, tools: Add support for PMU events in JSON format
CPUs support a large number of performance monitoring events (PMU events) and often these events are very specific to an architecture/model of the CPU. To use most of these PMU events with perf, we currently have to identify them by their raw codes:
perf stat -e r100f2 sleep 1
This patchset allows architectures to specify these PMU events in JSON files located in 'tools/perf/pmu-events/arch/' of the mainline tree. The events from the JSON files for the architecture are then built into the perf binary.
At run time, perf identifies the specific set of events for the CPU and creates "event aliases". These aliases allow users to specify events by "name" as:
perf stat -e pm_1plus_ppc_cmpl sleep 1
The file, 'tools/perf/pmu-events/README' in [PATCH 19/19] gives more details.
Note:
- All known events tables for the architecture are included in the perf binary.
- For architectures that don't have any JSON files, an empty mapping table is created and they should continue to build)
Thanks to input from Andi Kleen, Jiri Olsa, Namhyung Kim and Ingo Molnar.
These patches are available from:
https://github.com:sukadev/linux.git
Branch Description
------------------------------------------------------
json-v15 Source Code only
json-files-5 x86 and Powerpc datafiles only
json-v15-with-data Both code and data (build/test)
NOTE: Only "source code" patches (i.e those in json-v15) are being emailed.
Please pull the "data files" from the json-files-5 branch.
Changelog[v15]
Code changes:
- Fix 'perf list' usage string and update man page.
- Remove a redundant __maybe_unused tag.
- Rebase to recent perf/core branch.
Data files updates: json-files-5 branch
- Rebase to perf/intel-json-files-5 from Andi Kleen
- Add patch from Madhavan Srinivasan for couple more Powerpc models
Changelog[v14]
Comments from Jiri Olsa:
- Change parameter name/type for pmu_add_cpu_aliases (from void *data to list_head *head)
- Use asprintf() in file_name_to_tablename() and simplify/reorg code.
- Use __weak definition from <linux/compile.h>
- Use fopen() with mode "w" and eliminate unlink()
- Remove minor TODO.
- Add error check for return value from strdup() in print_pmu_events().
- Move independent changes from patches 3,11,12 .. to separate patches for easier review/backport.
- Clarify mapfile's "header line support" in patch description.
- Fix build failure with DEBUG=1
Comment from Andi Kleen:
- In tools/perf/pmu-events/Build, check for 'mapfile.csv' rather than 'mapfile*'
Misc:
- Minor changes/clarifications to tools/perf/pmu-events/README.
Changelog[v13]
Version: Individual patches have their own history :-) that I am preserving. Patchset version (v13) is for overall patchset and is somewhat arbitrary.
- Added support for "categories" of events to perf
- Add mapfile, jevents build dependency on pmu-events.c
- Silence jevents when parsing JSON files unless V=1 is specified
- Cleanup error messages
- Fix memory leak with ->cpuid
- Rebase to Arnaldo's tree
- Allow overriding CPUID via environment variable
- Support long descriptions for events
- Handle header line in mapfile.csv
- Cleanup JSON files (trim PublicDescription if identical to/prefix of BriefDescription field)
*** BLURB HERE ***
Andi Kleen (10):
perf, tools: Add jsmn `jasmine' JSON parser
perf, tools, jevents: Program to convert JSON file to C style file perf, tools: Allow events with dot
perf, tools: Support CPU id matching for x86 v2
perf, tools: Support alias descriptions
perf, tools: Query terminal width and use in perf list perf, tools: Add a --no-desc flag to perf list
perf, tools: Add override support for event list CPUID perf, tools: Add support for event list topics
perf, tools: Handle header line in mapfile
Sukadev Bhattiprolu (9):
Use __weak definition from <linux/compiler.h> perf, tools: Split perf_pmu__new_alias()
perf, tools: Use pmu_events table to create aliases perf, tools: Support CPU ID matching for Powerpc perf, tools, jevents: Add support for long descriptions perf, tools: Add alias support for long descriptions perf, tools: Support long descriptions with perf list perf, tools, jevents: Add support for event topics perf, tools: Add README for info on parsing JSON/map files
tools/perf/Documentation/perf-list.txt | 12 +- tools/perf/Makefile.perf | 25 +- tools/perf/arch/powerpc/util/header.c | 11 + tools/perf/arch/x86/util/header.c | 24 +- tools/perf/builtin-list.c | 17 +- tools/perf/pmu-events/Build | 11 + tools/perf/pmu-events/README | 122 ++++++ tools/perf/pmu-events/jevents.c | 712 +++++++++++++++++++++++++++++++++ tools/perf/pmu-events/jevents.h | 18 + tools/perf/pmu-events/jsmn.c | 313 +++++++++++++++ tools/perf/pmu-events/jsmn.h | 67 ++++ tools/perf/pmu-events/json.c | 162 ++++++++ tools/perf/pmu-events/json.h | 39 ++ tools/perf/pmu-events/pmu-events.h | 37 ++ tools/perf/util/cache.h | 1 + tools/perf/util/header.h | 1 + tools/perf/util/pager.c | 15 + tools/perf/util/parse-events.c | 5 +- tools/perf/util/parse-events.h | 3 +- tools/perf/util/parse-events.l | 5 +- tools/perf/util/pmu.c | 217 ++++++++-- tools/perf/util/pmu.h | 6 +- 22 files changed, 1772 insertions(+), 51 deletions(-) create mode 100644 tools/perf/pmu-events/Build create mode 100644 tools/perf/pmu-events/README create mode 100644 tools/perf/pmu-events/jevents.c create mode 100644 tools/perf/pmu-events/jevents.h create mode 100644 tools/perf/pmu-events/jsmn.c create mode 100644 tools/perf/pmu-events/jsmn.h create mode 100644 tools/perf/pmu-events/json.c create mode 100644 tools/perf/pmu-events/json.h create mode 100644 tools/perf/pmu-events/pmu-events.h
Signature · 1 line
1.8.3.1
PATCH v15 1/19 perf, tools: Add jsmn `jasmine' JSON parser
From: Andi Kleen <[email protected]>
I need a JSON parser. This adds the simplest JSON parser I could find -- Serge Zaitsev's jsmn `jasmine' -- to the perf library. I merely converted it to (mostly) Linux style and added support for non 0 terminated input.
The parser is quite straight forward and does not copy any data, just returns tokens with offsets into the input buffer. So it's relatively efficient and simple to use.
The code is not fully checkpatch clean, but I didn't want to completely fork the upstream code.
Original source: http://zserge.bitbucket.org/jsmn.html
In addition I added a simple wrapper that mmaps a json file and provides some straight forward access functions.
Used in follow-on patches to parse event files.
---
v2: Address review feedback.
v3: Minor checkpatch fixes.
v4 (by Sukadev Bhattiprolu)
- Rebase to 4.0 and fix minor conflicts in tools/perf/Makefile.perf
- Report error if specified events file is invalid.
v5 (Sukadev Bhattiprolu)
- Move files to tools/perf/pmu-events/ since parsing of JSON file now occurs when _building_ rather than running perf.
--- tools/perf/pmu-events/jsmn.c | 313 +++++++++++++++++++++++++++++++++++++++++++ tools/perf/pmu-events/jsmn.h | 67 +++++++++ tools/perf/pmu-events/json.c | 162 ++++++++++++++++++++++ tools/perf/pmu-events/json.h | 36 +++++ 4 files changed, 578 insertions(+) create mode 100644 tools/perf/pmu-events/jsmn.c create mode 100644 tools/perf/pmu-events/jsmn.h create mode 100644 tools/perf/pmu-events/json.c create mode 100644 tools/perf/pmu-events/json.h
tools/perf/pmu-events/jsmn.c new file +313 -0
@@ -0,0 +1,313 @@ +/* +* Copyright (c) 2010 Serge A. Zaitsev +* +* Permission is hereby granted, free of charge, to any person obtaining a copy +* of this software and associated documentation files (the "Software"), to deal +* in the Software without restriction, including without limitation the rights +* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +* copies of the Software, and to permit persons to whom the Software is +* furnished to do so, subject to the following conditions: +* +* The above copyright notice and this permission notice shall be included in +* all copies or substantial portions of the Software. +* +* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +* THE SOFTWARE. +* +* Slightly modified by AK to not assume 0 terminated input. +*/ + +#include <stdlib.h> +#include "jsmn.h" + +/* +* Allocates a fresh unused token from the token pool. +*/ +static jsmntok_t *jsmn_alloc_token (jsmn_parser *parser, +jsmntok_t *tokens,size_t num_tokens) +{ +jsmntok_t *tok; + +if ((unsigned )parser->toknext >= num_tokens) +return NULL ; + tok = &tokens[parser->toknext++]; + tok->start = tok->end =-1 ; + tok->size =0 ; +return tok; +} + +/* +* Fills token type and boundaries. +*/ +static void jsmn_fill_token (jsmntok_t *token,jsmntype_t type, +int start,int end) +{ + token->type = type; + token->start = start; + token->end = end; + token->size =0 ; +} + +/* +* Fills next available token with JSON primitive. +*/ +static jsmnerr_t jsmn_parse_primitive (jsmn_parser *parser,const char *js, +size_t len, +jsmntok_t *tokens,size_t num_tokens) +{ +jsmntok_t *token; +int start; + + start = parser->pos; + +for (; parser->pos < len; parser->pos++) { +switch (js[parser->pos]) { +#ifndef JSMN_STRICT +/* +* In strict mode primitive must be followed by "," +* or "}" or "]" +*/ +case ':' : +#endif +case '\t' : +case '\r' : +case '\n' : +case ' ' : +case ',' : +case ']' : +case '}' : + goto found; +default : +break ; + } +if (js[parser->pos] <32 || js[parser->pos] >=127 ) { + parser->pos = start; +return JSMN_ERROR_INVAL ; + } + } +#ifdef JSMN_STRICT +/* +* In strict mode primitive must be followed by a +* comma/object/array. +*/ + parser->pos = start; +return JSMN_ERROR_PART ; +#endif + +found: + token =jsmn_alloc_token (parser, tokens, num_tokens); +if (token ==NULL ) { + parser->pos = start; +return JSMN_ERROR_NOMEM ; + } +jsmn_fill_token (token,JSMN_PRIMITIVE , start, parser->pos); + parser->pos--;/* parent sees closing brackets */ +return JSMN_SUCCESS ; +} + +/* +* Fills next token with JSON string. +*/ +static jsmnerr_t jsmn_parse_string (jsmn_parser *parser,const char *js, +size_t len, +jsmntok_t *tokens,size_t num_tokens) +{ +jsmntok_t *token; +int start = parser->pos; + +/* Skip starting quote */ + parser->pos++; + +for (; parser->pos < len; parser->pos++) { +char c = js[parser->pos]; + +/* Quote: end of string */ +if (c =='\"' ) { + token =jsmn_alloc_token (parser, tokens, num_tokens); +if (token ==NULL ) { + parser->pos = start; +return JSMN_ERROR_NOMEM ; + } +jsmn_fill_token (token,JSMN_STRING , start+1 , + parser->pos); +return JSMN_SUCCESS ; + } + +/* Backslash: Quoted symbol expected */ +if (c =='\\' ) { + parser->pos++; +switch (js[parser->pos]) { +/* Allowed escaped symbols */ +case '\"' : +case '/' : +case '\\' : +case 'b' : +case 'f' : +case 'r' : +case 'n' : +case 't' : +break ; +/* Allows escaped symbol \uXXXX */ +case 'u' : +/* TODO */ +break ; +/* Unexpected symbol */ +default : + parser->pos = start; +return JSMN_ERROR_INVAL ; + } + } + } + parser->pos = start; +return JSMN_ERROR_PART ; +} + +/* +* Parse JSON string and fill tokens. +*/ +jsmnerr_t jsmn_parse (jsmn_parser *parser,const char *js,size_t len, +jsmntok_t *tokens,unsigned int num_tokens) +{ +jsmnerr_t r; +int i; +jsmntok_t *token; + +for (; parser->pos < len; parser->pos++) { +char c; +jsmntype_t type; + + c = js[parser->pos]; +switch (c) { +case '{' : +case '[' : + token =jsmn_alloc_token (parser, tokens, num_tokens); +if (token ==NULL ) +return JSMN_ERROR_NOMEM ; +if (parser->toksuper !=-1 ) + tokens[parser->toksuper].size++; + token->type = (c =='{' ?JSMN_OBJECT :JSMN_ARRAY ); + token->start = parser->pos; + parser->toksuper = parser->toknext -1 ; +break ; +case '}' : +case ']' : + type = (c =='}' ?JSMN_OBJECT :JSMN_ARRAY ); +for (i = parser->toknext -1 ; i >=0 ; i--) { + token = &tokens[i]; +if (token->start !=-1 && token->end ==-1 ) { +if (token->type != type) +return JSMN_ERROR_INVAL ; + parser->toksuper =-1 ; + token->end = parser->pos +1 ; +break ; + } + } +/* Error if unmatched closing bracket */ +if (i ==-1 ) +return JSMN_ERROR_INVAL ; +for (; i >=0 ; i--) { + token = &tokens[i]; +if (token->start !=-1 && token->end ==-1 ) { + parser->toksuper = i; +break ; + } + } +break ; +case '\"' : + r =jsmn_parse_string (parser, js, len, tokens, + num_tokens); +if (r <0 ) +return r; +if (parser->toksuper !=-1 ) + tokens[parser->toksuper].size++; +break ; +case '\t' : +case '\r' : +case '\n' : +case ':' : +case ',' : +case ' ' : +break ; +#ifdef JSMN_STRICT +/* +* In strict mode primitives are: +* numbers and booleans. +*/ +case '-' : +case '0' : +case '1' : +case '2' : +case '3' : +case '4' : +case '5' : +case '6' : +case '7' : +case '8' : +case '9' : +case 't' : +case 'f' : +case 'n' : +#else +/* +* In non-strict mode every unquoted value +* is a primitive. +*/ +/*FALL THROUGH */ +default : +#endif + r =jsmn_parse_primitive (parser, js, len, tokens, + num_tokens); +if (r <0 ) +return r; +if (parser->toksuper !=-1 ) + tokens[parser->toksuper].size++; +break ; + +#ifdef JSMN_STRICT +/* Unexpected char in strict mode */ +default : +return JSMN_ERROR_INVAL ; +#endif + } + } + +for (i = parser->toknext -1 ; i >=0 ; i--) { +/* Unmatched opened object or array */ +if (tokens[i].start !=-1 && tokens[i].end ==-1 ) +return JSMN_ERROR_PART ; + } + +return JSMN_SUCCESS ; +} + +/* +* Creates a new parser based over a given buffer with an array of tokens +* available. +*/ +void jsmn_init (jsmn_parser *parser) +{ + parser->pos =0 ; + parser->toknext =0 ; + parser->toksuper =-1 ; +} + +const char *jsmn_strerror (jsmnerr_t err) +{ +switch (err) { +case JSMN_ERROR_NOMEM : +return "No enough tokens" ; +case JSMN_ERROR_INVAL : +return "Invalid character inside JSON string" ; +case JSMN_ERROR_PART : +return "The string is not a full JSON packet, more bytes expected" ; +case JSMN_SUCCESS : +return "Success" ; +default : +return "Unknown json error" ; + } +}
tools/perf/pmu-events/jsmn.h new file +67 -0
67 lines not on this page · raw message
tools/perf/pmu-events/json.c new file +162 -0
162 lines not on this page · raw message
tools/perf/pmu-events/json.h new file +36 -0
@@ -0,0 +1,36 @@ +#ifndef JSON_H +#define JSON_H 1 + +#include "jsmn.h" + +jsmntok_t *parse_json (const char *fn,char **map,size_t *size,int *len); +void free_json (char *map,size_t size,jsmntok_t *tokens); +int json_line (char *map,jsmntok_t *t); +const char *json_name (jsmntok_t *t); +int json_streq (char *map,jsmntok_t *t,const char *s); +int json_len (jsmntok_t *t); + +extern int verbose; + +typedef unsigned int bool ; + +#ifndef true +#define true 1 +#endif + +extern int eprintf (int level,int var,const char *fmt, ...); +#define pr_fmt (fmt) fmt + +#define pr_err (fmt, ...) \ + eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__) + +#ifndef roundup +#define roundup (x, y) ( \ +{ \ + const typeof(y) __y = y; \ + (((x) + (__y - 1)) / __y) * __y; \ +} \ +) +#endif + +#endif
Signature · 1 line
1.8.3.1
PATCH v15 2/19 perf, tools, jevents: Program to convert JSON file to C style file
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
This is a modified version of an earlier patch by Andi Kleen.
We expect architectures to describe the performance monitoring events for each CPU in a corresponding JSON file, which look like:
[
{
"EventCode": "0x00",
"UMask": "0x01",
"EventName": "INST_RETIRED.ANY",
"BriefDescription": "Instructions retired from execution.",
"PublicDescription": "Instructions retired from execution.",
"Counter": "Fixed counter 1",
"CounterHTOff": "Fixed counter 1",
"SampleAfterValue": "2000003",
"SampleAfterValue": "2000003",
"MSRIndex": "0",
"MSRValue": "0",
"TakenAlone": "0",
"CounterMask": "0",
"Invert": "0",
"AnyThread": "0",
"EdgeDetect": "0",
"PEBS": "0",
"PRECISE_STORE": "0",
"Errata": "null",
"Offcore": "0"
}
]We also expect the architectures to provide a mapping between individual CPUs to their JSON files. Eg:
GenuineIntel-6-1E,V1,/NHM-EP/NehalemEP_core_V1.json,core
which maps each CPU, identified by [vendor, family, model, version, type] to a JSON file.
Given these files, the program, jevents::
- locates all JSON files for the architecture,
- parses each JSON file and generates a C-style "PMU-events table" (pmu-events.c)
- locates a mapfile for the architecture
- builds a global table, mapping each model of CPU to the corresponding PMU-events table.
The 'pmu-events.c' is generated when building perf and added to libperf.a. The global table pmu_events_map[] table in this pmu-events.c will be used in perf in a follow-on patch.
If the architecture does not have any JSON files or there is an error in processing them, an empty mapping file is created. This would allow the build of perf to proceed even if we are not able to provide aliases for events.
The parser for JSON files allows parsing Intel style JSON event files. This allows to use an Intel event list directly with perf. The Intel event lists can be quite large and are too big to store in unswappable kernel memory.
The conversion from JSON to C-style is straight forward. The parser knows (very little) Intel specific information, and can be easily extended to handle fields for other CPUs.
The parser code is partially shared with an independent parsing library, which is 2-clause BSD licenced. To avoid any conflicts I marked those files as BSD licenced too. As part of perf they become GPLv2.
---
v2: Address review feedback. Rename option to --event-files
v3: Add JSON example
v4: Update manpages.
v5: Don't remove dot in fixname. Fix compile error. Add include
protection. Comment realloc.
v6: Include debug/util.h
v7: (Sukadev Bhattiprolu)
Rebase to 4.0 and fix some conflicts.
v8: (Sukadev Bhattiprolu)
Move jevents.[hc] to tools/perf/pmu-events/
Rewrite to locate and process arch specific JSON and "map" files; and generate a C file.
(Removed acked-by Namhyung Kim due to modest changes to patch) Compile the generated pmu-events.c and add the pmu-events.o to libperf.a
v9: [Sukadev Bhattiprolu/Andi Kleen] Rename ->vfm to ->cpuid and use
that field to encode the PVR in Power.
Allow blank lines in mapfile.
[Jiri Olsa] Pass ARCH as a parameter to jevents so we don't have to detect it.
[Jiri Olsa] Use the infrastrastructure to build pmu-events/perf (Makefile changes from Jiri included in this patch). [Jiri Olsa, Andi Kleen] Detect changes to JSON files and rebuild pmu-events.o only if necessary.
v11: - [Andi Kleen] Add mapfile, jevents dependency on pmu-events.c
- [Jiri Olsa] Be silient if arch doesn't have JSON files
- Also silence 'jevents' when parsing JSON files unless V=1 is specified during build. Cleanup error messages.
v14:- - [Jiri Olsa] Fix compile error with DEBUG=1; drop unlink() and
use "w" mode with fopen(); simplify file_name_to_table_name()
v15: - Fix minor conflict in tools/perf/Makefile.perf when rebasing
to recent perf/core.
--- tools/perf/Makefile.perf | 25 +- tools/perf/pmu-events/Build | 11 + tools/perf/pmu-events/jevents.c | 686 +++++++++++++++++++++++++++++++++++++ tools/perf/pmu-events/jevents.h | 17 + tools/perf/pmu-events/json.h | 3 + tools/perf/pmu-events/pmu-events.h | 35 ++ 6 files changed, 773 insertions(+), 4 deletions(-) create mode 100644 tools/perf/pmu-events/Build create mode 100644 tools/perf/pmu-events/jevents.c create mode 100644 tools/perf/pmu-events/jevents.h create mode 100644 tools/perf/pmu-events/pmu-events.h
tools/perf/Makefile.perf +21 -4
@@ -275,14 +275,29 @@ strip: $(PROGRAMS) $(OUTPUT)perf PERF_IN := $(OUTPUT)perf-in.o +JEVENTS := $(OUTPUT)pmu-events/jevents +JEVENTS_IN := $(OUTPUT)pmu-events/jevents-in.o +PMU_EVENTS_IN := $(OUTPUT)pmu-events/pmu-events-in.o + +export JEVENTS + export srctree OUTPUT RM CC LD AR CFLAGS V BISON FLEX build := -f $(srctree)/tools/build/Makefile.build dir=. obj $(PERF_IN): $(OUTPUT)PERF-VERSION-FILE $(OUTPUT)common-cmds.h FORCE $(Q)$(MAKE) $(build)=perf -$(OUTPUT)perf: $(PERFLIBS) $(PERF_IN) $(LIBTRACEEVENT_DYNAMIC_LIST) - $(QUIET_LINK)$(CC) $(CFLAGS) $(LDFLAGS) $(PERF_IN) $(LIBS) -o $@ +$(JEVENTS_IN): FORCE + $(Q)$(MAKE) -f $(srctree)/tools/build/Makefile.build dir=pmu-events obj=jevents + +$(JEVENTS): $(JEVENTS_IN) + $(QUIET_LINK)$(CC) $(JEVENTS_IN) -o $@ + +$(PMU_EVENTS_IN): $(JEVENTS) FORCE + $(Q)$(MAKE) -f $(srctree)/tools/build/Makefile.build dir=pmu-events obj=pmu-events + +$(OUTPUT)perf: $(PERFLIBS) $(PERF_IN) $(PMU_EVENTS_IN) $(LIBTRACEEVENT_DYNAMIC_LIST) + $(QUIET_LINK)$(CC) $(CFLAGS) $(LDFLAGS) $(PERF_IN) $(PMU_EVENTS_IN) $(LIBS) -o $@ $(GTK_IN): FORCE $(Q)$(MAKE) $(build)=gtk
@@ -311,6 +326,8 @@ perf.spec $(SCRIPTS) \ ifneq ($(OUTPUT),) %.o: $(OUTPUT)%.o @echo " # Redirected target $@ => $(OUTPUT)$@" +pmu-events/%.o: $(OUTPUT)pmu-events/%.o + @echo " # Redirected target $@ => $(OUTPUT)$@" util/%.o: $(OUTPUT)util/%.o @echo " # Redirected target $@ => $(OUTPUT)$@" bench/%.o: $(OUTPUT)bench/%.o
@@ -544,8 +561,8 @@ clean: $(LIBTRACEEVENT)-clean $(LIBAPI)-clean config-clean $(call QUIET_CLEAN, core-objs) $(RM) $(LIB_FILE) $(OUTPUT)perf-archive $(OUTPUT)perf-with-kcore $(LANG_BINDINGS) $(Q)find . -name '*.o' -delete -o -name '\.*.cmd' -delete -o -name '\.*.d' -delete $(Q)$(RM) .config-detected - $(call QUIET_CLEAN, core-progs) $(RM) $(ALL_PROGRAMS) perf perf-read-vdso32 perf-read-vdsox32 - $(call QUIET_CLEAN, core-gen) $(RM) *.spec *.pyc *.pyo */*.pyc */*.pyo $(OUTPUT)common-cmds.h TAGS tags cscope* $(OUTPUT)PERF-VERSION-FILE $(OUTPUT)FEATURE-DUMP $(OUTPUT)util/*-bison* $(OUTPUT)util/*-flex* + $(call QUIET_CLEAN, core-progs) $(RM) $(ALL_PROGRAMS) perf perf-read-vdso32 perf-read-vdsox32 $(OUTPUT)pmu-events/jevents $(srctree)/tools/perf/pmu-events/pmu-events.c + $(call QUIET_CLEAN, core-gen) $(RM) *.spec *.pyc *.pyo */*.pyc */*.pyo $(OUTPUT)common-cmds.h TAGS tags cscope* $(OUTPUT)PERF-VERSION-FILE $(OUTPUT)FEATURE-DUMP $(OUTPUT)util/*-bison* $(OUTPUT)util/*-flex* $(OUTPUT)pmu-events/pmu-events.c $(QUIET_SUBDIR0)Documentation $(QUIET_SUBDIR1) clean $(python-clean)
tools/perf/pmu-events/Build new file +11 -0
@@ -0,0 +1,11 @@ +jevents-y += json.o jsmn.o jevents.o +pmu-events-y += pmu-events.o +JDIR = pmu-events/arch/$(ARCH) +JSON = $(shell [ -d $(JDIR) ] && \ + find $(JDIR) -name '*.json' -o -name 'mapfile.csv') +# +# Locate/process JSON files in pmu-events/arch/ +# directory and create tables in pmu-events.c. +# +$(OUTPUT)pmu-events/pmu-events.c: $(JSON) $(JEVENTS) + $(Q)$(call echo-cmd,gen)$(JEVENTS) $(ARCH) pmu-events/arch $(OUTPUT)pmu-events/pmu-events.c $(V)
tools/perf/pmu-events/jevents.c new file +686 -0
686 lines not on this page · raw message
tools/perf/pmu-events/jevents.h new file +17 -0
@@ -0,0 +1,17 @@ +#ifndef JEVENTS_H +#define JEVENTS_H 1 + +int json_events (const char *fn, +int (*func)(void *data,char *name,char *event,char *desc), +void *data); +char *get_cpu_str (void ); + +#ifndef min +#define min (x, y) ({ \ + typeof(x) _min1 = (x); \ + typeof(y) _min2 = (y); \ + (void) (&_min1 == &_min2); \ + _min1 < _min2 ? _min1 : _min2; }) +#endif + +#endif
tools/perf/pmu-events/json.h +3 -0
@@ -24,6 +24,9 @@ extern int eprintf(int level, int var, const char *fmt, ...);#define pr_err (fmt, ...) \ eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__) +#define pr_info (fmt, ...) \ + eprintf(1, verbose, pr_fmt(fmt), ##__VA_ARGS__) +#ifndef roundup#define roundup (x, y) ( \ { \
tools/perf/pmu-events/pmu-events.h new file +35 -0
@@ -0,0 +1,35 @@ +#ifndef PMU_EVENTS_H +#define PMU_EVENTS_H + +/* +* Describe each PMU event. Each CPU has a table of PMU events. +*/ +struct pmu_event { +const char *name; +const char *event; +const char *desc; +}; + +/* +* +* Map a CPU to its table of PMU events. The CPU is identified by the +* cpuid field, which is an arch-specific identifier for the CPU. +* The identifier specified in tools/perf/pmu-events/arch/xxx/mapfile +* must match the get_cpustr() in tools/perf/arch/xxx/util/header.c) +* +* The cpuid can contain any character other than the comma. +*/ +struct pmu_events_map { +const char *cpuid; +const char *version; +const char *type;/* core, uncore etc */ +struct pmu_event *table; +}; + +/* +* Global table mapping each known CPU for the architecture to its +* table of PMU events. +*/ +extern struct pmu_events_map pmu_events_map[]; + +#endif
Signature · 1 line
1.8.3.1
PATCH v15 3/19 Use __weak definition from <linux/compiler.h>
In reply to Sukadev BhattiproluJiri Olsa pointed out, that the <linux/compiler.h> defines the attribute '__weak'. We might as well use that.
--- tools/perf/util/pmu.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
tools/perf/util/pmu.c +2 -1
@@ -1,4 +1,5 @@#include <linux/list.h> +#include <linux/compiler.h> #include <sys/types.h> #include <unistd.h> #include <stdio.h>
@@ -436,7 +437,7 @@ static struct cpu_map *pmu_cpumask(const char *name)return cpus; } -struct perf_event_attr *__attribute__((weak)) +struct perf_event_attr *__weak perf_pmu__get_default_config (struct perf_pmu *pmu__maybe_unused ) {return NULL ;
Signature · 1 line
1.8.3.1
tip-bot for Sukadev Bhattiprolu
merge bot[tip:perf/core] perf pmu: Use __weak definition from <linux/ compiler.h>
perf pmu: Use __weak definition from <linux/compiler.h>
Commit-ID: c5de47f2e803c7e6ffc0a34b174d4d009c8bd8e1 Gitweb: http://git.kernel.org/tip/c5de47f2e803c7e6ffc0a34b174d4d009c8bd8e1 Author: Sukadev Bhattiprolu <[email protected]> AuthorDate: Wed, 10 Jun 2015 00:25:07 -0700 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 23 Jun 2015 18:21:15 -0300
perf pmu: Use __weak definition from <linux/compiler.h>
Jiri Olsa pointed out, that the <linux/compiler.h> defines the attribute '__weak'. We might as well use that.
--- tools/perf/util/pmu.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
tools/perf/util/pmu.c +2 -1
@@ -1,4 +1,5 @@#include <linux/list.h> +#include <linux/compiler.h> #include <sys/types.h> #include <unistd.h> #include <stdio.h>
@@ -436,7 +437,7 @@ static struct cpu_map *pmu_cpumask(const char *name)return cpus; } -struct perf_event_attr *__attribute__((weak)) +struct perf_event_attr *__weak perf_pmu__get_default_config (struct perf_pmu *pmu__maybe_unused ) {return NULL ;
PATCH v15 4/19 perf, tools: Split perf_pmu__new_alias()
In reply to Sukadev BhattiproluSeparate the event parsing code in perf_pmu__new_alias() out into a separate function __perf_pmu__new_alias() so that code can be called indepdently.
This is based on an earlier patch from Andi Kleen.
--- tools/perf/util/pmu.c | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-)
tools/perf/util/pmu.c +27 -15
@@ -206,17 +206,12 @@ static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,return 0 ; } -static int perf_pmu__new_alias (struct list_head *list,char *dir,char *name,FILE *file) +static int __perf_pmu__new_alias (struct list_head *list,char *dir,char *name, +char *desc__maybe_unused ,char *val) {struct perf_pmu_alias *alias; -char buf[256 ];int ret; - ret =fread (buf,1 ,sizeof (buf), file); -if (ret ==0 ) -return -EINVAL ; - buf[ret] =0 ; - alias =malloc (sizeof (*alias));if (!alias)return -ENOMEM ;
@@ -226,26 +221,43 @@ static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FI alias->unit[0 ] ='\0' ; alias->per_pkg = false; - ret =parse_events_terms (&alias->terms, buf); + ret =parse_events_terms (&alias->terms, val);if (ret) { +pr_err ("Cannot parse alias %s: %d\n" , val, ret);free (alias);return ret; } alias->name =strdup (name); -/* -* load unit name and scale if available -*/ -perf_pmu__parse_unit (alias, dir, name); -perf_pmu__parse_scale (alias, dir, name); -perf_pmu__parse_per_pkg (alias, dir, name); -perf_pmu__parse_snapshot (alias, dir, name); +if (dir) { +/* +* load unit name and scale if available +*/ +perf_pmu__parse_unit (alias, dir, name); +perf_pmu__parse_scale (alias, dir, name); +perf_pmu__parse_per_pkg (alias, dir, name); +perf_pmu__parse_snapshot (alias, dir, name); + }list_add_tail (&alias->list, list);return 0 ; } +static int perf_pmu__new_alias (struct list_head *list,char *dir,char *name,FILE *file) +{ +char buf[256 ]; +int ret; + + ret =fread (buf,1 ,sizeof (buf), file); +if (ret ==0 ) +return -EINVAL ; + + buf[ret] =0 ; + +return __perf_pmu__new_alias (list, dir, name,NULL , buf); +} +static inline bool pmu_alias_info_file (char *name) {size_t len;
Signature · 1 line
1.8.3.1
tip-bot for Sukadev Bhattiprolu
merge bot[tip:perf/core] perf pmu: Split perf_pmu__new_alias()
perf pmu: Split perf_pmu__new_alias()
Commit-ID: 70c646e0e47b51c8fa431f9ec1962f7d6e512860 Gitweb: http://git.kernel.org/tip/70c646e0e47b51c8fa431f9ec1962f7d6e512860 Author: Sukadev Bhattiprolu <[email protected]> AuthorDate: Wed, 10 Jun 2015 00:25:08 -0700 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 23 Jun 2015 18:21:30 -0300
perf pmu: Split perf_pmu__new_alias()
Separate the event parsing code in perf_pmu__new_alias() out into a separate function __perf_pmu__new_alias() so that code can be called indepdently.
This is based on an earlier patch from Andi Kleen.
--- tools/perf/util/pmu.c | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-)
tools/perf/util/pmu.c +27 -15
@@ -206,17 +206,12 @@ static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,return 0 ; } -static int perf_pmu__new_alias (struct list_head *list,char *dir,char *name,FILE *file) +static int __perf_pmu__new_alias (struct list_head *list,char *dir,char *name, +char *desc__maybe_unused ,char *val) {struct perf_pmu_alias *alias; -char buf[256 ];int ret; - ret =fread (buf,1 ,sizeof (buf), file); -if (ret ==0 ) -return -EINVAL ; - buf[ret] =0 ; - alias =malloc (sizeof (*alias));if (!alias)return -ENOMEM ;
@@ -226,26 +221,43 @@ static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FI alias->unit[0 ] ='\0' ; alias->per_pkg = false; - ret =parse_events_terms (&alias->terms, buf); + ret =parse_events_terms (&alias->terms, val);if (ret) { +pr_err ("Cannot parse alias %s: %d\n" , val, ret);free (alias);return ret; } alias->name =strdup (name); -/* -* load unit name and scale if available -*/ -perf_pmu__parse_unit (alias, dir, name); -perf_pmu__parse_scale (alias, dir, name); -perf_pmu__parse_per_pkg (alias, dir, name); -perf_pmu__parse_snapshot (alias, dir, name); +if (dir) { +/* +* load unit name and scale if available +*/ +perf_pmu__parse_unit (alias, dir, name); +perf_pmu__parse_scale (alias, dir, name); +perf_pmu__parse_per_pkg (alias, dir, name); +perf_pmu__parse_snapshot (alias, dir, name); + }list_add_tail (&alias->list, list);return 0 ; } +static int perf_pmu__new_alias (struct list_head *list,char *dir,char *name,FILE *file) +{ +char buf[256 ]; +int ret; + + ret =fread (buf,1 ,sizeof (buf), file); +if (ret ==0 ) +return -EINVAL ; + + buf[ret] =0 ; + +return __perf_pmu__new_alias (list, dir, name,NULL , buf); +} +static inline bool pmu_alias_info_file (char *name) {size_t len;
PATCH v15 5/19 perf, tools: Use pmu_events table to create aliases
In reply to Sukadev BhattiproluAt run time (when 'perf' is starting up), locate the specific table of PMU events that corresponds to the current CPU. Using that table, create aliases for the each of the PMU events in the CPU. The use these aliases to parse the user specified perf event.
In short this would allow the user to specify events using their aliases rather than raw event codes.
Based on input and some earlier patches from Andi Kleen, Jiri Olsa.
---
Changelog[v4]
- Split off unrelated code into separate patches.
Changelog[v3]
- [Jiri Olsa] Fix memory leak in cpuid
Changelog[v2]
- [Andi Kleen] Replace pmu_events_map->vfm with a generic "cpuid".
--- tools/perf/util/header.h | 1 + tools/perf/util/pmu.c | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+)
tools/perf/util/header.h +1 -0
@@ -157,4 +157,5 @@ int write_padded(int fd, const void *bf, size_t count, size_t count_aligned);*/ int get_cpuid (char *buffer,size_t sz); +char *get_cpuid_str (void );#endif /* __PERF_HEADER_H */
tools/perf/util/pmu.c +61 -0
79 lines not on this page · raw message
Signature · 1 line
1.8.3.1
PATCH v15 6/19 perf, tools: Support CPU ID matching for Powerpc
In reply to Sukadev BhattiproluImplement code that returns the generic CPU ID string for Powerpc. This will be used to identify the specific table of PMU events to parse/compare user specified events against.
---
Changelog[v14]
- [Jiri Olsa] Move this independent code off into a separate patch.
--- tools/perf/arch/powerpc/util/header.c | 11 +++++++++++ 1 file changed, 11 insertions(+)
tools/perf/arch/powerpc/util/header.c +11 -0
@@ -32,3 +32,14 @@ get_cpuid(char *buffer, size_t sz) }return -1 ; } + +char * +get_cpuid_str (void ) +{ +char *bufp; + +if (asprintf (&bufp,"%.8lx" ,mfspr (SPRN_PVR )) <0 ) + bufp =NULL ; + +return bufp; +}
Signature · 1 line
1.8.3.1
PATCH v15 7/19 perf, tools: Allow events with dot
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
The Intel events use a dot to separate event name and unit mask. Allow dot in names in the scanner, and remove special handling of dot as EOF. Also remove the hack in jevents to replace dot with underscore. This way dotted events can be specified directly by the user.
I'm not fully sure this change to the scanner is correct (what was the dot special case good for?), but I haven't found anything that breaks with it so far at least.
---
V2: Add the dot to name too, to handle events outside cpu//
--- tools/perf/util/parse-events.l | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
tools/perf/util/parse-events.l +2 -3
@@ -119,8 +119,8 @@ event [^,{}/]+ num_dec [0-9]+ num_hex 0x[a-fA-F0-9]+ num_raw_hex [a-fA-F0-9]+ -name [a-zA-Z_*?][a-zA-Z0-9_*?]* -name_minus [a-zA-Z_*?][a-zA-Z0-9\-_*?]* +name [a-zA-Z_*?][a-zA-Z0-9_*?.]* +name_minus [a-zA-Z_*?][a-zA-Z0-9\-_*?.]* /* If you add a modifier you need to update check_modifier() */ modifier_event [ukhpGHSDI]+ modifier_bp [rwx]{1,3}
@@ -165,7 +165,6 @@ modifier_bp [rwx]{1,3} return PE_EVENT_NAME; } -. | <<EOF>> { BEGIN(INITIAL); REWIND(0);
Signature · 1 line
1.8.3.1
tip-bot for Andi Kleen
merge bot[tip:perf/core] perf tools: Allow events with dot
perf tools: Allow events with dot
Commit-ID: 5b021ddf81b0bcd17d88186b605f53a2ca452d3a Gitweb: http://git.kernel.org/tip/5b021ddf81b0bcd17d88186b605f53a2ca452d3a Author: Andi Kleen <[email protected]> AuthorDate: Wed, 10 Jun 2015 00:25:11 -0700 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 23 Jun 2015 18:21:37 -0300
perf tools: Allow events with dot
The Intel events use a dot to separate event name and unit mask. Allow dot in names in the scanner, and remove special handling of dot as EOF. Also remove the hack in jevents to replace dot with underscore. This way dotted events can be specified directly by the user.
I'm not fully sure this change to the scanner is correct (what was the dot special case good for?), but I haven't found anything that breaks with it so far at least.
--- tools/perf/util/parse-events.l | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
tools/perf/util/parse-events.l +2 -3
@@ -119,8 +119,8 @@ event [^,{}/]+ num_dec [0-9]+ num_hex 0x[a-fA-F0-9]+ num_raw_hex [a-fA-F0-9]+ -name [a-zA-Z_*?][a-zA-Z0-9_*?]* -name_minus [a-zA-Z_*?][a-zA-Z0-9\-_*?]* +name [a-zA-Z_*?][a-zA-Z0-9_*?.]* +name_minus [a-zA-Z_*?][a-zA-Z0-9\-_*?.]* /* If you add a modifier you need to update check_modifier() */ modifier_event [ukhpGHSDI]+ modifier_bp [rwx]{1,3}
@@ -165,7 +165,6 @@ modifier_bp [rwx]{1,3} return PE_EVENT_NAME; } -. | <<EOF>> { BEGIN(INITIAL); REWIND(0);
PATCH v15 8/19 perf, tools: Support CPU id matching for x86 v2
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
Implement the code to match CPU types to mapfile types for x86 based on CPUID. This extends an existing similar function, but changes it to use the x86 mapfile cpu description. This allows to resolve event lists generated by jevents.
---
v2: Update to new get_cpuid_str() interface
--- tools/perf/arch/x86/util/header.c | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-)
tools/perf/arch/x86/util/header.c +21 -3
@@ -19,8 +19,8 @@ cpuid(unsigned int op, unsigned int *a, unsigned int *b, unsigned int *c, : "a" (op)); } -int -get_cpuid (char *buffer,size_t sz) +static int +__get_cpuid (char *buffer,size_t sz,const char *fmt) {unsigned int a, b, c, d, lvl;int family =-1 , model =-1 , step =-1 ;
@@ -48,7 +48,7 @@ get_cpuid(char *buffer, size_t sz)if (family >=0x6 ) model += ((a >>16 ) &0xf ) <<4 ; } - nb =scnprintf (buffer, sz,"%s,%u,%u,%u$" , vendor, family, model, step); + nb =scnprintf (buffer, sz, fmt, vendor, family, model, step);/* look for end marker to ensure the entire data fit */ if (strchr (buffer,'$' )) {
@@ -57,3 +57,21 @@ get_cpuid(char *buffer, size_t sz) }return -1 ; } + +int +get_cpuid (char *buffer,size_t sz) +{ +return __get_cpuid (buffer, sz,"%s,%u,%u,%u$" ); +} + +char * +get_cpuid_str (void ) +{ +char *buf =malloc (128 ); + +if (__get_cpuid (buf,128 ,"%s-%u-%X$" ) <0 ) { +free (buf); +return NULL ; + } +return buf; +}
Signature · 1 line
1.8.3.1
PATCH v15 9/19 perf, tools: Support alias descriptions
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
Add support to print alias descriptions in perf list, which are taken from the generated event files.
The sorting code is changed to put the events with descriptions at the end. The descriptions are printed as possibly multiple word wrapped lines.
Example output:
% perf list
...
arith.fpu_div
[Divide operations executed]
arith.fpu_div_active
[Cycles when divider is busy executing divide operations]
---
Changelog
- Delete a redundant free()
Changelog[v14]
- [Jiri Olsa] Fail, rather than continue if strdup() returns NULL; remove unnecessary __maybe_unused.
--- tools/perf/util/pmu.c | 82 +++++++++++++++++++++++++++++++++++++++++---------- tools/perf/util/pmu.h | 1 + 2 files changed, 67 insertions(+), 16 deletions(-)
tools/perf/util/pmu.c +66 -16
@@ -209,7 +209,7 @@ static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias, }static int __perf_pmu__new_alias (struct list_head *list,char *dir,char *name, -char *desc__maybe_unused ,char *val) +char *desc,char *val) {struct perf_pmu_alias *alias;int ret;
@@ -241,6 +241,8 @@ static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,perf_pmu__parse_snapshot (alias, dir, name); } + alias->desc = desc ?strdup (desc) :NULL ; +list_add_tail (&alias->list, list);return 0 ;
@@ -989,11 +991,42 @@ static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,return buf; } -static int cmp_string (const void *a,const void *b) +struct pair { +char *name; +char *desc; +}; + +static int cmp_pair (const void *a,const void *b) +{ +const struct pair *as = a; +const struct pair *bs = b; + +/* Put extra events last */ +if (!!as->desc != !!bs->desc) +return !!as->desc - !!bs->desc; +return strcmp (as->name, bs->name); +} + +static void wordwrap (char *s,int start,int max,int corr) { -const char *const *as = a; -const char *const *bs = b; -return strcmp (*as, *bs); +int column = start; +int n; + +while (*s) { +int wlen =strcspn (s," \t" ); + +if (column + wlen >= max && column > start) { +printf ("\n%*s" , start,"" ); + column = start + corr; + } + n =printf ("%s%.*s" , column > start ?" " :"" , wlen, s); +if (n <=0 ) +break ; + s += wlen; + column += n; +while (isspace (*s)) + s++; + } }void print_pmu_events (const char *event_glob,bool name_only)
@@ -1003,7 +1036,9 @@ void print_pmu_events(const char *event_glob, bool name_only)char buf[1024 ];int printed =0 ;int len, j; -char **aliases; +struct pair *aliases; +int numdesc =0 ; +int columns =78 ; pmu =NULL ; len =0 ;
@@ -1013,14 +1048,15 @@ void print_pmu_events(const char *event_glob, bool name_only)if (pmu->selectable) len++; } - aliases =zalloc (sizeof (char *) * len); + aliases =zalloc (sizeof (struct pair ) * len);if (!aliases) goto out_enomem; pmu =NULL ; j =0 ;while ((pmu =perf_pmu__scan (pmu)) !=NULL ) {list_for_each_entry (alias, &pmu->aliases, list) { -char *name =format_alias (buf,sizeof (buf), pmu, alias); +char *name = alias->desc ? alias->name : +format_alias (buf,sizeof (buf), pmu, alias);bool is_cpu = !strcmp (pmu->name,"cpu" ); if (event_glob != NULL &&
@@ -1029,37 +1065,51 @@ void print_pmu_events(const char *event_glob, bool name_only) event_glob))))continue ; -if (is_cpu && !name_only) +if (is_cpu && !name_only && !alias->desc) name =format_alias_or (buf,sizeof (buf), pmu, alias); - aliases[j] =strdup (name); -if (aliases[j] ==NULL ) + aliases[j].name = name; +if (is_cpu && !name_only && !alias->desc) + aliases[j].name =format_alias_or (buf,sizeof (buf), + pmu, alias); + aliases[j].name =strdup (aliases[j].name); +if (!aliases[j].name) goto out_enomem; + + aliases[j].desc = alias->desc; j++; }if (pmu->selectable) {char *s;if (asprintf (&s,"%s//" , pmu->name) <0 ) goto out_enomem; - aliases[j] = s; + aliases[j].name = s; j++; } } len = j; -qsort (aliases, len,sizeof (char *), cmp_string); +qsort (aliases, len,sizeof (struct pair ), cmp_pair);for (j =0 ; j < len; j++) {if (name_only) { -printf ("%s " , aliases[j]); +printf ("%s " , aliases[j].name);continue ; } -printf (" %-50s [Kernel PMU event]\n" , aliases[j]); +if (aliases[j].desc) { +if (numdesc++ ==0 ) +printf ("\n" ); +printf (" %-50s\n" , aliases[j].name); +printf ("%*s" ,8 ,"[" ); +wordwrap (aliases[j].desc,8 , columns,0 ); +printf ("]\n" ); + }else +printf (" %-50s [Kernel PMU event]\n" , aliases[j].name); printed++; }if (printed)printf ("\n" ); out_free:for (j =0 ; j < len; j++) -zfree (&aliases[j]); +zfree (&aliases[j].name);zfree (&aliases);return ;
tools/perf/util/pmu.h +1 -0
@@ -38,6 +38,7 @@ struct perf_pmu_info {struct perf_pmu_alias {char *name; +char *desc;struct list_head terms;/* HEAD struct parse_events_term -> list */ struct list_head list;/* ELEM */ char unit[UNIT_MAX_LEN +1 ];
Signature · 1 line
1.8.3.1
PATCH v15 10/19 perf, tools: Query terminal width and use in perf list
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
Automatically adapt the now wider and word wrapped perf list output to wider terminals. This requires querying the terminal before the auto pager takes over, and exporting this information from the pager subsystem.
--- tools/perf/util/cache.h | 1 + tools/perf/util/pager.c | 15 +++++++++++++++ tools/perf/util/pmu.c | 3 ++- 3 files changed, 18 insertions(+), 1 deletion(-)
tools/perf/util/cache.h +1 -0
@@ -32,6 +32,7 @@ extern const char *perf_config_dirname(const char *, const char *);extern void setup_pager (void );extern int pager_in_use (void );extern int pager_use_color; +int pager_get_columns (void );char *alias_lookup (const char *alias);int split_cmdline (char *cmdline,const char ***argv);
tools/perf/util/pager.c +15 -0
@@ -1,6 +1,7 @@#include "cache.h" #include "run-command.h" #include "sigchain.h" +#include <sys/ioctl.h> /* * This is split up from the rest of git so that we can do
@@ -8,6 +9,7 @@*/ static int spawned_pager; +static int pager_columns;static void pager_preexec (void ) {
@@ -47,9 +49,12 @@ static void wait_for_pager_signal(int signo)void setup_pager (void ) {const char *pager =getenv ("PERF_PAGER" ); +struct winsize sz;if (!isatty (1 ))return ; +if (ioctl (1 ,TIOCGWINSZ , &sz) ==0 ) + pager_columns = sz.ws_col;if (!pager) pager =getenv ("PAGER" );if (!(pager ||access ("/usr/bin/pager" ,X_OK )))
@@ -93,3 +98,13 @@ int pager_in_use(void) env =getenv ("PERF_PAGER_IN_USE" );return env ?perf_config_bool ("PERF_PAGER_IN_USE" , env) :0 ; } + +int pager_get_columns (void ) +{ +char *s; + + s =getenv ("COLUMNS" ); +if (s) +return atoi (s); +return (pager_columns ? pager_columns :80 ) -2 ; +}
tools/perf/util/pmu.c +2 -1
@@ -14,6 +14,7 @@#include "cpumap.h" #include "header.h" #include "pmu-events/pmu-events.h" +#include "cache.h" struct perf_pmu_format {char *name;
@@ -1038,7 +1039,7 @@ void print_pmu_events(const char *event_glob, bool name_only)int len, j;struct pair *aliases;int numdesc =0 ; -int columns =78 ; +int columns =pager_get_columns (); pmu =NULL ; len =0 ;
Signature · 1 line
1.8.3.1
PATCH v15 11/19 perf, tools: Add a --no-desc flag to perf list
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
Add a --no-desc flag to perf list to not print the event descriptions that were earlier added for JSON events. This may be useful to get a less crowded listing.
It's still default to print descriptions as that is the more useful default for most users.
---
v2: Rename --quiet to --no-desc. Add option to man page.
--- tools/perf/Documentation/perf-list.txt | 8 +++++++- tools/perf/builtin-list.c | 12 ++++++++---- tools/perf/util/parse-events.c | 4 ++-- tools/perf/util/parse-events.h | 2 +- tools/perf/util/pmu.c | 4 ++-- tools/perf/util/pmu.h | 2 +- 6 files changed, 21 insertions(+), 11 deletions(-)
tools/perf/Documentation/perf-list.txt +7 -1
@@ -8,13 +8,19 @@ perf-list - List all symbolic event types SYNOPSIS -------- [verse] -'perf list' [hw|sw|cache|tracepoint|pmu|event_glob] +'perf list' [--no-desc] [hw|sw|cache|tracepoint|pmu|event_glob] DESCRIPTION ----------- This command displays the symbolic event types which can be selected in the various perf commands with the -e option. +OPTIONS +------- +--no-desc:: +Don't print descriptions. + + [[EVENT_MODIFIERS]] EVENT MODIFIERS ---------------
tools/perf/builtin-list.c +8 -4
@@ -16,16 +16,20 @@#include "util/pmu.h" #include "util/parse-options.h" +static bool desc_flag = true; +int cmd_list (int argc,const char **argv,const char *prefix__maybe_unused ) {int i;bool raw_dump = false;struct option list_options[] = {OPT_BOOLEAN (0 ,"raw-dump" , &raw_dump,"Dump raw events" ), +OPT_BOOLEAN ('d' ,"desc" , &desc_flag, +"Print extra event descriptions. --no-desc to not print." ),OPT_END () };const char *const list_usage[] = { -"perf list [hw|sw|cache|tracepoint|pmu|event_glob]" , +"perf list [--no-desc] [hw|sw|cache|tracepoint|pmu|event_glob]" ,NULL };
@@ -40,7 +44,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)printf ("\nList of pre-defined events (to be used in -e):\n\n" );if (argc ==0 ) { -print_events (NULL , raw_dump); +print_events (NULL , raw_dump, !desc_flag);return 0 ; }
@@ -59,13 +63,13 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) strcmp(argv[i], "hwcache") == 0)print_hwcache_events (NULL , raw_dump); else if (strcmp(argv[i], "pmu") == 0) - print_pmu_events(NULL, raw_dump); + print_pmu_events(NULL, raw_dump, !desc_flag); else {char *sep =strchr (argv[i],':' ), *s;int sep_idx;if (sep ==NULL ) { -print_events (argv[i], raw_dump); +print_events (argv[i], raw_dump, !desc_flag);continue ; } sep_idx = sep - argv[i];
tools/perf/util/parse-events.c +2 -2
@@ -1521,7 +1521,7 @@ out_enomem:/* * Print the help text for the event symbols: */ -void print_events (const char *event_glob,bool name_only) +void print_events (const char *event_glob,bool name_only,bool quiet_flag) {print_symbol_events (event_glob,PERF_TYPE_HARDWARE , event_symbols_hw,PERF_COUNT_HW_MAX , name_only);
@@ -1531,7 +1531,7 @@ void print_events(const char *event_glob, bool name_only)print_hwcache_events (event_glob, name_only); -print_pmu_events (event_glob, name_only); +print_pmu_events (event_glob, name_only, quiet_flag);if (event_glob !=NULL )return ;
tools/perf/util/parse-events.h +1 -1
@@ -133,7 +133,7 @@ void parse_events_update_lists(struct list_head *list_event,void parse_events_evlist_error (struct parse_events_evlist *data,int idx,const char *str); -void print_events (const char *event_glob,bool name_only); +void print_events (const char *event_glob,bool name_only,bool quiet);struct event_symbol {const char *symbol;
tools/perf/util/pmu.c +2 -2
@@ -1030,7 +1030,7 @@ static void wordwrap(char *s, int start, int max, int corr) } } -void print_pmu_events (const char *event_glob,bool name_only) +void print_pmu_events (const char *event_glob,bool name_only,bool quiet_flag) {struct perf_pmu *pmu;struct perf_pmu_alias *alias;
@@ -1095,7 +1095,7 @@ void print_pmu_events(const char *event_glob, bool name_only)printf ("%s " , aliases[j].name);continue ; } -if (aliases[j].desc) { +if (aliases[j].desc && !quiet_flag) {if (numdesc++ ==0 )printf ("\n" );printf (" %-50s\n" , aliases[j].name);
tools/perf/util/pmu.h +1 -1
@@ -69,7 +69,7 @@ int perf_pmu__format_parse(char *dir, struct list_head *head);struct perf_pmu *perf_pmu__scan (struct perf_pmu *pmu); -void print_pmu_events (const char *event_glob,bool name_only); +void print_pmu_events (const char *event_glob,bool name_only,bool quiet);bool pmu_have_event (const char *pname,const char *name); int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
Signature · 1 line
1.8.3.1
PATCH v15 12/19 perf, tools: Add override support for event list CPUID
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
Add a PERF_CPUID variable to override the CPUID of the current CPU (within the current architecture). This is useful for testing, so that all event lists can be tested on a single system.
---
v2: Fix double free in earlier version.
Print actual CPUID being used with verbose option.
--- tools/perf/util/pmu.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)
tools/perf/util/pmu.c +7 -1
@@ -477,10 +477,16 @@ static int pmu_add_cpu_aliases(struct list_head *head)struct pmu_event *pe;char *cpuid; - cpuid =get_cpuid_str (); + cpuid =getenv ("PERF_CPUID" ); +if (cpuid) + cpuid =strdup (cpuid); +if (!cpuid) + cpuid =get_cpuid_str ();if (!cpuid)return 0 ; +pr_debug ("Using CPUID %s\n" , cpuid); + i =0 ;while (1 ) { map = &pmu_events_map[i++];
Signature · 1 line
1.8.3.1
PATCH v15 13/19 perf, tools, jevents: Add support for long descriptions
In reply to Sukadev BhattiproluImplement support in jevents to parse long descriptions for events that may have them in the JSON files. A follow on patch will make this long description available to user through the 'perf list' command.
---
Changelog[v14]
- [Jiri Olsa] Break up independent parts of the patch into separate patches.
--- tools/perf/pmu-events/jevents.c | 31 +++++++++++++++++++++++-------- tools/perf/pmu-events/jevents.h | 3 ++- tools/perf/pmu-events/pmu-events.h | 1 + 3 files changed, 26 insertions(+), 9 deletions(-)
tools/perf/pmu-events/jevents.c +23 -8
@@ -203,7 +203,7 @@ static void print_events_table_prefix(FILE *fp, const char *tblname) }static int print_events_table_entry (void *data,char *name,char *event, -char *desc) +char *desc,char *long_desc) {FILE *outfp = data;/*
@@ -215,6 +215,8 @@ static int print_events_table_entry(void *data, char *name, char *event,fprintf (outfp,"\t.name = \"%s\",\n" , name);fprintf (outfp,"\t.event = \"%s\",\n" , event);fprintf (outfp,"\t.desc = \"%s\",\n" , desc); +if (long_desc && long_desc[0 ]) +fprintf (outfp,"\t.long_desc = \"%s\",\n" , long_desc);fprintf (outfp,"},\n" );
@@ -235,7 +237,8 @@ static void print_events_table_suffix(FILE *outfp)/* Call func with each event in the json file */ int json_events (const char *fn, -int (*func)(void *data,char *name,char *event,char *desc), +int (*func)(void *data,char *name,char *event,char *desc, +char *long_desc),void *data) {int err = -EIO ;
@@ -254,6 +257,8 @@ int json_events(const char *fn, tok = tokens +1 ;for (i =0 ; i < tokens->size; i++) {char *event =NULL , *desc =NULL , *name =NULL ; +char *long_desc =NULL ; +char *extra_desc =NULL ;struct msrmap *msr =NULL ;jsmntok_t *msrval =NULL ;jsmntok_t *precise =NULL ;
@@ -279,6 +284,9 @@ int json_events(const char *fn, }else if (json_streq (map, field,"BriefDescription" )) {addfield (map, &desc,"" ,"" , val);fixdesc (desc); + }else if (json_streq (map, field,"PublicDescription" )) { +addfield (map, &long_desc,"" ,"" , val); +fixdesc (long_desc); }else if (json_streq (map, field,"PEBS" ) && nz) { precise = val; }else if (json_streq (map, field,"MSRIndex" ) && nz) {
@@ -287,10 +295,10 @@ int json_events(const char *fn, msrval = val; }else if (json_streq (map, field,"Errata" ) && !json_streq (map, val,"null" )) { -addfield (map, &desc,". " , +addfield (map, &extra_desc,". " ," Spec update: " , val); }else if (json_streq (map, field,"Data_LA" ) && nz) { -addfield (map, &desc,". " , +addfield (map, &extra_desc,". " ," Supports address when precise" ,NULL ); }
@@ -298,19 +306,26 @@ int json_events(const char *fn, }if (precise && !strstr (desc,"(Precise Event)" )) {if (json_streq (map, precise,"2" )) -addfield (map, &desc," " ,"(Must be precise)" , -NULL ); +addfield (map, &extra_desc," " , +"(Must be precise)" ,NULL );else -addfield (map, &desc," " , +addfield (map, &extra_desc," " ,"(Precise event)" ,NULL ); } +if (desc && extra_desc) +addfield (map, &desc," " , extra_desc,NULL ); +if (long_desc && extra_desc) +addfield (map, &long_desc," " , extra_desc,NULL );if (msr !=NULL )addfield (map, &event,"," , msr->pname, msrval);fixname (name); - err =func (data, name, event, desc); + + err =func (data, name, event, desc, long_desc);free (event);free (desc);free (name); +free (long_desc); +free (extra_desc);if (err)break ; tok += j;
tools/perf/pmu-events/jevents.h +2 -1
@@ -2,7 +2,8 @@#define JEVENTS_H 1int json_events (const char *fn, -int (*func)(void *data,char *name,char *event,char *desc), +int (*func)(void *data,char *name,char *event,char *desc, +char *long_desc),void *data);char *get_cpu_str (void );
tools/perf/pmu-events/pmu-events.h +1 -0
@@ -8,6 +8,7 @@ struct pmu_event {const char *name;const char *event;const char *desc; +const char *long_desc; };/*
Signature · 1 line
1.8.3.1
PATCH v15 14/19 perf, tools: Add alias support for long descriptions
In reply to Sukadev BhattiproluPreviously we were dropping the useful longer descriptions that some events have in the event list completely. Now that jevents provides support for longer descriptions (see previous patch), add support for parsing the long descriptions
---
Changelog[v14]
- [Jiri Olsa] Break up independent parts of the patch into separate patches.
--- tools/perf/util/parse-events.c | 5 +++-- tools/perf/util/parse-events.h | 3 ++- tools/perf/util/pmu.c | 15 ++++++++++----- tools/perf/util/pmu.h | 4 +++- 4 files changed, 18 insertions(+), 9 deletions(-)
tools/perf/util/parse-events.c +3 -2
@@ -1521,7 +1521,8 @@ out_enomem:/* * Print the help text for the event symbols: */ -void print_events (const char *event_glob,bool name_only,bool quiet_flag) +void print_events (const char *event_glob,bool name_only,bool quiet_flag, +bool long_desc) {print_symbol_events (event_glob,PERF_TYPE_HARDWARE , event_symbols_hw,PERF_COUNT_HW_MAX , name_only);
@@ -1531,7 +1532,7 @@ void print_events(const char *event_glob, bool name_only, bool quiet_flag)print_hwcache_events (event_glob, name_only); -print_pmu_events (event_glob, name_only, quiet_flag); +print_pmu_events (event_glob, name_only, quiet_flag, long_desc);if (event_glob !=NULL )return ;
tools/perf/util/parse-events.h +2 -1
@@ -133,7 +133,8 @@ void parse_events_update_lists(struct list_head *list_event,void parse_events_evlist_error (struct parse_events_evlist *data,int idx,const char *str); -void print_events (const char *event_glob,bool name_only,bool quiet); +void print_events (const char *event_glob,bool name_only,bool quiet, +bool long_desc);struct event_symbol {const char *symbol;
tools/perf/util/pmu.c +10 -5
@@ -210,7 +210,7 @@ static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias, }static int __perf_pmu__new_alias (struct list_head *list,char *dir,char *name, -char *desc,char *val) +char *desc,char *val,char *long_desc) {struct perf_pmu_alias *alias;int ret;
@@ -243,6 +243,8 @@ static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name, } alias->desc = desc ?strdup (desc) :NULL ; + alias->long_desc = long_desc ?strdup (long_desc) : + desc ?strdup (desc) :NULL ;list_add_tail (&alias->list, list);
@@ -260,7 +262,7 @@ static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FI buf[ret] =0 ; -return __perf_pmu__new_alias (list, dir, name,NULL , buf); +return __perf_pmu__new_alias (list, dir, name,NULL , buf,NULL ); }static inline bool pmu_alias_info_file (char *name)
@@ -508,7 +510,8 @@ static int pmu_add_cpu_aliases(struct list_head *head)/* need type casts to override 'const' */ __perf_pmu__new_alias (head,NULL , (char *)pe->name, - (char *)pe->desc, (char *)pe->event); + (char *)pe->desc, (char *)pe->event, + (char *)pe->long_desc); } out:
@@ -1036,7 +1039,8 @@ static void wordwrap(char *s, int start, int max, int corr) } } -void print_pmu_events (const char *event_glob,bool name_only,bool quiet_flag) +void print_pmu_events (const char *event_glob,bool name_only,bool quiet_flag, +bool long_desc) {struct perf_pmu *pmu;struct perf_pmu_alias *alias;
@@ -1083,7 +1087,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag)if (!aliases[j].name) goto out_enomem; - aliases[j].desc = alias->desc; + aliases[j].desc = long_desc ? alias->long_desc : + alias->desc; j++; }if (pmu->selectable) {
tools/perf/util/pmu.h +3 -1
@@ -39,6 +39,7 @@ struct perf_pmu_info {struct perf_pmu_alias {char *name;char *desc; +char *long_desc;struct list_head terms;/* HEAD struct parse_events_term -> list */ struct list_head list;/* ELEM */ char unit[UNIT_MAX_LEN +1 ];
@@ -69,7 +70,8 @@ int perf_pmu__format_parse(char *dir, struct list_head *head);struct perf_pmu *perf_pmu__scan (struct perf_pmu *pmu); -void print_pmu_events (const char *event_glob,bool name_only,bool quiet); +void print_pmu_events (const char *event_glob,bool name_only,bool quiet, +bool long_desc);bool pmu_have_event (const char *pname,const char *name); int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
Signature · 1 line
1.8.3.1
PATCH v15 15/19 perf, tools: Support long descriptions with perf list
In reply to Sukadev BhattiproluPreviously we were dropping the useful longer descriptions that some events have in the event list completely. This patch makes them appear with perf list.
Old perf list:
baclears:
baclears.all
[Counts the number of baclears]
vs new:
perf list -v:
...
baclears:
baclears.all
[The BACLEARS event counts the number of times the front end is
resteered, mainly when the Branch Prediction Unit cannot provide a correct prediction and this is corrected by the Branch Address Calculator at the front end. The BACLEARS.ANY event counts the number of baclears for any type of branch]
---
Changelog[v15]
- [Jir Olsa, Andi Kleen] Fix usage strings; update man page.
Changelog[v14]
- [Jiri Olsa] Break up independent parts of the patch into separate patches.
--- tools/perf/Documentation/perf-list.txt | 6 +++++- tools/perf/builtin-list.c | 13 +++++++++---- 2 files changed, 14 insertions(+), 5 deletions(-)
tools/perf/Documentation/perf-list.txt +5 -1
@@ -8,7 +8,7 @@ perf-list - List all symbolic event types SYNOPSIS -------- [verse] -'perf list' [--no-desc] [hw|sw|cache|tracepoint|pmu|event_glob] +'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|event_glob] DESCRIPTION -----------
@@ -20,6 +20,10 @@ OPTIONS --no-desc:: Don't print descriptions. +-v:: +--long-desc:: +Print longer event descriptions. + [[EVENT_MODIFIERS]] EVENT MODIFIERS
tools/perf/builtin-list.c +9 -4
@@ -22,14 +22,17 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) {int i;bool raw_dump = false; +bool long_desc_flag = false;struct option list_options[] = {OPT_BOOLEAN (0 ,"raw-dump" , &raw_dump,"Dump raw events" ),OPT_BOOLEAN ('d' ,"desc" , &desc_flag,"Print extra event descriptions. --no-desc to not print." ), +OPT_BOOLEAN ('v' ,"long-desc" , &long_desc_flag, +"Print longer event descriptions." ),OPT_END () };const char *const list_usage[] = { -"perf list [--no-desc] [hw|sw|cache|tracepoint|pmu|event_glob]" , +"perf list [<options>] [hw|sw|cache|tracepoint|pmu|event_glob]" ,NULL };
@@ -44,7 +47,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)printf ("\nList of pre-defined events (to be used in -e):\n\n" );if (argc ==0 ) { -print_events (NULL , raw_dump, !desc_flag); +print_events (NULL , raw_dump, !desc_flag, long_desc_flag);return 0 ; }
@@ -63,13 +66,15 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) strcmp(argv[i], "hwcache") == 0)print_hwcache_events (NULL , raw_dump); else if (strcmp(argv[i], "pmu") == 0) - print_pmu_events(NULL, raw_dump, !desc_flag); +print_pmu_events (NULL , raw_dump, !desc_flag, + long_desc_flag); else {char *sep =strchr (argv[i],':' ), *s;int sep_idx;if (sep ==NULL ) { -print_events (argv[i], raw_dump, !desc_flag); +print_events (argv[i], raw_dump, !desc_flag, + long_desc_flag);continue ; } sep_idx = sep - argv[i];
Signature · 1 line
1.8.3.1
PATCH v15 16/19 perf, tools, jevents: Add support for event topics
In reply to Sukadev BhattiproluAllow assigning categories "Topics" field to the PMU events i.e. process the topic field from the JSON file and add a corresponding topic field to the generated C events tables.
---
Changelog[v14]
[Jiri Olsa] Move this independent code off into a separate patch.
--- tools/perf/pmu-events/jevents.c | 12 +++++++++--- tools/perf/pmu-events/jevents.h | 2 +- tools/perf/pmu-events/pmu-events.h | 1 + 3 files changed, 11 insertions(+), 4 deletions(-)
tools/perf/pmu-events/jevents.c +9 -3
@@ -203,7 +203,7 @@ static void print_events_table_prefix(FILE *fp, const char *tblname) }static int print_events_table_entry (void *data,char *name,char *event, -char *desc,char *long_desc) +char *desc,char *long_desc,char *topic) {FILE *outfp = data;/*
@@ -217,6 +217,8 @@ static int print_events_table_entry(void *data, char *name, char *event,fprintf (outfp,"\t.desc = \"%s\",\n" , desc);if (long_desc && long_desc[0 ])fprintf (outfp,"\t.long_desc = \"%s\",\n" , long_desc); +if (topic) +fprintf (outfp,"\t.topic = \"%s\",\n" , topic);fprintf (outfp,"},\n" );
@@ -238,7 +240,7 @@ static void print_events_table_suffix(FILE *outfp)/* Call func with each event in the json file */ int json_events (const char *fn,int (*func)(void *data,char *name,char *event,char *desc, -char *long_desc), +char *long_desc,char *topic),void *data) {int err = -EIO ;
@@ -259,6 +261,7 @@ int json_events(const char *fn,char *event =NULL , *desc =NULL , *name =NULL ;char *long_desc =NULL ;char *extra_desc =NULL ; +char *topic =NULL ;struct msrmap *msr =NULL ;jsmntok_t *msrval =NULL ;jsmntok_t *precise =NULL ;
@@ -297,6 +300,8 @@ int json_events(const char *fn, !json_streq(map, val, "null")) {addfield (map, &extra_desc,". " ," Spec update: " , val); + } else if (json_streq(map, field, "Topic")) { +addfield (map, &topic,"" ,"" , val); } else if (json_streq(map, field, "Data_LA") && nz) { addfield(map, &extra_desc, ". ", " Supports address when precise",
@@ -320,12 +325,13 @@ int json_events(const char *fn,addfield (map, &event,"," , msr->pname, msrval);fixname (name); - err =func (data, name, event, desc, long_desc); + err =func (data, name, event, desc, long_desc, topic);free (event);free (desc);free (name);free (long_desc);free (extra_desc); +free (topic);if (err)break ; tok += j;
tools/perf/pmu-events/jevents.h +1 -1
@@ -3,7 +3,7 @@int json_events (const char *fn,int (*func)(void *data,char *name,char *event,char *desc, -char *long_desc), +char *long_desc,char *topic),void *data);char *get_cpu_str (void );
tools/perf/pmu-events/pmu-events.h +1 -0
@@ -9,6 +9,7 @@ struct pmu_event {const char *event;const char *desc;const char *long_desc; +const char *topic; };/*
Signature · 1 line
1.8.3.1
PATCH v15 17/19 perf, tools: Add support for event list topics
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
Add support to group the output of perf list by the Topic field in the JSON file.
Example output:
% perf list
...
Cache:
l1d.replacement
[L1D data line replacements]
l1d_pend_miss.pending
[L1D miss oustandings duration in cycles]
l1d_pend_miss.pending_cycles
[Cycles with L1D load Misses outstanding]
l2_l1d_wb_rqsts.all
[Not rejected writebacks from L1D to L2 cache lines in any state]
l2_l1d_wb_rqsts.hit_e
[Not rejected writebacks from L1D to L2 cache lines in E state]
l2_l1d_wb_rqsts.hit_m
[Not rejected writebacks from L1D to L2 cache lines in M state]
...
Pipeline:
arith.fpu_div
[Divide operations executed]
arith.fpu_div_active
[Cycles when divider is busy executing divide operations]
baclears.any
[Counts the total number when the front end is resteered, mainly when the BPU cannot provide a correct prediction and this is corrected by other branch handling mechanisms at the front end]
br_inst_exec.all_branches
[Speculative and retired branches]
br_inst_exec.all_conditional
[Speculative and retired macro-conditional branches]
br_inst_exec.all_direct_jmp
[Speculative and retired macro-unconditional branches excluding calls and indirects]
br_inst_exec.all_direct_near_call
[Speculative and retired direct near calls]
br_inst_exec.all_indirect_jump_non_call_ret
---
Changelog[v14]
- [Jiri Olsa] Move jevents support for Topic to a separate patch.
--- tools/perf/util/pmu.c | 37 +++++++++++++++++++++++++++---------- tools/perf/util/pmu.h | 1 + 2 files changed, 28 insertions(+), 10 deletions(-)
tools/perf/util/pmu.c +27 -10
@@ -210,7 +210,8 @@ static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias, }static int __perf_pmu__new_alias (struct list_head *list,char *dir,char *name, -char *desc,char *val,char *long_desc) +char *desc,char *val,char *long_desc, +char *topic) {struct perf_pmu_alias *alias;int ret;
@@ -245,6 +246,7 @@ static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name, alias->desc = desc ?strdup (desc) :NULL ; alias->long_desc = long_desc ?strdup (long_desc) : desc ?strdup (desc) :NULL ; + alias->topic = topic ?strdup (topic) :NULL ;list_add_tail (&alias->list, list);
@@ -262,7 +264,7 @@ static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FI buf[ret] =0 ; -return __perf_pmu__new_alias (list, dir, name,NULL , buf,NULL ); +return __perf_pmu__new_alias (list, dir, name,NULL , buf,NULL ,NULL ); }static inline bool pmu_alias_info_file (char *name)
@@ -511,7 +513,7 @@ static int pmu_add_cpu_aliases(struct list_head *head)/* need type casts to override 'const' */ __perf_pmu__new_alias (head,NULL , (char *)pe->name, (char *)pe->desc, (char *)pe->event, - (char *)pe->long_desc); + (char *)pe->long_desc, (char *)pe->topic); } out:
@@ -1001,19 +1003,26 @@ static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,return buf; } -struct pair { +struct sevent {char *name;char *desc; +char *topic; }; -static int cmp_pair (const void *a,const void *b) +static int cmp_sevent (const void *a,const void *b) { -const struct pair *as = a; -const struct pair *bs = b; +const struct sevent *as = a; +const struct sevent *bs = b;/* Put extra events last */ if (!!as->desc != !!bs->desc)return !!as->desc - !!bs->desc; +if (as->topic && bs->topic) { +int n =strcmp (as->topic, bs->topic); + +if (n) +return n; + }return strcmp (as->name, bs->name); }
@@ -1047,9 +1056,10 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,char buf[1024 ];int printed =0 ;int len, j; -struct pair *aliases; +struct sevent *aliases;int numdesc =0 ;int columns =pager_get_columns (); +char *topic =NULL ; pmu =NULL ; len =0 ;
@@ -1059,7 +1069,7 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,if (pmu->selectable) len++; } - aliases =zalloc (sizeof (struct pair ) * len); + aliases =zalloc (sizeof (struct sevent ) * len);if (!aliases) goto out_enomem; pmu =NULL ;
@@ -1089,6 +1099,7 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag, aliases[j].desc = long_desc ? alias->long_desc : alias->desc; + aliases[j].topic = alias->topic; j++; }if (pmu->selectable) {
@@ -1100,7 +1111,7 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag, } } len = j; -qsort (aliases, len,sizeof (struct pair ), cmp_pair); +qsort (aliases, len,sizeof (struct sevent ), cmp_sevent);for (j =0 ; j < len; j++) {if (name_only) {printf ("%s " , aliases[j].name);
@@ -1109,6 +1120,12 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,if (aliases[j].desc && !quiet_flag) {if (numdesc++ ==0 )printf ("\n" ); +if (aliases[j].topic && (!topic || +strcmp (topic, aliases[j].topic))) { +printf ("%s%s:\n" , topic ?"\n" :"" , + aliases[j].topic); + topic = aliases[j].topic; + }printf (" %-50s\n" , aliases[j].name);printf ("%*s" ,8 ,"[" );wordwrap (aliases[j].desc,8 , columns,0 );
tools/perf/util/pmu.h +1 -0
@@ -40,6 +40,7 @@ struct perf_pmu_alias {char *name;char *desc;char *long_desc; +char *topic;struct list_head terms;/* HEAD struct parse_events_term -> list */ struct list_head list;/* ELEM */ char unit[UNIT_MAX_LEN +1 ];
Signature · 1 line
1.8.3.1
PATCH v15 18/19 perf, tools: Handle header line in mapfile
In reply to Sukadev BhattiproluFrom: Andi Kleen <[email protected]>
To work with existing mapfiles, assume that the first line in 'mapfile.csv' is a header line and skip over it.
---
Changelog[v2]
All architectures may not use the "Family" to identify. So, assume first line is header.
--- tools/perf/pmu-events/jevents.c | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
tools/perf/pmu-events/jevents.c +7 -2
@@ -462,7 +462,12 @@ static int process_mapfile(FILE *outfp, char *fpath)print_mapping_table_prefix (outfp); - line_num =0 ; +/* Skip first line (header) */ + p =fgets (line, n, mapfp); +if (!p) + goto out; + + line_num =1 ;while (1 ) {char *cpuid, *version, *type, *fname;
@@ -506,8 +511,8 @@ static int process_mapfile(FILE *outfp, char *fpath)fprintf (outfp,"},\n" ); } +out:print_mapping_table_suffix (outfp); -return 0 ; }
Signature · 1 line
1.8.3.1
PATCH v15 19/19 perf, tools: Add README for info on parsing JSON/map files
In reply to Sukadev Bhattiprolu--- tools/perf/pmu-events/README | 122 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 tools/perf/pmu-events/README
tools/perf/pmu-events/README new file +122 -0
@@ -0,0 +1,122 @@ + +The contents of this directory allow users to specify PMU events in +their CPUs by their symbolic names rather than raw event codes (see +example below). + +The main program in this directory, is the 'jevents', which is built and +executed _before_ the perf binary itself is built. + +The 'jevents' program tries to locate and process JSON files in the directory +tree tools/perf/pmu-events/arch/foo. + + - Regular files with '.json' extension in the name are assumed to be + JSON files, each of which describes a set of PMU events. + + - Regular files with basename starting with 'mapfile.csv' are assumed + to be a CSV file that maps a specific CPU to its set of PMU events. + (see below for mapfile format) + + - Directories are traversed, but all other files are ignored. + +Using the JSON files and the mapfile, 'jevents' generates the C source file, +'pmu-events.c', which encodes the two sets of tables: + + - Set of 'PMU events tables' for all known CPUs in the architecture, + (one table like the following, per JSON file; table name 'pme_power8' + is derived from JSON file name, 'power8.json'). + + struct pmu_event pme_power8[] = { + + ... + + { + .name = "pm_1plus_ppc_cmpl", + .event = "event=0x100f2", + .desc = "1 or more ppc insts finished,", + }, + + ... + } + + - A 'mapping table' that maps each CPU of the architecture, to its + 'PMU events table' + + struct pmu_events_map pmu_events_map[] = { + { + .cpuid = "004b0000", + .version = "1", + .type = "core", + .table = pme_power8 + }, + ... + + }; + +After the 'pmu-events.c' is generated, it is compiled and the resulting +'pmu-events.o' is added to 'libperf.a' which is then used to build perf. + +NOTES: + 1. Several CPUs can support same set of events and hence use a common + JSON file. Hence several entries in the pmu_events_map[] could map + to a single 'PMU events table'. + + 2. The 'pmu-events.h' has an extern declaration for the mapping table + and the generated 'pmu-events.c' defines this table. + + 3. _All_ known CPU tables for architecture are included in the perf + binary. + +At run time, perf determines the actual CPU it is running on, finds the +matching events table and builds aliases for those events. This allows +users to specify events by their name: + + $ perf stat -e pm_1plus_ppc_cmpl sleep 1 + +where 'pm_1plus_ppc_cmpl' is a Power8 PMU event. + +In case of errors when processing files in the tools/perf/pmu-events/arch +directory, 'jevents' tries to create an empty mapping file to allow the perf +build to succeed even if the PMU event aliases cannot be used. + +However some errors in processing may cause the perf build to fail. + +Mapfile format +=============== + +The mapfile.csv format is expected to be: + + Header line + CPUID,Version,File/path/name.json,Type + +where: + + Comma: + is the required field delimiter (i.e other fields cannot + have commas within them). + + Comments: + Lines in which the first character is either '\n' or '#' + are ignored. + + Header line + The header line is the first line in the file, which is + _IGNORED_. It can be a comment (begin with '#') or empty. + + CPUID: + CPUID is an arch-specific char string, that can be used + to identify CPU (and associate it with a set of PMU events + it supports). Multiple CPUIDS can point to the same + File/path/name.json. + + Example: + CPUID == 'GenuineIntel-6-2E' (on x86). + CPUID == '004b0100' (PVR value in Powerpc) + Version: + is the Version of the mapfile. + + File/path/name.json: + is the pathname for the JSON file, relative to the directory + containing the mapfile.csv + + Type: + indicates whether the events or "core" or "uncore" events.
Signature · 1 line
1.8.3.1
Sukadev Bhattiprolu [[email protected]] wrote:
| CPUs support a large number of performance monitoring events (PMU events) | and often these events are very specific to an architecture/model of the | CPU. To use most of these PMU events with perf, we currently have to identify | them by their raw codes: | | perf stat -e r100f2 sleep 1 | | This patchset allows architectures to specify these PMU events in JSON | files located in 'tools/perf/pmu-events/arch/' of the mainline tree. | The events from the JSON files for the architecture are then built into | the perf binary. | | At run time, perf identifies the specific set of events for the CPU and | creates "event aliases". These aliases allow users to specify events by | "name" as: | | perf stat -e pm_1plus_ppc_cmpl sleep 1 | | The file, 'tools/perf/pmu-events/README' in [PATCH 19/19] gives more | details. | | Note: | - All known events tables for the architecture are included in the | perf binary. | | - For architectures that don't have any JSON files, an empty mapping | table is created and they should continue to build) | | Thanks to input from Andi Kleen, Jiri Olsa, Namhyung Kim and Ingo Molnar. | | These patches are available from: | | https://github.com:sukadev/linux.git | | Branch Description | ------------------------------------------------------ | json-v15 Source Code only | json-files-5 x86 and Powerpc datafiles only | json-v15-with-data Both code and data (build/test) | | NOTE: Only "source code" patches (i.e those in json-v15) are being emailed. | Please pull the "data files" from the json-files-5 branch.
Ingo, Arnaldo,
Any updates on this patchset? They have been reviewed/acked by Jiri and we have not received any comments since then.
Is there a chance this can make it into 4.3?
Sukadev