#include <fxlookasidelist.hpp>

Inheritance diagram for FxLookasideList:

[legend]

Collaboration diagram for FxLookasideList:

[legend]

Public Member Functions
	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)

Public Attributes
WDF_OBJECT_ATTRIBUTES	m_MemoryAttributes

Protected Member Functions
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)

Static Protected Member Functions
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)

Protected Attributes
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	FxMemoryBufferFromLookaside

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)

Detailed Description

Definition at line 25 of file fxlookasidelist.hpp.

Constructor & Destructor Documentation

◆ FxLookasideList()

FxLookasideList::FxLookasideList	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in USHORT	ObjectSize,
		__in ULONG	PoolTag
	)

Definition at line 27 of file fxlookasidelist.cpp.

      :
    FxObject(FX_TYPE_LOOKASIDE, ObjectSize, FxDriverGlobals),
    m_BufferSize(0), m_PoolTag(PoolTag), m_MemoryObjectSize(0)
/*++
 
Routine Description:
    Constructor for FxLookasideList
 
Arguments:
    ObjectSize - Size of the derived object.
 
    PoolTag - Tag to use when allocating memory.
 
Return Value:
    None
 
  --*/
{
}

◆ ~FxLookasideList()

FxLookasideList::~FxLookasideList ( )

protectedvirtual

Definition at line 51 of file fxlookasidelist.cpp.

66{

67}

Member Function Documentation

◆ _Reclaim()

VOID FxLookasideList::_Reclaim	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__inout PNPAGED_LOOKASIDE_LIST	List,
		__in FxMemoryBufferFromLookaside *	Memory
	)

staticprotected

Definition at line 206 of file fxlookasidelist.cpp.

{
    PFX_POOL_HEADER pHeader;
 
    pHeader = FxObject::_CleanupPointer(FxDriverGlobals, (FxObject*) Memory);
 
    FxFreeToNPagedLookasideList(List, pHeader->Base);
}

Referenced by FxNPagedLookasideList::Reclaim(), FxNPagedLookasideListFromPool::Reclaim(), and FxPagedLookasideListFromPool::Reclaim().

◆ Allocate()

virtual _Must_inspect_result_ NTSTATUS FxLookasideList::Allocate ( __out FxMemoryObject ** PPMemory )

pure virtual

Implemented in FxNPagedLookasideList, FxNPagedLookasideListFromPool, and FxPagedLookasideListFromPool.

Referenced by FxUsbPipeContinuousReader::FormatRepeater().

◆ GetBufferSize()

size_t FxLookasideList::GetBufferSize ( VOID )

inline

Definition at line 52 of file fxlookasidelist.hpp.

    {
        return m_BufferSize;
    }

◆ Initialize()

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

pure virtual

Implemented in FxNPagedLookasideList, FxNPagedLookasideListFromPool, and FxPagedLookasideListFromPool.

Referenced by FxUsbPipeContinuousReader::Config().

◆ InitializeLookaside()

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

protected

Definition at line 71 of file fxlookasidelist.cpp.

{
    size_t size;
    NTSTATUS status;
 
    if (MemoryAttributes != NULL) {
        RtlCopyMemory(&m_MemoryAttributes,
                      MemoryAttributes,
                      sizeof(m_MemoryAttributes));
    }
    else {
        RtlZeroMemory(&m_MemoryAttributes, sizeof(m_MemoryAttributes));
    }
 
    status = FxCalculateObjectTotalSize(GetDriverGlobals(),
                                        MemoryObjectSize,
                                        BufferSize,
                                        &m_MemoryAttributes,
                                        &size);
 
    if (!NT_SUCCESS(status)) {
        //
        // FxCalculateObjectTotalSize logs an error  to the IFR
        //
        return status;
    }
 
    status = FxPoolAddHeaderSize(GetDriverGlobals(), size, &size);
    if (!NT_SUCCESS(status)) {
        //
        // FxPoolAddHeaderSize logs to the IFR on error
        //
        return status;
    }
 
    //
    // It is *required* to set these values only once we know we are returning
    // success b/c the derived classes use == 0 as an indication that Initialization
    // failed and that any associated lookaside lists were not initialized.
    //
    m_MemoryObjectSize = size;
    m_BufferSize = BufferSize;
 
    return status;
}

Referenced by FxNPagedLookasideList::Initialize(), FxNPagedLookasideListFromPool::Initialize(), and FxPagedLookasideListFromPool::Initialize().

◆ InitObjectAlloc()

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

protected

Definition at line 147 of file fxlookasidelist.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    PFX_POOL_HEADER pHeader;
    PFX_POOL_TRACKER tracker;
 
    pFxDriverGlobals = GetDriverGlobals();
 
    RtlZeroMemory(Alloc, m_MemoryObjectSize);
 
    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;
 
        FxPoolInsertNonPagedAllocateTracker(
            &pFxDriverGlobals->FxPoolFrameworks,
            tracker,
            m_BufferSize,
            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 FxNPagedLookasideList::Allocate(), FxNPagedLookasideListFromPool::Allocate(), and FxPagedLookasideListFromPool::Allocate().

◆ Reclaim()

virtual VOID FxLookasideList::Reclaim ( __in FxMemoryBufferFromLookaside * Memory )

protectedpure virtual

Implemented in FxNPagedLookasideList, FxNPagedLookasideListFromPool, and FxPagedLookasideListFromPool.

Referenced by FxMemoryBufferFromLookaside::SelfDestruct().

Member Data Documentation

◆ FxMemoryBufferFromLookaside

friend FxLookasideList::FxMemoryBufferFromLookaside

private

Definition at line 27 of file fxlookasidelist.hpp.

Referenced by FxNPagedLookasideList::Allocate().

◆ m_BufferSize

size_t FxLookasideList::m_BufferSize

protected

Definition at line 98 of file fxlookasidelist.hpp.

Referenced by FxNPagedLookasideList::Allocate(), FxNPagedLookasideListFromPool::Allocate(), FxPagedLookasideListFromPool::Allocate(), GetBufferSize(), FxNPagedLookasideListFromPool::Initialize(), FxPagedLookasideListFromPool::Initialize(), InitializeLookaside(), InitObjectAlloc(), FxPagedLookasideListFromPool::ReclaimPool(), and FxNPagedLookasideListFromPool::~FxNPagedLookasideListFromPool().

◆ m_MemoryAttributes

WDF_OBJECT_ATTRIBUTES FxLookasideList::m_MemoryAttributes

Definition at line 95 of file fxlookasidelist.hpp.

Referenced by FxNPagedLookasideList::Allocate(), FxNPagedLookasideListFromPool::Allocate(), FxPagedLookasideListFromPool::Allocate(), and InitializeLookaside().

◆ m_MemoryObjectSize

size_t FxLookasideList::m_MemoryObjectSize

protected

Definition at line 100 of file fxlookasidelist.hpp.

Referenced by FxNPagedLookasideList::Initialize(), FxNPagedLookasideListFromPool::Initialize(), FxPagedLookasideListFromPool::Initialize(), InitializeLookaside(), InitObjectAlloc(), FxNPagedLookasideList::~FxNPagedLookasideList(), FxNPagedLookasideListFromPool::~FxNPagedLookasideListFromPool(), and FxPagedLookasideListFromPool::~FxPagedLookasideListFromPool().

◆ m_PoolTag

ULONG FxLookasideList::m_PoolTag

protected

Definition at line 102 of file fxlookasidelist.hpp.

Referenced by FxNPagedLookasideList::Initialize(), FxNPagedLookasideListFromPool::Initialize(), FxPagedLookasideListFromPool::Initialize(), InitObjectAlloc(), and FxPagedLookasideListFromPool::InitPagedAlloc().

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxLookasideList()

◆ ~FxLookasideList()

Member Function Documentation

◆ _Reclaim()

◆ Allocate()

◆ GetBufferSize()

◆ Initialize()

◆ InitializeLookaside()

◆ InitObjectAlloc()

◆ Reclaim()

Member Data Documentation

◆ FxMemoryBufferFromLookaside

◆ m_BufferSize

◆ m_MemoryAttributes

◆ m_MemoryObjectSize

◆ m_PoolTag