MPState Get/Set API and Get_TSC_KHZ API Changes (#67)

Add support for:
- KVM_{GET,SET}_MP_STATE
- KVM_GET_TSC_KHZ

Author: Pavan-Infovision

shim/include/handle_vcpu_kvm_get_mp_state.h

@@ -29,6 +29,7 @@
 
 #include <kvm_mp_state.h>
 #include <mv_types.h>
+#include <shim_vcpu_t.h>
 
 #ifdef __cplusplus
 extern "C"
@@ -40,11 +41,12 @@ extern "C"
      *   @brief Handles the execution of kvm_get_mp_state.
      *
      * <!-- inputs/outputs -->
-     *   @param pmut_ioctl_args the arguments provided by userspace
+     *   @param vcpu to pass the vsid to hypercall
+     *   @param pmut_args the arguments provided by userspace
      *   @return SHIM_SUCCESS on success, SHIM_FAILURE on failure.
      */
-    NODISCARD int64_t
-    handle_vcpu_kvm_get_mp_state(struct kvm_mp_state *const pmut_ioctl_args) NOEXCEPT;
+    NODISCARD int64_t handle_vcpu_kvm_get_mp_state(
+        struct shim_vcpu_t const *const vcpu, struct kvm_mp_state *const pmut_args) NOEXCEPT;
 
 #ifdef __cplusplus
 }

shim/include/handle_vcpu_kvm_get_tsc_khz.h

@@ -39,9 +39,10 @@ extern "C"
      *   @brief Handles the execution of kvm_get_tsc_khz.
      *
      * <!-- inputs/outputs -->
+     *   @param pmut_tsc_khz returns the virtual tsc khz
      *   @return SHIM_SUCCESS on success, SHIM_FAILURE on failure.
      */
-    NODISCARD int64_t handle_vcpu_kvm_get_tsc_khz(void) NOEXCEPT;
+    NODISCARD int64_t handle_vcpu_kvm_get_tsc_khz(uint64_t *const pmut_tsc_khz) NOEXCEPT;
 
 #ifdef __cplusplus
 }

shim/include/handle_vcpu_kvm_set_mp_state.h

@@ -29,6 +29,7 @@
 
 #include <kvm_mp_state.h>
 #include <mv_types.h>
+#include <shim_vcpu_t.h>
 
 #ifdef __cplusplus
 extern "C"
@@ -40,11 +41,12 @@ extern "C"
      *   @brief Handles the execution of kvm_set_mp_state.
      *
      * <!-- inputs/outputs -->
-     *   @param pmut_ioctl_args the arguments provided by userspace
+     *   @param vcpu to pass the vsid to hypercall
+     *   @param args the arguments provided by userspace
      *   @return SHIM_SUCCESS on success, SHIM_FAILURE on failure.
      */
-    NODISCARD int64_t
-    handle_vcpu_kvm_set_mp_state(struct kvm_mp_state *const pmut_ioctl_args) NOEXCEPT;
+    NODISCARD int64_t handle_vcpu_kvm_set_mp_state(
+        struct shim_vcpu_t const *const vcpu, struct kvm_mp_state const *const args) NOEXCEPT;
 
 #ifdef __cplusplus
 }

shim/include/kvm_constants.h

@@ -66,6 +66,16 @@ extern "C"
 #define KVM_CAP_IMMEDIATE_EXIT 136
 /** @brief defines MICROV_MAX_MCE_BANKS  */
 #define MICROV_MAX_MCE_BANKS 32
+/** @brief defines KVM_MP_STATE_RUNNABLE for mp state */
+#define KVM_MP_STATE_RUNNABLE 0
+/** @brief defines KVM_MP_STATE_UNINITIALIZED for mp state */
+#define KVM_MP_STATE_UNINITIALIZED 1
+/** @brief defines KVM_MP_STATE_INIT_RECEIVED for mp state */
+#define KVM_MP_STATE_INIT_RECEIVED 2
+/** @brief defines KVM_MP_STATE_HALTED for mp state */
+#define KVM_MP_STATE_HALTED 3
+/** @brief defines KVM_MP_STATE_SIPI_RECEIVED for mp state */
+#define KVM_MP_STATE_SIPI_RECEIVED 4
 
 #pragma pack(pop)
 

shim/include/kvm_constants.hpp

@@ -63,6 +63,16 @@ namespace shim
     constexpr auto KVM_CAP_UNSUPPORTED{0_i64};
     /// @brief defines the size of the KVM_CAP_IMMEDIATE_EXIT
     constexpr auto KVM_CAP_IMMEDIATE_EXIT{1_i64};
+    /// @brief defines the size of the KVM_MP_INITIAL_STATE
+    constexpr auto KVM_MP_RUNNING_STATE{0_u32};
+    /// @brief defines the size of the KVM_MP_RUNNING_STATE
+    constexpr auto KVM_MP_UNINITIALIZED_STATE{1_u32};
+    /// @brief defines the size of the KVM_MP_WAIT_STATE
+    constexpr auto KVM_MP_INIT_RECEIVED_STATE{2_u32};
+    /// @brief defines the size of the KVM_MP_INIT_STATE
+    constexpr auto KVM_MP_HALTED_STATE{3_u32};
+    /// @brief defines the size of the KVM_MP_SIPI_STATE
+    constexpr auto KVM_MP_SIPI_STATE{4_u32};
 
 }
 #pragma pack(pop)

shim/include/kvm_mp_state.h

@@ -44,8 +44,8 @@ extern "C"
      */
     struct kvm_mp_state
     {
-        /** @brief replace me with contents from KVM API */
-        int32_t dummy;
+        /** @brief the mp state of the VS to set or get */
+        uint32_t mp_state;
     };
 
 #pragma pack(pop)

shim/include/kvm_mp_state.hpp

@@ -0,0 +1,48 @@
+/// @copyright
+/// Copyright (C) 2020 Assured Information Security, Inc.
+///
+/// @copyright
+/// 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:
+///
+/// @copyright
+/// The above copyright notice and this permission notice shall be included in
+/// all copies or substantial portions of the Software.
+///
+/// @copyright
+/// 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.
+
+#ifndef KVM_MP_STATE_HPP
+#define KVM_MP_STATE_HPP
+
+#include <bsl/cstdint.hpp>
+
+#pragma pack(push, 1)
+
+namespace shim
+{
+    /// @struct kvm_mp_state
+    ///
+    /// <!-- description -->
+    ///   @brief see /include/uapi/linux/kvm.h in Linux for more details.
+    ///
+    struct kvm_mp_state final
+    {
+        /// @brief stores that value of the mp_state
+        bsl::uint32 mp_state;
+    };
+}
+
+#pragma pack(pop)
+
+#endif

shim/integration/CMakeLists.txt

@@ -42,3 +42,6 @@ microv_add_shim_integration(kvm_get_fpu HEADERS)
 microv_add_shim_integration(kvm_set_tss_addr HEADERS)
 microv_add_shim_integration(kvm_set_identity_map_addr HEADERS)
 microv_add_shim_integration(kvm_check_extension HEADERS)
+microv_add_shim_integration(kvm_get_mp_state HEADERS)
+microv_add_shim_integration(kvm_set_mp_state HEADERS)
+microv_add_shim_integration(kvm_get_tsc_khz HEADERS)