Change CoreCLR diagnostic resource production to remove cross-component build dependency (#67018)

Author: jkoritzinsky

src/coreclr/build-runtime.cmd

@@ -528,13 +528,9 @@ if %__BuildNative% EQU 1 (
     if /i "%__BuildArch%" == "x86" ( set __VCBuildArch=x86 )
     if /i "%__BuildArch%" == "arm" (
         set __VCBuildArch=x86_arm
-        set ___CrossBuildDefine="-DCLR_CMAKE_CROSS_ARCH=1" "-DCLR_CMAKE_CROSS_HOST_ARCH=%__CrossArch%"
     )
     if /i "%__BuildArch%" == "arm64" (
         set __VCBuildArch=x86_arm64
-        if defined __CrossArch (
-            set ___CrossBuildDefine="-DCLR_CMAKE_CROSS_ARCH=1" "-DCLR_CMAKE_CROSS_HOST_ARCH=%__CrossArch%"
-        )
     )
 
     echo %__MsgPrefix%Using environment: "%__VCToolsRoot%\vcvarsall.bat" !__VCBuildArch!
@@ -549,7 +545,7 @@ if %__BuildNative% EQU 1 (
         set __ExtraCmakeArgs="-DCMAKE_BUILD_TYPE=!__BuildType!"
     )
 
-    set __ExtraCmakeArgs=!__ExtraCmakeArgs! !___CrossBuildDefine! "-DCLR_CMAKE_PGO_INSTRUMENT=%__PgoInstrument%" "-DCLR_CMAKE_OPTDATA_PATH=%__PgoOptDataPath%" "-DCLR_CMAKE_PGO_OPTIMIZE=%__PgoOptimize%" %__CMakeArgs%
+    set __ExtraCmakeArgs=!__ExtraCmakeArgs! "-DCLR_CMAKE_PGO_INSTRUMENT=%__PgoInstrument%" "-DCLR_CMAKE_OPTDATA_PATH=%__PgoOptDataPath%" "-DCLR_CMAKE_PGO_OPTIMIZE=%__PgoOptimize%" %__CMakeArgs%
     call "%__RepoRootDir%\eng\native\gen-buildsys.cmd" "%__ProjectDir%" "%__IntermediatesDir%" %__VSVersion% %__BuildArch% !__ExtraCmakeArgs!
     if not !errorlevel! == 0 (
         echo %__ErrMsgPrefix%%__MsgPrefix%Error: failed to generate native component build project!

src/coreclr/crosscomponents.cmake

@@ -42,7 +42,3 @@ if(NOT CLR_CMAKE_HOST_LINUX AND NOT CLR_CMAKE_HOST_OSX AND NOT FEATURE_CROSSBITN
         COMPONENT crosscomponents
     )
 endif()
-
-if (CLR_CMAKE_TARGET_WIN32 AND NOT CLR_CMAKE_CROSS_ARCH)
-    add_dependencies(crosscomponents InjectResource GenClrDebugResource)
-endif()

src/coreclr/debug/runtimeinfo/CMakeLists.txt

@@ -29,8 +29,8 @@ function(generate_module_index Target ModuleIndexFile)
     target_sources(runtimeinfo PRIVATE ${ModuleIndexFile})
 endfunction(generate_module_index)
 
-generate_module_index(coreclr ${CMAKE_CURRENT_BINARY_DIR}/runtimemoduleindex.h)
 if(NOT DEFINED CLR_CROSS_COMPONENTS_BUILD)
+    generate_module_index(coreclr ${CMAKE_CURRENT_BINARY_DIR}/runtimemoduleindex.h)
     add_dependencies(runtimeinfo inject_debug_resources_coreclr)
     generate_module_index(mscordaccore ${CMAKE_CURRENT_BINARY_DIR}/dacmoduleindex.h)
     generate_module_index(mscordbi ${CMAKE_CURRENT_BINARY_DIR}/dbimoduleindex.h)

src/coreclr/dlls/CMakeLists.txt

@@ -2,10 +2,10 @@ if(CLR_CMAKE_TARGET_WIN32)
     add_subdirectory(clretwrc)
 endif(CLR_CMAKE_TARGET_WIN32)
 add_subdirectory(dbgshim)
-if (NOT (CLR_CMAKE_TARGET_WIN32 AND (CLR_CMAKE_TARGET_ARCH_I386 OR CLR_CMAKE_TARGET_ARCH_ARM) AND CLR_CMAKE_HOST_ARCH_AMD64))
+if (NOT (CLR_CMAKE_TARGET_WIN32 AND FEATURE_CROSSBITNESS))
     add_subdirectory(mscordbi)
     add_subdirectory(mscordac)
+    add_subdirectory(mscoree)
 endif()
-add_subdirectory(mscoree)
 add_subdirectory(mscorpe)
 add_subdirectory(mscorrc)

src/coreclr/dlls/mscoree/coreclr/CMakeLists.txt

@@ -173,6 +173,26 @@ target_link_libraries(coreclr_static PUBLIC ${CORECLR_LIBRARIES} clrjit_static c
 target_compile_definitions(coreclr_static PUBLIC CORECLR_EMBEDDED)
 
 if(CLR_CMAKE_TARGET_WIN32)
+    set(CLRDEBUGINFO_RESOURCE_PATH ${CMAKE_CURRENT_BINARY_DIR}/clr_debug_resource.bin)
+
+    add_custom_target(
+        clr_debug_resources
+        DEPENDS mscordaccore mscordbi
+        # make CLRDEBUGINFO resource
+        COMMAND powershell -NoProfile -ExecutionPolicy ByPass -File "${CMAKE_CURRENT_SOURCE_DIR}/GenClrDebugResource.ps1" -dac $<TARGET_FILE:mscordaccore> -dbi $<TARGET_FILE:mscordbi> -out ${CLRDEBUGINFO_RESOURCE_PATH}
+    )
+
+    configure_file(dump_helper_resource.rc.in ${CMAKE_CURRENT_BINARY_DIR}/dump_helper_resource.rc)
+
+    set(EMBEDDED_MINIDUMP_AUXILIARY_PROVIDER ON)
+    configure_file(dump_helper_resource.rc.in ${CMAKE_CURRENT_BINARY_DIR}/dump_helper_resource_embedded_minidump_provider.rc)
+
+    target_sources(coreclr PUBLIC ${CMAKE_CURRENT_BINARY_DIR}/dump_helper_resource.rc)
+    target_sources(coreclr_static PUBLIC ${CMAKE_CURRENT_BINARY_DIR}/dump_helper_resource_embedded_minidump_provider.rc)
+
+    add_dependencies(coreclr clr_debug_resources)
+    add_dependencies(coreclr_static clr_debug_resources)
+
     # Add dac table & debug resource to coreclr
     get_include_directories(INC_DIR)
     get_compile_definitions(PREPROCESS_DEFINITIONS)
@@ -191,10 +211,9 @@ if(CLR_CMAKE_TARGET_WIN32)
         clr_unknown_arch()
     endif()
 
-
-    if (CLR_CMAKE_CROSS_ARCH)
-        include(${CMAKE_INSTALL_PREFIX}/${CLR_CMAKE_CROSS_HOST_ARCH}/dactabletools/dactabletools.cmake)
-    endif()
+    # dacess.h defines this constant
+    # The value is a constract between the DAC and the runtime
+    set (DACCESS_TABLE_RESOURCE COREXTERNALDATAACCESSRESOURCE)
 
     add_custom_command(
         DEPENDS coreclr mscordaccore mscordbi ${CLR_DIR}/debug/daccess/daccess.cpp
@@ -203,17 +222,10 @@ if(CLR_CMAKE_TARGET_WIN32)
 
         # make and inject dactable for coreclr
         COMMAND cmd /c ${CLR_REPO_ROOT_DIR}/dotnet.cmd exec ${CMAKE_INSTALL_PREFIX}/DacTableGen/DacTableGen.dll /dac:${CMAKE_CURRENT_BINARY_DIR}/daccess.i /pdb:$<TARGET_PDB_FILE:coreclr> /dll:$<TARGET_FILE:coreclr> /bin:${CMAKE_CURRENT_BINARY_DIR}/wks.bin
-        COMMAND InjectResource /bin:${CMAKE_CURRENT_BINARY_DIR}/wks.bin /dll:$<TARGET_FILE:coreclr>
-
-        # make CLRDEBUGINFO resource and inject into coreclr
-        COMMAND GenClrDebugResource /dac:$<TARGET_FILE:mscordaccore> /dbi:$<TARGET_FILE:mscordbi> /sku:onecoreclr /out:${CMAKE_CURRENT_BINARY_DIR}/clrDebugResource.bin
-        COMMAND InjectResource /bin:${CMAKE_CURRENT_BINARY_DIR}/clrDebugResource.bin /dll:$<TARGET_FILE:coreclr> /name:CLRDEBUGINFO
-
-        # inject MINIDUMP_AUXILIARY_PROVIDER into coreclr
-        COMMAND InjectResource /bin:${CMAKE_CURRENT_SOURCE_DIR}/dump_helper_resource.bin /dll:$<TARGET_FILE:coreclr> /name:MINIDUMP_AUXILIARY_PROVIDER
+        COMMAND cmd /c ${CLR_REPO_ROOT_DIR}/dotnet.cmd exec ${CMAKE_INSTALL_PREFIX}/InjectResource/InjectResource.dll --bin ${CMAKE_CURRENT_BINARY_DIR}/wks.bin --image $<TARGET_FILE:coreclr> --name ${DACCESS_TABLE_RESOURCE}
 
         COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/inject_debug_resources_coreclr.timestamp
-        COMMENT Add dactable, debug resources, and dump helper resources to coreclr
+        COMMENT Add dactable to coreclr
     )
 
     if(NOT DEFINED CLR_CROSS_COMPONENTS_BUILD)
@@ -228,14 +240,10 @@ if(CLR_CMAKE_TARGET_WIN32)
 
         # make and inject dactable for singlefilehost
         COMMAND cmd /c ${CLR_REPO_ROOT_DIR}/dotnet.cmd exec ${CMAKE_INSTALL_PREFIX}/DacTableGen/DacTableGen.dll /dac:${CMAKE_CURRENT_BINARY_DIR}/daccess.i /pdb:$<TARGET_PDB_FILE:singlefilehost> /dll:$<TARGET_FILE:singlefilehost> /bin:${CMAKE_CURRENT_BINARY_DIR}/sfh.bin
-        COMMAND InjectResource /bin:${CMAKE_CURRENT_BINARY_DIR}/sfh.bin /dll:$<TARGET_FILE:singlefilehost>
-
-        # make CLRDEBUGINFO resource and inject into singlefilehost
-        COMMAND GenClrDebugResource /dac:$<TARGET_FILE:mscordaccore> /dbi:$<TARGET_FILE:mscordbi> /sku:onecoreclr /out:${CMAKE_CURRENT_BINARY_DIR}/clrDebugResource.bin
-        COMMAND InjectResource /bin:${CMAKE_CURRENT_BINARY_DIR}/clrDebugResource.bin /dll:$<TARGET_FILE:singlefilehost> /name:CLRDEBUGINFO
+        COMMAND cmd /c ${CLR_REPO_ROOT_DIR}/dotnet.cmd exec ${CMAKE_INSTALL_PREFIX}/InjectResource/InjectResource.dll --bin ${CMAKE_CURRENT_BINARY_DIR}/sfh.bin --image $<TARGET_FILE:singlefilehost> --name ${DACCESS_TABLE_RESOURCE}
 
         COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/inject_debug_resources_singlefilehost.timestamp
-        COMMENT Add dactable, debug resources, and dump helper resources to singlefilehost
+        COMMENT Add dactable to singlefilehost
     )
 
     if(NOT DEFINED CLR_CROSS_COMPONENTS_BUILD)

src/coreclr/dlls/mscoree/coreclr/GenClrDebugResource.ps1

@@ -0,0 +1,47 @@
+param (
+    [string]
+    $dac,
+    [string]
+    $dbi,
+    [string]
+    $out
+)
+
+function Parse-Int {
+    param (
+        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
+        [string]$hexValue
+    )
+    return [System.Int32]::Parse($hexValue, [System.Globalization.NumberStyles]::HexNumber)
+}
+
+$clrDebugResource = [System.IO.BinaryWriter]::new([System.IO.File]::OpenWrite($out))
+
+try {
+    # We're creating the resource with the following layout (represented as a C struct)
+    # struct CLR_DEBUG_RESOURCE
+    # {
+    #   int version;
+    #   GUID clrSkuGuid;
+    #   int dacTimeStamp;
+    #   int dacImageSize;
+    #   int dbiTimeStamp;
+    #   int dacImageSize;
+    # };
+
+    # Write the debug resource version
+    $clrDebugResource.Write(0);
+    # Write the GUID for CoreCLR (should match the CLR_ID_ONECORE_CLR GUID in clrinternal.idl)
+    $clrDebugResource.Write([System.Guid]::Parse("{0xb1ee760d,0x6c4a,0x4533,{0xba,0x41,0x6f,0x4f,0x66,0x1f,0xab,0xaf}}").ToByteArray())
+    [int]$dacTimeStamp = dumpbin $dac /HEADERS | Select-String "([0-9A-Fa-f]+) time date stamp" | %{ $_.Matches.Groups[1].Value } | Parse-Int
+    [int]$dacImageSize = dumpbin $dac /HEADERS | Select-String "([0-9A-Fa-f]+) size of image" | %{ $_.Matches.Groups[1].Value } | Parse-Int
+    [int]$dbiTimeStamp = dumpbin $dbi /HEADERS | Select-String "([0-9A-Fa-f]+) time date stamp" | %{ $_.Matches.Groups[1].Value } | Parse-Int
+    [int]$dbiImageSize = dumpbin $dbi /HEADERS | Select-String "([0-9A-Fa-f]+) size of image" | %{ $_.Matches.Groups[1].Value } | Parse-Int
+    $clrDebugResource.Write($dacTimeStamp)
+    $clrDebugResource.Write($dacImageSize)
+    $clrDebugResource.Write($dbiTimeStamp)
+    $clrDebugResource.Write($dbiImageSize)
+}
+finally {
+    $clrDebugResource.Dispose()
+}

src/coreclr/dlls/mscoree/coreclr/README.md

@@ -1,7 +1,4 @@
-dump\_helper\_resource.bin in this folder is a text file with a single 0 byte appended on the end using a hex-editor. It is unlikely it will need to be modified frequently if at all,
-but if that changes we can always create a little nicer tooling for it.
-
-dump\_helper\_resource.bin is used to populate the DUMP\_HELPER resource inside coreclr.dll on Windows. When an application crashes, Windows MinidumpWriteDump is planning to scan
+dump\_helper\_resource.rc is used to populate the MINIDUMP\_AUXILIARY\_PROVIDER resource inside coreclr.dll on Windows. When an application crashes, Windows MinidumpWriteDump is planning to scan
 modules looking for this resource. The content of the resource is expected to be the name of a dll in the same folder, encoded in UTF8, null terminated, that implements the
 CLRDataCreateInterface function. For OS security purposes MinidumpWriteDump will do an authenticode signing check before loading the indicated binary, however if your build isn't
 signed you can get around this limitation by registering it at HKLM\Software\Microsoft\WindowsNT\CurrentVersion\MiniDumpAuxilliaryDlls.

src/coreclr/dlls/mscoree/coreclr/dump_helper_resource.bin

@@ -0,0 +1,13 @@
+#include <windows.h>
+
+LANGUAGE LANG_NEUTRAL, SUBLANG_NEUTRAL
+
+#cmakedefine EMBEDDED_MINIDUMP_AUXILIARY_PROVIDER
+
+#ifndef EMBEDDED_MINIDUMP_AUXILIARY_PROVIDER
+
+MINIDUMP_AUXILIARY_PROVIDER RCDATA  { "mscordaccore.dll\0" }
+
+#endif
+
+CLRDEBUGINFO RCDATA @CLRDEBUGINFO_RESOURCE_PATH@

src/coreclr/dlls/mscoree/coreclr/dump_helper_resource.rc.in

@@ -7,8 +7,9 @@
     <AssemblyName>.NET Runtime</AssemblyName>
   </PropertyGroup>
 
-  <ItemGroup>
-    <ProjectReference Condition="'$(TargetOS)' == 'Windows'" Include="tools/SOS/DacTableGen/DacTableGen.csproj" />
+  <ItemGroup Condition="'$(TargetOS)' == 'Windows'">
+    <ProjectReference Include="tools/SOS/DacTableGen/DacTableGen.csproj" />
+    <ProjectReference Include="tools/InjectResource/InjectResource.csproj" />
   </ItemGroup>
 
   <Import Project="$(RepositoryEngineeringDir)versioning.targets" />

src/coreclr/runtime-prereqs.proj

@@ -1,12 +1,6 @@
 add_subdirectory(SOS)
 add_subdirectory(superpmi)
 
-if (CLR_CMAKE_TARGET_WIN32 AND NOT CLR_CMAKE_CROSS_ARCH)
-  add_subdirectory(GenClrDebugResource)
-  add_subdirectory(InjectResource)
-
-  install(EXPORT dactabletools DESTINATION dactabletools COMPONENT crosscomponents)
-endif()
 if (CLR_CMAKE_TARGET_ARCH_AMD64 OR CLR_CMAKE_TARGET_ARCH_ARM64)
   add_subdirectory(StressLogAnalyzer)
 endif()