#include <fxwmiinstance.hpp>

Inheritance diagram for FxWmiInstance:

[legend]

Collaboration diagram for FxWmiInstance:

[legend]

Public Member Functions
	FxWmiInstance (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in FxWmiProvider *Provider)

	~FxWmiInstance ()

CfxDevice *	GetDevice (VOID)

FxWmiProvider *	GetProvider (VOID)

_Must_inspect_result_ NTSTATUS	FireEvent (__in_bcount_opt(EventBufferSize) PVOID EventBuffer, __inout ULONG EventBufferSize)

BOOLEAN	IsEnabled (__in WDF_WMI_PROVIDER_CONTROL Control)

WDFWMIINSTANCE	GetHandle (VOID)

virtual BOOLEAN	IsQueryInstanceSupported (VOID)=0

virtual _Must_inspect_result_ __drv_sameIRQL	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS QueryInstance(__in ULONG OutBufferSize

virtual _Must_inspect_result_ __drv_sameIRQL	__out_bcount_part (OutBufferSize, *BufferUsed) PVOID OutBuffer

virtual BOOLEAN	IsSetInstanceSupported (VOID)=0

virtual _Must_inspect_result_ __drv_sameIRQL	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS SetInstance(__in ULONG InBufferSize

virtual _Must_inspect_result_ __drv_sameIRQL	__in_bcount (InBufferSize) PVOID InBuffer)=0

virtual BOOLEAN	IsSetItemSupported (VOID)=0

virtual _Must_inspect_result_ __drv_sameIRQL	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS SetItem(__in ULONG DataItemId

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG	__in_bcount (InBufferSize) PVOID InBuffer)=0

virtual BOOLEAN	IsExecuteMethodSupported (VOID)=0

virtual _Must_inspect_result_ __drv_sameIRQL	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS ExecuteMethod(__in ULONG MethodId

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG	__drv_when (InBufferSize >=OutBufferSize, __inout_bcount(InBufferSize)) __drv_when(InBufferSize< OutBufferSize

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG	__inout_bcount (OutBufferSize)) PVOID Buffer

virtual BOOLEAN	Dispose (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 Attributes
virtual _Must_inspect_result_ __drv_sameIRQL __out PULONG	BufferUsed =0

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG	InBufferSize

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG	OutBufferSize

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG __out PULONG	BufferUsed =0

Protected Attributes
LIST_ENTRY	m_ListEntry

FxWmiProvider *	m_Provider

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Private Attributes
friend	FxWmiProvider

friend	FxWmiIrpHandler

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)

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)

Detailed Description

Definition at line 31 of file fxwmiinstance.hpp.

Constructor & Destructor Documentation

◆ FxWmiInstance()

FxWmiInstance::FxWmiInstance	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in USHORT	ObjectSize,
		__in FxWmiProvider *	Provider
	)

Definition at line 28 of file fxwmiinstance.cpp.

      :
    FxNonPagedObject(FX_TYPE_WMI_INSTANCE, ObjectSize, FxDriverGlobals)
{
    InitializeListHead(&m_ListEntry);
    m_Provider = Provider;
    m_Provider->ADDREF(this);
    MarkDisposeOverride(ObjectDoNotLock);
}

◆ ~FxWmiInstance()

FxWmiInstance::~FxWmiInstance ( )

Definition at line 41 of file fxwmiinstance.cpp.

{
    ASSERT(IsListEmpty(&m_ListEntry));
}

Member Function Documentation

◆ __drv_maxIRQL() [1/4]

virtual _Must_inspect_result_ __drv_sameIRQL FxWmiInstance::__drv_maxIRQL ( PASSIVE_LEVEL )

virtual

Reimplemented in FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ __drv_maxIRQL() [2/4]

virtual _Must_inspect_result_ __drv_sameIRQL FxWmiInstance::__drv_maxIRQL ( PASSIVE_LEVEL )

virtual

Reimplemented in FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ __drv_maxIRQL() [3/4]

virtual _Must_inspect_result_ __drv_sameIRQL FxWmiInstance::__drv_maxIRQL ( PASSIVE_LEVEL )

virtual

Reimplemented in FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ __drv_maxIRQL() [4/4]

virtual _Must_inspect_result_ __drv_sameIRQL FxWmiInstance::__drv_maxIRQL ( PASSIVE_LEVEL )

virtual

Reimplemented in FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, FxWmiInstanceInternal, FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ __drv_when()

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG FxWmiInstance::__drv_when	(	InBufferSize >=	OutBufferSize,
		__inout_bcount(InBufferSize)
	)

◆ __in_bcount() [1/2]

virtual _Must_inspect_result_ __drv_sameIRQL FxWmiInstance::__in_bcount ( InBufferSize )

pure virtual

Implemented in FxWmiInstanceExternal, FxWmiInstanceExternal, FxWmiInstanceInternal, and FxWmiInstanceInternal.

◆ __in_bcount() [2/2]

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG FxWmiInstance::__in_bcount ( InBufferSize )

pure virtual

Implemented in FxWmiInstanceExternal, FxWmiInstanceExternal, FxWmiInstanceInternal, and FxWmiInstanceInternal.

◆ __inout_bcount()

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG FxWmiInstance::__inout_bcount ( OutBufferSize )

◆ __out_bcount_part()

virtual _Must_inspect_result_ __drv_sameIRQL FxWmiInstance::__out_bcount_part	(	OutBufferSize	,
		*	BufferUsed
	)

◆ Dispose()

BOOLEAN FxWmiInstance::Dispose ( VOID )

virtual

Reimplemented from FxObject.

Definition at line 47 of file fxwmiinstance.cpp.

{
    m_Provider->RemoveInstance(this);
    m_Provider->RELEASE(this);
 
    //
    // Object is being deleted, remove this object from the provider's list
    // of instances.  If we don't do this, the provider will have a list which
    // contains entries which have been freed.
    //
    return FxNonPagedObject::Dispose(); // __super call
}

◆ FireEvent()

_Must_inspect_result_ NTSTATUS FxWmiInstance::FireEvent	(	__in_bcount_opt(EventBufferSize) PVOID	EventBuffer,
		__inout ULONG	EventBufferSize
	)

Definition at line 64 of file fxwmiinstance.cpp.

{
    ULONG sizeNeeded;
    PWNODE_SINGLE_INSTANCE pNode;
    NTSTATUS status;
 
    if (EventBuffer == NULL) {
        EventBufferSize = 0;
    }
 
    sizeNeeded = sizeof(WNODE_SINGLE_INSTANCE) + EventBufferSize;
 
    //
    // IoWMIWriteEvent will free the memory by calling ExFreePool. This means
    // we cannot use a framework allocate function.
    //
    pNode = (PWNODE_SINGLE_INSTANCE)
        ExAllocatePoolWithTag(NonPagedPool, sizeNeeded, GetDriverGlobals()->Tag);
 
    if (pNode != NULL) {
        RtlCopyMemory(&pNode->WnodeHeader.Guid,
                      m_Provider->GetGUID(),
                      sizeof(GUID));
 
        pNode->WnodeHeader.ProviderId = IoWMIDeviceObjectToProviderId(
            GetDevice()->GetDeviceObject());
        pNode->WnodeHeader.BufferSize = sizeNeeded;
        pNode->WnodeHeader.Flags =  WNODE_FLAG_SINGLE_INSTANCE |
                                    WNODE_FLAG_EVENT_ITEM |
                                    WNODE_FLAG_STATIC_INSTANCE_NAMES;
        KeQuerySystemTime(&pNode->WnodeHeader.TimeStamp);
 
        pNode->InstanceIndex = m_Provider->GetInstanceIndex(this);
        pNode->SizeDataBlock = EventBufferSize;
        pNode->DataBlockOffset = sizeof(WNODE_SINGLE_INSTANCE);
 
        if (EventBuffer != NULL) {
            RtlCopyMemory(&pNode->VariableData, EventBuffer, EventBufferSize);
        }
 
        //
        // Upon success, IoWMIWriteEvent will free pNode.
        //
        status = IoWMIWriteEvent(pNode);
 
        if (!NT_SUCCESS(status)) {
            ExFreePool(pNode);
        }
    }
    else {
        status = STATUS_INSUFFICIENT_RESOURCES;
 
        DoTraceLevelMessage(
            GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "WDFWMIINSTANCE %p insufficient resources to fire event,%!STATUS!",
            GetHandle(), status);
    }
 
    return status;
}

Referenced by __in_bcount_opt().

◆ GetDevice()

CfxDevice * FxWmiInstance::GetDevice ( VOID )

inline

Definition at line 46 of file fxwmiinstance.hpp.

    {
        return m_Provider->GetDevice();
    }

◆ GetHandle()

WDFWMIINSTANCE FxWmiInstance::GetHandle ( VOID )

inline

Definition at line 77 of file fxwmiinstance.hpp.

    {
        return (WDFWMIINSTANCE) GetObjectHandle();
    }

Referenced by FxWmiIrpHandler::_QueryAllData().

◆ GetProvider()

FxWmiProvider * FxWmiInstance::GetProvider ( VOID )

inline

Definition at line 54 of file fxwmiinstance.hpp.

    {
        return m_Provider;
    }

◆ IsEnabled()

BOOLEAN FxWmiInstance::IsEnabled ( __in WDF_WMI_PROVIDER_CONTROL Control )

inline

Definition at line 69 of file fxwmiinstance.hpp.

    {
        return m_Provider->IsEnabled(Control);
    }

◆ IsExecuteMethodSupported()

virtual BOOLEAN FxWmiInstance::IsExecuteMethodSupported ( VOID )

pure virtual

Implemented in FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ IsQueryInstanceSupported()

virtual BOOLEAN FxWmiInstance::IsQueryInstanceSupported ( VOID )

pure virtual

Implemented in FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ IsSetInstanceSupported()

virtual BOOLEAN FxWmiInstance::IsSetInstanceSupported ( VOID )

pure virtual

Implemented in FxWmiInstanceExternal, and FxWmiInstanceInternal.

◆ IsSetItemSupported()

virtual BOOLEAN FxWmiInstance::IsSetItemSupported ( VOID )

pure virtual

Implemented in FxWmiInstanceExternal, and FxWmiInstanceInternal.

Member Data Documentation

◆ BufferUsed [1/2]

virtual _Must_inspect_result_ __drv_sameIRQL __out PULONG FxWmiInstance::BufferUsed =0

Definition at line 98 of file fxwmiinstance.hpp.

◆ BufferUsed [2/2]

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG __out PULONG FxWmiInstance::BufferUsed =0

Definition at line 152 of file fxwmiinstance.hpp.

◆ FxWmiIrpHandler

friend FxWmiInstance::FxWmiIrpHandler

private

Definition at line 34 of file fxwmiinstance.hpp.

◆ FxWmiProvider

friend FxWmiInstance::FxWmiProvider

private

Definition at line 33 of file fxwmiinstance.hpp.

◆ InBufferSize

_Must_inspect_result_ __drv_sameIRQL __in ULONG FxWmiInstance::InBufferSize

Definition at line 130 of file fxwmiinstance.hpp.

◆ m_ListEntry

LIST_ENTRY FxWmiInstance::m_ListEntry

protected

Definition at line 167 of file fxwmiinstance.hpp.

Referenced by FxWmiInstance(), and ~FxWmiInstance().

◆ m_Provider

FxWmiProvider* FxWmiInstance::m_Provider

protected

Definition at line 172 of file fxwmiinstance.hpp.

Referenced by __drv_maxIRQL(), Dispose(), FireEvent(), FxWmiInstance(), GetDevice(), GetProvider(), and IsEnabled().

◆ OutBufferSize

virtual _Must_inspect_result_ __drv_sameIRQL __in ULONG __inout ULONG FxWmiInstance::OutBufferSize

Definition at line 148 of file fxwmiinstance.hpp.

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxwmiinstance.hpp
sdk/lib/drivers/wdf/kmdf/src/irphandlers/wmi/fxwmiinstance.cpp

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxWmiInstance()

◆ ~FxWmiInstance()

Member Function Documentation

◆ __drv_maxIRQL() [1/4]

◆ __drv_maxIRQL() [2/4]

◆ __drv_maxIRQL() [3/4]

◆ __drv_maxIRQL() [4/4]

◆ __drv_when()

◆ __in_bcount() [1/2]

◆ __in_bcount() [2/2]

◆ __inout_bcount()

◆ __out_bcount_part()

◆ Dispose()

◆ FireEvent()

◆ GetDevice()

◆ GetHandle()

◆ GetProvider()

◆ IsEnabled()

◆ IsExecuteMethodSupported()

◆ IsQueryInstanceSupported()

◆ IsSetInstanceSupported()

◆ IsSetItemSupported()

Member Data Documentation

◆ BufferUsed [1/2]

◆ BufferUsed [2/2]

◆ FxWmiIrpHandler

◆ FxWmiProvider

◆ InBufferSize

◆ m_ListEntry

◆ m_Provider

◆ OutBufferSize