fxioqueueapi.cpp File Reference

#include "ioprivshared.hpp"
#include "fxpkgio.hpp"
#include "fxioqueue.hpp"

Include dependency graph for fxioqueueapi.cpp:

Go to the source code of this file.

Functions
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS NTAPI WDFEXPORT(WdfIoQueueCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Device, FX_TYPE_DEVICE,(PVOID *)&pDevice, &pFxDriverGlobals)
	FxPointerNotNull (pFxDriverGlobals, Config)
	if (!NT_SUCCESS(status))
	if (Config->Size !=sizeof(WDF_IO_QUEUE_CONFIG) &&Config->Size !=sizeof(WDF_IO_QUEUE_CONFIG_V1_9) &&Config->Size !=sizeof(WDF_IO_QUEUE_CONFIG_V1_7))
	if (!Config->DefaultQueue &&Queue==NULL)
	if (Config->DefaultQueue)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIO, "Created WDFQUEUE 0x%p", pQueue->GetObjectHandle())
	if (Queue !=NULL)
	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Queue, FX_TYPE_QUEUE,(PVOID *)&pQueue)
return pQueue	GetState (QueueCount, DriverCount)
	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Queue, FX_TYPE_QUEUE,(PVOID *) &pQueue)
	return (WDFDEVICE) pQueue -> GetDevice() ->GetHandle()
pQueue	QueueStart ()
__in WDFQUEUE	__drv_when (Context !=0, __in) __drv_when(Context
__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE	__drv_when (StopComplete !=0, __in) __drv_when(StopComplete
	__drv_maxIRQL (PASSIVE_LEVEL) VOID NTAPI WDFEXPORT(WdfIoQueueStopSynchronously)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Queue, FX_TYPE_QUEUE,(PVOID *)&pQueue, &pFxDriverGlobals)
	FxPointerNotNull (pQueue->GetDriverGlobals(), OutRequest)
	if (NT_SUCCESS(status))
	ASSERT (status !=STATUS_NOT_FOUND)
	FxPointerNotNull (pFxDriverGlobals, OutRequest)
	FxObjectHandleGetPtr (pFxDriverGlobals, FileObject, FX_TYPE_FILEOBJECT,(PVOID *)&pFO)
	FxObjectHandleGetPtr (pFxDriverGlobals, TagRequest, FX_TYPE_REQUEST,(PVOID *)&pTagRequest)
	if (TagRequest !=NULL)
	if (FileObject !=NULL)
	if ((Parameters !=NULL) &&(Parameters->Size< sizeof(WDF_REQUEST_PARAMETERS)))
	FxPointerNotNull (pFxDriverGlobals, ForwardProgressPolicy)
	if (pQueue->IsForwardProgressQueue())
	if (ForwardProgressPolicy->Size !=sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY))
	switch (ForwardProgressPolicy->ForwardProgressReservedPolicy)
	if (ForwardProgressPolicy->TotalForwardProgressRequests==0)

Variables
_Must_inspect_result_ __in WDFDEVICE	Device
_Must_inspect_result_ __in WDFDEVICE __in PWDF_IO_QUEUE_CONFIG	Config
_Must_inspect_result_ __in WDFDEVICE __in PWDF_IO_QUEUE_CONFIG __in_opt PWDF_OBJECT_ATTRIBUTES	QueueAttributes
_Must_inspect_result_ __in WDFDEVICE __in PWDF_IO_QUEUE_CONFIG __in_opt PWDF_OBJECT_ATTRIBUTES __out_opt WDFQUEUE *	Queue
PFX_DRIVER_GLOBALS	pFxDriverGlobals
CfxDevice *	pDevice
FxPkgIo *	pPkgIo = NULL
FxIoQueue *	pQueue = NULL
NTSTATUS	status
return	STATUS_SUCCESS
__in WDFQUEUE __out_opt PULONG	QueueCount
__in WDFQUEUE __out_opt PULONG __out_opt PULONG	DriverCount
	return
__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE	StopComplete
__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE __in_opt WDFCONTEXT	Context
__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE	StopAndPurgeComplete
FxIoQueue *	queue
PFX_DRIVER_GLOBALS	fxDriverGlobals
_Must_inspect_result_ __in WDFQUEUE __out WDFREQUEST *	OutRequest
FxRequest *	pOutputRequest = NULL
	else
_Must_inspect_result_ __in WDFQUEUE __in WDFFILEOBJECT	FileObject
FxFileObject *	pFO = NULL
MdFileObject	pWdmFO = NULL
_Must_inspect_result_ __in WDFQUEUE __in WDFREQUEST	TagRequest
FxRequest *	pTagRequest = NULL
_Must_inspect_result_ __in WDFQUEUE __in_opt WDFREQUEST __in_opt WDFFILEOBJECT __inout_opt PWDF_REQUEST_PARAMETERS	Parameters
__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE	DrainComplete
__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE	PurgeComplete
_Must_inspect_result_ __in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE	QueueReady
_Must_inspect_result_ __in WDFQUEUE __in PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY	ForwardProgressPolicy

Function Documentation

__drv_maxIRQL() [1/2]

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_maxIRQL() [2/2]

__drv_maxIRQL

(

PASSIVE_LEVEL

)

__drv_when() [1/2]

__in WDFQUEUE __drv_when	(	Context !	= 0,
		__in
	)

__drv_when() [2/2]

__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE __drv_when	(	StopComplete !	= 0,
		__in
	)

ASSERT()

ASSERT

(

status !

= STATUS_NOT_FOUND

)

DoTraceLevelMessage()

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIO	,
		"Created WDFQUEUE 0x%p"	,
		pQueue->	GetObjectHandle()
	)

Referenced by if(), and switch().

FxObjectHandleGetPtr() [1/4]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Queue	,
		FX_TYPE_QUEUE	,
		(PVOID *) &	pQueue
	)

FxObjectHandleGetPtr() [2/4]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Queue	,
		FX_TYPE_QUEUE	,
		(PVOID *)&	pQueue
	)

Referenced by if().

FxObjectHandleGetPtr() [3/4]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		FileObject	,
		FX_TYPE_FILEOBJECT	,
		(PVOID *)&	pFO
	)

FxObjectHandleGetPtr() [4/4]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		TagRequest	,
		FX_TYPE_REQUEST	,
		(PVOID *)&	pTagRequest
	)

FxObjectHandleGetPtrAndGlobals() [1/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Device	,
		FX_TYPE_DEVICE	,
		(PVOID *)&	pDevice,
		&	pFxDriverGlobals
	)

FxObjectHandleGetPtrAndGlobals() [2/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Queue	,
		FX_TYPE_QUEUE	,
		(PVOID *)&	pQueue,
		&	pFxDriverGlobals
	)

FxPointerNotNull() [1/4]

FxPointerNotNull	(	pFxDriverGlobals	,
		Config
	)

FxPointerNotNull() [2/4]

FxPointerNotNull	(	pFxDriverGlobals	,
		ForwardProgressPolicy
	)

FxPointerNotNull() [3/4]

FxPointerNotNull	(	pFxDriverGlobals	,
		OutRequest
	)

FxPointerNotNull() [4/4]

FxPointerNotNull	(	pQueue->	GetDriverGlobals(),
		OutRequest
	)

GetState()

return pQueue GetState	(	QueueCount	,
		DriverCount
	)

if() [1/12]

if

(

!Config->DefaultQueue &&

Queue = = NULL

)

Definition at line 147 of file fxioqueueapi.cpp.

                                               {
        status = STATUS_INVALID_PARAMETER_4;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
            "Parameter to receive WDFQUEUE handle is not optional "
            "for non default queue %!STATUS!", status);
 
        return status;
    }

if() [2/12]

if

(

!

NT_SUCCESSstatus

)

Definition at line 124 of file fxioqueueapi.cpp.

                             {
        return status;
    }

if() [3/12]

if

(

(Parameters !=NULL) &&(Parameters->Size< sizeof(WDF_REQUEST_PARAMETERS))

)

Definition at line 1051 of file fxioqueueapi.cpp.

                                                                                     {
        status = STATUS_INVALID_PARAMETER_4;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "Invalid WDF_REQUEST_PARAMETERS size %d %!STATUS!",
                            Parameters->Size, status);
        return status;
    }

if() [4/12]

if

(

Config->

DefaultQueue

)

Definition at line 168 of file fxioqueueapi.cpp.

                             {
 
        if(pDevice->IsLegacy()) {
            //
            // This is a controldevice. Make sure the create is called after the device
            // is initialized and ready to accept I/O.
            //
        if((pDevice->GetDeviceObjectFlags() & DO_DEVICE_INITIALIZING) == FALSE) {
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
                    "Default queue can only be created before WdfControlDeviceFinishInitializing"
                    "on the WDFDEVICE %p is called %!STATUS!",
                    Device,
                    STATUS_INVALID_DEVICE_STATE);
                return STATUS_INVALID_DEVICE_STATE;
            }
 
        } else {
            //
            // This is either FDO or PDO. Make sure it's not started yet.
            //
        if (pDevice->GetDevicePnpState() != WdfDevStatePnpInit) {
                status = STATUS_INVALID_DEVICE_STATE;
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
                    "Default queue can only be created before the WDFDEVICE 0x%p "
                    "is started, %!STATUS!", Device, status);
                return status;
            }
        }
    }

if() [5/12]

if

(

Config->Size !

= sizeof(WDF_IO_QUEUE_CONFIG) && Config->Size != sizeof(WDF_IO_QUEUE_CONFIG_V1_9) && Config->Size != sizeof(WDF_IO_QUEUE_CONFIG_V1_7)

)

Definition at line 129 of file fxioqueueapi.cpp.

                                                          {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "WDF_IO_QUEUE_CONFIG Size 0x%x, "
                            "expected for v1.7 size 0x%x or v1.9 size 0x%x or "
                            "current version size 0x%x, %!STATUS!",
                            Config->Size, sizeof(WDF_IO_QUEUE_CONFIG_V1_7),
                            sizeof(WDF_IO_QUEUE_CONFIG_V1_9),
                            sizeof(WDF_IO_QUEUE_CONFIG), status);
        return status;
    }

if() [6/12]

if

(

FileObject !

= NULL

)

Definition at line 1037 of file fxioqueueapi.cpp.

                            {
        FxObjectHandleGetPtr(pFxDriverGlobals,
                             FileObject,
                             FX_TYPE_FILEOBJECT,
                             (PVOID*)&pFO);
        //
        // Get the real WDM fileobject
        //
        pWdmFO = pFO->GetWdmFileObject();
    }

if() [7/12]

if

(

ForwardProgressPolicy->Size !

= sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY)

)

Definition at line 1387 of file fxioqueueapi.cpp.

                                                                                     {
        status = STATUS_INFO_LENGTH_MISMATCH;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY Size 0x%x, "
                            "expected 0x%x, %!STATUS!",
                            ForwardProgressPolicy->Size, sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY), status);
        return status;
    }

if() [8/12]

if

(

ForwardProgressPolicy->

TotalForwardProgressRequests = = 0

)

Definition at line 1420 of file fxioqueueapi.cpp.

                                                                  {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "Need to have more than  0 reserved Requests %!STATUS!",
                            status);
 
        return status;
    }

if() [9/12]

if

(

NT_SUCCESS(status)

)

Definition at line 672 of file fxioqueueapi.cpp.

                            {
        *OutRequest = (WDFREQUEST)pOutputRequest->GetObjectHandle();
    } else {

if() [10/12]

if

(

pQueue->

IsForwardProgressQueue()

)

Definition at line 1372 of file fxioqueueapi.cpp.

                                          {
        //
        // Queue is already configured for forward progress
        //
        status =  STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "Queue is already configured for forward progress %!STATUS!",
                             status);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        return status;
    }

if() [11/12]

if

(

Queue !

= NULL

)

Definition at line 243 of file fxioqueueapi.cpp.

                      {
        *Queue = (WDFQUEUE)pQueue->GetObjectHandle();
    }

if() [12/12]

if

(

TagRequest !

= NULL

)

Definition at line 1026 of file fxioqueueapi.cpp.

                            {
        FxObjectHandleGetPtr(pFxDriverGlobals,
                             TagRequest,
                             FX_TYPE_REQUEST,
                             (PVOID*)&pTagRequest);
    }

QueueStart()

pQueue QueueStart

(

)

return()

return

(

WDFDEVICE

)

-> GetDevice() ->GetHandle()

switch()

switch

(

ForwardProgressPolicy->

ForwardProgressReservedPolicy

)

Definition at line 1399 of file fxioqueueapi.cpp.

                                                                  {
        case WdfIoForwardProgressReservedPolicyUseExamine:
            if (ForwardProgressPolicy->ForwardProgressReservePolicySettings.Policy.ExaminePolicy.EvtIoWdmIrpForForwardProgress == NULL) {
                status = STATUS_INVALID_PARAMETER;
                DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                                    "Examine callback can't be null for WdfIoForwardProgressReservedPolicyUseExamine "
                                    " %!STATUS!",
                                     status);
 
                return status;
            }
            break;
 
        default:
            break;
 
    }

Variable Documentation

Config

_Must_inspect_result_ __in WDFDEVICE __in PWDF_IO_QUEUE_CONFIG Config

Definition at line 59 of file fxioqueueapi.cpp.

Context

_Must_inspect_result_ __in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE __in_opt WDFCONTEXT Context

Initial value:

{
    DDI_ENTRY()

Definition at line 397 of file fxioqueueapi.cpp.

Device

_Must_inspect_result_ __in WDFDEVICE Device

Definition at line 57 of file fxioqueueapi.cpp.

DrainComplete

__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE DrainComplete

Definition at line 1087 of file fxioqueueapi.cpp.

DriverCount

__in WDFQUEUE __out_opt PULONG __out_opt PULONG DriverCount

Initial value:

{
    DDI_ENTRY()

Definition at line 262 of file fxioqueueapi.cpp.

Referenced by FxIoQueue::GetState().

else

else

Initial value:

{
        *OutRequest = NULL

Definition at line 674 of file fxioqueueapi.cpp.

FileObject

_Must_inspect_result_ __in WDFQUEUE __in_opt WDFREQUEST __in_opt WDFFILEOBJECT FileObject

Definition at line 692 of file fxioqueueapi.cpp.

ForwardProgressPolicy

_Must_inspect_result_ __in WDFQUEUE __in PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY ForwardProgressPolicy

Initial value:

{
    DDI_ENTRY()

Definition at line 1345 of file fxioqueueapi.cpp.

fxDriverGlobals

PFX_DRIVER_GLOBALS fxDriverGlobals

Definition at line 590 of file fxioqueueapi.cpp.

OutRequest

_Must_inspect_result_ __in WDFQUEUE __in_opt WDFREQUEST __in_opt WDFFILEOBJECT __inout_opt PWDF_REQUEST_PARAMETERS __out WDFREQUEST* OutRequest

Initial value:

{
    DDI_ENTRY()

Definition at line 623 of file fxioqueueapi.cpp.

Parameters

_Must_inspect_result_ __in WDFQUEUE __in_opt WDFREQUEST __in_opt WDFFILEOBJECT __inout_opt PWDF_REQUEST_PARAMETERS Parameters

Definition at line 889 of file fxioqueueapi.cpp.

pDevice

CfxDevice* pDevice

Definition at line 101 of file fxioqueueapi.cpp.

Referenced by if().

pFO

FxFileObject* pFO = NULL

Definition at line 741 of file fxioqueueapi.cpp.

Referenced by if().

pFxDriverGlobals

PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 100 of file fxioqueueapi.cpp.

Referenced by __drv_maxIRQL(), if(), and switch().

pOutputRequest

FxRequest * pOutputRequest = NULL

Definition at line 660 of file fxioqueueapi.cpp.

Referenced by if().

pPkgIo

pPkgIo = NULL

Definition at line 102 of file fxioqueueapi.cpp.

pQueue

FxIoQueue* pQueue = NULL

Definition at line 103 of file fxioqueueapi.cpp.

Referenced by __drv_maxIRQL(), and if().

pTagRequest

FxRequest * pTagRequest = NULL

Definition at line 845 of file fxioqueueapi.cpp.

Referenced by if().

PurgeComplete

__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE PurgeComplete

Definition at line 1234 of file fxioqueueapi.cpp.

pWdmFO

MdFileObject pWdmFO = NULL

Definition at line 742 of file fxioqueueapi.cpp.

Referenced by if().

Queue

_Must_inspect_result_ __in WDFQUEUE Queue

Initial value:

{
    DDI_ENTRY()

Definition at line 63 of file fxioqueueapi.cpp.

queue

FxIoQueue* queue

Definition at line 539 of file fxioqueueapi.cpp.

QueueAttributes

_Must_inspect_result_ __in WDFDEVICE __in PWDF_IO_QUEUE_CONFIG __in_opt PWDF_OBJECT_ATTRIBUTES QueueAttributes

Definition at line 61 of file fxioqueueapi.cpp.

QueueCount

__in WDFQUEUE __out_opt PULONG QueueCount

Definition at line 260 of file fxioqueueapi.cpp.

QueueReady

_Must_inspect_result_ __in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE QueueReady

Definition at line 1296 of file fxioqueueapi.cpp.

return

return

Definition at line 381 of file fxioqueueapi.cpp.

status

return status

Initial value:

= FxValidateObjectAttributes(pFxDriverGlobals,
                                        QueueAttributes,
                                        (FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED |
                                         FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED))

Definition at line 104 of file fxioqueueapi.cpp.

Referenced by __drv_maxIRQL(), if(), and switch().

STATUS_SUCCESS

return STATUS_SUCCESS

Definition at line 247 of file fxioqueueapi.cpp.

StopAndPurgeComplete

__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE StopAndPurgeComplete

Definition at line 503 of file fxioqueueapi.cpp.

StopComplete

__in WDFQUEUE __in_opt PFN_WDF_IO_QUEUE_STATE StopComplete

Definition at line 394 of file fxioqueueapi.cpp.

TagRequest

_Must_inspect_result_ __in WDFQUEUE __in_opt WDFREQUEST TagRequest

Definition at line 786 of file fxioqueueapi.cpp.

Referenced by if().