Mx Class Reference

#include <mxgeneral.h>

Public Member Functions
	__drv_maxIRQL (HIGH_LEVEL) __drv_raisesIRQL(NewIrql) __inline static VOID MxRaiseIrql(__in KIRQL NewIrql
	__drv_maxIRQL (HIGH_LEVEL) __inline static VOID MxLowerIrql(__in __drv_restoresIRQL __drv_nonConstant KIRQL NewIrql)
	_Acquires_lock_ (_Global_critical_region_) __inline static VOID MxEnterCriticalRegion()
	_Releases_lock_ (_Global_critical_region_) __inline static VOID MxLeaveCriticalRegion()
	_Releases_lock_ (_Global_cancel_spin_lock_) __drv_requiresIRQL(DISPATCH_LEVEL) __inline static VOID ReleaseCancelSpinLock(__in __drv_restoresIRQL __drv_useCancelIRQL KIRQL Irql)

Static Public Member Functions
static __inline BOOLEAN	IsUM ()
static __inline BOOLEAN	IsKM ()
static __inline MxThread	MxGetCurrentThread ()
static __inline MdEThread	GetCurrentEThread ()
static NTSTATUS	MxTerminateCurrentThread (__in NTSTATUS Status)
static __inline KIRQL	MxGetCurrentIrql ()
static __inline VOID	MxQueryTickCount (__out PLARGE_INTEGER TickCount)
static __inline ULONG	MxQueryTimeIncrement ()
static DECLSPEC_NORETURN VOID	MxBugCheckEx (__in ULONG BugCheckCode, __in ULONG_PTR BugCheckParameter1, __in ULONG_PTR BugCheckParameter2, __in ULONG_PTR BugCheckParameter3, __in ULONG_PTR BugCheckParameter4)
static __inline VOID	MxDbgBreakPoint ()
static VOID	MxDbgPrint (__drv_formatString(printf) __in PCSTR DebugMessage,...)
static __inline VOID	MxAssert (__in BOOLEAN Condition)
static __inline VOID	MxAssertMsg (__in LPSTR Message, __in BOOLEAN Condition)
static __inline VOID	MxDelayExecutionThread (__in KPROCESSOR_MODE WaitMode, __in BOOLEAN Alertable, __in PLARGE_INTEGER Interval)
static __inline PVOID	MxGetSystemRoutineAddress (__in MxFuncName FuncName)
static __inline VOID	MxReferenceObject (__in PVOID Object)
static __inline VOID	MxDereferenceObject (__in PVOID Object)
static __inline VOID	MxInitializeRemoveLock (__in MdRemoveLock Lock, __in ULONG AllocateTag, __in ULONG MaxLockedMinutes, __in ULONG HighWatermark)
static __inline NTSTATUS	MxAcquireRemoveLock (__in MdRemoveLock RemoveLock, __in_opt PVOID Tag)
static __inline VOID	MxReleaseRemoveLock (__in MdRemoveLock RemoveLock, __in PVOID Tag)
static __inline VOID	MxReleaseRemoveLockAndWait (__in MdRemoveLock RemoveLock, __in PVOID Tag)
static __inline BOOLEAN	MxHasEnoughRemainingThreadStack (VOID)
static __inline NTSTATUS	CreateCallback (__out PCALLBACK_OBJECT *CallbackObject, __in POBJECT_ATTRIBUTES ObjectAttributes, __in BOOLEAN Create, __in BOOLEAN AllowMultipleCallbacks)
static __inline PVOID	RegisterCallback (__in PCALLBACK_OBJECT CallbackObject, __in MdCallbackFunction CallbackFunction, __in PVOID CallbackContext)
static __inline VOID	UnregisterCallback (__in PVOID CbRegistration)
static VOID	MxGlobalInit (VOID)
static __inline VOID	MxUnlockPages (__in PMDL Mdl)
static __inline PVOID	MxGetSystemAddressForMdlSafe (__inout PMDL Mdl, __in ULONG Priority)
static __inline VOID	MxBuildMdlForNonPagedPool (__inout PMDL Mdl)
static __inline PVOID	MxGetDriverObjectExtension (__in MdDriverObject DriverObject, __in PVOID ClientIdentificationAddress)
static __inline NTSTATUS	MxAllocateDriverObjectExtension (_In_ MdDriverObject DriverObject, _In_ PVOID ClientIdentificationAddress, _In_ ULONG DriverObjectExtensionSize, _Post_ _At_(*DriverObjectExtension, _When_(return==0, __drv_aliasesMem __drv_allocatesMem(Mem) _Post_notnull_)) _When_(return==0, _Outptr_result_bytebuffer_(DriverObjectExtensionSize)) PVOID *DriverObjectExtension)
static __inline MdDeviceObject	MxGetAttachedDeviceReference (__in MdDeviceObject DriverObject)
static __inline VOID	MxDeleteSymbolicLink (__in PUNICODE_STRING Link)
static __inline VOID	MxDeleteNPagedLookasideList (_In_ PNPAGED_LOOKASIDE_LIST LookasideList)
static __inline VOID	MxDeletePagedLookasideList (_In_ PPAGED_LOOKASIDE_LIST LookasideList)
static __inline VOID	MxInitializeNPagedLookasideList (_Out_ PNPAGED_LOOKASIDE_LIST Lookaside, _In_opt_ PALLOCATE_FUNCTION Allocate, _In_opt_ PFREE_FUNCTION Free, _In_ ULONG Flags, _In_ SIZE_T Size, _In_ ULONG Tag, _In_ USHORT Depth)
static __inline VOID	MxInitializePagedLookasideList (_Out_ PPAGED_LOOKASIDE_LIST Lookaside, _In_opt_ PALLOCATE_FUNCTION Allocate, _In_opt_ PFREE_FUNCTION Free, _In_ ULONG Flags, _In_ SIZE_T Size, _In_ ULONG Tag, _In_ USHORT Depth)
static __inline VOID	MxDeleteDevice (_In_ MdDeviceObject Device)
static VOID	MxDetachDevice (_Inout_ MdDeviceObject Device)
static __inline MdDeviceObject	MxAttachDeviceToDeviceStack (_In_ MdDeviceObject SourceDevice, _In_ MdDeviceObject TargetDevice)
static __inline NTSTATUS	MxCreateDeviceSecure (_In_ MdDriverObject DriverObject, _In_ ULONG DeviceExtensionSize, _In_opt_ PUNICODE_STRING DeviceName, _In_ DEVICE_TYPE DeviceType, _In_ ULONG DeviceCharacteristics, _In_ BOOLEAN Exclusive, _In_ PCUNICODE_STRING DefaultSDDLString, _In_opt_ LPCGUID DeviceClassGuid, _Out_ MdDeviceObject *DeviceObject)
static __inline NTSTATUS	MxCreateDevice (_In_ MdDriverObject DriverObject, _In_ ULONG DeviceExtensionSize, _In_opt_ PUNICODE_STRING DeviceName, _In_ DEVICE_TYPE DeviceType, _In_ ULONG DeviceCharacteristics, _In_ BOOLEAN Exclusive, _Out_ MdDeviceObject *DeviceObject)
static __inline NTSTATUS	MxCreateSymbolicLink (_In_ PUNICODE_STRING SymbolicLinkName, _In_ PUNICODE_STRING DeviceName)
static __inline VOID	MxFlushQueuedDpcs ()
static __inline NTSTATUS	MxOpenKey (_Out_ PHANDLE KeyHandle, _In_ ACCESS_MASK DesiredAccess, _In_ POBJECT_ATTRIBUTES ObjectAttributes)
static __inline NTSTATUS	MxSetDeviceInterfaceState (_In_ PUNICODE_STRING SymbolicLinkName, _In_ BOOLEAN Enable)
static __inline NTSTATUS	MxRegisterDeviceInterface (_In_ PDEVICE_OBJECT PhysicalDeviceObject, _In_ const GUID *InterfaceClassGuid, _In_opt_ PUNICODE_STRING ReferenceString, _Out_ PUNICODE_STRING SymbolicLinkName)
static __inline NTSTATUS	MxDeleteKey (_In_ HANDLE KeyHandle)
static __inline VOID	MxInitializeMdl (_In_ PMDL MemoryDescriptorList, _In_ PVOID BaseVa, _In_ SIZE_T Length)
static __inline PVOID	MxGetMdlVirtualAddress (_In_ PMDL Mdl)
static __inline VOID	MxBuildPartialMdl (_In_ PMDL SourceMdl, _Inout_ PMDL TargetMdl, _In_ PVOID VirtualAddress, _In_ ULONG Length)
static __inline VOID	MxQuerySystemTime (_Out_ PLARGE_INTEGER CurrentTime)
static __inline NTSTATUS	MxSetValueKey (_In_ HANDLE KeyHandle, _In_ PUNICODE_STRING ValueName, _In_opt_ ULONG TitleIndex, _In_ ULONG Type, _In_opt_ PVOID Data, _In_ ULONG DataSize)
static __inline NTSTATUS	MxQueryValueKey (_In_ HANDLE KeyHandle, _In_ PUNICODE_STRING ValueName, _In_ KEY_VALUE_INFORMATION_CLASS KeyValueInformationClass, _Out_opt_ PVOID KeyValueInformation, _In_ ULONG Length, _Out_ PULONG ResultLength)
static __inline NTSTATUS	MxReferenceObjectByHandle (__in HANDLE Handle, __in ACCESS_MASK DesiredAccess, __in_opt POBJECT_TYPE ObjectType, __in KPROCESSOR_MODE AccessMode, __out PVOID *Object, __out_opt POBJECT_HANDLE_INFORMATION HandleInformation)
static __inline NTSTATUS	MxUnRegisterPlugPlayNotification (__in __drv_freesMem(Pool) PVOID NotificationEntry)
static __inline NTSTATUS	MxClose (__in HANDLE Handle)
static __inline KIRQL	MxAcquireInterruptSpinLock (_Inout_ PKINTERRUPT Interrupt)
static __inline VOID	MxReleaseInterruptSpinLock (_Inout_ PKINTERRUPT Interrupt, _In_ KIRQL OldIrql)
static __inline BOOLEAN	MxInsertQueueDpc (__inout PRKDPC Dpc, __in_opt PVOID SystemArgument1, __in_opt PVOID SystemArgument2)

Public Attributes
__out __deref __drv_savesIRQL PKIRQL	OldIrql

Detailed Description

Definition at line 40 of file mxgeneral.h.

Member Function Documentation

__drv_maxIRQL() [1/2]

Mx::__drv_maxIRQL

(

HIGH_LEVEL

)

__drv_maxIRQL() [2/2]

Mx::__drv_maxIRQL

(

HIGH_LEVEL

)

_Acquires_lock_()

Mx::_Acquires_lock_

(

_Global_critical_region_

)

_Releases_lock_() [1/2]

Mx::_Releases_lock_

(

_Global_cancel_spin_lock_

)

_Releases_lock_() [2/2]

Mx::_Releases_lock_

(

_Global_critical_region_

)

CreateCallback()

__inline NTSTATUS Mx::CreateCallback ( __out PCALLBACK_OBJECT *  CallbackObject, __in POBJECT_ATTRIBUTES  ObjectAttributes, __in BOOLEAN  Create, __in BOOLEAN  AllowMultipleCallbacks  )

static

Definition at line 318 of file mxgeneralkm.h.

{
    return ExCreateCallback(
        CallbackObject,
        ObjectAttributes,
        Create,
        AllowMultipleCallbacks);
}

Referenced by FxPowerPolicyOwnerSettings::Init().

GetCurrentEThread()

__inline MdEThread Mx::GetCurrentEThread ( )

static

Definition at line 69 of file mxgeneralkm.h.

{
    return PsGetCurrentThread();
}

Referenced by FX_VF_METHOD(), FxSystemThread::IsCurrentThread(), FxSystemThread::Thread(), and FxWorkItem::WaitForSignal().

IsKM()

__inline BOOLEAN Mx::IsKM ( )

static

Definition at line 53 of file mxgeneralkm.h.

{
    return TRUE;
}

Referenced by FxPoolAllocator(), and FxPoolFree().

IsUM()

__inline BOOLEAN Mx::IsUM ( )

static

Definition at line 45 of file mxgeneralkm.h.

{
    return FALSE;
}

Referenced by FxPoolAllocator().

MxAcquireInterruptSpinLock()

__inline KIRQL Mx::MxAcquireInterruptSpinLock ( _Inout_ PKINTERRUPT  Interrupt )

static

Definition at line 767 of file mxgeneralkm.h.

{
    return KeAcquireInterruptSpinLock(Interrupt);
}

Referenced by FxInterrupt::AcquireLock().

MxAcquireRemoveLock()

__inline NTSTATUS Mx::MxAcquireRemoveLock ( __in MdRemoveLock  RemoveLock, __in_opt PVOID  Tag  )

static

Definition at line 268 of file mxgeneralkm.h.

{
    return IoAcquireRemoveLock(RemoveLock, Tag);
}

Referenced by FxDevice::_AcquireOptinRemoveLock(), FxPkgPnp::_PnpRemoveDevice(), FxPkgGeneral::AcquireRemoveLockForClose(), FxDevice::DispatchPreprocessedIrp(), FxDevice::DispatchWithLock(), and FxPkgPnp::PnpEventFinal().

MxAllocateDriverObjectExtension()

__inline NTSTATUS Mx::MxAllocateDriverObjectExtension ( _In_ MdDriverObject  DriverObject, _In_ PVOID  ClientIdentificationAddress, _In_ ULONG  DriverObjectExtensionSize, _Post_ _At_(*,(==0, Mem  _Post_notnull_  )

static

Definition at line 396 of file mxgeneralkm.h.

{
    return IoAllocateDriverObjectExtension(DriverObject,
                                            ClientIdentificationAddress,
                                            DriverObjectExtensionSize,
                                            DriverObjectExtension);
}

Referenced by FxDriver::AllocateDriverObjectExtensionAndStoreFxDriver().

MxAssert()

__inline VOID Mx::MxAssert ( __in BOOLEAN  Condition )

static

Definition at line 165 of file mxgeneralkm.h.

{
    UNREFERENCED_PARAMETER(Condition);
 
    ASSERT(Condition); //this get defined as RtlAssert
}

Referenced by __drv_when(), FxPkgPnp::CleanupDeviceFromFailedCreate(), FxPkgPnp::Dispatch(), FxPkgPdo::Initialize(), MxWorkItem::WaitForCallbacksToComplete(), and FxPkgPnp::~FxPkgPnp().

MxAssertMsg()

__inline VOID Mx::MxAssertMsg ( __in LPSTR  Message, __in BOOLEAN  Condition  )

static

Definition at line 176 of file mxgeneralkm.h.

{
    UNREFERENCED_PARAMETER(Message);
    UNREFERENCED_PARAMETER(Condition);
 
    ASSERT(Condition);
 
    // ASSERTMSG(Message, Condition); TODO: wtf
}

Referenced by __drv_when(), and MxLockNoDynam::TryToAcquire().

MxAttachDeviceToDeviceStack()

__inline MdDeviceObject Mx::MxAttachDeviceToDeviceStack ( _In_ MdDeviceObject  SourceDevice, _In_ MdDeviceObject  TargetDevice  )

static

Definition at line 511 of file mxgeneralkm.h.

{
    return IoAttachDeviceToDeviceStack(SourceDevice, TargetDevice);
}

Referenced by FxDevice::FdoInitialize().

MxBugCheckEx()

VOID Mx::MxBugCheckEx ( __in ULONG  BugCheckCode, __in ULONG_PTR  BugCheckParameter1, __in ULONG_PTR  BugCheckParameter2, __in ULONG_PTR  BugCheckParameter3, __in ULONG_PTR  BugCheckParameter4  )

static

Definition at line 133 of file mxgeneralkm.h.

{
#ifdef _MSC_VER
    #pragma prefast(suppress:__WARNING_USE_OTHER_FUNCTION, "KeBugCheckEx is the intent.");
#endif
    KeBugCheckEx(
        BugCheckCode,
        BugCheckParameter1,
        BugCheckParameter2,
        BugCheckParameter3,
        BugCheckParameter4
        );
 
    UNREACHABLE;
}

Referenced by FxPoolFree(), FxVerifierBugCheckWorker(), WdfCxVerifierKeBugCheck(), and WdfVerifierKeBugCheck().

MxBuildMdlForNonPagedPool()

__inline VOID Mx::MxBuildMdlForNonPagedPool ( __inout PMDL  Mdl )

static

Definition at line 376 of file mxgeneralkm.h.

{
    MmBuildMdlForNonPagedPool(Mdl);
}

Referenced by FxRequest::GetDeviceControlOutputMdl(), and FxRequest::GetMdl().

MxBuildPartialMdl()

__inline VOID Mx::MxBuildPartialMdl ( _In_ PMDL  SourceMdl, _Inout_ PMDL  TargetMdl, _In_ PVOID  VirtualAddress, _In_ ULONG  Length  )

static

Definition at line 663 of file mxgeneralkm.h.

{
    IoBuildPartialMdl(SourceMdl,
                        TargetMdl,
                        VirtualAddress,
                        Length
                        );
}

Referenced by FxRequestBuffer::GetOrAllocateMdl().

MxClose()

__inline NTSTATUS Mx::MxClose ( __in HANDLE  Handle )

static

Definition at line 758 of file mxgeneralkm.h.

{
    return ZwClose(Handle);
}

Referenced by FxIoTargetRemote::Close().

MxCreateDevice()

__inline NTSTATUS Mx::MxCreateDevice ( _In_ MdDriverObject  DriverObject, _In_ ULONG  DeviceExtensionSize, _In_opt_ PUNICODE_STRING  DeviceName, _In_ DEVICE_TYPE  DeviceType, _In_ ULONG  DeviceCharacteristics, _In_ BOOLEAN  Exclusive, _Out_ MdDeviceObject *  DeviceObject  )

static

Definition at line 557 of file mxgeneralkm.h.

{
    return IoCreateDevice(DriverObject,
                    DeviceExtensionSize,
                    DeviceName,
                    DeviceType,
                    DeviceCharacteristics,
                    Exclusive,
                    DeviceObject);
 
}

Referenced by FxDevice::CreateDevice().

MxCreateDeviceSecure()

__inline NTSTATUS Mx::MxCreateDeviceSecure ( _In_ MdDriverObject  DriverObject, _In_ ULONG  DeviceExtensionSize, _In_opt_ PUNICODE_STRING  DeviceName, _In_ DEVICE_TYPE  DeviceType, _In_ ULONG  DeviceCharacteristics, _In_ BOOLEAN  Exclusive, _In_ PCUNICODE_STRING  DefaultSDDLString, _In_opt_ LPCGUID  DeviceClassGuid, _Out_ MdDeviceObject *  DeviceObject  )

static

Definition at line 521 of file mxgeneralkm.h.

{
#ifndef __REACTOS__ // we don't have wdmsec.lib
    return IoCreateDeviceSecure(DriverObject,
                DeviceExtensionSize,
                DeviceName,
                DeviceType,
                DeviceCharacteristics,
                Exclusive,
                DefaultSDDLString,
                DeviceClassGuid,
                DeviceObject);
#else
    return IoCreateDevice(
                DriverObject,
                DeviceExtensionSize,
                DeviceName,
                DeviceType,
                DeviceCharacteristics,
                Exclusive,
                DeviceObject);
#endif
}

Referenced by FxDevice::CreateDevice().

MxCreateSymbolicLink()

__inline NTSTATUS Mx::MxCreateSymbolicLink ( _In_ PUNICODE_STRING  SymbolicLinkName, _In_ PUNICODE_STRING  DeviceName  )

static

Definition at line 579 of file mxgeneralkm.h.

{
    return IoCreateSymbolicLink(SymbolicLinkName, DeviceName);
}

Referenced by FxDevice::CreateSymbolicLink().

MxDbgBreakPoint()

__inline VOID Mx::MxDbgBreakPoint ( )

static

Definition at line 157 of file mxgeneralkm.h.

{
    DbgBreakPoint();
}

Referenced by FxVerifierBreakOnDeviceStateError(), and FxVerifierDbgBreakPoint().

MxDbgPrint()

VOID Mx::MxDbgPrint ( __drv_formatString(printf) __in PCSTR  DebugMessage,   ...  )

static

Definition at line 7 of file mxgeneralkm.cpp.

{
#if DBG
 
#define         TEMP_BUFFER_SIZE        1024
    va_list     list;
    CHAR        debugMessageBuffer[TEMP_BUFFER_SIZE];
    NTSTATUS    status;
 
    va_start(list, DebugMessage);
 
    if (DebugMessage) {
 
        //
        // Using new safe string functions instead of _vsnprintf.
        // This function takes care of NULL terminating if the message
        // is longer than the buffer.
        //
        status = RtlStringCbVPrintfA( debugMessageBuffer,
                                      sizeof(debugMessageBuffer),
                                      DebugMessage,
                                      list );
        if(!NT_SUCCESS(status)) {
 
            DbgPrint ("WDF DbgPrint: Unable to expand: %s", DebugMessage);
        }
        else {
            DbgPrint("%s", debugMessageBuffer);
        }
    }
    va_end(list);
 
#else
    UNREFERENCED_PARAMETER(DebugMessage);
#endif
    return;
}

Referenced by FxVerifierBreakOnDeviceStateError(), and FxVerifierDbgBreakPoint().

MxDelayExecutionThread()

__inline VOID Mx::MxDelayExecutionThread ( __in KPROCESSOR_MODE  WaitMode, __in BOOLEAN  Alertable, __in PLARGE_INTEGER  Interval  )

static

Definition at line 209 of file mxgeneralkm.h.

{
    ASSERTMSG("Interval must be relative\n", Interval->QuadPart <= 0);
 
    KeDelayExecutionThread(
        WaitMode,
        Alertable,
        Interval
        );
}

Referenced by FxVerifierLock::Lock(), FxPkgPnp::PowerPolicySendDevicePowerRequest(), and FxVerifierLock::Unlock().

MxDeleteDevice()

__inline VOID Mx::MxDeleteDevice ( _In_ MdDeviceObject  Device )

static

Definition at line 493 of file mxgeneralkm.h.

{
    IoDeleteDevice(Device);
}

Referenced by FxDevice::DeleteObject(), FxDevice::Destroy(), and FxDevice::FdoInitialize().

MxDeleteKey()

__inline NTSTATUS Mx::MxDeleteKey ( _In_ HANDLE  KeyHandle )

static

Definition at line 634 of file mxgeneralkm.h.

{
    return ZwDeleteKey(KeyHandle);
}

MxDeleteNPagedLookasideList()

__inline VOID Mx::MxDeleteNPagedLookasideList ( _In_ PNPAGED_LOOKASIDE_LIST  LookasideList )

static

Definition at line 433 of file mxgeneralkm.h.

{
    ExDeleteNPagedLookasideList(LookasideList);
}

Referenced by FxDevice::~FxDevice(), and FxPagedLookasideListFromPool::~FxPagedLookasideListFromPool().

MxDeletePagedLookasideList()

__inline VOID Mx::MxDeletePagedLookasideList ( _In_ PPAGED_LOOKASIDE_LIST  LookasideList )

static

Definition at line 442 of file mxgeneralkm.h.

{
    ExDeletePagedLookasideList(LookasideList);
}

Referenced by FxPagedLookasideListFromPool::~FxPagedLookasideListFromPool().

MxDeleteSymbolicLink()

__inline VOID Mx::MxDeleteSymbolicLink ( __in PUNICODE_STRING  Link )

static

Definition at line 424 of file mxgeneralkm.h.

{
    IoDeleteSymbolicLink(Value);
}

MxDereferenceObject()

__inline VOID Mx::MxDereferenceObject ( __in PVOID  Object )

static

Definition at line 247 of file mxgeneralkm.h.

{
    ObDereferenceObject(Object);
}

Referenced by FxPowerPolicyOwnerSettings::CleanupPowerCallback(), FxIoTargetRemote::Close(), FxDevice::Destroy(), FxMpDevice::Dispose(), FxPkgPnp::HandleQueryDeviceRelations(), FxPowerPolicyOwnerSettings::Init(), and FxDeviceBase::QueryForInterface().

MxDetachDevice()

VOID Mx::MxDetachDevice ( _Inout_ MdDeviceObject  Device )

static

Definition at line 502 of file mxgeneralkm.h.

{
    IoDetachDevice(Device);
}

Referenced by FxDevice::DetachDevice().

MxFlushQueuedDpcs()

__inline VOID Mx::MxFlushQueuedDpcs ( )

static

Definition at line 589 of file mxgeneralkm.h.

{
    KeFlushQueuedDpcs();
}

Referenced by MxTimer::FlushQueuedDpcs().

MxGetAttachedDeviceReference()

__inline MdDeviceObject Mx::MxGetAttachedDeviceReference ( __in MdDeviceObject  DriverObject )

static

Definition at line 415 of file mxgeneralkm.h.

{
    return IoGetAttachedDeviceReference(DriverObject);
}

Referenced by FxDeviceBase::GetAttachedDeviceReference().

MxGetCurrentIrql()

__inline KIRQL Mx::MxGetCurrentIrql ( )

static

Definition at line 86 of file mxgeneralkm.h.

{
    return KeGetCurrentIrql();
}

Referenced by FxInterrupt::AcquireLock(), FxPkgPnp::CleanupDeviceFromFailedCreate(), FxDriver::DeleteObject(), FxDevice::Destroy(), FxPkgIo::DispatchStep2(), FxDevice::Dispose(), FxInterrupt::Dispose(), FxIoTarget::Dispose(), FxSystemWorkItem::Dispose(), FxTimer::Dispose(), FxPkgIo::FlushAllQueuesByFileObject(), FxInterrupt::FlushAndRundown(), FxVerifierCheckIrqlLevel(), FxVerifierLock::Lock(), FxPkgGeneral::OnCreate(), FxPkgPnp::PowerPolicySetS0IdleSettings(), FxPkgPnp::PowerPolicySetSxWakeSettings(), FxPkgPnp::PowerPolicySetSxWakeState(), FxPowerIdleMachine::PowerReferenceWorker(), FxUsbDevice::Purge(), FxInterrupt::QueueWorkItemForIsr(), FxInterrupt::ReleaseLock(), FxObject::ShouldDeferDisposeLocked(), FxTimer::Stop(), FxUsbDevice::Stop(), FxInterrupt::TryToAcquireLock(), FxVerifierLock::Unlock(), FxIoTarget::WaitForDisposeEvent(), FxIoTarget::WaitForSentIoToComplete(), _FX_DRIVER_GLOBALS::WaitForSignal(), FxWorkItem::WaitForSignal(), FxDeviceText::~FxDeviceText(), and FxPkgPnp::~FxPkgPnp().

MxGetCurrentThread()

__inline MxThread Mx::MxGetCurrentThread ( )

static

Definition at line 61 of file mxgeneralkm.h.

{
    return KeGetCurrentThread();
}

Referenced by __drv_raisesIRQL(), __drv_requiresIRQL(), _Releases_lock_(), FxIoQueue::CanThreadDispatchEventsLocked(), FxWorkItem::FlushAndRundown(), FxTimer::FlushAndRundown(), FxWorkItem::FlushAndWait(), FxUsbPipeContinuousReader::FxUsbPipeRequestWorkItemHandler(), FxUsbPipe::GotoPurgeState(), FxUsbPipe::GotoStopState(), FxCallbackMutexLock::IsOwner(), FxCallbackSpinLock::IsOwner(), FxCallbackMutexLock::Lock(), FxCallbackSpinLock::Lock(), FxVerifierLock::Lock(), FxPowerIdleMachine::PowerReferenceWorker(), FxWatchdog::StartTimer(), FxTimer::Stop(), FxTimer::TimerHandler(), FxVerifierLock::Unlock(), FxDisposeList::WaitForEmpty(), and _FX_DRIVER_GLOBALS::WaitForSignal().

MxGetDriverObjectExtension()

__inline PVOID Mx::MxGetDriverObjectExtension ( __in MdDriverObject  DriverObject, __in PVOID  ClientIdentificationAddress  )

static

Definition at line 385 of file mxgeneralkm.h.

{
    return IoGetDriverObjectExtension(DriverObject,
                                        ClientIdentificationAddress);
}

Referenced by FxDriver::GetFxDriver().

MxGetMdlVirtualAddress()

__inline PVOID Mx::MxGetMdlVirtualAddress ( _In_ PMDL  Mdl )

static

Definition at line 654 of file mxgeneralkm.h.

{
    return MmGetMdlVirtualAddress(Mdl);
}

Referenced by FxRequestBuffer::GetOrAllocateMdl().

MxGetSystemAddressForMdlSafe()

__inline PVOID Mx::MxGetSystemAddressForMdlSafe ( __inout PMDL  Mdl, __in ULONG  Priority  )

static

Definition at line 366 of file mxgeneralkm.h.

{
    return MmGetSystemAddressForMdlSafe(Mdl, Priority);
}

Referenced by FxRequestBuffer::GetBuffer(), FxRequestSystemBuffer::GetBuffer(), FxRequestOutputBuffer::GetBuffer(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetMemoryObject(), FxRequest::ProbeAndLockForRead(), and FxRequest::ProbeAndLockForWrite().

MxGetSystemRoutineAddress()

__inline PVOID Mx::MxGetSystemRoutineAddress ( __in MxFuncName  FuncName )

static

Definition at line 226 of file mxgeneralkm.h.

{
    UNICODE_STRING funcName;
 
    RtlInitUnicodeString(&funcName, FuncName);
    return MmGetSystemRoutineAddress(&funcName);
}

Referenced by FxLibraryGlobalsCommission(), and FxLibraryGlobalsVerifyVersion().

MxGlobalInit()

VOID Mx::MxGlobalInit ( VOID  )

static

Definition at line 51 of file mxgeneralkm.cpp.

{
    //
    // Global initialization for kernel-mode primitives
    //
}

Referenced by FxLibraryGlobalsCommission().

MxHasEnoughRemainingThreadStack()

__inline BOOLEAN Mx::MxHasEnoughRemainingThreadStack ( VOID  )

static

Definition at line 298 of file mxgeneralkm.h.

{
    return (IoGetRemainingStackSize() < KERNEL_STACK_SIZE/2) ? FALSE : TRUE;
}

Referenced by FxPkgPnp::PnpDeviceUsageNotification(), and FxPkgPdo::PnpQueryCapabilities().

MxInitializeMdl()

__inline VOID Mx::MxInitializeMdl ( _In_ PMDL  MemoryDescriptorList, _In_ PVOID  BaseVa, _In_ SIZE_T  Length  )

static

Definition at line 643 of file mxgeneralkm.h.

{
    MmInitializeMdl(MemoryDescriptorList, BaseVa, Length);
}

Referenced by FxRequestBuffer::GetOrAllocateMdl().

MxInitializeNPagedLookasideList()

__inline VOID Mx::MxInitializeNPagedLookasideList ( _Out_ PNPAGED_LOOKASIDE_LIST  Lookaside, _In_opt_ PALLOCATE_FUNCTION  Allocate, _In_opt_ PFREE_FUNCTION  Free, _In_ ULONG  Flags, _In_ SIZE_T  Size, _In_ ULONG  Tag, _In_ USHORT  Depth  )

static

Definition at line 451 of file mxgeneralkm.h.

{
    ExInitializeNPagedLookasideList(Lookaside,
                                        Allocate,
                                        Free,
                                        Flags,
                                        Size,
                                        Tag,
                                        Depth);
}

Referenced by FxDevice::Initialize(), and FxPagedLookasideListFromPool::Initialize().

MxInitializePagedLookasideList()

__inline VOID Mx::MxInitializePagedLookasideList ( _Out_ PPAGED_LOOKASIDE_LIST  Lookaside, _In_opt_ PALLOCATE_FUNCTION  Allocate, _In_opt_ PFREE_FUNCTION  Free, _In_ ULONG  Flags, _In_ SIZE_T  Size, _In_ ULONG  Tag, _In_ USHORT  Depth  )

static

Definition at line 472 of file mxgeneralkm.h.

{
    ExInitializePagedLookasideList(Lookaside,
                                        Allocate,
                                        Free,
                                        Flags,
                                        Size,
                                        Tag,
                                        Depth);
}

Referenced by FxPagedLookasideListFromPool::Initialize().

MxInitializeRemoveLock()

__inline VOID Mx::MxInitializeRemoveLock ( __in MdRemoveLock  Lock, __in ULONG  AllocateTag, __in ULONG  MaxLockedMinutes, __in ULONG  HighWatermark  )

static

Definition at line 256 of file mxgeneralkm.h.

{
    IoInitializeRemoveLock(Lock, AllocateTag, MaxLockedMinutes, HighWatermark);
}

Referenced by FxDevice::CreateDevice().

MxInsertQueueDpc()

__inline BOOLEAN Mx::MxInsertQueueDpc ( __inout PRKDPC  Dpc, __in_opt PVOID  SystemArgument1, __in_opt PVOID  SystemArgument2  )

static

Definition at line 786 of file mxgeneralkm.h.

{
    return KeInsertQueueDpc(Dpc, SystemArgument1, SystemArgument2);
}

Referenced by FxInterrupt::QueueWorkItemForIsr().

MxOpenKey()

__inline NTSTATUS Mx::MxOpenKey ( _Out_ PHANDLE  KeyHandle, _In_ ACCESS_MASK  DesiredAccess, _In_ POBJECT_ATTRIBUTES  ObjectAttributes  )

static

Definition at line 597 of file mxgeneralkm.h.

{
    return ZwOpenKey(KeyHandle, DesiredAccess, ObjectAttributes);
}

MxQuerySystemTime()

__inline VOID Mx::MxQuerySystemTime ( _Out_ PLARGE_INTEGER  CurrentTime )

static

Definition at line 679 of file mxgeneralkm.h.

{
    KeQuerySystemTime(CurrentTime);
}

Referenced by IsLoggingEnabledAndNeeded(), and RegistryWriteCurrentTime().

MxQueryTickCount()

__inline VOID Mx::MxQueryTickCount ( __out PLARGE_INTEGER  TickCount )

static

Definition at line 116 of file mxgeneralkm.h.

{
    KeQueryTickCount(TickCount);
}

Referenced by __drv_raisesIRQL(), __drv_requiresIRQL(), FxPkgIo::FxPkgIo(), FxTagTrackingBlock::FxTagTrackingBlock(), FxPkgPnp::PnpIncrementRestartCountLogic(), and FxTagTracker::UpdateTagHistory().

MxQueryTimeIncrement()

__inline ULONG Mx::MxQueryTimeIncrement ( )

static

Definition at line 125 of file mxgeneralkm.h.

{
    return KeQueryTimeIncrement();
}

Referenced by FxPkgPnp::PnpIncrementRestartCountLogic().

MxQueryValueKey()

__inline NTSTATUS Mx::MxQueryValueKey ( _In_ HANDLE  KeyHandle, _In_ PUNICODE_STRING  ValueName, _In_ KEY_VALUE_INFORMATION_CLASS  KeyValueInformationClass, _Out_opt_ PVOID  KeyValueInformation, _In_ ULONG  Length, _Out_ PULONG  ResultLength  )

static

Definition at line 708 of file mxgeneralkm.h.

{
    return ZwQueryValueKey(KeyHandle,
                            ValueName,
                            KeyValueInformationClass,
                            KeyValueInformation,
                            Length,
                            ResultLength
                            );
}

MxReferenceObject()

__inline VOID Mx::MxReferenceObject ( __in PVOID  Object )

static

Definition at line 238 of file mxgeneralkm.h.

{
    ObReferenceObject(Object);
}

Referenced by FxDevice::DeleteObject(), FxMpDevice::FxMpDevice(), FxPkgPnp::HandleQueryDeviceRelations(), FxIoTargetRemote::Open(), FxPkgPdo::PnpQueryDeviceRelations(), FxDeviceBase::QueryForInterface(), and FxWorkItemEventQueue::QueueWorkItem().

MxReferenceObjectByHandle()

__inline NTSTATUS Mx::MxReferenceObjectByHandle ( __in HANDLE  Handle, __in ACCESS_MASK  DesiredAccess, __in_opt POBJECT_TYPE  ObjectType, __in KPROCESSOR_MODE  AccessMode, __out PVOID *  Object, __out_opt POBJECT_HANDLE_INFORMATION  HandleInformation  )

static

Definition at line 728 of file mxgeneralkm.h.

{
    return ObReferenceObjectByHandle(
                Handle,
                DesiredAccess,
                ObjectType,
                AccessMode,
                Object,
                HandleInformation);
}

MxRegisterDeviceInterface()

__inline NTSTATUS Mx::MxRegisterDeviceInterface ( _In_ PDEVICE_OBJECT  PhysicalDeviceObject, _In_ const GUID *  InterfaceClassGuid, _In_opt_ PUNICODE_STRING  ReferenceString, _Out_ PUNICODE_STRING  SymbolicLinkName  )

static

Definition at line 619 of file mxgeneralkm.h.

{
    return IoRegisterDeviceInterface(PhysicalDeviceObject,
                                     InterfaceClassGuid,
                                     ReferenceString,
                                     SymbolicLinkName);
}

Referenced by FxDeviceInterface::Register().

MxReleaseInterruptSpinLock()

__inline VOID Mx::MxReleaseInterruptSpinLock ( _Inout_ PKINTERRUPT  Interrupt, _In_ KIRQL  OldIrql  )

static

Definition at line 776 of file mxgeneralkm.h.

{
    KeReleaseInterruptSpinLock(Interrupt, OldIrql);
}

Referenced by FxInterrupt::ReleaseLock().

MxReleaseRemoveLock()

__inline VOID Mx::MxReleaseRemoveLock ( __in MdRemoveLock  RemoveLock, __in PVOID  Tag  )

static

Definition at line 278 of file mxgeneralkm.h.

{
    IoReleaseRemoveLock(RemoveLock, Tag);
}

Referenced by FxPkgFdo::_PnpPassDown(), FxPkgFdo::_PowerPassDown(), FxPkgPnp::CompletePnpRequest(), FxPkgPnp::CompletePowerRequest(), FxDefaultIrpHandler::Dispatch(), FxDevice::DispatchWithLock(), FxPkgGeneral::OnClose(), and PreprocessIrp().

MxReleaseRemoveLockAndWait()

__inline VOID Mx::MxReleaseRemoveLockAndWait ( __in MdRemoveLock  RemoveLock, __in PVOID  Tag  )

static

Definition at line 288 of file mxgeneralkm.h.

{
    IoReleaseRemoveLockAndWait(RemoveLock, Tag);
}

Referenced by FxPkgPnp::PnpEventFinal(), FxPkgFdo::ProcessRemoveDeviceOverload(), and FxPkgPdo::ProcessRemoveDeviceOverload().

MxSetDeviceInterfaceState()

__inline NTSTATUS Mx::MxSetDeviceInterfaceState ( _In_ PUNICODE_STRING  SymbolicLinkName, _In_ BOOLEAN  Enable  )

static

Definition at line 608 of file mxgeneralkm.h.

{
    return IoSetDeviceInterfaceState(SymbolicLinkName, Enable);
}

Referenced by FxDeviceInterface::SetState().

MxSetValueKey()

__inline NTSTATUS Mx::MxSetValueKey ( _In_ HANDLE  KeyHandle, _In_ PUNICODE_STRING  ValueName, _In_opt_ ULONG  TitleIndex, _In_ ULONG  Type, _In_opt_ PVOID  Data, _In_ ULONG  DataSize  )

static

Definition at line 688 of file mxgeneralkm.h.

{
    return ZwSetValueKey(KeyHandle,
                          ValueName,
                          TitleIndex,
                          Type,
                          Data,
                          DataSize
                          );
}

Referenced by RegistryWriteCurrentTime().

MxTerminateCurrentThread()

__inline NTSTATUS Mx::MxTerminateCurrentThread ( __in NTSTATUS  Status )

static

Definition at line 77 of file mxgeneralkm.h.

{
    return PsTerminateSystemThread(Status);
}

MxUnlockPages()

__inline VOID Mx::MxUnlockPages ( __in PMDL  Mdl )

static

Definition at line 357 of file mxgeneralkm.h.

{
    MmUnlockPages(Mdl);
}

Referenced by FxRequest::ProbeAndLockForRead(), FxRequest::ProbeAndLockForWrite(), FxUsbDeviceControlContext::ReleaseAndRestore(), and FxRequestMemory::~FxRequestMemory().

MxUnRegisterPlugPlayNotification()

__inline NTSTATUS Mx::MxUnRegisterPlugPlayNotification ( __in __drv_freesMem(Pool) PVOID  NotificationEntry )

static

Definition at line 748 of file mxgeneralkm.h.

{
    return IoUnregisterPlugPlayNotification(NotificationEntry);
}

RegisterCallback()

__inline PVOID Mx::RegisterCallback ( __in PCALLBACK_OBJECT  CallbackObject, __in MdCallbackFunction  CallbackFunction, __in PVOID  CallbackContext  )

static

Definition at line 334 of file mxgeneralkm.h.

{
    return ExRegisterCallback(
        CallbackObject,
        CallbackFunction,
        CallbackContext);
}

Referenced by FxPowerPolicyOwnerSettings::Init().

UnregisterCallback()

__inline VOID Mx::UnregisterCallback ( __in PVOID  CbRegistration )

static

Definition at line 348 of file mxgeneralkm.h.

{
    ExUnregisterCallback(CbRegistration);
}

Referenced by FxPowerPolicyOwnerSettings::CleanupPowerCallback().

Member Data Documentation

OldIrql

__out __deref __drv_savesIRQL PKIRQL Mx::OldIrql

Definition at line 97 of file mxgeneral.h.

Referenced by __drv_maxIRQL(), and MxReleaseInterruptSpinLock().

---

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

• sdk/lib/drivers/wdf/shared/inc/primitives/common/mxgeneral.h
• sdk/lib/drivers/wdf/shared/inc/primitives/km/mxgeneralkm.h
• sdk/lib/drivers/wdf/shared/inc/primitives/um/mxgeneralum.h
• sdk/lib/drivers/wdf/shared/primitives/km/mxgeneralkm.cpp
• sdk/lib/drivers/wdf/shared/primitives/um/mxgeneralum.cpp