Merge in 'release/8.0-rc2' changes

dotnet-bot · dotnet-bot · commit 8261a7b16650 · 2023-09-23T02:15:56.000Z
diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml
@@ -371,13 +371,13 @@
       <Uri>https://github.com/dotnet/roslyn</Uri>
       <Sha>9233e36abc5e2ca263dbd4d1616f35623440a935</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0-beta1.23468.1">
+    <Dependency Name="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0-beta1.23472.1">
       <Uri>https://github.com/dotnet/roslyn-analyzers</Uri>
-      <Sha>2c9a20b6706b8a9ad650b41bff30980cf5af67ed</Sha>
+      <Sha>4a7701fd72094614897b33e4cb1d9640c221d862</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0-preview.23468.1">
+    <Dependency Name="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0-preview.23472.1">
       <Uri>https://github.com/dotnet/roslyn-analyzers</Uri>
-      <Sha>2c9a20b6706b8a9ad650b41bff30980cf5af67ed</Sha>
+      <Sha>4a7701fd72094614897b33e4cb1d9640c221d862</Sha>
     </Dependency>
     <Dependency Name="Microsoft.DotNet.ApiCompat.Task" Version="8.0.100-preview.7.23329.3">
       <Uri>https://github.com/dotnet/sdk</Uri>
diff --git a/eng/Versions.props b/eng/Versions.props
@@ -34,8 +34,8 @@
   </ItemGroup>
   <PropertyGroup>
     <!-- dotnet/roslyn-analyzers dependencies -->
-    <MicrosoftCodeAnalysisAnalyzersVersion>3.11.0-beta1.23468.1</MicrosoftCodeAnalysisAnalyzersVersion>
-    <MicrosoftCodeAnalysisNetAnalyzersVersion>8.0.0-preview.23468.1</MicrosoftCodeAnalysisNetAnalyzersVersion>
+    <MicrosoftCodeAnalysisAnalyzersVersion>3.11.0-beta1.23472.1</MicrosoftCodeAnalysisAnalyzersVersion>
+    <MicrosoftCodeAnalysisNetAnalyzersVersion>8.0.0-preview.23472.1</MicrosoftCodeAnalysisNetAnalyzersVersion>
     <!-- dotnet/roslyn dependencies -->
     <!--
       These versions should not be used by any project that contributes to the design-time experience in VS, such as an analyzer, code-fix, or generator assembly.
diff --git a/src/coreclr/vm/callsiteinspect.cpp b/src/coreclr/vm/callsiteinspect.cpp
@@ -433,7 +433,8 @@ void CallsiteInspect::PropagateOutParametersBackToCallsite(
                 *(ARG_SLOT *)(frame->GetReturnValuePtr()) = retVal;
             }
 #ifdef ENREGISTERED_RETURNTYPE_MAXSIZE
-            else if (argit.HasNonStandardByvalReturn())
+            else if (argit.HasNonStandardByvalReturn()
+                    && !(flags & CallsiteDetails::HResultReturn))
             {
                 // In these cases, put the pointer to the return buffer into
                 // the frame's return value slot.
diff --git a/src/coreclr/vm/callsiteinspect.h b/src/coreclr/vm/callsiteinspect.h
@@ -25,6 +25,7 @@ struct CallsiteDetails
         BeginInvoke     = 0x01,
         EndInvoke       = 0x02,
         Ctor            = 0x04,
+        HResultReturn   = 0x08,
     };
     INT32 Flags;
 };
diff --git a/src/coreclr/vm/clrtocomcall.cpp b/src/coreclr/vm/clrtocomcall.cpp
@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
     return 0;
 }
 
-CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
+static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
 {
     CONTRACTL
     {
@@ -442,10 +442,20 @@ CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
         SigTypeContext::InitTypeContext(pMD, actualType, &typeContext);
     }
 
+    // If the signature is marked preserve sig, then the return
+    // is required to be an HRESULT, per COM rules. We set a flag to
+    // indicate this state to avoid issues when a C# developer defines
+    // an HRESULT in C# as a ValueClass with a single int field. This
+    // is convenient but does violate the COM ABI. Setting the flag
+    // lets us permit this convention and allow either a 4 byte primitive
+    // or the commonly used C# type "struct HResult { int Value; }".
+    if (IsMiPreserveSig(pMD->GetImplAttrs()))
+        callsiteFlags |= CallsiteDetails::HResultReturn;
+
     _ASSERTE(!signature.IsEmpty() && pModule != nullptr);
 
     // Create details
-    return CallsiteDetails{ { signature, pModule, &typeContext }, pFrame, pMD, fIsDelegate };
+    return CallsiteDetails{ { signature, pModule, &typeContext }, pFrame, pMD, fIsDelegate, callsiteFlags };
 }
 
 UINT32 CLRToCOMLateBoundWorker(
diff --git a/src/tests/Interop/COM/NETClients/IDispatch/Program.cs b/src/tests/Interop/COM/NETClients/IDispatch/Program.cs
@@ -139,6 +139,21 @@ static void Validate_Exception()
                 Assert.Equal(GetErrorCodeFromHResult(e.HResult), errorCode);
                 // Failing HRESULT exceptions contain CLR generated messages
             }
+
+            // Calling methods through IDispatch::Invoke() (i.e., late-bound) doesn't
+            // propagate the HRESULT when marked with PreserveSig. It is always 0.
+            {
+                Console.WriteLine($"Calling {nameof(DispatchTesting.TriggerException)} (PreserveSig) with {nameof(IDispatchTesting_Exception.Int)} {errorCode}...");
+                var dispatchTesting2 = (IDispatchTestingPreserveSig1)dispatchTesting;
+                Assert.Equal(0, dispatchTesting2.TriggerException(IDispatchTesting_Exception.Int, errorCode));
+            }
+
+            {
+                // Validate the HRESULT as a value type construct works for IDispatch.
+                Console.WriteLine($"Calling {nameof(DispatchTesting.TriggerException)} (PreserveSig, ValueType) with {nameof(IDispatchTesting_Exception.Int)} {errorCode}...");
+                var dispatchTesting3 = (IDispatchTestingPreserveSig2)dispatchTesting;
+                Assert.Equal(0, dispatchTesting3.TriggerException(IDispatchTesting_Exception.Int, errorCode).Value);
+            }
         }
 
         static void Validate_StructNotSupported()
diff --git a/src/tests/Interop/COM/NETServer/DispatchTesting.cs b/src/tests/Interop/COM/NETServer/DispatchTesting.cs
@@ -57,6 +57,7 @@ public void TriggerException(IDispatchTesting_Exception excep, int errorCode)
         case IDispatchTesting_Exception.Disp:
             throw new Exception();
         case IDispatchTesting_Exception.HResult:
+        case IDispatchTesting_Exception.Int:
             throw new System.ComponentModel.Win32Exception(errorCode);
         }
     }
diff --git a/src/tests/Interop/COM/NativeServer/DispatchTesting.h b/src/tests/Interop/COM/NativeServer/DispatchTesting.h
@@ -243,6 +243,8 @@ class DispatchTesting : public UnknownImpl, public IDispatchTesting
             return DISP_E_EXCEPTION;
         case IDispatchTesting_Exception_HResult:
             return HRESULT_FROM_WIN32(errorCode);
+        case IDispatchTesting_Exception_Int:
+            return errorCode;
         default:
             return S_FALSE; // Return a success case to indicate failure to trigger a failure.
         }
diff --git a/src/tests/Interop/COM/ServerContracts/Server.Contracts.cs b/src/tests/Interop/COM/ServerContracts/Server.Contracts.cs
@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
     {
         Disp,
         HResult,
+        Int,
     }
 
     [StructLayout(LayoutKind.Sequential)]
@@ -220,6 +221,12 @@ public struct HFA_4
         public float w;
     }
 
+    [StructLayout(LayoutKind.Sequential)]
+    public struct HRESULT
+    {
+        public int Value;
+    }
+
     [ComVisible(true)]
     [Guid("a5e04c1c-474e-46d2-bbc0-769d04e12b54")]
     [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
@@ -257,6 +264,32 @@ void DoubleNumeric_ReturnByRef (
         System.Collections.IEnumerator GetEnumerator();
     }
 
+    [ComVisible(true)]
+    [Guid("a5e04c1c-474e-46d2-bbc0-769d04e12b54")]
+    [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
+    public interface IDispatchTestingPreserveSig1
+    {
+        void Reserved1();
+        void Reserved2();
+        void Reserved3();
+
+        [PreserveSig]
+        int TriggerException(IDispatchTesting_Exception excep, int errorCode);
+    }
+
+    [ComVisible(true)]
+    [Guid("a5e04c1c-474e-46d2-bbc0-769d04e12b54")]
+    [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
+    public interface IDispatchTestingPreserveSig2
+    {
+        void Reserved1();
+        void Reserved2();
+        void Reserved3();
+
+        [PreserveSig]
+        HRESULT TriggerException(IDispatchTesting_Exception excep, int errorCode);
+    }
+
     [ComVisible(true)]
     [Guid("83AFF8E4-C46A-45DB-9D91-2ADB5164545E")]
     [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
diff --git a/src/tests/Interop/COM/ServerContracts/Server.Contracts.h b/src/tests/Interop/COM/ServerContracts/Server.Contracts.h
@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
 {
     IDispatchTesting_Exception_Disp,
     IDispatchTesting_Exception_HResult,
+    IDispatchTesting_Exception_Int,
 };
 
 struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))

Original file line number	Diff line number	Diff line change
`@@ -433,7 +433,8 @@ void CallsiteInspect::PropagateOutParametersBackToCallsite(`
`433`	`433`	`(ARG_SLOT )(frame->GetReturnValuePtr()) = retVal;`
`434`	`434`	`}`
`435`	`435`	`#ifdef ENREGISTERED_RETURNTYPE_MAXSIZE`
`436`		`- else if (argit.HasNonStandardByvalReturn())`
	`436`	`+ else if (argit.HasNonStandardByvalReturn()`
	`437`	`+ && !(flags & CallsiteDetails::HResultReturn))`
`437`	`438`	`{`
`438`	`439`	`// In these cases, put the pointer to the return buffer into`
`439`	`440`	`// the frame's return value slot.`
Original file line number	Diff line number	Diff line change
`@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc`
`364`	`364`	`return 0;`
`365`	`365`	`}`
`366`	`366`
`367`		`-CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)`
	`367`	`+static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)`
`368`	`368`	`{`
`369`	`369`	`CONTRACTL`
`370`	`370`	`{`
`@@ -442,10 +442,20 @@ CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)`
`442`	`442`	`SigTypeContext::InitTypeContext(pMD, actualType, &typeContext);`
`443`	`443`	`}`
`444`	`444`
	`445`	`+ // If the signature is marked preserve sig, then the return`
	`446`	`+ // is required to be an HRESULT, per COM rules. We set a flag to`
	`447`	`+ // indicate this state to avoid issues when a C# developer defines`
	`448`	`+ // an HRESULT in C# as a ValueClass with a single int field. This`
	`449`	`+ // is convenient but does violate the COM ABI. Setting the flag`
	`450`	`+ // lets us permit this convention and allow either a 4 byte primitive`
	`451`	`+ // or the commonly used C# type "struct HResult { int Value; }".`
	`452`	`+ if (IsMiPreserveSig(pMD->GetImplAttrs()))`
	`453`	`+ callsiteFlags \|= CallsiteDetails::HResultReturn;`
	`454`	`+`
`445`	`455`	`_ASSERTE(!signature.IsEmpty() && pModule != nullptr);`
`446`	`456`
`447`	`457`	`// Create details`
`448`		`- return CallsiteDetails{ { signature, pModule, &typeContext }, pFrame, pMD, fIsDelegate };`
	`458`	`+ return CallsiteDetails{ { signature, pModule, &typeContext }, pFrame, pMD, fIsDelegate, callsiteFlags };`
`449`	`459`	`}`
`450`	`460`
`451`	`461`	`UINT32 CLRToCOMLateBoundWorker(`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ public void TriggerException(IDispatchTesting_Exception excep, int errorCode)`
`57`	`57`	`case IDispatchTesting_Exception.Disp:`
`58`	`58`	`throw new Exception();`
`59`	`59`	`case IDispatchTesting_Exception.HResult:`
	`60`	`+ case IDispatchTesting_Exception.Int:`
`60`	`61`	`throw new System.ComponentModel.Win32Exception(errorCode);`
`61`	`62`	`}`
`62`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -243,6 +243,8 @@ class DispatchTesting : public UnknownImpl, public IDispatchTesting`
`243`	`243`	`return DISP_E_EXCEPTION;`
`244`	`244`	`case IDispatchTesting_Exception_HResult:`
`245`	`245`	`return HRESULT_FROM_WIN32(errorCode);`
	`246`	`+ case IDispatchTesting_Exception_Int:`
	`247`	`+ return errorCode;`
`246`	`248`	`default:`
`247`	`249`	`return S_FALSE; // Return a success case to indicate failure to trigger a failure.`
`248`	`250`	`}`
Original file line number	Diff line number	Diff line change
`@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception`
`385`	`385`	`{`
`386`	`386`	`IDispatchTesting_Exception_Disp,`
`387`	`387`	`IDispatchTesting_Exception_HResult,`
	`388`	`+ IDispatchTesting_Exception_Int,`
`388`	`389`	`};`
`389`	`390`
`390`	`391`	`struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))`