perf inject intel-PT LBR/brstack synthesis fixes
Ian Rogers
reviewercover perf inject intel-PT LBR/brstack synthesis fixes
An intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 ++-- tools/perf/builtin-inject.c | 83 ++++++++++++++++++++++++++++-- tools/perf/tests/dlfilter-test.c | 8 ++- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 7 ++- tools/perf/util/cs-etm.c | 6 ++- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 13 +++-- tools/perf/util/synthetic-events.c | 25 ++++++--- tools/perf/util/synthetic-events.h | 6 ++- 10 files changed, 135 insertions(+), 30 deletions(-)
Signature · 1 line
2.54.0.545.g6539524ca2-goog
Ian Rogers
reviewerPATCH 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighed an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 7 +++++-- tools/perf/util/cs-etm.c | 6 ++++-- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 7 +++++-- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 62 insertions(+), 26 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -463,8 +463,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1100,7 +1105,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +5 -2
@@ -484,8 +484,11 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq)static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.type =PERF_RECORD_SAMPLE ; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int
tools/perf/util/cs-etm.c +4 -2
@@ -1425,8 +1425,10 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq,static int cs_etm__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +5 -2
@@ -1731,8 +1731,11 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt,static int intel_pt_inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.545.g6539524ca2-goog
Re: [PATCH v1 1/2] perf event: Fix size of synthesized sample with branch stacks
Quoted 10 lines · Ian Rogers
Synthesizing branch stacks for Intel-PT highlighed an issue where
PERF_SAMPLE_BRANCH_HW_INDEXwas assumed to always be set in theperf_event_attrbranch_sample_type. This caused an incorrect size calculation.Fix the writing of the nr and
hw_idxvalues during sample event synthesis.Assisted-by Gemini:gemini-3.1-pro-previewSigned-off-by Ian Rogers <[email protected]>
Thanks,
Namhyung
Quoted 256 lines
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 7 +++++-- tools/perf/util/cs-etm.c | 6 ++++-- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 7 +++++-- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 62 insertions(+), 26 deletions(-)tools/perf/bench/inject-buildid.c +6
-3@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }tools/perf/builtin-inject.c +9
-3@@ -463,8 +463,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }@@ -1100,7 +1105,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);tools/perf/tests/dlfilter-test.c +6
-2@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );tools/perf/tests/sample-parsing.c +3
-2@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);tools/perf/util/arm-spe.c +5
-2@@ -484,8 +484,11 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq)static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.type =PERF_RECORD_SAMPLE ; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline inttools/perf/util/cs-etm.c +4
-2@@ -1425,8 +1425,10 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq,static int cs_etm__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }tools/perf/util/intel-bts.c +2
-1@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }tools/perf/util/intel-pt.c +5
-2@@ -1731,8 +1731,11 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt,static int intel_pt_inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,tools/perf/util/synthetic-events.c +18
-7@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }tools/perf/util/synthetic-events.h +4
-2@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,Signature · 1 line
2.54.0.545.g6539524ca2-goog
Ian Rogers
reviewerPATCH 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_deliver_synth_event.
2. The record layout was misaligned because of inconsistent handling of PERF_SAMPLE_BRANCH_HW_INDEX. Fixed by explicitly writing nr and hw_idx in perf_event__synthesize_sample.
3. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
4. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
5. Potential Heap Overflow in perf_event__repipe_sample : Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE , as you requested.
6. Header vs Payload Mismatch in __cmd_inject : Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
7. NULL Pointer Dereference in intel-pt.c : Addressed by updating the condition in intel_pt_do_synth_pebs_sample to fill sample. branch_stack if it was synthesized, even if not in the original sample_type .
--- tools/perf/builtin-inject.c | 87 ++++++++++++++++++++++++++++++++----- tools/perf/util/intel-pt.c | 6 ++- 2 files changed, 81 insertions(+), 12 deletions(-)
tools/perf/builtin-inject.c +77 -10
@@ -223,6 +223,11 @@ static int perf_event__repipe_attr(const struct perf_tool *tool, tool);int ret; +if (inject->itrace_synth_opts.add_last_branch) { + event->attr.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + event->attr.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + ret =perf_event__process_attr (tool, event, pevlist);if (ret)return ret;
@@ -375,7 +380,60 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && sample->aux_sample.size) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -463,13 +521,9 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); - ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, - evsel->core.attr.read_format, - evsel->core.attr.branch_sample_type, sample); -if (ret) { -pr_err ("Failed to synthesize sample\n" ); -return ret; - } +perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample);return perf_event__repipe_synth (tool, event_copy); }
@@ -2440,12 +2494,25 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/intel-pt.c +4 -2
@@ -1731,6 +1731,7 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt,static int intel_pt_inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { + event->header.type =PERF_RECORD_SAMPLE ; event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 );
@@ -2489,7 +2490,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2560,7 +2561,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.545.g6539524ca2-goog
[email protected]
AI reviewRe: [PATCH v1 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 7 potential issue(s) to consider: - [High] Silent data corruption due to removed error check in perf_event__convert_sample_callchain().…
Thank you for your contribution! Sashiko AI review found 7 potential issue(s) to consider:
- [High] Silent data corruption due to removed error check in perf_event__convert_sample_callchain().
- [High] Pipe mode attribute headers incorrectly advertise PERF_SAMPLE_AUX, breaking downstream parsers.
- [High] Out-of-bounds write and parser breakage in perf_event__repipe_attr().
- [High] Unadvertised size field left in payload by perf_inject__cut_auxtrace_sample() breaks parsing.
- [High] Off-by-one error in sample size overflow check causes infinite parsing loops.
- [High] Dangling pointer vulnerability via sample->branch_stack stack variable assignment.
- [High] hw_idx omission in PEBS synthesis causes header vs payload mismatch.
--
commit e339fa2584e0f4ca5e2c4e8eb68d763fd40fbc59
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
This patch fixes several issues with perf inject --itrace=L when synthesizing branch stacks from AUX data. It adjusts the sample types and event layout, and addresses parsing issues and potential heap overflows.
Quoted 3 lines
tools/perf/builtin-inject.c +0
-0
[ ... ]
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 230
Quoted 9 lines
tools/perf/builtin-inject.c +5
-0@@ -223,6 +223,11 @@ static int perf_event__repipe_attr(const struct perf_tool *tool, tool);int ret; +if (inject->itrace_synth_opts.add_last_branch) { + event->attr.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + event->attr.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +
Does modifying event->attr.attr.sample_type before calling perf_event__process_attr() risk an out-of-bounds write if the event buffer is truncated?
Also, this populates the session's internal evsel with PERF_SAMPLE_BRANCH_STACK, which might cause perf_evsel__parse_sample() to fail on subsequent raw records that lack this data.
For pipe mode, this function dynamically emits headers but doesn't clear PERF_SAMPLE_AUX from the repiped event->attr. Since the payload has the AUX data stripped, does this cause downstream parsers to misinterpret event boundaries because the header advertises data that isn't there?
Quoted 1 line
tools/perf/builtin-inject.c +0
-0ret =perf_event__process_attr (tool, event, pevlist);
[ ... ]
Quoted 11 lines
tools/perf/builtin-inject.c +6
-1@@ -375,7 +380,60 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err;
[ ... ]
tools/perf/builtin-inject.c static int perf_event__repipe_sample(const struct perf_tool *tool, · line 402
Quoted 2 lines
tools/perf/builtin-inject.c +2
-0+if (!sample->branch_stack) + sample->branch_stack = &dummy_bs;
If PERF_FORMAT_GROUP is used, could this leave a dangling pointer?
If deliver_sample_group() reuses the exact same sample structure for subsequent deliveries, sample->branch_stack will point to dummy_bs which is allocated on the stack and goes out of scope when this function returns.
tools/perf/builtin-inject.c static int perf_event__repipe_sample(const struct perf_tool *tool, · line 415
Quoted 13 lines
tools/perf/builtin-inject.c +13
-0+ +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >PERF_SAMPLE_MAX_SIZE ) {
Does this allow sz to be exactly PERF_SAMPLE_MAX_SIZE (65536)?
If sz evaluates to 65536, assigning it to event_copy->header.size (a __u16) would overflow and wrap to 0. Emitting an event with header.size = 0 can cause downstream parsers to enter an infinite loop.
Should this check be >= PERF_SAMPLE_MAX_SIZE?
Quoted 3 lines
tools/perf/builtin-inject.c +3
-0+pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + }
[ ... ]
tools/perf/builtin-inject.c static int perf_event__repipe_sample(const struct perf_tool *tool, · line 437
Quoted 7 lines
tools/perf/builtin-inject.c +6
-0+if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && sample->aux_sample.size) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);
This fallback leaves an 8-byte size field (set to 0) in the sample payload.
Since PERF_SAMPLE_AUX is now globally cleared from the evsel headers in __cmd_inject(), will parsers misinterpret this 8-byte field as the next field in the format (like DATA_SRC) and shift all subsequent fields?
Quoted 2 lines
tools/perf/builtin-inject.c +0
-0if (IS_ERR (event))return PTR_ERR (event);
[ ... ]
Quoted 5 lines
tools/perf/builtin-inject.c +0
-1@@ -463,13 +521,9 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); - ret = perf_event__synthesize_sample(event_copy, evsel->core.attr.sample_type,
tools/perf/builtin-inject.c static int perf_event__convert_sample_callchain(const struct perf_tool *tool, · line 527
Quoted 10 lines
tools/perf/builtin-inject.c +3
-6- evsel->core.attr.read_format, - evsel->core.attr.branch_sample_type, sample); -if (ret) { -pr_err ("Failed to synthesize sample\n" ); -return ret; - } +perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample);return perf_event__repipe_synth (tool, event_copy);
Is it safe to remove the error check here?
If synthesis fails and returns a negative error code, event_copy might remain uninitialized. Unconditionally passing it to perf_event__repipe_synth() could write malformed or uninitialized memory to the output stream.
Quoted 1 line
tools/perf/builtin-inject.c +0
-0}
[ ... ]
Quoted 3 lines
tools/perf/util/intel-pt.c +0
-0
[ ... ]
tools/perf/util/intel-pt.c static void intel_pt_prep_b_sample(struct intel_pt *pt, · line 1737
Quoted 8 lines
tools/perf/util/intel-pt.c +1
-0@@ -1731,6 +1731,7 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt,static int intel_pt_inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { + event->header.type =PERF_RECORD_SAMPLE ; event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 );
Since __cmd_inject() globally sets PERF_SAMPLE_BRANCH_HW_INDEX on all evsels when add_last_branch is true, does passing branch_sample_type=0 here omit the hw_idx field from synthesized PEBS samples?
Downstream parsers might misalign the payload if the file header advertises its presence but the payload omits it.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv2 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 ++- tools/perf/builtin-inject.c | 107 ++++++++++++++++++++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 7 +- tools/perf/util/cs-etm.c | 6 +- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 26 +++++-- tools/perf/util/synthetic-events.c | 25 +++++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 165 insertions(+), 37 deletions(-)
Signature · 1 line
2.54.0.545.g6539524ca2-goog
Ian Rogers
reviewerPATCH v2 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighed an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 7 +++++-- tools/perf/util/cs-etm.c | 6 ++++-- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 7 +++++-- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 62 insertions(+), 26 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -463,8 +463,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1100,7 +1105,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +5 -2
@@ -484,8 +484,11 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq)static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.type =PERF_RECORD_SAMPLE ; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int
tools/perf/util/cs-etm.c +4 -2
@@ -1425,8 +1425,10 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq,static int cs_etm__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +5 -2
@@ -1731,8 +1731,11 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt,static int intel_pt_inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.545.g6539524ca2-goog
[email protected]
AI reviewRe: [PATCH v2 1/2] perf event: Fix size of synthesized sample with branch stacks
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [High] Synthesized branch stack samples in hardware tracers (arm-spe, cs-etm, intel-pt) omit the hw_idx…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [High] Synthesized branch stack samples in hardware tracers (arm-spe, cs-etm, intel-pt) omit the hw_idx field despite the event attribute claiming its presence, causing parsers to read misaligned data.
- [High] In perf_event__convert_sample_callchain(), passing the unmasked evsel->core.attr.sample_type causes the generated payload to serialize stack and register data out of sync with the reduced header.size, leading to data stream corruption. --
commit eb27565513c2df3df4959ab5f50b38abd090fa86
Author: Ian Rogers <[email protected]>
perf event: Fix size of synthesized sample with branch stacks
This commit updates sample event synthesis to correctly size and write the nr and hw_idx values for branch stacks by explicitly checking the PERF_SAMPLE_BRANCH_HW_INDEX flag.
Quoted 3 lines
tools/perf/builtin-inject.c +0
-0
[ ... ]
tools/perf/builtin-inject.c static int perf_event__convert_sample_callchain(const struct perf_tool *tool, · line 468
Quoted 9 lines
tools/perf/builtin-inject.c +3
-2@@ -463,8 +463,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample);
I noticed this is fixed later in the patch series by commit "perf inject:
Fix itrace branch stack synthesis".
Does passing the unmasked evsel->core.attr.sample_type here instead of the local masked sample_type variable cause the generated payload to serialize stack and register data out of sync with the reduced header size?
[ ... ]
Quoted 3 lines
tools/perf/util/arm-spe.c +0
-0
[ ... ]
tools/perf/util/arm-spe.c static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) · line 492
Quoted 10 lines
static int
arm_spe__inject_event(union perf_event *event, struct perf_sample *sample, u64 type){tools/perf/util/arm-spe.c +5
-2- event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.type =PERF_RECORD_SAMPLE ; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }
I see this is fixed for intel-pt.c later in the series by commit "perf inject: Fix itrace branch stack synthesis", but it appears it remains unfixed for arm-spe.c and cs-etm.c.
If branch_sample_type is hardcoded to 0 here, will it omit the hw_idx field even if the synthesized event attribute claims it is present?
If so, will parsers reading the payload misinterpret the first 8 bytes of the branch entries as the hw_idx field, shifting subsequent sample fields?
[ ... ]
Quoted 3 lines
tools/perf/util/cs-etm.c +0
-0
[ ... ]
tools/perf/util/cs-etm.c static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, · line 1432
Quoted 10 lines
static int cs_etm__inject_event(union
perf_event*event,tools/perf/util/cs-etm.c +4
-2struct perf_sample *sample, u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }
Does this function suffer from the same issue, where hardcoding branch_sample_type to 0 omits the hw_idx field and causes misaligned reads during parsing?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Ian Rogers
reviewerPATCH v2 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: Addressed by updating the condition in intel_pt_do_synth_pebs_sample to fill sample. branch_stack if it was synthesized, even if not in the original sample_type.
7. Modifying event attributes in perf_event__repipe_attr early caused downstream parser breakage in pipe mode. Fixed by clearing PERF_SAMPLE_AUX when itrace_synth_opts.set is true to ensure the headers match the stripped payload. Also added a size check against struct perf_record_header_attr to prevent out-of-bounds writes.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit.
11. Silent data corruption in convert_sample_callchain: Addressed by restoring the error check for perf_event__synthesize_sample to prevent writing malformed or uninitialized memory.
12. Omission of hw_idx in PEBS synthesis: Fixed by passing the correct
evsel->core.attr.branch_sample_type instead of 0 in intel-pt.c.
---
v2:
- Fix error handling in callchain conversion by keeping the error check.
- Fix header advertise issues in pipe mode by clearing PERF_SAMPLE_AUX.
- Prevent out-of-bounds writes in attribute repiping with size checks.
- Fix sample payload misalignment by cutting the unadvertised AUX size field.
- Fix off-by-one check in sample size overflow to correctly use >=.
- Avoid dangling pointer vulnerability by restoring the branch_stack pointer.
- Pass evsel's branch_sample_type to synthesized samples to prevent hw_idx omission.
--- tools/perf/builtin-inject.c | 97 ++++++++++++++++++++++++++++++++++--- tools/perf/util/intel-pt.c | 23 ++++++--- 2 files changed, 106 insertions(+), 14 deletions(-)
tools/perf/builtin-inject.c +89 -8
@@ -223,6 +223,19 @@ static int perf_event__repipe_attr(const struct perf_tool *tool, tool);int ret; +if (event->header.size <sizeof (struct perf_record_header_attr )) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + +if (inject->itrace_synth_opts.set) + event->attr.attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + event->attr.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + event->attr.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + ret =perf_event__process_attr (tool, event, pevlist);if (ret)return ret;
@@ -330,8 +343,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -342,13 +355,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -375,7 +387,63 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && sample->aux_sample.size) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -463,7 +531,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); - ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);if (ret) {
@@ -2440,12 +2508,25 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/intel-pt.c +17 -6
@@ -1728,14 +1728,24 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { +struct evsel *evsel =NULL ; +u64 branch_sample_type =0 ; + +if (pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 ); + branch_sample_type);return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 , sample); + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1745,7 +1755,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
@@ -2489,7 +2499,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2560,7 +2570,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.545.g6539524ca2-goog
[email protected]
AI reviewRe: [PATCH v2 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider: - [Critical] Modifying `event->attr.attr` in-place in `perf_event__repipe_attr` causes SIGSEGV and…
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
- [Critical] Modifying event->attr.attr in-place in perf_event__repipe_attr causes SIGSEGV and completely breaks sample parsing.
- [High] The size check in perf_event__repipe_attr incorrectly rejects valid older files and causes out-of-bounds writes.
- [High] Flawed sample_size recalculation in perf_event__convert_sample_callchain causes heap memory leaks and malformed output. --
commit 64e2d17135bd2355121cf62d57be79321e910c46
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
This commit addresses several issues with synthesizing branch stacks from AUX data when using "perf inject --itrace=L". It modifies sample types early to handle missing branch stack flags and fixes sample synthesis logic.
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 226
Quoted 9 lines
tools/perf/builtin-inject.c +1
-0@@ -223,6 +223,19 @@ static int perf_event__repipe_attr(const struct perf_tool *tool, tool);int ret; +if (event->header.size <sizeof (struct perf_record_header_attr )) {
Does this size check incorrectly reject valid older files?
Older perf.data files have a smaller attr.size (e.g., 64 bytes). Valid events from older kernels may have a total size of 72 bytes, triggering this check and causing perf inject to wrongly reject them.
If an older event has enough trailing IDs to pass the size check, the struct ends at offset 64 and the id[] array begins at offset 72. Modifying event->attr.attr.branch_sample_type writes to offset 80, which overlaps with the id[] array and can corrupt the event ID data.
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 237
Quoted 11 lines
tools/perf/builtin-inject.c +11
-0+pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + +if (inject->itrace_synth_opts.set) + event->attr.attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + event->attr.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + event->attr.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + }
Could modifying event->attr.attr in-place here cause a segmentation fault?
When reading from a standard perf.data file, perf_session__process_events() mmaps the file into memory using PROT_READ. The event pointer passed to perf_event__repipe_attr() points directly into this read-only buffer, so writing to event->attr.attr.sample_type could immediately trigger a SIGSEGV.
Even when reading from a pipe where the buffer might be writable, applying these modifications before calling perf_event__process_attr() alters the flags received by the internal evsel. The sample records arriving next in the stream still physically contain the original layout, which causes evsel__parse_sample() to misinterpret payload offsets and abort the session.
Quoted 1 line
tools/perf/builtin-inject.c +0
-0ret =perf_event__process_attr (tool, event, pevlist);
[ ... ]
tools/perf/builtin-inject.c static int perf_event__convert_sample_callchain(const struct perf_tool *tool, · line 534
Quoted 6 lines
tools/perf/builtin-inject.c +1
-1@@ -463,7 +531,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); - ret = perf_event__synthesize_sample(event_copy, evsel->core.attr.sample_type, + ret = perf_event__synthesize_sample(event_copy, sample_type,
This wasn't introduced by this patch, but does the sample_size recalculation just above this cause heap memory leaks and malformed output?
When adjusting the size of the synthesized sample, the function adds the size of the newly injected callchain but fails to subtract the size of the original callchain present in the event. Additionally, when removing STACK_USER, it only subtracts the payload size, failing to remove the 16 bytes of length prefix and suffix metadata.
This heavily inflates the calculated sample_size. While perf_event__synthesize_sample() correctly writes the smaller, actual data to the heap buffer, perf_event__repipe_synth() writes the inflated sample_size to the output pipe, leaking uninitialized heap memory into the file and resulting in an oversized, malformed record.
Quoted 2 lines
tools/perf/builtin-inject.c +0
-0evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv3 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v3:
- Add missing Fixes: tags on both commits.
- Refactor perf_event__repipe_attr to avoid in-place modifications on read-only mmap buffers, preventing SIGSEGV in file mode and premature evsel updates in pipe mode.
- Use perf_event__synthesize_attr to correctly construct and repipe attributes in pipe mode.
- Replace manual arithmetic in convert_sample_callchain with perf_event__sample_event_size to prevent uninitialized memory leaks.
- Retrieve evsel branch_sample_type dynamically in util/arm-spe.c and util/cs-etm.c instead of hardcoding 0, resolving missing hw_idx field on synthesized branch stacks.
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 +- tools/perf/builtin-inject.c | 141 +++++++++++++++++++++++++---- tools/perf/tests/dlfilter-test.c | 8 +- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 21 ++++- tools/perf/util/cs-etm.c | 23 +++-- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 26 ++++-- tools/perf/util/synthetic-events.c | 25 +++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 216 insertions(+), 51 deletions(-)
Signature · 1 line
2.54.0.563.g4f69b47b94-goog
Ian Rogers
reviewerPATCH v3 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighted an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 7 +++++-- tools/perf/util/cs-etm.c | 6 ++++-- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 7 +++++-- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 62 insertions(+), 26 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -465,8 +465,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1102,7 +1107,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +5 -2
@@ -489,8 +489,11 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq)static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.type =PERF_RECORD_SAMPLE ; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int
tools/perf/util/cs-etm.c +4 -2
@@ -1425,8 +1425,10 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq,static int cs_etm__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +5 -2
@@ -1731,8 +1731,11 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt,static int intel_pt_inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.563.g4f69b47b94-goog
[email protected]
AI reviewRe: [PATCH v3 1/2] perf event: Fix size of synthesized sample with branch stacks
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [High] Heap buffer overflow and event truncation in `perf_event__convert_sample_callchain` due to…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [High] Heap buffer overflow and event truncation in perf_event__convert_sample_callchain due to incorrectly using unmasked sample_type.
- [High] Hardware tracer event corruption due to hardcoded branch_sample_type=0 omitting the hw_idx field.
--
commit bc54c42a1fd16f8d3cc2f06f7ef9e4f81b9c3d09
Author: Ian Rogers <[email protected]>
perf event: Fix size of synthesized sample with branch stacks
This commit fixes the writing of the nr and hw_idx values during sample event synthesis by passing the branch_sample_type into the sample size and synthesis functions.
Quoted 3 lines
tools/perf/builtin-inject.c +0
-0
[ ... ]
tools/perf/builtin-inject.c static int perf_event__convert_sample_callchain(const struct perf_tool *tool, · line 468
Quoted 9 lines
tools/perf/builtin-inject.c +3
-2@@ -463,8 +463,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample);
Is it possible this causes a heap buffer overflow or event truncation?
By using evsel->core.attr.sample_type instead of the local masked sample_type variable, the synthesizer is instructed to write the full user stack and registers into event_copy. If the original stack is large, appending the newly resolved callchain might overflow the allocation.
Additionally, since event_copy->header.size was manually adjusted to the smaller size earlier in this function, could this cause the output event stream to become truncated or corrupted?
I noticed this is explicitly fixed later in the patch series in commit 5881c330c2ca4300a88cc8c8e4d578c17a6ebef5 ("perf inject: Fix itrace branch stack synthesis").
Quoted 6 lines
tools/perf/builtin-inject.c +4
-0+if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
[ ... ]
Quoted 3 lines
tools/perf/util/arm-spe.c +0
-0
[ ... ]
tools/perf/util/arm-spe.c static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) · line 492
Quoted 12 lines
tools/perf/util/arm-spe.c +5
-2@@ -484,8 +484,11 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq)static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); + event->header.type =PERF_RECORD_SAMPLE ; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , sample); }
Could hardcoding branch_sample_type to 0 here cause hardware tracer event corruption?
Hardware tracers like ARM SPE, Intel PT, and CS-ETM explicitly set PERF_SAMPLE_BRANCH_HW_INDEX in their event attributes during setup. By passing 0 to the synthesizer, it skips writing the 8-byte hw_idx field in the payload.
When parsing the synthesized event later, wouldn't tools like evsel__parse_sample() see the flag and incorrectly consume the first 8 bytes of the branch stack entries as hw_idx, misaligning all subsequent fields?
I noticed this same hardcoded 0 is used in the cs-etm.c and intel-pt.c updates in this commit, and that this is explicitly fixed for all hardware tracers later in the patch series in commit 5881c330c2ca4300a88cc8c8e4d578c17a6ebef5 ("perf inject: Fix itrace branch stack synthesis").
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Ian Rogers
reviewerPATCH v3 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: Addressed by updating the condition in intel_pt_do_synth_pebs_sample to fill sample. branch_stack if it was synthesized, even if not in the original sample_type.
7. Modifying event attributes in perf_event__repipe_attr in-place caused SIGSEGV on read-only mmap buffers in file mode and downstream parser breakage in pipe mode. Fixed by processing the unmodified attribute first, returning immediately in non-pipe mode, and correctly synthesizing a new attribute event for pipe output using perf_event__synthesize_attr.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit.
11. Inaccurate sample size calculation and uninitialized memory leaks in
convert_sample_callchain: Fixed by replacing manual arithmetic with perf_event__sample_event_size and adding a bounds check against PERF_SAMPLE_MAX_SIZE.
12. Omission of hw_idx in synthesized samples: Fixed by retrieving the correct evsel->core.attr.branch_sample_type instead of hardcoding 0 in intel-pt.c, arm-spe.c, and cs-etm.c.
--- tools/perf/builtin-inject.c | 131 +++++++++++++++++++++++++++++++----- tools/perf/util/arm-spe.c | 18 +++-- tools/perf/util/cs-etm.c | 21 ++++-- tools/perf/util/intel-pt.c | 23 +++++-- 4 files changed, 161 insertions(+), 32 deletions(-)
tools/perf/builtin-inject.c +115 -16
@@ -216,12 +216,23 @@ static int perf_event__repipe_op4_synth(const struct perf_tool *tool,return perf_event__repipe_synth (tool, event); } +static int perf_event__repipe_synth_cb (const struct perf_tool *tool, +union perf_event *event, +struct perf_sample *sample__maybe_unused , +struct machine *machine__maybe_unused ) +{ +return perf_event__repipe_synth (tool, event); +} +static int perf_event__repipe_attr (const struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) { struct perf_inject *inject = container_of(tool, struct perf_inject, tool); +struct perf_event_attr attr; +size_t n_ids; +u64 *ids;int ret; ret =perf_event__process_attr (tool, event, pevlist);
@@ -232,7 +243,24 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + + attr = event->attr.attr; + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (attr.size <PERF_ATTR_SIZE_VER2 ) + attr.size =PERF_ATTR_SIZE_VER2 ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); } static int perf_event__repipe_event_update(const struct perf_tool *tool,
@@ -331,8 +359,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -343,13 +371,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -376,7 +403,63 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && sample->aux_sample.size) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -397,7 +480,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,struct callchain_cursor_node *node;struct thread *thread;u64 sample_type = evsel->core.attr.sample_type; -u32 sample_size = event->header.size; +size_t sz;u64 i, k;int ret;
@@ -456,16 +539,19 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool, out:memcpy (event_copy, event,sizeof (event->header)); -/* adjust sample size for stack and regs */ - sample_size -= sample->user_stack.size; - sample_size -= (hweight64 (evsel->core.attr.sample_regs_user) +1 ) *sizeof (u64); - sample_size += (sample->callchain->nr +1 ) *sizeof (u64); - event_copy->header.size = sample_size; -/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); - ret =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + sz =perf_event__sample_event_size (sample, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event_copy->header.size = sz; + + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);if (ret) {
@@ -2442,12 +2528,25 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/arm-spe.c +14 -4
@@ -487,13 +487,23 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { +struct evsel *evsel =NULL ; +u64 branch_sample_type =0 ; + +if (spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + event->header.type =PERF_RECORD_SAMPLE ; event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 ); + branch_sample_type);return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 , sample); + branch_sample_type, sample); } static inline int
@@ -505,7 +515,7 @@ arm_spe_deliver_synth_event(struct arm_spe *spe,int ret;if (spe->synth_opts.inject) { - ret =arm_spe__inject_event (event, sample, spe->sample_type); + ret =arm_spe__inject_event (spe, event, sample, spe->sample_type);if (ret)return ret; }
tools/perf/util/cs-etm.c +15 -6
@@ -1422,13 +1422,22 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, bs->nr +=1 ; } -static int cs_etm__inject_event (union perf_event *event, -struct perf_sample *sample,u64 type) +static int cs_etm__inject_event (struct cs_etm_auxtrace *etm,union perf_event *event, +struct perf_sample *sample,u64 type) { +struct evsel *evsel =NULL ; +u64 branch_sample_type =0 ; + +if (etm->session && etm->session->evlist) + evsel =evlist__id2evsel (etm->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 ); + branch_sample_type);return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 , sample); + branch_sample_type, sample); }
@@ -1594,7 +1603,7 @@ static int cs_etm__synth_instruction_sample(struct cs_etm_queue *etmq, sample.branch_stack = tidq->last_branch;if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->instructions_sample_type);if (ret)return ret;
@@ -1669,7 +1678,7 @@ static int cs_etm__synth_branch_sample(struct cs_etm_queue *etmq, }if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->branches_sample_type);if (ret)return ret;
tools/perf/util/intel-pt.c +17 -6
@@ -1728,14 +1728,24 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { +struct evsel *evsel =NULL ; +u64 branch_sample_type =0 ; + +if (pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 ); + branch_sample_type);return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 , sample); + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1745,7 +1755,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
@@ -2489,7 +2499,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2560,7 +2570,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.563.g4f69b47b94-goog
[email protected]
AI reviewRe: [PATCH v3 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 5 potential issue(s) to consider: - [Critical] Missing `PERF_SAMPLE_MAX_SIZE` bounds check in auxtrace injection helpers causes Heap…
Thank you for your contribution! Sashiko AI review found 5 potential issue(s) to consider:
- [Critical] Missing PERF_SAMPLE_MAX_SIZE bounds check in auxtrace injection helpers causes Heap Overflow.
- [High] Failure to strip size field on empty AUX samples breaks downstream parsing.
- [High] Early error return in perf_event__repipe_sample leaves a dangling pointer and corrupted shared state.
- [High] Integer underflow and out-of-bounds read in perf_event__repipe_attr.
- [Medium] Missing attr.size update in file mode branch stack injection.
--
commit 5881c330c2ca4300a88cc8c8e4d578c17a6ebef5
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
When using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file.
Quoted 6 lines
tools/perf/builtin-inject.c +0
-0@@ -231,7 +242,24 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 251
Quoted 10 lines
tools/perf/builtin-inject.c +7
-1return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + + attr = event->attr.attr; + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event);
Could event->header.size underflow n_ids here if it is smaller than the combined size of the header and attribute?
If an event is crafted with a maliciously small size, the direct struct assignment might trigger an out-of-bounds read, and the underflowed n_ids could lead to a large out-of-bounds memcpy() in perf_event__synthesize_attr().
[ ... ]
Quoted 33 lines
tools/perf/builtin-inject.c +28
-1@@ -375,7 +402,63 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + }
tools/perf/builtin-inject.c static int perf_event__repipe_sample(const struct perf_tool *tool, · line 442
Quoted 10 lines
tools/perf/builtin-inject.c +10
-0+ evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + }
Does this early return leave a dangling pointer in sample->branch_stack and corrupt the shared evsel state?
Since the cleanup logic that restores evsel->core.attr.sample_type, evsel->core.attr.branch_sample_type, and sample->branch_stack is bypassed, sample->branch_stack may be left pointing to the out-of-scope dummy_bs variable, which could cause a use-after-free if the sample is processed further.
[ ... ]
tools/perf/builtin-inject.c static int perf_event__repipe_sample(const struct perf_tool *tool, · line 465
Quoted 13 lines
tools/perf/builtin-inject.c +10
-0+ evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && sample->aux_sample.size) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
If the original event had PERF_SAMPLE_AUX set but sample->aux_sample.size is 0, will bypassing perf_inject__cut_auxtrace_sample() leave an 8-byte size field in the payload?
Because PERF_SAMPLE_AUX is globally stripped from evsel->core.attr.sample_type, downstream parsers won't expect this 8-byte field, which might misalign subsequent fields and cause parsing of the generated file to fail.
[ ... ]
Quoted 16 lines
tools/perf/builtin-inject.c +8
-2@@ -2440,12 +2526,25 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {
tools/perf/builtin-inject.c static int __cmd_inject(struct perf_inject *inject) · line 2548
Quoted 10 lines
tools/perf/builtin-inject.c +7
-0perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }
If the input file was recorded with an older, smaller attribute size, should evsel->core.attr.size be expanded to PERF_ATTR_SIZE_VER2 here as well?
Unlike the pipe mode logic in perf_event__repipe_attr(), attr.size isn't expanded here. The newly set branch_sample_type field might reside beyond attr.size and be silently omitted when headers are written to the output file.
Quoted 15 lines
tools/perf/util/arm-spe.c +5
-1@@ -482,13 +482,23 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { +struct evsel *evsel =NULL ; +u64 branch_sample_type =0 ; +
tools/perf/util/arm-spe.c static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) · line 499
Quoted 10 lines
tools/perf/util/arm-spe.c +7
-1+if (spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + event->header.type =PERF_RECORD_SAMPLE ; event->header.size =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , -/*branch_sample_type=*/ 0 ); + branch_sample_type);
Could the computed event->header.size exceed PERF_SAMPLE_MAX_SIZE here?
The sz >= PERF_SAMPLE_MAX_SIZE bounds check was added to perf_event__repipe_sample() and perf_event__convert_sample_callchain(), but appears to be missing from the hardware tracing helpers (arm_spe__inject_event, cs_etm__inject_event, intel_pt_inject_event).
If the computed size exceeds PERF_SAMPLE_MAX_SIZE, it might truncate the value when assigned to the u16 header.size, while perf_event__synthesize_sample() writes the full size and overflows the buffer.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv4 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v4:
- Avoid temporary regressions in Commit 1:
* Used local masked sample_type in convert_sample_callchain instead of unmasked evsel attribute, preventing heap overflows.
* Promoted hardware tracer signature changes and dynamic retrieval of branch_sample_type to Commit 1, removing hardcoded 0 bugs.
* Checked sample->evsel first before performing evlist__id2evsel lookup to optimize evsel retrieval when already populated.
- Address critical security and correctness feedback in Commit 2:
* Added check in perf_event__repipe_attr to prevent n_ids underflow.
* Fixed early return error path in perf_event__repipe_sample to prevent state corruption and dangling pointers on dummy_bs.
* Ensured perf_inject__cut_auxtrace_sample cuts the 8-byte size field even when aux_sample.size is 0 to prevent parser misalignment.
* Expanded older attributes to PERF_ATTR_SIZE_VER2 in file mode within __cmd_inject to prevent silent truncation of branch_sample_type.
* Added bounds checks against PERF_SAMPLE_MAX_SIZE to all hardware tracing synthetic helpers to prevent heap buffer overflows.
* Fixed checkpatch.pl warnings/errors for line-wrapping.
v3:
- Add missing Fixes: tags on both commits.
- Refactor perf_event__repipe_attr to avoid in-place modifications on read-only mmap buffers, preventing SIGSEGV in file mode and premature evsel updates in pipe mode.
- Use perf_event__synthesize_attr to correctly construct and repipe attributes in pipe mode.
- Replace manual arithmetic in convert_sample_callchain with perf_event__sample_event_size to prevent uninitialized memory leaks.
- Retrieve evsel branch_sample_type dynamically in util/arm-spe.c and util/cs-etm.c instead of hardcoding 0, resolving missing hw_idx field on synthesized branch stacks.
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 +- tools/perf/builtin-inject.c | 151 +++++++++++++++++++++++++---- tools/perf/tests/dlfilter-test.c | 8 +- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 28 +++++- tools/perf/util/cs-etm.c | 28 +++++- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 27 +++++- tools/perf/util/synthetic-events.c | 25 +++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 242 insertions(+), 48 deletions(-)
Signature · 1 line
2.54.0.563.g4f69b47b94-goog
Ian Rogers
reviewerPATCH v4 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighted an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis by passing the branch_sample_type into the sample size and synthesis functions. Also update hardware tracers (Intel PT, ARM SPE, CS-ETM) to retrieve and pass their branch_sample_type dynamically to prevent payload misalignment.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 28 ++++++++++++++++++++++++---- tools/perf/util/cs-etm.c | 28 +++++++++++++++++++++++----- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 27 +++++++++++++++++++++++---- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 118 insertions(+), 33 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -465,8 +465,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1102,7 +1107,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +24 -4
@@ -487,10 +487,30 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int
@@ -502,7 +522,7 @@ arm_spe_deliver_synth_event(struct arm_spe *spe,int ret;if (spe->synth_opts.inject) { - ret =arm_spe__inject_event (event, sample, spe->sample_type); + ret =arm_spe__inject_event (spe, event, sample, spe->sample_type);if (ret)return ret; }
tools/perf/util/cs-etm.c +23 -5
@@ -1422,11 +1422,29 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, bs->nr +=1 ; } -static int cs_etm__inject_event (union perf_event *event, +static int cs_etm__inject_event (struct cs_etm_auxtrace *etm,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && etm->session && etm->session->evlist) + evsel =evlist__id2evsel (etm->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); }
@@ -1592,7 +1610,7 @@ static int cs_etm__synth_instruction_sample(struct cs_etm_queue *etmq, sample.branch_stack = tidq->last_branch;if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->instructions_sample_type);if (ret)return ret;
@@ -1667,7 +1685,7 @@ static int cs_etm__synth_branch_sample(struct cs_etm_queue *etmq, }if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->branches_sample_type);if (ret)return ret;
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +23 -4
@@ -1728,11 +1728,30 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1742,7 +1761,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.563.g4f69b47b94-goog
Ian Rogers
reviewerPATCH v4 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: Addressed by updating the condition in intel_pt_do_synth_pebs_sample to fill sample. branch_stack if it warrants synthesis, even if not in the original sample_type.
7. Modifying event attributes in perf_event__repipe_attr in-place caused SIGSEGV on read-only mmap buffers in file mode and downstream parser breakage in pipe mode. Fixed by processing the unmodified attribute first, returning immediately in non-pipe mode, and correctly synthesizing a new attribute event for pipe output using perf_event__synthesize_attr. Also added a size validation check to prevent n_ids underflow when parsing header size.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning, including on early error return paths.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit. Cut the AUX sample payload even if size is 0.
11. Inaccurate sample size calculation and uninitialized memory leaks in
convert_sample_callchain: Fixed by replacing manual arithmetic with perf_event__sample_event_size and adding a bounds check against PERF_SAMPLE_MAX_SIZE.
12. Omission of branch_sample_type in file headers: Addressed by expanding older, smaller attributes to PERF_ATTR_SIZE_VER2 in __cmd_inject to ensure branch_sample_type is not silently omitted.
--- tools/perf/builtin-inject.c | 139 ++++++++++++++++++++++++++++++++---- 1 file changed, 124 insertions(+), 15 deletions(-)
tools/perf/builtin-inject.c +124 -15
@@ -216,12 +216,23 @@ static int perf_event__repipe_op4_synth(const struct perf_tool *tool,return perf_event__repipe_synth (tool, event); } +static int perf_event__repipe_synth_cb (const struct perf_tool *tool, +union perf_event *event, +struct perf_sample *sample__maybe_unused , +struct machine *machine__maybe_unused ) +{ +return perf_event__repipe_synth (tool, event); +} +static int perf_event__repipe_attr (const struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) { struct perf_inject *inject = container_of(tool, struct perf_inject, tool); +struct perf_event_attr attr; +size_t n_ids; +u64 *ids;int ret; ret =perf_event__process_attr (tool, event, pevlist);
@@ -232,7 +243,28 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + + attr = event->attr.attr; +if (event->header.size <sizeof (event->header) + event->attr.attr.size) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (attr.size <PERF_ATTR_SIZE_VER2 ) + attr.size =PERF_ATTR_SIZE_VER2 ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); } static int perf_event__repipe_event_update(const struct perf_tool *tool,
@@ -331,8 +363,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -343,13 +375,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -376,7 +407,67 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && + (evsel->core.attr.sample_type &PERF_SAMPLE_AUX )) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -397,7 +488,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,struct callchain_cursor_node *node;struct thread *thread;u64 sample_type = evsel->core.attr.sample_type; -u32 sample_size = event->header.size; +size_t sz;u64 i, k;int ret;
@@ -456,15 +547,18 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool, out:memcpy (event_copy, event,sizeof (event->header)); -/* adjust sample size for stack and regs */ - sample_size -= sample->user_stack.size; - sample_size -= (hweight64 (evsel->core.attr.sample_regs_user) +1 ) *sizeof (u64); - sample_size += (sample->callchain->nr +1 ) *sizeof (u64); - event_copy->header.size = sample_size; -/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); + sz =perf_event__sample_event_size (sample, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event_copy->header.size = sz; + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);
@@ -2442,12 +2536,27 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (evsel->core.attr.size <PERF_ATTR_SIZE_VER2 ) + evsel->core.attr.size =PERF_ATTR_SIZE_VER2 ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
Signature · 1 line
2.54.0.563.g4f69b47b94-goog
[email protected]
AI reviewRe: [PATCH v4 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [Critical] Size mismatch in synthesized attributes causes downstream parser out-of-bounds reads and data…
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Critical] Size mismatch in synthesized attributes causes downstream parser out-of-bounds reads and data corruption.
- [Medium] Missing implementation of intel-pt.c bug fixes claimed in commit message.
--
commit 9f4d44a4d4fc78e9089af666b1106f4abf4ea03a
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
This commit addresses multiple issues in the generation of synthesized branch stacks from AUX data. It adjusts sample types, fixes size calculation bugs, prevents event truncation, and introduces safe handling of read-only maps in perf_event__repipe_attr.
Quoted 4 lines
1. The synthesized samples were delivered without the
PERF_SAMPLE_BRANCH_STACKflag if it was not in the original event'ssample_type. Fixed by usingsample_type|evsel->synth_sample_typeinintel_pt_do_synth_pebs_sample.
[ ... ]
Quoted 4 lines
6. NULL Pointer Dereference in
intel-pt.c: Addressed by updating the condition inintel_pt_do_synth_pebs_sampleto fill sample.branch_stackif it warrants synthesis, even if not in the originalsample_type.
The commit message explicitly mentions fixes in intel_pt_do_synth_pebs_sample() within intel-pt.c, but the patch does not contain any modifications to that file.
Were these changes accidentally omitted from this patch?
Quoted 4 lines
tools/perf/builtin-inject.c +0
-0
[ ... ]
Quoted 18 lines
tools/perf/builtin-inject.c +13
-1@@ -231,7 +242,28 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + + attr = event->attr.attr; +if (event->header.size <sizeof (event->header) + event->attr.attr.size) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.sample_type &= ~PERF_SAMPLE_AUX ;
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 267
Quoted 10 lines
tools/perf/builtin-inject.c +9
-0+ +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (attr.size <PERF_ATTR_SIZE_VER2 ) + attr.size =PERF_ATTR_SIZE_VER2 ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); }
Can this cause size mismatch issues downstream?
By performing a fixed-size struct copy attr = event->attr.attr, if the incoming event's attribute is smaller (e.g., PERF_ATTR_SIZE_VER0), this will copy the trailing id array into fields like branch_sample_type.
Then, when passing it to perf_event__synthesize_attr(), it hardcodes the new event's header.size using sizeof(struct perf_event_attr) but leaves attr.size as PERF_ATTR_SIZE_VER2.
Could downstream parsers calculating the number of IDs:
n_ids = (event->header.size - sizeof(header) - attr.size) / sizeof(u64)
end up hallucinating extra IDs because header.size accounts for 136 bytes while attr.size is 80?
If the original attr.size was larger than 136, could this calculation underflow to a negative value, causing the parser to read out of bounds?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv5 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v5:
- Restored the missing PEBS branch stack synthesis fixes in intel-pt.c which were accidentally dropped in a previous rebase/conflict resolution.
- Addressed the pipe mode size mismatch and ID array out-of-bounds read:
* Safely copy the incoming attribute payload using min_t and memset zero, preventing trailing ID corruption.
* Explicitly set the synthesized event's attr.size to match the tool's physical sizeof(struct perf_event_attr), guaranteeing perfect offset alignment and removing any risk of hallucinated/garbage IDs or underflow out-of-bounds reads.
- Refactored both commit descriptions to strictly focus on code changes, deferring meta-commentary and implementation details exclusively to the cover letter.
v4:
- Avoid temporary regressions in Commit 1:
* Used local masked sample_type in convert_sample_callchain instead of unmasked evsel attribute, preventing heap overflows.
* Promoted hardware tracer signature changes and dynamic retrieval of branch_sample_type to Commit 1, removing hardcoded 0 bugs.
* Checked sample->evsel first before performing evlist__id2evsel lookup to optimize evsel retrieval when already populated.
- Address critical security and correctness feedback in Commit 2:
* Added check in perf_event__repipe_attr to prevent n_ids underflow.
* Fixed early return error path in perf_event__repipe_sample to prevent state corruption and dangling pointers on dummy_bs.
* Ensured perf_inject__cut_auxtrace_sample cuts the 8-byte size field even when aux_sample.size is 0 to prevent parser misalignment.
* Expanded older attributes to PERF_ATTR_SIZE_VER2 in file mode within __cmd_inject to prevent silent truncation of branch_sample_type.
* Added bounds checks against PERF_SAMPLE_MAX_SIZE to all hardware tracing synthetic helpers to prevent heap buffer overflows.
* Fixed checkpatch.pl warnings/errors for line-wrapping.
v3:
- Add missing Fixes: tags on both commits.
- Refactor perf_event__repipe_attr to avoid in-place modifications on read-only mmap buffers, preventing SIGSEGV in file mode and premature evsel updates in pipe mode.
- Use perf_event__synthesize_attr to correctly construct and repipe attributes in pipe mode.
- Replace manual arithmetic in convert_sample_callchain with perf_event__sample_event_size to prevent uninitialized memory leaks.
- Retrieve evsel branch_sample_type dynamically in util/arm-spe.c and util/cs-etm.c instead of hardcoding 0, resolving missing hw_idx field on synthesized branch stacks.
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 +- tools/perf/builtin-inject.c | 153 +++++++++++++++++++++++++---- tools/perf/tests/dlfilter-test.c | 8 +- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 28 +++++- tools/perf/util/cs-etm.c | 28 +++++- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 32 ++++-- tools/perf/util/synthetic-events.c | 25 +++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 247 insertions(+), 50 deletions(-)
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v5 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighted an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis by passing the branch_sample_type into the sample size and synthesis functions. Also update hardware tracers (Intel PT, ARM SPE, CS-ETM) to retrieve and pass their branch_sample_type dynamically to prevent payload misalignment.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 28 ++++++++++++++++++++++++---- tools/perf/util/cs-etm.c | 28 +++++++++++++++++++++++----- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 27 +++++++++++++++++++++++---- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 118 insertions(+), 33 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -465,8 +465,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1102,7 +1107,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +24 -4
@@ -487,10 +487,30 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int
@@ -502,7 +522,7 @@ arm_spe_deliver_synth_event(struct arm_spe *spe,int ret;if (spe->synth_opts.inject) { - ret =arm_spe__inject_event (event, sample, spe->sample_type); + ret =arm_spe__inject_event (spe, event, sample, spe->sample_type);if (ret)return ret; }
tools/perf/util/cs-etm.c +23 -5
@@ -1422,11 +1422,29 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, bs->nr +=1 ; } -static int cs_etm__inject_event (union perf_event *event, +static int cs_etm__inject_event (struct cs_etm_auxtrace *etm,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && etm->session && etm->session->evlist) + evsel =evlist__id2evsel (etm->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); }
@@ -1592,7 +1610,7 @@ static int cs_etm__synth_instruction_sample(struct cs_etm_queue *etmq, sample.branch_stack = tidq->last_branch;if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->instructions_sample_type);if (ret)return ret;
@@ -1667,7 +1685,7 @@ static int cs_etm__synth_branch_sample(struct cs_etm_queue *etmq, }if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->branches_sample_type);if (ret)return ret;
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +23 -4
@@ -1728,11 +1728,30 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1742,7 +1761,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v5 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: Addressed by updating the condition in intel_pt_do_synth_pebs_sample to fill sample. branch_stack if it warrants synthesis, even if not in the original sample_type.
7. Modifying event attributes in perf_event__repipe_attr in-place caused SIGSEGV on read-only mmap buffers in file mode and downstream parser breakage in pipe mode. Fixed by processing the unmodified attribute first, returning immediately in non-pipe mode, and correctly synthesizing a new attribute event for pipe output using perf_event__synthesize_attr. Also added a size validation check to prevent n_ids underflow when parsing header size.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning, including on early error return paths.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit. Cut the AUX sample payload even if size is 0.
11. Inaccurate sample size calculation and uninitialized memory leaks in
convert_sample_callchain: Fixed by replacing manual arithmetic with perf_event__sample_event_size and adding a bounds check against PERF_SAMPLE_MAX_SIZE.
12. Omission of branch_sample_type in file headers: Addressed by expanding older, smaller attributes to PERF_ATTR_SIZE_VER2 in __cmd_inject to ensure branch_sample_type is not silently omitted.
--- tools/perf/builtin-inject.c | 141 ++++++++++++++++++++++++++++++++---- tools/perf/util/intel-pt.c | 5 +- 2 files changed, 129 insertions(+), 17 deletions(-)
tools/perf/builtin-inject.c +126 -15
@@ -216,12 +216,23 @@ static int perf_event__repipe_op4_synth(const struct perf_tool *tool,return perf_event__repipe_synth (tool, event); } +static int perf_event__repipe_synth_cb (const struct perf_tool *tool, +union perf_event *event, +struct perf_sample *sample__maybe_unused , +struct machine *machine__maybe_unused ) +{ +return perf_event__repipe_synth (tool, event); +} +static int perf_event__repipe_attr (const struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) { struct perf_inject *inject = container_of(tool, struct perf_inject, tool); +struct perf_event_attr attr; +size_t n_ids; +u64 *ids;int ret; ret =perf_event__process_attr (tool, event, pevlist);
@@ -232,7 +243,30 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + +memset (&attr,0 ,sizeof (attr)); +memcpy (&attr, &event->attr.attr, +min_t (size_t,sizeof (attr), (size_t )event->attr.attr.size)); + +if (event->header.size <sizeof (event->header) + event->attr.attr.size) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.size =sizeof (struct perf_event_attr ); + attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); } static int perf_event__repipe_event_update(const struct perf_tool *tool,
@@ -331,8 +365,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -343,13 +377,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -376,7 +409,67 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && + (evsel->core.attr.sample_type &PERF_SAMPLE_AUX )) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -397,7 +490,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,struct callchain_cursor_node *node;struct thread *thread;u64 sample_type = evsel->core.attr.sample_type; -u32 sample_size = event->header.size; +size_t sz;u64 i, k;int ret;
@@ -456,15 +549,18 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool, out:memcpy (event_copy, event,sizeof (event->header)); -/* adjust sample size for stack and regs */ - sample_size -= sample->user_stack.size; - sample_size -= (hweight64 (evsel->core.attr.sample_regs_user) +1 ) *sizeof (u64); - sample_size += (sample->callchain->nr +1 ) *sizeof (u64); - event_copy->header.size = sample_size; -/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); + sz =perf_event__sample_event_size (sample, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event_copy->header.size = sz; + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);
@@ -2442,12 +2538,27 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (evsel->core.attr.size <PERF_ATTR_SIZE_VER2 ) + evsel->core.attr.size =PERF_ATTR_SIZE_VER2 ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/intel-pt.c +3 -2
@@ -2505,7 +2505,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2576,7 +2576,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
[email protected]
AI reviewRe: [PATCH v5 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] The newly added event size validation in `perf_event__repipe_attr` is executed after a memory…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The newly added event size validation in perf_event__repipe_attr is executed after a memory copy and is vulnerable to integer overflow on 32-bit architectures. --
commit d1753b02b3fecbf4dd36f4b01ecfc58131e9bfb4
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
This commit fixes several issues when synthesizing branch stacks from AUX data using perf inject --itrace=L. It corrects missing branch stack flags, resolves memory leaks, and adds size validation to prevent buffer overflows and parse failures.
Quoted 4 lines
tools/perf/builtin-inject.c +0
-0
[ ... ]
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 250
Quoted 11 lines
tools/perf/builtin-inject.c +6
-1@@ -231,7 +242,30 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + +memset (&attr,0 ,sizeof (attr)); +memcpy (&attr, &event->attr.attr, +min_t (size_t,sizeof (attr), (size_t )event->attr.attr.size));
Could this result in an out-of-bounds read from the event buffer if a malformed event provides a large attr.size but a very small header.size?
The size validation check happens just after this memcpy. Would it be safer to move the event->header.size check before the memcpy?
tools/perf/builtin-inject.c static int perf_event__repipe_attr(const struct perf_tool *tool, · line 256
Quoted 5 lines
tools/perf/builtin-inject.c +5
-0+ +if (event->header.size <sizeof (event->header) + event->attr.attr.size) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + }
On 32-bit architectures, can the addition of sizeof(event->header) and event->attr.attr.size overflow if the provided attr.size is exceptionally large (like 0xFFFFFFF8)?
If it wraps around to a small value, it seems it would bypass this check entirely and cause an underflow in the n_ids calculation below, potentially leading to out-of-bounds memory accesses in perf_event__synthesize_attr().
Quoted 3 lines
tools/perf/builtin-inject.c +3
-0+ n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event);
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv6 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v6:
- Address critical security and correctness feedback in Commit 2:
* Fixed potential out-of-bounds read in perf_event__repipe_attr() by moving the header.size validation check before accessing event->attr.attr.size or copying.
* Prevented 32-bit integer wrapping overflow on header.size validation by using subtraction instead of addition.
- Restored PEBS LBR synthesis fixes in tools/perf/util/intel-pt.c.
v5:
- Restored the missing PEBS branch stack synthesis fixes in intel-pt.c which were accidentally dropped in a previous rebase/conflict resolution.
- Addressed the pipe mode size mismatch and ID array out-of-bounds read:
* Safely copy the incoming attribute payload using min_t and memset zero, preventing trailing ID corruption.
* Explicitly set the synthesized event's attr.size to match the tool's physical sizeof(struct perf_event_attr), guaranteeing perfect offset alignment and removing any risk of hallucinated/garbage IDs or underflow out-of-bounds reads.
- Refactored both commit descriptions to strictly focus on code changes, deferring meta-commentary and implementation details exclusively to the cover letter.
v4:
- Avoid temporary regressions in Commit 1:
* Used local masked sample_type in convert_sample_callchain instead of unmasked evsel attribute, preventing heap overflows.
* Promoted hardware tracer signature changes and dynamic retrieval of branch_sample_type to Commit 1, removing hardcoded 0 bugs.
* Checked sample->evsel first before performing evlist__id2evsel lookup to optimize evsel retrieval when already populated.
- Address critical security and correctness feedback in Commit 2:
* Added check in perf_event__repipe_attr to prevent n_ids underflow.
* Fixed early return error path in perf_event__repipe_sample to prevent state corruption and dangling pointers on dummy_bs.
* Ensured perf_inject__cut_auxtrace_sample cuts the 8-byte size field even when aux_sample.size is 0 to prevent parser misalignment.
* Expanded older attributes to PERF_ATTR_SIZE_VER2 in file mode within __cmd_inject to prevent silent truncation of branch_sample_type.
* Added bounds checks against PERF_SAMPLE_MAX_SIZE to all hardware tracing synthetic helpers to prevent heap buffer overflows.
* Fixed checkpatch.pl warnings/errors for line-wrapping.
v3:
- Add missing Fixes: tags on both commits.
- Refactor perf_event__repipe_attr to avoid in-place modifications on read-only mmap buffers, preventing SIGSEGV in file mode and premature evsel updates in pipe mode.
- Use perf_event__synthesize_attr to correctly construct and repipe attributes in pipe mode.
- Replace manual arithmetic in convert_sample_callchain with perf_event__sample_event_size to prevent uninitialized memory leaks.
- Retrieve evsel branch_sample_type dynamically in util/arm-spe.c and util/cs-etm.c instead of hardcoding 0, resolving missing hw_idx field on synthesized branch stacks.
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 +- tools/perf/builtin-inject.c | 160 +++++++++++++++++++++++++---- tools/perf/tests/dlfilter-test.c | 8 +- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 28 ++++- tools/perf/util/cs-etm.c | 28 ++++- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 32 ++++-- tools/perf/util/synthetic-events.c | 25 +++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 254 insertions(+), 50 deletions(-)
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v6 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighted an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis by passing the branch_sample_type into the sample size and synthesis functions. Also update hardware tracers (Intel PT, ARM SPE, CS-ETM) to retrieve and pass their branch_sample_type dynamically to prevent payload misalignment.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 28 ++++++++++++++++++++++++---- tools/perf/util/cs-etm.c | 28 +++++++++++++++++++++++----- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 27 +++++++++++++++++++++++---- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 118 insertions(+), 33 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -465,8 +465,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1102,7 +1107,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +24 -4
@@ -487,10 +487,30 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int
@@ -502,7 +522,7 @@ arm_spe_deliver_synth_event(struct arm_spe *spe,int ret;if (spe->synth_opts.inject) { - ret =arm_spe__inject_event (event, sample, spe->sample_type); + ret =arm_spe__inject_event (spe, event, sample, spe->sample_type);if (ret)return ret; }
tools/perf/util/cs-etm.c +23 -5
@@ -1422,11 +1422,29 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, bs->nr +=1 ; } -static int cs_etm__inject_event (union perf_event *event, +static int cs_etm__inject_event (struct cs_etm_auxtrace *etm,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && etm->session && etm->session->evlist) + evsel =evlist__id2evsel (etm->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); }
@@ -1592,7 +1610,7 @@ static int cs_etm__synth_instruction_sample(struct cs_etm_queue *etmq, sample.branch_stack = tidq->last_branch;if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->instructions_sample_type);if (ret)return ret;
@@ -1667,7 +1685,7 @@ static int cs_etm__synth_branch_sample(struct cs_etm_queue *etmq, }if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->branches_sample_type);if (ret)return ret;
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +23 -4
@@ -1728,11 +1728,30 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1742,7 +1761,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v6 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: Addressed by updating the condition in intel_pt_do_synth_pebs_sample to fill sample. branch_stack if it warrants synthesis, even if not in the original sample_type.
7. Modifying event attributes in perf_event__repipe_attr in-place caused SIGSEGV on read-only mmap buffers in file mode and downstream parser breakage in pipe mode. Fixed by processing the unmodified attribute first, returning immediately in non-pipe mode, and correctly synthesizing a new attribute event for pipe output using perf_event__synthesize_attr. Also added a size validation check to prevent n_ids underflow when parsing header size.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning, including on early error return paths.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit. Cut the AUX sample payload even if size is 0.
11. Inaccurate sample size calculation and uninitialized memory leaks in
convert_sample_callchain: Fixed by replacing manual arithmetic with perf_event__sample_event_size and adding a bounds check against PERF_SAMPLE_MAX_SIZE.
12. Omission of branch_sample_type in file headers: Addressed by expanding older, smaller attributes to PERF_ATTR_SIZE_VER2 in __cmd_inject to ensure branch_sample_type is not silently omitted.
--- tools/perf/builtin-inject.c | 148 ++++++++++++++++++++++++++++++++---- tools/perf/util/intel-pt.c | 5 +- 2 files changed, 136 insertions(+), 17 deletions(-)
tools/perf/builtin-inject.c +133 -15
@@ -216,12 +216,23 @@ static int perf_event__repipe_op4_synth(const struct perf_tool *tool,return perf_event__repipe_synth (tool, event); } +static int perf_event__repipe_synth_cb (const struct perf_tool *tool, +union perf_event *event, +struct perf_sample *sample__maybe_unused , +struct machine *machine__maybe_unused ) +{ +return perf_event__repipe_synth (tool, event); +} +static int perf_event__repipe_attr (const struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) { struct perf_inject *inject = container_of(tool, struct perf_inject, tool); +struct perf_event_attr attr; +size_t n_ids; +u64 *ids;int ret; ret =perf_event__process_attr (tool, event, pevlist);
@@ -232,7 +243,37 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + +if (event->header.size <sizeof (struct perf_event_header ) +sizeof (u64)) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + +if (event->header.size -sizeof (event->header) < event->attr.attr.size) { +pr_err ("Attribute event size %u is too small for attr.size %u\n" , + event->header.size, event->attr.attr.size); +return -EINVAL ; + } + +memset (&attr,0 ,sizeof (attr)); +memcpy (&attr, &event->attr.attr, +min_t (size_t,sizeof (attr), (size_t )event->attr.attr.size)); + + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.size =sizeof (struct perf_event_attr ); + attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); } static int perf_event__repipe_event_update(const struct perf_tool *tool,
@@ -331,8 +372,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -343,13 +384,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -376,7 +416,67 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && + (evsel->core.attr.sample_type &PERF_SAMPLE_AUX )) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -397,7 +497,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,struct callchain_cursor_node *node;struct thread *thread;u64 sample_type = evsel->core.attr.sample_type; -u32 sample_size = event->header.size; +size_t sz;u64 i, k;int ret;
@@ -456,15 +556,18 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool, out:memcpy (event_copy, event,sizeof (event->header)); -/* adjust sample size for stack and regs */ - sample_size -= sample->user_stack.size; - sample_size -= (hweight64 (evsel->core.attr.sample_regs_user) +1 ) *sizeof (u64); - sample_size += (sample->callchain->nr +1 ) *sizeof (u64); - event_copy->header.size = sample_size; -/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); + sz =perf_event__sample_event_size (sample, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event_copy->header.size = sz; + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);
@@ -2442,12 +2545,27 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (evsel->core.attr.size <PERF_ATTR_SIZE_VER2 ) + evsel->core.attr.size =PERF_ATTR_SIZE_VER2 ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/intel-pt.c +3 -2
@@ -2505,7 +2505,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2576,7 +2576,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
[email protected]
AI reviewRe: [PATCH v6 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] The patch introduces a reliable NULL pointer dereference in `intel_pt_do_synth_pebs_sample` when…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The patch introduces a reliable NULL pointer dereference in intel_pt_do_synth_pebs_sample when branch stack injection is requested via perf inject --itrace=L. --
commit 2c77e921627255ed5c1e2aee4ca756b993e7acc3
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
When using "perf inject --itrace=L" to synthesize branch stacks from AUX data, this commit fixes several issues, including missing PERF_SAMPLE_BRANCH_STACK flags, incorrect sample types early in __cmd_inject, and other validation and memory problems in sample repiping.
Quoted 4 lines
tools/perf/util/intel-pt.c +0
-0
[ ... ]
Quoted 11 lines
tools/perf/util/intel-pt.c +1
-1@@ -2505,7 +2505,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {intel_pt_add_lbrs(ptq->last_branch, items); } else if (pt->synth_opts.last_branch) {
Quoted 8 lines
thread_stack__br_sample(ptq->thread, ptq->cpu,
ptq->last_branch,
pt->br_stack_sz);
} else {
ptq->last_branch->nr = 0;
}
sample.branch_stack = ptq->last_branch;
}Could this lead to a NULL pointer dereference when running perf inject --itrace=L?
When branch stack injection is requested, pt->synth_opts.add_last_branch is true, but pt->synth_opts.last_branch and pt->synth_opts.other_events remain false. This bypasses the allocation of ptq->last_branch in intel_pt_alloc_queue(), leaving it as NULL.
Simultaneously, intel_pt_br_stack_init() sets the PERF_SAMPLE_BRANCH_STACK flag in evsel->synth_sample_type for all evsels. By checking (sample_type | evsel->synth_sample_type) & PERF_SAMPLE_BRANCH_STACK, execution is forced into this branch stack handling block for PEBS samples.
Inside this block, the code dereferences ptq->last_branch either in intel_pt_add_lbrs() or by assigning ptq->last_branch->nr = 0. Since ptq->last_branch is NULL, this leads to a segmentation fault.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv7 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v7:
- Fixed a critical NULL pointer dereference crash in Commit 2:
* In tools/perf/util/intel-pt.c, when branch stack injection is requested (add_last_branch is true) but last_branch is false (such as in perf inject --itrace=L), ptq->last_branch was not allocated.
* When PEBS branch stack synthesis is forced via evsel->synth_sample_type, the code dereferenced ptq->last_branch inside do_synth_pebs_sample (either in intel_pt_add_lbrs or by setting nr = 0), causing a SEGSEGV.
* Fixed by ensuring ptq->last_branch is successfully allocated in intel_pt_alloc_queue() when add_last_branch is requested.
v6:
- Address critical security and correctness feedback in Commit 2:
* Fixed potential out-of-bounds read in perf_event__repipe_attr() by moving the header.size validation check before accessing event->attr.attr.size or copying.
* Prevented 32-bit integer wrapping overflow on header.size validation by using subtraction instead of addition.
- Restored PEBS LBR synthesis fixes in tools/perf/util/intel-pt.c.
v5:
- Restored the missing PEBS branch stack synthesis fixes in intel-pt.c which were accidentally dropped in a previous rebase/conflict resolution.
- Addressed the pipe mode size mismatch and ID array out-of-bounds read:
* Safely copy the incoming attribute payload using min_t and memset zero, preventing trailing ID corruption.
* Explicitly set the synthesized event's attr.size to match the tool's physical sizeof(struct perf_event_attr), guaranteeing perfect offset alignment and removing any risk of hallucinated/garbage IDs or underflow out-of-bounds reads.
- Refactored both commit descriptions to strictly focus on code changes, deferring meta-commentary and implementation details exclusively to the cover letter.
v4:
- Avoid temporary regressions in Commit 1:
* Used local masked sample_type in convert_sample_callchain instead of unmasked evsel attribute, preventing heap overflows.
* Promoted hardware tracer signature changes and dynamic retrieval of branch_sample_type to Commit 1, removing hardcoded 0 bugs.
* Checked sample->evsel first before performing evlist__id2evsel lookup to optimize evsel retrieval when already populated.
- Address critical security and correctness feedback in Commit 2:
* Added check in perf_event__repipe_attr to prevent n_ids underflow.
* Fixed early return error path in perf_event__repipe_sample to prevent state corruption and dangling pointers on dummy_bs.
* Ensured perf_inject__cut_auxtrace_sample cuts the 8-byte size field even when aux_sample.size is 0 to prevent parser misalignment.
* Expanded older attributes to PERF_ATTR_SIZE_VER2 in file mode within __cmd_inject to prevent silent truncation of branch_sample_type.
* Added bounds checks against PERF_SAMPLE_MAX_SIZE to all hardware tracing synthetic helpers to prevent heap buffer overflows.
* Fixed checkpatch.pl warnings/errors for line-wrapping.
v3:
- Add missing Fixes: tags on both commits.
- Refactor perf_event__repipe_attr to avoid in-place modifications on read-only mmap buffers, preventing SIGSEGV in file mode and premature evsel updates in pipe mode.
- Use perf_event__synthesize_attr to correctly construct and repipe attributes in pipe mode.
- Replace manual arithmetic in convert_sample_callchain with perf_event__sample_event_size to prevent uninitialized memory leaks.
- Retrieve evsel branch_sample_type dynamically in util/arm-spe.c and util/cs-etm.c instead of hardcoding 0, resolving missing hw_idx field on synthesized branch stacks.
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 +- tools/perf/builtin-inject.c | 160 +++++++++++++++++++++++++---- tools/perf/tests/dlfilter-test.c | 8 +- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 28 ++++- tools/perf/util/cs-etm.c | 28 ++++- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 35 +++++-- tools/perf/util/synthetic-events.c | 25 +++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 256 insertions(+), 51 deletions(-)
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v7 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighted an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis by passing the branch_sample_type into the sample size and synthesis functions. Also update hardware tracers (Intel PT, ARM SPE, CS-ETM) to retrieve and pass their branch_sample_type dynamically to prevent payload misalignment.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 28 ++++++++++++++++++++++++---- tools/perf/util/cs-etm.c | 28 +++++++++++++++++++++++----- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 27 +++++++++++++++++++++++---- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 118 insertions(+), 33 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -465,8 +465,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1102,7 +1107,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +24 -4
@@ -487,10 +487,30 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int
@@ -502,7 +522,7 @@ arm_spe_deliver_synth_event(struct arm_spe *spe,int ret;if (spe->synth_opts.inject) { - ret =arm_spe__inject_event (event, sample, spe->sample_type); + ret =arm_spe__inject_event (spe, event, sample, spe->sample_type);if (ret)return ret; }
tools/perf/util/cs-etm.c +23 -5
@@ -1422,11 +1422,29 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, bs->nr +=1 ; } -static int cs_etm__inject_event (union perf_event *event, +static int cs_etm__inject_event (struct cs_etm_auxtrace *etm,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && etm->session && etm->session->evlist) + evsel =evlist__id2evsel (etm->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); }
@@ -1592,7 +1610,7 @@ static int cs_etm__synth_instruction_sample(struct cs_etm_queue *etmq, sample.branch_stack = tidq->last_branch;if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->instructions_sample_type);if (ret)return ret;
@@ -1667,7 +1685,7 @@ static int cs_etm__synth_branch_sample(struct cs_etm_queue *etmq, }if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->branches_sample_type);if (ret)return ret;
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +23 -4
@@ -1728,11 +1728,30 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1742,7 +1761,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v7 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: When branch stack injection is requested (add_last_branch is true) but last_branch is false (e.g., perf inject --itrace=L), ptq->last_branch was not allocated. However, PEBS branch stack synthesis (via synth_sample_type) still forced LBR handling in do_synth_pebs_sample(), dereferencing the NULL ptq->last_branch pointer. Guarding the dereference is not sufficient because downstream sample size calculation and synthesis strictly require a non-NULL branch_stack when the bit is set. Fixed by ensuring ptq->last_branch is allocated in intel_pt_alloc_queue() when add_last_branch is requested.
7. Modifying event attributes in perf_event__repipe_attr in-place caused SIGSEGV on read-only mmap buffers in file mode and downstream parser breakage in pipe mode. Fixed by processing the unmodified attribute first, returning immediately in non-pipe mode, and correctly synthesizing a new attribute event for pipe output using perf_event__synthesize_attr. Also:
- Added a size validation check and integer underflow protection when parsing n_ids.
- Prevented Trailing ID memory corruption by zero-initializing the local attr copy and safely copying using min_t(size_t, sizeof(attr), event->attr.attr.size).
- Resolved ID array parsing mismatch downstream by expanding attr.size to sizeof(struct perf_event_attr) before synthesis to guarantee perfect header/attribute size alignment.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning, including on early error return paths.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit. Cut the AUX sample payload even if size is 0.
11. Inaccurate sample size calculation and uninitialized memory leaks in
convert_sample_callchain: Fixed by replacing manual arithmetic with perf_event__sample_event_size and adding a bounds check against PERF_SAMPLE_MAX_SIZE.
12. Omission of branch_sample_type in file headers: Addressed by expanding older, smaller attributes to PERF_ATTR_SIZE_VER2 in __cmd_inject to ensure branch_sample_type is not silently omitted.
--- tools/perf/builtin-inject.c | 148 ++++++++++++++++++++++++++++++++---- tools/perf/util/intel-pt.c | 8 +- 2 files changed, 138 insertions(+), 18 deletions(-)
tools/perf/builtin-inject.c +133 -15
@@ -216,12 +216,23 @@ static int perf_event__repipe_op4_synth(const struct perf_tool *tool,return perf_event__repipe_synth (tool, event); } +static int perf_event__repipe_synth_cb (const struct perf_tool *tool, +union perf_event *event, +struct perf_sample *sample__maybe_unused , +struct machine *machine__maybe_unused ) +{ +return perf_event__repipe_synth (tool, event); +} +static int perf_event__repipe_attr (const struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) { struct perf_inject *inject = container_of(tool, struct perf_inject, tool); +struct perf_event_attr attr; +size_t n_ids; +u64 *ids;int ret; ret =perf_event__process_attr (tool, event, pevlist);
@@ -232,7 +243,37 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + +if (event->header.size <sizeof (struct perf_event_header ) +sizeof (u64)) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + +if (event->header.size -sizeof (event->header) < event->attr.attr.size) { +pr_err ("Attribute event size %u is too small for attr.size %u\n" , + event->header.size, event->attr.attr.size); +return -EINVAL ; + } + +memset (&attr,0 ,sizeof (attr)); +memcpy (&attr, &event->attr.attr, +min_t (size_t,sizeof (attr), (size_t )event->attr.attr.size)); + + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.size =sizeof (struct perf_event_attr ); + attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); } static int perf_event__repipe_event_update(const struct perf_tool *tool,
@@ -331,8 +372,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -343,13 +384,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -376,7 +416,67 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && + (evsel->core.attr.sample_type &PERF_SAMPLE_AUX )) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -397,7 +497,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,struct callchain_cursor_node *node;struct thread *thread;u64 sample_type = evsel->core.attr.sample_type; -u32 sample_size = event->header.size; +size_t sz;u64 i, k;int ret;
@@ -456,15 +556,18 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool, out:memcpy (event_copy, event,sizeof (event->header)); -/* adjust sample size for stack and regs */ - sample_size -= sample->user_stack.size; - sample_size -= (hweight64 (evsel->core.attr.sample_regs_user) +1 ) *sizeof (u64); - sample_size += (sample->callchain->nr +1 ) *sizeof (u64); - event_copy->header.size = sample_size; -/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); + sz =perf_event__sample_event_size (sample, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event_copy->header.size = sz; + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);
@@ -2442,12 +2545,27 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (evsel->core.attr.size <PERF_ATTR_SIZE_VER2 ) + evsel->core.attr.size =PERF_ATTR_SIZE_VER2 ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/intel-pt.c +5 -3
@@ -1307,7 +1307,8 @@ static struct intel_pt_queue *intel_pt_alloc_queue(struct intel_pt *pt, goto out_free; } -if (pt->synth_opts.last_branch || pt->synth_opts.other_events) { +if (pt->synth_opts.last_branch || pt->synth_opts.add_last_branch || + pt->synth_opts.other_events) {unsigned int entry_cnt =max (LBRS_MAX , pt->br_stack_sz); ptq->last_branch =intel_pt_alloc_br_stack (entry_cnt);
@@ -2505,7 +2506,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2576,7 +2577,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
[email protected]
AI reviewRe: [PATCH v7 2/2] perf inject: Fix itrace branch stack synthesis
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] Unconditional dereference of `evsel` in `perf_event__repipe_sample` can cause a SIGSEGV when…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] Unconditional dereference of evsel in perf_event__repipe_sample can cause a SIGSEGV when processing events with unknown IDs. --
commit f883a5f637221df403997603ff0a3d50c5cf401b
Author: Ian Rogers <[email protected]>
perf inject: Fix itrace branch stack synthesis
This commit addresses several issues with synthesizing branch stacks from AUX data when using "perf inject --itrace=L". It fixes sample types, modifies event attributes, and addresses multiple parsing, size calculation, and pointer issues in event repiping paths.
Quoted 4 lines
tools/perf/builtin-inject.c +0
-0
[ ... ]
tools/perf/builtin-inject.c static int perf_event__repipe_sample(const struct perf_tool *tool, · line 425
Quoted 13 lines
tools/perf/builtin-inject.c +8
-1@@ -375,7 +415,67 @@ static int perf_event__repipe_sample(const struct perf_tool *tool,build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type;
If machines__deliver_event() encounters a PERF_RECORD_READ event with an unknown or missing sample ID, evsel may be evaluated to NULL and passed to this callback. Does this unconditionally dereference evsel, leading to a crash when analyzing a malformed perf.data file?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Ian Rogers
reviewerv8 cover perf inject intel-PT LBR/brstack synthesis fixes
In reply to Ian RogersAn intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their perf_event_attr. A range of fixes were required.
This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
v8:
- Avoid potential NULL pointer dereference of evsel in Commit 2:
* If machines__deliver_event() processes a malformed PERF_RECORD_READ event with an unknown or missing sample ID, the evsel is passed as NULL.
* Added an early evsel == NULL check in perf_event__repipe_sample() to safely fallback and repipe the raw event unmodified, preventing any segmentation faults.
v7:
- Fixed a critical NULL pointer dereference crash in Commit 2:
* In tools/perf/util/intel-pt.c, when branch stack injection is requested (add_last_branch is true) but last_branch is false (such as in perf inject --itrace=L), ptq->last_branch was not allocated.
* When PEBS branch stack synthesis is forced via evsel->synth_sample_type, the code dereferenced ptq->last_branch inside do_synth_pebs_sample (either in intel_pt_add_lbrs or by setting nr = 0), causing a SEGSEGV.
* Fixed by ensuring ptq->last_branch is successfully allocated in intel_pt_alloc_queue() when add_last_branch is requested.
v6:
- Address critical security and correctness feedback in Commit 2:
* Fixed potential out-of-bounds read in perf_event__repipe_attr() by moving the header.size validation check before accessing event->attr.attr.size or copying.
* Prevented 32-bit integer wrapping overflow on header.size validation by using subtraction instead of addition.
- Restored PEBS LBR synthesis fixes in tools/perf/util/intel-pt.c.
v5:
- Restored the missing PEBS branch stack synthesis fixes in intel-pt.c which were accidentally dropped in a previous rebase/conflict resolution.
- Addressed the pipe mode size mismatch and ID array out-of-bounds read:
* Safely copy the incoming attribute payload using min_t and memset zero, preventing trailing ID corruption.
* Explicitly set the synthesized event's attr.size to match the tool's physical sizeof(struct perf_event_attr), guaranteeing perfect offset alignment and removing any risk of hallucinated/garbage IDs or underflow out-of-bounds reads.
- Refactored both commit descriptions to strictly focus on code changes, deferring meta-commentary and implementation details exclusively to the cover letter.
v4:
- Avoid temporary regressions in Commit 1:
* Used local masked sample_type in convert_sample_callchain instead of unmasked evsel attribute, preventing heap overflows.
* Promoted hardware tracer signature changes and dynamic retrieval of branch_sample_type to Commit 1, removing hardcoded 0 bugs.
* Checked sample->evsel first before performing evlist__id2evsel lookup to optimize evsel retrieval when already populated.
- Address critical security and correctness feedback in Commit 2:
* Added check in perf_event__repipe_attr to prevent n_ids underflow.
* Fixed early return error path in perf_event__repipe_sample to prevent state corruption and dangling pointers on dummy_bs.
* Ensured perf_inject__cut_auxtrace_sample cuts the 8-byte size field even when aux_sample.size is 0 to prevent parser misalignment.
* Expanded older attributes to PERF_ATTR_SIZE_VER2 in file mode within __cmd_inject to prevent silent truncation of branch_sample_type.
* Added bounds checks against PERF_SAMPLE_MAX_SIZE to all hardware tracing synthetic helpers to prevent heap buffer overflows.
* Fixed checkpatch.pl warnings/errors for line-wrapping.
v3:
- Add missing Fixes: tags on both commits.
- Refactor perf_event__repipe_attr to avoid in-place modifications on read-only mmap buffers, preventing SIGSEGV in file mode and premature evsel updates in pipe mode.
- Use perf_event__synthesize_attr to correctly construct and repipe attributes in pipe mode.
- Replace manual arithmetic in convert_sample_callchain with perf_event__sample_event_size to prevent uninitialized memory leaks.
- Retrieve evsel branch_sample_type dynamically in util/arm-spe.c and util/cs-etm.c instead of hardcoding 0, resolving missing hw_idx field on synthesized branch stacks.
v2: Response to sashiko fixes for patch 2, Namhyung's acked-by for patch 1.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (2):
perf event: Fix size of synthesized sample with branch stacks perf inject: Fix itrace branch stack synthesis
tools/perf/bench/inject-buildid.c | 9 +- tools/perf/builtin-inject.c | 165 +++++++++++++++++++++++++---- tools/perf/tests/dlfilter-test.c | 8 +- tools/perf/tests/sample-parsing.c | 5 +- tools/perf/util/arm-spe.c | 28 ++++- tools/perf/util/cs-etm.c | 28 ++++- tools/perf/util/intel-bts.c | 3 +- tools/perf/util/intel-pt.c | 35 ++++-- tools/perf/util/synthetic-events.c | 25 +++-- tools/perf/util/synthetic-events.h | 6 +- 10 files changed, 260 insertions(+), 52 deletions(-)
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v8 1/2 perf event: Fix size of synthesized sample with branch stacks
Synthesizing branch stacks for Intel-PT highlighted an issue where PERF_SAMPLE_BRANCH_HW_INDEX was assumed to always be set in the perf_event_attr branch_sample_type. This caused an incorrect size calculation.
Fix the writing of the nr and hw_idx values during sample event synthesis by passing the branch_sample_type into the sample size and synthesis functions. Also update hardware tracers (Intel PT, ARM SPE, CS-ETM) to retrieve and pass their branch_sample_type dynamically to prevent payload misalignment.
--- tools/perf/bench/inject-buildid.c | 9 ++++++--- tools/perf/builtin-inject.c | 12 +++++++++--- tools/perf/tests/dlfilter-test.c | 8 ++++++-- tools/perf/tests/sample-parsing.c | 5 +++-- tools/perf/util/arm-spe.c | 28 ++++++++++++++++++++++++---- tools/perf/util/cs-etm.c | 28 +++++++++++++++++++++++----- tools/perf/util/intel-bts.c | 3 ++- tools/perf/util/intel-pt.c | 27 +++++++++++++++++++++++---- tools/perf/util/synthetic-events.c | 25 ++++++++++++++++++------- tools/perf/util/synthetic-events.h | 6 ++++-- 10 files changed, 118 insertions(+), 33 deletions(-)
tools/perf/bench/inject-buildid.c +6 -3
@@ -228,9 +228,12 @@ static ssize_t synthesize_sample(struct bench_data *data, struct bench_dso *dso, event.header.type =PERF_RECORD_SAMPLE ; event.header.misc =PERF_RECORD_MISC_USER ; - event.header.size =perf_event__sample_event_size (&sample, bench_sample_type,0 ); - -perf_event__synthesize_sample (&event, bench_sample_type,0 , &sample); + event.header.size =perf_event__sample_event_size (&sample, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); +perf_event__synthesize_sample (&event, bench_sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);return writen (data->input_pipe[1 ], &event, event.header.size); }
tools/perf/builtin-inject.c +9 -3
@@ -465,8 +465,13 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); -perf_event__synthesize_sample (event_copy, sample_type, - evsel->core.attr.read_format, sample); + ret =perf_event__synthesize_sample (event_copy, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); +if (ret) { +pr_err ("Failed to synthesize sample\n" ); +return ret; + }return perf_event__repipe_synth (tool, event_copy); }
@@ -1102,7 +1107,8 @@ static int perf_inject__sched_stat(const struct perf_tool *tool, sample_sw.period = sample->period; sample_sw.time = sample->time;perf_event__synthesize_sample (event_sw, evsel->core.attr.sample_type, - evsel->core.attr.read_format, &sample_sw); + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, &sample_sw);build_id__mark_dso_hit (tool, event_sw, &sample_sw, evsel, machine); ret =perf_event__repipe (tool, event_sw, &sample_sw, machine);perf_sample__exit (&sample_sw);
tools/perf/tests/dlfilter-test.c +6 -2
@@ -188,8 +188,12 @@ static int write_sample(struct test_data *td, u64 sample_type, u64 id, pid_t pid event->header.type =PERF_RECORD_SAMPLE ; event->header.misc =PERF_RECORD_MISC_USER ; - event->header.size =perf_event__sample_event_size (&sample, sample_type,0 ); - err =perf_event__synthesize_sample (event, sample_type,0 , &sample); + event->header.size =perf_event__sample_event_size (&sample, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 ); + err =perf_event__synthesize_sample (event, sample_type, +/*read_format=*/ 0 , +/*branch_sample_type=*/ 0 , &sample);if (err)return test_result ("perf_event__synthesize_sample() failed" ,TEST_FAIL );
tools/perf/tests/sample-parsing.c +3 -2
@@ -310,7 +310,8 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) sample.read.one.lost =1 ; } - sz =perf_event__sample_event_size (&sample, sample_type, read_format); + sz =perf_event__sample_event_size (&sample, sample_type, read_format, + evsel.core.attr.branch_sample_type); bufsz = sz +4096 ;/* Add a bit for overrun checking */ event =malloc (bufsz);if (!event) {
@@ -324,7 +325,7 @@ static int do_test(u64 sample_type, u64 sample_regs, u64 read_format) event->header.size = sz; err =perf_event__synthesize_sample (event, sample_type, read_format, - &sample); + evsel.core.attr.branch_sample_type, &sample);if (err) {pr_debug ("%s failed for sample_type %#" PRIx64", error %d\n" ,"perf_event__synthesize_sample" , sample_type, err);
tools/perf/util/arm-spe.c +24 -4
@@ -487,10 +487,30 @@ static void arm_spe__prep_branch_stack(struct arm_spe_queue *speq) bstack->hw_idx =-1ULL ; } -static int arm_spe__inject_event (union perf_event *event,struct perf_sample *sample,u64 type) +static int arm_spe__inject_event (struct arm_spe *spe,union perf_event *event, +struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && spe->session && spe->session->evlist) + evsel =evlist__id2evsel (spe->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int
@@ -502,7 +522,7 @@ arm_spe_deliver_synth_event(struct arm_spe *spe,int ret;if (spe->synth_opts.inject) { - ret =arm_spe__inject_event (event, sample, spe->sample_type); + ret =arm_spe__inject_event (spe, event, sample, spe->sample_type);if (ret)return ret; }
tools/perf/util/cs-etm.c +23 -5
@@ -1422,11 +1422,29 @@ static void cs_etm__update_last_branch_rb(struct cs_etm_queue *etmq, bs->nr +=1 ; } -static int cs_etm__inject_event (union perf_event *event, +static int cs_etm__inject_event (struct cs_etm_auxtrace *etm,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && etm->session && etm->session->evlist) + evsel =evlist__id2evsel (etm->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); }
@@ -1592,7 +1610,7 @@ static int cs_etm__synth_instruction_sample(struct cs_etm_queue *etmq, sample.branch_stack = tidq->last_branch;if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->instructions_sample_type);if (ret)return ret;
@@ -1667,7 +1685,7 @@ static int cs_etm__synth_branch_sample(struct cs_etm_queue *etmq, }if (etm->synth_opts.inject) { - ret =cs_etm__inject_event (event, &sample, + ret =cs_etm__inject_event (etm, event, &sample, etm->branches_sample_type);if (ret)return ret;
tools/perf/util/intel-bts.c +2 -1
@@ -303,7 +303,8 @@ static int intel_bts_synth_branch_sample(struct intel_bts_queue *btsq, event.sample.header.size = bts->branches_event_size; ret =perf_event__synthesize_sample (&event, bts->branches_sample_type, -0 , &sample); +/*read_format=*/ 0 ,/*branch_sample_type=*/ 0 , + &sample);if (ret)return ret; }
tools/perf/util/intel-pt.c +23 -4
@@ -1728,11 +1728,30 @@ static void intel_pt_prep_b_sample(struct intel_pt *pt, event->sample.header.misc = sample->cpumode; } -static int intel_pt_inject_event (union perf_event *event, +static int intel_pt_inject_event (struct intel_pt *pt,union perf_event *event,struct perf_sample *sample,u64 type) { - event->header.size =perf_event__sample_event_size (sample, type,0 ); -return perf_event__synthesize_sample (event, type,0 , sample); +struct evsel *evsel = sample->evsel; +u64 branch_sample_type =0 ; +size_t sz; + +if (!evsel && pt->session && pt->session->evlist) + evsel =evlist__id2evsel (pt->session->evlist, sample->id); + +if (evsel) + branch_sample_type = evsel->core.attr.branch_sample_type; + + event->header.type =PERF_RECORD_SAMPLE ; + sz =perf_event__sample_event_size (sample, type,/*read_format=*/ 0 , + branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event->header.size = sz; + +return perf_event__synthesize_sample (event, type,/*read_format=*/ 0 , + branch_sample_type, sample); } static inline int intel_pt_opt_inject(struct intel_pt *pt,
@@ -1742,7 +1761,7 @@ static inline int intel_pt_opt_inject(struct intel_pt *pt,if (!pt->synth_opts.inject)return 0 ; -return intel_pt_inject_event (event, sample, type); +return intel_pt_inject_event (pt, event, sample, type); } static int intel_pt_deliver_synth_event(struct intel_pt *pt,
tools/perf/util/synthetic-events.c +18 -7
@@ -1455,7 +1455,8 @@ int perf_event__synthesize_stat_round(const struct perf_tool *tool,return process (tool, (union perf_event *) &event,NULL , machine); } -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format) +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format, +u64 branch_sample_type) {size_t sz, result =sizeof (struct perf_record_sample );
@@ -1515,8 +1516,10 @@ size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,if (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); +/* nr */ + sz +=sizeof (u64); +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) + sz +=sizeof (u64); result += sz; }
@@ -1605,7 +1608,7 @@ static __u64 *copy_read_group_values(__u64 *array, __u64 read_format, }int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, -const struct perf_sample *sample) +u64 branch_sample_type,const struct perf_sample *sample) {__u64 *array;size_t sz;
@@ -1719,9 +1722,17 @@ int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_foif (type &PERF_SAMPLE_BRANCH_STACK ) { sz = sample->branch_stack->nr *sizeof (struct branch_entry ); -/* nr, hw_idx */ - sz +=2 *sizeof (u64); -memcpy (array, sample->branch_stack, sz); + + *array++ = sample->branch_stack->nr; + +if (branch_sample_type &PERF_SAMPLE_BRANCH_HW_INDEX ) { +if (sample->no_hw_idx) + *array++ =0 ; +else + *array++ = sample->branch_stack->hw_idx; + } + +memcpy (array,perf_sample__branch_entries ((struct perf_sample *)sample), sz); array = (void *)array + sz; }
tools/perf/util/synthetic-events.h +4 -2
@@ -81,7 +81,8 @@ int perf_event__synthesize_mmap_events(const struct perf_tool *tool, union perf_int perf_event__synthesize_modules (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_namespaces (const struct perf_tool *tool,union perf_event *event,pid_t pid,pid_t tgid,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_cgroups (const struct perf_tool *tool,perf_event__handler_t process,struct machine *machine); -int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format,const struct perf_sample *sample); +int perf_event__synthesize_sample (union perf_event *event,u64 type,u64 read_format, +u64 branch_sample_type,const struct perf_sample *sample);int perf_event__synthesize_stat_config (const struct perf_tool *tool,struct perf_stat_config *config,perf_event__handler_t process,struct machine *machine);int perf_event__synthesize_stat_events (struct perf_stat_config *config,const struct perf_tool *tool,struct evlist *evlist,perf_event__handler_t process,bool attrs);int perf_event__synthesize_stat_round (const struct perf_tool *tool,u64 time,u64 type,perf_event__handler_t process,struct machine *machine);
@@ -97,7 +98,8 @@ void perf_event__synthesize_final_bpf_metadata(struct perf_session *session,int perf_tool__process_synth_event (const struct perf_tool *tool,union perf_event *event,struct machine *machine,perf_event__handler_t process); -size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type,u64 read_format); +size_t perf_event__sample_event_size (const struct perf_sample *sample,u64 type, +u64 read_format,u64 branch_sample_type); int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool, struct target *target, struct perf_thread_map *threads,
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Ian Rogers
reviewerPATCH v8 2/2 perf inject: Fix itrace branch stack synthesis
In reply to Ian RogersWhen using "perf inject --itrace=L" to synthesize branch stacks from AUX data, several issues caused failures with the generated file:
1. The synthesized samples were delivered without the PERF_SAMPLE_BRANCH_STACK flag if it was not in the original event's sample_type. Fixed by using sample_type | evsel->synth_sample_type in intel_pt_do_synth_pebs_sample.
2. Modifying evsel->core.attr.sample_type early in __cmd_inject caused parse failures for subsequent records in the input file. Fixed by moving this modification to just before writing the header.
3. perf_event__repipe_sample was narrowed to only synthesize samples when branch stack injection was requested, and restored the use of perf_inject__cut_auxtrace_sample as a fallback to preserve functionality.
4. Potential Heap Overflow in perf_event__repipe_sample: Addressed by adding a check that prints an error and returns -EFAULT if the calculated event size exceeds PERF_SAMPLE_MAX_SIZE.
5. Header vs Payload Mismatch in __cmd_inject: Addressed by narrowing the condition so that HEADER_BRANCH_STACK is only set in the file header if add_last_branch was true.
6. NULL Pointer Dereference in intel-pt.c: When branch stack injection is requested (add_last_branch is true) but last_branch is false (e.g., perf inject --itrace=L), ptq->last_branch was not allocated. However, PEBS branch stack synthesis (via synth_sample_type) still forced LBR handling in do_synth_pebs_sample(), dereferencing the NULL ptq->last_branch pointer. Guarding the dereference is not sufficient because downstream sample size calculation and synthesis strictly require a non-NULL branch_stack when the bit is set. Fixed by ensuring ptq->last_branch is allocated in intel_pt_alloc_queue() when add_last_branch is requested.
7. Modifying event attributes in perf_event__repipe_attr in-place caused SIGSEGV on read-only mmap buffers in file mode and downstream parser breakage in pipe mode. Fixed by processing the unmodified attribute first, returning immediately in non-pipe mode, and correctly synthesizing a new attribute event for pipe output using perf_event__synthesize_attr. Also:
- Added a size validation check and integer underflow protection when parsing n_ids.
- Prevented Trailing ID memory corruption by zero-initializing the local attr copy and safely copying using min_t(size_t, sizeof(attr), event->attr.attr.size).
- Resolved ID array parsing mismatch downstream by expanding attr.size to sizeof(struct perf_event_attr) before synthesis to guarantee perfect header/attribute size alignment.
8. Potential dangling pointer vulnerability in perf_event__repipe_sample:
Addressed by restoring the original sample->branch_stack pointer before returning, including on early error return paths.
9. Off-by-one error in sample size check in perf_event__repipe_sample:
Fixed by checking if sz >= PERF_SAMPLE_MAX_SIZE instead of >.
10. Unadvertised size field left in payload by cut_auxtrace_sample:
Addressed by excluding the 8-byte size field from the copied payload to correctly match the cleared PERF_SAMPLE_AUX bit. Cut the AUX sample payload even if size is 0.
11. Inaccurate sample size calculation and uninitialized memory leaks in
convert_sample_callchain: Fixed by replacing manual arithmetic with perf_event__sample_event_size and adding a bounds check against PERF_SAMPLE_MAX_SIZE.
12. Omission of branch_sample_type in file headers: Addressed by expanding older, smaller attributes to PERF_ATTR_SIZE_VER2 in __cmd_inject to ensure branch_sample_type is not silently omitted.
--- tools/perf/builtin-inject.c | 153 ++++++++++++++++++++++++++++++++---- tools/perf/util/intel-pt.c | 8 +- 2 files changed, 142 insertions(+), 19 deletions(-)
tools/perf/builtin-inject.c +137 -16
@@ -216,12 +216,23 @@ static int perf_event__repipe_op4_synth(const struct perf_tool *tool,return perf_event__repipe_synth (tool, event); } +static int perf_event__repipe_synth_cb (const struct perf_tool *tool, +union perf_event *event, +struct perf_sample *sample__maybe_unused , +struct machine *machine__maybe_unused ) +{ +return perf_event__repipe_synth (tool, event); +} +static int perf_event__repipe_attr (const struct perf_tool *tool,union perf_event *event,struct evlist **pevlist) { struct perf_inject *inject = container_of(tool, struct perf_inject, tool); +struct perf_event_attr attr; +size_t n_ids; +u64 *ids;int ret; ret =perf_event__process_attr (tool, event, pevlist);
@@ -232,7 +243,37 @@ static int perf_event__repipe_attr(const struct perf_tool *tool,if (!inject->output.is_pipe)return 0 ; -return perf_event__repipe_synth (tool, event); +if (!inject->itrace_synth_opts.set) +return perf_event__repipe_synth (tool, event); + +if (event->header.size <sizeof (struct perf_event_header ) +sizeof (u64)) { +pr_err ("Attribute event size %u is too small\n" , event->header.size); +return -EINVAL ; + } + +if (event->header.size -sizeof (event->header) < event->attr.attr.size) { +pr_err ("Attribute event size %u is too small for attr.size %u\n" , + event->header.size, event->attr.attr.size); +return -EINVAL ; + } + +memset (&attr,0 ,sizeof (attr)); +memcpy (&attr, &event->attr.attr, +min_t (size_t,sizeof (attr), (size_t )event->attr.attr.size)); + + n_ids = event->header.size -sizeof (event->header) - event->attr.attr.size; + n_ids /=sizeof (u64); + ids =perf_record_header_attr_id (event); + + attr.size =sizeof (struct perf_event_attr ); + attr.sample_type &= ~PERF_SAMPLE_AUX ; + +if (inject->itrace_synth_opts.add_last_branch) { + attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } +return perf_event__synthesize_attr (tool, &attr, (u32 )n_ids, ids, + perf_event__repipe_synth_cb); } static int perf_event__repipe_event_update(const struct perf_tool *tool,
@@ -331,8 +372,8 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject,union perf_event *event, struct perf_sample *sample) { - size_t sz1 = sample->aux_sample.data - (void *)event; -size_t sz2 = event->header.size - sample->aux_sample.size - sz1; + size_t sz1 = sample->aux_sample.data - (void *)event - sizeof(u64); +size_t sz2 = event->header.size - sample->aux_sample.size - (sz1 +sizeof (u64));union perf_event *ev;if (inject->event_copy ==NULL ) {
@@ -343,13 +384,12 @@ perf_inject__cut_auxtrace_sample(struct perf_inject *inject, ev = (union perf_event *)inject->event_copy;if (sz1 > event->header.size || sz2 > event->header.size || sz1 + sz2 > event->header.size || - sz1 <sizeof (struct perf_event_header ) +sizeof (u64)) + sz1 <sizeof (struct perf_event_header ))return event;memcpy (ev, event, sz1);memcpy ((void *)ev + sz1, (void *)event + event->header.size - sz2, sz2); ev->header.size = sz1 + sz2; - ((u64 *)((void *)ev + sz1))[-1 ] =0 ;return ev; }
@@ -369,14 +409,77 @@ static int perf_event__repipe_sample(const struct perf_tool *tool, struct perf_inject *inject = container_of(tool, struct perf_inject, tool); -if (evsel && evsel->handler) { +if (evsel ==NULL ) +return perf_event__repipe_synth (tool, event); + +if (evsel->handler) {inject_handler f = evsel->handler;return f (tool, event, sample, evsel, machine); }build_id__mark_dso_hit (tool, event, sample, evsel, machine); -if (inject->itrace_synth_opts.set && sample->aux_sample.size) { +if (inject->itrace_synth_opts.set && + (inject->itrace_synth_opts.last_branch || + inject->itrace_synth_opts.add_last_branch)) { +union perf_event *event_copy = (void *)inject->event_copy; +struct branch_stack dummy_bs = { .nr =0 , .hw_idx =0 }; +int err; +size_t sz; +u64 orig_type = evsel->core.attr.sample_type; +u64 orig_branch_type = evsel->core.attr.branch_sample_type; + +struct branch_stack *orig_bs = sample->branch_stack; + +if (event_copy ==NULL ) { + inject->event_copy =malloc (PERF_SAMPLE_MAX_SIZE ); +if (!inject->event_copy) +return -ENOMEM ; + + event_copy = (void *)inject->event_copy; + } + +if (!sample->branch_stack) + sample->branch_stack = &dummy_bs; + +if (inject->itrace_synth_opts.add_last_branch) { +/* Temporarily add in type bits for synthesis. */ + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; + evsel->core.attr.branch_sample_type |=PERF_SAMPLE_BRANCH_HW_INDEX ; + } + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + + sz =perf_event__sample_event_size (sample, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); + +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; +return -EFAULT ; + } + + event_copy->header.type =PERF_RECORD_SAMPLE ; + event_copy->header.misc = event->header.misc; + event_copy->header.size = sz; + + err =perf_event__synthesize_sample (event_copy, evsel->core.attr.sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type, sample); + + evsel->core.attr.sample_type = orig_type; + evsel->core.attr.branch_sample_type = orig_branch_type; + sample->branch_stack = orig_bs; + +if (err) { +pr_err ("Failed to synthesize sample\n" ); +return err; + } + event = event_copy; + }else if (inject->itrace_synth_opts.set && + (evsel->core.attr.sample_type &PERF_SAMPLE_AUX )) { event =perf_inject__cut_auxtrace_sample (inject, event, sample);if (IS_ERR (event))return PTR_ERR (event);
@@ -397,7 +500,7 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool,struct callchain_cursor_node *node;struct thread *thread;u64 sample_type = evsel->core.attr.sample_type; -u32 sample_size = event->header.size; +size_t sz;u64 i, k;int ret;
@@ -456,15 +559,18 @@ static int perf_event__convert_sample_callchain(const struct perf_tool *tool, out:memcpy (event_copy, event,sizeof (event->header)); -/* adjust sample size for stack and regs */ - sample_size -= sample->user_stack.size; - sample_size -= (hweight64 (evsel->core.attr.sample_regs_user) +1 ) *sizeof (u64); - sample_size += (sample->callchain->nr +1 ) *sizeof (u64); - event_copy->header.size = sample_size; -/* remove sample_type {STACK,REGS}_USER for synthesize */ sample_type &= ~(PERF_SAMPLE_STACK_USER |PERF_SAMPLE_REGS_USER ); + sz =perf_event__sample_event_size (sample, sample_type, + evsel->core.attr.read_format, + evsel->core.attr.branch_sample_type); +if (sz >=PERF_SAMPLE_MAX_SIZE ) { +pr_err ("Sample size %zu exceeds max size %d\n" , sz,PERF_SAMPLE_MAX_SIZE ); +return -EFAULT ; + } + event_copy->header.size = sz; + ret =perf_event__synthesize_sample (event_copy, sample_type, evsel->core.attr.read_format, evsel->core.attr.branch_sample_type, sample);
@@ -2442,12 +2548,27 @@ static int __cmd_inject(struct perf_inject *inject)* synthesized hardware events, so clear the feature flag. */ if (inject->itrace_synth_opts.set) { +struct evsel *evsel; +perf_header__clear_feat (&session->header,HEADER_AUXTRACE ); -if (inject->itrace_synth_opts.last_branch || - inject->itrace_synth_opts.add_last_branch) + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type &= ~PERF_SAMPLE_AUX ; + } + +if (inject->itrace_synth_opts.add_last_branch) {perf_header__set_feat (&session->header,HEADER_BRANCH_STACK ); + +evlist__for_each_entry (session->evlist, evsel) { + evsel->core.attr.sample_type |=PERF_SAMPLE_BRANCH_STACK ; +if (evsel->core.attr.size <PERF_ATTR_SIZE_VER2 ) + evsel->core.attr.size =PERF_ATTR_SIZE_VER2 ; + evsel->core.attr.branch_sample_type |= +PERF_SAMPLE_BRANCH_HW_INDEX ; + } + } }/*
tools/perf/util/intel-pt.c +5 -3
@@ -1307,7 +1307,8 @@ static struct intel_pt_queue *intel_pt_alloc_queue(struct intel_pt *pt, goto out_free; } -if (pt->synth_opts.last_branch || pt->synth_opts.other_events) { +if (pt->synth_opts.last_branch || pt->synth_opts.add_last_branch || + pt->synth_opts.other_events) {unsigned int entry_cnt =max (LBRS_MAX , pt->br_stack_sz); ptq->last_branch =intel_pt_alloc_br_stack (entry_cnt);
@@ -2505,7 +2506,7 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evseintel_pt_add_xmm (intr_regs, pos, items, regs_mask); } -if (sample_type &PERF_SAMPLE_BRANCH_STACK ) { +if ((sample_type | evsel->synth_sample_type) &PERF_SAMPLE_BRANCH_STACK ) {if (items->mask[INTEL_PT_LBR_0_POS ] || items->mask[INTEL_PT_LBR_1_POS ] || items->mask[INTEL_PT_LBR_2_POS ]) {
@@ -2576,7 +2577,8 @@ static int intel_pt_do_synth_pebs_sample(struct intel_pt_queue *ptq, struct evse sample.transaction = txn; } - ret =intel_pt_deliver_synth_event (pt, event, &sample, sample_type); + ret =intel_pt_deliver_synth_event (pt, event, &sample, + sample_type | evsel->synth_sample_type);perf_sample__exit (&sample);return ret; }
Signature · 1 line
2.54.0.631.ge1b05301d1-goog
Quoted 9 lines · Ian Rogers
An intel-pt trace can be turned into LBR events either in perf script or perf inject with the --itrace=L option. With perf inject the generated perf.data file failed to be parsed as the sample events were out of sync with their
perf_event_attr. A range of fixes were required.This patch was separated from a large perf script refactor that highlighted the breakage:
https://lore.kernel.org/lkml/[email protected]/
Thanks, applied to perf-tools-next, for v7.2.
- Arnaldo