eventobj.c File Reference

#include <ntoskrnl.h>
#include <debug.h>

Include dependency graph for eventobj.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
VOID NTAPI	KeClearEvent (IN PKEVENT Event)
VOID NTAPI	KeInitializeEvent (OUT PKEVENT Event, IN EVENT_TYPE Type, IN BOOLEAN State)
VOID NTAPI	KeInitializeEventPair (IN PKEVENT_PAIR EventPair)
LONG NTAPI	KePulseEvent (IN PKEVENT Event, IN KPRIORITY Increment, IN BOOLEAN Wait)
LONG NTAPI	KeReadStateEvent (IN PKEVENT Event)
LONG NTAPI	KeResetEvent (IN PKEVENT Event)
LONG NTAPI	KeSetEvent (IN PKEVENT Event, IN KPRIORITY Increment, IN BOOLEAN Wait)
VOID NTAPI	KeSetEventBoostPriority (IN PKEVENT Event, IN PKTHREAD *WaitingThread OPTIONAL)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 12 of file eventobj.c.

Function Documentation

KeClearEvent()

VOID NTAPI KeClearEvent

(

IN PKEVENT

Event

)

Definition at line 22 of file eventobj.c.

{
    ASSERT_EVENT(Event);
 
    /* Reset Signal State */
    Event->Header.SignalState = FALSE;
}

Referenced by __brelse(), _Function_class_(), _Requires_lock_held_(), acpi_bus_receive_event(), add_calc_job_comp(), add_calc_job_decomp(), AfdEnumEvents(), CdWaitSync(), ChewCreate(), chunk_lock_range(), MxEvent::Clear(), do_calc_job(), DpcRoutine(), DriverIoControl(), EngClearEvent(), ExSwapinWorkerThreads(), Ext2bhReaperThread(), Ext2FcbReaperThread(), Ext2McbReaperThread(), Ext2ReadWriteBlocks(), ExUnregisterCallback(), FatWaitSync(), FinishThread(), FreeBT_IoIncrement(), IdlePong(), InitController(), IoCancelFileOpen(), IopCloseFile(), IopDeleteFile(), IopDeviceFsIoControl(), IopGetSetSecurityObject(), IopMountVolume(), IopQueryDeviceInformation(), IopShutdownBaseFileSystems(), IoSetInformation(), IoShutdownSystem(), KbdHid_Create(), KsQueryInformationFile(), KsQueueWorkItem(), KsReadFile(), KsStreamIo(), KsWriteFile(), lock_volume(), MiDecrementAvailablePages(), MiIncrementAvailablePages(), MiInitializePoolEvents(), MiNotifyMemoryEvents(), MmZeroPageThread(), MouHid_Create(), MountMgrUnload(), NdisMAllocateMapRegisters(), NdisResetEvent(), NtClearEvent(), NtFlushBuffersFile(), NtLockFile(), NtNotifyChangeDirectoryFile(), NtQueryDirectoryFile(), NtQueryInformationFile(), NtQueryVolumeInformationFile(), NtReadFile(), NtReplyWaitReceivePortEx(), NtSetInformationFile(), NtSetVolumeInformationFile(), NtUnlockFile(), NtWaitForDebugEvent(), NtWriteFile(), pause_balance(), pause_scrub(), PiQueueDeviceAction(), RawQueryFsSizeInfo(), read_send_buffer(), ReadBytes(), ReadWritePassive(), Recalibrate(), ReceiveDatagram(), ResetChangeFlag(), RWDetermineMediaType(), RWSeekToCylinder(), RxCommonWrite(), RxScavengerTimerRoutine(), RxSpinUpRequestsDispatcher(), SermouseDeviceWorker(), StopMotor(), StreamClassStartDevice(), SubmitIdleRequestIrp(), TestEventFunctional(), TestTcpConnect(), TriggerWork(), USBD_RegisterRootHubCallBack(), USBH_ChangeIndication(), USBH_CheckHubIdle(), USBH_SubmitStatusChangeTransfer(), USBPORT_WorkerThread(), USBSTOR_QueueAddIrp(), VideoPortClearEvent(), wait_for_flush(), WaitForControllerInterrupt(), and xHalIoSetPartitionInformation().

KeInitializeEvent()

VOID NTAPI KeInitializeEvent	(	OUT PKEVENT	Event,
		IN EVENT_TYPE	Type,
		IN BOOLEAN	State
	)

Definition at line 35 of file eventobj.c.

{
    /* Initialize the Dispatcher Header */
    ASSERT((Type == NotificationEvent) || (Type == SynchronizationEvent));
    Event->Header.Type = EventNotificationObject + Type;
    //Event->Header.Signalling = FALSE; // fails in kmtest
    Event->Header.Size = sizeof(KEVENT) / sizeof(ULONG);
    Event->Header.SignalState = State;
    InitializeListHead(&(Event->Header.WaitListHead));
}

KeInitializeEventPair()

VOID NTAPI KeInitializeEventPair

(

IN PKEVENT_PAIR

EventPair

)

Definition at line 53 of file eventobj.c.

{
    /* Initialize the Event Pair Type and Size */
    EventPair->Type = EventPairObject;
    EventPair->Size = sizeof(KEVENT_PAIR);
 
    /* Initialize the two Events */
    KeInitializeEvent(&EventPair->LowEvent, SynchronizationEvent, FALSE);
    KeInitializeEvent(&EventPair->HighEvent, SynchronizationEvent, FALSE);
}

KePulseEvent()

LONG NTAPI KePulseEvent	(	IN PKEVENT	Event,
		IN KPRIORITY	Increment,
		IN BOOLEAN	Wait
	)

Definition at line 69 of file eventobj.c.

{
    KIRQL OldIrql;
    LONG PreviousState;
    PKTHREAD Thread;
    ASSERT_EVENT(Event);
    ASSERT_IRQL_LESS_OR_EQUAL(DISPATCH_LEVEL);
 
    /* Lock the Dispatcher Database */
    OldIrql = KiAcquireDispatcherLock();
 
    /* Save the Old State */
    PreviousState = Event->Header.SignalState;
 
    /* Check if we are non-signaled and we have stuff in the Wait Queue */
    if (!PreviousState && !IsListEmpty(&Event->Header.WaitListHead))
    {
        /* Set the Event to Signaled */
        Event->Header.SignalState = 1;
 
        /* Wake the Event */
        KiWaitTest(&Event->Header, Increment);
    }
 
    /* Unsignal it */
    Event->Header.SignalState = 0;
 
    /* Check what wait state was requested */
    if (Wait == FALSE)
    {
        /* Wait not requested, release Dispatcher Database and return */
        KiReleaseDispatcherLock(OldIrql);
    }
    else
    {
        /* Return Locked and with a Wait */
        Thread = KeGetCurrentThread();
        Thread->WaitNext = TRUE;
        Thread->WaitIrql = OldIrql;
    }
 
    /* Return the previous State */
    return PreviousState;
}

Referenced by EngMapEvent(), NtPulseEvent(), START_TEST(), and TestEventFunctional().

KeReadStateEvent()

LONG NTAPI KeReadStateEvent

(

IN PKEVENT

Event

)

Definition at line 121 of file eventobj.c.

{
    ASSERT_EVENT(Event);
 
    /* Return the Signal State */
    return Event->Header.SignalState;
}

Referenced by EngReadStateEvent(), IopAbortInterruptedIrp(), lock_volume(), MiNotifyMemoryEvents(), NtQueryEvent(), QueueThread(), MxEvent::ReadState(), RequestEvtCleanup(), TdiCall(), TdiSendThread(), TestCreateEvent(), and VideoPortReadStateEvent().

KeResetEvent()

LONG NTAPI KeResetEvent

(

IN PKEVENT

Event

)

Definition at line 134 of file eventobj.c.

{
    KIRQL OldIrql;
    LONG PreviousState;
    ASSERT_EVENT(Event);
    ASSERT_IRQL_LESS_OR_EQUAL(DISPATCH_LEVEL);
 
    /* Lock the Dispatcher Database */
    OldIrql = KiAcquireDispatcherLock();
 
    /* Save the Previous State */
    PreviousState = Event->Header.SignalState;
 
    /* Set it to zero */
    Event->Header.SignalState = 0;
 
    /* Release Dispatcher Database and return previous state */
    KiReleaseDispatcherLock(OldIrql);
    return PreviousState;
}

Referenced by MmRebalanceMemoryConsumersAndWait(), NtResetEvent(), and TestEventFunctional().

KeSetEvent()

LONG NTAPI KeSetEvent	(	IN PKEVENT	Event,
		IN KPRIORITY	Increment,
		IN BOOLEAN	Wait
	)

Definition at line 160 of file eventobj.c.

{
    KIRQL OldIrql;
    LONG PreviousState;
    PKTHREAD Thread;
    ASSERT_EVENT(Event);
    ASSERT_IRQL_LESS_OR_EQUAL(DISPATCH_LEVEL);
 
    /*
     * Check if this is an signaled notification event without an upcoming wait.
     * In this case, we can immediately return TRUE, without locking.
     */
    if ((Event->Header.Type == EventNotificationObject) &&
        (Event->Header.SignalState == 1) &&
        !(Wait))
    {
        /* Return the signal state (TRUE/Signalled) */
        return TRUE;
    }
 
    /* Lock the Dispathcer Database */
    OldIrql = KiAcquireDispatcherLock();
 
    /* Save the Previous State */
    PreviousState = Event->Header.SignalState;
 
    /* Set the Event to Signaled */
    Event->Header.SignalState = 1;
 
    /* Check if the event just became signaled now, and it has waiters */
    if (!(PreviousState) && !(IsListEmpty(&Event->Header.WaitListHead)))
    {
        /* Check the type of event */
        if (Event->Header.Type == EventNotificationObject)
        {
            /* Unwait the thread */
            KxUnwaitThread(&Event->Header, Increment);
        }
        else
        {
            /* Otherwise unwait the thread and unsignal the event */
            KxUnwaitThreadForEvent(Event, Increment);
        }
    }
 
    /* Check what wait state was requested */
    if (!Wait)
    {
        /* Wait not requested, release Dispatcher Database and return */
        KiReleaseDispatcherLock(OldIrql);
    }
    else
    {
        /* Return Locked and with a Wait */
        Thread = KeGetCurrentThread();
        Thread->WaitNext = TRUE;
        Thread->WaitIrql = OldIrql;
    }
 
    /* Return the previous State */
    return PreviousState;
}

KeSetEventBoostPriority()

VOID NTAPI KeSetEventBoostPriority	(	IN PKEVENT	Event,
		IN PKTHREAD *WaitingThread	OPTIONAL
	)

Definition at line 230 of file eventobj.c.

{
    KIRQL OldIrql;
    PKWAIT_BLOCK WaitBlock;
    PKTHREAD Thread = KeGetCurrentThread(), WaitThread;
    ASSERT(Event->Header.Type == EventSynchronizationObject);
    ASSERT_IRQL_LESS_OR_EQUAL(DISPATCH_LEVEL);
 
    /* Acquire Dispatcher Database Lock */
    OldIrql = KiAcquireDispatcherLock();
 
    /* Check if the list is empty */
    if (IsListEmpty(&Event->Header.WaitListHead))
    {
        /* Set the Event to Signaled */
        Event->Header.SignalState = 1;
 
        /* Return */
        KiReleaseDispatcherLock(OldIrql);
        return;
    }
 
    /* Get the Wait Block */
    WaitBlock = CONTAINING_RECORD(Event->Header.WaitListHead.Flink,
                                  KWAIT_BLOCK,
                                  WaitListEntry);
 
    /* Check if this is a WaitAll */
    if (WaitBlock->WaitType == WaitAll)
    {
        /* Set the Event to Signaled */
        Event->Header.SignalState = 1;
 
        /* Unwait the thread and unsignal the event */
        KxUnwaitThreadForEvent(Event, EVENT_INCREMENT);
    }
    else
    {
        /* Return waiting thread to caller */
        WaitThread = WaitBlock->Thread;
        if (WaitingThread) *WaitingThread = WaitThread;
 
        /* Calculate new priority */
        Thread->Priority = KiComputeNewPriority(Thread, 0);
 
        /* Unlink the waiting thread */
        KiUnlinkThread(WaitThread, STATUS_SUCCESS);
 
        /* Request priority boosting */
        WaitThread->AdjustIncrement = Thread->Priority;
        WaitThread->AdjustReason = AdjustBoost;
 
        /* Ready the thread */
        KiReadyThread(WaitThread);
    }
 
    /* Release the Dispatcher Database Lock */
    KiReleaseDispatcherLock(OldIrql);
}

Referenced by _ExReleaseFastMutex(), _ExReleaseFastMutexUnsafe(), ExfUnblockPushLock(), ExReleaseResourceForThreadLite(), and NtSetEventBoostPriority().