mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-03-22 07:27:12 +08:00
rust: time: Add wrapper for fsleep() function
Add a wrapper for fsleep(), flexible sleep functions in include/linux/delay.h which typically deals with hardware delays. The kernel supports several sleep functions to handle various lengths of delay. This adds fsleep(), automatically chooses the best sleep method based on a duration. fsleep() can only be used in a nonatomic context. This requirement is not checked by these abstractions, but it is intended that klint [1] or a similar tool will be used to check it in the future. Link: https://rust-for-linux.com/klint [1] Reviewed-by: Gary Guo <gary@garyguo.net> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Fiona Behrens <me@kloenk.dev> Tested-by: Daniel Almeida <daniel.almeida@collabora.com> Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org> Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com> Link: https://lore.kernel.org/r/20250617144155.3903431-3-fujita.tomonori@gmail.com Signed-off-by: Andreas Hindborg <a.hindborg@kernel.org>
This commit is contained in:
committed by
Andreas Hindborg
parent
fc38b7ff87
commit
d4b29ddf82
@@ -1,8 +1,14 @@
|
||||
// SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
#include <linux/delay.h>
|
||||
#include <linux/ktime.h>
|
||||
#include <linux/timekeeping.h>
|
||||
|
||||
void rust_helper_fsleep(unsigned long usecs)
|
||||
{
|
||||
fsleep(usecs);
|
||||
}
|
||||
|
||||
ktime_t rust_helper_ktime_get_real(void)
|
||||
{
|
||||
return ktime_get_real();
|
||||
|
||||
@@ -26,6 +26,7 @@
|
||||
|
||||
use core::marker::PhantomData;
|
||||
|
||||
pub mod delay;
|
||||
pub mod hrtimer;
|
||||
|
||||
/// The number of nanoseconds per microsecond.
|
||||
|
||||
49
rust/kernel/time/delay.rs
Normal file
49
rust/kernel/time/delay.rs
Normal file
@@ -0,0 +1,49 @@
|
||||
// SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
//! Delay and sleep primitives.
|
||||
//!
|
||||
//! This module contains the kernel APIs related to delay and sleep that
|
||||
//! have been ported or wrapped for usage by Rust code in the kernel.
|
||||
//!
|
||||
//! C header: [`include/linux/delay.h`](srctree/include/linux/delay.h).
|
||||
|
||||
use super::Delta;
|
||||
use crate::prelude::*;
|
||||
|
||||
/// Sleeps for a given duration at least.
|
||||
///
|
||||
/// Equivalent to the C side [`fsleep()`], flexible sleep function,
|
||||
/// which automatically chooses the best sleep method based on a duration.
|
||||
///
|
||||
/// `delta` must be within `[0, i32::MAX]` microseconds;
|
||||
/// otherwise, it is erroneous behavior. That is, it is considered a bug
|
||||
/// to call this function with an out-of-range value, in which case the function
|
||||
/// will sleep for at least the maximum value in the range and may warn
|
||||
/// in the future.
|
||||
///
|
||||
/// The behavior above differs from the C side [`fsleep()`] for which out-of-range
|
||||
/// values mean "infinite timeout" instead.
|
||||
///
|
||||
/// This function can only be used in a nonatomic context.
|
||||
///
|
||||
/// [`fsleep()`]: https://docs.kernel.org/timers/delay_sleep_functions.html#c.fsleep
|
||||
pub fn fsleep(delta: Delta) {
|
||||
// The maximum value is set to `i32::MAX` microseconds to prevent integer
|
||||
// overflow inside fsleep, which could lead to unintentional infinite sleep.
|
||||
const MAX_DELTA: Delta = Delta::from_micros(i32::MAX as i64);
|
||||
|
||||
let delta = if (Delta::ZERO..=MAX_DELTA).contains(&delta) {
|
||||
delta
|
||||
} else {
|
||||
// TODO: Add WARN_ONCE() when it's supported.
|
||||
MAX_DELTA
|
||||
};
|
||||
|
||||
// SAFETY: It is always safe to call `fsleep()` with any duration.
|
||||
unsafe {
|
||||
// Convert the duration to microseconds and round up to preserve
|
||||
// the guarantee; `fsleep()` sleeps for at least the provided duration,
|
||||
// but that it may sleep for longer under some circumstances.
|
||||
bindings::fsleep(delta.as_micros_ceil() as c_ulong)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user