fxmemorybufferapi.cpp File Reference

#include "coreprivshared.hpp"
#include "fxmemorybuffer.hpp"

Include dependency graph for fxmemorybufferapi.cpp:

Go to the source code of this file.

Functions
_Must_inspect_result_	__drv_when (PoolType==1||PoolType==257, __drv_maxIRQL(APC_LEVEL)) __drv_when(PoolType
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL)) WDFAPI NTSTATUS NTAPI WDFEXPORT(WdfMemoryCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in	__drv_strictTypeMatch (__drv_typeExpr) POOL_TYPE PoolType
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __in_opt ULONG __in	__drv_when (BufferSize==0, __drv_reportError(BufferSize cannot be zero)) size_t BufferSize
	if (NT_SUCCESS(FxValidateObjectAttributesForParentHandle(pFxDriverGlobals, Attributes)))
	FxPointerNotNull (pFxDriverGlobals, Memory)
	if (FxIsPagedPoolType(PoolType))
	if (BufferSize==0)
	if (!NT_SUCCESS(status))
	if (PoolTag==0)
	FxVerifierCheckNxPoolType (pFxDriverGlobals, PoolType, PoolTag)
	if (NT_SUCCESS(status))
	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), Memory, IFX_TYPE_MEMORY,(PVOID *)&pMemory)
	if (BufferSize !=NULL)
return pMemory	GetBuffer ()
_Must_inspect_result_ __in WDFMEMORY __in size_t	__out_bcount (NumBytesToCopyTo) PVOID Buffer
_Must_inspect_result_ __in WDFMEMORY __in size_t __in	__drv_when (NumBytesToCopyTo==0, __drv_reportError(NumBytesToCopyTo cannot be zero)) size_t NumBytesToCopyTo)
_Must_inspect_result_ __in WDFMEMORY __in size_t __in PVOID __in	__drv_when (NumBytesToCopyFrom==0, __drv_reportError(NumBytesToCopyFrom cannot be zero)) size_t NumBytesToCopyFrom)

Variables
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES	Attributes
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __in_opt ULONG	PoolTag
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __in_opt ULONG __in __out WDFMEMORY *	Memory = NULL
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __in_opt ULONG __in __out WDFMEMORY __out_opt PVOID *	Buffer
PFX_DRIVER_GLOBALS	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)
FxMemoryObject *	pBuffer
WDFMEMORY	hMemory
NTSTATUS	status = FxValidateObjectAttributes(pFxDriverGlobals, Attributes)
	else
__in WDFMEMORY __out_opt size_t *	BufferSize
IFxMemory *	pMemory
_Must_inspect_result_ __in WDFMEMORY	SourceMemory
_Must_inspect_result_ __in WDFMEMORY __in size_t	SourceOffset
_Must_inspect_result_ __in WDFMEMORY	DestinationMemory
_Must_inspect_result_ __in WDFMEMORY __in size_t	DestinationOffset

Function Documentation

__drv_maxIRQL()

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_strictTypeMatch()

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __drv_strictTypeMatch

(

__drv_typeExpr

)

__drv_when() [1/4]

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __in_opt ULONG __in __drv_when	(	BufferSize	= = 0,
		__drv_reportError(BufferSize cannot be zero)
	)

__drv_when() [2/4]

_Must_inspect_result_ __in WDFMEMORY __in size_t __in PVOID __in __drv_when	(	NumBytesToCopyFrom	= = 0,
		__drv_reportError(NumBytesToCopyFrom cannot be zero)
	)

Definition at line 302 of file fxmemorybufferapi.cpp.

{
    DDI_ENTRY();
 
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    WDFMEMORY_OFFSET srcOffsets;
    WDFMEMORY_OFFSET dstOffsets;
    IFxMemory* pDest;
    NTSTATUS status;
 
    FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals),
                         DestinationMemory,
                         IFX_TYPE_MEMORY,
                         (PVOID*) &pDest);
 
    pFxDriverGlobals = pDest->GetDriverGlobals();
 
    FxPointerNotNull(pFxDriverGlobals, Buffer);
 
    if (NumBytesToCopyFrom == 0) {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Zero bytes to copy not allowed, %!STATUS!", status);
        return status;
    }
 
    RtlZeroMemory(&srcOffsets, sizeof(srcOffsets));
    srcOffsets.BufferLength = NumBytesToCopyFrom;
    srcOffsets.BufferOffset = 0;
 
    RtlZeroMemory(&dstOffsets, sizeof(dstOffsets));
    dstOffsets.BufferLength = NumBytesToCopyFrom;
    dstOffsets.BufferOffset = DestinationOffset;
 
    return pDest->CopyFromPtr(&dstOffsets,
                              Buffer,
                              NumBytesToCopyFrom,
                              &srcOffsets);
}

__drv_when() [3/4]

_Must_inspect_result_ __in WDFMEMORY __in size_t __in __drv_when	(	NumBytesToCopyTo	= = 0,
		__drv_reportError(NumBytesToCopyTo cannot be zero)
	)

Definition at line 223 of file fxmemorybufferapi.cpp.

{
    DDI_ENTRY();
 
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    IFxMemory* pSource;
    WDFMEMORY_OFFSET srcOffsets;
    WDFMEMORY_OFFSET dstOffsets;
    NTSTATUS status;
 
    FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals),
                         SourceMemory,
                         IFX_TYPE_MEMORY,
                         (PVOID*) &pSource);
 
    pFxDriverGlobals = pSource->GetDriverGlobals();
 
    FxPointerNotNull(pFxDriverGlobals, Buffer);
 
    if (NumBytesToCopyTo == 0) {
        status =STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Zero bytes to copy not allowed, %!STATUS!", status);
        return status;
    }
 
    RtlZeroMemory(&srcOffsets, sizeof(srcOffsets));
    srcOffsets.BufferLength = NumBytesToCopyTo;
    srcOffsets.BufferOffset = SourceOffset;
 
    RtlZeroMemory(&dstOffsets, sizeof(dstOffsets));
    dstOffsets.BufferLength = NumBytesToCopyTo;
    dstOffsets.BufferOffset = 0;
 
    return pSource->CopyToPtr(&srcOffsets,
                              Buffer,
                              NumBytesToCopyTo,
                              &dstOffsets);
}

__drv_when() [4/4]

_Must_inspect_result_ __drv_when	(	PoolType	= = 1 || PoolType == 257,
		__drv_maxIRQL(APC_LEVEL)
	)

__out_bcount()

_Must_inspect_result_ __in WDFMEMORY __in size_t __out_bcount

(

NumBytesToCopyTo

)

FxObjectHandleGetPtr()

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		Memory	,
		IFX_TYPE_MEMORY	,
		(PVOID *)&	pMemory
	)

Referenced by __drv_when().

FxPointerNotNull()

FxPointerNotNull	(	pFxDriverGlobals	,
		Memory
	)

FxVerifierCheckNxPoolType()

FxVerifierCheckNxPoolType	(	pFxDriverGlobals	,
		PoolType	,
		PoolTag
	)

GetBuffer()

return pMemory GetBuffer

(

)

Referenced by IFxMemory::CopyFromPtr(), IFxMemory::CopyToPtr(), DECLARE_INTERFACE(), DECLARE_INTERFACE_(), CHString::GetBufferSetLength(), CHString::LockBuffer(), and CHString2::UseStuff().

if() [1/7]

if

(

!

NT_SUCCESSstatus

)

Definition at line 128 of file fxmemorybufferapi.cpp.

                             {
        return status;
    }

if() [2/7]

if

(

BufferSize !

= NULL

)

Definition at line 201 of file fxmemorybufferapi.cpp.

                            {
        *BufferSize = pMemory->GetBufferSize();
    }

if() [3/7]

if

(

BufferSize

= = 0

)

Definition at line 118 of file fxmemorybufferapi.cpp.

                         {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "BufferSize == 0 not allowed,  %!STATUS!", status);
        return status;
    }

if() [4/7]

if

(

FxIsPagedPoolType(PoolType)

)

Definition at line 111 of file fxmemorybufferapi.cpp.

                                     {
        status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL);
        if (!NT_SUCCESS(status)) {
            return status;
        }
    }

if() [5/7]

if

(

NT_SUCCESS(FxValidateObjectAttributesForParentHandle(pFxDriverGlobals, Attributes))

)

Definition at line 98 of file fxmemorybufferapi.cpp.

                                                                           {
        FxObject* pParent;
 
        FxObjectHandleGetPtrAndGlobals(pFxDriverGlobals,
                                       Attributes->ParentObject,
                                       FX_TYPE_OBJECT,
                                       (PVOID*)&pParent,
                                       &pFxDriverGlobals);
    }

if() [6/7]

if

(

NT_SUCCESS(status)

)

Definition at line 152 of file fxmemorybufferapi.cpp.

                            {
        *Memory = hMemory;
        if (Buffer != NULL) {
            *Buffer = pBuffer->GetBuffer();
        }
    }

if() [7/7]

if

(

PoolTag

= = 0

)

Definition at line 132 of file fxmemorybufferapi.cpp.

                      {
        PoolTag = pFxDriverGlobals->Tag;
    }

Variable Documentation

Attributes

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 43 of file fxmemorybufferapi.cpp.

Buffer

_Must_inspect_result_ __in WDFMEMORY __in size_t __in PVOID Buffer

Initial value:

{
    DDI_ENTRY()

Definition at line 55 of file fxmemorybufferapi.cpp.

BufferSize

__in WDFMEMORY __out_opt size_t* BufferSize

Initial value:

{
    DDI_ENTRY()

Definition at line 175 of file fxmemorybufferapi.cpp.

DestinationMemory

_Must_inspect_result_ __in WDFMEMORY DestinationMemory

Definition at line 296 of file fxmemorybufferapi.cpp.

DestinationOffset

_Must_inspect_result_ __in WDFMEMORY __in size_t DestinationOffset

Definition at line 298 of file fxmemorybufferapi.cpp.

Referenced by __drv_when().

else

else

Initial value:

{
        pBuffer->DeleteFromFailedCreate()

Definition at line 158 of file fxmemorybufferapi.cpp.

hMemory

WDFMEMORY hMemory

Definition at line 90 of file fxmemorybufferapi.cpp.

Referenced by if().

Memory

__in WDFMEMORY Memory = NULL

Definition at line 53 of file fxmemorybufferapi.cpp.

pBuffer

FxMemoryObject* pBuffer

Definition at line 89 of file fxmemorybufferapi.cpp.

Referenced by if().

pFxDriverGlobals

pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

Definition at line 88 of file fxmemorybufferapi.cpp.

Referenced by __drv_when(), and if().

pMemory

IFxMemory* pMemory

Definition at line 194 of file fxmemorybufferapi.cpp.

Referenced by if().

PoolTag

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __in __in_opt ULONG PoolTag

Definition at line 48 of file fxmemorybufferapi.cpp.

SourceMemory

_Must_inspect_result_ __in WDFMEMORY SourceMemory

Definition at line 217 of file fxmemorybufferapi.cpp.

SourceOffset

_Must_inspect_result_ __in WDFMEMORY __in size_t SourceOffset

Definition at line 219 of file fxmemorybufferapi.cpp.

Referenced by __drv_when().

status

return status = FxValidateObjectAttributes(pFxDriverGlobals, Attributes)

Definition at line 91 of file fxmemorybufferapi.cpp.

Referenced by __drv_when(), and if().