mirror of
https://github.com/reactos/reactos.git
synced 2024-11-05 06:09:58 +00:00
354 lines
9.8 KiB
C
354 lines
9.8 KiB
C
/*
|
|
* PROJECT: ReactOS Kernel
|
|
* LICENSE: GPL - See COPYING in the top level directory
|
|
* FILE: ntoskrnl/kd64/kdprint.c
|
|
* PURPOSE: KD64 Trap Handler Routines
|
|
* PROGRAMMERS: Alex Ionescu (alex.ionescu@reactos.org)
|
|
* Stefan Ginsberg (stefan.ginsberg@reactos.org)
|
|
*/
|
|
|
|
/* INCLUDES ******************************************************************/
|
|
|
|
#include <ntoskrnl.h>
|
|
#define NDEBUG
|
|
#include <debug.h>
|
|
|
|
/* FUNCTIONS *****************************************************************/
|
|
|
|
BOOLEAN
|
|
NTAPI
|
|
KdpPrintString(IN PSTRING Output)
|
|
{
|
|
STRING Data, Header;
|
|
DBGKD_DEBUG_IO DebugIo;
|
|
USHORT Length = Output->Length;
|
|
|
|
/* Copy the string */
|
|
RtlMoveMemory(KdpMessageBuffer, Output->Buffer, Length);
|
|
|
|
/* Make sure we don't exceed the KD Packet size */
|
|
if ((sizeof(DBGKD_DEBUG_IO) + Length) > PACKET_MAX_SIZE)
|
|
{
|
|
/* Normalize length */
|
|
Length = PACKET_MAX_SIZE - sizeof(DBGKD_DEBUG_IO);
|
|
}
|
|
|
|
/* Build the packet header */
|
|
DebugIo.ApiNumber = DbgKdPrintStringApi;
|
|
DebugIo.ProcessorLevel = KeProcessorLevel;
|
|
DebugIo.Processor = KeGetCurrentPrcb()->Number;
|
|
DebugIo.u.PrintString.LengthOfString = Length;
|
|
Header.Length = sizeof(DBGKD_DEBUG_IO);
|
|
Header.Buffer = (PCHAR)&DebugIo;
|
|
|
|
/* Build the data */
|
|
Data.Length = Length;
|
|
Data.Buffer = KdpMessageBuffer;
|
|
|
|
/* Send the packet */
|
|
KdSendPacket(PACKET_TYPE_KD_DEBUG_IO, &Header, &Data, &KdpContext);
|
|
|
|
/* Check if the user pressed CTRL+C */
|
|
return KdpPollBreakInWithPortLock();
|
|
}
|
|
|
|
BOOLEAN
|
|
NTAPI
|
|
KdpPromptString(IN PSTRING PromptString,
|
|
IN PSTRING ResponseString)
|
|
{
|
|
STRING Data, Header;
|
|
DBGKD_DEBUG_IO DebugIo;
|
|
ULONG Length = PromptString->Length;
|
|
KDSTATUS Status;
|
|
|
|
/* Copy the string to the message buffer */
|
|
RtlCopyMemory(KdpMessageBuffer,
|
|
PromptString->Buffer,
|
|
PromptString->Length);
|
|
|
|
/* Make sure we don't exceed the KD Packet size */
|
|
if ((sizeof(DBGKD_DEBUG_IO) + Length) > PACKET_MAX_SIZE)
|
|
{
|
|
/* Normalize length */
|
|
Length = PACKET_MAX_SIZE - sizeof(DBGKD_DEBUG_IO);
|
|
}
|
|
|
|
/* Build the packet header */
|
|
DebugIo.ApiNumber = DbgKdGetStringApi;
|
|
DebugIo.ProcessorLevel = KeProcessorLevel;
|
|
DebugIo.Processor = KeGetCurrentPrcb()->Number;
|
|
DebugIo.u.GetString.LengthOfPromptString = Length;
|
|
DebugIo.u.GetString.LengthOfStringRead = ResponseString->MaximumLength;
|
|
Header.Length = sizeof(DBGKD_DEBUG_IO);
|
|
Header.Buffer = (PCHAR)&DebugIo;
|
|
|
|
/* Build the data */
|
|
Data.Length = PromptString->Length;
|
|
Data.Buffer = KdpMessageBuffer;
|
|
|
|
/* Send the packet */
|
|
KdSendPacket(PACKET_TYPE_KD_DEBUG_IO, &Header, &Data, &KdpContext);
|
|
|
|
/* Set the maximum lengths for the receive */
|
|
Header.MaximumLength = sizeof(DBGKD_DEBUG_IO);
|
|
Data.MaximumLength = sizeof(KdpMessageBuffer);
|
|
|
|
/* Enter receive loop */
|
|
do
|
|
{
|
|
/* Get our reply */
|
|
Status = KdReceivePacket(PACKET_TYPE_KD_DEBUG_IO,
|
|
&Header,
|
|
&Data,
|
|
&Length,
|
|
&KdpContext);
|
|
|
|
/* 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);
|
|
|
|
/* Copy back the string and return the length */
|
|
RtlCopyMemory(ResponseString->Buffer, KdpMessageBuffer, Length);
|
|
ResponseString->Length = Length;
|
|
|
|
/* Success; we don't need to resend */
|
|
return FALSE;
|
|
}
|
|
|
|
VOID
|
|
NTAPI
|
|
KdpCommandString(IN PSTRING NameString,
|
|
IN PSTRING CommandString,
|
|
IN KPROCESSOR_MODE PreviousMode,
|
|
IN PCONTEXT ContextRecord,
|
|
IN PKTRAP_FRAME TrapFrame,
|
|
IN PKEXCEPTION_FRAME ExceptionFrame)
|
|
{
|
|
BOOLEAN Enable;
|
|
PKPRCB Prcb = KeGetCurrentPrcb();
|
|
|
|
/* Check if we need to do anything */
|
|
if ((PreviousMode != KernelMode) || (KdDebuggerNotPresent)) return;
|
|
|
|
/* Enter the debugger */
|
|
Enable = KdEnterDebugger(TrapFrame, ExceptionFrame);
|
|
|
|
/* Save the CPU Control State and save the context */
|
|
KiSaveProcessorControlState(&Prcb->ProcessorState);
|
|
RtlCopyMemory(&Prcb->ProcessorState.ContextFrame,
|
|
ContextRecord,
|
|
sizeof(CONTEXT));
|
|
|
|
/* Send the command string to the debugger */
|
|
KdpReportCommandStringStateChange(NameString,
|
|
CommandString,
|
|
&Prcb->ProcessorState.ContextFrame);
|
|
|
|
/* Restore the processor state */
|
|
RtlCopyMemory(ContextRecord,
|
|
&Prcb->ProcessorState.ContextFrame,
|
|
sizeof(CONTEXT));
|
|
KiRestoreProcessorControlState(&Prcb->ProcessorState);
|
|
|
|
/* Exit the debugger and return */
|
|
KdExitDebugger(Enable);
|
|
}
|
|
|
|
VOID
|
|
NTAPI
|
|
KdpSymbol(IN PSTRING DllPath,
|
|
IN PKD_SYMBOLS_INFO SymbolInfo,
|
|
IN BOOLEAN Unload,
|
|
IN KPROCESSOR_MODE PreviousMode,
|
|
IN PCONTEXT ContextRecord,
|
|
IN PKTRAP_FRAME TrapFrame,
|
|
IN PKEXCEPTION_FRAME ExceptionFrame)
|
|
{
|
|
BOOLEAN Enable;
|
|
PKPRCB Prcb = KeGetCurrentPrcb();
|
|
|
|
/* Check if we need to do anything */
|
|
if ((PreviousMode != KernelMode) || (KdDebuggerNotPresent)) return;
|
|
|
|
/* Enter the debugger */
|
|
Enable = KdEnterDebugger(TrapFrame, ExceptionFrame);
|
|
|
|
/* Save the CPU Control State and save the context */
|
|
KiSaveProcessorControlState(&Prcb->ProcessorState);
|
|
RtlCopyMemory(&Prcb->ProcessorState.ContextFrame,
|
|
ContextRecord,
|
|
sizeof(CONTEXT));
|
|
|
|
/* Report the new state */
|
|
KdpReportLoadSymbolsStateChange(DllPath,
|
|
SymbolInfo,
|
|
Unload,
|
|
&Prcb->ProcessorState.ContextFrame);
|
|
|
|
/* Restore the processor state */
|
|
RtlCopyMemory(ContextRecord,
|
|
&Prcb->ProcessorState.ContextFrame,
|
|
sizeof(CONTEXT));
|
|
KiRestoreProcessorControlState(&Prcb->ProcessorState);
|
|
|
|
/* Exit the debugger and return */
|
|
KdExitDebugger(Enable);
|
|
}
|
|
|
|
USHORT
|
|
NTAPI
|
|
KdpPrompt(IN LPSTR PromptString,
|
|
IN USHORT PromptLength,
|
|
OUT LPSTR ResponseString,
|
|
IN USHORT MaximumResponseLength,
|
|
IN KPROCESSOR_MODE PreviousMode,
|
|
IN PKTRAP_FRAME TrapFrame,
|
|
IN PKEXCEPTION_FRAME ExceptionFrame)
|
|
{
|
|
STRING PromptBuffer, ResponseBuffer;
|
|
BOOLEAN Enable, Resend;
|
|
|
|
/* Normalize the lengths */
|
|
PromptLength = min(PromptLength, 512);
|
|
MaximumResponseLength = min(MaximumResponseLength, 512);
|
|
|
|
/* Check if we need to verify the string */
|
|
if (PreviousMode != KernelMode)
|
|
{
|
|
/* FIXME: Handle user-mode */
|
|
}
|
|
|
|
/* Setup the prompt and response buffers */
|
|
PromptBuffer.Buffer = PromptString;
|
|
PromptBuffer.Length = PromptLength;
|
|
ResponseBuffer.Buffer = ResponseString;
|
|
ResponseBuffer.Length = 0;
|
|
ResponseBuffer.MaximumLength = MaximumResponseLength;
|
|
|
|
/* Log the print */
|
|
//KdLogDbgPrint(&PromptBuffer);
|
|
|
|
/* Enter the debugger */
|
|
Enable = KdEnterDebugger(TrapFrame, ExceptionFrame);
|
|
|
|
/* Enter prompt loop */
|
|
do
|
|
{
|
|
/* Send the prompt and receive the response */
|
|
Resend = KdpPromptString(&PromptBuffer, &ResponseBuffer);
|
|
|
|
/* Loop while we need to resend */
|
|
} while (Resend);
|
|
|
|
/* Exit the debugger */
|
|
KdExitDebugger(Enable);
|
|
|
|
/* Return the number of characters received */
|
|
return ResponseBuffer.Length;
|
|
}
|
|
|
|
NTSTATUS
|
|
NTAPI
|
|
KdpPrint(IN ULONG ComponentId,
|
|
IN ULONG Level,
|
|
IN LPSTR String,
|
|
IN USHORT Length,
|
|
IN KPROCESSOR_MODE PreviousMode,
|
|
IN PKTRAP_FRAME TrapFrame,
|
|
IN PKEXCEPTION_FRAME ExceptionFrame,
|
|
OUT PBOOLEAN Handled)
|
|
{
|
|
NTSTATUS ReturnStatus;
|
|
BOOLEAN Enable;
|
|
STRING OutputString;
|
|
|
|
/* Assume failure */
|
|
*Handled = FALSE;
|
|
|
|
/* Validate the mask */
|
|
if (Level < 32) Level = 1 << Level;
|
|
if (!(Kd_WIN2000_Mask & Level) ||
|
|
((ComponentId < KdComponentTableSize) &&
|
|
!(*KdComponentTable[ComponentId] & Level)))
|
|
{
|
|
/* Mask validation failed */
|
|
*Handled = TRUE;
|
|
return STATUS_SUCCESS;
|
|
}
|
|
|
|
/* Normalize the length */
|
|
Length = min(Length, 512);
|
|
|
|
/* Check if we need to verify the buffer */
|
|
if (PreviousMode != KernelMode)
|
|
{
|
|
/* FIXME: Support user-mode */
|
|
}
|
|
|
|
/* Setup the output string */
|
|
OutputString.Buffer = String;
|
|
OutputString.Length = Length;
|
|
|
|
/* Log the print */
|
|
//KdLogDbgPrint(&OutputString);
|
|
|
|
/* Check for a debugger */
|
|
if (KdDebuggerNotPresent)
|
|
{
|
|
/* Fail */
|
|
*Handled = TRUE;
|
|
return STATUS_DEVICE_NOT_CONNECTED;
|
|
}
|
|
|
|
/* Enter the debugger */
|
|
Enable = KdEnterDebugger(TrapFrame, ExceptionFrame);
|
|
|
|
/* Print the string */
|
|
if (KdpPrintString(&OutputString))
|
|
{
|
|
/* User pressed CTRL-C, breakpoint on return */
|
|
ReturnStatus = STATUS_BREAKPOINT;
|
|
}
|
|
else
|
|
{
|
|
/* String was printed */
|
|
ReturnStatus = STATUS_SUCCESS;
|
|
}
|
|
|
|
/* Exit the debugger and return */
|
|
KdExitDebugger(Enable);
|
|
*Handled = TRUE;
|
|
return ReturnStatus;
|
|
}
|
|
|
|
VOID
|
|
__cdecl
|
|
KdpDprintf(IN PCHAR Format,
|
|
...)
|
|
{
|
|
STRING String;
|
|
CHAR Buffer[100];
|
|
USHORT Length;
|
|
va_list ap;
|
|
|
|
/* Format the string */
|
|
va_start(ap, Format);
|
|
Length = (USHORT)_vsnprintf(Buffer,
|
|
sizeof(Buffer),
|
|
Format,
|
|
ap);
|
|
|
|
/* Set it up */
|
|
String.Buffer = Buffer;
|
|
String.Length = Length + 1;
|
|
|
|
/* Send it to the debugger directly */
|
|
KdpPrintString(&String);
|
|
va_end(ap);
|
|
}
|