[LLVM][CMake][MSVC] Install PDBs alongside executables #120683
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
mayanez
force-pushed
the
build/cmakepdb
branch
2 times, most recently
from
2c3e4a9 to
ac540f9
Compare
|
Ping Should probably also be tagged with |
|
@llvm/pr-subscribers-platform-windows Author: Miguel A. Arroyo (mayanez) Changes
Full diff: https://github.com/llvm/llvm-project/pull/120683.diff 1 Files Affected:
diff --git a/llvm/cmake/modules/AddLLVM.cmake b/llvm/cmake/modules/AddLLVM.cmake
index 54a54db338e695..48e2dfef148419 100644
--- a/llvm/cmake/modules/AddLLVM.cmake
+++ b/llvm/cmake/modules/AddLLVM.cmake
@@ -1489,6 +1489,11 @@ macro(llvm_add_tool project name)
${export_to_llvmexports}
RUNTIME DESTINATION ${${project}_TOOLS_INSTALL_DIR}
COMPONENT ${name})
+ if (MSVC)
+ install(FILES $<TARGET_PDB_FILE:${name}>
+ DESTINATION "${${project}_TOOLS_INSTALL_DIR}" COMPONENT ${name}
+ OPTIONAL)
+ endif()
if (NOT LLVM_ENABLE_IDE)
add_llvm_install_targets(install-${name}
@@ -1519,6 +1524,11 @@ macro(add_llvm_example name)
add_llvm_executable(${name} EXPORT_SYMBOLS ${ARGN})
if( LLVM_BUILD_EXAMPLES )
install(TARGETS ${name} RUNTIME DESTINATION "${LLVM_EXAMPLES_INSTALL_DIR}")
+ if (MSVC)
+ install(FILES $<TARGET_PDB_FILE:${name}>
+ DESTINATION "${LLVM_EXAMPLES_INSTALL_DIR}" COMPONENT ${name}
+ OPTIONAL)
+ endif()
endif()
get_subproject_title(subproject_title)
set_target_properties(${name} PROPERTIES FOLDER "${subproject_title}/Examples")
@@ -1553,6 +1563,11 @@ macro(add_llvm_utility name)
${export_to_llvmexports}
RUNTIME DESTINATION ${LLVM_UTILS_INSTALL_DIR}
COMPONENT ${name})
+ if (MSVC)
+ install(FILES $<TARGET_PDB_FILE:${name}>
+ DESTINATION "${LLVM_UTILS_INSTALL_DIR}" COMPONENT ${name}
+ OPTIONAL)
+ endif()
if (NOT LLVM_ENABLE_IDE)
add_llvm_install_targets(install-${name}
|
|
I think the reason why we weren’t doing it before is a concern of installation size. I agree having the PDBs would be useful. I’d rather prefer publishing them on a symbol server, and pull them on-demand instead. |
compnerd
reviewed
Jan 14, 2025
There was a problem hiding this comment.
I think that you should use LLVM_ENABLE_PDB instead of MSVC for the condition. However, I agree with @aganea that size is a concern. OTOH, this is primarily either used for staging and then subsequently building the installer (which could/would drop the PDB, so the distribution size shouldn't be impacted, in theory) or it is for the developer installing it to the system for some reason.
I think that @zmodem should verify that the installer would not package up the PDBs.
That's a good callout! I can make the change for that.
While orthogonal, wouldn't having them in the
Yes, if the installer doesn't pick it up that would be ideal. Otherwise, I can take a look at that next. |
I think with the current version of the patch, the PDBs would end up in the installer (I didn't have time to try it yet though). However if you gate it behind |
mayanez
force-pushed
the
build/cmakepdb
branch
from
ac540f9 to
aa5aada
Compare
|
I've updated it to use |
compnerd
approved these changes
Feb 6, 2025
This was referenced Feb 11, 2025
Icohedron
pushed a commit
to Icohedron/llvm-project
that referenced
this pull request
Feb 11, 2025
* When building on Windows hosts, PDBs aren't installed to the `CMAKE_INSTALL_PREFIX`. * This PR addresses it solely for `llvm-*` executables. * Similar changes are required in `AddClang.cmake`, `AddLLD.cmake`, etc. I'd be happy to queue those PRs after this one.
mayanez
added a commit
that referenced
this pull request
Feb 12, 2025
* Follows up on #120683 enabling PDBs for `clang`.
github-actions bot
pushed a commit
to arm/arm-toolchain
that referenced
this pull request
Feb 12, 2025
…126675) * Follows up on llvm/llvm-project#120683 enabling PDBs for `clang`.
flovent
pushed a commit
to flovent/llvm-project
that referenced
this pull request
Feb 13, 2025
* Follows up on llvm#120683 enabling PDBs for `clang`.
joaosaffran
pushed a commit
to joaosaffran/llvm-project
that referenced
this pull request
Feb 14, 2025
* When building on Windows hosts, PDBs aren't installed to the `CMAKE_INSTALL_PREFIX`. * This PR addresses it solely for `llvm-*` executables. * Similar changes are required in `AddClang.cmake`, `AddLLD.cmake`, etc. I'd be happy to queue those PRs after this one.
joaosaffran
pushed a commit
to joaosaffran/llvm-project
that referenced
this pull request
Feb 14, 2025
* Follows up on llvm#120683 enabling PDBs for `clang`.
sivan-shani
pushed a commit
to sivan-shani/llvm-project
that referenced
this pull request
Feb 24, 2025
* When building on Windows hosts, PDBs aren't installed to the `CMAKE_INSTALL_PREFIX`. * This PR addresses it solely for `llvm-*` executables. * Similar changes are required in `AddClang.cmake`, `AddLLD.cmake`, etc. I'd be happy to queue those PRs after this one.
sivan-shani
pushed a commit
to sivan-shani/llvm-project
that referenced
this pull request
Feb 24, 2025
* Follows up on llvm#120683 enabling PDBs for `clang`.
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/98/builds/1156 Here is the relevant piece of the build log for the reference |
mayanez
added a commit
that referenced
this pull request
May 23, 2025
* Follows up on #120683 installing PDBs for LLD.
llvm-sync bot
pushed a commit
to arm/arm-toolchain
that referenced
this pull request
May 23, 2025
…6680) * Follows up on llvm/llvm-project#120683 installing PDBs for LLD.
sivan-shani
pushed a commit
to sivan-shani/llvm-project
that referenced
this pull request
Jun 3, 2025
* Follows up on llvm#120683 installing PDBs for LLD.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When building on Windows hosts, PDBs aren't installed to the
CMAKE_INSTALL_PREFIX.This PR addresses it solely for
llvm-*executables.AddClang.cmake,AddLLD.cmake, etc. I'd be happy to queue those PRs after this one.