- Invert CONFIG_SMP defines as requested by Hartmut
[reactos.git] / reactos / ntoskrnl / ke / queue.c
index 6a1c654..8883a35 100644 (file)
@@ -1,11 +1,12 @@
-/* $Id$
- *
+/*
  * COPYRIGHT:       See COPYING in the top level directory
  * PROJECT:         ReactOS kernel
  * FILE:            ntoskrnl/ke/queue.c
  * PURPOSE:         Implements kernel queues
- * 
- * PROGRAMMERS:     Eric Kohl (ekohl@rz-online.de)
+ *
+ * PROGRAMMERS:     Alex Ionescu (alex@relsoft.net)
+ *                  Gunnar Dalsnes
+ *                  Eric Kohl (ekohl@rz-online.de)
  */
 
 /* INCLUDES *****************************************************************/
 /* FUNCTIONS *****************************************************************/
 
 LONG STDCALL KiInsertQueue(IN PKQUEUE Queue, IN PLIST_ENTRY Entry, BOOLEAN Head);
-              
+
 /*
  * @implemented
  */
-VOID 
+VOID
 STDCALL
 KeInitializeQueue(IN PKQUEUE Queue,
                   IN ULONG Count OPTIONAL)
 {
     DPRINT("KeInitializeQueue %x\n", Queue);
-    
+
     /* Initialize the Header */
     KeInitializeDispatcherHeader(&Queue->Header,
                                  QueueObject,
                                  sizeof(KQUEUE)/sizeof(ULONG),
                                  0);
-    
+
     /* Initialize the Lists */
     InitializeListHead(&Queue->EntryListHead);
     InitializeListHead(&Queue->ThreadListHead);
-    
+
     /* Set the Current and Maximum Count */
     Queue->CurrentCount = 0;
     Queue->MaximumCount = (Count == 0) ? (ULONG) KeNumberProcessors : Count;
@@ -53,18 +54,18 @@ KeInsertHeadQueue(IN PKQUEUE Queue,
 {
     LONG PreviousState;
     KIRQL OldIrql;
-    
+
     DPRINT("KeInsertHeadQueue %x\n", Queue);
-    
+
     /* Lock the Dispatcher Database */
     OldIrql = KeAcquireDispatcherDatabaseLock();
-    
+
     /* Insert the Queue */
     PreviousState = KiInsertQueue(Queue, Entry, TRUE);
-    
+
     /* Release the Dispatcher Lock */
     KeReleaseDispatcherDatabaseLock(OldIrql);
-   
+
     /* Return previous State */
     return PreviousState;
 }
@@ -78,18 +79,18 @@ KeInsertQueue(IN PKQUEUE Queue,
 {
     LONG PreviousState;
     KIRQL OldIrql;
-    
+
     DPRINT("KeInsertQueue %x\n", Queue);
-    
+
     /* Lock the Dispatcher Database */
     OldIrql = KeAcquireDispatcherDatabaseLock();
-    
+
     /* Insert the Queue */
     PreviousState = KiInsertQueue(Queue, Entry, FALSE);
-    
+
     /* Release the Dispatcher Lock */
     KeReleaseDispatcherDatabaseLock(OldIrql);
-   
+
     /* Return previous State */
     return PreviousState;
 }
@@ -110,31 +111,29 @@ KeReadStateQueue(IN PKQUEUE Queue)
 /*
  * @implemented
  */
-PLIST_ENTRY 
+PLIST_ENTRY
 STDCALL
 KeRemoveQueue(IN PKQUEUE Queue,
               IN KPROCESSOR_MODE WaitMode,
               IN PLARGE_INTEGER Timeout OPTIONAL)
 {
-   
-    PLIST_ENTRY ListEntry;
+    PLIST_ENTRY QueueEntry;
     NTSTATUS Status;
     PKTHREAD Thread = KeGetCurrentThread();
     KIRQL OldIrql;
     PKQUEUE PreviousQueue;
     PKWAIT_BLOCK WaitBlock;
-    PKWAIT_BLOCK TimerWaitBlock;
     PKTIMER Timer;
-
     DPRINT("KeRemoveQueue %x\n", Queue);
-    
+
     /* Check if the Lock is already held */
-    if (Thread->WaitNext) {
-    
+    if (Thread->WaitNext)
+    {
         DPRINT("Lock is already held\n");
-    
-    } else {
-        
+        Thread->WaitNext = FALSE;
+    }
+    else
+    {
         /* Lock the Dispatcher Database */
         DPRINT("Lock not held, acquiring\n");
         OldIrql = KeAcquireDispatcherDatabaseLock();
@@ -145,189 +144,203 @@ KeRemoveQueue(IN PKQUEUE Queue,
     PreviousQueue = Thread->Queue;
     Thread->Queue = Queue;
 
-    /* Check if this is a different queue */    
-    if (Queue != PreviousQueue) {
-        
-        /*
-         * INVESTIGATE: What is the Thread->QueueListEntry used for? It's linked it into the
-         * Queue->ThreadListHead when the thread registers with the queue and unlinked when
-         * the thread registers with a new queue. The Thread->Queue already tells us what
-         * queue the thread is registered with.
-         * -Gunnar
-         */
+    /* Check if this is a different queue */
+    if (Queue != PreviousQueue)
+    {
         DPRINT("Different Queue\n");
-        if (PreviousQueue)  {
-          
+        QueueEntry = &Thread->QueueListEntry;
+        if (PreviousQueue)
+        {
             /* Remove from this list */
             DPRINT("Removing Old Queue\n");
-            RemoveEntryList(&Thread->QueueListEntry);
-            
+            RemoveEntryList(QueueEntry);
+
             /* Wake the queue */
             DPRINT("Activating new thread\n");
             KiWakeQueue(PreviousQueue);
-      }
+        }
 
         /* Insert in this new Queue */
         DPRINT("Inserting new Queue!\n");
-        InsertTailList(&Queue->ThreadListHead, &Thread->QueueListEntry);
-   
-    } else {
-      
+        InsertTailList(&Queue->ThreadListHead, QueueEntry);
+    }
+    else
+    {
         /* Same queue, decrement waiting threads */
         DPRINT("Same Queue!\n");
         Queue->CurrentCount--;
     }
-    
+
     /* Loop until the queue is processed */
-    while (TRUE) {
-      
-        /* Get the Entry */
-        ListEntry = Queue->EntryListHead.Flink;
-        
+    while (TRUE)
+    {
         /* Check if the counts are valid and if there is still a queued entry */
-        if ((Queue->CurrentCount < Queue->MaximumCount) && 
-             (ListEntry != &Queue->EntryListHead)) {
-          
+        QueueEntry = Queue->EntryListHead.Flink;
+        if ((Queue->CurrentCount < Queue->MaximumCount) &&
+            (QueueEntry != &Queue->EntryListHead))
+        {
             /* Remove the Entry and Save it */
-            DPRINT("Removing Queue Entry. CurrentCount: %d, Maximum Count: %d\n", 
+            DPRINT("Removing Queue Entry. CurrentCount: %d, Maximum Count: %d\n",
                     Queue->CurrentCount, Queue->MaximumCount);
-            ListEntry = RemoveHeadList(&Queue->EntryListHead);
-            
+
             /* Decrease the number of entries */
             Queue->Header.SignalState--;
-            
+
             /* Increase numbef of running threads */
             Queue->CurrentCount++;
-            
+
             /* Check if the entry is valid. If not, bugcheck */
-            if (!ListEntry->Flink || !ListEntry->Blink) {
-            
+            if (!(QueueEntry->Flink) || !(QueueEntry->Blink))
+            {
                 KEBUGCHECK(INVALID_WORK_QUEUE_ITEM);
             }
-            
+
             /* Remove the Entry */
-            RemoveEntryList(ListEntry);
-            ListEntry->Flink = NULL;
-            
+            RemoveEntryList(QueueEntry);
+            QueueEntry->Flink = NULL;
+
             /* Nothing to wait on */
             break;
-            
-        } else {
-                       
+        }
+        else
+        {
             /* Do the wait */
-            DPRINT("Waiting on Queue Entry. CurrentCount: %d, Maximum Count: %d\n", 
+            DPRINT("Waiting on Queue Entry. CurrentCount: %d, Maximum Count: %d\n",
                     Queue->CurrentCount, Queue->MaximumCount);
-            
+
             /* Use the Thread's Wait Block, it's big enough */
             Thread->WaitBlockList = &Thread->WaitBlock[0];
-            
-            /* Fail if there's an APC Pending */
-            if (WaitMode == UserMode && Thread->ApcState.UserApcPending) {
-            
+
+            /* Check if a kernel APC is pending and we were below APC_LEVEL */
+            if ((Thread->ApcState.KernelApcPending) &&
+                (Thread->WaitIrql < APC_LEVEL))
+            {
+                /* Increment the count and unlock the dispatcher */
+                Queue->CurrentCount++;
+                KeReleaseDispatcherDatabaseLock(Thread->WaitIrql);
+                goto SkipWait;
+            }
+
+            /* Fail if there's a User APC Pending */
+            if ((WaitMode != KernelMode) && (Thread->ApcState.UserApcPending))
+            {
                 /* Return the status and increase the pending threads */
-                ListEntry = (PLIST_ENTRY)STATUS_USER_APC;
+                QueueEntry = (PLIST_ENTRY)STATUS_USER_APC;
                 Queue->CurrentCount++;
-                
+
                 /* Nothing to wait on */
                 break;
             }
-            
+
             /* Build the Wait Block */
             WaitBlock = &Thread->WaitBlock[0];
             WaitBlock->Object = (PVOID)Queue;
             WaitBlock->WaitKey = STATUS_SUCCESS;
             WaitBlock->WaitType = WaitAny;
             WaitBlock->Thread = Thread;
-            WaitBlock->NextWaitBlock = NULL;
-            
-            Thread->WaitStatus = STATUS_SUCCESS;
-            
+            Thread->WaitStatus = STATUS_WAIT_0;
+
             /* We need to wait for the object... check if we have a timeout */
-            if (Timeout) {
-        
+            if (Timeout)
+            {
                 /* If it's zero, then don't do any waiting */
-                if (!Timeout->QuadPart) {
-            
+                if (!Timeout->QuadPart)
+                {
                     /* Instant Timeout, return the status and increase the pending threads */
                     DPRINT("Queue Wait has timed out\n");
-                    ListEntry = (PLIST_ENTRY)STATUS_TIMEOUT;
+                    QueueEntry = (PLIST_ENTRY)STATUS_TIMEOUT;
                     Queue->CurrentCount++;
-                    
+
                     /* Nothing to wait on */
                     break;
                 }
-                
-                /* 
+
+                /*
                  * Set up the Timer. We'll use the internal function so that we can
                  * hold on to the dispatcher lock.
                  */
                 Timer = &Thread->Timer;
-                TimerWaitBlock = &Thread->WaitBlock[1];
+                WaitBlock->NextWaitBlock = &Thread->WaitBlock[1];
+                WaitBlock = &Thread->WaitBlock[1];
 
                 /* Set up the Timer Wait Block */
-                TimerWaitBlock->Object = (PVOID)Timer;
-                TimerWaitBlock->Thread = Thread;
-                TimerWaitBlock->WaitKey = STATUS_TIMEOUT;
-                TimerWaitBlock->WaitType = WaitAny;
-                TimerWaitBlock->NextWaitBlock = NULL;
-            
+                WaitBlock->Object = (PVOID)Timer;
+                WaitBlock->Thread = Thread;
+                WaitBlock->WaitKey = STATUS_TIMEOUT;
+                WaitBlock->WaitType = WaitAny;
+
                 /* Link the timer to this Wait Block */
                 InitializeListHead(&Timer->Header.WaitListHead);
-                InsertTailList(&Timer->Header.WaitListHead, &TimerWaitBlock->WaitListEntry);
-            
+                InsertTailList(&Timer->Header.WaitListHead, &WaitBlock->WaitListEntry);
+
                 /* Create Timer */
                 DPRINT("Creating Timer with timeout %I64d\n", *Timeout);
                 KiInsertTimer(Timer, *Timeout);
             }
-                            
+
+            /* Close the loop */
+            WaitBlock->NextWaitBlock = &Thread->WaitBlock[0];
+
             /* Insert the wait block into the Queues's wait list */
-            WaitBlock = Thread->WaitBlockList;
-            InsertTailList(&Queue->Header.WaitListHead, &WaitBlock->WaitListEntry);
-            
-            /* Block the Thread */
-            DPRINT("Blocking the Thread: %x %x!\n", KeGetCurrentThread(), Thread);
-            PsBlockThread(&Status, 
-                          FALSE, 
-                          WaitMode,
-                          WrQueue);
-    
+            WaitBlock = &Thread->WaitBlock[0];
+            InsertTailList(&Queue->Header.WaitListHead,
+                           &WaitBlock->WaitListEntry);
+
+            /* Setup the wait information */
+            Thread->WaitMode = WaitMode;
+            Thread->WaitReason = WrQueue;
+            Thread->Alertable = FALSE;
+            Thread->WaitTime = 0;
+            Thread->State = Waiting;
+
+            /* Find a new thread to run */
+            DPRINT("Swapping threads\n");
+            Status = KiSwapThread();
+
             /* Reset the wait reason */
             Thread->WaitReason = 0;
-            
+
             /* Check if we were executing an APC */
-            if (Status != STATUS_KERNEL_APC) {
-             
+            if (Status != STATUS_KERNEL_APC)
+            {
                 /* Done Waiting  */
                 DPRINT("Done waking queue. Thread: %x %x!\n", KeGetCurrentThread(), Thread);
                 return (PLIST_ENTRY)Status;
             }
-        
+
+            /* Check if we had a timeout */
+            if (Timeout)
+            {
+                /* FIXME: Fixup interval */
+            }
+
             /* Acquire again the lock */
+SkipWait:
             DPRINT("Looping again\n");
             OldIrql = KeAcquireDispatcherDatabaseLock();
-            
+
             /* Save the new IRQL and decrease number of waiting threads */
             Thread->WaitIrql = OldIrql;
             Queue->CurrentCount--;
         }
     }
-    
+
     /* Unlock Database and return */
     KeReleaseDispatcherDatabaseLock(Thread->WaitIrql);
-    DPRINT("Returning. CurrentCount: %d, Maximum Count: %d\n", 
+    DPRINT("Returning. CurrentCount: %d, Maximum Count: %d\n",
             Queue->CurrentCount, Queue->MaximumCount);
-    return ListEntry;
+    return QueueEntry;
 }
 
 /*
  * @implemented
  */
-PLIST_ENTRY 
+PLIST_ENTRY
 STDCALL
 KeRundownQueue(IN PKQUEUE Queue)
 {
     PLIST_ENTRY EnumEntry;
-    PLIST_ENTRY FirstEntry;
+    PLIST_ENTRY FirstEntry = NULL;
     PKTHREAD Thread;
     KIRQL OldIrql;
 
@@ -336,30 +349,22 @@ KeRundownQueue(IN PKQUEUE Queue)
     /* Get the Dispatcher Lock */
     OldIrql = KeAcquireDispatcherDatabaseLock();
 
-    /* Get the First Empty Entry */
-    FirstEntry = Queue->EntryListHead.Flink;
-            
     /* Make sure the list is not empty */
-    if (FirstEntry == &Queue->EntryListHead) {
-    
-        /* It is, so don't return anything */
-        EnumEntry = NULL;
-   
-    } else {
-       
+    if (!IsListEmpty(&Queue->EntryListHead))
+    {
         /* Remove it */
-        RemoveEntryList(&Queue->EntryListHead);
+        FirstEntry = RemoveHeadList(&Queue->EntryListHead);
     }
-    
+
     /* Unlink threads and clear their Thread->Queue */
-    while (!IsListEmpty(&Queue->ThreadListHead)) {
-        
+    while (!IsListEmpty(&Queue->ThreadListHead))
+    {
         /* Get the Entry and Remove it */
         EnumEntry = RemoveHeadList(&Queue->ThreadListHead);
-        
+
         /* Get the Entry's Thread */
         Thread = CONTAINING_RECORD(EnumEntry, KTHREAD, QueueListEntry);
-        
+
         /* Kill its Queue */
         Thread->Queue = NULL;
     }
@@ -379,45 +384,49 @@ KiWakeQueue(IN PKQUEUE Queue)
     PLIST_ENTRY QueueEntry;
     PLIST_ENTRY WaitEntry;
     PKWAIT_BLOCK WaitBlock;
-    
+    PKTHREAD Thread;
+
     /* Decrement the number of active threads */
     DPRINT("KiWakeQueue: %x. Thread: %x\n", Queue, KeGetCurrentThread());
     Queue->CurrentCount--;
-    
+
     /* Make sure the counts are OK */
-    if (Queue->CurrentCount < Queue->MaximumCount) {
-    
+    if (Queue->CurrentCount < Queue->MaximumCount)
+    {
         /* Get the Queue Entry */
         QueueEntry = Queue->EntryListHead.Flink;
-        
+
         /* Get the Wait Entry */
         WaitEntry = Queue->Header.WaitListHead.Blink;
-        DPRINT("Queue Count is ok, Queue entries: %x, %x\n", QueueEntry, WaitEntry);
-        
-        /* Make sure that the Queue List isn't empty and that this entry is valid */
-        if (!IsListEmpty(&Queue->Header.WaitListHead) && 
-            (QueueEntry != &Queue->EntryListHead)) {
-            
+        DPRINT("Queue Count is ok; entries: %p, %p\n", QueueEntry, WaitEntry);
+
+        /* Make sure that the Queue entries are not part of empty lists */
+        if ((WaitEntry != &Queue->Header.WaitListHead) &&
+            (QueueEntry != &Queue->EntryListHead))
+        {
             /* Remove this entry */
             DPRINT("Queue in List, removing it\n");
             RemoveEntryList(QueueEntry);
             QueueEntry->Flink = NULL;
-            
+
             /* Decrease the Signal State */
             Queue->Header.SignalState--;
-            
+
             /* Unwait the Thread */
-            DPRINT("Unwaiting Thread\n");
-            WaitBlock = CONTAINING_RECORD(WaitEntry, KWAIT_BLOCK, WaitListEntry);
-            KiAbortWaitThread(WaitBlock->Thread, (NTSTATUS)QueueEntry);
+            WaitBlock = CONTAINING_RECORD(WaitEntry,
+                                          KWAIT_BLOCK,
+                                          WaitListEntry);
+            Thread = WaitBlock->Thread;
+            DPRINT1("Unwaiting Thread: %d\n", Thread->State);
+            KiAbortWaitThread(Thread, (NTSTATUS)QueueEntry, IO_NO_INCREMENT);
         }
-    }    
+    }
 }
 
 /*
  * Returns the previous number of entries in the queue
  */
-LONG 
+LONG
 STDCALL
 KiInsertQueue(IN PKQUEUE Queue,
               IN PLIST_ENTRY Entry,
@@ -427,65 +436,71 @@ KiInsertQueue(IN PKQUEUE Queue,
     PKTHREAD Thread = KeGetCurrentThread();
     PKWAIT_BLOCK WaitBlock;
     PLIST_ENTRY WaitEntry;
-  
     DPRINT("KiInsertQueue(Queue %x, Entry %x)\n", Queue, Entry);
-   
+
     /* Save the old state */
     InitialState = Queue->Header.SignalState;
-     
+
     /* Get the Entry */
     WaitEntry = Queue->Header.WaitListHead.Blink;
     DPRINT("Initial State, WaitEntry: %d, %x\n", InitialState, WaitEntry);
-    
+
     /*
      * Why the KeGetCurrentThread()->Queue != Queue?
-     * KiInsertQueue might be called from an APC for the current thread. 
+     * KiInsertQueue might be called from an APC for the current thread.
      * -Gunnar
      */
-    if ((Queue->CurrentCount < Queue->MaximumCount) && 
+    if ((Queue->CurrentCount < Queue->MaximumCount) &&
         (WaitEntry != &Queue->Header.WaitListHead) &&
-        ((Thread->Queue != Queue) || (Thread->WaitReason != WrQueue))) {
-       
+        ((Thread->Queue != Queue) || (Thread->WaitReason != WrQueue)))
+    {
         /* Remove the wait entry */
         DPRINT("Removing Entry\n");
         RemoveEntryList(WaitEntry);
-        
+
         /* Get the Wait Block and Thread */
         WaitBlock = CONTAINING_RECORD(WaitEntry, KWAIT_BLOCK, WaitListEntry);
         DPRINT("Got wait block: %x\n", WaitBlock);
         Thread = WaitBlock->Thread;
-        
+
         /* Reset the wait reason */
         Thread->WaitReason = 0;
-        
-        /* Increase the waiting threads */
+
+        /* Increase the active threads and set the status*/
         Queue->CurrentCount++;
-        
+        Thread->WaitStatus = (NTSTATUS)Entry;
+
+        /* Remove the thread from its wait list */
+        RemoveEntryList(&Thread->WaitListEntry);
+
         /* Check if there's a Thread Timer */
-        if (Thread->Timer.Header.Inserted) {
-    
+        if (Thread->Timer.Header.Inserted)
+        {
             /* Cancel the Thread Timer with the no-lock fastpath */
             DPRINT("Removing the Thread's Timer\n");
             Thread->Timer.Header.Inserted = FALSE;
             RemoveEntryList(&Thread->Timer.TimerListEntry);
         }
-        
+
         /* Reschedule the Thread */
         DPRINT("Unblocking the Thread\n");
-        PsUnblockThread((PETHREAD)Thread, (PNTSTATUS)&Entry, 0);
-    
-    } else {
-    
+        KiUnblockThread(Thread, (PNTSTATUS)&Entry, 0);
+    }
+    else
+    {
         /* Increase the Entries */
         DPRINT("Adding new Queue Entry: %d %d\n", Head, Queue->Header.SignalState);
         Queue->Header.SignalState++;
-        
-        if (Head) {
-        
+
+        /* Check which mode we're using */
+        if (Head)
+        {
+            /* Insert in the head */
             InsertHeadList(&Queue->EntryListHead, Entry);
-        
-        } else {
-        
+        }
+        else
+        {
+            /* Insert at the end */
             InsertTailList(&Queue->EntryListHead, Entry);
         }
     }