From: "Gary Guo" <gary@garyguo.net>
To: <peder.bergan@gmail.com>, "Miguel Ojeda" <ojeda@kernel.org>
Cc: "Boqun Feng" <boqun@kernel.org>, "Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
"Daniel Almeida" <daniel.almeida@collabora.com>,
"Tamir Duberstein" <tamird@kernel.org>,
"Alexandre Courbot" <acourbot@nvidia.com>,
"Onur Özkan" <work@onurozkan.dev>,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
stable@vger.kernel.org,
"Georgios Androutsopoulos" <georgeandrout13@gmail.com>
Subject: Re: [PATCH] rust: str: tie Formatter to its backing buffer
Date: Tue, 17 Nov 2026 11:27:24 +0000 [thread overview]
Message-ID: <DMXG7K9AMK2E.1QL8P4O7L8RFX@garyguo.net> (raw)
In-Reply-To: <20261117-formatter-lifetime-v1-1-9d7f38686552@gmail.com>
On Tue Nov 17, 2026 at 9:47 AM GMT, Peder Bergan via B4 Relay wrote:
> From: Peder Bergan <peder.bergan@gmail.com>
>
> Formatter::new() returns a Formatter whose lifetime is independent of the
> borrow of its backing buffer. Safe code can therefore drop the buffer and
> then write through the formatter, causing a use-after-free.
>
> Tie the buffer borrow to the formatter's lifetime so that the borrow
> checker rejects such callers and prevents overlapping mutable access.
> Add a doctest showing formatting into a borrowed buffer.
>
> Fixes: 87482d6d9104 ("rust: str: allow `str::Formatter` to format into `&mut [u8]`.")
> Cc: stable@vger.kernel.org
> Reported-by: Georgios Androutsopoulos <georgeandrout13@gmail.com>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1261
> Signed-off-by: Peder Bergan <peder.bergan@gmail.com>
> ---
> I compiled the in-tree callers with Clippy and ran the string tests and
> kernel doctests under x86_64 QEMU. Three borrowing probes compiled before
> the fix and failed with the expected borrow-checker errors after it.
> Rust documentation and formatting checks passed.
>
> OpenAI Codex assisted with coding and testing.
> ---
> rust/kernel/str.rs | 20 ++++++++++++++++++--
> 1 file changed, 18 insertions(+), 2 deletions(-)
>
> diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs
> index 644b4279a..6222faacf 100644
> --- a/rust/kernel/str.rs
> +++ b/rust/kernel/str.rs
> @@ -645,7 +645,7 @@ impl fmt::Write for RawFormatter {
> /// Fails if callers attempt to write more than will fit in the buffer.
> pub struct Formatter<'a>(RawFormatter, PhantomData<&'a mut ()>);
>
> -impl Formatter<'_> {
> +impl<'a> Formatter<'a> {
> /// Creates a new instance of [`Formatter`] with the given buffer.
> ///
> /// # Safety
> @@ -658,7 +658,23 @@ impl Formatter<'_> {
> }
>
> /// Create a new [`Self`] instance.
> - pub fn new(buffer: &mut [u8]) -> Self {
> + ///
> + /// The formatter exclusively borrows `buffer` for its lifetime.
> + ///
> + /// # Examples
> + ///
> + /// ```
> + /// use kernel::fmt::Write as _;
> + /// use kernel::str::Formatter;
> + ///
> + /// let mut buffer = [0; 4];
> + /// let mut formatter = Formatter::new(&mut buffer);
> + /// formatter.write_str("test")?;
> + /// assert_eq!(formatter.bytes_written(), 4);
> + /// assert_eq!(&buffer, b"test");
> + /// # Ok::<(), kernel::error::Error>(())
> + /// ```
Please split the doc change to a separate commit and leave fix as a fix only.
Best,
Gary
> + pub fn new(buffer: &'a mut [u8]) -> Self {
> // SAFETY: `buffer` is valid for writes for the entire length for
> // the lifetime of `Self`.
> unsafe { Formatter::from_buffer(buffer.as_mut_ptr(), buffer.len()) }
>
> ---
> base-commit: aebb7274476403040d582c61478df8f4a7bf9cd3
> change-id: 20261117-formatter-lifetime-48391ed7affd
>
> Best regards,
> --
> Peder Bergan <peder.bergan@gmail.com>
prev parent reply other threads:[~2026-11-17 11:27 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-17 9:47 [PATCH] rust: str: tie Formatter to its backing buffer Peder Bergan via B4 Relay
2026-11-17 9:47 ` Peder Bergan
2026-11-17 11:27 ` Gary Guo [this message]
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=DMXG7K9AMK2E.1QL8P4O7L8RFX@garyguo.net \
--to=gary@garyguo.net \
--cc=a.hindborg@kernel.org \
--cc=acourbot@nvidia.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun@kernel.org \
--cc=dakr@kernel.org \
--cc=daniel.almeida@collabora.com \
--cc=georgeandrout13@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=ojeda@kernel.org \
--cc=peder.bergan@gmail.com \
--cc=rust-for-linux@vger.kernel.org \
--cc=stable@vger.kernel.org \
--cc=tamird@kernel.org \
--cc=tmgross@umich.edu \
--cc=work@onurozkan.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.