Commit cc6d1098 authored by FUJITA Tomonori's avatar FUJITA Tomonori Committed by Andreas Hindborg
Browse files

rust: time: Add ktime_get() to ClockSource trait 



Introduce the ktime_get() associated function to the ClockSource
trait, allowing each clock source to specify how it retrieves the
current time. This enables Instant::now() to be implemented
generically using the type-level ClockSource abstraction.

This change enhances the type safety and extensibility of timekeeping
by statically associating time retrieval mechanisms with their
respective clock types. It also reduces the reliance on hardcoded
clock logic within Instant.

Signed-off-by: default avatarFUJITA Tomonori <fujita.tomonori@gmail.com>
Link: https://lore.kernel.org/r/20250610093258.3435874-4-fujita.tomonori@gmail.com


Signed-off-by: default avatarAndreas Hindborg <a.hindborg@kernel.org>
parent 768dfbfc

rust/helpers/time.c

+16 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0



#include <linux/ktime.h>

#include <linux/timekeeping.h>



ktime_t rust_helper_ktime_get_real(void)

{

	return ktime_get_real();

}



ktime_t rust_helper_ktime_get_boottime(void)

{

	return ktime_get_boottime();

}



ktime_t rust_helper_ktime_get_clocktai(void)

{

	return ktime_get_clocktai();

}



s64 rust_helper_ktime_to_us(const ktime_t kt)

{

rust/kernel/time.rs

+28 −4
Original line number Diff line number Diff line
@@ -63,6 +63,11 @@ pub trait ClockSource { 
    ///

    /// This constant corresponds to the C side `clockid_t` value.

    const ID: bindings::clockid_t;



    /// Get the current time from the clock source.

    ///

    /// The function must return a value in the range from 0 to `KTIME_MAX`.

    fn ktime_get() -> bindings::ktime_t;

}



/// A monotonically increasing clock.
@@ -80,6 +85,11 @@ pub trait ClockSource { 


impl ClockSource for Monotonic {

    const ID: bindings::clockid_t = bindings::CLOCK_MONOTONIC as bindings::clockid_t;



    fn ktime_get() -> bindings::ktime_t {

        // SAFETY: It is always safe to call `ktime_get()` outside of NMI context.

        unsafe { bindings::ktime_get() }

    }

}



/// A settable system-wide clock that measures real (i.e., wall-clock) time.
@@ -100,6 +110,11 @@ impl ClockSource for Monotonic { 


impl ClockSource for RealTime {

    const ID: bindings::clockid_t = bindings::CLOCK_REALTIME as bindings::clockid_t;



    fn ktime_get() -> bindings::ktime_t {

        // SAFETY: It is always safe to call `ktime_get_real()` outside of NMI context.

        unsafe { bindings::ktime_get_real() }

    }

}



/// A monotonic that ticks while system is suspended.
@@ -113,6 +128,11 @@ impl ClockSource for RealTime { 


impl ClockSource for BootTime {

    const ID: bindings::clockid_t = bindings::CLOCK_BOOTTIME as bindings::clockid_t;



    fn ktime_get() -> bindings::ktime_t {

        // SAFETY: It is always safe to call `ktime_get_boottime()` outside of NMI context.

        unsafe { bindings::ktime_get_boottime() }

    }

}



/// International Atomic Time.
@@ -130,6 +150,11 @@ impl ClockSource for BootTime { 


impl ClockSource for Tai {

    const ID: bindings::clockid_t = bindings::CLOCK_TAI as bindings::clockid_t;



    fn ktime_get() -> bindings::ktime_t {

        // SAFETY: It is always safe to call `ktime_get_tai()` outside of NMI context.

        unsafe { bindings::ktime_get_clocktai() }

    }

}



/// A specific point in time.
@@ -153,14 +178,13 @@ fn clone(&self) -> Self { 
impl<C: ClockSource> Copy for Instant<C> {}



impl<C: ClockSource> Instant<C> {

    /// Get the current time using `CLOCK_MONOTONIC`.

    /// Get the current time from the clock source.

    #[inline]

    pub fn now() -> Self {

        // INVARIANT: The `ktime_get()` function returns a value in the range

        // INVARIANT: The `ClockSource::ktime_get()` function returns a value in the range

        // from 0 to `KTIME_MAX`.

        Self {

            // SAFETY: It is always safe to call `ktime_get()` outside of NMI context.

            inner: unsafe { bindings::ktime_get() },

            inner: C::ktime_get(),

            _c: PhantomData,

        }

    }