Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} 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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } 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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions docs/design/datacontracts/Exception.md
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
# Contract Thread
# Contract Exception

This contract is for getting information about exceptions in the process.

## APIs of contract

```csharp
record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);
```

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException);
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo);
ExceptionData GetExceptionData(TargetPointer exceptionAddr)
```

## Version 1

Data descriptors used:
- `ExceptionInfo`
- `Exception`

``` csharp
TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
if (exception == TargetPointer.Null)
if (exceptionInfo == TargetPointer.Null)
throw new InvalidArgumentException();

nextNestedException = target.ReadPointer(address + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(address + /* ExceptionInfo::ThrownObject offset */);
nextNestedException = target.ReadPointer(exceptionInfo + /* ExceptionInfo::PreviousNestedInfo offset*/);
TargetPointer thrownObjHandle = target.ReadPointer(exceptionInfo + /* ExceptionInfo::ThrownObject offset */);
return = thrownObjHandle != TargetPointer.Null
? target.ReadPointer(thrownObjHandle)
: TargetPointer.Null;
}

ExceptionData GetExceptionData(TargetPointer exceptionAddr)
{
return new ExceptionData(
target.ReadPointer(exceptionAddr + /* Exception::Message offset */),
target.ReadPointer(exceptionAddr + /* Exception::InnerException offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTrace offset */),
target.ReadPointer(exceptionAddr + /* Exception::WatsonBuckets offset */),
target.ReadPointer(exceptionAddr + /* Exception::StackTraceString offset */),
target.ReadPointer(exceptionAddr + /* Exception::RemoteStackTraceString offset */),
target.Read<int>(exceptionAddr + /* Exception::HResult offset */),
target.Read<int>(exceptionAddr + /* Exception::XCode offset */),
);
}
```
1 change: 1 addition & 0 deletions src/coreclr/debug/daccess/daccess.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -5512,6 +5512,7 @@ ClrDataAccess::Initialize(void)
// Get SOS interfaces from the cDAC if available.
IUnknown* unk = m_cdac.SosInterface();
(void)unk->QueryInterface(__uuidof(ISOSDacInterface), (void**)&m_cdacSos);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface2), (void**)&m_cdacSos2);
(void)unk->QueryInterface(__uuidof(ISOSDacInterface9), (void**)&m_cdacSos9);
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/coreclr/debug/daccess/dacimpl.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -1234,6 +1234,7 @@ class ClrDataAccess
HRESULT GetNestedExceptionDataImpl(CLRDATA_ADDRESS exception, CLRDATA_ADDRESS *exceptionObject, CLRDATA_ADDRESS *nextNestedException);
HRESULT GetMethodTableDataImpl(CLRDATA_ADDRESS mt, struct DacpMethodTableData *data);
HRESULT GetMethodTableForEEClassImpl (CLRDATA_ADDRESS eeClassReallyMT, CLRDATA_ADDRESS *value);
HRESULT GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data);

BOOL IsExceptionFromManagedCode(EXCEPTION_RECORD * pExceptionRecord);
#ifndef TARGET_UNIX
Expand DownExpand Up@@ -1423,6 +1424,7 @@ class ClrDataAccess

CDAC m_cdac;
NonVMComHolder<ISOSDacInterface> m_cdacSos;
NonVMComHolder<ISOSDacInterface2> m_cdacSos2;
NonVMComHolder<ISOSDacInterface9> m_cdacSos9;

#ifdef FEATURE_MINIMETADATA_IN_TRIAGEDUMPS
Expand Down
41 changes: 36 additions & 5 deletions src/coreclr/debug/daccess/request.cpp
Original file line numberDiff line numberDiff line change
Expand Up@@ -4600,8 +4600,42 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da

SOSDacEnter();

PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
if (m_cdacSos2 != NULL)
{
hr = m_cdacSos2->GetObjectExceptionData(objAddr, data);
if (FAILED(hr))
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}
#ifdef _DEBUG
else
{
DacpExceptionObjectData dataLocal;
HRESULT hrLocal = GetObjectExceptionDataImpl(objAddr, &dataLocal);
_ASSERTE(hr == hrLocal);
_ASSERTE(data->Message == dataLocal.Message);
_ASSERTE(data->InnerException == dataLocal.InnerException);
_ASSERTE(data->StackTrace == dataLocal.StackTrace);
_ASSERTE(data->WatsonBuckets == dataLocal.WatsonBuckets);
_ASSERTE(data->StackTraceString == dataLocal.StackTraceString);
_ASSERTE(data->RemoteStackTraceString == dataLocal.RemoteStackTraceString);
_ASSERTE(data->HResult == dataLocal.HResult);
_ASSERTE(data->XCode == dataLocal.XCode);
}
#endif
}
else
{
hr = GetObjectExceptionDataImpl(objAddr, data);
}

SOSDacLeave();
return hr;
}

HRESULT ClrDataAccess::GetObjectExceptionDataImpl(CLRDATA_ADDRESS objAddr, struct DacpExceptionObjectData *data)
{
PTR_ExceptionObject pObj = dac_cast<PTR_ExceptionObject>(TO_TADDR(objAddr));
data->Message = TO_CDADDR(dac_cast<TADDR>(pObj->GetMessage()));
data->InnerException = TO_CDADDR(dac_cast<TADDR>(pObj->GetInnerException()));
data->StackTrace = TO_CDADDR(dac_cast<TADDR>(pObj->GetStackTraceArrayObject()));
Expand All@@ -4610,10 +4644,7 @@ HRESULT ClrDataAccess::GetObjectExceptionData(CLRDATA_ADDRESS objAddr, struct Da
data->RemoteStackTraceString = TO_CDADDR(dac_cast<TADDR>(pObj->GetRemoteStackTraceString()));
data->HResult = pObj->GetHResult();
data->XCode = pObj->GetXCode();

SOSDacLeave();

return hr;
return S_OK;
}

HRESULT ClrDataAccess::IsRCWDCOMProxy(CLRDATA_ADDRESS rcwAddr, BOOL* isDCOMProxy)
Expand Down
16 changes: 16 additions & 0 deletions src/coreclr/debug/runtimeinfo/datadescriptor.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,21 @@ CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Pointer, offsetof(gc_alloc_context,
CDAC_TYPE_FIELD(GCAllocContext, /*pointer*/, Limit, offsetof(gc_alloc_context, alloc_limit))
CDAC_TYPE_END(GCAllocContext)

// Exception

// Use exact managed type field names for the descriptor as field names often can't change due to binary serialization or implicit diagnostic contracts
CDAC_TYPE_BEGIN(Exception)
CDAC_TYPE_INDETERMINATE(Exception)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _message, cdac_offsets<ExceptionObject>::_message)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _innerException, cdac_offsets<ExceptionObject>::_innerException)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTrace, cdac_offsets<ExceptionObject>::_stackTrace)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _watsonBuckets, cdac_offsets<ExceptionObject>::_watsonBuckets)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _stackTraceString, cdac_offsets<ExceptionObject>::_stackTraceString)
CDAC_TYPE_FIELD(Exception, /*pointer*/, _remoteStackTraceString, cdac_offsets<ExceptionObject>::_remoteStackTraceString)
CDAC_TYPE_FIELD(Exception, /*int32*/, _HResult, cdac_offsets<ExceptionObject>::_HResult)
CDAC_TYPE_FIELD(Exception, /*int32*/, _xcode, cdac_offsets<ExceptionObject>::_xcode)
CDAC_TYPE_END(Exception)

CDAC_TYPE_BEGIN(ExceptionInfo)
CDAC_TYPE_INDETERMINATE(ExceptionInfo)
#if FEATURE_EH_FUNCLETS
Expand All@@ -152,6 +167,7 @@ CDAC_TYPE_FIELD(PreviousNestedInfo, /*pointer*/, PreviousNestedInfo, offsetof(Ex
#endif
CDAC_TYPE_END(ExceptionInfo)


CDAC_TYPE_BEGIN(GCHandle)
CDAC_TYPE_SIZE(sizeof(OBJECTHANDLE))
CDAC_TYPE_END(GCHandle)
Expand Down
17 changes: 16 additions & 1 deletion src/coreclr/vm/object.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -2096,7 +2096,7 @@ class LoaderAllocatorObject : public Object
INT32 GetSlotsUsed();
void SetSlotsUsed(INT32 newSlotsUsed);
#endif // DACCESS_COMPILE

void SetNativeLoaderAllocator(LoaderAllocator * pLoaderAllocator)
{
LIMITED_METHOD_CONTRACT;
Expand DownExpand Up@@ -2340,6 +2340,21 @@ class ExceptionObject : public Object
void* _xptrs;
INT32 _xcode;
INT32 _HResult;

template<typename T> friend struct ::cdac_offsets;
};

template<>
struct cdac_offsets<ExceptionObject>
{
static constexpr size_t _message = offsetof(ExceptionObject, _message);
static constexpr size_t _innerException = offsetof(ExceptionObject, _innerException);
static constexpr size_t _stackTrace = offsetof(ExceptionObject, _stackTrace);
static constexpr size_t _watsonBuckets = offsetof(ExceptionObject, _watsonBuckets);
static constexpr size_t _stackTraceString = offsetof(ExceptionObject, _stackTraceString);
static constexpr size_t _remoteStackTraceString = offsetof(ExceptionObject, _remoteStackTraceString);
static constexpr size_t _HResult = offsetof(ExceptionObject, _HResult);
static constexpr size_t _xcode = offsetof(ExceptionObject, _xcode);
};

// Defined in Contracts.cs
Expand Down
13 changes: 12 additions & 1 deletion src/native/managed/cdacreader/src/Contracts/Exception.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,16 @@

namespace Microsoft.Diagnostics.DataContractReader.Contracts;

internal record struct ExceptionData(
TargetPointer Message,
TargetPointer InnerException,
TargetPointer StackTrace,
TargetPointer WatsonBuckets,
TargetPointer StackTraceString,
TargetPointer RemoteStackTraceString,
int HResult,
int XCode);

internal interface IException : IContract
{
static string IContract.Name { get; } = nameof(Exception);
Expand All@@ -17,7 +27,8 @@ static IContract IContract.Create(Target target, int version)
};
}

public virtual TargetPointer GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual TargetPointer GetNestedExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException) => throw new NotImplementedException();
public virtual ExceptionData GetExceptionData(TargetPointer managedException) => throw new NotImplementedException();
}

internal readonly struct Exception : IException
Expand Down
20 changes: 17 additions & 3 deletions src/native/managed/cdacreader/src/Contracts/Exception_1.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,24 @@ internal Exception_1(Target target)
_target = target;
}

TargetPointer IException.GetExceptionInfo(TargetPointer exception, out TargetPointer nextNestedException)
TargetPointer IException.GetNestedExceptionInfo(TargetPointer exceptionInfoAddr, out TargetPointer nextNestedExceptionInfo)
{
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exception);
nextNestedException = exceptionInfo.PreviousNestedInfo;
Data.ExceptionInfo exceptionInfo = _target.ProcessedData.GetOrAdd<Data.ExceptionInfo>(exceptionInfoAddr);
nextNestedExceptionInfo = exceptionInfo.PreviousNestedInfo;
return exceptionInfo.ThrownObject.Object;
}

ExceptionData IException.GetExceptionData(TargetPointer exceptionAddr)
{
Data.Exception exception = _target.ProcessedData.GetOrAdd<Data.Exception>(exceptionAddr);
return new ExceptionData(
exception.Message,
exception.InnerException,
exception.StackTrace,
exception.WatsonBuckets,
exception.StackTraceString,
exception.RemoteStackTraceString,
exception.HResult,
exception.XCode);
}
}
33 changes: 33 additions & 0 deletions src/native/managed/cdacreader/src/Data/Exception.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.Diagnostics.DataContractReader.Data;

internal sealed class Exception : IData<Exception>
{
static Exception IData<Exception>.Create(Target target, TargetPointer address)
=> new Exception(target, address);

public Exception(Target target, TargetPointer address)
{
Target.TypeInfo type = target.GetTypeInfo(DataType.Exception);

Message = target.ReadPointer(address + (ulong)type.Fields["_message"].Offset);
InnerException = target.ReadPointer(address + (ulong)type.Fields["_innerException"].Offset);
StackTrace = target.ReadPointer(address + (ulong)type.Fields["_stackTrace"].Offset);
WatsonBuckets = target.ReadPointer(address + (ulong)type.Fields["_watsonBuckets"].Offset);
StackTraceString = target.ReadPointer(address + (ulong)type.Fields["_stackTraceString"].Offset);
RemoteStackTraceString = target.ReadPointer(address + (ulong)type.Fields["_remoteStackTraceString"].Offset);
HResult = target.Read<int>(address + (ulong)type.Fields["_HResult"].Offset);
XCode = target.Read<int>(address + (ulong)type.Fields["_xcode"].Offset);
}

public TargetPointer Message { get; init; }
public TargetPointer InnerException { get; init; }
public TargetPointer StackTrace { get; init; }
public TargetPointer WatsonBuckets { get; init; }
public TargetPointer StackTraceString { get; init; }
public TargetPointer RemoteStackTraceString { get; init; }
public int HResult { get; init; }
public int XCode { get; init; }
}
1 change: 1 addition & 0 deletions src/native/managed/cdacreader/src/DataType.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ public enum DataType
Thread,
ThreadStore,
GCAllocContext,
Exception,
ExceptionInfo,
RuntimeThreadLocals,

Expand Down
24 changes: 24 additions & 0 deletions src/native/managed/cdacreader/src/Legacy/ISOSDacInterface.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,6 +304,30 @@ internal unsafe partial interface ISOSDacInterface
int GetFailedAssemblyDisplayName(ulong assembly, uint count, char* name, uint* pNeeded);
};

#pragma warning disable CS0649 // Field is never assigned to, and will always have its default value
internal struct DacpExceptionObjectData
{
public ulong Message;
public ulong InnerException;
public ulong StackTrace;
public ulong WatsonBuckets;
public ulong StackTraceString;
public ulong RemoteStackTraceString;
public int HResult;
public int XCode;
}
#pragma warning restore CS0649 // Field is never assigned to, and will always have its default value

[GeneratedComInterface]
[Guid("A16026EC-96F4-40BA-87FB-5575986FB7AF")]
internal unsafe partial interface ISOSDacInterface2
{
[PreserveSig]
int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data);
[PreserveSig]
int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy);
}

[GeneratedComInterface]
[Guid("4eca42d8-7e7b-4c8a-a116-7bfbf6929267")]
internal partial interface ISOSDacInterface9
Expand Down
29 changes: 27 additions & 2 deletions src/native/managed/cdacreader/src/Legacy/SOSDacImpl.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ namespace Microsoft.Diagnostics.DataContractReader.Legacy;
/// corresponding error code.
/// </remarks>
[GeneratedComClass]
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface9
internal sealed partial class SOSDacImpl : ISOSDacInterface, ISOSDacInterface2, ISOSDacInterface9
{
private readonly Target _target;

Expand DownExpand Up@@ -158,7 +158,7 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject
try
{
Contracts.IException contract = _target.Contracts.Exception;
TargetPointer exceptionObjectLocal = contract.GetExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
TargetPointer exceptionObjectLocal = contract.GetNestedExceptionInfo(exception, out TargetPointer nextNestedExceptionLocal);
*exceptionObject = exceptionObjectLocal;
*nextNestedException = nextNestedExceptionLocal;
}
Expand All@@ -172,6 +172,30 @@ public unsafe int GetNestedExceptionData(ulong exception, ulong* exceptionObject

public unsafe int GetObjectClassName(ulong obj, uint count, char* className, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetObjectData(ulong objAddr, void* data) => HResults.E_NOTIMPL;

public unsafe int GetObjectExceptionData(ulong objectAddress, DacpExceptionObjectData* data)
{
try
{
Contracts.IException contract = _target.Contracts.Exception;
Contracts.ExceptionData exceptionData = contract.GetExceptionData(objectAddress);
data->Message = exceptionData.Message;
data->InnerException = exceptionData.InnerException;
data->StackTrace = exceptionData.StackTrace;
data->WatsonBuckets = exceptionData.WatsonBuckets;
data->StackTraceString = exceptionData.StackTraceString;
data->RemoteStackTraceString = exceptionData.RemoteStackTraceString;
data->HResult = exceptionData.HResult;
data->XCode = exceptionData.XCode;
}
catch (Exception ex)
{
return ex.HResult;
}

return HResults.S_OK;
}

public unsafe int GetObjectStringData(ulong obj, uint count, char* stringData, uint* pNeeded) => HResults.E_NOTIMPL;
public unsafe int GetOOMData(ulong oomAddr, void* data) => HResults.E_NOTIMPL;
public unsafe int GetOOMStaticData(void* data) => HResults.E_NOTIMPL;
Expand DownExpand Up@@ -255,6 +279,7 @@ public unsafe int GetThreadStoreData(DacpThreadStoreData* data)
public unsafe int GetTLSIndex(uint* pIndex) => HResults.E_NOTIMPL;
public unsafe int GetUsefulGlobals(void* data) => HResults.E_NOTIMPL;
public unsafe int GetWorkRequestData(ulong addrWorkRequest, void* data) => HResults.E_NOTIMPL;
public unsafe int IsRCWDCOMProxy(ulong rcwAddress, int* inDCOMProxy) => HResults.E_NOTIMPL;
public unsafe int TraverseEHInfo(ulong ip, void* pCallback, void* token) => HResults.E_NOTIMPL;
public unsafe int TraverseLoaderHeap(ulong loaderHeapAddr, void* pCallback) => HResults.E_NOTIMPL;
public unsafe int TraverseModuleMap(int mmt, ulong moduleAddr, void* pCallback, void* token) => HResults.E_NOTIMPL;
Expand Down