#include <fxwmiprovider.hpp>

Inheritance diagram for FxWmiProvider:

Collaboration diagram for FxWmiProvider:

[legend]

Public Member Functions
	FxWmiProvider (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PWDF_WMI_PROVIDER_CONFIG Config, __in CfxDevice *Device)

	~FxWmiProvider ()

CfxDevice *	GetDevice (VOID)

GUID *	GetGUID (VOID)

ULONG	GetFlags (VOID)

ULONG	GetMinInstanceBufferSize (VOID)

ULONG	GetRegistrationFlagsLocked (VOID)

BOOLEAN	IsEventOnly (VOID)

BOOLEAN	IsEnabled (__in WDF_WMI_PROVIDER_CONTROL Control)

ULONGLONG	GetTracingHandle (VOID)

VOID	SetTracingHandle (__in ULONGLONG TracingHandle)

WDFWMIPROVIDER	GetHandle (VOID)

BOOLEAN	IsFunctionControlSupported (VOID)

_Must_inspect_result_ NTSTATUS	FunctionControl (__in WDF_WMI_PROVIDER_CONTROL Control, __in BOOLEAN Enable)

_Must_inspect_result_ NTSTATUS	AddInstance (__in FxWmiInstance *Instance, __in BOOLEAN NoErrorIfPresent=FALSE)

VOID	RemoveInstance (__in FxWmiInstance *Instance)

ULONG	GetInstanceIndex (__in FxWmiInstance *Instance)

_Must_inspect_result_ FxWmiInstance *	GetInstanceReferenced (__in ULONG Index, __in PVOID Tag)

_Must_inspect_result_ FxWmiInstance *	GetInstanceReferencedLocked (__in ULONG Index, __in PVOID Tag)

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)

Static Public Member Functions
static _Must_inspect_result_ NTSTATUS	_Create (__in PFX_DRIVER_GLOBALS CallersGlobals, __in WDFDEVICE Device, __in_opt PWDF_OBJECT_ATTRIBUTES ProviderAttributes, __in PWDF_WMI_PROVIDER_CONFIG WmiProviderConfig, __out WDFWMIPROVIDER WmiProvider, __out FxWmiProvider *Provider)

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 Types
enum	AddInstanceAction { AddInstanceToTail , AddInstanceToHead }

Protected Member Functions
_Must_inspect_result_ NTSTATUS	AddInstanceLocked (__in FxWmiInstance *Instance, __in BOOLEAN NoErrorIfPresent, __out PBOOLEAN Update, __in AddInstanceAction Action=AddInstanceToTail)

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 Attributes
LIST_ENTRY	m_ListEntry

LIST_ENTRY	m_InstanceListHead

ULONG	m_NumInstances

FxWmiIrpHandler *	m_Parent

GUID	m_Guid

ULONGLONG	m_TracingHandle

ULONG	m_MinInstanceBufferSize

union {
ULONG m_Flags

struct {
ULONG EventOnly: 1

ULONG Expensive: 1

ULONG Tracing: 1

} m_FlagsByName

};

FxWmiProviderFunctionControlCallback	m_FunctionControl

BOOLEAN	m_EventControlEnabled

BOOLEAN	m_DataBlockControlEnabled

BOOLEAN	m_RemoveGuid

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Private Attributes
friend	FxWmiIrpHandler

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

Detailed Description

Definition at line 73 of file fxwmiprovider.hpp.

Member Enumeration Documentation

◆ AddInstanceAction

enum FxWmiProvider::AddInstanceAction

protected

Enumerator
AddInstanceToTail
AddInstanceToHead

Definition at line 234 of file fxwmiprovider.hpp.

                           {
        AddInstanceToTail,
        AddInstanceToHead
    };

Constructor & Destructor Documentation

◆ FxWmiProvider()

FxWmiProvider::FxWmiProvider	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in PWDF_WMI_PROVIDER_CONFIG	Config,
		__in CfxDevice *	Device
	)

Definition at line 28 of file fxwmiprovider.cpp.

      :
    FxNonPagedObject(FX_TYPE_WMI_PROVIDER,
                     sizeof(FxWmiProvider),
                     FxDriverGlobals),
    m_FunctionControl(FxDriverGlobals)
{
    InitializeListHead(&m_ListEntry);
    InitializeListHead(&m_InstanceListHead);
    m_NumInstances = 0;
 
    m_Parent = Device->m_PkgWmi;
 
    m_EventControlEnabled = FALSE;
    m_DataBlockControlEnabled = FALSE;
    m_RemoveGuid = FALSE;
 
    m_TracingHandle = 0;
 
    m_Flags = Config->Flags;
    m_MinInstanceBufferSize = Config->MinInstanceBufferSize;
    RtlCopyMemory(&m_Guid, &Config->Guid, sizeof(GUID));
 
    if (Config->EvtWmiProviderFunctionControl != NULL) {
        m_FunctionControl.m_Method = Config->EvtWmiProviderFunctionControl;
    }
 
    //
    // Driver cannot call WdfObjectDelete on this handle
    //
    MarkNoDeleteDDI();
 
    MarkDisposeOverride(ObjectDoNotLock);
}

◆ ~FxWmiProvider()

FxWmiProvider::~FxWmiProvider ( )

Definition at line 66 of file fxwmiprovider.cpp.

{
    ASSERT(IsListEmpty(&m_ListEntry));
}

Member Function Documentation

◆ _Create()

_Must_inspect_result_ NTSTATUS FxWmiProvider::_Create	(	__in PFX_DRIVER_GLOBALS	CallersGlobals,
		__in WDFDEVICE	Device,
		__in_opt PWDF_OBJECT_ATTRIBUTES	ProviderAttributes,
		__in PWDF_WMI_PROVIDER_CONFIG	WmiProviderConfig,
		__out WDFWMIPROVIDER *	WmiProvider,
		__out FxWmiProvider **	Provider
	)

static

Definition at line 88 of file fxwmiprovider.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxDevice* pDevice;
    FxWmiProvider* pProvider;
    NTSTATUS status;
    WDFOBJECT hProvider;
    GUID zeroGuid;
    BOOLEAN update;
 
    FxObjectHandleGetPtrAndGlobals(CallersGlobals,
                                   Device,
                                   FX_TYPE_DEVICE,
                                   (PVOID*) &pDevice,
                                   &pFxDriverGlobals);
 
    *Provider = NULL;
    update = FALSE;
 
    *WmiProvider = NULL;
 
    status = FxValidateObjectAttributes(pFxDriverGlobals,
                                        ProviderAttributes,
                                        FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    if (WmiProviderConfig->Size != sizeof(WDF_WMI_PROVIDER_CONFIG)) {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "WmiProviderConfig Size 0x%x, expected size 0x%x, %!STATUS!",
            WmiProviderConfig->Size, sizeof(WDF_WMI_PROVIDER_CONFIG),
            status);
 
        return status;
    }
 
    if ((WmiProviderConfig->Flags & ~WdfWmiProviderValidFlags) != 0) {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "Invalid flag(s) set, Flags 0x%x, valid mask 0x%x, %!STATUS!",
            WmiProviderConfig->Flags, WdfWmiProviderValidFlags,
            status);
        return status;
    }
 
    if ((WmiProviderConfig->Flags & WdfWmiProviderTracing) &&
        (WmiProviderConfig->Flags & ~WdfWmiProviderTracing)) {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "WdfWmiProviderTracing must be the only flag set, %!STATUS!",
            status);
 
        return status;
    }
 
    //
    // Function control makes sense if it is expensive.  Otherwise you will
    // not be called back on it.
    //
    // The opposite, marking yourself as expensive but providing no callback is
    // OK b/c the provider marks the enabled state and the driver can retrieve
    // it at runtime.
    //
    // Function control also applies to tracing GUIDs since the tracing subsystem
    // will call enable/disable events to start/stop tracing.
    //
    if (WmiProviderConfig->EvtWmiProviderFunctionControl != NULL &&
        ((WmiProviderConfig->Flags & (WdfWmiProviderTracing | WdfWmiProviderExpensive)) == 0)) {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "EvtWmiProviderFunctionControl can only be set if Flags 0x%x has "
            "WdfWmiProviderTracing (%d) or WdfWmiProviderExpensive (%d) bit "
            "values set, %!STATUS!",
            WmiProviderConfig->Flags, WdfWmiProviderTracing,
            WdfWmiProviderExpensive, status);
 
        return status;
    }
 
    RtlZeroMemory(&zeroGuid, sizeof(zeroGuid));
 
    if (RtlCompareMemory(&WmiProviderConfig->Guid,
                         &zeroGuid,
                         sizeof(GUID)) == sizeof(GUID)) {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "WmiProvider Guid filed is all zeros, %!STATUS!",
            status);
 
        return status;
    }
 
    pProvider = NULL;
 
    pProvider = new(pFxDriverGlobals, ProviderAttributes)
        FxWmiProvider(pFxDriverGlobals, WmiProviderConfig, pDevice);
 
    if (pProvider == NULL) {
        status = STATUS_INSUFFICIENT_RESOURCES;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "Could not allocate memory for a WDFWMIPROVIDER, %!STATUS!",
            status);
 
        return status;
    }
 
    status = pDevice->m_PkgWmi->AddProvider(pProvider, &update);
 
    if (NT_SUCCESS(status)) {
        status = pProvider->Commit(ProviderAttributes, &hProvider, pDevice);
 
        if (!NT_SUCCESS(status)) {
            pDevice->m_PkgWmi->RemoveProvider(pProvider);
        }
        else {
            //
            // NT_SUCCES(status) case
            //
            *WmiProvider = (WDFWMIPROVIDER) hProvider;
        }
    }
 
    if (NT_SUCCESS(status)) {
        *Provider = pProvider;
 
        if (update) {
            pDevice->m_PkgWmi->UpdateGuids();
        }
    }
    else {
        //
        // AddProvider incremented update count on success however since we
        // are not going to update registration due to this failure, decrement
        // the count.
        //
        if (update) {
            pDevice->m_PkgWmi->DecrementUpdateCount();
        }
 
        pProvider->DeleteFromFailedCreate();
    }
 
    return status;
}

◆ AddInstance()

_Must_inspect_result_ NTSTATUS FxWmiProvider::AddInstance	(	__in FxWmiInstance *	Instance,
		__in BOOLEAN	NoErrorIfPresent = `FALSE`
	)

Definition at line 352 of file fxwmiprovider.cpp.

{
    NTSTATUS status;
    KIRQL irql;
    BOOLEAN update;
 
    if (m_Flags & WdfWmiProviderTracing) {
        status = STATUS_INVALID_DEVICE_REQUEST;
 
        DoTraceLevelMessage(
            GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "WDFWMIINSTANCE %p cannot be added to tracing WDFWMIPROVIDER %p, "
            "%!STATUS!", Instance->GetHandle(), GetHandle(), status);
 
        return status;
    }
 
    m_Parent->Lock(&irql);
    status = AddInstanceLocked(Instance, NoErrorIfPresent, &update);
 
    if (update) {
        update = m_Parent->DeferUpdateLocked(irql);
    }
    m_Parent->Unlock(irql);
 
    if (update) {
        m_Parent->UpdateGuids();
    }
 
    return status;
}

Referenced by if().

◆ AddInstanceLocked()

_Must_inspect_result_ NTSTATUS FxWmiProvider::AddInstanceLocked	(	__in FxWmiInstance *	Instance,
		__in BOOLEAN	NoErrorIfPresent,
		__out PBOOLEAN	Update,
		__in AddInstanceAction	Action = `AddInstanceToTail`
	)

protected

Definition at line 255 of file fxwmiprovider.cpp.

{
    NTSTATUS status;
 
    *Update = FALSE;
 
    if (!IsListEmpty(&Instance->m_ListEntry)) {
        if (NoErrorIfPresent) {
            return STATUS_SUCCESS;
        }
        else {
            //
            // Entry is already on a list, bad caller!
            //
            status = STATUS_INVALID_DEVICE_REQUEST;
 
            DoTraceLevelMessage(
                GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGDEVICE,
                "WDFWMIINSTANCE %p already added, %!STATUS!",
                Instance->GetHandle(), status);
 
            return status;
        }
    }
 
    //
    // Check to see if we are in the process of
    //
    switch (m_Parent->m_RegisteredState) {
    case FxWmiIrpHandler::WmiUnregistered:
        //
        // The GUID will be reported when we do the initial registration
        //
        break;
 
    case FxWmiIrpHandler::WmiDeregistered:
        //
        // Either the GUID will be reported when we do the re-registration or
        // we will clean it up when we goto the cleanup state.
        //
        break;
 
    case FxWmiIrpHandler::WmiRegistered:
        //
        // Since we already registered we need to tell WMI the change in the
        // number of instances on this provider.
        //
        *Update = TRUE;
        break;
 
    case FxWmiIrpHandler::WmiCleanedUp:
        //
        // Device is going away, registration is not allowed for the device
        // anymore.
        //
        status = STATUS_INVALID_DEVICE_STATE;
 
        DoTraceLevelMessage(
            GetDriverGlobals(), TRACE_LEVEL_INFORMATION, TRACINGDEVICE,
            "WMI is being cleanedup, WDFWMIINSTANCE %p add failing, %!STATUS!",
            Instance->GetHandle(), status);
 
        return status;
 
    default:
        ASSERT(FALSE);
        break;
    }
 
    if (Action == AddInstanceToTail) {
        InsertTailList(&m_InstanceListHead, &Instance->m_ListEntry);
    }
    else {
        InsertHeadList(&m_InstanceListHead, &Instance->m_ListEntry);
    }
 
    //
    // Since the count is increasing to at least one, we are not going to
    // need to report this GUID as missing.  We could check the
    // m_Parent->m_RegisteredState and only set it when we are registered, but
    // it does us no harm to always clear this value regardless of state.
    //
    m_RemoveGuid = FALSE;
 
    m_NumInstances++;
    status = STATUS_SUCCESS;
 
    return status;
}

Referenced by AddInstance(), and FxWmiIrpHandler::AddPowerPolicyProviderAndInstance().

◆ Dispose()

BOOLEAN FxWmiProvider::Dispose ( VOID )

virtual

Reimplemented from FxObject.

Definition at line 72 of file fxwmiprovider.cpp.

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

◆ FunctionControl()

_Must_inspect_result_ NTSTATUS FxWmiProvider::FunctionControl	(	__in WDF_WMI_PROVIDER_CONTROL	Control,
		__in BOOLEAN	Enable
	)

Definition at line 508 of file fxwmiprovider.cpp.

{
    return m_FunctionControl.Invoke(m_Parent->GetDevice()->GetHandle(),
                                    GetHandle(),
                                    Control,
                                    Enable);
}

◆ GetDevice()

CfxDevice * FxWmiProvider::GetDevice ( VOID )

inline

Definition at line 99 of file fxwmiprovider.hpp.

    {
        return m_Parent->GetDevice();
    }

Referenced by FxWmiInstance::GetDevice().

◆ GetFlags()

ULONG FxWmiProvider::GetFlags ( VOID )

inline

Definition at line 115 of file fxwmiprovider.hpp.

    {
        return m_Flags;
    }

◆ GetGUID()

GUID * FxWmiProvider::GetGUID ( VOID )

inline

Definition at line 107 of file fxwmiprovider.hpp.

    {
        return &m_Guid;
    }

Referenced by FxWmiIrpHandler::AddPowerPolicyProviderAndInstance(), and FxWmiInstance::FireEvent().

◆ GetHandle()

WDFWMIPROVIDER FxWmiProvider::GetHandle ( VOID )

inline

Definition at line 172 of file fxwmiprovider.hpp.

    {
        return (WDFWMIPROVIDER) GetObjectHandle();
    }

Referenced by __drv_maxIRQL().

◆ GetInstanceIndex()

ULONG FxWmiProvider::GetInstanceIndex ( __in FxWmiInstance * Instance )

Definition at line 441 of file fxwmiprovider.cpp.

{
    PLIST_ENTRY ple;
    ULONG index;
    KIRQL irql;
 
    m_Parent->Lock(&irql);
    for (index = 0, ple = m_InstanceListHead.Flink;
         index < m_NumInstances;
         index++, ple = ple->Flink) {
        if (CONTAINING_RECORD(ple, FxWmiInstance, m_ListEntry) == Instance) {
            break;
        }
    }
    m_Parent->Unlock(irql);
 
    return index;
}

Referenced by FxWmiInstance::FireEvent().

◆ GetInstanceReferenced()

_Must_inspect_result_ FxWmiInstance * FxWmiProvider::GetInstanceReferenced	(	__in ULONG	Index,
		__in PVOID	Tag
	)

Definition at line 464 of file fxwmiprovider.cpp.

{
    FxWmiInstance* pInstance;
    KIRQL irql;
 
    m_Parent->Lock(&irql);
    pInstance = GetInstanceReferencedLocked(Index, Tag);
    m_Parent->Unlock(irql);
 
    return pInstance;
}

◆ GetInstanceReferencedLocked()

_Must_inspect_result_ FxWmiInstance * FxWmiProvider::GetInstanceReferencedLocked	(	__in ULONG	Index,
		__in PVOID	Tag
	)

Definition at line 481 of file fxwmiprovider.cpp.

{
    FxWmiInstance* pFound;
    PLIST_ENTRY ple;
    ULONG i;
 
    pFound = NULL;
 
    for (i = 0, ple = m_InstanceListHead.Flink;
         i < m_NumInstances;
         ple = ple->Flink, i++) {
 
        if (i == Index) {
            pFound = CONTAINING_RECORD(ple, FxWmiInstance, m_ListEntry);
            pFound->ADDREF(Tag);
            break;
        }
    }
 
    return pFound;
}

Referenced by FxWmiIrpHandler::Dispatch(), and GetInstanceReferenced().

◆ GetMinInstanceBufferSize()

ULONG FxWmiProvider::GetMinInstanceBufferSize ( VOID )

inline

Definition at line 123 of file fxwmiprovider.hpp.

    {
        return m_MinInstanceBufferSize;
    }

Referenced by __drv_maxIRQL().

◆ GetRegistrationFlagsLocked()

ULONG FxWmiProvider::GetRegistrationFlagsLocked ( VOID )

Definition at line 520 of file fxwmiprovider.cpp.

{
    ULONG flags;
 
    if (m_Flags & WdfWmiProviderTracing) {
        flags = WMIREG_FLAG_TRACED_GUID | WMIREG_FLAG_TRACE_CONTROL_GUID;
 
        //
        // Once tracing GUID is registered, we do not allow it to be unregistered
        //
        ASSERT(m_RemoveGuid == FALSE);
    }
    else {
        flags = WMIREG_FLAG_INSTANCE_PDO;
 
        if (m_Flags & WdfWmiProviderExpensive) {
            flags |= WMIREG_FLAG_EXPENSIVE;
        }
 
        if (m_Flags & WdfWmiProviderEventOnly) {
            flags |= WMIREG_FLAG_EVENT_ONLY_GUID;
        }
    }
 
    if (m_RemoveGuid) {
        //
        // We have gone down to zero instances of this provider, report it as
        // gone to WMI.
        //
        ASSERT(m_NumInstances == 0);
        flags |= WMIREG_FLAG_REMOVE_GUID;
 
        //
        // Once reported as removed, we do not have not have to report ourselves
        // as removed again.
        //
        m_RemoveGuid = FALSE;
    }
 
    return flags;
}

Referenced by FxWmiIrpHandler::_RegInfo().

◆ GetTracingHandle()

ULONGLONG FxWmiProvider::GetTracingHandle ( VOID )

inline

Definition at line 156 of file fxwmiprovider.hpp.

    {
        return m_TracingHandle;
    }

◆ IsEnabled()

BOOLEAN FxWmiProvider::IsEnabled ( __in WDF_WMI_PROVIDER_CONTROL Control )

inline

Definition at line 144 of file fxwmiprovider.hpp.

    {
        switch (Control) {
        case WdfWmiEventControl:    return m_EventControlEnabled;
        case WdfWmiInstanceControl: return m_DataBlockControlEnabled;
        default:                        ASSERT(FALSE); return FALSE;
        }
    }

Referenced by FxWmiInstance::IsEnabled().

◆ IsEventOnly()

BOOLEAN FxWmiProvider::IsEventOnly ( VOID )

inline

Definition at line 136 of file fxwmiprovider.hpp.

    {
        return FLAG_TO_BOOL(m_Flags, WdfWmiProviderEventOnly);
    }

◆ IsFunctionControlSupported()

BOOLEAN FxWmiProvider::IsFunctionControlSupported ( VOID )

inline

Definition at line 180 of file fxwmiprovider.hpp.

    {
        return m_FunctionControl.m_Method != NULL;
    }

◆ RemoveInstance()

VOID FxWmiProvider::RemoveInstance ( __in FxWmiInstance * Instance )

Definition at line 388 of file fxwmiprovider.cpp.

{
    KIRQL irql;
    BOOLEAN update;
 
    update = FALSE;
 
    m_Parent->Lock(&irql);
 
    if (!IsListEmpty(&Instance->m_ListEntry)) {
        //
        // Instance is in the list of instances on this provider.  Remove it.
        //
        RemoveEntryList(&Instance->m_ListEntry);
        InitializeListHead(&Instance->m_ListEntry);
        m_NumInstances--;
 
        if (m_Parent->m_RegisteredState == FxWmiIrpHandler::WmiRegistered) {
            update = TRUE;
 
            //
            // When the count goes to zero, inform WMI that the GUID should be
            // removed when we get requeried.  We only need to do this once we have
            // been registered.  In all other states, we ignore this value.
            //
            if (m_NumInstances == 0 &&
                (m_Flags & WdfWmiProviderExpensive) == 0) {
                m_RemoveGuid = TRUE;
            }
        }
    }
    else {
        //
        // The instance was explicitly removed and now the instance is trying
        // to remove itself during dispose.  Nothing to do.
        //
        DO_NOTHING();
    }
 
    if (update) {
        update = m_Parent->DeferUpdateLocked(irql);
    }
 
    m_Parent->Unlock(irql);
 
    if (update) {
        m_Parent->UpdateGuids();
    }
}

Referenced by FxWmiInstance::Dispose().

◆ SetTracingHandle()

VOID FxWmiProvider::SetTracingHandle ( __in ULONGLONG TracingHandle )

inline

Definition at line 164 of file fxwmiprovider.hpp.

    {
        m_TracingHandle = TracingHandle;
    }

Member Data Documentation

◆

union { ... } FxWmiProvider::@4825

◆ EventOnly

ULONG FxWmiProvider::EventOnly

Definition at line 280 of file fxwmiprovider.hpp.

◆ Expensive

ULONG FxWmiProvider::Expensive

Definition at line 281 of file fxwmiprovider.hpp.

◆ FxWmiIrpHandler

friend FxWmiProvider::FxWmiIrpHandler

private

Definition at line 75 of file fxwmiprovider.hpp.

◆ m_DataBlockControlEnabled

BOOLEAN FxWmiProvider::m_DataBlockControlEnabled

protected

Definition at line 290 of file fxwmiprovider.hpp.

Referenced by FxWmiProvider(), and IsEnabled().

◆ m_EventControlEnabled

BOOLEAN FxWmiProvider::m_EventControlEnabled

protected

Definition at line 288 of file fxwmiprovider.hpp.

Referenced by FxWmiProvider(), and IsEnabled().

◆ m_Flags

ULONG FxWmiProvider::m_Flags

Definition at line 274 of file fxwmiprovider.hpp.

Referenced by AddInstance(), FxWmiProvider(), GetFlags(), GetRegistrationFlagsLocked(), IsEventOnly(), and RemoveInstance().

◆

struct { ... } FxWmiProvider::m_FlagsByName

◆ m_FunctionControl

FxWmiProviderFunctionControlCallback FxWmiProvider::m_FunctionControl

protected

Definition at line 286 of file fxwmiprovider.hpp.

Referenced by FunctionControl(), FxWmiProvider(), and IsFunctionControlSupported().

◆ m_Guid

GUID FxWmiProvider::m_Guid

protected

Definition at line 260 of file fxwmiprovider.hpp.

Referenced by FxWmiIrpHandler::_RegInfo(), FxWmiIrpHandler::FindProviderLocked(), FxWmiProvider(), and GetGUID().

◆ m_InstanceListHead

LIST_ENTRY FxWmiProvider::m_InstanceListHead

protected

Definition at line 254 of file fxwmiprovider.hpp.

Referenced by AddInstanceLocked(), FxWmiProvider(), GetInstanceIndex(), and GetInstanceReferencedLocked().

◆ m_ListEntry

LIST_ENTRY FxWmiProvider::m_ListEntry

protected

Definition at line 252 of file fxwmiprovider.hpp.

Referenced by FxWmiProvider(), GetInstanceIndex(), GetInstanceReferencedLocked(), and ~FxWmiProvider().

◆ m_MinInstanceBufferSize

ULONG FxWmiProvider::m_MinInstanceBufferSize

protected

Definition at line 268 of file fxwmiprovider.hpp.

Referenced by FxWmiProvider(), and GetMinInstanceBufferSize().

◆ m_NumInstances

ULONG FxWmiProvider::m_NumInstances

protected

Definition at line 256 of file fxwmiprovider.hpp.

Referenced by FxWmiIrpHandler::_RegInfo(), AddInstanceLocked(), FxWmiIrpHandler::AddPowerPolicyProviderAndInstance(), FxWmiProvider(), GetInstanceIndex(), GetInstanceReferencedLocked(), GetRegistrationFlagsLocked(), and RemoveInstance().

◆ m_Parent

FxWmiIrpHandler* FxWmiProvider::m_Parent

protected

Definition at line 258 of file fxwmiprovider.hpp.

Referenced by AddInstance(), AddInstanceLocked(), Dispose(), FunctionControl(), FxWmiProvider(), GetDevice(), GetInstanceIndex(), GetInstanceReferenced(), and RemoveInstance().

◆ m_RemoveGuid

BOOLEAN FxWmiProvider::m_RemoveGuid

protected

Definition at line 292 of file fxwmiprovider.hpp.

Referenced by AddInstanceLocked(), FxWmiProvider(), GetRegistrationFlagsLocked(), and RemoveInstance().

◆ m_TracingHandle

ULONGLONG FxWmiProvider::m_TracingHandle

protected

Definition at line 266 of file fxwmiprovider.hpp.

Referenced by FxWmiProvider(), GetTracingHandle(), and SetTracingHandle().

◆ Tracing

ULONG FxWmiProvider::Tracing

Definition at line 282 of file fxwmiprovider.hpp.

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxwmiprovider.hpp
sdk/lib/drivers/wdf/kmdf/src/irphandlers/wmi/fxwmiapi.cpp
sdk/lib/drivers/wdf/kmdf/src/irphandlers/wmi/fxwmiprovider.cpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/um/fxwmiproviderum.cpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AddInstanceAction

Constructor & Destructor Documentation

◆ FxWmiProvider()

◆ ~FxWmiProvider()

Member Function Documentation

◆ _Create()

◆ AddInstance()

◆ AddInstanceLocked()

◆ Dispose()

◆ FunctionControl()

◆ GetDevice()

◆ GetFlags()

◆ GetGUID()

◆ GetHandle()

◆ GetInstanceIndex()

◆ GetInstanceReferenced()

◆ GetInstanceReferencedLocked()

◆ GetMinInstanceBufferSize()

◆ GetRegistrationFlagsLocked()

◆ GetTracingHandle()

◆ IsEnabled()

◆ IsEventOnly()

◆ IsFunctionControlSupported()

◆ RemoveInstance()

◆ SetTracingHandle()

Member Data Documentation

◆

◆ EventOnly

◆ Expensive

◆ FxWmiIrpHandler

◆ m_DataBlockControlEnabled

◆ m_EventControlEnabled

◆ m_Flags

◆

◆ m_FunctionControl

◆ m_Guid

◆ m_InstanceListHead

◆ m_ListEntry

◆ m_MinInstanceBufferSize

◆ m_NumInstances

◆ m_Parent

◆ m_RemoveGuid

◆ m_TracingHandle

◆ Tracing