[cdac] Create transport package and rename the cdac reader #114812

steveisok · 2025-04-18T02:49:00Z

This change adds new cdac transport packages that are built for Windows, MacOS, and Linux. Each package contains a host specific native cdac library that is meant to ride along with various diagnostics tools.

The cdacreader was also renamed to cdac as part of this change. I picked what I thought was the best suggestion in #108720 (comment). Feel free to make alternate suggestions.

Contributes to #108720

… name

Copilot

Pull Request Overview

This PR introduces new cdac transport packages for Windows, MacOS, and Linux and renames the cdacreader to cdac.

Updated comments and macro definitions in native library code to reflect the new cdac naming
Adjusted pipeline build arguments and subset names across YAML configuration files to align with the renaming

Reviewed Changes

Copilot reviewed 231 out of 237 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/coreclr/debug/daccess/dacimpl.h	Updated comments to refer to cdac instead of cdacreader
src/coreclr/debug/daccess/cdac.cpp	Renamed macro definition and updated associated comments
eng/pipelines/runtime.yml	Revised build arguments to use tools.cdac and tools.cdactests
eng/pipelines/runtime-diagnostics.yml	Modified build arguments to reference the updated cdac nomenclature
eng/pipelines/common/evaluate-default-paths.yml	Changed subset and include paths to reference cdac instead of cdacreader

Files not reviewed (6)

Directory.Build.props: Language not supported
eng/Subsets.props: Language not supported
eng/liveBuilds.targets: Language not supported
src/coreclr/debug/daccess/CMakeLists.txt: Language not supported
src/installer/pkg/projects/Microsoft.DotNet.CDac.Transport/Microsoft.DotNet.CDac.Transport.pkgproj: Language not supported
src/installer/pkg/projects/cdac-packages.proj: Language not supported

jkotas · 2025-04-18T15:15:47Z

The cdacreader was also renamed to cdac as part of this change

The namespace used by cdac is Microsoft.Diagnostics.DataContractReader. If we are renaming it, it would be nice to make the native binary name to be aligned with the namespace and APIs names to make the connection clear.

steveisok · 2025-04-18T16:15:52Z

The cdacreader was also renamed to cdac as part of this change

The namespace used by cdac is Microsoft.Diagnostics.DataContractReader. If we are renaming it, it would be nice to make the native binary name to be aligned with the namespace and APIs names to make the connection clear.

I considered that initially and figured I would wait to see how others felt before going there. Thanks for the feedback.

mikem8361 · 2025-04-19T19:50:04Z

I can't tell from the changes but does the resulting package contain all the platform/architecture builds of the cda modules under a rid subdirectory? Something like tools/win-x64/cdac.dll, tools/linux-x64/libcdac.so, tools/osx-arm64/libcdac.dylib, etc.

steveisok · 2025-04-20T01:05:57Z

I can't tell from the changes but does the resulting package contain all the platform/architecture builds of the cda modules under a rid subdirectory? Something like tools/win-x64/cdac.dll, tools/linux-x64/libcdac.so, tools/osx-arm64/libcdac.dylib, etc.

Yeah, it'll be runtimes/<rid>/native, but looking at that again it probably should be tools/<rid>/<library>

jkotas · 2025-04-20T03:06:59Z

tools directory in nuget packages is meant for executables. cdac is a native library. runtimes looks right to me.

dotnet-policy-service · 2025-04-21T16:05:09Z

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

jkotas · 2025-04-21T17:57:33Z

CDac name does not follow the .NET naming conventions:

It is not an acronym in common usage. (I do not even know what this acronym stands for.) From .NET Framework design guidelines: "In general, it is important to avoid using acronyms in identifier names unless they are in common usage and are immediately understandable to anyone who might use the framework."
If we went with the acronym, it should be capitalized as Cdac. From .NET Framework design guidelines: "Acronyms of three or more characters follow the guidelines of any other word. Only the first letter is capitalized".

I think a longer self-descriptive name would be better.

max-charlamb · 2025-04-21T18:27:37Z

@jkotas, would you be okay with contractdac?

steveisok · 2025-04-21T18:49:46Z

I think a longer self-descriptive name would be better.
@jkotas, would you be okay with contractdac?

I have no strong opinion. I'll be glad to name it whatever we all think is best.

am11 · 2025-04-23T13:15:10Z

The namespace used by cdac is Microsoft.Diagnostics.DataContractReader. If we are renaming it, it would be nice to make the native binary name to be aligned with the namespace and APIs names to make the connection clear.

The convention used by src/native/libs is <managed namespace>.Native, which produce libraries with same pattern, e.g. libSystem.IO.Ports.Native. This could be applied here as well?

jkotas · 2025-04-23T15:01:02Z

System.IO.Ports.Native is a helper library for implementation of System.IO.Ports namespace. The cdacreader is not a helper library like that. cdacreader is a managed library built from https://github.com/dotnet/runtime/tree/main/src/native/managed/cdacreader/src/ that we build with PublishAot. The implementation namespace for this library is Microsoft.Diagnostics.DataContractReader.Legacy;, but that is very long name.

We had more offline conversation about the naming. Stay tuned.

jkotas · 2025-04-23T16:58:42Z

Add something like this to https://github.com/dotnet/runtime/blob/main/docs/project/glossary.md:

CDAC Codename for (Data Contracts)[../design/datacontracts/datacontracts_design.md] project

src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Abstractions/Target.cs

src/coreclr/debug/daccess/cdac.cpp

eng/Subsets.props

src/native/managed/cdac/src/mscordaccore_universal.csproj

eng/Subsets.props

docs/project/glossary.md

…wrong place

jkotas · 2025-04-24T19:14:32Z

Microsoft.DotNet.CDAC.Transport.pkgproj

Nit: The casing that follows .NET naming conventions would be Cdac: #114812 (comment)

jkotas

LGTM! Thanks

jkotas · 2025-04-24T20:52:14Z

Directory.Build.props

@@ -178,6 +178,7 @@

  <PropertyGroup>
    <DotNetHostBinDir>$([MSBuild]::NormalizeDirectory('$(ArtifactsBinDir)', '$(OutputRID).$(HostConfiguration)', 'corehost'))</DotNetHostBinDir>
+    <DotNetCDacBinDir>$([MSBuild]::NormalizeDirectory('$(ArtifactsBinDir)', 'mscordaccore_universal', '$(Configuration)', '$(NetCoreAppCurrent)', '$(OutputRID)', 'publish'))</DotNetCDacBinDir>


Nit: DotNetCDacBinDir -> DotNetCdacBinDir, _BuildCDacPack -> _BuildCdacPack

Thanks - I'll do that in a quick follow up.

Follow up from dotnet#114812 (comment)

Follow up from #114812 (comment)

steveisok added 3 commits April 17, 2025 16:54

First pass at cdac packaging. Rename cdacreader to just cdac

0fe027f

Add linux as a publisher of the cdac pack

aff1d9c

Use PackageTargetRuntime so the host-arch goes as part of the package…

3788ac3

… name

Copilot AI review requested due to automatic review settings April 18, 2025 02:49

ghost added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Apr 18, 2025

Copilot AI reviewed Apr 18, 2025

View reviewed changes

steveisok requested review from a team April 18, 2025 02:49

dotnet-policy-service bot assigned steveisok Apr 18, 2025

Rename rest of cdac reader and related things.

dae2f2e

am11 added area-Infrastructure and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Apr 21, 2025

github-project-automation bot added this to Runtime Infra Apr 21, 2025

Merge remote-tracking branch 'upstream/main' into cdac-packaging

cf580ea

steveisok added 2 commits April 23, 2025 12:29

Rename to after discussion

79533b3

Merge remote-tracking branch 'upstream/main' into cdac-packaging

75fba07

jkotas reviewed Apr 23, 2025

View reviewed changes

build-analysis bot mentioned this pull request Apr 23, 2025

[6.0] tvOS arm64 build graph failure: project file not loaded System.Composition.AttributedModel.csproj #84334

Open

steveisok added 3 commits April 23, 2025 15:02

PR feedback

6b377e2

Don't assume cdac transport packaging is always going to be built

d14f733

Make sure lib name is used correctly

330a0b9

jkotas reviewed Apr 23, 2025

View reviewed changes

docs/project/glossary.md Outdated Show resolved Hide resolved

jkotas and others added 6 commits April 23, 2025 13:29

Update docs/project/glossary.md

f363c9f

Rename the right folder because I interpreted feedback to change the …

ffe32e5

…wrong place

Last src referral

97a2ca3

Don't package on certain architectures

180228b

Don't package on sourcebuild too

85a2bd1

Rename transport pkg

386180d

It's Cdac

2145839

jkotas approved these changes Apr 24, 2025

View reviewed changes

This was referenced Apr 25, 2025

[Long Running Test] 'System.Composition.UnitTests.ConcurrencyTests.SharedInstancesAreNotVisibleUntilActivationCompletes' #113686

Open

System.Globalization.Tests.IdnMappingIdnaConformanceTests failing on Windows #115006

Closed

steveisok merged commit 957aaac into dotnet:main Apr 25, 2025
145 of 150 checks passed

github-project-automation bot moved this to Done in Runtime Infra Apr 25, 2025

steveisok deleted the cdac-packaging branch April 25, 2025 11:17

steveisok added a commit to steveisok/runtime that referenced this pull request Apr 25, 2025

[cdac] Nits follow up from transport package PR

f2665d9

Follow up from dotnet#114812 (comment)

steveisok mentioned this pull request Apr 25, 2025

[cdac] Nits follow up from transport package PR #115047

Merged

steveisok added a commit that referenced this pull request Apr 25, 2025

[cdac] Nits follow up from transport package PR (#115047)

3eef331

Follow up from #114812 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cdac] Create transport package and rename the cdac reader #114812

[cdac] Create transport package and rename the cdac reader #114812

steveisok commented Apr 18, 2025

Copilot AI left a comment

jkotas commented Apr 18, 2025

steveisok commented Apr 18, 2025

mikem8361 commented Apr 19, 2025

steveisok commented Apr 20, 2025

jkotas commented Apr 20, 2025

dotnet-policy-service bot commented Apr 21, 2025

jkotas commented Apr 21, 2025 •

edited

Loading

max-charlamb commented Apr 21, 2025

steveisok commented Apr 21, 2025

am11 commented Apr 23, 2025

jkotas commented Apr 23, 2025

jkotas commented Apr 23, 2025

jkotas commented Apr 24, 2025

jkotas left a comment

jkotas Apr 24, 2025

steveisok Apr 25, 2025

[cdac] Create transport package and rename the cdac reader #114812

[cdac] Create transport package and rename the cdac reader #114812

Conversation

steveisok commented Apr 18, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

jkotas commented Apr 18, 2025

steveisok commented Apr 18, 2025

mikem8361 commented Apr 19, 2025

steveisok commented Apr 20, 2025

jkotas commented Apr 20, 2025

dotnet-policy-service bot commented Apr 21, 2025

jkotas commented Apr 21, 2025 • edited Loading

max-charlamb commented Apr 21, 2025

steveisok commented Apr 21, 2025

am11 commented Apr 23, 2025

jkotas commented Apr 23, 2025

jkotas commented Apr 23, 2025

jkotas commented Apr 24, 2025

jkotas left a comment

Choose a reason for hiding this comment

jkotas Apr 24, 2025

Choose a reason for hiding this comment

steveisok Apr 25, 2025

Choose a reason for hiding this comment

jkotas commented Apr 21, 2025 •

edited

Loading