#include <fxcommonbuffer.hpp>

Inheritance diagram for FxCommonBuffer:

Collaboration diagram for FxCommonBuffer:

[legend]

Public Member Functions
	FxCommonBuffer (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxDmaEnabler *pDmaEnabler)

virtual BOOLEAN	Dispose (VOID)

_Must_inspect_result_ NTSTATUS	AllocateCommonBuffer (__in size_t Length)

VOID	FreeCommonBuffer (VOID)

__forceinline PHYSICAL_ADDRESS	GetAlignedLogicalAddress (VOID)

__forceinline PVOID	GetAlignedVirtualAddress (VOID)

__forceinline size_t	GetLength (VOID)

__forceinline VOID	SetAlignment (__in ULONG Alignment)

Public Member Functions inherited from FxNonPagedObject
	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

virtual	~FxNonPagedObject (VOID)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL PreviousIrql)

	_Releases_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID Unlock(__in __drv_restoresIRQL KIRQL PreviousIrql)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID LockAtDispatch(VOID)

	_Requires_lock_held_ (this->m_NPLock.m_Lock) _Releases_lock_(this -> m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID UnlockFromDispatch(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 Attributes
PVOID	m_BufferRawVA

PVOID	m_BufferAlignedVA

PHYSICAL_ADDRESS	m_BufferAlignedLA

PHYSICAL_ADDRESS	m_BufferRawLA

FxDmaEnabler *	m_DmaEnabler

size_t	m_Length

size_t	m_RawLength

size_t	m_Alignment

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)

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 inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Detailed Description

Definition at line 54 of file fxcommonbuffer.hpp.

Constructor & Destructor Documentation

◆ FxCommonBuffer()

FxCommonBuffer::FxCommonBuffer	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in FxDmaEnabler *	pDmaEnabler
	)

Definition at line 30 of file fxcommonbuffer.cpp.

      :
    FxNonPagedObject(FX_TYPE_COMMON_BUFFER, sizeof(FxCommonBuffer), FxDriverGlobals)
{
    m_DmaEnabler           = pDmaEnabler;
    m_BufferRawVA          = NULL;   // allocated buffer base (unaligned)
    m_BufferAlignedVA      = NULL;   // aligned buffer base
    m_BufferAlignedLA.QuadPart = NULL;   // aligned physical buffer base
    m_BufferRawLA.QuadPart = NULL;   // allocated buffer phy base (unaligned)
    m_Length               = 0;
    m_RawLength            = 0;
 
    MarkDisposeOverride(ObjectDoNotLock);
 
    //
    // By default use the alignment of the dma enabler.
    //
    m_Alignment = m_DmaEnabler->GetAlignment();
}

Member Function Documentation

◆ AllocateCommonBuffer()

_Must_inspect_result_ NTSTATUS FxCommonBuffer::AllocateCommonBuffer ( __in size_t Length )

Definition at line 61 of file fxcommonbuffer.cpp.

{
    NTSTATUS status;
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
    ULONGLONG offset;
    ULONG result;
 
    //
    // Must be running at PASIVE_LEVEL
    //
    status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    m_Length = Length;
 
    //
    // If required, add alignment to the length.
    // If alignment is <= page-1, we actually don't need to do it b/c
    // AllocateCommonBuffer allocates at least a page of memory, regardless
    // of the requested Length. If driver version is < v1.11, we still add the
    // alignment to the length for compatibility.
    //
    if (m_Alignment > PAGE_SIZE-1 ||
        pFxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,11) == FALSE) {
 
        status = RtlSizeTAdd(Length, m_Alignment, &m_RawLength);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                "WDFDMAENABLER %p AllocateCommonBuffer:  overflow when adding Length "
                "%I64d + Alignment %I64d", GetObjectHandle(), Length, m_Alignment);
            FxVerifierDbgBreakPoint(pFxDriverGlobals);
            return status;
        }
    }
    else {
        m_RawLength = Length;
    }
 
    m_DmaEnabler->AllocateCommonBuffer(m_RawLength,
                                       &m_BufferRawVA,
                                       &m_BufferRawLA);
    if (m_BufferRawVA) {
 
        m_BufferAlignedVA = FX_ALIGN_VIRTUAL_ADDRESS(m_BufferRawVA, m_Alignment);
        m_BufferAlignedLA.QuadPart = FX_ALIGN_LOGICAL_ADDRESS(m_BufferRawLA, m_Alignment);
 
        if (m_Alignment > PAGE_SIZE-1) {
            //
            // If the alignment mask is over a page-size then the aligned virtual
            // and aligned logical could be pointing to different locations
            // in memory. So ajdust the VA to match the LA address by adding
            // the offset of alignedLA and RawLA to VA. By doing this we
            // only guarantee alignment of LA when the page alignment exceeds PAGE_SIZE.
            //
            status = RtlULongLongSub(m_BufferAlignedLA.QuadPart,
                                     m_BufferRawLA.QuadPart,
                                     &offset);
            if (!NT_SUCCESS(status)) {
                DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMAENABLER %p AllocateCommonBuffer:  overflow when subtracting "
                    "RawLA %I64x from AlignedLA %I64x",
                    GetObjectHandle(), m_BufferRawLA.QuadPart, m_BufferAlignedLA.QuadPart);
                FxVerifierDbgBreakPoint(pFxDriverGlobals);
                return status;
            }
 
            status = RtlULongLongToULong(offset, &result);
            if (!NT_SUCCESS(status)) {
                DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMAENABLER %p AllocateCommonBuffer:  overflow when  "
                    "converting from ULongLong %I64d to ULong",
                    GetObjectHandle(), offset);
                FxVerifierDbgBreakPoint(pFxDriverGlobals);
                return status;
            }
 
            m_BufferAlignedVA = WDF_PTR_ADD_OFFSET(m_BufferRawVA, result);
        }
        else {
            ASSERT(m_BufferAlignedVA == m_BufferRawVA);
            ASSERT(m_BufferAlignedLA.QuadPart == m_BufferRawLA.QuadPart);
        }
    } else {
        m_Length                   = 0;
        m_RawLength                = 0;
        m_BufferAlignedVA          = NULL;
        m_BufferAlignedLA.QuadPart = NULL;
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    return status;
}

◆ Dispose()

BOOLEAN FxCommonBuffer::Dispose ( VOID )

virtual

Reimplemented from FxObject.

Definition at line 53 of file fxcommonbuffer.cpp.

{
    FreeCommonBuffer();
    return TRUE;
}

◆ FreeCommonBuffer()

VOID FxCommonBuffer::FreeCommonBuffer ( VOID )

Definition at line 159 of file fxcommonbuffer.cpp.

{
    //
    // Free this CommonBuffer per DmaEnabler
    //
    if (m_BufferRawVA != NULL) {
        m_DmaEnabler->FreeCommonBuffer((ULONG) m_RawLength,
                                        m_BufferRawVA,
                                        m_BufferRawLA);
    }
}

Referenced by Dispose().

◆ GetAlignedLogicalAddress()

__forceinline PHYSICAL_ADDRESS FxCommonBuffer::GetAlignedLogicalAddress ( VOID )

inline

Definition at line 82 of file fxcommonbuffer.hpp.

    {
        return m_BufferAlignedLA;
    }

◆ GetAlignedVirtualAddress()

__forceinline PVOID FxCommonBuffer::GetAlignedVirtualAddress ( VOID )

inline

Definition at line 91 of file fxcommonbuffer.hpp.

    {
        return m_BufferAlignedVA;
    }

◆ GetLength()

__forceinline size_t FxCommonBuffer::GetLength ( VOID )

inline

Definition at line 100 of file fxcommonbuffer.hpp.

    {
        return m_Length;
    }

◆ SetAlignment()

__forceinline VOID FxCommonBuffer::SetAlignment ( __in ULONG Alignment )

inline

Definition at line 109 of file fxcommonbuffer.hpp.

    {
        m_Alignment = Alignment;
    }

Member Data Documentation

◆ m_Alignment

size_t FxCommonBuffer::m_Alignment

protected

Definition at line 157 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FxCommonBuffer(), and SetAlignment().

◆ m_BufferAlignedLA

PHYSICAL_ADDRESS FxCommonBuffer::m_BufferAlignedLA

protected

Definition at line 131 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FxCommonBuffer(), and GetAlignedLogicalAddress().

◆ m_BufferAlignedVA

PVOID FxCommonBuffer::m_BufferAlignedVA

protected

Definition at line 126 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FxCommonBuffer(), and GetAlignedVirtualAddress().

◆ m_BufferRawLA

PHYSICAL_ADDRESS FxCommonBuffer::m_BufferRawLA

protected

Definition at line 136 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FreeCommonBuffer(), and FxCommonBuffer().

◆ m_BufferRawVA

PVOID FxCommonBuffer::m_BufferRawVA

protected

Definition at line 121 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FreeCommonBuffer(), and FxCommonBuffer().

◆ m_DmaEnabler

FxDmaEnabler* FxCommonBuffer::m_DmaEnabler

protected

Definition at line 141 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FreeCommonBuffer(), and FxCommonBuffer().

◆ m_Length

size_t FxCommonBuffer::m_Length

protected

Definition at line 146 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FxCommonBuffer(), and GetLength().

◆ m_RawLength

size_t FxCommonBuffer::m_RawLength

protected

Definition at line 152 of file fxcommonbuffer.hpp.

Referenced by AllocateCommonBuffer(), FreeCommonBuffer(), and FxCommonBuffer().

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

sdk/lib/drivers/wdf/kmdf/inc/private/fxcommonbuffer.hpp
sdk/lib/drivers/wdf/kmdf/src/dma/base/fxcommonbuffer.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxCommonBuffer()

Member Function Documentation

◆ AllocateCommonBuffer()

◆ Dispose()

◆ FreeCommonBuffer()

◆ GetAlignedLogicalAddress()

◆ GetAlignedVirtualAddress()

◆ GetLength()

◆ SetAlignment()

Member Data Documentation

◆ m_Alignment

◆ m_BufferAlignedLA

◆ m_BufferAlignedVA

◆ m_BufferRawLA

◆ m_BufferRawVA

◆ m_DmaEnabler

◆ m_Length

◆ m_RawLength