perf script: Fix allocation of evsel->priv related to per-event dump files
Arnaldo Carvalho de Melo
maintainerPATCH 1/1 perf script: Fix allocation of evsel->priv related to per-event dump files
I'm carrying this in my perf-tools-next, please ack :-)
- Arnaldo
---
When printing output we may want to generate per event files, where the --per-event-dump option should be used, creating perf.data.EVENT.dump files instead of printing to stdout.
The callback thar processes event thus expects that evsel->priv->fp should point to either the per-event FILE descriptor or to stdout.
The a3af66f51bd0bca7 ("perf script: Fix crash because of missing evsel->priv") changeset fixed a case where evsel->priv wasn't setup, thus set to NULL, causing a segfault when trying to access evsel->priv->fp.
But it did it for the non --per-event-dump case by allocating a 'struct perf_evsel_script' just to set its ->fp to stdout.
Since evsel->priv is only freed when --per-event-dump is used, we ended up with a memory leek, detected using ASAN.
Fix it by using the same method as perf_script__setup_per_event_dump(), and reuse that static 'struct perf_evsel_script'.
Also check if evsel_script__new() failed.
--- tools/perf/builtin-script.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
tools/perf/builtin-script.c +8 -8
@@ -2410,6 +2410,9 @@ static int process_sample_event(struct perf_tool *tool,return ret; } +// Used when scr->per_event_dump is not set +static struct evsel_script es_stdout; +static int process_attr (struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) {
@@ -2418,7 +2421,6 @@ static int process_attr(struct perf_tool *tool, union perf_event *event,struct evsel *evsel, *pos;u64 sample_type;int err; -static struct evsel_script *es; err =perf_event__process_attr (tool, event, pevlist);if (err)
@@ -2428,14 +2430,13 @@ static int process_attr(struct perf_tool *tool, union perf_event *event, evsel =evlist__last (*pevlist);if (!evsel->priv) { -if (scr->per_event_dump) { +if (scr->per_event_dump) { evsel->priv =evsel_script__new (evsel, scr->session->data); - }else { - es =zalloc (sizeof (*es)); -if (!es) +if (!evsel->priv)return -ENOMEM ; - es->fp = stdout; - evsel->priv = es; + }else {// Replicate what is done in perf_script__setup_per_event_dump() + es_stdout.fp = stdout; + evsel->priv = &es_stdout; } }
@@ -2741,7 +2742,6 @@ static int perf_script__fopen_per_event_dump(struct perf_script *script)static int perf_script__setup_per_event_dump (struct perf_script *script) {struct evsel *evsel; -static struct evsel_script es_stdout;if (script->per_event_dump)return perf_script__fopen_per_event_dump (script);
Signature · 1 line
2.37.1
Quoted 19 lines · Arnaldo Carvalho de Melo
I'm carrying this in my perf-tools-next, please ack :-)
- Arnaldo
---
When printing output we may want to generate per event files, where the --per-event-dump option should be used, creating perf.data.EVENT.dump files instead of printing to stdout.
The callback thar processes event thus expects that
evsel->priv->fpshould point to either the per-event FILE descriptor or to stdout.The
a3af66f51bd0bca7("perf script: Fix crash because of missingevsel->priv") changeset fixed a case whereevsel->privwasn't setup, thus set to NULL, causing a segfault when trying to accessevsel->priv->fp.
Quoted 5 lines
But it did it for the non --per-event-dump case by allocating a 'struct
perf_evsel_script' just to set its ->fp to stdout.Since
evsel->privis only freed when --per-event-dump is used, we ended up with a memory leek, detected using ASAN.
nit: s/leek/leak/
Quoted 6 lines
Fix it by using the same method as
perf_script__setup_per_event_dump(), and reuse that static 'structperf_evsel_script'.Also check if
evsel_script__new()failed.
Quoted 7 lines
Fixes a3af66f51bd0bca7 ("perf script: Fix crash because of missing evsel->priv")Reported-by Ian Rogers <[email protected]>Cc Adrian Hunter <[email protected]>Cc Jiri Olsa <[email protected]>Cc Namhyung Kim <[email protected]>Cc Ravi Bangoria <[email protected]>Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
Tested on top of my asan work:
Quoted 27 lines
--- tools/perf/builtin-script.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)tools/perf/builtin-script.c +3
-1@@ -2410,6 +2410,9 @@ static int process_sample_event(struct perf_tool *tool,return ret; } +// Used when scr->per_event_dump is not set +static struct evsel_script es_stdout; +static int process_attr (struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) {@@ -2418,7 +2421,6 @@ static int process_attr(struct perf_tool *tool, union perf_event *event,struct evsel *evsel, *pos;u64 sample_type;int err; -static struct evsel_script *es; err =perf_event__process_attr (tool, event, pevlist);if (err)
tools/perf/builtin-script.c static int process_attr(struct perf_tool *tool, union perf_event *event, · line 2433
Quoted 5 lines
tools/perf/builtin-script.c +1
-1@@ -2428,14 +2430,13 @@ static int process_attr(struct perf_tool *tool, union perf_event *event, evsel =evlist__last (*pevlist);if (!evsel->priv) { -if (scr->per_event_dump) { +if (scr->per_event_dump) {
nit: whitespace issue.
Quoted 25 lines
tools/perf/builtin-script.c +4
-7evsel->priv =evsel_script__new (evsel, scr->session->data); - }else { - es =zalloc (sizeof (*es)); -if (!es) +if (!evsel->priv)return -ENOMEM ; - es->fp = stdout; - evsel->priv = es; + }else {// Replicate what is done in perf_script__setup_per_event_dump() + es_stdout.fp = stdout; + evsel->priv = &es_stdout; } }@@ -2741,7 +2742,6 @@ static int perf_script__fopen_per_event_dump(struct perf_script *script)static int perf_script__setup_per_event_dump (struct perf_script *script) {struct evsel *evsel; -static struct evsel_script es_stdout;if (script->per_event_dump)return perf_script__fopen_per_event_dump (script); --2.37.1
Arnaldo Carvalho de Melo
maintainerEm Tue, Jun 06, 2023 at 04:14:51PM -0700, Ian Rogers escreveu:
Quoted 21 lines
Quoted 19 lines · Arnaldo Carvalho de Melo
I'm carrying this in my perf-tools-next, please ack :-)
- Arnaldo
---
When printing output we may want to generate per event files, where the --per-event-dump option should be used, creating perf.data.EVENT.dump files instead of printing to stdout.
The callback thar processes event thus expects that
evsel->priv->fpshould point to either the per-event FILE descriptor or to stdout.The
a3af66f51bd0bca7("perf script: Fix crash because of missingevsel->priv") changeset fixed a case whereevsel->privwasn't setup, thus set to NULL, causing a segfault when trying to accessevsel->priv->fp.
Quoted 7 lines
Quoted 5 lines
But it did it for the non --per-event-dump case by allocating a 'struct
perf_evsel_script' just to set its ->fp to stdout.Since
evsel->privis only freed when --per-event-dump is used, we ended up with a memory leek, detected using ASAN.nit: s/leek/leak/
Fixed
Quoted 14 lines
Quoted 6 lines
Fix it by using the same method as
perf_script__setup_per_event_dump(), and reuse that static 'structperf_evsel_script'.Also check if
evsel_script__new()failed.Quoted 7 lines
Fixes a3af66f51bd0bca7 ("perf script: Fix crash because of missing evsel->priv")Reported-by Ian Rogers <[email protected]>Cc Adrian Hunter <[email protected]>Cc Jiri Olsa <[email protected]>Cc Namhyung Kim <[email protected]>Cc Ravi Bangoria <[email protected]>Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
Quoted 2 lines
Tested on top of my asan work:
Tested-by Ian Rogers <[email protected]>
Thanks,
- Arnaldo
Quoted 60 lines
Quoted 27 lines
--- tools/perf/builtin-script.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)tools/perf/builtin-script.c +3
-1@@ -2410,6 +2410,9 @@ static int process_sample_event(struct perf_tool *tool,return ret; } +// Used when scr->per_event_dump is not set +static struct evsel_script es_stdout; +static int process_attr (struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) {@@ -2418,7 +2421,6 @@ static int process_attr(struct perf_tool *tool, union perf_event *event,struct evsel *evsel, *pos;u64 sample_type;int err; -static struct evsel_script *es; err =perf_event__process_attr (tool, event, pevlist);if (err)tools/perf/builtin-script.c static int process_attr(struct perf_tool *tool, union perf_event *event, · line 2433
Quoted 5 lines
tools/perf/builtin-script.c +1
-1@@ -2428,14 +2430,13 @@ static int process_attr(struct perf_tool *tool, union perf_event *event, evsel =evlist__last (*pevlist);if (!evsel->priv) { -if (scr->per_event_dump) { +if (scr->per_event_dump) {nit: whitespace issue.
Quoted 25 lines
tools/perf/builtin-script.c +4
-7evsel->priv =evsel_script__new (evsel, scr->session->data); - }else { - es =zalloc (sizeof (*es)); -if (!es) +if (!evsel->priv)return -ENOMEM ; - es->fp = stdout; - evsel->priv = es; + }else {// Replicate what is done in perf_script__setup_per_event_dump() + es_stdout.fp = stdout; + evsel->priv = &es_stdout; } }@@ -2741,7 +2742,6 @@ static int perf_script__fopen_per_event_dump(struct perf_script *script)static int perf_script__setup_per_event_dump (struct perf_script *script) {struct evsel *evsel; -static struct evsel_script es_stdout;if (script->per_event_dump)return perf_script__fopen_per_event_dump (script); --2.37.1
Signature · 1 line
- Arnaldo