kdfuncs.h File Reference

Go to the source code of this file.

Macros
#define	KdPrint(_x_)
#define	KdPrintEx(_x_)
#define	vKdPrintEx(_x_)
#define	vKdPrintExWithPrefix(_x_)
#define	KdBreakPoint()
#define	KdBreakPointWithStatus(s)
#define	KD_DEBUGGER_ENABLED   (*KdDebuggerEnabled)
#define	KD_DEBUGGER_NOT_PRESENT   (*KdDebuggerNotPresent)

Typedefs
typedef VOID(*	PDEBUG_PRINT_CALLBACK) (_In_ PSTRING Output, _In_ ULONG ComponentId, _In_ ULONG Level)

Functions
	$if (_NTDDK_) NTSYSAPI ULONG NTAPI DbgPrompt(_In_z_ PCCH Prompt
	_Out_writes_bytes_ (MaximumResponseLength) PCH Response
	$endif (_NTDDK_) $if(_WDMDDK_) ULONG __cdecl DbgPrint(_In_z_ _Printf_format_string_ PCSTR Format
NTSYSAPI ULONG __cdecl	DbgPrintReturnControlC (_In_z_ _Printf_format_string_ PCCH Format,...)
NTSYSAPI ULONG __cdecl	DbgPrintEx (_In_ ULONG ComponentId, _In_ ULONG Level, _In_z_ _Printf_format_string_ PCSTR Format,...)
NTSYSAPI NTSTATUS NTAPI	DbgQueryDebugFilterState (_In_ ULONG ComponentId, _In_ ULONG Level)
NTSYSAPI NTSTATUS NTAPI	DbgSetDebugFilterState (_In_ ULONG ComponentId, _In_ ULONG Level, _In_ BOOLEAN State)
NTSYSAPI NTSTATUS NTAPI	DbgSetDebugPrintCallback (_In_ PDEBUG_PRINT_CALLBACK DebugPrintCallback, _In_ BOOLEAN Enable)
NTKERNELAPI NTSTATUS NTAPI	KdDisableDebugger (VOID)
NTKERNELAPI NTSTATUS NTAPI	KdEnableDebugger (VOID)
__analysis_noreturn VOID NTAPI	DbgBreakPoint (VOID)
__analysis_noreturn NTSYSAPI VOID NTAPI	DbgBreakPointWithStatus (_In_ ULONG Status)
NTKERNELAPI BOOLEAN NTAPI	KdRefreshDebuggerNotPresent (VOID)
NTKERNELAPI NTSTATUS NTAPI	KdChangeOption (_In_ KD_OPTION Option, _In_opt_ ULONG InBufferBytes, _In_ PVOID InBuffer, _In_opt_ ULONG OutBufferBytes, _Out_ PVOID OutBuffer, _Out_opt_ PULONG OutBufferNeeded)

Variables
_In_ ULONG	MaximumResponseLength
BOOLEAN *	KdDebuggerEnabled
BOOLEAN *	KdDebuggerNotPresent

Macro Definition Documentation

KD_DEBUGGER_ENABLED

#define KD_DEBUGGER_ENABLED   (*KdDebuggerEnabled)

Definition at line 130 of file kdfuncs.h.

KD_DEBUGGER_NOT_PRESENT

#define KD_DEBUGGER_NOT_PRESENT   (*KdDebuggerNotPresent)

Definition at line 133 of file kdfuncs.h.

KdBreakPoint

#define KdBreakPoint

(

)

Definition at line 117 of file kdfuncs.h.

KdBreakPointWithStatus

#define KdBreakPointWithStatus

(

s

)

Definition at line 118 of file kdfuncs.h.

KdPrint

#define KdPrint

(

_x_

)

Definition at line 113 of file kdfuncs.h.

KdPrintEx

#define KdPrintEx

(

_x_

)

Definition at line 114 of file kdfuncs.h.

vKdPrintEx

#define vKdPrintEx

(

_x_

)

Definition at line 115 of file kdfuncs.h.

vKdPrintExWithPrefix

#define vKdPrintExWithPrefix

(

_x_

)

Definition at line 116 of file kdfuncs.h.

Typedef Documentation

PDEBUG_PRINT_CALLBACK

typedef VOID(* PDEBUG_PRINT_CALLBACK) (_In_ PSTRING Output, _In_ ULONG ComponentId, _In_ ULONG Level)

Definition at line 86 of file kdfuncs.h.

Function Documentation

$endif()

$endif

(

_NTDDK_

)

Definition at line 2490 of file iofuncs.h.

{
    PriorityInfo->Size = sizeof(IO_PRIORITY_INFO);
    PriorityInfo->ThreadPriority = 0xffff;
    PriorityInfo->IoPriority = IoPriorityNormal;
    PriorityInfo->PagePriority = 0;
}

$if()

$if

(

_NTDDK_

)

Definition at line 176 of file ke.h.

                                           {
  ULONG64 P1Home;
  ULONG64 P2Home;
  ULONG64 P3Home;
  ULONG64 P4Home;
  ULONG64 P5Home;
  ULONG64 P6Home;
  ULONG ContextFlags;
  ULONG MxCsr;
  USHORT SegCs;
  USHORT SegDs;
  USHORT SegEs;
  USHORT SegFs;
  USHORT SegGs;
  USHORT SegSs;
  ULONG EFlags;
  ULONG64 Dr0;
  ULONG64 Dr1;
  ULONG64 Dr2;
  ULONG64 Dr3;
  ULONG64 Dr6;
  ULONG64 Dr7;
  ULONG64 Rax;
  ULONG64 Rcx;
  ULONG64 Rdx;
  ULONG64 Rbx;
  ULONG64 Rsp;
  ULONG64 Rbp;
  ULONG64 Rsi;
  ULONG64 Rdi;
  ULONG64 R8;
  ULONG64 R9;
  ULONG64 R10;
  ULONG64 R11;
  ULONG64 R12;
  ULONG64 R13;
  ULONG64 R14;
  ULONG64 R15;
  ULONG64 Rip;
  union {
    XMM_SAVE_AREA32 FltSave;
    struct {
      M128A Header[2];
      M128A Legacy[8];
      M128A Xmm0;
      M128A Xmm1;
      M128A Xmm2;
      M128A Xmm3;
      M128A Xmm4;
      M128A Xmm5;
      M128A Xmm6;
      M128A Xmm7;
      M128A Xmm8;
      M128A Xmm9;
      M128A Xmm10;
      M128A Xmm11;
      M128A Xmm12;
      M128A Xmm13;
      M128A Xmm14;
      M128A Xmm15;
    } DUMMYSTRUCTNAME;
  } DUMMYUNIONNAME;
  M128A VectorRegister[26];
  ULONG64 VectorControl;
  ULONG64 DebugControl;
  ULONG64 LastBranchToRip;
  ULONG64 LastBranchFromRip;
  ULONG64 LastExceptionToRip;
  ULONG64 LastExceptionFromRip;
} CONTEXT;

_Out_writes_bytes_()

_Out_writes_bytes_

(

MaximumResponseLength

)

DbgBreakPoint()

__analysis_noreturn VOID NTAPI DbgBreakPoint

(

VOID

)

Definition at line 553 of file mach.c.

                     {
    __asm__("twi 31,0,0");
}

Referenced by __cxa_pure_virtual(), __declspec(), ARPTransmit(), BaseInitializeContext(), CsrApiRequestThread(), CsrCallServerFromServer(), CsrCaptureArguments(), CsrIdentifyAlertableThread(), CsrReleaseCapturedArguments(), CsrSetPriorityClass(), CsrShutdownProcesses(), CsrValidateMessageBuffer(), DbgUiRemoteBreakin(), DeviceInterfaceChangeCallback(), Dispatch_fnDeviceIoControl(), DriverEntry(), EHCI_InterruptTransfer(), EHCI_QueryEndpointRequirements(), EHCI_SetAsyncEndpointState(), EHCI_SetEndpointStatus(), EHCI_SubmitTransfer(), EHCI_SuspendController(), ExAllocatePoolWithTag(), ExpInsertPoolTracker(), ExpRemovePoolTracker(), ExpWaitForResource(), FatalExit(), FatCompleteRequest_Real(), FatExceptionFilter(), FatMultiAsyncCompletionRoutine(), FatMultiSyncCompletionRoutine(), FatSingleAsyncCompletionRoutine(), FatSingleSyncCompletionRoutine(), FxLibraryCommonRegisterClient(), HalClearSoftwareInterrupt(), HalpAddDevice(), HalpGetParameters(), HalpOpcodeInvalid(), HalRequestSoftwareInterrupt(), HalReturnToFirmware(), IKsPin_PinStatePropertyHandler(), KeFlushIoBuffers(), KeStartThread(), KeUpdateRunTime(), KiCheckTimerTable(), KiIpiServiceRoutine(), KsPinAttemptProcessing(), KsStreamPointerAdvance(), KsStreamPointerAdvanceOffsets(), KsStreamPointerAdvanceOffsetsAndUnlock(), KsStreamPointerDelete(), KsStreamPointerGetNextClone(), LdrpInitializeProcess(), LdrpRunInitializeRoutines(), MiSubsectionConsistent(), Mx::MxDbgBreakPoint(), NdisInitializeWrapper(), NtProcessStartup(), ObInsertObject(), OHCI_InsertEndpointInSchedule(), OHCI_PollAsyncEndpoint(), OHCI_QueryEndpointRequirements(), OHCI_RemoveEndpointFromSchedule(), PciBeginStateTransition(), PciDispatchIrp(), PcRegisterSubdevice(), PinPropertyHandler(), PspCatchCriticalBreak(), Reboot(), RtlApplicationVerifierStop(), RtlAssert(), RtlInterlockedPushListSList(), RtlpDphAllocateVm(), RtlpDphEnterCriticalSection(), RtlpDphFreeVm(), RtlpDphPointerFromHandle(), RtlpDphProtectVm(), RtlpDphRemoveFromAvailableList(), RtlpPageHeapAllocate(), RtlpPageHeapDestroy(), RtlpPageHeapFree(), RxAssert(), SetLastError(), SmpAllocateSessionId(), SmpUnhandledExceptionFilter(), SpiParseDeviceInfo(), StreamClassDebugAssert(), UhciInterruptService(), UhciQueryEndpointRequirements(), UhciRHPortResetComplete(), UhciStopController(), USBH_ChangeIndicationWorker(), USBH_CompletePortWakeIrpsWorker(), USBH_DeviceControl(), USBH_FdoIdleNotificationCallback(), USBH_FdoPower(), USBH_FdoQueryBusRelations(), USBH_FdoStartDevice(), USBH_FdoStopDevice(), USBH_FdoWWIrpIoCompletion(), USBH_FlushPortPwrList(), USBH_HubCompleteQueuedPortIdleIrps(), USBH_HubCompleteQueuedPortWakeIrps(), USBH_HubDispatch(), USBH_HubQueuePortIdleIrps(), USBH_HubQueuePortWakeIrps(), USBH_PdoDispatch(), USBH_PdoInternalControl(), USBH_PdoPnP(), USBH_PdoStopDevice(), USBH_PdoUrbFilter(), USBH_PowerIrpCompletion(), USBH_ProcessHubStateChange(), USBH_ProcessPortStateChange(), USBH_SelectConfigOrInterfaceComplete(), USBPORT_AllocateBandwidthUSB2(), USBPORT_Dispatch(), USBPORT_DmaEndpointWorker(), USBPORT_PdoDevicePowerState(), USBPORT_RestoreDevice(), USBPORT_RootHubClassCommand(), USBPORT_RootHubCreateDevice(), USBPORT_SplitBulkInterruptTransfer(), USBPORT_StopDevice(), UserLoadKbdDll(), _FX_DRIVER_GLOBALS::WaitForSignal(), WdfVerifierDbgBreakPoint(), WdmAudControlOpenMixer(), and wmain().

DbgBreakPointWithStatus()

__analysis_noreturn NTSYSAPI VOID NTAPI DbgBreakPointWithStatus

(

_In_ ULONG

Status

)

DbgPrintEx()

NTSYSAPI ULONG __cdecl DbgPrintEx	(	_In_ ULONG	ComponentId,
		_In_ ULONG	Level,
		_In_z_ _Printf_format_string_ PCSTR	Format,
			...
	)

DbgPrintReturnControlC()

NTSYSAPI ULONG __cdecl DbgPrintReturnControlC	(	_In_z_ _Printf_format_string_ PCCH	Format,
			...
	)

DbgQueryDebugFilterState()

NTSYSAPI NTSTATUS NTAPI DbgQueryDebugFilterState	(	_In_ ULONG	ComponentId,
		_In_ ULONG	Level
	)

Referenced by DisplayIPPacket().

DbgSetDebugFilterState()

NTSYSAPI NTSTATUS NTAPI DbgSetDebugFilterState	(	_In_ ULONG	ComponentId,
		_In_ ULONG	Level,
		_In_ BOOLEAN	State
	)

DbgSetDebugPrintCallback()

NTSYSAPI NTSTATUS NTAPI DbgSetDebugPrintCallback	(	_In_ PDEBUG_PRINT_CALLBACK	DebugPrintCallback,
		_In_ BOOLEAN	Enable
	)

KdChangeOption()

NTKERNELAPI NTSTATUS NTAPI KdChangeOption	(	_In_ KD_OPTION	Option,
		_In_opt_ ULONG	InBufferBytes,
		_In_ PVOID	InBuffer,
		_In_opt_ ULONG	OutBufferBytes,
		_Out_ PVOID	OutBuffer,
		_Out_opt_ PULONG	OutBufferNeeded
	)

KdDisableDebugger()

NTKERNELAPI NTSTATUS NTAPI KdDisableDebugger

(

VOID

)

Definition at line 2141 of file kdapi.c.

{
    /* Use the internal routine */
    return KdDisableDebuggerWithLock(TRUE);
}

Referenced by PcipGetFunctionLimits().

KdEnableDebugger()

NTKERNELAPI NTSTATUS NTAPI KdEnableDebugger

(

VOID

)

Definition at line 2130 of file kdapi.c.

{
    /* Use the internal routine */
    return KdEnableDebuggerWithLock(TRUE);
}

Referenced by KdpStub(), and PcipGetFunctionLimits().

KdRefreshDebuggerNotPresent()

NTKERNELAPI BOOLEAN NTAPI KdRefreshDebuggerNotPresent

(

VOID

)

Definition at line 2319 of file kdapi.c.

{
    BOOLEAN Enable, DebuggerNotPresent;

    /* Check if the debugger is completely disabled */
    if (KdPitchDebugger)
    {
        /* Don't try to refresh then, fail early */
        return TRUE;
    }

    /* Enter the debugger */
    Enable = KdEnterDebugger(NULL, NULL);

    /*
     * Attempt to send a string to the debugger
     * to refresh the connection state.
     */
    KdpDprintf("KDTARGET: Refreshing KD connection\n");

    /* Save the state while we are holding the lock */
    DebuggerNotPresent = KdDebuggerNotPresent;

    /* Exit the debugger and return the state */
    KdExitDebugger(Enable);
    return DebuggerNotPresent;
}

Referenced by _FX_DRIVER_GLOBALS::IsDebuggerAttached().

Variable Documentation

KdDebuggerEnabled

BOOLEAN* KdDebuggerEnabled

Definition at line 83 of file kddata.c.

Referenced by KdDisableDebuggerWithLock(), KdInitSystem(), KdPollBreakIn(), KdpPollBreakInWithPortLock(), KdpStub(), KeBugCheckWithTf(), KeEnterKernelDebugger(), KeUpdateRunTime(), KeUpdateSystemTime(), MmLoadSystemImage(), ObpCloseHandle(), PspCatchCriticalBreak(), and PspExitThread().

KdDebuggerNotPresent

BOOLEAN* KdDebuggerNotPresent

Definition at line 82 of file kddata.c.

Referenced by KdInitSystem(), KdpCommandString(), KdpPrint(), KdpSendWaitContinue(), KdpSymbol(), KdRefreshDebuggerNotPresent(), KeBugCheckWithTf(), MmLoadSystemImage(), and PspCatchCriticalBreak().

MaximumResponseLength

_In_ ULONG MaximumResponseLength

Definition at line 11 of file kdfuncs.h.

Referenced by DbgPrompt(), and KdpPrompt().