[flang] Make flang build compatible with LLVM dylib

[serge-sans-paille]

Summary

If flang links with LLVM_DYLIB, there's no need to link the support library again.

[jeanPerier]

Thanks for fixing this. I tested in my build environment. I could reproduce the failure without this fix at build time with LLVM_LINK_LLVM_DYLIB when Generating ../../include/flang/__fortran_builtins.mod. With this fix, I can still build OK without LLVM_LINK_LLVM_DYLIB. With LLVM_LINK_LLVM_DYLIB, flang now builds, but I see 14 flang regression tests are failing with error CommandLine Error: Option 'disable-symbolication' registered more than once!. I think it may be a test linking issue that is remaining, but at least LLVM_LINK_LLVM_DYLIB now works to build flang.

[serge-sans-paille]

Thanks. I'll try to fix this duplicate link issue before commiting this (incomplete) patch then :-)

[serge-sans-paille]

Harmonize usage of LLVM components througout Flang.

Explicit LLVM Libs where used across several CMakeFIles, which led to incompatibilities with LLVM shlibs.
Fortunately, the LLVM component system can be relied on to harmoniously handle both cases.

[serge-sans-paille]

ping?

[jeanPerier]

Thanks for this update, I just finished testing it. There is one issue with a really really slow test being run in regression (see inline comment). Apart from that, this patch built in my environment with/without LLVM_LINK_LLVM_DYLIB in/out of LLVM tree.

flang/unittests/Decimal/CMakeLists.txt

7

With this change, thorough-test is now run with make check-flang regression tests which we would like to avoid because it can take ~1hour to run. I think this is because lit just tries to run whatever executable are ending with ".test" in this folder. To fix that, add_flang_nongtest_unittest could avoid adding the ".test" extension to the executable in case SLOW_TEST is passed to it.

[serge-sans-paille]

(Try to) fix slow tests. Thanks @jeanPerier for spotting that.

[jeanPerier]

I can build and run tests as expected with and without LLVM_LINK_LLVM_DYLIB now. Thanks for making flang work with this build option !

[awarzynski]

@serge-sans-paille Thank you for working on this! Sadly the Flang buildbot is unhappy again:http://lab.llvm.org:8014/#/builders/109/builds/35. I'm guessing that you didn't test with -DFLANG_BUILD_NEW_DRIVER=ON?

IIUC, the add_flang_tool macro needs fixing/updating. I'll take a look and submit something. Perhaps I'll need to revert the changes in flang/tools/flang-driver/CMakeLists.txt. in the interim.

flang/tools/flang-driver/CMakeLists.txt

11

Sadly, add_flang_tool doesn't understand this syntax: http://lab.llvm.org:8014/#/builders/109/builds/35

[awarzynski]

In D87893#2330109, @awarzynski wrote:

@serge-sans-paille Thank you for working on this! Sadly the Flang buildbot is unhappy again:http://lab.llvm.org:8014/#/builders/109/builds/35. I'm guessing that you didn't test with -DFLANG_BUILD_NEW_DRIVER=ON?

IIUC, the add_flang_tool macro needs fixing/updating. I'll take a look and submit something. Perhaps I'll need to revert the changes in flang/tools/flang-driver/CMakeLists.txt. in the interim.

Should be fixed here: https://reviews.llvm.org/D89403

[awarzynski]

The CMake error for flang-new is now fixed, but I'm no longer able to build Flang with BUILD_SHARED_LIBS=On. @serge-sans-paille , have you tested that configuration? I'm struggling to find a fix.

[serge-sans-paille]

I'll have a look and submit a patch

flang/CMakeLists.txt

 if(LINK_WITH_FIR)
   # tco tool and FIR lib output directories
   if(FLANG_STANDALONE_BUILD)
     set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/bin)
     set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/lib)
   endif()
   # Always build tco tool
   set(LLVM_BUILD_TOOLS ON)
-  message(STATUS "Linking driver with FIR and LLVM")
-  llvm_map_components_to_libnames(LLVM_COMMON_LIBS support)
-  message(STATUS "LLVM libraries: ${LLVM_COMMON_LIBS}")
+  set(LLVM_COMMON_COMPONENTS Support)
+  message(STATUS "Linking driver with FIR and LLVM, using LLVM components: ${LLVM_COMMON_COMPONENTS}")
 endif()
 
 # Add Flang-centric modules to cmake path.
 include_directories(BEFORE
   ${FLANG_BINARY_DIR}/include
   ${FLANG_SOURCE_DIR}/include)
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")

flang/cmake/modules/AddFlang.cmake

else()
       set(LIBTYPE STATIC OBJECT)
     endif()
     set_property(GLOBAL APPEND PROPERTY FLANG_STATIC_LIBS ${name})
   endif()
 
   llvm_add_library(${name} ${LIBTYPE} ${ARG_UNPARSED_ARGUMENTS} ${srcs})
 
   if (TARGET ${name})
-    target_link_libraries(${name} INTERFACE ${LLVM_COMMON_LIBS})
 
     if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ${name} STREQUAL "libflang")
       set(export_to_flangtargets)
       if (${name} IN_LIST LLVM_DISTRIBUTION_COMPONENTS OR
           "flang-libraries" IN_LIST LLVM_DISTRIBUTION_COMPONENTS OR
           NOT LLVM_DISTRIBUTION_COMPONENTS)
         set(export_to_flangtargets EXPORT FlangTargets)
         set_property(GLOBAL PROPERTY FLANG_HAS_EXPORTS True)

flang/tools/flang-driver/CMakeLists.txt

 # Infrastructure to build flang driver entry point. Flang driver depends on
 # LLVM libraries.
 
 # Set your project compile flags.
 link_directories(${LLVM_LIBRARY_DIR})
 
 add_flang_tool(flang-new
   driver.cpp
   fc1_main.cpp
+
+  LINK_COMPONENTS
+
+  ${LLVM_COMMON_COMPONENTS}
+  Support
+  Target
+  Option
 )
 
 # Link against LLVM and Clang libraries
 target_link_libraries(flang-new
   PRIVATE
-  ${LLVM_COMMON_LIBS}
   flangFrontend
   flangFrontendTool
   clangDriver
   clangBasic
   clangFrontend
-  LLVMSupport
-  LLVMTarget
-  LLVMOption
 )
 
 install(TARGETS flang-new DESTINATION bin)

flang/unittests/CMakeLists.txt

 add_custom_target(FlangUnitTests)
 set_target_properties(FlangUnitTests PROPERTIES FOLDER "Flang Unit Tests")
 
 function(add_flang_unittest test_dirname)
   add_unittest(FlangUnitTests ${test_dirname} ${ARGN})
 endfunction()
 
 if (CXX_SUPPORTS_SUGGEST_OVERRIDE_FLAG)
   add_compile_options("-Wno-suggest-override")
 endif()
 
 function(add_flang_nongtest_unittest test_name)
-  add_executable(${test_name}.test ${test_name}.cpp)
+  cmake_parse_arguments(ARG
+    "SLOW_TEST"
+    ""
+    ""
+    ${ARGN})
+
+  if(ARG_SLOW_TEST)
+      set(suffix .slow)
+  else()
+      set(suffix .test)
+  endif()
+
+  add_executable(${test_name}${suffix} ${test_name}.cpp)
 
-  target_link_libraries(${test_name}.test ${ARGN})
+  if (LLVM_LINK_LLVM_DYLIB AND NOT ARG_DISABLE_LLVM_LINK_LLVM_DYLIB)
+    set(llvm_libs LLVM)
+  else()
+    llvm_map_components_to_libnames(llvm_libs Support)
+  endif()
+  target_link_libraries(${test_name}${suffix} ${llvm_libs} ${ARG_UNPARSED_ARGUMENTS})
 
-  add_dependencies(FlangUnitTests ${test_name}.test)
+  if(NOT ARG_SLOW_TEST)
+    add_dependencies(FlangUnitTests ${test_name}${suffix})
+  endif()
 endfunction()
 
 add_subdirectory(Optimizer)
 add_subdirectory(Decimal)
 add_subdirectory(Evaluate)
 add_subdirectory(Runtime)
 
 if (FLANG_BUILD_NEW_DRIVER)
   add_subdirectory(Frontend)
 endif()

flang/unittests/Decimal/CMakeLists.txt

 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 add_flang_nongtest_unittest(quick-sanity-test
   FortranDecimal
-  LLVMSupport
 )
 
-# This test is not run by default as it takes a long time to execute
-add_executable(thorough-test
-  thorough-test.cpp
-)
-
-target_link_libraries(thorough-test
+# This test is not run by default as it takes a long time to execute.
+add_flang_nongtest_unittest(thorough-test
+  SLOW_TEST
   FortranDecimal
-  LLVMSupport
 )

flang/unittests/Evaluate/CMakeLists.txt

 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 add_library(FortranEvaluateTesting
   testing.cpp
   fp-testing.cpp
 )
-
+    if (LLVM_LINK_LLVM_DYLIB)
+      set(llvm_libs LLVM)
+    else()
+      llvm_map_components_to_libnames(llvm_libs Support)
+    endif()
     target_link_libraries(FortranEvaluateTesting
-  LLVMSupport
-)
+      ${llvm_libs})
 
 add_flang_nongtest_unittest(leading-zero-bit-count
   FortranEvaluateTesting
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(bit-population-count
   FortranEvaluateTesting
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(uint128
   FortranEvaluateTesting
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(expression
   FortranCommon
   FortranEvaluateTesting
   FortranEvaluate
   FortranSemantics
   FortranParser
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(integer
   FortranEvaluateTesting
   FortranEvaluate
   FortranSemantics
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(intrinsics
   FortranCommon
   FortranEvaluateTesting
   FortranEvaluate
   FortranDecimal
   FortranSemantics
   FortranParser
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(logical
   FortranEvaluateTesting
   FortranEvaluate
   FortranSemantics
-  LLVMSupport
 )
 
 # GCC -fno-exceptions breaks the fenv.h interfaces needed to capture
 # IEEE exception flags (different use of the word "exception")
 # in the actual hardware floating-point status register, so ensure that
 # C++ exceptions are enabled for this test.
 set(LLVM_REQUIRES_EH ON)
 set(LLVM_REQUIRES_RTTI ON)
 add_flang_nongtest_unittest(real
   FortranEvaluateTesting
   FortranEvaluate
   FortranDecimal
   FortranSemantics
-  LLVMSupport
 )
 llvm_update_compile_flags(real.test)
 
 add_flang_nongtest_unittest(reshape
   FortranEvaluateTesting
   FortranSemantics
   FortranEvaluate
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(ISO-Fortran-binding
   FortranEvaluateTesting
   FortranEvaluate
   FortranSemantics
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(folding
   FortranCommon
   FortranEvaluateTesting
   FortranEvaluate
   FortranSemantics
-  LLVMSupport
 )

flang/unittests/Runtime/CMakeLists.txt

 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
 # RuntimeTesting needs exceptions enabled
 set(LLVM_REQUIRES_EH ON)
 set(LLVM_REQUIRES_RTTI ON)
 add_library(RuntimeTesting
   testing.cpp
 )
 llvm_update_compile_flags(RuntimeTesting)
 
 target_link_libraries(RuntimeTesting
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(format
   RuntimeTesting
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(hello
   RuntimeTesting
   FortranRuntime
-  LLVMSupport
 )
 
 # This test is not run by default as it requires input.
 add_executable(external-hello-world
   external-hello.cpp
 )
 
 target_link_libraries(external-hello-world
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(external-io
   RuntimeTesting
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(list-input
   RuntimeTesting
   FortranRuntime
-  LLVMSupport
 )
 
 add_flang_nongtest_unittest(character
   RuntimeTesting
   FortranRuntime
-  LLVMSupport
 )