vfprivkm.hpp File Reference

#include <ntddk.h>
#include "fx.hpp"

Include dependency graph for vfprivkm.hpp:

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

Go to the source code of this file.

Functions
__inline VOID	VerifyIrqlEntry (__out KIRQL *Irql)
__inline VOID	VerifyIrqlExit (__in PWDF_DRIVER_GLOBALS DriverGlobals, __in KIRQL PrevIrql)
__inline VOID	VerifyCriticalRegionEntry (__out BOOLEAN *CritRegion)
__inline VOID	VerifyCriticalRegionExit (__in PWDF_DRIVER_GLOBALS DriverGlobals, __in BOOLEAN OldCritRegion, __in PVOID Pfn)
FORCEINLINE VOID	PerformanceAnalysisIOProcess (__in PFX_DRIVER_GLOBALS pFxDriverGlobals, __in WDFREQUEST Handle, __out FxRequest **ppReq, __inout GUID *pActivityId)
FORCEINLINE BOOLEAN	PerfIoStart (__in WDFREQUEST Handle)
FORCEINLINE BOOLEAN	PerfIoComplete (__in WDFREQUEST Handle)
FORCEINLINE PFN_WDF_DRIVER_DEVICE_ADD	PerformanceGetDriverDeviceAdd (__in WDFOBJECT Handle)
__inline BOOLEAN	PerfEvtDeviceD0EntryStart (__in WDFDEVICE Handle, __inout GUID *pActivityId)
__inline VOID	PerfEvtDeviceD0EntryStop (__in WDFDEVICE Handle, __in GUID *pActivityId)
__inline BOOLEAN	PerfEvtDeviceD0ExitStart (__in WDFDEVICE Handle, __inout GUID *pActivityId)
__inline VOID	PerfEvtDeviceD0ExitStop (__in WDFDEVICE Handle, __in GUID *pActivityId)
__inline BOOLEAN	PerfEvtDevicePrepareHardwareStart (__in WDFDEVICE Handle, __inout GUID *pActivityId)
__inline VOID	PerfEvtDevicePrepareHardwareStop (__in WDFDEVICE Handle, __in GUID *pActivityId)
__inline BOOLEAN	PerfEvtDeviceReleaseHardwareStart (__in WDFDEVICE Handle, __inout GUID *pActivityId)
__inline VOID	PerfEvtDeviceReleaseHardwareStop (__in WDFDEVICE Handle, __in GUID *pActivityId)
__inline BOOLEAN	PerfEvtIoStopStart (__in WDFQUEUE Queue, __inout GUID *pActivityId)
__inline VOID	PerfEvtIoStopStop (__in WDFQUEUE Queue, __in GUID *pActivityId)

Function Documentation

PerfEvtDeviceD0EntryStart()

__inline BOOLEAN PerfEvtDeviceD0EntryStart	(	__in WDFDEVICE	Handle,
		__inout GUID *	pActivityId
	)

Definition at line 184 of file vfprivkm.hpp.

{
    WDFOBJECT_OFFSET offset = 0;
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status) {
        PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        EtwActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        EventWriteFX_POWER_D0_ENTRY_START(pActivityId, pDriverDeviceAdd, Handle);
    }
 
    return status;
}

Referenced by VfEvtDeviceD0Entry().

PerfEvtDeviceD0EntryStop()

__inline VOID PerfEvtDeviceD0EntryStop	(	__in WDFDEVICE	Handle,
		__in GUID *	pActivityId
	)

Definition at line 205 of file vfprivkm.hpp.

{
    EventWriteFX_POWER_D0_ENTRY_STOP(pActivityId, PerformanceGetDriverDeviceAdd(Handle), Handle);
}

Referenced by VfEvtDeviceD0Entry().

PerfEvtDeviceD0ExitStart()

__inline BOOLEAN PerfEvtDeviceD0ExitStart	(	__in WDFDEVICE	Handle,
		__inout GUID *	pActivityId
	)

Definition at line 215 of file vfprivkm.hpp.

{
    WDFOBJECT_OFFSET offset = 0;
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status) {
        PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        EtwActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        EventWriteFX_POWER_D0_EXIT_START(pActivityId, pDriverDeviceAdd, Handle);
    }
    return status;
}

Referenced by VfEvtDeviceD0Exit().

PerfEvtDeviceD0ExitStop()

__inline VOID PerfEvtDeviceD0ExitStop	(	__in WDFDEVICE	Handle,
		__in GUID *	pActivityId
	)

Definition at line 235 of file vfprivkm.hpp.

{
    EventWriteFX_POWER_D0_EXIT_STOP(pActivityId, PerformanceGetDriverDeviceAdd(Handle), Handle);
}

Referenced by VfEvtDeviceD0Exit().

PerfEvtDevicePrepareHardwareStart()

__inline BOOLEAN PerfEvtDevicePrepareHardwareStart	(	__in WDFDEVICE	Handle,
		__inout GUID *	pActivityId
	)

Definition at line 245 of file vfprivkm.hpp.

{
 
    WDFOBJECT_OFFSET offset = 0;
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status) {
        PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        EtwActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        EventWriteFX_POWER_HW_PREPARE_START(pActivityId, pDriverDeviceAdd, Handle);
    }
    return status;
}

Referenced by VfEvtDevicePrepareHardware().

PerfEvtDevicePrepareHardwareStop()

__inline VOID PerfEvtDevicePrepareHardwareStop	(	__in WDFDEVICE	Handle,
		__in GUID *	pActivityId
	)

Definition at line 266 of file vfprivkm.hpp.

{
    EventWriteFX_POWER_HW_PREPARE_STOP(pActivityId, PerformanceGetDriverDeviceAdd(Handle), Handle);
}

Referenced by VfEvtDevicePrepareHardware().

PerfEvtDeviceReleaseHardwareStart()

__inline BOOLEAN PerfEvtDeviceReleaseHardwareStart	(	__in WDFDEVICE	Handle,
		__inout GUID *	pActivityId
	)

Definition at line 276 of file vfprivkm.hpp.

{
    WDFOBJECT_OFFSET offset = 0;
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status) {
        PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        EtwActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        EventWriteFX_POWER_HW_RELEASE_START(pActivityId, pDriverDeviceAdd, Handle);
    }
    return status;
}

Referenced by VfEvtDeviceReleaseHardware().

PerfEvtDeviceReleaseHardwareStop()

__inline VOID PerfEvtDeviceReleaseHardwareStop	(	__in WDFDEVICE	Handle,
		__in GUID *	pActivityId
	)

Definition at line 296 of file vfprivkm.hpp.

{
    EventWriteFX_POWER_HW_RELEASE_STOP(pActivityId, PerformanceGetDriverDeviceAdd(Handle), Handle);
}

Referenced by VfEvtDeviceReleaseHardware().

PerfEvtIoStopStart()

__inline BOOLEAN PerfEvtIoStopStart	(	__in WDFQUEUE	Queue,
		__inout GUID *	pActivityId
	)

Definition at line 307 of file vfprivkm.hpp.

{
    WDFOBJECT_OFFSET offset = 0;
    WDFDEVICE device;
    FxIoQueue* pQueue;
    PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd;
 
    FxObject *pObject = FxObject::_GetObjectFromHandle(Queue, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status) {
        FxObjectHandleGetPtr(pFxDriverGlobals,
                          Queue,
                          FX_TYPE_QUEUE,
                          (PVOID*) &pQueue);
        device = (WDFDEVICE) pQueue->GetDevice()->GetHandle();
        pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        EtwActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        EventWriteFX_EVTIOSTOP_START(pActivityId, pDriverDeviceAdd, device);
    }
    return status;
}

Referenced by VfEvtIoStop().

PerfEvtIoStopStop()

__inline VOID PerfEvtIoStopStop	(	__in WDFQUEUE	Queue,
		__in GUID *	pActivityId
	)

Definition at line 337 of file vfprivkm.hpp.

{
    WDFOBJECT_OFFSET offset = 0;
    WDFDEVICE device;
    FxIoQueue* pQueue;
    PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd;
 
    FxObject *pObject = FxObject::_GetObjectFromHandle(Queue, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    FxObjectHandleGetPtr(pFxDriverGlobals,
                      Queue,
                      FX_TYPE_QUEUE,
                      (PVOID*) &pQueue);
    device = (WDFDEVICE) pQueue->GetDevice()->GetHandle();
    pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
 
    EventWriteFX_EVTIOSTOP_STOP(pActivityId, pDriverDeviceAdd, device);
}

Referenced by VfEvtIoStop().

PerfIoComplete()

FORCEINLINE BOOLEAN PerfIoComplete

(

__in WDFREQUEST

Handle

)

Definition at line 145 of file vfprivkm.hpp.

{
    FxRequest* pReq;
    GUID activityId = { 0 };
    WDFOBJECT_OFFSET offset = 0;
 
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status)
    {
        PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        PerformanceAnalysisIOProcess(pFxDriverGlobals, Handle, &pReq,
                &activityId);
 
        EventWriteFX_REQUEST_COMPLETE(&activityId, pReq->GetFxIrp()->GetMajorFunction(),
                    pDriverDeviceAdd, pReq->GetCurrentQueue()->GetDevice()->GetHandle());
    }
    return status;
}

PerfIoStart()

FORCEINLINE BOOLEAN PerfIoStart

(

__in WDFREQUEST

Handle

)

Definition at line 119 of file vfprivkm.hpp.

{
    FxRequest* pReq;
    GUID activityId = { 0 };
    WDFOBJECT_OFFSET offset = 0;
 
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
    BOOLEAN status = IsFxPerformanceAnalysis(pFxDriverGlobals);
 
    if(status)
    {
        PFN_WDF_DRIVER_DEVICE_ADD pDriverDeviceAdd = pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
        PerformanceAnalysisIOProcess(pFxDriverGlobals, Handle, &pReq,
                &activityId);
 
        EventWriteFX_REQUEST_START(&activityId, pReq->GetFxIrp()->GetMajorFunction(),
                    pDriverDeviceAdd, pReq->GetCurrentQueue()->GetDevice()->GetHandle());
    }
    return status;
}

Referenced by if(), VfEvtIoDefault(), VfEvtIoDeviceControl(), VfEvtIoInternalDeviceControl(), VfEvtIoRead(), and VfEvtIoWrite().

PerformanceAnalysisIOProcess()

FORCEINLINE VOID PerformanceAnalysisIOProcess	(	__in PFX_DRIVER_GLOBALS	pFxDriverGlobals,
		__in WDFREQUEST	Handle,
		__out FxRequest **	ppReq,
		__inout GUID *	pActivityId
	)

Definition at line 97 of file vfprivkm.hpp.

{
 
    FxObjectHandleGetPtr(pFxDriverGlobals,
                         Handle,
                         FX_TYPE_REQUEST,
                         (PVOID *) ppReq);
 
    if (IoGetActivityIdIrp((*ppReq)->GetFxIrp()->GetIrp(), pActivityId) == STATUS_NOT_FOUND)
    {
        EtwActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        IoSetActivityIdIrp((*ppReq)->GetFxIrp()->GetIrp(), pActivityId);
    }
}

Referenced by PerfIoComplete(), and PerfIoStart().

PerformanceGetDriverDeviceAdd()

FORCEINLINE PFN_WDF_DRIVER_DEVICE_ADD PerformanceGetDriverDeviceAdd

(

__in WDFOBJECT

Handle

)

Definition at line 171 of file vfprivkm.hpp.

{
    WDFOBJECT_OFFSET offset = 0;
    FxObject *pObject = FxObject::_GetObjectFromHandle(Handle, &offset);
    PFX_DRIVER_GLOBALS pFxDriverGlobals = pObject->GetDriverGlobals();
 
    return pFxDriverGlobals->Driver->GetDriverDeviceAddMethod();
}

Referenced by PerfEvtDeviceD0EntryStop(), PerfEvtDeviceD0ExitStop(), PerfEvtDevicePrepareHardwareStop(), and PerfEvtDeviceReleaseHardwareStop().

VerifyCriticalRegionEntry()

__inline VOID VerifyCriticalRegionEntry

(

__out BOOLEAN *

CritRegion

)

Definition at line 65 of file vfprivkm.hpp.

{
    if (KeGetCurrentIrql() <= APC_LEVEL) {
        *CritRegion = KeAreApcsDisabled();
    }
}

Referenced by VfEvtDeviceD0Entry(), VfEvtDeviceD0EntryPostInterruptsEnabled(), VfEvtDeviceD0Exit(), VfEvtDeviceD0ExitPreInterruptsDisabled(), VfEvtDevicePrepareHardware(), VfEvtDeviceQueryRemove(), VfEvtDeviceQueryStop(), VfEvtDeviceRelationsQuery(), VfEvtDeviceReleaseHardware(), VfEvtDeviceSelfManagedIoCleanup(), VfEvtDeviceSelfManagedIoFlush(), VfEvtDeviceSelfManagedIoInit(), VfEvtDeviceSelfManagedIoRestart(), VfEvtDeviceSelfManagedIoSuspend(), VfEvtDeviceSurpriseRemoval(), VfEvtDeviceUsageNotification(), VfEvtDeviceUsageNotificationEx(), VfEvtIoCanceledOnQueue(), VfEvtIoDefault(), VfEvtIoDeviceControl(), VfEvtIoInternalDeviceControl(), VfEvtIoRead(), VfEvtIoResume(), VfEvtIoStop(), and VfEvtIoWrite().

VerifyCriticalRegionExit()

__inline VOID VerifyCriticalRegionExit	(	__in PWDF_DRIVER_GLOBALS	DriverGlobals,
		__in BOOLEAN	OldCritRegion,
		__in PVOID	Pfn
	)

Definition at line 76 of file vfprivkm.hpp.

{
    if (KeGetCurrentIrql() <= APC_LEVEL) {
        if (OldCritRegion != KeAreApcsDisabled()) {
            KdPrint(("WDF VERIFIER: Critical section entry and exit around event callback incorrect\n"));
            FxVerifierBugCheck(GetFxDriverGlobals(DriverGlobals),
                               WDF_VERIFIER_CRITICAL_REGION_MISMATCH,
                               (ULONG_PTR)Pfn,
                               0
                               );
        }
    }
}

Referenced by VfEvtDeviceD0Entry(), VfEvtDeviceD0EntryPostInterruptsEnabled(), VfEvtDeviceD0Exit(), VfEvtDeviceD0ExitPreInterruptsDisabled(), VfEvtDevicePrepareHardware(), VfEvtDeviceQueryRemove(), VfEvtDeviceQueryStop(), VfEvtDeviceRelationsQuery(), VfEvtDeviceReleaseHardware(), VfEvtDeviceSelfManagedIoCleanup(), VfEvtDeviceSelfManagedIoFlush(), VfEvtDeviceSelfManagedIoInit(), VfEvtDeviceSelfManagedIoRestart(), VfEvtDeviceSelfManagedIoSuspend(), VfEvtDeviceSurpriseRemoval(), VfEvtDeviceUsageNotification(), VfEvtDeviceUsageNotificationEx(), VfEvtIoCanceledOnQueue(), VfEvtIoDefault(), VfEvtIoDeviceControl(), VfEvtIoInternalDeviceControl(), VfEvtIoRead(), VfEvtIoResume(), VfEvtIoStop(), and VfEvtIoWrite().

VerifyIrqlEntry()

__inline VOID VerifyIrqlEntry

(

__out KIRQL *

Irql

)

Definition at line 36 of file vfprivkm.hpp.

{
    *Irql = KeGetCurrentIrql();
}

Referenced by VfEvtDeviceD0Entry(), VfEvtDeviceD0EntryPostInterruptsEnabled(), VfEvtDeviceD0Exit(), VfEvtDeviceD0ExitPreInterruptsDisabled(), VfEvtDevicePrepareHardware(), VfEvtDeviceQueryRemove(), VfEvtDeviceQueryStop(), VfEvtDeviceRelationsQuery(), VfEvtDeviceReleaseHardware(), VfEvtDeviceSelfManagedIoCleanup(), VfEvtDeviceSelfManagedIoFlush(), VfEvtDeviceSelfManagedIoInit(), VfEvtDeviceSelfManagedIoRestart(), VfEvtDeviceSelfManagedIoSuspend(), VfEvtDeviceSurpriseRemoval(), VfEvtDeviceUsageNotification(), VfEvtDeviceUsageNotificationEx(), VfEvtIoCanceledOnQueue(), VfEvtIoDefault(), VfEvtIoDeviceControl(), VfEvtIoInternalDeviceControl(), VfEvtIoRead(), VfEvtIoResume(), VfEvtIoStop(), and VfEvtIoWrite().

VerifyIrqlExit()

__inline VOID VerifyIrqlExit	(	__in PWDF_DRIVER_GLOBALS	DriverGlobals,
		__in KIRQL	PrevIrql
	)

Definition at line 45 of file vfprivkm.hpp.

{
    KIRQL currIrql;
 
    currIrql = KeGetCurrentIrql();
    if (PrevIrql != currIrql) {
        KdPrint(("WDF VERIFIER: Irql at entry of event is not same as at exit.\n"));
        FxVerifierBugCheck(GetFxDriverGlobals(DriverGlobals),
                           WDF_VERIFIER_IRQL_MISMATCH,
                           PrevIrql,
                           currIrql
                           );
    }
}

Referenced by VfEvtDeviceD0Entry(), VfEvtDeviceD0EntryPostInterruptsEnabled(), VfEvtDeviceD0Exit(), VfEvtDeviceD0ExitPreInterruptsDisabled(), VfEvtDevicePrepareHardware(), VfEvtDeviceQueryRemove(), VfEvtDeviceQueryStop(), VfEvtDeviceRelationsQuery(), VfEvtDeviceReleaseHardware(), VfEvtDeviceSelfManagedIoCleanup(), VfEvtDeviceSelfManagedIoFlush(), VfEvtDeviceSelfManagedIoInit(), VfEvtDeviceSelfManagedIoRestart(), VfEvtDeviceSelfManagedIoSuspend(), VfEvtDeviceSurpriseRemoval(), VfEvtDeviceUsageNotification(), VfEvtDeviceUsageNotificationEx(), VfEvtIoCanceledOnQueue(), VfEvtIoDefault(), VfEvtIoDeviceControl(), VfEvtIoInternalDeviceControl(), VfEvtIoRead(), VfEvtIoResume(), VfEvtIoStop(), and VfEvtIoWrite().