kdmain.c File Reference

#include <ntoskrnl.h>
#include <debug.h>

Include dependency graph for kdmain.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
VOID NTAPI	PspDumpThreads (BOOLEAN SystemThreads)
ULONG NTAPI	KdpServiceDispatcher (ULONG Service, PVOID Buffer1, ULONG Buffer1Length, KPROCESSOR_MODE PreviousMode)
BOOLEAN NTAPI	KdpEnterDebuggerException (IN PKTRAP_FRAME TrapFrame, IN PKEXCEPTION_FRAME ExceptionFrame, IN PEXCEPTION_RECORD ExceptionRecord, IN PCONTEXT Context, IN KPROCESSOR_MODE PreviousMode, IN BOOLEAN SecondChance)
BOOLEAN NTAPI	KdIsThisAKdTrap (IN PEXCEPTION_RECORD ExceptionRecord, IN PCONTEXT Context, IN KPROCESSOR_MODE PreviousMode)
VOID NTAPI	KdUpdateDataBlock (VOID)
BOOLEAN NTAPI	KdEnterDebugger (IN PKTRAP_FRAME TrapFrame, IN PKEXCEPTION_FRAME ExceptionFrame)
VOID NTAPI	KdExitDebugger (IN BOOLEAN Enable)
BOOLEAN NTAPI	KdRefreshDebuggerNotPresent (VOID)
NTSTATUS NTAPI	KdDisableDebugger (VOID)
NTSTATUS NTAPI	KdEnableDebuggerWithLock (IN BOOLEAN NeedLock)
NTSTATUS NTAPI	KdEnableDebugger (VOID)
BOOLEAN NTAPI	KdPollBreakIn (VOID)
NTSTATUS NTAPI	KdPowerTransition (ULONG PowerState)
NTSTATUS NTAPI	KdChangeOption (IN KD_OPTION Option, IN ULONG InBufferLength OPTIONAL, IN PVOID InBuffer, IN ULONG OutBufferLength OPTIONAL, OUT PVOID OutBuffer, OUT PULONG OutBufferRequiredLength OPTIONAL)
NTSTATUS NTAPI	KdSystemDebugControl (IN SYSDBG_COMMAND Command, IN PVOID InputBuffer, IN ULONG InputBufferLength, OUT PVOID OutputBuffer, IN ULONG OutputBufferLength, IN OUT PULONG ReturnLength, IN KPROCESSOR_MODE PreviousMode)

Variables
BOOLEAN	KdDebuggerEnabled = FALSE
BOOLEAN	KdEnteredDebugger = FALSE
BOOLEAN	KdDebuggerNotPresent = TRUE
BOOLEAN	KdBreakAfterSymbolLoad = FALSE
BOOLEAN	KdPitchDebugger = TRUE
BOOLEAN	KdIgnoreUmExceptions = FALSE
PKDEBUG_ROUTINE	KiDebugRoutine = KdpEnterDebuggerException

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 11 of file kdmain.c.

Function Documentation

KdChangeOption()

NTSTATUS NTAPI KdChangeOption	(	IN KD_OPTION	Option,
		IN ULONG InBufferLength	OPTIONAL,
		IN PVOID	InBuffer,
		IN ULONG OutBufferLength	OPTIONAL,
		OUT PVOID	OutBuffer,
		OUT PULONG OutBufferRequiredLength	OPTIONAL
	)

Definition at line 420 of file kdmain.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

KdDisableDebugger()

NTSTATUS NTAPI KdDisableDebugger

(

VOID

)

Definition at line 342 of file kdmain.c.

{
    KIRQL OldIrql;

    /* Raise IRQL */
    KeRaiseIrql(DISPATCH_LEVEL, &OldIrql);

    /* TODO: Disable any breakpoints */

    /* Disable the Debugger */
    KdDebuggerEnabled = FALSE;
    SharedUserData->KdDebuggerEnabled = FALSE;

    /* Lower the IRQL */
    KeLowerIrql(OldIrql);

    /* Return success */
    return STATUS_SUCCESS;
}

Referenced by PcipGetFunctionLimits().

KdEnableDebugger()

NTSTATUS NTAPI KdEnableDebugger

(

VOID

)

Definition at line 374 of file kdmain.c.

{
    KIRQL OldIrql;

    /* Raise IRQL */
    KeRaiseIrql(DISPATCH_LEVEL, &OldIrql);

    /* TODO: Re-enable any breakpoints */

    /* Enable the Debugger */
    KdDebuggerEnabled = TRUE;
    SharedUserData->KdDebuggerEnabled = TRUE;

    /* Lower the IRQL */
    KeLowerIrql(OldIrql);

    /* Return success */
    return STATUS_SUCCESS;
}

Referenced by KdpStub(), and PcipGetFunctionLimits().

KdEnableDebuggerWithLock()

NTSTATUS NTAPI KdEnableDebuggerWithLock

(

IN BOOLEAN

NeedLock

)

Definition at line 364 of file kdmain.c.

{
    return STATUS_ACCESS_DENIED;
}

Referenced by KeBugCheckWithTf().

KdEnterDebugger()

BOOLEAN NTAPI KdEnterDebugger	(	IN PKTRAP_FRAME	TrapFrame,
		IN PKEXCEPTION_FRAME	ExceptionFrame
	)

Definition at line 312 of file kdmain.c.

{
    return FALSE;
}

Referenced by KdpPrint(), KdpPrompt(), KdpReport(), and KdSetOwedBreakpoints().

KdExitDebugger()

VOID NTAPI KdExitDebugger

(

IN BOOLEAN

Enable

)

Definition at line 320 of file kdmain.c.

{
}

Referenced by KdpPrint(), KdpPrompt(), KdpReport(), and KdSetOwedBreakpoints().

KdIsThisAKdTrap()

BOOLEAN NTAPI KdIsThisAKdTrap	(	IN PEXCEPTION_RECORD	ExceptionRecord,
		IN PCONTEXT	Context,
		IN KPROCESSOR_MODE	PreviousMode
	)

Definition at line 294 of file kdmain.c.

{
    /* KDBG has its own mechanism for ignoring user mode exceptions */
    return FALSE;
}

KdpEnterDebuggerException()

BOOLEAN NTAPI KdpEnterDebuggerException	(	IN PKTRAP_FRAME	TrapFrame,
		IN PKEXCEPTION_FRAME	ExceptionFrame,
		IN PEXCEPTION_RECORD	ExceptionRecord,
		IN PCONTEXT	Context,
		IN KPROCESSOR_MODE	PreviousMode,
		IN BOOLEAN	SecondChance
	)

Definition at line 158 of file kdmain.c.

{
    KD_CONTINUE_TYPE Return = kdHandleException;
    ULONG ExceptionCommand = ExceptionRecord->ExceptionInformation[0];

    /* Check if this was a breakpoint due to DbgPrint or Load/UnloadSymbols */
    if ((ExceptionRecord->ExceptionCode == STATUS_BREAKPOINT) &&
        (ExceptionRecord->NumberParameters > 0) &&
        ((ExceptionCommand == BREAKPOINT_LOAD_SYMBOLS) ||
         (ExceptionCommand == BREAKPOINT_UNLOAD_SYMBOLS) ||
         (ExceptionCommand == BREAKPOINT_COMMAND_STRING) ||
         (ExceptionCommand == BREAKPOINT_PRINT) ||
         (ExceptionCommand == BREAKPOINT_PROMPT)))
    {
        /* Check if this is a debug print */
        if (ExceptionCommand == BREAKPOINT_PRINT)
        {
            /* Call KDBG */
            NTSTATUS ReturnStatus;
            BOOLEAN Handled;
            ReturnStatus = KdpPrint((ULONG)KdpGetParameterThree(Context),
                                    (ULONG)KdpGetParameterFour(Context),
                                    (PCHAR)ExceptionRecord->ExceptionInformation[1],
                                    (USHORT)ExceptionRecord->ExceptionInformation[2],
                                    PreviousMode,
                                    TrapFrame,
                                    ExceptionFrame,
                                    &Handled);

            /* Update the return value for the caller */
            KeSetContextReturnRegister(Context, ReturnStatus);
        }
#ifdef KDBG
        else if (ExceptionCommand == BREAKPOINT_LOAD_SYMBOLS)
        {
            PKD_SYMBOLS_INFO SymbolsInfo;
            KD_SYMBOLS_INFO CapturedSymbolsInfo;
            PLDR_DATA_TABLE_ENTRY LdrEntry;

            SymbolsInfo = (PKD_SYMBOLS_INFO)ExceptionRecord->ExceptionInformation[2];
            if (PreviousMode != KernelMode)
            {
                _SEH2_TRY
                {
                    ProbeForRead(SymbolsInfo,
                                 sizeof(*SymbolsInfo),
                                 1);
                    KdpMoveMemory(&CapturedSymbolsInfo,
                                  SymbolsInfo,
                                  sizeof(*SymbolsInfo));
                    SymbolsInfo = &CapturedSymbolsInfo;
                }
                _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
                {
                    SymbolsInfo = NULL;
                }
                _SEH2_END;
            }

            if (SymbolsInfo != NULL)
            {
                /* Load symbols. Currently implemented only for KDBG! */
                if (KdbpSymFindModule(SymbolsInfo->BaseOfDll, NULL, -1, &LdrEntry))
                {
                    KdbSymProcessSymbols(LdrEntry);
                }
            }
        }
        else if (ExceptionCommand == BREAKPOINT_PROMPT)
        {
            /* Call KDBG */
            ULONG ReturnLength;
            ReturnLength = KdpPrompt((PCHAR)ExceptionRecord->ExceptionInformation[1],
                                     (USHORT)ExceptionRecord->ExceptionInformation[2],
                                     (PCHAR)KdpGetParameterThree(Context),
                                     (USHORT)KdpGetParameterFour(Context),
                                     PreviousMode,
                                     TrapFrame,
                                     ExceptionFrame);

            /* Update the return value for the caller */
            KeSetContextReturnRegister(Context, ReturnLength);
        }
#endif

        /* This we can handle: simply bump the Program Counter */
        KeSetContextPc(Context, KeGetContextPc(Context) + KD_BREAKPOINT_SIZE);
        return TRUE;
    }

#ifdef KDBG
    /* Check if this is an assertion failure */
    if (ExceptionRecord->ExceptionCode == STATUS_ASSERTION_FAILURE)
    {
        /* Bump EIP to the instruction following the int 2C */
        Context->Eip += 2;
    }
#endif

    /* Get out of here if the Debugger isn't connected */
    if (KdDebuggerNotPresent) return FALSE;

#ifdef KDBG
    /* Call KDBG if available */
    Return = KdbEnterDebuggerException(ExceptionRecord,
                                       PreviousMode,
                                       Context,
                                       TrapFrame,
                                       !SecondChance);
#else /* not KDBG */
    if (WrapperInitRoutine)
    {
        /* Call GDB */
        Return = WrapperTable.KdpExceptionRoutine(ExceptionRecord,
                                                  Context,
                                                  TrapFrame);
    }

    /* We'll manually dump the stack for the user... */
    KeRosDumpStackFrames(NULL, 0);
#endif /* not KDBG */

    /* Debugger didn't handle it, please handle! */
    if (Return == kdHandleException) return FALSE;

    /* Debugger handled it */
    return TRUE;
}

KdPollBreakIn()

BOOLEAN NTAPI KdPollBreakIn

(

VOID

)

Definition at line 399 of file kdmain.c.

{
    return FALSE;
}

Referenced by KdInitSystem(), KeUpdateSystemTime(), KiInitializeSystem(), KiSystemStartup(), and KiSystemStartupReal().

KdPowerTransition()

NTSTATUS NTAPI KdPowerTransition

(

ULONG

PowerState

)

Definition at line 409 of file kdmain.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

KdpServiceDispatcher()

ULONG NTAPI KdpServiceDispatcher	(	ULONG	Service,
		PVOID	Buffer1,
		ULONG	Buffer1Length,
		KPROCESSOR_MODE	PreviousMode
	)

Definition at line 65 of file kdmain.c.

{
    ULONG Result = 0;

    switch (Service)
    {
        case BREAKPOINT_PRINT: /* DbgPrint */
        {
            /* Call KDBG */
            BOOLEAN Handled;
            Result = KdpPrint(MAXULONG,
                              DPFLTR_INFO_LEVEL,
                              (PCHAR)Buffer1,
                              (USHORT)Buffer1Length,
                              PreviousMode,
                              NULL, // TrapFrame,
                              NULL, // ExceptionFrame,
                              &Handled);
            break;
        }

#if DBG
        case ' soR': /* ROS-INTERNAL */
        {
            switch ((ULONG_PTR)Buffer1)
            {
                case DumpAllThreads:
                    PspDumpThreads(TRUE);
                    break;

                case DumpUserThreads:
                    PspDumpThreads(FALSE);
                    break;

                case KdSpare3:
                    MmDumpArmPfnDatabase(FALSE);
                    break;

                default:
                    break;
            }
            break;
        }

#if defined(_M_IX86) && !defined(_WINKD_) // See ke/i386/traphdlr.c
        /* Register a debug callback */
        case 'CsoR':
        {
            switch (Buffer1Length)
            {
                case ID_Win32PreServiceHook:
                    KeWin32PreServiceHook = Buffer1;
                    break;

                case ID_Win32PostServiceHook:
                    KeWin32PostServiceHook = Buffer1;
                    break;

            }
            break;
        }
#endif

        /* Special  case for stack frame dumps */
        case 'DsoR':
        {
            KeRosDumpStackFrames((PULONG_PTR)Buffer1, Buffer1Length);
            break;
        }

#if defined(KDBG)
        /* Register KDBG CLI callback */
        case 'RbdK':
        {
            Result = KdbRegisterCliCallback(Buffer1, Buffer1Length);
            break;
        }
#endif /* KDBG */
#endif /* DBG */
        default:
            DPRINT1("Invalid debug service call!\n");
            HalDisplayString("Invalid debug service call!\r\n");
            break;
    }

    return Result;
}

Referenced by KdSystemDebugControl(), and KiSystemService().

KdRefreshDebuggerNotPresent()

BOOLEAN NTAPI KdRefreshDebuggerNotPresent

(

VOID

)

Definition at line 329 of file kdmain.c.

{
    UNIMPLEMENTED;

    /* Just return whatever was set previously -- FIXME! */
    return KdDebuggerNotPresent;
}

KdSystemDebugControl()

NTSTATUS NTAPI KdSystemDebugControl	(	IN SYSDBG_COMMAND	Command,
		IN PVOID	InputBuffer,
		IN ULONG	InputBufferLength,
		OUT PVOID	OutputBuffer,
		IN ULONG	OutputBufferLength,
		IN OUT PULONG	ReturnLength,
		IN KPROCESSOR_MODE	PreviousMode
	)

Definition at line 436 of file kdmain.c.

{
    /* HACK */
    return KdpServiceDispatcher(Command,
                                InputBuffer,
                                InputBufferLength,
                                PreviousMode);
}

Referenced by DriverEntry(), i8042KbdInterruptService(), KdRosDumpStackFrames(), KdRosSetDebugCallback(), and NtSystemDebugControl().

KdUpdateDataBlock()

VOID NTAPI KdUpdateDataBlock

(

VOID

)

Definition at line 306 of file kdmain.c.

{
}

PspDumpThreads()

VOID NTAPI PspDumpThreads

(

BOOLEAN

SystemThreads

)

Referenced by KdpServiceDispatcher().

Variable Documentation

KdBreakAfterSymbolLoad

BOOLEAN KdBreakAfterSymbolLoad = FALSE

Definition at line 51 of file kdmain.c.

Referenced by ExpInitializeExecutive(), and KdInitSystem().

KdDebuggerEnabled

BOOLEAN KdDebuggerEnabled = FALSE

Definition at line 48 of file kdmain.c.

Referenced by KdDisableDebugger(), KdEnableDebugger(), KdInitSystem(), KdpGdbStubInit(), KdpGetDebugMode(), KdPollBreakIn(), KdpPollBreakInWithPortLock(), KdpStub(), KeBugCheckWithTf(), KeEnterKernelDebugger(), KeUpdateRunTime(), KeUpdateSystemTime(), MmLoadSystemImage(), ObpCloseHandle(), PspCatchCriticalBreak(), and PspExitThread().

KdDebuggerNotPresent

BOOLEAN KdDebuggerNotPresent = TRUE

Definition at line 50 of file kdmain.c.

Referenced by KdInitSystem(), KdpEnterDebuggerException(), KdpGetDebugMode(), KdpPrint(), KdRefreshDebuggerNotPresent(), KeBugCheckWithTf(), MmLoadSystemImage(), and PspCatchCriticalBreak().

KdEnteredDebugger

BOOLEAN KdEnteredDebugger = FALSE

Definition at line 49 of file kdmain.c.

KdIgnoreUmExceptions

BOOLEAN KdIgnoreUmExceptions = FALSE

Definition at line 53 of file kdmain.c.

Referenced by KdInitSystem(), and KiDispatchException().

KdPitchDebugger

BOOLEAN KdPitchDebugger = TRUE

Definition at line 52 of file kdmain.c.

Referenced by KdInitSystem(), KdpStub(), KeBugCheckWithTf(), and KeEnterKernelDebugger().

KiDebugRoutine

PKDEBUG_ROUTINE KiDebugRoutine = KdpEnterDebuggerException

Definition at line 451 of file kdmain.c.

Referenced by KdInitSystem(), and KiDispatchException().