Received-SPF: pass (google.com: domain of linux-kernel+bounces-119566-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Date: Tue, 26 Mar 2024 17:13:38 +0000
To: Boqun Feng <boqun.feng@gmail.com>
From: Benno Lossin <benno.lossin@proton.me>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Thomas Gleixner <tglx@linutronix.de>, Alice Ryhl <aliceryhl@google.com>, Miguel Ojeda <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>, Wedson Almeida Filho <wedsonaf@gmail.com>, Gary Guo <gary@garyguo.net>, =?utf-8?Q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>, Andreas Hindborg <a.hindborg@samsung.com>, John Stultz <jstultz@google.com>, Stephen Boyd <sboyd@kernel.org>, Valentin Obst <kernel@valentinobst.de>, Heghedus Razvan <heghedus.razvan@protonmail.com>, Asahi Lina <lina@asahilina.net>
Subject: Re: [PATCH 5/5] rust: time: Add Instant::elapsed() for monotonic clocks
Message-ID: <kZmwObXVcyEJFVR3I05Nab0WdjcccDVARoOm6U9EmXhd89fxYRjvNmEAUZsueWTUlBlHp8jpU3i2YfgN9aWCLZameta0tPT_OgQdBOWUIko=@proton.me>
In-Reply-To: <20240324223339.971934-6-boqun.feng@gmail.com>
References: <20240324223339.971934-1-boqun.feng@gmail.com> <20240324223339.971934-6-boqun.feng@gmail.com>
Feedback-ID: 71780778:user:proton
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

On 24.03.24 23:33, Boqun Feng wrote:
> This is a convenient way to do:
>=20
> =09t1 =3D Clock::now();
> =09...
> =09delta =3D  Clock::now() - t1;
>=20
> Hence add it.
>=20
> Co-developed-by: Heghedus Razvan <heghedus.razvan@protonmail.com>
> Signed-off-by: Heghedus Razvan <heghedus.razvan@protonmail.com>
> Co-developed-by: Asahi Lina <lina@asahilina.net>
> Signed-off-by: Asahi Lina <lina@asahilina.net>
> Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
> ---
>  rust/kernel/time.rs | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>=20
> diff --git a/rust/kernel/time.rs b/rust/kernel/time.rs
> index 5cd669cbea01..cd1e45169517 100644
> --- a/rust/kernel/time.rs
> +++ b/rust/kernel/time.rs
> @@ -114,6 +114,31 @@ fn sub(self, other: Self) -> Self::Output {
>      }
>  }
>=20
> +impl<T: Clock + Monotonic> Instant<T> {
> +    /// Returns the time elapsed since this [`Instant`].
> +    ///
> +    /// This provides a convenient way to calculate time elapsed since a=
 previous [`Clock::now`].
> +    /// Note even though the function only exists for monotonic clocks, =
it could still return
> +    /// negative [`Duration`] if the current time is earlier than the ti=
me of `&self`, and this
> +    /// could happen if `&self` is a timestamp generated by a [`Instant`=
] + [`Duration`].

But there currently is no way to add an `Instant<T>` to a `Duration`.

> +    ///
> +    /// But for typical usages, it should always return non-negative [`D=
uration`]:
> +    ///
> +    /// # Examples
> +    ///
> +    /// ```
> +    /// use kernel::time::{Clock, clock::KernelTime};
> +    ///
> +    /// let ts =3D KernelTime::now();
> +    ///
> +    /// // `KernelTime` is monotonic.
> +    /// assert!(ts.elapsed().to_ns() >=3D 0);

Now that I thought a bit more about the design, I think allowing
negative durations is a bad idea.
Do you disagree?

If there is a case where you have a non-monotonic clock, or you are not
sure if two timestamps are in the correct relation, we could have a
function that returns a `Option<Duration>` or `Result<Duration>`.

--=20
Cheers,
Benno

> +    /// ```
> +    pub fn elapsed(&self) -> Duration {
> +        T::now() - *self
> +    }
> +}
> +
>  /// Contains the various clock source types available to the kernel.
>  pub mod clock {
>      use super::*;
> --
> 2.44.0
>