rust: add seqfile abstraction
Alice Ryhl
reviewerPATCH 1/1 rust: add seqfile abstraction
This adds a simple seq file abstraction that lets you print to a seq file using ordinary Rust printing syntax.
An example user from Rust Binder:
pub(crate) fn full_debug_print(
&self,
m: &SeqFile,
owner_inner: &mut ProcessInner,
) -> Result<()> {
let prio = self.node_prio();
let inner = self.inner.access_mut(owner_inner);
seq_print!(
m,
" node {}: u{:016x} c{:016x} pri {}:{} hs {} hw {} cs {} cw {}",
self.debug_id,
self.ptr,
self.cookie,
prio.sched_policy,
prio.prio,
inner.strong.has_count,
inner.weak.has_count,
inner.strong.count,
inner.weak.count,
);
if !inner.refs.is_empty() {
seq_print!(m, " proc");
for node_ref in &inner.refs {
seq_print!(m, " {}", node_ref.process.task.pid());
}
}
seq_print!(m, "\n");
for t in &inner.oneway_todo {
t.debug_print_inner(m, " pending async transaction ");
}
Ok(())
}The SeqFile type is marked not thread safe so that call_printf can be a &self method. The alternative is to use self: Pin<&mut Self> which is inconvenient, or to have SeqFile wrap a pointer instead of wrapping the C struct directly.
--- rust/kernel/lib.rs | 1 + rust/kernel/seq_file.rs | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+)
rust/kernel/lib.rs +1 -0
@@ -49,6 +49,7 @@pub mod sizes;pub mod rbtree;pub mod security; +pub mod seq_file;mod static_assert;#[doc(hidden)] pub mod std_vendor;
rust/kernel/seq_file.rs new file +52 -0
52 lines not on this page · raw message
---
base-commit: e9980e40804730de33c1563d9ac74d5b51591ec0
change-id: 20241001-seqfile-91d2243b8e99
Best regards,
Signature · 1 line
Alice Ryhl <[email protected]>
Alice Ryhl
reviewerQuoted 39 lines · Alice Ryhl
This adds a simple seq file abstraction that lets you print to a seq file using ordinary Rust printing syntax.
An example user from Rust Binder:
pub(crate) fn full_debug_print( &self, m: &SeqFile, owner_inner: &mut ProcessInner, ) -> Result<()> { let prio = self.node_prio(); let inner = self.inner.access_mut(owner_inner); seq_print!( m, " node {}: u{:016x} c{:016x} pri {}:{} hs {} hw {} cs {} cw {}", self.debug_id, self.ptr, self.cookie, prio.sched_policy, prio.prio, inner.strong.has_count, inner.weak.has_count, inner.strong.count, inner.weak.count, ); if !inner.refs.is_empty() { seq_print!(m, " proc"); for node_ref in &inner.refs { seq_print!(m, " {}", node_ref.process.task.pid()); } } seq_print!(m, "\n"); for t in &inner.oneway_todo { t.debug_print_inner(m, " pending async transaction "); } Ok(()) }
Quoted 6 lines
The
SeqFiletype is marked not thread safe so thatcall_printfcan be a&selfmethod. The alternative is to useself: Pin<&mut Self>which is inconvenient, or to haveSeqFilewrap a pointer instead of wrapping the C struct directly.Signed-off-by Alice Ryhl <[email protected]>
It's supposed to say this below the --- line:
This series is based on top of vfs.rust.file for the NotThreadSafe type.
I have no idea why b4 decided to drop this information ...
Alice
Quoted 38 lines · Alice Ryhl
This adds a simple seq file abstraction that lets you print to a seq file using ordinary Rust printing syntax.
An example user from Rust Binder:
pub(crate) fn full_debug_print( &self, m: &SeqFile, owner_inner: &mut ProcessInner, ) -> Result<()> { let prio = self.node_prio(); let inner = self.inner.access_mut(owner_inner); seq_print!( m, " node {}: u{:016x} c{:016x} pri {}:{} hs {} hw {} cs {} cw {}", self.debug_id, self.ptr, self.cookie, prio.sched_policy, prio.prio, inner.strong.has_count, inner.weak.has_count, inner.strong.count, inner.weak.count, ); if !inner.refs.is_empty() { seq_print!(m, " proc"); for node_ref in &inner.refs { seq_print!(m, " {}", node_ref.process.task.pid()); } } seq_print!(m, "\n"); for t in &inner.oneway_todo { t.debug_print_inner(m, " pending async transaction "); } Ok(()) }
Quoted 1 line
[...]
Seems straightforward.
---
Applied to the vfs.rust.file branch of the vfs/vfs.git tree. Patches in the vfs.rust.file branch should appear in linux-next soon.
Please report any outstanding bugs that were missed during review in a new review to the original patch series allowing us to drop it.
It's encouraged to provide Acked-bys and Reviewed-bys even though the patch has now been applied. If possible patch trailers will be updated.
Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. If in doubt, please check the listed branch.
tree: https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git branch: vfs.rust.file
[1/1] rust: add seqfile abstraction
https://git.kernel.org/vfs/vfs/c/66423ace209c