#include <fxrequestmemory.hpp>

Inheritance diagram for FxRequestMemory:

[legend]

Collaboration diagram for FxRequestMemory:

[legend]

Public Member Functions
	FxRequestMemory (__in PFX_DRIVER_GLOBALS Globals)

virtual PVOID	GetBuffer (VOID)

virtual _Must_inspect_result_ PMDL	GetMdl (VOID)

virtual USHORT	GetFlags (VOID)

VOID	SetBuffer (_In_ FxRequest *Request, _Pre_notnull_ _Pre_writable_byte_size_(BufferSize) PVOID Buffer, _In_ PMDL BackingMdl, _In_ size_t BufferSize, _In_ BOOLEAN ReadOnly)

VOID	SetMdl (__in FxRequest *Request, __in PMDL Mdl, __in PVOID MdlBuffer, __in size_t BufferSize, __in BOOLEAN ReadOnly)

_Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)

	~FxRequestMemory (VOID)

Public Member Functions inherited from FxMemoryBufferPreallocated
	FxMemoryBufferPreallocated (_In_ PFX_DRIVER_GLOBALS FxDriverGlobals, _Pre_notnull_ _Pre_writable_byte_size_(BufferSize) PVOID Buffer, _In_ size_t BufferSize)

virtual PVOID	GetBuffer (VOID)

VOID	UpdateBuffer (_Pre_notnull_ _Pre_writable_byte_size_(BufferSize) PVOID Buffer, _In_ size_t BufferSize)

_Must_inspect_result_ NTSTATUS	QueryInterface (__inout FxQueryInterfaceParams *Params)

Public Member Functions inherited from FxMemoryObject
virtual size_t	GetBufferSize (VOID)

virtual PMDL	GetMdl (VOID)

virtual WDFMEMORY	GetHandle (VOID)

virtual PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)

virtual ULONG	AddRef (__in PVOID Tag, __in LONG Line, __in_opt PSTR File)

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

virtual VOID	Delete (VOID)

virtual USHORT	GetFlags (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)

Public Member Functions inherited from IFxMemory
virtual PVOID	GetBuffer (VOID)=0

virtual size_t	GetBufferSize (VOID)=0

virtual PMDL	GetMdl (VOID)=0

virtual WDFMEMORY	GetHandle (VOID)=0

virtual USHORT	GetFlags (VOID)=0

virtual PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)=0

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

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

virtual VOID	Delete (VOID)=0

_Must_inspect_result_ NTSTATUS	ValidateMemoryOffsets (__in_opt PWDFMEMORY_OFFSET Offsets)

_Must_inspect_result_ NTSTATUS	CopyFromPtr (__in_opt PWDFMEMORY_OFFSET DestinationOffsets, __in_bcount(SourceBufferLength) PVOID SourceBuffer, __in size_t SourceBufferLength, __in_opt PWDFMEMORY_OFFSET SourceOffsets)

_Must_inspect_result_ NTSTATUS	CopyToPtr (__in_opt PWDFMEMORY_OFFSET SourceOffsets, __out_bcount(DestinationBufferLength) PVOID DestinationBuffer, __in size_t DestinationBufferLength, __in_opt PWDFMEMORY_OFFSET DestinationOffsets)

virtual PVOID	GetBuffer (VOID)=0

virtual size_t	GetBufferSize (VOID)=0

virtual PMDL	GetMdl (VOID)=0

virtual WDFMEMORY	GetHandle (VOID)=0

virtual USHORT	GetFlags (VOID)=0

virtual PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)=0

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

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

virtual VOID	Delete (VOID)=0

_Must_inspect_result_ NTSTATUS	ValidateMemoryOffsets (__in_opt PWDFMEMORY_OFFSET Offsets)

_Must_inspect_result_ NTSTATUS	CopyFromPtr (__in_opt PWDFMEMORY_OFFSET DestinationOffsets, __in_bcount(SourceBufferLength) PVOID SourceBuffer, __in size_t SourceBufferLength, __in_opt PWDFMEMORY_OFFSET SourceOffsets)

_Must_inspect_result_ NTSTATUS	CopyToPtr (__in_opt PWDFMEMORY_OFFSET SourceOffsets, __out_bcount(DestinationBufferLength) PVOID DestinationBuffer, __in size_t DestinationBufferLength, __in_opt PWDFMEMORY_OFFSET DestinationOffsets)

Static Public Member Functions
static NTSTATUS	Create (__in PFX_DRIVER_GLOBALS DriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out FxRequestMemory **Object)

Static Public Member Functions inherited from FxMemoryObject
static _Must_inspect_result_ NTSTATUS	_Create (__in PFX_DRIVER_GLOBALS DriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in POOL_TYPE PoolType, __in ULONG PoolTag, __in size_t BufferSize, __out FxMemoryObject **Object)

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)

Protected Member Functions
VOID	SetFlags (__in USHORT Flags)

Protected Member Functions inherited from FxMemoryBufferPreallocated
	FxMemoryBufferPreallocated (__in USHORT ObjectSize, __in PFX_DRIVER_GLOBALS Globals)

	FxMemoryBufferPreallocated (_In_ PFX_DRIVER_GLOBALS FxDriverGlobals, _In_ USHORT ObjectSize, _Pre_notnull_ _Pre_writable_byte_size_(BufferSize) PVOID Buffer, _In_ size_t BufferSize)

	~FxMemoryBufferPreallocated ()

Protected Member Functions inherited from FxMemoryObject
	FxMemoryObject (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in size_t BufferSize)

virtual _Must_inspect_result_ NTSTATUS	QueryInterface (__inout FxQueryInterfaceParams *Params)

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
FxRequest *	m_Request

PMDL	m_Mdl

USHORT	m_Flags

Protected Attributes inherited from FxMemoryBufferPreallocated
PVOID	m_pBuffer

Protected Attributes inherited from FxMemoryObject
size_t	m_BufferSize

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

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

Static Protected Member Functions inherited from IFxMemory
static _Must_inspect_result_ NTSTATUS	_CopyPtrToPtr (__in_bcount(SourceBufferLength) PVOID SourceBuffer, __in size_t SourceBufferLength, __in_opt PWDFMEMORY_OFFSET SourceOffsets, __out_bcount(DestinationBufferLength) PVOID DestinationBuffer, __in size_t DestinationBufferLength, __in_opt PWDFMEMORY_OFFSET DestinationOffsets)

static _Must_inspect_result_ NTSTATUS	_CopyPtrToPtr (__in_bcount(SourceBufferLength) PVOID SourceBuffer, __in size_t SourceBufferLength, __in_opt PWDFMEMORY_OFFSET SourceOffsets, __out_bcount(DestinationBufferLength) PVOID DestinationBuffer, __in size_t DestinationBufferLength, __in_opt PWDFMEMORY_OFFSET DestinationOffsets)

Detailed Description

Definition at line 33 of file fxrequestmemory.hpp.

Constructor & Destructor Documentation

◆ FxRequestMemory()

FxRequestMemory::FxRequestMemory ( __in PFX_DRIVER_GLOBALS Globals )

Definition at line 83 of file fxrequestmemory.cpp.

      :
    FxMemoryBufferPreallocated(sizeof(*this), FxDriverGlobals)
/*++
 
Routine Description:
 
    Default constructor for this object.
 
  --*/
{
 
    //
    // Our constructor chain:
    //
    // FxRequestMemory(ObjectSize, PFX_DRIVER_GLOBALS),
    //     : FxMemoryBufferPreallocated(ObjectSize, PFX_DRIVER_GLOBALS),
    //     : FxMemoryObject(PFX_DRIVER_GLOBALS, ObjectSize, ObjectSize),
    //     : FxObject(FX_TYPE_MEMORY, ObjectSize, PFX_DRIVER_GLOBALS)
    //
    m_Request = NULL;
 
    m_Mdl = NULL;
 
    m_Flags = 0;
}

◆ ~FxRequestMemory()

FxRequestMemory::~FxRequestMemory ( VOID )

Definition at line 112 of file fxrequestmemory.cpp.

{
    //
    // Non-embedded case releases resources in the destructor
    // rather than Dispose to ensure all outstanding device driver
    // references are gone.
    //
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    if( m_Mdl != NULL ) {
        Mx::MxUnlockPages(m_Mdl);
        FxMdlFree(GetDriverGlobals(), m_Mdl);
        m_Mdl = NULL;
    }
#endif
 
    if( m_Request != NULL ) {
        m_Request->ReleaseIrpReference();
        m_Request = NULL;
    }
}

Member Function Documentation

◆ Create()

NTSTATUS FxRequestMemory::Create	(	__in PFX_DRIVER_GLOBALS	DriverGlobals,
		__in_opt PWDF_OBJECT_ATTRIBUTES	Attributes,
		__out FxRequestMemory **	Object
	)

static

Definition at line 54 of file fxrequestmemory.cpp.

{
    FxRequestMemory* pMemory;
 
    // Build an FxRequestMemory object now
    pMemory = new(DriverGlobals, Attributes) FxRequestMemory(DriverGlobals);
 
    if (pMemory == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    *Object = pMemory;
 
    return STATUS_SUCCESS;
}

Referenced by FxRequest::ProbeAndLockForRead(), and FxRequest::ProbeAndLockForWrite().

◆ GetBuffer()

PVOID FxRequestMemory::GetBuffer ( VOID )

virtual

Reimplemented from FxMemoryBufferPreallocated.

Definition at line 164 of file fxrequestmemory.cpp.

{
    return m_pBuffer;
}

◆ GetFlags()

virtual USHORT FxRequestMemory::GetFlags ( VOID )

inlinevirtual

Reimplemented from FxMemoryObject.

Definition at line 65 of file fxrequestmemory.hpp.

    {
        return m_Flags;
    }

◆ GetMdl()

_Must_inspect_result_ PMDL FxRequestMemory::GetMdl ( VOID )

virtual

Reimplemented from FxMemoryObject.

Definition at line 187 of file fxrequestmemory.cpp.

{
    return m_Mdl;
}

◆ QueryInterface()

_Must_inspect_result_ NTSTATUS FxRequestMemory::QueryInterface ( __in FxQueryInterfaceParams * Params )

virtual

Reimplemented from FxObject.

Definition at line 150 of file fxrequestmemory.cpp.

{
    if (Params->Type == FX_TYPE_REQUEST_MEMORY) {
        *Params->Object = (FxRequestMemory*) this;
        return STATUS_SUCCESS;
    }
    else {
        return FxMemoryBufferPreallocated::QueryInterface(Params); // __super call
    }
}

◆ SetBuffer()

VOID FxRequestMemory::SetBuffer	(	_In_ FxRequest *	Request,
		_Pre_notnull_ _Pre_writable_byte_size_(BufferSize) PVOID	Buffer,
		_In_ PMDL	BackingMdl,
		_In_ size_t	BufferSize,
		_In_ BOOLEAN	ReadOnly
	)

Definition at line 207 of file fxrequestmemory.cpp.

{
    ASSERT(m_pBuffer == NULL);
    ASSERT(m_Request == NULL);
    ASSERT(m_Mdl == NULL);
 
    ASSERT(Request != NULL);
 
    m_pBuffer = Buffer;
    m_Mdl = BackingMdl;
    m_BufferSize = BufferSize;
 
    m_Request = Request;
 
    //
    // A single FxRequest IRP reference
    // is outstanding until destroy
    //
    m_Request->AddIrpReference();
 
    // Set access checking if its a readonly buffer
    if (ReadOnly) {
        SetFlags(IFxMemoryFlagReadOnly);
    }
}

◆ SetFlags()

VOID FxRequestMemory::SetFlags ( __in USHORT Flags )

inlineprotected

Definition at line 103 of file fxrequestmemory.hpp.

    {
        m_Flags = Flags;
    }

Referenced by SetBuffer(), and SetMdl().

◆ SetMdl()

VOID FxRequestMemory::SetMdl	(	__in FxRequest *	Request,
		__in PMDL	Mdl,
		__in PVOID	MdlBuffer,
		__in size_t	BufferSize,
		__in BOOLEAN	ReadOnly
	)

Definition at line 262 of file fxrequestmemory.cpp.

{
 
    ASSERT(m_pBuffer == NULL);
    ASSERT(m_Mdl == NULL);
    ASSERT(m_Request == NULL);
    ASSERT(Request != NULL);
 
    m_Mdl = Mdl;
    m_pBuffer = MdlBuffer;
    m_BufferSize = BufferSize;
 
    m_Request = Request;
 
    //
    // A single FxRequest IRP reference is outstanding until destroy
    //
    m_Request->AddIrpReference();
 
    // Set access checking if it's a readonly buffer
    if (ReadOnly) {
        SetFlags(IFxMemoryFlagReadOnly);
    }
 
    return;
}

Member Data Documentation

◆ m_Flags

USHORT FxRequestMemory::m_Flags

protected

Definition at line 119 of file fxrequestmemory.hpp.

Referenced by FxRequestMemory(), GetFlags(), and SetFlags().

◆ m_Mdl

PMDL FxRequestMemory::m_Mdl

protected

Definition at line 117 of file fxrequestmemory.hpp.

Referenced by FxRequestMemory(), GetMdl(), SetBuffer(), SetMdl(), and ~FxRequestMemory().

◆ m_Request

FxRequest* FxRequestMemory::m_Request

protected

Definition at line 112 of file fxrequestmemory.hpp.

Referenced by FxRequestMemory(), SetBuffer(), SetMdl(), and ~FxRequestMemory().

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxrequestmemory.hpp
sdk/lib/drivers/wdf/shared/core/fxrequestmemory.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxRequestMemory()

◆ ~FxRequestMemory()

Member Function Documentation

◆ Create()

◆ GetBuffer()

◆ GetFlags()

◆ GetMdl()

◆ QueryInterface()

◆ SetBuffer()

◆ SetFlags()

◆ SetMdl()

Member Data Documentation

◆ m_Flags

◆ m_Mdl

◆ m_Request