Separate stack walk contexts for different requests from Visual Studi…

…o to fix jumping frames in call stack window
WheretIB · May 23, 2020 · 3a0cf07 · 3a0cf07
1 parent 1267332
commit 3a0cf07
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 27 deletions.
diff --git a/LuaDkmDebuggerComponent/LocalComponent.cs b/LuaDkmDebuggerComponent/LocalComponent.cs
@@ -29,7 +29,10 @@ internal class LuaLocalProcessData : DkmDataItem
         public string workingDirectory = null;
 
         public LuaDebugConfiguration configuration;
+    }
 
+    internal class LuaStackContextData : DkmDataItem
+    {
         // Stack walk data for multiple switches between Lua and C++
         public bool seenLuaFrame = false;
         public int skipFrames = 0; // How many Lua frames to skip
@@ -165,16 +168,7 @@ DkmStackWalkFrame[] IDkmCallStackFilter.FilterNextFrame(DkmStackContext stackCon
         {
             // null input frame indicates the end of the call stack
             if (input == null)
-            {
-                var processData = DebugHelpers.GetOrCreateDataItem<LuaLocalProcessData>(stackContext.InspectionSession.Process);
-
-                // Reset stack walk frame position
-                processData.seenLuaFrame = false;
-                processData.skipFrames = 0;
-                processData.seenFrames = 0;
-
                 return null;
-            }
 
             if (input.InstructionAddress == null)
                 return new DkmStackWalkFrame[1] { input };
@@ -185,6 +179,8 @@ DkmStackWalkFrame[] IDkmCallStackFilter.FilterNextFrame(DkmStackContext stackCon
             if (input.BasicSymbolInfo == null)
                 return new DkmStackWalkFrame[1] { input };
 
+            var stackContextData = DebugHelpers.GetOrCreateDataItem<LuaStackContextData>(stackContext);
+
             if (input.BasicSymbolInfo.MethodName == "luaV_execute")
             {
                 var process = stackContext.InspectionSession.Process;
@@ -390,9 +386,9 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
                         if (prevCallInfoData.func == null)
                             break;
 
-                        if (processData.skipFrames != 0)
+                        if (stackContextData.skipFrames != 0)
                         {
-                            processData.skipFrames--;
+                            stackContextData.skipFrames--;
 
                             currCallInfoAddress = currCallInfoAddress - (DebugHelpers.Is64Bit(process) ? 40ul : 24ul);
                             continue;
@@ -431,8 +427,8 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
 
                         if (currCallLuaFunction.value.isC_5_1 == 0)
                         {
-                            processData.seenLuaFrame = true;
-                            processData.seenFrames++;
+                            stackContextData.seenLuaFrame = true;
+                            stackContextData.seenFrames++;
 
                             var frame = GetLuaFunctionStackWalkFrame(currCallInfoAddress, currCallInfoData, currCallLuaFunction, currFunctionName);
 
@@ -445,10 +441,10 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
                         }
                         else
                         {
-                            if (processData.seenLuaFrame)
+                            if (stackContextData.seenLuaFrame)
                             {
-                                processData.seenLuaFrame = false;
-                                processData.skipFrames = processData.seenFrames;
+                                stackContextData.seenLuaFrame = false;
+                                stackContextData.skipFrames = stackContextData.seenFrames;
                                 break;
                             }
 
@@ -476,9 +472,9 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
 
                         if (currCallInfoData.func.baseType == LuaBaseType.Function)
                         {
-                            if (processData.skipFrames != 0)
+                            if (stackContextData.skipFrames != 0)
                             {
-                                processData.skipFrames--;
+                                stackContextData.skipFrames--;
 
                                 currCallInfoAddress = currCallInfoData.previousAddress;
                                 continue;
@@ -529,8 +525,8 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
                                 if (currCallLuaFunction == null)
                                     break;
 
-                                processData.seenLuaFrame = true;
-                                processData.seenFrames++;
+                                stackContextData.seenLuaFrame = true;
+                                stackContextData.seenFrames++;
 
                                 var frame = GetLuaFunctionStackWalkFrame(currCallInfoAddress.Value, currCallInfoData, currCallLuaFunction, currFunctionName);
 
@@ -543,10 +539,10 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
                             }
                             else if (currCallInfoData.func.extendedType == LuaExtendedType.ExternalFunction)
                             {
-                                if (processData.seenLuaFrame)
+                                if (stackContextData.seenLuaFrame)
                                 {
-                                    processData.seenLuaFrame = false;
-                                    processData.skipFrames = processData.seenFrames;
+                                    stackContextData.seenLuaFrame = false;
+                                    stackContextData.skipFrames = stackContextData.seenFrames;
                                     break;
                                 }
 
@@ -556,10 +552,10 @@ DkmStackWalkFrame GetLuaFunctionStackWalkFrame(ulong callInfoAddress, LuaFunctio
                             }
                             else if (currCallInfoData.func.extendedType == LuaExtendedType.ExternalClosure)
                             {
-                                if (processData.seenLuaFrame)
+                                if (stackContextData.seenLuaFrame)
                                 {
-                                    processData.seenLuaFrame = false;
-                                    processData.skipFrames = processData.seenFrames;
+                                    stackContextData.seenLuaFrame = false;
+                                    stackContextData.skipFrames = stackContextData.seenFrames;
                                     break;
                                 }
 

diff --git a/README.md b/README.md
@@ -41,4 +41,3 @@ Add `ScriptPaths` key with an array of additional search paths.
 ### Known Issues:
  * This extension will always add Lua module to the application (can be seen in 'Modules' section of the debugger) even when debugging applications with no Lua code (check notes in RemoteComponent.cs)
  * Lua 5.2 is assumed to be compiled with LUA_NANTRICK in x86 (deafult configuration)
- * When Lua stack frames are separated by C/C++ frames, stepping might display two top Lua call stack blocks in reverse order, double click any frame for Visual Studio to refresh with correct order