#include <fxiotarget.hpp>

Inheritance diagram for FxIoContext:

Collaboration diagram for FxIoContext:

[legend]

Public Member Functions
	FxIoContext (VOID)

virtual	~FxIoContext (VOID)

VOID	StoreAndReferenceOtherMemory (__in FxRequestBuffer *Buffer)

virtual VOID	ReleaseAndRestore (__in FxRequestBase *Request)

VOID	ClearBuffer (VOID)

VOID	SetBufferAndLength (__in PVOID Buffer, __in size_t BufferLength, __in BOOLEAN CopyBackToBuffer)

VOID	CopyParameters (__in FxRequestBase *Request)

VOID	CaptureState (__in FxIrp *Irp)

VOID	SwapIrpBuffer (_In_ FxRequestBase *Request, _In_ ULONG NewInputBufferCb, _In_reads_bytes_opt_(NewInputBufferCb) PVOID NewInputBuffer, _In_ ULONG NewOutputBufferCb, _In_reads_bytes_opt_(NewOutputBufferCb) PVOID NewOutputBuffer)

Public Member Functions inherited from FxRequestContext
	FxRequestContext (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual	~FxRequestContext (VOID)

virtual VOID	Dispose (VOID)

virtual VOID	StoreAndReferenceMemory (__in FxRequestBuffer *Buffer)

virtual VOID	ReleaseAndRestore (__in FxRequestBase *Request)

__inline BOOLEAN	IsType (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual VOID	CopyParameters (__in FxRequestBase *Request)

VOID	FormatWriteParams (__in_opt IFxMemory *WriteMemory, __in_opt PWDFMEMORY_OFFSET WriteOffsets)

VOID	FormatReadParams (__in_opt IFxMemory *ReadMemory, __in_opt PWDFMEMORY_OFFSET ReadOffsets)

VOID	FormatOtherParams (__in FxInternalIoctlParams *InternalIoctlParams)

Public Member Functions inherited from FxStump
PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in POOL_TYPE PoolType)

VOID	operator delete (__in PVOID pointer)

PVOID	operator new[] (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

VOID	operator delete[] (__in PVOID pointer)

Public Attributes
PVOID	m_BufferToFree

PVOID	m_OriginalSystemBuffer

PVOID	m_OriginalUserBuffer

PMDL	m_MdlToFree

union {
PMDL m_OriginalMdl

PFX_DRIVER_GLOBALS m_DriverGlobals

};

ULONG	m_OriginalFlags

size_t	m_BufferToFreeLength

size_t	m_MdlToFreeSize

BOOLEAN	m_CopyBackToBuffer

BOOLEAN	m_UnlockPages

BOOLEAN	m_RestoreState

UCHAR	m_MajorFunction

IFxMemory *	m_OtherMemory

Public Attributes inherited from FxRequestContext
WDF_REQUEST_COMPLETION_PARAMS	m_CompletionParams

IFxMemory *	m_RequestMemory

FX_REQUEST_CONTEXT_TYPE	m_RequestType

Additional Inherited Members
Protected Member Functions inherited from FxRequestContext
VOID __inline	InitCompletionParams (VOID)

Protected Member Functions inherited from FxStump
	FxStump (VOID)

Static Protected Member Functions inherited from FxRequestContext
static VOID	_StoreAndReferenceMemoryWorker (__in PVOID Tag, __deref_out_opt IFxMemory *PPMemory, __in FxRequestBuffer Buffer)

Detailed Description

Definition at line 32 of file fxiotarget.hpp.

Constructor & Destructor Documentation

◆ FxIoContext()

__inline FxIoContext::FxIoContext ( VOID )

Definition at line 32 of file fxiotargetkm.hpp.

      :
    FxRequestContext(FX_RCT_IO),
    m_MdlToFree(NULL),
    m_OriginalMdl(NULL),
    m_BufferToFree(NULL),
    m_OriginalSystemBuffer(NULL),
    m_OriginalUserBuffer(NULL),
    m_OtherMemory(NULL),
    m_CopyBackToBuffer(FALSE),
    m_UnlockPages(FALSE),
    m_RestoreState(FALSE),
    m_BufferToFreeLength(0),
    m_MdlToFreeSize(0)
{
}

◆ ~FxIoContext()

__inline FxIoContext::~FxIoContext ( VOID )

virtual

Definition at line 51 of file fxiotargetkm.hpp.

{
    //
    // Free the buffer allocated for the request, reset m_CopyBackToBuffer
    // to FALSE.
    // NOTE: We delay the freeing of the buffer on purpose.
    //
    ClearBuffer();
 
    //
    // Free the MDL allocated for the request
    //
    if (m_MdlToFree != NULL) {
        //
        // Being defensive here, MmUnlockPages should have been done in
        // ReleaseAndRestore.
        //
        if (m_UnlockPages) {
            MmUnlockPages(m_MdlToFree);
            m_UnlockPages = FALSE;
        }
 
        FxMdlFree(m_DriverGlobals, m_MdlToFree);
        m_MdlToFree = NULL;
    }
}

Member Function Documentation

◆ CaptureState()

__inline VOID FxIoContext::CaptureState ( __in FxIrp * Irp )

Definition at line 202 of file fxiotargetkm.hpp.

{
    m_RestoreState = TRUE;
    m_OriginalSystemBuffer = Irp->GetSystemBuffer();
    m_OriginalUserBuffer = Irp->GetUserBuffer();
    m_OriginalMdl = Irp->GetMdl();
    m_OriginalFlags = Irp->GetFlags();
}

Referenced by FxIoTarget::FormatIoctlRequest(), and FxIoTarget::FormatIoRequest().

◆ ClearBuffer()

__inline VOID FxIoContext::ClearBuffer ( VOID )

Definition at line 135 of file fxiotargetkm.hpp.

{
    if (m_BufferToFree != NULL) {
        FxPoolFree(m_BufferToFree);
        m_BufferToFree = NULL;
    }
 
    m_BufferToFreeLength = 0;
    m_CopyBackToBuffer = FALSE;
}

Referenced by ~FxIoContext().

◆ CopyParameters()

__inline VOID FxIoContext::CopyParameters ( __in FxRequestBase * Request )

virtual

Reimplemented from FxRequestContext.

Definition at line 150 of file fxiotargetkm.hpp.

{
    switch (m_MajorFunction) {
    case IRP_MJ_WRITE:
        m_CompletionParams.Parameters.Write.Length =
            m_CompletionParams.IoStatus.Information;
        break;
 
    case IRP_MJ_READ:
        m_CompletionParams.Parameters.Read.Length =
            m_CompletionParams.IoStatus.Information;
        break;
 
    case IRP_MJ_DEVICE_CONTROL:
    case IRP_MJ_INTERNAL_DEVICE_CONTROL:
        m_CompletionParams.Parameters.Ioctl.Output.Length =
            m_CompletionParams.IoStatus.Information;
        break;
 
    default:
        ASSERT(FALSE);
    }
 
    if (m_BufferToFree == NULL) {
        return;
    }
 
    if (m_CopyBackToBuffer) {
        FxIrp* irp = Request->GetSubmitFxIrp();
 
        if (irp->GetUserBuffer() != NULL) {
            //
            // UserBuffer contains the caller's original output buffer.
            // Copy the results back into the original buffer.
            //
            if (m_MajorFunction == IRP_MJ_DEVICE_CONTROL ||
                m_MajorFunction == IRP_MJ_INTERNAL_DEVICE_CONTROL) {
                ASSERT(irp->GetInformation() <= m_BufferToFreeLength);
            }
 
            RtlCopyMemory(irp->GetUserBuffer(),
                          m_BufferToFree,
                          irp->GetInformation());
            m_CopyBackToBuffer = FALSE;
        }
    }
}

◆ ReleaseAndRestore()

__inline VOID FxIoContext::ReleaseAndRestore ( __in FxRequestBase * Request )

virtual

Reimplemented from FxRequestContext.

Definition at line 82 of file fxiotargetkm.hpp.

{
    FxIrp* irp = NULL;
 
    irp = Request->GetSubmitFxIrp();
 
    if (m_RestoreState) {
        irp->SetSystemBuffer(m_OriginalSystemBuffer);
        irp->SetUserBuffer(m_OriginalUserBuffer);
        irp->SetMdlAddress(m_OriginalMdl);
        irp->SetFlags(m_OriginalFlags);
        m_OriginalSystemBuffer = NULL;
        m_OriginalUserBuffer = NULL;
        m_OriginalMdl = NULL;
        m_OriginalFlags = NULL;
 
        m_RestoreState = FALSE;
    }
 
    //
    // If there was a buffer present don't free the buffer here so that
    // it can be reused for any request with the same size.
    // Similarly if there was an MDL to be freed unlock the pages but dont free
    // the Mdl so that it can be reused.
    //
    if (m_MdlToFree != NULL) {
        if (m_UnlockPages) {
            MmUnlockPages(m_MdlToFree);
            m_UnlockPages = FALSE;
        }
 
 
        m_DriverGlobals = Request->GetDriverGlobals();
    }
 
    //
    // Release the 2ndary buffer if we have an outstanding reference
    //
    if (m_OtherMemory != NULL) {
        m_OtherMemory->RELEASE(this);
        m_OtherMemory = NULL;
    }
 
    //
    // Release the other buffer and all __super related fields
    //
    FxRequestContext::ReleaseAndRestore(Request); // __super call
}

◆ SetBufferAndLength()

__inline VOID FxIoContext::SetBufferAndLength	(	__in PVOID	Buffer,
		__in size_t	BufferLength,
		__in BOOLEAN	CopyBackToBuffer
	)

Definition at line 215 of file fxiotargetkm.hpp.

{
    PVOID pOldBuffer;
 
    pOldBuffer = m_BufferToFree;
    m_BufferToFree = Buffer;
    m_BufferToFreeLength = BufferLength;
    m_CopyBackToBuffer = CopyBackToBuffer;
 
    if (pOldBuffer != NULL) {
        FxPoolFree(pOldBuffer);
    }
}

Referenced by FxIoTarget::FormatIoctlRequest(), and FxIoTarget::FormatIoRequest().

◆ StoreAndReferenceOtherMemory()

VOID FxIoContext::StoreAndReferenceOtherMemory ( __in FxRequestBuffer * Buffer )

inline

Definition at line 44 of file fxiotarget.hpp.

    {
        _StoreAndReferenceMemoryWorker(this, &m_OtherMemory, Buffer);
    }

Referenced by FxIoTarget::FormatIoctlRequest().

◆ SwapIrpBuffer()

__inline VOID FxIoContext::SwapIrpBuffer	(	_In_ FxRequestBase *	Request,
		_In_ ULONG	NewInputBufferCb,
		_In_reads_bytes_opt_(NewInputBufferCb) PVOID	NewInputBuffer,
		_In_ ULONG	NewOutputBufferCb,
		_In_reads_bytes_opt_(NewOutputBufferCb) PVOID	NewOutputBuffer
	)

Definition at line 115 of file fxiotargetum.hpp.

{
    FxIrp* irp = NULL;
 
    irp = Request->GetSubmitFxIrp();
 
    m_RestoreState = TRUE;
    irp->GetIoIrp()->SwapCurrentBuffer(
                                       true,
                                       NewInputBufferCb,
                                       NewInputBuffer,
                                       NewOutputBufferCb,
                                       NewOutputBuffer,
                                       &m_OriginalBufferInfo
                                       );
}