cpumctx.h revision e7d8a97e3787122b211311253a20c1600b441f8a
/** @file
* CPUM - CPU Monitor(/ Manager), Context Structures.
*/
/*
* Copyright (C) 2006-2012 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_cpumctx_h
#define ___VBox_vmm_cpumctx_h
#ifndef VBOX_FOR_DTRACE_LIB
# include <iprt/x86.h>
# include <VBox/types.h>
#else
# pragma D depends_on library x86.d
#endif
RT_C_DECLS_BEGIN
/** @addgroup grp_cpum_ctx The CPUM Context Structures
* @ingroup grp_cpum
* @{
*/
/**
* Selector hidden registers.
*/
typedef struct CPUMSELREG
{
/** The selector register. */
RTSEL Sel;
/** Padding, don't use. */
RTSEL PaddingSel;
/** The selector which info resides in u64Base, u32Limit and Attr, provided
* that CPUMSELREG_FLAGS_VALID is set. */
RTSEL ValidSel;
/** Flags, see CPUMSELREG_FLAGS_XXX. */
uint16_t fFlags;
/** Base register.
*
* Long mode remarks:
* - Unused in long mode for CS, DS, ES, SS
* - 32 bits for FS & GS; FS(GS)_BASE msr used for the base address
* - 64 bits for TR & LDTR
*/
uint64_t u64Base;
/** Limit (expanded). */
uint32_t u32Limit;
/** Flags.
* This is the high 32-bit word of the descriptor entry.
* Only the flags, dpl and type are used. */
X86DESCATTR Attr;
} CPUMSELREG;
/** @name CPUMSELREG_FLAGS_XXX - CPUMSELREG::fFlags values.
* @{ */
#define CPUMSELREG_FLAGS_VALID UINT16_C(0x0001)
#define CPUMSELREG_FLAGS_STALE UINT16_C(0x0002)
#define CPUMSELREG_FLAGS_VALID_MASK UINT16_C(0x0003)
/** @} */
/** Checks if the hidden parts of the selector register are valid. */
#ifdef VBOX_WITH_RAW_MODE_NOT_R0
# define CPUMSELREG_ARE_HIDDEN_PARTS_VALID(a_pVCpu, a_pSelReg) \
( ((a_pSelReg)->fFlags & CPUMSELREG_FLAGS_VALID) \
&& ( (a_pSelReg)->ValidSel == (a_pSelReg)->Sel \
|| ( (a_pVCpu) /*!= NULL*/ \
&& (a_pSelReg)->ValidSel == ((a_pSelReg)->Sel & X86_SEL_MASK_OFF_RPL) \
&& ((a_pSelReg)->Sel & X86_SEL_RPL) == 1 \
&& ((a_pSelReg)->ValidSel & X86_SEL_RPL) == 0 \
&& CPUMIsGuestInRawMode(a_pVCpu) \
) \
) \
)
#else
# define CPUMSELREG_ARE_HIDDEN_PARTS_VALID(a_pVCpu, a_pSelReg) \
( ((a_pSelReg)->fFlags & CPUMSELREG_FLAGS_VALID) \
&& (a_pSelReg)->ValidSel == (a_pSelReg)->Sel )
#endif
/** Old type used for the hidden register part.
* @deprecated */
typedef CPUMSELREG CPUMSELREGHID;
/**
* The sysenter register set.
*/
typedef struct CPUMSYSENTER
{
/** Ring 0 cs.
* This value + 8 is the Ring 0 ss.
* This value + 16 is the Ring 3 cs.
* This value + 24 is the Ring 3 ss.
*/
uint64_t cs;
/** Ring 0 eip. */
uint64_t eip;
/** Ring 0 esp. */
uint64_t esp;
} CPUMSYSENTER;
/**
* For compilers (like DTrace) that does not grok nameless unions, we have a
* little hack to make them palatable.
*/
#ifdef VBOX_FOR_DTRACE_LIB
# define CPUM_UNION_NAME(a_Nm) a_Nm
#elif defined(VBOX_WITHOUT_UNNAMED_UNIONS)
# define CPUM_UNION_NAME(a_Nm) a_Nm
#else
# define CPUM_UNION_NAME(a_Nm)
#endif
/**
* CPU context core.
*
* @todo eliminate this structure!
*/
#pragma pack(1)
typedef struct CPUMCTXCORE
{
/** @name General Register.
* @note These follow the encoding order (X86_GREG_XXX) and can be accessed as
* an array starting a rax.
* @{ */
union
{
uint8_t al;
uint16_t ax;
uint32_t eax;
uint64_t rax;
} CPUM_UNION_NAME(rax);
union
{
uint8_t cl;
uint16_t cx;
uint32_t ecx;
uint64_t rcx;
} CPUM_UNION_NAME(rcx);
union
{
uint8_t dl;
uint16_t dx;
uint32_t edx;
uint64_t rdx;
} CPUM_UNION_NAME(rdx);
union
{
uint8_t bl;
uint16_t bx;
uint32_t ebx;
uint64_t rbx;
} CPUM_UNION_NAME(rbx);
union
{
uint16_t sp;
uint32_t esp;
uint64_t rsp;
} CPUM_UNION_NAME(rsp);
union
{
uint16_t bp;
uint32_t ebp;
uint64_t rbp;
} CPUM_UNION_NAME(rbp);
union
{
uint8_t sil;
uint16_t si;
uint32_t esi;
uint64_t rsi;
} CPUM_UNION_NAME(rsi);
union
{
uint8_t dil;
uint16_t di;
uint32_t edi;
uint64_t rdi;
} CPUM_UNION_NAME(rdi);
uint64_t r8;
uint64_t r9;
uint64_t r10;
uint64_t r11;
uint64_t r12;
uint64_t r13;
uint64_t r14;
uint64_t r15;
/** @} */
/** @name Segment registers.
* @note These follow the encoding order (X86_SREG_XXX) and can be accessed as
* an array starting a es.
* @{ */
CPUMSELREG es;
CPUMSELREG cs;
CPUMSELREG ss;
CPUMSELREG ds;
CPUMSELREG fs;
CPUMSELREG gs;
/** @} */
/** The program counter. */
union
{
uint16_t ip;
uint32_t eip;
uint64_t rip;
} CPUM_UNION_NAME(rip);
/** The flags register. */
union
{
X86EFLAGS eflags;
X86RFLAGS rflags;
} CPUM_UNION_NAME(rflags);
} CPUMCTXCORE;
#pragma pack()
/**
* CPU context.
*/
#pragma pack(1) /* for VBOXIDTR / VBOXGDTR. */
typedef struct CPUMCTX
{
/** FPU state. (16-byte alignment)
* @todo This doesn't have to be in X86FXSTATE on CPUs without fxsr - we need a type for the
* actual format or convert it (waste of time). */
X86FXSTATE fpu;
/** CPUMCTXCORE Part.
* @{ */
/** @name General Register.
* @note These follow the encoding order (X86_GREG_XXX) and can be accessed as
* an array starting at rax.
* @{ */
union
{
uint8_t al;
uint16_t ax;
uint32_t eax;
uint64_t rax;
} CPUM_UNION_NAME(rax);
union
{
uint8_t cl;
uint16_t cx;
uint32_t ecx;
uint64_t rcx;
} CPUM_UNION_NAME(rcx);
union
{
uint8_t dl;
uint16_t dx;
uint32_t edx;
uint64_t rdx;
} CPUM_UNION_NAME(rdx);
union
{
uint8_t bl;
uint16_t bx;
uint32_t ebx;
uint64_t rbx;
} CPUM_UNION_NAME(rbx);
union
{
uint16_t sp;
uint32_t esp;
uint64_t rsp;
} CPUM_UNION_NAME(rsp);
union
{
uint16_t bp;
uint32_t ebp;
uint64_t rbp;
} CPUM_UNION_NAME(rbp);
union
{
uint8_t sil;
uint16_t si;
uint32_t esi;
uint64_t rsi;
} CPUM_UNION_NAME(rsi);
union
{
uint8_t dil;
uint16_t di;
uint32_t edi;
uint64_t rdi;
} CPUM_UNION_NAME(rdi);
uint64_t r8;
uint64_t r9;
uint64_t r10;
uint64_t r11;
uint64_t r12;
uint64_t r13;
uint64_t r14;
uint64_t r15;
/** @} */
/** @name Segment registers.
* @note These follow the encoding order (X86_SREG_XXX) and can be accessed as
* an array starting at es.
* @{ */
CPUMSELREG es;
CPUMSELREG cs;
CPUMSELREG ss;
CPUMSELREG ds;
CPUMSELREG fs;
CPUMSELREG gs;
/** @} */
/** The program counter. */
union
{
uint16_t ip;
uint32_t eip;
uint64_t rip;
} CPUM_UNION_NAME(rip);
/** The flags register. */
union
{
X86EFLAGS eflags;
X86RFLAGS rflags;
} CPUM_UNION_NAME(rflags);
/** @} */ /*(CPUMCTXCORE)*/
/** @name Control registers.
* @{ */
uint64_t cr0;
uint64_t cr2;
uint64_t cr3;
uint64_t cr4;
/** @} */
/** Debug registers.
* @remarks DR4 and DR5 should not be used since they are aliases for
* DR6 and DR7 respectively on both AMD and Intel CPUs.
* @remarks DR8-15 are currently not supported by AMD or Intel, so
* neither do we.
*/
uint64_t dr[8];
/** Padding before the structure so the 64-bit member is correctly aligned.
* @todo fix this structure! */
uint16_t gdtrPadding[3];
/** Global Descriptor Table register. */
VBOXGDTR gdtr;
/** Padding before the structure so the 64-bit member is correctly aligned.
* @todo fix this structure! */
uint16_t idtrPadding[3];
/** Interrupt Descriptor Table register. */
VBOXIDTR idtr;
/** The task register.
* Only the guest context uses all the members. */
CPUMSELREG ldtr;
/** The task register.
* Only the guest context uses all the members. */
CPUMSELREG tr;
/** The sysenter msr registers.
* This member is not used by the hypervisor context. */
CPUMSYSENTER SysEnter;
/** @name System MSRs.
* @{ */
uint64_t msrEFER;
uint64_t msrSTAR; /**< Legacy syscall eip, cs & ss. */
uint64_t msrPAT; /**< Page attribute table. */
uint64_t msrLSTAR; /**< 64 bits mode syscall rip. */
uint64_t msrCSTAR; /**< Compatibility mode syscall rip. */
uint64_t msrSFMASK; /**< syscall flag mask. */
uint64_t msrKERNELGSBASE; /**< swapgs exchange value. */
uint64_t msrApicBase; /**< The local APIC base (IA32_APIC_BASE MSR). */
/** @} */
/** Size padding. */
uint32_t au32SizePadding[6];
} CPUMCTX;
#pragma pack()
#ifndef VBOX_FOR_DTRACE_LIB
/**
* Gets the CPUMCTXCORE part of a CPUMCTX.
*/
# define CPUMCTX2CORE(pCtx) ((PCPUMCTXCORE)(void *)&(pCtx)->rax)
/**
* Gets the first selector register of a CPUMCTX.
*
* Use this with X86_SREG_COUNT to loop thru the selector registers.
*/
# define CPUMCTX_FIRST_SREG(a_pCtx) (&(a_pCtx)->es)
#endif /* !VBOX_FOR_DTRACE_LIB */
/**
* Additional guest MSRs (i.e. not part of the CPU context structure).
*
* @remarks Never change the order here because of the saved stated! The size
* can in theory be changed, but keep older VBox versions in mind.
*/
typedef union CPUMCTXMSRS
{
struct
{
uint64_t TscAux; /**< MSR_K8_TSC_AUX */
uint64_t MiscEnable; /**< MSR_IA32_MISC_ENABLE */
uint64_t MtrrDefType; /**< IA32_MTRR_DEF_TYPE */
uint64_t MtrrFix64K_00000; /**< IA32_MTRR_FIX16K_80000 */
uint64_t MtrrFix16K_80000; /**< IA32_MTRR_FIX16K_80000 */
uint64_t MtrrFix16K_A0000; /**< IA32_MTRR_FIX16K_A0000 */
uint64_t MtrrFix4K_C0000; /**< IA32_MTRR_FIX4K_C0000 */
uint64_t MtrrFix4K_C8000; /**< IA32_MTRR_FIX4K_C8000 */
uint64_t MtrrFix4K_D0000; /**< IA32_MTRR_FIX4K_D0000 */
uint64_t MtrrFix4K_D8000; /**< IA32_MTRR_FIX4K_D8000 */
uint64_t MtrrFix4K_E0000; /**< IA32_MTRR_FIX4K_E0000 */
uint64_t MtrrFix4K_E8000; /**< IA32_MTRR_FIX4K_E8000 */
uint64_t MtrrFix4K_F0000; /**< IA32_MTRR_FIX4K_F0000 */
uint64_t MtrrFix4K_F8000; /**< IA32_MTRR_FIX4K_F8000 */
} msr;
uint64_t au64[64];
} CPUMCTXMSRS;
/** Pointer to the guest MSR state. */
typedef CPUMCTXMSRS *PCPUMCTXMSRS;
/** Pointer to the const guest MSR state. */
typedef const CPUMCTXMSRS *PCCPUMCTXMSRS;
/**
* The register set returned by a CPUID operation.
*/
typedef struct CPUMCPUID
{
uint32_t eax;
uint32_t ebx;
uint32_t ecx;
uint32_t edx;
} CPUMCPUID;
/** Pointer to a CPUID leaf. */
typedef CPUMCPUID *PCPUMCPUID;
/** Pointer to a const CPUID leaf. */
typedef const CPUMCPUID *PCCPUMCPUID;
/** @} */
RT_C_DECLS_END
#endif