Linux Perf Users
 help / color / mirror / Atom feed
From: Arnaldo Carvalho de Melo <acme@kernel.org>
To: sashiko-reviews@lists.linux.dev
Cc: linux-perf-users@vger.kernel.org
Subject: Re: [PATCH 10/11] perf tools: Use scnprintf() in build_id__snprintf() and hwmon read_events()
Date: Wed, 10 Jun 2026 13:29:46 -0300	[thread overview]
Message-ID: <aimQ-pXYUnPBmeqy@x1> (raw)
In-Reply-To: <20260609011717.79A371F00893@smtp.kernel.org>

On Tue, Jun 09, 2026 at 01:17:17AM +0000, sashiko-bot@kernel.org wrote:
> Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
> - [Medium] build_id__snprintf() fails to null-terminate the output buffer when bf_size is 1.
> - [Low] hwmon_pmu__describe_items() spins doing useless sysfs operations once the output buffer fills.
> --
> 
> commit 0f670823c7b8e81b469db29dc89cf4b4de7e4cad
> Author: Arnaldo Carvalho de Melo <acme@redhat.com>
> 
> perf tools: Use scnprintf() in build_id__snprintf() and hwmon read_events()
> 
> This commit switches build_id__snprintf() and hwmon_pmu__describe_items()
> to use scnprintf() instead of snprintf() to prevent out-of-bounds length
> tracking. It also modifies the loop guard in build_id__snprintf() to
> prevent useless zero-byte writes once the buffer is full.
> 
> > diff --git a/tools/perf/util/build-id.c b/tools/perf/util/build-id.c
> > index 8c0a9ae932aa5..82af3dca7e2fb 100644
> > --- a/tools/perf/util/build-id.c
> > +++ b/tools/perf/util/build-id.c
> > @@ -93,8 +93,8 @@ int build_id__snprintf(const struct build_id *build_id, char *bf, size_t bf_size
> >  		return 0;
> >  	}
> >  
> > -	for (size_t i = 0; i < build_id->size && offs < bf_size; ++i)
> > -		offs += snprintf(bf + offs, bf_size - offs, "%02x", build_id->data[i]);
> > +	for (size_t i = 0; i < build_id->size && offs + 1 < bf_size; ++i)
> > +		offs += scnprintf(bf + offs, bf_size - offs, "%02x", build_id->data[i]);
> 
> [Severity: Medium]
> If bf_size is 1, does this new loop condition skip execution entirely?
> 
> If build_id->size > 0 and bf_size == 1, the offs + 1 < bf_size condition
> is false on the first iteration. Because scnprintf is never called, would
> bf[0] be left un-null-terminated?

Addressing this one in v5.
> 
> > +++ b/tools/perf/util/hwmon_pmu.c
> [ ... ]
> > @@ -442,12 +442,12 @@ static size_t hwmon_pmu__describe_items(struct hwmon_pmu *hwm, char *out_buf, si
> >  
> >  				buf[read_len] = '\0';
> >  				val = strtoll(buf, /*endptr=*/NULL, 10);
> > -				len += snprintf(out_buf + len, out_buf_len - len, "%s%s%s=%g%s",
> > -						len == 0 ? " " : ", ",
> > -						hwmon_item_strs[bit],
> > -						is_alarm ? "_alarm" : "",
> > -						(double)val / 1000.0,
> > -						hwmon_units[key.type]);
> > +				len += scnprintf(out_buf + len, out_buf_len - len, "%s%s%s=%g%s",
> > +						 len == 0 ? " " : ", ",
> > +						 hwmon_item_strs[bit],
> > +						 is_alarm ? "_alarm" : "",
> > +						 (double)val / 1000.0,
> > +						 hwmon_units[key.type]);
> >  			}
> >  			close(fd);
> >  		}
> 
> [Severity: Low]
> Does this loop also need an early break condition once the buffer fills?
 
> The commit message notes that build_id__snprintf() was updated to avoid
> spinning doing zero-byte writes once the buffer fills. 
 
> In hwmon_pmu__describe_items(), once len reaches out_buf_len - 1, scnprintf
> will return 0. Does this mean the loop continues for all remaining hardware
> monitor items, performing unnecessary sysfs file open, read, and close
> operations only to do a 0-byte scnprintf write?

I've added this to a cleanups TODO file for future work, nice
observation, the same pattern may happen in other places, worth a
series.

- Arnaldo

  reply	other threads:[~2026-06-10 16:29 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-09  1:05 [PATCHES v4 00/11] perf tools: Assorted fixes Arnaldo Carvalho de Melo
2026-06-09  1:05 ` [PATCH 01/11] perf tools: Fix get_max_num() size_t underflow on empty sysfs file Arnaldo Carvalho de Melo
2026-06-09  1:24   ` sashiko-bot
2026-06-09  1:05 ` [PATCH 02/11] perf tools: Use scnprintf() in cpu_map__snprint() to prevent overflow Arnaldo Carvalho de Melo
2026-06-09  1:05 ` [PATCH 03/11] perf tools: Use perf_env__get_cpu_topology() in machine__resolve() Arnaldo Carvalho de Melo
2026-06-09  1:22   ` sashiko-bot
2026-06-09  1:05 ` [PATCH 04/11] perf tools: NULL bitmap pointers after bitmap_free() Arnaldo Carvalho de Melo
2026-06-09  1:23   ` sashiko-bot
2026-06-09  1:05 ` [PATCH 05/11] perf sched: Bounds-check prio before test_bit() in timehist Arnaldo Carvalho de Melo
2026-06-09  1:05 ` [PATCH 06/11] perf sched: Fix idle-hist callchain display using wrong rb_first variant Arnaldo Carvalho de Melo
2026-06-09  1:18   ` sashiko-bot
2026-06-09  1:05 ` [PATCH 07/11] perf tools: Add O_CLOEXEC to open() calls in DSO and ELF code Arnaldo Carvalho de Melo
2026-06-09  1:16   ` sashiko-bot
2026-06-10 16:49     ` Arnaldo Carvalho de Melo
2026-06-09  1:05 ` [PATCH 08/11] perf bpf: Use scnprintf() in snprintf_hex() and synthesize_bpf_prog_name() Arnaldo Carvalho de Melo
2026-06-09  1:18   ` sashiko-bot
2026-06-09  1:05 ` [PATCH 09/11] perf hists: Fix snprintf() in hists__scnprintf_title() UID filter path Arnaldo Carvalho de Melo
2026-06-09  1:23   ` sashiko-bot
2026-06-09  1:05 ` [PATCH 10/11] perf tools: Use scnprintf() in build_id__snprintf() and hwmon read_events() Arnaldo Carvalho de Melo
2026-06-09  1:17   ` sashiko-bot
2026-06-10 16:29     ` Arnaldo Carvalho de Melo [this message]
2026-06-09  1:05 ` [PATCH 11/11] libperf: Document code simplification case for widening struct perf_cpu Arnaldo Carvalho de Melo
  -- strict thread matches above, loose matches on Subject: below --
2026-06-10 16:51 [PATCHES v5 00/11] perf tools: Assorted fixes Arnaldo Carvalho de Melo
2026-06-10 16:52 ` [PATCH 10/11] perf tools: Use scnprintf() in build_id__snprintf() and hwmon read_events() Arnaldo Carvalho de Melo
2026-06-10 17:09   ` Ian Rogers
2026-06-10 17:17   ` sashiko-bot
2026-06-10 18:12     ` Arnaldo Carvalho de Melo
2026-06-08 20:17 [PATCHES v3 00/11] perf tools: Assorted fixes Arnaldo Carvalho de Melo
2026-06-08 20:17 ` [PATCH 10/11] perf tools: Use scnprintf() in build_id__snprintf() and hwmon read_events() Arnaldo Carvalho de Melo
2026-06-08 20:50   ` sashiko-bot
2026-06-08 22:03     ` Ian Rogers

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aimQ-pXYUnPBmeqy@x1 \
    --to=acme@kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=sashiko-reviews@lists.linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox