Fix: move snapshot into module under vmm

Moved `snapshot` into module under `vmm`. Many of these crates
could be modules and the number of crates in our workspace
greatly reduced. This reduces the binary size and makes the
workspace more ergonomic.

Signed-off-by: Ashwin Ginoria <[email protected]>

Author: Ashwin Ginoria

Cargo.lock

@@ -25,7 +25,6 @@ thiserror = "1.0.53"
 timerfd = "1.5.0"
 
 seccompiler = { path = "../seccompiler" }
-snapshot = { path = "../snapshot" }
 utils = { path = "../utils" }
 vmm = { path = "../vmm" }
 
@@ -45,7 +44,7 @@ serde = { version = "1.0.193" }
 serde_json = "1.0.109"
 
 [features]
-tracing = ["log-instrument", "seccompiler/tracing", "snapshot/tracing", "utils/tracing", "vmm/tracing"]
+tracing = ["log-instrument", "seccompiler/tracing", "utils/tracing", "vmm/tracing"]
 
 [[example]]
 name = "uffd_malicious_handler"

src/firecracker/Cargo.toml

@@ -17,7 +17,6 @@ use api_server_adapter::ApiServerError;
 use event_manager::SubscriberOps;
 use seccomp::FilterError;
 use seccompiler::BpfThreadMap;
-use snapshot::{Error as SnapshotError, Snapshot};
 use utils::arg_parser::{ArgParser, Argument};
 use utils::terminal::Terminal;
 use utils::validators::validate_instance_id;
@@ -28,6 +27,7 @@ use vmm::logger::{
 use vmm::persist::SNAPSHOT_VERSION;
 use vmm::resources::VmResources;
 use vmm::signal_handler::register_signal_handlers;
+use vmm::snapshot::{Error as SnapshotError, Snapshot};
 use vmm::vmm_config::instance_info::{InstanceInfo, VmState};
 use vmm::vmm_config::metrics::{init_metrics, MetricsConfig, MetricsConfigError};
 use vmm::{EventManager, FcExitCode, HTTP_MAX_PAYLOAD_SIZE};

src/firecracker/src/main.rs

@@ -15,7 +15,6 @@ displaydoc = "0.2.4"
 libc = "0.2.151"
 log-instrument = { path = "../log-instrument", optional = true }
 semver = "1.0.20"
-snapshot = { path = "../snapshot" }
 thiserror = "1.0.53"
 vmm = { path = "../vmm" }
 

src/snapshot-editor/Cargo.toml

@@ -6,8 +6,8 @@ use std::path::PathBuf;
 
 use fc_utils::u64_to_usize;
 use semver::Version;
-use snapshot::Snapshot;
 use vmm::persist::MicrovmState;
+use vmm::snapshot::Snapshot;
 
 // Some errors are only used in aarch64 code
 #[allow(unused)]
@@ -18,11 +18,11 @@ pub enum UtilsError {
     /// Can not retrieve metadata for snapshot file: {0}
     VmStateFileMeta(std::io::Error),
     /// Can not load snapshot: {0}
-    VmStateLoad(snapshot::Error),
+    VmStateLoad(vmm::snapshot::Error),
     /// Can not open output file: {0}
     OutputFileOpen(std::io::Error),
     /// Can not save snapshot: {0}
-    VmStateSave(snapshot::Error),
+    VmStateSave(vmm::snapshot::Error),
 }
 
 #[allow(unused)]

src/snapshot-editor/src/utils.rs

@@ -36,9 +36,9 @@ base64 = "0.21.0"
 bincode = "1.2.1"
 micro_http = { git = "https://github.com/firecracker-microvm/micro-http" }
 log-instrument = { path = "../log-instrument", optional = true }
+crc64 = "2.0.0"
 
 seccompiler = { path = "../seccompiler" }
-snapshot = { path = "../snapshot"}
 utils = { path = "../utils" }
 smallvec = "1.11.2"
 

src/snapshot/Cargo.toml

@@ -478,9 +478,8 @@ reg_data_array!([u8; 256], 256);
 
 #[cfg(test)]
 mod tests {
-    use snapshot::Snapshot;
-
     use super::*;
+    use crate::snapshot::Snapshot;
 
     #[test]
     fn test_reg_size() {

src/vmm/Cargo.toml

@@ -18,7 +18,6 @@ use linux_loader::loader::elf::Elf as Loader;
 use linux_loader::loader::pe::PE as Loader;
 use linux_loader::loader::KernelLoader;
 use seccompiler::BpfThreadMap;
-use snapshot::Persist;
 use userfaultfd::Uffd;
 use utils::eventfd::EventFd;
 use utils::time::TimestampUs;
@@ -53,6 +52,7 @@ use crate::devices::BusDevice;
 use crate::logger::{debug, error};
 use crate::persist::{MicrovmState, MicrovmStateError};
 use crate::resources::VmResources;
+use crate::snapshot::Persist;
 use crate::vmm_config::boot_source::BootConfig;
 use crate::vmm_config::drive::BlockDeviceType;
 use crate::vmm_config::instance_info::InstanceInfo;

src/vmm/src/arch/aarch64/regs.rs

@@ -10,7 +10,6 @@ use event_manager::{MutEventSubscriber, SubscriberOps};
 use kvm_ioctls::VmFd;
 use log::{error, warn};
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 use vm_allocator::AllocPolicy;
 
 use super::mmio::*;
@@ -45,6 +44,7 @@ use crate::devices::virtio::vsock::{
 use crate::devices::virtio::{TYPE_BALLOON, TYPE_BLOCK, TYPE_NET, TYPE_RNG};
 use crate::mmds::data_store::MmdsVersion;
 use crate::resources::VmResources;
+use crate::snapshot::Persist;
 use crate::vmm_config::mmds::MmdsConfigError;
 use crate::vstate::memory::GuestMemoryMmap;
 use crate::EventManager;
@@ -646,13 +646,13 @@ impl<'a> Persist<'a> for MMIODeviceManager {
 
 #[cfg(test)]
 mod tests {
-    use snapshot::Snapshot;
     use utils::tempfile::TempFile;
 
     use super::*;
     use crate::builder::tests::*;
     use crate::devices::virtio::block_common::CacheType;
     use crate::resources::VmmConfig;
+    use crate::snapshot::Snapshot;
     use crate::vmm_config::balloon::BalloonDeviceConfig;
     use crate::vmm_config::entropy::EntropyDeviceConfig;
     use crate::vmm_config::net::NetworkInterfaceConfig;

src/vmm/src/builder.rs

@@ -8,7 +8,6 @@ use std::sync::Arc;
 use std::time::Duration;
 
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 use timerfd::{SetTimeFlags, TimerState};
 
 use super::*;
@@ -17,6 +16,7 @@ use crate::devices::virtio::device::DeviceState;
 use crate::devices::virtio::persist::VirtioDeviceState;
 use crate::devices::virtio::queue::FIRECRACKER_MAX_QUEUE_SIZE;
 use crate::devices::virtio::TYPE_BALLOON;
+use crate::snapshot::Persist;
 use crate::vstate::memory::GuestMemoryMmap;
 
 /// Information about the balloon config's that are saved
@@ -174,12 +174,11 @@ impl Persist<'_> for Balloon {
 mod tests {
     use std::sync::atomic::Ordering;
 
-    use snapshot::Snapshot;
-
     use super::*;
     use crate::devices::virtio::device::VirtioDevice;
     use crate::devices::virtio::test_utils::default_mem;
     use crate::devices::virtio::TYPE_BALLOON;
+    use crate::snapshot::Snapshot;
 
     #[test]
     fn test_persistence() {

src/vmm/src/device_manager/persist.rs

@@ -8,7 +8,6 @@ use std::sync::atomic::AtomicU32;
 use std::sync::{Arc, Mutex};
 
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 use utils::net::mac::MacAddr;
 
 use super::device::Net;
@@ -22,6 +21,7 @@ use crate::mmds::ns::MmdsNetworkStack;
 use crate::mmds::persist::MmdsNetworkStackState;
 use crate::rate_limiter::persist::RateLimiterState;
 use crate::rate_limiter::RateLimiter;
+use crate::snapshot::Persist;
 use crate::vstate::memory::GuestMemoryMmap;
 
 /// Information about the network config's that are saved
@@ -140,12 +140,11 @@ impl Persist<'_> for Net {
 mod tests {
     use std::sync::atomic::Ordering;
 
-    use snapshot::Snapshot;
-
     use super::*;
     use crate::devices::virtio::device::VirtioDevice;
     use crate::devices::virtio::net::test_utils::{default_net, default_net_no_mmds};
     use crate::devices::virtio::test_utils::default_mem;
+    use crate::snapshot::Snapshot;
 
     fn validate_save_and_restore(net: Net, mmds_ds: Option<Arc<Mutex<Mmds>>>) {
         let guest_mem = default_mem();

src/vmm/src/devices/virtio/balloon/persist.rs

@@ -8,12 +8,12 @@ use std::sync::atomic::Ordering;
 use std::sync::{Arc, Mutex};
 
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 
 use crate::devices::virtio::device::VirtioDevice;
 use crate::devices::virtio::gen::virtio_ring::VIRTIO_RING_F_EVENT_IDX;
 use crate::devices::virtio::mmio::MmioTransport;
 use crate::devices::virtio::queue::Queue;
+use crate::snapshot::Persist;
 use crate::vstate::memory::{GuestAddress, GuestMemoryMmap};
 
 /// Errors thrown during restoring virtio state.
@@ -225,7 +225,6 @@ impl Persist<'_> for MmioTransport {
 
 #[cfg(test)]
 mod tests {
-    use snapshot::Snapshot;
     use utils::tempfile::TempFile;
 
     use super::*;
@@ -237,6 +236,7 @@ mod tests {
     use crate::devices::virtio::virtio_block::test_utils::default_block_with_path;
     use crate::devices::virtio::virtio_block::VirtioBlock;
     use crate::devices::virtio::vsock::{Vsock, VsockUnixBackend};
+    use crate::snapshot::Snapshot;
 
     const DEFAULT_QUEUE_MAX_SIZE: u16 = 256;
     impl Default for QueueState {

src/vmm/src/devices/virtio/net/persist.rs

@@ -4,14 +4,14 @@
 //! Defines the structures needed for saving/restoring entropy devices.
 
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 
 use crate::devices::virtio::persist::{PersistError as VirtioStateError, VirtioDeviceState};
 use crate::devices::virtio::queue::FIRECRACKER_MAX_QUEUE_SIZE;
 use crate::devices::virtio::rng::{Entropy, EntropyError, RNG_NUM_QUEUES};
 use crate::devices::virtio::TYPE_RNG;
 use crate::rate_limiter::persist::RateLimiterState;
 use crate::rate_limiter::RateLimiter;
+use crate::snapshot::Persist;
 use crate::vstate::memory::GuestMemoryMmap;
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -79,12 +79,11 @@ impl Persist<'_> for Entropy {
 mod tests {
     use std::sync::atomic::Ordering;
 
-    use snapshot::Snapshot;
-
     use super::*;
     use crate::devices::virtio::device::VirtioDevice;
     use crate::devices::virtio::rng::device::ENTROPY_DEV_ID;
     use crate::devices::virtio::test_utils::test::create_virtio_mem;
+    use crate::snapshot::Snapshot;
 
     #[test]
     fn test_persistence() {

src/vmm/src/devices/virtio/persist.rs

@@ -4,12 +4,12 @@
 //! Defines the structures needed for saving/restoring block devices.
 
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 
 use super::device::VhostUserBlock;
 use super::VhostUserBlockError;
 use crate::devices::virtio::block_common::CacheType;
 use crate::devices::virtio::persist::VirtioDeviceState;
+use crate::snapshot::Persist;
 use crate::vstate::memory::GuestMemoryMmap;
 
 /// vhost-user block device state.

src/vmm/src/devices/virtio/rng/persist.rs

@@ -7,7 +7,6 @@ use std::sync::atomic::AtomicU32;
 use std::sync::Arc;
 
 use serde::{Deserialize, Serialize};
-use snapshot::Persist;
 use utils::eventfd::EventFd;
 
 use super::device::DiskProperties;
@@ -21,6 +20,7 @@ use crate::devices::virtio::TYPE_BLOCK;
 use crate::logger::warn;
 use crate::rate_limiter::persist::RateLimiterState;
 use crate::rate_limiter::RateLimiter;
+use crate::snapshot::Persist;
 use crate::vstate::memory::GuestMemoryMmap;
 
 /// Holds info about block's file engine type. Gets saved in snapshot.
@@ -173,13 +173,13 @@ impl Persist<'_> for VirtioBlock {
 mod tests {
     use std::sync::atomic::Ordering;
 
-    use snapshot::Snapshot;
     use utils::tempfile::TempFile;
 
     use super::*;
     use crate::devices::virtio::device::VirtioDevice;
     use crate::devices::virtio::test_utils::default_mem;
     use crate::devices::virtio::virtio_block::device::VirtioBlockConfig;
+    use crate::snapshot::Snapshot;
 
     #[test]
     fn test_cache_semantic_ser() {