From: Matthew Maurer <mmaurer@google.com>
To: "Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
"Sami Tolvanen" <samitolvanen@google.com>
Cc: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org,
Matthew Maurer <mmaurer@google.com>
Subject: [PATCH 6/8] rust: debugfs: Implement display_file in terms of fmt_file
Date: Tue, 29 Apr 2025 23:16:00 +0000 [thread overview]
Message-ID: <20250429-debugfs-rust-v1-6-6b6e7cb7929f@google.com> (raw)
In-Reply-To: <20250429-debugfs-rust-v1-0-6b6e7cb7929f@google.com>
fmt_file is fundamentally more flexible, this reduces the number of
unsafe blocks, and allows us to append a newline for display_file which
is a good default.
Previous display_file did not append a newline to ensure that all output
strings, including those without trailing newlines, were an option.
Signed-off-by: Matthew Maurer <mmaurer@google.com>
---
rust/kernel/debugfs.rs | 18 ++++--------------
1 file changed, 4 insertions(+), 14 deletions(-)
diff --git a/rust/kernel/debugfs.rs b/rust/kernel/debugfs.rs
index 2faa59d2dae44ab708cb8fca0d23f06f73a95a3a..835df2b5d7311f278d1d15fc8d688809d0ca363f 100644
--- a/rust/kernel/debugfs.rs
+++ b/rust/kernel/debugfs.rs
@@ -108,7 +108,7 @@ fn as_ptr(&self) -> *mut bindings::dentry {
}
/// Create a file in a DebugFS directory with the provided name, and contents from invoking
- /// [`Display::fmt`] on the provided reference.
+ /// [`Display::fmt`] on the provided reference with a trailing newline.
///
/// # Example
///
@@ -124,8 +124,7 @@ pub fn display_file<T: Display + Sized>(
name: &CStr,
data: &'static T,
) -> Result<ARef<Self>> {
- // SAFETY: As `data` lives for the static lifetime, it outlives the file.
- unsafe { self.display_file_raw(name, data) }
+ self.fmt_file(name, data, &|val, f| write!(f, "{val}\n"))
}
/// Create a file in a DebugFS directory with the provided name, and contents from invoking `f`
@@ -367,7 +366,7 @@ unsafe fn new(inner: &'a Dir) -> Self {
}
/// Create a file in a DebugFS directory with the provided name, and contents from invoking
- /// [`Display::fmt`] on the provided reference.
+ /// [`Display::fmt`] on the provided reference with a trailing newline.
///
/// # Example
///
@@ -384,16 +383,7 @@ unsafe fn new(inner: &'a Dir) -> Self {
/// # Ok::<(), Error>(())
/// ```
pub fn display_file<T: Display + Sized>(&self, name: &CStr, data: &'a T) -> Result<()> {
- // We forget the reference because its reference count is implicitly "owned" by the root
- // builder, which we know will use `debugfs_remove` to clean this up. If we release the
- // file here, it will be immediately deleted.
- // SAFETY:
- // Because `Builder`'s invariant says that our lifetime is how long the directory will
- // be available, and is equivariant, `'a` will outlive the base directory, which will be
- // torn down by `debugfs_remove` to prevent access even if an extra refcount is held
- // somewhere.
- core::mem::forget(unsafe { self.inner.display_file_raw(name, data)? });
- Ok(())
+ self.fmt_file(name, data, &|val, f| write!(f, "{val}\n"))
}
/// Creates a nested directory that may live as long as its parent
--
2.49.0.901.g37484f566f-goog
next prev parent reply other threads:[~2025-04-29 23:16 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-29 23:15 [PATCH 0/8] rust: DebugFS Bindings Matthew Maurer
2025-04-29 23:15 ` [PATCH 1/8] rust: debugfs: Bind DebugFS directory creation Matthew Maurer
2025-04-30 7:50 ` Greg Kroah-Hartman
2025-04-30 15:10 ` Matthew Maurer
2025-04-30 15:23 ` Greg Kroah-Hartman
2025-04-30 15:31 ` Matthew Maurer
2025-04-30 16:58 ` Greg Kroah-Hartman
2025-04-29 23:15 ` [PATCH 2/8] rust: debugfs: Bind file creation for long-lived Display Matthew Maurer
2025-04-30 3:27 ` Miguel Ojeda
2025-04-30 15:26 ` Matthew Maurer
2025-04-30 7:52 ` Greg Kroah-Hartman
2025-04-30 15:15 ` Matthew Maurer
2025-04-30 7:55 ` Greg Kroah-Hartman
2025-04-30 15:12 ` Matthew Maurer
2025-04-30 15:24 ` Greg Kroah-Hartman
2025-04-29 23:15 ` [PATCH 3/8] rust: debugfs: Add scoped builder interface Matthew Maurer
2025-04-30 7:57 ` Greg Kroah-Hartman
2025-04-29 23:15 ` [PATCH 4/8] rust: debugfs: Allow subdir creation in " Matthew Maurer
2025-04-30 7:58 ` Greg Kroah-Hartman
2025-04-29 23:15 ` [PATCH 5/8] rust: debugfs: Support format hooks Matthew Maurer
2025-04-30 3:17 ` Miguel Ojeda
2025-04-29 23:16 ` Matthew Maurer [this message]
2025-04-29 23:16 ` [PATCH 7/8] rust: debugfs: Helper macro for common case implementations Matthew Maurer
2025-04-29 23:16 ` [PATCH 8/8] rust: samples: Add debugfs sample Matthew Maurer
2025-04-30 8:01 ` Greg Kroah-Hartman
2025-04-30 0:04 ` [PATCH 0/8] rust: DebugFS Bindings John Hubbard
2025-04-30 8:03 ` Greg Kroah-Hartman
2025-04-30 15:01 ` Matthew Maurer
2025-04-30 15:21 ` Greg Kroah-Hartman
2025-04-30 15:24 ` Matthew Maurer
2025-04-30 15:30 ` Greg Kroah-Hartman
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=20250429-debugfs-rust-v1-6-6b6e7cb7929f@google.com \
--to=mmaurer@google.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rafael@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=samitolvanen@google.com \
--cc=tmgross@umich.edu \
/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 NNTP newsgroup(s).