EE: Handle notification when metadata has been invalidated (dotnet#75423

)
cston · Oct 15, 2024 · cb74ff1 · cb74ff1
1 parent 3fd39c8
commit cb74ff1
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 1,558 deletions.
diff --git a/eng/Directory.Packages.props b/eng/Directory.Packages.props
@@ -64,7 +64,7 @@
     <PackageVersion Include="Microsoft.VisualStudio.Extensibility" Version="$(MicrosoftVisualStudioExtensibilityVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Extensibility.Sdk" Version="$(MicrosoftVisualStudioExtensibilityVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Extensibility.JsonGenerators.Sdk" Version="$(MicrosoftVisualStudioExtensibilityVersion)" />
-    <PackageVersion Include="Microsoft.VSSDK.Debugger.VSDConfigTool" Version="17.0.1051901-preview" />
+    <PackageVersion Include="Microsoft.VSSDK.Debugger.VSDConfigTool" Version="17.13.1100801-preview" />
     <PackageVersion Include="Microsoft.VisualStudio.ProjectSystem" Version="17.0.77-pre-g62a6cb5699" />
     <PackageVersion Include="Microsoft.VisualStudio.Progression.CodeSchema" Version="15.8.27812-alpha" />
     <PackageVersion Include="Microsoft.VisualStudio.Progression.Common" Version="15.8.27812-alpha" />
@@ -122,8 +122,8 @@
       VS Debugger
     -->
     <PackageVersion Include="Microsoft.VisualStudio.Debugger.Contracts" Version="17.12.0-beta.24403.1" />
-    <PackageVersion Include="Microsoft.VisualStudio.Debugger.Engine-implementation" Version="17.8.1072001-preview" />
-    <PackageVersion Include="Microsoft.VisualStudio.Debugger.Metadata-implementation" Version="17.8.1072001-preview" />
+    <PackageVersion Include="Microsoft.VisualStudio.Debugger.Engine-implementation" Version="17.13.1100701-preview" />
+    <PackageVersion Include="Microsoft.VisualStudio.Debugger.Metadata-implementation" Version="17.13.1100701-preview" />
 
     <!--
       VS .NET Runtime

diff --git a/...xpressionEvaluator/CSharp/Source/ExpressionCompiler/CSharpExpressionCompiler.vsdconfigxml b/...xpressionEvaluator/CSharp/Source/ExpressionCompiler/CSharpExpressionCompiler.vsdconfigxml
@@ -23,6 +23,7 @@
         <InterfaceGroup
           CallOnlyWhenLoaded="true">
           <NoFilter/>
+          <Interface Name="IDkmMetaDataPointerInvalidatedNotification"/>
           <Interface Name="IDkmModuleModifiedNotification"/>
           <Interface Name="IDkmModuleInstanceUnloadNotification"/>
         </InterfaceGroup>

diff --git a/src/ExpressionEvaluator/Core/Source/ExpressionCompiler/ExpressionCompiler.cs b/src/ExpressionEvaluator/Core/Source/ExpressionCompiler/ExpressionCompiler.cs
@@ -8,7 +8,6 @@
 using System.Diagnostics;
 using System.IO;
 using System.Threading;
-using Microsoft.CodeAnalysis.Collections;
 using Microsoft.CodeAnalysis.PooledObjects;
 using Microsoft.VisualStudio.Debugger;
 using Microsoft.VisualStudio.Debugger.CallStack;
@@ -23,6 +22,7 @@ namespace Microsoft.CodeAnalysis.ExpressionEvaluator
     public abstract class ExpressionCompiler :
         IDkmClrExpressionCompiler,
         IDkmClrExpressionCompilerCallback,
+        IDkmMetaDataPointerInvalidatedNotification,
         IDkmModuleModifiedNotification,
         IDkmModuleInstanceUnloadNotification,
         IDkmLanguageFrameDecoder,
@@ -247,6 +247,11 @@ internal static bool ShouldTryAgainWithMoreMetadataBlocks(DkmUtilities.GetMetada
             return false;
         }
 
+        void IDkmMetaDataPointerInvalidatedNotification.OnMetaDataPointerInvalidated(DkmClrModuleInstance moduleInstance)
+        {
+            RemoveDataItemIfNecessary(moduleInstance);
+        }
+
         void IDkmModuleModifiedNotification.OnModuleModified(DkmModuleInstance moduleInstance)
         {
             RemoveDataItemIfNecessary(moduleInstance);

diff --git a/src/ExpressionEvaluator/Core/Source/ExpressionCompiler/ExpressionEvaluatorFatalError.cs b/src/ExpressionEvaluator/Core/Source/ExpressionCompiler/ExpressionEvaluatorFatalError.cs
@@ -76,6 +76,7 @@ internal static bool CrashIfFailFastEnabled(Exception exception)
             {
                 switch (dkmException.Code)
                 {
+                    case DkmExceptionCode.E_METADATA_UPDATE_DEADLOCK: // Metadata was updated while EE had component lock
                     case DkmExceptionCode.E_PROCESS_DESTROYED:
                     case DkmExceptionCode.E_XAPI_REMOTE_CLOSED:
                     case DkmExceptionCode.E_XAPI_REMOTE_DISCONNECTED:

diff --git a/src/ExpressionEvaluator/Core/Source/FunctionResolver/CSharp/FunctionResolver.vsdconfigxml b/src/ExpressionEvaluator/Core/Source/FunctionResolver/CSharp/FunctionResolver.vsdconfigxml
@@ -28,6 +28,7 @@
             <RuntimeId RequiredValue="DkmRuntimeId.Clr"/>
             <RuntimeId RequiredValue="DkmRuntimeId.ClrNativeCompilation"/>
           </Filter>
+          <Interface Name="IDkmMetaDataPointerInvalidatedNotification"/>
           <Interface Name="IDkmModuleInstanceLoadNotification"/>
           <Interface Name="IDkmModuleInstanceUnloadNotification"/>
           <Interface Name="IDkmModuleModifiedNotification"/>

diff --git a/src/ExpressionEvaluator/Core/Source/FunctionResolver/FunctionResolver.cs b/src/ExpressionEvaluator/Core/Source/FunctionResolver/FunctionResolver.cs
@@ -20,6 +20,7 @@ namespace Microsoft.CodeAnalysis.ExpressionEvaluator
     internal abstract class FunctionResolver :
         FunctionResolverBase<DkmProcess, DkmClrModuleInstance, DkmRuntimeFunctionResolutionRequest>,
         IDkmRuntimeFunctionResolver,
+        IDkmMetaDataPointerInvalidatedNotification,
         IDkmModuleInstanceLoadNotification,
         IDkmModuleInstanceUnloadNotification,
         IDkmModuleModifiedNotification,
@@ -54,6 +55,13 @@ void IDkmModuleModifiedNotification.OnModuleModified(DkmModuleInstance moduleIns
             // caller from modifying modules while binding.
         }
 
+        void IDkmMetaDataPointerInvalidatedNotification.OnMetaDataPointerInvalidated(DkmClrModuleInstance moduleInstance)
+        {
+            // Implementing IDkmMetaDataPointerInvalidatedNotification
+            // (with Synchronized="true" in .vsdconfigxml) prevents
+            // caller from modifying modules while binding.
+        }
+
         void IDkmModuleSymbolsLoadedNotification.OnModuleSymbolsLoaded(DkmModuleInstance moduleInstance, DkmModule module, bool isReload, DkmWorkList workList, DkmEventDescriptor eventDescriptor)
         {
             OnModuleLoad(moduleInstance, workList);

diff --git a/...xpressionEvaluator/Core/Source/FunctionResolver/VisualBasic/FunctionResolver.vsdconfigxml b/...xpressionEvaluator/Core/Source/FunctionResolver/VisualBasic/FunctionResolver.vsdconfigxml
@@ -29,6 +29,7 @@
             <RuntimeId RequiredValue="DkmRuntimeId.Clr"/>
             <RuntimeId RequiredValue="DkmRuntimeId.ClrNativeCompilation"/>
           </Filter>
+          <Interface Name="IDkmMetaDataPointerInvalidatedNotification"/>
           <Interface Name="IDkmModuleInstanceLoadNotification"/>
           <Interface Name="IDkmModuleInstanceUnloadNotification"/>
           <Interface Name="IDkmModuleModifiedNotification"/>