GIM.cpp revision 236b2935f217749893b7034e59da3e3568928ace
236b2935f217749893b7034e59da3e3568928acevboxsync * GIM - Guest Interface Manager.
236b2935f217749893b7034e59da3e3568928acevboxsync * Copyright (C) 2014 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/** @page pg_gim GIM - The Guest Interface Manager
236b2935f217749893b7034e59da3e3568928acevboxsync * The Guest Interface Manager abstracts an interface provider through which
236b2935f217749893b7034e59da3e3568928acevboxsync * guests may interact with the hypervisor.
236b2935f217749893b7034e59da3e3568928acevboxsync * @see grp_gim
236b2935f217749893b7034e59da3e3568928acevboxsync * @section sec_gim_provider Providers
236b2935f217749893b7034e59da3e3568928acevboxsync * A GIM provider implements a particular hypervisor interface such as Microsoft
236b2935f217749893b7034e59da3e3568928acevboxsync * Hyper-V, Linux KVM and so on. It hooks into various components in the VMM to
236b2935f217749893b7034e59da3e3568928acevboxsync * ease the guest in running under a recognized virtualized environment. This is
236b2935f217749893b7034e59da3e3568928acevboxsync * also referred to as paravirtualization interfaces.
236b2935f217749893b7034e59da3e3568928acevboxsync * The idea behind this is primarily for making guests more accurate and
236b2935f217749893b7034e59da3e3568928acevboxsync * efficient when operating in a virtualized environment.
236b2935f217749893b7034e59da3e3568928acevboxsync * For instance, a guest when interfaced to VirtualBox through a GIM provider
236b2935f217749893b7034e59da3e3568928acevboxsync * may rely on the provider (and VirtualBox ultimately) for providing the
236b2935f217749893b7034e59da3e3568928acevboxsync * correct TSC frequency and may therefore not have to caliberate the TSC
236b2935f217749893b7034e59da3e3568928acevboxsync * itself, resulting in higher accuracy and saving several CPU cycles.
236b2935f217749893b7034e59da3e3568928acevboxsync * Only one provider can be active for a running VM.
236b2935f217749893b7034e59da3e3568928acevboxsync/*******************************************************************************
236b2935f217749893b7034e59da3e3568928acevboxsync* Header Files *
236b2935f217749893b7034e59da3e3568928acevboxsync*******************************************************************************/
236b2935f217749893b7034e59da3e3568928acevboxsync/* Include all GIM providers. */
236b2935f217749893b7034e59da3e3568928acevboxsync/*******************************************************************************
236b2935f217749893b7034e59da3e3568928acevboxsync* Internal Functions *
236b2935f217749893b7034e59da3e3568928acevboxsync*******************************************************************************/
236b2935f217749893b7034e59da3e3568928acevboxsyncstatic DECLCALLBACK(int) gimR3Save(PVM pVM, PSSMHANDLE pSSM);
236b2935f217749893b7034e59da3e3568928acevboxsyncstatic DECLCALLBACK(int) gimR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
236b2935f217749893b7034e59da3e3568928acevboxsync * Initializes the GIM.
236b2935f217749893b7034e59da3e3568928acevboxsync * @returns VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pVM Pointer to the VM.
236b2935f217749893b7034e59da3e3568928acevboxsync * Assert alignment and sizes.
236b2935f217749893b7034e59da3e3568928acevboxsync AssertCompile(sizeof(pVM->gim.s) <= sizeof(pVM->gim.padding));
236b2935f217749893b7034e59da3e3568928acevboxsync * Register the saved state data unit.
236b2935f217749893b7034e59da3e3568928acevboxsync rc = SSMR3RegisterInternal(pVM, "GIM", 0, GIM_SSM_VERSION, sizeof(GIM),
236b2935f217749893b7034e59da3e3568928acevboxsync * Read configuration.
236b2935f217749893b7034e59da3e3568928acevboxsync PCFGMNODE pCfgNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "GIM/");
236b2935f217749893b7034e59da3e3568928acevboxsync /** @cfgm{GIM/Provider, string}
236b2935f217749893b7034e59da3e3568928acevboxsync * The name of the GIM provider. The default is "none". */
236b2935f217749893b7034e59da3e3568928acevboxsync rc = CFGMR3QueryStringDef(pCfgNode, "Provider", szProvider, sizeof(szProvider), "none");
236b2935f217749893b7034e59da3e3568928acevboxsync * Setup the GIM provider for this VM.
236b2935f217749893b7034e59da3e3568928acevboxsync LogRel(("GIM: Using provider \"%s\"\n", szProvider));
236b2935f217749893b7034e59da3e3568928acevboxsync /** @todo KVM and others. */
236b2935f217749893b7034e59da3e3568928acevboxsync LogRel(("GIM: Provider \"%s\" unknown.\n", szProvider));
236b2935f217749893b7034e59da3e3568928acevboxsync * Applies relocations to data and code managed by this
236b2935f217749893b7034e59da3e3568928acevboxsync * component. This function will be called at init and
236b2935f217749893b7034e59da3e3568928acevboxsync * whenever the VMM need to relocate it self inside the GC.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pVM Pointer to the VM.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param offDelta Relocation delta relative to old location.
236b2935f217749893b7034e59da3e3568928acevboxsyncVMM_INT_DECL(void) GIMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
236b2935f217749893b7034e59da3e3568928acevboxsync AssertMsgFailed(("Invalid provider id %#x\n", pVM->gim.s.enmProvider));
236b2935f217749893b7034e59da3e3568928acevboxsync * Execute state save operation.
236b2935f217749893b7034e59da3e3568928acevboxsync * @returns VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pVM Pointer to the VM.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pSSM SSM operation handle.
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLCALLBACK(int) gimR3Save(PVM pVM, PSSMHANDLE pSSM)
236b2935f217749893b7034e59da3e3568928acevboxsync /** @todo save state. */
236b2935f217749893b7034e59da3e3568928acevboxsync * Execute state load operation.
236b2935f217749893b7034e59da3e3568928acevboxsync * @returns VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pVM Pointer to the VM.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pSSM SSM operation handle.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param uVersion Data layout version.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param uPass The data pass.
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLCALLBACK(int) gimR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
236b2935f217749893b7034e59da3e3568928acevboxsync /** @todo load state. */
236b2935f217749893b7034e59da3e3568928acevboxsync * Terminates the GIM.
236b2935f217749893b7034e59da3e3568928acevboxsync * Termination means cleaning up and freeing all resources,
236b2935f217749893b7034e59da3e3568928acevboxsync * the VM itself is, at this point, powered off or suspended.
236b2935f217749893b7034e59da3e3568928acevboxsync * @returns VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pVM Pointer to the VM.