Build a flat LLDB.framework for embedded Darwin targets

[vsk]

Summary

This patch configures LLDB.framework to build as a flat unversioned
framework on non-macOS Darwin targets, which have never supported the
macOS framework layout.

This patch also renames the 'IOS' cmake variable to 'APPLE_EMBEDDED' to
reflect the fact that lldb is built for several different kinds of embedded
Darwin targets, not just iOS.

[JDevlieghere]

lldb/cmake/modules/LLDBFramework.cmake

6–38

I think you should be able to do this.

[vsk]

lldb/cmake/modules/LLDBFramework.cmake

6–38

I've tried factoring out the value for the VERSION property in the past and, if memory serves, this resulted in an unusable framework on iOS. I'd rather hold off on this for now.

[JDevlieghere]

Thanks!

lldb/cmake/modules/LLDBFramework.cmake

6–38

Alright, makes sense.

[smeenai]

lldb/cmake/modules/LLDBFramework.cmake

142–147

This bit appears to have been introduced by this revision, without any equivalent existing before. This is causing issues for us when we build an LLDB framework in LLVM 12, because Versions/Current/XPCServices doesn't exist, so the created symlink is dangling. Is there some other target which should be creating that directory? (This is the only instance of XPCServices I see in LLDB's build.)

[vsk]

lldb/cmake/modules/LLDBFramework.cmake

142–147

Thanks for catching this. I'm curious how you spotted this. It looks like we do have a target that sets up this directory, but that it's not upstream. It should be safe to remove this; we can reapply the change downstream if that happens.

[smeenai]

lldb/cmake/modules/LLDBFramework.cmake

142–147

There's a part of our build/distribution infrastructure which checksums the built directory, and it failed for LLVM 12 because it tried to follow the dangling symlink. I put up D97701 to remove this; thanks!

lldb/cmake/modules/LLDBConfig.cmake

if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   if (NOT CMAKE_CONFIGURATION_TYPES)
     add_llvm_install_targets(install-lldb-headers
                              COMPONENT lldb-headers)
   endif()
 endif()
 
 # Find Apple-specific libraries or frameworks that may be needed.
 if (APPLE)
-  if(NOT IOS)
+  if(NOT APPLE_EMBEDDED)
     find_library(CARBON_LIBRARY Carbon)
     find_library(CORE_SERVICES_LIBRARY CoreServices)
   endif()
   find_library(FOUNDATION_LIBRARY Foundation)
   find_library(CORE_FOUNDATION_LIBRARY CoreFoundation)
   find_library(SECURITY_LIBRARY Security)
   include_directories(${LIBXML2_INCLUDE_DIR})
 endif()

lldb/cmake/modules/LLDBFramework.cmake

 message(STATUS "LLDB.framework: build path is '${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}'")
 message(STATUS "LLDB.framework: install path is '${LLDB_FRAMEWORK_INSTALL_DIR}'")
 message(STATUS "LLDB.framework: resources subdirectory is 'Versions/${LLDB_FRAMEWORK_VERSION}/Resources'")
 
 # Configure liblldb as a framework bundle
+if(NOT APPLE_EMBEDDED)
   set_target_properties(liblldb PROPERTIES
     FRAMEWORK ON
     FRAMEWORK_VERSION ${LLDB_FRAMEWORK_VERSION}
 
     OUTPUT_NAME LLDB
     VERSION ${LLDB_VERSION}
     LIBRARY_OUTPUT_DIRECTORY ${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}
 
     # Compatibility version
     SOVERSION "1.0.0"
 
     MACOSX_FRAMEWORK_IDENTIFIER com.apple.LLDB.framework
     MACOSX_FRAMEWORK_BUNDLE_VERSION ${LLDB_VERSION}
     MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${LLDB_VERSION}
     MACOSX_FRAMEWORK_INFO_PLIST ${LLDB_SOURCE_DIR}/resources/LLDB-Info.plist.in
   )
+else()
+  set_target_properties(liblldb PROPERTIES
+    FRAMEWORK ON
+    FRAMEWORK_VERSION ${LLDB_FRAMEWORK_VERSION}
+
+    # Note: iOS doesn't specify version, as the framework layout is flat.
+    OUTPUT_NAME LLDB
+    LIBRARY_OUTPUT_DIRECTORY ${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}
+
+    MACOSX_FRAMEWORK_IDENTIFIER com.apple.LLDB.framework
+    MACOSX_FRAMEWORK_BUNDLE_VERSION ${LLDB_VERSION}
+    MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${LLDB_VERSION}
+    MACOSX_FRAMEWORK_INFO_PLIST ${LLDB_SOURCE_DIR}/resources/LLDB-Info.plist.in
+  )
+endif()
 
 # Used in llvm_add_library() to set default output directories for multi-config
 # generators. Overwrite to account for special framework output directory.
 set_output_directory(liblldb
   BINARY_DIR ${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}
   LIBRARY_DIR ${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}
 )
 
 lldb_add_post_install_steps_darwin(liblldb ${LLDB_FRAMEWORK_INSTALL_DIR})
 
 # Affects the layout of the framework bundle (default is macOS layout).
-if(IOS)
+if(APPLE_EMBEDDED)
   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()
 
 # Add -Wdocumentation parameter
 set(CMAKE_XCODE_ATTRIBUTE_CLANG_WARN_DOCUMENTATION_COMMENTS "YES")
 
+# On iOS, there is no versioned framework layout. Skip this symlink step.
+if(NOT APPLE_EMBEDDED)
   # Apart from this one, CMake creates all required symlinks in the framework bundle.
   add_custom_command(TARGET liblldb POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E create_symlink
             Versions/Current/Headers
             ${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}/LLDB.framework/Headers
     COMMENT "LLDB.framework: create Headers symlink"
   )
+endif()
 
 # At configuration time, collect headers for the framework bundle and copy them
 # into a staging directory. Later we can copy over the entire folder.
 file(GLOB public_headers ${LLDB_SOURCE_DIR}/include/lldb/API/*.h)
 file(GLOB root_public_headers ${LLDB_SOURCE_DIR}/include/lldb/lldb-*.h)
 file(GLOB root_private_headers ${LLDB_SOURCE_DIR}/include/lldb/lldb-private*.h)
 list(REMOVE_ITEM root_public_headers ${root_private_headers})
 

 
 # Wrap output in a target, so lldb-framework can depend on it.
 add_custom_target(liblldb-resource-headers DEPENDS ${lldb_staged_headers})
 set_target_properties(liblldb-resource-headers PROPERTIES FOLDER "lldb misc")
 add_dependencies(liblldb liblldb-resource-headers)
 
 # At build time, copy the staged headers into the framework bundle (and do
 # some post-processing in-place).
-if (NOT IOS)
 add_custom_command(TARGET liblldb POST_BUILD
   COMMAND ${CMAKE_COMMAND} -E copy_directory ${lldb_header_staging} $<TARGET_FILE_DIR:liblldb>/Headers
   COMMAND ${LLDB_SOURCE_DIR}/scripts/framework-header-fix.sh $<TARGET_FILE_DIR:liblldb>/Headers ${LLDB_VERSION}
   COMMENT "LLDB.framework: copy framework headers"
 )
-endif()
 
 # Copy vendor-specific headers from clang (without staging).
-if(NOT IOS)
+if(NOT APPLE_EMBEDDED)
   if (TARGET clang-resource-headers)
     add_dependencies(liblldb clang-resource-headers)
     set(clang_resource_headers_dir $<TARGET_PROPERTY:clang-resource-headers,RUNTIME_OUTPUT_DIRECTORY>)
   else()
     # In standalone builds try the best possible guess
     if(Clang_DIR)
       set(clang_lib_dir ${Clang_DIR}/../..)
     elseif(LLVM_DIR)
if(NOT APPLE_EMBEDDED)
   add_custom_command(TARGET liblldb POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy_directory
             ${clang_resource_headers_dir}
             $<TARGET_FILE_DIR:liblldb>/Resources/Clang/include
     COMMENT "LLDB.framework: copy clang vendor-specific headers"
   )
 endif()
 
+# IOS framework bundles are flat
+if(NOT APPLE_EMBEDDED)
+  add_custom_command(TARGET liblldb POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E create_symlink
+            Versions/Current/XPCServices
+            ${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}/LLDB.framework/XPCServices
+    COMMENT "LLDB.framework: create symlink XPCServices"
+  )
+endif()
+
 # Add an rpath pointing to the directory where LLDB.framework is installed.
 # This allows frameworks (relying on @rpath) to be installed in the same folder and found at runtime.
 set_property(TARGET liblldb APPEND PROPERTY INSTALL_RPATH
   "@loader_path/../../../")

lldb/source/Host/CMakeLists.txt

if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
     add_host_subdirectory(macosx
       macosx/cfcpp/CFCBundle.cpp
       macosx/cfcpp/CFCData.cpp
       macosx/cfcpp/CFCMutableArray.cpp
       macosx/cfcpp/CFCMutableDictionary.cpp
       macosx/cfcpp/CFCMutableSet.cpp
       macosx/cfcpp/CFCString.cpp
       )
-    if(IOS)
+    if(APPLE_EMBEDDED)
       set_property(SOURCE macosx/Host.mm APPEND PROPERTY
                COMPILE_DEFINITIONS "NO_XPC_SERVICES=1")
     endif()
 
 
   elseif (CMAKE_SYSTEM_NAME MATCHES "Linux|Android")
     add_host_subdirectory(linux
       linux/AbstractSocket.cpp

lldb/tools/debugserver/source/CMakeLists.txt

 # Override locally, so the identity is used for targets created in this scope.
 set(LLVM_CODESIGNING_IDENTITY ${debugserver_codesign_identity})
 
 # Use the same identity later in the test suite.
 set_property(GLOBAL PROPERTY
   LLDB_DEBUGSERVER_CODESIGN_IDENTITY ${debugserver_codesign_identity})
 
 if(APPLE)
-  if(IOS)
+  if(APPLE_EMBEDDED)
     find_library(BACKBOARD_LIBRARY BackBoardServices
       PATHS ${CMAKE_OSX_SYSROOT}/System/Library/PrivateFrameworks)
     find_library(FRONTBOARD_LIBRARY FrontBoardServices
       PATHS ${CMAKE_OSX_SYSROOT}/System/Library/PrivateFrameworks)
     find_library(SPRINGBOARD_LIBRARY SpringBoardServices
       PATHS ${CMAKE_OSX_SYSROOT}/System/Library/PrivateFrameworks)
     find_library(MOBILESERVICES_LIBRARY MobileCoreServices
       PATHS ${CMAKE_OSX_SYSROOT}/System/Library/PrivateFrameworks)
     find_library(LOCKDOWN_LIBRARY lockdown)
 
     if(NOT BACKBOARD_LIBRARY)
       set(SKIP_TEST_DEBUGSERVER ON CACHE BOOL "" FORCE)
     endif()
   endif()
 endif()
 
 if(HAVE_LIBCOMPRESSION)
   set(LIBCOMPRESSION compression)
 endif()
 
 if(LLDB_USE_ENTITLEMENTS)
-  if(IOS)
+  if(APPLE_EMBEDDED)
     set(entitlements ${CMAKE_CURRENT_SOURCE_DIR}/debugserver-entitlements.plist)
   else()
     # Same entitlements file as used for lldb-server
     set(entitlements ${LLDB_SOURCE_DIR}/resources/debugserver-macosx-entitlements.plist)
   endif()
 endif()
 
 add_definitions(-DLLDB_USE_OS_LOG)
COMMAND ${CMAKE_COMMAND} -E
             xcrun codesign -f -s ${debugserver_codesign_identity}
             ${pass_entitlements} ${copy_location}
     COMMENT "Code-sign debugserver copy in the build-tree framework: ${copy_location}"
   )
 endif()
 
 set_target_properties(debugserver PROPERTIES FOLDER "lldb libraries/debugserver")
 
-if(IOS)
+if(APPLE_EMBEDDED)
   set_property(TARGET lldbDebugserverCommon APPEND PROPERTY COMPILE_DEFINITIONS
     WITH_LOCKDOWN
     WITH_FBS
     WITH_BKS
     )
   set_property(TARGET debugserver APPEND PROPERTY COMPILE_DEFINITIONS
     WITH_LOCKDOWN
     WITH_FBS

lldb/tools/lldb-server/CMakeLists.txt

 if(CMAKE_SYSTEM_NAME MATCHES "Darwin")
   list(APPEND LLDB_PLUGINS lldbPluginObjectFileMachO)
 elseif(CMAKE_SYSTEM_NAME MATCHES "Windows")
   list(APPEND LLDB_PLUGINS lldbPluginObjectFilePECOFF)
 else()
   list(APPEND LLDB_PLUGINS lldbPluginObjectFileELF)
 endif()
 
-if(IOS)
+if(APPLE_EMBEDDED)
   if(LLDB_CODESIGN_IDENTITY)
     # Use explicit LLDB identity
     set(LLVM_CODESIGNING_IDENTITY ${LLDB_CODESIGN_IDENTITY})
   else()
     # Use explicit LLVM identity or default to lldb_codesign if empty
     if(NOT LLVM_CODESIGNING_IDENTITY)
       set(LLVM_CODESIGNING_IDENTITY lldb_codesign)
     endif()

lldb/unittests/debugserver/CMakeLists.txt

add_lldb_unittest(debugserverTests
   LINK_COMPONENTS
     Support
   )
 
 target_include_directories(debugserverTests PRIVATE
   ${LLDB_SOURCE_DIR}/tools/debugserver/source
   ${LLDB_SOURCE_DIR}/tools/debugserver/source/MacOSX)
 
-if(IOS)
+if(APPLE_EMBEDDED)
   set_property(TARGET debugserverTests APPEND PROPERTY COMPILE_DEFINITIONS
       WITH_LOCKDOWN
       WITH_FBS
       WITH_BKS
       )
 
   add_lldb_unittest(debugserverNonUITests
     JSONTest.cpp