misc: Adapt consistent import style formatting

Historically the Cloud Hypervisor coding style has been to ensure that
all imports are ordered and placed in a single group. Unfortunately
cargo fmt has no support for ensuring that all imports are in a single
group so if whitespace lines were added as part of the import statements
then they would only be odered correctly in the group.

By adopting "group_imports="StdExternalCrate" we can enforce a style
where imports are placed in at most three groups for std, external
crates and the crate itself. Choosing a style enforceable by the tooling
reduces the reviewer burden.

Signed-off-by: Rob Bradford <rbradford@rivosinc.com>

hypervisor/src/arch/aarch64/gic.rs

@@ -2,11 +2,13 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{CpuState, GicState, HypervisorDeviceError, HypervisorVmError};
 use std::any::Any;
 use std::result;
+
 use thiserror::Error;
 
+use crate::{CpuState, GicState, HypervisorDeviceError, HypervisorVmError};
+
 /// Errors thrown while setting up the VGIC.
 #[derive(Debug, Error)]
 pub enum Error {

hypervisor/src/arch/emulator/mod.rs

@@ -6,6 +6,7 @@
 
 use core::fmt::Debug;
 use std::fmt::{self, Display};
+
 use thiserror::Error;
 
 #[derive(Clone, Copy, Error, Debug)]

hypervisor/src/arch/x86/emulator/instructions/mod.rs

@@ -4,10 +4,11 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+use iced_x86::*;
+
 use crate::arch::emulator::{EmulationError, PlatformEmulator, PlatformError};
 use crate::arch::x86::emulator::CpuStateManager;
 use crate::arch::x86::Exception;
-use iced_x86::*;
 
 pub mod cmp;
 pub mod mov;

hypervisor/src/arch/x86/emulator/instructions/or.rs

@@ -51,7 +51,6 @@ impl<T: CpuStateManager> InstructionHandler<T> for Or_rm8_r8 {
 #[cfg(test)]
 mod tests {
     use super::*;
-
     use crate::arch::x86::emulator::mock_vmm::*;
 
     #[test]

hypervisor/src/arch/x86/emulator/mod.rs

@@ -4,6 +4,9 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+use anyhow::Context;
+use iced_x86::*;
+
 use crate::arch::emulator::{EmulationError, EmulationResult, PlatformEmulator, PlatformError};
 use crate::arch::x86::emulator::instructions::*;
 use crate::arch::x86::regs::{CR0_PE, EFER_LMA};
@@ -11,8 +14,6 @@ use crate::arch::x86::{
     segment_type_expand_down, segment_type_ro, Exception, SegmentRegister, SpecialRegisters,
 };
 use crate::StandardRegisters;
-use anyhow::Context;
-use iced_x86::*;
 
 #[macro_use]
 mod instructions;
@@ -653,11 +654,12 @@ impl<'a, T: CpuStateManager> Emulator<'a, T> {
 
 #[cfg(test)]
 mod mock_vmm {
+    use std::sync::{Arc, Mutex};
+
     use super::*;
     use crate::arch::x86::emulator::EmulatorCpuState as CpuState;
     use crate::arch::x86::gdt::{gdt_entry, segment_from_gdt};
     use crate::StandardRegisters;
-    use std::sync::{Arc, Mutex};
 
     #[derive(Debug, Clone)]
     pub struct MockVmm {

hypervisor/src/arch/x86/mod.rs

@@ -242,10 +242,11 @@ impl Default for LapicState {
 
 impl LapicState {
     pub fn get_klapic_reg(&self, reg_offset: usize) -> u32 {
-        use byteorder::{LittleEndian, ReadBytesExt};
         use std::io::Cursor;
         use std::mem;
 
+        use byteorder::{LittleEndian, ReadBytesExt};
+
         // SAFETY: plain old data type
         let sliceu8 = unsafe {
             // This array is only accessed as parts of a u32 word, so interpret it as a u8 array.
@@ -261,10 +262,11 @@ impl LapicState {
     }
 
     pub fn set_klapic_reg(&mut self, reg_offset: usize, value: u32) {
-        use byteorder::{LittleEndian, WriteBytesExt};
         use std::io::Cursor;
         use std::mem;
 
+        use byteorder::{LittleEndian, WriteBytesExt};
+
         // SAFETY: plain old data type
         let sliceu8 = unsafe {
             // This array is only accessed as parts of a u32 word, so interpret it as a u8 array.

hypervisor/src/cpu.rs

@@ -8,6 +8,9 @@
 //
 //
 
+use thiserror::Error;
+use vm_memory::GuestAddress;
+
 #[cfg(target_arch = "aarch64")]
 use crate::aarch64::{RegList, VcpuInit};
 #[cfg(target_arch = "x86_64")]
@@ -17,8 +20,6 @@ use crate::kvm::{TdxExitDetails, TdxExitStatus};
 use crate::CpuState;
 use crate::MpState;
 use crate::StandardRegisters;
-use thiserror::Error;
-use vm_memory::GuestAddress;
 
 #[cfg(target_arch = "x86_64")]
 #[derive(Copy, Clone, Default)]

hypervisor/src/hypervisor.rs

@@ -7,6 +7,12 @@
 // Copyright 2018-2019 CrowdStrike, Inc.
 //
 //
+#[cfg(target_arch = "x86_64")]
+use std::arch::x86_64;
+use std::sync::Arc;
+
+use thiserror::Error;
+
 #[cfg(target_arch = "x86_64")]
 use crate::arch::x86::CpuIdEntry;
 #[cfg(target_arch = "x86_64")]
@@ -15,10 +21,6 @@ use crate::cpu::CpuVendor;
 use crate::kvm::TdxCapabilities;
 use crate::vm::Vm;
 use crate::HypervisorType;
-#[cfg(target_arch = "x86_64")]
-use std::arch::x86_64;
-use std::sync::Arc;
-use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum HypervisorError {

hypervisor/src/kvm/aarch64/gic/dist_regs.rs

@@ -1,12 +1,13 @@
 // Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+use kvm_ioctls::DeviceFd;
+
 use crate::arch::aarch64::gic::{Error, Result};
 use crate::device::HypervisorDeviceError;
 use crate::kvm::kvm_bindings::{
     kvm_device_attr, KVM_DEV_ARM_VGIC_GRP_DIST_REGS, KVM_DEV_ARM_VGIC_GRP_NR_IRQS,
 };
-use kvm_ioctls::DeviceFd;
 
 /*
  Distributor registers as detailed at page 456 from

hypervisor/src/kvm/aarch64/gic/icc_regs.rs

@@ -2,6 +2,8 @@
 // Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+use kvm_ioctls::DeviceFd;
+
 use crate::arch::aarch64::gic::{Error, Result};
 use crate::device::HypervisorDeviceError;
 use crate::kvm::kvm_bindings::{
@@ -10,7 +12,6 @@ use crate::kvm::kvm_bindings::{
     KVM_REG_ARM64_SYSREG_OP0_MASK, KVM_REG_ARM64_SYSREG_OP0_SHIFT, KVM_REG_ARM64_SYSREG_OP1_MASK,
     KVM_REG_ARM64_SYSREG_OP1_SHIFT, KVM_REG_ARM64_SYSREG_OP2_MASK, KVM_REG_ARM64_SYSREG_OP2_SHIFT,
 };
-use kvm_ioctls::DeviceFd;
 
 const KVM_DEV_ARM_VGIC_V3_MPIDR_SHIFT: u32 = 32;
 const KVM_DEV_ARM_VGIC_V3_MPIDR_MASK: u64 = 0xffffffff << KVM_DEV_ARM_VGIC_V3_MPIDR_SHIFT as u64;

hypervisor/src/kvm/aarch64/gic/mod.rs

@@ -6,16 +6,18 @@ mod dist_regs;
 mod icc_regs;
 mod redist_regs;
 
-use crate::arch::aarch64::gic::{Error, Result, Vgic, VgicConfig};
-use crate::device::HypervisorDeviceError;
-use crate::kvm::KvmVm;
-use crate::{CpuState, Vm};
+use std::any::Any;
+
 use dist_regs::{get_dist_regs, read_ctlr, set_dist_regs, write_ctlr};
 use icc_regs::{get_icc_regs, set_icc_regs};
 use kvm_ioctls::DeviceFd;
 use redist_regs::{construct_gicr_typers, get_redist_regs, set_redist_regs};
 use serde::{Deserialize, Serialize};
-use std::any::Any;
+
+use crate::arch::aarch64::gic::{Error, Result, Vgic, VgicConfig};
+use crate::device::HypervisorDeviceError;
+use crate::kvm::KvmVm;
+use crate::{CpuState, Vm};
 
 const GITS_CTLR: u32 = 0x0000;
 const GITS_IIDR: u32 = 0x0004;

hypervisor/src/kvm/aarch64/gic/redist_regs.rs

@@ -2,6 +2,8 @@
 // Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+use kvm_ioctls::DeviceFd;
+
 use crate::arch::aarch64::gic::{Error, Result};
 use crate::device::HypervisorDeviceError;
 use crate::kvm::kvm_bindings::{
@@ -12,7 +14,6 @@ use crate::kvm::kvm_bindings::{
 use crate::kvm::Register;
 use crate::kvm::VcpuKvmState;
 use crate::CpuState;
-use kvm_ioctls::DeviceFd;
 
 // Relevant redistributor registers that we want to save/restore.
 const GICR_CTLR: u32 = 0x0000;

hypervisor/src/kvm/aarch64/mod.rs

@@ -10,7 +10,6 @@
 
 pub mod gic;
 
-use crate::kvm::{KvmError, KvmResult};
 use kvm_bindings::{
     kvm_mp_state, kvm_one_reg, kvm_regs, KVM_REG_ARM_COPROC_MASK, KVM_REG_ARM_CORE,
     KVM_REG_SIZE_MASK, KVM_REG_SIZE_U32, KVM_REG_SIZE_U64,
@@ -19,6 +18,8 @@ pub use kvm_bindings::{kvm_one_reg as Register, kvm_vcpu_init as VcpuInit, RegLi
 use serde::{Deserialize, Serialize};
 pub use {kvm_ioctls::Cap, kvm_ioctls::Kvm};
 
+use crate::kvm::{KvmError, KvmResult};
+
 // This macro gets the offset of a structure (i.e `str`) member (i.e `field`) without having
 // an instance of that structure.
 #[macro_export]

hypervisor/src/kvm/mod.rs

@@ -8,6 +8,23 @@
 //
 //
 
+use std::any::Any;
+use std::collections::HashMap;
+#[cfg(target_arch = "x86_64")]
+use std::fs::File;
+#[cfg(target_arch = "x86_64")]
+use std::os::unix::io::AsRawFd;
+#[cfg(feature = "tdx")]
+use std::os::unix::io::RawFd;
+use std::result;
+#[cfg(target_arch = "x86_64")]
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::sync::Mutex;
+use std::sync::{Arc, RwLock};
+
+use kvm_ioctls::{NoDatamatch, VcpuFd, VmFd};
+use vmm_sys_util::eventfd::EventFd;
+
 #[cfg(target_arch = "aarch64")]
 use crate::aarch64::gic::KvmGicV3Its;
 #[cfg(target_arch = "aarch64")]
@@ -24,35 +41,9 @@ use crate::vm::{self, InterruptSourceConfig, VmOps};
 use crate::HypervisorType;
 #[cfg(target_arch = "aarch64")]
 use crate::{arm64_core_reg_id, offset_of};
-use kvm_ioctls::{NoDatamatch, VcpuFd, VmFd};
-use std::any::Any;
-use std::collections::HashMap;
-#[cfg(target_arch = "x86_64")]
-use std::fs::File;
-#[cfg(target_arch = "x86_64")]
-use std::os::unix::io::AsRawFd;
-#[cfg(feature = "tdx")]
-use std::os::unix::io::RawFd;
-use std::result;
-#[cfg(target_arch = "x86_64")]
-use std::sync::atomic::{AtomicBool, Ordering};
-use std::sync::Mutex;
-use std::sync::{Arc, RwLock};
-use vmm_sys_util::eventfd::EventFd;
 // x86_64 dependencies
 #[cfg(target_arch = "x86_64")]
 pub mod x86_64;
-#[cfg(target_arch = "x86_64")]
-use crate::arch::x86::{
-    CpuIdEntry, FpuState, LapicState, MsrEntry, SpecialRegisters, XsaveState, NUM_IOAPIC_PINS,
-};
-#[cfg(target_arch = "x86_64")]
-use crate::ClockData;
-use crate::StandardRegisters;
-use crate::{
-    CpuState, IoEventAddress, IrqRoutingEntry, MpState, UserMemoryRegion,
-    USER_MEMORY_REGION_LOG_DIRTY, USER_MEMORY_REGION_READ, USER_MEMORY_REGION_WRITE,
-};
 #[cfg(target_arch = "aarch64")]
 use aarch64::{RegList, Register};
 #[cfg(target_arch = "x86_64")]
@@ -64,9 +55,24 @@ use kvm_bindings::{
 use x86_64::check_required_kvm_extensions;
 #[cfg(target_arch = "x86_64")]
 pub use x86_64::{CpuId, ExtendedControlRegisters, MsrEntries, VcpuKvmState};
+
+#[cfg(target_arch = "x86_64")]
+use crate::arch::x86::{
+    CpuIdEntry, FpuState, LapicState, MsrEntry, SpecialRegisters, XsaveState, NUM_IOAPIC_PINS,
+};
+#[cfg(target_arch = "x86_64")]
+use crate::ClockData;
+use crate::StandardRegisters;
+use crate::{
+    CpuState, IoEventAddress, IrqRoutingEntry, MpState, UserMemoryRegion,
+    USER_MEMORY_REGION_LOG_DIRTY, USER_MEMORY_REGION_READ, USER_MEMORY_REGION_WRITE,
+};
 // aarch64 dependencies
 #[cfg(target_arch = "aarch64")]
 pub mod aarch64;
+#[cfg(target_arch = "aarch64")]
+use std::mem;
+
 pub use kvm_bindings;
 pub use kvm_bindings::{
     kvm_clock_data, kvm_create_device, kvm_device_type_KVM_DEV_TYPE_VFIO, kvm_guest_debug,
@@ -85,8 +91,6 @@ use kvm_bindings::{
 use kvm_bindings::{kvm_run__bindgen_ty_1, KVMIO};
 pub use kvm_ioctls;
 pub use kvm_ioctls::{Cap, Kvm};
-#[cfg(target_arch = "aarch64")]
-use std::mem;
 use thiserror::Error;
 use vfio_ioctls::VfioDeviceFd;
 #[cfg(feature = "tdx")]
@@ -104,7 +108,6 @@ const KVM_CAP_SGX_ATTRIBUTE: u32 = 196;
 
 #[cfg(target_arch = "x86_64")]
 use vmm_sys_util::ioctl_io_nr;
-
 #[cfg(all(not(feature = "tdx"), target_arch = "x86_64"))]
 use vmm_sys_util::ioctl_ioc_nr;
 

hypervisor/src/kvm/x86_64/mod.rs

@@ -8,13 +8,7 @@
 //
 //
 
-use crate::arch::x86::{
-    CpuIdEntry, DescriptorTable, FpuState, LapicState, MsrEntry, SegmentRegister, SpecialRegisters,
-    XsaveState, CPUID_FLAG_VALID_INDEX,
-};
-use crate::kvm::{Cap, Kvm, KvmError, KvmResult};
 use serde::{Deserialize, Serialize};
-
 ///
 /// Export generically-named wrappers of kvm-bindings for Unix-based platforms
 ///
@@ -28,6 +22,12 @@ pub use {
     kvm_bindings::KVM_CPUID_FLAG_SIGNIFCANT_INDEX,
 };
 
+use crate::arch::x86::{
+    CpuIdEntry, DescriptorTable, FpuState, LapicState, MsrEntry, SegmentRegister, SpecialRegisters,
+    XsaveState, CPUID_FLAG_VALID_INDEX,
+};
+use crate::kvm::{Cap, Kvm, KvmError, KvmResult};
+
 ///
 /// Check KVM extension for Linux
 ///

hypervisor/src/lib.rs

@@ -48,7 +48,8 @@ mod cpu;
 /// Device related module
 mod device;
 
-pub use crate::hypervisor::{Hypervisor, HypervisorError};
+use std::sync::Arc;
+
 use concat_idents::concat_idents;
 #[cfg(target_arch = "x86_64")]
 pub use cpu::CpuVendor;
@@ -56,12 +57,13 @@ pub use cpu::{HypervisorCpuError, Vcpu, VmExit};
 pub use device::HypervisorDeviceError;
 #[cfg(all(feature = "kvm", target_arch = "aarch64"))]
 pub use kvm::{aarch64, GicState};
-use std::sync::Arc;
 pub use vm::{
     DataMatch, HypervisorVmError, InterruptSourceConfig, LegacyIrqSourceConfig, MsiIrqSourceConfig,
     Vm, VmOps,
 };
 
+pub use crate::hypervisor::{Hypervisor, HypervisorError};
+
 #[derive(Debug, Copy, Clone)]
 pub enum HypervisorType {
     #[cfg(feature = "kvm")]

hypervisor/src/mshv/mod.rs

@@ -3,6 +3,15 @@
 // Copyright © 2020, Microsoft Corporation
 //
 
+use std::any::Any;
+use std::collections::HashMap;
+use std::sync::{Arc, RwLock};
+
+use mshv_bindings::*;
+use mshv_ioctls::{set_registers_64, InterruptRequest, Mshv, NoDatamatch, VcpuFd, VmFd, VmType};
+use vfio_ioctls::VfioDeviceFd;
+use vm::DataMatch;
+
 use crate::arch::emulator::PlatformEmulator;
 #[cfg(target_arch = "x86_64")]
 use crate::arch::x86::emulator::Emulator;
@@ -12,18 +21,32 @@ use crate::mshv::emulator::MshvEmulatorContext;
 use crate::vec_with_array_field;
 use crate::vm::{self, InterruptSourceConfig, VmOps};
 use crate::HypervisorType;
-use mshv_bindings::*;
-use mshv_ioctls::{set_registers_64, InterruptRequest, Mshv, NoDatamatch, VcpuFd, VmFd, VmType};
-use std::any::Any;
-use std::collections::HashMap;
-use std::sync::{Arc, RwLock};
-use vfio_ioctls::VfioDeviceFd;
-use vm::DataMatch;
 #[cfg(feature = "sev_snp")]
 mod snp_constants;
 // x86_64 dependencies
 #[cfg(target_arch = "x86_64")]
 pub mod x86_64;
+#[cfg(target_arch = "x86_64")]
+use std::fs::File;
+use std::os::unix::io::AsRawFd;
+
+#[cfg(feature = "sev_snp")]
+use igvm_defs::IGVM_VHS_SNP_ID_BLOCK;
+#[cfg(feature = "sev_snp")]
+use snp_constants::*;
+use vmm_sys_util::eventfd::EventFd;
+#[cfg(target_arch = "x86_64")]
+pub use x86_64::*;
+#[cfg(target_arch = "x86_64")]
+pub use x86_64::{emulator, VcpuMshvState};
+///
+/// Export generically-named wrappers of mshv-bindings for Unix-based platforms
+///
+pub use {
+    mshv_bindings::mshv_create_device as CreateDevice,
+    mshv_bindings::mshv_device_attr as DeviceAttr, mshv_ioctls, mshv_ioctls::DeviceFd,
+};
+
 #[cfg(target_arch = "x86_64")]
 use crate::arch::x86::{CpuIdEntry, FpuState, MsrEntry};
 #[cfg(target_arch = "x86_64")]
@@ -33,26 +56,6 @@ use crate::{
     USER_MEMORY_REGION_ADJUSTABLE, USER_MEMORY_REGION_EXECUTE, USER_MEMORY_REGION_READ,
     USER_MEMORY_REGION_WRITE,
 };
-#[cfg(feature = "sev_snp")]
-use igvm_defs::IGVM_VHS_SNP_ID_BLOCK;
-#[cfg(feature = "sev_snp")]
-use snp_constants::*;
-#[cfg(target_arch = "x86_64")]
-use std::fs::File;
-use std::os::unix::io::AsRawFd;
-use vmm_sys_util::eventfd::EventFd;
-#[cfg(target_arch = "x86_64")]
-pub use x86_64::*;
-#[cfg(target_arch = "x86_64")]
-pub use x86_64::{emulator, VcpuMshvState};
-
-///
-/// Export generically-named wrappers of mshv-bindings for Unix-based platforms
-///
-pub use {
-    mshv_bindings::mshv_create_device as CreateDevice,
-    mshv_bindings::mshv_device_attr as DeviceAttr, mshv_ioctls, mshv_ioctls::DeviceFd,
-};
 
 pub const PAGE_SHIFT: usize = 12;
 

hypervisor/src/mshv/x86_64/emulator.rs

@@ -3,12 +3,13 @@
 // Copyright © 2024, Microsoft Corporation
 //
 
+use iced_x86::Register;
+use mshv_bindings::*;
+
 use crate::arch::emulator::{PlatformEmulator, PlatformError};
 use crate::arch::x86::emulator::{CpuStateManager, EmulatorCpuState};
 use crate::cpu::Vcpu;
 use crate::mshv::MshvVcpu;
-use iced_x86::Register;
-use mshv_bindings::*;
 
 pub struct MshvEmulatorContext<'a> {
     pub vcpu: &'a MshvVcpu,

hypervisor/src/mshv/x86_64/mod.rs

@@ -7,11 +7,13 @@
 // Copyright 2018-2019 CrowdStrike, Inc.
 //
 //
+use std::fmt;
+
+use serde::{Deserialize, Serialize};
+
 use crate::arch::x86::{
     CpuIdEntry, DescriptorTable, FpuState, LapicState, MsrEntry, SegmentRegister, SpecialRegisters,
 };
-use serde::{Deserialize, Serialize};
-use std::fmt;
 
 pub mod emulator;
 

hypervisor/src/vm.rs

@@ -8,6 +8,18 @@
 //
 //
 
+use std::any::Any;
+#[cfg(target_arch = "x86_64")]
+use std::fs::File;
+use std::sync::Arc;
+#[cfg(target_arch = "aarch64")]
+use std::sync::Mutex;
+
+#[cfg(feature = "sev_snp")]
+use igvm_defs::IGVM_VHS_SNP_ID_BLOCK;
+use thiserror::Error;
+use vmm_sys_util::eventfd::EventFd;
+
 #[cfg(target_arch = "aarch64")]
 use crate::aarch64::VcpuInit;
 #[cfg(target_arch = "aarch64")]
@@ -19,16 +31,6 @@ use crate::cpu::Vcpu;
 use crate::ClockData;
 use crate::UserMemoryRegion;
 use crate::{IoEventAddress, IrqRoutingEntry};
-#[cfg(feature = "sev_snp")]
-use igvm_defs::IGVM_VHS_SNP_ID_BLOCK;
-use std::any::Any;
-#[cfg(target_arch = "x86_64")]
-use std::fs::File;
-use std::sync::Arc;
-#[cfg(target_arch = "aarch64")]
-use std::sync::Mutex;
-use thiserror::Error;
-use vmm_sys_util::eventfd::EventFd;
 
 ///
 /// I/O events data matches (32 or 64 bits).