FxResourceCollection Class Reference

#include <fxresource.hpp>

Inheritance diagram for FxResourceCollection:

Collaboration diagram for FxResourceCollection:

Public Member Functions
BOOLEAN	RemoveAndDelete (__in ULONG Index)
_Must_inspect_result_ NTSTATUS	AddAt (__in ULONG Index, __in FxObject *Object)
BOOLEAN	IsRemoveAllowed (VOID)
BOOLEAN	IsAddAllowed (VOID)
VOID	MarkChanged (VOID)
BOOLEAN	IsChanged (VOID)
Public Member Functions inherited from FxCollection
	FxCollection (__in PFX_DRIVER_GLOBALS FxDriverGlobals)
	~FxCollection (VOID)
BOOLEAN	Add (__in FxObject *Item)
VOID	StealCollection (__in FxCollection *Collection)
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 FxCollectionInternal
	FxCollectionInternal (VOID)
	~FxCollectionInternal (VOID)
_Must_inspect_result_ FxCollectionEntry *	FindEntry (__in ULONG Index)
_Must_inspect_result_ FxCollectionEntry *	FindEntryByObject (__in FxObject *Object)
ULONG	Count (VOID)
BOOLEAN	Add (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Item)
_Must_inspect_result_ FxObject *	GetItem (__in ULONG Index)
_Must_inspect_result_ FxObject *	GetFirstItem (VOID)
_Must_inspect_result_ FxObject *	GetLastItem (VOID)
NTSTATUS	Remove (__in ULONG Index)
VOID	CleanupEntry (__in FxCollectionEntry *Entry)
VOID	CleanupEntryObject (__in FxObject *Object)
NTSTATUS	RemoveEntry (__in FxCollectionEntry *Entry)
_Must_inspect_result_ NTSTATUS	RemoveItem (__in FxObject *Item)
_Must_inspect_result_ FxCollectionEntry *	Start (VOID)
_Must_inspect_result_ FxCollectionEntry *	End (VOID)
VOID	Clear (VOID)

Public Attributes
UCHAR	m_AccessFlags
BOOLEAN	m_Changed

Protected Member Functions
	FxResourceCollection (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFTYPE Type, __in USHORT Size, __in UCHAR AccessFlags=FxResourceNoAccess)
Protected Member Functions inherited from FxCollection
	FxCollection (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFTYPE Type, __in USHORT Size)
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)
Protected Member Functions inherited from FxCollectionInternal
_Must_inspect_result_ FxCollectionEntry *	AllocateEntry (__in PFX_DRIVER_GLOBALS FxDriverGlobals)
VOID	AddEntry (__in FxCollectionEntry *Node, __in FxObject *Item)

Additional Inherited Members
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)
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
};
Protected Attributes inherited from FxCollectionInternal
ULONG	m_Count
LIST_ENTRY	m_ListHead

Detailed Description

Definition at line 280 of file fxresource.hpp.

Constructor & Destructor Documentation

FxResourceCollection()

FxResourceCollection::FxResourceCollection ( __in PFX_DRIVER_GLOBALS  FxDriverGlobals, __in WDFTYPE  Type, __in USHORT  Size, __in UCHAR  AccessFlags = FxResourceNoAccess  )

inlineprotected

Definition at line 282 of file fxresource.hpp.

          : FxCollection(FxDriverGlobals, Type, Size),
            m_AccessFlags(AccessFlags), m_Changed(FALSE)
    {
        //
        // Driver cannot delete this or any of its derivations
        //
        MarkNoDeleteDDI();
    }

Member Function Documentation

AddAt()

_Must_inspect_result_ NTSTATUS FxResourceCollection::AddAt	(	__in ULONG	Index,
		__in FxObject *	Object
	)

Definition at line 103 of file fxresourcecollection.cpp.

{
    FxCollectionEntry *pNew;
    PLIST_ENTRY ple;
    NTSTATUS status;
    KIRQL irql;
 
    if (IsAddAllowed() == FALSE) {
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGPNP,
                            "Adds not allowed on handle %p, add at index %d"
                            "failed", GetObjectHandle(), Index);
 
        FxVerifierDbgBreakPoint(GetDriverGlobals());
 
        return STATUS_ACCESS_DENIED;
    }
 
    Lock(&irql);
 
    ple = NULL;
    status = STATUS_SUCCESS;
 
    pNew = AllocateEntry(GetDriverGlobals());
 
    if (pNew != NULL) {
        //
        // Inserting at the current count (i.e. one past the end) is the same
        // as append.
        //
        if (Index == WDF_INSERT_AT_END || Index == Count()) {
            ple = &m_ListHead;
        }
        else {
            FxCollectionEntry* cur, *end;
            ULONG i;
 
            for (cur = Start(), end = End(), i = 0;
                 cur != end;
                 cur = cur->Next(), i++) {
                if (i == Index) {
                    ple = &cur->m_ListEntry;
                    break;
                }
            }
 
            if (ple == NULL) {
                delete pNew;
                status = STATUS_ARRAY_BOUNDS_EXCEEDED;
            }
        }
    }
    else {
        status = STATUS_INSUFFICIENT_RESOURCES;
    }
 
    if (NT_SUCCESS(status)) {
        PLIST_ENTRY blink;
 
        // ple now points to the list entry which we will insert our node
        // *before*
 
        blink = ple->Blink;
 
        // Link the previous with the new entry
        blink->Flink = &pNew->m_ListEntry;
        pNew->m_ListEntry.Blink = blink;
 
        // Link the current with the new entry
        pNew->m_ListEntry.Flink = ple;
        ple->Blink = &pNew->m_ListEntry;
 
        AddEntry(pNew, Object);
 
        //
        // Mark the list as changed so when we go to create a WDM resource list
        // we know if a new list is needed.
        //
        MarkChanged();
    }
 
    Unlock(irql);
 
    if (!NT_SUCCESS(status)) {
        Object->DeleteFromFailedCreate();
    }
 
    return status;
}

IsAddAllowed()

BOOLEAN FxResourceCollection::IsAddAllowed ( VOID  )

inline

Definition at line 319 of file fxresource.hpp.

    {
        return FLAG_TO_BOOL(m_AccessFlags, FxResourceAddAllowed);
    }

Referenced by AddAt().

IsChanged()

BOOLEAN FxResourceCollection::IsChanged ( VOID  )

inline

Definition at line 335 of file fxresource.hpp.

    {
        return m_Changed;
    }

Referenced by FxPkgFdo::PnpFilterResourceRequirements(), and FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

IsRemoveAllowed()

BOOLEAN FxResourceCollection::IsRemoveAllowed ( VOID  )

inline

Definition at line 311 of file fxresource.hpp.

    {
        return FLAG_TO_BOOL(m_AccessFlags, FxResourceRemoveAllowed);
    }

Referenced by RemoveAndDelete().

MarkChanged()

VOID FxResourceCollection::MarkChanged ( VOID  )

inline

Definition at line 327 of file fxresource.hpp.

    {
        m_Changed = TRUE;
    }

Referenced by __drv_strictTypeMatch(), AddAt(), if(), RemoveAndDelete(), and while().

RemoveAndDelete()

BOOLEAN FxResourceCollection::RemoveAndDelete

(

__in ULONG

Index

)

Definition at line 35 of file fxresourcecollection.cpp.

{
    FxObject* pObject;
    FxCollectionEntry* pEntry;
    KIRQL irql;
 
    if (IsRemoveAllowed() == FALSE) {
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGPNP,
                            "Removes not allowed on handle %p, remove at index %d"
                            "failed", GetObjectHandle(), Index);
 
        FxVerifierDbgBreakPoint(GetDriverGlobals());
        return FALSE;
    }
 
    pObject = NULL;
 
    Lock(&irql);
 
    pEntry = FindEntry(Index);
    if (pEntry != NULL) {
 
        //
        // Mark the list as changed so when we go to create a WDM resource list we
        // know if a new list is needed.
        //
        MarkChanged();
 
        pObject = pEntry->m_Object;
 
        //
        // Remove the entry
        //
        RemoveEntry(pEntry);
    }
    Unlock(irql);
 
    if (pObject != NULL) {
        //
        // Delete the object since we created it
        //
        pObject->DeleteObject();
        pObject = NULL;
 
        return TRUE;
    }
    else {
        return FALSE;
    }
}

Member Data Documentation

m_AccessFlags

UCHAR FxResourceCollection::m_AccessFlags

Definition at line 343 of file fxresource.hpp.

Referenced by FxCmResList::BuildFromWdmList(), FxIoResList::FxIoResList(), FxIoResReqList::FxIoResReqList(), if(), IsAddAllowed(), and IsRemoveAllowed().

m_Changed

BOOLEAN FxResourceCollection::m_Changed

Definition at line 345 of file fxresource.hpp.

Referenced by IsChanged(), MarkChanged(), and FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/common/fxresource.hpp
• sdk/lib/drivers/wdf/shared/support/fxresourcecollection.cpp