288 lines
11 KiB
C
288 lines
11 KiB
C
/*++
|
|
Copyright (c) 1990 Microsoft Corporation
|
|
|
|
Module Name:
|
|
kdtrap.c
|
|
|
|
Abstract:
|
|
This module contains code to implement the target side of the portable kernel debugger.
|
|
|
|
Author:
|
|
David N. Cutler 27-July-1990
|
|
--*/
|
|
|
|
#include "kdp.h"
|
|
|
|
// Define breakpoint instruction masks.
|
|
#define BREAKPOINT_CODE_SHIFT 16
|
|
#define BREAKPOINT_CODE_MASK (0xfffff << 6)
|
|
|
|
// globals
|
|
ULONG KdpPageInAddress;
|
|
WORK_QUEUE_ITEM KdpPageInWorkItem;
|
|
|
|
// externs
|
|
extern BOOLEAN KdpControlCPressed;
|
|
|
|
|
|
#pragma optimize( "", off )
|
|
VOID KdpPageInData (IN PUCHAR volatile DataAddress)
|
|
/*++
|
|
Routine Description:
|
|
This routine is called to page in data at the supplied address.
|
|
It is called either directly from KdpTrap() or from a worker thread that is queued by KdpTrap().
|
|
Arguments:
|
|
DataAddress - Supplies a pointer to the data to be paged in.
|
|
--*/
|
|
{
|
|
if (MmIsSystemAddressAccessable(DataAddress)) {
|
|
UCHAR c = *DataAddress;
|
|
DataAddress = &c;
|
|
}
|
|
KdpControlCPending = TRUE;
|
|
}
|
|
#pragma optimize( "", on )
|
|
|
|
|
|
BOOLEAN KdpTrap (
|
|
IN PKTRAP_FRAME TrapFrame,
|
|
IN PKEXCEPTION_FRAME ExceptionFrame,
|
|
IN PEXCEPTION_RECORD ExceptionRecord,
|
|
IN PCONTEXT ContextRecord,
|
|
IN KPROCESSOR_MODE PreviousMode,
|
|
IN BOOLEAN SecondChance
|
|
)
|
|
/*++
|
|
Routine Description:
|
|
This routine is called whenever a exception is dispatched and the kernel debugger is active.
|
|
Arguments:
|
|
TrapFrame - Supplies a pointer to a trap frame that describes the trap.
|
|
ExceptionFrame - Supplies a pointer to a exception frame that describes the trap.
|
|
ExceptionRecord - Supplies a pointer to an exception record that describes the exception.
|
|
ContextRecord - Supplies the context at the time of the exception.
|
|
PreviousMode - Supplies the previous processor mode.
|
|
SecondChance - Supplies a boolean value that determines whether this is the second chance (TRUE) that the exception has been raised.
|
|
Return Value:
|
|
A value of TRUE is returned if the exception is handled. Otherwise a value of FALSE is returned.
|
|
--*/
|
|
{
|
|
BOOLEAN Completion;
|
|
BOOLEAN Enable;
|
|
BOOLEAN UnloadSymbols = FALSE;
|
|
STRING Input;
|
|
ULONG OldFir;
|
|
STRING Output;
|
|
PKPRCB Prcb;
|
|
|
|
// Synchronize processor execution, save processor state, enter debugger, and flush the current TB.
|
|
re_enter_debugger:
|
|
Enable = KdEnterDebugger(TrapFrame, ExceptionFrame);
|
|
Prcb = KeGetCurrentPrcb();
|
|
KiSaveProcessorState(TrapFrame, ExceptionFrame);
|
|
KeFlushCurrentTb();
|
|
|
|
// If this is a breakpoint instruction, then check to determine if is an internal command.
|
|
if ((ExceptionRecord->ExceptionCode == STATUS_BREAKPOINT) && (((ExceptionRecord->ExceptionInformation[0] & BREAKPOINT_CODE_MASK) >> BREAKPOINT_CODE_SHIFT) >= DEBUG_PRINT_BREAKPOINT)) {
|
|
// Switch on the breakpoint code.
|
|
switch ((ExceptionRecord->ExceptionInformation[0] & BREAKPOINT_CODE_MASK) >> BREAKPOINT_CODE_SHIFT) {
|
|
// Print a debug string.
|
|
|
|
// Arguments:
|
|
// a0 - Supplies a pointer to an output string buffer.
|
|
// a1 - Supplies the length of the output string buffer.
|
|
case DEBUG_PRINT_BREAKPOINT:
|
|
Output.Buffer = (PCHAR)((ULONG)ContextRecord->XIntA0);
|
|
Output.Length = (USHORT)ContextRecord->XIntA1;
|
|
if (KdDebuggerNotPresent == FALSE) {
|
|
if (KdpPrintString(&Output)) {
|
|
ContextRecord->XIntV0 = (ULONGLONG)((LONG)STATUS_BREAKPOINT);
|
|
} else {
|
|
ContextRecord->XIntV0 = (ULONGLONG)((LONG)STATUS_SUCCESS);
|
|
}
|
|
} else {
|
|
ContextRecord->XIntV0 = (ULONGLONG)((LONG)STATUS_DEVICE_NOT_CONNECTED);
|
|
}
|
|
|
|
KiRestoreProcessorState(TrapFrame, ExceptionFrame);
|
|
KdExitDebugger(Enable);
|
|
ContextRecord->Fir += 4;
|
|
return TRUE;
|
|
|
|
// Print a debug prompt string, then input a string.
|
|
// a0 - Supplies a pointer to an output string buffer.
|
|
// a1 - Supplies the length of the output string buffer..
|
|
// a2 - supplies a pointer to an input string buffer.
|
|
// a3 - Supplies the length of the input string bufffer.
|
|
case DEBUG_PROMPT_BREAKPOINT:
|
|
Output.Buffer = (PCHAR)((ULONG)ContextRecord->XIntA0);
|
|
Output.Length = (USHORT)ContextRecord->XIntA1;
|
|
Input.Buffer = (PCHAR)((ULONG)ContextRecord->XIntA2);
|
|
Input.MaximumLength = (USHORT)ContextRecord->XIntA3;
|
|
KdpPromptString(&Output, &Input);
|
|
ContextRecord->XIntV0 = (LONG)Input.Length;
|
|
KiRestoreProcessorState(TrapFrame, ExceptionFrame);
|
|
KdExitDebugger(Enable);
|
|
ContextRecord->Fir += 4;
|
|
return TRUE;
|
|
|
|
// Load the symbolic information for an image.
|
|
// Arguments:
|
|
// a0 - Supplies a pointer to an output string descriptor.
|
|
// a1 - Supplies a the base address of the image.
|
|
case DEBUG_UNLOAD_SYMBOLS_BREAKPOINT:
|
|
UnloadSymbols = TRUE;
|
|
|
|
// Fall through
|
|
case DEBUG_LOAD_SYMBOLS_BREAKPOINT:
|
|
OldFir = ContextRecord->Fir;
|
|
if (KdDebuggerNotPresent == FALSE) {
|
|
KdpReportLoadSymbolsStateChange((PSTRING)((ULONG)ContextRecord->XIntA0), (PKD_SYMBOLS_INFO)((ULONG)ContextRecord->XIntA1), UnloadSymbols, &Prcb->ProcessorState.ContextFrame);
|
|
}
|
|
|
|
RtlCopyMemory(ContextRecord, &Prcb->ProcessorState.ContextFrame, sizeof (CONTEXT) );
|
|
KiRestoreProcessorState(TrapFrame, ExceptionFrame);
|
|
KdExitDebugger(Enable);
|
|
|
|
// If the kernel debugger did not update the FIR, then increment past the break point instruction.
|
|
if (ContextRecord->Fir == OldFir) {
|
|
ContextRecord->Fir += 4;
|
|
}
|
|
|
|
return TRUE;
|
|
default:// Unknown internal command.
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Report state change to kernel debugger on host machine.
|
|
Completion = KdpReportExceptionStateChange(ExceptionRecord, &Prcb->ProcessorState.ContextFrame, SecondChance);
|
|
|
|
RtlCopyMemory(ContextRecord, &Prcb->ProcessorState.ContextFrame, sizeof(CONTEXT));
|
|
KiRestoreProcessorState(TrapFrame, ExceptionFrame);
|
|
KdExitDebugger(Enable);
|
|
|
|
// Check to determine if the user of the remote debugger requested memory to be paged in.
|
|
if (KdpPageInAddress) {
|
|
if (KeGetCurrentIrql() <= APC_LEVEL) {
|
|
// If the IQRL is below DPC level then cause the page fault to occur and then re-enter the debugger.
|
|
// This whole process is transparent to the user.
|
|
KdpPageInData((PUCHAR)KdpPageInAddress);
|
|
KdpPageInAddress = 0;
|
|
KdpControlCPending = FALSE;
|
|
goto re_enter_debugger;
|
|
} else {
|
|
// A page fault cannot be taken at an IRQL above APC level.
|
|
// Thus a worker item is queued to take the page fault.
|
|
// After the worker item takes the page fault it sets the contol-c flag so that the user re-enters the debugger just as if control-c was pressed.
|
|
if (KdpControlCPressed) {
|
|
ExInitializeWorkItem(&KdpPageInWorkItem, (PWORKER_THREAD_ROUTINE) KdpPageInData, (PVOID) KdpPageInAddress);
|
|
ExQueueWorkItem( &KdpPageInWorkItem, DelayedWorkQueue );
|
|
KdpPageInAddress = 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
KdpControlCPressed = FALSE;
|
|
return Completion;
|
|
}
|
|
|
|
|
|
BOOLEAN KdIsThisAKdTrap (IN PEXCEPTION_RECORD ExceptionRecord, IN PCONTEXT ContextRecord, IN KPROCESSOR_MODE PreviousMode)
|
|
/*++
|
|
Routine Description:
|
|
This routine is called whenever a user-mode exception occurs and it might be a kernel debugger exception (Like DbgPrint/DbgPrompt ).
|
|
Arguments:
|
|
ExceptionRecord - Supplies a pointer to an exception record that describes the exception.
|
|
ContextRecord - Supplies the context at the time of the exception.
|
|
PreviousMode - Supplies the previous processor mode.
|
|
Return Value:
|
|
A value of TRUE is returned if this is for the kernel debugger.
|
|
Otherwise, a value of FALSE is returned.
|
|
--*/
|
|
{
|
|
ULONG BreakpointCode;
|
|
|
|
// Isolate the breakpoint code from the breakpoint instruction which is stored by the exception dispatch code in the information field of the exception record.
|
|
BreakpointCode = (ExceptionRecord->ExceptionInformation[0] & BREAKPOINT_CODE_MASK) >> BREAKPOINT_CODE_SHIFT;
|
|
|
|
// Switch on the breakpoint code.
|
|
switch (BreakpointCode) {
|
|
// Kernel breakpoint codes.
|
|
case BREAKIN_BREAKPOINT:
|
|
case KERNEL_BREAKPOINT:
|
|
#if DEVL
|
|
return TRUE;
|
|
#else
|
|
if (PreviousMode == KernelMode) {
|
|
return TRUE;
|
|
} else {
|
|
return FALSE;
|
|
}
|
|
#endif
|
|
case DEBUG_PRINT_BREAKPOINT:// Debug print code.
|
|
return TRUE;
|
|
case DEBUG_PROMPT_BREAKPOINT:// Debug prompt code.
|
|
return TRUE;
|
|
case DEBUG_STOP_BREAKPOINT:// Debug stop code.
|
|
#if DEVL
|
|
return TRUE;
|
|
#else
|
|
if (PreviousMode == KernelMode) {
|
|
return TRUE;
|
|
} else {
|
|
return FALSE;
|
|
}
|
|
#endif
|
|
case DEBUG_LOAD_SYMBOLS_BREAKPOINT:// Debug load symbols code.
|
|
if (PreviousMode == KernelMode) {
|
|
return TRUE;
|
|
} else {
|
|
return FALSE;
|
|
}
|
|
case DEBUG_UNLOAD_SYMBOLS_BREAKPOINT:// Debug unload symbols code.
|
|
if (PreviousMode == KernelMode) {
|
|
return TRUE;
|
|
} else {
|
|
return FALSE;
|
|
}
|
|
default:// All other codes.
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
|
|
BOOLEAN KdpStub (
|
|
IN PKTRAP_FRAME TrapFrame,
|
|
IN PKEXCEPTION_FRAME ExceptionFrame,
|
|
IN PEXCEPTION_RECORD ExceptionRecord,
|
|
IN PCONTEXT ContextRecord,
|
|
IN KPROCESSOR_MODE PreviousMode,
|
|
IN BOOLEAN SecondChance
|
|
)
|
|
/*++
|
|
Routine Description:
|
|
This routine provides a kernel debugger stub routine that catchs debug prints in checked systems when the kernel debugger is not active.
|
|
Arguments:
|
|
TrapFrame - Supplies a pointer to a trap frame that describes the trap.
|
|
ExceptionFrame - Supplies a pointer to a exception frame that describes the trap.
|
|
ExceptionRecord - Supplies a pointer to an exception record that describes the exception.
|
|
ContextRecord - Supplies the context at the time of the exception.
|
|
PreviousMode - Supplies the previous processor mode.
|
|
SecondChance - Supplies a boolean value that determines whether this is the second chance (TRUE) that the exception has been raised.
|
|
Return Value:
|
|
A value of TRUE is returned if the exception is handled. Otherwise a value of FALSE is returned.
|
|
--*/
|
|
{
|
|
ULONG BreakpointCode;
|
|
|
|
// Isolate the breakpoint code from the breakpoint instruction which is stored by the exception dispatch code in the information field of the exception record.
|
|
BreakpointCode = (ExceptionRecord->ExceptionInformation[0] & BREAKPOINT_CODE_MASK) >> BREAKPOINT_CODE_SHIFT;
|
|
|
|
// If the breakpoint is a debug print, debug load symbols, or debug unload symbols, then return TRUE. Otherwise, return FALSE;
|
|
if ((BreakpointCode == DEBUG_PRINT_BREAKPOINT) || (BreakpointCode == DEBUG_LOAD_SYMBOLS_BREAKPOINT) || (BreakpointCode == DEBUG_UNLOAD_SYMBOLS_BREAKPOINT)) {
|
|
ContextRecord->Fir += 4;
|
|
return TRUE;
|
|
} else {
|
|
return FALSE;
|
|
}
|
|
} |