ci: Test for unused dependencies

Adds a test for unused cargo dependencies, and removes unused dependencies to satisfy this test. Signed-off-by: Jonathan Woollett-Light <jcawl@amazon.co.uk>
firecracker-microvm · Oct 3, 2023 · 542db3d · 542db3d
1 parent 5326773
commit 542db3d
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 24 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/cpu_templates/boot-protocol.md b/docs/cpu_templates/boot-protocol.md
@@ -28,6 +28,6 @@ and MSR_IA32_MISC_ENABLE is set to `1`.
 
 On aarch64, the following registers are set:
 
-- PSTATE to PSR_MODE_EL1h | PSR_A_BIT | PSR_F_BIT | PSR_I_BIT | PSR_D_BIT
+- PSTATE to `PSR_MODE_EL1h | PSR_A_BIT | PSR_F_BIT | PSR_I_BIT | PSR_D_BIT`
 - PC to kernel load address (vCPU0 only)
 - X0 to DTB/FDT address (vCPU0 only)
diff --git a/docs/network-performance.md b/docs/network-performance.md
@@ -7,11 +7,11 @@ Scope of the measurements is to illustrate the limits for the emulation thread.
 
 ## TCP Throughput
 
-Segment size/ Direction | 1460bytes | 256bytes | 128bytes | 96bytes
---- | --- | --- | --- |---
-Ingress| 25Gbps | 23Gbps | 20Gbps | 18Gbps
-Egress | 25Gbps | 23Gbps | 20Gbps | 18Gbps
-Bidirectional | 18Gbps | 18Gbps | 18Gbps | 18Gbps
+Segment size/ Direction | 1460bytes | 256bytes | 128bytes | 96bytes |
+--- | --- | --- | --- |--- |
+Ingress| 25Gbps | 23Gbps | 20Gbps | 18Gbps |
+Egress | 25Gbps | 23Gbps | 20Gbps | 18Gbps |
+Bidirectional | 18Gbps | 18Gbps | 18Gbps | 18Gbps |
 
 **Setup and test description**
 Throughput measurements were done using [iperf3](https://iperf.fr/). The target

diff --git a/docs/snapshotting/versioning.md b/docs/snapshotting/versioning.md
@@ -71,10 +71,10 @@ A microVM state file is further split into four different fields:
 
 | Field | Bits| Description |
 |----|----|----|
-| magic_id | 64 | Firecracker snapshot, architecture (x86_64/aarch64) and storage version.
-| version  | 16 | The snapshot version number internally mapped 1:1 to a specific Firecracker version.
-| state | N | Bincode blob containing the microVM state.
- | crc| 64 | Optional CRC64 sum of magic_id, version and state fields.
+| magic_id | 64 | Firecracker snapshot, architecture (x86_64/aarch64) and storage version. |
+| version  | 16 | The snapshot version number internally mapped 1:1 to a specific Firecracker version. |
+| state | N | Bincode blob containing the microVM state. |
+| crc| 64 | Optional CRC64 sum of magic_id, version and state fields. |
 
 **Note**: the last 16 bits of `magic_id` encode the storage version which specifies
 the encoding used for the `version` and `state` fields. The current

diff --git a/src/snapshot-editor/Cargo.toml b/src/snapshot-editor/Cargo.toml
@@ -11,11 +11,13 @@ bench = false
 
 [dependencies]
 clap = { version = "4.4.6", features = ["derive", "string"] }
-clap-num = "1.0.2"
 displaydoc = "0.2.4"
 libc = "0.2.148"
 snapshot = { path = "../snapshot" }
 thiserror = "1.0.49"
 vmm = { path = "../vmm" }
 
 fc_utils = { package = "utils", path = "../utils" }
+
+[target.'cfg(target_arch = "aarch64")'.dependencies]
+clap-num = "1.0.2"
diff --git a/src/utils/Cargo.toml b/src/utils/Cargo.toml
@@ -19,7 +19,5 @@ versionize_derive = "0.1.5"
 vmm-sys-util = "0.11.0"
 vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-bitmap"] }
 
-net_gen = { path = "../net_gen" }
-
 [dev-dependencies]
 serde_json = "1.0.99"
diff --git a/src/vmm/Cargo.toml b/src/vmm/Cargo.toml
@@ -28,7 +28,6 @@ userfaultfd = "0.7.0"
 versionize = "0.1.10"
 versionize_derive = "0.1.5"
 vm-allocator = "0.1.0"
-vm-fdt = "0.2.0"
 vm-superio = "0.7.0"
 log = { version = "0.4.17", features = ["std", "serde"] }
 aes-gcm =  { version = "0.10.1", default-features = false, features = ["aes"] }
@@ -42,6 +41,9 @@ snapshot = { path = "../snapshot"}
 utils = { path = "../utils" }
 virtio_gen = { path = "../virtio_gen" }
 
+[target.'cfg(target_arch = "aarch64")'.dependencies]
+vm-fdt = "0.2.0"
+
 [dev-dependencies]
 criterion = { version = "0.5.0", default-features = false }
 device_tree = "1.1.0"

diff --git a/tests/integration_tests/build/test_dependencies.py b/tests/integration_tests/build/test_dependencies.py
@@ -25,3 +25,10 @@ def test_licenses():
     )
 
     cargo("deny", f"--manifest-path {toml_file} check licenses bans")
+
+
+def test_unused_dependencies():
+    """
+    Test that there are no unused dependencies.
+    """
+    cargo("+nightly udeps --all")
diff --git a/tools/devctr/Dockerfile b/tools/devctr/Dockerfile
@@ -71,9 +71,10 @@ RUN cd /tmp/poetry && \
 
 # Install the Rust toolchain. Kani only work on x86, so only try to install it there.
 RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain "$RUST_TOOLCHAIN" \
+    && rustup install nightly \
     && rustup target add $ARCH-unknown-linux-musl \
     && rustup component add llvm-tools-preview \
-    && cargo install cargo-audit cargo-deny grcov cargo-sort \
+    && cargo install cargo-audit cargo-deny grcov cargo-sort cargo-udeps \
     && (if [ "$ARCH" = "x86_64" ]; then cargo install kani-verifier && cargo kani setup; else true; fi) \
     && rm -rf "$CARGO_HOME/registry" \
     && ln -s "$CARGO_REGISTRY_DIR" "$CARGO_HOME/registry" \

diff --git a/tools/devctr/poetry.lock b/tools/devctr/poetry.lock
diff --git a/tools/devtool b/tools/devtool
@@ -72,7 +72,7 @@
 DEVCTR_IMAGE_NO_TAG="public.ecr.aws/firecracker/fcuvm"
 
 # Development container tag
-DEVCTR_IMAGE_TAG=${DEVCTR_IMAGE_TAG:-v64}
+DEVCTR_IMAGE_TAG=${DEVCTR_IMAGE_TAG:-v65}
 
 # Development container image (name:tag)
 # This should be updated whenever we upgrade the development container.