perf mem: Don't leak mem event names
Ian Rogers
reviewerPATCH v2 1/1 perf mem: Don't leak mem event names
When preparing the mem events for the argv copies are intentionally made. These copies are leaked and cause runs of perf using address sanitizer to fail. Rather than leak the memory allocate a chunk of memory for the mem event names upfront and build the strings in this - the storage is sized larger than the previous buffer size. The caller is then responsible for clearing up this memory. As part of this change, remove the mem_loads_name and mem_stores_name global buffers then change the perf_pmu__mem_events_name to write to an out argument buffer.
---
v2. Add return -ENOMEM suggested by Kan Liang.
--- tools/perf/builtin-c2c.c | 4 ++- tools/perf/builtin-mem.c | 12 ++++--- tools/perf/util/mem-events.c | 67 +++++++++++++++++++++--------------- tools/perf/util/mem-events.h | 3 +- 4 files changed, 53 insertions(+), 33 deletions(-)
tools/perf/builtin-c2c.c +3 -1
@@ -3239,6 +3239,7 @@ static int perf_c2c__record(int argc, const char **argv) {int rec_argc, i =0 , j;const char **rec_argv; +char *event_name_storage =NULL ;int ret;bool all_user = false, all_kernel = false;bool event_set = false;
@@ -3300,7 +3301,7 @@ static int perf_c2c__record(int argc, const char **argv) rec_argv[i++] ="--phys-data" ; rec_argv[i++] ="--sample-cpu" ; - ret =perf_mem_events__record_args (rec_argv, &i); + ret =perf_mem_events__record_args (rec_argv, &i, &event_name_storage);if (ret) goto out;
@@ -3327,6 +3328,7 @@ static int perf_c2c__record(int argc, const char **argv) ret =cmd_record (i, rec_argv); out: +free (event_name_storage);free (rec_argv);return ret; }
tools/perf/builtin-mem.c +8 -4
@@ -74,6 +74,7 @@ static int __cmd_record(int argc, const char **argv, struct perf_mem *mem,int rec_argc, i =0 , j;int start, end;const char **rec_argv; +char *event_name_storage =NULL ;int ret;struct perf_mem_event *e;struct perf_pmu *pmu;
@@ -140,7 +141,7 @@ static int __cmd_record(int argc, const char **argv, struct perf_mem *mem, rec_argv[i++] ="--data-page-size" ; start = i; - ret =perf_mem_events__record_args (rec_argv, &i); + ret =perf_mem_events__record_args (rec_argv, &i, &event_name_storage);if (ret) goto out; end = i;
@@ -170,6 +171,7 @@ static int __cmd_record(int argc, const char **argv, struct perf_mem *mem, ret =cmd_record (i, rec_argv); out: +free (event_name_storage);free (rec_argv);return ret; }
@@ -521,6 +523,7 @@ int cmd_mem(int argc, const char **argv)NULL , NULL }; +int ret; argc =parse_options_subcommand (argc, argv, mem_options, mem_subcommands, mem_usage,PARSE_OPT_STOP_AT_NON_OPTION );
@@ -536,14 +539,15 @@ int cmd_mem(int argc, const char **argv) }if (strlen (argv[0 ]) >2 &&strstarts ("record" , argv[0 ])) -return __cmd_record (argc, argv, &mem, record_options); + ret =__cmd_record (argc, argv, &mem, record_options);else if (strlen (argv[0 ]) >2 &&strstarts ("report" , argv[0 ])) -return __cmd_report (argc, argv, &mem, report_options); + ret =__cmd_report (argc, argv, &mem, report_options);else usage_with_options (mem_usage, mem_options);/* free usage string allocated by parse_options_subcommand */ free ((void *)mem_usage[0 ]); +free (sort_order_help); -return 0 ; +return ret; }
tools/perf/util/mem-events.c +40 -27
148 lines not on this page · raw message
tools/perf/util/mem-events.h +2 -1
@@ -38,7 +38,8 @@ int perf_pmu__mem_events_num_mem_pmus(struct perf_pmu *pmu);bool is_mem_loads_aux_event (struct evsel *leader);void perf_pmu__mem_events_list (struct perf_pmu *pmu); -int perf_mem_events__record_args (const char **rec_argv,int *argv_nr); +int perf_mem_events__record_args (const char **rec_argv,int *argv_nr, +char **event_name_storage_out);int perf_mem__tlb_scnprintf (char *out,size_t sz,const struct mem_info *mem_info);int perf_mem__lvl_scnprintf (char *out,size_t sz,const struct mem_info *mem_info);
Signature · 1 line
2.49.0.rc0.332.g42c0ae87b1-goog
Quoted 10 lines · Ian Rogers
When preparing the mem events for the argv copies are intentionally made. These copies are leaked and cause runs of perf using address sanitizer to fail. Rather than leak the memory allocate a chunk of memory for the mem event names upfront and build the strings in this - the storage is sized larger than the previous buffer size. The caller is then responsible for clearing up this memory. As part of this change, remove the
mem_loads_nameandmem_stores_nameglobal buffers then change theperf_pmu__mem_events_nameto write to an out argument buffer.
Quoted 2 lines
Tested-by Thomas Falcon <[email protected]>Signed-off-by Ian Rogers <[email protected]>
Quoted 268 lines
---
v2. Add return-ENOMEMsuggested by Kan Liang.--- tools/perf/builtin-c2c.c | 4 ++- tools/perf/builtin-mem.c | 12 ++++--- tools/perf/util/mem-events.c | 67 +++++++++++++++++++++--------------- tools/perf/util/mem-events.h | 3 +- 4 files changed, 53 insertions(+), 33 deletions(-)tools/perf/builtin-c2c.c +3
-1@@ -3239,6 +3239,7 @@ static int perf_c2c__record(int argc, const char **argv) {int rec_argc, i =0 , j;const char **rec_argv; +char *event_name_storage =NULL ;int ret;bool all_user = false, all_kernel = false;bool event_set = false;@@ -3300,7 +3301,7 @@ static int perf_c2c__record(int argc, const char **argv) rec_argv[i++] ="--phys-data" ; rec_argv[i++] ="--sample-cpu" ; - ret =perf_mem_events__record_args (rec_argv, &i); + ret =perf_mem_events__record_args (rec_argv, &i, &event_name_storage);if (ret) goto out;@@ -3327,6 +3328,7 @@ static int perf_c2c__record(int argc, const char **argv) ret =cmd_record (i, rec_argv); out: +free (event_name_storage);free (rec_argv);return ret; }tools/perf/builtin-mem.c +8
-4@@ -74,6 +74,7 @@ static int __cmd_record(int argc, const char **argv, struct perf_mem *mem,int rec_argc, i =0 , j;int start, end;const char **rec_argv; +char *event_name_storage =NULL ;int ret;struct perf_mem_event *e;struct perf_pmu *pmu;@@ -140,7 +141,7 @@ static int __cmd_record(int argc, const char **argv, struct perf_mem *mem, rec_argv[i++] ="--data-page-size" ; start = i; - ret =perf_mem_events__record_args (rec_argv, &i); + ret =perf_mem_events__record_args (rec_argv, &i, &event_name_storage);if (ret) goto out; end = i;@@ -170,6 +171,7 @@ static int __cmd_record(int argc, const char **argv, struct perf_mem *mem, ret =cmd_record (i, rec_argv); out: +free (event_name_storage);free (rec_argv);return ret; }@@ -521,6 +523,7 @@ int cmd_mem(int argc, const char **argv)NULL , NULL }; +int ret; argc =parse_options_subcommand (argc, argv, mem_options, mem_subcommands, mem_usage,PARSE_OPT_STOP_AT_NON_OPTION );@@ -536,14 +539,15 @@ int cmd_mem(int argc, const char **argv) }if (strlen (argv[0 ]) >2 &&strstarts ("record" , argv[0 ])) -return __cmd_record (argc, argv, &mem, record_options); + ret =__cmd_record (argc, argv, &mem, record_options);else if (strlen (argv[0 ]) >2 &&strstarts ("report" , argv[0 ])) -return __cmd_report (argc, argv, &mem, report_options); + ret =__cmd_report (argc, argv, &mem, report_options);else usage_with_options (mem_usage, mem_options);/* free usage string allocated by parse_options_subcommand */ free ((void *)mem_usage[0 ]); +free (sort_order_help); -return 0 ; +return ret; }tools/perf/util/mem-events.c +40
-27@@ -31,9 +31,6 @@ struct perf_mem_event perf_mem_events[PERF_MEM_EVENTS__MAX] = {bool perf_mem_record[PERF_MEM_EVENTS__MAX ] = {0 }; -static char mem_loads_name[100 ]; -static char mem_stores_name[100 ]; -struct perf_mem_event *perf_pmu__mem_events_ptr (struct perf_pmu *pmu,int i) {if (i >=PERF_MEM_EVENTS__MAX || !pmu)@@ -81,7 +78,8 @@ int perf_pmu__mem_events_num_mem_pmus(struct perf_pmu *pmu)return num; } -static const char *perf_pmu__mem_events_name (int i,struct perf_pmu *pmu) +static const char *perf_pmu__mem_events_name (struct perf_pmu *pmu,int i, +char *buf,size_t buf_size) {struct perf_mem_event *e;@@ -96,31 +94,31 @@ static const char *perf_pmu__mem_events_name(int i, struct perf_pmu *pmu)if (e->ldlat) {if (!e->aux_event) {/* ARM and Most of Intel */ -scnprintf (mem_loads_name,sizeof (mem_loads_name), +scnprintf (buf, buf_size, e->name, pmu->name, perf_mem_events__loads_ldlat); }else {/* Intel with mem-loads-aux event */ -scnprintf (mem_loads_name,sizeof (mem_loads_name), +scnprintf (buf, buf_size, e->name, pmu->name, pmu->name, perf_mem_events__loads_ldlat); } }else {if (!e->aux_event) {/* AMD and POWER */ -scnprintf (mem_loads_name,sizeof (mem_loads_name), +scnprintf (buf, buf_size, e->name, pmu->name); - }else + }else {return NULL ; + } } - -return mem_loads_name; +return buf; }if (i ==PERF_MEM_EVENTS__STORE ) { -scnprintf (mem_stores_name,sizeof (mem_stores_name), +scnprintf (buf, buf_size, e->name, pmu->name); -return mem_stores_name; +return buf; }return NULL ;@@ -238,55 +236,69 @@ void perf_pmu__mem_events_list(struct perf_pmu *pmu)int j;for (j =0 ; j <PERF_MEM_EVENTS__MAX ; j++) { +char buf[128 ];struct perf_mem_event *e =perf_pmu__mem_events_ptr (pmu, j);fprintf (stderr,"%-*s%-*s%s" , e->tag ?13 :0 , e->tag ? :"" , e->tag && verbose >0 ?25 :0 , - e->tag && verbose >0 ?perf_pmu__mem_events_name (j, pmu) :"" , + e->tag && verbose >0 + ?perf_pmu__mem_events_name (pmu, j, buf,sizeof (buf)) + :"" , e->supported ?": available\n" :"" ); } } -int perf_mem_events__record_args (const char **rec_argv,int *argv_nr) +int perf_mem_events__record_args (const char **rec_argv,int *argv_nr,char **event_name_storage_out) {const char *mnt =sysfs__mount ();struct perf_pmu *pmu =NULL ; -struct perf_mem_event *e;int i = *argv_nr; -const char *s; -char *copy;struct perf_cpu_map *cpu_map =NULL ; -int ret; +size_t event_name_storage_size = +perf_pmu__mem_events_num_mem_pmus (NULL ) *PERF_MEM_EVENTS__MAX *128 ; +size_t event_name_storage_remaining = event_name_storage_size; +char *event_name_storage =malloc (event_name_storage_size); +char *event_name_storage_ptr = event_name_storage; + +if (!event_name_storage) +return -ENOMEM ; + *event_name_storage_out =NULL ;while ((pmu =perf_pmus__scan_mem (pmu)) !=NULL ) {for (int j =0 ; j <PERF_MEM_EVENTS__MAX ; j++) { - e =perf_pmu__mem_events_ptr (pmu, j); +const char *s; +struct perf_mem_event *e =perf_pmu__mem_events_ptr (pmu, j); +int ret;if (!perf_mem_record[j])continue ;if (!e->supported) { +char buf[128 ]; +pr_err ("failed: event '%s' not supported\n" , -perf_pmu__mem_events_name (j, pmu)); +perf_pmu__mem_events_name (pmu, j, buf,sizeof (buf))); +free (event_name_storage);return -1 ; } - s =perf_pmu__mem_events_name (j, pmu); + s =perf_pmu__mem_events_name (pmu, j, event_name_storage_ptr, + event_name_storage_remaining);if (!s || !perf_pmu__mem_events_supported (mnt, pmu, e))continue ; - copy =strdup (s); -if (!copy) -return -1 ; - rec_argv[i++] ="-e" ; - rec_argv[i++] = copy; + rec_argv[i++] = event_name_storage_ptr; + event_name_storage_remaining -=strlen (event_name_storage_ptr) +1 ; + event_name_storage_ptr +=strlen (event_name_storage_ptr) +1 ; ret =perf_cpu_map__merge (&cpu_map, pmu->cpus); -if (ret <0 ) +if (ret <0 ) { +free (event_name_storage);return ret; + } } }@@ -301,6 +313,7 @@ int perf_mem_events__record_args(const char **rec_argv, int *argv_nr) } *argv_nr = i; + *event_name_storage_out = event_name_storage;return 0 ; }tools/perf/util/mem-events.h +2
-1@@ -38,7 +38,8 @@ int perf_pmu__mem_events_num_mem_pmus(struct perf_pmu *pmu);bool is_mem_loads_aux_event (struct evsel *leader);void perf_pmu__mem_events_list (struct perf_pmu *pmu); -int perf_mem_events__record_args (const char **rec_argv,int *argv_nr); +int perf_mem_events__record_args (const char **rec_argv,int *argv_nr, +char **event_name_storage_out);int perf_mem__tlb_scnprintf (char *out,size_t sz,const struct mem_info *mem_info);int perf_mem__lvl_scnprintf (char *out,size_t sz,const struct mem_info *mem_info);Signature · 1 line
2.49.0.rc0.332.g42c0ae87b1-goog
Quoted 11 lines · Ian Rogers
When preparing the mem events for the argv copies are intentionally made. These copies are leaked and cause runs of perf using address sanitizer to fail. Rather than leak the memory allocate a chunk of memory for the mem event names upfront and build the strings in this - the storage is sized larger than the previous buffer size. The caller is then responsible for clearing up this memory. As part of this change, remove the
mem_loads_nameandmem_stores_nameglobal buffers then change theperf_pmu__mem_events_nameto write to an out argument buffer.[...]
Applied to perf-tools-next, thanks!
Best regards,
Namhyung