DebuggerVmcalls.h File Reference

Go to the source code of this file.

Macros
#define	DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000001)
	VMCALL to cause vm-exit and halt the system.
#define	DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM_AS_A_RESULT_OF_TRIGGERING_EVENT   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000002)
	VMCALL to cause vm-exit and halt the system because of triggering an event.
#define	DEBUGGER_VMCALL_SIGNAL_DEBUGGER_EXECUTION_FINISHED   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000003)
	VMCALL to signal debugger that debuggee finished execution of the command.
#define	DEBUGGER_VMCALL_SEND_MESSAGES_TO_DEBUGGER   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000004)
	VMCALL to send messages to the debugger.
#define	DEBUGGER_VMCALL_SEND_GENERAL_BUFFER_TO_DEBUGGER   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000005)
	VMCALL to send general buffers from debuggee user-mode to the debugger.

Functions
BOOLEAN	DebuggerVmcallHandler (UINT32 CoreId, UINT64 VmcallNumber, UINT64 OptionalParam1, UINT64 OptionalParam2, UINT64 OptionalParam3)
	Termination function for external-interrupts.

Macro Definition Documentation

DEBUGGER_VMCALL_SEND_GENERAL_BUFFER_TO_DEBUGGER

#define DEBUGGER_VMCALL_SEND_GENERAL_BUFFER_TO_DEBUGGER   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000005)

VMCALL to send general buffers from debuggee user-mode to the debugger.

DEBUGGER_VMCALL_SEND_MESSAGES_TO_DEBUGGER

#define DEBUGGER_VMCALL_SEND_MESSAGES_TO_DEBUGGER   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000004)

VMCALL to send messages to the debugger.

DEBUGGER_VMCALL_SIGNAL_DEBUGGER_EXECUTION_FINISHED

#define DEBUGGER_VMCALL_SIGNAL_DEBUGGER_EXECUTION_FINISHED   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000003)

VMCALL to signal debugger that debuggee finished execution of the command.

DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM

#define DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000001)

VMCALL to cause vm-exit and halt the system.

DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM_AS_A_RESULT_OF_TRIGGERING_EVENT

#define DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM_AS_A_RESULT_OF_TRIGGERING_EVENT   (TOP_LEVEL_DRIVERS_VMCALL_STARTING_NUMBER + 0x00000002)

VMCALL to cause vm-exit and halt the system because of triggering an event.

Function Documentation

DebuggerVmcallHandler()

BOOLEAN DebuggerVmcallHandler	(	UINT32	CoreId,
		UINT64	VmcallNumber,
		UINT64	OptionalParam1,
		UINT64	OptionalParam2,
		UINT64	OptionalParam3 )

Termination function for external-interrupts.

Parameters

CoreId
VmcallNumber
OptionalParam1
OptionalParam2
OptionalParam3

Returns

BOOLEAN

{
    UNREFERENCED_PARAMETER(OptionalParam3);
 
    BOOLEAN                     Result   = FALSE;
    PROCESSOR_DEBUGGING_STATE * DbgState = &g_DbgState[CoreId];
 
    switch (VmcallNumber)
    {
    case DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM:
    {
        KdHandleBreakpointAndDebugBreakpoints(DbgState,
                                              DEBUGGEE_PAUSING_REASON_REQUEST_FROM_DEBUGGER,
                                              NULL);
        Result = TRUE;
        break;
    }
    case DEBUGGER_VMCALL_VM_EXIT_HALT_SYSTEM_AS_A_RESULT_OF_TRIGGERING_EVENT:
    {
        DEBUGGER_TRIGGERED_EVENT_DETAILS * TriggeredEventDetail = (DEBUGGER_TRIGGERED_EVENT_DETAILS *)OptionalParam1;
        PGUEST_REGS                        TempReg              = NULL;
 
        TempReg = DbgState->Regs;
 
        //
        // We won't send current vmcall registers
        // instead we send the registers provided
        // from the third parameter
        //
        DbgState->Regs = (GUEST_REGS *)OptionalParam2;
 
        KdHandleBreakpointAndDebugBreakpoints(DbgState,
                                              DEBUGGEE_PAUSING_REASON_DEBUGGEE_EVENT_TRIGGERED,
                                              TriggeredEventDetail);
 
        //
        // Restore the register
        //
        DbgState->Regs = TempReg;
 
        Result = TRUE;
        break;
    }
    case DEBUGGER_VMCALL_SIGNAL_DEBUGGER_EXECUTION_FINISHED:
    {
        KdSendCommandFinishedSignal(CoreId);
 
        Result = TRUE;
        break;
    }
    case DEBUGGER_VMCALL_SEND_MESSAGES_TO_DEBUGGER:
    {
        //
        // Kernel debugger is active, we should send the bytes over serial
        //
 
        if (OptionalParam1 != NULL64_ZERO && OptionalParam2 != NULL64_ZERO)
        {
            KdLoggingResponsePacketToDebugger(
                (CHAR *)OptionalParam1,
                (UINT32)OptionalParam2,
                OPERATION_LOG_INFO_MESSAGE);
        }
 
        Result = TRUE;
        break;
    }
    case DEBUGGER_VMCALL_SEND_GENERAL_BUFFER_TO_DEBUGGER:
    {
        //
        // Cast the buffer received to perform sending buffer and possibly
        // halt the debuggee
        //
        PDEBUGGEE_SEND_GENERAL_PACKET_FROM_DEBUGGEE_TO_DEBUGGER DebuggeeBufferRequest = (DEBUGGEE_SEND_GENERAL_PACKET_FROM_DEBUGGEE_TO_DEBUGGER *)OptionalParam1;
 
        KdResponsePacketToDebugger(DEBUGGER_REMOTE_PACKET_TYPE_DEBUGGEE_TO_DEBUGGER,
                                   DebuggeeBufferRequest->RequestedAction,
                                   (CHAR *)((UINT64)DebuggeeBufferRequest + (SIZEOF_DEBUGGEE_SEND_GENERAL_PACKET_FROM_DEBUGGEE_TO_DEBUGGER)),
                                   DebuggeeBufferRequest->LengthOfBuffer);
 
        //
        // Check if we expect a buffer and command from the debugger or the
        // request is just finished
        //
        if (DebuggeeBufferRequest->PauseDebuggeeWhenSent)
        {
            DbgState->IgnoreDisasmInNextPacket = TRUE;
 
            KdHandleBreakpointAndDebugBreakpoints(DbgState,
                                                  DEBUGGEE_PAUSING_REASON_PAUSE,
                                                  NULL);
        }
 
        Result = TRUE;
        break;
    }
    default:
        Result = FALSE;
        LogError("Err, invalid VMCALL in top-level debugger");
 
        break;
    }
 
    return Result;
}