fxtrace.h File Reference

Go to the source code of this file.

Macros
#define	WDF_FX_TRACE_WPPGUID   (544d4c9d,942c,46d5,bf50,df5cd9524a50)
#define	WDF_FRAMEWORKS_TRACE_FLAGS
#define	WPP_CONTROL_GUIDS    WDF_FRAMEWORKS_TRACE_FLAGS
#define	WPP_GLOBALS_LEVEL_FLAGS_LOGGER(globals, lvl, flags)   WPP_LEVEL_LOGGER(flags)
#define	WPP_GLOBALS_LEVEL_FLAGS_ENABLED(globals, lvl, flags)   (WPP_LEVEL_ENABLED(flags) && WPP_CONTROL(WPP_BIT_ ## flags).Level >= lvl)
#define	IFR_GLOBALS_LEVEL_FLAGS_FILTER(globals, lvl, flags)   (lvl < TRACE_LEVEL_VERBOSE || globals->FxVerboseOn)

Typedefs
typedef struct _WDF_DRIVER_CONFIG *	PWDF_DRIVER_CONFIG

Functions
_Must_inspect_result_ NTSTATUS	FxTraceInitialize (VOID)
VOID	TraceUninitialize (VOID)
VOID	FxIFRStart (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PCUNICODE_STRING RegistryPath, __in MdDriverObject DriverObject)
VOID	FxIFRStop (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

Macro Definition Documentation

IFR_GLOBALS_LEVEL_FLAGS_FILTER

#define IFR_GLOBALS_LEVEL_FLAGS_FILTER	(		globals,
			lvl,
			flags
	)		(lvl < TRACE_LEVEL_VERBOSE || globals->FxVerboseOn)

Definition at line 85 of file fxtrace.h.

WDF_FRAMEWORKS_TRACE_FLAGS

#define WDF_FRAMEWORKS_TRACE_FLAGS

Value:

    WPP_DEFINE_WDF_CONTROL_GUID(                    \
        KmdfTraceGuid,                              \
        WDF_FX_TRACE_WPPGUID,                       \
        WPP_DEFINE_BIT(TRACINGFULL)                 \
        WPP_DEFINE_BIT(TRACINGERROR)                \
        WPP_DEFINE_BIT(TRACINGDBGPRINT)             \
        WPP_DEFINE_BIT(TRACINGFRAMEWORKS)           \
        WPP_DEFINE_BIT(TRACINGAPI)                  \
        WPP_DEFINE_BIT(TRACINGAPIERROR)             \
        WPP_DEFINE_BIT(TRACINGRESOURCES)            \
        WPP_DEFINE_BIT(TRACINGLOCKING)              \
        WPP_DEFINE_BIT(TRACINGCONTEXT)              \
        WPP_DEFINE_BIT(TRACINGPOOL)                 \
        WPP_DEFINE_BIT(TRACINGHANDLE)               \
        WPP_DEFINE_BIT(TRACINGPNP)                  \
        WPP_DEFINE_BIT(TRACINGIO)                   \
        WPP_DEFINE_BIT(TRACINGIOTARGET)             \
        WPP_DEFINE_BIT(TRACINGDMA)                  \
        WPP_DEFINE_BIT(TRACINGREQUEST)              \
        WPP_DEFINE_BIT(TRACINGDRIVER)               \
        WPP_DEFINE_BIT(TRACINGDEVICE)               \
        WPP_DEFINE_BIT(TRACINGUSEROBJECT)           \
        WPP_DEFINE_BIT(TRACINGOBJECT)               \
        WPP_DEFINE_BIT(TRACINGPNPPOWERSTATES)       \
        )

Definition at line 42 of file fxtrace.h.

WDF_FX_TRACE_WPPGUID

#define WDF_FX_TRACE_WPPGUID   (544d4c9d,942c,46d5,bf50,df5cd9524a50)

Tracing Definitions:

Definition at line 37 of file fxtrace.h.

WPP_CONTROL_GUIDS

#define WPP_CONTROL_GUIDS    WDF_FRAMEWORKS_TRACE_FLAGS

Definition at line 69 of file fxtrace.h.

WPP_GLOBALS_LEVEL_FLAGS_ENABLED

#define WPP_GLOBALS_LEVEL_FLAGS_ENABLED	(		globals,
			lvl,
			flags
	)		(WPP_LEVEL_ENABLED(flags) && WPP_CONTROL(WPP_BIT_ ## flags).Level >= lvl)

Definition at line 83 of file fxtrace.h.

WPP_GLOBALS_LEVEL_FLAGS_LOGGER

#define WPP_GLOBALS_LEVEL_FLAGS_LOGGER	(		globals,
			lvl,
			flags
	)		WPP_LEVEL_LOGGER(flags)

Definition at line 82 of file fxtrace.h.

Typedef Documentation

PWDF_DRIVER_CONFIG

typedef struct _WDF_DRIVER_CONFIG* PWDF_DRIVER_CONFIG

Definition at line 30 of file fxtrace.h.

Function Documentation

FxIFRStart()

VOID FxIFRStart	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in PCUNICODE_STRING	RegistryPath,
		__in MdDriverObject	DriverObject
	)

Definition at line 220 of file tracing.cpp.

{
    PWDF_IFR_HEADER pHeader;
    ULONG size;
 
    UNREFERENCED_PARAMETER( DriverObject );
 
    WDFCASSERT(FxIFRRecordSignature == WDF_IFR_RECORD_SIGNATURE);
 
    //
    // Return early if IFR is disabled.
    //
    if (FxLibraryGlobals.IfrDisabled) {
        ASSERT(FxDriverGlobals->WdfLogHeader == NULL);
        return;
    }
 
    if (FxDriverGlobals == NULL || FxDriverGlobals->WdfLogHeader != NULL) {
        return;
    }
 
    size = FxIFRGetSize(FxDriverGlobals, RegistryPath);
 
    pHeader = (PWDF_IFR_HEADER) ExAllocatePoolWithTag(NonPagedPool,
                                                      size,
                                                      WDF_IFR_LOG_TAG );
    if (pHeader == NULL) {
        return;
    }
 
    RtlZeroMemory(pHeader, size);
 
    //
    // Initialize the header.
    // Base will be where the IFR records are placed.
    // WPP_ThisDir_CTLGUID_FrameworksTraceGuid
    //
    RtlCopyMemory(&pHeader->Guid, (PVOID) &WdfTraceGuid, sizeof(GUID));
 
    pHeader->Base = (PUCHAR) &pHeader[1];
    pHeader->Size = size - sizeof(WDF_IFR_HEADER);
 
    pHeader->Offset.u.s.Current  = 0;
    pHeader->Offset.u.s.Previous = 0;
    RtlStringCchCopyA(pHeader->DriverName, WDF_IFR_HEADER_NAME_LEN, FxDriverGlobals->Public.DriverName);
 
    FxDriverGlobals->WdfLogHeader = pHeader;
 
    DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_INFORMATION, TRACINGDRIVER,
                        "FxIFR logging started" );
 
    if (size > FxIFRMinLogSize) {
        DoTraceLevelMessage(
            FxDriverGlobals, TRACE_LEVEL_INFORMATION, TRACINGDRIVER,
            "FxIFR has been started with a size override:  size 0x%x bytes, "
            "# Pages %d.  An extended IFR size may not be written to a minidump!",
            size, size/PAGE_SIZE);
    }
}

FxIFRStop()

VOID FxIFRStop

(

__in PFX_DRIVER_GLOBALS

FxDriverGlobals

)

Definition at line 297 of file tracing.cpp.

{
    //
    // Return early if IFR is disabled.
    //
    if (FxLibraryGlobals.IfrDisabled) {
        ASSERT(FxDriverGlobals->WdfLogHeader == NULL);
        return;
    }
 
    if (FxDriverGlobals == NULL || FxDriverGlobals->WdfLogHeader == NULL) {
        return;
    }
 
    //
    // Free the Log buffer.
    //
    ExFreePoolWithTag( FxDriverGlobals->WdfLogHeader, WDF_IFR_LOG_TAG );
    FxDriverGlobals->WdfLogHeader = NULL;
}

FxTraceInitialize()

_Must_inspect_result_ NTSTATUS FxTraceInitialize

(

VOID

)

Definition at line 47 of file tracing.cpp.

{
    //
    // Initialize the tracing package: Vista or later
    //
    WPP_INIT_TRACING(NULL, NULL);
 
    return STATUS_SUCCESS;
}

Referenced by FxLibraryCommonCommission().

TraceUninitialize()

VOID TraceUninitialize

(

VOID

)

Definition at line 79 of file tracing.cpp.

{
    //
    // Vista and later
    //
    WPP_CLEANUP(NULL);
}

Referenced by FxLibraryCommonDecommission().