fxrequestapi.cpp File Reference

#include "coreprivshared.hpp"

Include dependency graph for fxrequestapi.cpp:

Go to the source code of this file.

Macros
#define	WDF_REQUEST_REUSE_VALID_FLAGS_V1_9   (WDF_REQUEST_REUSE_SET_NEW_IRP)
#define	WDF_REQUEST_REUSE_VALID_FLAGS   (WDF_REQUEST_REUSE_SET_NEW_IRP | WDF_REQUEST_REUSE_MUST_COMPLETE)
#define	GLOBALS_ACTION(globals)   ((ULONG)(ULONG_PTR)(globals))
#define	PGLOBALS_ACTION(globals)   ((PULONG)(PULONG_PTR)(globals))
#define	GLOBALS_DEVICE(globals)   ((FxDevice*)(ULONG_PTR)(globals))
#define	PGLOBALS_DEVICE(globals)   ((FxDevice**)(PULONG_PTR)(globals))
#define	WDFREQUEST_FXREQUEST(handle)   ((FxRequest*)(handle))
#define	WDFIOTARGET_FXIOTARGET(handle)   ((FxIoTarget*)(handle))

Functions
	FX_DECLARE_VF_FUNCTION_P1 (NTSTATUS, VerifyRequestComplete, _In_ FxRequest *)
	FX_DECLARE_VF_FUNCTION_P1 (NTSTATUS, VerifyWdfRequestIsCanceled, _In_ FxRequest *)
	FX_DECLARE_VF_FUNCTION_P1 (NTSTATUS, VerifyWdfRequestForwardToIoQueue, _In_ FxRequest *)
	FX_DECLARE_VF_FUNCTION_P1 (NTSTATUS, VerifyWdfRequestForwardToParentDeviceIoQueue, _In_ FxRequest *)
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS STDCALL WDFEXPORT(WdfRequestCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	if (Target !=NULL)
	if (RequestAttributes !=NULL &&RequestAttributes->ParentObject !=NULL)
	FxPointerNotNull (pFxDriverGlobals, Request)
	if (NT_SUCCESS(status))
	FxPointerNotNull (pFxDriverGlobals, Irp)
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Request, FX_TYPE_REQUEST,(PVOID *)&pRequest, &pFxDriverGlobals)
	FxPointerNotNull (pFxDriverGlobals, ReuseParams)
	if (ReuseParams->Size !=sizeof(WDF_REQUEST_REUSE_PARAMS))
	if (pFxDriverGlobals->IsVersionGreaterThanOrEqualTo(1, 11))
	if (ReuseParams->Flags &~validFlags)
return pRequest	Reuse (ReuseParams)
	FxObjectHandleGetPtr (pFxDriverGlobals, IoTarget, FX_TYPE_IO_TARGET,(PVOID *)&pTarget)
return pRequest	ValidateTarget (pTarget)
_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION()	VerifyRequestComplete (_In_ PFX_DRIVER_GLOBALS FxDriverGlobals, _In_ FxRequest *pRequest)
	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Request, FX_TYPE_REQUEST,(PVOID *)&pRequest)
	if (!NT_SUCCESS(status))
pRequest	Complete (RequestStatus)
pRequest	CompleteWithPriority (RequestStatus, PriorityBoost)
pRequest	CompleteWithInformation (RequestStatus, Information)
pRequest	SetInformation (Information)
return pRequest	GetInformation ()
	FxPointerNotNull (pFxDriverGlobals, Memory)
	if (pRequest->GetFxIrp() ->GetMajorFunction()==IRP_MJ_READ)
	if (majorFunction==IRP_MJ_WRITE)
	if ((majorFunction==IRP_MJ_DEVICE_CONTROL)||(majorFunction==IRP_MJ_INTERNAL_DEVICE_CONTROL))
	FxPointerNotNull (pFxDriverGlobals, Buffer)
	if (Length !=NULL)
_Must_inspect_result_	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS WDFAPI STDCALL WDFEXPORT(WdfRequestRetrieveUnsafeUserInputBuffer)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxPointerNotNull (pFxDriverGlobals, InputBuffer)
	if (pFxDriverGlobals->FxVerifierOn)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST, "Error: This call is valid only on method-neither " "ioctl and write WDFREQUEST %p, %!STATUS!", Request, status)
	FxVerifierDbgBreakPoint (pFxDriverGlobals)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST, "Error: This call is valid only on method-neither ioctl and read " "WDFREQUEST 0x%p, %!STATUS!", Request, status)
	FxPointerNotNull (pFxDriverGlobals, Mdl)
void	CheckUnionAssumptions (VOID)
	if (!NT_SUCCESS(FxValidateRequestOptions(WDFREQUEST_FXREQUEST(Request) ->GetDriverGlobals(), Options, WDFREQUEST_FXREQUEST(Request))))
	FxObjectHandleGetPtr (WDFREQUEST_FXREQUEST(Request) ->GetDriverGlobals(), Target, FX_TYPE_IO_TARGET,(PVOID *) &Target)
	if (Options !=NULL &&(Options->Flags &(WDF_REQUEST_SEND_OPTION_SYNCHRONOUS|WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET)) !=0x0)
else	if (WDFREQUEST_FXREQUEST(Request) ->IsCompletionRoutineSet()==FALSE &&WDFREQUEST_FXREQUEST(Request) ->IsAllocatedFromIo())
	if (GLOBALS_ACTION(DriverGlobals) &SubmitSend)
return pRequest	GetStatus ()
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGREQUEST, "Enter: WDFREQUEST %p to be cancelled", Request)
_Must_inspect_result_	__drv_maxIRQL (APC_LEVEL) BOOLEAN STDCALL WDFEXPORT(WdfRequestIsFrom32BitProcess)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Request, FX_TYPE_REQUEST,(PVOID *) &pRequest, &pFxDriverGlobals)
	if (irp->GetIrp()==NULL)
	if (irp->HasStack(2)==FALSE)
irp	CopyCurrentIrpStackLocationToNext ()
pRequest	VerifierSetFormatted ()
	FxPointerNotNull (pFxDriverGlobals, Stack)
	if (pIrp==NULL)
	if (pIrp->GetCurrentIrpStackLocationIndex()< 2)
pIrp	CopyToNextIrpStackLocation (Stack)
pRequest	SetCompletionRoutine (CompletionRoutine, CompletionContext)
	FxPointerNotNull (pFxDriverGlobals, Parameters)
	if (Parameters->Size !=sizeof(WDF_REQUEST_PARAMETERS))
VOID pRequest	GetParameters (Parameters)
	FxPointerNotNull (pFxDriverGlobals, Params)
	if (Params->Size !=sizeof(WDF_REQUEST_COMPLETION_PARAMS))
pRequest	CopyCompletionParams (Params)
return pRequest	CreateTimer ()
	if (pRequest->GetDriverGlobals() ->IsVerificationEnabled(1, 9, OkForDownLevel))
else	if (NULL==pFO)
return pFO	GetHandle ()
_Must_inspect_result_ __in WDFREQUEST	__in_bcount (Length) PVOID Buffer
	FxPointerNotNull (pFxDriverGlobals, MemoryObject)
return pRequest	GetRequestorMode ()
	if (pRequest->GetCurrentQueue()==NULL)
	return (WDFQUEUE) pRequest -> GetCurrentQueue() ->GetObjectHandle()
_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION()	VerifyWdfRequestForwardToIoQueue (_In_ PFX_DRIVER_GLOBALS FxDriverGlobals, _In_ FxRequest *request)
	FxObjectHandleGetPtrAndGlobals (cxDriverGlobals, DestinationQueue, FX_TYPE_QUEUE,(PVOID *)&queue, &fxDriverGlobals)
	FxObjectHandleGetPtr (fxDriverGlobals, Request, FX_TYPE_REQUEST,(PVOID *)&request)
	if (request->GetCurrentQueue() !=NULL)
_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION()	VerifyWdfRequestForwardToParentDeviceIoQueue (_In_ PFX_DRIVER_GLOBALS fxDriverGlobals, _In_ FxRequest *request)
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), ParentDeviceQueue, FX_TYPE_QUEUE,(PVOID *)&queue, &fxDriverGlobals)
	FxPointerNotNull (fxDriverGlobals, ForwardOptions)
	if (ForwardOptions->Size !=sizeof(WDF_REQUEST_FORWARD_OPTIONS))
	if ((ForwardOptions->Flags &~WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET) !=0)
return pRequest	GetCurrentQueue () -> Requeue(pRequest)
	FxPointerNotNull (pFxDriverGlobals, EvtRequestCancel)
	UNREFERENCED_PARAMETER (status)
	ASSERT (status==STATUS_SUCCESS)
_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION()	VerifyWdfRequestIsCanceled (_In_ PFX_DRIVER_GLOBALS FxDriverGlobals, _In_ FxRequest *pRequest)
return pRequest	IsCancelled ()
pRequest	StopAcknowledge (Requeue)
return pRequest	IsReserved ()

Variables
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES	RequestAttributes
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in_opt WDFIOTARGET	Target
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in_opt WDFIOTARGET __out WDFREQUEST *	Request
FxRequest *	pRequest
FxIoTarget *	pTarget
NTSTATUS	status
	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)
	else
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in MdIrp	Irp
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in MdIrp __in BOOLEAN	RequestFreesIrp
__in WDFREQUEST __in PWDF_REQUEST_REUSE_PARAMS	ReuseParams
ULONG	validFlags
_Must_inspect_result_ __in WDFREQUEST __in WDFIOTARGET	IoTarget
__in WDFREQUEST __in NTSTATUS	RequestStatus
__in WDFREQUEST __in NTSTATUS __in CCHAR	PriorityBoost
__in WDFREQUEST __in NTSTATUS __in ULONG_PTR	Information
_Must_inspect_result_ __in WDFREQUEST __out WDFMEMORY *	Memory
IFxMemory *	pMemory = NULL
PVOID	pBuffer
size_t	length
UCHAR	majorFunction = pRequest->GetFxIrp()->GetMajorFunction()
_Must_inspect_result_ __in WDFREQUEST __in size_t	RequiredLength
_Must_inspect_result_ __in WDFREQUEST __in size_t __deref_out_bcount Length PVOID *	Buffer = NULL
_Must_inspect_result_ __in WDFREQUEST __in size_t __deref_out_bcount Length PVOID __out_opt size_t *	Length
_Must_inspect_result_ __in WDFREQUEST __in size_t __deref_out_bcount_opt Length PVOID *	InputBuffer = NULL
FxDevice *	pDevice = FxDevice::GetFxDevice(irp->GetDeviceObject())
FxIrp *	irp = pRequest->GetFxIrp()
_Must_inspect_result_ __in WDFREQUEST __in size_t __deref_out_bcount_opt Length PVOID *	OutputBuffer = NULL
_Must_inspect_result_ __in WDFREQUEST __deref_out PMDL *	Mdl
_Must_inspect_result_ __in WDFREQUEST __in WDFIOTARGET __in_opt PWDF_REQUEST_SEND_OPTIONS	Options
BOOLEAN	result = pRequest->Cancel()
pRequest	m_NextStackLocationFormatted = TRUE
__in WDFREQUEST __in PIO_STACK_LOCATION	Stack
FxIrp *	pIrp = pRequest->GetSubmitFxIrp()
__in WDFREQUEST __in_opt PFN_WDF_REQUEST_COMPLETION_ROUTINE	CompletionRoutine
__in WDFREQUEST __in_opt PFN_WDF_REQUEST_COMPLETION_ROUTINE __in_opt WDFCONTEXT	CompletionContext
	return
__in WDFREQUEST __out PWDF_REQUEST_PARAMETERS	Parameters
__in WDFREQUEST __out PWDF_REQUEST_COMPLETION_PARAMS	Params
FxFileObject *	pFO = NULL
_Must_inspect_result_ __in WDFREQUEST __in size_t __out WDFMEMORY *	MemoryObject
_Must_inspect_result_ __in WDFREQUEST __in WDFQUEUE	DestinationQueue
PFX_DRIVER_GLOBALS	cxDriverGlobals = GetFxDriverGlobals(DriverGlobals)
FxRequest *	request
FxIoQueue *	queue
Done	__pad2__
_Must_inspect_result_ __in WDFREQUEST __in WDFQUEUE	ParentDeviceQueue
_Must_inspect_result_ __in WDFREQUEST __in WDFQUEUE __in PWDF_REQUEST_FORWARD_OPTIONS	ForwardOptions
Done	__pad3__
__in WDFREQUEST __in PFN_WDF_REQUEST_CANCEL	EvtRequestCancel
__in WDFREQUEST __in BOOLEAN	Requeue

Macro Definition Documentation

GLOBALS_ACTION

#define GLOBALS_ACTION

(

globals

)

((ULONG)(ULONG_PTR)(globals))

Definition at line 1858 of file fxrequestapi.cpp.

GLOBALS_DEVICE

#define GLOBALS_DEVICE

(

globals

)

((FxDevice*)(ULONG_PTR)(globals))

Definition at line 1861 of file fxrequestapi.cpp.

PGLOBALS_ACTION

#define PGLOBALS_ACTION

(

globals

)

((PULONG)(PULONG_PTR)(globals))

Definition at line 1859 of file fxrequestapi.cpp.

PGLOBALS_DEVICE

#define PGLOBALS_DEVICE

(

globals

)

((FxDevice**)(PULONG_PTR)(globals))

Definition at line 1862 of file fxrequestapi.cpp.

WDF_REQUEST_REUSE_VALID_FLAGS

#define WDF_REQUEST_REUSE_VALID_FLAGS   (WDF_REQUEST_REUSE_SET_NEW_IRP | WDF_REQUEST_REUSE_MUST_COMPLETE)

Definition at line 249 of file fxrequestapi.cpp.

WDF_REQUEST_REUSE_VALID_FLAGS_V1_9

#define WDF_REQUEST_REUSE_VALID_FLAGS_V1_9   (WDF_REQUEST_REUSE_SET_NEW_IRP)

Definition at line 246 of file fxrequestapi.cpp.

WDFIOTARGET_FXIOTARGET

#define WDFIOTARGET_FXIOTARGET

(

handle

)

((FxIoTarget*)(handle))

Definition at line 1865 of file fxrequestapi.cpp.

WDFREQUEST_FXREQUEST

#define WDFREQUEST_FXREQUEST

(

handle

)

((FxRequest*)(handle))

Definition at line 1864 of file fxrequestapi.cpp.

Function Documentation

__drv_maxIRQL() [1/3]

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_maxIRQL() [2/3]

_Must_inspect_result_ __drv_maxIRQL

(

PASSIVE_LEVEL

)

__drv_maxIRQL() [3/3]

_Must_inspect_result_ __drv_maxIRQL

(

APC_LEVEL

)

__in_bcount()

_Must_inspect_result_ __in WDFREQUEST __in_bcount

(

Length

)

ASSERT()

ASSERT

(

status

= =STATUS_SUCCESS

)

Referenced by if(), and VerifyWdfRequestForwardToParentDeviceIoQueue().

CheckUnionAssumptions()

void CheckUnionAssumptions

(

VOID

)

Definition at line 1829 of file fxrequestapi.cpp.

{
    // ActionUnion check
    WDFCASSERT(sizeof(ULONG) <= sizeof(PWDF_DRIVER_GLOBALS));
    // RequestUnion check
    WDFCASSERT(sizeof(FxRequest*) <= sizeof(WDFREQUEST));
    // TargetUnion check
    WDFCASSERT(sizeof(FxIoTarget*) <= sizeof(WDFIOTARGET));
}

Complete()

pRequest Complete

(

RequestStatus

)

Referenced by BucketCompletionWorker(), CmBattOpenClose(), DECLARE_INTERFACE_(), DGReceiveDatagram(), InPortQueryWmiDataBlock(), InPortStartDevice(), MountMgrDeviceControl(), MupDereferenceMasterQueryContext(), MupForwardIoRequest(), RamdiskReadWrite(), TCPAccept(), TCPConnect(), TCPDisconnect(), TCPReceiveData(), TCPSendData(), and TiDispatchInternal().

CompleteWithInformation()

pRequest CompleteWithInformation	(	RequestStatus	,
		Information
	)

CompleteWithPriority()

pRequest CompleteWithPriority	(	RequestStatus	,
		PriorityBoost
	)

CopyCompletionParams()

pRequest CopyCompletionParams

(

Params

)

CopyCurrentIrpStackLocationToNext()

irp CopyCurrentIrpStackLocationToNext

(

)

CopyToNextIrpStackLocation()

pIrp CopyToNextIrpStackLocation

(

Stack

)

CreateTimer()

return pRequest CreateTimer

(

)

DoTraceLevelMessage() [1/3]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_ERROR	,
		TRACINGREQUEST	,
		"Error: This call is valid only on method-neither " "ioctl and write WDFREQUEST %	p,
		%!STATUS!"	,
		Request	,
		status
	)

Referenced by if(), VerifyWdfRequestForwardToIoQueue(), and VerifyWdfRequestForwardToParentDeviceIoQueue().

DoTraceLevelMessage() [2/3]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_ERROR	,
		TRACINGREQUEST	,
		"Error: This call is valid only on method-neither ioctl and read " "WDFREQUEST 0x%	p,
		%!STATUS!"	,
		Request	,
		status
	)

DoTraceLevelMessage() [3/3]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGREQUEST	,
		"Enter: WDFREQUEST %p to be cancelled"	,
		Request
	)

FX_DECLARE_VF_FUNCTION_P1() [1/4]

FX_DECLARE_VF_FUNCTION_P1	(	NTSTATUS	,
		VerifyRequestComplete	,
		_In_ FxRequest *
	)

FX_DECLARE_VF_FUNCTION_P1() [2/4]

FX_DECLARE_VF_FUNCTION_P1	(	NTSTATUS	,
		VerifyWdfRequestIsCanceled	,
		_In_ FxRequest *
	)

FX_DECLARE_VF_FUNCTION_P1() [3/4]

FX_DECLARE_VF_FUNCTION_P1	(	NTSTATUS	,
		VerifyWdfRequestForwardToIoQueue	,
		_In_ FxRequest *
	)

FX_DECLARE_VF_FUNCTION_P1() [4/4]

FX_DECLARE_VF_FUNCTION_P1	(	NTSTATUS	,
		VerifyWdfRequestForwardToParentDeviceIoQueue	,
		_In_ FxRequest *
	)

FxObjectHandleGetPtr() [1/4]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		IoTarget	,
		FX_TYPE_IO_TARGET	,
		(PVOID *)&	pTarget
	)

FxObjectHandleGetPtr() [2/4]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Request	,
		FX_TYPE_REQUEST	,
		(PVOID *)&	pRequest
	)

FxObjectHandleGetPtr() [3/4]

FxObjectHandleGetPtr	(	WDFREQUEST_FXREQUEST(Request) ->GetDriverGlobals()	,
		Target	,
		FX_TYPE_IO_TARGET	,
		(PVOID *) &	Target
	)

FxObjectHandleGetPtr() [4/4]

FxObjectHandleGetPtr	(	fxDriverGlobals	,
		Request	,
		FX_TYPE_REQUEST	,
		(PVOID *)&	request
	)

FxObjectHandleGetPtrAndGlobals() [1/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Request	,
		FX_TYPE_REQUEST	,
		(PVOID *)&	pRequest,
		&	pFxDriverGlobals
	)

Referenced by if().

FxObjectHandleGetPtrAndGlobals() [2/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Request	,
		FX_TYPE_REQUEST	,
		(PVOID *) &	pRequest,
		&	pFxDriverGlobals
	)

FxObjectHandleGetPtrAndGlobals() [3/4]

FxObjectHandleGetPtrAndGlobals	(	cxDriverGlobals	,
		DestinationQueue	,
		FX_TYPE_QUEUE	,
		(PVOID *)&	queue,
		&	fxDriverGlobals
	)

FxObjectHandleGetPtrAndGlobals() [4/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		ParentDeviceQueue	,
		FX_TYPE_QUEUE	,
		(PVOID *)&	queue,
		&	fxDriverGlobals
	)

FxPointerNotNull() [1/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Request
	)

FxPointerNotNull() [2/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Irp
	)

FxPointerNotNull() [3/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		ReuseParams
	)

FxPointerNotNull() [4/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Memory
	)

FxPointerNotNull() [5/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Buffer
	)

FxPointerNotNull() [6/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		InputBuffer
	)

FxPointerNotNull() [7/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Mdl
	)

FxPointerNotNull() [8/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Stack
	)

FxPointerNotNull() [9/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Parameters
	)

FxPointerNotNull() [10/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		Params
	)

FxPointerNotNull() [11/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		MemoryObject
	)

FxPointerNotNull() [12/13]

FxPointerNotNull	(	fxDriverGlobals	,
		ForwardOptions
	)

FxPointerNotNull() [13/13]

FxPointerNotNull	(	pFxDriverGlobals	,
		EvtRequestCancel
	)

FxVerifierDbgBreakPoint()

FxVerifierDbgBreakPoint

(

pFxDriverGlobals

)

Referenced by if(), VerifyWdfRequestForwardToIoQueue(), and VerifyWdfRequestForwardToParentDeviceIoQueue().

GetCurrentQueue()

return pRequest GetCurrentQueue

(

)

-> Requeue(pRequest)

GetHandle()

return pFO GetHandle

(

)

Referenced by if().

GetInformation()

return pRequest GetInformation

(

)

GetParameters()

VOID pRequest GetParameters

(

Parameters

)

Referenced by DECLARE_INTERFACE_().

GetRequestorMode()

return pRequest GetRequestorMode

(

)

GetStatus()

return pRequest GetStatus

(

)

Referenced by AtaCommand48(), AtapiCallBack(), AtapiCallBack__(), AtapiCheckInterrupt__(), AtapiDmaInit(), AtapiHwInitialize(), AtapiHwInitialize__(), AtapiInterrupt(), AtapiInterrupt__(), AtapiResetController(), AtapiResetController__(), AtapiSendCommand(), AtapiSuckPort2(), AtapiSuckPortBuffer2(), CheckDevice(), DECLARE_INTERFACE_(), FindDevices(), IssueIdentify(), SetDriveParameters(), UniataAnybodyHome(), WaitForDrq(), WaitForIdleLong(), WaitOnBusy(), WaitOnBusyLong(), and WaitShortForDrq().

if() [1/28]

if

(

Target !

= NULL

)

Definition at line 109 of file fxrequestapi.cpp.

                        {
        FxObjectHandleGetPtrAndGlobals(pFxDriverGlobals,
                                       Target,
                                       FX_TYPE_IO_TARGET,
                                       (PVOID*)&pTarget,
                                       &pFxDriverGlobals);
    }

if() [2/28]

if

(

RequestAttributes !

= NULL && RequestAttributes->ParentObject != NULL

)

Definition at line 122 of file fxrequestapi.cpp.

                                                     {

            FxObjectHandleGetGlobals(
                pFxDriverGlobals,
                RequestAttributes->ParentObject,
                &pFxDriverGlobals);
        }

if() [3/28]

if

(

NT_SUCCESS(status)

)

Definition at line 143 of file fxrequestapi.cpp.

                            {
        *Request = pRequest->GetHandle();

#if FX_VERBOSE_TRACE
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGREQUEST,
            "Created WDFREQUEST %p, %!STATUS!",
            *Request, status);
#endif // FX_VERBOSE_TRACE
    }

if() [4/28]

if

(

ReuseParams->Size !

= sizeof(WDF_REQUEST_REUSE_PARAMS)

)

Definition at line 302 of file fxrequestapi.cpp.

                                                               {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
                            "ReuseParams Size %d, expected %d %!STATUS!",
                            ReuseParams->Size, sizeof(WDF_REQUEST_REUSE_PARAMS),
                            STATUS_INVALID_PARAMETER);
        return STATUS_INVALID_PARAMETER;
    }

if() [5/28]

if

(

pFxDriverGlobals->

IsVersionGreaterThanOrEqualTo1, 11

)

Definition at line 310 of file fxrequestapi.cpp.

                                                               {
        validFlags = WDF_REQUEST_REUSE_VALID_FLAGS;
    }

if() [6/28]

if

(

ReuseParams->Flags &~

validFlags

)

Definition at line 317 of file fxrequestapi.cpp.

                                          {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
                            "ReuseParams Flags 0x%x, valid mask 0x%x, %!STATUS!",
                            ReuseParams->Flags,
                            (ULONG) ~validFlags,
                            STATUS_INVALID_PARAMETER);
        return STATUS_INVALID_PARAMETER;
    }

if() [7/28]

if

(

!

NT_SUCCESSstatus

)

Definition at line 437 of file fxrequestapi.cpp.

                             {
        return;
    }

if() [8/28]

if

(

pRequest->

GetFxIrp) ->GetMajorFunction( = = IRP_MJ_READ

)

Definition at line 773 of file fxrequestapi.cpp.

                                                                 {
        status = STATUS_INVALID_DEVICE_REQUEST;

        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGREQUEST,
            "This call is not valid on the Read request, you should call"
            " WdfRequestRetrieveOutputMemory to get the Memory for WDFREQUEST "
            "0x%p, %!STATUS!", Request, status);

        return status;
    }

if() [9/28]

if

(

majorFunction

= = IRP_MJ_WRITE

)

Definition at line 889 of file fxrequestapi.cpp.

                                       {
        status = STATUS_INVALID_DEVICE_REQUEST;

        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGREQUEST,
            "This call is not valid on the Write request, you should call"
            " WdfRequestRetrieveInputMemory to get the Memory for WDFREQUEST "
            "0x%p, %!STATUS!", Request, status);

        return status;
    }

if() [10/28]

if

(

(majorFunction==IRP_MJ_DEVICE_CONTROL)||(majorFunction==IRP_MJ_INTERNAL_DEVICE_CONTROL)

)

Definition at line 901 of file fxrequestapi.cpp.

                                                            {
        status = pRequest->GetDeviceControlOutputMemoryObject(&pMemory, &pBuffer, &length);
    }

if() [11/28]

if

(

Length !

= NULL

)

Definition at line 1012 of file fxrequestapi.cpp.

                        {
        *Length  = 0;
    }

if() [12/28]

if

(

pFxDriverGlobals->

FxVerifierOn

)

Definition at line 1309 of file fxrequestapi.cpp.

                                        {
        KIRQL irql;

        pRequest->Lock(&irql);

        status = pRequest->VerifyRequestIsInCallerContext(pFxDriverGlobals);

        pRequest->Unlock(irql);

        if (!NT_SUCCESS(status)) {
            return status;
        }
    }

if() [13/28]

if

(

!

NT_SUCCESSFxValidateRequestOptions( WDFREQUEST_FXREQUEST(Request) ->GetDriverGlobals(), Options, WDFREQUEST_FXREQUEST(Request))

)

Definition at line 1924 of file fxrequestapi.cpp.

                                                                  {

        WDFREQUEST_FXREQUEST(Request)->SetStatus(STATUS_INVALID_PARAMETER);

        FxVerifierDbgBreakPoint(WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals());
        return FALSE;
    }

if() [14/28]

if

(

Options !

= NULL && (Options->Flags & (WDF_REQUEST_SEND_OPTION_SYNCHRONOUS |                           WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET)) != 0x0

)

Definition at line 1943 of file fxrequestapi.cpp.

                                                                             {

        if (Options->Flags & WDF_REQUEST_SEND_OPTION_SYNCHRONOUS) {
            //
            // This sets impersonation flags for UMDF. Noop for KMDF.
            //
            WDFREQUEST_FXREQUEST(Request)->SetImpersonationFlags(Options->Flags);

            *PGLOBALS_ACTION(&DriverGlobals) = SubmitSyncCallCompletion;
            (void) WDFIOTARGET_FXIOTARGET(Target)->SubmitSync(
                WDFREQUEST_FXREQUEST(Request),
                Options,
                PGLOBALS_ACTION(&DriverGlobals)
                );
        }
        else if (Options->Flags & WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET) {
            if (WDFREQUEST_FXREQUEST(Request)->IsAllocatedFromIo() == FALSE) {
                DoTraceLevelMessage(
                    WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals(),
                    TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                    "WDFREQUEST %p must be a WDFQUEUE presented request",
                    WDFREQUEST_FXREQUEST(Request)->GetHandle());

                WDFREQUEST_FXREQUEST(Request)->SetStatus(
                    STATUS_INVALID_DEVICE_STATE
                    );

                *PGLOBALS_ACTION(&DriverGlobals) = 0;
            }
            else if (WDFREQUEST_FXREQUEST(Request)->HasContext()) {
                //
                // Cannot send-and-forget a request with formatted IO context.
                //
                DoTraceLevelMessage(
                    WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals(),
                    TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                    "Cannot send-and-forget WDFREQUEST 0x%p with formatted IO"
                    " context, %!STATUS!",
                    WDFREQUEST_FXREQUEST(Request)->GetHandle(),
                    STATUS_INVALID_DEVICE_REQUEST );

                WDFREQUEST_FXREQUEST(Request)->SetStatus(
                    STATUS_INVALID_DEVICE_REQUEST
                    );

                *PGLOBALS_ACTION(&DriverGlobals) = 0;

                FxVerifierDbgBreakPoint(
                        WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals());
            }
            else {
                //
                // We split processing into pre and post processing to reduce
                // stack usage (by not making the call to IoCallDriver in a
                // deep function.
                //

                //
                // This will skip the current stack location
                //
                WDFREQUEST_FXREQUEST(Request)->PreProcessSendAndForget();

                //
                // This sets impersonation flags for UMDF. Noop for KMDF.
                //
                WDFREQUEST_FXREQUEST(Request)->SetImpersonationFlags(Options->Flags);

                MdIrp submitIrp = WDFREQUEST_FXREQUEST(Request)->GetSubmitIrp();

                WDFIOTARGET_FXIOTARGET(Target)->Send(submitIrp);

                //
                // This will free the request memory and pop the queue
                //
                WDFREQUEST_FXREQUEST(Request)->PostProcessSendAndForget();
                return TRUE;
            }
        }
    }

if() [15/28]

else if

(

WDFREQUEST_FXREQUEST(Request) ->IsCompletionRoutineSet()

= = FALSE && WDFREQUEST_FXREQUEST(Request)->IsAllocatedFromIo()

)

Definition at line 2024 of file fxrequestapi.cpp.

                                                                 {
            //
            // Cannot send an asynchronous queue presented request without a
            // completion routine.
            //
            DoTraceLevelMessage(
                WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals(),
                TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "WDFREQUEST %p is a WDFQUEUE presented request with no"
                " completion routine, %!STATUS!",
                WDFREQUEST_FXREQUEST(Request)->GetHandle(),
                STATUS_INVALID_DEVICE_REQUEST );

            WDFREQUEST_FXREQUEST(Request)->SetStatus(
                    STATUS_INVALID_DEVICE_REQUEST
                    );

            *PGLOBALS_ACTION(&DriverGlobals) = 0;

            FxVerifierDbgBreakPoint(
                    WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals());
    }

if() [16/28]

else if

(

GLOBALS_ACTION(DriverGlobals) &

SubmitSend

)

Definition at line 2090 of file fxrequestapi.cpp.

                                                        {

            *PGLOBALS_ACTION(&DriverGlobals) |= SubmitSent;

            ASSERT((GLOBALS_ACTION(DriverGlobals) & SubmitQueued) == 0);

#if FX_VERBOSE_TRACE
            DoTraceLevelMessage(
                WDFREQUEST_FXREQUEST(Request)->GetDriverGlobals(),
                TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                "Sending FxRequest %p (WDFREQUEST %p), Irp %p",
                WDFREQUEST_FXREQUEST(Request),
                WDFREQUEST_FXREQUEST(Request)->GetHandle(),
                WDFREQUEST_FXREQUEST(Request)->GetSubmitIrp());
#endif // FX_VERBOSE_TRACE

            MdIrp submitIrp = WDFREQUEST_FXREQUEST(Request)->GetSubmitIrp();

            WDFIOTARGET_FXIOTARGET(Target)->Send(submitIrp);
        }

if() [17/28]

if

(

irp->

GetIrp() = = NULL

)

Definition at line 2287 of file fxrequestapi.cpp.

                               {
        FxVerifierBugCheck(pFxDriverGlobals,
                           WDF_REQUEST_FATAL_ERROR,
                           WDF_REQUEST_FATAL_ERROR_NULL_IRP,
                           (ULONG_PTR) Request);
        return; // not reached
    }

if() [18/28]

if

(

irp->

HasStack2 = = FALSE

)

Definition at line 2299 of file fxrequestapi.cpp.

                                   {
        FxVerifierBugCheck(pFxDriverGlobals,
                           WDF_REQUEST_FATAL_ERROR,
                           WDF_REQUEST_FATAL_ERROR_NO_MORE_STACK_LOCATIONS,
                           (ULONG_PTR) irp->GetIrp());
        return; // not reached
    }

if() [19/28]

if

(

pIrp

= = NULL

)

Definition at line 2368 of file fxrequestapi.cpp.

                      {
        FxVerifierBugCheck(pFxDriverGlobals,
                           WDF_REQUEST_FATAL_ERROR,
                           WDF_REQUEST_FATAL_ERROR_NULL_IRP,
                           (ULONG_PTR) Request);
        return; // not reached
    }

if() [20/28]

if

(

)

Definition at line 2380 of file fxrequestapi.cpp.

                                                     {
        FxVerifierBugCheck(pFxDriverGlobals,
                           WDF_REQUEST_FATAL_ERROR,
                           WDF_REQUEST_FATAL_ERROR_NO_MORE_STACK_LOCATIONS,
                           (ULONG_PTR) pIrp);
        return; // not reached
    }

if() [21/28]

if

(

Parameters->Size !

= sizeof(WDF_REQUEST_PARAMETERS)

)

Definition at line 2465 of file fxrequestapi.cpp.

                                                            {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
                            "Params size %d incorrect, expected %d",
                            Parameters->Size, sizeof(WDF_REQUEST_PARAMETERS));

        FxVerifierDbgBreakPoint(pFxDriverGlobals);

        return;
    }

if() [22/28]

if

(

Params->Size !

= sizeof(WDF_REQUEST_COMPLETION_PARAMS)

)

Definition at line 2515 of file fxrequestapi.cpp.

                                                               {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
            "Params Size 0x%x, expected 0x%x",
            Params->Size, sizeof(WDF_REQUEST_COMPLETION_PARAMS));
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        return;
    }

if() [23/28]

if

(

pRequest->

GetDriverGlobals) ->IsVerificationEnabled( 1, 9, OkForDownLevel

)

Definition at line 2688 of file fxrequestapi.cpp.

                                  {
        KIRQL irql;

        pRequest->Lock(&irql);
        status = pRequest->VerifyRequestIsDriverOwned(pFxDriverGlobals);
        pRequest->Unlock(irql);
        if (!NT_SUCCESS(status)) {
            return NULL;
        }
    }

if() [24/28]

else if

(

NULL

= = pFO

)

Definition at line 2706 of file fxrequestapi.cpp.

                          {
        //
        // Success and NULL file object: driver during init told us that it
        // knows how to handle NULL file objects.
        //
        return NULL;
    }

if() [25/28]

if

(

pRequest->

GetCurrentQueue() = = NULL

)

Definition at line 3009 of file fxrequestapi.cpp.

                                             {
        //
        // For a driver-created request, the queue can be NULL. It is not
        // necessarily an error to call WdfRequestGetIoQueue on a driver-
        // created request, because the caller may not really know whether or
        // not the request is driver-created.
        //
        // For example, it is possible for a class extension to create a request
        // and pass it to the client driver, in which case the client driver
        // wouldn't really know whether or not it was driver-created. Or a
        // client driver is might be using a helper library for some of its
        // tasks and it might pass in a request object to the helper library. In
        // this case, the helper library wouldn't really know whether or not the
        // request was driver-created. Therefore, the log message below is at
        // verbose level and not at error or warning level.
        //
        DoTraceLevelMessage(pFxDriverGlobals,
                            TRACE_LEVEL_VERBOSE,
                            TRACINGREQUEST,
                            "WDFREQUEST %p doesn't belong to any queue",
                            Request);
        return NULL;
    }

if() [26/28]

if

(

request->GetCurrentQueue() !

= NULL

)

Definition at line 3163 of file fxrequestapi.cpp.

                                            {
        status = request->GetCurrentQueue()->ForwardRequest(queue, request);
        goto Done;
    }

if() [27/28]

if

(

ForwardOptions->Size !

= sizeof(WDF_REQUEST_FORWARD_OPTIONS)

)

Definition at line 3314 of file fxrequestapi.cpp.

                                                                     {
        //
        // Size is wrong, bale out
        //
        status = STATUS_INFO_LENGTH_MISMATCH;
        DoTraceLevelMessage(fxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
                            "ForwardOptions %p Size incorrect, expected %d, "
                            "got %d, %!STATUS!",
                            ForwardOptions, sizeof(WDF_REQUEST_FORWARD_OPTIONS),
                            ForwardOptions->Size,
                            status);

        goto Done;
    }

if() [28/28]

if

(

(ForwardOptions->Flags &~WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET) !

= 0

)

Definition at line 3329 of file fxrequestapi.cpp.

                                                                                    {
        //
        // Invalid flag
        //
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(fxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
                            "ForwardOptions %p Flags 0x%x invalid, "
                            "valid mask is 0x%x, %!STATUS!",
                            ForwardOptions, ForwardOptions->Flags,
                            WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET,
                            status);

        goto Done;
    }

IsCancelled()

return pRequest IsCancelled

(

)

IsReserved()

return pRequest IsReserved

(

)

return()

return

(

WDFQUEUE

)

-> GetCurrentQueue() ->GetObjectHandle()

Reuse()

return pRequest Reuse

(

ReuseParams

)

Referenced by FxUsbUmFormatRequest().

SetCompletionRoutine()

pRequest SetCompletionRoutine	(	CompletionRoutine	,
		CompletionContext
	)

SetInformation()

pRequest SetInformation

(

Information

)

StopAcknowledge()

pRequest StopAcknowledge

(

Requeue

)

UNREFERENCED_PARAMETER()

UNREFERENCED_PARAMETER

(

status

)

ValidateTarget()

return pRequest ValidateTarget

(

pTarget

)

VerifierSetFormatted()

pRequest VerifierSetFormatted

(

)

VerifyRequestComplete()

_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION() VerifyRequestComplete	(	_In_ PFX_DRIVER_GLOBALS	FxDriverGlobals,
		_In_ FxRequest *	pRequest
	)

Definition at line 362 of file fxrequestapi.cpp.

{
    NTSTATUS status;
    KIRQL irql;

    PAGED_CODE_LOCKED();

    pRequest->Lock(&irql);

    status = pRequest->VerifyRequestIsDriverOwned(FxDriverGlobals);
    if (NT_SUCCESS(status)) {
        status = pRequest->VerifyRequestCanBeCompleted(FxDriverGlobals);
    }

    pRequest->Unlock(irql);
    return status;
}

VerifyWdfRequestForwardToIoQueue()

_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION() VerifyWdfRequestForwardToIoQueue	(	_In_ PFX_DRIVER_GLOBALS	FxDriverGlobals,
		_In_ FxRequest *	request
	)

Definition at line 3055 of file fxrequestapi.cpp.

{
    NTSTATUS status = STATUS_SUCCESS;

    PAGED_CODE_LOCKED();

    //
    // * Is request I/O allocated but without a queue? This should not happen.
    // * Is WDF driver v1.9 or below trying to use this feature? We don't allow it.
    //
    if (request->IsAllocatedDriver() == FALSE ||
        FxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,11) == FALSE) {
        status =  STATUS_INVALID_DEVICE_REQUEST;
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
                    "WDFREQUEST %p doesn't belong to any queue, %!STATUS!",
                    request->GetHandle(), status);
        FxVerifierDbgBreakPoint(FxDriverGlobals);
        return status;
    }

    //
    // Make sure current IRP stack location is valid. See helper routine for error msgs.
    //
    status = request->VerifyRequestCanBeCompleted(FxDriverGlobals);
    return status;
}

VerifyWdfRequestForwardToParentDeviceIoQueue()

_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION() VerifyWdfRequestForwardToParentDeviceIoQueue	(	_In_ PFX_DRIVER_GLOBALS	fxDriverGlobals,
		_In_ FxRequest *	request
	)

Definition at line 3187 of file fxrequestapi.cpp.

{
    NTSTATUS status;
    FxIrp* irp;

    PAGED_CODE_LOCKED();

    //
    // * Is request I/O allocated but without a queue? This should not happen.
    // * Is WDF driver v1.9 or below trying to use this feature? We don't allow it.
    //
    if (request->IsAllocatedDriver() == FALSE ||
        fxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,11) == FALSE) {
        status =  STATUS_INVALID_DEVICE_REQUEST;
        DoTraceLevelMessage(fxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
                    "WDFREQUEST %p doesn't belong to any queue, %!STATUS!",
                    request->GetHandle(), status);
        FxVerifierDbgBreakPoint(fxDriverGlobals);
        goto Done;
    }

    //
    // Make sure current IRP stack location is valid.
    //
    status = request->VerifyRequestCanBeCompleted(fxDriverGlobals);
    if (!NT_SUCCESS(status)) {
        goto Done;
    }

    //
    // Make sure IRP has space for at least another stack location.
    //
    irp = request->GetFxIrp();

    ASSERT(irp->GetIrp() != NULL);

    if (irp->GetCurrentIrpStackLocationIndex() <= 1) {
        status =  STATUS_INVALID_DEVICE_REQUEST;
        DoTraceLevelMessage(fxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGREQUEST,
                            "IRP %p of WDFREQUEST %p doesn't enough stack "
                            "locations, %!STATUS!",
                            irp, request->GetHandle(), status);
        FxVerifierDbgBreakPoint(fxDriverGlobals);
        goto Done;
    }

Done:
    return status;
}

VerifyWdfRequestIsCanceled()

_Must_inspect_result_ NTSTATUS FX_VF_FUNCTION() VerifyWdfRequestIsCanceled	(	_In_ PFX_DRIVER_GLOBALS	FxDriverGlobals,
		_In_ FxRequest *	pRequest
	)

Definition at line 3637 of file fxrequestapi.cpp.

{
    NTSTATUS status;
    KIRQL irql;

    PAGED_CODE_LOCKED();

    pRequest->Lock(&irql);

    status = pRequest->VerifyRequestIsDriverOwned(FxDriverGlobals);
    if (NT_SUCCESS(status)) {
        status = pRequest->VerifyRequestIsNotCancelable(FxDriverGlobals);
    }

    pRequest->Unlock(irql);
    return status;
}

Variable Documentation

__pad2__

Done __pad2__

Definition at line 3182 of file fxrequestapi.cpp.

__pad3__

Done __pad3__

Definition at line 3370 of file fxrequestapi.cpp.

Buffer

* Buffer = NULL

Definition at line 928 of file fxrequestapi.cpp.

CompletionContext

__in WDFREQUEST __in_opt PFN_WDF_REQUEST_COMPLETION_ROUTINE __in_opt WDFCONTEXT CompletionContext

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 2408 of file fxrequestapi.cpp.

CompletionRoutine

__in WDFREQUEST __in_opt PFN_WDF_REQUEST_COMPLETION_ROUTINE CompletionRoutine

Definition at line 2402 of file fxrequestapi.cpp.

cxDriverGlobals

cxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

Definition at line 3136 of file fxrequestapi.cpp.

DestinationQueue

_Must_inspect_result_ __in WDFREQUEST __in WDFQUEUE DestinationQueue

Initial value:

{
    PFX_DRIVER_GLOBALS  fxDriverGlobals

Definition at line 3134 of file fxrequestapi.cpp.

else

else

Initial value:

{
        pTarget = NULL

Definition at line 116 of file fxrequestapi.cpp.

EvtRequestCancel

_Must_inspect_result_ __in WDFREQUEST __in PFN_WDF_REQUEST_CANCEL EvtRequestCancel

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 3464 of file fxrequestapi.cpp.

ForwardOptions

_Must_inspect_result_ __in WDFREQUEST __in WDFQUEUE __in PWDF_REQUEST_FORWARD_OPTIONS ForwardOptions

Initial value:

{
    PFX_DRIVER_GLOBALS  fxDriverGlobals

Definition at line 3290 of file fxrequestapi.cpp.

Information

__in WDFREQUEST __in ULONG_PTR Information

Initial value:

{
    FxRequest *pRequest

Definition at line 551 of file fxrequestapi.cpp.

InputBuffer

* InputBuffer = NULL

Definition at line 1226 of file fxrequestapi.cpp.

IoTarget

_Must_inspect_result_ __in WDFREQUEST __in WDFIOTARGET IoTarget

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 341 of file fxrequestapi.cpp.

Irp

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in MdIrp Irp

Definition at line 165 of file fxrequestapi.cpp.

irp

MdIrp irp = pRequest->GetFxIrp()

Definition at line 1323 of file fxrequestapi.cpp.

Referenced by FxDevice::_AcquireOptinRemoveLock(), _IRQL_requires_max_(), FxPkgFdo::_PnpStartDeviceCompletionRoutine(), FxPkgPdo::_QueryCapsWorkItem(), FxQueryInterface::_QueryForInterface(), CallUSBD(), FxIoQueue::CancelIrps(), CancelSelectSuspend(), ClasspCompleteOffloadRead(), ClasspCompleteOffloadWrite(), ClasspContinueOffloadWrite(), ClasspDequeueIdleRequest(), ClasspFailurePredict(), ClasspInitializeGesn(), ClasspInitializePolling(), ClasspPrepareMcnIrp(), ClasspReceivePopulateTokenInformation(), ClasspReceivePopulateTokenInformationTransferPacketDone(), ClasspReceiveWriteUsingTokenInformation(), ClasspReceiveWriteUsingTokenInformationTransferPacketDone(), ClasspReleaseQueue(), ClasspRetryRequestDpc(), ClasspSendMediaStateIrp(), ClasspServiceIdleRequest(), ClasspUpdateDiskProperties(), ClassSendDeviceIoControlSynchronous(), ClassSendSrbSynchronous(), ClassSendStartUnit(), FxPkgPnp::ClearPendingDevicePowerIrp(), FxPkgPnp::ClearPendingPnpIrp(), FxPkgPnp::ClearPendingSystemPowerIrp(), FxRequest::CompleteInternal(), FxPkgPnp::CompletePowerRequest(), FxRequest::CopyCurrentIrpStackLocationToNext(), FxIoTarget::CopyFileObjectAndFlags(), FxIoContext::CopyParameters(), DequeueDeferredClientIrp(), DeviceSendIoctlAsynchronously(), DeviceZPODDGetPowerupReason(), DiskInfoExceptionCheck(), DiskInitFdo(), DiskPerformSmartCommand(), DiskReregWorker(), DiskSendFailurePredictIoctl(), DiskStartFdo(), FxPkgPnp::Dispatch(), FxDevice::DispatchPreprocessedIrp(), FxDevice::DispatchWithLock(), DispatchWorker(), FxPostProcessInfo::Evaluate(), FlopticalFormatMedia(), FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), FreeBT_GetPortStatus(), FreeBT_ResetParentPort(), FX_VF_METHOD(), FxFormatUsbRequest(), FxRequestSystemBuffer::GetBuffer(), FxRequestOutputBuffer::GetBuffer(), FxRequestSystemBuffer::GetBufferSize(), FxRequestOutputBuffer::GetBufferSize(), FxRequestSystemBuffer::GetFlags(), FxRequestOutputBuffer::GetFlags(), FxRequestSystemBuffer::GetMdl(), FxRequestOutputBuffer::GetMdl(), GetStackCapabilities(), FxIoTargetRemote::GetTargetDeviceRelations(), HoldIoRequestsWorkerRoutine(), if(), FxRequest::Impersonate(), FxIrpQueue::InsertIrpInQueue(), FxPkgPnp::IsDevicePowerUpIrpPending(), IsPreprocessIrp(), FxPkgGeneral::OnClose(), FxIrpQueue::PeekNextIrpFromQueue(), PiceSendIoctl(), FxPkgPnp::PnpEventInitQueryRemove(), FxPkgPnp::PnpEventInitQueryRemoveCanceled(), FxPkgPnp::PnpEventQueryRemovePending(), FxPkgPnp::PnpEventQueryStopPending(), FxPkgPnp::PnpFinishProcessingIrp(), FxPkgPnp::PnpMatchResources(), FxPkgFdo::PnpSendStartDeviceDownTheStackOverload(), FxPkgPnp::PowerCompletePendedWakeIrp(), FxPkgPnp::PowerGotoDxIoStopped(), FxPkgPnp::PowerGotoDxIoStoppedNP(), FxPkgPnp::PowerPolicyCancelWaitWake(), FxPkgPnp::PowerPolicyCompleteSystemPowerIrp(), FxPkgPnp::PowerPolicyGetPendingSystemState(), FxPkgFdo::PowerReleasePendingDeviceIrp(), FxPkgPdo::PowerReleasePendingDeviceIrp(), PreprocessIrp(), print_irp_flags(), FxRequest::ProbeAndLockForRead(), FxRequest::ProbeAndLockForWrite(), FxPkgPnp::QueryForD3ColdInterface(), FxRequest::Release(), FxIoContext::ReleaseAndRestore(), FxIrpQueue::RemoveIrpFromQueueByContext(), RequestCompletion(), RequestDispatchSpecialIoctls(), RequestGetCurrentStackLocationFlags(), RequestHandleReadWrite(), RequestProcessInternalDeviceControl(), RequestSetupMcnSyncIrp(), RequestSynchronizeProcessWithSerialQueue(), RequestValidateRawRead(), RequestValidateReadWrite(), ResetBus(), ScratchBuffer_ResetItems(), ScratchBuffer_SetupReadWriteSrb(), ScsiFlopProcessError(), ScsiFlopStartDevice(), FxUsbDevice::SelectConfig(), FxIoTargetSelf::Send(), FxIoTarget::SetCompletionRoutine(), FxIrp::SetIrp(), FxPkgPnp::SetPendingPnpIrpStatus(), SubmitIdleRequestIrp(), FxIoContext::SwapIrpBuffer(), UDFPhReadSynchronous(), UDFPhSendIOCTL(), UDFPhWriteSynchronous(), USBPORT_CancelActiveTransferIrp(), USBPORT_CancelPendingTransferIrp(), USBPORT_FindIrpInTable(), USBPORT_FindUrbInIrpTable(), VerifyWdfRequestForwardToParentDeviceIoQueue(), VfdDeviceThread(), and FxRequestBase::~FxRequestBase().

length

size_t length

Definition at line 750 of file fxrequestapi.cpp.

Length

_Must_inspect_result_ __in WDFREQUEST __in size_t Length

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 987 of file fxrequestapi.cpp.

m_NextStackLocationFormatted

pRequest m_NextStackLocationFormatted = TRUE

Definition at line 2307 of file fxrequestapi.cpp.

majorFunction

UCHAR majorFunction = pRequest->GetFxIrp()->GetMajorFunction()

Definition at line 864 of file fxrequestapi.cpp.

Referenced by FxIrp::CopyParameters(), FxIoQueue::DispatchRequestToDriver(), FxIoTarget::FormatIoctlRequest(), FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetDeviceControlOutputMemoryObject(), FxIrp::GetMajorFunction(), FxRequest::GetMdl(), FxRequest::GetMemoryObject(), FxIoQueue::GetRequest(), ScsiFlopProcessError(), FxIoTargetSelf::Send(), and VerifyWdfDeviceWdmDispatchIrpToIoQueue().

Mdl

* Mdl

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 1680 of file fxrequestapi.cpp.

Memory

_Must_inspect_result_ __in WDFREQUEST __out WDFMEMORY* Memory

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 744 of file fxrequestapi.cpp.

MemoryObject

* MemoryObject

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 2764 of file fxrequestapi.cpp.

Options

_Must_inspect_result_ __in WDFREQUEST __in WDFIOTARGET __in_opt PWDF_REQUEST_SEND_OPTIONS Options

Initial value:

{
    
    
    
    FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals),
                         Request,
                         FX_TYPE_REQUEST,
                         (PVOID*) &Request)

Definition at line 1911 of file fxrequestapi.cpp.

OutputBuffer

* OutputBuffer = NULL

Definition at line 1430 of file fxrequestapi.cpp.

Parameters

__in WDFREQUEST __out PWDF_REQUEST_PARAMETERS Parameters

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 2445 of file fxrequestapi.cpp.

Params

__in WDFREQUEST __out PWDF_REQUEST_COMPLETION_PARAMS Params

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 2495 of file fxrequestapi.cpp.

ParentDeviceQueue

_Must_inspect_result_ __in WDFREQUEST __in WDFQUEUE ParentDeviceQueue

Definition at line 3248 of file fxrequestapi.cpp.

pBuffer

PVOID pBuffer

Definition at line 749 of file fxrequestapi.cpp.

Referenced by if().

pDevice

pDevice = FxDevice::GetFxDevice(irp->GetDeviceObject())

Definition at line 1278 of file fxrequestapi.cpp.

pFO

pFO = NULL

Definition at line 2670 of file fxrequestapi.cpp.

pFxDriverGlobals

PFX_DRIVER_GLOBALS pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

Definition at line 107 of file fxrequestapi.cpp.

Referenced by if().

pIrp

pIrp = pRequest->GetSubmitFxIrp()

Definition at line 2348 of file fxrequestapi.cpp.

Referenced by _In_reads_(), FxPkgFdo::_PnpPassDown(), FxPkgFdo::_PowerPassDown(), FxQueryInterface::_QueryForInterface(), AdapterDispatchPnp(), FxMessageDispatch::CleanupFile(), FxMessageDispatch::CloseFile(), FxRequest::CompleteInternal(), FxPkgPnp::CompletePnpRequest(), FxMessageDispatch::DeviceControl(), FxMessageDispatch::DispatchPnP(), FxIoQueue::DispatchRequestToDriver(), FxIoTarget::DrainPendedRequestsLocked(), EngpFileIoRequest(), FxMessageDispatch::FlushBuffers(), FxIoQueue::ForwardRequestToParent(), FxUsbUmFormatRequest(), FxRequest::GetNextRequest(), FxIoQueue::GetRequest(), FxIoTargetRemote::GetTargetDeviceRelations(), if(), FxUsbIdleInfo::Initialize(), PoRequestPowerIrp(), FxPkgFdo::PowerReleasePendingDeviceIrp(), FxPkgPdo::PowerReleasePendingDeviceIrp(), FxMessageDispatch::QueryInformationFile(), FxIoQueue::QueueRequest(), FxMessageDispatch::ReadFile(), FxRequest::RemoveFromIrpQueue(), SerialCompleteIrp(), SerialGetPerfStats(), FxMessageDispatch::SetInformationFile(), StartDevice(), FxRequestBase::ValidateTarget(), and FxMessageDispatch::WriteFile().

pMemory

FxRequestMemory* pMemory = NULL

Definition at line 748 of file fxrequestapi.cpp.

Referenced by if().

pRequest

FxRequest* pRequest

Definition at line 103 of file fxrequestapi.cpp.

Referenced by if(), VerifyRequestComplete(), and VerifyWdfRequestIsCanceled().

PriorityBoost

__in WDFREQUEST __in NTSTATUS __in CCHAR PriorityBoost

Initial value:

{
    NTSTATUS status

Definition at line 483 of file fxrequestapi.cpp.

pTarget

FxIoTarget* pTarget

Definition at line 104 of file fxrequestapi.cpp.

Referenced by if().

queue

FxIoQueue * queue

Definition at line 3138 of file fxrequestapi.cpp.

Referenced by AddEventHooksWdfIoQueueCreate(), FxPkgIo::AddIoQueue(), FxRequest::CompleteInternal(), FxPkgIo::DispatchStep1(), GetIoQueueList_ProcessQueueListEntry(), FxPkgIo::GetNextIoQueueLocked(), HTMLScriptElement_put_src(), CNotifyToolbar::Initialize(), NBCmdQueueCreate(), FxRequest::Release(), FxPkgIo::ResetStateForRestart(), FxPkgIo::ResumeProcessingForPower(), FxIoTargetSelf::Send(), SetupInstallFilesFromInfSectionW(), SetupInstallFromInfSectionW(), SetupOpenFileQueue(), SetupQueueCopyA(), SetupQueueCopySectionW(), SetupQueueCopyW(), SetupQueueDefaultCopyA(), SetupQueueDefaultCopyW(), FxPkgIo::StopProcessingForPower(), vp_setup_vq(), and wined3d_cs_run().

Request

__in WDFREQUEST Request

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 101 of file fxrequestapi.cpp.

request

FxSyncRequest request

Definition at line 3137 of file fxrequestapi.cpp.

Referenced by __in_xcount(), FxUsbPipe::_SendTransfer(), CTuneRequest_fnConstructor(), FxUsbDevice::CyclePort(), FxUsbDevice::Deconfig(), FxPkgIo::DispatchStep2(), FxUsbDevice::GetString(), HTTP_HttpOpenRequestW(), HttpAddRequestHeadersW(), HttpEndRequestW(), HttpQueryInfoW(), HttpSendRequestExW(), HttpSendRequestW(), FxUsbDevice::InitDevice(), InternetOpenRequest_test(), make_request(), FxIoQueue::QueueIdle(), rdpdr_process_irp(), FxUsbDevice::Reset(), FxUsbPipe::Reset(), FxUsbDevice::SelectConfig(), FxUsbInterface::SelectSetting(), FxUsbDevice::SendSyncUmUrb(), SQLConfigDriver(), SQLConfigDriverW(), test_basic_authentication(), test_cache_control_verb(), test_default_service_port(), test_header_handling_order(), test_http_cache(), test_IWinHttpRequest_Invoke(), test_not_modified(), test_WinHttpAddHeaders(), test_WinHttpOpenRequest(), test_WinHttpQueryOption(), test_WinHttpSendRequest(), TIFFDefaultStripSize(), VfdDeviceThread(), WinHttpAddRequestHeaders(), WinHttpOpenRequest(), WinHttpQueryAuthSchemes(), WinHttpQueryDataAvailable(), WinHttpQueryHeaders(), WinHttpReadData(), WinHttpReceiveResponse(), WinHttpRequest_create(), WinHttpSendRequest(), WinHttpSetCredentials(), and WinHttpWriteData().

RequestAttributes

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES RequestAttributes

Definition at line 72 of file fxrequestapi.cpp.

RequestFreesIrp

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in MdIrp __in BOOLEAN RequestFreesIrp

Definition at line 165 of file fxrequestapi.cpp.

RequestStatus

__in WDFREQUEST __in NTSTATUS RequestStatus

Initial value:

{
    NTSTATUS status

Definition at line 416 of file fxrequestapi.cpp.

Requeue

__in WDFREQUEST __in BOOLEAN Requeue

Initial value:

{
    FxRequest* pRequest

Definition at line 3743 of file fxrequestapi.cpp.

RequiredLength

_Must_inspect_result_ __in WDFREQUEST __in size_t RequiredLength

Definition at line 925 of file fxrequestapi.cpp.

result

return result = pRequest->Cancel()

Definition at line 2172 of file fxrequestapi.cpp.

return

return

Definition at line 2430 of file fxrequestapi.cpp.

ReuseParams

__in WDFREQUEST __in PWDF_REQUEST_REUSE_PARAMS ReuseParams

Initial value:

{
    PFX_DRIVER_GLOBALS  pFxDriverGlobals

Definition at line 289 of file fxrequestapi.cpp.

Stack

__in WDFREQUEST __in PIO_STACK_LOCATION Stack

Initial value:

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 2345 of file fxrequestapi.cpp.

status

status

Initial value:

= FxRequest::_Create(pFxDriverGlobals,
                                RequestAttributes,
                                NULL,
                                pTarget,
                                FxRequestOwnsIrp,
                                FxRequestConstructorCallerIsDriver,
                                &pRequest)

Definition at line 105 of file fxrequestapi.cpp.

Referenced by if(), VerifyRequestComplete(), VerifyWdfRequestForwardToIoQueue(), VerifyWdfRequestForwardToParentDeviceIoQueue(), and VerifyWdfRequestIsCanceled().

Target

_Must_inspect_result_ __in WDFREQUEST __in WDFIOTARGET Target

Definition at line 72 of file fxrequestapi.cpp.

validFlags

ULONG validFlags

Definition at line 292 of file fxrequestapi.cpp.

Referenced by if().