#include <fxrequest.hpp>

Inheritance diagram for FxRequestOutputBuffer:

Collaboration diagram for FxRequestOutputBuffer:

[legend]

Public Member Functions
	FxRequestOutputBuffer (VOID)

virtual PVOID	GetBuffer (VOID)

virtual size_t	GetBufferSize (VOID)

virtual _Must_inspect_result_ PMDL	GetMdl (VOID)

virtual WDFMEMORY	GetHandle (VOID)

virtual USHORT	GetFlags (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)

__inline BOOLEAN	IsBufferSet (VOID)

__inline VOID	ClearBufferMdl (VOID)

Public Member Functions inherited from IFxMemory
_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)

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

Public Attributes
friend	FxRequest

PVOID	m_Buffer

PMDL	m_Mdl

Protected Member Functions
__inline VOID	SetBuffer (__in PVOID Buffer)

__inline VOID	SetMdl (__in PMDL Mdl)

FxRequest *	GetRequest (VOID)

Protected Attributes
union {
PVOID m_Buffer

PMDL m_Mdl

};

Additional Inherited Members
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 242 of file fxrequest.hpp.

Constructor & Destructor Documentation

◆ FxRequestOutputBuffer()

FxRequestOutputBuffer::FxRequestOutputBuffer ( VOID )

inline

Definition at line 246 of file fxrequest.hpp.

     {
         m_Buffer = NULL;
     }

Member Function Documentation

◆ AddRef()

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

virtual

Implements IFxMemory.

Definition at line 218 of file fxrequestoutputbuffer.cpp.

 {
     UNREFERENCED_PARAMETER(Tag);
     UNREFERENCED_PARAMETER(Line);
     UNREFERENCED_PARAMETER(File);
 
     GetRequest()->AddIrpReference();
 
     return 2;
 }

◆ ClearBufferMdl()

__inline VOID FxRequestOutputBuffer::ClearBufferMdl ( VOID )

inline

Definition at line 323 of file fxrequest.hpp.

     {
         m_Buffer = NULL;
         m_Mdl = NULL;
     }

Referenced by FxRequest::ClearFieldsForReuse().

◆ Delete()

VOID FxRequestOutputBuffer::Delete ( VOID )

virtual

Implements IFxMemory.

Definition at line 306 of file fxrequestoutputbuffer.cpp.

 {
     // this function should never be called
     ASSERT(FALSE);
 }

◆ GetBuffer()

PVOID FxRequestOutputBuffer::GetBuffer ( VOID )

virtual

Implements IFxMemory.

Definition at line 36 of file fxrequestoutputbuffer.cpp.

 {
     FxIrp* irp = GetRequest()->GetFxIrp();
 
     ASSERT(irp->GetMajorFunction() == IRP_MJ_DEVICE_CONTROL ||
            irp->GetMajorFunction() == IRP_MJ_INTERNAL_DEVICE_CONTROL);
 
     switch (irp->GetParameterIoctlCodeBufferMethod()) {
     case METHOD_BUFFERED:
         //
         // For buffered ioctls, input and output buffer pointers are same.
         //
         return m_Buffer;
 
     case METHOD_IN_DIRECT:
     case METHOD_OUT_DIRECT:
         //
         // FxRequest::GetDeviceControlOutputMemoryObject has already called
         // MmGetSystemAddressForMdlSafe and returned success, so we know that
         // we can safely call MmGetSystemAddressForMdlSafe again to get a
         // valid VA pointer.
         //
         return Mx::MxGetSystemAddressForMdlSafe(m_Mdl, NormalPagePriority);
 
     case METHOD_NEITHER:
         return m_Buffer;
 
     default:
         ASSERT(FALSE);
         return NULL;
     }
 }

Referenced by FxRequest::CompleteInternal().

◆ GetBufferSize()

size_t FxRequestOutputBuffer::GetBufferSize ( VOID )

virtual

Implements IFxMemory.

Definition at line 84 of file fxrequestoutputbuffer.cpp.

 {
     FxIrp* irp = GetRequest()->GetFxIrp();
 
     ASSERT(irp->GetMajorFunction() == IRP_MJ_DEVICE_CONTROL ||
            irp->GetMajorFunction() == IRP_MJ_INTERNAL_DEVICE_CONTROL);
 
     return irp->GetParameterIoctlOutputBufferLength();
 }

Referenced by FxRequest::CompleteInternal().

◆ GetDriverGlobals()

PFX_DRIVER_GLOBALS FxRequestOutputBuffer::GetDriverGlobals ( VOID )

virtual

Implements IFxMemory.

Definition at line 198 of file fxrequestoutputbuffer.cpp.

 {
     return GetRequest()->GetDriverGlobals();
 }

◆ GetFlags()

USHORT FxRequestOutputBuffer::GetFlags ( VOID )

virtual

Implements IFxMemory.

Definition at line 163 of file fxrequestoutputbuffer.cpp.

 {
     FxIrp* irp = GetRequest()->GetFxIrp();
 
     ASSERT(irp->GetMajorFunction() == IRP_MJ_DEVICE_CONTROL ||
            irp->GetMajorFunction() == IRP_MJ_INTERNAL_DEVICE_CONTROL);
 
     switch (irp->GetParameterIoctlCodeBufferMethod()) {
     case METHOD_IN_DIRECT:
         return IFxMemoryFlagReadOnly;
 
     case METHOD_BUFFERED:
     case METHOD_OUT_DIRECT:
     case METHOD_NEITHER: // since it is neither, we can't tell, so leave it as 0
     default:
         return 0;
     }
 }

◆ GetHandle()

WDFMEMORY FxRequestOutputBuffer::GetHandle ( VOID )

virtual

Implements IFxMemory.

Definition at line 142 of file fxrequestoutputbuffer.cpp.

 {
     return GetRequest()->GetMemoryHandle(
         FIELD_OFFSET(FxRequest, m_OutputBufferOffset));
 }

Referenced by FxRequest::CompleteInternal().

◆ GetMdl()

_Must_inspect_result_ PMDL FxRequestOutputBuffer::GetMdl ( VOID )

virtual

Implements IFxMemory.

Definition at line 110 of file fxrequestoutputbuffer.cpp.

 {
     FxIrp* irp = GetRequest()->GetFxIrp();
 
     ASSERT(irp->GetMajorFunction() == IRP_MJ_DEVICE_CONTROL ||
            irp->GetMajorFunction() == IRP_MJ_INTERNAL_DEVICE_CONTROL);
 
     switch (irp->GetParameterIoctlCodeBufferMethod()) {
     case METHOD_IN_DIRECT:
     case METHOD_OUT_DIRECT:
         return m_Mdl;
 
     default:
         return NULL;
     }
 }

Referenced by FxRequest::CompleteInternal().

◆ GetRequest()

FxRequest * FxRequestOutputBuffer::GetRequest ( VOID )

protected

Definition at line 286 of file fxrequestoutputbuffer.cpp.

 {
     return CONTAINING_RECORD(this, FxRequest, m_OutputBuffer);
 }

Referenced by AddRef(), GetBuffer(), GetBufferSize(), GetDriverGlobals(), GetFlags(), GetHandle(), GetMdl(), and Release().

◆ IsBufferSet()

__inline BOOLEAN FxRequestOutputBuffer::IsBufferSet ( VOID )

inline

Definition at line 314 of file fxrequest.hpp.

     {
         return m_Buffer != NULL ? TRUE : FALSE;
     }

Referenced by FxRequest::AssignMemoryBuffers().

◆ Release()

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

virtual

Implements IFxMemory.

Definition at line 252 of file fxrequestoutputbuffer.cpp.

 {
     UNREFERENCED_PARAMETER(Tag);
     UNREFERENCED_PARAMETER(Line);
     UNREFERENCED_PARAMETER(File);
 
     GetRequest()->ReleaseIrpReference();
 
     return 1;
 }

◆ SetBuffer()

__inline VOID FxRequestOutputBuffer::SetBuffer ( __in PVOID Buffer )

inlineprotected

Definition at line 334 of file fxrequest.hpp.

     {
         ASSERT(m_Buffer == NULL);
         m_Buffer = Buffer;
     }

Referenced by FxRequest::AssignMemoryBuffers().

◆ SetMdl()

__inline VOID FxRequestOutputBuffer::SetMdl ( __in PMDL Mdl )

inlineprotected

Definition at line 344 of file fxrequest.hpp.

     {
         ASSERT(m_Mdl == NULL);
         m_Mdl = Mdl;
     }

Referenced by FxRequest::GetDeviceControlOutputMemoryObject().

Member Data Documentation

◆ @4585

union { ... }

◆ FxRequest

friend FxRequestOutputBuffer::FxRequest

Definition at line 243 of file fxrequest.hpp.

◆ m_Buffer

PVOID FxRequestOutputBuffer::m_Buffer

Definition at line 365 of file fxrequest.hpp.

Referenced by ClearBufferMdl(), FxRequestOutputBuffer(), GetBuffer(), FxRequest::GetDeviceControlOutputMemoryObject(), IsBufferSet(), and SetBuffer().

◆ m_Mdl

PMDL FxRequestOutputBuffer::m_Mdl

Definition at line 366 of file fxrequest.hpp.

Referenced by ClearBufferMdl(), GetBuffer(), FxRequest::GetDeviceControlOutputMemoryObject(), GetMdl(), and SetMdl().

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxRequestOutputBuffer()

Member Function Documentation

◆ AddRef()

◆ ClearBufferMdl()

◆ Delete()

◆ GetBuffer()

◆ GetBufferSize()

◆ GetDriverGlobals()

◆ GetFlags()

◆ GetHandle()

◆ GetMdl()

◆ GetRequest()

◆ IsBufferSet()

◆ Release()

◆ SetBuffer()

◆ SetMdl()

Member Data Documentation

◆ @4585

◆ FxRequest

◆ m_Buffer

◆ m_Mdl