From: Kent Overstreet <kent.overstreet@linux.dev>
To: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
Cc: Brian Foster <bfoster@redhat.com>,
linux-kernel@vger.kernel.org, kernel-janitors@vger.kernel.org,
linux-bcachefs@vger.kernel.org
Subject: Re: [PATCH v2] bcachefs: Avoid a potential useless over memory allocation in bch2_prt_[v]printf()
Date: Mon, 19 Feb 2024 16:36:09 -0500 [thread overview]
Message-ID: <csjcyhnh5lhj22emlwdzpr6v4s3mfldsw3um75hsk4ffjsmqmb@otyei3qylhdn> (raw)
In-Reply-To: <c745c4d3-a084-440d-bc07-0ecbcfe10e37@wanadoo.fr>
On Mon, Feb 19, 2024 at 07:10:10PM +0100, Christophe JAILLET wrote:
> Le 19/02/2024 à 04:39, Kent Overstreet a écrit :
> > On Sun, Feb 18, 2024 at 05:12:28PM +0100, Christophe JAILLET wrote:
> > > 2 issues related to incorrect available space in the output buffer
> > > computation may lead to some extra memory allocation.
> > >
> > >
> > > First: vsnprintf() takes the size of the buffer, *including* the space for
> > > the trailing null.
> > >
> > > But printbuf_remaining() returns the number of characters we can print
> > > to the output buffer, *excluding* the terminating null.
> > >
> > > So, use printbuf_remaining_size(), which includes the space for the
> > > terminating null.
> >
> > nope, buggy.
> >
> > passing printbuf_remaining_size() to snprintf() is correct, but
> > snprintf() returns the number of charecters wrote _excluding_ the null
>
> Hi,
>
> I think that the patch is correct.
You didn't test it, I did.
In the future, no more patches that you haven't tested - thanks.
> snprintf() returns the number of characters wrote _excluding_ the null. That
> is why the test is: len >= size_of_the_buffer ==> more space is needed.
> The case you describe is handled by the == part of >=.
>
> On the contrary, if len is < size_of_the_buffer, then we have at least 1
> place for the terminating NULL. It will then eventually lead to:
> len_of_the_string + space_for_'\0' == size_of_the_buffer
> So it does not overflow.
>
>
> Anyway, feel free to ignore the patch completely if it sounds too risky,
> take only half of it (s/printbuf_remaining/printbuf_remaining_size/) if you
> are more confident with it, or the complete patch if the explanation above
> convinced you.
>
> From my PoV, the 3 options lead to the same run-time output, with more or
> less memory allocated.
>
> Best regards.
>
> CJ
>
>
> >
> > >
> > >
> > > Second: if the return value of vsnprintf() is greater than or equal to the
> > > passed size, the resulting string is truncated.
> > > So, in order to see if some extra space is needed, the check needs to be
> > > changed.
> > >
> > > Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> > > ---
> > > Un-tested
> > >
> > > v2: - Use printbuf_remaining_size() instead of hand-writing it. [Brian Foster]
> > > - Reword the commit log, hoping it is clearer.
> > > - Synch with -next-20240215
> > >
> > > v1: https://lore.kernel.org/all/0f40108bed3e084057223bdbe32c4b37f8500ff3.1694845203.git.christophe.jaillet@wanadoo.fr/
> > > ---
> > > fs/bcachefs/printbuf.c | 10 ++++++----
> > > 1 file changed, 6 insertions(+), 4 deletions(-)
> > >
> > > diff --git a/fs/bcachefs/printbuf.c b/fs/bcachefs/printbuf.c
> > > index b27d22925929..8cee9c2f88c4 100644
> > > --- a/fs/bcachefs/printbuf.c
> > > +++ b/fs/bcachefs/printbuf.c
> > > @@ -55,9 +55,10 @@ void bch2_prt_vprintf(struct printbuf *out, const char *fmt, va_list args)
> > > va_list args2;
> > > va_copy(args2, args);
> > > - len = vsnprintf(out->buf + out->pos, printbuf_remaining(out), fmt, args2);
> > > + len = vsnprintf(out->buf + out->pos, printbuf_remaining_size(out),
> > > + fmt, args2);
> > > va_end(args2);
> > > - } while (len + 1 >= printbuf_remaining(out) &&
> > > + } while (len >= printbuf_remaining_size(out) &&
> > > !bch2_printbuf_make_room(out, len + 1));
> > > len = min_t(size_t, len,
> > > @@ -72,9 +73,10 @@ void bch2_prt_printf(struct printbuf *out, const char *fmt, ...)
> > > do {
> > > va_start(args, fmt);
> > > - len = vsnprintf(out->buf + out->pos, printbuf_remaining(out), fmt, args);
> > > + len = vsnprintf(out->buf + out->pos, printbuf_remaining_size(out),
> > > + fmt, args);
> > > va_end(args);
> > > - } while (len + 1 >= printbuf_remaining(out) &&
> > > + } while (len >= printbuf_remaining_size(out) &&
> > > !bch2_printbuf_make_room(out, len + 1));
> > > len = min_t(size_t, len,
> > > --
> > > 2.43.2
> > >
> >
> >
>
next prev parent reply other threads:[~2024-02-19 21:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-18 16:12 [PATCH v2] bcachefs: Avoid a potential useless over memory allocation in bch2_prt_[v]printf() Christophe JAILLET
2024-02-18 20:57 ` Kent Overstreet
2024-02-19 3:39 ` Kent Overstreet
2024-02-19 18:10 ` Christophe JAILLET
2024-02-19 21:36 ` Kent Overstreet [this message]
2024-02-19 3:42 ` Kent Overstreet
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=csjcyhnh5lhj22emlwdzpr6v4s3mfldsw3um75hsk4ffjsmqmb@otyei3qylhdn \
--to=kent.overstreet@linux.dev \
--cc=bfoster@redhat.com \
--cc=christophe.jaillet@wanadoo.fr \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-bcachefs@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).