Skip to content

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@max-charlamb@davmason
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[cDAC] Support passing global string values by max-charlamb · Pull Request #114085 · dotnet/runtime · GitHub
Skip to content

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@max-charlamb@davmason
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [cDAC] Support passing global string values by max-charlamb · Pull Request #114085 · dotnet/runtime · GitHub
Skip to content

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@max-charlamb@davmason
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); [cDAC] Support passing global string values by max-charlamb · Pull Request #114085 · dotnet/runtime · GitHub
Skip to content

[cDAC] Support passing global string values - #114085

Closed
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings
Closed

[cDAC] Support passing global string values#114085
max-charlamb wants to merge 2 commits into
dotnet:mainfrom
max-charlamb:cdac-strings

Conversation

@max-charlamb

@max-charlambmax-charlamb commented Mar 31, 2025

Copy link
Copy Markdown
Member

Will be used in #113899 to pass target runtime identifier.

To support passing global strings, I have modified the data descriptor spec. Previously globals were of the form

[ VALUE | [int], "type name" ]
or
VALUE | [int]

Where the VALUE may be a JSON numeric constant integer or a string containing a signed or unsigned decimal or hex (with prefix 0x or 0X) integer constant.

I have modified VALUE to be less constrained: VALUE may be either a number or a string. JSON numeric constants are always parsed as numbers. JSON strings are always parsed as strings and may additionally parse as a hex (with prefix 0x or 0X) or decimal number.

To fit the new spec, the cDAC data contract implementation was modified in three main:

  • The datadescriptor.h and datadescriptor.cpp in the runtime.
    • Added mechanism CDAC_GLOBAL_STRING(name, value) to pass global strings which are a mapping of a string (name) to string (value). Both strings exist in the existing string pool.
  • The cdac-build-tool which takes the obj file and converts it to a JSON human readable contract.
    • Modified to parse global strings from the obj and properly convert to JSON.
  • The parser inside of cdacreader which reads the JSON into a Target.
    • Modified to parse global strings and allow fetching existing stringy number globals as strings.

With this change existing stringy numbers can be parsed as either a number or a string.

Example:

{
"globals": {
"stringValue" : "Hello world",
"stringyInt" : "1234",
"stringyHex" : "0x1234",
"int" : 1234
}
}
target.ReadGlobalString("stringValue");// "Hello world"target.ReadGlobal<ulong>("stringValue");// Exception!! cannot be parsed as a numbertarget.ReadGlobalString("stringyInt");// "1234"target.ReadGlobal<ulong>("stringyInt");// 1234target.ReadGlobalString("stringyHex");// "0x1234"target.ReadGlobal<ulong>("stringyHex");// 4660 (0x1234)target.ReadGlobalString("int");// Exception!! no string representation for JSON Numberstarget.ReadGlobal<ulong>("int");// 1234

CopilotAI review requested due to automatic review settings March 31, 2025 21:36
@max-charlamb
max-charlamb requested review from a team and davidwrightonMarch 31, 2025 21:36

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for passing global string values to the data contract reader and descriptor model. Key changes include:

  • Introducing new fields and APIs for global strings in targets and builders.
  • Enhancing test coverage with new tests for reading global string values.
  • Updating the build tool and parser to handle global string specifications in the data descriptor blob.

Reviewed Changes

Copilot reviewed 10 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/native/managed/cdacreader/tests/TestPlaceholderTarget.csAdded global strings field and TryReadGlobalString method.
src/native/managed/cdacreader/tests/ContractDescriptor/TargetTests.csAdded tests to validate global string value reading.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorHelpers.csAdded helper for JSON serialization of global strings.
src/native/managed/cdacreader/tests/ContractDescriptor/ContractDescriptorBuilder.csExtended builder API to include global strings.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorTarget.csIntegrated global strings into target reading.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader/ContractDescriptorParser.csAdded global strings support in JSON serialization and diagnostics.
src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.csDefined abstract TryReadGlobalString method.
src/coreclr/tools/cdac-build-tool/data-descriptor-blob.mdUpdated blob specification to include GlobalStringSpec.
src/coreclr/tools/cdac-build-tool/ObjectFileScraper.csModified header reading and parsing logic to handle global string specs.
src/coreclr/tools/cdac-build-tool/DataDescriptorModel.csExtended descriptor model to incorporate global strings.
Files not reviewed (4)
  • src/coreclr/debug/runtimeinfo/datadescriptor.cpp: Language not supported
  • src/coreclr/debug/runtimeinfo/datadescriptor.h: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.blob.c: Language not supported
  • src/coreclr/tools/cdac-build-tool/sample/sample.data.h: Language not supported

Comment threadsrc/coreclr/tools/cdac-build-tool/ObjectFileScraper.cs Outdated
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

return new GlobalDescriptor { NumericValue = valueCase1, Kind = GlobalDescriptor.KindEnum.Direct };
// Case 2: string
if (TryGetStringFromToken(ref reader, out string valueCase2))
return new GlobalDescriptor { StringValue = valueCase2, Kind = GlobalDescriptor.KindEnum.String };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the algorithm of "try a number, if it fails it is a string." Since we own the spec we should be able to do better. Is there a reason we have to have the implicit string type and can't just use the explicit one?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the type of the json node or the optional string representing the type of the value?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the optional string, could we have a string by itself be a number and only treat it as a string if we add the optional type

@max-charlamb

Copy link
Copy Markdown
MemberAuthor

Closing as this content was combined in #113899

@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 4, 2025
@max-charlamb
max-charlamb deleted the cdac-strings branch August 20, 2025 13:43
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@max-charlamb@davmason