Export.c File Reference

Implementation of exported functions from hypervisor. More...

#include "pch.h"

Functions
VOID	VmFuncPerformRipIncrement (UINT32 CoreId)
	Perform the incrementation of RIP.
VOID	VmFuncSuppressRipIncrement (UINT32 CoreId)
	Suppress the incrementation of RIP.
VOID	VmFuncChangeMtfUnsettingState (UINT32 CoreId, BOOLEAN Set)
	Suppress unsetting MTF.
VOID	VmFuncChangeIgnoreOneMtfState (UINT32 CoreId, BOOLEAN Set)
	Change ignore one MTF state.
VOID	VmFuncSetInstrumentationStepInState (UINT32 CoreId)
	Set instrumentation step in MTF (used for single stepping with MTF).
VOID	VmFuncUnsetInstrumentationStepInState (UINT32 CoreId)
	Unset instrumentation step in MTF (used for single stepping with MTF).
BOOLEAN	VmFuncQueryInstrumentationStepInState (UINT32 CoreId)
	Query instrumentation step in MTF state.
VOID	VmFuncSetMonitorTrapFlag (BOOLEAN Set)
	Set the monitor trap flag.
VOID	VmFuncSetRflagTrapFlag (BOOLEAN Set)
	Set Rflag's trap flag.
VOID	VmFuncSetLoadDebugControls (UINT32 CoreId, BOOLEAN Set)
	Set LOAD DEBUG CONTROLS on Vm-entry controls.
VOID	VmFuncSetLoadGuestIa32LbrCtl (UINT32 CoreId, BOOLEAN Set)
	Set LOAD GUEST IA32_LBR_CTL on Vm-entry controls.
VOID	VmFuncSetSaveDebugControls (UINT32 CoreId, BOOLEAN Set)
	Set SAVE DEBUG CONTROLS on Vm-exit controls.
VOID	VmFuncSetClearGuestIa32LbrCtl (UINT32 CoreId, BOOLEAN Set)
	Set CLEAR GUEST IA32_LBR_CTL on Vm-exit controls.
VOID	VmFuncSetPmcVmexit (BOOLEAN Set)
	Set vm-exit for rdpmc instructions.
VOID	VmFuncSetMovControlRegsExiting (BOOLEAN Set, UINT64 ControlRegister, UINT64 MaskRegister)
	Set vm-exit for mov-to-cr0/4.
VOID	VmFuncSetMovToCr3Vmexit (UINT32 CoreId, BOOLEAN Set)
	Set vm-exit for mov-to-cr3.
VOID	VmFuncWriteExceptionBitmap (UINT32 BitmapMask)
	Write on exception bitmap in VMCS DO NOT CALL IT DIRECTLY, instead use HvSetExceptionBitmap.
UINT32	VmFuncReadExceptionBitmap ()
	Read exception bitmap in VMCS.
VOID	VmFuncSetInterruptWindowExiting (BOOLEAN Set)
	Set Interrupt-window exiting.
VOID	VmFuncSetNmiWindowExiting (BOOLEAN Set)
	Set NMI-window exiting.
VOID	VmFuncSetNmiExiting (BOOLEAN Set)
	Set the NMI Exiting.
VOID	VmFuncSetExceptionBitmap (UINT32 CoreId, UINT32 IdtIndex)
	Set exception bitmap in VMCS.
VOID	VmFuncUnsetExceptionBitmap (UINT32 CoreId, UINT32 IdtIndex)
	Unset exception bitmap in VMCS.
VOID	VmFuncSetExternalInterruptExiting (UINT32 CoreId, BOOLEAN Set)
	Set the External Interrupt Exiting.
VOID	VmFuncSetRdtscExiting (UINT32 CoreId, BOOLEAN Set)
	Set the RDTSC/P Exiting.
VOID	VmFuncSetMovDebugRegsExiting (UINT32 CoreId, BOOLEAN Set)
	Set or unset the Mov to Debug Registers Exiting.
UINT64	VmFuncGetLastVmexitRip (UINT32 CoreId)
	get the last vm-exit RIP
VOID	VmFuncInjectPendingExternalInterrupts (UINT32 CoreId)
	Inject pending external interrupts.
UINT16	VmFuncGetCsSelector ()
	Read CS selector.
UINT64	VmFuncGetRflags ()
	Read guest's RFLAGS.
VOID	VmFuncSetRflags (UINT64 Rflags)
	Set guest's RFLAGS.
UINT64	VmFuncGetRip ()
	Read guest's RIP.
VOID	VmFuncSetRip (UINT64 Rip)
	Set guest's RIP.
UINT64	VmFuncGetDebugctl ()
	Get the guest state of IA32_DEBUGCTL.
UINT64	VmFuncGetDebugctlVmcallOnTargetCore ()
	Get the guest state of IA32_DEBUGCTL on the target core from VMCS using VMCALL.
UINT64	VmFuncGetGuestIa32LbrCtl ()
	Get the guest state of IA32_LBR_CTL.
UINT64	VmFuncGetGuestIa32LbrCtlVmcallOnTargetCore ()
	Get the guest state of IA32_LBR_CTL on the target core from VMCS.
BOOLEAN	VmFuncCheckCpuSupportForSaveAndLoadDebugControls ()
	Check if CPU support save and load debug controls on exit and load entries.
BOOLEAN	VmFuncCheckCpuSupportForLoadAndClearGuestIa32LbrCtlControls ()
	Check if CPU support load and clear guest IA32_LBR_CTL controls on VM-entry and VM-exit.
VOID	VmFuncSetDebugctl (UINT64 Value)
	Set the guest state of IA32_DEBUGCTL.
VOID	VmFuncSetDebugctlVmcallOnTargetCore (UINT64 Value)
	Set the guest state of IA32_DEBUGCTL on the target core from VMCS using VMCALL.
VOID	VmFuncSetGuestIa32LbrCtl (UINT64 Value)
	Set the guest state of IA32_LBR_CTL.
VOID	VmFuncSetGuestIa32LbrCtlVmcallOnTargetCore (UINT64 Value)
	Set the guest state of IA32_LBR_CTL on the target core from VMCS using VMCALL.
VOID	VmFuncSetLbrSelect (UINT64 FilterOptions)
	Set the guest state of MSR_LEGACY_LBR_SELECT.
VOID	VmFuncSetLbrSelectVmcallOnTargetCore (UINT64 FilterOptions)
	Set the guest state of MSR_LEGACY_LBR_SELECT on the target core from VMCS using VMCALL.
VOID	VmFuncSetLoadDebugControlsVmcallOnTargetCore (BOOLEAN Set)
	Set LOAD DEBUG CONTROLS on VM-entry controls on the target core from VMCS using VMCALL.
VOID	VmFuncSetLoadGuestIa32LbrCtlVmcallOnTargetCore (BOOLEAN Set)
	Set LOAD GUEST IA32_LBR_CTL on VM-entry controls on the target core from VMCS using VMCALL.
VOID	VmFuncSetSaveDebugControlsVmcallOnTargetCore (BOOLEAN Set)
	Set SAVE DEBUG CONTROLS on VM-exit controls on the target core from VMCS using VMCALL.
VOID	VmFuncSetClearGuestIa32LbrCtlVmcallOnTargetCore (BOOLEAN Set)
	Set CLEAR GUEST IA32_LBR_CTL on VM-exit controls on the target core from VMCS using VMCALL.
VOID	VmFuncSetDebugReg7 (UINT64 Value)
	Set the guest state of DR7.
UINT64	VmFuncGetInterruptibilityState ()
	Read guest's interruptibility state.
UINT64	VmFuncClearSteppingBits (UINT64 Interruptibility)
	Clear STI and MOV SS bits.
VOID	VmFuncSetInterruptibilityState (UINT64 InterruptibilityState)
	Set guest's interruptibility state.
BOOLEAN	VmFuncNmiBroadcastRequest (UINT32 CoreId)
	Broadcast NMI requests.
BOOLEAN	VmFuncNmiBroadcastInvalidateEptSingleContext (UINT32 CoreId)
	Broadcast NMI requests for single-context EPT invalidation.
BOOLEAN	VmFuncNmiBroadcastInvalidateEptAllContexts (UINT32 CoreId)
	Broadcast NMI requests for all contexts EPT invalidation.
VOID	VmFuncInvalidateEptSingleContext (UINT32 CoreId)
	Requests for single-context EPT invalidation.
VOID	VmFuncInvalidateEptAllContexts ()
	Requests for all contexts EPT invalidation.
VOID	VmFuncCheckAndEnableExternalInterrupts (UINT32 CoreId)
	Check and enable external interrupts.
VOID	VmFuncDisableExternalInterruptsAndInterruptWindow (UINT32 CoreId)
	Disable external-interrupts and interrupt window.
BOOLEAN	VmFuncInitVmm (VMM_CALLBACKS *VmmCallbacks)
	Initializes hypervisor.
VOID	VmFuncUninitVmm ()
	Uninitialize Terminate Vmx on all logical cores.
BOOLEAN	VmFuncVmxGetCurrentExecutionMode ()
	Get the current VMX operation state.
BOOLEAN	VmFuncQueryModeExecTrap ()
	Get the current state of mode exec trap mechanism.
VOID	VmFuncSetTriggerEventForVmcalls (BOOLEAN Set)
	Set triggering events for VMCALLs.
VOID	VmFuncSetTriggerEventForCpuids (BOOLEAN Set)
	Set triggering events for CPUIDs.
VOID	VmFuncSetTriggerEventForXsetbvs (BOOLEAN Set)
	Set trigger event for XSETBVs.
UINT32	VmFuncVmxCompatibleStrlen (const CHAR *s)
	VMX-root compatible strlen.
UINT32	VmFuncVmxCompatibleWcslen (const WCHAR *s)
	VMX-root compatible strlen.
VOID	VmFuncVmxCompatibleMicroSleep (UINT64 Us)
	VMX-root compatible micro sleep.
VOID	VmFuncEventInjectPageFaultWithCr2 (UINT32 CoreId, UINT64 Address, UINT32 PageFaultCode)
	Inject #PF and configure CR2 register.
VOID	VmFuncEventInjectPageFaultRangeAddress (UINT32 CoreId, UINT64 AddressFrom, UINT64 AddressTo, UINT32 PageFaultCode)
	Inject a range of page-faults.
VOID	VmFuncEventInjectInterruption (UINT32 InterruptionType, UINT32 Vector, BOOLEAN DeliverErrorCode, UINT32 ErrorCode)
	Inject interrupt/faults/exceptions.
NTSTATUS	VmFuncVmxVmcall (UINT64 VmcallNumber, UINT64 OptionalParam1, UINT64 OptionalParam2, UINT64 OptionalParam3)
	Export for running VMX VMCALLs.
VOID	VmFuncVmxBroadcastInitialize ()
	Export for initialize the VMX Broadcast mechanism.
VOID	VmFuncVmxBroadcastUninitialize ()
	Export for uninitialize the VMX Broadcast mechanism.
VOID	VmFuncEventInjectBreakpoint ()
	Inject #BP to the guest (Event Injection).
INT32	VmFuncVmxCompatibleStrcmp (const CHAR *Address1, const CHAR *Address2)
	VMX-root compatible strcmp.
INT32	VmFuncVmxCompatibleStrncmp (const CHAR *Address1, const CHAR *Address2, SIZE_T Num)
	VMX-root compatible strncmp.
INT32	VmFuncVmxCompatibleWcscmp (const WCHAR *Address1, const WCHAR *Address2)
	VMX-root compatible wcscmp.
INT32	VmFuncVmxCompatibleWcsncmp (const WCHAR *Address1, const WCHAR *Address2, SIZE_T Num)
	VMX-root compatible wcsncmp.
INT32	VmFuncVmxCompatibleMemcmp (const CHAR *Address1, const CHAR *Address2, SIZE_T Count)
	VMX-root compatible memcmp.
VOID	VmFuncEnableMtfAndChangeExternalInterruptState (UINT32 CoreId)
	Enables MTF and adjust external interrupt state.
VOID	VmFuncEnableAndCheckForPreviousExternalInterrupts (UINT32 CoreId)
	Checks to enable and reinject previous interrupts.
BOOLEAN	VmFuncApicStoreLocalApicFields (PLAPIC_PAGE LocalApicBuffer, PBOOLEAN IsUsingX2APIC)
	Store the details Local APIC in xapic or x2apic modes.
BOOLEAN	VmFuncApicStoreIoApicFields (IO_APIC_ENTRY_PACKETS *IoApicPackets)
	Store the details of I/O APIC.
VOID	VmFuncIdtQueryEntries (PINTERRUPT_DESCRIPTOR_TABLE_ENTRIES_PACKETS IdtQueryRequest, BOOLEAN ReadFromVmxRoot)
	Perform query for IDT entries.
BOOLEAN	VmFuncSmmPerformSmiOperation (SMI_OPERATION_PACKETS *SmiOperationRequest, BOOLEAN ApplyFromVmxRootMode)
	Perform actions related to System Management Interrupts (SMIs).

Detailed Description

Implementation of exported functions from hypervisor.

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.1

Date

2022-12-09

Copyright

This project is released under the GNU Public License v3.

Function Documentation

VmFuncApicStoreIoApicFields()

BOOLEAN VmFuncApicStoreIoApicFields

(

IO_APIC_ENTRY_PACKETS *

IoApicPackets

)

Store the details of I/O APIC.

Parameters

IoApicPackets

Returns

BOOLEAN

{
    return ApicStoreIoApicFields(IoApicPackets);
}

VmFuncApicStoreLocalApicFields()

BOOLEAN VmFuncApicStoreLocalApicFields	(	PLAPIC_PAGE	LocalApicBuffer,
		PBOOLEAN	IsUsingX2APIC )

Store the details Local APIC in xapic or x2apic modes.

Parameters

LocalApicBuffer
IsUsingX2APIC

Returns

BOOLEAN

{
    return ApicStoreLocalApicFields(LocalApicBuffer, IsUsingX2APIC);
}

VmFuncChangeIgnoreOneMtfState()

VOID VmFuncChangeIgnoreOneMtfState	(	UINT32	CoreId,
		BOOLEAN	Set )

Change ignore one MTF state.

Parameters

CoreId	Target core's ID
Set	State of setting or unsetting

Returns

VOID

{
    g_GuestState[CoreId].IgnoreOneMtf = Set;
}

VmFuncChangeMtfUnsettingState()

VOID VmFuncChangeMtfUnsettingState	(	UINT32	CoreId,
		BOOLEAN	Set )

Suppress unsetting MTF.

Parameters

CoreId	Target core's ID
Set	State of setting or unsetting

Returns

VOID

{
    g_GuestState[CoreId].IgnoreMtfUnset = Set;
}

VmFuncCheckAndEnableExternalInterrupts()

VOID VmFuncCheckAndEnableExternalInterrupts

(

UINT32

CoreId

)

Check and enable external interrupts.

Parameters

CoreId

Target core's ID

Returns

VOID

{
    HvCheckAndEnableExternalInterrupts(&g_GuestState[CoreId]);
}

VmFuncCheckCpuSupportForLoadAndClearGuestIa32LbrCtlControls()

BOOLEAN VmFuncCheckCpuSupportForLoadAndClearGuestIa32LbrCtlControls

(

)

Check if CPU support load and clear guest IA32_LBR_CTL controls on VM-entry and VM-exit.

Returns

BOOLEAN

{
    return HvCheckCpuSupportForLoadAndClearGuestIa32LbrCtlControls();
}

VmFuncCheckCpuSupportForSaveAndLoadDebugControls()

BOOLEAN VmFuncCheckCpuSupportForSaveAndLoadDebugControls

(

)

Check if CPU support save and load debug controls on exit and load entries.

Returns

BOOLEAN

{
    return HvCheckCpuSupportForSaveAndLoadDebugControls();
}

VmFuncClearSteppingBits()

UINT64 VmFuncClearSteppingBits

(

UINT64

Interruptibility

)

Clear STI and MOV SS bits.

Returns

UINT64

{
    return HvClearSteppingBits(Interruptibility);
}

VmFuncDisableExternalInterruptsAndInterruptWindow()

VOID VmFuncDisableExternalInterruptsAndInterruptWindow

(

UINT32

CoreId

)

Disable external-interrupts and interrupt window.

Parameters

CoreId

Returns

VOID

{
    HvDisableExternalInterruptsAndInterruptWindow(&g_GuestState[CoreId]);
}

VmFuncEnableAndCheckForPreviousExternalInterrupts()

VOID VmFuncEnableAndCheckForPreviousExternalInterrupts

(

UINT32

CoreId

)

Checks to enable and reinject previous interrupts.

Parameters

CoreId

Returns

VOID

{
    HvEnableAndCheckForPreviousExternalInterrupts(&g_GuestState[CoreId]);
}

VmFuncEnableMtfAndChangeExternalInterruptState()

VOID VmFuncEnableMtfAndChangeExternalInterruptState

(

UINT32

CoreId

)

Enables MTF and adjust external interrupt state.

Parameters

CoreId

Returns

VOID

{
    HvEnableMtfAndChangeExternalInterruptState(&g_GuestState[CoreId]);
}

VmFuncEventInjectBreakpoint()

VOID VmFuncEventInjectBreakpoint

(

)

Inject #BP to the guest (Event Injection).

Returns

VOID

{
    EventInjectBreakpoint();
}

VmFuncEventInjectInterruption()

VOID VmFuncEventInjectInterruption	(	UINT32	InterruptionType,
		UINT32	Vector,
		BOOLEAN	DeliverErrorCode,
		UINT32	ErrorCode )

Inject interrupt/faults/exceptions.

Parameters

InterruptionType
Vector
DeliverErrorCode
ErrorCode

Returns

VOID

{
    EventInjectInterruption(InterruptionType,
                            Vector,
                            DeliverErrorCode,
                            ErrorCode);
}

VmFuncEventInjectPageFaultRangeAddress()

VOID VmFuncEventInjectPageFaultRangeAddress	(	UINT32	CoreId,
		UINT64	AddressFrom,
		UINT64	AddressTo,
		UINT32	PageFaultCode )

Inject a range of page-faults.

Parameters

CoreId	Target core's ID
AddressFrom	Page-fault address (from)
AddressTo	Page-fault address (to)
Address	Page-fault address
PageFaultCode	Page-fault error code

Returns

VOID

{
    EventInjectPageFaultRangeAddress(&g_GuestState[CoreId], AddressFrom, AddressTo, PageFaultCode);
}

VmFuncEventInjectPageFaultWithCr2()

VOID VmFuncEventInjectPageFaultWithCr2	(	UINT32	CoreId,
		UINT64	Address,
		UINT32	PageFaultCode )

Inject #PF and configure CR2 register.

Parameters

CoreId	Target core's ID
Address	Page-fault address
PageFaultCode	Page-fault error code

Returns

VOID

{
    EventInjectPageFaultWithCr2(&g_GuestState[CoreId], Address, PageFaultCode);
}

VmFuncGetCsSelector()

UINT16 VmFuncGetCsSelector

(

)

Read CS selector.

Returns

UINT16

{
    return HvGetCsSelector();
}

VmFuncGetDebugctl()

UINT64 VmFuncGetDebugctl

(

)

Get the guest state of IA32_DEBUGCTL.

Returns

UINT64

{
    return HvGetDebugctl();
}

VmFuncGetDebugctlVmcallOnTargetCore()

UINT64 VmFuncGetDebugctlVmcallOnTargetCore

(

)

Get the guest state of IA32_DEBUGCTL on the target core from VMCS using VMCALL.

Returns

UINT64

{
    return CrossVmcallGetDebugctlVmcallOnTargetCore();
}

VmFuncGetGuestIa32LbrCtl()

UINT64 VmFuncGetGuestIa32LbrCtl

(

)

Get the guest state of IA32_LBR_CTL.

Returns

UINT64

{
    return HvGetGuestIa32LbrCtl();
}

VmFuncGetGuestIa32LbrCtlVmcallOnTargetCore()

UINT64 VmFuncGetGuestIa32LbrCtlVmcallOnTargetCore

(

)

Get the guest state of IA32_LBR_CTL on the target core from VMCS.

Returns

UINT64

{
    return CrossVmcallGetGuestIa32LbrCtlVmcallOnTargetCore();
}

VmFuncGetInterruptibilityState()

UINT64 VmFuncGetInterruptibilityState

(

)

Read guest's interruptibility state.

Returns

UINT64

{
    return HvGetInterruptibilityState();
}

VmFuncGetLastVmexitRip()

UINT64 VmFuncGetLastVmexitRip

(

UINT32

CoreId

)

get the last vm-exit RIP

Parameters

CoreId

Target core's ID

Returns

UINT64

{
    return g_GuestState[CoreId].LastVmexitRip;
}

VmFuncGetRflags()

UINT64 VmFuncGetRflags

(

)

Read guest's RFLAGS.

Returns

UINT64

{
    return HvGetRflags();
}

VmFuncGetRip()

UINT64 VmFuncGetRip

(

)

Read guest's RIP.

Returns

UINT64

{
    return HvGetRip();
}

VmFuncIdtQueryEntries()

VOID VmFuncIdtQueryEntries	(	PINTERRUPT_DESCRIPTOR_TABLE_ENTRIES_PACKETS	IdtQueryRequest,
		BOOLEAN	ReadFromVmxRoot )

Perform query for IDT entries.

Parameters

IdtQueryRequest
ReadFromVmxRoot

Returns

VOID

{
    IdtEmulationQueryIdtEntriesRequest(IdtQueryRequest, ReadFromVmxRoot);
}

VmFuncInitVmm()

BOOLEAN VmFuncInitVmm

(

VMM_CALLBACKS *

VmmCallbacks

)

Initializes hypervisor.

Parameters

VmmCallbacks

Returns

BOOLEAN Shows whether the initialization was successful or not

{
    return HvInitVmm(VmmCallbacks);
}

VmFuncInjectPendingExternalInterrupts()

VOID VmFuncInjectPendingExternalInterrupts

(

UINT32

CoreId

)

Inject pending external interrupts.

Parameters

CoreId

Target core's ID

Returns

VOID

{
    HvInjectPendingExternalInterrupts(&g_GuestState[CoreId]);
}

VmFuncInvalidateEptAllContexts()

VOID VmFuncInvalidateEptAllContexts

(

)

Requests for all contexts EPT invalidation.

Returns

VOID

{
    //
    // Broadcast NMI requests
    //
    EptInveptAllContexts();
}

VmFuncInvalidateEptSingleContext()

VOID VmFuncInvalidateEptSingleContext

(

UINT32

CoreId

)

Requests for single-context EPT invalidation.

Parameters

CoreId

Target core's ID

Returns

VOID

{
    EptInveptSingleContext(g_GuestState[CoreId].EptPointer.AsUInt);
}

VmFuncNmiBroadcastInvalidateEptAllContexts()

BOOLEAN VmFuncNmiBroadcastInvalidateEptAllContexts

(

UINT32

CoreId

)

Broadcast NMI requests for all contexts EPT invalidation.

Parameters

CoreId

Target core's ID

Returns

BOOLEAN

{
    //
    // Broadcast NMI requests
    //
    return VmxBroadcastNmi(&g_GuestState[CoreId], NMI_BROADCAST_ACTION_INVALIDATE_EPT_CACHE_ALL_CONTEXTS);
}

VmFuncNmiBroadcastInvalidateEptSingleContext()

BOOLEAN VmFuncNmiBroadcastInvalidateEptSingleContext

(

UINT32

CoreId

)

Broadcast NMI requests for single-context EPT invalidation.

Parameters

CoreId

Target core's ID

Returns

BOOLEAN

{
    //
    // Broadcast NMI requests
    //
    return VmxBroadcastNmi(&g_GuestState[CoreId], NMI_BROADCAST_ACTION_INVALIDATE_EPT_CACHE_SINGLE_CONTEXT);
}

VmFuncNmiBroadcastRequest()

BOOLEAN VmFuncNmiBroadcastRequest

(

UINT32

CoreId

)

Broadcast NMI requests.

Parameters

CoreId

Target core's ID

Returns

BOOLEAN

{
    //
    // Broadcast NMI requests
    //
    return VmxBroadcastNmi(&g_GuestState[CoreId], NMI_BROADCAST_ACTION_REQUEST);
}

VmFuncPerformRipIncrement()

VOID VmFuncPerformRipIncrement

(

UINT32

CoreId

)

Perform the incrementation of RIP.

Parameters

CoreId

Target core's ID

Returns

VOID

{
    HvPerformRipIncrement(&g_GuestState[CoreId]);
}

VmFuncQueryInstrumentationStepInState()

BOOLEAN VmFuncQueryInstrumentationStepInState

(

UINT32

CoreId

)

Query instrumentation step in MTF state.

Parameters

CoreId

Target core's ID

Returns

BOOLEAN

{
    return g_GuestState[CoreId].InstrumentationStepInMtf;
}

VmFuncQueryModeExecTrap()

BOOLEAN VmFuncQueryModeExecTrap

(

)

Get the current state of mode exec trap mechanism.

Returns

BOOLEAN

{
    return g_ExecTrapInitialized;
}

VmFuncReadExceptionBitmap()

UINT32 VmFuncReadExceptionBitmap

(

)

Read exception bitmap in VMCS.

Should be called in vmx-root

Returns

UINT32

{
    return HvReadExceptionBitmap();
}

VmFuncSetClearGuestIa32LbrCtl()

VOID VmFuncSetClearGuestIa32LbrCtl	(	UINT32	CoreId,
		BOOLEAN	Set )

Set CLEAR GUEST IA32_LBR_CTL on Vm-exit controls.

Parameters

CoreId	target core id
Set	Set or unset

Returns

VOID

{
    HvSetClearGuestIa32LbrCtl(&g_GuestState[CoreId], Set);
}

VmFuncSetClearGuestIa32LbrCtlVmcallOnTargetCore()

VOID VmFuncSetClearGuestIa32LbrCtlVmcallOnTargetCore

(

BOOLEAN

Set

)

Set CLEAR GUEST IA32_LBR_CTL on VM-exit controls on the target core from VMCS using VMCALL.

Parameters

Set	Set or unset

Returns

VOID

{
    CrossVmcallSetClearGuestIa32LbrCtlVmcallOnTargetCore(Set);
}

VmFuncSetDebugctl()

VOID VmFuncSetDebugctl

(

UINT64

Value

)

Set the guest state of IA32_DEBUGCTL.

Parameters

Value

Returns

VOID

{
    HvSetDebugctl(Value);
}

VmFuncSetDebugctlVmcallOnTargetCore()

VOID VmFuncSetDebugctlVmcallOnTargetCore

(

UINT64

Value

)

Set the guest state of IA32_DEBUGCTL on the target core from VMCS using VMCALL.

Parameters

Value

Returns

VOID

{
    CrossVmcallSetDebugctlVmcallOnTargetCore(Value);
}

VmFuncSetDebugReg7()

VOID VmFuncSetDebugReg7

(

UINT64

Value

)

Set the guest state of DR7.

Parameters

Value

Returns

VOID

{
    HvSetDebugReg7(Value);
}

VmFuncSetExceptionBitmap()

VOID VmFuncSetExceptionBitmap	(	UINT32	CoreId,
		UINT32	IdtIndex )

Set exception bitmap in VMCS.

Should be called in vmx-root

Parameters

CoreId	Target core's ID
IdtIndex	Interrupt Descriptor Table index of exception

Returns

VOID

{
    HvSetExceptionBitmap(&g_GuestState[CoreId], IdtIndex);
}

VmFuncSetExternalInterruptExiting()

VOID VmFuncSetExternalInterruptExiting	(	UINT32	CoreId,
		BOOLEAN	Set )

Set the External Interrupt Exiting.

Parameters

CoreId	Target core's ID
Set	Set or unset the External Interrupt Exiting

Returns

VOID

{
    HvSetExternalInterruptExiting(&g_GuestState[CoreId], Set);
}

VmFuncSetGuestIa32LbrCtl()

VOID VmFuncSetGuestIa32LbrCtl

(

UINT64

Value

)

Set the guest state of IA32_LBR_CTL.

Parameters

Value

Returns

VOID

{
    HvSetGuestIa32LbrCtl(Value);
}

VmFuncSetGuestIa32LbrCtlVmcallOnTargetCore()

VOID VmFuncSetGuestIa32LbrCtlVmcallOnTargetCore

(

UINT64

Value

)

Set the guest state of IA32_LBR_CTL on the target core from VMCS using VMCALL.

Parameters

Value

Returns

VOID

{
    CrossVmcallSetGuestIa32LbrCtlVmcallOnTargetCore(Value);
}

VmFuncSetInstrumentationStepInState()

VOID VmFuncSetInstrumentationStepInState

(

UINT32

CoreId

)

Set instrumentation step in MTF (used for single stepping with MTF).

Parameters

CoreId

Target core's ID

Returns

VOID

{
    g_GuestState[CoreId].InstrumentationStepInMtf = TRUE;
}

VmFuncSetInterruptibilityState()

VOID VmFuncSetInterruptibilityState

(

UINT64

InterruptibilityState

)

Set guest's interruptibility state.

Parameters

InterruptibilityState

Returns

VOID

{
    HvSetInterruptibilityState(InterruptibilityState);
}

VmFuncSetInterruptWindowExiting()

VOID VmFuncSetInterruptWindowExiting

(

BOOLEAN

Set

)

Set Interrupt-window exiting.

Parameters

Set	Set or unset the Interrupt-window exiting

Returns

VOID

{
    HvSetInterruptWindowExiting(Set);
}

VmFuncSetLbrSelect()

VOID VmFuncSetLbrSelect

(

UINT64

FilterOptions

)

Set the guest state of MSR_LEGACY_LBR_SELECT.

Parameters

FilterOptions

Returns

VOID

{
    HvSetLbrSelect(FilterOptions);
}

VmFuncSetLbrSelectVmcallOnTargetCore()

VOID VmFuncSetLbrSelectVmcallOnTargetCore

(

UINT64

FilterOptions

)

Set the guest state of MSR_LEGACY_LBR_SELECT on the target core from VMCS using VMCALL.

Parameters

FilterOptions

Returns

VOID

{
    CrossVmcallSetLbrSelectVmcallOnTargetCore(FilterOptions);
}

VmFuncSetLoadDebugControls()

VOID VmFuncSetLoadDebugControls	(	UINT32	CoreId,
		BOOLEAN	Set )

Set LOAD DEBUG CONTROLS on Vm-entry controls.

Parameters

CoreId	target core id
Set	Set or unset

Returns

VOID

{
    HvSetLoadDebugControls(&g_GuestState[CoreId], Set);
}

VmFuncSetLoadDebugControlsVmcallOnTargetCore()

VOID VmFuncSetLoadDebugControlsVmcallOnTargetCore

(

BOOLEAN

Set

)

Set LOAD DEBUG CONTROLS on VM-entry controls on the target core from VMCS using VMCALL.

Parameters

Set	Set or unset

Returns

VOID

{
    CrossVmcallSetLoadDebugControlsVmcallOnTargetCore(Set);
}

VmFuncSetLoadGuestIa32LbrCtl()

VOID VmFuncSetLoadGuestIa32LbrCtl	(	UINT32	CoreId,
		BOOLEAN	Set )

Set LOAD GUEST IA32_LBR_CTL on Vm-entry controls.

Parameters

CoreId	target core id
Set	Set or unset

Returns

VOID

{
    HvSetLoadGuestIa32LbrCtl(&g_GuestState[CoreId], Set);
}

VmFuncSetLoadGuestIa32LbrCtlVmcallOnTargetCore()

VOID VmFuncSetLoadGuestIa32LbrCtlVmcallOnTargetCore

(

BOOLEAN

Set

)

Set LOAD GUEST IA32_LBR_CTL on VM-entry controls on the target core from VMCS using VMCALL.

Parameters

Set	Set or unset

Returns

VOID

{
    CrossVmcallSetLoadGuestIa32LbrCtlVmcallOnTargetCore(Set);
}

VmFuncSetMonitorTrapFlag()

VOID VmFuncSetMonitorTrapFlag

(

BOOLEAN

Set

)

Set the monitor trap flag.

Parameters

Set	Set or unset the MTFs

Returns

VOID

{
    HvSetMonitorTrapFlag(Set);
}

VmFuncSetMovControlRegsExiting()

VOID VmFuncSetMovControlRegsExiting	(	BOOLEAN	Set,
		UINT64	ControlRegister,
		UINT64	MaskRegister )

Set vm-exit for mov-to-cr0/4.

Should be called in vmx-root

Parameters

Set	or unset the vm-exits
Control	Register
Mask	Register

Returns

VOID

{
    HvSetMovControlRegsExiting(Set, ControlRegister, MaskRegister);
}

VmFuncSetMovDebugRegsExiting()

VOID VmFuncSetMovDebugRegsExiting	(	UINT32	CoreId,
		BOOLEAN	Set )

Set or unset the Mov to Debug Registers Exiting.

Parameters

CoreId	Target core's ID
Set	Set or unset the Mov to Debug Registers Exiting

Returns

VOID

{
    HvSetMovDebugRegsExiting(&g_GuestState[CoreId], Set);
}

VmFuncSetMovToCr3Vmexit()

VOID VmFuncSetMovToCr3Vmexit	(	UINT32	CoreId,
		BOOLEAN	Set )

Set vm-exit for mov-to-cr3.

Should be called in vmx-root

Parameters

CoreId	target core id
Set	Set or unset the vm-exits

Returns

VOID

{
    HvSetMovToCr3Vmexit(&g_GuestState[CoreId], Set);
}

VmFuncSetNmiExiting()

VOID VmFuncSetNmiExiting

(

BOOLEAN

Set

)

Set the NMI Exiting.

Parameters

Set	Set or unset the NMI Exiting

Returns

VOID

{
    HvSetNmiExiting(Set);
}

VmFuncSetNmiWindowExiting()

VOID VmFuncSetNmiWindowExiting

(

BOOLEAN

Set

)

Set NMI-window exiting.

Parameters

Set	Set or unset the NMI-window exiting

Returns

VOID

{
    HvSetNmiWindowExiting(Set);
}

VmFuncSetPmcVmexit()

VOID VmFuncSetPmcVmexit

(

BOOLEAN

Set

)

Set vm-exit for rdpmc instructions.

Should be called in vmx-root

Parameters

Set	Set or unset the vm-exits

Returns

VOID

{
    HvSetPmcVmexit(Set);
}

VmFuncSetRdtscExiting()

VOID VmFuncSetRdtscExiting	(	UINT32	CoreId,
		BOOLEAN	Set )

Set the RDTSC/P Exiting.

Parameters

CoreId	Target core's ID
Set	Set or unset the RDTSC/P Exiting

Returns

VOID

{
    HvSetRdtscExiting(&g_GuestState[CoreId], Set);
}

VmFuncSetRflags()

VOID VmFuncSetRflags

(

UINT64

Rflags

)

Set guest's RFLAGS.

Parameters

Rflags

Returns

VOID

{
    HvSetRflags(Rflags);
}

VmFuncSetRflagTrapFlag()

VOID VmFuncSetRflagTrapFlag

(

BOOLEAN

Set

)

Set Rflag's trap flag.

Parameters

Set	Set or unset the TF

Returns

VOID

{
    HvSetRflagTrapFlag(Set);
}

VmFuncSetRip()

VOID VmFuncSetRip

(

UINT64

Rip

)

Set guest's RIP.

Parameters

Rip

Returns

VOID

{
    HvSetRip(Rip);
}

VmFuncSetSaveDebugControls()

VOID VmFuncSetSaveDebugControls	(	UINT32	CoreId,
		BOOLEAN	Set )

Set SAVE DEBUG CONTROLS on Vm-exit controls.

Parameters

CoreId	target core id
Set	Set or unset

Returns

VOID

{
    HvSetSaveDebugControls(&g_GuestState[CoreId], Set);
}

VmFuncSetSaveDebugControlsVmcallOnTargetCore()

VOID VmFuncSetSaveDebugControlsVmcallOnTargetCore

(

BOOLEAN

Set

)

Set SAVE DEBUG CONTROLS on VM-exit controls on the target core from VMCS using VMCALL.

Parameters

Set	Set or unset

Returns

VOID

{
    CrossVmcallSetSaveDebugControlsVmcallOnTargetCore(Set);
}

VmFuncSetTriggerEventForCpuids()

VOID VmFuncSetTriggerEventForCpuids

(

BOOLEAN

Set

)

Set triggering events for CPUIDs.

Parameters

Set	Set or unset the trigger

Returns

VOID

{
    g_TriggerEventForCpuids = Set;
}

VmFuncSetTriggerEventForVmcalls()

VOID VmFuncSetTriggerEventForVmcalls

(

BOOLEAN

Set

)

Set triggering events for VMCALLs.

Parameters

Set	Set or unset the trigger

Returns

VOID

{
    g_TriggerEventForVmcalls = Set;
}

VmFuncSetTriggerEventForXsetbvs()

VOID VmFuncSetTriggerEventForXsetbvs

(

BOOLEAN

Set

)

Set trigger event for XSETBVs.

Parameters

Set	Set or unset the trigger

Returns

VOID

{
    g_TriggerEventForXsetbvs = Set;
}

VmFuncSmmPerformSmiOperation()

BOOLEAN VmFuncSmmPerformSmiOperation	(	SMI_OPERATION_PACKETS *	SmiOperationRequest,
		BOOLEAN	ApplyFromVmxRootMode )

Perform actions related to System Management Interrupts (SMIs).

Parameters

SmiOperationRequest
ApplyFromVmxRootMode

Returns

BOOLEAN

{
    return SmmPerformSmiOperation(SmiOperationRequest, ApplyFromVmxRootMode);
}

VmFuncSuppressRipIncrement()

VOID VmFuncSuppressRipIncrement

(

UINT32

CoreId

)

Suppress the incrementation of RIP.

Parameters

CoreId

Target core's ID

Returns

VOID

{
    HvSuppressRipIncrement(&g_GuestState[CoreId]);
}

VmFuncUninitVmm()

VOID VmFuncUninitVmm

(

)

Uninitialize Terminate Vmx on all logical cores.

Returns

VOID

{
    VmxPerformTermination();
}

VmFuncUnsetExceptionBitmap()

VOID VmFuncUnsetExceptionBitmap	(	UINT32	CoreId,
		UINT32	IdtIndex )

Unset exception bitmap in VMCS.

Should be called in vmx-root

Parameters

CoreId	Target core's ID
IdtIndex	Interrupt Descriptor Table index of exception

Returns

VOID

{
    HvUnsetExceptionBitmap(&g_GuestState[CoreId], IdtIndex);
}

VmFuncUnsetInstrumentationStepInState()

VOID VmFuncUnsetInstrumentationStepInState

(

UINT32

CoreId

)

Unset instrumentation step in MTF (used for single stepping with MTF).

Parameters

CoreId

Target core's ID

Returns

VOID

{
    g_GuestState[CoreId].InstrumentationStepInMtf = FALSE;
}

VmFuncVmxBroadcastInitialize()

VOID VmFuncVmxBroadcastInitialize

(

)

Export for initialize the VMX Broadcast mechanism.

Returns

VOID

{
    VmxBroadcastInitialize();
}

VmFuncVmxBroadcastUninitialize()

VOID VmFuncVmxBroadcastUninitialize

(

)

Export for uninitialize the VMX Broadcast mechanism.

Returns

VOID

{
    VmxBroadcastUninitialize();
}

VmFuncVmxCompatibleMemcmp()

INT32 VmFuncVmxCompatibleMemcmp	(	const CHAR *	Address1,
		const CHAR *	Address2,
		SIZE_T	Count )

VMX-root compatible memcmp.

Parameters

Address1
Address2
Count

Returns

INT32

{
    return VmxCompatibleMemcmp(Address1, Address2, Count);
}

VmFuncVmxCompatibleMicroSleep()

VOID VmFuncVmxCompatibleMicroSleep

(

UINT64

Us

)

VMX-root compatible micro sleep.

Parameters

Us	Delay in micro seconds

Returns

VOID

{
    VmxCompatibleMicroSleep(Us);
}

VmFuncVmxCompatibleStrcmp()

INT32 VmFuncVmxCompatibleStrcmp	(	const CHAR *	Address1,
		const CHAR *	Address2 )

VMX-root compatible strcmp.

Parameters

Address1
Address2

Returns

INT32

{
    return VmxCompatibleStrcmp(Address1, Address2, NULL_ZERO, FALSE);
}

VmFuncVmxCompatibleStrlen()

UINT32 VmFuncVmxCompatibleStrlen

(

const CHAR *

s

)

VMX-root compatible strlen.

Parameters

s	A pointer to the string

Returns

UINT32

{
    return VmxCompatibleStrlen(s);
}

VmFuncVmxCompatibleStrncmp()

INT32 VmFuncVmxCompatibleStrncmp	(	const CHAR *	Address1,
		const CHAR *	Address2,
		SIZE_T	Num )

VMX-root compatible strncmp.

Parameters

Address1
Address2
Num

Returns

INT32

{
    return VmxCompatibleStrcmp(Address1, Address2, Num, TRUE);
}

VmFuncVmxCompatibleWcscmp()

INT32 VmFuncVmxCompatibleWcscmp	(	const WCHAR *	Address1,
		const WCHAR *	Address2 )

VMX-root compatible wcscmp.

Parameters

Address1
Address2

Returns

INT32

{
    return VmxCompatibleWcscmp(Address1, Address2, NULL_ZERO, FALSE);
}

VmFuncVmxCompatibleWcslen()

UINT32 VmFuncVmxCompatibleWcslen

(

const WCHAR *

s

)

VMX-root compatible strlen.

Parameters

s	A pointer to the string

Returns

UINT32

{
    return VmxCompatibleWcslen(s);
}

VmFuncVmxCompatibleWcsncmp()

INT32 VmFuncVmxCompatibleWcsncmp	(	const WCHAR *	Address1,
		const WCHAR *	Address2,
		SIZE_T	Num )

VMX-root compatible wcsncmp.

Parameters

Address1
Address2
Num

Returns

INT32

{
    return VmxCompatibleWcscmp(Address1, Address2, Num, TRUE);
}

VmFuncVmxGetCurrentExecutionMode()

BOOLEAN VmFuncVmxGetCurrentExecutionMode

(

)

Get the current VMX operation state.

Returns

BOOLEAN

{
    return VmxGetCurrentExecutionMode();
}

VmFuncVmxVmcall()

NTSTATUS VmFuncVmxVmcall	(	UINT64	VmcallNumber,
		UINT64	OptionalParam1,
		UINT64	OptionalParam2,
		UINT64	OptionalParam3 )

Export for running VMX VMCALLs.

Parameters

VmcallNumber
OptionalParam1
OptionalParam2
OptionalParam3

Returns

NTSTATUS

{
    return AsmVmxVmcall(VmcallNumber, OptionalParam1, OptionalParam2, OptionalParam3);
}

VmFuncWriteExceptionBitmap()

VOID VmFuncWriteExceptionBitmap

(

UINT32

BitmapMask

)

Write on exception bitmap in VMCS DO NOT CALL IT DIRECTLY, instead use HvSetExceptionBitmap.

Should be called in vmx-root

Parameters

BitmapMask

The content to write on exception bitmap

Returns

VOID

{
    HvWriteExceptionBitmap(BitmapMask);
}