#include <fxrequest.hpp>

Inheritance diagram for FxRequestSystemBuffer:

Collaboration diagram for FxRequestSystemBuffer:

[legend]

Public Member Functions
	FxRequestSystemBuffer (VOID)

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

Public Attributes
friend	FxRequest

PVOID	m_Buffer

PMDL	m_Mdl

Protected Member Functions
__inline VOID	SetBuffer (PVOID Buffer)

__inline VOID	SetMdl (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 95 of file fxrequest.hpp.

Constructor & Destructor Documentation

◆ FxRequestSystemBuffer()

FxRequestSystemBuffer::FxRequestSystemBuffer ( VOID )

inline

Definition at line 99 of file fxrequest.hpp.

    {
        m_Buffer = NULL;
    }

Member Function Documentation

◆ AddRef()

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

virtual

Implements IFxMemory.

Definition at line 205 of file fxrequestsystembuffer.cpp.

{
    UNREFERENCED_PARAMETER(Tag);
    UNREFERENCED_PARAMETER(Line);
    UNREFERENCED_PARAMETER(File);
 
    GetRequest()->AddIrpReference();
 
    //
    // This value should never be used by the caller
    //
    return 2;
}

◆ ClearBufferMdl()

__inline VOID FxRequestSystemBuffer::ClearBufferMdl ( VOID )

inline

Definition at line 177 of file fxrequest.hpp.

    {
        m_Buffer = NULL;
        m_Mdl = NULL;
    }

Referenced by FxRequest::ClearFieldsForReuse().

◆ Delete()

VOID FxRequestSystemBuffer::Delete ( VOID )

virtual

Implements IFxMemory.

Definition at line 296 of file fxrequestsystembuffer.cpp.

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

◆ GetBuffer()

_Must_inspect_result_ PVOID FxRequestSystemBuffer::GetBuffer ( VOID )

virtual

Implements IFxMemory.

Definition at line 38 of file fxrequestsystembufferkm.cpp.

{
    FxDevice* pDevice;
    FxIrp* irp = GetRequest()->GetFxIrp();
    WDF_DEVICE_IO_TYPE ioType;
 
    switch (irp->GetMajorFunction()) {
    case IRP_MJ_DEVICE_CONTROL:
    case IRP_MJ_INTERNAL_DEVICE_CONTROL:
        return m_Buffer;
 
    case IRP_MJ_READ:
    case IRP_MJ_WRITE:
        pDevice = FxDevice::GetFxDevice(irp->GetDeviceObject());
        ioType = pDevice->GetIoType();
 
        switch (ioType) {
        case WdfDeviceIoBuffered:
            return m_Buffer;
 
        case WdfDeviceIoDirect:
            //
            // FxRequest::GetMemoryObject 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 WdfDeviceIoNeither:
            return m_Buffer;
 
        default:
            ASSERT(FALSE);
            return NULL;
        }
 
    default:
        ASSERT(FALSE);
        return NULL;
    }
}

Referenced by FxRequest::CompleteInternal().

◆ GetBufferSize()

size_t FxRequestSystemBuffer::GetBufferSize ( VOID )

virtual

Implements IFxMemory.

Definition at line 37 of file fxrequestsystembuffer.cpp.

{
    FxIrp* irp = GetRequest()->GetFxIrp();
 
    switch (irp->GetMajorFunction()) {
    case IRP_MJ_READ:
        return irp->GetParameterReadLength();
 
    case IRP_MJ_WRITE:
        return irp->GetParameterWriteLength();
 
    case IRP_MJ_DEVICE_CONTROL:
    case IRP_MJ_INTERNAL_DEVICE_CONTROL:
        return irp->GetParameterIoctlInputBufferLength();
 
    default:
        // should not get here
        ASSERT(FALSE);
        return 0;
    }
}

Referenced by FxRequest::CompleteInternal().

◆ GetDriverGlobals()

PFX_DRIVER_GLOBALS FxRequestSystemBuffer::GetDriverGlobals ( VOID )

virtual

Implements IFxMemory.

Definition at line 185 of file fxrequestsystembuffer.cpp.

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

◆ GetFlags()

USHORT FxRequestSystemBuffer::GetFlags ( VOID )

virtual

Implements IFxMemory.

Definition at line 140 of file fxrequestsystembuffer.cpp.

{
    FxIrp* irp = GetRequest()->GetFxIrp();
 
    switch (irp->GetMajorFunction()) {
    case IRP_MJ_DEVICE_CONTROL:
    case IRP_MJ_INTERNAL_DEVICE_CONTROL:
        switch (irp->GetParameterIoctlCodeBufferMethod()) {
        case METHOD_BUFFERED:
        case METHOD_NEITHER:
            return 0;
 
        case METHOD_IN_DIRECT:
        case METHOD_OUT_DIRECT:
            return IFxMemoryFlagReadOnly;
        }
 
    case IRP_MJ_READ:
        return 0;
 
    case IRP_MJ_WRITE:
        return IFxMemoryFlagReadOnly;
 
    default:
        ASSERT(FALSE);
        return 0;
    }
}

◆ GetHandle()

WDFMEMORY FxRequestSystemBuffer::GetHandle ( VOID )

virtual

Implements IFxMemory.

Definition at line 119 of file fxrequestsystembuffer.cpp.

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

Referenced by FxRequest::CompleteInternal().

◆ GetMdl()

_Must_inspect_result_ PMDL FxRequestSystemBuffer::GetMdl ( VOID )

virtual

Implements IFxMemory.

Definition at line 75 of file fxrequestsystembuffer.cpp.

{
    FxDevice* pDevice;
    FxIrp* irp = GetRequest()->GetFxIrp();
 
    switch (irp->GetMajorFunction()) {
    case IRP_MJ_READ:
    case IRP_MJ_WRITE:
        pDevice = FxDevice::GetFxDevice(irp->GetDeviceObject());
 
        if (pDevice->GetIoType() == WdfDeviceIoDirect) {
            return m_Mdl;
        }
        //    ||  ||       Fall through  ||   ||
        //    \/  \/                     \/   \/
 
    case IRP_MJ_DEVICE_CONTROL:
    case IRP_MJ_INTERNAL_DEVICE_CONTROL:
        //
        // For IOCLs, the outbuffer will return the PMDL
        //
        //    ||  ||       Fall through  ||   ||
        //    \/  \/                     \/   \/
 
    default:
        return NULL;
    }
}

Referenced by FxRequest::CompleteInternal().

◆ GetRequest()

FxRequest * FxRequestSystemBuffer::GetRequest ( VOID )

protected

Definition at line 276 of file fxrequestsystembuffer.cpp.

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

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

◆ IsBufferSet()

__inline BOOLEAN FxRequestSystemBuffer::IsBufferSet ( VOID )

inline

Definition at line 168 of file fxrequest.hpp.

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

Referenced by FxRequest::AssignMemoryBuffers().

◆ Release()

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

virtual

Implements IFxMemory.

Definition at line 242 of file fxrequestsystembuffer.cpp.

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

◆ SetBuffer()

__inline VOID FxRequestSystemBuffer::SetBuffer ( PVOID Buffer )

inlineprotected

Definition at line 188 of file fxrequest.hpp.

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

Referenced by FxRequest::AssignMemoryBuffers().

◆ SetMdl()

__inline VOID FxRequestSystemBuffer::SetMdl ( PMDL Mdl )

inlineprotected

Definition at line 198 of file fxrequest.hpp.

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

Referenced by FxRequest::GetMemoryObject().

Member Data Documentation

◆

union { ... } FxRequestSystemBuffer::@5086

◆ FxRequest

friend FxRequestSystemBuffer::FxRequest

Definition at line 96 of file fxrequest.hpp.

◆ m_Buffer

PVOID FxRequestSystemBuffer::m_Buffer

Definition at line 237 of file fxrequest.hpp.

Referenced by ClearBufferMdl(), FxRequestSystemBuffer(), GetBuffer(), FxRequest::GetMemoryObject(), IsBufferSet(), and SetBuffer().

◆ m_Mdl

PMDL FxRequestSystemBuffer::m_Mdl

Definition at line 238 of file fxrequest.hpp.

Referenced by ClearBufferMdl(), GetBuffer(), GetMdl(), FxRequest::GetMemoryObject(), 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/fxrequestsystembuffer.cpp
sdk/lib/drivers/wdf/shared/core/km/fxrequestsystembufferkm.cpp
sdk/lib/drivers/wdf/shared/core/um/fxrequestsystembufferum.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxRequestSystemBuffer()

Member Function Documentation

◆ AddRef()

◆ ClearBufferMdl()

◆ Delete()

◆ GetBuffer()

◆ GetBufferSize()

◆ GetDriverGlobals()

◆ GetFlags()

◆ GetHandle()

◆ GetMdl()

◆ GetRequest()

◆ IsBufferSet()

◆ Release()

◆ SetBuffer()

◆ SetMdl()

Member Data Documentation

◆

◆ FxRequest

◆ m_Buffer

◆ m_Mdl