ParaNdis-Debug.c File Reference

#include "ndis56common.h"
#include "stdarg.h"
#include "ntstrsafe.h"

Include dependency graph for ParaNdis-Debug.c:

Go to the source code of this file.

Classes
struct	_tagBugCheckStaticData
struct	_tagBugCheckData

Macros
#define	MAX_CONTEXTS   4
#define	MAX_HISTORY   2

Typedefs
typedef BOOLEAN(NTAPI *	KeRegisterBugCheckReasonCallbackType) (__out PKBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord, __in PKBUGCHECK_REASON_CALLBACK_ROUTINE CallbackRoutine, __in KBUGCHECK_CALLBACK_REASON Reason, __in PUCHAR Component)
typedef BOOLEAN(NTAPI *	KeDeregisterBugCheckReasonCallbackType) (__inout PKBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord)
typedef ULONG(NTAPI *	vDbgPrintExType) (__in ULONG ComponentId, __in ULONG Level, __in PCCH Format, __in va_list arglist)
typedef struct _tagBugCheckStaticData	tBugCheckStaticData
typedef struct _tagBugCheckData	tBugCheckData

Functions
static VOID NTAPI	ParaNdis_OnBugCheck (IN KBUGCHECK_CALLBACK_REASON Reason, IN PKBUGCHECK_REASON_CALLBACK_RECORD Record, IN OUT PVOID ReasonSpecificData, IN ULONG ReasonSpecificDataLength)
static VOID	ParaNdis_PrepareBugCheckData ()
static ULONG NTAPI	DummyPrintProcedure (__in ULONG ComponentId, __in ULONG Level, __in PCCH Format, __in va_list arglist)
static BOOLEAN NTAPI	KeRegisterBugCheckReasonCallbackDummyProc (__out PKBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord, __in PKBUGCHECK_REASON_CALLBACK_ROUTINE CallbackRoutine, __in KBUGCHECK_CALLBACK_REASON Reason, __in PUCHAR Component)
BOOLEAN NTAPI	KeDeregisterBugCheckReasonCallbackDummyProc (__inout PKBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord)
void	_LogOutEntry (int level, const char *s)
	defined(WPP_EVENT_TRACING) || defined(WPP_USE_BYPASS)
void	_LogOutExitValue (int level, const char *s, ULONG value)
void	_LogOutString (int level, const char *s)
VOID	WppEnableCallback (__in LPCGUID Guid, __in __int64 Logger, __in BOOLEAN Enable, __in ULONG Flags, __in UCHAR Level)
void	ParaNdis_DebugInitialize (PVOID DriverObject, PVOID RegistryPath)
void	ParaNdis_DebugCleanup (PDRIVER_OBJECT pDriverObject)
void	ParaNdis_DebugRegisterMiniport (PARANDIS_ADAPTER *pContext, BOOLEAN bRegister)
static UINT	FillDataOnBugCheck ()

Variables
int	virtioDebugLevel = 1
int	nDebugLevel = 1
int	bDebugPrint = 1
static NDIS_SPIN_LOCK	CrashLock
static KBUGCHECK_REASON_CALLBACK_ROUTINE	ParaNdis_OnBugCheck
static vDbgPrintExType	PrintProcedure = DummyPrintProcedure
static KeRegisterBugCheckReasonCallbackType	BugCheckRegisterCallback = KeRegisterBugCheckReasonCallbackDummyProc
static KeDeregisterBugCheckReasonCallbackType	BugCheckDeregisterCallback = KeDeregisterBugCheckReasonCallbackDummyProc
KBUGCHECK_REASON_CALLBACK_RECORD	CallbackRecord
DEBUGPRINTFUNC	pDebugPrint = DbgPrint
DEBUGPRINTFUNC	VirtioDebugPrintProc = DbgPrint
static tBugCheckData	BugCheckData
static BOOLEAN	bNative = TRUE

Macro Definition Documentation

MAX_CONTEXTS

#define MAX_CONTEXTS   4

Definition at line 257 of file ParaNdis-Debug.c.

MAX_HISTORY

#define MAX_HISTORY   2

Definition at line 261 of file ParaNdis-Debug.c.

Typedef Documentation

KeDeregisterBugCheckReasonCallbackType

typedef BOOLEAN(NTAPI * KeDeregisterBugCheckReasonCallbackType) (__inout PKBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord)

Definition at line 61 of file ParaNdis-Debug.c.

KeRegisterBugCheckReasonCallbackType

typedef BOOLEAN(NTAPI * KeRegisterBugCheckReasonCallbackType) (__out PKBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord, __in PKBUGCHECK_REASON_CALLBACK_ROUTINE CallbackRoutine, __in KBUGCHECK_CALLBACK_REASON Reason, __in PUCHAR Component)

Definition at line 54 of file ParaNdis-Debug.c.

tBugCheckData

typedef struct _tagBugCheckData tBugCheckData

tBugCheckStaticData

typedef struct _tagBugCheckStaticData tBugCheckStaticData

vDbgPrintExType

typedef ULONG(NTAPI * vDbgPrintExType) (__in ULONG ComponentId, __in ULONG Level, __in PCCH Format, __in va_list arglist)

Definition at line 65 of file ParaNdis-Debug.c.

Function Documentation

_LogOutEntry()

void _LogOutEntry	(	int	level,
		const char *	s
	)

defined(WPP_EVENT_TRACING) || defined(WPP_USE_BYPASS)

Definition at line 157 of file ParaNdis-Debug.c.

{
    DPrintf(level, ("[%s]=>", s));
}

_LogOutExitValue()

void _LogOutExitValue	(	int	level,
		const char *	s,
		ULONG	value
	)

Definition at line 162 of file ParaNdis-Debug.c.

{
    DPrintf(level, ("[%s]<=0x%X", s, value));
}

_LogOutString()

void _LogOutString	(	int	level,
		const char *	s
	)

Definition at line 167 of file ParaNdis-Debug.c.

{
    DPrintf(level, ("[%s]", s));
}

Referenced by DriverEntry().

DummyPrintProcedure()

static ULONG NTAPI DummyPrintProcedure ( __in ULONG  ComponentId, __in ULONG  Level, __in PCCH  Format, __in va_list  arglist  )

static

Definition at line 72 of file ParaNdis-Debug.c.

{
    return 0;
}

FillDataOnBugCheck()

static UINT FillDataOnBugCheck ( )

static

Definition at line 313 of file ParaNdis-Debug.c.

{
    UINT i, n = 0;
    NdisGetCurrentSystemTime(&BugCheckData.StaticData.Header.qCrashTime);
    for (i = 0; i < MAX_CONTEXTS; ++i)
    {
        tBugCheckPerNicDataContent *pSave = &BugCheckData.StaticData.PerNicData[i];
        PARANDIS_ADAPTER *p = (PARANDIS_ADAPTER *)pSave->Context;
        if (!p) continue;
        pSave->nofPacketsToComplete = p->NetTxPacketsToReturn;
        pSave->nofReadyTxBuffers = p->nofFreeHardwareBuffers;
        pSave->LastInterruptTimeStamp.QuadPart = PARANDIS_GET_LAST_INTERRUPT_TIMESTAMP(p);
        pSave->LastTxCompletionTimeStamp = p->LastTxCompletionTimeStamp;
        ParaNdis_CallOnBugCheck(p);
        ++n;
    }
    return n;
}

Referenced by ParaNdis_OnBugCheck().

KeDeregisterBugCheckReasonCallbackDummyProc()

BOOLEAN NTAPI KeDeregisterBugCheckReasonCallbackDummyProc

(

__inout PKBUGCHECK_REASON_CALLBACK_RECORD

CallbackRecord

)

Definition at line 92 of file ParaNdis-Debug.c.

{
    return FALSE;
}

KeRegisterBugCheckReasonCallbackDummyProc()

static BOOLEAN NTAPI KeRegisterBugCheckReasonCallbackDummyProc ( __out PKBUGCHECK_REASON_CALLBACK_RECORD  CallbackRecord, __in PKBUGCHECK_REASON_CALLBACK_ROUTINE  CallbackRoutine, __in KBUGCHECK_CALLBACK_REASON  Reason, __in PUCHAR  Component  )

static

Definition at line 81 of file ParaNdis-Debug.c.

{
    CallbackRecord->State = 0;
    return FALSE;
}

ParaNdis_DebugCleanup()

void ParaNdis_DebugCleanup

(

PDRIVER_OBJECT

pDriverObject

)

Definition at line 243 of file ParaNdis-Debug.c.

{
#ifdef OVERRIDE_DEBUG_BREAK
    if (sizeof(PVOID) == sizeof(ULONG) && pDbgBreakPoint)
    {
        DPrintf(0, ("Restoring original BP handler at %p", pDbgBreakPoint));
        RtlCopyMemory(pDbgBreakPoint, DbgBreakPointChunk, sizeof(DbgBreakPointChunk));
    }
#endif
    BugCheckDeregisterCallback(&CallbackRecord);
    WPP_CLEANUP(pDriverObject);
}

Referenced by ParaVirtualNICUnload().

ParaNdis_DebugInitialize()

void ParaNdis_DebugInitialize	(	PVOID	DriverObject,
		PVOID	RegistryPath
	)

Definition at line 198 of file ParaNdis-Debug.c.

{
    NDIS_STRING usRegister, usDeregister, usPrint;
    PVOID pr, pd;
    BOOLEAN res;
    WPP_INIT_TRACING(DriverObject, RegistryPath);
 
    NdisAllocateSpinLock(&CrashLock);
    KeInitializeCallbackRecord(&CallbackRecord);
    ParaNdis_PrepareBugCheckData();
    NdisInitUnicodeString(&usPrint, L"vDbgPrintEx");
    NdisInitUnicodeString(&usRegister, L"KeRegisterBugCheckReasonCallback");
    NdisInitUnicodeString(&usDeregister, L"KeDeregisterBugCheckReasonCallback");
    pd = MmGetSystemRoutineAddress(&usPrint);
    if (pd) PrintProcedure = (vDbgPrintExType)pd;
    pr = MmGetSystemRoutineAddress(&usRegister);
    pd = MmGetSystemRoutineAddress(&usDeregister);
    if (pr && pd)
    {
        BugCheckRegisterCallback = (KeRegisterBugCheckReasonCallbackType)pr;
        BugCheckDeregisterCallback = (KeDeregisterBugCheckReasonCallbackType)pd;
    }
    res = BugCheckRegisterCallback(&CallbackRecord, ParaNdis_OnBugCheck, KbCallbackSecondaryDumpData, "NetKvm");
    DPrintf(0, ("[%s] Crash callback %sregistered", __FUNCTION__, res ? "" : "NOT "));
 
#ifdef OVERRIDE_DEBUG_BREAK
    if (sizeof(PVOID) == sizeof(ULONG))
    {
        UCHAR replace[5] = {0xe9,0,0,0,0};
        ULONG replacement;
        NDIS_STRING usDbgBreakPointName;
        NdisInitUnicodeString(&usDbgBreakPointName, L"DbgBreakPoint");
        pDbgBreakPoint = (PUCHAR)MmGetSystemRoutineAddress(&usDbgBreakPointName);
        if (pDbgBreakPoint)
        {
            DPrintf(0, ("Replacing original BP handler at %p", pDbgBreakPoint));
            replacement = RtlPointerToOffset(pDbgBreakPoint + 5, AnotherDbgBreak);
            RtlCopyMemory(replace + 1, &replacement, sizeof(replacement));
            RtlCopyMemory(DbgBreakPointChunk, pDbgBreakPoint, sizeof(DbgBreakPointChunk));
            RtlCopyMemory(pDbgBreakPoint, replace, sizeof(replace));
        }
    }
#endif
}

Referenced by DriverEntry().

ParaNdis_DebugRegisterMiniport()

void ParaNdis_DebugRegisterMiniport	(	PARANDIS_ADAPTER *	pContext,
		BOOLEAN	bRegister
	)

Definition at line 298 of file ParaNdis-Debug.c.

{
    UINT i;
    NdisAcquireSpinLock(&CrashLock);
    for (i = 0; i < MAX_CONTEXTS; ++i)
    {
        UINT64 val1 = bRegister ? 0 : (UINT_PTR)pContext;
        UINT64 val2 = bRegister ? (UINT_PTR)pContext : 0;
        if (BugCheckData.StaticData.PerNicData[i].Context != val1) continue;
        BugCheckData.StaticData.PerNicData[i].Context = val2;
        break;
    }
    NdisReleaseSpinLock(&CrashLock);
}

Referenced by ParaNdis5_Halt(), and ParaNdis5_Initialize().

ParaNdis_OnBugCheck()

static VOID NTAPI ParaNdis_OnBugCheck ( IN KBUGCHECK_CALLBACK_REASON  Reason, IN PKBUGCHECK_REASON_CALLBACK_RECORD  Record, IN OUT PVOID  ReasonSpecificData, IN ULONG  ReasonSpecificDataLength  )

static

Definition at line 332 of file ParaNdis-Debug.c.

{
    KBUGCHECK_SECONDARY_DUMP_DATA *pDump = (KBUGCHECK_SECONDARY_DUMP_DATA *)ReasonSpecificData;
    if (KbCallbackSecondaryDumpData == Reason && ReasonSpecificDataLength >= sizeof(*pDump))
    {
        ULONG dumpSize = sizeof(BugCheckData.Location);
        if (!pDump->OutBuffer)
        {
            UINT nSaved;
            nSaved = FillDataOnBugCheck();
            if (pDump->InBufferLength >= dumpSize)
            {
                pDump->OutBuffer = pDump->InBuffer;
                pDump->OutBufferLength = dumpSize;
            }
            else
            {
                pDump->OutBuffer = &BugCheckData.Location;
                pDump->OutBufferLength = dumpSize;
                bNative = FALSE;
            }
            DPrintf(0, ("[%s] system buffer of %d, saving data for %d NIC", __FUNCTION__,pDump->InBufferLength, nSaved));
            DPrintf(0, ("[%s] using %s buffer", __FUNCTION__, bNative ? "native" : "own"));
        }
        else if (pDump->OutBuffer == pDump->InBuffer)
        {
            RtlCopyMemory(&pDump->Guid, &ParaNdis_CrashGuid, sizeof(pDump->Guid));
            RtlCopyMemory(pDump->InBuffer, &BugCheckData.Location, dumpSize);
            pDump->OutBufferLength = dumpSize;
            DPrintf(0, ("[%s] written %d to %p", __FUNCTION__, (ULONG)BugCheckData.Location.Size, (UINT_PTR)BugCheckData.Location.Address ));
            DPrintf(0, ("[%s] dump data (%d) at %p", __FUNCTION__, pDump->OutBufferLength, pDump->OutBuffer));
        }
    }
}

ParaNdis_PrepareBugCheckData()

VOID ParaNdis_PrepareBugCheckData ( )

static

Definition at line 281 of file ParaNdis-Debug.c.

{
    BugCheckData.StaticData.Header.StaticDataVersion = PARANDIS_DEBUG_STATIC_DATA_VERSION;
    BugCheckData.StaticData.Header.PerNicDataVersion = PARANDIS_DEBUG_PER_NIC_DATA_VERSION;
    BugCheckData.StaticData.Header.ulMaxContexts = MAX_CONTEXTS;
    BugCheckData.StaticData.Header.SizeOfPointer = sizeof(PVOID);
    BugCheckData.StaticData.Header.PerNicData = (UINT_PTR)(PVOID)BugCheckData.StaticData.PerNicData;
    BugCheckData.StaticData.Header.DataArea = (UINT64)&BugCheckData.StaticData.Data;
    BugCheckData.StaticData.Header.DataAreaSize = sizeof(BugCheckData.StaticData.Data);
    BugCheckData.StaticData.Data.HistoryDataVersion = PARANDIS_DEBUG_HISTORY_DATA_VERSION;
    BugCheckData.StaticData.Data.SizeOfHistory = MAX_HISTORY;
    BugCheckData.StaticData.Data.SizeOfHistoryEntry = sizeof(tBugCheckHistoryDataEntry);
    BugCheckData.StaticData.Data.HistoryData = (UINT_PTR)(PVOID)BugCheckData.StaticData.History;
    BugCheckData.Location.Address = (UINT64)&BugCheckData;
    BugCheckData.Location.Size = sizeof(BugCheckData);
}

Referenced by ParaNdis_DebugInitialize().

WppEnableCallback()

VOID WppEnableCallback	(	__in LPCGUID	Guid,
		__in __int64	Logger,
		__in BOOLEAN	Enable,
		__in ULONG	Flags,
		__in UCHAR	Level
	)

Definition at line 172 of file ParaNdis-Debug.c.

{
#if WPP_USE_BYPASS
    DPrintfBypass(0, ("[%s] %s, flags %X, level %d",
        __FUNCTION__, Enable ? "enabled" : "disabled",
        Flags, (ULONG)Level));
#endif
    nDebugLevel = Level;
    bDebugPrint = Enable;
}

Variable Documentation

bDebugPrint

int bDebugPrint = 1

Definition at line 41 of file ParaNdis-Debug.c.

Referenced by ReadNicConfiguration(), and WppEnableCallback().

bNative

BOOLEAN bNative = TRUE

static

Definition at line 279 of file ParaNdis-Debug.c.

Referenced by ParaNdis_OnBugCheck().

BugCheckData

tBugCheckData BugCheckData

static

Definition at line 278 of file ParaNdis-Debug.c.

Referenced by AuxKlibGetBugCheckData(), FillDataOnBugCheck(), KiInitializeBugCheck(), ParaNdis_DebugRegisterMiniport(), ParaNdis_OnBugCheck(), and ParaNdis_PrepareBugCheckData().

BugCheckDeregisterCallback

KeDeregisterBugCheckReasonCallbackType BugCheckDeregisterCallback = KeDeregisterBugCheckReasonCallbackDummyProc

static

Definition at line 101 of file ParaNdis-Debug.c.

Referenced by ParaNdis_DebugCleanup(), and ParaNdis_DebugInitialize().

BugCheckRegisterCallback

KeRegisterBugCheckReasonCallbackType BugCheckRegisterCallback = KeRegisterBugCheckReasonCallbackDummyProc

static

Definition at line 100 of file ParaNdis-Debug.c.

Referenced by ParaNdis_DebugInitialize().

CallbackRecord

KBUGCHECK_REASON_CALLBACK_RECORD CallbackRecord

Definition at line 102 of file ParaNdis-Debug.c.

Referenced by KeDeregisterBugCheckCallback(), KeDeregisterBugCheckReasonCallback(), KeRegisterBugCheckCallback(), KeRegisterBugCheckReasonCallback(), KeRegisterBugCheckReasonCallbackDummyProc(), ParaNdis_DebugCleanup(), and ParaNdis_DebugInitialize().

CrashLock

NDIS_SPIN_LOCK CrashLock

static

Definition at line 43 of file ParaNdis-Debug.c.

Referenced by ParaNdis_DebugInitialize(), and ParaNdis_DebugRegisterMiniport().

nDebugLevel

int nDebugLevel = 1

Definition at line 40 of file ParaNdis-Debug.c.

Referenced by ReadNicConfiguration(), and WppEnableCallback().

ParaNdis_OnBugCheck

VOID NTAPI ParaNdis_OnBugCheck

static

Definition at line 45 of file ParaNdis-Debug.c.

Referenced by ParaNdis_DebugInitialize().

pDebugPrint

DEBUGPRINTFUNC pDebugPrint = DbgPrint

Definition at line 149 of file ParaNdis-Debug.c.

PrintProcedure

vDbgPrintExType PrintProcedure = DummyPrintProcedure

static

Definition at line 99 of file ParaNdis-Debug.c.

Referenced by ParaNdis_DebugInitialize().

virtioDebugLevel

int virtioDebugLevel = 1

Definition at line 39 of file ParaNdis-Debug.c.

VirtioDebugPrintProc

DEBUGPRINTFUNC VirtioDebugPrintProc = DbgPrint

Definition at line 150 of file ParaNdis-Debug.c.