Distribute macOS symbols as dSYM, not .dwarf

[filipnavara]

macOS tooling expects symbols to be distributed as .dSYM bundles created using dsymtool without the --flat parameter. The distribution using dSYM allows the lldb debugger, spindump, sample, and other tools to locate the symbols automatically (through Spotlight indexer with matches the symbols through UUID back to the original executable). This automatic symbol loading doesn't work for .dwarf files located next to the executable.

This makes debugging tools like ILCompiler particularly annoying. Profiling long compilations produces non-symbolicated traces which are hard to interpret.

[ghost]

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

Issue Details

---

macOS tooling expects symbols to be distributed as .dSYM bundles created using dsymtool without the --flat parameter. The distribution using dSYM allows the lldb debugger, spindump, sample, and other tools to locate the symbols automatically (through Spotlight indexer with matches the symbols through UUID back to the original executable). This automatic symbol loading doesn't work for .dwarf files located next to the executable.

This makes debugging tools like ILCompiler particularly annoying. Profiling long compilations produces non-symbolicated traces which are hard to interpret.

Author:	filipnavara
Assignees:	-
Labels:	area-Diagnostics-coreclr
Milestone:	-

[am11]

I think if we want to also ship .dSYM files, it will require coordinated effort. After the mechanical code changes in these places:

• runtime/eng/native/functions.cmake

  Line 389 in 0d77cf0

  if (CLR_CMAKE_TARGET_APPLE)

• runtime/eng/native/naming.props

  Line 21 in 0d77cf0

  <SymbolsSuffix>.dwarf</SymbolsSuffix>

• runtime/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.targets

  Line 397 in 0d77cf0

  dsymutil $(DsymUtilOptions) "$(NativeBinary)" &&

• runtime/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.Unix.targets

  Line 22 in 0d77cf0

  <DsymUtilOptions Condition="'$(_IsApplePlatform)' == 'true'">--flat</DsymUtilOptions>

• runtime/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.Unix.targets

  Line 236 in 0d77cf0

  <DsymUtilOptions>$(DsymUtilOptions) --minimize</DsymUtilOptions>

there might be additional work required in https://github.com/dotnet/diagnostics tools and https://github.com/dotnet/symstore (and the underlying blob storage).

[EgorBo]

I guess it should also help native profilers?

[filipnavara]

I guess it should also help native profilers?

Yep. It applies to Instruments too.

[dotnet-policy-service]

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