This graph shows which files directly or indirectly include this file:

Macros
#define	FxVerifierBugCheck(FxDriverGlobals, Error, ...)

Enumerations
enum	FxEnhancedVerifierBitFlags { FxEnhancedVerifierCallbackIrqlAndCRCheck = 0x00000001 , FxEnhancedVerifierForwardProgressFailAll = 0x00010000 , FxEnhancedVerifierForwardProgressFailRandom = 0x00020000 , FxEnhancedVerifierFunctionTableHookMask = 0x0000ffff , FxEnhancedVerifierForwardProgressMask = 0x000f0000 , FxEnhancedVerifierPerformanceAnalysisMask = 0x00f00000 }

Functions
__inline VOID	FxVerifierDbgBreakPoint (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

__inline VOID	FxVerifierBreakOnDeviceStateError (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

__inline BOOLEAN	IsFxVerifierFunctionTableHooking (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

DECLSPEC_NORETURN VOID	FxVerifierBugCheckWorker (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDF_BUGCHECK_CODES WdfBugCheckCode, __in_opt ULONG_PTR BugCheckParameter2=0, __in_opt ULONG_PTR BugCheckParameter3=0)

DECLSPEC_NORETURN VOID	FxVerifierNullBugCheck (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PVOID ReturnAddress)

__inline NTSTATUS	FxVerifierCheckIrqlLevel (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in KIRQL Irql)

__inline BOOLEAN	IsFxVerifierTestForwardProgressFailAll (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

__inline BOOLEAN	IsFxVerifierTestForwardProgressFailRandom (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

__inline BOOLEAN	IsFxVerifierTestForwardProgress (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

__inline BOOLEAN	IsFxPerformanceAnalysis (__in PFX_DRIVER_GLOBALS FxDriverGlobals)

Macro Definition Documentation

◆ FxVerifierBugCheck

#define FxVerifierBugCheck	(	FxDriverGlobals,
		Error,
		...
	)

Value:

    FX_VERIFY_WITH_NAME(DRIVER(BadAction, Error),                    \
                        TRAPMSG("WDF Violation: Please check"        \
                        "tracelog for a description of this error"), \
                        FxDriverGlobals->Public.DriverName)

Definition at line 58 of file fxverifier.h.

Enumeration Type Documentation

◆ FxEnhancedVerifierBitFlags

enum FxEnhancedVerifierBitFlags

Enumerator
FxEnhancedVerifierCallbackIrqlAndCRCheck
FxEnhancedVerifierForwardProgressFailAll
FxEnhancedVerifierForwardProgressFailRandom
FxEnhancedVerifierFunctionTableHookMask
FxEnhancedVerifierForwardProgressMask
FxEnhancedVerifierPerformanceAnalysisMask

Definition at line 34 of file fxverifier.h.

                                {
    //
    // low 2 bytes are used for function table Hooking
    //
    FxEnhancedVerifierCallbackIrqlAndCRCheck      = 0x00000001,
    //
    // Lower nibble of 3rd byte  for forward progress
    //
    FxEnhancedVerifierForwardProgressFailAll      = 0x00010000,
    FxEnhancedVerifierForwardProgressFailRandom   = 0x00020000,
 
    //
    // bit masks
    //
    FxEnhancedVerifierFunctionTableHookMask       = 0x0000ffff,
    FxEnhancedVerifierForwardProgressMask         = 0x000f0000,
 
    //
    // higher nibble of 3rd byte for performance analysis
    //
    FxEnhancedVerifierPerformanceAnalysisMask      = 0x00f00000,
};

Function Documentation

◆ FxVerifierBreakOnDeviceStateError()

__inline VOID FxVerifierBreakOnDeviceStateError ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 101 of file fxverifier.h.

{
#if FX_CORE_MODE == FX_CORE_KERNEL_MODE
        CHAR ext[] = "sys";
#else
        CHAR ext[] = "dll";
#endif
 
    Mx::MxDbgPrint("WDF detected potentially invalid device state in %s.%s. "
             "Dump the driver log (!wdflogdump %s.$s) for more information.\n",
             FxDriverGlobals->Public.DriverName, ext,
             FxDriverGlobals->Public.DriverName, ext);
 
    if (FxDriverGlobals->FxVerifierDbgBreakOnDeviceStateError) {
        Mx::MxDbgBreakPoint();
    } else {
        Mx::MxDbgPrint("Turn on framework verifier for %s.%s to automatically "
            "break into the debugger next time it happens.\n",
            FxDriverGlobals->Public.DriverName, ext);
    }
}

Referenced by FxPkgPnp::PowerPolSleeping().

◆ FxVerifierBugCheckWorker()

DECLSPEC_NORETURN VOID FxVerifierBugCheckWorker	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDF_BUGCHECK_CODES	WdfBugCheckCode,
		__in_opt ULONG_PTR	BugCheckParameter2 = `0`,
		__in_opt ULONG_PTR	BugCheckParameter3 = `0`
	)

Definition at line 44 of file fxverifierbugcheck.cpp.

{
    //
    // Indicate to the BugCheck callback filter which IFR to dump.
    //
    FxDriverGlobals->FxForceLogsInMiniDump = TRUE;
 
    Mx::MxBugCheckEx(WDF_VIOLATION,
                 WdfBugCheckCode,
                 BugCheckParameter2,
                 BugCheckParameter3,
                 (ULONG_PTR) FxDriverGlobals );
}

◆ FxVerifierCheckIrqlLevel()

__inline NTSTATUS FxVerifierCheckIrqlLevel	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in KIRQL	Irql
	)

Definition at line 158 of file fxverifier.h.

{
    //
    // Full treatment only if VerifierOn is set.
    //
    if (FxDriverGlobals->FxVerifierOn) {
 
        KIRQL currentIrql = Mx::MxGetCurrentIrql();
 
        if (currentIrql <= Irql) {
            return STATUS_SUCCESS;
        }
 
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Called at wrong IRQL; at level %d, should be "
                            "at level %d", currentIrql, Irql);
 
        FxVerifierDbgBreakPoint(FxDriverGlobals);
 
        return STATUS_INVALID_DEVICE_REQUEST;
    }
 
    //
    // If Verifier is turned off, always return success.
    //
    return STATUS_SUCCESS;
}

Referenced by __deref_out_range(), __drv_maxIRQL(), __drv_strictTypeMatch(), __drv_when(), __in_bcount_opt(), __in_ecount(), __in_xcount(), FxDevice::_OpenKey(), _Requires_lock_held_(), _Requires_lock_not_held_(), FxUsbPipe::_SendTransfer(), FxCommonBuffer::AllocateCommonBuffer(), FxDevice::DeleteObject(), FxIoTargetSendIo(), FxIoTargetSendIoctl(), FxDevice::FxValidateInterfacePropertyData(), if(), FxDeviceDescriptionEntry::IsDeviceRemoved(), FxChildList::NotifyDeviceRemove(), FxChildList::NotifyDeviceSurpriseRemove(), FxChildList::ProcessBusRelations(), FxDeviceDescriptionEntry::ProcessDeviceRemoved(), and StopIdleWorker().

◆ FxVerifierDbgBreakPoint()

__inline VOID FxVerifierDbgBreakPoint ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 74 of file fxverifier.h.

{
#if FX_CORE_MODE == FX_CORE_KERNEL_MODE
    CHAR ext[] = "sys";
#else
    CHAR ext[] = "dll";
#endif
 
    Mx::MxDbgPrint("WDF detected potentially invalid operation by %s.%s "
             "Dump the driver log (!wdflogdump %s.%s) for more information.\n",
             FxDriverGlobals->Public.DriverName, ext,
             FxDriverGlobals->Public.DriverName, ext
             );
 
    if (FxDriverGlobals->FxVerifierDbgBreakOnError) {
        Mx::MxDbgBreakPoint();
    } else {
        Mx::MxDbgPrint("Turn on framework verifier for %s.%s to automatically "
            "break into the debugger next time it happens.\n",
            FxDriverGlobals->Public.DriverName, ext);
    }
}

Referenced by FxVerifierCheckIrqlLevel().

◆ FxVerifierNullBugCheck()

DECLSPEC_NORETURN VOID FxVerifierNullBugCheck	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in PVOID	ReturnAddress
	)

Definition at line 77 of file fxverifierbugcheck.cpp.

{
 
    DoTraceLevelMessage( FxDriverGlobals, TRACE_LEVEL_FATAL, TRACINGERROR,
                         "NULL Required Parameter Passed to a DDI\n"
                         "FxDriverGlobals 0x%p",
                         FxDriverGlobals
                         );
 
    FxVerifierBugCheck(FxDriverGlobals,
                       WDF_REQUIRED_PARAMETER_IS_NULL,  // Bugcheck code.
                       0,                               // Parameter 2
                       (ULONG_PTR)ReturnAddress         // Parameter 3
                       );
}

◆ IsFxPerformanceAnalysis()

__inline BOOLEAN IsFxPerformanceAnalysis ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 250 of file fxverifier.h.

{
    if (FxDriverGlobals->FxEnhancedVerifierOptions &
            FxEnhancedVerifierPerformanceAnalysisMask) {
        return TRUE;
    }
    else {
        return FALSE;
    }
}

Referenced by FxLibraryCommonRegisterClient(), PerfEvtDeviceD0EntryStart(), PerfEvtDeviceD0ExitStart(), PerfEvtDevicePrepareHardwareStart(), PerfEvtDeviceReleaseHardwareStart(), PerfEvtIoStopStart(), PerfIoComplete(), PerfIoStart(), and PerformanceAnalysisPowerProcess().

◆ IsFxVerifierFunctionTableHooking()

__inline BOOLEAN IsFxVerifierFunctionTableHooking ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 127 of file fxverifier.h.

{
    if (FxDriverGlobals->FxEnhancedVerifierOptions &
            FxEnhancedVerifierFunctionTableHookMask) {
        return TRUE;
    }
    else {
        return FALSE;
    }
}

Referenced by FxLibraryCommonRegisterClient(), and FxLibraryCommonUnregisterClient().

◆ IsFxVerifierTestForwardProgress()

__inline BOOLEAN IsFxVerifierTestForwardProgress ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 235 of file fxverifier.h.

{
    if (FxDriverGlobals->FxEnhancedVerifierOptions &
            FxEnhancedVerifierForwardProgressMask) {
        return TRUE;
    }
    else {
        return FALSE;
    }
}

Referenced by FxPkgIo::DispatchStep2().

◆ IsFxVerifierTestForwardProgressFailAll()

__inline BOOLEAN IsFxVerifierTestForwardProgressFailAll ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 205 of file fxverifier.h.

{
    if (FxDriverGlobals->FxEnhancedVerifierOptions &
            FxEnhancedVerifierForwardProgressFailAll) {
        return TRUE;
    }
    else {
        return FALSE;
    }
}

Referenced by FxPkgIo::VerifierFreeRequestToTestForwardProgess().

◆ IsFxVerifierTestForwardProgressFailRandom()

__inline BOOLEAN IsFxVerifierTestForwardProgressFailRandom ( __in PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 220 of file fxverifier.h.

{
    if (FxDriverGlobals->FxEnhancedVerifierOptions &
            FxEnhancedVerifierForwardProgressFailRandom) {
        return TRUE;
    }
    else {
        return FALSE;
    }
}