Make LLVM_ENABLE_LTO function with multi-arch values for CMAKE_OSX_ARCHITECTURES

[dsanders]

Summary

Each ld invocation within the clang command needs a unique filename on the
-object_path_lto option so that dsymutil can extract debug info for all compiled
slices. In the current code, every slice uses the same temporary filename and
as a result only one slice of debug info ends up in the dSYM.

clang already knows how to use -object_path_file and dsymutil for multiarch
builds correctly so use that method instead. There is however a strange quirk.
clang will only do this if there is at least one non-object in the command that
performs a link (this doesn't make sense in my opinion). To work around this
we include a nearly-empty file (empty causes warnings) in the linking clang
invocation.

[dsanders]

tools/lto/hide-linkonce-odr.ll failed on my test run but it seems to be down to my system rather than the compiler (a library is genuinely missing). Will check if it fails without this change too

[dsanders]

In D84127#2161077, @dsanders wrote:

tools/lto/hide-linkonce-odr.ll failed on my test run but it seems to be down to my system rather than the compiler (a library is genuinely missing). Will check if it fails without this change too

It fails for me without the change too

[beanz]

I was talking to @bogner about this. I think this patch is reasonable, but it is important to note that this patch (and the previous version) are both workarounds for a bug in clang. Anytime the clang driver is provided a flag to generate debug info and it is linking temporary object files, clang should insert a dsymutil step. Right now it only inserts the step if there is a compiler or assembler input to the compiler. I filed a bug to track it (https://bugs.llvm.org/show_bug.cgi?id=46841), and I will upload a patch to the clang driver to fix this issue.

@dsanders, could you add a comment that this is a workaround for the bug in the clang driver and a link to the bug? That will allow us to track making this behavior conditional and maybe eventually removing it.

[beanz]

The clang fix -> https://reviews.llvm.org/D84565

[dsanders]

In D84127#2173436, @beanz wrote:

I was talking to @bogner about this. I think this patch is reasonable, but it is important to note that this patch (and the previous version) are both workarounds for a bug in clang. Anytime the clang driver is provided a flag to generate debug info and it is linking temporary object files, clang should insert a dsymutil step. Right now it only inserts the step if there is a compiler or assembler input to the compiler. I filed a bug to track it (https://bugs.llvm.org/show_bug.cgi?id=46841), and I will upload a patch to the clang driver to fix this issue.

Thanks. That makes sense to me, I thought it was pretty strange that output depended on whether it took 1 or >1 steps to get the result.
I also think the emit+move dance is a workaround to not being able to tell clang where to put them. I've posted D84572 for that bit

@dsanders, could you add a comment that this is a workaround for the bug in the clang driver and a link to the bug? That will allow us to track making this behavior conditional and maybe eventually removing it.

Sure

llvm/cmake/modules/AddLLVM.cmake

1987–1997

I've posted https://reviews.llvm.org/D84572 which will (eventually) allow us to remove this emit+move dance by adding -external-dsym-dir=${LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR} to the cflags/cxxflags in order to emit the dSYM in the desired location to begin with.

[dsanders]

• Add comment referencing the bug

[dsanders]

• Comment on the emit+move too

[dsanders]

llvm/cmake/modules/AddLLVM.cmake

1997

I'm testing a small bug fix for this before I land it as it currently fails on a missing file when there's no debug info.

[dsanders]

Fix the non-LTO path. It wasn't externalizing the debug info in single-slice builds

[dsanders]

Last one our own testing hit: Fix the case where lack of debug info means we didn't extract dsyms

[dsanders]

Make standalone clang builds work correctly. LLVM_SOURCE_DIR isn't set for those
Small naming change to match that directory

llvm/cmake/modules/AddLLVM.cmake

function(llvm_externalize_debuginfo name)
 
   if(APPLE)
     if(LLVM_EXTERNALIZE_DEBUGINFO_EXTENSION)
       set(file_ext ${LLVM_EXTERNALIZE_DEBUGINFO_EXTENSION})
     else()
       set(file_ext dSYM)
     endif()
 
-    set(output_name "$<TARGET_FILE_NAME:${name}>.${file_ext}")
-
-    if(LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR)
-      set(output_path "-o=${LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR}/${output_name}")
-    else()
-      set(output_path "-o=${output_name}")
-    endif()
-
-    if(CMAKE_CXX_FLAGS MATCHES "-flto"
-      OR CMAKE_CXX_FLAGS_${uppercase_CMAKE_BUILD_TYPE} MATCHES "-flto")
-
-      set(lto_object ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${name}-lto.o)
-      set_property(TARGET ${name} APPEND_STRING PROPERTY
-        LINK_FLAGS " -Wl,-object_path_lto,${lto_object}")
-    endif()
-    if(NOT CMAKE_DSYMUTIL)
-      set(CMAKE_DSYMUTIL xcrun dsymutil)
+    # As long as we compile at least one file from source code, clang will
+    # invoke dsymutil on the temporary objects after lipo'ing all the slices
+    # together.
+    # This is a workaround to a clang bug where dsymutil is not invoked for
+    # every case where debug info is present and temporary objects are being
+    # linked. See https://bugs.llvm.org/show_bug.cgi?id=46841 for more
+    # information.
+    set(empty_src
+        ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${name}-empty.cpp)
+    file(WRITE "${empty_src}" "extern int dummy;\n")
+      LINK_FLAGS " ${empty_src}")
+    if(LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR)
+      # clang can currently only emit dSYM's to the same directory as the output
+      # binary. Workaround this by moving it after the build.
+      set(output_name "$<TARGET_FILE_NAME:${name}>.${file_ext}")
+      set(output_path "${LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR}/${output_name}")
+      add_custom_command(TARGET ${name} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E make_directory "${LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR}"
+        # Remove any old versions if present
+        COMMAND ${CMAKE_COMMAND} -E rm "-rf" "${output_path}"
+        # Move the dSYM clang emitted next to the output binary where we want it
+        # to be.
+        COMMAND ${CMAKE_COMMAND}
+                    -DFROM="$<TARGET_FILE:${name}>.${file_ext}"
+                    -DTO="${output_path}"
+                    -P ${LLVM_SOURCE_DIR}/cmake/scripts/move_if_exists.cmake
+      )
     endif()
     add_custom_command(TARGET ${name} POST_BUILD
-      COMMAND ${CMAKE_DSYMUTIL} ${output_path} $<TARGET_FILE:${name}>
-      ${strip_command}
+      COMMAND ${strip_command}
       )
   else()
     add_custom_command(TARGET ${name} POST_BUILD
       COMMAND ${CMAKE_OBJCOPY} --only-keep-debug $<TARGET_FILE:${name}> $<TARGET_FILE:${name}>.debug
       ${strip_command} -R .gnu_debuglink
       COMMAND ${CMAKE_OBJCOPY} --add-gnu-debuglink=$<TARGET_FILE:${name}>.debug $<TARGET_FILE:${name}>
       )
   endif()

llvm/cmake/scripts/move_if_exists.cmake

+if(EXISTS "${FROM}")
+  execute_process(COMMAND ${CMAKE_COMMAND} -E rename "${FROM}" "${TO}")
+endif()