[CMake] LLDB.framework tools handling

[sgraenitz]

Summary

Modify the way LLDB.framework tools are collected. This allows for better fine-tuning of the install behavior downstream. Each target calls lldb_add_to_framework() individually. When entering the function, the target exists and we can tweak its very own post-build and install steps. This was not possible with the old LLDB_FRAMEWORK_TOOLS approach.

No function change otherwise.
This is a reduced follow-up from the proposal in D61952.

[sgraenitz]

lldb-vscode is no fremwork tool, but instead it needs the RPATHs

[JDevlieghere]

lldb/tools/argdumper/CMakeLists.txt

9

Why do we need this in the framework? Is it only there for testing?

lldb/tools/darwin-debug/CMakeLists.txt

6

Presumably this should be darwin-debug. But do we need it at all?

[friss]

lldb/tools/argdumper/CMakeLists.txt

9

It is definitely use by our process launch code.

lldb/tools/darwin-debug/CMakeLists.txt

6

I think it has come in handy a handful of times to debug some issues. It's not needed for LLDB to do its job though.

[sgraenitz]

Fix copy/paste mistake for darwin-debug

[sgraenitz]

Thanks for having a look. I'd to focus on the mechanism here and keep the contents of the framework bundle unchanged. Happy to discuss this in separate reviews like D62474.

lldb/tools/darwin-debug/CMakeLists.txt

6

Thanks for catching that one!

[xiaobai]

This is a much nicer solution. Thanks for doing this.

lldb/tools/debugserver/source/CMakeLists.txt

268

This should be debugserver.

[JDevlieghere]

lldb/tools/argdumper/CMakeLists.txt

9

I see, apparently it's used from Host::ShellExpandArguments

[clayborg]

lldb/tools/darwin-debug/CMakeLists.txt

6

We need it for launching in a terminal on macOS. So it actually is needed for "process launch --tty" on macOS

[sgraenitz]

Fixed debugserver; excluded changes in add_lldb_library() for now; result of this test looks as good as before:

$ cmake -GNinja -C../llvm-project/lldb/cmake/caches/Apple-lldb-macOS.cmake -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi;lldb" ../llvm-project/llvm
$ ninja lldb lldb-argdumper lldb-server darwin-debug debugserver lldb-framework
$ DESTDIR=install ninja install

[jingham]

The typical trick for doing argument substitution before debugging was roughly to debug:

exec /bin/sh executable arg1 arg2 ...

then follow through the shell to the executable. That failed when SIP made it impossible to debug any of the shells, so we had to come up with another way to do shell expansion. That's what argdumper does. We run that under the user's shell and it just dumps the args array in a structured output so we can launch directly with those expanded arguments.

lldb/CMakeLists.txt

if(APPLE)
       endif()
     endif()
   endif()
 
   if(TARGET dsymutil)
     list(APPEND LLDB_TEST_DEPS dsymutil)
   endif()
 
+  if(TARGET lldb-framework)
+    list(APPEND LLDB_TEST_DEPS lldb-framework)
+  endif()
+
   add_custom_target(lldb-test-deps)
   add_dependencies(lldb-test-deps ${LLDB_TEST_DEPS})
 
   add_subdirectory(test)
   add_subdirectory(unittests)
   add_subdirectory(lit)
   add_subdirectory(utils/lit-cpuid)
   add_subdirectory(utils/lldb-dotest)

lldb/cmake/modules/AddLLDB.cmake

else()
 
     llvm_add_library(${name} ${libkind} ${srcs}
       LINK_LIBS ${PARAM_LINK_LIBS}
       DEPENDS ${PARAM_DEPENDS}
       ${pass_ENTITLEMENTS}
       ${pass_NO_INSTALL_RPATH}
     )
 
-    if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ${name} STREQUAL "liblldb")
+    if (NOT LLDB_BUILD_FRAMEWORK AND (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ${name} STREQUAL "liblldb"))
       if (PARAM_SHARED)
-        if(${name} STREQUAL "liblldb" AND LLDB_BUILD_FRAMEWORK)
-          if(LLDB_FRAMEWORK_INSTALL_DIR)
-            set(install_dir ${LLDB_FRAMEWORK_INSTALL_DIR})
-          else()
-            set(install_dir ".")
-          endif()
-        else()
-          set(install_dir lib${LLVM_LIBDIR_SUFFIX})
-        endif()
         install(TARGETS ${name}
           COMPONENT ${name}
           RUNTIME DESTINATION bin
           LIBRARY DESTINATION ${install_dir}
           ARCHIVE DESTINATION ${install_dir})
       else()
         install(TARGETS ${name}
           COMPONENT ${name}
function(lldb_setup_framework_rpaths_in_tool name)
   set_target_properties(${name} PROPERTIES
     BUILD_WITH_INSTALL_RPATH OFF
     BUILD_RPATH "${framework_target_dir}"
     INSTALL_RPATH "${rpaths_install_tree}"
   )
 
   add_dependencies(${name} lldb-framework)
 endfunction()
+
+# Unified handling for executable LLDB.framework resources. Given the name of an
+# executable target, this function adds a post-build step to copy it to the
+# framework bundle in the build-tree.
+function(lldb_add_to_framework name)
+  set(subdir "LLDB.framework/Versions/${LLDB_FRAMEWORK_VERSION}/Resources")
+
+  # Destination for the copy in the build-tree. While the framework target may
+  # not exist yet, it will exist when the generator expression gets expanded.
+  set(copy_dest "$<TARGET_FILE_DIR:liblldb>/../../../${subdir}")
+
+  # Copy into the framework's Resources directory for testing.
+  add_custom_command(TARGET ${name} POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:${name}> ${copy_dest}
+    COMMENT "Copy ${name} to ${copy_dest}"
+  )
+endfunction()
+
+# CMake's set_target_properties() doesn't allow to pass lists for RPATH
+# properties directly (error: "called with incorrect number of arguments").
+# Instead of defining two list variables each time, use this helper function.
+function(lldb_setup_rpaths name)
+  cmake_parse_arguments(LIST "" "" "BUILD_RPATH;INSTALL_RPATH" ${ARGN})
+  set_target_properties(${name} PROPERTIES
+    BUILD_WITH_INSTALL_RPATH OFF
+    BUILD_RPATH "${LIST_BUILD_RPATH}"
+    INSTALL_RPATH "${LIST_INSTALL_RPATH}"
+  )
+endfunction()
 No newline at end of file

lldb/cmake/modules/LLDBConfig.cmake

if(LLDB_BUILD_FRAMEWORK)
   # CMake < 3.8 did not have the BUILD_RPATH target property
   if(CMAKE_VERSION VERSION_LESS 3.8)
     message(FATAL_ERROR "LLDB_BUILD_FRAMEWORK is not supported on CMake < 3.8")
   endif()
 
   set(LLDB_FRAMEWORK_VERSION A CACHE STRING "LLDB.framework version (default is A)")
   set(LLDB_FRAMEWORK_BUILD_DIR bin CACHE STRING "Output directory for LLDB.framework")
   set(LLDB_FRAMEWORK_INSTALL_DIR Library/Frameworks CACHE STRING "Install directory for LLDB.framework")
-  set(LLDB_FRAMEWORK_TOOLS darwin-debug;debugserver;lldb-argdumper;lldb-server CACHE STRING
-      "List of tools to include in LLDB.framework/Resources")
 
   # Set designated directory for all dSYMs. Essentially, this emits the
   # framework's dSYM outside of the framework directory.
   if(LLVM_EXTERNALIZE_DEBUGINFO)
     set(LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/bin CACHE STRING
         "Directory to emit dSYM files stripped from executables and libraries (Darwin Only)")
   endif()
 endif()

lldb/cmake/modules/LLDBFramework.cmake

if(IOS)
   set_target_properties(liblldb PROPERTIES
     XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET "${IPHONEOS_DEPLOYMENT_TARGET}")
 else()
   set_target_properties(liblldb PROPERTIES
     XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGET "${MACOSX_DEPLOYMENT_TARGET}")
 endif()
 
 # Target to capture extra steps for a fully functional framework bundle.
-add_custom_target(lldb-framework)
+add_custom_target(lldb-framework ALL)
 add_dependencies(lldb-framework liblldb)
 
-# Dependencies are defined once tools are added (see AddLLDB.cmake)
-if(LLDB_FRAMEWORK_TOOLS)
-  message(STATUS "LLDB.framework: adding tools ${LLDB_FRAMEWORK_TOOLS}")
-  foreach(tool ${LLDB_FRAMEWORK_TOOLS})
-    add_custom_command(TARGET lldb-framework POST_BUILD
-      COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:${tool}> $<TARGET_FILE_DIR:liblldb>/Resources
-      COMMENT "LLDB.framework: copy additional tool ${tool}"
-    )
-  endforeach()
-else()
-  message(WARNING "LLDB.framework: no additional tools configured (set via LLDB_FRAMEWORK_TOOLS)")
-endif()
-
 # Apart from this one, CMake creates all required symlinks in the framework bundle.
 add_custom_command(TARGET lldb-framework POST_BUILD
   COMMAND ${CMAKE_COMMAND} -E create_symlink
           Versions/Current/Headers
           ${framework_target_dir}/LLDB.framework/Headers
   COMMENT "LLDB.framework: create Headers symlink"
 )
 

lldb/tools/argdumper/CMakeLists.txt

 add_lldb_tool(lldb-argdumper
   argdumper.cpp
 
   LINK_LIBS
     lldbUtility
   )
+
+if(LLDB_BUILD_FRAMEWORK)
+  lldb_add_to_framework(lldb-argdumper)
+endif()

lldb/tools/darwin-debug/CMakeLists.txt

 add_lldb_tool(darwin-debug
   darwin-debug.cpp
   )
+
+if(LLDB_BUILD_FRAMEWORK)
+  lldb_add_to_framework(darwin-debug)
+endif()

lldb/tools/debugserver/source/CMakeLists.txt

add_lldb_tool(debugserver
 
     LINK_LIBS
       lldbDebugserverCommon
 
     ENTITLEMENTS
       ${entitlements}
     )
 
+  if(LLDB_BUILD_FRAMEWORK)
+    lldb_add_to_framework(lldb-argdumper)
+  endif()
+
   if(IOS)
     set_property(TARGET lldbDebugserverCommon APPEND PROPERTY COMPILE_DEFINITIONS
       WITH_LOCKDOWN
       WITH_FBS
       WITH_BKS
       )
     set_property(TARGET debugserver APPEND PROPERTY COMPILE_DEFINITIONS
       WITH_LOCKDOWN

lldb/tools/driver/CMakeLists.txt

 endif()
 
 add_dependencies(lldb
   LLDBOptionsTableGen
   ${tablegen_deps}
 )
 
 if(LLDB_BUILD_FRAMEWORK)
-  lldb_setup_framework_rpaths_in_tool(lldb)
+  # In the build-tree, we know the exact path to the framework directory.
+  # The installed framework can be in different locations.
+  get_target_property(framework_build_dir liblldb LIBRARY_OUTPUT_DIRECTORY)
+  lldb_setup_rpaths(lldb
+    BUILD_RPATH
+      "${framework_build_dir}"
+    INSTALL_RPATH
+      "@loader_path/../../../SharedFrameworks"
+      "@loader_path/../../System/Library/PrivateFrameworks"
+      "@loader_path/../../Library/PrivateFrameworks"
+  )
 endif()

lldb/tools/lldb-mi/CMakeLists.txt

LINK_LIBS
     ${host_lib}
     ${extra_libs}
 
   LINK_COMPONENTS
     Support
   )
 
 if(LLDB_BUILD_FRAMEWORK)
-  lldb_setup_framework_rpaths_in_tool(lldb-mi)
+  # In the build-tree, we know the exact path to the framework directory.
+  # The installed framework can be in different locations.
+  get_target_property(framework_build_dir liblldb LIBRARY_OUTPUT_DIRECTORY)
+  lldb_setup_rpaths(lldb-mi
+    BUILD_RPATH
+      "${framework_build_dir}"
+    INSTALL_RPATH
+      "@loader_path/../../../SharedFrameworks"
+      "@loader_path/../../System/Library/PrivateFrameworks"
+      "@loader_path/../../Library/PrivateFrameworks"
+  )
 endif()

lldb/tools/lldb-server/CMakeLists.txt

LINK_LIBS
       lldbPluginInstructionMIPS64
       ${LLDB_SYSTEM_LIBS}
 
     LINK_COMPONENTS
       Support
 )
 
 target_link_libraries(lldb-server PRIVATE ${LLDB_SYSTEM_LIBS})
+
+if(LLDB_BUILD_FRAMEWORK)
+  lldb_add_to_framework(lldb-server)
+endif()

lldb/tools/lldb-vscode/CMakeLists.txt

LINK_LIBS
     ${host_lib}
     ${extra_libs}
 
   LINK_COMPONENTS
     Support
   )
 
 if(LLDB_BUILD_FRAMEWORK)
-  lldb_setup_framework_rpaths_in_tool(lldb-vscode)
+  # In the build-tree, we know the exact path to the framework directory.
+  # The installed framework can be in different locations.
+  get_target_property(framework_build_dir liblldb LIBRARY_OUTPUT_DIRECTORY)
+  lldb_setup_rpaths(lldb-vscode
+    BUILD_RPATH
+      "${framework_build_dir}"
+    INSTALL_RPATH
+      "@loader_path/../../../SharedFrameworks"
+      "@loader_path/../../System/Library/PrivateFrameworks"
+      "@loader_path/../../Library/PrivateFrameworks"
+  )
 endif()