1. Patchew
  2. linux
  3. View series

[PATCH] perf stat-display: Check if snprintf()'s fmt argument is NULL

Kaige Ye posted 1 patch 2 years, 6 months ago
There is a newer version of this series
tools/perf/util/stat-display.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH] perf stat-display: Check if snprintf()'s fmt argument is NULL
Posted by Kaige Ye 2 years, 6 months ago 
It is undefined behavior to pass NULL as snprintf()'s fmt argument.
Here is an example to trigger the problem:

  $ perf stat --metric-only -x, -e instructions -- sleep 1
  insn per cycle,
  Segmentation fault (core dumped)

With this patch:

  $ perf stat --metric-only -x, -e instructions -- sleep 1
  insn per cycle,
  ,

Signed-off-by: Kaige Ye <ye@kaige.org>
---
 tools/perf/util/stat-display.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/tools/perf/util/stat-display.c b/tools/perf/util/stat-display.c
index 7329b3340..e8936cffd 100644
--- a/tools/perf/util/stat-display.c
+++ b/tools/perf/util/stat-display.c
@@ -438,7 +438,7 @@ static void print_metric_csv(struct perf_stat_config *config __maybe_unused,
 		fprintf(out, "%s%s", config->csv_sep, config->csv_sep);
 		return;
 	}
-	snprintf(buf, sizeof(buf), fmt, val);
+	snprintf(buf, sizeof(buf), fmt ?: "", val);
 	ends = vals = skip_spaces(buf);
 	while (isdigit(*ends) || *ends == '.')
 		ends++;
@@ -578,7 +578,7 @@ static void print_metric_only_csv(struct perf_stat_config *config __maybe_unused
 	if (!valid_only_metric(unit))
 		return;
 	unit = fixunit(tbuf, os->evsel, unit);
-	snprintf(buf, sizeof buf, fmt, val);
+	snprintf(buf, sizeof(buf), fmt ?: "", val);
 	ends = vals = skip_spaces(buf);
 	while (isdigit(*ends) || *ends == '.')
 		ends++;
@@ -600,7 +600,7 @@ static void print_metric_only_json(struct perf_stat_config *config __maybe_unuse
 	if (!valid_only_metric(unit))
 		return;
 	unit = fixunit(tbuf, os->evsel, unit);
-	snprintf(buf, sizeof(buf), fmt, val);
+	snprintf(buf, sizeof(buf), fmt ?: "", val);
 	ends = vals = skip_spaces(buf);
 	while (isdigit(*ends) || *ends == '.')
 		ends++;
-- 
2.41.0
Re: [PATCH] perf stat-display: Check if snprintf()'s fmt argument is NULL
Posted by Ian Rogers 2 years, 6 months ago 
On Tue, Aug 1, 2023 at 9:04 PM Kaige Ye <ye@kaige.org> wrote:
>
> It is undefined behavior to pass NULL as snprintf()'s fmt argument.
> Here is an example to trigger the problem:
>
>   $ perf stat --metric-only -x, -e instructions -- sleep 1
>   insn per cycle,
>   Segmentation fault (core dumped)
>
> With this patch:
>
>   $ perf stat --metric-only -x, -e instructions -- sleep 1
>   insn per cycle,
>   ,
>
> Signed-off-by: Kaige Ye <ye@kaige.org>
> ---
>  tools/perf/util/stat-display.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/tools/perf/util/stat-display.c b/tools/perf/util/stat-display.c
> index 7329b3340..e8936cffd 100644
> --- a/tools/perf/util/stat-display.c
> +++ b/tools/perf/util/stat-display.c
> @@ -438,7 +438,7 @@ static void print_metric_csv(struct perf_stat_config *config __maybe_unused,
>                 fprintf(out, "%s%s", config->csv_sep, config->csv_sep);
>                 return;
>         }
> -       snprintf(buf, sizeof(buf), fmt, val);
> +       snprintf(buf, sizeof(buf), fmt ?: "", val);

Hi,

I couldn't reproduce this error and the code immediately above here
does null check fmt:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/stat-display.c?h=perf-tools-next#n437
Perhaps this is an older version of the perf tool? You can run "perf
version" to determine this.

Thanks,
Ian


>         ends = vals = skip_spaces(buf);
>         while (isdigit(*ends) || *ends == '.')
>                 ends++;
> @@ -578,7 +578,7 @@ static void print_metric_only_csv(struct perf_stat_config *config __maybe_unused
>         if (!valid_only_metric(unit))
>                 return;
>         unit = fixunit(tbuf, os->evsel, unit);
> -       snprintf(buf, sizeof buf, fmt, val);
> +       snprintf(buf, sizeof(buf), fmt ?: "", val);
>         ends = vals = skip_spaces(buf);
>         while (isdigit(*ends) || *ends == '.')
>                 ends++;
> @@ -600,7 +600,7 @@ static void print_metric_only_json(struct perf_stat_config *config __maybe_unuse
>         if (!valid_only_metric(unit))
>                 return;
>         unit = fixunit(tbuf, os->evsel, unit);
> -       snprintf(buf, sizeof(buf), fmt, val);
> +       snprintf(buf, sizeof(buf), fmt ?: "", val);
>         ends = vals = skip_spaces(buf);
>         while (isdigit(*ends) || *ends == '.')
>                 ends++;
> --
> 2.41.0
>
Re: [PATCH] perf stat-display: Check if snprintf()'s fmt argument is NULL
Posted by Kaige Ye 2 years, 6 months ago 
On Wed, 2 Aug 2023 10:45:47 -0700 Ian Rogers <irogers@google.com> wrote:
> >
> > It is undefined behavior to pass NULL as snprintf()'s fmt argument.
> > Here is an example to trigger the problem:
> >
> >   $ perf stat --metric-only -x, -e instructions -- sleep 1
> >   insn per cycle,
> >   Segmentation fault (core dumped)
> >
> > With this patch:
> >
> >   $ perf stat --metric-only -x, -e instructions -- sleep 1
> >   insn per cycle,
> >   ,
> >
> > Signed-off-by: Kaige Ye <ye@kaige.org>
> > ---
> >  tools/perf/util/stat-display.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/tools/perf/util/stat-display.c b/tools/perf/util/stat-display.c
> > index 7329b3340..e8936cffd 100644
> > --- a/tools/perf/util/stat-display.c
> > +++ b/tools/perf/util/stat-display.c
> > @@ -438,7 +438,7 @@ static void print_metric_csv(struct perf_stat_config *config __maybe_unused,
> >                 fprintf(out, "%s%s", config->csv_sep, config->csv_sep);
> >                 return;
> >         }
> > -       snprintf(buf, sizeof(buf), fmt, val);
> > +       snprintf(buf, sizeof(buf), fmt ?: "", val);
> 
> Hi,
> 
> I couldn't reproduce this error and the code immediately above here
> does null check fmt:
> https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/stat-display.c?h=perf-tools-next#n437

Hi Ian,

I apologize for my carelessness. You're right, the code above doesn't need any change.
I'll send a new patch to fix it.

> Perhaps this is an older version of the perf tool? You can run "perf
> version" to determine this.

I found this bug with perf version 6.4.4, and I can reproduce the error with perf version 6.5.rc2.g76efcf004289.
The root cause is when I run `perf stat` like this:

  $ perf stat --metric-only -x, -e instructions -- sleep 1

It'll hit this line:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/stat-shadow.c#n318

The error can also be triggered by:
- Replace the `-x,` option with `-j`
- Replace the `-e instructions` option with `-e cycles`

Thanks,
Kaige

> [...]

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.