#include <fxnpagedlookasidelist.hpp>

Inheritance diagram for FxNPagedLookasideList:

Collaboration diagram for FxNPagedLookasideList:

[legend]

Public Member Functions
	FxNPagedLookasideList (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in ULONG PoolTag)

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 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
	~FxNPagedLookasideList ()

virtual VOID	Reclaim (__in FxMemoryBufferFromLookaside *Memory)

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
NPAGED_LOOKASIDE_LIST	m_ObjectLookaside

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

};

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 fxnpagedlookasidelist.hpp.

Constructor & Destructor Documentation

◆ FxNPagedLookasideList()

FxNPagedLookasideList::FxNPagedLookasideList	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in ULONG	PoolTag
	)

Definition at line 29 of file fxnpagedlookasidelistkm.cpp.

      :
    FxLookasideList(FxDriverGlobals, sizeof(*this), PoolTag)
{
}

◆ ~FxNPagedLookasideList()

FxNPagedLookasideList::~FxNPagedLookasideList ( )

protected

Definition at line 37 of file fxnpagedlookasidelistkm.cpp.

{
    if (m_MemoryObjectSize != 0) {
        ExDeleteNPagedLookasideList(&m_ObjectLookaside);
    }
}

Member Function Documentation

◆ Allocate()

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

virtual

Implements FxLookasideList.

Definition at line 93 of file fxnpagedlookasidelistkm.cpp.

{
    FxMemoryBufferFromLookaside *pBuffer;
    PVOID p;
 
    if (PPMemory == NULL) {
        return STATUS_INVALID_PARAMETER;
    }
 
    *PPMemory = NULL;
 
    //
    // Get the raw memory allocation.
    //
    p = FxAllocateFromNPagedLookasideList(&m_ObjectLookaside);
    if (p == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    p = InitObjectAlloc(p);
 
    //
    // Construct new FxMemoryBufferFromLookaside
    //
    pBuffer = new(GetDriverGlobals(), p, m_BufferSize, &m_MemoryAttributes)
        FxMemoryBufferFromLookaside(GetDriverGlobals(), this, m_BufferSize);
 
    //
    // pBuffer might be displaced if there is a debug extension
    //
    ASSERT(_GetBase(pBuffer) == p);
 
    *PPMemory = pBuffer;
 
    return STATUS_SUCCESS;
}

◆ Initialize()

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

virtual

Implements FxLookasideList.

Definition at line 46 of file fxnpagedlookasidelistkm.cpp.

{
    NTSTATUS status;
 
    //
    // This type of class does not support BufferSize greater than 0xFFFF.
    // The verification below ensures this contract is respected in both
    // free and chk builds.
    //
    if (BufferSize > MAXUSHORT) {
        ASSERT(FALSE);
        status = STATUS_INVALID_BUFFER_SIZE;
        goto Done;
    }
 
    status = InitializeLookaside((USHORT) BufferSize,
                                 sizeof(FxMemoryBufferFromLookaside),
                                 MemoryAttributes);
 
    //
    // Must be called after InitializeLookaside so that m_MemoryObjectSize is
    // computed correctly.
    //
    if (NT_SUCCESS(status)) {
        ASSERT(m_MemoryObjectSize != 0);
 
        //
        // Initialize a non-paged pool with these characteristics.
        //
        ExInitializeNPagedLookasideList(&m_ObjectLookaside,
                                        NULL,
                                        NULL,
                                        0,
                                        m_MemoryObjectSize,
                                        m_PoolTag,
                                        0);
    }
 
Done:
    return status;
}

◆ Reclaim()

VOID FxNPagedLookasideList::Reclaim ( __in FxMemoryBufferFromLookaside * Memory )

protectedvirtual

Implements FxLookasideList.

Definition at line 133 of file fxnpagedlookasidelistkm.cpp.

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

Member Data Documentation

◆ m_ObjectLookaside

NPAGED_LOOKASIDE_LIST FxNPagedLookasideList::m_ObjectLookaside

protected

Definition at line 56 of file fxnpagedlookasidelist.hpp.

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

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxnpagedlookasidelist.hpp
sdk/lib/drivers/wdf/shared/core/km/fxnpagedlookasidelistkm.cpp
sdk/lib/drivers/wdf/shared/core/um/fxnpagedlookasidelistum.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxNPagedLookasideList()

◆ ~FxNPagedLookasideList()

Member Function Documentation

◆ Allocate()

◆ Initialize()

◆ Reclaim()

Member Data Documentation

◆ m_ObjectLookaside