VmxBroadcast.h File Reference

Headers for broadcast in VMX-root mode. More...

Go to the source code of this file.

Functions
VOID	VmxBroadcastInitialize ()
	Initialize the VMX Broadcast mechanism.
VOID	VmxBroadcastUninitialize ()
	Uninitialize the VMX Broadcast mechanism.
BOOLEAN	VmxBroadcastHandleNmiCallback (PVOID Context, BOOLEAN Handled)
	Handles NMIs in kernel-mode.
BOOLEAN	VmxBroadcastNmi (VIRTUAL_MACHINE_STATE *VCpu, NMI_BROADCAST_ACTION_TYPE VmxBroadcastAction)
	Broadcast NMI in vmx-root mode.
BOOLEAN	VmxBroadcastNmiHandler (VIRTUAL_MACHINE_STATE *VCpu, BOOLEAN IsOnVmxNmiHandler)
	Handle broadcast NMIs in vmx-root mode.

Detailed Description

Headers for broadcast in VMX-root mode.

Author

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

Version

0.1

Date

2021-12-31

Copyright

This project is released under the GNU Public License v3.

Function Documentation

VmxBroadcastHandleNmiCallback()

BOOLEAN VmxBroadcastHandleNmiCallback	(	PVOID	Context,
		BOOLEAN	Handled )

Handles NMIs in kernel-mode.

Parameters

Context
Handled

Returns

BOOLEAN

{
    UNREFERENCED_PARAMETER(Context);
 
    ULONG CurrentCore;
    CurrentCore                  = KeGetCurrentProcessorNumberEx(NULL);
    VIRTUAL_MACHINE_STATE * VCpu = &g_GuestState[CurrentCore];
 
    //
    // This mechanism tries to solve the problem of receiving NMIs
    // when we're already in vmx-root mode, e.g., when we want to
    // inject NMIs to other cores and those cores are already operating
    // in vmx-root mode; however, this is not the approach to solve the
    // problem. In order to solve this problem, we should create our own
    // host IDT in vmx-root mode (Note that we should set VMCS_HOST_IDTR_BASE
    // and there is no need to LIMIT as it's fixed at 0xffff for VMX
    // operations).
    // Because we want to use the debugging mechanism of the Windows
    // we use the same IDT with the guest (guest and host IDT is the
    // same), but in the future versions we solve this problem by our
    // own ISR NMI handler in vmx-root mode
    //
 
    //
    // We should check whether the NMI is in vmx-root mode or not
    // if it's not in vmx-root mode then it's not related to us
    //
    if (!VmxBroadcastNmiHandler(VCpu, TRUE))
    {
        return Handled;
    }
    else
    {
        //
        // If we're here then it related to us
        // return true to show that it's handled
        //
        return TRUE;
    }
}

VmxBroadcastInitialize()

VOID VmxBroadcastInitialize

(

)

Initialize the VMX Broadcast mechanism.

Returns

VOID

{
    //
    // *** Initialize NMI broadcasting mechanism ***
    //
 
    //
    // Initialize APIC
    //
    ApicInitialize();
 
#if USE_DEFAULT_OS_IDT_AS_HOST_IDT == TRUE
 
    //
    // Register NMI handler for vmx-root
    //
    g_NmiHandlerForKeDeregisterNmiCallback = KeRegisterNmiCallback(&VmxBroadcastHandleNmiCallback, NULL);
 
#endif //  USE_DEFAULT_OS_IDT_AS_HOST_IDT == TRUE
 
    //
    // Broadcast on all core to cause exit for NMIs
    //
    BroadcastEnableNmiExitingAllCores();
 
    //
    // Indicate that NMI broadcasting is initialized
    //
    g_NmiBroadcastingInitialized = TRUE;
}

VmxBroadcastNmi()

BOOLEAN VmxBroadcastNmi	(	VIRTUAL_MACHINE_STATE *	VCpu,
		NMI_BROADCAST_ACTION_TYPE	VmxBroadcastAction )

Broadcast NMI in vmx-root mode.

caller to this function should take actions to the current core the NMI won't be triggered for the current core

Parameters

VCpu	The virtual processor's state
VmxBroadcastAction

Returns

BOOLEAN

{
    ULONG ProcessorsCount;
 
    //
    // Check if NMI broadcasting is initialized
    //
    if (!g_NmiBroadcastingInitialized)
    {
        return FALSE;
    }
 
    ProcessorsCount = KeQueryActiveProcessorCount(0);
 
    //
    // Indicate that we're waiting for NMI
    //
    for (size_t i = 0; i < ProcessorsCount; i++)
    {
        if (i != VCpu->CoreId)
        {
            SpinlockInterlockedCompareExchange((volatile LONG *)&g_GuestState[i].NmiBroadcastingState.NmiBroadcastAction,
                                               VmxBroadcastAction,
                                               NMI_BROADCAST_ACTION_NONE);
        }
    }
 
    //
    // Broadcast NMI through APIC (xAPIC or x2APIC)
    //
    ApicTriggerGenericNmi();
 
    return TRUE;
}

VmxBroadcastNmiHandler()

BOOLEAN VmxBroadcastNmiHandler	(	VIRTUAL_MACHINE_STATE *	VCpu,
		BOOLEAN	IsOnVmxNmiHandler )

Handle broadcast NMIs in vmx-root mode.

Parameters

VCpu	The virtual processor's state
IsOnVmxNmiHandler

Returns

BOOLEAN Shows whether it's handled by this routine or not

{
    NMI_BROADCAST_ACTION_TYPE BroadcastAction;
    BOOLEAN                   IsHandled = FALSE;
 
    //
    // Check if NMI relates to us or not
    // Set NMI broadcasting action to none (clear the action)
    //
    BroadcastAction = InterlockedExchange((volatile LONG *)&VCpu->NmiBroadcastingState.NmiBroadcastAction, NMI_BROADCAST_ACTION_NONE);
 
    if (BroadcastAction == NMI_BROADCAST_ACTION_NONE)
    {
        IsHandled = FALSE;
        goto ReturnIsHandled;
    }
 
    //
    // *** It's relating to us ***
    //
 
    switch (BroadcastAction)
    {
    case NMI_BROADCAST_ACTION_TEST:
 
        //
        // Use for stress testing of the broadcasting mechanism
        //
        IsHandled = TRUE;
 
        break;
 
    case NMI_BROADCAST_ACTION_REQUEST:
 
        //
        // Handle NMI of halt the other cores
        //
        VmmCallbackNmiBroadcastRequestHandler(VCpu->CoreId, IsOnVmxNmiHandler);
        IsHandled = TRUE;
 
        break;
 
    case NMI_BROADCAST_ACTION_INVALIDATE_EPT_CACHE_SINGLE_CONTEXT:
 
        //
        // Invalidate EPT cache (single-context)
        //
        EptInveptSingleContext(VCpu->EptPointer.AsUInt);
 
        IsHandled = TRUE;
 
        break;
 
    case NMI_BROADCAST_ACTION_INVALIDATE_EPT_CACHE_ALL_CONTEXTS:
 
        //
        // Invalidate EPT cache (all contexts)
        //
        EptInveptAllContexts();
        IsHandled = TRUE;
 
        break;
 
    default:
 
        IsHandled = FALSE;
        LogError("Err, invalid NMI reason received");
 
        break;
    }
 
ReturnIsHandled:
    return IsHandled;
}

VmxBroadcastUninitialize()

VOID VmxBroadcastUninitialize

(

)

Uninitialize the VMX Broadcast mechanism.

Returns

VOID

{
    //
    // *** Uninitialize NMI broadcasting mechanism ***
    //
    g_NmiBroadcastingInitialized = FALSE;
 
#if USE_DEFAULT_OS_IDT_AS_HOST_IDT == TRUE
 
    //
    // De-register NMI handler
    //
    KeDeregisterNmiCallback(g_NmiHandlerForKeDeregisterNmiCallback);
 
#endif //  USE_DEFAULT_OS_IDT_AS_HOST_IDT == TRUE
 
    //
    // Broadcast on all core to cause not to exit for NMIs
    //
    BroadcastDisableNmiExitingAllCores();
 
    //
    // Uinitialize APIC related function
    //
    ApicUninitialize();
}