#include <fxmemorybufferfrompool.hpp>

Inheritance diagram for FxMemoryBufferFromPool:

[legend]

Collaboration diagram for FxMemoryBufferFromPool:

[legend]

Public Member Functions
	FxMemoryBufferFromPool (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in size_t BufferSize)

virtual PVOID	GetBuffer (VOID)

BOOLEAN	AllocateBuffer (__in POOL_TYPE Type, __in ULONG Tag)

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 _Must_inspect_result_ NTSTATUS	_Create (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in POOL_TYPE PoolType, __in ULONG PoolTag, __in size_t BufferSize, __out FxMemoryObject **Buffer)

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
	FxMemoryBufferFromPool (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in size_t BufferSize, __in USHORT ObjectSize)

	~FxMemoryBufferFromPool ()

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
PVOID	m_Pool

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 25 of file fxmemorybufferfrompool.hpp.

Constructor & Destructor Documentation

◆ FxMemoryBufferFromPool() [1/2]

FxMemoryBufferFromPool::FxMemoryBufferFromPool	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in size_t	BufferSize
	)

Definition at line 26 of file fxmemorybufferfrompool.cpp.

      :
    FxMemoryObject(FxDriverGlobals, sizeof(*this), BufferSize)
/*++
 
Routine Description:
    Constructor for this object.
 
Arguments:
    BufferSize - The buffer size associated with this object
 
Return Value:
    None
 
  --*/
{
    m_Pool = NULL;
}

◆ FxMemoryBufferFromPool() [2/2]

FxMemoryBufferFromPool::FxMemoryBufferFromPool	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in size_t	BufferSize,
		__in USHORT	ObjectSize
	)

protected

Definition at line 47 of file fxmemorybufferfrompool.cpp.

      :
    FxMemoryObject(FxDriverGlobals, ObjectSize, BufferSize)
/*++
 
Routine Description:
    Constructor for this object.
 
Arguments:
    BufferSize - The buffer size associated with this object
 
    ObjectSize - size of the derived object
 
Return Value:
    None
 
  --*/
{
    m_Pool = NULL;
}

◆ ~FxMemoryBufferFromPool()

FxMemoryBufferFromPool::~FxMemoryBufferFromPool ( )

protected

Definition at line 71 of file fxmemorybufferfrompool.cpp.

{
    if (m_Pool != NULL) {
        MxMemory::MxFreePool(m_Pool);
    }
}

Member Function Documentation

◆ _Create()

_Must_inspect_result_ NTSTATUS FxMemoryBufferFromPool::_Create	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in_opt PWDF_OBJECT_ATTRIBUTES	Attributes,
		__in POOL_TYPE	PoolType,
		__in ULONG	PoolTag,
		__in size_t	BufferSize,
		__out FxMemoryObject **	Buffer
	)

static

Definition at line 93 of file fxmemorybufferfrompool.cpp.

{
    CfxDeviceBase* pDeviceBase;
    FxMemoryBufferFromPool* pBuffer;
    NTSTATUS status;
    BOOLEAN isPaged;
 
    isPaged = FxIsPagedPoolType(PoolType);
 
    if (isPaged) {
        pDeviceBase = FxDeviceBase::_SearchForDevice(FxDriverGlobals,
                                                     Attributes);
    }
    else {
        pDeviceBase = NULL;
    }
 
    //
    // FxMemoryBufferFromPool can handle paged allocation as well.  We only
    // use FxMemoryPagedBufferFromPool if we have an FxDeviceBase that we can use
    // in the dispose path, otherwise these 2 classes are the same.
    //
    if (pDeviceBase != NULL) {
        ASSERT(isPaged);
        pBuffer = new(FxDriverGlobals, Attributes)
            FxMemoryPagedBufferFromPool(FxDriverGlobals, BufferSize, pDeviceBase);
    }
    else {
        pBuffer = new(FxDriverGlobals, Attributes)
            FxMemoryBufferFromPool(FxDriverGlobals, BufferSize);
    }
 
    if (pBuffer == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    status = STATUS_SUCCESS;
 
    if (pBuffer->AllocateBuffer(PoolType, PoolTag) == FALSE) {
        status = STATUS_INSUFFICIENT_RESOURCES;
    }
 
    if (!NT_SUCCESS(status)) {
        pBuffer->DeleteFromFailedCreate();
        return status;
    }
 
    if (isPaged) {
        //
        // Callbacks might be a bit excessive (passive dispose is what we are
        // really after) because this object has no callbacks, but this is being
        // proactive in case any callbacks are added.  If they are added, this
        // will take care of them w/out additional changes to object setup.
        //
        pBuffer->MarkPassiveCallbacks(ObjectDoNotLock);
    }
 
    *Buffer = pBuffer;
 
    return STATUS_SUCCESS;
}

Referenced by FxMemoryObject::_Create().

◆ AllocateBuffer()

BOOLEAN FxMemoryBufferFromPool::AllocateBuffer	(	__in POOL_TYPE	Type,
		__in ULONG	Tag
	)

inline

Definition at line 55 of file fxmemorybufferfrompool.hpp.

    {
        m_Pool = MxMemory::MxAllocatePoolWithTag(Type, GetBufferSize(), Tag);
        return  m_Pool != NULL ? TRUE : FALSE;
    }

◆ GetBuffer()

virtual PVOID FxMemoryBufferFromPool::GetBuffer ( VOID )

inlinevirtual

Implements IFxMemory.

Definition at line 47 of file fxmemorybufferfrompool.hpp.

    {
        return m_Pool;
    }

Member Data Documentation

◆ m_Pool

PVOID FxMemoryBufferFromPool::m_Pool

protected

Definition at line 73 of file fxmemorybufferfrompool.hpp.

Referenced by AllocateBuffer(), FxMemoryBufferFromPool(), GetBuffer(), and ~FxMemoryBufferFromPool().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxMemoryBufferFromPool() [1/2]

◆ FxMemoryBufferFromPool() [2/2]

◆ ~FxMemoryBufferFromPool()

Member Function Documentation

◆ _Create()

◆ AllocateBuffer()

◆ GetBuffer()

Member Data Documentation

◆ m_Pool