#include <fxpagedlookasidelist.hpp>

Inheritance diagram for FxPagedLookasideListFromPool:

[legend]

Collaboration diagram for FxPagedLookasideListFromPool:

[legend]

Public Member Functions
	FxPagedLookasideListFromPool (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in ULONG PoolTag, __in FxDeviceBase DeviceBase, __in FxDeviceBase MemoryDeviceBase)

virtual _Must_inspect_result_ NTSTATUS	Initialize (__in size_t BufferSize, __in PWDF_OBJECT_ATTRIBUTES MemoryAttributes)

virtual _Must_inspect_result_ NTSTATUS	Allocate (__out FxMemoryObject **PPMemory)

Public Member Functions inherited from FxLookasideListFromPool
	FxLookasideListFromPool (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in ULONG PoolTag)

Public Member Functions inherited from FxLookasideList
	FxLookasideList (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in ULONG PoolTag)

virtual _Must_inspect_result_ NTSTATUS	Initialize (__in size_t BufferSize, __in PWDF_OBJECT_ATTRIBUTES MemoryAttributes)=0

virtual _Must_inspect_result_ NTSTATUS	Allocate (__out FxMemoryObject **PPMemory)=0

size_t	GetBufferSize (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)

Protected Member Functions
	~FxPagedLookasideListFromPool (VOID)

virtual VOID	Reclaim (__in FxMemoryBufferFromLookaside *Memory)

virtual VOID	ReclaimPool (__inout PVOID Pool)

PVOID	InitPagedAlloc (__out_bcount(this->m_RawBufferSize) PVOID Alloc)

BOOLEAN	UsePagedBufferObject (VOID)

virtual VOID	ReclaimPool (__inout PVOID Pool)=0

Protected Member Functions inherited from FxLookasideList
virtual	~FxLookasideList ()

virtual VOID	Reclaim (__in FxMemoryBufferFromLookaside *Memory)=0

_Must_inspect_result_ NTSTATUS	InitializeLookaside (__in USHORT BufferSize, __in USHORT MemoryObjectSize, __in PWDF_OBJECT_ATTRIBUTES MemoryAttributes)

PVOID	InitObjectAlloc (__out_bcount(this->m_MemoryObjectSize) PVOID Alloc)

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
size_t	m_RawBufferSize

FxDeviceBase *	m_MemoryDeviceBase

NPAGED_LOOKASIDE_LIST	m_ObjectLookaside

PAGED_LOOKASIDE_LIST	m_PoolLookaside

Protected Attributes inherited from FxLookasideList
size_t	m_BufferSize

size_t	m_MemoryObjectSize

ULONG	m_PoolTag

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Private Attributes
friend	FxMemoryBufferFromPoolLookaside

Additional Inherited Members
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 inherited from FxLookasideList
WDF_OBJECT_ATTRIBUTES	m_MemoryAttributes

Static Protected Member Functions inherited from FxLookasideList
static VOID	_Reclaim (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __inout PNPAGED_LOOKASIDE_LIST List, __in FxMemoryBufferFromLookaside *Memory)

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

Detailed Description

Definition at line 24 of file fxpagedlookasidelist.hpp.

Constructor & Destructor Documentation

◆ FxPagedLookasideListFromPool()

FxPagedLookasideListFromPool::FxPagedLookasideListFromPool	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in ULONG	PoolTag,
		__in FxDeviceBase *	DeviceBase,
		__in FxDeviceBase *	MemoryDeviceBase
	)

Definition at line 29 of file fxpagedlookasidelist.cpp.

      : FxLookasideListFromPool(FxDriverGlobals, sizeof(*this), PoolTag),
        m_RawBufferSize(0), m_MemoryDeviceBase(MemoryDeviceBase)
{
    SetDeviceBase(DeviceBase);
 
    //
    // 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.
    //
    MarkPassiveCallbacks(ObjectDoNotLock);
}

◆ ~FxPagedLookasideListFromPool()

FxPagedLookasideListFromPool::~FxPagedLookasideListFromPool ( VOID )

protected

Definition at line 48 of file fxpagedlookasidelist.cpp.

{
    if (m_MemoryObjectSize != 0) {
        Mx::MxDeleteNPagedLookasideList(&m_ObjectLookaside);
    }
 
    if (m_RawBufferSize != 0) {
        Mx::MxDeletePagedLookasideList(&m_PoolLookaside);
    }
}

Member Function Documentation

◆ Allocate()

_Must_inspect_result_ NTSTATUS FxPagedLookasideListFromPool::Allocate ( __out FxMemoryObject ** PPMemory )

virtual

Implements FxLookasideList.

Definition at line 215 of file fxpagedlookasidelist.cpp.

{
    FxMemoryBufferFromPoolLookaside* pBuffer;
    PVOID pObj, pBuf;
 
    //
    // Allocate the object which will contain the 2ndary allocation
    //
    pObj = FxAllocateFromNPagedLookasideList(&m_ObjectLookaside);
 
    if (pObj == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    pObj = InitObjectAlloc(pObj);
 
    //
    // Create the 2ndary allocation (the one the driver writer uses), what will
    // be FxMemoryBufferFromPoolLookaside::m_Pool below.
    //
    pBuf = FxAllocateFromPagedLookasideList(&m_PoolLookaside);
    if (pBuf == NULL) {
        //
        // This case is safe because Reclaim doesn't treat the pointer as an
        // object, rather it just performs pointer math and then frees the alloc
        //
        Reclaim((FxMemoryBufferFromPoolLookaside*) pObj);
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    if (m_BufferSize < PAGE_SIZE) {
        //
        // For allocations < PAGE, allocate a header, otherwise leave the
        // allocation alone.
        //
        pBuf = InitPagedAlloc(pBuf);
    }
    else {
        //
        // There is no tracking info before the real allocation start since we
        // don't want to burn an entire page.
        //
        DO_NOTHING();
    }
 
    //
    // Construct a new FxMemoryBufferFromPoolLookaside using the pool will allocated
    // above.
    //
    // Both objects will know that the base object is one allocation and the
    // buffer is another.  FxMemoryPagedBufferFromPoolLookaside also knows to
    // dispose itself on the owning FxDeviceBase* pointer.
    //
    if (UsePagedBufferObject()) {
        pBuffer = new(GetDriverGlobals(), pObj, &m_MemoryAttributes)
            FxMemoryPagedBufferFromPoolLookaside(GetDriverGlobals(),
                                                 this,
                                                 m_BufferSize,
                                                 pBuf,
                                                 m_MemoryDeviceBase);
    }
    else {
        pBuffer = new(GetDriverGlobals(), pObj, &m_MemoryAttributes)
            FxMemoryBufferFromPoolLookaside(GetDriverGlobals(),
                                            this,
                                            m_BufferSize,
                                            pBuf);
    }
 
    //
    // pBuffer might be displaced if there is a debug extension
    //
    ASSERT(_GetBase(pBuffer) == pObj);
 
    //
    // 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);
 
    *PPMemory = pBuffer;
 
    return STATUS_SUCCESS;
}

◆ Initialize()

_Must_inspect_result_ NTSTATUS FxPagedLookasideListFromPool::Initialize	(	__in size_t	BufferSize,
		__in PWDF_OBJECT_ATTRIBUTES	MemoryAttributes
	)

virtual

Implements FxLookasideList.

Definition at line 63 of file fxpagedlookasidelist.cpp.

{
    size_t rawBufferSize;
    NTSTATUS status;
 
    if (BufferSize >= PAGE_SIZE) {
        //
        // We don't want to burn extra entire pages for tracking information
        // so we just use the size as is.
        //
        rawBufferSize = BufferSize;
    }
    else {
        //
        // Allocate extra space for tracking the allocation
        //
        status = FxPoolAddHeaderSize(GetDriverGlobals(),
                                     BufferSize,
                                     &rawBufferSize);
 
        if (!NT_SUCCESS(status)) {
            //
            // FxPoolAddHeaderSize logs to the IFR on error
            //
            return status;
        }
    }
 
    if (UsePagedBufferObject()) {
        status = InitializeLookaside(0,
                                     sizeof(FxMemoryPagedBufferFromPoolLookaside),
                                     MemoryAttributes);
    }
    else {
        status = InitializeLookaside(0,
                                     sizeof(FxMemoryBufferFromPoolLookaside),
                                     MemoryAttributes);
    }
 
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    //
    // We use m_RawBufferSize == 0 as a condition not to delete the lookaside, so
    // only assign it a value once we know success is guaranteed.
    //
    m_BufferSize = BufferSize;
    m_RawBufferSize = rawBufferSize;
 
    //
    // Initialize a non paged pool with these characteristics.   All FxObject
    // derived objects must come from non paged pool.
    //
    Mx::MxInitializeNPagedLookasideList(&m_ObjectLookaside,
                                   NULL,
                                   NULL,
                                   0,
                                   m_MemoryObjectSize,
                                   m_PoolTag,
                                   0);
 
    //
    // Initialize a paged pool with these characteristics.
    //
    // Free and Allocate are left intentionally NULL so that we use the Ex
    // versions.
    //
    // bufferSize is used b/c it is full size of the object + pool requirements.
    // m_BufferSize is the size the client wants the buffer to be.
    //
    Mx::MxInitializePagedLookasideList(&m_PoolLookaside,
                                   NULL,
                                   NULL,
                                   0,
                                   m_RawBufferSize,
                                   m_PoolTag,
                                   0);
 
    return status;
}

◆ InitPagedAlloc()

PVOID FxPagedLookasideListFromPool::InitPagedAlloc ( __out_bcount(this->m_RawBufferSize) PVOID Alloc )

protected

Definition at line 155 of file fxpagedlookasidelist.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    PFX_POOL_HEADER pHeader;
    PFX_POOL_TRACKER tracker;
 
    pFxDriverGlobals = GetDriverGlobals();
 
    RtlZeroMemory(Alloc, m_RawBufferSize);
 
    if (pFxDriverGlobals->IsPoolTrackingOn())  {
        //
        // PoolTracking is active, so format and insert
        // a tracker in the NonPagedHeader list of the pool.
        //
        tracker = (PFX_POOL_TRACKER) Alloc;
        pHeader  = WDF_PTR_ADD_OFFSET_TYPE(Alloc,
                                           sizeof(FX_POOL_TRACKER),
                                           PFX_POOL_HEADER);
 
        pHeader->Base = Alloc;
        pHeader->FxDriverGlobals = pFxDriverGlobals;
 
        FxPoolInsertPagedAllocateTracker(
            &pFxDriverGlobals->FxPoolFrameworks,
            tracker,
            m_RawBufferSize,
            m_PoolTag,
            _ReturnAddress());
    }
    else {
        //
        // PoolTracking is inactive, only format FX_POOL_HEADER area.
        //
        pHeader = (PFX_POOL_HEADER) Alloc;
        pHeader->Base = Alloc;
        pHeader->FxDriverGlobals = pFxDriverGlobals;
    }
 
    return &pHeader->AllocationStart[0];
}

Referenced by Allocate().

◆ Reclaim()

VOID FxPagedLookasideListFromPool::Reclaim ( __in FxMemoryBufferFromLookaside * Memory )

protectedvirtual

Implements FxLookasideList.

Definition at line 305 of file fxpagedlookasidelist.cpp.

{
    _Reclaim(GetDriverGlobals(), &m_ObjectLookaside, Memory);
}

Referenced by Allocate().

◆ ReclaimPool()

virtual VOID FxPagedLookasideListFromPool::ReclaimPool ( __inout PVOID Pool )

inlineprotectedvirtual

Implements FxLookasideListFromPool.

Definition at line 64 of file fxpagedlookasidelist.hpp.

    {
        if (m_BufferSize < PAGE_SIZE) {
            PFX_POOL_HEADER pHeader;
 
            //
            // For < PAGE_SIZE, we track the allocation
            //
            pHeader = CONTAINING_RECORD(Pool, FX_POOL_HEADER, AllocationStart);
 
            //
            // If PoolTracker is on then do....
            //
            if (GetDriverGlobals()->IsPoolTrackingOn()) {
                //
                // Decommission this Paged Allocation tracker
                //
#pragma prefast(suppress:__WARNING_BUFFER_UNDERFLOW, "Accessing pool's header to reclaim pool");
                FxPoolRemovePagedAllocateTracker((PFX_POOL_TRACKER) pHeader->Base);
            }
 
#pragma prefast(suppress:__WARNING_BUFFER_UNDERFLOW, "Accessing pool's header to reclaim pool");
            FxFreeToPagedLookasideList(&m_PoolLookaside, pHeader->Base);
        }
        else {
            //
            // Page or greater size has no allocation tracking info prepended
            // to the allocation.
            //
            FxFreeToPagedLookasideList(&m_PoolLookaside, Pool);
        }
    }

◆ UsePagedBufferObject()

BOOLEAN FxPagedLookasideListFromPool::UsePagedBufferObject ( VOID )

inlineprotected

Definition at line 105 of file fxpagedlookasidelist.hpp.

    {
        return m_MemoryDeviceBase != NULL ? TRUE : FALSE;
    }

Referenced by Allocate(), and Initialize().

Member Data Documentation

◆ FxMemoryBufferFromPoolLookaside

friend FxPagedLookasideListFromPool::FxMemoryBufferFromPoolLookaside

private

Definition at line 26 of file fxpagedlookasidelist.hpp.

Referenced by Allocate().

◆ m_MemoryDeviceBase

FxDeviceBase* FxPagedLookasideListFromPool::m_MemoryDeviceBase

protected

Definition at line 120 of file fxpagedlookasidelist.hpp.

Referenced by Allocate(), and UsePagedBufferObject().

◆ m_ObjectLookaside

NPAGED_LOOKASIDE_LIST FxPagedLookasideListFromPool::m_ObjectLookaside

protected

Definition at line 122 of file fxpagedlookasidelist.hpp.

Referenced by Allocate(), Initialize(), Reclaim(), and ~FxPagedLookasideListFromPool().

◆ m_PoolLookaside

PAGED_LOOKASIDE_LIST FxPagedLookasideListFromPool::m_PoolLookaside

protected

Definition at line 124 of file fxpagedlookasidelist.hpp.

Referenced by Allocate(), Initialize(), ReclaimPool(), and ~FxPagedLookasideListFromPool().

◆ m_RawBufferSize

size_t FxPagedLookasideListFromPool::m_RawBufferSize

protected

Definition at line 118 of file fxpagedlookasidelist.hpp.

Referenced by Initialize(), InitPagedAlloc(), and ~FxPagedLookasideListFromPool().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxPagedLookasideListFromPool()

◆ ~FxPagedLookasideListFromPool()

Member Function Documentation

◆ Allocate()

◆ Initialize()

◆ InitPagedAlloc()

◆ Reclaim()

◆ ReclaimPool()

◆ UsePagedBufferObject()

Member Data Documentation

◆ FxMemoryBufferFromPoolLookaside

◆ m_MemoryDeviceBase

◆ m_ObjectLookaside

◆ m_PoolLookaside

◆ m_RawBufferSize