#include <fxrequestbase.hpp>

Inheritance diagram for FxRequestBase:

[legend]

Collaboration diagram for FxRequestBase:

[legend]

Public Member Functions
__inline VOID	SetCompletionRoutine (__in_opt PFN_WDF_REQUEST_COMPLETION_ROUTINE CompletionRoutine=NULL, __in_opt WDFCONTEXT CompletionContext=NULL)

PFN_WDF_REQUEST_COMPLETION_ROUTINE	ClearCompletionRoutine (VOID)

WDFCONTEXT	ClearCompletionContext (VOID)

__inline BOOLEAN	IsCompletionRoutineSet (VOID)

__inline BOOLEAN	IsCancelRoutineSet (VOID)

__inline FxRequestContext *	GetContext (VOID)

__inline VOID	SetContext (__in FxRequestContext *RequestContext=NULL)

VOID	ContextReleaseAndRestore (VOID)

__inline VOID	EnableContextDisposeNotification (VOID)

__inline BOOLEAN	HasContextType (__in FX_REQUEST_CONTEXT_TYPE Type)

__inline BOOLEAN	HasContext (VOID)

__inline MdIrp	GetSubmitIrp (VOID)

__inline FxIrp *	GetSubmitFxIrp (VOID)

MdIrp	SetSubmitIrp (__in_opt MdIrp NewIrp, __in BOOLEAN FreeIrp=TRUE)

__inline BOOLEAN	CanComplete (VOID)

VOID	CompleteSubmitted (VOID)

_Must_inspect_result_ NTSTATUS	ValidateTarget (__in FxIoTarget *Target)

__inline FxIoTarget *	GetTarget (VOID)

VOID __inline	SetTarget (__in FxIoTarget *Target)

__inline UCHAR	GetTargetFlags (VOID)

__inline VOID	SetTargetFlags (__in UCHAR Flags)

__inline ULONG	ClearTargetFlags (__in UCHAR Flags)

__inline VOID	SetRequestBaseFlags (__in UCHAR Flags)

SHORT	GetVerifierFlagsLocked (VOID)

__inline SHORT	GetVerifierFlags (VOID)

__inline VOID	SetVerifierFlagsLocked (__in SHORT Flags)

__inline VOID	SetVerifierFlags (__in SHORT Flags)

__inline VOID	ClearVerifierFlagsLocked (__in SHORT Flags)

__inline VOID	ClearVerifierFlags (__in SHORT Flags)

__inline VOID	VerifierSetFormatted (VOID)

__inline VOID	VerifierClearFormatted (VOID)

__inline BOOLEAN	VerifierIsFormatted (VOID)

__inline BOOLEAN	ShouldClearContext (VOID)

_Must_inspect_result_ NTSTATUS	CreateTimer (VOID)

VOID	StartTimer (__in LONGLONG Timeout)

_Must_inspect_result_ BOOLEAN	CancelTimer (VOID)

BOOLEAN	Cancel (VOID)

BOOLEAN __inline	IsAllocatedFromIo (VOID)

BOOLEAN __inline	IsAllocatedDriver (VOID)

BOOLEAN __inline	IsCanComplete (VOID)

__inline VOID	SetCompleted (__in BOOLEAN Value)

VOID __inline	SetPriorityBoost (CCHAR PriorityBoost)

CCHAR __inline	GetPriorityBoost (VOID)

__inline WDFREQUEST	GetHandle (VOID)

__inline PVOID	GetTraceObjectHandle (VOID)

VOID	FreeMdls (VOID)

DECLSPEC_NORETURN VOID	FatalError (__in NTSTATUS Status)

VOID	ClearFieldsForReuse (VOID)

Public Member Functions inherited from FxNonPagedObject
	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

virtual	~FxNonPagedObject (VOID)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL PreviousIrql)

	_Releases_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID Unlock(__in __drv_restoresIRQL KIRQL PreviousIrql)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID LockAtDispatch(VOID)

	_Requires_lock_held_ (this->m_NPLock.m_Lock) _Releases_lock_(this -> m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID UnlockFromDispatch(VOID)

Public Member Functions inherited from FxObject
PVOID	GetCOMWrapper ()

void	SetCOMWrapper (__drv_aliasesMem PVOID Wrapper)

	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

virtual	~FxObject (VOID)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType Type)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in USHORT ExtraSize=0)

VOID	operator delete (__in PVOID Memory)

VOID	SetNoContextHeader (VOID)

PVOID __inline	GetObjectHandle (VOID)

__inline FxContextHeader *	GetContextHeader (VOID)

__inline PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)

WDFTYPE	GetType (VOID)

USHORT	GetObjectSize (VOID)

LONG	GetRefCnt (VOID)

FxTagTracker *	GetTagTracker (VOID)

CfxDevice *	GetDevice (VOID)

CfxDeviceBase *	GetDeviceBase (VOID)

VOID	SetDeviceBase (__in CfxDeviceBase *DeviceBase)

__inline VOID	CallCleanup (VOID)

ULONG __inline	AddRef (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	Release (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	AddRefOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	ReleaseOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual _Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)

VOID	MarkTraceState (VOID)

BOOLEAN __inline	IsTraceState (VOID)

VOID __inline	TraceDroppedEvent (__in FxObjectDroppedEvent Event)

VOID	MarkPassiveDispose (__in FxObjectLockState State=ObjectLock)

VOID	MarkPassiveCallbacks (__in FxObjectLockState State=ObjectLock)

VOID	MarkForceDisposeThread (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsPassiveCallbacks (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsPassiveDispose (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsForceDisposeThread (__in BOOLEAN AcquireLock=TRUE)

VOID	MarkCommitted (VOID)

BOOLEAN	IsCommitted (VOID)

VOID	MarkDisposeOverride (__in FxObjectLockState State=ObjectLock)

VOID	MarkNoDeleteDDI (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsNoDeleteDDI (VOID)

_Must_inspect_result_ NTSTATUS	Commit (__in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out_opt WDFOBJECT ObjectHandle, __in_opt FxObject Parent=NULL, __in BOOLEAN AssignDriverAsDefaultParent=TRUE)

VOID	DeleteFromFailedCreate (VOID)

VOID	ClearEvtCallbacks (VOID)

BOOLEAN	EarlyDispose (VOID)

virtual VOID	DeleteObject (VOID)

virtual BOOLEAN	Dispose (VOID)

_Must_inspect_result_ NTSTATUS	AssignParentObject (__in FxObject *ParentObject)

_Must_inspect_result_ NTSTATUS	AddContext (__in FxContextHeader Header, __in PVOID Context, __in PWDF_OBJECT_ATTRIBUTES Attributes)

_Must_inspect_result_ NTSTATUS	RemoveParentAssignment (VOID)

_Must_inspect_result_ FxObject *	GetParentObjectReferenced (__in PVOID Tag)

BOOLEAN	IsDisposed (VOID)

Static Public Member Functions
static __inline FxRequestBase *	_FromListEntry (__in PLIST_ENTRY Entry)

static __inline FxRequestBase *	_FromDrainEntry (__in PSINGLE_LIST_ENTRY Entry)

static __inline FxRequestBase *	_FromCsqContext (__in PMdIoCsqIrpContext Context)

Static Public Member Functions inherited from FxObject
static FxObject *	_FromDisposeEntry (__in PSINGLE_LIST_ENTRY Entry)

static FxObject *	_GetObjectFromHandle (__in WDFOBJECT Handle, __inout PWDFOBJECT_OFFSET ObjectOffset)

static PVOID __inline	_ToHandle (__in FxObject *Object)

static VOID __inline	_ReferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static VOID __inline	_DereferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static PVOID	_GetDebugBase (__in FxObject *Object)

static PFX_POOL_HEADER	_CleanupPointer (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Object)

static _Must_inspect_result_ NTSTATUS	_GetEffectiveLock (__in FxObject Object, __in_opt IFxHasCallbacks Callbacks, __in BOOLEAN AutomaticLocking, __in BOOLEAN PassiveCallbacks, __out FxCallbackLock CallbackLock, __out_opt FxObject CallbackLockObject)

static _Must_inspect_result_ NTSTATUS	_ObjectQuery (_In_ FxObject Object, _In_ CONST GUID Guid, _In_ ULONG QueryBufferLength, _Out_writes_bytes_(QueryBufferLength) PVOID QueryBuffer)

Public Attributes
union {
MdIoCsqIrpContext m_CsqContext

LIST_ENTRY m_ListEntry

};

union {
SINGLE_LIST_ENTRY m_DrainSingleEntry

BOOLEAN m_NextStackLocationFormatted

};

Protected Member Functions
	FxRequestBase (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in_opt MdIrp Irp, __in FxRequestIrpOwnership Ownership, __in FxRequestConstructorCaller Caller, __in FxObjectType ObjectType=FxObjectTypeExternal)

virtual	~FxRequestBase (VOID)

	FX_DECLARE_VF_FUNCTION (VOID, VerifyDispose)

virtual BOOLEAN	Dispose (VOID)

VOID	CompleteSubmittedNoContext (VOID)

VOID	ZeroOutDriverContext (VOID)

Protected Member Functions inherited from FxObject
	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

FxObjectDebugExtension *	GetDebugExtension (VOID)

BOOLEAN	IsDebug (VOID)

VOID	AllocateTagTracker (__in WDFTYPE Type)

virtual VOID	SelfDestruct (VOID)

PVOID __inline	GetObjectHandleUnchecked (VOID)

VOID __inline	DestroyChildren (VOID)

VOID	DeleteEarlyDisposedObject (VOID)

Protected Attributes
FxIrp	m_Irp

FxIoTarget *	m_Target

FxRequestContext *	m_RequestContext

FxRequestTimer *	m_Timer

FxRequestCancelCallback	m_CancelRoutine

FxRequestCompletionCallback	m_CompletionRoutine

WDFCONTEXT	m_TargetCompletionContext

LONG	m_IrpCompletionReferenceCount

union {
UCHAR m_TargetFlags

struct {
UCHAR Completed: 1

UCHAR FlagsPended: 1

UCHAR TimerSet: 1

UCHAR CancelledFromTimer: 1

UCHAR IgnoreState: 1

} m_TargetFlagsByName

};

UCHAR	m_IrpAllocation

BOOLEAN	m_Completed

BOOLEAN	m_Canceled

WDFOBJECT_OFFSET_ALIGNED	m_SystemBufferOffset

union {
SHORT m_VerifierFlags

struct {
SHORT DriverOwned: 1

SHORT TagRequest: 1

SHORT Forwarded: 1

SHORT DriverDispatch: 1

SHORT DriverCancelable: 1

SHORT DriverInprocessContext: 1

SHORT Cancelled: 1

SHORT Formatted: 1

SHORT SentToTarget: 1

SHORT DriverInEvtIoStopContext: 1

} m_VeriferFlagsByName

};

LONG	m_IrpReferenceCount

FxIrpQueue *	m_IrpQueue

WDFOBJECT_OFFSET_ALIGNED	m_OutputBufferOffset

union {
UCHAR m_RequestBaseFlags

struct {
UCHAR SystemMdlMapped: 1

UCHAR OutputMdlMapped: 1

UCHAR SyncCleanupContext: 1

} m_RequestBaseFlagsByName

};

union {
UCHAR m_RequestBaseStaticFlags

struct {
UCHAR SystemBufferValid: 1

UCHAR OutputBufferValid: 1

} m_RequestBaseStaticFlagsByName

};

CCHAR	m_PriorityBoost

BYTE	m_CompletionState

BOOLEAN	m_CanComplete

PMDL	m_AllocatedMdl

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Static Protected Attributes
static MdDeferredRoutineType	_TimerDPC

Private Attributes
friend	FxIoTarget

friend	FxSyncRequest

Additional Inherited Members
Static Protected Member Functions inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Detailed Description

Definition at line 166 of file fxrequestbase.hpp.

Constructor & Destructor Documentation

◆ FxRequestBase()

FxRequestBase::FxRequestBase	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in USHORT	ObjectSize,
		__in_opt MdIrp	Irp,
		__in FxRequestIrpOwnership	Ownership,
		__in FxRequestConstructorCaller	Caller,
		__in FxObjectType	ObjectType = `FxObjectTypeExternal`
	)

protected

Definition at line 32 of file fxrequestbase.cpp.

      : FxNonPagedObject(FX_TYPE_REQUEST, ObjectSize, FxDriverGlobals, ObjectType),
        m_Irp(Irp)
{
    //
    // By default requests cannot be completed except for request associated with
    // IRP allocated from I/O (upper drivers).
    //
    m_CanComplete = FALSE;
 
    //
    // After is all said and done with assigning to m_IrpAllocation value, if
    // m_Irp().GetIrp  == NULL, then m_IrpAllocation can be overridden in
    // ValidateTarget.
    //
    if (Caller == FxRequestConstructorCallerIsDriver) {
        if (Ownership == FxRequestOwnsIrp) {
            //
            // Driver writer gave the irp to the framework but still owns it
            // or there is no irp passed in when the FxRequest was created.
            //
            m_IrpAllocation = REQUEST_ALLOCATED_INTERNAL;
        }
        else {
            //
            // Driver writer gave the irp to the framework but still owns it
            //
            m_IrpAllocation = REQUEST_ALLOCATED_DRIVER;
        }
 
        //
        // Cleanup request's context in Dispose. Please see Dispose below
        // for specific scenario we are trying to fix.  Enable Dispose only if
        // driver is v1.11 or above b/c it may be possible that older driver
        // may have used invalid/bad scenarios similar to this one:
        // - create target object.
        // - create one or more driver created requests parented to the target.
        // - send one or more of these requests to the target (lower stack).
        // - delete the target object while requests are pending.
        // Deleting a target while it has a pending request is a valid
        // operation, what is not valid is for these request to be also
        // parented to the target at the same time.
        // In this scenario if we turn on Dispose, the Dispose callback will
        // be called before the request is completed.
        // Note that if the driver had specified any Cleanup callbacks on
        // these requests, these also are called before the requests are
        // completed.
        //
        if (FxDriverGlobals->IsVersionGreaterThanOrEqualTo(1, 11)) {
            MarkDisposeOverride();
        }
    }
    else if (Ownership == FxRequestOwnsIrp) {
        //
        // The request will own the irp and free it when the request is freed
        //
        m_IrpAllocation = REQUEST_ALLOCATED_INTERNAL;
    }
    else {
        //
        // Request is owned by the io queue
        //
        m_IrpAllocation = REQUEST_ALLOCATED_FROM_IO;
        m_CanComplete = TRUE;
    }
 
    m_Target = NULL;
    m_TargetFlags = 0;
 
    m_TargetCompletionContext = NULL;
 
    m_Completed = m_Irp.GetIrp() ? FALSE : TRUE;
    m_Canceled = FALSE;
 
    m_PriorityBoost = 0;
 
    m_RequestContext = NULL;
    m_Timer = NULL;
 
    InitializeListHead(&m_ListEntry);
    m_DrainSingleEntry.Next = NULL;
 
    m_IrpReferenceCount = 0;
 
    m_IrpQueue = NULL;
 
    m_SystemBufferOffset = 0;
    m_OutputBufferOffset = 0;
    m_IrpCompletionReferenceCount = 0;
 
    m_AllocatedMdl = NULL;
 
    m_VerifierFlags = 0;
    m_RequestBaseFlags = 0;
    m_RequestBaseStaticFlags = 0x0;
    m_CompletionState = FxRequestCompletionStateNone;
}

◆ ~FxRequestBase()

FxRequestBase::~FxRequestBase ( VOID )

protectedvirtual

Definition at line 136 of file fxrequestbase.cpp.

{
    MdIrp irp;
 
    //
    // Since m_ListEntry is a union with the CSQ context and the irp have just
    // come off of a CSQ, we cannot be guaranteed that the m_ListEntry is
    // initialized to point to itself.
    //
    // ASSERT(IsListEmpty(&m_ListEntry));
 
 
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    //
    // If an MDL is associated with the request, free it
    //
    if (m_AllocatedMdl != NULL) {
        FxMdlFree(GetDriverGlobals(), m_AllocatedMdl);
    }
#endif
 
    irp = m_Irp.GetIrp();
 
    //
    // If the request was created through WdfRequestCreate, formatted, and not
    // reused, we can still have a request context.
    //
    if (m_RequestContext != NULL) {
        if (irp != NULL) {
            m_RequestContext->ReleaseAndRestore(this);
        }
 
        delete m_RequestContext;
    }
 
    if (irp != NULL && m_IrpAllocation == REQUEST_ALLOCATED_INTERNAL) {
        m_Irp.FreeIrp();
    }
 
    if (m_Timer != NULL) {
        delete m_Timer;
    }
}

Member Function Documentation

◆ _FromCsqContext()

static __inline FxRequestBase * FxRequestBase::_FromCsqContext ( __in PMdIoCsqIrpContext Context )

inlinestatic

Definition at line 666 of file fxrequestbase.hpp.

    {
        return CONTAINING_RECORD(Context, FxRequestBase, m_CsqContext);
    }

Referenced by FxIoTarget::_RequestCancelled(), and FxIoTarget::DrainPendedRequestsLocked().

◆ _FromDrainEntry()

static __inline FxRequestBase * FxRequestBase::_FromDrainEntry ( __in PSINGLE_LIST_ENTRY Entry )

inlinestatic

Definition at line 655 of file fxrequestbase.hpp.

    {
        return CONTAINING_RECORD(Entry, FxRequestBase, m_DrainSingleEntry);
    }

Referenced by FxIoTarget::_CancelSentRequests().

◆ _FromListEntry()

static __inline FxRequestBase * FxRequestBase::_FromListEntry ( __in PLIST_ENTRY Entry )

inlinestatic

Definition at line 645 of file fxrequestbase.hpp.

    {
        return CONTAINING_RECORD(Entry, FxRequestBase, m_ListEntry);
    }

Referenced by FxUsbDevice::_CleanupPipesRequests(), FxIoTarget::CompletePendedRequestList(), FxIoTarget::GetSentRequestsListLocked(), FxUsbDevice::Start(), and FxIoTarget::SubmitPendedRequests().

◆ Cancel()

BOOLEAN FxRequestBase::Cancel ( VOID )

Definition at line 534 of file fxrequestbase.cpp.

{
    BOOLEAN result;
 
    DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                        "Request %p", this);
 
    //
    // It is critical to set m_Canceled before we check the reference count.
    // We could be racing with FxIoTarget::SubmitLocked and if this call executes
    // before SubmitLocked, the completion reference count will still be zero.
    // SubmitLocked will check m_Canceled after setting the reference count to
    // one so that it decrement the count back.
    //
    m_Canceled = TRUE;
 
    //
    // If the ref count is zero, the irp has completed already.  This means we
    // cannot safely touch the underlying PIRP because we cannot guarantee it
    // will not be completed from underneath us.
    //
    if (FxInterlockedIncrementGTZero(&m_IrpCompletionReferenceCount) != 0) {
        //
        // Successfully incremented the ref count.  The PIRP will not be completed
        // until the count goes to zero.
        //
        // Cancelling the irp handles all 2 states:
        //
        // 1)  the request is pended in a target.  the target will attempt to
        //     complete the request immediately in the cancellation routine, but
        //     will not be able to because of the added count to the ref count
        //     done above.  The count will move back to zero below and
        //     CompletedCanceledRequest will complete the request
        //
        // 2)  The irp is in flight to the target WDM device.  In which case the
        //     target WDM device should complete the request immediatley.  If
        //     it does not, it becomes the same as the case where the target WDM
        //     device has already pended it and placed a cancellation routine
        //     on the request and the request will (a)synchronously complete
        //
        result = m_Irp.Cancel();
 
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                            "Request %p, PIRP %p, cancel result %d",
                            this, m_Irp.GetIrp(), result);
 
        //
        // If the count goes to zero, the completion routine ran, but deferred
        // completion ownership to this thread since we had the outstanding
        // refeference.
        //
        if (InterlockedDecrement(&m_IrpCompletionReferenceCount) == 0) {
 
            //
            // Since completion ownership was claimed, m_Target will be valid
            // until m_Target->CompleteRequest executes because the target will
            // not delete while there is outstanding I/O.
            //
            ASSERT(m_Target != NULL);
 
            DoTraceLevelMessage(
                GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                "Request %p, PIRP %p, completed synchronously in cancel call, "
                "completing request on target %p", this, m_Irp.GetIrp(), m_Target);
 
            m_Target->CompleteCanceledRequest(this);
        }
    }
    else {
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                            "Could not cancel request %p, already completed", this);
 
        result = FALSE;
    }
 
    return result;
}

Referenced by FxUsbPipeContinuousReader::CancelRepeaters().

◆ CancelTimer()

_Must_inspect_result_ BOOLEAN FxRequestBase::CancelTimer ( VOID )

Definition at line 766 of file fxrequestbase.cpp.

{
    if (m_TargetFlags & FX_REQUEST_TIMER_SET) {
        //
        // If we can successfully cancel the timer, release the reference
        // taken in StartTimer and mark the timer as not queued.
        //
 
        if (m_Timer->Timer.Stop() == FALSE) {
 
            DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                                "Request %p, did not cancel timer", this);
 
            //
            // Leave FX_REQUEST_TIMER_SET set.  The timer DPC will clear the it
            //
 
            return FALSE;
        }
 
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                            "Request %p, canceled timer successfully", this);
 
        m_TargetFlags &= ~FX_REQUEST_TIMER_SET;
    }
 
    return TRUE;
}

Referenced by FxIoTarget::DrainPendedRequestsLocked().

◆ CanComplete()

__inline BOOLEAN FxRequestBase::CanComplete ( VOID )

inline

Definition at line 334 of file fxrequestbase.hpp.

    {
        LONG count;
        count = InterlockedDecrement(&m_IrpCompletionReferenceCount);
        ASSERT(count >= 0);
        return count == 0 ? TRUE : FALSE;
    }

Referenced by FxIoTarget::DrainPendedRequestsLocked().

◆ ClearCompletionContext()

WDFCONTEXT FxRequestBase::ClearCompletionContext ( VOID )

inline

Definition at line 198 of file fxrequestbase.hpp.

    {
        WDFCONTEXT pContext;
 
        pContext = m_TargetCompletionContext;
        m_TargetCompletionContext = NULL;
 
        return pContext;
    }

Referenced by CompleteSubmitted(), and CompleteSubmittedNoContext().

◆ ClearCompletionRoutine()

PFN_WDF_REQUEST_COMPLETION_ROUTINE FxRequestBase::ClearCompletionRoutine ( VOID )

inline

Definition at line 185 of file fxrequestbase.hpp.

    {
        PFN_WDF_REQUEST_COMPLETION_ROUTINE pRoutine;
 
        pRoutine = m_CompletionRoutine.m_Completion;
        m_CompletionRoutine.m_Completion = NULL;
 
        return pRoutine;
    }

Referenced by CompleteSubmitted(), and CompleteSubmittedNoContext().

◆ ClearFieldsForReuse()

VOID FxRequestBase::ClearFieldsForReuse ( VOID )

Definition at line 260 of file fxrequestbase.cpp.

{
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    if (m_AllocatedMdl != NULL) {
        FxMdlFree(GetDriverGlobals(), m_AllocatedMdl);
        m_AllocatedMdl = NULL;
    }
#endif
 
    m_RequestBaseFlags = 0;
    m_RequestBaseStaticFlags = 0x0;
    m_VerifierFlags = 0;
    m_Canceled = FALSE;
 
    SetCompleted(FALSE);
    SetPriorityBoost(0);
 
    m_NextStackLocationFormatted = FALSE;
 
    if (m_Timer != NULL) {
        delete m_Timer;
        m_Timer = NULL;
    }
 
    m_Target = NULL;
    m_TargetFlags = 0;
    m_TargetCompletionContext = NULL;
 
    InitializeListHead(&m_ListEntry);
 
    m_DrainSingleEntry.Next = NULL;
    m_IrpCompletionReferenceCount = 0;
    m_CompletionState = FxRequestCompletionStateNone;
}

Referenced by FxRequest::ClearFieldsForReuse().

◆ ClearTargetFlags()

__inline ULONG FxRequestBase::ClearTargetFlags ( __in UCHAR Flags )

inline

Definition at line 395 of file fxrequestbase.hpp.

    {
        ULONG oldFlags;
 
        oldFlags = m_TargetFlags;
 
        // Assumes caller is holding appropriate lock
        m_TargetFlags &= ~Flags;
 
        return oldFlags;
    }

Referenced by FxIoTarget::_RequestCancelled(), and FxIoTarget::DrainPendedRequestsLocked().

◆ ClearVerifierFlags()

__inline VOID FxRequestBase::ClearVerifierFlags ( __in SHORT Flags )

inline

Definition at line 479 of file fxrequestbase.hpp.

    {
        KIRQL irql;
 
        ASSERT(GetDriverGlobals()->FxVerifierOn);
 
        Lock(&irql);
        ClearVerifierFlagsLocked(Flags);
        Unlock(irql);
    }

Referenced by FxIoQueue::DispatchRequestToDriver(), FxIoQueue::RequestCancelable(), FxRequest::Reuse(), and VerifierClearFormatted().

◆ ClearVerifierFlagsLocked()

__inline VOID FxRequestBase::ClearVerifierFlagsLocked ( __in SHORT Flags )

inline

Definition at line 470 of file fxrequestbase.hpp.

    {
        m_VerifierFlags &= ~Flags;
    }

Referenced by ClearVerifierFlags().

◆ CompleteSubmitted()

VOID FxRequestBase::CompleteSubmitted ( VOID )

Definition at line 454 of file fxrequestbase.cpp.

{
    FxIoTarget* pTarget;
 
    pTarget = m_Target;
 
    FX_TRACK_DRIVER(GetDriverGlobals());
 
    if (GetDriverGlobals()->FxVerifierOn) {
        //
        // Zero out any values previous driver may have set; when completing the irp
        // through FxRequest::CompleteInternal, we check to see what the lastest
        // package was (stored off in the DriverContext).  Since the request was
        // sent off to another devobj, don't assume any valid values in the
        // DriverContext anymore.
        //
        ZeroOutDriverContext();
 
        //
        // ClearFormatted also checks for WdfVefiefierOn, but that's OK
        //
        VerifierClearFormatted();
    }
 
    if (m_RequestContext != NULL) {
        //
        // Always do the copy because the driver can retrieve the parameters
        // later even if there is no completion routine set.
        //
        GetSubmitFxIrp()->CopyStatus(
                    &m_RequestContext->m_CompletionParams.IoStatus
                    );
 
        m_RequestContext->CopyParameters(this);
 
        //
        // Call the completion routine if present.  Once we call the completion
        // routine we can't touch any fields anymore since the request may be resent
        // down the stack.
        //
        if (m_CompletionRoutine.m_Completion != NULL) {
            ClearCompletionRoutine()(GetHandle(),
                                     pTarget->GetHandle(),
                                     &m_RequestContext->m_CompletionParams,
                                     ClearCompletionContext());
        }
    }
    else if (m_CompletionRoutine.m_Completion != NULL) {
        //
        // Only put a completion parameters struct on the stack if we have to.
        // By putting it into a separate function, we can control stack usage
        // in this way.
        //
        CompleteSubmittedNoContext();
    }
 
    //
    // Release the tag that was acquired when the request was submitted or
    // pended.
    //
    RELEASE(pTarget);
}

◆ CompleteSubmittedNoContext()

VOID FxRequestBase::CompleteSubmittedNoContext ( VOID )

protected

Definition at line 416 of file fxrequestbase.cpp.

{
    WDF_REQUEST_COMPLETION_PARAMS params;
 
    params.Type = WdfRequestTypeNoFormat;
 
    GetSubmitFxIrp()->CopyStatus(&params.IoStatus);
 
    RtlZeroMemory(&params.Parameters, sizeof(params.Parameters));
 
 
    //
    // Once we call the completion routine we can't touch any fields anymore
    // since the request may be resent down the stack.
    //
    ClearCompletionRoutine()(GetHandle(),
                             m_Target->GetHandle(),
                             &params,
                             ClearCompletionContext());
}

Referenced by CompleteSubmitted().

◆ ContextReleaseAndRestore()

VOID FxRequestBase::ContextReleaseAndRestore ( VOID )

inline

Definition at line 264 of file fxrequestbase.hpp.

    {
        //
        // This does not free the context, rather it tells the context to release
        // any references it is holding and restore fields back into the PIRP
        //
        if (m_RequestContext != NULL && m_Irp.GetIrp() != NULL) {
            m_RequestContext->ReleaseAndRestore(this);
            VerifierClearFormatted();
        }
    }

Referenced by ValidateTarget().

◆ CreateTimer()

_Must_inspect_result_ NTSTATUS FxRequestBase::CreateTimer ( VOID )

Definition at line 674 of file fxrequestbase.cpp.

{
    FxRequestTimer* pTimer;
    PVOID pResult;
    NTSTATUS status;
 
    PFX_DRIVER_GLOBALS FxDriverGlobals = GetDriverGlobals();
 
    if (m_Timer != NULL) {
        return STATUS_SUCCESS;
    }
 
 
 
 
 
    pTimer = new (FxDriverGlobals) FxRequestTimer();
 
    if(pTimer == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    status = pTimer->Timer.Initialize(this, _TimerDPC, 0);
    if(!NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "Failed to initialize timer for request %p", this);
        delete pTimer;
        return status;
    }
 
    pResult = InterlockedCompareExchangePointer((PVOID*)&m_Timer, pTimer, NULL);
 
    if (pResult != NULL) {
        //
        // Another value was set before we could set it, free our timer now
        //
        delete pTimer;
    }
 
    return STATUS_SUCCESS;
}

◆ Dispose()

BOOLEAN FxRequestBase::Dispose ( VOID )

protectedvirtual

Reimplemented from FxObject.

Definition at line 206 of file fxrequestbase.cpp.

{
    //
    // Make sure request is not in use.
    //
    VerifyDispose(GetDriverGlobals());
 
    //
    // Now call Cleanup on any handle context's exposed
    // to the device driver.
    //
    CallCleanup();
 
    //
    // Call the request's cleanup (~dtor or Dispose).
    //
    if (m_RequestContext != NULL) {
        if (IsAllocatedFromIo() == FALSE && m_Irp.GetIrp() != NULL) {
            //
            // This code allows the following scenario to work correctly b/c
            // the original request can be completed without worrying that the
            // new request's context has references on the original request.
            //
            // * Driver receives an ioctl request.
            // * Driver creates a new request.
            // * Driver formats the new request with buffers from original ioctl.
            // * Driver sends the new request synchronously.
            // * Driver retrieves info/status from the new request.
            // * Driver deletes the new request.
            // * Driver completes the original request.
            //
            m_RequestContext->ReleaseAndRestore(this);
 
            //
            // ~dtor cleans up everything. No need to call its Dispose method.
            //
            delete m_RequestContext;
            m_RequestContext = NULL;
        }
        else {
            //
            // Let request's context know that Dispose is in progress.
            // RequestContext may receive the following two calls after Dispose:
            //      . ReleaseAndRestore if an IRP is still present.
            //      . Destructor
            //
            m_RequestContext->Dispose();
        }
    }
 
    return FALSE;
}

◆ EnableContextDisposeNotification()

__inline VOID FxRequestBase::EnableContextDisposeNotification ( VOID )

inline

Definition at line 280 of file fxrequestbase.hpp.

    {
        MarkDisposeOverride();
    }

◆ FatalError()

DECLSPEC_NORETURN VOID FxRequestBase::FatalError ( __in NTSTATUS Status )

Definition at line 816 of file fxrequestbase.cpp.

{
    WDF_QUEUE_FATAL_ERROR_DATA data;
 
    RtlZeroMemory(&data, sizeof(data));
 
    data.Queue = NULL;
    data.Request = (WDFREQUEST) GetTraceObjectHandle();
    data.Status = Status;
 
    FxVerifierBugCheck(GetDriverGlobals(),
                       WDF_QUEUE_FATAL_ERROR,
                       (ULONG_PTR) &data);
}

◆ FreeMdls()

VOID __inline FxRequestBase::FreeMdls ( VOID )

Definition at line 31 of file fxrequestbasekm.hpp.

{
    PMDL pMdl, pNext;
 
    if (IsAllocatedFromIo() || IsCanComplete()) {
      return;
    }
 
    pMdl = m_Irp.GetIrp()->MdlAddress;
 
    //
    // Free any PMDLs that the lower layer allocated.  Since we are going
    // to free the PIRP ourself and not call IoCompleteRequest, we must mimic
    // the behavior in IoCompleteRequest which does the same thing.
    //
    while (pMdl != NULL) {
      pNext = pMdl->Next;
 
      if (pMdl->MdlFlags & MDL_PAGES_LOCKED) {
        MmUnlockPages(pMdl);
      }
      else if (GetDriverGlobals()->FxVerifierOn) {
        DbgPrint("pMdl %p, Flags 0x%x in PIRP %p should be locked",
            pMdl, pMdl->MdlFlags, m_Irp.GetIrp());
 
        FxVerifierDbgBreakPoint(GetDriverGlobals());
      }
 
      FxIrpMdlFree(pMdl);
      pMdl = pNext;
    }
 
    m_Irp.GetIrp()->MdlAddress = NULL;
}

◆ FX_DECLARE_VF_FUNCTION()

FxRequestBase::FX_DECLARE_VF_FUNCTION	(	VOID	,
		VerifyDispose
	)

protected

◆ GetContext()

__inline FxRequestContext * FxRequestBase::GetContext ( VOID )

inline

Definition at line 232 of file fxrequestbase.hpp.

    {
        return m_RequestContext;
    }

Referenced by FxUsbPipe::_FormatTransfer(), FxUsbPipeContinuousReader::FormatRepeater(), FxIoTargetFormatIo(), FxIoTargetFormatIoctl(), and if().

◆ GetHandle()

__inline WDFREQUEST FxRequestBase::GetHandle ( VOID )

inline

Definition at line 635 of file fxrequestbase.hpp.

    {
        return (WDFREQUEST) GetObjectHandle();
    }

Referenced by FxIoQueue::AllocateReservedRequest(), FxIoQueue::DispatchRequestToDriver(), FxIoQueue::GetRequest(), if(), FxIoQueue::QueuePurge(), FxIoQueue::QueueRequest(), FxIoQueue::QueueRequestFromForward(), and FxIoQueue::Requeue().

◆ GetPriorityBoost()

CCHAR __inline FxRequestBase::GetPriorityBoost ( VOID )

inline

Definition at line 613 of file fxrequestbase.hpp.

    {
        return m_PriorityBoost;
    }

Referenced by FxRequest::CompleteInternal(), and FxRequest::Release().

◆ GetSubmitFxIrp()

__inline FxIrp * FxRequestBase::GetSubmitFxIrp ( VOID )

inline

Definition at line 319 of file fxrequestbase.hpp.

    {
        return &m_Irp;
    }

Referenced by CompleteSubmitted(), CompleteSubmittedNoContext(), FxRequest::CopyCurrentIrpStackLocationToNext(), FxIoTarget::DrainPendedRequestsLocked(), FxUsbPipeContinuousReader::FxUsbPipeRequestWorkItemHandler(), FxRequest::SetImpersonationFlags(), and ZeroOutDriverContext().

◆ GetSubmitIrp()

__inline MdIrp FxRequestBase::GetSubmitIrp ( VOID )

inline

Definition at line 310 of file fxrequestbase.hpp.

    {
        return m_Irp.GetIrp();
    }

Referenced by __drv_functionClass(), FxUsbPipeContinuousReader::Config(), and ValidateTarget().

◆ GetTarget()

__inline FxIoTarget * FxRequestBase::GetTarget ( VOID )

inline

Definition at line 357 of file fxrequestbase.hpp.

    {
        return m_Target;
    }

Referenced by FxUsbDevice::_CleanupPipesRequests(), FxRequest::Reuse(), and FxUsbDevice::Start().

◆ GetTargetFlags()

__inline UCHAR FxRequestBase::GetTargetFlags ( VOID )

inline

Definition at line 375 of file fxrequestbase.hpp.

    {
        // Assumes caller is holding appropriate lock
        return m_TargetFlags;
    }

Referenced by FxIoTarget::_RequestCancelled(), and FxIoTarget::DrainPendedRequestsLocked().

◆ GetTraceObjectHandle()

__inline PVOID FxRequestBase::GetTraceObjectHandle ( VOID )

inline

Definition at line 675 of file fxrequestbase.hpp.

    {
        PVOID handle;
 
        handle = GetObjectHandle();
 
        if (handle != NULL) {
            return handle;
        }
        else {
            return (PVOID) this;
        }
    }

Referenced by FxIoTarget::_RequestCancelled(), FxIoTarget::DrainPendedRequestsLocked(), FatalError(), FxRequest::Reuse(), and ValidateTarget().

◆ GetVerifierFlags()

__inline SHORT FxRequestBase::GetVerifierFlags ( VOID )

inline

Definition at line 430 of file fxrequestbase.hpp.

    {
        SHORT flags;
        KIRQL irql;
 
        Lock(&irql);
        flags =  GetVerifierFlagsLocked();
        Unlock(irql);
 
        return flags;
    }

Referenced by FxIoQueue::DispatchRequestToDriver(), and VerifierIsFormatted().

◆ GetVerifierFlagsLocked()

SHORT FxRequestBase::GetVerifierFlagsLocked ( VOID )

inline

Definition at line 420 of file fxrequestbase.hpp.

    {
        ASSERT(GetDriverGlobals()->FxVerifierOn);
        return m_VerifierFlags;
    }

Referenced by GetVerifierFlags(), and FxRequest::Reuse().

◆ HasContext()

__inline BOOLEAN FxRequestBase::HasContext ( VOID )

inline

Definition at line 299 of file fxrequestbase.hpp.

    {
        return (m_RequestContext != NULL &&
                m_RequestContext->m_RequestType !=
                    FX_REQUEST_CONTEXT_TYPE_NONE) ? TRUE : FALSE;
    }

Referenced by FxPkgIo::EnqueueRequest(), and FxRequest::PreProcessSendAndForget().

◆ HasContextType()

__inline BOOLEAN FxRequestBase::HasContextType ( __in FX_REQUEST_CONTEXT_TYPE Type )

inline

Definition at line 289 of file fxrequestbase.hpp.

    {
        return (m_RequestContext != NULL &&
                m_RequestContext->m_RequestType == Type) ? TRUE : FALSE;
    }

◆ IsAllocatedDriver()

BOOLEAN __inline FxRequestBase::IsAllocatedDriver ( VOID )

inline

Definition at line 577 of file fxrequestbase.hpp.

    {
        return m_IrpAllocation == REQUEST_ALLOCATED_DRIVER ? TRUE : FALSE;
    }

Referenced by FxRequest::GetFileObject().

◆ IsAllocatedFromIo()

BOOLEAN __inline FxRequestBase::IsAllocatedFromIo ( VOID )

inline

Definition at line 568 of file fxrequestbase.hpp.

    {
        return m_IrpAllocation == REQUEST_ALLOCATED_FROM_IO ? TRUE : FALSE;
    }

Referenced by FxRequest::CompleteInternal(), Dispose(), FreeMdls(), FxIoQueue::QueueRequestFromForward(), and FxRequest::Release().

◆ IsCancelRoutineSet()

__inline BOOLEAN FxRequestBase::IsCancelRoutineSet ( VOID )

inline

Definition at line 222 of file fxrequestbase.hpp.

    {
        return (m_CancelRoutine.m_Cancel != NULL) ?
                    TRUE : FALSE;
    }

Referenced by FxRequest::CompleteInternal().

◆ IsCanComplete()

BOOLEAN __inline FxRequestBase::IsCanComplete ( VOID )

inline

Definition at line 586 of file fxrequestbase.hpp.

    {
        return m_CanComplete;
    }

Referenced by FxRequest::CompleteInternal(), FreeMdls(), and FxRequest::Release().

◆ IsCompletionRoutineSet()

__inline BOOLEAN FxRequestBase::IsCompletionRoutineSet ( VOID )

inline

Definition at line 212 of file fxrequestbase.hpp.

    {
        return (m_CompletionRoutine.m_Completion != NULL) ?
                    TRUE : FALSE;
    }

◆ SetCompleted()

__inline VOID FxRequestBase::SetCompleted ( __in BOOLEAN Value )

inline

Definition at line 595 of file fxrequestbase.hpp.

    {
        m_Completed = Value;
    }

Referenced by FxIoQueue::AllocateReservedRequest(), and ClearFieldsForReuse().

◆ SetCompletionRoutine()

__inline VOID FxRequestBase::SetCompletionRoutine	(	__in_opt PFN_WDF_REQUEST_COMPLETION_ROUTINE	CompletionRoutine = `NULL`,
		__in_opt WDFCONTEXT	CompletionContext = `NULL`
	)

inline

Definition at line 175 of file fxrequestbase.hpp.

    {
        m_CompletionRoutine.m_Completion = CompletionRoutine;
        m_TargetCompletionContext = CompletionContext;
    }

Referenced by FxUsbPipeContinuousReader::FormatRepeater(), and FxRequest::Reuse().

◆ SetContext()

__inline VOID FxRequestBase::SetContext ( __in FxRequestContext * RequestContext = NULL )

inline

Definition at line 241 of file fxrequestbase.hpp.

    {
        //
        // If we are setting to the same value, just return
        //
        if (m_RequestContext == RequestContext) {
            return;
        }
 
        //
        // If we are changing the context to another unique pointer, free the
        // old context.
        //
        if (m_RequestContext != NULL) {
            delete m_RequestContext;
        }
 
        m_RequestContext = RequestContext;
    }

◆ SetPriorityBoost()

VOID __inline FxRequestBase::SetPriorityBoost ( CCHAR PriorityBoost )

inline

Definition at line 604 of file fxrequestbase.hpp.

    {
        m_PriorityBoost = PriorityBoost;
    }

Referenced by ClearFieldsForReuse(), FxRequest::Complete(), and FxRequest::CompleteWithPriority().

◆ SetRequestBaseFlags()

__inline VOID FxRequestBase::SetRequestBaseFlags ( __in UCHAR Flags )

inline

Definition at line 411 of file fxrequestbase.hpp.

    {
        // Assumes caller is holding appropriate lock
        m_RequestBaseFlags|= Flags;
    }

◆ SetSubmitIrp()

MdIrp FxRequestBase::SetSubmitIrp	(	__in_opt MdIrp	NewIrp,
		__in BOOLEAN	FreeIrp = `TRUE`
	)

Definition at line 382 of file fxrequestbase.cpp.

{
    MdIrp pOldIrp, pIrpToFree;
 
    pIrpToFree = NULL;
    pOldIrp = m_Irp.SetIrp(NewIrp);
 
    if (NewIrp != NULL) {
        m_Completed = FALSE;
    }
 
    //
    // If there is a previous irp that is not the current value and we
    // allocated it ourselves and the caller wants us to free it, do so.
    //
    if (pOldIrp != NULL &&
        pOldIrp != NewIrp &&
        m_IrpAllocation == REQUEST_ALLOCATED_INTERNAL) {
        if (FreeIrp) {
            FxIrp oldIrp(pOldIrp);
            oldIrp.FreeIrp();
        }
        else {
            pIrpToFree = pOldIrp;
        }
    }
 
    return pIrpToFree;
}

Referenced by FxRequest::_Create(), and ValidateTarget().

◆ SetTarget()

VOID __inline FxRequestBase::SetTarget ( __in FxIoTarget * Target )

inline

Definition at line 366 of file fxrequestbase.hpp.

    {
        m_Target = Target;
    }

Referenced by FxUsbPipe::GotoStartState().

◆ SetTargetFlags()

__inline VOID FxRequestBase::SetTargetFlags ( __in UCHAR Flags )

inline

Definition at line 385 of file fxrequestbase.hpp.

    {
        // Assumes caller is holding appropriate lock
        m_TargetFlags |= Flags;
    }

Referenced by FxIoTarget::DrainPendedRequestsLocked().

◆ SetVerifierFlags()

__inline VOID FxRequestBase::SetVerifierFlags ( __in SHORT Flags )

inline

Definition at line 455 of file fxrequestbase.hpp.

    {
        KIRQL irql;
 
        ASSERT(GetDriverGlobals()->FxVerifierOn);
 
        Lock(&irql);
        SetVerifierFlagsLocked(Flags);
        Unlock(irql);
    }

Referenced by FxIoQueue::DispatchRequestToDriver(), FxIoQueue::PeekRequest(), FxIoQueue::RequestCancelable(), FxRequest::Reuse(), and VerifierSetFormatted().

◆ SetVerifierFlagsLocked()

__inline VOID FxRequestBase::SetVerifierFlagsLocked ( __in SHORT Flags )

inline

Definition at line 446 of file fxrequestbase.hpp.

    {
        m_VerifierFlags |= Flags;
    }

Referenced by SetVerifierFlags().

◆ ShouldClearContext()

__inline BOOLEAN FxRequestBase::ShouldClearContext ( VOID )

inline

Definition at line 536 of file fxrequestbase.hpp.

    {
        return (m_RequestBaseFlags & FxRequestBaseSyncCleanupContext) ? TRUE
                                                                      : FALSE;
    }

◆ StartTimer()

VOID FxRequestBase::StartTimer ( __in LONGLONG Timeout )

Definition at line 736 of file fxrequestbase.cpp.

{
    LARGE_INTEGER timeout;
    timeout.QuadPart = Timeout;
 
    m_TargetFlags |= FX_REQUEST_TIMER_SET;
 
    m_Timer->Timer.Start(timeout);
 
}

◆ ValidateTarget()

_Must_inspect_result_ NTSTATUS FxRequestBase::ValidateTarget ( __in FxIoTarget * Target )

Definition at line 299 of file fxrequestbase.cpp.

{
    MdIrp pIrp, pOldIrp;
    FxIrp fxIrp;
    NTSTATUS status;
 
    pOldIrp = NULL;
 
    pIrp = GetSubmitIrp();
    fxIrp.SetIrp(pIrp);
 
    //
    // Must restore to the previous irp in case we reallocate the irp
    //
    ContextReleaseAndRestore();
 
    if (Target->HasValidStackSize() == FALSE) {
 
        //
        // Target is closed down
        //
        status = STATUS_INVALID_DEVICE_STATE;
 
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "WDFIOTARGET %p is closed, cannot validate, %!STATUS!",
                            Target->GetHandle(), status);
    }
    else if (pIrp != NULL && Target->HasEnoughStackLocations(&fxIrp)) {
        status = STATUS_SUCCESS;
    }
    else if (pIrp == NULL || m_IrpAllocation == REQUEST_ALLOCATED_INTERNAL) {
        //
        // Try to allocate a new irp.
        //
        pIrp = FxIrp::AllocateIrp(Target->m_TargetStackSize, Target->GetDevice());
 
        if (pIrp == NULL) {
            status = STATUS_INSUFFICIENT_RESOURCES;
            DoTraceLevelMessage(
                GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "Could not allocate irp for WDFREQUEST %p for WDFIOTARGET %p,"
                " %!STATUS!", GetTraceObjectHandle(), Target->GetHandle(), status);
        }
        else {
            pOldIrp = SetSubmitIrp(pIrp, FALSE);
            m_IrpAllocation = REQUEST_ALLOCATED_INTERNAL;
            status = STATUS_SUCCESS;
        }
    }
    else {
        //
        // The internal IRP is not owned by this object, so we can't reallocate
        // it.
        //
 
 
 
 
 
 
 
        status = STATUS_REQUEST_NOT_ACCEPTED;
 
        DoTraceLevelMessage(
            GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "Cannot reallocate PIRP for WDFREQUEST %p using WDFIOTARGET %p,"
            " %!STATUS!", GetTraceObjectHandle(), Target->GetHandle(), status);
    }
 
    if (pOldIrp != NULL) {
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGIO,
                            "Freeing irp %p from WDFREQUEST %p\n",
                             pOldIrp, GetTraceObjectHandle());
        FxIrp oldIrp(pOldIrp);
        oldIrp.FreeIrp();
    }
 
    return status;
}

Referenced by FxRequest::_Create().

◆ VerifierClearFormatted()

__inline VOID FxRequestBase::VerifierClearFormatted ( VOID )

inline

Definition at line 506 of file fxrequestbase.hpp.

    {
        if (GetDriverGlobals()->FxVerifierOn &&
            GetDriverGlobals()->FxVerifierIO) {
            ClearVerifierFlags(FXREQUEST_FLAG_FORMATTED);
        }
    }

Referenced by CompleteSubmitted(), and ContextReleaseAndRestore().

◆ VerifierIsFormatted()

__inline BOOLEAN FxRequestBase::VerifierIsFormatted ( VOID )

inline

Definition at line 518 of file fxrequestbase.hpp.

    {
        if (GetDriverGlobals()->FxVerifierOn &&
            GetDriverGlobals()->FxVerifierIO) {
            return (GetVerifierFlags() & FXREQUEST_FLAG_FORMATTED) ? TRUE : FALSE;
        }
        else {
            //
            // we are not tracking the state
            //
            return TRUE;
        }
    }

◆ VerifierSetFormatted()

__inline VOID FxRequestBase::VerifierSetFormatted ( VOID )

inline

Definition at line 494 of file fxrequestbase.hpp.

    {
        if (GetDriverGlobals()->FxVerifierOn &&
            GetDriverGlobals()->FxVerifierIO) {
            SetVerifierFlags(FXREQUEST_FLAG_FORMATTED);
        }
    }

◆ ZeroOutDriverContext()

VOID FxRequestBase::ZeroOutDriverContext ( VOID )

inlineprotected

Definition at line 744 of file fxrequestbase.hpp.

    {
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    RtlZeroMemory(GetSubmitFxIrp()->GetDriverContext(),
                  GetSubmitFxIrp()->GetDriverContextSize());
#else
    //
    // UMDF host doesn't expose any easier way to zero out the contexts so
    // set context to NULL one by one.
    //
    GetSubmitFxIrp()->SetContext(0, NULL);
    GetSubmitFxIrp()->SetContext(1, NULL);
    GetSubmitFxIrp()->SetContext(2, NULL);
    GetSubmitFxIrp()->SetContext(3, NULL);
#endif
    }

Referenced by CompleteSubmitted().

Member Data Documentation

◆

union { ... } FxRequestBase::@4591

◆

union { ... } FxRequestBase::@4593

◆

union { ... } FxRequestBase::@4595

◆

union { ... } FxRequestBase::@4597

◆

union { ... } FxRequestBase::@4599

◆

union { ... } FxRequestBase::@4601

◆ _TimerDPC

VOID FxRequestBase::_TimerDPC

staticprotected

Definition at line 736 of file fxrequestbase.hpp.

Referenced by CreateTimer().

◆ Cancelled

SHORT FxRequestBase::Cancelled

Definition at line 889 of file fxrequestbase.hpp.

◆ CancelledFromTimer

UCHAR FxRequestBase::CancelledFromTimer

Definition at line 858 of file fxrequestbase.hpp.

◆ Completed

UCHAR FxRequestBase::Completed

Definition at line 855 of file fxrequestbase.hpp.

◆ DriverCancelable

SHORT FxRequestBase::DriverCancelable

Definition at line 887 of file fxrequestbase.hpp.

◆ DriverDispatch

SHORT FxRequestBase::DriverDispatch

Definition at line 886 of file fxrequestbase.hpp.

◆ DriverInEvtIoStopContext

SHORT FxRequestBase::DriverInEvtIoStopContext

Definition at line 892 of file fxrequestbase.hpp.

◆ DriverInprocessContext

SHORT FxRequestBase::DriverInprocessContext

Definition at line 888 of file fxrequestbase.hpp.

◆ DriverOwned

SHORT FxRequestBase::DriverOwned

Definition at line 883 of file fxrequestbase.hpp.

◆ FlagsPended

UCHAR FxRequestBase::FlagsPended

Definition at line 856 of file fxrequestbase.hpp.

◆ Formatted

SHORT FxRequestBase::Formatted

Definition at line 890 of file fxrequestbase.hpp.

◆ Forwarded

SHORT FxRequestBase::Forwarded

Definition at line 885 of file fxrequestbase.hpp.

◆ FxIoTarget

friend FxRequestBase::FxIoTarget

private

Definition at line 168 of file fxrequestbase.hpp.

◆ FxSyncRequest

friend FxRequestBase::FxSyncRequest

private

Definition at line 169 of file fxrequestbase.hpp.

◆ IgnoreState

UCHAR FxRequestBase::IgnoreState

Definition at line 859 of file fxrequestbase.hpp.

◆ m_AllocatedMdl

PMDL FxRequestBase::m_AllocatedMdl

protected

Definition at line 952 of file fxrequestbase.hpp.

Referenced by ClearFieldsForReuse(), FxRequestBase(), FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetMdl(), and ~FxRequestBase().

◆ m_Canceled

BOOLEAN FxRequestBase::m_Canceled

protected

Definition at line 871 of file fxrequestbase.hpp.

Referenced by Cancel(), ClearFieldsForReuse(), FxRequestBase(), FxRequest::IsCancelled(), FxIoQueue::QueuePurge(), FxIoQueue::RequestCancelable(), and FxRequest::Reuse().

◆ m_CancelRoutine

FxRequestCancelCallback FxRequestBase::m_CancelRoutine

protected

Definition at line 828 of file fxrequestbase.hpp.

Referenced by IsCancelRoutineSet(), and FxIoQueue::RequestCancelable().

◆ m_CanComplete

BOOLEAN FxRequestBase::m_CanComplete

protected

Definition at line 947 of file fxrequestbase.hpp.

Referenced by FxRequestBase(), FxRequest::GetFileObject(), IsCanComplete(), and FxRequest::Reuse().

◆ m_Completed

BOOLEAN FxRequestBase::m_Completed

protected

Definition at line 869 of file fxrequestbase.hpp.

Referenced by FxRequest::CompleteInternal(), FxRequestBase(), FxRequest::GetCurrentQueue(), FxRequest::InsertHeadIrpQueue(), FxRequest::InsertTailIrpQueue(), FxRequest::PostProcessSendAndForget(), FxRequest::Release(), FxRequest::Reuse(), SetCompleted(), FxRequest::SetCompletionState(), and SetSubmitIrp().

◆ m_CompletionRoutine

FxRequestCompletionCallback FxRequestBase::m_CompletionRoutine

protected

Definition at line 830 of file fxrequestbase.hpp.

Referenced by ClearCompletionRoutine(), CompleteSubmitted(), IsCompletionRoutineSet(), and SetCompletionRoutine().

◆ m_CompletionState

BYTE FxRequestBase::m_CompletionState

protected

Definition at line 942 of file fxrequestbase.hpp.

Referenced by ClearFieldsForReuse(), FxRequest::CompleteInternal(), FxRequestBase(), FxRequest::PostProcessSendAndForget(), FxRequest::Release(), FxRequest::Reuse(), and FxRequest::SetCompletionState().

◆ m_CsqContext

MdIoCsqIrpContext FxRequestBase::m_CsqContext

Definition at line 770 of file fxrequestbase.hpp.

Referenced by _FromCsqContext(), FxRequest::GetCsqContext(), FxRequest::InsertHeadIrpQueue(), FxRequest::InsertTailIrpQueue(), FxRequest::RemoveFromIrpQueue(), and FxRequest::RetrieveFromCsqContext().

◆ m_DrainSingleEntry

SINGLE_LIST_ENTRY FxRequestBase::m_DrainSingleEntry

Definition at line 785 of file fxrequestbase.hpp.

Referenced by _FromDrainEntry(), ClearFieldsForReuse(), FxRequestBase(), FxIoTarget::GetSentRequestsListLocked(), and FxUsbPipe::GotoStartState().

◆ m_Irp

FxIrp FxRequestBase::m_Irp

protected

Definition at line 806 of file fxrequestbase.hpp.

Referenced by FxRequest::AssignMemoryBuffers(), Cancel(), FxRequest::Complete(), FxRequest::CompleteInternal(), FxRequest::CompleteWithInformation(), FxRequest::CompleteWithPriority(), ContextReleaseAndRestore(), Dispose(), FxIoTarget::DrainPendedRequestsLocked(), FreeMdls(), FxRequestBase(), FxRequest::GetCurrentIrpStackLocation(), FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetFileObject(), FxRequest::GetFxIrp(), FxRequest::GetInformation(), FxRequest::GetIrp(), FxRequest::GetMdl(), FxRequest::GetMemoryObject(), FxRequest::GetParameters(), FxRequest::GetRequestorMode(), FxRequest::GetStatus(), GetSubmitFxIrp(), GetSubmitIrp(), FxRequest::InsertHeadIrpQueue(), FxRequest::InsertTailIrpQueue(), FxRequest::IsCancelled(), FxRequest::PostProcessSendAndForget(), FxRequest::PreProcessSendAndForget(), FxRequest::ProbeAndLockForRead(), FxRequest::ProbeAndLockForWrite(), FxRequest::Release(), FxRequest::Reuse(), FxRequest::SetCompletionState(), FxRequest::SetInformation(), FxRequest::SetStatus(), SetSubmitIrp(), and ~FxRequestBase().

◆ m_IrpAllocation

UCHAR FxRequestBase::m_IrpAllocation

protected

Definition at line 867 of file fxrequestbase.hpp.

Referenced by FxRequestBase(), IsAllocatedDriver(), IsAllocatedFromIo(), FxRequest::Reuse(), SetSubmitIrp(), ValidateTarget(), and ~FxRequestBase().

◆ m_IrpCompletionReferenceCount

LONG FxRequestBase::m_IrpCompletionReferenceCount

protected

Definition at line 840 of file fxrequestbase.hpp.

Referenced by Cancel(), CanComplete(), ClearFieldsForReuse(), and FxRequestBase().

◆ m_IrpQueue

FxIrpQueue* FxRequestBase::m_IrpQueue

protected

Definition at line 903 of file fxrequestbase.hpp.

Referenced by FxRequest::CompleteInternal(), FxRequestBase(), FxRequest::InsertHeadIrpQueue(), FxRequest::InsertTailIrpQueue(), FxRequest::MarkRemovedFromIrpQueue(), and FxRequest::RemoveFromIrpQueue().

◆ m_IrpReferenceCount

LONG FxRequestBase::m_IrpReferenceCount

protected

Definition at line 900 of file fxrequestbase.hpp.

Referenced by FxRequest::AddIrpReference(), FxRequest::CompleteInternal(), FxRequestBase(), and FxRequest::ReleaseIrpReference().

◆ m_ListEntry

LIST_ENTRY FxRequestBase::m_ListEntry

Definition at line 777 of file fxrequestbase.hpp.

Referenced by _FromListEntry(), FxIoTarget::_RequestCancelled(), ClearFieldsForReuse(), FxIoTarget::DrainPendedRequestsLocked(), FxRequestBase(), and FxUsbPipe::GotoStartState().

◆ m_NextStackLocationFormatted

BOOLEAN FxRequestBase::m_NextStackLocationFormatted

Definition at line 795 of file fxrequestbase.hpp.

Referenced by ClearFieldsForReuse(), and FxRequest::PreProcessSendAndForget().

◆ m_OutputBufferOffset

WDFOBJECT_OFFSET_ALIGNED FxRequestBase::m_OutputBufferOffset

protected

Definition at line 905 of file fxrequestbase.hpp.

Referenced by FxRequest::AddRefOverride(), FxRequest::CheckAssumptions(), FxRequest::FxRequest(), FxRequestBase(), FxRequest::QueryInterface(), and FxRequest::ReleaseOverride().

◆ m_PriorityBoost

CCHAR FxRequestBase::m_PriorityBoost

protected

Definition at line 937 of file fxrequestbase.hpp.

Referenced by FxRequestBase(), GetPriorityBoost(), and SetPriorityBoost().

◆ m_RequestBaseFlags

UCHAR FxRequestBase::m_RequestBaseFlags

Definition at line 911 of file fxrequestbase.hpp.

Referenced by ClearFieldsForReuse(), FxRequest::CompleteInternal(), FxRequestBase(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetMemoryObject(), SetRequestBaseFlags(), and ShouldClearContext().

◆

struct { ... } FxRequestBase::m_RequestBaseFlagsByName

◆ m_RequestBaseStaticFlags

UCHAR FxRequestBase::m_RequestBaseStaticFlags

Definition at line 926 of file fxrequestbase.hpp.

Referenced by FxRequest::AssignMemoryBuffers(), ClearFieldsForReuse(), FxRequest::CompleteInternal(), FxRequestBase(), FxRequest::GetDeviceControlOutputMemoryObject(), and FxRequest::GetMemoryObject().

◆

struct { ... } FxRequestBase::m_RequestBaseStaticFlagsByName

◆ m_RequestContext

FxRequestContext* FxRequestBase::m_RequestContext

protected

Definition at line 817 of file fxrequestbase.hpp.

Referenced by FxRequest::CompleteInternal(), CompleteSubmitted(), ContextReleaseAndRestore(), FxRequest::CopyCompletionParams(), Dispose(), FxRequest::FreeRequest(), FxRequestBase(), GetContext(), HasContext(), HasContextType(), FxRequest::Reuse(), SetContext(), and ~FxRequestBase().

◆ m_SystemBufferOffset

WDFOBJECT_OFFSET_ALIGNED FxRequestBase::m_SystemBufferOffset

protected

Definition at line 873 of file fxrequestbase.hpp.

Referenced by FxRequest::AddRefOverride(), FxRequest::CheckAssumptions(), FxRequest::FxRequest(), FxRequestBase(), FxRequest::QueryInterface(), and FxRequest::ReleaseOverride().

◆ m_Target

FxIoTarget* FxRequestBase::m_Target

protected

Definition at line 815 of file fxrequestbase.hpp.

Referenced by Cancel(), ClearFieldsForReuse(), CompleteSubmitted(), CompleteSubmittedNoContext(), FxRequestBase(), GetTarget(), and SetTarget().

◆ m_TargetCompletionContext

WDFCONTEXT FxRequestBase::m_TargetCompletionContext

protected

Definition at line 835 of file fxrequestbase.hpp.

Referenced by ClearCompletionContext(), ClearFieldsForReuse(), FxRequestBase(), and SetCompletionRoutine().

◆ m_TargetFlags

UCHAR FxRequestBase::m_TargetFlags

Definition at line 848 of file fxrequestbase.hpp.

Referenced by CancelTimer(), ClearFieldsForReuse(), ClearTargetFlags(), FxRequestBase(), GetTargetFlags(), SetTargetFlags(), and StartTimer().

◆

struct { ... } FxRequestBase::m_TargetFlagsByName

◆ m_Timer

FxRequestTimer* FxRequestBase::m_Timer

protected

Definition at line 822 of file fxrequestbase.hpp.

Referenced by CancelTimer(), ClearFieldsForReuse(), CreateTimer(), FxRequestBase(), StartTimer(), and ~FxRequestBase().

◆

struct { ... } FxRequestBase::m_VeriferFlagsByName

◆ m_VerifierFlags

SHORT FxRequestBase::m_VerifierFlags

Definition at line 880 of file fxrequestbase.hpp.

Referenced by ClearFieldsForReuse(), ClearVerifierFlagsLocked(), FxRequestBase(), GetVerifierFlagsLocked(), and SetVerifierFlagsLocked().

◆ OutputBufferValid

UCHAR FxRequestBase::OutputBufferValid

Definition at line 930 of file fxrequestbase.hpp.

◆ OutputMdlMapped

UCHAR FxRequestBase::OutputMdlMapped

Definition at line 915 of file fxrequestbase.hpp.

◆ SentToTarget

SHORT FxRequestBase::SentToTarget

Definition at line 891 of file fxrequestbase.hpp.

◆ SyncCleanupContext

UCHAR FxRequestBase::SyncCleanupContext

Definition at line 916 of file fxrequestbase.hpp.

◆ SystemBufferValid

UCHAR FxRequestBase::SystemBufferValid

Definition at line 929 of file fxrequestbase.hpp.

◆ SystemMdlMapped

UCHAR FxRequestBase::SystemMdlMapped

Definition at line 914 of file fxrequestbase.hpp.

◆ TagRequest

SHORT FxRequestBase::TagRequest

Definition at line 884 of file fxrequestbase.hpp.

Referenced by FxRequest::GetNextRequest(), and FxRequest::PeekRequest().

◆ TimerSet

UCHAR FxRequestBase::TimerSet

Definition at line 857 of file fxrequestbase.hpp.

The documentation for this class was generated from the following files:

sdk/lib/drivers/wdf/shared/inc/private/common/fxrequestbase.hpp
sdk/lib/drivers/wdf/shared/core/fxrequestbase.cpp
sdk/lib/drivers/wdf/shared/inc/private/km/fxrequestbasekm.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxRequestBase()

◆ ~FxRequestBase()

Member Function Documentation

◆ _FromCsqContext()

◆ _FromDrainEntry()

◆ _FromListEntry()

◆ Cancel()

◆ CancelTimer()

◆ CanComplete()

◆ ClearCompletionContext()

◆ ClearCompletionRoutine()

◆ ClearFieldsForReuse()

◆ ClearTargetFlags()

◆ ClearVerifierFlags()

◆ ClearVerifierFlagsLocked()

◆ CompleteSubmitted()

◆ CompleteSubmittedNoContext()

◆ ContextReleaseAndRestore()

◆ CreateTimer()

◆ Dispose()

◆ EnableContextDisposeNotification()

◆ FatalError()

◆ FreeMdls()

◆ FX_DECLARE_VF_FUNCTION()

◆ GetContext()

◆ GetHandle()

◆ GetPriorityBoost()

◆ GetSubmitFxIrp()

◆ GetSubmitIrp()

◆ GetTarget()

◆ GetTargetFlags()

◆ GetTraceObjectHandle()

◆ GetVerifierFlags()

◆ GetVerifierFlagsLocked()

◆ HasContext()

◆ HasContextType()

◆ IsAllocatedDriver()

◆ IsAllocatedFromIo()

◆ IsCancelRoutineSet()

◆ IsCanComplete()

◆ IsCompletionRoutineSet()

◆ SetCompleted()

◆ SetCompletionRoutine()

◆ SetContext()

◆ SetPriorityBoost()

◆ SetRequestBaseFlags()

◆ SetSubmitIrp()

◆ SetTarget()

◆ SetTargetFlags()

◆ SetVerifierFlags()

◆ SetVerifierFlagsLocked()

◆ ShouldClearContext()

◆ StartTimer()

◆ ValidateTarget()

◆ VerifierClearFormatted()

◆ VerifierIsFormatted()

◆ VerifierSetFormatted()

◆ ZeroOutDriverContext()

Member Data Documentation

◆ _TimerDPC

◆ Cancelled

◆ CancelledFromTimer

◆ Completed

◆ DriverCancelable

◆ DriverDispatch

◆ DriverInEvtIoStopContext

◆ DriverInprocessContext

◆ DriverOwned

◆ FlagsPended

◆ Formatted