uvm.h revision 0b74a2f80aba476dc8be8bc1c63891fc53945986
/** @file
* GVM - The Global VM Data.
*/
/*
* Copyright (C) 2007-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_vmm_uvm_h
#define ___VBox_vmm_uvm_h
#include <VBox/types.h>
#include <iprt/assert.h>
/**
* Per virtual CPU ring-3 (user mode) data.
*/
typedef struct UVMCPU
{
/** Pointer to the UVM structure. */
PUVM pUVM;
/** Pointer to the VM structure. */
PVM pVM;
/** Pointer to the VMCPU structure. */
PVMCPU pVCpu;
/** The virtual CPU ID. */
RTCPUID idCpu;
/** Alignment padding. */
uint8_t abAlignment0[HC_ARCH_BITS == 32 ? 16 : 4];
/** The VM internal data. */
union
{
#ifdef ___VMInternal_h
struct VMINTUSERPERVMCPU s;
#endif
uint8_t padding[512];
} vm;
} UVMCPU;
AssertCompileMemberAlignment(UVMCPU, vm, 32);
/**
* The ring-3 (user mode) VM structure.
*
* This structure is similar to VM and GVM except that it resides in swappable
* user memory. The main purpose is to assist bootstrapping, where it allows us
* to start EMT much earlier and gives PDMLdr somewhere to put it's VMMR0 data.
* It is also a nice place to put big things that are user mode only.
*/
typedef struct UVM
{
/** Magic / eye-catcher (UVM_MAGIC). */
uint32_t u32Magic;
/** The number of virtual CPUs. */
uint32_t cCpus;
/** The ring-3 mapping of the shared VM structure. */
PVM pVM;
/** Pointer to the next VM.
* We keep a per process list of VM for the event that a process could
* contain more than one VM.
* @todo move this into vm.s!
*/
struct UVM *pNext;
/** Pointer to the optional method table provided by the VMM user. */
PCVMM2USERMETHODS pVmm2UserMethods;
#if HC_ARCH_BITS == 32
/** Align the next member on a 32 byte boundary. */
uint8_t abAlignment0[HC_ARCH_BITS == 32 ? 12 : 0];
#endif
/** The VM internal data. */
union
{
#ifdef ___VMInternal_h
struct VMINTUSERPERVM s;
#endif
uint8_t padding[512];
} vm;
/** The MM data. */
union
{
#ifdef ___MMInternal_h
struct MMUSERPERVM s;
#endif
uint8_t padding[32];
} mm;
/** The PDM data. */
union
{
#ifdef ___PDMInternal_h
struct PDMUSERPERVM s;
#endif
uint8_t padding[128];
} pdm;
/** The STAM data. */
union
{
#ifdef ___STAMInternal_h
struct STAMUSERPERVM s;
#endif
uint8_t padding[4096];
} stam;
/** Per virtual CPU data. */
UVMCPU aCpus[1];
} UVM;
AssertCompileMemberAlignment(UVM, vm, 32);
AssertCompileMemberAlignment(UVM, mm, 32);
AssertCompileMemberAlignment(UVM, pdm, 32);
AssertCompileMemberAlignment(UVM, stam, 32);
AssertCompileMemberAlignment(UVM, aCpus, 32);
/** The UVM::u32Magic value (Brad Mehldau). */
#define UVM_MAGIC 0x19700823
/** @def UVM_ASSERT_VALID_EXT_RETURN
* Asserts a the VM handle is valid for external access, i.e. not being
* destroy or terminated.
*/
#define UVM_ASSERT_VALID_EXT_RETURN(pVM, rc) \
AssertMsgReturn( RT_VALID_ALIGNED_PTR(pVM, PAGE_SIZE) \
&& (pUVM)->u32Magic == UVM_MAGIC, \
("pUVM=%p u32Magic=%#x\n", (pUVM), \
RT_VALID_ALIGNED_PTR(pVM, PAGE_SIZE) ? (pUVM)->u32Magic : 0), \
(rc))
#endif