236b2935f217749893b7034e59da3e3568928acevboxsync * GIM - Guest Interface Manager - All Contexts.
f84ab9e4599e758ec1f36479f871b3f5b7f271f2vboxsync * Copyright (C) 2014-2015 Oracle Corporation
236b2935f217749893b7034e59da3e3568928acevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
236b2935f217749893b7034e59da3e3568928acevboxsync * available from http://www.virtualbox.org. This file is free software;
236b2935f217749893b7034e59da3e3568928acevboxsync * you can redistribute it and/or modify it under the terms of the GNU
236b2935f217749893b7034e59da3e3568928acevboxsync * General Public License (GPL) as published by the Free Software
236b2935f217749893b7034e59da3e3568928acevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
236b2935f217749893b7034e59da3e3568928acevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
236b2935f217749893b7034e59da3e3568928acevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
236b2935f217749893b7034e59da3e3568928acevboxsync/*******************************************************************************
236b2935f217749893b7034e59da3e3568928acevboxsync* Header Files *
236b2935f217749893b7034e59da3e3568928acevboxsync*******************************************************************************/
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync/* Include all the providers. */
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * Checks whether GIM is being used by this VM.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @retval @c true if used.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @retval @c false if no GIM provider ("none") is used.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pVM Pointer to the VM.
4ae0ac3d0dc641305a0b0197db43ee7c4b40f747vboxsync return pVM->gim.s.enmProviderId != GIMPROVIDERID_NONE;
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Gets the GIM provider configured for this VM.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @returns The GIM provider Id.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pVM Pointer to the VM.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * Returns whether the guest has configured and enabled calls to the hypervisor.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * @returns true if hypercalls are enabled and usable, false otherwise.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * @param pVCpu Pointer to the VMCPU.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsyncVMM_INT_DECL(bool) GIMAreHypercallsEnabled(PVMCPU pVCpu)
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync return false;
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync return false;
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * Implements a GIM hypercall with the provider configured for the VM.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @returns VBox status code.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pVCpu Pointer to the VMCPU.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pCtx Pointer to the guest-CPU context.
236b2935f217749893b7034e59da3e3568928acevboxsyncVMM_INT_DECL(int) GIMHypercall(PVMCPU pVCpu, PCPUMCTX pCtx)
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync AssertMsgFailed(("GIMHypercall: for provider %u not available/implemented\n", pVM->gim.s.enmProviderId));
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * Returns whether the guest has configured and setup the use of paravirtualized
6d0dfca130b3267e60e6dcb6f8cea0487534680avboxsync * Paravirtualized TSCs are per-VM and the rest of the execution engine logic
6d0dfca130b3267e60e6dcb6f8cea0487534680avboxsync * relies on that.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * @returns true if enabled and usable, false otherwise.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * @param pVM Pointer to the VM.
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync return false;
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * Whether #UD exceptions in the guest needs to be intercepted by the GIM
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * provider.
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * At the moment, the reason why this isn't a more generic interface wrt to
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * exceptions is because of performance (each VM-exit would have to manually
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * check whether or not GIM needs to be notified). Left as a todo for later if
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * really required.
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * @returns true if needed, false otherwise.
66d96ba0c4c722996a3a1e6d92403a14a27db1b4vboxsync * @param pVCpu Pointer to the VMCPU.
66d96ba0c4c722996a3a1e6d92403a14a27db1b4vboxsyncVMM_INT_DECL(bool) GIMShouldTrapXcptUD(PVMCPU pVCpu)
fa35e2dfd910e18dbb7f136bfe56030e5116d51cvboxsync return false;
fa35e2dfd910e18dbb7f136bfe56030e5116d51cvboxsync return false;
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * Exception handler for #UD when requested by the GIM provider.
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * @param pVCpu Pointer to the VMCPU.
9c178a84047ec38c02debb747cbdc7de4531d940vboxsync * @param pCtx Pointer to the guest-CPU context.
fa35e2dfd910e18dbb7f136bfe56030e5116d51cvboxsync * @param pDis Pointer to the disassembled instruction state at RIP.
fa35e2dfd910e18dbb7f136bfe56030e5116d51cvboxsync * Optional, can be NULL.
fa35e2dfd910e18dbb7f136bfe56030e5116d51cvboxsyncVMM_INT_DECL(int) GIMXcptUD(PVMCPU pVCpu, PCPUMCTX pCtx, PDISCPUSTATE pDis)
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * Invokes the read-MSR handler for the GIM provider configured for the VM.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @returns Strict VBox status code like CPUMQueryGuestMsr.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @retval VINF_CPUM_R3_MSR_READ
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @retval VERR_CPUM_RAISE_GP_0
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pVCpu Pointer to the VMCPU.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param idMsr The MSR to read.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pRange The range this MSR belongs to.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param puValue Where to store the MSR value read.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsyncVMM_INT_DECL(VBOXSTRICTRC) GIMReadMsr(PVMCPU pVCpu, uint32_t idMsr, PCCPUMMSRRANGE pRange, uint64_t *puValue)
f84ab9e4599e758ec1f36479f871b3f5b7f271f2vboxsync return gimHvReadMsr(pVCpu, idMsr, pRange, puValue);
0bc35f54322c5f9b2d43b064f839a8cf8c99a234vboxsync return gimKvmReadMsr(pVCpu, idMsr, pRange, puValue);
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync AssertMsgFailed(("GIMReadMsr: for unknown provider %u idMsr=%#RX32 -> #GP(0)", pVM->gim.s.enmProviderId, idMsr));
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * Invokes the write-MSR handler for the GIM provider configured for the VM.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @returns Strict VBox status code like CPUMSetGuestMsr.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @retval VINF_CPUM_R3_MSR_WRITE
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @retval VERR_CPUM_RAISE_GP_0
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pVCpu Pointer to the VMCPU.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param idMsr The MSR to write.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pRange The range this MSR belongs to.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param uValue The value to set, ignored bits masked.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param uRawValue The raw value with the ignored bits not masked.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsyncVMM_INT_DECL(VBOXSTRICTRC) GIMWriteMsr(PVMCPU pVCpu, uint32_t idMsr, PCCPUMMSRRANGE pRange, uint64_t uValue, uint64_t uRawValue)
f84ab9e4599e758ec1f36479f871b3f5b7f271f2vboxsync return gimHvWriteMsr(pVCpu, idMsr, pRange, uRawValue);
0bc35f54322c5f9b2d43b064f839a8cf8c99a234vboxsync return gimKvmWriteMsr(pVCpu, idMsr, pRange, uRawValue);
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync AssertMsgFailed(("GIMWriteMsr: for unknown provider %u idMsr=%#RX32 -> #GP(0)", pVM->gim.s.enmProviderId, idMsr));