From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pf1-f202.google.com (mail-pf1-f202.google.com [209.85.210.202]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 05AD02F5484 for ; Thu, 4 Sep 2025 21:14:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.202 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757020457; cv=none; b=jhsufBBPrs1auwULoLa2S7P/hYEdLVZ7QTHV4oP3F16n5G8PdXGtzqCHm0FJOQGayTXh4vn8UyZNGu+sgoi06b1zpVcck6elsQsFcX/DmIQnahbGzt1AEubFoKyzETSPx4Y+jQFiGeu8owD2aCKNQWyXpngQRSIdSV8mK6hKvOY= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757020457; c=relaxed/simple; bh=ZOByofkirTEhHxljqlcJt3YijCsj4603lkXVxLBHevc=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=GOtfXQvLC8jzl3i/eCQJfzXIA+p2eAEShzwkVj2MZDM+B4iDga7mTQ2HtDctfrnX6TpVzH4gb90wjeCI0cp0Wxjro7/hQZZQ0djQ/GO/ORrRjNv5Wo78EcR2YH1p64HlBVxrmFvFmswaTX7iZzSA5ybpgMnndjThT+s1Xn+7kvo= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--mmaurer.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=BL7ohsv+; arc=none smtp.client-ip=209.85.210.202 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--mmaurer.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="BL7ohsv+" Received: by mail-pf1-f202.google.com with SMTP id d2e1a72fcca58-77260707951so2124072b3a.0 for ; Thu, 04 Sep 2025 14:14:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1757020455; x=1757625255; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=MuVbHTcTn1dGtaw/xfjGHfOlmUWLY+u0Yv+dfyfZ2z0=; b=BL7ohsv+0QJsYKvY/8WoZ/6ufGM0HjlHpe2JUftH6WiV5zaHS7f9jn184BlKilDPsA GC4yvBywrHw+E0r5uaT86gkuMZWA3e0gTWaDm8hm8woGm9DU8/AMRsR903diXYQnTuZW Z2Lsl99uyRWRkLpH6g2mxyCxhFCVpjJWRIYi5QDIic0C5XtfogGh2L0/md4lcNry8Wkp yiC3CmCa9u3m3YHeoPg4GY+6FH/y6tbBBcXj55MecLOtb+R/ZalWjIeWT4kkEYHVfBp5 1eeiBOrhFhpx7xhnPotnnr1/P7r088rdBzSUZL/qQK77P0THBHWYdO8UQFie5OoArbnu Bgiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757020455; x=1757625255; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=MuVbHTcTn1dGtaw/xfjGHfOlmUWLY+u0Yv+dfyfZ2z0=; b=kbiy1Uildsr0WdSBK7DFJjLfdoFCwAXawUVJ1Bfi+MDrW/ITe36aAd/N99cRhXsC8Y uTsDT5NC6nfz9UlS4DRx7TjgEvAvFuN2gD13enk1pej0ZoS2n1wF2F+sQz5Uu92fw5wU PkPQmP+cmtVoBhySUarPxrXDAy6OC/n8er5my1bAvvtMe2F4hkTKxId9DHx7iJyJ+fh6 nkQNG0U4EeWBCpqMRvBKJYzH0xAIM4O9cpNQPKvNgG3zwGEjrjOwtsG6bT/02RLKdCf8 zxEryPrz0/xdhA9Hygzd5AUmsOdzr4U99SxXqWlowTmXR+/hON/xWG+coMndZ4Zu6+Wn tFXQ== X-Forwarded-Encrypted: i=1; AJvYcCUDGuW08Ovmoh1rDvH//of3vqTEb4EKe7R5FGHfbBY6y1F6ZeOk88dy8jM8QDAXekYgMOvbpTQcB850FaztyQ==@vger.kernel.org X-Gm-Message-State: AOJu0YwqnanlhCWN6AenJtVXlUCocXNMfoEJMM4+LHIok1yakzi4mYa1 oteLt+7ThNdqZCM80efpEpvnM0KYmq7dq+fNHLA/8wAZ6fwHnVBlKeww2uyiqjkiCl30E4xBqEZ i/6SG21gmCA== X-Google-Smtp-Source: AGHT+IE8miOQ1cTcO0C+Ywnb/WSRBEUZzd7DMsAk3P0BP9MWStesJpoYvtzfZYCTN4qKw3/Cfc/6aI10NvFj X-Received: from pfbjo21.prod.google.com ([2002:a05:6a00:9095:b0:771:83fa:dfac]) (user=mmaurer job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6300:218a:b0:243:b20d:5e05 with SMTP id adf61e73a8af0-243d6f051e5mr28631242637.39.1757020455228; Thu, 04 Sep 2025 14:14:15 -0700 (PDT) Date: Thu, 04 Sep 2025 21:13:58 +0000 In-Reply-To: <20250904-debugfs-rust-v11-0-7d12a165685a@google.com> Precedence: bulk X-Mailing-List: rust-for-linux@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250904-debugfs-rust-v11-0-7d12a165685a@google.com> X-Developer-Key: i=mmaurer@google.com; a=ed25519; pk=2Ezhl7+fEjTOMVFpplDeak2AdQ8cjJieLRVJdNzrW+E= X-Developer-Signature: v=1; a=ed25519-sha256; t=1757020440; l=7155; i=mmaurer@google.com; s=20250429; h=from:subject:message-id; bh=ZOByofkirTEhHxljqlcJt3YijCsj4603lkXVxLBHevc=; b=z+SsK8AErLja4NFbvWC9hBFsO/jociQidr7OHZFQUBBZxVNnfNJfH3+U1dQALNPMVtQF/RxOC ABPHJUeKBRkBVRtNo40OpsQ44BZRYj8V0p1k7vJcJ/y5gvyxSfqOGJr X-Mailer: b4 0.14.2 Message-ID: <20250904-debugfs-rust-v11-7-7d12a165685a@google.com> Subject: [PATCH v11 7/7] samples: rust: Add scoped debugfs sample driver From: Matthew Maurer To: Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , "=?utf-8?q?Bj=C3=B6rn_Roy_Baron?=" , Andreas Hindborg , Alice Ryhl , Trevor Gross , Danilo Krummrich , Greg Kroah-Hartman , "Rafael J. Wysocki" , Sami Tolvanen , Timur Tabi , Benno Lossin , Dirk Beheme Cc: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, Matthew Maurer Content-Type: text/plain; charset="utf-8" Adds a new sample driver `rust_scoped_debugfs` that demonstrates the use of the scoped debugfs APIs. The driver creates a `control` directory with two write-only files, `create` and `remove`. Writing a name and a series of numbers to `create` will create a new subdirectory under a `dynamic` directory. This new subdirectory will contain files that expose the numbers as atomic values. Writing a name to `remove` will remove the corresponding subdirectory from the `dynamic` directory. This sample serves as an example of how to use the `debugfs::Scope` and `debugfs::ScopedDir` APIs to create and manage debugfs entries that are tied to the lifetime of a data structure. Signed-off-by: Matthew Maurer --- MAINTAINERS | 1 + samples/rust/Kconfig | 11 +++ samples/rust/Makefile | 1 + samples/rust/rust_scoped_debugfs.rs | 134 ++++++++++++++++++++++++++++++++++++ 4 files changed, 147 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 5b6db584a33dd7ee39de3fdd0085d2bd7b7bef0e..2cbe890085dbb6a652623b38dd0eadeeaa127a94 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7482,6 +7482,7 @@ F: rust/kernel/driver.rs F: rust/kernel/faux.rs F: rust/kernel/platform.rs F: samples/rust/rust_debugfs.rs +F: samples/rust/rust_scoped_debugfs.rs F: samples/rust/rust_driver_platform.rs F: samples/rust/rust_driver_faux.rs diff --git a/samples/rust/Kconfig b/samples/rust/Kconfig index 01101db41ae31b08a86d048cdd27da8ef9bb23a2..3372935519d658529ee7ba25fb2c3fff6adae8c4 100644 --- a/samples/rust/Kconfig +++ b/samples/rust/Kconfig @@ -73,6 +73,17 @@ config SAMPLE_RUST_DEBUGFS If unsure, say N. +config SAMPLE_RUST_SCOPED_DEBUGFS + tristate "Scoped DebugFS Test Module" + depends on DEBUG_FS + help + This option builds the Rust Scoped DebugFS Test module sample. + + To compile this as a module, choose M here: + the module will be called rust_scoped_debugfs. + + If unsure, say N. + config SAMPLE_RUST_DRIVER_PCI tristate "PCI Driver" depends on PCI diff --git a/samples/rust/Makefile b/samples/rust/Makefile index 61276222a99f8cc6d7f84c26d0533b30815ebadd..de10b7f4db3996dc57be813ceb076d050ad8f65a 100644 --- a/samples/rust/Makefile +++ b/samples/rust/Makefile @@ -5,6 +5,7 @@ obj-$(CONFIG_SAMPLE_RUST_MINIMAL) += rust_minimal.o obj-$(CONFIG_SAMPLE_RUST_MISC_DEVICE) += rust_misc_device.o obj-$(CONFIG_SAMPLE_RUST_PRINT) += rust_print.o obj-$(CONFIG_SAMPLE_RUST_DEBUGFS) += rust_debugfs.o +obj-$(CONFIG_SAMPLE_RUST_SCOPED_DEBUGFS) += rust_scoped_debugfs.o obj-$(CONFIG_SAMPLE_RUST_DMA) += rust_dma.o obj-$(CONFIG_SAMPLE_RUST_DRIVER_PCI) += rust_driver_pci.o obj-$(CONFIG_SAMPLE_RUST_DRIVER_PLATFORM) += rust_driver_platform.o diff --git a/samples/rust/rust_scoped_debugfs.rs b/samples/rust/rust_scoped_debugfs.rs new file mode 100644 index 0000000000000000000000000000000000000000..7c34cab62a2753d1ede3a1334be1fb13ddce780c --- /dev/null +++ b/samples/rust/rust_scoped_debugfs.rs @@ -0,0 +1,134 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2025 Google LLC. + +//! Sample DebugFS exporting platform driver that demonstrates the use of +//! `Scope::dir` to create a variety of files without the need to separately +//! track them all. + +use core::sync::atomic::AtomicUsize; +use kernel::debugfs::{Dir, Scope}; +use kernel::prelude::*; +use kernel::sync::Mutex; +use kernel::{c_str, new_mutex, str::CString}; + +module! { + type: RustScopedDebugFs, + name: "rust_scoped_debugfs", + authors: ["Matthew Maurer"], + description: "Rust Scoped DebugFS usage sample", + license: "GPL", +} + +fn remove_file_write( + mod_data: &ModuleData, + reader: &mut kernel::uaccess::UserSliceReader, +) -> Result<()> { + let mut buf = [0u8; 128]; + if reader.len() >= buf.len() { + return Err(EINVAL); + } + let n = reader.len(); + reader.read_slice(&mut buf[..n])?; + + let s = core::str::from_utf8(&buf[..n]).map_err(|_| EINVAL)?.trim(); + let nul_idx = s.len(); + buf[nul_idx] = 0; + let to_remove = CStr::from_bytes_with_nul(&buf[..nul_idx + 1]).map_err(|_| EINVAL)?; + mod_data + .devices + .lock() + .retain(|device| device.name.as_bytes() != to_remove.as_bytes()); + Ok(()) +} + +fn create_file_write( + mod_data: &ModuleData, + reader: &mut kernel::uaccess::UserSliceReader, +) -> Result<()> { + let mut buf = [0u8; 128]; + if reader.len() > buf.len() { + return Err(EINVAL); + } + let n = reader.len(); + reader.read_slice(&mut buf[..n])?; + + let mut nums = KVec::new(); + + let s = core::str::from_utf8(&buf[..n]).map_err(|_| EINVAL)?.trim(); + let mut items = s.split_whitespace(); + let name_str = items.next().ok_or(EINVAL)?; + let name = CString::try_from_fmt(fmt!("{name_str}"))?; + let file_name = CString::try_from_fmt(fmt!("{name_str}"))?; + for sub in items { + nums.push( + AtomicUsize::new(sub.parse().map_err(|_| EINVAL)?), + GFP_KERNEL, + )?; + } + + let scope = KBox::pin_init( + mod_data + .device_dir + .scope(DeviceData { name, nums }, &file_name, |dev_data, dir| { + for (idx, val) in dev_data.nums.iter().enumerate() { + let Ok(name) = CString::try_from_fmt(fmt!("{idx}")) else { + return; + }; + dir.read_write_file(&name, val); + } + }), + GFP_KERNEL, + )?; + (*mod_data.devices.lock()).push(scope, GFP_KERNEL)?; + + Ok(()) +} + +struct RustScopedDebugFs { + _data: Pin>>, +} + +#[pin_data] +struct ModuleData { + device_dir: Dir, + #[pin] + devices: Mutex>>>>, +} + +impl ModuleData { + fn init(device_dir: Dir) -> impl PinInit { + pin_init! { + Self { + device_dir: device_dir, + devices <- new_mutex!(KVec::new()) + } + } + } +} + +struct DeviceData { + name: CString, + nums: KVec, +} + +fn init_control(base_dir: &Dir, dyn_dirs: Dir) -> impl PinInit> + '_ { + base_dir.scope( + ModuleData::init(dyn_dirs), + c_str!("control"), + |data, dir| { + dir.write_only_callback_file(c_str!("create"), data, &create_file_write); + dir.write_only_callback_file(c_str!("remove"), data, &remove_file_write); + }, + ) +} + +impl kernel::Module for RustScopedDebugFs { + fn init(_module: &'static kernel::ThisModule) -> Result { + let base_dir = Dir::new(c_str!("rust_scoped_debugfs")); + let dyn_dirs = base_dir.subdir(c_str!("dynamic")); + Ok(Self { + _data: KBox::pin_init(init_control(&base_dir, dyn_dirs), GFP_KERNEL)?, + }) + } +} -- 2.51.0.355.g5224444f11-goog