vfprivum.hpp File Reference

#include "fxmin.hpp"

Include dependency graph for vfprivum.hpp:

Go to the source code of this file.

Functions
FORCEINLINE VOID	PerformanceAnalysisIOProcess (__in PFX_DRIVER_GLOBALS pFxDriverGlobals, __in WDFREQUEST Handle, __inout FxRequest **ppReq, __inout GUID *pActivityId)
FORCEINLINE BOOLEAN	PerfIoStart (__in WDFREQUEST Handle)
FORCEINLINE BOOLEAN	PerfIoComplete (__in WDFREQUEST Handle)
__inline BOOLEAN	PerformanceAnalysisPowerProcess (__in PCEVENT_DESCRIPTOR EventDescriptor, __in GUID *pActivityId, __in WDFDEVICE 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)
__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)

Function Documentation

PerfEvtDeviceD0EntryStart()

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

Definition at line 156 of file vfprivum.hpp.

{
    EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
    return PerformanceAnalysisPowerProcess(&FX_POWER_D0_ENTRY_START, pActivityId, Handle);
}

PerfEvtDeviceD0EntryStop()

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

Definition at line 167 of file vfprivum.hpp.

{
    PerformanceAnalysisPowerProcess(&FX_POWER_D0_ENTRY_STOP, pActivityId, Handle);
}

PerfEvtDeviceD0ExitStart()

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

Definition at line 177 of file vfprivum.hpp.

{
    EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
    return PerformanceAnalysisPowerProcess(&FX_POWER_D0_EXIT_START, pActivityId, Handle);
}

PerfEvtDeviceD0ExitStop()

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

Definition at line 188 of file vfprivum.hpp.

{
    PerformanceAnalysisPowerProcess(&FX_POWER_D0_EXIT_STOP, pActivityId, Handle);
}

PerfEvtDevicePrepareHardwareStart()

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

Definition at line 198 of file vfprivum.hpp.

{
    EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
    return PerformanceAnalysisPowerProcess(&FX_POWER_HW_PREPARE_START, pActivityId, Handle);
}

PerfEvtDevicePrepareHardwareStop()

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

Definition at line 209 of file vfprivum.hpp.

{
    PerformanceAnalysisPowerProcess(&FX_POWER_HW_PREPARE_STOP, pActivityId, Handle);
}

PerfEvtDeviceReleaseHardwareStart()

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

Definition at line 219 of file vfprivum.hpp.

{
    EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
    return PerformanceAnalysisPowerProcess(&FX_POWER_HW_RELEASE_START, pActivityId, Handle);
}

PerfEvtDeviceReleaseHardwareStop()

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

Definition at line 230 of file vfprivum.hpp.

{
    PerformanceAnalysisPowerProcess(&FX_POWER_HW_RELEASE_STOP, pActivityId, Handle);
}

PerfEvtIoStopStart()

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

Definition at line 241 of file vfprivum.hpp.

{
    FxIoQueue* pQueue;
    WDFOBJECT_OFFSET offset = 0;
    WDFDEVICE device;
 
    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();
 
    EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
    return PerformanceAnalysisPowerProcess(&FX_EVTIOSTOP_START, pActivityId, device);
}

PerfEvtIoStopStop()

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

Definition at line 266 of file vfprivum.hpp.

{
    FxIoQueue* pQueue;
    WDFOBJECT_OFFSET offset = 0;
    WDFDEVICE device;
 
    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();
 
    PerformanceAnalysisPowerProcess(&FX_EVTIOSTOP_STOP, pActivityId, device);
}

PerfIoComplete()

FORCEINLINE BOOLEAN PerfIoComplete

(

__in WDFREQUEST

Handle

)

Definition at line 89 of file vfprivum.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);
 
        UCHAR Type = pReq->GetFxIrp()->GetMajorFunction();
        WDFDEVICE Device = pReq->GetCurrentQueue()->GetDevice()->GetHandle();
        EVENT_DATA_DESCRIPTOR EventData[3];
        EventDataDescCreate(&EventData[0], &Type, sizeof(const UCHAR));
        EventDataDescCreate(&EventData[1], &pDriverDeviceAdd, sizeof(PVOID));
        EventDataDescCreate(&EventData[2], &Device, sizeof(PVOID));
 
        EventWriteTransfer(Microsoft_Windows_DriverFrameworks_UserMode_PerformanceHandle,
                 &FX_REQUEST_COMPLETE,
                 &activityId,
                 NULL,
                 3,
                 &EventData[0]);
    }
    return status;
}

PerfIoStart()

FORCEINLINE BOOLEAN PerfIoStart

(

__in WDFREQUEST

Handle

)

Definition at line 53 of file vfprivum.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);
 
        UCHAR Type = pReq->GetFxIrp()->GetMajorFunction();
        WDFDEVICE Device = pReq->GetCurrentQueue()->GetDevice()->GetHandle();
        EVENT_DATA_DESCRIPTOR EventData[3];
        EventDataDescCreate(&EventData[0], &Type, sizeof(const UCHAR));
        EventDataDescCreate(&EventData[1], &pDriverDeviceAdd, sizeof(PVOID));
        EventDataDescCreate(&EventData[2], &Device, sizeof(PVOID));
 
        EventWriteTransfer(Microsoft_Windows_DriverFrameworks_UserMode_PerformanceHandle,
                 &FX_REQUEST_START,
                 &activityId,
                 NULL,
                 3,
                 &EventData[0]);
    }
    return status;
}

PerformanceAnalysisIOProcess()

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

Definition at line 30 of file vfprivum.hpp.

{
    FxObjectHandleGetPtr(pFxDriverGlobals,
                         Handle,
                         FX_TYPE_REQUEST,
                         (PVOID *) ppReq);
 
    if ((*ppReq)->GetFxIrp()->GetIoIrp()->IsActivityIdSet() == FALSE) {
        EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, pActivityId);
        (*ppReq)->GetFxIrp()->GetIoIrp()->SetActivityId(pActivityId);
    }
    else {
        *pActivityId = *(*ppReq)->GetFxIrp()->GetIoIrp()->GetActivityId();
    }
}

Referenced by PerfIoComplete(), and PerfIoStart().

PerformanceAnalysisPowerProcess()

__inline BOOLEAN PerformanceAnalysisPowerProcess	(	__in PCEVENT_DESCRIPTOR	EventDescriptor,
		__in GUID *	pActivityId,
		__in WDFDEVICE	Handle
	)

Definition at line 125 of file vfprivum.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();
 
        EVENT_DATA_DESCRIPTOR EventData[2];
        EventDataDescCreate(&EventData[0], &pDriverDeviceAdd, sizeof(PVOID));
        EventDataDescCreate(&EventData[1], &Handle, sizeof(PVOID));
 
        EventWriteTransfer(Microsoft_Windows_DriverFrameworks_UserMode_PerformanceHandle,
                 EventDescriptor,
                 pActivityId,
                 NULL,
                 2,
                 &EventData[0]);
    }
 
    return status;
}

Referenced by PerfEvtDeviceD0EntryStart(), PerfEvtDeviceD0EntryStop(), PerfEvtDeviceD0ExitStart(), PerfEvtDeviceD0ExitStop(), PerfEvtDevicePrepareHardwareStart(), PerfEvtDevicePrepareHardwareStop(), PerfEvtDeviceReleaseHardwareStart(), PerfEvtDeviceReleaseHardwareStop(), PerfEvtIoStopStart(), and PerfEvtIoStopStop().

VerifyCriticalRegionEntry()

__inline VOID VerifyCriticalRegionEntry

(

__out BOOLEAN *

CritRegion

)

Definition at line 308 of file vfprivum.hpp.

{
    DO_NOTHING();
}

VerifyCriticalRegionExit()

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

Definition at line 317 of file vfprivum.hpp.

{
    DO_NOTHING();
}

VerifyIrqlEntry()

__inline VOID VerifyIrqlEntry

(

__out KIRQL *

Irql

)

Definition at line 289 of file vfprivum.hpp.

{
    DO_NOTHING();
}

VerifyIrqlExit()

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

Definition at line 298 of file vfprivum.hpp.

{
    DO_NOTHING();
}