Re: [PATCH] rust: str: tie Formatter to its backing buffer

From: Gary Guo

Date: Tue Nov 17 2026 - 06:27:35 EST


On Tue Nov 17, 2026 at 9:47 AM GMT, Peder Bergan via B4 Relay wrote:
> From: Peder Bergan <peder.bergan@xxxxxxxxx>
>
> 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@xxxxxxxxxxxxxxx
> Reported-by: Georgios Androutsopoulos <georgeandrout13@xxxxxxxxx>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1261
> Signed-off-by: Peder Bergan <peder.bergan@xxxxxxxxx>
> ---
> 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@xxxxxxxxx>