IFxMemory Class Reference

#include <ifxmemory.hpp>

Inheritance diagram for IFxMemory:

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

Static Protected Member Functions
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 40 of file ifxmemory.hpp.

Member Function Documentation

_CopyPtrToPtr() [1/2]

_Must_inspect_result_ NTSTATUS IFxMemory::_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  )

staticprotected

Definition at line 205 of file fxmemoryobject.cpp.

{
    size_t srcSize, copyLength;
    PUCHAR pSrcBuf, pDstBuf;
 
    if (SourceBuffer == NULL) {
       return STATUS_INVALID_PARAMETER;
    }
 
    pSrcBuf = (PUCHAR) SourceBuffer;
    srcSize = SourceBufferLength;
 
    pDstBuf = (PUCHAR) DestinationBuffer;
    copyLength = DestinationBufferLength;
 
    if (SourceOffsets != NULL) {
        if (SourceOffsets->BufferOffset != 0) {
            if (SourceOffsets->BufferOffset >= srcSize) {
                //
                // Offset is beyond end of buffer
                //
                return STATUS_BUFFER_TOO_SMALL;
            }
 
            //
            // Adjust the start and source size to reflect the offset info the
            // source
            //
            pSrcBuf += SourceOffsets->BufferOffset;
            srcSize -= SourceOffsets->BufferOffset;
        }
    }
 
    if (DestinationOffsets != NULL) {
        if (DestinationOffsets->BufferOffset != 0) {
            if (DestinationOffsets->BufferOffset >= copyLength) {
                //
                // Offset is beyond end of buffer
                //
                return STATUS_INVALID_BUFFER_SIZE;
            }
 
            //
            // Adjust the start and copy length to reflect the offset info the
            // destination
            //
            pDstBuf += DestinationOffsets->BufferOffset;
            copyLength -= DestinationOffsets->BufferOffset;
        }
 
        //
        // Non zero buffer length overrides previously calculated copy length
        //
        if (DestinationOffsets->BufferLength != 0) {
            //
            // Is the desired buffer length greater than the amount of buffer
            // available?
            //
            if (DestinationOffsets->BufferLength > copyLength) {
                return STATUS_INVALID_BUFFER_SIZE;
            }
 
            copyLength = DestinationOffsets->BufferLength;
        }
    }
 
    //
    // Compare the final computed copy length against the length of the source
    // buffer.
    //
    if (copyLength > srcSize) {
        return STATUS_BUFFER_TOO_SMALL;
    }
 
    RtlCopyMemory(pDstBuf, pSrcBuf, copyLength);
 
    return STATUS_SUCCESS;
}

Referenced by CopyFromPtr(), and CopyToPtr().

_CopyPtrToPtr() [2/2]

static _Must_inspect_result_ NTSTATUS IFxMemory::_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  )

staticprotected

AddRef() [1/2]

virtual ULONG IFxMemory::AddRef ( __in PVOID  Tag, __in LONG  Line, __in_opt PSTR  File  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

AddRef() [2/2]

virtual ULONG IFxMemory::AddRef ( __in PVOID  Tag, __in LONG  Line, __in_opt PSTR  File  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

CopyFromPtr() [1/2]

_Must_inspect_result_ NTSTATUS IFxMemory::CopyFromPtr	(	__in_opt PWDFMEMORY_OFFSET	DestinationOffsets,
		__in_bcount(SourceBufferLength) PVOID	SourceBuffer,
		__in size_t	SourceBufferLength,
		__in_opt PWDFMEMORY_OFFSET	SourceOffsets
	)

Definition at line 118 of file fxmemoryobject.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
 
    pFxDriverGlobals = GetDriverGlobals();
 
    //
    // We read from the supplied buffer writing to the current FxMemoryBuffer
    //
    if (GetFlags() & IFxMemoryFlagReadOnly) {
        //
        // FxMemoryBuffer is not writeable
        //
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Target WDFMEMORY 0x%p is ReadOnly", GetHandle());
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
 
        return STATUS_ACCESS_VIOLATION;
    }
 
    return _CopyPtrToPtr(
        SourceBuffer,
        SourceBufferLength,
        SourceOffsets,
        GetBuffer(),
        GetBufferSize(),
        DestinationOffsets
        );
}

Referenced by __drv_when().

CopyFromPtr() [2/2]

_Must_inspect_result_ NTSTATUS IFxMemory::CopyFromPtr	(	__in_opt PWDFMEMORY_OFFSET	DestinationOffsets,
		__in_bcount(SourceBufferLength) PVOID	SourceBuffer,
		__in size_t	SourceBufferLength,
		__in_opt PWDFMEMORY_OFFSET	SourceOffsets
	)

CopyToPtr() [1/2]

_Must_inspect_result_ NTSTATUS IFxMemory::CopyToPtr	(	__in_opt PWDFMEMORY_OFFSET	SourceOffsets,
		__out_bcount(DestinationBufferLength) PVOID	DestinationBuffer,
		__in size_t	DestinationBufferLength,
		__in_opt PWDFMEMORY_OFFSET	DestinationOffsets
	)

Definition at line 155 of file fxmemoryobject.cpp.

{
    //
    // We are reading from the FxMemoryBuffer, so no need to check for ReadOnly
    //
    return _CopyPtrToPtr(
        GetBuffer(),
        GetBufferSize(),
        SourceOffsets,
        DestinationBuffer,
        DestinationBufferLength,
        DestinationOffsets
        );
}

Referenced by __drv_when().

CopyToPtr() [2/2]

_Must_inspect_result_ NTSTATUS IFxMemory::CopyToPtr	(	__in_opt PWDFMEMORY_OFFSET	SourceOffsets,
		__out_bcount(DestinationBufferLength) PVOID	DestinationBuffer,
		__in size_t	DestinationBufferLength,
		__in_opt PWDFMEMORY_OFFSET	DestinationOffsets
	)

Delete() [1/2]

virtual VOID IFxMemory::Delete ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

Referenced by FxUsbPipeContinuousReader::DeleteMemory().

Delete() [2/2]

virtual VOID IFxMemory::Delete ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

GetBuffer() [1/2]

virtual PVOID IFxMemory::GetBuffer ( VOID  )

pure virtual

Implemented in FxMemoryBuffer, FxMemoryBufferFromLookaside, FxMemoryBufferFromPoolLookaside, FxMemoryBufferFromPool, FxMemoryBufferPreallocated, FxRequestSystemBuffer, FxRequestOutputBuffer, and FxRequestMemory.

Referenced by FxDevice::_AllocAndQueryProperty(), FxDevice::_AllocAndQueryPropertyEx(), FxUsbDeviceStringContext::CopyParameters(), FxUsbPipeContinuousReader::FormatRepeater(), and if().

GetBuffer() [2/2]

virtual PVOID IFxMemory::GetBuffer ( VOID  )

pure virtual

Implemented in FxMemoryBuffer, FxMemoryBufferFromLookaside, FxMemoryBufferFromPoolLookaside, FxMemoryBufferFromPool, FxMemoryBufferPreallocated, FxRequestSystemBuffer, FxRequestOutputBuffer, and FxRequestMemory.

GetBufferSize() [1/2]

virtual size_t IFxMemory::GetBufferSize ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

Referenced by CopyFromPtr(), FxUsbDeviceStringContext::CopyParameters(), CopyToPtr(), if(), and ValidateMemoryOffsets().

GetBufferSize() [2/2]

virtual size_t IFxMemory::GetBufferSize ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

GetDriverGlobals() [1/2]

virtual PFX_DRIVER_GLOBALS IFxMemory::GetDriverGlobals ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

Referenced by __drv_when(), and CopyFromPtr().

GetDriverGlobals() [2/2]

virtual PFX_DRIVER_GLOBALS IFxMemory::GetDriverGlobals ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

GetFlags() [1/2]

virtual USHORT IFxMemory::GetFlags ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, FxRequestOutputBuffer, and FxRequestMemory.

Referenced by CopyFromPtr().

GetFlags() [2/2]

virtual USHORT IFxMemory::GetFlags ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, FxRequestOutputBuffer, and FxRequestMemory.

GetHandle() [1/2]

virtual WDFMEMORY IFxMemory::GetHandle ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

GetHandle() [2/2]

virtual WDFMEMORY IFxMemory::GetHandle ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

GetMdl() [1/2]

virtual PMDL IFxMemory::GetMdl ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, FxRequestOutputBuffer, and FxRequestMemory.

GetMdl() [2/2]

virtual PMDL IFxMemory::GetMdl ( VOID  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, FxRequestOutputBuffer, and FxRequestMemory.

Release() [1/2]

virtual ULONG IFxMemory::Release ( __in PVOID  Tag, __in LONG  Line, __in_opt PSTR  File  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

Release() [2/2]

virtual ULONG IFxMemory::Release ( __in PVOID  Tag, __in LONG  Line, __in_opt PSTR  File  )

pure virtual

Implemented in FxMemoryObject, FxRequestSystemBuffer, and FxRequestOutputBuffer.

ValidateMemoryOffsets() [1/2]

_Must_inspect_result_ NTSTATUS IFxMemory::ValidateMemoryOffsets ( __in_opt PWDFMEMORY_OFFSET  Offsets )

inline

Definition at line 105 of file ifxmemory.hpp.

    {
        NTSTATUS status;
        size_t total;
 
        if (Offsets == NULL) {
            return STATUS_SUCCESS;
        }
 
        status = RtlSizeTAdd(Offsets->BufferLength, Offsets->BufferOffset, &total);
 
        if (!NT_SUCCESS(status)) {
            return status;
        }
 
        if (total > GetBufferSize()) {
            return STATUS_INTEGER_OVERFLOW;
        }
 
        return STATUS_SUCCESS;
    }

Referenced by FxUsbPipe::_FormatTransfer(), for(), if(), and FxRequestBuffer::ValidateMemoryDescriptor().

ValidateMemoryOffsets() [2/2]

_Must_inspect_result_ NTSTATUS IFxMemory::ValidateMemoryOffsets ( __in_opt PWDFMEMORY_OFFSET  Offsets )

inline

Definition at line 105 of file ifxmemory.hpp.

    {
        NTSTATUS status;
        size_t total;
 
        if (Offsets == NULL) {
            return STATUS_SUCCESS;
        }
 
        status = RtlSizeTAdd(Offsets->BufferLength, Offsets->BufferOffset, &total);
 
        if (!NT_SUCCESS(status)) {
            return status;
        }
 
        if (total > GetBufferSize()) {
            return STATUS_INTEGER_OVERFLOW;
        }
 
        return STATUS_SUCCESS;
    }

---

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

• sdk/lib/drivers/wdf/kmdf/inc/private/ifxmemory.hpp
• sdk/lib/drivers/wdf/shared/inc/private/common/ifxmemory.hpp
• sdk/lib/drivers/wdf/shared/core/fxmemoryobject.cpp