[MERGE #5515 @thomasmo] Add more debug fields to FunctionExecutionStateMachine

Merge pull request #5515 from thomasmo:simplejit_debug_110

Adding some temporary flags to help with debugging in automation

Author: Thomas Moore (CHAKRA)

bin/NativeTests/FunctionExecutionTest.h

@@ -109,6 +109,11 @@ namespace Js
         static size_t Print(const char16 *form, ...) { UNREFERENCED_PARAMETER(form);  return 0; }
     };
 
+    enum DebuggerMode : unsigned int
+    {
+        NotDebugging
+    };
+
     class FunctionBody
     {
     public:
@@ -118,6 +123,7 @@ namespace Js
         uint GetByteCodeCount() const { return 0; }
         uint GetByteCodeInLoopCount() const { return 0; }
         uint GetByteCodeWithoutLDACount() const { return 0; }
+        Js::DebuggerMode GetDebuggerMode() { return (Js::DebuggerMode)0; }
         FunctionEntryPointInfo* GetDefaultFunctionEntryPointInfo() { return &defaultInfo; }
         FunctionEntryPointInfo *GetSimpleJitEntryPointInfo() { return &simpleInfo; }
         void TraceExecutionMode(const char *const eventDescription = nullptr) const { UNREFERENCED_PARAMETER(eventDescription); }

lib/Runtime/Base/FunctionBody.cpp

@@ -9607,6 +9607,13 @@ namespace Js
     {
         return m_hasFirstTmpRegister ? this->GetCountField(CounterFields::FirstTmpRegister) : Constants::NoRegister;
     }
+
+#if DBG && defined(ENABLE_SCRIPT_DEBUGGING)
+    Js::DebuggerMode FunctionBody::GetDebuggerMode()
+    {
+        return this->GetScriptContext()->GetDebugContext()->GetDebuggerMode();
+    }
+#endif
 }
 
 #if !DBG

lib/Runtime/Base/FunctionBody.h

@@ -2470,6 +2470,9 @@ namespace Js
     public:
 #if DBG
         int GetProfileSession() { return m_iProfileSession; }
+#ifdef ENABLE_SCRIPT_DEBUGGING
+        Js::DebuggerMode GetDebuggerMode();
+#endif
 #endif
         virtual void Finalize(bool isShutdown) override;
         virtual void OnMark() override;

lib/Runtime/Base/FunctionExecutionStateMachine.cpp

@@ -24,14 +24,25 @@ namespace Js
         lastInterpretedCount(0)
 #if DBG
         ,initializedExecutionModeAndLimits(false)
+        ,hasBeenReinitialized(false)
+#ifdef ENABLE_SCRIPT_DEBUGGING
+        ,initDebuggerMode(DebuggerMode::NotDebugging)
+        ,reinitDebuggerMode(DebuggerMode::NotDebugging)
+#endif
 #endif
     {
     }
 
     void FunctionExecutionStateMachine::InitializeExecutionModeAndLimits(FunctionBody* functionBody)
     {
 #if DBG
-        initializedExecutionModeAndLimits = true;
+#ifdef ENABLE_SCRIPT_DEBUGGING
+        if (!initializedExecutionModeAndLimits)
+        {
+            initDebuggerMode = functionBody->GetDebuggerMode();
+        }
+#endif
+        initializedExecutionModeAndLimits = true;        
 #endif
         // Assert we're either uninitialized, or being reinitialized on the same FunctionBody
         Assert(owner == nullptr || owner == functionBody);
@@ -151,6 +162,12 @@ namespace Js
 
     void FunctionExecutionStateMachine::ReinitializeExecutionModeAndLimits(FunctionBody* functionBody)
     {
+#if DBG
+        hasBeenReinitialized = true;
+#ifdef ENABLE_SCRIPT_DEBUGGING
+        reinitDebuggerMode = functionBody->GetDebuggerMode();
+#endif
+#endif
         // TODO: Investigate what it would take to make this invariant hold. Currently fails in AsmJS tests
         // Assert(initializedExecutionModeAndLimits);
 

lib/Runtime/Base/FunctionExecutionStateMachine.h

@@ -6,6 +6,10 @@
 
 namespace Js
 {
+#if DBG && defined(ENABLE_SCRIPT_DEBUGGING)
+    enum DebuggerMode : unsigned int;
+#endif
+
     class FunctionExecutionStateMachine
     {
     public:
@@ -113,6 +117,12 @@ namespace Js
 
 #if DBG
         FieldWithBarrier(bool) initializedExecutionModeAndLimits;
+        // Temporary debug flags for automation
+        FieldWithBarrier(bool) hasBeenReinitialized;
+#ifdef ENABLE_SCRIPT_DEBUGGING
+        FieldWithBarrier(Js::DebuggerMode) initDebuggerMode;
+        FieldWithBarrier(Js::DebuggerMode) reinitDebuggerMode;
+#endif
 #endif
     };
 };

lib/Runtime/Debug/DebugContext.h

@@ -24,7 +24,7 @@ class HostDebugContext
 namespace Js
 {
     // Represents the different modes that the debugger can be placed into.
-    enum DebuggerMode
+    enum DebuggerMode : unsigned int
     {
         // The debugger is not running so the engine can be running
         // in JITed mode.
@@ -53,6 +53,9 @@ namespace Js
         void SetHostDebugContext(HostDebugContext * hostDebugContext);
 
         void SetDebuggerMode(DebuggerMode mode);
+#if DBG
+        DebuggerMode GetDebuggerMode() const { return this->debuggerMode; }
+#endif
 
         bool IsDebugContextInNonDebugMode() const { return this->debuggerMode == DebuggerMode::NotDebugging; }
         bool IsDebugContextInDebugMode() const { return this->debuggerMode == DebuggerMode::Debugging; }