linux-kernel - [PATCH 5/5] rust: time: Add Instant::elapsed() for monotonic clocks

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240324223339.971934-6-boqun.feng@gmail.com>
Date: Sun, 24 Mar 2024 15:33:39 -0700
From: Boqun Feng <boqun.feng@...il.com>
To: rust-for-linux@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Thomas Gleixner <tglx@...utronix.de>
Cc: Alice Ryhl <aliceryhl@...gle.com>,
	Miguel Ojeda <ojeda@...nel.org>,
	Alex Gaynor <alex.gaynor@...il.com>,
	Wedson Almeida Filho <wedsonaf@...il.com>,
	Boqun Feng <boqun.feng@...il.com>,
	Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	benno.lossin@...ton.me,
	Andreas Hindborg <a.hindborg@...sung.com>,
	John Stultz <jstultz@...gle.com>,
	Stephen Boyd <sboyd@...nel.org>,
	Valentin Obst <kernel@...entinobst.de>,
	Heghedus Razvan <heghedus.razvan@...tonmail.com>,
	Asahi Lina <lina@...hilina.net>
Subject: [PATCH 5/5] rust: time: Add Instant::elapsed() for monotonic clocks

This is a convenient way to do:

	t1 = Clock::now();
	...
	delta =  Clock::now() - t1;

Hence add it.

Co-developed-by: Heghedus Razvan <heghedus.razvan@...tonmail.com>
Signed-off-by: Heghedus Razvan <heghedus.razvan@...tonmail.com>
Co-developed-by: Asahi Lina <lina@...hilina.net>
Signed-off-by: Asahi Lina <lina@...hilina.net>
Signed-off-by: Boqun Feng <boqun.feng@...il.com>
---
 rust/kernel/time.rs | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

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 {
     }
 }
 
+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 time of `&self`, and this
+    /// could happen if `&self` is a timestamp generated by a [`Instant`] + [`Duration`].
+    ///
+    /// But for typical usages, it should always return non-negative [`Duration`]:
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use kernel::time::{Clock, clock::KernelTime};
+    ///
+    /// let ts = KernelTime::now();
+    ///
+    /// // `KernelTime` is monotonic.
+    /// assert!(ts.elapsed().to_ns() >= 0);
+    /// ```
+    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