Skip to content

Commit

Permalink
Ban uses of Instant operations that can panic (#1456)
Browse files Browse the repository at this point in the history
When comparing instances, we should use saturating varieties to help
ensure that we can't hit panics.

This change bans uses of `std::time::Instant::{duration_since, elapsed,
sub}` via clippy. Uses are ported to using `Instant::saturating_duration_since`.

Related to linkerd/linkerd2#7748

Signed-off-by: Oliver Gould <ver@buoyant.io>
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
  • Loading branch information
olix0r and hawkw authored Feb 1, 2022
1 parent d9dbdec commit bffdb1a
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 15 deletions.
7 changes: 6 additions & 1 deletion .clippy.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,9 @@ disallowed-methods = [
# see https://github.com/rust-lang/rust/issues/90308 for details.
"std::env::set_var",
"std::env::remove_var",
]

# Avoid instances of https://github.com/rust-lang/rust/issues/86470
"std::time::Instant::duration_since",
"std::time::Instant::elapsed",
# Clippy doesn't let us ban std::time::Instant::sub, but it knows what it did.
]
2 changes: 1 addition & 1 deletion linkerd/app/integration/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ macro_rules! assert_eventually {
} else if i == $retries {
panic!(
"assertion failed after {} (retried {} times): {}",
crate::HumanDuration(start_t.elapsed()),
crate::HumanDuration(Instant::now().saturating_duration_since(start_t)),
i,
format_args!($($arg)+)
)
Expand Down
2 changes: 1 addition & 1 deletion linkerd/app/integration/src/metrics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ impl MetricMatch {
"{}\n retried {} times ({:?})",
e,
MAX_RETRIES,
start_t.elapsed()
Instant::now().saturating_duration_since(start_t)
),
Err(_) => {
tracing::trace!("waiting...");
Expand Down
2 changes: 1 addition & 1 deletion linkerd/detect/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ where
let mut buf = BytesMut::with_capacity(capacity);
let detected = match time::timeout(timeout, detect.detect(&mut io, &mut buf)).await {
Ok(Ok(protocol)) => {
debug!(?protocol, elapsed = ?t0.elapsed(), "DetectResult");
debug!(?protocol, elapsed = ?time::Instant::now().saturating_duration_since(t0), "DetectResult");
Ok(protocol)
}
Err(_) => Err(DetectTimeoutError(timeout, std::marker::PhantomData)),
Expand Down
2 changes: 1 addition & 1 deletion linkerd/http-access-log/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ where

let response: http::Response<B2> = match this.inner.try_poll(cx) {
Poll::Pending => {
data.processing += Instant::now().duration_since(poll_start);
data.processing += Instant::now().saturating_duration_since(poll_start);
return Poll::Pending;
}
Poll::Ready(Err(e)) => return Poll::Ready(Err(e)),
Expand Down
3 changes: 2 additions & 1 deletion linkerd/http-metrics/src/requests/service.rs
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,8 @@ where
.entry(Some(*this.status))
.or_insert_with(StatusMetrics::default);

status_metrics.latency.add(now - *this.stream_open_at);
let elapsed = now.saturating_duration_since(*this.stream_open_at);
status_metrics.latency.add(elapsed);

*this.latency_recorded = true;
}
Expand Down
14 changes: 9 additions & 5 deletions linkerd/proxy/tap/src/grpc/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -364,10 +364,10 @@ impl iface::TapResponse for TapResponse {
} else {
None
};

let since_request_init = response_init_at.saturating_duration_since(self.request_init_at);
let init = api::tap_event::http::Event::ResponseInit(api::tap_event::http::ResponseInit {
id: Some(self.tap.id.clone()),
since_request_init: Some((response_init_at - self.request_init_at).into()),
since_request_init: Some(since_request_init.into()),
http_status: rsp.status().as_u16().into(),
headers,
});
Expand Down Expand Up @@ -398,9 +398,10 @@ impl iface::TapResponse for TapResponse {
fn fail<E: HasH2Reason>(self, err: &E) {
let response_end_at = Instant::now();
let reason = err.h2_reason();
let since_request_init = response_end_at.saturating_duration_since(self.request_init_at);
let end = api::tap_event::http::Event::ResponseEnd(api::tap_event::http::ResponseEnd {
id: Some(self.tap.id.clone()),
since_request_init: Some((response_end_at - self.request_init_at).into()),
since_request_init: Some(since_request_init.into()),
since_response_init: None,
response_bytes: 0,
eos: Some(api::Eos {
Expand Down Expand Up @@ -464,10 +465,13 @@ impl TapResponsePayload {
} else {
None
};

let since_request_init = response_end_at.saturating_duration_since(self.request_init_at);
let since_response_init = response_end_at.saturating_duration_since(self.response_init_at);
let end = api::tap_event::http::ResponseEnd {
id: Some(self.tap.id),
since_request_init: Some((response_end_at - self.request_init_at).into()),
since_response_init: Some((response_end_at - self.response_init_at).into()),
since_request_init: Some(since_request_init.into()),
since_response_init: Some(since_response_init.into()),
response_bytes: self.response_bytes as u64,
eos: Some(api::Eos { end }),
trailers,
Expand Down
6 changes: 3 additions & 3 deletions linkerd/stack/metrics/src/service.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ where
// updated even when we're "stuck" in pending.
let now = Instant::now();
if let Some(t0) = self.blocked_since.take() {
let not_ready = now - t0;
let not_ready = now.saturating_duration_since(t0);
self.metrics.poll_millis.add(not_ready.as_millis() as u64);
}
self.blocked_since = Some(now);
Expand All @@ -48,15 +48,15 @@ where
Poll::Ready(Ok(())) => {
self.metrics.ready_total.incr();
if let Some(t0) = self.blocked_since.take() {
let not_ready = Instant::now() - t0;
let not_ready = Instant::now().saturating_duration_since(t0);
self.metrics.poll_millis.add(not_ready.as_millis() as u64);
}
Poll::Ready(Ok(()))
}
Poll::Ready(Err(e)) => {
self.metrics.error_total.incr();
if let Some(t0) = self.blocked_since.take() {
let not_ready = Instant::now() - t0;
let not_ready = Instant::now().saturating_duration_since(t0);
self.metrics.poll_millis.add(not_ready.as_millis() as u64);
}
Poll::Ready(Err(e))
Expand Down
2 changes: 1 addition & 1 deletion linkerd/tracing/src/uptime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ impl Uptime {

impl FormatTime for Uptime {
fn format_time(&self, w: &mut format::Writer<'_>) -> fmt::Result {
Self::format(Instant::now() - self.start_time, w)
Self::format(Instant::now().saturating_duration_since(self.start_time), w)
}
}

Expand Down

0 comments on commit bffdb1a

Please sign in to comment.