mirror of
https://github.com/torvalds/linux.git
synced 2025-10-31 08:38:45 +02:00
5990533a83
Reduce coupling to implementation details of the formatting machinery by avoiding direct use for `core`'s formatting traits and macros. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Benno Lossin <lossin@kernel.org> Signed-off-by: Tamir Duberstein <tamird@gmail.com> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
53 lines
1.7 KiB
Rust
53 lines
1.7 KiB
Rust
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
//! Seq file bindings.
|
|
//!
|
|
//! C header: [`include/linux/seq_file.h`](srctree/include/linux/seq_file.h)
|
|
|
|
use crate::{bindings, c_str, fmt, types::NotThreadSafe, types::Opaque};
|
|
|
|
/// A utility for generating the contents of a seq file.
|
|
#[repr(transparent)]
|
|
pub struct SeqFile {
|
|
inner: Opaque<bindings::seq_file>,
|
|
_not_send: NotThreadSafe,
|
|
}
|
|
|
|
impl SeqFile {
|
|
/// Creates a new [`SeqFile`] from a raw pointer.
|
|
///
|
|
/// # Safety
|
|
///
|
|
/// The caller must ensure that for the duration of `'a` the following is satisfied:
|
|
/// * The pointer points at a valid `struct seq_file`.
|
|
/// * The `struct seq_file` is not accessed from any other thread.
|
|
pub unsafe fn from_raw<'a>(ptr: *mut bindings::seq_file) -> &'a SeqFile {
|
|
// SAFETY: The caller ensures that the reference is valid for 'a. There's no way to trigger
|
|
// a data race by using the `&SeqFile` since this is the only thread accessing the seq_file.
|
|
//
|
|
// CAST: The layout of `struct seq_file` and `SeqFile` is compatible.
|
|
unsafe { &*ptr.cast() }
|
|
}
|
|
|
|
/// Used by the [`seq_print`] macro.
|
|
#[inline]
|
|
pub fn call_printf(&self, args: fmt::Arguments<'_>) {
|
|
// SAFETY: Passing a void pointer to `Arguments` is valid for `%pA`.
|
|
unsafe {
|
|
bindings::seq_printf(
|
|
self.inner.get(),
|
|
c_str!("%pA").as_char_ptr(),
|
|
core::ptr::from_ref(&args).cast::<crate::ffi::c_void>(),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Write to a [`SeqFile`] with the ordinary Rust formatting syntax.
|
|
#[macro_export]
|
|
macro_rules! seq_print {
|
|
($m:expr, $($arg:tt)+) => (
|
|
$m.call_printf($crate::prelude::fmt!($($arg)+))
|
|
);
|
|
}
|
|
pub use seq_print;
|