#include <fxmemorybufferfromlookaside.hpp>

Inheritance diagram for FxMemoryBufferFromLookaside:

[legend]

Collaboration diagram for FxMemoryBufferFromLookaside:

[legend]

Public Member Functions
	FxMemoryBufferFromLookaside (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __inout FxLookasideList *Lookaside, __in size_t BufferSize)

_Must_inspect_result_ PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __inout PVOID ValidMemory, __in size_t BufferSize, __in PWDF_OBJECT_ATTRIBUTES Attributes)

virtual PVOID	GetBuffer (VOID)

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)

Protected Member Functions
	FxMemoryBufferFromLookaside (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __inout FxLookasideList *Lookaside, __in size_t BufferSize, __in USHORT ObjectSize)

	~FxMemoryBufferFromLookaside ()

VOID	Init (VOID)

virtual VOID	SelfDestruct (VOID)

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
FxLookasideList *	m_pLookaside

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 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)

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 24 of file fxmemorybufferfromlookaside.hpp.

Constructor & Destructor Documentation

◆ FxMemoryBufferFromLookaside() [1/2]

FxMemoryBufferFromLookaside::FxMemoryBufferFromLookaside	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__inout FxLookasideList *	Lookaside,
		__in size_t	BufferSize
	)

Definition at line 28 of file fxmemorybufferfromlookaside.cpp.

      :
    FxMemoryObject(FxDriverGlobals,
                   COMPUTE_OBJECT_SIZE(sizeof(*this), (ULONG) BufferSize),
                   BufferSize),
    m_pLookaside(Lookaside)
/*++
 
Routine Description:
    Constructor for this object.  Remembers which lookaside list this object
    was allocated from
 
    We round up the object size (via COMPUTE_OBJECT_SIZE) because the object,
    the context and the memory it returns via GetBuffer() are all in one allocation
    and the returned memory needs to match the alignment that raw pool follows.
 
Arguments:
    Lookaside - The lookaside list which this object will return itself to when
        its last reference is removed
 
    BufferSize - The buffer size associated with this object
 
Return Value:
    None
 
  --*/
{
    Init();
}

◆ FxMemoryBufferFromLookaside() [2/2]

FxMemoryBufferFromLookaside::FxMemoryBufferFromLookaside	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__inout FxLookasideList *	Lookaside,
		__in size_t	BufferSize,
		__in USHORT	ObjectSize
	)

protected

Definition at line 61 of file fxmemorybufferfromlookaside.cpp.

      :
    FxMemoryObject(FxDriverGlobals, ObjectSize, BufferSize),
    m_pLookaside(Lookaside)
/*++
 
Routine Description:
    Constructor for this object.  Remembers which lookaside list this object
    was allocated from
 
    There is no round up of the ObjectSize because the derived class may not
    embed the buffer in the same allocation as the object.  If it were to do so,
    the derived object should do the round up on its own.
 
Arguments:
    Lookaside - The lookaside list which this object will return itself to when
        its last reference is removed
 
    BufferSize - The buffer size associated with this object
 
    ObjectSize - The size of this object.
 
Return Value:
    None
 
  --*/
{
    Init();
}

◆ ~FxMemoryBufferFromLookaside()

FxMemoryBufferFromLookaside::~FxMemoryBufferFromLookaside ( )

protected

Definition at line 105 of file fxmemorybufferfromlookaside.cpp.

117{

118}

Referenced by SelfDestruct().

Member Function Documentation

◆ GetBuffer()

PVOID FxMemoryBufferFromLookaside::GetBuffer ( VOID )

virtual

Implements IFxMemory.

Reimplemented in FxMemoryBufferFromPoolLookaside.

Definition at line 182 of file fxmemorybufferfromlookaside.cpp.

{
    //
    // The buffer follows the struct itself
    //
    return ((PUCHAR) this) + COMPUTE_RAW_OBJECT_SIZE(sizeof(*this));
}

◆ Init()

VOID FxMemoryBufferFromLookaside::Init ( VOID )

protected

Definition at line 96 of file fxmemorybufferfromlookaside.cpp.

{
    m_pLookaside->ADDREF(this);
}

◆ operator new()

_Must_inspect_result_ PVOID FxMemoryBufferFromLookaside::operator new	(	__in size_t	Size,
		__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__inout PVOID	ValidMemory,
		__in size_t	BufferSize,
		__in PWDF_OBJECT_ATTRIBUTES	Attributes
	)

Definition at line 122 of file fxmemorybufferfromlookaside.cpp.

{
    size_t objectSize;
 
    UNREFERENCED_PARAMETER(Size);
 
    ASSERT(Size >= sizeof(FxMemoryBufferFromLookaside));
 
    //
    // We round up the object size (via COMPUTE_OBJECT_SIZE) because the object,
    // and the buffer are all in one allocation and the returned memory needs to
    // match the alignment that raw pool follows.
    //
    // Note that FxMemoryBufferFromLookaside is used for buffer less than a page
    // size so downcasting to USHORT (via COMPUTE_OBJECT_SIZE) is safe because
    // size of object plus buffer (<page size) would be smaller than 64K that
    // could fit in USHORT. See comments in FxMemoryObject.hpp for info on
    // various fx memory objects.
    //
    objectSize = COMPUTE_OBJECT_SIZE(sizeof(FxMemoryBufferFromLookaside),
                                     (ULONG) BufferSize);
 
    return FxObjectAndHandleHeaderInit(
        FxDriverGlobals,
        ValidMemory,
        (USHORT) objectSize,
        Attributes,
        FxObjectTypeExternal
        );
}

◆ SelfDestruct()

VOID FxMemoryBufferFromLookaside::SelfDestruct ( VOID )

protectedvirtual

Reimplemented from FxObject.

Reimplemented in FxMemoryBufferFromPoolLookaside.

Definition at line 191 of file fxmemorybufferfromlookaside.cpp.

{
    FxLookasideList* pLookaside;
 
    //
    // Call the destructor first.
    //
    // Since we were allocated from a lookaside list, return ourself to this
    // list and then free the reference we have on it.  We can't call this from
    // within the destructor b/c then all parent objects would be destructing on
    // freed pool.
    //
    this->~FxMemoryBufferFromLookaside();
 
    //
    // After FxLookaside::Reclaim, this no longer points to valid memory so we
    // must stash off m_pLookaside first so we can use it after the reclaim.
    //
    pLookaside = m_pLookaside;
    pLookaside->Reclaim(this);
    pLookaside->RELEASE(this);
}

Referenced by FxMemoryBufferFromPoolLookaside::SelfDestruct().

Member Data Documentation

◆ m_pLookaside

FxLookasideList* FxMemoryBufferFromLookaside::m_pLookaside

protected

Definition at line 71 of file fxmemorybufferfromlookaside.hpp.

Referenced by Init(), SelfDestruct(), and FxMemoryBufferFromPoolLookaside::SelfDestruct().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxMemoryBufferFromLookaside() [1/2]

◆ FxMemoryBufferFromLookaside() [2/2]

◆ ~FxMemoryBufferFromLookaside()

Member Function Documentation

◆ GetBuffer()

◆ Init()

◆ operator new()

◆ SelfDestruct()

Member Data Documentation

◆ m_pLookaside