* [PATCH] rust: str: tie Formatter to its backing buffer
@ 2026-11-17 9:47 Peder Bergan via B4 Relay
2026-11-17 11:27 ` Gary Guo
0 siblings, 1 reply; 2+ messages in thread
From: Peder Bergan via B4 Relay @ 2026-11-17 9:47 UTC (permalink / raw)
To: Miguel Ojeda
Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Alice Ryhl, Trevor Gross, Danilo Krummrich,
Daniel Almeida, Tamir Duberstein, Alexandre Courbot,
Onur Özkan, rust-for-linux, linux-kernel, stable,
Georgios Androutsopoulos
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>(())
+ /// ```
+ 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>
^ permalink raw reply related [flat|nested] 2+ messages in thread* Re: [PATCH] rust: str: tie Formatter to its backing buffer
2026-11-17 9:47 [PATCH] rust: str: tie Formatter to its backing buffer Peder Bergan via B4 Relay
@ 2026-11-17 11:27 ` Gary Guo
0 siblings, 0 replies; 2+ messages in thread
From: Gary Guo @ 2026-11-17 11:27 UTC (permalink / raw)
To: peder.bergan, Miguel Ojeda
Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Alice Ryhl, Trevor Gross, Danilo Krummrich,
Daniel Almeida, Tamir Duberstein, Alexandre Courbot,
Onur Özkan, rust-for-linux, linux-kernel, stable,
Georgios Androutsopoulos
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>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-11-17 11:27 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-17 9:47 [PATCH] rust: str: tie Formatter to its backing buffer Peder Bergan via B4 Relay
2026-11-17 11:27 ` Gary Guo
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox