Skip to content

Use MonotonicTime as Instant shifted by 10 years forward #2322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lightning/src/ln/outbound_payment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ impl Retry {
},
#[cfg(all(not(feature = "no-std"), not(test)))]
(Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
*max_duration >= std::time::Instant::now().duration_since(*first_attempted_at),
*max_duration >= crate::util::time::MonotonicTime::now().duration_since(*first_attempted_at),
#[cfg(all(not(feature = "no-std"), test))]
(Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
*max_duration >= SinceEpoch::now().duration_since(*first_attempted_at),
Expand Down Expand Up @@ -274,7 +274,7 @@ pub(crate) struct PaymentAttemptsUsingTime<T: Time> {
}

#[cfg(not(any(feature = "no-std", test)))]
type ConfiguredTime = std::time::Instant;
type ConfiguredTime = crate::util::time::MonotonicTime;
#[cfg(feature = "no-std")]
type ConfiguredTime = crate::util::time::Eternity;
#[cfg(all(not(feature = "no-std"), test))]
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/routing/scoring.rs
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ impl ReadableArgs<u64> for FixedPenaltyScorer {
}

#[cfg(not(feature = "no-std"))]
type ConfiguredTime = std::time::Instant;
type ConfiguredTime = crate::util::time::MonotonicTime;
#[cfg(feature = "no-std")]
use crate::util::time::Eternity;
#[cfg(feature = "no-std")]
Expand Down
40 changes: 36 additions & 4 deletions lightning/src/util/time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,20 @@ impl Sub<Duration> for Eternity {
}
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg(not(feature = "no-std"))]
pub struct MonotonicTime(std::time::Instant);

/// The amount of time to shift `Instant` forward to prevent overflow when subtracting a `Duration`
/// from `Instant::now` on some operating systems (e.g., iOS representing `Instance` as `u64`).
#[cfg(not(feature = "no-std"))]
const SHIFT: Duration = Duration::from_secs(10 * 365 * 24 * 60 * 60); // 10 years.

#[cfg(not(feature = "no-std"))]
impl Time for std::time::Instant {
impl Time for MonotonicTime {
fn now() -> Self {
std::time::Instant::now()
let instant = std::time::Instant::now().checked_add(SHIFT).expect("Overflow on MonotonicTime instantiation");
Self(instant)
}

fn duration_since(&self, earlier: Self) -> Duration {
Expand All @@ -70,15 +80,26 @@ impl Time for std::time::Instant {
// clocks" that go backwards in practice (likely relatively ancient kernels/etc). Thus, we
// manually check for time going backwards here and return a duration of zero in that case.
let now = Self::now();
if now > earlier { now - earlier } else { Duration::from_secs(0) }
if now.0 > earlier.0 { now.0 - earlier.0 } else { Duration::from_secs(0) }
}

fn duration_since_epoch() -> Duration {
use std::time::SystemTime;
SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap()
}

fn elapsed(&self) -> Duration {
std::time::Instant::elapsed(self)
Self::now().0 - self.0
}
}

#[cfg(not(feature = "no-std"))]
impl Sub<Duration> for MonotonicTime {
type Output = Self;

fn sub(self, other: Duration) -> Self {
let instant = self.0.checked_sub(other).expect("MonotonicTime is not supposed to go backward futher than 10 years");
Self(instant)
}
}

Expand Down Expand Up @@ -154,4 +175,15 @@ pub mod tests {
assert_eq!(now.elapsed(), Duration::from_secs(0));
assert_eq!(later - elapsed, now);
}

#[test]
#[cfg(not(feature = "no-std"))]
fn monotonic_time_subtracts() {
let now = super::MonotonicTime::now();
assert!(now.elapsed() < Duration::from_secs(10));

let ten_years = Duration::from_secs(10 * 365 * 24 * 60 * 60);
let past = now - ten_years;
assert!(past.elapsed() >= ten_years);
}
}