Fix exception in inline frame processing (#22)

microsoft · Jan 25, 2022 · ec2ea6f · ec2ea6f
1 parent d548ba5
commit ec2ea6f
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/Engine/DiaUtil.cs b/Engine/DiaUtil.cs
@@ -175,8 +175,11 @@ internal static string ProcessInlineFrames(string moduleName, bool useUndecorate
                 }
                 Marshal.ReleaseComObject(enumInlinees);
             } catch (COMException) {
-                sbInline.AppendLine(" -- WARN: Unable to process inline frames");
+                sbInline.AppendLine(" -- WARN: Unable to process inline frames; maybe symbols are mismatched?");
+            } catch (System.ArgumentException) {
+                sbInline.AppendLine(" -- WARN: Unable to process inline frames; maybe symbols are mismatched?");
             }
+
             return sbInline.ToString();
         }
     }

diff --git a/GUI/MainForm.cs b/GUI/MainForm.cs
@@ -11,7 +11,6 @@ namespace Microsoft.SqlServer.Utils.Misc.SQLCallStackResolver {
     using System.Net;
     using System.Globalization;
     using System.Configuration;
-    using System.ComponentModel;
     using System.Threading.Tasks;
     using System.Threading;
 
@@ -133,6 +132,14 @@ private void ResolveCallstacks_Click(object sender, EventArgs e) {
             this.MonitorBackgroundTask(backgroundTask);
 
             finalOutput.Text = backgroundTask.Result;
+
+            if (backgroundTask.Result.Contains("-- WARN:")) {
+                MessageBox.Show(this,
+                    "One or more potential issues exist in the output. This is sometimes due to mismatched symbols, so please double-check symbol paths and re-run if needed.",
+                    "Potential issues with the output",
+                    MessageBoxButtons.OK,
+                    MessageBoxIcon.Warning);
+            }
         }
 
         private void DisableCancelButton() {

diff --git a/Tests/Tests.cs b/Tests/Tests.cs
@@ -75,7 +75,7 @@ public void LargeXEventsInput() {
                 xeventInput.AppendLine("</Events>");
                 var timer = new System.Diagnostics.Stopwatch();
                 timer.Start();
-                var ret = csr.ResolveCallstacks(xeventInput.ToString(), @"..\..\..\Tests\TestCases\TestOrdinal", false, null, false, false, false, false, true, false, false, Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()));
+                csr.ResolveCallstacks(xeventInput.ToString(), @"..\..\..\Tests\TestCases\TestOrdinal", false, null, false, false, false, false, true, false, false, Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()));
                 timer.Stop();
                 Assert.True(timer.Elapsed.TotalSeconds < 45 * 60);  // 45 minutes max on GitHub hosted DSv2 runner (2 vCPU, 7 GiB RAM).
             }
@@ -401,6 +401,26 @@ public void InlineFrameResolution() {
             }
         }
 
+        /// "Fuzz" test for inline frame resolution by providing random offsets into the module. This test uses symbols for a Windows Driver Kit module, Wdf01000.sys, because private PDBs for that module are legitimately available on the
+        /// Microsoft public symbols servers. https://github.com/microsoft/Windows-Driver-Frameworks/releases if interested.
+        [Fact]
+        [Trait("Category", "Unit")]
+        public void RandomInlineFrameResolution() {
+            using (var csr = new StackResolver()) {
+                var pdbPath = @"..\..\..\Tests\TestCases\SourceInformation";
+                var callstackInput = new System.Text.StringBuilder();
+                // generate frames with random offsets
+                var rng = new Random();
+                // generate 1000 frames, each frame having a random offset into Wdf01000
+                for (int frameNum = 0; frameNum < 1000; frameNum++) {
+                    callstackInput.AppendLine($"Wdf01000+{rng.Next(0, 1000000)}");
+                }
+                csr.ResolveCallstacks(callstackInput.ToString(), pdbPath, false, null, false, false, true, false, true, true, false, null);
+                // We do not need to check anything; the criteria for the test passing is that the call did not throw an unhandled exception
+            }
+        }
+
+
         /// Test for inline frame resolution without source lines included This test uses symbols for a Windows Driver Kit module, Wdf01000.sys,
         /// because private PDBs for that module are legitimately available on the Microsoft public symbols servers. https://github.com/microsoft/Windows-Driver-Frameworks/releases if interested.
         [Fact][Trait("Category", "Unit")]