[hbelusca] 68854: [NTOS] Addendum to r68851: - Reset the state of the worker thread *after* having captured the data, not before. - Fix the explanations given in comments.

Author: hbelusca
Date: Sat Aug 29 12:53:08 2015
New Revision: 68854

URL: http://svn.reactos.org/svn/reactos?rev=68854&view=rev
Log:
[NTOS]
Addendum to r68851:
- Reset the state of the worker thread *after* having captured the data, not before.
- Fix the explanations given in comments.

Modified:
    trunk/reactos/ntoskrnl/ex/dbgctrl.c
    trunk/reactos/ntoskrnl/ex/work.c
    trunk/reactos/ntoskrnl/include/internal/ex.h

Modified: trunk/reactos/ntoskrnl/ex/dbgctrl.c
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/ntoskrnl/ex/dbgctrl.c?rev=…
==============================================================================
--- trunk/reactos/ntoskrnl/ex/dbgctrl.c	[iso-8859-1] (original)
+++ trunk/reactos/ntoskrnl/ex/dbgctrl.c	[iso-8859-1] Sat Aug 29 12:53:08 2015
@@ -16,7 +16,7 @@
 
 // #ifdef _WINKD_
 /*
- * WinDBG Debugger Worker Thread data
+ * WinDBG Debugger Worker State Machine data
  */
 WORK_QUEUE_ITEM ExpDebuggerWorkItem;
 /*
@@ -33,19 +33,22 @@
 
 // #ifdef _WINKD_
 /*
- * WinDBG Debugger Worker Thread
- *
- * A worker thread is queued whenever WinDBG wants to attach or kill a user-mode
+ * WinDBG Debugger Worker State Machine
+ *
+ * This functionality is used whenever WinDBG wants to attach or kill a user-mode
  * process from within live kernel-mode session, and/or page-in an address region.
+ * It is implemented as a state machine: when it is in "Ready" state, WinDBG
can
+ * initialize the data for the state machine, then switch its state to
"Start".
+ * The worker thread balance manager detects this, switches the state to
"Initialized"
+ * and queues a worker thread. As long as the state is not "Ready" again,
WinDBG
+ * prevents from requeuing a new thread. When the thread is started, it captures
+ * all the data, then resets the machine state to "Ready", thus allowing
WinDBG
+ * to requeue another worker thread.
  *
  * WinDBG commands:
  *     .process /i <addr> (where <addr> is the address of the EPROCESS block
for this process)
  *     .kill <addr>       (       "                "               
"                "       )
  *     .pagein <addr>     (where <addr> is the address to page in)
- *
- * The implementation is very naive because the same data is reused, so that if
- * the worker thread has not started before WinDBG sends fresh new data again,
- * then only the latest data is taken into account.
  */
 VOID
 NTAPI
@@ -59,22 +62,25 @@
     UNREFERENCED_PARAMETER(Context);
 
     /* Be sure we were started in an initialized state */
-    ASSERTMSG("ExpDebuggerWorker being entered with state != 2\n",
+    ASSERTMSG("ExpDebuggerWorker being entered in non-initialized state!\n",
               ExpDebuggerWork == WinKdWorkerInitialized);
-    if (ExpDebuggerWork != WinKdWorkerInitialized) return;
-
-    /* Reset the worker flag to the disabled state */
-    ExpDebuggerWork = WinKdWorkerDisabled;
+    if (ExpDebuggerWork != WinKdWorkerInitialized)
+    {
+        /* An error happened, so get a chance to restart proper */
+        ExpDebuggerWork = WinKdWorkerReady;
+        return;
+    }
 
     /* Get the processes to be attached or killed, and the address to page in */
     ProcessToAttach = ExpDebuggerProcessAttach;
     ProcessToKill   = ExpDebuggerProcessKill;
     PageInAddress   = ExpDebuggerPageIn;
 
-    /* Reset to their default values */
+    /* Reset the state machine to its ready state */
     ExpDebuggerProcessAttach = NULL;
     ExpDebuggerProcessKill   = NULL;
     ExpDebuggerPageIn = (ULONG_PTR)NULL;
+    ExpDebuggerWork = WinKdWorkerReady;
 
     /* Default to the current process if we don't find the process to be attached or
killed */
     Process = NULL;

Modified: trunk/reactos/ntoskrnl/ex/work.c
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/ntoskrnl/ex/work.c?rev=688…
==============================================================================
--- trunk/reactos/ntoskrnl/ex/work.c	[iso-8859-1] (original)
+++ trunk/reactos/ntoskrnl/ex/work.c	[iso-8859-1] Sat Aug 29 12:53:08 2015
@@ -491,7 +491,7 @@
          * If WinDBG wants to attach or kill a user-mode process, and/or
          * page-in an address region, queue a debugger worker thread.
          */
-        if (ExpDebuggerWork == WinKdWorkerActivate)
+        if (ExpDebuggerWork == WinKdWorkerStart)
         {
              ExInitializeWorkItem(&ExpDebuggerWorkItem, ExpDebuggerWorker, NULL);
              ExpDebuggerWork = WinKdWorkerInitialized;

Modified: trunk/reactos/ntoskrnl/include/internal/ex.h
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/ntoskrnl/include/internal/…
==============================================================================
--- trunk/reactos/ntoskrnl/include/internal/ex.h	[iso-8859-1] (original)
+++ trunk/reactos/ntoskrnl/include/internal/ex.h	[iso-8859-1] Sat Aug 29 12:53:08 2015
@@ -44,12 +44,12 @@
 
 // #ifdef _WINKD_
 /*
- * WinDBG Debugger Worker Thread data (see dbgctrl.c)
+ * WinDBG Debugger Worker State Machine data (see dbgctrl.c)
  */
 typedef enum _WINKD_WORKER_STATE
 {
-    WinKdWorkerDisabled = 0,
-    WinKdWorkerActivate,
+    WinKdWorkerReady = 0,
+    WinKdWorkerStart,
     WinKdWorkerInitialized
 } WINKD_WORKER_STATE;