CMake: Install imports when installing the compiler, not the runtime

Author: kinke

.github/actions/5-install/action.yml

@@ -22,16 +22,16 @@ runs:
           # * bin/: executables
           # * lib/: LTO plugin and compiler-rt libs only
           # * etc/bash_completion.d/
+          # * import/: missing ldc/gccbuiltins_*.di
           ninja -C build-cross install
 
           # install the cross-compiled libs to populate:
           # * lib/: runtime library artifacts
           # * etc/ldc2.conf
-          # * import/: missing ldc/gccbuiltins_*.di
           ninja -C build-cross-libs install
 
           # copy gccbuiltins from bootstrap compiler
-          cp bootstrap-ldc/runtime/import/ldc/gccbuiltins_*.di install/import/ldc/
+          cp bootstrap-ldc/import/ldc/gccbuiltins_*.di install/import/ldc/
         fi
 
         cp ldc/LICENSE install/

CMakeLists.txt

@@ -138,6 +138,7 @@ set(D_VERSION ${DMDFE_MAJOR_VERSION} CACHE STRING "D language version")
 set(PROGRAM_PREFIX "" CACHE STRING "Prepended to ldc/ldmd binary names")
 set(PROGRAM_SUFFIX "" CACHE STRING "Appended to ldc/ldmd binary names")
 set(CONF_INST_DIR ${SYSCONF_INSTALL_DIR} CACHE PATH "Directory ldc2.conf is installed to")
+set(INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_PREFIX}/include/d CACHE PATH "Path to install D modules to")
 
 # Note: LIB_SUFFIX should perhaps be renamed to LDC_LIBDIR_SUFFIX.
 set(LIB_SUFFIX "" CACHE STRING "Appended to the library installation directory. Set to '64' to install libraries into ${PREFIX}/lib64.")
@@ -910,6 +911,42 @@ endif()
 #
 add_subdirectory(utils)
 
+# auto-generate ldc/gccbuiltins_*.di headers, depending on LLVM version and enabled LLVM backends
+set(GCCBUILTINS "")
+if(TARGET gen_gccbuiltins)
+    file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/import/ldc")
+
+    function(gen_gccbuiltins name)
+        set(module "${PROJECT_BINARY_DIR}/import/ldc/gccbuiltins_${name}.di")
+        if (GCCBUILTINS STREQUAL "")
+            set(GCCBUILTINS "${module}" PARENT_SCOPE)
+        else()
+            set(GCCBUILTINS "${GCCBUILTINS};${module}" PARENT_SCOPE)
+        endif()
+        add_custom_command(
+            OUTPUT ${module}
+            COMMAND gen_gccbuiltins ${module} "${name}"
+            DEPENDS gen_gccbuiltins
+        )
+    endfunction()
+
+    set(target_arch "AArch64;AMDGPU;ARM;Mips;RISCV;NVPTX;PowerPC;SystemZ;X86")
+    set(target_name "aarch64;amdgcn;arm;mips;riscv;nvvm;ppc;s390;x86")
+
+    foreach(target ${LLVM_TARGETS_TO_BUILD})
+        list(FIND target_arch ${target} idx)
+        if(idx GREATER -1)
+            list(GET target_name ${idx} name)
+            gen_gccbuiltins(${name})
+        endif()
+    endforeach()
+
+    add_custom_target(gccbuiltins DEPENDS ${GCCBUILTINS})
+
+    # make sure they are generated when building the compiler (as link-time dependency)
+    add_dependencies(${LDC_EXE} gccbuiltins)
+endif()
+
 #
 # Auxiliary tools.
 #
@@ -992,6 +1029,17 @@ if(${CMAKE_SYSTEM_NAME} MATCHES "Linux")
     install(DIRECTORY packaging/bash_completion.d/ DESTINATION ${BASH_COMPLETION_COMPLETIONSDIR})
 endif()
 
+# imports/includes
+install(FILES runtime/druntime/src/object.d runtime/druntime/src/__importc_builtins.di runtime/druntime/src/importc.h DESTINATION ${INCLUDE_INSTALL_DIR})
+foreach(p core etc ldc)
+    install(DIRECTORY runtime/druntime/src/${p} DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
+    install(DIRECTORY runtime/druntime/src/${p} DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.di")
+endforeach()
+install(DIRECTORY runtime/phobos/std DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
+install(DIRECTORY runtime/phobos/etc DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
+install(DIRECTORY runtime/jit-rt/d/ldc DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
+install(FILES ${GCCBUILTINS} DESTINATION ${INCLUDE_INSTALL_DIR}/ldc)
+
 #
 # Packaging
 #

ldc2.conf.in

@@ -23,7 +23,7 @@ default:
     // default switches appended after all explicit command-line switches
     post-switches = [
         "-I@RUNTIME_DIR@/src",
-        "-I@LDC_BUILD_IMPORT_DIR@",
+        "-I@LDC_GCCBUILTINS_IMPORT_DIR@",
         "-I@JITRT_DIR@/d",
     ];
     // default directories to be searched for libraries when linking

ldc2_phobos.conf.in

@@ -23,7 +23,7 @@ default:
     // default switches appended after all explicit command-line switches
     post-switches = [
         "-I@RUNTIME_DIR@/src",
-        "-I@LDC_BUILD_IMPORT_DIR@",
+        "-I@LDC_GCCBUILTINS_IMPORT_DIR@",
         "-I@JITRT_DIR@/d",
         "-I@PHOBOS2_DIR@",
     ];

runtime/CMakeLists.txt

@@ -35,7 +35,6 @@ endif()
 
 set(MULTILIB              OFF                                 CACHE BOOL   "Build both 32/64 bit runtime libraries")
 set(BUILD_LTO_LIBS        OFF                                 CACHE BOOL   "Also build the runtime as LLVM bitcode libraries for LTO")
-set(INCLUDE_INSTALL_DIR   ${CMAKE_INSTALL_PREFIX}/include/d   CACHE PATH   "Path to install D modules to")
 set(BUILD_SHARED_LIBS     AUTO                                CACHE STRING "Whether to build the runtime as a shared library (ON|OFF|BOTH)")
 set(D_FLAGS               -w;-de;-preview=dip1000;-preview=dtorfields;-preview=fieldwise CACHE STRING "Runtime D compiler flags, separated by ';'")
 set(D_EXTRA_FLAGS         ""                                  CACHE STRING "Runtime extra D compiler flags, separated by ';'")
@@ -301,8 +300,11 @@ endif()
 # LLD 8+ requires (new) `--export-dynamic` for WebAssembly (https://github.com/ldc-developers/ldc/issues/3023).
 set(WASM_DEFAULT_LDC_SWITCHES "${WASM_DEFAULT_LDC_SWITCHES}\n        \"-L--export-dynamic\",")
 
-# Directory filled with auto-generated import files
-set(LDC_BUILD_IMPORT_DIR "${PROJECT_BINARY_DIR}/import")
+# Note: normally inherited from LDC CMake parent build, and only needed for ldc2_install.conf
+set(INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/include/d" CACHE PATH "Path the D modules are installed to")
+
+# Note: default value only works if embedded in LDC CMake parent build, but only needed for ImportC (__importc_builtins.di) and non-install ldc2.conf
+set(LDC_GCCBUILTINS_IMPORT_DIR "${CMAKE_BINARY_DIR}/import" CACHE PATH "Directory filled with auto-generated ldc/gccbuiltins_*.di files")
 
 # Generate .conf files
 if(LDC_EXE)
@@ -369,36 +371,6 @@ install(FILES ${install_conf_path} DESTINATION ${CONF_INST_DIR} RENAME ${CONFIG_
 # druntime/Phobos compilation helpers.
 #
 
-set(GCCBUILTINS "")
-if(TARGET gen_gccbuiltins)
-  file(MAKE_DIRECTORY "${LDC_BUILD_IMPORT_DIR}/ldc")
-
-  function(gen_gccbuiltins name)
-    set(module "${LDC_BUILD_IMPORT_DIR}/ldc/gccbuiltins_${name}.di")
-    if (GCCBUILTINS STREQUAL "")
-      set(GCCBUILTINS "${module}" PARENT_SCOPE)
-    else()
-      set(GCCBUILTINS "${GCCBUILTINS};${module}" PARENT_SCOPE)
-    endif()
-    add_custom_command(
-        OUTPUT ${module}
-        COMMAND gen_gccbuiltins ${module} "${name}"
-        DEPENDS gen_gccbuiltins
-    )
-  endfunction()
-
-  set(target_arch "AArch64;AMDGPU;ARM;Mips;RISCV;NVPTX;PowerPC;SystemZ;X86")
-  set(target_name "aarch64;amdgcn;arm;mips;riscv;nvvm;ppc;s390;x86")
-
-  foreach(target ${LLVM_TARGETS_TO_BUILD})
-    list(FIND target_arch ${target} idx)
-    if(idx GREATER -1)
-      list(GET target_name ${idx} name)
-      gen_gccbuiltins(${name})
-    endif()
-  endforeach()
-endif()
-
 # Always build zlib and other C parts of the runtime in release mode, regardless
 # of what the user chose for LDC itself. Also add other C_FLAGS here.
 # 1) Set up CMAKE_C_FLAGS_RELEASE
@@ -449,7 +421,7 @@ macro(dc src_files src_basedir d_flags output_basedir emit_bc all_at_once single
 
     # dc_deps can only contain paths, otherwise cmake will ignore the dependency.
     # See: https://github.com/ldc-developers/ldc/pull/4743#issuecomment-2323156173
-    set(dc_deps ${LDC_EXE_FULL} ${GCCBUILTINS})
+    set(dc_deps ${LDC_EXE_FULL})
     if(TARGET add-multilib-section)
         # Make sure the config files are available before invoking LDC.
         set(dc_deps ${dc_deps} add-multilib-section)
@@ -564,7 +536,7 @@ macro(compile_druntime d_flags lib_suffix path_suffix emit_bc all_at_once single
     endif()
     dc("${DRUNTIME_D}"
        "${RUNTIME_DIR}/src"
-       "-conf=;${d_flags};${DRUNTIME_EXTRA_FLAGS};-I${RUNTIME_DIR}/src;-I${LDC_BUILD_IMPORT_DIR}"
+       "-conf=;${d_flags};${DRUNTIME_EXTRA_FLAGS};-I${RUNTIME_DIR}/src"
        "${PROJECT_BINARY_DIR}/objects${target_suffix}"
        "${emit_bc}"
        "${all_at_once}"
@@ -900,19 +872,6 @@ foreach(libname ${libs_to_install})
     endif()
 endforeach()
 
-set(DRUNTIME_PACKAGES core etc ldc)
-
-install(FILES ${RUNTIME_DIR}/src/object.d ${RUNTIME_DIR}/src/__importc_builtins.di ${RUNTIME_DIR}/src/importc.h DESTINATION ${INCLUDE_INSTALL_DIR})
-foreach(p ${DRUNTIME_PACKAGES})
-    install(DIRECTORY ${RUNTIME_DIR}/src/${p} DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
-    install(DIRECTORY ${RUNTIME_DIR}/src/${p} DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.di")
-endforeach()
-if(PHOBOS2_DIR)
-    install(DIRECTORY ${PHOBOS2_DIR}/std DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
-    install(DIRECTORY ${PHOBOS2_DIR}/etc DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
-endif()
-install(FILES ${GCCBUILTINS} DESTINATION ${INCLUDE_INSTALL_DIR}/ldc)
-
 
 #
 # Test targets.

runtime/jit-rt/DefineBuildJitRT.cmake

@@ -89,9 +89,6 @@ if(LDC_DYNAMIC_COMPILE)
         list(APPEND ${outlist_targets} "ldc-jit-rt${target_suffix}")
         set(${outlist_targets} ${${outlist_targets}} PARENT_SCOPE)
     endfunction()
-
-    # Install D interface files
-    install(DIRECTORY ${JITRT_DIR}/d/ldc DESTINATION ${INCLUDE_INSTALL_DIR} FILES_MATCHING PATTERN "*.d")
 else()
     function(build_jit_runtime d_flags c_flags ld_flags path_suffix outlist_targets)
     endfunction()

runtime/ldc-build-runtime.d.in

@@ -159,6 +159,7 @@ void runCMake() {
         "-DDMDFE_MINOR_VERSION=@DMDFE_MINOR_VERSION@",
         "-DDMDFE_PATCH_VERSION=@DMDFE_PATCH_VERSION@",
         "-DLDC_WITH_LLD=@LDC_WITH_LLD@",
+        "-DINCLUDE_INSTALL_DIR=@INCLUDE_INSTALL_DIR@",
     ];
 
     if (config.targetSystem.length) args ~= "-DTARGET_SYSTEM=" ~ config.targetSystem.join(";");