perf expr: Force encapsulation on expr_id_data
Ian Rogers
reviewerPATCH 1/2 perf expr: Force encapsulation on expr_id_data
This patch resolves some undefined behavior where variables in expr_id_data were accessed (for debugging) without being defined. To better enforce the tagged union behavior, the struct is moved into expr.c and accessors provided. Tag values (kinds) are explicitly identified.
--- tools/perf/util/expr.c | 64 ++++++++++++++++++++++++++++++----- tools/perf/util/expr.h | 17 +++------- tools/perf/util/expr.y | 2 +- tools/perf/util/metricgroup.c | 4 +-- 4 files changed, 62 insertions(+), 25 deletions(-)
tools/perf/util/expr.c +55 -9
@@ -17,6 +17,25 @@extern int expr_debug;#endif +struct expr_id_data { +union { +double val; +struct { +double val; +const char *metric_name; +const char *metric_expr; + } ref; +struct expr_id *parent; + }; + +enum { +EXPR_ID_DATA__VALUE , +EXPR_ID_DATA__REF , +EXPR_ID_DATA__REF_VALUE , +EXPR_ID_DATA__PARENT , + } kind; +}; +static size_t key_hash (const void *key,void *ctx__maybe_unused ) {const char *str = (const char *)key;
@@ -48,6 +67,7 @@ int expr__add_id(struct expr_parse_ctx *ctx, const char *id)return -ENOMEM ; data_ptr->parent = ctx->parent; + data_ptr->kind =EXPR_ID_DATA__PARENT ; ret =hashmap__set (&ctx->ids, id, data_ptr, (const void **)&old_key, (void **)&old_data);
@@ -69,7 +89,7 @@ int expr__add_id_val(struct expr_parse_ctx *ctx, const char *id, double val)if (!data_ptr)return -ENOMEM ; data_ptr->val = val; - data_ptr->is_ref = false; + data_ptr->kind =EXPR_ID_DATA__VALUE ; ret =hashmap__set (&ctx->ids, id, data_ptr, (const void **)&old_key, (void **)&old_data);
@@ -114,8 +134,7 @@ int expr__add_ref(struct expr_parse_ctx *ctx, struct metric_ref *ref)*/ data_ptr->ref.metric_name = ref->metric_name; data_ptr->ref.metric_expr = ref->metric_expr; - data_ptr->ref.counted = false; - data_ptr->is_ref = true; + data_ptr->kind =EXPR_ID_DATA__REF ; ret =hashmap__set (&ctx->ids, name, data_ptr, (const void **)&old_key, (void **)&old_data);
@@ -148,17 +167,30 @@ int expr__resolve_id(struct expr_parse_ctx *ctx, const char *id, data = *datap; -pr_debug2 ("lookup: is_ref %d, counted %d, val %f: %s\n" , - data->is_ref, data->ref.counted, data->val, id); - -if (data->is_ref && !data->ref.counted) { - data->ref.counted = true; +switch (data->kind) { +case EXPR_ID_DATA__VALUE : +pr_debug2 ("lookup(%s): val %f\n" , id, data->val); +break ; +case EXPR_ID_DATA__PARENT : +pr_debug2 ("lookup(%s): parent %s\n" , id, data->parent->id); +break ; +case EXPR_ID_DATA__REF : +pr_debug2 ("lookup(%s): ref metric name %s\n" , id, + data->ref.metric_name);pr_debug ("processing metric: %s ENTRY\n" , id); -if (expr__parse (&data->val, ctx, data->ref.metric_expr,1 )) { + data->kind =EXPR_ID_DATA__REF_VALUE ; +if (expr__parse (&data->ref.val, ctx, data->ref.metric_expr,1 )) {pr_debug ("%s failed to count\n" , id);return -1 ; }pr_debug ("processing metric: %s EXIT: %f\n" , id, data->val); +break ; +case EXPR_ID_DATA__REF_VALUE : +pr_debug2 ("lookup(%s): ref val %f metric name %s\n" , id, + data->ref.val, data->ref.metric_name); +break ; +default : +assert (0 );/* Unreachable. */ }return 0 ;
@@ -241,3 +273,17 @@ int expr__find_other(const char *expr, const char *one,return ret; } + +double expr_id_data__value (const struct expr_id_data *data) +{ +if (data->kind ==EXPR_ID_DATA__VALUE ) +return data->val; +assert (data->kind ==EXPR_ID_DATA__REF_VALUE ); +return data->ref.val; +} + +struct expr_id *expr_id_data__parent (struct expr_id_data *data) +{ +assert (data->kind ==EXPR_ID_DATA__PARENT ); +return data->parent; +}
tools/perf/util/expr.h +4 -13
@@ -23,19 +23,7 @@ struct expr_parse_ctx {struct expr_id *parent; }; -struct expr_id_data { -union { -double val; -struct { -const char *metric_name; -const char *metric_expr; -bool counted; - } ref; -struct expr_id *parent; - }; - -bool is_ref; -}; +struct expr_id_data ;struct expr_scanner_ctx {int start_token;
@@ -57,4 +45,7 @@ int expr__parse(double *final_val, struct expr_parse_ctx *ctx,int expr__find_other (const char *expr,const char *one,struct expr_parse_ctx *ids,int runtime); +double expr_id_data__value (const struct expr_id_data *data); +struct expr_id *expr_id_data__parent (struct expr_id_data *data); +#endif
tools/perf/util/expr.y +1 -1
@@ -93,7 +93,7 @@ expr: NUMBER YYABORT; } - $$ = data->val; + $$ = expr_id_data__value(data); free($1); } | expr '|' expr { $$ = (long)$1 | (long)$3; }
tools/perf/util/metricgroup.c +2 -2
@@ -786,7 +786,7 @@ static int recursion_check(struct metric *m, const char *id, struct expr_id **paif (ret)return ret; - p = data->parent; + p =expr_id_data__parent (data);while (p->parent) {if (!strcmp (p->id, id)) {
@@ -807,7 +807,7 @@ static int recursion_check(struct metric *m, const char *id, struct expr_id **pa } p->id =strdup (id); - p->parent = data->parent; + p->parent =expr_id_data__parent (data); *parent = p;return p->id ?0 : -ENOMEM ;
Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Ian Rogers
reviewerPATCH 2/2 perf parse-events: Avoid an uninitialized read.
With a fake_pmu the pmu_info isn't populated by perf_pmu__check_alias. In this case, don't try to copy the uninitialized values to the evsel.
--- tools/perf/util/parse-events.c | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-)
tools/perf/util/parse-events.c +17 -13
@@ -1533,19 +1533,23 @@ int parse_events_add_pmu(struct parse_events_state *parse_state, evsel =__add_event (list, &parse_state->idx, &attr, true,get_config_name (head_config), pmu, &config_terms, auto_merge_stats,NULL ); -if (evsel) { - evsel->unit = info.unit; - evsel->scale = info.scale; - evsel->per_pkg = info.per_pkg; - evsel->snapshot = info.snapshot; - evsel->metric_expr = info.metric_expr; - evsel->metric_name = info.metric_name; - evsel->pmu_name = name ?strdup (name) :NULL ; - evsel->use_uncore_alias = use_uncore_alias; - evsel->percore =config_term_percore (&evsel->config_terms); - } - -return evsel ?0 : -ENOMEM ; +if (!evsel) +return -ENOMEM ; + + evsel->pmu_name = name ?strdup (name) :NULL ; + evsel->use_uncore_alias = use_uncore_alias; + evsel->percore =config_term_percore (&evsel->config_terms); + +if (parse_state->fake_pmu) +return 0 ; + + evsel->unit = info.unit; + evsel->scale = info.scale; + evsel->per_pkg = info.per_pkg; + evsel->snapshot = info.snapshot; + evsel->metric_expr = info.metric_expr; + evsel->metric_name = info.metric_name; +return 0 ; } int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Re: [PATCH 2/2] perf parse-events: Avoid an uninitialized read.
Quoted 4 lines · Ian Rogers
With a
fake_pmuthepmu_infoisn't populated byperf_pmu__check_alias. In this case, don't try to copy the uninitialized values to the evsel.Signed-off-by Ian Rogers <[email protected]>
thanks,
jirka
Quoted 48 lines
--- tools/perf/util/parse-events.c | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-)tools/perf/util/parse-events.c +17
-13@@ -1533,19 +1533,23 @@ int parse_events_add_pmu(struct parse_events_state *parse_state, evsel =__add_event (list, &parse_state->idx, &attr, true,get_config_name (head_config), pmu, &config_terms, auto_merge_stats,NULL ); -if (evsel) { - evsel->unit = info.unit; - evsel->scale = info.scale; - evsel->per_pkg = info.per_pkg; - evsel->snapshot = info.snapshot; - evsel->metric_expr = info.metric_expr; - evsel->metric_name = info.metric_name; - evsel->pmu_name = name ?strdup (name) :NULL ; - evsel->use_uncore_alias = use_uncore_alias; - evsel->percore =config_term_percore (&evsel->config_terms); - } - -return evsel ?0 : -ENOMEM ; +if (!evsel) +return -ENOMEM ; + + evsel->pmu_name = name ?strdup (name) :NULL ; + evsel->use_uncore_alias = use_uncore_alias; + evsel->percore =config_term_percore (&evsel->config_terms); + +if (parse_state->fake_pmu) +return 0 ; + + evsel->unit = info.unit; + evsel->scale = info.scale; + evsel->per_pkg = info.per_pkg; + evsel->snapshot = info.snapshot; + evsel->metric_expr = info.metric_expr; + evsel->metric_name = info.metric_name; +return 0 ; } int parse_events_multi_pmu_add(struct parse_events_state *parse_state,Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Re: [PATCH 2/2] perf parse-events: Avoid an uninitialized read.
Em Wed, Aug 26, 2020 at 01:34:18PM +0200, Jiri Olsa escreveu:
Quoted 7 lines · Ian Rogers
Quoted 4 lines
With a
fake_pmuthepmu_infoisn't populated byperf_pmu__check_alias. In this case, don't try to copy the uninitialized values to the evsel.Signed-off-by Ian Rogers <[email protected]>Acked-by Jiri Olsa <[email protected]>
Thanks, applied.
- Arnaldo
Quoted 52 lines
thanks,
jirkaQuoted 48 lines
--- tools/perf/util/parse-events.c | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-)tools/perf/util/parse-events.c +17
-13@@ -1533,19 +1533,23 @@ int parse_events_add_pmu(struct parse_events_state *parse_state, evsel =__add_event (list, &parse_state->idx, &attr, true,get_config_name (head_config), pmu, &config_terms, auto_merge_stats,NULL ); -if (evsel) { - evsel->unit = info.unit; - evsel->scale = info.scale; - evsel->per_pkg = info.per_pkg; - evsel->snapshot = info.snapshot; - evsel->metric_expr = info.metric_expr; - evsel->metric_name = info.metric_name; - evsel->pmu_name = name ?strdup (name) :NULL ; - evsel->use_uncore_alias = use_uncore_alias; - evsel->percore =config_term_percore (&evsel->config_terms); - } - -return evsel ?0 : -ENOMEM ; +if (!evsel) +return -ENOMEM ; + + evsel->pmu_name = name ?strdup (name) :NULL ; + evsel->use_uncore_alias = use_uncore_alias; + evsel->percore =config_term_percore (&evsel->config_terms); + +if (parse_state->fake_pmu) +return 0 ; + + evsel->unit = info.unit; + evsel->scale = info.scale; + evsel->per_pkg = info.per_pkg; + evsel->snapshot = info.snapshot; + evsel->metric_expr = info.metric_expr; + evsel->metric_name = info.metric_name; +return 0 ; } int parse_events_multi_pmu_add(struct parse_events_state *parse_state,Signature · 1 line
2.28.0.297.g1956fa8f8d-goog
Signature · 1 line
- Arnaldo
Quoted 29 lines · Ian Rogers
This patch resolves some undefined behavior where variables in
expr_id_datawere accessed (for debugging) without being defined. To better enforce the tagged union behavior, the struct is moved intoexpr.cand accessors provided. Tag values (kinds) are explicitly identified.Signed-off-by Ian Rogers <[email protected]>--- tools/perf/util/expr.c | 64 ++++++++++++++++++++++++++++++----- tools/perf/util/expr.h | 17 +++------- tools/perf/util/expr.y | 2 +- tools/perf/util/metricgroup.c | 4 +-- 4 files changed, 62 insertions(+), 25 deletions(-)tools/perf/util/expr.c +7
-0@@ -17,6 +17,25 @@extern int expr_debug;#endif +struct expr_id_data { + union { + double val; + struct { + double val; + const char *metric_name; + const char *metric_expr;
tools/perf/util/expr.c line 36
Quoted 10 lines
tools/perf/util/expr.c +10
-0+ } ref; +struct expr_id *parent; + }; + +enum { +EXPR_ID_DATA__VALUE , +EXPR_ID_DATA__REF , +EXPR_ID_DATA__REF_VALUE , +EXPR_ID_DATA__PARENT , + } kind;
I like that, it's more clear than current state ;-)
could you still put a small comment for each enum above, as a hint what it's used for?
thanks,
jirka
Ian Rogers
reviewerQuoted 44 lines · Jiri Olsa
Quoted 29 lines · Ian Rogers
This patch resolves some undefined behavior where variables in
expr_id_datawere accessed (for debugging) without being defined. To better enforce the tagged union behavior, the struct is moved intoexpr.cand accessors provided. Tag values (kinds) are explicitly identified.Signed-off-by Ian Rogers <[email protected]>--- tools/perf/util/expr.c | 64 ++++++++++++++++++++++++++++++----- tools/perf/util/expr.h | 17 +++------- tools/perf/util/expr.y | 2 +- tools/perf/util/metricgroup.c | 4 +-- 4 files changed, 62 insertions(+), 25 deletions(-)tools/perf/util/expr.c +7
-0@@ -17,6 +17,25 @@extern int expr_debug;#endif +struct expr_id_data { + union { + double val; + struct { + double val; + const char *metric_name; + const char *metric_expr;tools/perf/util/expr.c line 36
Quoted 10 lines
tools/perf/util/expr.c +10
-0+ } ref; +struct expr_id *parent; + }; + +enum { +EXPR_ID_DATA__VALUE , +EXPR_ID_DATA__REF , +EXPR_ID_DATA__REF_VALUE , +EXPR_ID_DATA__PARENT , + } kind;I like that, it's more clear than current state ;-)
Quoted 2 lines
could you still put a small comment for each enum above, as a hint what it's used for?
Thanks, I had a go at this in v2:
https://lore.kernel.org/lkml/[email protected]/T/#u
Ian
Quoted 3 lines
thanks,
jirka