Addressed PR feedback

Changed licenses, fixed compilation annotations, created separate files for explicitly-defined Windows data structures, and moved all tests
to a module at the end of the file.

Cargo.toml

@@ -4,6 +4,10 @@ version = "0.1.0"
 authors = ["Jenny Mankin <[email protected]>", 
            "Timo Kreuzer <[email protected]>",
            "Alessandro Pilotti <[email protected]>"]
+description = "Hypervisor-agnostic abstraction crate over virtual CPU functionality"
+repository = "https://github.com/rust-vmm/vmm-vcpu"
+readme = "README.md"
+license = "Apache-2.0 or MIT"
 
 [dependencies]
 byteorder = "*"

LICENSE → LICENSE-APACHE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

LICENSE-MIT

@@ -0,0 +1,24 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+

src/arm.rs

@@ -1,28 +1,16 @@
 // Copyright 2018-2019 CrowdStrike, Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License"); you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
 
-///
-/// Use kvm_bindings behind the scenes as these are architectural structures and
-/// not actually KVM-dependent, but export as generically-named data
-/// structures to be consumed by any VMM's vCPU implementation
-///
+/// ARM-specific data structures.
 
+///
 /// Type of CPU to present to the guest, and the optional features it should have.
 ///
-/// pub struct kvm_vcpu_init {
-///     pub target: __u32,
-///     pub features: [__u32; 7usize],
-/// }
-#[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
+#[cfg(windows)]
+pub struct VcpuInit {
+    pub target: u32,
+    pub features: [u32; 7usize],
+}
+
+#[cfg(unix)]
 pub use kvm_bindings::kvm_vcpu_init as VcpuInit;

src/lib.rs

@@ -1,22 +1,11 @@
 // Copyright 2018-2019 CrowdStrike, Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License"); you may
-// not use this file except in compliance with the License. You may obtain
-// a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-// License for the specific language governing permissions and limitations
-// under the License.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+pub mod vcpu;
 
 #[cfg(unix)]
 extern crate kvm_bindings;
 
-pub mod vcpu;
-
 #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 pub mod x86_64;
 

src/vcpu.rs

@@ -1,8 +1,8 @@
 // Copyright 2018-2019 CrowdStrike, Inc.
-// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: Apache-2.0 or MIT
 //
 // Portions Copyright 2018 Cloudbase Solutions Srl
-// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: Apache-2.0 or MIT
 //
 // Portions Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
@@ -15,32 +15,15 @@
 
 use std::{io, result};
 
-///
-/// Generic types used in the virtual CPU trait definition and exported for
-/// public consumption.
-///
-/// These types use kvm_bindings under the hood, as they are not necessarily KVM-
-/// specific, but rather generic x86/x86/ARM structures.  Generic naming makes
-/// them more intuitive for consumption by non-KVM VMMs.
-///
 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
 pub use arm::VcpuInit;
 
 #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 pub use x86_64::{
-    DescriptorTable, FpuState, MsrEntries, MsrEntry, SegmentRegister, SpecialRegisters,
-    StandardRegisters,
+    StandardRegisters, SpecialRegisters, FpuState, MsrEntries, MsrEntry, 
+    CpuId, LapicState
 };
 
-///
-/// Generic types used in the virtual CPU trait definition and exported for
-/// public consumption.
-///
-/// These types are explicitly defined in x86_64
-///
-#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
-pub use x86_64::{CpuId, LapicState};
-
 ///
 /// Reasons for vCPU exits.
 ///
@@ -54,7 +37,6 @@ pub enum VcpuExit<'a> {
     UnrecoverableException,
     InvalidVpRegisterValue,
     UnsupportedFeature,
-    InterruptWindow,
     MsrAccess,
     Cpuid,
     Canceled,
@@ -75,7 +57,6 @@ pub enum VcpuExit<'a> {
     Unknown,
     Hypercall,
     Debug,
-    IrqWindowOpen,
     Shutdown,
     FailEntry,
     Intr,
@@ -99,6 +80,7 @@ pub enum VcpuExit<'a> {
     Hlt,
     IoapicEoi,
     Exception,
+    IrqWindowOpen,
 }
 
 pub type Result<T> = result::Result<T, io::Error>;