[cdac] Read contract descriptor from target#101208

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
elinor-fung merged 9 commits into from
Apr 22, 2024
Merged

[cdac] Read contract descriptor from target #101208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9fdbbe7
Pass DotNetRuntimeContractDescriptor address to cdac
elinor-fung Apr 16, 2024
8db6283
Read contract descriptor from target
elinor-fung Apr 17, 2024
80af170
Add threshold for stackalloc when reading descriptor
elinor-fung Apr 17, 2024
faa1722
Use UTF-8 literals
elinor-fung Apr 18, 2024
85ffbda
Parse JSON and store the contracts
lambdageek Apr 17, 2024
c215266
Only use cDAC on platforms where we implement functionality to get an…
elinor-fung Apr 19, 2024
7468518
Use DynamicDependency attribute instead of xml file
elinor-fung Apr 19, 2024
1dee369
Fix reading from target after initialization
elinor-fung Apr 20, 2024
5e6fbb0
Better target initialization
elinor-fung Apr 22, 2024
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
20 changes: 8 additions & 12 deletions src/coreclr/debug/daccess/cdac.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
{
CDAC* cdac = reinterpret_cast<CDAC*>(context);
return cdac->ReadFromTarget(addr, dest, count);
ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
if (FAILED(hr))
return hr;

return S_OK;
}
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
return;
}

m_target->AddRef();
decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
_ASSERTE(init != nullptr && getSosInterface != nullptr);

init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
if (FAILED(hr))
return hr;

return S_OK;
}
7 changes: 3 additions & 4 deletions src/coreclr/debug/daccess/cdac.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
CDAC(CDAC&& other)
: m_module{ other.m_module }
, m_cdac_handle{ other.m_cdac_handle }
, m_target{ other.m_target }
, m_target{ other.m_target.Extract() }
, m_sos{ other.m_sos.Extract() }
{
other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
{
m_module = other.m_module;
m_cdac_handle = other.m_cdac_handle;
m_target = other.m_target;
m_target = other.m_target.Extract();
m_sos = other.m_sos.Extract();

other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

// This does not AddRef the returned interface
IUnknown* SosInterface();
int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
HMODULE m_module;
intptr_t m_cdac_handle;
ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
NonVMComHolder<IUnknown> m_sos;
};

Expand Down
10 changes: 7 additions & 3 deletions src/coreclr/debug/daccess/daccess.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
IfFailRet(GetDacGlobalValues());
IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
if (enable.IsSet())
{
DWORD val;
if (enable.TryAsInteger(10, val) && val == 1)
{
// TODO: [cdac] Get contract descriptor from exported symbol
uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
{
m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
}
}
}
#endif

//
// DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
return E_INVALIDARG;
}
#endif
// On MacOS, FreeBSD or NetBSD use the RVA include file
// On FreeBSD, NetBSD, or SunOS use the RVA include file
*dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.
#else
// Otherwise, try to get the dac table address via the export symbol
Expand Down
21 changes: 18 additions & 3 deletions src/native/managed/cdacreader/src/ContractDescriptorParser.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
/// <summary>
/// Parses the "compact" representation of a contract descriptor.
/// </summary>
// Workaround for https://github.com/dotnet/runtime/issues/101205
[DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
{
return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
}

[JsonSerializable(typeof(ContractDescriptor))]
[JsonSerializable(typeof(int))]
[JsonSerializable(typeof(int?))]
[JsonSerializable(typeof(string))]
[JsonSerializable(typeof(Dictionary<string, int>))]
[JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
[JsonSerializable(typeof(TypeDescriptor))]
[JsonSerializable(typeof(FieldDescriptor))]
[JsonSerializable(typeof(GlobalDescriptor))]
[JsonSerializable(typeof(Dictionary<string, JsonElement>))]
[JsonSourceGenerationOptions(AllowTrailingCommas = true,
DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
NumberHandling = JsonNumberHandling.AllowReadingFromString,
ReadCommentHandling = JsonCommentHandling.Skip)]
ReadCommentHandling = JsonCommentHandling.Skip,
UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
Converters = [typeof(TypeDescriptorConverter),
typeof(FieldDescriptorConverter),
typeof(GlobalDescriptorConverter)])]
internal sealed partial class ContractDescriptorContext : JsonSerializerContext
{
}
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

[JsonExtensionData]
public Dictionary<string, object?>? Extras { get; set; }
public Dictionary<string, JsonElement>? Extras { get; set; }

public override string ToString()
{
return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
}

}

[JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down
5 changes: 4 additions & 1 deletion src/native/managed/cdacreader/src/Entrypoints.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
[UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
{
Target target = new(descriptor, readFromTarget, readContext);
// TODO: [cdac] Better error code/details
if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
return -1;

GCHandle gcHandle = GCHandle.Alloc(target);
*handle = GCHandle.ToIntPtr(gcHandle);
return 0;
Expand Down
12 changes: 12 additions & 0 deletions src/native/managed/cdacreader/src/Root.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
// https://github.com/dotnet/runtime/issues/101205
public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading
, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading

, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading

, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading

, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading

, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading

, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading

, '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
[cdac] Read contract descriptor from target#101208

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

elinor-fung
merged 9 commits into

from

Apr 22, 2024
 Merged


[cdac] Read contract descriptor from target
#101208
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
9fdbbe7

Pass DotNetRuntimeContractDescriptor address to cdac


elinor-fung Apr 16, 2024
8db6283

Read contract descriptor from target


elinor-fung Apr 17, 2024
80af170

Add threshold for stackalloc when reading descriptor


elinor-fung Apr 17, 2024
faa1722

Use UTF-8 literals


elinor-fung Apr 18, 2024
85ffbda

Parse JSON and store the contracts


lambdageek Apr 17, 2024
c215266

Only use cDAC on platforms where we implement functionality to get an…


elinor-fung Apr 19, 2024
7468518

Use DynamicDependency attribute instead of xml file


elinor-fung Apr 19, 2024
1dee369

Fix reading from target after initialization


elinor-fung Apr 20, 2024
5e6fbb0

Better target initialization


elinor-fung Apr 22, 2024

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


20 changes: 8 additions & 12 deletions
src/coreclr/debug/daccess/cdac.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,12 @@ namespace

 int ReadFromTargetCallback(uint64_t addr, uint8_t* dest, uint32_t count, void* context)
 {
 CDAC* cdac = reinterpret_cast<CDAC*>(context);
 return cdac->ReadFromTarget(addr, dest, count);
 ICorDebugDataTarget* target = reinterpret_cast<ICorDebugDataTarget*>(context);
 HRESULT hr = ReadFromDataTarget(target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
 }
}

Expand All@@ -52,11 +56,12 @@ CDAC::CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target)
 return;
 }

 m_target->AddRef();
 decltype(&cdac_reader_init) init = reinterpret_cast<decltype(&cdac_reader_init)>(::GetProcAddress(m_module, "cdac_reader_init"));
 decltype(&cdac_reader_get_sos_interface) getSosInterface = reinterpret_cast<decltype(&cdac_reader_get_sos_interface)>(::GetProcAddress(m_module, "cdac_reader_get_sos_interface"));
 _ASSERTE(init != nullptr && getSosInterface != nullptr);

 init(descriptorAddr, &ReadFromTargetCallback, this, &m_cdac_handle);
 init(descriptorAddr, &ReadFromTargetCallback, m_target, &m_cdac_handle);
 getSosInterface(m_cdac_handle, &m_sos);
}

Expand All@@ -77,12 +82,3 @@ IUnknown* CDAC::SosInterface()
{
 return m_sos;
}

int CDAC::ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count)
{
 HRESULT hr = ReadFromDataTarget(m_target, addr, dest, count);
 if (FAILED(hr))
 return hr;

 return S_OK;
}

7 changes: 3 additions & 4 deletions
src/coreclr/debug/daccess/cdac.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ class CDAC final
 CDAC(CDAC&& other)
 : m_module{ other.m_module }
 , m_cdac_handle{ other.m_cdac_handle }
 , m_target{ other.m_target }
 , m_target{ other.m_target.Extract() }
 , m_sos{ other.m_sos.Extract() }
 {
 other.m_module = NULL;
Expand All@@ -34,7 +34,7 @@ class CDAC final
 {
 m_module = other.m_module;
 m_cdac_handle = other.m_cdac_handle;
 m_target = other.m_target;
 m_target = other.m_target.Extract();
 m_sos = other.m_sos.Extract();

 other.m_module = NULL;
Expand All@@ -54,15 +54,14 @@ class CDAC final

 // This does not AddRef the returned interface
 IUnknown* SosInterface();
 int ReadFromTarget(uint64_t addr, uint8_t* dest, uint32_t count);

private:
 CDAC(HMODULE module, uint64_t descriptorAddr, ICorDebugDataTarget* target);

private:
 HMODULE m_module;
 intptr_t m_cdac_handle;
 ICorDebugDataTarget* m_target;
NonVMComHolder<ICorDebugDataTarget> m_target;
 NonVMComHolder<IUnknown> m_sos;
};

Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/debug/daccess/daccess.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,8 @@
#include <dactablerva.h>
#else
extern "C" bool TryGetSymbol(ICorDebugDataTarget* dataTarget, uint64_t baseAddress, const char* symbolName, uint64_t* symbolAddress);
// cDAC depends on symbol lookup to find the contract descriptor
#define CAN_USE_CDAC
#endif

#include "dwbucketmanager.hpp"
Expand DownExpand Up@@ -5493,15 +5495,16 @@ ClrDataAccess::Initialize(void)
 IfFailRet(GetDacGlobalValues());
 IfFailRet(DacGetHostVtPtrs());

// TODO: [cdac] TryGetSymbol is only implemented for Linux, OSX, and Windows.
#ifdef CAN_USE_CDAC
 CLRConfigNoCache enable = CLRConfigNoCache::Get("ENABLE_CDAC");
 if (enable.IsSet())
 {
 DWORD val;
 if (enable.TryAsInteger(10, val) && val == 1)
 {
 // TODO: [cdac] Get contract descriptor from exported symbol
 uint64_t contractDescriptorAddr = 0;
//if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 if (TryGetSymbol(m_pTarget, m_globalBase, "DotNetRuntimeContractDescriptor", &contractDescriptorAddr))
 {
 m_cdac = CDAC::Create(contractDescriptorAddr, m_pTarget);
 if (m_cdac.IsValid())
Expand All@@ -5514,6 +5517,7 @@ ClrDataAccess::Initialize(void)
 }
 }
 }
#endif

 //
 // DAC is now setup and ready to use
Expand DownExpand Up@@ -6946,7 +6950,7 @@ GetDacTableAddress(ICorDebugDataTarget* dataTarget, ULONG64 baseAddress, PULONG6
 return E_INVALIDARG;
 }
#endif
 // On MacOS, FreeBSD or NetBSD use the RVA include file
 // On FreeBSD, NetBSD, or SunOS use the RVA include file
 *dacTableAddress = baseAddress + DAC_TABLE_RVA;
Comment thread
mikem8361 marked this conversation as resolved.

#else
 // Otherwise, try to get the dac table address via the export symbol
Expand Down

21 changes: 18 additions & 3 deletions
src/native/managed/cdacreader/src/ContractDescriptorParser.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text.Json;
using System.Text.Json.Serialization;
Expand All@@ -23,13 +24,15 @@ public partial class ContractDescriptorParser
 /// <summary>
 /// Parses the "compact" representation of a contract descriptor.
 /// </summary>
 // Workaround for https://github.com/dotnet/runtime/issues/101205
 [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(Root))]
 public static ContractDescriptor? ParseCompact(ReadOnlySpan<byte> json)
 {
 return JsonSerializer.Deserialize(json, ContractDescriptorContext.Default.ContractDescriptor);
 }

 [JsonSerializable(typeof(ContractDescriptor))]
 [JsonSerializable(typeof(int))]
 [JsonSerializable(typeof(int?))]
 [JsonSerializable(typeof(string))]
 [JsonSerializable(typeof(Dictionary<string, int>))]
 [JsonSerializable(typeof(Dictionary<string, TypeDescriptor>))]
Expand All@@ -38,11 +41,17 @@ public partial class ContractDescriptorParser
 [JsonSerializable(typeof(TypeDescriptor))]
 [JsonSerializable(typeof(FieldDescriptor))]
 [JsonSerializable(typeof(GlobalDescriptor))]
 [JsonSerializable(typeof(Dictionary<string, JsonElement>))]
 [JsonSourceGenerationOptions(AllowTrailingCommas = true,
 DictionaryKeyPolicy = JsonKnownNamingPolicy.Unspecified, // contracts, types and globals are case sensitive
 PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
 NumberHandling = JsonNumberHandling.AllowReadingFromString,
 ReadCommentHandling = JsonCommentHandling.Skip)]
 ReadCommentHandling = JsonCommentHandling.Skip,
 UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
 UnknownTypeHandling = JsonUnknownTypeHandling.JsonElement,
 Converters = [typeof(TypeDescriptorConverter),
 typeof(FieldDescriptorConverter),
 typeof(GlobalDescriptorConverter)])]
 internal sealed partial class ContractDescriptorContext : JsonSerializerContext
 {
 }
Expand All@@ -58,7 +67,13 @@ public class ContractDescriptor
 public Dictionary<string, GlobalDescriptor>? Globals { get; set; }

 [JsonExtensionData]
 public Dictionary<string, object?>? Extras { get; set; }
 public Dictionary<string, JsonElement>? Extras { get; set; }

 public override string ToString()
 {
 return $"Version: {Version}, Baseline: {Baseline}, Contracts: {Contracts?.Count}, Types: {Types?.Count}, Globals: {Globals?.Count}";
 }

 }

 [JsonConverter(typeof(TypeDescriptorConverter))]
Expand Down

5 changes: 4 additions & 1 deletion
src/native/managed/cdacreader/src/Entrypoints.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,10 @@ internal static class Entrypoints
 [UnmanagedCallersOnly(EntryPoint = $"{CDAC}init")]
 private static unsafe int Init(ulong descriptor, delegate* unmanaged<ulong, byte*, uint, void*, int> readFromTarget, void* readContext, IntPtr* handle)
 {
 Target target = new(descriptor, readFromTarget, readContext);
 // TODO: [cdac] Better error code/details
 if (!Target.TryCreate(descriptor, readFromTarget, readContext, out Target? target))
 return -1;

 GCHandle gcHandle = GCHandle.Alloc(target);
 *handle = GCHandle.ToIntPtr(gcHandle);
 return 0;
Expand Down

12 changes: 12 additions & 0 deletions
src/native/managed/cdacreader/src/Root.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Serialization;

namespace Microsoft.Diagnostics.DataContractReader;

internal static class Root
{
 // https://github.com/dotnet/runtime/issues/101205
 public static JsonDerivedTypeAttribute[] R1 = new JsonDerivedTypeAttribute[] { null! };
}
Loading