Skip to content

Commit 8aa474e

Browse files
olix0rolix0r
authored
clippy: Disallow lock and instant types from std (#1458)
We use `parking_lot` locks throughout our code. This change disallows the introduction of std::sync's locks. This change also enforces the use of `tokio::time::Instant`, which allows for a mockable time source in tests. Signed-off-by: Oliver Gould <ver@buoyant.io>
1 parent bffdb1a commit 8aa474e

File tree

89 files changed

+514
-210
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+514
-210
lines changed

‎.clippy.toml‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
11
type-complexity-threshold = 500
22
disallowed-methods = [
3-
# mutating environment variables in a multi-threaded context can
3+
# Mutating environment variables in a multi-threaded context can
44
# cause data races.
55
# see https://github.com/rust-lang/rust/issues/90308 for details.
66
"std::env::set_var",
77
"std::env::remove_var",
88

9-
# Avoid instances of https://github.com/rust-lang/rust/issues/86470
10-
"std::time::Instant::duration_since",
11-
"std::time::Instant::elapsed",
12-
# Clippy doesn't let us ban std::time::Instant::sub, but it knows what it did.
9+
# Avoid instances of https://github.com/rust-lang/rust/issues/86470 until tokio/tokio#4461 is
10+
# available.
11+
"tokio::time::Instant::duration_since",
12+
"tokio::time::Instant::elapsed",
13+
# Clippy doesn't let us ban tokio::time::Instant::sub, but it knows what it did.
14+
]
15+
disallowed-types = [
16+
# Use parking_lot instead.
17+
"std::sync::Mutex",
18+
"std::sync::RwLock",
19+
20+
# Use tokio::time::Instant instead.
21+
"std::time::Instant",
1322
]

‎Cargo.lock‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -917,6 +917,7 @@ dependencies = [
917917
"linkerd-metrics",
918918
"linkerd-tracing",
919919
"linkerd2-proxy-api",
920+
"parking_lot 0.12.0",
920921
"regex",
921922
"rustls-pemfile",
922923
"socket2 0.4.4",
@@ -968,6 +969,7 @@ dependencies = [
968969
"linkerd-app-core",
969970
"linkerd-identity",
970971
"linkerd-io",
972+
"parking_lot 0.12.0",
971973
"regex",
972974
"thiserror",
973975
"tokio",
@@ -1090,6 +1092,7 @@ dependencies = [
10901092
"linkerd-tls",
10911093
"linkerd-tracing",
10921094
"pin-project",
1095+
"tokio",
10931096
"tracing",
10941097
]
10951098

@@ -1131,6 +1134,7 @@ dependencies = [
11311134
"linkerd-stack",
11321135
"parking_lot 0.12.0",
11331136
"pin-project",
1137+
"tokio",
11341138
"tower",
11351139
"tracing",
11361140
]
@@ -1529,6 +1533,7 @@ dependencies = [
15291533
"futures",
15301534
"linkerd-error",
15311535
"linkerd-tracing",
1536+
"parking_lot 0.12.0",
15321537
"pin-project",
15331538
"thiserror",
15341539
"tokio",
@@ -1669,6 +1674,7 @@ dependencies = [
16691674
"linkerd-stack",
16701675
"parking_lot 0.12.0",
16711676
"pin-project",
1677+
"tokio",
16721678
"tracing",
16731679
]
16741680

‎hyper-balance/src/lib.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
#![deny(warnings, rust_2018_idioms, clippy::disallowed_method)]
1+
#![deny(
2+
warnings,
3+
rust_2018_idioms,
4+
clippy::disallowed_method,
5+
clippy::disallowed_type
6+
)]
27
#![forbid(unsafe_code)]
38

49
use hyper::body::HttpBody;

‎linkerd/addr/src/lib.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
#![deny(warnings, rust_2018_idioms, clippy::disallowed_method)]
1+
#![deny(
2+
warnings,
3+
rust_2018_idioms,
4+
clippy::disallowed_method,
5+
clippy::disallowed_type
6+
)]
27
#![forbid(unsafe_code)]
38
use linkerd_dns_name::Name;
49
use std::{

‎linkerd/app/admin/src/lib.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
#![deny(warnings, rust_2018_idioms, clippy::disallowed_method)]
1+
#![deny(
2+
warnings,
3+
rust_2018_idioms,
4+
clippy::disallowed_method,
5+
clippy::disallowed_type
6+
)]
27
#![forbid(unsafe_code)]
38

49
mod server;

‎linkerd/app/core/src/lib.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@
77
//! - Tap
88
//! - Metric labeling
99
10-
#![deny(warnings, rust_2018_idioms, clippy::disallowed_method)]
10+
#![deny(
11+
warnings,
12+
rust_2018_idioms,
13+
clippy::disallowed_method,
14+
clippy::disallowed_type
15+
)]
1116
#![forbid(unsafe_code)]
1217

1318
pub use drain;

‎linkerd/app/gateway/src/lib.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
#![deny(warnings, rust_2018_idioms, clippy::disallowed_method)]
1+
#![deny(
2+
warnings,
3+
rust_2018_idioms,
4+
clippy::disallowed_method,
5+
clippy::disallowed_type
6+
)]
27
#![forbid(unsafe_code)]
38

49
mod gateway;

‎linkerd/app/inbound/src/lib.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,12 @@
33
//! The inbound proxy is responsible for terminating traffic from other network
44
//! endpoints inbound to the local application.
55
6-
#![deny(warnings, rust_2018_idioms, clippy::disallowed_method)]
6+
#![deny(
7+
warnings,
8+
rust_2018_idioms,
9+
clippy::disallowed_method,
10+
clippy::disallowed_type
11+
)]
712
#![forbid(unsafe_code)]
813

914
mod accept;

‎linkerd/app/integration/Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ linkerd-metrics = { path = "../../metrics", features = ["test_util"] }
3131
linkerd2-proxy-api = { version = "0.3", features = ["destination", "arbitrary"] }
3232
linkerd-app-test = { path = "../test" }
3333
linkerd-tracing = { path = "../../tracing" }
34+
parking_lot = "0.12"
3435
regex = "1"
3536
socket2 = "0.4"
3637
tokio = { version = "1", features = ["io-util", "net", "rt", "macros"] }

‎linkerd/app/integration/src/client.rs‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
use super::*;
22
use linkerd_app_core::proxy::http::trace;
3+
use parking_lot::Mutex;
34
use std::io;
4-
use std::{
5-
convert::TryFrom,
6-
sync::{Arc, Mutex},
7-
};
5+
use std::{convert::TryFrom, sync::Arc};
86
use tokio::net::TcpStream;
97
use tokio::sync::{mpsc, oneshot};
108
use tokio::task::JoinHandle;
@@ -315,7 +313,6 @@ impl tower::Service<hyper::Uri> for Conn {
315313
let running = self
316314
.running
317315
.lock()
318-
.unwrap()
319316
.take()
320317
.expect("test client cannot connect twice");
321318
Box::pin(async move {

0 commit comments

Comments
 (0)