Debug helper functions for kernel-mode drivers. More...

#include <wdm.h>
#include "cbm_driver.h"
#include "../../arch/windows/debug.c"

Data Structures
struct	NTSTATUS_DEBUGCODE

Macros
#define	min(_x, _y) ( ((_x) < (_y)) ? (_x) : (_y) )

#define	REPORT_BUG(_no, _a, _b, _c, _d, _str)
	@@@ More...

#define	DEFINE_STATUSCODE(_x) { #_x, _x }

#define	_MARKLASTENTRY ((NTSTATUS) -1)

#define	_LASTENTRY { "", _MARKLASTENTRY }

#define	USE_SPINLOCK 1
	use a spinlock for the debugging buffer implementation

#define	DBG_SIZE_MEMORY_BUFFER 0x20000u
	the size of the memory buffer used for the debugging buffer

Typedefs
typedef struct NTSTATUS_DEBUGCODE	NTSTATUS_DEBUGCODE

Functions
const UCHAR *	DebugNtStatus (NTSTATUS Value)
	Return the description of an NTSTATUS code. More...

VOID	DbgInit (VOID)
	Initialise debugging system. More...

VOID	DbgAllocateMemoryBuffer (VOID)
	Get storage area for debugging output. More...

VOID	DbgFreeMemoryBuffer (VOID)
	Free storage area for debugging output. More...

VOID	DbgOutputMemoryBuffer (const char *String)
	Output into the debugging buffer. More...

NTSTATUS	cbm_dbg_readbuffer (IN PDEVICE_EXTENSION Pdx, OUT PCHAR ReturnBuffer, IN OUT PULONG ReturnLength)
	Give the debug buffer contents to the installer. More...

Variables
const NTSTATUS_DEBUGCODE	text []

Detailed Description

Debug helper functions for kernel-mode drivers.

Author: Spiro Trikaliotis

Definition in file sys/libcommon/debug.c.

Macro Definition Documentation

#define _LASTENTRY { "", _MARKLASTENTRY }

this marks the last entry of the array

Definition at line 81 of file sys/libcommon/debug.c.

#define _MARKLASTENTRY ((NTSTATUS) -1)

This mark is used as value for the last entry of the array

Definition at line 78 of file sys/libcommon/debug.c.

Referenced by DebugNtStatus().

#define DEFINE_STATUSCODE ( _x ) { #_x, _x }

Define one NTSTATUS entry

Definition at line 75 of file sys/libcommon/debug.c.

#define min	(	_x,
		_y
	)	( ((_x) < (_y)) ? (_x) : (_y) )

Mark: This file is DEBUG.C, thus, some variables and functions should not be defined as "extern"

find the minimum of both parameters

Definition at line 31 of file sys/libcommon/debug.c.

Referenced by cbm_dbg_readbuffer().

#define REPORT_BUG	(	_no,
		_a,
		_b,
		_c,
		_d,
		_str
	)

Value:

DbgPrint("--- REPORT_BUG: %04x (%08x, %08x, %08x, %08x). '%s' " \
        "in %s, %s(), line %u\n", \
        _no, _a, _b, _c, _d, _str, \
        __FILE__, __FUNCTION__, __LINE__);

@@@

Todo:: document

Parameters

_no
_a
_b
_c
_d
_str

Returns

Definition at line 53 of file sys/libcommon/debug.c.

Referenced by DbgOutputMemoryBuffer().

Typedef Documentation

typedef struct NTSTATUS_DEBUGCODE NTSTATUS_DEBUGCODE

one descriptional entry for the NTSTATUS codes

Function Documentation

NTSTATUS cbm_dbg_readbuffer	(	IN PDEVICE_EXTENSION	Pdx,
		OUT PCHAR	ReturnBuffer,
		IN OUT PULONG	ReturnLength
	)

Give the debug buffer contents to the installer.

This function is used to get the contents of the debug buffer for the use of the installer.

Parameters

Pdx	Pointer to the device extension.
ReturnBuffer	Pointer to a buffer which will contain the result.
ReturnLength	Pointer to a ULONG which contains the length of the ReturnBuffer on entry, and which will contain the length of the written ReturnBuffer on exit.