public inbox for linux-fsdevel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] rust: seq_file: add puts, putc, write, and hex_dump methods
@ 2026-04-03 23:39 Christian Benton
  2026-04-07  8:20 ` Alice Ryhl
  2026-04-07 23:00 ` kernel test robot
  0 siblings, 2 replies; 3+ messages in thread
From: Christian Benton @ 2026-04-03 23:39 UTC (permalink / raw)
  To: ojeda
  Cc: viro, brauner, rust-for-linux, linux-fsdevel, linux-kernel,
	aliceryhl, lossin, Christian Benton

The SeqFile abstraction currently only exposes seq_printf via the
seq_print! macro. This leaves several commonly used seq_file operations
unavailable to Rust kernel code.

Add the following methods to SeqFile:

- puts(): writes a C string using __seq_puts()
- putc(): writes a single byte using seq_putc()
- write(): writes raw bytes using seq_write()
- hex_dump(): dumps binary data as formatted hex using seq_hex_dump()

Also add HexDumpPrefix, a Rust enum wrapping the DUMP_PREFIX_NONE,
DUMP_PREFIX_ADDRESS, and DUMP_PREFIX_OFFSET constants, replacing the
raw integer interface with a type-safe alternative that makes invalid
prefix values unrepresentable.

Signed-off-by: Christian Benton <t1bur0n.kernel.org@protonmail.ch>
---
 rust/kernel/seq_file.rs | 85 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 84 insertions(+), 1 deletion(-)

diff --git a/rust/kernel/seq_file.rs b/rust/kernel/seq_file.rs
index 518265558..cd4df821b 100644
--- a/rust/kernel/seq_file.rs
+++ b/rust/kernel/seq_file.rs
@@ -4,7 +4,7 @@
 //!
 //! C header: [`include/linux/seq_file.h`](srctree/include/linux/seq_file.h)
 
-use crate::{bindings, fmt, str::CStrExt as _, types::NotThreadSafe, types::Opaque};
+use crate::{bindings, ffi, fmt, str::CStr, str::CStrExt as _, types::NotThreadSafe, types::Opaque};
 
 /// A utility for generating the contents of a seq file.
 #[repr(transparent)]
@@ -13,6 +13,26 @@ pub struct SeqFile {
     _not_send: NotThreadSafe,
 }
 
+/// The prefix type for [`SeqFile::hex_dump`].
+pub enum HexDumpPrefix {
+    /// No prefix.
+    None,
+    /// Prefix with the memory address.
+    Address,
+    /// Prefix with the offset within the buffer.
+    Offset,
+}
+
+impl HexDumpPrefix {
+    fn as_c_int(self) -> ffi::c_int {
+        match self {
+            Self::None => bindings::DUMP_PREFIX_NONE as ffi::c_int,
+            Self::Address => bindings::DUMP_PREFIX_ADDRESS as ffi::c_int,
+            Self::Offset => bindings::DUMP_PREFIX_OFFSET as ffi::c_int,
+        }
+    }
+}
+
 impl SeqFile {
     /// Creates a new [`SeqFile`] from a raw pointer.
     ///
@@ -41,6 +61,69 @@ pub fn call_printf(&self, args: fmt::Arguments<'_>) {
             );
         }
     }
+
+    /// Prints a C string to the seq file.
+    pub fn puts(&self, s: &CStr) {
+        // SAFETY: `self.inner.get()` is valid because `&self` guarantees the
+        // `SeqFile` is alive and was properly initialized via `from_raw`.
+        // `s.as_char_ptr()` is valid because `CStr` is always a valid
+        // null-terminated C string.
+        unsafe { bindings::__seq_puts(self.inner.get(), s.as_char_ptr()) }
+    }
+
+    /// Prints a single char to the seq file.
+    pub fn putc(&self, c: u8) {
+        // SAFETY: `self.inner.get()` is valid because `&self`
+        // guarantees `SeqFile` is alive and was properly initialized via `from_raw`
+        unsafe { bindings::seq_putc(self.inner.get(), c as ffi::c_char) }
+    }
+
+    /// Writes raw bytes to the seq file.
+    pub fn write(&self, data: &[u8]) {
+        // SAFETY: `self.inner.get()` is valid because `&self` guarantees the
+        // `SeqFile` is alive and was properly initialized via `from_raw`.
+        // `data.as_ptr()` is valid and non-dangling because it comes from a
+        // `&[u8]`, which guarantees the memory is valid for `data.len()` bytes
+        // and will not be modified during the call due to the shared reference.
+        unsafe {
+            bindings::seq_write(
+                self.inner.get(),
+                data.as_ptr().cast::<ffi::c_void>(),
+                data.len(),
+            )
+        };
+    }
+
+    /// Prints a hex dump of `buf` to the seq file.
+    pub fn hex_dump(
+        &self,
+        prefix_str: &CStr,
+        prefix_type: HexDumpPrefix,
+        rowsize: u8,
+        groupsize: u8,
+        buf: &[u8],
+        ascii: bool,
+    ) {
+        // SAFETY: `self.inner.get()` is valid because `&self` guarantees the
+        // `SeqFile` is alive and was properly initialized via `from_raw`.
+        // `prefix_str.as_char_ptr()` is valid because `CStr` is always a valid
+        // null-terminated C string. `buf.as_ptr()` is valid and non-dangling
+        // because it comes from a `&[u8]`, which guarantees the memory is valid
+        // for `buf.len()` bytes and will not be modified during the call due to
+        // the shared reference.
+        unsafe {
+            bindings::seq_hex_dump(
+                self.inner.get(),
+                prefix_str.as_char_ptr(),
+                prefix_type.as_c_int(),
+                rowsize as ffi::c_int,
+                groupsize as ffi::c_int,
+                buf.as_ptr().cast::<ffi::c_void>(),
+                buf.len(),
+                ascii,
+            )
+        }
+    }
 }
 
 /// Write to a [`SeqFile`] with the ordinary Rust formatting syntax.
-- 
2.53.0



^ permalink raw reply related	[flat|nested] 3+ messages in thread
end of thread, other threads:[~2026-04-07 23:00 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-03 23:39 [PATCH] rust: seq_file: add puts, putc, write, and hex_dump methods Christian Benton
2026-04-07  8:20 ` Alice Ryhl
2026-04-07 23:00 ` kernel test robot

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox