#include <fxfileobject.hpp>

Inheritance diagram for FxFileObject:

[legend]

Collaboration diagram for FxFileObject:

[legend]

Public Member Functions
	FxFileObject (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in MdFileObject pWdmFileObject, __in FxDevice *Device)

virtual	~FxFileObject ()

__inline WDFFILEOBJECT	GetHandle (VOID)

__inline MdFileObject	GetWdmFileObject (VOID)

__inline CfxDevice *	GetDevice (VOID)

__inline PUNICODE_STRING	GetFileName (VOID)

__inline PLARGE_INTEGER	GetCurrentByteOffset (VOID)

__inline ULONG	GetFlags (VOID)

__inline VOID	SetPkgCleanupCloseContext (PVOID Context)

__inline PVOID	GetPkgCleanupCloseContext (VOID)

VOID	Initialize (_In_ MdIrp CreateIrp)

VOID	DeleteFileObjectFromFailedCreate (VOID)

_Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)

VOID	GetConstraints (__in WDF_EXECUTION_LEVEL ExecutionLevel, __in WDF_SYNCHRONIZATION_SCOPE SynchronizationScope)

_Must_inspect_result_ FxCallbackLock *	GetCallbackLockPtr (__deref_out_opt FxObject **LockObject)

_Must_inspect_result_ NTSTATUS	UpdateProcessKeepAliveCount (_In_ BOOLEAN Increment)

FxFileObject *	GetRelatedFileObject (VOID)

Public Member Functions inherited from FxNonPagedObject
	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

virtual	~FxNonPagedObject (VOID)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL PreviousIrql)

	_Releases_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID Unlock(__in __drv_restoresIRQL KIRQL PreviousIrql)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID LockAtDispatch(VOID)

	_Requires_lock_held_ (this->m_NPLock.m_Lock) _Releases_lock_(this -> m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID UnlockFromDispatch(VOID)

Public Member Functions inherited from FxObject
PVOID	GetCOMWrapper ()

void	SetCOMWrapper (__drv_aliasesMem PVOID Wrapper)

	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

virtual	~FxObject (VOID)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType Type)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in USHORT ExtraSize=0)

VOID	operator delete (__in PVOID Memory)

VOID	SetNoContextHeader (VOID)

PVOID __inline	GetObjectHandle (VOID)

__inline FxContextHeader *	GetContextHeader (VOID)

__inline PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)

WDFTYPE	GetType (VOID)

USHORT	GetObjectSize (VOID)

LONG	GetRefCnt (VOID)

FxTagTracker *	GetTagTracker (VOID)

CfxDevice *	GetDevice (VOID)

CfxDeviceBase *	GetDeviceBase (VOID)

VOID	SetDeviceBase (__in CfxDeviceBase *DeviceBase)

__inline VOID	CallCleanup (VOID)

ULONG __inline	AddRef (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	Release (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	AddRefOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	ReleaseOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual _Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)

VOID	MarkTraceState (VOID)

BOOLEAN __inline	IsTraceState (VOID)

VOID __inline	TraceDroppedEvent (__in FxObjectDroppedEvent Event)

VOID	MarkPassiveDispose (__in FxObjectLockState State=ObjectLock)

VOID	MarkPassiveCallbacks (__in FxObjectLockState State=ObjectLock)

VOID	MarkForceDisposeThread (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsPassiveCallbacks (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsPassiveDispose (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsForceDisposeThread (__in BOOLEAN AcquireLock=TRUE)

VOID	MarkCommitted (VOID)

BOOLEAN	IsCommitted (VOID)

VOID	MarkDisposeOverride (__in FxObjectLockState State=ObjectLock)

VOID	MarkNoDeleteDDI (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsNoDeleteDDI (VOID)

_Must_inspect_result_ NTSTATUS	Commit (__in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out_opt WDFOBJECT ObjectHandle, __in_opt FxObject Parent=NULL, __in BOOLEAN AssignDriverAsDefaultParent=TRUE)

VOID	DeleteFromFailedCreate (VOID)

VOID	ClearEvtCallbacks (VOID)

BOOLEAN	EarlyDispose (VOID)

virtual VOID	DeleteObject (VOID)

virtual BOOLEAN	Dispose (VOID)

_Must_inspect_result_ NTSTATUS	AssignParentObject (__in FxObject *ParentObject)

_Must_inspect_result_ NTSTATUS	AddContext (__in FxContextHeader Header, __in PVOID Context, __in PWDF_OBJECT_ATTRIBUTES Attributes)

_Must_inspect_result_ NTSTATUS	RemoveParentAssignment (VOID)

_Must_inspect_result_ FxObject *	GetParentObjectReferenced (__in PVOID Tag)

BOOLEAN	IsDisposed (VOID)

Public Member Functions inherited from IFxHasCallbacks
virtual VOID	GetConstraints (__out WDF_EXECUTION_LEVEL ExecutionLevel, __out WDF_SYNCHRONIZATION_SCOPE SynchronizationScope)=0

virtual _Must_inspect_result_ FxCallbackLock *	GetCallbackLockPtr (__out_opt FxObject **LockObject)=0

Static Public Member Functions
static _Must_inspect_result_ NTSTATUS	_CreateFileObject (__in FxDevice pDevice, __in MdIrp Irp, __in WDF_FILEOBJECT_CLASS FileObjectClass, __in_opt PWDF_OBJECT_ATTRIBUTES pObjectAttributes, __in_opt MdFileObject pWdmFileObject, __deref_out_opt FxFileObject *ppFxFileObject)

static VOID	_DestroyFileObject (__in FxDevice *pDevice, __in WDF_FILEOBJECT_CLASS FileObjectClass, __in_opt MdFileObject pWdmFileObject)

static _Must_inspect_result_ NTSTATUS	_GetFileObjectFromWdm (__in FxDevice pDevice, __in WDF_FILEOBJECT_CLASS FileObjectClass, __in_opt MdFileObject pWdmFileObject, __deref_out_opt FxFileObject *ppFxFileObject)

Static Public Member Functions inherited from FxObject
static FxObject *	_FromDisposeEntry (__in PSINGLE_LIST_ENTRY Entry)

static FxObject *	_GetObjectFromHandle (__in WDFOBJECT Handle, __inout PWDFOBJECT_OFFSET ObjectOffset)

static PVOID __inline	_ToHandle (__in FxObject *Object)

static VOID __inline	_ReferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static VOID __inline	_DereferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static PVOID	_GetDebugBase (__in FxObject *Object)

static PFX_POOL_HEADER	_CleanupPointer (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Object)

static _Must_inspect_result_ NTSTATUS	_GetEffectiveLock (__in FxObject Object, __in_opt IFxHasCallbacks Callbacks, __in BOOLEAN AutomaticLocking, __in BOOLEAN PassiveCallbacks, __out FxCallbackLock CallbackLock, __out_opt FxObject CallbackLockObject)

static _Must_inspect_result_ NTSTATUS	_ObjectQuery (_In_ FxObject Object, _In_ CONST GUID Guid, _In_ ULONG QueryBufferLength, _Out_writes_bytes_(QueryBufferLength) PVOID QueryBuffer)

Public Attributes
LIST_ENTRY	m_Link

Private Member Functions
VOID	SetFileObjectContext (_In_ MdFileObject WdmFileObject, _In_ WDF_FILEOBJECT_CLASS NormalizedFileClass, _In_ MdIrp Irp, _In_ FxDevice *Device)

Private Attributes
MxFileObject	m_FileObject

PVOID	m_PkgContext

UNICODE_STRING	m_FileName

FxFileObject *	m_RelatedFileObject

Additional Inherited Members
Protected Member Functions inherited from FxObject
	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

FxObjectDebugExtension *	GetDebugExtension (VOID)

BOOLEAN	IsDebug (VOID)

VOID	AllocateTagTracker (__in WDFTYPE Type)

virtual VOID	SelfDestruct (VOID)

PVOID __inline	GetObjectHandleUnchecked (VOID)

VOID __inline	DestroyChildren (VOID)

VOID	DeleteEarlyDisposedObject (VOID)

Static Protected Member Functions inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Detailed Description

Definition at line 29 of file fxfileobject.hpp.

Constructor & Destructor Documentation

◆ FxFileObject()

FxFileObject::FxFileObject	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in MdFileObject	pWdmFileObject,
		__in FxDevice *	Device
	)

Definition at line 38 of file fxfileobject.cpp.

      :
    FxNonPagedObject(FX_TYPE_FILEOBJECT, sizeof(FxFileObject), FxDriverGlobals)
{
    m_FileObject.SetFileObject(pWdmFileObject);
    m_PkgContext = NULL;
    m_Device = pDevice;
 
#if (FX_CORE_MODE == FX_CORE_USER_MODE)
    RtlInitUnicodeString(&m_FileName, NULL);
    m_RelatedFileObject = NULL;
#endif
 
    //
    // Cannot be deleted by the device driver
    //
    MarkNoDeleteDDI();
}

◆ ~FxFileObject()

FxFileObject::~FxFileObject ( )

virtual

Definition at line 60 of file fxfileobject.cpp.

{
#if (FX_CORE_MODE == FX_CORE_USER_MODE)
    SAFE_RELEASE(m_RelatedFileObject);
#endif
}

Member Function Documentation

◆ _CreateFileObject()

_Must_inspect_result_ NTSTATUS FxFileObject::_CreateFileObject	(	__in FxDevice *	pDevice,
		__in MdIrp	Irp,
		__in WDF_FILEOBJECT_CLASS	FileObjectClass,
		__in_opt PWDF_OBJECT_ATTRIBUTES	pObjectAttributes,
		__in_opt MdFileObject	pWdmFileObject,
		__deref_out_opt FxFileObject **	ppFxFileObject
	)

static

Definition at line 72 of file fxfileobject.cpp.

{
    NTSTATUS Status;
    FxFileObject* pfo;
    KIRQL irql;
    WDF_FILEOBJECT_CLASS normalizedFileClass;
 
    PFX_DRIVER_GLOBALS FxDriverGlobals = pDevice->GetDriverGlobals();
 
    //
    // Create does require a WDM file obj based on the normalized file obj
    // class value.
    //
    normalizedFileClass = FxFileObjectClassNormalize(FileObjectClass);
 
    //
    // No FileObject support
    //
    if( normalizedFileClass == WdfFileObjectNotRequired ) {
        if( pFileObject != NULL ) *pFileObject = NULL;
        return STATUS_SUCCESS;
    }
 
    //
    // If fileobject support was specified, and a NULL
    // WDM PFILE_OBJECT is supplied, then it's an error
    //
    if( pWdmFileObject == NULL ) {
 
        //
        // Seems like some filter driver above us sending a create without fileobject.
        // We support this only if the FileObjectClass class is set to
        // WdfFileObjectWdfCannotUseFsContexts and device is created to be
        // exclusive.
        //
        if ( normalizedFileClass == WdfFileObjectWdfCannotUseFsContexts  &&
             pDevice->IsExclusive() ) {
 
            DO_NOTHING();
 
        } else {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIO,
              "WdfFileObjectWdfCanUseFsContexts is specified, but the Create "
              "IRP %p doesn't have a fileObject\n",
              Irp);
            FxVerifierDbgBreakPoint(pDevice->GetDriverGlobals());
            return STATUS_DEVICE_CONFIGURATION_ERROR;
        }
 
    }
 
    // Allocate a new FxFileObject with context
    pfo = new(pDevice->GetDriverGlobals(), pObjectAttributes)
             FxFileObject(pDevice->GetDriverGlobals(), pWdmFileObject, pDevice);
 
    if( pfo == NULL ) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    pfo->Initialize(Irp);
 
    // Assign FxDevice as the parent for the file object
    Status = pfo->Commit(pObjectAttributes, NULL, pDevice);
    if( !NT_SUCCESS(Status) ) {
        pfo->DeleteFromFailedCreate();
        return Status;
    }
 
    //
    // Place it on the list of FxFileObject's for this FxDevice
    //
    pDevice->Lock(&irql);
    InsertHeadList(&pDevice->m_FileObjectListHead, &pfo->m_Link);
    pDevice->Unlock(irql);
 
    //
    // Set file object context in mode-specific manner
    //
    pfo->SetFileObjectContext(pWdmFileObject,
                              normalizedFileClass,
                              Irp,
                              pDevice);
 
    // FxFileObject* to caller
    if( pFileObject != NULL ) {
        *pFileObject = pfo;
    }
 
    return STATUS_SUCCESS;
}

Referenced by FxPkgGeneral::OnCreate().

◆ _DestroyFileObject()

VOID FxFileObject::_DestroyFileObject	(	__in FxDevice *	pDevice,
		__in WDF_FILEOBJECT_CLASS	FileObjectClass,
		__in_opt MdFileObject	pWdmFileObject
	)

static

Definition at line 175 of file fxfileobject.cpp.

{
    FxFileObject* pfo = NULL;
    PFX_DRIVER_GLOBALS FxDriverGlobals = pDevice->GetDriverGlobals();
    WDF_FILEOBJECT_CLASS normalizedFileClass;
 
    //
    // Close does require a WDM file obj based on the normalized file obj
    // class value.
    //
    normalizedFileClass = FxFileObjectClassNormalize(FileObjectClass);
 
    if( normalizedFileClass == WdfFileObjectNotRequired ) {
        return;
    }
 
    //
    // Driver has specified file object support, and we
    // allocated one at Create, so they must pass one
    // to close, otherwise it's an error and we will leak
    // the file object.
    //
    MxFileObject wdmFileObject(pWdmFileObject);
    if( pWdmFileObject == NULL &&
        normalizedFileClass != WdfFileObjectWdfCannotUseFsContexts) {
 
        //
        // It's likely that IRP_MJ_CREATE had NULL for the Wdm FileObject as well.
        //
        // If a driver passes != NULL for Wdm FileObject to create, and NULL to
        // this routine, a WDF FxFileObject object leak will occur, which will
        // be reported at driver unload.
        //
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIO,
           "PFILE_OBJECT in close IRP is NULL, *Possible Leak of FxFileObject*\n");
 
        FxVerifierDbgBreakPoint(pDevice->GetDriverGlobals());
 
        return;
    }
    else if( normalizedFileClass == WdfFileObjectWdfCanUseFsContext ) {
        pfo = (FxFileObject*)wdmFileObject.GetFsContext();
        wdmFileObject.SetFsContext(NULL);
 
    }
    else if( normalizedFileClass == WdfFileObjectWdfCanUseFsContext2 ) {
        pfo = (FxFileObject*)wdmFileObject.GetFsContext2();
        wdmFileObject.SetFsContext2(NULL);
    }
    else {
        NTSTATUS status;
        //
        // We must find the associated FxFileObject from the list
        // on the device
        //
        status = FxFileObject::_GetFileObjectFromWdm(
                          pDevice,
                          WdfFileObjectWdfCannotUseFsContexts,
                          pWdmFileObject,
                          &pfo
                          );
 
        //
        // We should find it, unless a different one was passed to IRP_MJ_CLOSE
        // than to IRP_MJ_CREATE, which is an error.
        //
        if (NT_SUCCESS(status) == FALSE || pfo == NULL) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Could not find WDFFILEOBJECT for PFILE_OBJECT 0x%p",
                                pWdmFileObject);
 
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Did a different PFILE_OBJECT get passed to "
                            "IRP_MJ_CLOSE than did to IRP_MJ_CREATE?");
            FxVerifierDbgBreakPoint(pDevice->GetDriverGlobals());
        }
    }
 
    if( pfo != NULL ) {
        KIRQL irql;
 
        //
        // Remove it from the list of FxFileObjects on the FxDevice
        //
        pDevice->Lock(&irql);
        RemoveEntryList(&pfo->m_Link);
        pDevice->Unlock(irql);
 
        // Delete the file object
        pfo->DeleteObject();
    }
 
    return;
}

Referenced by FxPkgGeneral::CreateCompleted(), and FxPkgGeneral::OnClose().

◆ _GetFileObjectFromWdm()

_Must_inspect_result_ NTSTATUS FxFileObject::_GetFileObjectFromWdm	(	__in FxDevice *	pDevice,
		__in WDF_FILEOBJECT_CLASS	FileObjectClass,
		__in_opt MdFileObject	pWdmFileObject,
		__deref_out_opt FxFileObject **	ppFxFileObject
	)

static

Definition at line 279 of file fxfileobject.cpp.

{
    FxFileObject* pfo = NULL;
    PFX_DRIVER_GLOBALS FxDriverGlobals = pDevice->GetDriverGlobals();
    WDF_FILEOBJECT_CLASS normalizedFileClass;
 
    //
    // Normalize file object class value.
    //
    normalizedFileClass = FxFileObjectClassNormalize(FileObjectClass);
 
    //
    // No FileObject support
    //
    if( normalizedFileClass == WdfFileObjectNotRequired ) {
        *ppFxFileObject = NULL;
        return STATUS_SUCCESS;
    }
 
    if( pWdmFileObject == NULL ) {
 
        //
        // Warn if an I/O request has NULL for the WDM PFILE_OBJECT
        //
        if ( pDevice->IsExclusive() &&
             normalizedFileClass == WdfFileObjectWdfCannotUseFsContexts ) {
            //
            // We allow a NULL file object iff the device is exclusive and
            // we have to look up the WDFFILEOBJECT by PFILE_OBJECT value
            //
            DO_NOTHING();
        }
        else if ( FxIsFileObjectOptional(FileObjectClass) ) {
            //
            // Driver told us that it's able to handle this case.
            //
            *ppFxFileObject = NULL;
            return STATUS_SUCCESS;
        }
        else {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                                    "NULL passed for PFILE_OBJECT when FileObject "
                                    "support is requested in an I/O request");
            FxVerifierDbgBreakPoint(pDevice->GetDriverGlobals());
 
            return STATUS_UNSUCCESSFUL;
        }
    }
 
    //
    // Depending on the drivers configuration, we can quickly
    // get the FxFileObject* from FxContext, or FxContext2.
    //
    // Some drivers can not touch either of the FxContext(s), and
    // in that case we must resort to a list or hashtable.
    //
    MxFileObject wdmFileObject(pWdmFileObject);
    if( normalizedFileClass == WdfFileObjectWdfCanUseFsContext ) {
        pfo = (FxFileObject*)wdmFileObject.GetFsContext();
    }
    else if( normalizedFileClass == WdfFileObjectWdfCanUseFsContext2 ) {
        pfo = (FxFileObject*)wdmFileObject.GetFsContext2();
    }
    else {
        PLIST_ENTRY next;
        FxFileObject* f;
        KIRQL irql;
 
        //
        // Must look it up from the FxDevice->m_FileObjectListHead.
        //
        pfo = NULL;
 
        pDevice->Lock(&irql);
 
        next = pDevice->m_FileObjectListHead.Flink;
 
        if(pWdmFileObject == NULL) {
            //
            // If the pWdmFileObject is NULL then we will pass the first entry
            // in the list because the device must be exclusive and there
            // can be only one fileobject in the list.
            //
            ASSERT(IsListEmpty(&pDevice->m_FileObjectListHead) == FALSE);
 
            f = CONTAINING_RECORD(next, FxFileObject, m_Link);
            pfo = f;
 
        } else {
 
            while( next != &pDevice->m_FileObjectListHead ) {
                f = CONTAINING_RECORD(next, FxFileObject, m_Link);
 
                if( f->m_FileObject.GetFileObject()== pWdmFileObject ) {
                    pfo = f;
                    break;
                }
 
                next = next->Flink;
            }
        }
 
 
 
 
 
 
 
 
 
 
        if(pfo == NULL
             && pDevice->IsExclusive()
             && pDevice->GetMxDeviceObject()->GetDeviceType() == FILE_DEVICE_SERIAL_PORT
             && !IsListEmpty(&pDevice->m_FileObjectListHead)) {
 
            f = CONTAINING_RECORD(pDevice->m_FileObjectListHead.Flink,
                                    FxFileObject, m_Link);
            pfo = f;
 
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGDEVICE,
                            "The PFILE_OBJECT 0x%p in this request (cleanup/close) "
                            "is different from the one specified in "
                            "create request 0x%p.This is bad!", pWdmFileObject,
                            ((f != NULL) ? f->m_FileObject.GetFileObject(): NULL));
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGDEVICE,
                            "Since this is a serial port device, framework is "
                            "using a workaround to allow this");
        }
 
        pDevice->Unlock(irql);
    }
 
    //
    // This can happen if a different PFILE_OBJECT is passed to an I/O
    // request than was presented to IRP_MJ_CREATE
    //
    if (pfo == NULL && FxIsFileObjectOptional(FileObjectClass) == FALSE) {
 
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Could not locate WDFFILEOBJECT for "
                            "PFILE_OBJECT 0x%p",pWdmFileObject);
 
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                            "Did a different PFILE_OBJECT get passed to the "
                            "request than was to IRP_MJ_CREATE?");
 
 
 
 
 
 
 
 
 
 
        if (FxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,9)) {
            FxVerifierDbgBreakPoint(pDevice->GetDriverGlobals());
        }
    }
 
    //
    // We don't do an extra reference count since the file objects
    // lifetime is controlled by the IoMgr. When the IRP_MJ_CLOSE
    // occurs, the reference is released after the optional
    // driver event callback.
    //
 
    *ppFxFileObject = pfo;
 
    return STATUS_SUCCESS;
}

Referenced by _DestroyFileObject(), FxRequest::GetFileObject(), FxPkgGeneral::OnCleanup(), and FxPkgGeneral::OnClose().

◆ DeleteFileObjectFromFailedCreate()

VOID FxFileObject::DeleteFileObjectFromFailedCreate ( VOID )

Definition at line 458 of file fxfileobject.cpp.

{
    KIRQL irql;
 
    //
    // Remove it from the list of FxFileObjects on the FxDevice
    //
    m_Device->Lock(&irql);
    RemoveEntryList(&m_Link);
    m_Device->Unlock(irql);
 
    // Delete the file object
    DeleteFromFailedCreate();
}

Referenced by FxPkgGeneral::OnCreate().

◆ GetCallbackLockPtr()

_Must_inspect_result_ FxCallbackLock * FxFileObject::GetCallbackLockPtr ( __deref_out_opt FxObject ** LockObject )

Definition at line 541 of file fxfileobject.cpp.

{
    //
    // Get it from FxPkgGeneral which has the File attributes passed to it at device Creation time.
    //
    return GetDevice()->m_PkgGeneral->GetCallbackLockPtrHelper(LockObject);
}

◆ GetConstraints()

VOID FxFileObject::GetConstraints	(	__in WDF_EXECUTION_LEVEL *	ExecutionLevel,
		__in WDF_SYNCHRONIZATION_SCOPE *	SynchronizationScope
	)

Definition at line 511 of file fxfileobject.cpp.

{
    //
    // Get it from FxPkgGeneral which has the File attributes passed to it at device Creation time.
    //
    return GetDevice()->m_PkgGeneral->GetConstraintsHelper(ExecutionLevel, SynchronizationScope);
}

◆ GetCurrentByteOffset()

__inline PLARGE_INTEGER FxFileObject::GetCurrentByteOffset ( VOID )

inline

Definition at line 121 of file fxfileobject.hpp.

    {
        return m_FileObject.GetCurrentByteOffset();
    }

◆ GetDevice()

__inline CfxDevice * FxFileObject::GetDevice ( VOID )

inline

Definition at line 99 of file fxfileobject.hpp.

    {
        return m_Device;
    }

◆ GetFileName()

__inline PUNICODE_STRING FxFileObject::GetFileName ( VOID )

inline

Definition at line 108 of file fxfileobject.hpp.

    {
    #if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
        return m_FileObject.GetFileName(NULL);
    #else
        return m_FileObject.GetFileName(&m_FileName);
    #endif
    }

Referenced by if().

◆ GetFlags()

__inline ULONG FxFileObject::GetFlags ( VOID )

inline

Definition at line 130 of file fxfileobject.hpp.

    {
        return m_FileObject.GetFlags();
    }

◆ GetHandle()

__inline WDFFILEOBJECT FxFileObject::GetHandle ( VOID )

inline

Definition at line 81 of file fxfileobject.hpp.

    {
        return (WDFFILEOBJECT) GetObjectHandle();
    }

Referenced by if(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), and FxPkgGeneral::OnCreate().

◆ GetPkgCleanupCloseContext()

__inline PVOID FxFileObject::GetPkgCleanupCloseContext ( VOID )

inline

Definition at line 148 of file fxfileobject.hpp.

    {
        return m_PkgContext;
    }

Referenced by FxPkgGeneral::OnCleanup(), and FxPkgGeneral::OnClose().

◆ GetRelatedFileObject()

FxFileObject * FxFileObject::GetRelatedFileObject ( VOID )

inline

Definition at line 243 of file fxfileobject.hpp.

    {
        return m_RelatedFileObject;
    }

◆ GetWdmFileObject()

__inline MdFileObject FxFileObject::GetWdmFileObject ( VOID )

inline

Definition at line 90 of file fxfileobject.hpp.

    {
        return m_FileObject.GetFileObject();
    }

Referenced by if().

◆ Initialize()

VOID FxFileObject::Initialize ( _In_ MdIrp CreateIrp )

Definition at line 69 of file fxfileobjectkm.cpp.

{
    UNREFERENCED_PARAMETER(CreateIrp);
 
    //
    // Not needed for KMDF.
    //
    DO_NOTHING();
 
    return;
}

◆ QueryInterface()

_Must_inspect_result_ NTSTATUS FxFileObject::QueryInterface ( __in FxQueryInterfaceParams * Params )

virtual

Reimplemented from FxObject.

Definition at line 477 of file fxfileobject.cpp.

{
    switch (Params->Type) {
    case FX_TYPE_FILEOBJECT:
        *Params->Object = (FxFileObject*) this;
        break;
 
    case FX_TYPE_IHASCALLBACKS:
        *Params->Object = (IFxHasCallbacks*) this;
        break;
 
    default:
        return FxNonPagedObject::QueryInterface(Params); // __super call
    }
 
    return STATUS_SUCCESS;
}

◆ SetFileObjectContext()

VOID FxFileObject::SetFileObjectContext	(	_In_ MdFileObject	WdmFileObject,
		_In_ WDF_FILEOBJECT_CLASS	NormalizedFileClass,
		_In_ MdIrp	Irp,
		_In_ FxDevice *	Device
	)

private

Definition at line 34 of file fxfileobjectkm.cpp.

{
    MxFileObject wdmFileObject(WdmFileObject);
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(Device);
 
    //
    // We now must be able to quickly retrieve the FxFileObject*
    // from the WDM PFILE_OBJECT when we get I/O requests.
    //
    // But different driver stacks have different rules, so
    // we must be flexible here, including not touching the
    // WDM PFILE_OBJECT at all.
    //
    if( NormalizedFileClass == WdfFileObjectWdfCanUseFsContext ) {
        wdmFileObject.SetFsContext(this);
    }
    else if( NormalizedFileClass == WdfFileObjectWdfCanUseFsContext2 ) {
        wdmFileObject.SetFsContext2(this);
    }
    else {
        //
        // WdfDeviceFileObjectNoContext will look up the FxFileObject
        // from the FxDevice->m_FileObjectListHead at runtime.
        //
    }
}

◆ SetPkgCleanupCloseContext()

__inline VOID FxFileObject::SetPkgCleanupCloseContext ( PVOID Context )

inline

Definition at line 139 of file fxfileobject.hpp.

    {
        m_PkgContext = Context;
    }

Referenced by FxPkgGeneral::OnCreate().

◆ UpdateProcessKeepAliveCount()

_Must_inspect_result_ NTSTATUS FxFileObject::UpdateProcessKeepAliveCount ( _In_ BOOLEAN Increment )

Definition at line 85 of file fxfileobjectkm.cpp.

{
    UNREFERENCED_PARAMETER(Increment);
 
    //
    // Not needed for KMDF.
    //
    DO_NOTHING();
 
    return STATUS_NOT_IMPLEMENTED;
}

Member Data Documentation

◆ m_FileName

UNICODE_STRING FxFileObject::m_FileName

private

Definition at line 44 of file fxfileobject.hpp.

Referenced by FxFileObject(), and GetFileName().

◆ m_FileObject

MxFileObject FxFileObject::m_FileObject

private

Definition at line 34 of file fxfileobject.hpp.

Referenced by FxFileObject(), GetCurrentByteOffset(), GetFileName(), GetFlags(), and GetWdmFileObject().

◆ m_Link

LIST_ENTRY FxFileObject::m_Link

Definition at line 56 of file fxfileobject.hpp.

Referenced by _GetFileObjectFromWdm(), and DeleteFileObjectFromFailedCreate().

◆ m_PkgContext

PVOID FxFileObject::m_PkgContext

private

Definition at line 35 of file fxfileobject.hpp.

Referenced by FxFileObject(), GetPkgCleanupCloseContext(), and SetPkgCleanupCloseContext().

◆ m_RelatedFileObject

FxFileObject* FxFileObject::m_RelatedFileObject

private

Definition at line 49 of file fxfileobject.hpp.

Referenced by FxFileObject(), GetRelatedFileObject(), and ~FxFileObject().

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxfileobject.hpp
sdk/lib/drivers/wdf/shared/core/fxfileobject.cpp
sdk/lib/drivers/wdf/shared/core/km/fxfileobjectkm.cpp
sdk/lib/drivers/wdf/shared/core/um/fxfileobjectum.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxFileObject()

◆ ~FxFileObject()

Member Function Documentation

◆ _CreateFileObject()

◆ _DestroyFileObject()

◆ _GetFileObjectFromWdm()

◆ DeleteFileObjectFromFailedCreate()

◆ GetCallbackLockPtr()

◆ GetConstraints()

◆ GetCurrentByteOffset()

◆ GetDevice()

◆ GetFileName()

◆ GetFlags()

◆ GetHandle()

◆ GetPkgCleanupCloseContext()

◆ GetRelatedFileObject()

◆ GetWdmFileObject()

◆ Initialize()

◆ QueryInterface()

◆ SetFileObjectContext()

◆ SetPkgCleanupCloseContext()

◆ UpdateProcessKeepAliveCount()

Member Data Documentation

◆ m_FileName

◆ m_FileObject

◆ m_Link

◆ m_PkgContext

◆ m_RelatedFileObject