Overhaul and reuse workspace-wide Rust lints

Overhaul the set of Rust lints in use and make them apply in a
workspace-wide manner. Fix everything new that is being flagged.

Signed-off-by: Daniel Müller <[email protected]>

Author: d-e-s-o

.clippy.toml

@@ -0,0 +1,16 @@
+# For general information about this file, check
+# https://doc.rust-lang.org/stable/clippy/configuration.html
+
+doc-valid-idents = [
+  "Host1X",
+  "HugeTLB",
+  "InfiniBand",
+  "JITed",
+  "NetFilter",
+  "QLogic",
+  "RxRPC",
+  "SMBus",
+  "SunRPC",
+  "Video4Linux2",
+  "..",
+]

.github/workflows/test.yml

@@ -111,10 +111,10 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - name: Build libbpf-rs sample
         run: |
-          cargo init --bin libbpf-rs-test-project
-          cd libbpf-rs-test-project
+          cargo init --bin ../libbpf-rs-test-project
+          cd ../libbpf-rs-test-project
           cat >> Cargo.toml <<EOF
-          libbpf-rs = { path = "../libbpf-rs", ${{ matrix.args }} }
+          libbpf-rs = { path = "../libbpf-rs/libbpf-rs", ${{ matrix.args }} }
           EOF
           cat > src/main.rs <<EOF
           fn main() {
@@ -237,7 +237,7 @@ jobs:
           # We want the old resolver here as it has more suitable feature
           # unification logic for this invocation.
           sed -i 's@resolver = "2"@resolver = "1"@' Cargo.toml
-          cargo clippy --locked --no-deps --all-targets --tests --features=dont-generate-test-files -- -D warnings -D clippy::absolute_paths
+          cargo clippy --locked --no-deps --all-targets --tests --features=dont-generate-test-files -- -D warnings
 
   rustfmt:
     name: Check code formatting

Cargo.toml

@@ -22,3 +22,34 @@ members = [
   "examples/tproxy",
 ]
 resolver = "2"
+
+[workspace.lints.rust]
+deprecated-safe = "warn"
+future-incompatible = "warn"
+keyword-idents = "warn"
+let-underscore = "warn"
+missing-debug-implementations = "warn"
+missing-docs = "warn"
+trivial-numeric-casts = "warn"
+unexpected_cfgs = {level = "warn", check-cfg = ['cfg(has_procmap_query_ioctl)', 'cfg(has_large_test_files)']}
+unsafe-op-in-unsafe-fn = "warn"
+unused = "warn"
+
+[workspace.lints.clippy]
+collapsible-else-if = "allow"
+collapsible-if = "allow"
+fn-to-numeric-cast = "allow"
+let-and-return = "allow"
+let-unit-value = "allow"
+module-inception = "allow"
+type-complexity = "allow"
+absolute-paths = "warn"
+clone-on-ref-ptr = "warn"
+dbg-macro = "warn"
+doc-markdown = "warn"
+join-absolute-paths = "warn"
+large-enum-variant = "warn"
+redundant-closure-for-method-calls = "warn"
+unchecked-duration-subtraction = "warn"
+uninlined-format-args = "warn"
+wildcard-imports = "warn"

examples/bpf_query/Cargo.toml

@@ -12,3 +12,6 @@ clap = { version = "4.0.32", default-features = false, features = ["std", "deriv
 
 [target.'cfg(target_arch = "x86_64")'.dependencies]
 iced-x86 = "1.20.0"
+
+[lints]
+workspace = true

examples/bpf_query/src/main.rs

@@ -1,3 +1,5 @@
+//! Example illustrating how to query certain BPF information.
+
 use std::process::exit;
 
 use clap::Parser;
@@ -46,7 +48,7 @@ fn prog(args: ProgArgs) {
                     let insn = d.decode();
                     let mut f_insn = String::new();
                     f.format(&insn, &mut f_insn);
-                    println!("  {}: {}", ip, f_insn);
+                    println!("  {ip}: {f_insn}");
                 }
             }
 

examples/capable/Cargo.toml

@@ -20,3 +20,6 @@ clap = { version = "4.0.32", default-features = false, features = ["std", "deriv
 
 [features]
 static = ["libbpf-rs/static"]
+
+[lints]
+workspace = true

examples/capable/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `capable` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/capable/src/main.rs

@@ -3,6 +3,9 @@
 // Author Devasia Thomas <https://www.linkedin.com/in/devasiathomas/>
 //
 // Based on capable(8) by Brendan Gregg
+
+//! Example showing basic functionality of capable(8).
+
 use core::time::Duration;
 use std::mem::MaybeUninit;
 use std::str;
@@ -27,7 +30,7 @@ mod capable {
 }
 
 use capable::types::uniqueness;
-use capable::*;
+use capable::CapableSkelBuilder;
 
 static CAPS: phf::Map<i32, &'static str> = phf_map! {
     0i32 => "CAP_CHOWN",

examples/netfilter_blocklist/Cargo.toml

@@ -17,3 +17,6 @@ clap = { version = "4.0.32", default-features = false, features = ["std", "deriv
 ctrlc = "3.2"
 libbpf-rs = { path = "../../libbpf-rs" }
 plain = "0.2"
+
+[lints]
+workspace = true

examples/netfilter_blocklist/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `netfilter_blocklist` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/netfilter_blocklist/src/main.rs

@@ -1,3 +1,5 @@
+//! A NetFilter blocklist example.
+
 use std::mem::MaybeUninit;
 use std::net::Ipv4Addr;
 use std::str::FromStr;
@@ -26,6 +28,7 @@ mod netfilter {
     ));
 }
 
+#[allow(clippy::wildcard_imports)]
 use netfilter::*;
 
 /// Netfilter Blocklist Example
@@ -51,7 +54,7 @@ fn main() -> Result<()> {
 
     // Install Ctrl-C handler
     let running = Arc::new(AtomicBool::new(true));
-    let r = running.clone();
+    let r = Arc::clone(&running);
     ctrlc::set_handler(move || {
         r.store(false, Ordering::SeqCst);
     })?;

examples/ringbuf_multi/Cargo.toml

@@ -13,3 +13,6 @@ vmlinux = { git = "https://github.com/libbpf/vmlinux.h.git", rev = "83a228cf37fc
 libbpf-rs = { path = "../../libbpf-rs" }
 libc = "0.2"
 plain = "0.2"
+
+[lints]
+workspace = true

examples/ringbuf_multi/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `ringbuf_multi` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/ringbuf_multi/src/main.rs

@@ -1,5 +1,7 @@
 // SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
 
+//! Example illustrating `BPF_MAP_TYPE_ARRAY_OF_MAPS` usage.
+
 use core::time::Duration;
 use std::ffi::c_int;
 use std::mem::MaybeUninit;
@@ -18,6 +20,7 @@ mod ringbuf_multi {
     ));
 }
 
+#[allow(clippy::wildcard_imports)]
 use ringbuf_multi::*;
 
 unsafe impl Plain for types::sample {}

examples/runqslower/Cargo.toml

@@ -16,3 +16,6 @@ libc = "0.2"
 plain = "0.2"
 time = { version = "0.3", features = ["formatting", "local-offset", "macros"]}
 clap = { version = "4.0.32", default-features = false, features = ["std", "derive", "help", "usage"] }
+
+[lints]
+workspace = true

examples/runqslower/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `runqslower` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/runqslower/src/main.rs

@@ -1,5 +1,7 @@
 // SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
 
+//! An example illustrating how to trace run queue latency using BPF.
+
 use std::mem::MaybeUninit;
 use std::str;
 use std::time::Duration;
@@ -21,6 +23,7 @@ mod runqslower {
     ));
 }
 
+#[allow(clippy::wildcard_imports)]
 use runqslower::*;
 
 /// Trace high run queue latency

examples/tc_port_whitelist/Cargo.toml

@@ -15,3 +15,6 @@ libbpf-rs = { path = "../../libbpf-rs" }
 libc = "0.2"
 nix = { version = "0.28", default-features = false, features = ["net", "user"] }
 clap = { version = "4.0.32", default-features = false, features = ["std", "derive", "help", "usage"] }
+
+[lints]
+workspace = true

examples/tc_port_whitelist/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `rc_port_whitelist` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/tc_port_whitelist/src/main.rs

@@ -1,4 +1,4 @@
-#![allow(clippy::let_unit_value)]
+//! An example showing how to block ports using TC.
 
 use std::mem::MaybeUninit;
 use std::os::unix::io::AsFd as _;
@@ -24,7 +24,7 @@ use nix::net::if_::if_nametoindex;
 mod tc {
     include!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/bpf/tc.skel.rs"));
 }
-use tc::*;
+use tc::TcSkelBuilder;
 
 #[derive(Debug, Parser)]
 struct Command {

examples/tcp_ca/Cargo.toml

@@ -15,3 +15,6 @@ clap = { version = "4.0.32", features = ["derive"] }
 # works with that.
 the-original-libbpf-rs = { path = "../../libbpf-rs", package = "libbpf-rs" }
 libc = "0.2"
+
+[lints]
+workspace = true

examples/tcp_ca/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `runqslower` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/tcp_ca/src/main.rs

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
 
-#![allow(clippy::let_unit_value)]
+//! An example illustrating `struct_opt` usage to change TCP congestion
+//! algorithms.
 
 use std::ffi::c_int;
 use std::ffi::c_void;
@@ -80,7 +81,7 @@ fn set_tcp_ca(fd: BorrowedFd<'_>, tcp_ca: &OsStr) -> Result<()> {
         IPPROTO_TCP,
         TCP_CONGESTION,
         bytes.as_ptr().cast(),
-        bytes.len() as _,
+        bytes.len(),
     )
     .with_context(|| {
         format!(

examples/tcp_option/Cargo.toml

@@ -14,3 +14,6 @@ libbpf-rs = { path = "../../libbpf-rs" }
 clap = { version = "4.0.32", features = ["derive"] }
 libc = "0.2"
 ctrlc = "3.2"
+
+[lints]
+workspace = true

examples/tcp_option/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `tcp_option` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/tcp_option/src/main.rs

@@ -1,3 +1,5 @@
+//! Example illustrating how to modify TCP headers.
+
 use std::mem::MaybeUninit;
 use std::net::Ipv4Addr;
 use std::os::fd::AsFd;
@@ -35,7 +37,7 @@ mod tcp_option {
         "/src/bpf/tcp_option.skel.rs"
     ));
 }
-use tcp_option::*;
+use tcp_option::TcpOptionSkelBuilder;
 
 const SOL_SOCKET: c_int = 1;
 const SO_ATTACH_BPF: c_int = 50;
@@ -70,7 +72,7 @@ fn main() -> Result<()> {
     let opts = Command::parse();
 
     let running = Arc::new(AtomicBool::new(true));
-    let r = running.clone();
+    let r = Arc::clone(&running);
     ctrlc::set_handler(move || {
         r.store(false, Ordering::SeqCst);
     })?;
@@ -110,7 +112,7 @@ fn main() -> Result<()> {
     let prog_fd = skel.progs.socket_handler.as_fd();
     match unsafe {
         libc::setsockopt(
-            target_socket_fd as c_int,
+            target_socket_fd,
             SOL_SOCKET,
             SO_ATTACH_BPF,
             &prog_fd as *const _ as *const c_void,

examples/tproxy/Cargo.toml

@@ -18,3 +18,6 @@ clap = { version = "4.0.32", default-features = false, features = ["std", "deriv
 ctrlc = "3.2"
 libbpf-rs = { path = "../../libbpf-rs" }
 nix = { version = "0.28", default-features = false, features = ["net", "user"] }
+
+[lints]
+workspace = true

examples/tproxy/build.rs

@@ -1,3 +1,5 @@
+//! Build script for the `tproxy` example.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

examples/tproxy/src/bin/proxy.rs

@@ -1,3 +1,5 @@
+//! A fake proxy.
+
 use std::net::TcpListener;
 use std::net::TcpStream;
 use std::os::unix::io::AsRawFd as _;

examples/tproxy/src/main.rs

@@ -1,3 +1,5 @@
+//! Example implementing the classic iptables TPROXY target.
+
 use std::mem::MaybeUninit;
 use std::net::Ipv4Addr;
 use std::os::unix::io::AsFd as _;
@@ -23,7 +25,7 @@ mod tproxy {
     ));
 }
 
-use tproxy::*;
+use tproxy::TproxySkelBuilder;
 
 /// Transparent proxy driver
 ///
@@ -53,7 +55,7 @@ fn main() -> Result<()> {
 
     // Install Ctrl-C handler
     let running = Arc::new(AtomicBool::new(true));
-    let r = running.clone();
+    let r = Arc::clone(&running);
     ctrlc::set_handler(move || {
         r.store(false, Ordering::SeqCst);
     })?;

libbpf-cargo/Cargo.toml

@@ -45,3 +45,6 @@ clap = { version = "4.0.32", features = ["derive"] }
 goblin = "0.9"
 test-log = { version = "0.2.16", default-features = false, features = ["log"] }
 vmlinux = { git = "https://github.com/libbpf/vmlinux.h.git", rev = "83a228cf37fc65f2d14e4896a04922b5ee531a94" }
+
+[lints]
+workspace = true

libbpf-cargo/src/build.rs

@@ -62,8 +62,9 @@ impl BpfObjBuilder {
     }
 
     /// We're essentially going to run:
-    ///
-    ///   clang -g -O2 -target bpf -c -D__TARGET_ARCH_$(ARCH) runqslower.bpf.c -o runqslower.bpf.o
+    /// ```text
+    /// clang -g -O2 -target bpf -c -D__TARGET_ARCH_$(ARCH) runqslower.bpf.c -o runqslower.bpf.o
+    /// ```
     ///
     /// for each prog.
     fn compile_single(
@@ -297,6 +298,8 @@ fn extract_clang_or_default(clang: Option<&Path>) -> PathBuf {
     }
 }
 
+/// Build the project, assuming necessary skeleton files have already
+/// been generated.
 pub fn build_project(
     manifest_path: Option<&Path>,
     clang: Option<&Path>,