debug.c File Reference

#include <rtl.h>
#include <ndk/kdfuncs.h>
#include <debug.h>

Include dependency graph for debug.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
ULONG NTAPI	DebugPrint (IN PSTRING DebugString, IN ULONG ComponentId, IN ULONG Level)
ULONG NTAPI	DebugPrompt (IN PSTRING Output, IN PSTRING Input)
ULONG NTAPI	vDbgPrintExWithPrefixInternal (IN PCCH Prefix, IN ULONG ComponentId, IN ULONG Level, IN PCCH Format, IN va_list ap, IN BOOLEAN HandleBreakpoint)
ULONG NTAPI	vDbgPrintExWithPrefix (IN PCCH Prefix, IN ULONG ComponentId, IN ULONG Level, IN PCCH Format, IN va_list ap)
ULONG NTAPI	vDbgPrintEx (IN ULONG ComponentId, IN ULONG Level, IN PCCH Format, IN va_list ap)
ULONG __cdecl	DbgPrint (PCCH Format,...)
ULONG __cdecl	DbgPrintEx (IN ULONG ComponentId, IN ULONG Level, IN PCCH Format,...)
ULONG __cdecl	DbgPrintReturnControlC (PCCH Format,...)
ULONG NTAPI	DbgPrompt (IN PCCH Prompt, OUT PCH Response, IN ULONG MaximumResponseLength)
NTSTATUS NTAPI	DbgQueryDebugFilterState (IN ULONG ComponentId, IN ULONG Level)
NTSTATUS NTAPI	DbgSetDebugFilterState (IN ULONG ComponentId, IN ULONG Level, IN BOOLEAN State)
VOID NTAPI	DbgLoadImageSymbols (IN PSTRING Name, IN PVOID Base, IN ULONG_PTR ProcessId)
VOID NTAPI	DbgUnLoadImageSymbols (IN PSTRING Name, IN PVOID Base, IN ULONG_PTR ProcessId)
VOID NTAPI	DbgCommandString (IN PCCH Name, IN PCCH Command)
VOID NTAPI	RtlPopFrame (IN PTEB_ACTIVE_FRAME Frame)
VOID NTAPI	RtlPushFrame (IN PTEB_ACTIVE_FRAME Frame)
PTEB_ACTIVE_FRAME NTAPI	RtlGetFrame (VOID)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 16 of file debug.c.

Function Documentation

DbgCommandString()

VOID NTAPI DbgCommandString	(	IN PCCH	Name,
		IN PCCH	Command
	)

Definition at line 381 of file debug.c.

{
    STRING NameString, CommandString;
 
    /* Setup the strings */
    NameString.Buffer = (PCHAR)Name;
    NameString.Length = (USHORT)strlen(Name);
    CommandString.Buffer = (PCHAR)Command;
    CommandString.Length = (USHORT)strlen(Command);
 
    /* Send them to the debugger */
    DebugService2(&NameString, &CommandString, BREAKPOINT_COMMAND_STRING);
}

DbgLoadImageSymbols()

VOID NTAPI DbgLoadImageSymbols	(	IN PSTRING	Name,
		IN PVOID	Base,
		IN ULONG_PTR	ProcessId
	)

Definition at line 326 of file debug.c.

{
    PIMAGE_NT_HEADERS NtHeader;
    KD_SYMBOLS_INFO SymbolInfo;
 
    /* Setup the symbol data */
    SymbolInfo.BaseOfDll = Base;
    SymbolInfo.ProcessId = ProcessId;
 
    /* Get NT Headers */
    NtHeader = RtlImageNtHeader(Base);
    if (NtHeader)
    {
        /* Get the rest of the data */
        SymbolInfo.CheckSum = NtHeader->OptionalHeader.CheckSum;
        SymbolInfo.SizeOfImage = NtHeader->OptionalHeader.SizeOfImage;
    }
    else
    {
        /* No data available */
        SymbolInfo.CheckSum =
        SymbolInfo.SizeOfImage = 0;
    }
 
    /* Load the symbols */
    DebugService2(Name, &SymbolInfo, BREAKPOINT_LOAD_SYMBOLS);
}

DbgPrint()

ULONG __cdecl DbgPrint	(	PCCH	Format,
			...
	)

Definition at line 206 of file debug.c.

{
    ULONG Status;
    va_list ap;
 
    /* Call the internal routine that also handles ControlC */
    va_start(ap, Format);
    Status = vDbgPrintExWithPrefixInternal("",
                                           -1,
                                           DPFLTR_ERROR_LEVEL,
                                           Format,
                                           ap,
                                           TRUE);
    va_end(ap);
    return Status;
}

DbgPrintEx()

ULONG __cdecl DbgPrintEx	(	IN ULONG	ComponentId,
		IN ULONG	Level,
		IN PCCH	Format,
			...
	)

Definition at line 229 of file debug.c.

{
    ULONG Status;
    va_list ap;
 
    /* Call the internal routine that also handles ControlC */
    va_start(ap, Format);
    Status = vDbgPrintExWithPrefixInternal("",
                                           ComponentId,
                                           Level,
                                           Format,
                                           ap,
                                           TRUE);
    va_end(ap);
    return Status;
}

DbgPrintReturnControlC()

ULONG __cdecl DbgPrintReturnControlC	(	PCCH	Format,
			...
	)

Definition at line 254 of file debug.c.

{
    ULONG Status;
    va_list ap;
 
    /* Call the internal routine that also handles ControlC */
    va_start(ap, Format);
    Status = vDbgPrintExWithPrefixInternal("",
                                           -1,
                                           DPFLTR_ERROR_LEVEL,
                                           Format,
                                           ap,
                                           FALSE);
    va_end(ap);
    return Status;
}

DbgPrompt()

ULONG NTAPI DbgPrompt	(	IN PCCH	Prompt,
		OUT PCH	Response,
		IN ULONG	MaximumResponseLength
	)

Definition at line 277 of file debug.c.

{
    STRING Output;
    STRING Input;
 
    /* Setup the input string */
    Input.MaximumLength = (USHORT)MaximumResponseLength;
    Input.Buffer = Response;
 
    /* Setup the output string */
    Output.Length = (USHORT)strlen(Prompt);
    Output.Buffer = (PCHAR)Prompt;
 
    /* Call the system service */
    return DebugPrompt(&Output, &Input);
}

DbgQueryDebugFilterState()

NTSTATUS NTAPI DbgQueryDebugFilterState	(	IN ULONG	ComponentId,
		IN ULONG	Level
	)

Definition at line 301 of file debug.c.

{
    /* Call the Nt routine */
    return NtQueryDebugFilterState(ComponentId, Level);
}

DbgSetDebugFilterState()

NTSTATUS NTAPI DbgSetDebugFilterState	(	IN ULONG	ComponentId,
		IN ULONG	Level,
		IN BOOLEAN	State
	)

Definition at line 313 of file debug.c.

{
    /* Call the Nt routine */
    return NtSetDebugFilterState(ComponentId, Level, State);
}

DbgUnLoadImageSymbols()

VOID NTAPI DbgUnLoadImageSymbols	(	IN PSTRING	Name,
		IN PVOID	Base,
		IN ULONG_PTR	ProcessId
	)

Definition at line 361 of file debug.c.

{
    KD_SYMBOLS_INFO SymbolInfo;
 
    /* Setup the symbol data */
    SymbolInfo.BaseOfDll = Base;
    SymbolInfo.ProcessId = ProcessId;
    SymbolInfo.CheckSum = SymbolInfo.SizeOfImage = 0;
 
    /* Load the symbols */
    DebugService2(Name, &SymbolInfo, BREAKPOINT_UNLOAD_SYMBOLS);
}

DebugPrint()

ULONG NTAPI DebugPrint	(	IN PSTRING	DebugString,
		IN ULONG	ComponentId,
		IN ULONG	Level
	)

Definition at line 23 of file debug.c.

{
    /* Call the Debug Service */
    return DebugService(BREAKPOINT_PRINT,
                        DebugString->Buffer,
                        UlongToPtr(DebugString->Length),
                        UlongToPtr(ComponentId),
                        UlongToPtr(Level));
}

DebugPrompt()

ULONG NTAPI DebugPrompt	(	IN PSTRING	Output,
		IN PSTRING	Input
	)

Definition at line 37 of file debug.c.

{
    /* Call the Debug Service */
    return DebugService(BREAKPOINT_PROMPT,
                        Output->Buffer,
                        UlongToPtr(Output->Length),
                        Input->Buffer,
                        UlongToPtr(Input->MaximumLength));
}

Referenced by DbgPrompt().

RtlGetFrame()

PTEB_ACTIVE_FRAME NTAPI RtlGetFrame

(

VOID

)

Definition at line 421 of file debug.c.

{
    /* Return the frame that's currently active */
    return NtCurrentTeb()->ActiveFrame;
}

RtlPopFrame()

VOID NTAPI RtlPopFrame

(

IN PTEB_ACTIVE_FRAME

Frame

)

Definition at line 401 of file debug.c.

{
    /* Restore the previous frame as the active one */
    NtCurrentTeb()->ActiveFrame = Frame->Previous;
}

RtlPushFrame()

VOID NTAPI RtlPushFrame

(

IN PTEB_ACTIVE_FRAME

Frame

)

Definition at line 412 of file debug.c.

{
    /* Save the current frame and set the new one as active */
    Frame->Previous = NtCurrentTeb()->ActiveFrame;
    NtCurrentTeb()->ActiveFrame = Frame;
}

vDbgPrintEx()

ULONG NTAPI vDbgPrintEx	(	IN ULONG	ComponentId,
		IN ULONG	Level,
		IN PCCH	Format,
		IN va_list	ap
	)

Definition at line 187 of file debug.c.

{
    /* Call the internal routine that also handles ControlC */
    return vDbgPrintExWithPrefixInternal("",
                                         ComponentId,
                                         Level,
                                         Format,
                                         ap,
                                         TRUE);
}

vDbgPrintExWithPrefix()

ULONG NTAPI vDbgPrintExWithPrefix	(	IN PCCH	Prefix,
		IN ULONG	ComponentId,
		IN ULONG	Level,
		IN PCCH	Format,
		IN va_list	ap
	)

Definition at line 167 of file debug.c.

{
    /* Call the internal routine that also handles ControlC */
    return vDbgPrintExWithPrefixInternal(Prefix,
                                         ComponentId,
                                         Level,
                                         Format,
                                         ap,
                                         TRUE);
}

vDbgPrintExWithPrefixInternal()

ULONG NTAPI vDbgPrintExWithPrefixInternal	(	IN PCCH	Prefix,
		IN ULONG	ComponentId,
		IN ULONG	Level,
		IN PCCH	Format,
		IN va_list	ap,
		IN BOOLEAN	HandleBreakpoint
	)

Definition at line 52 of file debug.c.

{
    NTSTATUS Status;
    STRING DebugString;
    CHAR Buffer[512];
    SIZE_T Length, PrefixLength;
    EXCEPTION_RECORD ExceptionRecord;
 
    /* Check if we should print it or not */
    if ((ComponentId != MAXULONG) &&
        (NtQueryDebugFilterState(ComponentId, Level)) != (NTSTATUS)TRUE)
    {
        /* This message is masked */
        return STATUS_SUCCESS;
    }
 
    /* For user mode, don't recursively DbgPrint */
    if (RtlpSetInDbgPrint()) return STATUS_SUCCESS;
 
    /* Guard against incorrect pointers */
    _SEH2_TRY
    {
        /* Get the length and normalize it */
        PrefixLength = strlen(Prefix);
        if (PrefixLength > sizeof(Buffer)) PrefixLength = sizeof(Buffer);
 
        /* Copy it */
        strncpy(Buffer, Prefix, PrefixLength);
 
        /* Do the printf */
        Length = _vsnprintf(Buffer + PrefixLength,
                            sizeof(Buffer) - PrefixLength,
                            Format,
                            ap);
    }
    _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
    {
        /* In user-mode, clear the InDbgPrint Flag */
        RtlpClearInDbgPrint();
        /* Fail */
        _SEH2_YIELD(return _SEH2_GetExceptionCode());
    }
    _SEH2_END;
 
    /* Check if we went past the buffer */
    if (Length == MAXULONG)
    {
        /* Terminate it if we went over-board */
        Buffer[sizeof(Buffer) - 2] = '\n';
        Buffer[sizeof(Buffer) - 1] = '\0';
 
        /* Put maximum */
        Length = sizeof(Buffer) - 1;
    }
    else
    {
        /* Add the prefix */
        Length += PrefixLength;
    }
 
    /* Build the string */
    DebugString.Length = (USHORT)Length;
    DebugString.Buffer = Buffer;
 
    /* First, let the debugger know as well */
    if (RtlpCheckForActiveDebugger())
    {
        /* Fill out an exception record */
        ExceptionRecord.ExceptionCode = DBG_PRINTEXCEPTION_C;
        ExceptionRecord.ExceptionRecord = NULL;
        ExceptionRecord.NumberParameters = 2;
        ExceptionRecord.ExceptionFlags = 0;
        ExceptionRecord.ExceptionInformation[0] = DebugString.Length + 1;
        ExceptionRecord.ExceptionInformation[1] = (ULONG_PTR)DebugString.Buffer;
 
        /* Raise the exception */
        RtlRaiseException(&ExceptionRecord);
 
        /* In user-mode, clear the InDbgPrint Flag */
        RtlpClearInDbgPrint();
        return STATUS_SUCCESS;
    }
 
    /* Call the Debug Print routine */
    Status = DebugPrint(&DebugString, ComponentId, Level);
 
    /* Check if this was with Control-C */
    if (HandleBreakpoint)
    {
        /* Check if we got a breakpoint */
        if (Status == STATUS_BREAKPOINT)
        {
            /* Breakpoint */
            DbgBreakPointWithStatus(DBG_STATUS_CONTROL_C);
            Status = STATUS_SUCCESS;
        }
    }
 
    /* In user-mode, clear the InDbgPrint Flag */
    RtlpClearInDbgPrint();
 
    /* Return */
    return Status;
}

Referenced by DbgPrint(), DbgPrintEx(), DbgPrintReturnControlC(), vDbgPrintEx(), and vDbgPrintExWithPrefix().