[PATCH v3 1/4] rust: debugfs: Bind DebugFS directory creation

From: Matthew Maurer
Date: Thu May 01 2025 - 18:48:18 EST

Support creating DebugFS directories and subdirectories. Similar to the
original DebugFS API, errors are hidden.

By default, when a root directory handle leaves scope, it will be cleaned
up.

Subdirectories will by default persist until their root directory is
cleaned up, but can be converted into a root directory if a scoped
lifecycle is desired.

Signed-off-by: Matthew Maurer <mmaurer@xxxxxxxxxx>
---
MAINTAINERS | 1 +
rust/bindings/bindings_helper.h | 1 +
rust/kernel/debugfs.rs | 155 ++++++++++++++++++++++++++++++++++++++++
rust/kernel/lib.rs | 1 +
4 files changed, 158 insertions(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 906881b6c5cb6ff743e13b251873b89138c69a1c..a3b835e427b083a4ddd690d9e7739851f0af47ae 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7271,6 +7271,7 @@ F: include/linux/kobj*
F: include/linux/property.h
F: include/linux/sysfs.h
F: lib/kobj*
+F: rust/kernel/debugfs.rs
F: rust/kernel/device.rs
F: rust/kernel/device_id.rs
F: rust/kernel/devres.rs
diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h
index 8a2add69e5d66d1c2ebed9d2c950380e61c48842..787f928467faabd02a7f3cf041378fac856c4f89 100644
--- a/rust/bindings/bindings_helper.h
+++ b/rust/bindings/bindings_helper.h
@@ -13,6 +13,7 @@
#include <linux/blkdev.h>
#include <linux/cpumask.h>
#include <linux/cred.h>
+#include <linux/debugfs.h>
#include <linux/device/faux.h>
#include <linux/dma-mapping.h>
#include <linux/errname.h>
diff --git a/rust/kernel/debugfs.rs b/rust/kernel/debugfs.rs
new file mode 100644
index 0000000000000000000000000000000000000000..b589c2d9a8d169bd66e98d2894261784e427230e
--- /dev/null
+++ b/rust/kernel/debugfs.rs
@@ -0,0 +1,155 @@
+// SPDX-License-Identifier: GPL-2.0
+
+// Copyright (C) 2025 Google LLC.
+
+//! DebugFS Abstraction
+//!
+//! C header: [`include/linux/debugfs.h`](srctree/include/linux/debugfs.h)
+
+use crate::str::CStr;
+use core::mem::ManuallyDrop;
+use core::ops::Deref;
+
+/// Owning handle to a DebugFS directory.
+///
+/// This directory will be cleaned up when it goes out of scope.
+///
+/// # Invariants
+///
+/// The wrapped pointer will always be `NULL`, an error, or an owned DebugFS `dentry`.
+#[repr(transparent)]
+pub struct Dir(#[cfg(CONFIG_DEBUG_FS)] *mut bindings::dentry);
+
+// SAFETY: Dir is just a `dentry` under the hood, which the API promises can be transferred
+// between threads.
+unsafe impl Send for Dir {}
+
+// SAFETY: All the native functions we re-export use interior locking, and the contents of the
+// struct are opaque to Rust.
+unsafe impl Sync for Dir {}
+
+impl Dir {
+ /// Create a new directory in DebugFS at the root.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use kernel::c_str;
+ /// # use kernel::debugfs::Dir;
+ /// {
+ /// let parent = Dir::new(c_str!("parent"));
+ /// // The path "parent" exists in DebugFS here.
+ /// }
+ /// // It does not exist here.
+ /// ```
+ pub fn new(name: &CStr) -> Self {
+ Self::create(name, None)
+ }
+
+ /// Create a DebugFS subdirectory.
+ ///
+ /// This returns a [`SubDir`], which will not be automatically cleaned up when it leaves scope.
+ /// To convert this to a handle governing the lifetime of the directory, use [`Dir::from`].
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use kernel::c_str;
+ /// # use kernel::debugfs::Dir;
+ /// {
+ /// let parent = Dir::new(c_str!("parent"));
+ /// // The path "parent" exists in DebugFS here.
+ /// {
+ /// let child = parent.subdir(c_str!("child"));
+ /// // The path "parent/child" exists in DebugFS here.
+ /// }
+ /// // The path "parent/child" still exists.
+ /// {
+ /// let child2 = Dir::from(parent.subdir(c_str!("child2")));
+ /// // The path "parent/child2" exists in DebugFS here.
+ /// }
+ /// // The path "parent/child2" is gone.
+ /// }
+ /// // None of the paths exist here.
+ /// ```
+ pub fn subdir(&self, name: &CStr) -> SubDir {
+ SubDir::new(Self::create(name, Some(self)))
+ }
+
+ /// Create a new directory in DebugFS. If `parent` is [`None`], it will be created at the root.
+ #[cfg(CONFIG_DEBUG_FS)]
+ fn create(name: &CStr, parent: Option<&Self>) -> Self {
+ let parent_ptr = match parent {
+ Some(parent) => parent.as_ptr(),
+ None => core::ptr::null_mut(),
+ };
+ // SAFETY:
+ // * `name` argument points to a NUL-terminated string that lives across the call, by
+ // invariants of `&CStr`.
+ // * If `parent` is `None`, `parent` accepts null pointers to mean create at root.
+ // * If `parent` is `Some`, `parent` accepts live dentry debugfs pointers.
+ // * `debugfs_create_dir` either returns an error code or a legal `dentry` pointer,
+ // so we can call `Self::from_ptr`.
+ unsafe { Self::from_ptr(bindings::debugfs_create_dir(name.as_char_ptr(), parent_ptr)) }
+ }
+
+ #[cfg(not(CONFIG_DEBUG_FS))]
+ fn create(_name: &CStr, _parent: Option<&Self>) -> Self {
+ Self()
+ }
+
+ /// Constructs a new DebugFS [`Dir`] from the underlying pointer.
+ ///
+ /// # Safety
+ ///
+ /// The pointer must either be an error code, `NULL`, or represent a transfer of ownership of a
+ /// live DebugFS directory.
+ #[cfg(CONFIG_DEBUG_FS)]
+ unsafe fn from_ptr(ptr: *mut bindings::dentry) -> Self {
+ Self(ptr)
+ }
+
+ /// Returns the pointer representation of the DebugFS directory.
+ ///
+ /// Due to the type invariant, the value returned from this function will always be an error
+ /// code, NUL, or a live DebugFS directory.
+ // If this function is ever needed with `not(CONFIG_DEBUG_FS)`, hardcode it to return `ENODEV`.
+ #[cfg(CONFIG_DEBUG_FS)]
+ fn as_ptr(&self) -> *mut bindings::dentry {
+ self.0
+ }
+}
+
+impl Drop for Dir {
+ fn drop(&mut self) {
+ // SAFETY: `debugfs_remove` can take `NULL`, error values, and legal DebugFS dentries.
+ // `as_ptr` guarantees that the pointer is of this form.
+ #[cfg(CONFIG_DEBUG_FS)]
+ unsafe {
+ bindings::debugfs_remove(self.as_ptr())
+ }
+ }
+}
+
+/// Handle to a DebugFS directory that will stay alive after leaving scope.
+#[repr(transparent)]
+pub struct SubDir(ManuallyDrop<Dir>);
+
+impl Deref for SubDir {
+ type Target = Dir;
+ fn deref(&self) -> &Dir {
+ &self.0
+ }
+}
+
+impl From<SubDir> for Dir {
+ fn from(subdir: SubDir) -> Self {
+ ManuallyDrop::into_inner(subdir.0)
+ }
+}
+
+impl SubDir {
+ fn new(dir: Dir) -> Self {
+ Self(ManuallyDrop::new(dir))
+ }
+}
diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
index c3762e80b314316b4b0cee3bfd9442f8f0510b91..86f6055b828d5f711578293d8916a517f2436977 100644
--- a/rust/kernel/lib.rs
+++ b/rust/kernel/lib.rs
@@ -45,6 +45,7 @@
#[doc(hidden)]
pub mod build_assert;
pub mod cred;
+pub mod debugfs;
pub mod device;
pub mod device_id;
pub mod devres;

--
2.49.0.906.g1f30a19c02-goog