rust: kernel: add doclinks
Add doclinks to existing documentation. Signed-off-by: Valentin Obst <kernel@valentinobst.de> Reviewed-by: Trevor Gross <tmgross@umich.edu> Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-10-0c8af94ed7de@valentinobst.de Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This commit is contained in:
parent
6269fadf35
commit
4c799d1dc8
@ -365,12 +365,12 @@ impl<T: ?Sized> From<Pin<UniqueArc<T>>> for Arc<T> {
|
|||||||
/// A borrowed reference to an [`Arc`] instance.
|
/// A borrowed reference to an [`Arc`] instance.
|
||||||
///
|
///
|
||||||
/// For cases when one doesn't ever need to increment the refcount on the allocation, it is simpler
|
/// For cases when one doesn't ever need to increment the refcount on the allocation, it is simpler
|
||||||
/// to use just `&T`, which we can trivially get from an `Arc<T>` instance.
|
/// to use just `&T`, which we can trivially get from an [`Arc<T>`] instance.
|
||||||
///
|
///
|
||||||
/// However, when one may need to increment the refcount, it is preferable to use an `ArcBorrow<T>`
|
/// However, when one may need to increment the refcount, it is preferable to use an `ArcBorrow<T>`
|
||||||
/// over `&Arc<T>` because the latter results in a double-indirection: a pointer (shared reference)
|
/// over `&Arc<T>` because the latter results in a double-indirection: a pointer (shared reference)
|
||||||
/// to a pointer (`Arc<T>`) to the object (`T`). An [`ArcBorrow`] eliminates this double
|
/// to a pointer ([`Arc<T>`]) to the object (`T`). An [`ArcBorrow`] eliminates this double
|
||||||
/// indirection while still allowing one to increment the refcount and getting an `Arc<T>` when/if
|
/// indirection while still allowing one to increment the refcount and getting an [`Arc<T>`] when/if
|
||||||
/// needed.
|
/// needed.
|
||||||
///
|
///
|
||||||
/// # Invariants
|
/// # Invariants
|
||||||
|
@ -21,14 +21,21 @@ pub mod spinlock;
|
|||||||
/// # Safety
|
/// # Safety
|
||||||
///
|
///
|
||||||
/// - Implementers must ensure that only one thread/CPU may access the protected data once the lock
|
/// - Implementers must ensure that only one thread/CPU may access the protected data once the lock
|
||||||
/// is owned, that is, between calls to `lock` and `unlock`.
|
/// is owned, that is, between calls to [`lock`] and [`unlock`].
|
||||||
/// - Implementers must also ensure that `relock` uses the same locking method as the original
|
/// - Implementers must also ensure that [`relock`] uses the same locking method as the original
|
||||||
/// lock operation.
|
/// lock operation.
|
||||||
|
///
|
||||||
|
/// [`lock`]: Backend::lock
|
||||||
|
/// [`unlock`]: Backend::unlock
|
||||||
|
/// [`relock`]: Backend::relock
|
||||||
pub unsafe trait Backend {
|
pub unsafe trait Backend {
|
||||||
/// The state required by the lock.
|
/// The state required by the lock.
|
||||||
type State;
|
type State;
|
||||||
|
|
||||||
/// The state required to be kept between `lock` and `unlock`.
|
/// The state required to be kept between [`lock`] and [`unlock`].
|
||||||
|
///
|
||||||
|
/// [`lock`]: Backend::lock
|
||||||
|
/// [`unlock`]: Backend::unlock
|
||||||
type GuardState;
|
type GuardState;
|
||||||
|
|
||||||
/// Initialises the lock.
|
/// Initialises the lock.
|
||||||
|
@ -12,19 +12,19 @@
|
|||||||
//!
|
//!
|
||||||
//! # The raw API
|
//! # The raw API
|
||||||
//!
|
//!
|
||||||
//! The raw API consists of the `RawWorkItem` trait, where the work item needs to provide an
|
//! The raw API consists of the [`RawWorkItem`] trait, where the work item needs to provide an
|
||||||
//! arbitrary function that knows how to enqueue the work item. It should usually not be used
|
//! arbitrary function that knows how to enqueue the work item. It should usually not be used
|
||||||
//! directly, but if you want to, you can use it without using the pieces from the safe API.
|
//! directly, but if you want to, you can use it without using the pieces from the safe API.
|
||||||
//!
|
//!
|
||||||
//! # The safe API
|
//! # The safe API
|
||||||
//!
|
//!
|
||||||
//! The safe API is used via the `Work` struct and `WorkItem` traits. Furthermore, it also includes
|
//! The safe API is used via the [`Work`] struct and [`WorkItem`] traits. Furthermore, it also
|
||||||
//! a trait called `WorkItemPointer`, which is usually not used directly by the user.
|
//! includes a trait called [`WorkItemPointer`], which is usually not used directly by the user.
|
||||||
//!
|
//!
|
||||||
//! * The `Work` struct is the Rust wrapper for the C `work_struct` type.
|
//! * The [`Work`] struct is the Rust wrapper for the C `work_struct` type.
|
||||||
//! * The `WorkItem` trait is implemented for structs that can be enqueued to a workqueue.
|
//! * The [`WorkItem`] trait is implemented for structs that can be enqueued to a workqueue.
|
||||||
//! * The `WorkItemPointer` trait is implemented for the pointer type that points at a something
|
//! * The [`WorkItemPointer`] trait is implemented for the pointer type that points at a something
|
||||||
//! that implements `WorkItem`.
|
//! that implements [`WorkItem`].
|
||||||
//!
|
//!
|
||||||
//! ## Example
|
//! ## Example
|
||||||
//!
|
//!
|
||||||
@ -218,7 +218,9 @@ impl Queue {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// A helper type used in `try_spawn`.
|
/// A helper type used in [`try_spawn`].
|
||||||
|
///
|
||||||
|
/// [`try_spawn`]: Queue::try_spawn
|
||||||
#[pin_data]
|
#[pin_data]
|
||||||
struct ClosureWork<T> {
|
struct ClosureWork<T> {
|
||||||
#[pin]
|
#[pin]
|
||||||
@ -258,9 +260,11 @@ impl<T: FnOnce()> WorkItem for ClosureWork<T> {
|
|||||||
///
|
///
|
||||||
/// # Safety
|
/// # Safety
|
||||||
///
|
///
|
||||||
/// Implementers must ensure that any pointers passed to a `queue_work_on` closure by `__enqueue`
|
/// Implementers must ensure that any pointers passed to a `queue_work_on` closure by [`__enqueue`]
|
||||||
/// remain valid for the duration specified in the guarantees section of the documentation for
|
/// remain valid for the duration specified in the guarantees section of the documentation for
|
||||||
/// `__enqueue`.
|
/// [`__enqueue`].
|
||||||
|
///
|
||||||
|
/// [`__enqueue`]: RawWorkItem::__enqueue
|
||||||
pub unsafe trait RawWorkItem<const ID: u64> {
|
pub unsafe trait RawWorkItem<const ID: u64> {
|
||||||
/// The return type of [`Queue::enqueue`].
|
/// The return type of [`Queue::enqueue`].
|
||||||
type EnqueueOutput;
|
type EnqueueOutput;
|
||||||
@ -290,10 +294,11 @@ pub unsafe trait RawWorkItem<const ID: u64> {
|
|||||||
|
|
||||||
/// Defines the method that should be called directly when a work item is executed.
|
/// Defines the method that should be called directly when a work item is executed.
|
||||||
///
|
///
|
||||||
/// This trait is implemented by `Pin<Box<T>>` and `Arc<T>`, and is mainly intended to be
|
/// This trait is implemented by `Pin<Box<T>>` and [`Arc<T>`], and is mainly intended to be
|
||||||
/// implemented for smart pointer types. For your own structs, you would implement [`WorkItem`]
|
/// implemented for smart pointer types. For your own structs, you would implement [`WorkItem`]
|
||||||
/// instead. The `run` method on this trait will usually just perform the appropriate
|
/// instead. The [`run`] method on this trait will usually just perform the appropriate
|
||||||
/// `container_of` translation and then call into the `run` method from the [`WorkItem`] trait.
|
/// `container_of` translation and then call into the [`run`][WorkItem::run] method from the
|
||||||
|
/// [`WorkItem`] trait.
|
||||||
///
|
///
|
||||||
/// This trait is used when the `work_struct` field is defined using the [`Work`] helper.
|
/// This trait is used when the `work_struct` field is defined using the [`Work`] helper.
|
||||||
///
|
///
|
||||||
@ -309,8 +314,10 @@ pub unsafe trait WorkItemPointer<const ID: u64>: RawWorkItem<ID> {
|
|||||||
///
|
///
|
||||||
/// # Safety
|
/// # Safety
|
||||||
///
|
///
|
||||||
/// The provided `work_struct` pointer must originate from a previous call to `__enqueue` where
|
/// The provided `work_struct` pointer must originate from a previous call to [`__enqueue`]
|
||||||
/// the `queue_work_on` closure returned true, and the pointer must still be valid.
|
/// where the `queue_work_on` closure returned true, and the pointer must still be valid.
|
||||||
|
///
|
||||||
|
/// [`__enqueue`]: RawWorkItem::__enqueue
|
||||||
unsafe extern "C" fn run(ptr: *mut bindings::work_struct);
|
unsafe extern "C" fn run(ptr: *mut bindings::work_struct);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -328,12 +335,14 @@ pub trait WorkItem<const ID: u64 = 0> {
|
|||||||
|
|
||||||
/// Links for a work item.
|
/// Links for a work item.
|
||||||
///
|
///
|
||||||
/// This struct contains a function pointer to the `run` function from the [`WorkItemPointer`]
|
/// This struct contains a function pointer to the [`run`] function from the [`WorkItemPointer`]
|
||||||
/// trait, and defines the linked list pointers necessary to enqueue a work item in a workqueue.
|
/// trait, and defines the linked list pointers necessary to enqueue a work item in a workqueue.
|
||||||
///
|
///
|
||||||
/// Wraps the kernel's C `struct work_struct`.
|
/// Wraps the kernel's C `struct work_struct`.
|
||||||
///
|
///
|
||||||
/// This is a helper type used to associate a `work_struct` with the [`WorkItem`] that uses it.
|
/// This is a helper type used to associate a `work_struct` with the [`WorkItem`] that uses it.
|
||||||
|
///
|
||||||
|
/// [`run`]: WorkItemPointer::run
|
||||||
#[repr(transparent)]
|
#[repr(transparent)]
|
||||||
pub struct Work<T: ?Sized, const ID: u64 = 0> {
|
pub struct Work<T: ?Sized, const ID: u64 = 0> {
|
||||||
work: Opaque<bindings::work_struct>,
|
work: Opaque<bindings::work_struct>,
|
||||||
@ -409,7 +418,7 @@ impl<T: ?Sized, const ID: u64> Work<T, ID> {
|
|||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// Note that since the `Work` type is annotated with an id, you can have several `work_struct`
|
/// Note that since the [`Work`] type is annotated with an id, you can have several `work_struct`
|
||||||
/// fields by using a different id for each one.
|
/// fields by using a different id for each one.
|
||||||
///
|
///
|
||||||
/// # Safety
|
/// # Safety
|
||||||
@ -429,7 +438,7 @@ pub unsafe trait HasWork<T, const ID: u64 = 0> {
|
|||||||
/// Returns the offset of the [`Work<T, ID>`] field.
|
/// Returns the offset of the [`Work<T, ID>`] field.
|
||||||
///
|
///
|
||||||
/// This method exists because the [`OFFSET`] constant cannot be accessed if the type is not
|
/// This method exists because the [`OFFSET`] constant cannot be accessed if the type is not
|
||||||
/// `Sized`.
|
/// [`Sized`].
|
||||||
///
|
///
|
||||||
/// [`Work<T, ID>`]: Work
|
/// [`Work<T, ID>`]: Work
|
||||||
/// [`OFFSET`]: HasWork::OFFSET
|
/// [`OFFSET`]: HasWork::OFFSET
|
||||||
|
Loading…
Reference in New Issue
Block a user