kdb_print.c File Reference

#include <ntoskrnl.h>
#include "kdb.h"

Include dependency graph for kdb_print.c:

Go to the source code of this file.

Macros
#define	pKdSendPacket   KdSendPacket
#define	pKdReceivePacket   KdReceivePacket

Functions
static VOID	KdbPrintStringWorker (_In_ const CSTRING *Output, _In_ ULONG ApiNumber, _Inout_ PDBGKD_DEBUG_IO DebugIo, _Inout_ PSTRING Header, _Inout_ PSTRING Data)
VOID	KdbPrintString (_In_ const CSTRING *Output)
static BOOLEAN	KdbPromptStringWorker (_In_ const CSTRING *PromptString, _Inout_ PSTRING ResponseString)
USHORT	KdbPromptString (_In_ const CSTRING *PromptString, _Inout_ PSTRING ResponseString)
VOID	KdbPutsN (_In_ PCCH String, _In_ USHORT Length)
VOID	KdbPuts (_In_ PCSTR String)
VOID __cdecl	KdbPrintf (_In_ PCSTR Format,...)
SIZE_T	KdbPrompt (_In_ PCSTR Prompt, _Out_ PCHAR Buffer, _In_ SIZE_T Size)

Variables
static KD_CONTEXT	KdbgKdContext

Macro Definition Documentation

pKdReceivePacket

#define pKdReceivePacket   KdReceivePacket

Definition at line 22 of file kdb_print.c.

pKdSendPacket

#define pKdSendPacket   KdSendPacket

Definition at line 19 of file kdb_print.c.

Function Documentation

KdbPrintf()

VOID __cdecl KdbPrintf	(	_In_ PCSTR	Format,
			...
	)

Definition at line 160 of file kdb_print.c.

{
    va_list ap;
    SIZE_T Length;
    CHAR Buffer[1024];
 
    /* Format the string */
    va_start(ap, Format);
    Length = _vsnprintf(Buffer,
                        sizeof(Buffer),
                        Format,
                        ap);
    Length = min(Length, MAXUSHORT - sizeof(ANSI_NULL));
    va_end(ap);
 
    /* Send it to the debugger directly */
    KdbPutsN(Buffer, (USHORT)Length);
}

Referenced by KdbEnterDebuggerException(), KdbpDeleteBreakPoint(), KdbpDisableBreakPoint(), KdbpEnableBreakPoint(), KdbpInsertBreakPoint(), KdbpPagerInternal(), KdbpPrintAddressInCode(), KdbpShouldStepOverInstruction(), KdbSymPrintAddress(), KdReceivePacket(), and KdSendPacket().

KdbPrintString()

VOID KdbPrintString

(

_In_ const CSTRING *

Output

)

Definition at line 64 of file kdb_print.c.

{
    DBGKD_DEBUG_IO DebugIo;
    STRING Header, Data;
 
    KdbPrintStringWorker(Output, DbgKdPrintStringApi,
                         &DebugIo, &Header, &Data);
}

Referenced by KdbPutsN().

KdbPrintStringWorker()

static VOID KdbPrintStringWorker ( _In_ const CSTRING *  Output, _In_ ULONG  ApiNumber, _Inout_ PDBGKD_DEBUG_IO  DebugIo, _Inout_ PSTRING  Header, _Inout_ PSTRING  Data  )

static

Definition at line 25 of file kdb_print.c.

{
    USHORT Length;
    C_ASSERT(PACKET_MAX_SIZE >= sizeof(*DebugIo));
 
    ASSERT((ApiNumber == DbgKdPrintStringApi) ||
           (ApiNumber == DbgKdGetStringApi));
 
    /* Make sure we don't exceed the KD Packet size */
    Length = min(Output->Length, PACKET_MAX_SIZE - sizeof(*DebugIo));
 
    /* Build the packet header */
    DebugIo->ApiNumber = ApiNumber;
    DebugIo->ProcessorLevel = 0; // (USHORT)KeProcessorLevel;
    DebugIo->Processor = KeGetCurrentPrcb()->Number;
 
    if (ApiNumber == DbgKdPrintStringApi)
        DebugIo->u.PrintString.LengthOfString = Length;
    else // if (ApiNumber == DbgKdGetStringApi)
        DebugIo->u.GetString.LengthOfPromptString = Length;
 
    Header->Length = sizeof(*DebugIo);
    Header->Buffer = (PCHAR)DebugIo;
 
    /* Build the data */
    Data->Length = Length;
    Data->Buffer = (PCHAR)Output->Buffer;
 
    /* Send the packet */
    /* IO packet: call KdTerm */
    pKdSendPacket(PACKET_TYPE_KD_DEBUG_IO, Header, Data, &KdbgKdContext);
}

Referenced by KdbPrintString(), and KdbPromptStringWorker().

KdbPrompt()

SIZE_T KdbPrompt	(	_In_ PCSTR	Prompt,
		_Out_ PCHAR	Buffer,
		_In_ SIZE_T	Size
	)

Definition at line 182 of file kdb_print.c.

{
    CSTRING PromptString;
    STRING ResponseBuffer;
 
    PromptString.Buffer = Prompt;
    PromptString.Length = PromptString.MaximumLength =
        (USHORT)strnlen(Prompt, MAXUSHORT - sizeof(ANSI_NULL));
 
    ResponseBuffer.Buffer = Buffer;
    ResponseBuffer.Length = 0;
    ResponseBuffer.MaximumLength = (USHORT)min(Size, MAXUSHORT);
 
    return KdbPromptString(&PromptString, &ResponseBuffer);
}

Referenced by KdbpCliMainLoop().

KdbPromptString()

USHORT KdbPromptString	(	_In_ const CSTRING *	PromptString,
		_Inout_ PSTRING	ResponseString
	)

Definition at line 125 of file kdb_print.c.

{
    /* Enter prompt loop: send the prompt and receive the response */
    ResponseString->Length = 0;
    while (KdbPromptStringWorker(PromptString, ResponseString))
    {
        /* Loop while we need to resend */
    }
    return ResponseString->Length;
}

Referenced by KdbPrompt().

KdbPromptStringWorker()

static BOOLEAN KdbPromptStringWorker ( _In_ const CSTRING *  PromptString, _Inout_ PSTRING  ResponseString  )

static

Definition at line 75 of file kdb_print.c.

{
    DBGKD_DEBUG_IO DebugIo;
    STRING Header, Data;
    ULONG Length;
    KDSTATUS Status;
 
    /* Print the prompt */
    // DebugIo.u.GetString.LengthOfPromptString = Length;
    DebugIo.u.GetString.LengthOfStringRead = ResponseString->MaximumLength;
    KdbPrintStringWorker(PromptString, DbgKdGetStringApi,
                         &DebugIo, &Header, &Data);
 
    /* Set the maximum lengths for the receive */
    Header.MaximumLength = sizeof(DebugIo);
    Data.MaximumLength = ResponseString->MaximumLength;
    /* Build the data */
    Data.Buffer = ResponseString->Buffer;
 
    /* Enter receive loop */
    do
    {
        /* Get our reply */
        /* IO packet: call KdTerm */
        Status = pKdReceivePacket(PACKET_TYPE_KD_DEBUG_IO,
                                  &Header,
                                  &Data,
                                  &Length,
                                  &KdbgKdContext);
 
        /* Return TRUE if we need to resend */
        if (Status == KdPacketNeedsResend)
            return TRUE;
 
    /* Loop until we succeed */
    } while (Status != KdPacketReceived);
 
    /* Don't copy back a larger response than there is room for */
    Length = min(Length, ResponseString->MaximumLength);
 
    /* We've got the string back; return the length */
    ResponseString->Length = (USHORT)Length;
 
    /* Success; we don't need to resend */
    return FALSE;
}

Referenced by KdbPromptString().

KdbPuts()

VOID KdbPuts

(

_In_ PCSTR

String

)

Definition at line 152 of file kdb_print.c.

{
    KdbPutsN(String, (USHORT)strnlen(String, MAXUSHORT - sizeof(ANSI_NULL)));
}

Referenced by KdbEnterDebuggerException(), KdbpDisableBreakPoint(), KdbpInsertBreakPoint(), KdbpPagerInternal(), and KdbpPrintDisasm().

KdbPutsN()

VOID KdbPutsN	(	_In_ PCCH	String,
		_In_ USHORT	Length
	)

Definition at line 140 of file kdb_print.c.

{
    CSTRING Output;
 
    Output.Buffer = String;
    Output.Length = Output.MaximumLength = Length;
    KdbPrintString(&Output);
}

Referenced by KdbPrintf(), and KdbPuts().

Variable Documentation

KdbgKdContext

KD_CONTEXT KdbgKdContext

static

Definition at line 16 of file kdb_print.c.

Referenced by KdbPrintStringWorker(), and KdbPromptStringWorker().