Work around AV in dbgeng when loading image as dump

Author: jazzdelightsme

DbgProvider/public/Debugger/DbgEngDebugger.cs

@@ -67,11 +67,29 @@ internal static DbgEngDebugger NewDebugger()
             return _GlobalDebugger;
         }
 
+
+        // There's a bug in dbgeng.dll that results in an AV in dbgeng. The situation is
+        // triggered when we load up an image file as a dump. After we call WaitForEvent,
+        // dbgeng calls back into us to notify us of various state changes, and in those,
+        // we query current state, such as a the current scope frame, and then dbgeng AVs.
+        //
+        // If we didn't handle it, it would get handled by dbgeng's own WaitForEvent
+        // underneath us, so now DbgEngWrapper catches all exceptions that come out of
+        // dbgeng. However, even in that case, some of dbgeng's internal state gets messed
+        // up (engine nesting level), so we'll conspire to avoid hitting the AV in the
+        // first place: When loading an image as a dump file, we'll skip calling
+        // GetCurrentScopeFrameIndexEx that first time.
+        internal int m_loadingImageHack;
+
         internal void LoadCrashDump( string dumpFileName,
-                                   string targetFriendlyName )
+                                     string targetFriendlyName )
         {
             DbgEngThread.Singleton.Execute( () =>
                 {
+                    if( dumpFileName.EndsWith( ".dll" ) || dumpFileName.EndsWith( ".exe" ) )
+                    {
+                        m_loadingImageHack = 1;
+                    }
                     CheckHr( m_debugClient.OpenDumpFileWide( dumpFileName, 0 ) );
                     SetNextTargetName( targetFriendlyName );
                 } );
@@ -4302,12 +4320,19 @@ public DbgEngContext GetCurrentDbgEngContext()
                         threadIdOrAddr = uiThreadId;
                     }
 
-                    hr = m_debugSymbols.GetCurrentScopeFrameIndexEx( DEBUG_FRAME.DEFAULT, out frameId );
-                    if( 0 != hr )
+                    if( m_loadingImageHack-- > 0 )
                     {
-                        LogManager.Trace( "GetCurrentDbgEngContext: no current frame: {0}.",
-                                          Util.FormatErrorCode( hr ) );
-                        return;
+                        LogManager.Trace( "Avoiding querying current scope frame to avoid dbgeng bug." );
+                    }
+                    else
+                    {
+                        hr = m_debugSymbols.GetCurrentScopeFrameIndexEx( DEBUG_FRAME.DEFAULT, out frameId );
+                        if( 0 != hr )
+                        {
+                            LogManager.Trace( "GetCurrentDbgEngContext: no current frame: {0}.",
+                                              Util.FormatErrorCode( hr ) );
+                            return;
+                        }
                     }
                 } );
 

DbgProvider/public/Debugger/RealDebugEventCallbacks.cs

@@ -609,6 +609,7 @@ public int ChangeSymbolState( DEBUG_CSS Flags, ulong Argument )
                         m_debugger.m_sympath = null;
                     }
 
+                    // Re: m_loadingImageHack: this is where the AV in dbgeng occurs.
                     var eventArgs = new SymbolStateChangedEventArgs( m_debugger, Flags, Argument );
                     int retVal = _RaiseEvent( m_debugger.SymbolStateChanged, eventArgs );
                     if( _ShouldOutput( retVal, eventArgs ) )