[LLVM][CMake][MSVC] Wrap linker flags for ICX on Windows #112680
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
The Intel C++ Compiler (ICX) passes linker flags through the driver unlike MSVC and clang-cl, and therefore needs them to be prefixed with `/Qoption,link` (the equivalent of `-Wl,` for gcc on *nix). Use `LINKER:` prefix wherever supported by cmake, when that's not possible fall-back to `${CMAKE_CXX_LINKER_WRAPPER_FLAG}`. CMake replaces these with `/Qoption,link` for ICX and with the empty string for MSVC and clang-cl. For `target_link_libraries` neither `LINKER:` (not supported prior to CMake 3.32) nor `${CMAKE_CXX_LINKER_WRAPPER_FLAG}` (does not begin with `-` would be taken as a library name) works, use `-Qoption,link` directly within a conditional generator expression that we're linking with ICX. For MSVC and clang-cl no functional change is intended. Tested by compiling with ICX and setting `CMAKE_(EXE|SHARED|STATIC|MODULE)_LINKER_FLAGS_INIT` to `-Werror=unknown-argument`. RFC: https://discourse.llvm.org/t/rfc-cmake-linker-flags-need-wl-equivalent-for-intel-c-icx-on-windows/82446 
llvmbot added cmake 
Member
| @llvm/pr-subscribers-llvm-support Author: Mészáros Gergely (Maetveis) ChangesThe Intel C++ Compiler (ICX) passes linker flags through the driver unlike MSVC and clang-cl, and therefore needs them to be prefixed with Use For For MSVC and clang-cl no functional change is intended. Tested by compiling with ICX and setting Full diff: https://github.com/llvm/llvm-project/pull/112680.diff 5 Files Affected:
diff --git a/llvm/cmake/modules/AddLLVM.cmake b/llvm/cmake/modules/AddLLVM.cmake index c62b5649facae1..9f5e4344b898a7 100644 --- a/llvm/cmake/modules/AddLLVM.cmake +++ b/llvm/cmake/modules/AddLLVM.cmake @@ -149,20 +149,20 @@ function(add_llvm_symbol_exports target_name export_file) set(export_file_linker_flag "${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}") if(MSVC) # cl.exe or clang-cl, i.e. MSVC style command line interface - set(export_file_linker_flag "/DEF:\"${export_file_linker_flag}\"") + set(export_file_linker_flag "LINKER:/DEF:${export_file_linker_flag}") elseif(CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC") # clang in msvc mode, calling a link.exe/lld-link style linker - set(export_file_linker_flag "-Wl,/DEF:\"${export_file_linker_flag}\"") + set(export_file_linker_flag "-Wl,/DEF:${export_file_linker_flag}") elseif(MINGW) # ${export_file_linker_flag}, which is the plain file name, works as is # when passed to the compiler driver, which then passes it on to the # linker as an input file. - set(export_file_linker_flag "\"${export_file_linker_flag}\"") + set(export_file_linker_flag "${export_file_linker_flag}") else() message(FATAL_ERROR "Unsupported Windows toolchain") endif() - set_property(TARGET ${target_name} APPEND_STRING PROPERTY - LINK_FLAGS " ${export_file_linker_flag}") + set_property(TARGET ${target_name} APPEND PROPERTY + LINK_OPTIONS "${export_file_linker_flag}") endif() add_custom_target(${target_name}_exports DEPENDS ${native_export_file}) diff --git a/llvm/cmake/modules/HandleLLVMOptions.cmake b/llvm/cmake/modules/HandleLLVMOptions.cmake index 990afafae0f94f..0112850928fae6 100644 --- a/llvm/cmake/modules/HandleLLVMOptions.cmake +++ b/llvm/cmake/modules/HandleLLVMOptions.cmake @@ -542,7 +542,7 @@ if(MSVC) # behavior was changed in CMake 2.8.11 (Issue 12437) to use the MSVC default # value (1 MB) which is not enough for us in tasks such as parsing recursive # C++ templates in Clang. - set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /STACK:10000000") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${CMAKE_CXX_LINKER_WRAPPER_FLAG}/STACK:10000000") elseif(MINGW OR CYGWIN) set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--stack,16777216") diff --git a/llvm/cmake/platforms/WinMsvc.cmake b/llvm/cmake/platforms/WinMsvc.cmake index 40d47f12c53ab7..00746c0826929d 100644 --- a/llvm/cmake/platforms/WinMsvc.cmake +++ b/llvm/cmake/platforms/WinMsvc.cmake @@ -324,6 +324,10 @@ if(case_sensitive_filesystem) -libpath:"${msvc_lib_symlinks_dir}") endif() +if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.25") + list(TRANSFORM LINK_FLAGS PREPEND "${CMAKE_CXX_LINKER_WRAPPER_FLAG}") +endif() + string(REPLACE ";" " " LINK_FLAGS "${LINK_FLAGS}") string(APPEND CMAKE_EXE_LINKER_FLAGS_INIT " ${LINK_FLAGS}") string(APPEND CMAKE_MODULE_LINKER_FLAGS_INIT " ${LINK_FLAGS}") diff --git a/llvm/lib/Support/CMakeLists.txt b/llvm/lib/Support/CMakeLists.txt index 97188b0672f032..531bdeaca12614 100644 --- a/llvm/lib/Support/CMakeLists.txt +++ b/llvm/lib/Support/CMakeLists.txt @@ -74,6 +74,14 @@ elseif( CMAKE_HOST_UNIX ) endif() endif( WIN32 ) +set(WL "") +if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.25" + AND MSVC + AND NOT CMAKE_GENERATOR MATCHES "Visual Studio") + #IntelLLVM requires to pass linker flags with a wrapper + set(WL "$<$<OR:$<LINK_LANG_AND_ID:C,IntelLLVM>,$<LINK_LANG_AND_ID:CXX,IntelLLVM>,$<LINK_LANG_AND_ID:Fortran,IntelLLVM>>:-Qoption,link,>") +endif() + # Delay load shell32.dll if possible to speed up process startup. set (delayload_flags) if (MSVC) @@ -81,7 +89,7 @@ if (MSVC) # than invoking `link.exe` directly. In such a case, the flags should be # marked as `-Xlinker` to pass them directly to the linker. As a temporary # workaround simply elide the delay loading. - set (delayload_flags $<$<NOT:$<LINK_LANGUAGE:Swift>>:delayimp -delayload:shell32.dll -delayload:ole32.dll>) + set (delayload_flags $<$<NOT:$<LINK_LANGUAGE:Swift>>:delayimp ${WL}-delayload:shell32.dll ${WL}-delayload:ole32.dll>) endif() # Link Z3 if the user wants to build it. @@ -104,16 +112,16 @@ if(LLVM_INTEGRATED_CRT_ALLOC) if((LLVM_INTEGRATED_CRT_ALLOC MATCHES "rpmalloc$") OR LLVM_ENABLE_RPMALLOC) add_compile_definitions(ENABLE_OVERRIDE ENABLE_PRELOAD) set(ALLOCATOR_FILES "${LLVM_INTEGRATED_CRT_ALLOC}/rpmalloc/rpmalloc.c") - set(delayload_flags "${delayload_flags} -INCLUDE:malloc") + set(delayload_flags "${delayload_flags} ${WL}-INCLUDE:malloc") elseif(LLVM_INTEGRATED_CRT_ALLOC MATCHES "snmalloc$") set(ALLOCATOR_FILES "${LLVM_INTEGRATED_CRT_ALLOC}/src/snmalloc/override/new.cc") - set(system_libs ${system_libs} "mincore.lib" "-INCLUDE:malloc") + set(system_libs ${system_libs} "mincore.lib" "${WL}-INCLUDE:malloc") elseif(LLVM_INTEGRATED_CRT_ALLOC MATCHES "mimalloc$") set(MIMALLOC_LIB "${LLVM_INTEGRATED_CRT_ALLOC}/out/msvc-x64/Release/mimalloc-static.lib") if(NOT EXISTS "${MIMALLOC_LIB}") message(FATAL_ERROR "Cannot find the mimalloc static library. To build it, first apply the patch from https://github.com/microsoft/mimalloc/issues/268 then build the Release x64 target through ${LLVM_INTEGRATED_CRT_ALLOC}\\ide\\vs2019\\mimalloc.sln") endif() - set(system_libs ${system_libs} "${MIMALLOC_LIB}" "-INCLUDE:malloc") + set(system_libs ${system_libs} "${MIMALLOC_LIB}" "${WL}-INCLUDE:malloc") endif() endif() diff --git a/llvm/tools/llvm-shlib/CMakeLists.txt b/llvm/tools/llvm-shlib/CMakeLists.txt index 0436bd973b44b9..ede3c5034e045f 100644 --- a/llvm/tools/llvm-shlib/CMakeLists.txt +++ b/llvm/tools/llvm-shlib/CMakeLists.txt @@ -188,7 +188,7 @@ if(LLVM_BUILD_LLVM_C_DYLIB AND MSVC) if (LLVM_INTEGRATED_CRT_ALLOC AND MSVC) # Make sure we search LLVMSupport first, before the CRT libs - set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -INCLUDE:malloc") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${CMAKE_CXX_LINKER_WRAPPER_FLAG}-INCLUDE:malloc") endif() endif() |
yingcong-wu approved these changes Oct 23, 2024
Collaborator
| LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/190/builds/8125 Here is the relevant piece of the build log for the reference |
Collaborator
| LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/146/builds/1442 Here is the relevant piece of the build log for the reference |
Closed
NoumanAmir657 pushed a commit to NoumanAmir657/llvm-project that referenced this pull request Nov 4, 2024
The Intel C++ Compiler (ICX) passes linker flags through the driver unlike MSVC and clang-cl, and therefore needs them to be prefixed with `/Qoption,link` (the equivalent of `-Wl,` for gcc on *nix). Use `LINKER:` prefix wherever supported by cmake, when that's not possible fall-back to `${CMAKE_CXX_LINKER_WRAPPER_FLAG}`. CMake replaces these with `/Qoption,link` for ICX and with the empty string for MSVC and clang-cl. For `target_link_libraries` neither `LINKER:` (not supported prior to CMake 3.32) nor `${CMAKE_CXX_LINKER_WRAPPER_FLAG}` (does not begin with `-` would be taken as a library name) works, use `-Qoption,link` directly within a conditional generator expression that we're linking with ICX. For MSVC and clang-cl no functional change is intended. Tested by compiling with ICX and setting `CMAKE_(EXE|SHARED|STATIC|MODULE)_LINKER_FLAGS_INIT` to `-Werror=unknown-argument`. RFC: https://discourse.llvm.org/t/rfc-cmake-linker-flags-need-wl-equivalent-for-intel-c-icx-on-windows/82446 Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
The Intel C++ Compiler (ICX) passes linker flags through the driver unlike MSVC and clang-cl, and therefore needs them to be prefixed with
/Qoption,link(the equivalent of-Wl,for gcc on *nix).Use
LINKER:prefix wherever supported by cmake, when that's not possible fall-back to${CMAKE_CXX_LINKER_WRAPPER_FLAG}. CMake replaces these with/Qoption,linkfor ICX and with the empty string for MSVC and clang-cl.For
target_link_librariesneitherLINKER:(not supported prior to CMake 3.32) nor${CMAKE_CXX_LINKER_WRAPPER_FLAG}(does not begin with-would be taken as a library name) works, use-Qoption,linkdirectly within a conditional generator expression that we're linking with ICX.For MSVC and clang-cl no functional change is intended.
Tested by compiling with ICX and setting
CMAKE_(EXE|SHARED|STATIC|MODULE)_LINKER_FLAGS_INITto-Werror=unknown-argument.RFC: https://discourse.llvm.org/t/rfc-cmake-linker-flags-need-wl-equivalent-for-intel-c-icx-on-windows/82446