perf expr: Force encapsulation on expr_id_data
Ian Rogers
reviewerPATCH v2 1/1 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 | 68 ++++++++++++++++++++++++++++++----- tools/perf/util/expr.h | 17 +++------ tools/perf/util/expr.y | 2 +- tools/perf/util/metricgroup.c | 4 +-- 4 files changed, 66 insertions(+), 25 deletions(-)
tools/perf/util/expr.c +59 -9
@@ -17,6 +17,29 @@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 { +/* Holding a double value. */ +EXPR_ID_DATA__VALUE , +/* Reference to another metric. */ +EXPR_ID_DATA__REF , +/* A reference but the value has been computed. */ +EXPR_ID_DATA__REF_VALUE , +/* A parent is remembered for the recursion check. */ +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 +71,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 +93,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 +138,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 +171,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 +277,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
Quoted 7 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]>
great, thanks for doing this
jirka
kajoljain
Reviewed-byQuoted 6 lines · Jiri Olsa
Quoted 5 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.
Thanks,
Kajol Jain
Quoted 9 lines
Quoted 2 lines
Signed-off-by Ian Rogers <[email protected]>great, thanks for doing this
Acked-by Jiri Olsa <[email protected]>jirka
Ian Rogers
reviewerQuoted 11 lines · kajoljain
Quoted 6 lines · Jiri Olsa
Quoted 5 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.
Quoted 13 lines
Reviewed-by Kajol Jain<[email protected]>Thanks,
Kajol JainQuoted 9 lines
Quoted 2 lines
Signed-off-by Ian Rogers <[email protected]>great, thanks for doing this
Acked-by Jiri Olsa <[email protected]>jirka
Thanks for the reviews! Arnaldo could this get merged? Thanks! Ian
Arnaldo Carvalho de Melo
maintainerEm Thu, Sep 03, 2020 at 10:53:16PM -0700, Ian Rogers escreveu:
Quoted 19 lines · kajoljain
Quoted 18 lines · Jiri Olsa
Quoted 6 lines · Ian Rogers
Quoted 5 lines
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.Reviewed-by Kajol Jain<[email protected]>Thanks,
Kajol JainQuoted 3 lines
Quoted 2 lines
Signed-off-by Ian Rogers <[email protected]>
Quoted 8 lines
Quoted 6 lines
Quoted 6 lines
great, thanks for doing this
Acked-by Jiri Olsa <[email protected]>jirka
Thanks for the reviews! Arnaldo could this get merged? Thanks!
I'll get this and the other outstanding patches into perf/core soon as I got urgent stuff already merged by Linus,
Thanks!
- Arnaldo
A message that is not in the archive (sent off-list or not yet received): CAP-5=fW7bF4PJpNQnDnf--RVtmYQ+nKC-OoU_wYjaR4cuAXZfg@mail.gmail.com
Arnaldo Carvalho de Melo
maintainerEm Fri, Nov 13, 2020 at 10:38:28AM -0800, Ian Rogers escreveu:
Quoted 35 lines
Quoted 32 lines · Arnaldo Carvalho de Melo
Em Thu, Sep 03, 2020 at 10:53:16PM -0700, Ian Rogers escreveu:
Quoted 19 lines · kajoljain
Quoted 18 lines · Jiri Olsa
Quoted 6 lines · Ian Rogers
Quoted 5 lines
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.Reviewed-by Kajol Jain<[email protected]>Thanks,
Kajol JainQuoted 3 lines
Quoted 2 lines
Signed-off-by Ian Rogers <[email protected]>Quoted 8 lines
Quoted 6 lines
Quoted 6 lines
great, thanks for doing this
Acked-by Jiri Olsa <[email protected]>jirka
Thanks for the reviews! Arnaldo could this get merged? Thanks!
I'll get this and the other outstanding patches into perf/core soon as I got urgent stuff already merged by Linus,
Quoted 8 lines
Quoted 4 lines
Thanks!
- Arnaldo
I just spotted this wasn't merged and will conflict with:
https://lore.kernel.org/lkml/[email protected]/
I can fix that patch when this lands.
Thanks, applied, will test build and push publicly today.
- Arnaldo