xbox-kernel/private/ntos/inc/kd.h
2020-09-30 17:17:25 +02:00

183 lines
3.5 KiB
C

/*++ BUILD Version: 0006 // Increment this if a change has global effects
Copyright (c) 1989 Microsoft Corporation
Module Name:
kd.h
Abstract:
This module contains the public data structures and procedure
prototypes for the Kernel Debugger sub-component of NTOS.
Author:
Mike O'Leary (mikeol) 29-June-1989
Revision History:
--*/
#ifndef _KD_
#define _KD_
// begin_nthal
//
// Status Constants for reading data from comport
//
#define CP_GET_SUCCESS 0
#define CP_GET_NODATA 1
#define CP_GET_ERROR 2
// end_nthal
//
// Debug constants for FreezeFlag
//
#define FREEZE_BACKUP 0x0001
#define FREEZE_SKIPPED_PROCESSOR 0x0002
#define FREEZE_FROZEN 0x0004
//
// System Initialization procedure for KD subcomponent of NTOS
//
VOID
KdInitSystem(
BOOLEAN InitializingSystem
);
BOOLEAN
KdEnterDebugger(
IN PKTRAP_FRAME TrapFrame,
IN PKEXCEPTION_FRAME ExceptionFrame
);
VOID
KdExitDebugger(
IN BOOLEAN Enable
);
BOOLEAN
KdPollBreakIn (
VOID
);
VOID
KdSetOwedBreakpoints(
VOID
);
VOID
KdDeleteAllBreakpoints(
VOID
);
//
// Data structure for passing information to KdpReportLoadSymbolsStateChange
// function via the debug trap
//
typedef struct _KD_SYMBOLS_INFO {
IN PVOID BaseOfDll;
IN ULONG_PTR ProcessId;
IN ULONG CheckSum;
IN ULONG SizeOfImage;
} KD_SYMBOLS_INFO, *PKD_SYMBOLS_INFO;
// begin_nthal
//
// Defines the debug port parameters for kernel debugger
// CommunicationPort - specify which COM port to use as debugging port
// 0 - use default; N - use COM N.
// BaudRate - the baud rate used to initialize debugging port
// 0 - use default rate.
//
typedef struct _DEBUG_PARAMETERS {
ULONG CommunicationPort;
ULONG BaudRate;
} DEBUG_PARAMETERS, *PDEBUG_PARAMETERS;
// end_nthal
// begin_ntddk begin_wdm begin_nthal begin_ntifs
//
// Define external data.
// because of indirection for all drivers external to ntoskrnl these are actually ptrs
//
#if defined(_NTDDK_) || defined(_NTIFS_) || defined(_NTHAL_) || defined(_WDMDDK_) || defined(_XBDM_)
extern PBOOLEAN KdDebuggerNotPresent;
extern PBOOLEAN KdDebuggerEnabled;
#else
extern BOOLEAN KdDebuggerNotPresent;
extern BOOLEAN KdDebuggerEnabled;
#endif
// end_ntddk end_wdm end_nthal end_ntifs
extern LIST_ENTRY KdLoadedModuleList;
extern DEBUG_PARAMETERS KdDebugParameters;
//
// This event is provided by the time service. The debugger
// signals the event when the system time has slipped due
// to debugger activity.
//
VOID
KdUpdateTimeSlipEvent(
PVOID Event
);
// begin_ntddk begin_nthal begin_ntifs
typedef struct _DBGKD_DEBUG_DATA_HEADER64 *PDBGKD_DEBUG_DATA_HEADER64;
BOOLEAN
KdRegisterDebuggerDataBlock(
IN ULONG Tag,
IN PDBGKD_DEBUG_DATA_HEADER64 DataHeader,
IN ULONG Size
);
VOID
KdDeregisterDebuggerDataBlock32(
IN PDBGKD_DEBUG_DATA_HEADER64 DataHeader
);
// end_ntddk end_nthal end_ntifs
//
// DbgPrint strings will always be logged to a circular buffer,
// even if FLG_DISABLE_DBGPRINT is set. This function may be called
// directly by the debugger service trap handler even when the debugger
// is not enabled.
//
#if DBG
#define KDPRINTBUFFERSIZE 16384
#else
#define KDPRINTBUFFERSIZE 4096
#endif
VOID
KdLogDbgPrint(
IN PSTRING String
);
#endif // _KD_