Support Single File Diagnostics

[tommcdon]

This issue is tracking the work necessary to support single-file diagnostics. Our goal is to deliver parity with debugging and profiling with framework dependent applications where applicable.

• Reduce long term maintenance by moving to the dotnet/diagnostics repo
• dbgshim needs an ELF parser to identify if a module is CoreCLR + extract the DAC/DBI keys. There's currently a copy in use in the runtime for createdump and the DAC on Linux dumps and one used in SOS for OpenVirtualProcess.
• dbgshim OVP needs updated ILibraryProvider callback interface that accepts buildid information for DAC/DBI. This receives the DAC/DBI keys that were retrieved.
• dbgshim live debugging case needs to integrate ILibraryProvider so that the caller can locate DAC/DBI instead of dbgshim.
  • We search for CoreCLR in the module list. On Linux and macOS we have the PAL runtime startup helper:

    runtime/src/coreclr/src/pal/src/thread/process.cpp

    Line 1654 in 6438d08

    PAL_ERROR InvokeStartupCallback()

  • Use the path to coreclr as a lookup location for DBI: F:\github\coreclr\src\dlls\dbgshim\dbgshim.cpp:382
  • provide the coreclr base address to DBI:

    mscordbi!Cordb::SetTargetCLR 
    mscordbi!CoreCLRCreateCordbObjectEx 
    mscordbi!CoreCLRCreateCordbObject dbgshim!CreateCoreDbgWithoutSandboxSupport 
    dbgshim!CreateCoreDbg dbgshim!RuntimeStartupHelper::InvokeStartupCallback 
    dbgshim!RuntimeStartupHandler 
    dbgshim!InvokeStartupCallback dbgshim!StartupHelperThread
    

• createdump and a portion of the DAC need to be linked into the host
• The linked version of createdump needs to be modified to use a linked in DAC rather than searching for it.
• F:\github\coreclr\src\debug\createdump\crashinfo.cpp(374) - cache coreclr path unneeded
• F:\github\coreclr\src\debug\createdump\crashinfo.cpp(620) - add alternate path to construct pfnCLRDataCreateInstance
• Mac OS superhost debugging support Change DAC to use MachOReader to lookup "g_dacTable" symbol instead of the rva header file hack #38901
• Link DotNetRuntimeInfo into the superhost Debugging singlefile deployment: Failed to find runtime module (libcoreclr.so), 0x80004005 diagnostics#1764
• Watson support for single-file apps diagnostics#2438 (comment)

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

Issue Details

---

This issue is tracking the work necessary to support single-file diagnostics

[ ] dbgshim needs an ELF parser to identify if a module is CoreCLR + extract the DAC/DBI keys.
○ one copy is linked into SOS for OVP
○ one is still built in CoreCLR

[ ] dbgshim OVP needs updated ILibraryProvider callback interface that accepts buildid information for DAC/DBI. This receives the DAC/DBI keys that were retrieved in (4) David

[ ] dbgshim live debugging case needs to integrate ILibraryProvider so that the caller can locate DAC/DBI instead of dbgshim F:\github\coreclr\src\pal\src\thread\process.cpp:1809 - InvokeStartupCallback - This searches for coreclr in the module list in order to:

	○ use the path to coreclr as a lookup location for DBI: F:\github\coreclr\src\dlls\dbgshim\dbgshim.cpp:382
	○ provide the coreclr base address to DBI: 
		§ mscordbi!Cordb::SetTargetCLR 
		§ mscordbi!CoreCLRCreateCordbObjectEx 
		§ mscordbi!CoreCLRCreateCordbObject dbgshim!CreateCoreDbgWithoutSandboxSupport 
		§ dbgshim!CreateCoreDbg dbgshim!RuntimeStartupHelper::InvokeStartupCallback 
		§ dbgshim!RuntimeStartupHandler 
		§ dbgshim!InvokeStartupCallback dbgshim!StartupHelperThread

[ ] CreateDump + DAC (or a fraction of it) needs to be linked into the nativehost

[ ] Linked in CreateDump is modified to use a linked in DAC rather than searching for it
○ F:\github\coreclr\src\debug\createdump\crashinfo.cpp(374) - cache coreclr path unneeded
○ F:\github\coreclr\src\debug\createdump\crashinfo.cpp(620) - add alternate path to construct pfnCLRDataCreateInstance

Author:	tommcdon
Assignees:	-
Labels:	area-Diagnostics-coreclr
Milestone:	6.0.0