Introduce install-lldb-framework target

[xiaobai]

Summary

Previously, I thought that install-liblldb would fail because CMake had
a bug related to installing frameworks. In actuality, I misunderstood the
semantics of add_custom_target: the DEPENDS option refers to specific files,
not targets. Therefore install-liblldb should rely on the actual liblldb
getting generated rather than the target.

This means that the previous patch I committed (to stop relying on CMake's
framework support) is no longer needed and has been reverted. Using CMake's
framework support greatly simplifies the implementation.

install-lldb-framework (and the stripped variant) is as simple as
depending on install-liblldb because CMake knows that liblldb was built as a
framework and will install the whole framework for you. The stripped variant
will depend on the stripped variants of individual tools only to ensure they
actually are stripped as well.

[xiaobai]

Using this patch, I was able to build the lldb framework and install it. I configured with:

cmake .. -G Ninja -DCMAKE_BUILD_TYPE=Release -DLLDB_CODESIGN_IDENTITY="" -DLLDB_BUILD_FRAMEWORK=1 -DLLDB_USE_SYSTEM_SIX=1 -DCMAKE_INSTALL_PREFIX="" -DLLVM_TARGETS_TO_BUILD="X86;ARM;AArch64" -DSKIP_DEBUGSERVER=1 -DLLVM_DISTRIBUTION_COMPONENTS="lldb;lldb-framework"

and built with:

DESTDIR=/Users/apl/code/llvm/build/tmp ninja install-distribution

This built and installed lldb at DESTDIR. I used the installed lldb to debug a small test binary.

[labath]

I am glad filing the cmake bug has paid off. :)

I just have one small question about this patch.

cmake/modules/AddLLDB.cmake

88–94

Shouldn't this be also guarded under the NOT LLVM_INSTALL_TOOLCHAIN_ONLY, like the code above? If someone sets LLVM_INSTALL_TOOLCHAIN_ONLY=True, then the install-liblldb target will not even be generated and these lines will fail (or just do something weird).

[xiaobai]

In D50038#1181817, @labath wrote:

I am glad filing the cmake bug has paid off. :)

Same! :)

cmake/modules/AddLLDB.cmake

88–94

Ahh, yeah I think you're right. I think it should actually be a level deeper in if (NOT CMAKE_CONFIGURATION_TYPES). I'll amend this.

[xiaobai]

Address comments

[labath]

lgtm

[clayborg]

Might be nice to put a blurb in the build page about this in the MacOS section?

[xiaobai]

In D50038#1184445, @clayborg wrote:

Might be nice to put a blurb in the build page about this in the MacOS section?

Yep, I think that wouldn't be a bad idea. I can handle that in a separate commit. Might be nice for one of the buildbots to use this method of building as well. :P

CMakeLists.txt

 if(LLDB_BUILD_FRAMEWORK)
   if (CMAKE_VERSION VERSION_LESS 3.7)
     message(FATAL_ERROR "LLDB_BUILD_FRAMEWORK is not supported on CMake < 3.7")
   endif()
   if (NOT APPLE)
     message(FATAL_ERROR "LLDB.framework can only be generated when targeting Apple platforms")
   endif()
 
+  add_custom_target(lldb-framework)
   # These are used to fill out LLDB-Info.plist. These are relevant when building
   # the framework, and must be defined before building liblldb.
   set(PRODUCT_NAME "LLDB")
   set(EXECUTABLE_NAME "LLDB")
   set(CURRENT_PROJECT_VERSION "360.99.0")
   set(LLDB_SUITE_TARGET lldb-framework)
 
   set(LLDB_FRAMEWORK_DIR
     ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${LLDB_FRAMEWORK_INSTALL_DIR})
+  include(LLDBFramework)
 endif()
 
 add_subdirectory(docs)
 if (NOT LLDB_DISABLE_PYTHON)
   if(LLDB_USE_SYSTEM_SIX)
     set(SIX_EXTRA_ARGS "--useSystemSix")
   endif()
 
if(LLDB_INCLUDE_TESTS)
   endif()
 
   add_subdirectory(test)
   add_subdirectory(unittests)
   add_subdirectory(lit)
   add_subdirectory(utils/lldb-dotest)
 endif()
 
-if (LLDB_BUILD_FRAMEWORK)
-  add_custom_target(lldb-framework)
-  include(LLDBFramework)
-endif()
 
 if (NOT LLDB_DISABLE_PYTHON)
     # Add a Post-Build Event to copy over Python files and create the symlink
     # to liblldb.so for the Python API(hardlink on Windows)
     add_custom_target(finish_swig ALL
         COMMAND
            ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/scripts/finishSwigWrapperClasses.py
                --srcRoot=${LLDB_SOURCE_DIR}

cmake/modules/AddLLDB.cmake

llvm_add_library(${name} ${libkind} ${srcs} LINK_LIBS
                                 ${PARAM_LINK_LIBS}
                                 DEPENDS ${PARAM_DEPENDS})
 
     if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ${name} STREQUAL "liblldb")
       if (PARAM_SHARED)
         set(out_dir lib${LLVM_LIBDIR_SUFFIX})
         if(${name} STREQUAL "liblldb" AND LLDB_BUILD_FRAMEWORK)
           set(out_dir ${LLDB_FRAMEWORK_INSTALL_DIR})
+          # The framework that is generated will install with install-liblldb
+          # because we enable CMake's framework support. CMake will copy all the
+          # headers and resources for us.
+          add_dependencies(install-lldb-framework install-${name})
+          add_dependencies(install-lldb-framework-stripped install-${name}-stripped)
         endif()
         install(TARGETS ${name}
           COMPONENT ${name}
           RUNTIME DESTINATION bin
           LIBRARY DESTINATION ${out_dir}
           ARCHIVE DESTINATION ${out_dir})
       else()
         install(TARGETS ${name}
           COMPONENT ${name}
           LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
           ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX})
       endif()
       if (NOT CMAKE_CONFIGURATION_TYPES)
         add_llvm_install_targets(install-${name}
-                                 DEPENDS ${name}
+                                 DEPENDS $<TARGET_FILE:${name}>
                                  COMPONENT ${name})
+
+        # install-liblldb{,-stripped} is the actual target that will install the
+        # framework, so it must rely on the framework being fully built first.
+        if (LLDB_BUILD_FRAMEWORK AND ${name} STREQUAL "liblldb")
+          add_dependencies(install-${name} lldb-framework)
+          add_dependencies(install-lldb-framework-stripped lldb-framework)
         endif()
       endif()
     endif()
+  endif()
+
 
   # Hack: only some LLDB libraries depend on the clang autogenerated headers,
   # but it is simple enough to make all of LLDB depend on some of those
   # headers without negatively impacting much of anything.
   add_dependencies(${name} clang-tablegen-targets)
 
   # Add in any extra C++ compilation flags for this library.
   target_compile_options(${name} PRIVATE ${PARAM_EXTRA_CXXFLAGS})
 
   set_target_properties(${name} PROPERTIES FOLDER "lldb libraries")
 endfunction(add_lldb_library)
 
 function(add_lldb_executable name)
   cmake_parse_arguments(ARG
     "INCLUDE_IN_SUITE;GENERATE_INSTALL"
set_target_properties(${name} PROPERTIES
           BUILD_WITH_INSTALL_RPATH On
           INSTALL_RPATH "@loader_path/../${LLDB_FRAMEWORK_INSTALL_DIR}")
   endif()
 
   if(ARG_GENERATE_INSTALL)
     set(out_dir "bin")
     if (LLDB_BUILD_FRAMEWORK AND ARG_INCLUDE_IN_SUITE)
       set(out_dir ${LLDB_FRAMEWORK_INSTALL_DIR}/${LLDB_FRAMEWORK_RESOURCE_DIR})
+      # While install-liblldb-stripped will handle copying the tools, it will
+      # not strip them. We depend on this target to guarantee a stripped version
+      # will get installed in the framework.
+      add_dependencies(install-lldb-framework-stripped install-${name}-stripped)
     endif()
     install(TARGETS ${name}
           COMPONENT ${name}
           RUNTIME DESTINATION ${out_dir})
     if (NOT CMAKE_CONFIGURATION_TYPES)
       add_llvm_install_targets(install-${name}
                                DEPENDS ${name}
                                COMPONENT ${name})

cmake/modules/LLDBFramework.cmake

if (NOT IOS)
   endif()
   add_custom_command(TARGET lldb-framework POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E create_symlink Versions/Current/Headers ${LLDB_FRAMEWORK_DIR}/LLDB.framework/Headers
     COMMAND ${CMAKE_COMMAND} -E create_symlink ${LLDB_FRAMEWORK_VERSION} ${LLDB_FRAMEWORK_DIR}/LLDB.framework/Versions/Current
     COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX}/clang/${LLDB_VERSION} $<TARGET_FILE_DIR:liblldb>/Resources/Clang
   )
 endif()
 
-set_target_properties(liblldb PROPERTIES
-  OUTPUT_NAME LLDB
-  FRAMEWORK On
-  FRAMEWORK_VERSION ${LLDB_FRAMEWORK_VERSION}
-  MACOSX_FRAMEWORK_INFO_PLIST ${LLDB_SOURCE_DIR}/resources/LLDB-Info.plist
-  LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${LLDB_FRAMEWORK_INSTALL_DIR}
-  PUBLIC_HEADER "${framework_headers}")
-
 add_dependencies(lldb-framework
   lldb-framework-headers
   lldb-suite)
+
+add_custom_target(install-lldb-framework)
+add_custom_target(install-lldb-framework-stripped)

source/API/CMakeLists.txt

if ( CMAKE_SYSTEM_NAME MATCHES "Windows" )
   endif()
 else()
   set_target_properties(liblldb
     PROPERTIES
     OUTPUT_NAME lldb
   )
 endif()
 
+if (LLDB_BUILD_FRAMEWORK)
+  set_target_properties(liblldb
+    PROPERTIES
+    OUTPUT_NAME LLDB
+    FRAMEWORK On
+    FRAMEWORK_VERSION ${LLDB_FRAMEWORK_VERSION}
+    MACOSX_FRAMEWORK_INFO_PLIST ${LLDB_SOURCE_DIR}/resources/LLDB-Info.plist
+    LIBRARY_OUTPUT_DIRECTORY ${LLDB_FRAMEWORK_DIR}
+  )
+endif()
+
 if (LLDB_WRAP_PYTHON)
   add_dependencies(liblldb swig_wrapper)
 endif()