IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AaronRobinsonMSFT merged 4 commits into from
Sep 22, 2023
Merged

IDispatch should accept HRESULT as valuetype #92447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45db259
IDispatch should accept HRESULT as valuetype
AaronRobinsonMSFT Sep 21, 2023
1bb47b6
Ensure vtables line up for early bound.
AaronRobinsonMSFT Sep 22, 2023
d4e5b21
Add larger comment to workaround.
AaronRobinsonMSFT Sep 22, 2023
635c52c
Comment
AaronRobinsonMSFT Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/coreclr/vm/callsiteinspect.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down
1 change: 1 addition & 0 deletions src/coreclr/vm/callsiteinspect.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
BeginInvoke = 0x01,
EndInvoke = 0x02,
Ctor = 0x04,
HResultReturn = 0x08,
};
INT32 Flags;
};
Expand Down
14 changes: 12 additions & 2 deletions src/coreclr/vm/clrtocomcall.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
CONTRACTL
{
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.
}

UINT32 CLRToCOMLateBoundWorker(
Expand Down
15 changes: 15 additions & 0 deletions src/tests/Interop/COM/NETClients/IDispatch/Program.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down
1 change: 1 addition & 0 deletions src/tests/Interop/COM/NETServer/DispatchTesting.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/tests/Interop/COM/NativeServer/DispatchTesting.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
}
Expand Down
33 changes: 33 additions & 0 deletions src/tests/Interop/COM/ServerContracts/Server.Contracts.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
{
Disp,
HResult,
Int,
}

[StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down
1 change: 1 addition & 0 deletions src/tests/Interop/COM/ServerContracts/Server.Contracts.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
IDispatchTesting_Exception_Disp,
IDispatchTesting_Exception_HResult,
IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
IDispatch should accept HRESULT as valuetype#92447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AaronRobinsonMSFT
merged 4 commits into

from

Sep 22, 2023
 Merged

IDispatch should accept HRESULT as valuetype
#92447
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45db259

IDispatch should accept HRESULT as valuetype


AaronRobinsonMSFT Sep 21, 2023
1bb47b6

Ensure vtables line up for early bound.


AaronRobinsonMSFT Sep 22, 2023
d4e5b21

Add larger comment to workaround.


AaronRobinsonMSFT Sep 22, 2023
635c52c

Comment


AaronRobinsonMSFT Sep 22, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 2 additions & 1 deletion
src/coreclr/vm/callsiteinspect.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

1 change: 1 addition & 0 deletions
src/coreclr/vm/callsiteinspect.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ struct CallsiteDetails
 BeginInvoke = 0x01,
 EndInvoke = 0x02,
 Ctor = 0x04,
 HResultReturn = 0x08,
 };
 INT32 Flags;
};
Expand Down

14 changes: 12 additions & 2 deletions
src/coreclr/vm/clrtocomcall.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -364,7 +364,7 @@ UINT32 CLRToCOMEventCallWorker(ComPlusMethodFrame* pFrame, ComPlusCallMethodDesc
 return 0;
}

CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
static CallsiteDetails CreateCallsiteDetails(_In_ FramedMethodFrame *pFrame)
{
 CONTRACTL
 {
Expand DownExpand Up@@ -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 };
Comment thread
AaronRobinsonMSFT marked this conversation as resolved.

}

UINT32 CLRToCOMLateBoundWorker(
Expand Down

15 changes: 15 additions & 0 deletions
src/tests/Interop/COM/NETClients/IDispatch/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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()
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/NETServer/DispatchTesting.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
 }
 }
Expand Down

2 changes: 2 additions & 0 deletions
src/tests/Interop/COM/NativeServer/DispatchTesting.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
 }
Expand Down

33 changes: 33 additions & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,7 @@ public enum IDispatchTesting_Exception
 {
 Disp,
 HResult,
 Int,
 }

 [StructLayout(LayoutKind.Sequential)]
Expand All@@ -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)]
Expand DownExpand Up@@ -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)]
Expand Down

1 change: 1 addition & 0 deletions
src/tests/Interop/COM/ServerContracts/Server.Contracts.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,6 +385,7 @@ enum IDispatchTesting_Exception
{
 IDispatchTesting_Exception_Disp,
 IDispatchTesting_Exception_HResult,
 IDispatchTesting_Exception_Int,
};

struct __declspec(uuid("a5e04c1c-474e-46d2-bbc0-769d04e12b54"))
Expand Down