Used HasTerminated as bitmap for flags to make difference between calling PsTerminate...
[reactos.git] / reactos / ntoskrnl / ps / kill.c
index 8ae130a..1837f09 100644 (file)
-/*
+/* $Id$
+ *
  * COPYRIGHT:       See COPYING in the top level directory
  * PROJECT:         ReactOS kernel
  * FILE:            ntoskrnl/ps/kill.c
  * PURPOSE:         Terminating a thread
- * PROGRAMMER:      David Welch (welch@cwcom.net)
- * UPDATE HISTORY:
- *                  Created 22/05/98
+ * 
+ * PROGRAMMERS:     David Welch (welch@cwcom.net)
  */
 
 /* INCLUDES *****************************************************************/
 
-#include <ddk/ntddk.h>
-#include <internal/ps.h>
-#include <internal/ke.h>
-#include <internal/mm.h>
-#include <internal/ob.h>
-
+#include <ntoskrnl.h>
 #define NDEBUG
 #include <internal/debug.h>
 
 /* GLOBALS *******************************************************************/
 
-extern ULONG PiNrThreads;
-extern ULONG PiNrRunnableThreads;
-extern KSPIN_LOCK PiThreadListLock;
+VOID PsTerminateCurrentThread(NTSTATUS ExitStatus);
+NTSTATUS STDCALL NtCallTerminatePorts(PETHREAD Thread);
+
+#define TAG_TERMINATE_APC   TAG('T', 'A', 'P', 'C')
+
+LIST_ENTRY ThreadsToReapHead;
+
+#define TERMINATE_PROC 0x1
+#define TERMINATE_APC  0x2
 
 /* FUNCTIONS *****************************************************************/
 
-VOID PsTerminateCurrentThread(NTSTATUS ExitStatus)
+VOID
+PsInitializeThreadReaper(VOID)
+{
+  InitializeListHead(&ThreadsToReapHead);
+}
+
+VOID
+PsReapThreads(VOID)
+{
+  KIRQL oldlvl;
+  PETHREAD Thread;
+  PLIST_ENTRY ListEntry;
+
+  oldlvl = KeAcquireDispatcherDatabaseLock();
+  while((ListEntry = RemoveHeadList(&ThreadsToReapHead)) != &ThreadsToReapHead)
+  {
+    PiNrThreadsAwaitingReaping--;
+    KeReleaseDispatcherDatabaseLock(oldlvl);
+    Thread = CONTAINING_RECORD(ListEntry, ETHREAD, TerminationPortList);
+
+    ObDereferenceObject(Thread);
+    oldlvl = KeAcquireDispatcherDatabaseLock();
+  }
+  KeReleaseDispatcherDatabaseLock(oldlvl);
+}
+
+VOID
+PsQueueThreadReap(PETHREAD Thread)
+{
+  InsertTailList(&ThreadsToReapHead, &Thread->TerminationPortList);
+  PiNrThreadsAwaitingReaping++;
+}
+
+VOID
+PiTerminateProcessThreads(PEPROCESS Process,
+                         NTSTATUS ExitStatus)
+{
+   KIRQL oldlvl;
+   PLIST_ENTRY current_entry;
+   PETHREAD current, CurrentThread = PsGetCurrentThread();
+   
+   DPRINT("PiTerminateProcessThreads(Process %x, ExitStatus %x)\n",
+         Process, ExitStatus);
+         
+   oldlvl = KeAcquireDispatcherDatabaseLock();
+   
+   current_entry = Process->ThreadListHead.Flink;
+   while (current_entry != &Process->ThreadListHead)
+     {
+       current = CONTAINING_RECORD(current_entry, ETHREAD,
+                                   ThreadListEntry);
+       if (current != CurrentThread && current->HasTerminated == 0)
+         {
+            DPRINT("Terminating %x, current thread: %x, "
+                   "thread's process: %x\n", current, PsGetCurrentThread(), 
+                   current->ThreadsProcess);
+             KeReleaseDispatcherDatabaseLock(oldlvl);
+            PsTerminateOtherThread(current, ExitStatus);
+             oldlvl = KeAcquireDispatcherDatabaseLock();
+            current_entry = Process->ThreadListHead.Flink;
+         }
+       else
+         {
+            current_entry = current_entry->Flink;
+         }
+     }
+   KeReleaseDispatcherDatabaseLock(oldlvl);
+   DPRINT("Finished PiTerminateProcessThreads()\n");
+}
+
+VOID
+PsTerminateCurrentThread(NTSTATUS ExitStatus)
 /*
  * FUNCTION: Terminates the current thread
  */
 {
    KIRQL oldIrql;
    PETHREAD CurrentThread;
-   
-   
+   PLIST_ENTRY current_entry;
+   PKMUTANT Mutant;
+   BOOLEAN Last;
+   PEPROCESS CurrentProcess;
+   SIZE_T Length = PAGE_SIZE;
+   PVOID TebBlock;
+
+   DPRINT("PsTerminateCurrentThread(ExitStatus %x)\n", ExitStatus);
+
    CurrentThread = PsGetCurrentThread();
-   
+
+   oldIrql = KeAcquireDispatcherDatabaseLock();
+   if (CurrentThread->HasTerminated & TERMINATE_PROC)
+   {
+      KeReleaseDispatcherDatabaseLock(oldIrql);
+      return;
+   }
+   CurrentThread->HasTerminated |= TERMINATE_PROC;
+   KeReleaseDispatcherDatabaseLock(oldIrql);
+
+   KeLowerIrql(PASSIVE_LEVEL);
+
+   CurrentProcess = CurrentThread->ThreadsProcess;
+
+   /* Can't terminate a thread if it attached another process */
+   if (AttachedApcEnvironment == CurrentThread->Tcb.ApcStateIndex)
+     {
+        KEBUGCHECKEX(INVALID_PROCESS_ATTACH_ATTEMPT, (ULONG) CurrentProcess,
+                     (ULONG) CurrentThread->Tcb.ApcState.Process,
+                     (ULONG) CurrentThread->Tcb.ApcStateIndex,
+                     (ULONG) CurrentThread);
+     }
+
+   KeCancelTimer(&CurrentThread->Tcb.Timer);
+
+   oldIrql = KeAcquireDispatcherDatabaseLock();
+
    DPRINT("terminating %x\n",CurrentThread);
-   KeAcquireSpinLock(&PiThreadListLock, &oldIrql);
-   
+
    CurrentThread->ExitStatus = ExitStatus;
-   
-   DPRINT("ObGetReferenceCount(CurrentThread) %d\n",
-         ObGetReferenceCount(CurrentThread));
-   DPRINT("ObGetHandleCount(CurrentThread) %x\n",
-         ObGetHandleCount(CurrentThread));
-   
+   KeQuerySystemTime((PLARGE_INTEGER)&CurrentThread->ExitTime);
+
+   /* If the ProcessoR Control Block's NpxThread points to the current thread
+    * unset it.
+    */
+   InterlockedCompareExchangePointer(&KeGetCurrentKPCR()->PrcbData.NpxThread,
+                                     NULL, ETHREAD_TO_KTHREAD(CurrentThread));
+
+   KeReleaseDispatcherDatabaseLock(oldIrql);
+   PsLockProcess(CurrentProcess, FALSE);
+
+   /* Remove the thread from the thread list of its process */
+   RemoveEntryList(&CurrentThread->ThreadListEntry);
+   Last = IsListEmpty(&CurrentProcess->ThreadListHead);
+   PsUnlockProcess(CurrentProcess);
+
+   /* Notify subsystems of the thread termination */
+   PspRunCreateThreadNotifyRoutines(CurrentThread, FALSE);
+   PsTerminateWin32Thread(CurrentThread);
+
+   /* Free the TEB */
+   if(CurrentThread->Tcb.Teb)
+   {
+     DPRINT("Decommit teb at %p\n", CurrentThread->Tcb.Teb);
+     ExAcquireFastMutex(&CurrentProcess->TebLock);
+     TebBlock = MM_ROUND_DOWN(CurrentThread->Tcb.Teb, MM_VIRTMEM_GRANULARITY);
+     ZwFreeVirtualMemory(NtCurrentProcess(),
+                         (PVOID *)&CurrentThread->Tcb.Teb,
+                         &Length,
+                         MEM_DECOMMIT);
+     DPRINT("teb %p, TebBlock %p\n", CurrentThread->Tcb.Teb, TebBlock);
+     if (TebBlock != CurrentProcess->TebBlock ||
+         CurrentProcess->TebBlock == CurrentProcess->TebLastAllocated)
+       {
+         MmLockAddressSpace(&CurrentProcess->AddressSpace);
+         MmReleaseMemoryAreaIfDecommitted(CurrentProcess, &CurrentProcess->AddressSpace, TebBlock);
+         MmUnlockAddressSpace(&CurrentProcess->AddressSpace);
+       }
+     CurrentThread->Tcb.Teb = NULL;
+     ExReleaseFastMutex(&CurrentProcess->TebLock);
+   }
+
+   /* abandon all owned mutants */
+   current_entry = CurrentThread->Tcb.MutantListHead.Flink;
+   while (current_entry != &CurrentThread->Tcb.MutantListHead)
+     {
+       Mutant = CONTAINING_RECORD(current_entry, KMUTANT,
+                                  MutantListEntry);
+       KeReleaseMutant(Mutant,
+                       MUTANT_INCREMENT,
+                       TRUE,
+                       FALSE);
+       current_entry = CurrentThread->Tcb.MutantListHead.Flink;
+     }
+
+   oldIrql = KeAcquireDispatcherDatabaseLock();
    CurrentThread->Tcb.DispatcherHeader.SignalState = TRUE;
-   KeDispatcherObjectWake(&CurrentThread->Tcb.DispatcherHeader);
+   KiDispatcherObjectWake(&CurrentThread->Tcb.DispatcherHeader, IO_NO_INCREMENT);
+   KeReleaseDispatcherDatabaseLock (oldIrql);
+
+   /* The last thread shall close the door on exit */
+   if(Last)
+   {
+    /* save the last thread exit status */
+    CurrentProcess->LastThreadExitStatus = ExitStatus;
+    
+    PspRunCreateProcessNotifyRoutines(CurrentProcess, FALSE);
+    PsTerminateWin32Process(CurrentProcess);
+    PiTerminateProcess(CurrentProcess, ExitStatus);
+   }
+
+   oldIrql = KeAcquireDispatcherDatabaseLock();
+
+#ifdef _ENABLE_THRDEVTPAIR
+   ExpSwapThreadEventPair(CurrentThread, NULL); /* Release the associated eventpair object, if there was one */
+#endif /* _ENABLE_THRDEVTPAIR */
+
+   ASSERT(CurrentThread->Tcb.WaitBlockList == NULL);
    
    PsDispatchThreadNoLock(THREAD_STATE_TERMINATED_1);
-   KeBugCheck(0);
+   DPRINT1("Unexpected return, CurrentThread %x PsGetCurrentThread() %x\n", CurrentThread, PsGetCurrentThread());
+   KEBUGCHECK(0);
+}
+
+VOID STDCALL
+PiTerminateThreadRundownRoutine(PKAPC Apc)
+{
+  ExFreePool(Apc);
 }
 
-VOID PsTerminateOtherThread(PETHREAD Thread, NTSTATUS ExitStatus)
+VOID STDCALL
+PiTerminateThreadKernelRoutine(PKAPC Apc,
+                              PKNORMAL_ROUTINE* NormalRoutine,
+                              PVOID* NormalContext,
+                              PVOID* SystemArgument1,
+                              PVOID* SystemArguemnt2)
+{
+  ExFreePool(Apc);
+}
+
+VOID STDCALL
+PiTerminateThreadNormalRoutine(PVOID NormalContext,
+                            PVOID SystemArgument1,
+                            PVOID SystemArgument2)
+{
+  PsTerminateCurrentThread((NTSTATUS)SystemArgument1);
+}
+
+VOID
+PsTerminateOtherThread(PETHREAD Thread,
+                      NTSTATUS ExitStatus)
 /*
- * FUNCTION: Terminate a thread when calling from that thread's context
+ * FUNCTION: Terminate a thread when calling from another thread's context
+ * NOTES: This function must be called with PiThreadLock held
  */
 {
-   KIRQL oldIrql;
-   
-   KeAcquireSpinLock(&PiThreadListLock, &oldIrql);
-   if (Thread->Tcb.State == THREAD_STATE_RUNNABLE)
-     {
-       PiNrRunnableThreads--;
-       RemoveEntryList(&Thread->Tcb.QueueListEntry);
-     }
-   RemoveEntryList(&Thread->Tcb.ThreadListEntry);
-   Thread->Tcb.State = THREAD_STATE_TERMINATED_2;
-   Thread->Tcb.DispatcherHeader.SignalState = TRUE;
-   KeDispatcherObjectWake(&Thread->Tcb.DispatcherHeader);
-   ObDereferenceObject(Thread);
-   KeReleaseSpinLock(&PiThreadListLock, oldIrql);
+  PKAPC Apc;
+  KIRQL OldIrql;
+
+  DPRINT("PsTerminateOtherThread(Thread %x, ExitStatus %x)\n",
+        Thread, ExitStatus);
+
+  OldIrql = KeAcquireDispatcherDatabaseLock();
+  if (Thread->HasTerminated & TERMINATE_APC)
+  {
+     KeReleaseDispatcherDatabaseLock (OldIrql);
+     return;
+  }
+  Thread->HasTerminated |= TERMINATE_APC;
+  KeReleaseDispatcherDatabaseLock (OldIrql);
+  Apc = ExAllocatePoolWithTag(NonPagedPool, sizeof(KAPC), TAG_TERMINATE_APC);
+  KeInitializeApc(Apc,
+                 &Thread->Tcb,
+                 OriginalApcEnvironment,
+                 PiTerminateThreadKernelRoutine,
+                 PiTerminateThreadRundownRoutine,
+                 PiTerminateThreadNormalRoutine,
+                 KernelMode,
+                 NULL);
+  KeInsertQueueApc(Apc,
+                  (PVOID)ExitStatus,
+                  NULL,
+                  IO_NO_INCREMENT);
+
+  OldIrql = KeAcquireDispatcherDatabaseLock();          
+  if (THREAD_STATE_BLOCKED == Thread->Tcb.State && UserMode == Thread->Tcb.WaitMode)
+    {
+      DPRINT("Unblocking thread\n");
+      KiAbortWaitThread((PKTHREAD)Thread, STATUS_THREAD_IS_TERMINATING);
+    }
+  KeReleaseDispatcherDatabaseLock(OldIrql); 
 }
 
-NTSTATUS STDCALL PiTerminateProcess(PEPROCESS Process,
-                                   NTSTATUS ExitStatus)
+NTSTATUS STDCALL
+PiTerminateProcess(PEPROCESS Process,
+                  NTSTATUS ExitStatus)
 {
-   KIRQL oldlvl;
-   
-   DPRINT("PsTerminateProcess(Process %x, ExitStatus %x)\n",
-          Process, ExitStatus);
+   KIRQL OldIrql;
+   PEPROCESS CurrentProcess;
+
+   DPRINT("PiTerminateProcess(Process %x, ExitStatus %x) PC %d HC %d\n",
+          Process, ExitStatus, ObGetObjectPointerCount(Process),
+          ObGetObjectHandleCount(Process));
    
-   PiTerminateProcessThreads(Process, ExitStatus);
-   KeRaiseIrql(DISPATCH_LEVEL, &oldlvl);
-   Process->Pcb.ProcessState = PROCESS_STATE_TERMINATED;
+   ObReferenceObject(Process);
+   if (InterlockedExchangeUL(&Process->Pcb.State, 
+                            PROCESS_STATE_TERMINATED) == 
+       PROCESS_STATE_TERMINATED)
+     {
+        ObDereferenceObject(Process);
+       return(STATUS_SUCCESS);
+     }
+   CurrentProcess = PsGetCurrentProcess();
+   if (Process != CurrentProcess)
+   {
+      KeAttachProcess(&Process->Pcb);
+   }
+   ObCloseAllHandles(Process);
+   if (Process != CurrentProcess)
+   {
+      KeDetachProcess();
+   }
+   OldIrql = KeAcquireDispatcherDatabaseLock ();
    Process->Pcb.DispatcherHeader.SignalState = TRUE;
-   KeDispatcherObjectWake(&Process->Pcb.DispatcherHeader);
-   KeLowerIrql(oldlvl);
+   KiDispatcherObjectWake(&Process->Pcb.DispatcherHeader, IO_NO_INCREMENT);
+   KeReleaseDispatcherDatabaseLock (OldIrql);
+   ObDereferenceObject(Process);
    return(STATUS_SUCCESS);
 }
 
-NTSTATUS STDCALL NtTerminateProcess(IN HANDLE          ProcessHandle,
-                                   IN  NTSTATUS        ExitStatus)
+NTSTATUS STDCALL
+NtTerminateProcess(IN  HANDLE          ProcessHandle  OPTIONAL,
+                  IN   NTSTATUS        ExitStatus)
 {
    NTSTATUS Status;
    PEPROCESS Process;
    
+   PAGED_CODE();
+   
    DPRINT("NtTerminateProcess(ProcessHandle %x, ExitStatus %x)\n",
-          ProcessHandle, ExitStatus);
+          ProcessHandle, ExitStatus);
    
    Status = ObReferenceObjectByHandle(ProcessHandle,
                                       PROCESS_TERMINATE,
                                       PsProcessType,
-                                     UserMode,
+                                     KeGetCurrentThread()->PreviousMode,
                                       (PVOID*)&Process,
                                      NULL);
-   if (Status != STATUS_SUCCESS)
-   {
-        return(Status);
-   }
-   
-   PiTerminateProcess(Process, ExitStatus);
+   if (!NT_SUCCESS(Status))
+     {
+       return(Status);
+     }
+   Process->ExitStatus = ExitStatus;
+   PiTerminateProcessThreads(Process, ExitStatus);
    if (PsGetCurrentThread()->ThreadsProcess == Process)
-   {
-      ObDereferenceObject(Process);
-      PsTerminateCurrentThread(ExitStatus);
-   }
+     {
+       ObDereferenceObject(Process);
+       PsTerminateCurrentThread(ExitStatus);
+       /*
+        * We should never get here!
+        */
+       return(STATUS_SUCCESS);
+     }
    ObDereferenceObject(Process);
    return(STATUS_SUCCESS);
 }
 
 
-NTSTATUS STDCALL NtTerminateThread(IN  HANDLE          ThreadHandle,
-                                  IN   NTSTATUS        ExitStatus)
+NTSTATUS STDCALL
+NtTerminateThread(IN   HANDLE          ThreadHandle,
+                 IN    NTSTATUS        ExitStatus)
 {
    PETHREAD Thread;
    NTSTATUS Status;
    
+   PAGED_CODE();
+   
    Status = ObReferenceObjectByHandle(ThreadHandle,
                                      THREAD_TERMINATE,
                                      PsThreadType,
-                                     UserMode,
+                                     KeGetCurrentThread()->PreviousMode,
                                      (PVOID*)&Thread,
                                      NULL);
    if (Status != STATUS_SUCCESS)
@@ -141,21 +395,29 @@ NTSTATUS STDCALL NtTerminateThread(IN     HANDLE          ThreadHandle,
        return(Status);
      }
    
-   ObDereferenceObject(Thread);
-   
    if (Thread == PsGetCurrentThread())
      {
-       PsTerminateCurrentThread(ExitStatus);
+        /* dereference the thread object before we kill our thread */
+        ObDereferenceObject(Thread);
+        PsTerminateCurrentThread(ExitStatus);
+        /*
+         * We should never get here!
+         */
      }
    else
      {
        PsTerminateOtherThread(Thread, ExitStatus);
+       ObDereferenceObject(Thread);
      }
    return(STATUS_SUCCESS);
 }
 
 
-NTSTATUS PsTerminateSystemThread(NTSTATUS ExitStatus)
+/*
+ * @implemented
+ */
+NTSTATUS STDCALL
+PsTerminateSystemThread(NTSTATUS ExitStatus)
 /*
  * FUNCTION: Terminates the current thread
  * ARGUMENTS:
@@ -167,8 +429,68 @@ NTSTATUS PsTerminateSystemThread(NTSTATUS ExitStatus)
    return(STATUS_SUCCESS);
 }
 
+NTSTATUS STDCALL
+NtCallTerminatePorts(PETHREAD Thread)
+{
+   KIRQL oldIrql;
+   PLIST_ENTRY current_entry;
+   PEPORT_TERMINATION_REQUEST current;
+   
+   PAGED_CODE();
+   
+   KeAcquireSpinLock(&Thread->ActiveTimerListLock, &oldIrql);
+   while ((current_entry = RemoveHeadList(&Thread->TerminationPortList)) !=
+         &Thread->TerminationPortList);
+     {
+       current = CONTAINING_RECORD(current_entry,
+                                   EPORT_TERMINATION_REQUEST,
+                                   ThreadListEntry);
+       KeReleaseSpinLock(&Thread->ActiveTimerListLock, oldIrql);
+       LpcSendTerminationPort(current->Port, 
+                              Thread->CreateTime);
+       ExFreePool(current);
+       KeAcquireSpinLock(&Thread->ActiveTimerListLock, &oldIrql);
+     }
+   KeReleaseSpinLock(&Thread->ActiveTimerListLock, oldIrql);
+   return(STATUS_SUCCESS);
+}
 
-NTSTATUS STDCALL NtRegisterThreadTerminatePort(HANDLE  TerminationPort)
+NTSTATUS STDCALL
+NtRegisterThreadTerminatePort(HANDLE PortHandle)
 {
-   UNIMPLEMENTED;
+   NTSTATUS Status;
+   PEPORT_TERMINATION_REQUEST Request;
+   PEPORT TerminationPort;
+   KIRQL oldIrql;
+   PETHREAD Thread;
+   
+   PAGED_CODE();
+   
+   Status = ObReferenceObjectByHandle(PortHandle,
+                                     PORT_ALL_ACCESS,
+                                     LpcPortObjectType,
+                                     KeGetCurrentThread()->PreviousMode,
+                                     (PVOID*)&TerminationPort,
+                                     NULL);   
+   if (!NT_SUCCESS(Status))
+     {
+       return(Status);
+     }
+   
+   Request = ExAllocatePool(NonPagedPool, sizeof(EPORT_TERMINATION_REQUEST));
+   if(Request != NULL)
+   {
+     Request->Port = TerminationPort;
+     Thread = PsGetCurrentThread();
+     KeAcquireSpinLock(&Thread->ActiveTimerListLock, &oldIrql);
+     InsertTailList(&Thread->TerminationPortList, &Request->ThreadListEntry);
+     KeReleaseSpinLock(&Thread->ActiveTimerListLock, oldIrql);
+
+     return(STATUS_SUCCESS);
+   }
+   else
+   {
+     ObDereferenceObject(TerminationPort);
+     return(STATUS_INSUFFICIENT_RESOURCES);
+   }
 }