mirror of
https://github.com/linux-msm/laptops-kernel.git
synced 2026-08-13 14:19:53 -07:00
Merge tag 'rust-hrtimer-for-v6.15-v3' of https://github.com/Rust-for-Linux/linux into rust-next
Pull rust-hrtimer updates from Andreas Hindborg:
"Introduce Rust support for the 'hrtimer' subsystem:
- Add a way to use the 'hrtimer' subsystem from Rust. Rust code can
now set up intrusive timers without allocating when starting the
timer.
- Add support for 'Pin<Box<_>>', 'Arc<_>', 'Pin<&_>' and
'Pin<&mut _>' as pointer types for use with timer callbacks.
- Add support for setting clock source and timer mode.
'kernel' crate:
- Add 'Arc::as_ptr' for converting an 'Arc' to a raw pointer. This is
a dependency for the 'hrtimer' API.
- Add 'Box::into_pin' for converting a 'Box<_>' into a 'Pin<Box<_>>'
to align with Rust 'alloc'. This is a dependency for the 'hrtimer'
API."
* tag 'rust-hrtimer-for-v6.15-v3' of https://github.com/Rust-for-Linux/linux:
rust: hrtimer: add maintainer entry
rust: hrtimer: add clocksource selection through `ClockId`
rust: hrtimer: add `HrTimerMode`
rust: hrtimer: implement `HrTimerPointer` for `Pin<Box<T>>`
rust: alloc: add `Box::into_pin`
rust: hrtimer: implement `UnsafeHrTimerPointer` for `Pin<&mut T>`
rust: hrtimer: implement `UnsafeHrTimerPointer` for `Pin<&T>`
rust: hrtimer: add `hrtimer::ScopedHrTimerPointer`
rust: hrtimer: add `UnsafeHrTimerPointer`
rust: hrtimer: allow timer restart from timer handler
rust: hrtimer: implement `HrTimerPointer` for `Arc`
rust: sync: add `Arc::as_ptr`
rust: hrtimer: introduce hrtimer support
This commit is contained in:
Miguel Ojeda committed
commit
e6ea10d5db
9 files changed
+1052
-2
No files matched your search
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,100 @@
|
||||
// SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
use super::HasHrTimer;
|
||||
use super::HrTimer;
|
||||
use super::HrTimerCallback;
|
||||
use super::HrTimerHandle;
|
||||
use super::HrTimerPointer;
|
||||
use super::RawHrTimerCallback;
|
||||
use crate::sync::Arc;
|
||||
use crate::sync::ArcBorrow;
|
||||
use crate::time::Ktime;
|
||||
|
||||
/// A handle for an `Arc<HasHrTimer<T>>` returned by a call to
|
||||
/// [`HrTimerPointer::start`].
|
||||
pub struct ArcHrTimerHandle<T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
pub(crate) inner: Arc<T>,
|
||||
}
|
||||
|
||||
// SAFETY: We implement drop below, and we cancel the timer in the drop
|
||||
// implementation.
|
||||
unsafe impl<T> HrTimerHandle for ArcHrTimerHandle<T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
fn cancel(&mut self) -> bool {
|
||||
let self_ptr = Arc::as_ptr(&self.inner);
|
||||
|
||||
// SAFETY: As we obtained `self_ptr` from a valid reference above, it
|
||||
// must point to a valid `T`.
|
||||
let timer_ptr = unsafe { <T as HasHrTimer<T>>::raw_get_timer(self_ptr) };
|
||||
|
||||
// SAFETY: As `timer_ptr` points into `T` and `T` is valid, `timer_ptr`
|
||||
// must point to a valid `HrTimer` instance.
|
||||
unsafe { HrTimer::<T>::raw_cancel(timer_ptr) }
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Drop for ArcHrTimerHandle<T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
fn drop(&mut self) {
|
||||
self.cancel();
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> HrTimerPointer for Arc<T>
|
||||
where
|
||||
T: 'static,
|
||||
T: Send + Sync,
|
||||
T: HasHrTimer<T>,
|
||||
T: for<'a> HrTimerCallback<Pointer<'a> = Self>,
|
||||
{
|
||||
type TimerHandle = ArcHrTimerHandle<T>;
|
||||
|
||||
fn start(self, expires: Ktime) -> ArcHrTimerHandle<T> {
|
||||
// SAFETY:
|
||||
// - We keep `self` alive by wrapping it in a handle below.
|
||||
// - Since we generate the pointer passed to `start` from a valid
|
||||
// reference, it is a valid pointer.
|
||||
unsafe { T::start(Arc::as_ptr(&self), expires) };
|
||||
ArcHrTimerHandle { inner: self }
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> RawHrTimerCallback for Arc<T>
|
||||
where
|
||||
T: 'static,
|
||||
T: HasHrTimer<T>,
|
||||
T: for<'a> HrTimerCallback<Pointer<'a> = Self>,
|
||||
{
|
||||
type CallbackTarget<'a> = ArcBorrow<'a, T>;
|
||||
|
||||
unsafe extern "C" fn run(ptr: *mut bindings::hrtimer) -> bindings::hrtimer_restart {
|
||||
// `HrTimer` is `repr(C)`
|
||||
let timer_ptr = ptr.cast::<super::HrTimer<T>>();
|
||||
|
||||
// SAFETY: By C API contract `ptr` is the pointer we passed when
|
||||
// queuing the timer, so it is a `HrTimer<T>` embedded in a `T`.
|
||||
let data_ptr = unsafe { T::timer_container_of(timer_ptr) };
|
||||
|
||||
// SAFETY:
|
||||
// - `data_ptr` is derived form the pointer to the `T` that was used to
|
||||
// queue the timer.
|
||||
// - As per the safety requirements of the trait `HrTimerHandle`, the
|
||||
// `ArcHrTimerHandle` associated with this timer is guaranteed to
|
||||
// be alive until this method returns. That handle borrows the `T`
|
||||
// behind `data_ptr` thus guaranteeing the validity of
|
||||
// the `ArcBorrow` created below.
|
||||
// - We own one refcount in the `ArcTimerHandle` associated with this
|
||||
// timer, so it is not possible to get a `UniqueArc` to this
|
||||
// allocation from other `Arc` clones.
|
||||
let receiver = unsafe { ArcBorrow::from_raw(data_ptr) };
|
||||
|
||||
T::run(receiver).into_c()
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,104 @@
|
||||
// SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
use super::HasHrTimer;
|
||||
use super::HrTimer;
|
||||
use super::HrTimerCallback;
|
||||
use super::HrTimerHandle;
|
||||
use super::RawHrTimerCallback;
|
||||
use super::UnsafeHrTimerPointer;
|
||||
use crate::time::Ktime;
|
||||
use core::pin::Pin;
|
||||
|
||||
/// A handle for a `Pin<&HasHrTimer>`. When the handle exists, the timer might be
|
||||
/// running.
|
||||
pub struct PinHrTimerHandle<'a, T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
pub(crate) inner: Pin<&'a T>,
|
||||
}
|
||||
|
||||
// SAFETY: We cancel the timer when the handle is dropped. The implementation of
|
||||
// the `cancel` method will block if the timer handler is running.
|
||||
unsafe impl<'a, T> HrTimerHandle for PinHrTimerHandle<'a, T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
fn cancel(&mut self) -> bool {
|
||||
let self_ptr: *const T = self.inner.get_ref();
|
||||
|
||||
// SAFETY: As we got `self_ptr` from a reference above, it must point to
|
||||
// a valid `T`.
|
||||
let timer_ptr = unsafe { <T as HasHrTimer<T>>::raw_get_timer(self_ptr) };
|
||||
|
||||
// SAFETY: As `timer_ptr` is derived from a reference, it must point to
|
||||
// a valid and initialized `HrTimer`.
|
||||
unsafe { HrTimer::<T>::raw_cancel(timer_ptr) }
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a, T> Drop for PinHrTimerHandle<'a, T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
fn drop(&mut self) {
|
||||
self.cancel();
|
||||
}
|
||||
}
|
||||
|
||||
// SAFETY: We capture the lifetime of `Self` when we create a `PinHrTimerHandle`,
|
||||
// so `Self` will outlive the handle.
|
||||
unsafe impl<'a, T> UnsafeHrTimerPointer for Pin<&'a T>
|
||||
where
|
||||
T: Send + Sync,
|
||||
T: HasHrTimer<T>,
|
||||
T: HrTimerCallback<Pointer<'a> = Self>,
|
||||
{
|
||||
type TimerHandle = PinHrTimerHandle<'a, T>;
|
||||
|
||||
unsafe fn start(self, expires: Ktime) -> Self::TimerHandle {
|
||||
// Cast to pointer
|
||||
let self_ptr: *const T = self.get_ref();
|
||||
|
||||
// SAFETY:
|
||||
// - As we derive `self_ptr` from a reference above, it must point to a
|
||||
// valid `T`.
|
||||
// - We keep `self` alive by wrapping it in a handle below.
|
||||
unsafe { T::start(self_ptr, expires) };
|
||||
|
||||
PinHrTimerHandle { inner: self }
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a, T> RawHrTimerCallback for Pin<&'a T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
T: HrTimerCallback<Pointer<'a> = Self>,
|
||||
{
|
||||
type CallbackTarget<'b> = Self;
|
||||
|
||||
unsafe extern "C" fn run(ptr: *mut bindings::hrtimer) -> bindings::hrtimer_restart {
|
||||
// `HrTimer` is `repr(C)`
|
||||
let timer_ptr = ptr as *mut HrTimer<T>;
|
||||
|
||||
// SAFETY: By the safety requirement of this function, `timer_ptr`
|
||||
// points to a `HrTimer<T>` contained in an `T`.
|
||||
let receiver_ptr = unsafe { T::timer_container_of(timer_ptr) };
|
||||
|
||||
// SAFETY:
|
||||
// - By the safety requirement of this function, `timer_ptr`
|
||||
// points to a `HrTimer<T>` contained in an `T`.
|
||||
// - As per the safety requirements of the trait `HrTimerHandle`, the
|
||||
// `PinHrTimerHandle` associated with this timer is guaranteed to
|
||||
// be alive until this method returns. That handle borrows the `T`
|
||||
// behind `receiver_ptr`, thus guaranteeing the validity of
|
||||
// the reference created below.
|
||||
let receiver_ref = unsafe { &*receiver_ptr };
|
||||
|
||||
// SAFETY: `receiver_ref` only exists as pinned, so it is safe to pin it
|
||||
// here.
|
||||
let receiver_pin = unsafe { Pin::new_unchecked(receiver_ref) };
|
||||
|
||||
T::run(receiver_pin).into_c()
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,108 @@
|
||||
// SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
use super::{
|
||||
HasHrTimer, HrTimer, HrTimerCallback, HrTimerHandle, RawHrTimerCallback, UnsafeHrTimerPointer,
|
||||
};
|
||||
use crate::time::Ktime;
|
||||
use core::{marker::PhantomData, pin::Pin, ptr::NonNull};
|
||||
|
||||
/// A handle for a `Pin<&mut HasHrTimer>`. When the handle exists, the timer might
|
||||
/// be running.
|
||||
pub struct PinMutHrTimerHandle<'a, T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
pub(crate) inner: NonNull<T>,
|
||||
_p: PhantomData<&'a mut T>,
|
||||
}
|
||||
|
||||
// SAFETY: We cancel the timer when the handle is dropped. The implementation of
|
||||
// the `cancel` method will block if the timer handler is running.
|
||||
unsafe impl<'a, T> HrTimerHandle for PinMutHrTimerHandle<'a, T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
fn cancel(&mut self) -> bool {
|
||||
let self_ptr = self.inner.as_ptr();
|
||||
|
||||
// SAFETY: As we got `self_ptr` from a reference above, it must point to
|
||||
// a valid `T`.
|
||||
let timer_ptr = unsafe { <T as HasHrTimer<T>>::raw_get_timer(self_ptr) };
|
||||
|
||||
// SAFETY: As `timer_ptr` is derived from a reference, it must point to
|
||||
// a valid and initialized `HrTimer`.
|
||||
unsafe { HrTimer::<T>::raw_cancel(timer_ptr) }
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a, T> Drop for PinMutHrTimerHandle<'a, T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
{
|
||||
fn drop(&mut self) {
|
||||
self.cancel();
|
||||
}
|
||||
}
|
||||
|
||||
// SAFETY: We capture the lifetime of `Self` when we create a
|
||||
// `PinMutHrTimerHandle`, so `Self` will outlive the handle.
|
||||
unsafe impl<'a, T> UnsafeHrTimerPointer for Pin<&'a mut T>
|
||||
where
|
||||
T: Send + Sync,
|
||||
T: HasHrTimer<T>,
|
||||
T: HrTimerCallback<Pointer<'a> = Self>,
|
||||
{
|
||||
type TimerHandle = PinMutHrTimerHandle<'a, T>;
|
||||
|
||||
unsafe fn start(mut self, expires: Ktime) -> Self::TimerHandle {
|
||||
// SAFETY:
|
||||
// - We promise not to move out of `self`. We only pass `self`
|
||||
// back to the caller as a `Pin<&mut self>`.
|
||||
// - The return value of `get_unchecked_mut` is guaranteed not to be null.
|
||||
let self_ptr = unsafe { NonNull::new_unchecked(self.as_mut().get_unchecked_mut()) };
|
||||
|
||||
// SAFETY:
|
||||
// - As we derive `self_ptr` from a reference above, it must point to a
|
||||
// valid `T`.
|
||||
// - We keep `self` alive by wrapping it in a handle below.
|
||||
unsafe { T::start(self_ptr.as_ptr(), expires) };
|
||||
|
||||
PinMutHrTimerHandle {
|
||||
inner: self_ptr,
|
||||
_p: PhantomData,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a, T> RawHrTimerCallback for Pin<&'a mut T>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
T: HrTimerCallback<Pointer<'a> = Self>,
|
||||
{
|
||||
type CallbackTarget<'b> = Self;
|
||||
|
||||
unsafe extern "C" fn run(ptr: *mut bindings::hrtimer) -> bindings::hrtimer_restart {
|
||||
// `HrTimer` is `repr(C)`
|
||||
let timer_ptr = ptr as *mut HrTimer<T>;
|
||||
|
||||
// SAFETY: By the safety requirement of this function, `timer_ptr`
|
||||
// points to a `HrTimer<T>` contained in an `T`.
|
||||
let receiver_ptr = unsafe { T::timer_container_of(timer_ptr) };
|
||||
|
||||
// SAFETY:
|
||||
// - By the safety requirement of this function, `timer_ptr`
|
||||
// points to a `HrTimer<T>` contained in an `T`.
|
||||
// - As per the safety requirements of the trait `HrTimerHandle`, the
|
||||
// `PinMutHrTimerHandle` associated with this timer is guaranteed to
|
||||
// be alive until this method returns. That handle borrows the `T`
|
||||
// behind `receiver_ptr` mutably thus guaranteeing the validity of
|
||||
// the reference created below.
|
||||
let receiver_ref = unsafe { &mut *receiver_ptr };
|
||||
|
||||
// SAFETY: `receiver_ref` only exists as pinned, so it is safe to pin it
|
||||
// here.
|
||||
let receiver_pin = unsafe { Pin::new_unchecked(receiver_ref) };
|
||||
|
||||
T::run(receiver_pin).into_c()
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,120 @@
|
||||
// SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
use super::HasHrTimer;
|
||||
use super::HrTimer;
|
||||
use super::HrTimerCallback;
|
||||
use super::HrTimerHandle;
|
||||
use super::HrTimerPointer;
|
||||
use super::RawHrTimerCallback;
|
||||
use crate::prelude::*;
|
||||
use crate::time::Ktime;
|
||||
use core::ptr::NonNull;
|
||||
|
||||
/// A handle for a [`Box<HasHrTimer<T>>`] returned by a call to
|
||||
/// [`HrTimerPointer::start`].
|
||||
///
|
||||
/// # Invariants
|
||||
///
|
||||
/// - `self.inner` comes from a `Box::into_raw` call.
|
||||
pub struct BoxHrTimerHandle<T, A>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
A: crate::alloc::Allocator,
|
||||
{
|
||||
pub(crate) inner: NonNull<T>,
|
||||
_p: core::marker::PhantomData<A>,
|
||||
}
|
||||
|
||||
// SAFETY: We implement drop below, and we cancel the timer in the drop
|
||||
// implementation.
|
||||
unsafe impl<T, A> HrTimerHandle for BoxHrTimerHandle<T, A>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
A: crate::alloc::Allocator,
|
||||
{
|
||||
fn cancel(&mut self) -> bool {
|
||||
// SAFETY: As we obtained `self.inner` from a valid reference when we
|
||||
// created `self`, it must point to a valid `T`.
|
||||
let timer_ptr = unsafe { <T as HasHrTimer<T>>::raw_get_timer(self.inner.as_ptr()) };
|
||||
|
||||
// SAFETY: As `timer_ptr` points into `T` and `T` is valid, `timer_ptr`
|
||||
// must point to a valid `HrTimer` instance.
|
||||
unsafe { HrTimer::<T>::raw_cancel(timer_ptr) }
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, A> Drop for BoxHrTimerHandle<T, A>
|
||||
where
|
||||
T: HasHrTimer<T>,
|
||||
A: crate::alloc::Allocator,
|
||||
{
|
||||
fn drop(&mut self) {
|
||||
self.cancel();
|
||||
// SAFETY: By type invariant, `self.inner` came from a `Box::into_raw`
|
||||
// call.
|
||||
drop(unsafe { Box::<T, A>::from_raw(self.inner.as_ptr()) })
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, A> HrTimerPointer for Pin<Box<T, A>>
|
||||
where
|
||||
T: 'static,
|
||||
T: Send + Sync,
|
||||
T: HasHrTimer<T>,
|
||||
T: for<'a> HrTimerCallback<Pointer<'a> = Pin<Box<T, A>>>,
|
||||
A: crate::alloc::Allocator,
|
||||
{
|
||||
type TimerHandle = BoxHrTimerHandle<T, A>;
|
||||
|
||||
fn start(self, expires: Ktime) -> Self::TimerHandle {
|
||||
// SAFETY:
|
||||
// - We will not move out of this box during timer callback (we pass an
|
||||
// immutable reference to the callback).
|
||||
// - `Box::into_raw` is guaranteed to return a valid pointer.
|
||||
let inner =
|
||||
unsafe { NonNull::new_unchecked(Box::into_raw(Pin::into_inner_unchecked(self))) };
|
||||
|
||||
// SAFETY:
|
||||
// - We keep `self` alive by wrapping it in a handle below.
|
||||
// - Since we generate the pointer passed to `start` from a valid
|
||||
// reference, it is a valid pointer.
|
||||
unsafe { T::start(inner.as_ptr(), expires) };
|
||||
|
||||
// INVARIANT: `inner` came from `Box::into_raw` above.
|
||||
BoxHrTimerHandle {
|
||||
inner,
|
||||
_p: core::marker::PhantomData,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, A> RawHrTimerCallback for Pin<Box<T, A>>
|
||||
where
|
||||
T: 'static,
|
||||
T: HasHrTimer<T>,
|
||||
T: for<'a> HrTimerCallback<Pointer<'a> = Pin<Box<T, A>>>,
|
||||
A: crate::alloc::Allocator,
|
||||
{
|
||||
type CallbackTarget<'a> = Pin<&'a mut T>;
|
||||
|
||||
unsafe extern "C" fn run(ptr: *mut bindings::hrtimer) -> bindings::hrtimer_restart {
|
||||
// `HrTimer` is `repr(C)`
|
||||
let timer_ptr = ptr.cast::<super::HrTimer<T>>();
|
||||
|
||||
// SAFETY: By C API contract `ptr` is the pointer we passed when
|
||||
// queuing the timer, so it is a `HrTimer<T>` embedded in a `T`.
|
||||
let data_ptr = unsafe { T::timer_container_of(timer_ptr) };
|
||||
|
||||
// SAFETY:
|
||||
// - As per the safety requirements of the trait `HrTimerHandle`, the
|
||||
// `BoxHrTimerHandle` associated with this timer is guaranteed to
|
||||
// be alive until this method returns. That handle owns the `T`
|
||||
// behind `data_ptr` thus guaranteeing the validity of
|
||||
// the reference created below.
|
||||
// - As `data_ptr` comes from a `Pin<Box<T>>`, only pinned references to
|
||||
// `data_ptr` exist.
|
||||
let data_mut_ref = unsafe { Pin::new_unchecked(&mut *data_ptr) };
|
||||
|
||||
T::run(data_mut_ref).into_c()
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user