fxdriverapi.cpp File Reference

#include "coreprivshared.hpp"
#include <ntverp.h>
#include "fxtelemetry.hpp"

Include dependency graph for fxdriverapi.cpp:

Go to the source code of this file.

Functions
	__drv_maxIRQL (PASSIVE_LEVEL) PWSTR NTAPI WDFEXPORT(WdfDriverGetRegistryPath)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Driver, FX_TYPE_DRIVER,(PVOID *)&pDriver, &pFxDriverGlobals)
	if (!NT_SUCCESS(status))
return pDriver	GetRegistryPathUnicodeString () -> Buffer
	FxPointerNotNull (pFxDriverGlobals, DriverObject)
	FxPointerNotNull (pFxDriverGlobals, RegistryPath)
	FxPointerNotNull (pFxDriverGlobals, DriverConfig)
	WDFCASSERT (sizeof(WDF_DRIVER_CONFIG_V1_0)==sizeof(WDF_DRIVER_CONFIG_V1_1))
	if (DriverConfig->Size !=sizeof(WDF_DRIVER_CONFIG) &&DriverConfig->Size !=sizeof(WDF_DRIVER_CONFIG_V1_1))
	if ((DriverConfig->DriverInitFlags &~validFlags) !=0)
	if (pFxDriverGlobals->Driver !=NULL||pFxDriverGlobals->Public.Driver !=NULL)
	if (Driver !=NULL)
	if (DriverConfig->Size==sizeof(WDF_DRIVER_CONFIG) &&DriverConfig->DriverPoolTag !=0x0 &&DriverConfig->DriverPoolTag !=' kdD')
	if (DriverConfig->DriverInitFlags &WdfDriverInitNoDispatchOverride)
else	if ((DriverConfig->DriverInitFlags &WdfDriverInitNonPnpDriver) &&DriverConfig->EvtDriverDeviceAdd !=NULL)
	FxInitialize (pFxDriverGlobals, DriverObject, RegistryPath, DriverConfig)
	if (pDriver !=NULL)
	if (NT_SUCCESS(status))
	UNREFERENCED_PARAMETER (DriverGlobals)
	UNREFERENCED_PARAMETER (DriverObject)
	UNREFERENCED_PARAMETER (EvtTraceCallback)
	UNREFERENCED_PARAMETER (ControlBlock)
	FxPointerNotNull (pFxDriverGlobals, String)
	FxObjectHandleGetPtr (pFxDriverGlobals, String, FX_TYPE_STRING,(PVOID *)&pString)
	FxPointerNotNull (pFxDriverGlobals, VersionAvailableParams)
	if (VersionAvailableParams->Size !=sizeof(WDF_DRIVER_VERSION_AVAILABLE_PARAMS))
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_INFORMATION, TRACINGDRIVER, "IsVersionAvailable, current WDF ver major %d, minor %d, caller asking " "about major %d, minor %d", major, minor, VersionAvailableParams->MajorVersion, VersionAvailableParams->MinorVersion)
	if (VersionAvailableParams->MajorVersion==major &&VersionAvailableParams->MinorVersion<=minor)

Variables
__in WDFDRIVER	Driver
PFX_DRIVER_GLOBALS	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)
NTSTATUS	status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL)
FxDriver *	pDriver
_Must_inspect_result_ __in MdDriverObject	DriverObject
_Must_inspect_result_ __in MdDriverObject __in PCUNICODE_STRING	RegistryPath
_Must_inspect_result_ __in MdDriverObject __in PCUNICODE_STRING __in_opt PWDF_OBJECT_ATTRIBUTES	DriverAttributes
_Must_inspect_result_ __in MdDriverObject __in PCUNICODE_STRING __in_opt PWDF_OBJECT_ATTRIBUTES __in PWDF_DRIVER_CONFIG	DriverConfig
WDFDRIVER	hDriver = NULL
const LONG	validFlags
	else
_Must_inspect_result_ __in PDRIVER_OBJECT __in PFN_WDF_TRACE_CALLBACK	EvtTraceCallback
_Must_inspect_result_ __in PDRIVER_OBJECT __in PFN_WDF_TRACE_CALLBACK __in PVOID	ControlBlock
return	STATUS_NOT_SUPPORTED
_Must_inspect_result_ __in WDFDRIVER __in WDFSTRING	String
FxString *	pString
const PWCHAR	pVersionStr
const PWCHAR	pVersionStrVerifier
_Must_inspect_result_ __in WDFDRIVER __in PWDF_DRIVER_VERSION_AVAILABLE_PARAMS	VersionAvailableParams
ULONG	major = __WDF_MAJOR_VERSION
ULONG	minor = __WDF_MINOR_VERSION
return	FALSE

Function Documentation

__drv_maxIRQL()

__drv_maxIRQL

(

PASSIVE_LEVEL

)

DoTraceLevelMessage()

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_INFORMATION	,
		TRACINGDRIVER	,
		"	IsVersionAvailable,
		current WDF ver major %	d,
		minor %	d,
		caller asking " "about major %	d,
		minor %d"	,
		major	,
		minor	,
		VersionAvailableParams->	MajorVersion,
		VersionAvailableParams->	MinorVersion
	)

Referenced by if().

FxInitialize()

FxInitialize	(	pFxDriverGlobals	,
		DriverObject	,
		RegistryPath	,
		DriverConfig
	)

FxObjectHandleGetPtr()

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		String	,
		FX_TYPE_STRING	,
		(PVOID *)&	pString
	)

FxObjectHandleGetPtrAndGlobals()

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Driver	,
		FX_TYPE_DRIVER	,
		(PVOID *)&	pDriver,
		&	pFxDriverGlobals
	)

FxPointerNotNull() [1/5]

FxPointerNotNull	(	pFxDriverGlobals	,
		DriverConfig
	)

FxPointerNotNull() [2/5]

FxPointerNotNull	(	pFxDriverGlobals	,
		DriverObject
	)

FxPointerNotNull() [3/5]

FxPointerNotNull	(	pFxDriverGlobals	,
		RegistryPath
	)

FxPointerNotNull() [4/5]

FxPointerNotNull	(	pFxDriverGlobals	,
		String
	)

FxPointerNotNull() [5/5]

FxPointerNotNull	(	pFxDriverGlobals	,
		VersionAvailableParams
	)

GetRegistryPathUnicodeString()

return pDriver GetRegistryPathUnicodeString

(

)

-> Buffer

if() [1/12]

if

(

!

NT_SUCCESSstatus

)

Definition at line 68 of file fxdriverapi.cpp.

                             {
        return NULL;
    }

if() [2/12]

else if

(

(DriverConfig->DriverInitFlags &WdfDriverInitNonPnpDriver) &&DriverConfig->EvtDriverDeviceAdd !

= NULL

)

Definition at line 214 of file fxdriverapi.cpp.

                                                       {
 
         DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDRIVER,
                            "Invalid Driver flags or EvtDriverDeviceAdd callback already added"
                              "STATUS_INVALID_PARAMETER");
 
        return STATUS_INVALID_PARAMETER;
    }

if() [3/12]

if

(

(DriverConfig->DriverInitFlags &~validFlags) !

= 0

)

Definition at line 133 of file fxdriverapi.cpp.

                                                            {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDRIVER,
            "DriverInitFlags 0x%x invalid, valid flags are 0x%x, %!STATUS!",
            DriverConfig->DriverInitFlags, validFlags, status);
        return status;
    }

if() [4/12]

if

(

Driver !

= NULL

)

Definition at line 170 of file fxdriverapi.cpp.

                        {
        *Driver = NULL;
    }

if() [5/12]

if

(

DriverConfig->DriverInitFlags &

WdfDriverInitNoDispatchOverride

)

Definition at line 211 of file fxdriverapi.cpp.

                                                                         {
        DO_NOTHING();
    }

if() [6/12]

if

(

DriverConfig->Size !

= sizeof(WDF_DRIVER_CONFIG) && DriverConfig->Size != sizeof(WDF_DRIVER_CONFIG_V1_1)

)

Definition at line 116 of file fxdriverapi.cpp.

                                                              {
 
        status = STATUS_INFO_LENGTH_MISMATCH;
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDRIVER,
            "WDF_DRIVER_CONFIG got Size %d, expected v1.1 size %d or cur ver size %d, %!STATUS!",
            DriverConfig->Size,
            sizeof(WDF_DRIVER_CONFIG_V1_1), sizeof(WDF_DRIVER_CONFIG), status);
 
        return status;
    }

if() [7/12]

if

(

DriverConfig->

Size = = sizeof(WDF_DRIVER_CONFIG) && DriverConfig->DriverPoolTag != 0x0 && DriverConfig->DriverPoolTag != ' kdD'

)

Definition at line 190 of file fxdriverapi.cpp.

                                               {
        //
        // Copy directly using the driver's value
        //
        pFxDriverGlobals->Tag = DriverConfig->DriverPoolTag;
        pFxDriverGlobals->Public.DriverTag = DriverConfig->DriverPoolTag;
    }

if() [8/12]

if

(

NT_SUCCESS(status)

)

Definition at line 265 of file fxdriverapi.cpp.

                            {
        //
        // **** Note ****
        // Do not introduce failures after this point without ensuring
        // FxObject::DeleteFromFailedCreate has a chance to clear out any
        // assigned callbacks on the object.
        //
 
        //
        // Store the WDFDRIVER and FxDriver* globally so the driver can retrieve
        // it anytime.
        //
        pFxDriverGlobals->Driver = pDriver;
        pFxDriverGlobals->Public.Driver = hDriver;
 
        //
        // Record the flags so that diagnostics knows what type of driver it is.
        //
        pFxDriverGlobals->Public.DriverFlags |= DriverConfig->DriverInitFlags;
 
        if (DriverConfig->DriverInitFlags &
                (WdfDriverInitNoDispatchOverride | WdfDriverInitNonPnpDriver)) {
            //
            // If there is no dispatch override or if it is an NT4 legacy style
            // driver then we will not displace unload in the stub if one was not
            // specified.
            //
            if (DriverConfig->EvtDriverUnload != NULL) {
                pFxDriverGlobals->Public.DisplaceDriverUnload = TRUE;
            }
            else {
                pFxDriverGlobals->Public.DisplaceDriverUnload = FALSE;
            }
        }
        else {
            pFxDriverGlobals->Public.DisplaceDriverUnload = TRUE;
        }
 
        if (Driver != NULL) {
            *Driver = hDriver;
        }
 
#ifndef __REACTOS__
        if (FX_TELEMETRY_ENABLED(g_TelemetryProvider, pFxDriverGlobals)) {
            FxAutoString imageName;
 
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
        const PWCHAR pVersionStr =
            FX_MAKE_WSTR(__WDF_MAJOR_VERSION_STRING) L"."
            FX_MAKE_WSTR(__WDF_MINOR_VERSION_STRING) L"."
            FX_MAKE_WSTR(__WDF_BUILD_NUMBER) ;
#else // USER_MODE
        const PWCHAR pVersionStr =
            FX_MAKE_WSTR(__WUDF_MAJOR_VERSION_STRING) L"."
            FX_MAKE_WSTR(__WUDF_MINOR_VERSION_STRING) L"."
            FX_MAKE_WSTR(__WUDF_SERVICE_VERSION) ;
#endif
 
            //
            // GetImageName can fail if the registry cannot be accessed. This
            // can happen during system shutdown. Since the image name is only
            // used for telemetry the failure can be ignored.
            //
            (VOID) GetImageName(pFxDriverGlobals, &imageName.m_UnicodeString);
 
            WDF_CENSUS_EVT_WRITE_DRIVER_LOAD(g_TelemetryProvider,
                                    pFxDriverGlobals,
                                    imageName.m_UnicodeString.Buffer,
                                    pVersionStr);
        }
#endif // __REACTOS__
    }

if() [9/12]

if

(

pDriver !

= NULL

)

Definition at line 245 of file fxdriverapi.cpp.

                         {
 
        if (NT_SUCCESS(status)) {
 
            status = pDriver->Initialize(RegistryPath, DriverConfig, DriverAttributes);
 
            if (NT_SUCCESS(status)) {
                status = pDriver->Commit(DriverAttributes, (WDFOBJECT*)&hDriver, FALSE);
            }
        }
    }

if() [10/12]

if

(

pFxDriverGlobals->Driver !

= NULL || pFxDriverGlobals->Public.Driver != NULL

)

Definition at line 157 of file fxdriverapi.cpp.

                                                 {
 
        status = STATUS_DRIVER_INTERNAL_ERROR;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDRIVER,
                            "WdfDriverCreate can only be called one time per "
                            "WDM PDRIVER_OBJECT %p, %!STATUS!",
                            DriverObject, status);
 
        return status;
    }

if() [11/12]

if

(

VersionAvailableParams->

MajorVersion = = major && VersionAvailableParams->MinorVersion <= minor

)

Definition at line 521 of file fxdriverapi.cpp.

                                                       {
        return TRUE;
    }

if() [12/12]

if

(

VersionAvailableParams->Size !

= sizeof(WDF_DRIVER_VERSION_AVAILABLE_PARAMS)

)

Definition at line 493 of file fxdriverapi.cpp.

                                                                                     {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDRIVER,
            "VersionAvailableParams Size 0x%x, expected 0x%x, %!STATUS!",
            VersionAvailableParams->Size, sizeof(WDF_DRIVER_VERSION_AVAILABLE_PARAMS),
            status);
 
        return FALSE;
    }

UNREFERENCED_PARAMETER() [1/4]

UNREFERENCED_PARAMETER

(

ControlBlock

)

UNREFERENCED_PARAMETER() [2/4]

UNREFERENCED_PARAMETER

(

DriverGlobals

)

UNREFERENCED_PARAMETER() [3/4]

UNREFERENCED_PARAMETER

(

DriverObject

)

UNREFERENCED_PARAMETER() [4/4]

UNREFERENCED_PARAMETER

(

EvtTraceCallback

)

WDFCASSERT()

WDFCASSERT

(

sizeof(WDF_DRIVER_CONFIG_V1_0)

= =sizeof(WDF_DRIVER_CONFIG_V1_1)

)

Variable Documentation

ControlBlock

_Must_inspect_result_ __in PDRIVER_OBJECT __in PFN_WDF_TRACE_CALLBACK __in PVOID ControlBlock

Initial value:

{
    DDI_ENTRY()

Definition at line 360 of file fxdriverapi.cpp.

Driver

_Must_inspect_result_ __in WDFDRIVER Driver

Initial value:

{
    DDI_ENTRY()

Definition at line 52 of file fxdriverapi.cpp.

DriverAttributes

_Must_inspect_result_ __in MdDriverObject __in PCUNICODE_STRING __in_opt PWDF_OBJECT_ATTRIBUTES DriverAttributes

Definition at line 87 of file fxdriverapi.cpp.

DriverConfig

_Must_inspect_result_ __in MdDriverObject __in PCUNICODE_STRING __in_opt PWDF_OBJECT_ATTRIBUTES __in PWDF_DRIVER_CONFIG DriverConfig

Definition at line 89 of file fxdriverapi.cpp.

DriverObject

_Must_inspect_result_ __in PDRIVER_OBJECT DriverObject

Definition at line 83 of file fxdriverapi.cpp.

else

else

Initial value:

{
        
        
        
        FxDriver::_InitializeTag(pFxDriverGlobals, DriverConfig)

Definition at line 199 of file fxdriverapi.cpp.

EvtTraceCallback

_Must_inspect_result_ __in PDRIVER_OBJECT __in PFN_WDF_TRACE_CALLBACK EvtTraceCallback

Definition at line 358 of file fxdriverapi.cpp.

FALSE

return FALSE

Definition at line 526 of file fxdriverapi.cpp.

Referenced by if().

hDriver

hDriver = NULL

Definition at line 99 of file fxdriverapi.cpp.

Referenced by if().

major

major = __WDF_MAJOR_VERSION

Definition at line 466 of file fxdriverapi.cpp.

minor

minor = __WDF_MINOR_VERSION

Definition at line 466 of file fxdriverapi.cpp.

pDriver

FxDriver* pDriver

Initial value:

= new(pFxDriverGlobals, DriverAttributes)
        FxDriver(DriverObject, DriverConfig, pFxDriverGlobals)

Definition at line 59 of file fxdriverapi.cpp.

Referenced by if().

pFxDriverGlobals

PFX_DRIVER_GLOBALS pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

Definition at line 57 of file fxdriverapi.cpp.

Referenced by if().

pString

FxString* pString

Definition at line 390 of file fxdriverapi.cpp.

pVersionStr

const PWCHAR pVersionStr

Initial value:

=
        L"Kernel Mode Driver Framework version "
        FX_MAKE_WSTR(__WDF_MAJOR_VERSION_STRING) L"."
        FX_MAKE_WSTR(__WDF_MINOR_VERSION_STRING) L"."
        FX_MAKE_WSTR(__WDF_BUILD_NUMBER)

Definition at line 394 of file fxdriverapi.cpp.

Referenced by if().

pVersionStrVerifier

const PWCHAR pVersionStrVerifier

Initial value:

=
        L"Kernel Mode Driver Framework (verifier on) version "
        FX_MAKE_WSTR(__WDF_MAJOR_VERSION_STRING) L"."
        FX_MAKE_WSTR(__WDF_MINOR_VERSION_STRING) L"."
        FX_MAKE_WSTR(__WDF_BUILD_NUMBER)

Definition at line 400 of file fxdriverapi.cpp.

RegistryPath

_Must_inspect_result_ __in MdDriverObject __in PCUNICODE_STRING RegistryPath

Definition at line 85 of file fxdriverapi.cpp.

status

status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL)

Definition at line 58 of file fxdriverapi.cpp.

Referenced by if().

STATUS_NOT_SUPPORTED

return STATUS_NOT_SUPPORTED

Definition at line 370 of file fxdriverapi.cpp.

String

_Must_inspect_result_ __in WDFDRIVER __in WDFSTRING String

Initial value:

{
    DDI_ENTRY()

Definition at line 383 of file fxdriverapi.cpp.

validFlags

const LONG validFlags

Initial value:

= WdfDriverInitNonPnpDriver |
                            WdfDriverInitNoDispatchOverride

Definition at line 100 of file fxdriverapi.cpp.

Referenced by if().

VersionAvailableParams

_Must_inspect_result_ __in WDFDRIVER __in PWDF_DRIVER_VERSION_AVAILABLE_PARAMS VersionAvailableParams

Initial value:

{
    DDI_ENTRY()

Definition at line 458 of file fxdriverapi.cpp.