Current File : //lib/virtualbox/dtrace/lib/amd64/CPUMInternal.d
/* $Id: CPUMInternal.h 127984 2019-01-07 13:48:16Z aeichner $ */
/** @file
* CPUM - Internal header file.
*/
/*
* Copyright (C) 2006-2019 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.
*/
#pragma D depends_on library x86.d
#pragma D depends_on library cpumctx.d
#pragma D depends_on library cpum.d
/* Some fudging. */
typedef uint64_t STAMCOUNTER;
/** @defgroup grp_cpum_int Internals
* @ingroup grp_cpum
* @internal
* @{
*/
/** Flags and types for CPUM fault handlers
* @{ */
/** Type: Load DS */
inline uint8_t CPUM_HANDLER_DS = 1;
/** Type: Load ES */
inline uint8_t CPUM_HANDLER_ES = 2;
/** Type: Load FS */
inline uint8_t CPUM_HANDLER_FS = 3;
/** Type: Load GS */
inline uint8_t CPUM_HANDLER_GS = 4;
/** Type: IRET */
inline uint8_t CPUM_HANDLER_IRET = 5;
/** Type mask. */
inline uint8_t CPUM_HANDLER_TYPEMASK = 0xff;
/** If set EBP points to the CPUMCTXCORE that's being used. */
inline uint32_t CPUM_HANDLER_CTXCORE_IN_EBP = 1U << 31;
/** @} */
/** Use flags (CPUM::fUseFlags).
* (Don't forget to sync this with CPUMInternal.mac !)
* @note Part of saved state.
* @{ */
/** Indicates that we've saved the host FPU, SSE, whatever state and that it
* needs to be restored. */
inline uint32_t CPUM_USED_FPU_HOST = 1U << 0;
/** Indicates that we've loaded the guest FPU, SSE, whatever state and that it
* needs to be saved. */
inline uint32_t CPUM_USED_FPU_GUEST = 1U << 10;
/** Used the guest FPU, SSE or such stuff since last we were in REM.
* REM syncing is clearing this, lazy FPU is setting it. */
inline uint32_t CPUM_USED_FPU_SINCE_REM = 1U << 1;
/** The XMM state was manually restored. (AMD only) */
inline uint32_t CPUM_USED_MANUAL_XMM_RESTORE = 1U << 2;
/** Host OS is using SYSENTER and we must NULL the CS. */
inline uint32_t CPUM_USE_SYSENTER = 1U << 3;
/** Host OS is using SYSENTER and we must NULL the CS. */
inline uint32_t CPUM_USE_SYSCALL = 1U << 4;
/** Debug registers are used by host and that DR7 and DR6 must be saved and
* disabled when switching to raw-mode. */
inline uint32_t CPUM_USE_DEBUG_REGS_HOST = 1U << 5;
/** Records that we've saved the host DRx registers.
* In ring-0 this means all (DR0-7), while in raw-mode context this means DR0-3
* since DR6 and DR7 are covered by CPUM_USE_DEBUG_REGS_HOST. */
inline uint32_t CPUM_USED_DEBUG_REGS_HOST = 1U << 6;
/** Set to indicate that we should save host DR0-7 and load the hypervisor debug
* registers in the raw-mode world switchers. (See CPUMRecalcHyperDRx.) */
inline uint32_t CPUM_USE_DEBUG_REGS_HYPER = 1U << 7;
/** Used in ring-0 to indicate that we have loaded the hypervisor debug
* registers. */
inline uint32_t CPUM_USED_DEBUG_REGS_HYPER = 1U << 8;
/** Used in ring-0 to indicate that we have loaded the guest debug
* registers (DR0-3 and maybe DR6) for direct use by the guest.
* DR7 (and AMD-V DR6) are handled via the VMCB. */
inline uint32_t CPUM_USED_DEBUG_REGS_GUEST = 1U << 9;
/** Sync the FPU state on next entry (32->64 switcher only). */
inline uint32_t CPUM_SYNC_FPU_STATE = 1U << 16;
/** Sync the debug state on next entry (32->64 switcher only). */
inline uint32_t CPUM_SYNC_DEBUG_REGS_GUEST = 1U << 17;
/** Sync the debug state on next entry (32->64 switcher only).
* Almost the same as CPUM_USE_DEBUG_REGS_HYPER in the raw-mode switchers. */
inline uint32_t CPUM_SYNC_DEBUG_REGS_HYPER = 1U << 18;
/** Host CPU requires fxsave/fxrstor leaky bit handling. */
inline uint32_t CPUM_USE_FFXSR_LEAKY = 1U << 19;
/** Set if the VM supports long-mode. */
inline uint32_t CPUM_USE_SUPPORTS_LONGMODE = 1U << 20;
/** @} */
/** @name CPUM Saved State Version.
* @{ */
/** The current saved state version. */
/** The saved state version including SVM hardware virtualization state. */
inline uint8_t CPUM_SAVED_STATE_VERSION_HWVIRT_SVM = 18;
/** The saved state version including XSAVE state. */
inline uint8_t CPUM_SAVED_STATE_VERSION_XSAVE = 17;
/** The saved state version with good CPUID leaf count. */
inline uint8_t CPUM_SAVED_STATE_VERSION_GOOD_CPUID_COUNT = 16;
/** CPUID changes with explode forgetting to update the leaf count on
* restore, resulting in garbage being saved restoring+saving old states). */
inline uint8_t CPUM_SAVED_STATE_VERSION_BAD_CPUID_COUNT = 15;
/** The saved state version before the CPUIDs changes. */
inline uint8_t CPUM_SAVED_STATE_VERSION_PUT_STRUCT = 14;
/** The saved state version before using SSMR3PutStruct. */
inline uint8_t CPUM_SAVED_STATE_VERSION_MEM = 13;
/** The saved state version before introducing the MSR size field. */
inline uint8_t CPUM_SAVED_STATE_VERSION_NO_MSR_SIZE = 12;
/** The saved state version of 3.2, 3.1 and 3.3 trunk before the hidden
* selector register change (CPUM_CHANGED_HIDDEN_SEL_REGS_INVALID). */
inline uint8_t CPUM_SAVED_STATE_VERSION_VER3_2 = 11;
/** The saved state version of 3.0 and 3.1 trunk before the teleportation
* changes. */
inline uint8_t CPUM_SAVED_STATE_VERSION_VER3_0 = 10;
/** The saved state version for the 2.1 trunk before the MSR changes. */
inline uint8_t CPUM_SAVED_STATE_VERSION_VER2_1_NOMSR = 9;
/** The saved state version of 2.0, used for backwards compatibility. */
inline uint8_t CPUM_SAVED_STATE_VERSION_VER2_0 = 8;
/** The saved state version of 1.6, used for backwards compatibility. */
inline uint8_t CPUM_SAVED_STATE_VERSION_VER1_6 = 6;
/** @} */
/**
* CPU info
*/
typedef struct CPUMINFO
{
/** The number of MSR ranges (CPUMMSRRANGE) in the array pointed to below. */
uint32_t cMsrRanges;
/** Mask applied to ECX before looking up the MSR for a RDMSR/WRMSR
* instruction. Older hardware has been observed to ignore higher bits. */
uint32_t fMsrMask;
/** MXCSR mask. */
uint32_t fMxCsrMask;
/** The number of CPUID leaves (CPUMCPUIDLEAF) in the array pointed to below. */
uint32_t cCpuIdLeaves;
/** The index of the first extended CPUID leaf in the array.
* Set to cCpuIdLeaves if none present. */
uint32_t iFirstExtCpuIdLeaf;
/** How to handle unknown CPUID leaves. */
CPUMUNKNOWNCPUID enmUnknownCpuIdMethod;
/** For use with CPUMUNKNOWNCPUID_DEFAULTS (DB & VM),
* CPUMUNKNOWNCPUID_LAST_STD_LEAF (VM) and CPUMUNKNOWNCPUID_LAST_STD_LEAF_WITH_ECX (VM). */
CPUMCPUID DefCpuId;
/** Scalable bus frequency used for reporting other frequencies. */
uint64_t uScalableBusFreq;
/** Pointer to the MSR ranges (ring-0 pointer). */
PCPUMMSRRANGE paMsrRangesR0;
/** Pointer to the CPUID leaves (ring-0 pointer). */
PCPUMCPUIDLEAF paCpuIdLeavesR0;
/** Pointer to the MSR ranges (ring-3 pointer). */
RTR3PTR paMsrRangesR3;
/** Pointer to the CPUID leaves (ring-3 pointer). */
RTR3PTR paCpuIdLeavesR3;
/** Pointer to the MSR ranges (raw-mode context pointer). */
RTRCPTR paMsrRangesRC;
/** Pointer to the CPUID leaves (raw-mode context pointer). */
RTRCPTR paCpuIdLeavesRC;
} CPUMINFO;
/** Pointer to a CPU info structure. */
typedef CPUMINFO *PCPUMINFO;
/** Pointer to a const CPU info structure. */
typedef CPUMINFO const *CPCPUMINFO;
/**
* The saved host CPU state.
*/
typedef struct CPUMHOSTCTX
{
/** General purpose register, selectors, flags and more
* @{ */
/** General purpose register ++
* { */
/*uint64_t rax; - scratch*/
uint64_t rbx;
/*uint64_t rcx; - scratch*/
/*uint64_t rdx; - scratch*/
uint64_t rdi;
uint64_t rsi;
uint64_t rbp;
uint64_t rsp;
/*uint64_t r8; - scratch*/
/*uint64_t r9; - scratch*/
uint64_t r10;
uint64_t r11;
uint64_t r12;
uint64_t r13;
uint64_t r14;
uint64_t r15;
/*uint64_t rip; - scratch*/
uint64_t rflags;
/** @} */
/** Selector registers
* @{ */
RTSEL ss;
RTSEL ssPadding;
RTSEL gs;
RTSEL gsPadding;
RTSEL fs;
RTSEL fsPadding;
RTSEL es;
RTSEL esPadding;
RTSEL ds;
RTSEL dsPadding;
RTSEL cs;
RTSEL csPadding;
/** @} */
/** Control registers.
* @{ */
/** The CR0 FPU state in HM mode. */
uint64_t cr0;
/*uint64_t cr2; - scratch*/
uint64_t cr3;
uint64_t cr4;
uint64_t cr8;
/** @} */
/** Debug registers.
* @{ */
uint64_t dr0;
uint64_t dr1;
uint64_t dr2;
uint64_t dr3;
uint64_t dr6;
uint64_t dr7;
/** @} */
/** Global Descriptor Table register. */
X86XDTR64 gdtr;
uint16_t gdtrPadding;
/** Interrupt Descriptor Table register. */
X86XDTR64 idtr;
uint16_t idtrPadding;
/** The task register. */
RTSEL ldtr;
RTSEL ldtrPadding;
/** The task register. */
RTSEL tr;
RTSEL trPadding;
/** MSRs
* @{ */
CPUMSYSENTER SysEnter;
uint64_t FSbase;
uint64_t GSbase;
uint64_t efer;
/** @} */
/* padding to get 64byte aligned size */
uint8_t auPadding[4];
/** Pointer to the FPU/SSE/AVX/XXXX state raw-mode mapping. */
RTRCPTR pXStateRC;
/** Pointer to the FPU/SSE/AVX/XXXX state ring-0 mapping. */
PX86XSAVEAREA pXStateR0;
/** Pointer to the FPU/SSE/AVX/XXXX state ring-3 mapping. */
RTR3PTR pXStateR3;
/** The XCR0 register. */
uint64_t xcr0;
/** The mask to pass to XSAVE/XRSTOR in EDX:EAX. If zero we use
* FXSAVE/FXRSTOR (since bit 0 will always be set, we only need to test it). */
uint64_t fXStateMask;
} CPUMHOSTCTX;
/** Pointer to the saved host CPU state. */
typedef CPUMHOSTCTX *PCPUMHOSTCTX;
/**
* CPUM Data (part of VM)
*/
typedef struct CPUM
{
/** Offset from CPUM to CPUMCPU for the first CPU. */
uint32_t offCPUMCPU0;
/** Use flags.
* These flags indicates which CPU features the host uses.
*/
uint32_t fHostUseFlags;
/** CR4 mask */
struct
{
uint32_t AndMask; /**< @todo Move these to the per-CPU structure and fix the switchers. Saves a register! */
uint32_t OrMask;
} CR4;
/** The (more) portable CPUID level. */
uint8_t u8PortableCpuIdLevel;
/** Indicates that a state restore is pending.
* This is used to verify load order dependencies (PGM). */
uint8_t fPendingRestore;
uint8_t abPadding0[6];
/** XSAVE/XRTOR components we can expose to the guest mask. */
uint64_t fXStateGuestMask;
/** XSAVE/XRSTOR host mask. Only state components in this mask can be exposed
* to the guest. This is 0 if no XSAVE/XRSTOR bits can be exposed. */
uint64_t fXStateHostMask;
/** The host MXCSR mask (determined at init). */
uint32_t fHostMxCsrMask;
uint8_t abPadding1[20];
/** Host CPU feature information.
* Externaly visible via the VM structure, aligned on 64-byte boundrary. */
CPUMFEATURES HostFeatures;
/** Guest CPU feature information.
* Externaly visible via that VM structure, aligned with HostFeatures. */
CPUMFEATURES GuestFeatures;
/** Guest CPU info. */
CPUMINFO GuestInfo;
/** The standard set of CpuId leaves. */
CPUMCPUID aGuestCpuIdPatmStd[6];
/** The extended set of CpuId leaves. */
CPUMCPUID aGuestCpuIdPatmExt[10];
/** The centaur set of CpuId leaves. */
CPUMCPUID aGuestCpuIdPatmCentaur[4];
/** @name MSR statistics.
* @{ */
STAMCOUNTER cMsrWrites;
STAMCOUNTER cMsrWritesToIgnoredBits;
STAMCOUNTER cMsrWritesRaiseGp;
STAMCOUNTER cMsrWritesUnknown;
STAMCOUNTER cMsrReads;
STAMCOUNTER cMsrReadsRaiseGp;
STAMCOUNTER cMsrReadsUnknown;
/** @} */
} CPUM;
/** Pointer to the CPUM instance data residing in the shared VM structure. */
typedef CPUM *PCPUM;
/**
* CPUM Data (part of VMCPU)
*/
typedef struct CPUMCPU
{
/**
* Guest context.
* Aligned on a 64-byte boundary.
*/
CPUMCTX Guest;
/**
* Guest context - misc MSRs
* Aligned on a 64-byte boundary.
*/
CPUMCTXMSRS GuestMsrs;
/** Use flags.
* These flags indicates both what is to be used and what has been used.
*/
uint32_t fUseFlags;
/** Changed flags.
* These flags indicates to REM (and others) which important guest
* registers which has been changed since last time the flags were cleared.
* See the CPUM_CHANGED_* defines for what we keep track of.
*/
uint32_t fChanged;
/** Offset from CPUM to CPUMCPU. */
uint32_t offCPUM;
/** Temporary storage for the return code of the function called in the
* 32-64 switcher. */
uint32_t u32RetCode;
/** The address of the APIC mapping, NULL if no APIC.
* Call CPUMR0SetLApic to update this before doing a world switch. */
RTHCPTR pvApicBase;
/** Used by the world switcher code to store which vectors needs restoring on
* the way back. */
uint32_t fApicDisVectors;
/** Set if the CPU has the X2APIC mode enabled.
* Call CPUMR0SetLApic to update this before doing a world switch. */
uint8_t fX2Apic;
/** Have we entered raw-mode? */
uint8_t fRawEntered;
/** Have we entered the recompiler? */
uint8_t fRemEntered;
/** Whether the X86_CPUID_FEATURE_EDX_APIC and X86_CPUID_AMD_FEATURE_EDX_APIC
* (?) bits are visible or not. (The APIC is responsible for setting this
* when loading state, so we won't save it.) */
uint8_t fCpuIdApicFeatureVisible;
/** Align the next member on a 64-byte boundrary. */
uint8_t abPadding2[64 - 16 - (64 == 64 ? 8 : 4) - 4 - 1 - 3];
/** Saved host context. Only valid while inside RC or HM contexts.
* Must be aligned on a 64-byte boundary. */
CPUMHOSTCTX Host;
/** Hypervisor context. Must be aligned on a 64-byte boundary. */
CPUMCTX Hyper;
} CPUMCPU;
/** Pointer to the CPUMCPU instance data residing in the shared VMCPU structure. */
typedef CPUMCPU *PCPUMCPU;
/** @} */
Mini Shell