Merge pull request #64102 from al45tair/backtracing/full-extra-shims

[Backtracing] Build work.

Author: al45tair

CMakeLists.txt

@@ -1152,6 +1152,7 @@ if(SWIFT_BUILD_STDLIB OR SWIFT_BUILD_SDK_OVERLAY)
   message(STATUS "Concurrency Support:                ${SWIFT_ENABLE_EXPERIMENTAL_CONCURRENCY}")
   message(STATUS "Distributed Support:                ${SWIFT_ENABLE_EXPERIMENTAL_DISTRIBUTED}")
   message(STATUS "String Processing Support:          ${SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING}")
+  message(STATUS "Backtracing Support:                ${SWIFT_ENABLE_BACKTRACING}")
   message(STATUS "Unicode Support:                    ${SWIFT_STDLIB_ENABLE_UNICODE_DATA}")
   message(STATUS "Reflection Support:                 ${SWIFT_ENABLE_EXPERIMENTAL_REFLECTION}")
   message(STATUS "Observation Support:                ${SWIFT_ENABLE_EXPERIMENTAL_OBSERVATION}")
@@ -1161,6 +1162,16 @@ else()
   message(STATUS "")
 endif()
 
+if(SWIFT_BUILD_LIBEXEC)
+  message(STATUS "Building Swift auxiliary executables for SDKs: ${SWIFT_SDKS}")
+  message(STATUS "")
+endif()
+
+if(SWIFT_BUILD_REMOTE_MIRROR)
+  message(STATUS "Building Swift Remote Mirror for SDKs: ${SWIFT_SDKS}")
+  message(STATUS "")
+endif()
+
 #
 # Find required dependencies.
 #
@@ -1246,6 +1257,19 @@ else()
   if(SWIFT_INCLUDE_TOOLS)
     add_subdirectory(stdlib/public/SwiftShims/swift/shims)
   endif()
+
+  # We might want to build Remote Mirror separately
+  if(SWIFT_BUILD_REMOTE_MIRROR)
+    add_subdirectory(stdlib/public/LLVMSupport)
+    add_subdirectory(stdlib/public/Demangling)
+    add_subdirectory(stdlib/public/Reflection)
+    add_subdirectory(stdlib/public/SwiftRemoteMirror)
+  endif()
+
+  # We might also want to build the things in libexec seaprately
+  if(SWIFT_BUILD_LIBEXEC)
+    add_subdirectory(stdlib/public/libexec)
+  endif()
 endif()
 
 if(SWIFT_INCLUDE_APINOTES)

cmake/modules/SwiftComponents.cmake

@@ -69,7 +69,7 @@
 # * llvm-toolchain-dev-tools -- install LLVM development tools useful in a shared toolchain
 # * dev -- headers and libraries required to use Swift compiler as a library.
 set(_SWIFT_DEFINED_COMPONENTS
-  "autolink-driver;back-deployment;compiler;clang-builtin-headers;clang-resource-dir-symlink;clang-builtin-headers-in-clang-resource-dir;stdlib;stdlib-experimental;sdk-overlay;static-mirror-lib;editor-integration;tools;testsuite-tools;toolchain-tools;toolchain-dev-tools;llvm-toolchain-dev-tools;dev;license;sourcekit-xpc-service;sourcekit-inproc;swift-remote-mirror;swift-remote-mirror-headers")
+  "autolink-driver;back-deployment;compiler;clang-builtin-headers;clang-resource-dir-symlink;clang-builtin-headers-in-clang-resource-dir;libexec;stdlib;stdlib-experimental;sdk-overlay;static-mirror-lib;editor-integration;tools;testsuite-tools;toolchain-tools;toolchain-dev-tools;llvm-toolchain-dev-tools;dev;license;sourcekit-xpc-service;sourcekit-inproc;swift-remote-mirror;swift-remote-mirror-headers")
 
 # The default install components include all of the defined components, except
 # for the following exceptions.

include/swift/Runtime/Backtrace.h

@@ -20,7 +20,7 @@
 #include "swift/Runtime/Config.h"
 
 #include "swift/shims/Visibility.h"
-#include "swift/shims/_SwiftBacktracing.h"
+#include "swift/shims/CrashInfo.h"
 
 #include <inttypes.h>
 

stdlib/CMakeLists.txt

@@ -224,6 +224,16 @@ if(SWIFT_STDLIB_ENABLE_SIB_TARGETS)
 endif()
 swift_create_stdlib_targets("swift-test-stdlib" "" FALSE)
 
+# Create the libexec targets
+swift_create_stdlib_targets("swift-libexec" "" TRUE)
+swift_create_stdlib_targets("swift-test-libexec" "" FALSE)
+
+# Check whether the Swift compiler we're using supports
+# -disable-implicit-backtracing-module-import
+include(SwiftImplicitImport)
+
+swift_supports_implicit_module("backtracing" SWIFT_COMPILER_SUPPORTS_BACKTRACING)
+
 # FIXME: Include the toolchain directory before the public directory. Otherwise
 # the clang resource directory symlink stops installing correctly.
 add_subdirectory(toolchain)

stdlib/cmake/modules/AddSwiftStdlib.cmake

@@ -1825,7 +1825,7 @@ function(add_swift_target_library name)
   endif()
 
   # Turn off implicit import of _Backtracing when building libraries
-  if(SWIFT_IMPLICIT_BACKTRACING_IMPORT)
+  if(SWIFT_COMPILER_SUPPORTS_BACKTRACING)
     list(APPEND SWIFTLIB_SWIFT_COMPILE_FLAGS "-Xfrontend;-disable-implicit-backtracing-module-import")
   endif()
 
@@ -2658,7 +2658,8 @@ endfunction()
 function(add_swift_target_executable name)
   set(SWIFTEXE_options
     EXCLUDE_FROM_ALL
-    BUILD_WITH_STDLIB)
+    BUILD_WITH_STDLIB
+    BUILD_WITH_LIBEXEC)
   set(SWIFTEXE_single_parameter_options
     INSTALL_IN_COMPONENT)
   set(SWIFTEXE_multiple_parameter_options
@@ -2715,10 +2716,12 @@ function(add_swift_target_executable name)
     list(APPEND SWIFTEXE_TARGET_COMPILE_FLAGS "-Xfrontend;-disable-implicit-backtracing-module-import")
   endif()
 
-  # All Swift executables depend on the standard library.
-  list(APPEND SWIFTEXE_TARGET_SWIFT_MODULE_DEPENDS Core)
-  # All Swift executables depend on the swiftSwiftOnoneSupport library.
-  list(APPEND SWIFTEXE_TARGET_SWIFT_MODULE_DEPENDS SwiftOnoneSupport)
+  if(SWIFT_BUILD_STDLIB)
+    # All Swift executables depend on the standard library.
+    list(APPEND SWIFTEXE_TARGET_SWIFT_MODULE_DEPENDS Core)
+    # All Swift executables depend on the swiftSwiftOnoneSupport library.
+    list(APPEND SWIFTEXE_TARGET_SWIFT_MODULE_DEPENDS SwiftOnoneSupport)
+  endif()
 
   # If target SDKs are not specified, build for all known SDKs.
   if("${SWIFTEXE_TARGET_TARGET_SDKS}" STREQUAL "")
@@ -2897,15 +2900,23 @@ function(add_swift_target_executable name)
       list(APPEND THIN_INPUT_TARGETS ${VARIANT_NAME})
     endforeach()
 
-    set(library_subdir "${SWIFT_SDK_${sdk}_LIB_SUBDIR}")
-    if(maccatalyst_build_flavor STREQUAL "ios-like")
-      set(library_subdir "${SWIFT_SDK_MACCATALYST_LIB_SUBDIR}")
+    if(SWIFTEXE_TARGET_BUILD_WITH_LIBEXEC)
+      set(library_subdir "${SWIFT_SDK_${sdk}_LIB_SUBDIR}")
+      if(maccatalyst_build_flavor STREQUAL "ios-like")
+        set(library_subdir "${SWIFT_SDK_MACCATALYST_LIB_SUBDIR}")
+      endif()
+
+      set(lipo_target_dir "${SWIFTLIBEXEC_DIR}/${library_subdir}")
+      set(lipo_suffix "")
+    else()
+      set(lipo_target_dir "${SWIFT_RUNTIME_OUTPUT_INTDIR}")
+      set(lipo_suffix "-${sdk}")
     endif()
 
     if("${sdk}" STREQUAL "WINDOWS")
-      set(UNIVERSAL_NAME "${SWIFTLIBEXEC_DIR}/${library_subdir}/${name}.exe")
+      set(UNIVERSAL_NAME "${lipo_target_dir}/${name}${lipo_suffix}.exe")
     else()
-      set(UNIVERSAL_NAME "${SWIFTLIBEXEC_DIR}/${library_subdir}/${name}")
+      set(UNIVERSAL_NAME "${lipo_target_dir}/${name}${lipo_suffix}")
     endif()
 
     set(lipo_target "${name}-${sdk}")
@@ -2990,5 +3001,14 @@ function(add_swift_target_executable name)
       endforeach()
     endif()
 
+    if(SWIFTEXE_TARGET_BUILD_WITH_LIBEXEC)
+      foreach(arch ${SWIFT_SDK_${sdk}_ARCHITECTURES})
+        set(variant "-${SWIFT_SDK_${sdk}_LIB_SUBDIR}-${arch}")
+        if(TARGET "swift-libexec${variant}")
+          add_dependencies("swift-libexec${variant}" ${lipo_target})
+        endif()
+      endforeach()
+    endif()
+
   endforeach()
 endfunction()

stdlib/public/Backtracing/Backtrace.swift

@@ -18,7 +18,6 @@ import Swift
 
 #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
 
-@_implementationOnly import Darwin.Mach
 @_implementationOnly import _SwiftBacktracingShims
 
 #endif
@@ -327,20 +326,20 @@ public struct Backtrace: CustomStringConvertible, Sendable {
   /// @returns A list of `Image`s.
   public static func captureImages() -> [Image] {
     #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-    return captureImages(for: mach_task_self_)
+    return captureImages(for: _swift_backtrace_task_self())
     #else
     return []
     #endif
   }
 
   #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-  private static func withDyldProcessInfo<T>(for task: task_t,
+  private static func withDyldProcessInfo<T>(for task: __swift_task_t,
                                              fn: (OpaquePointer?) throws -> T)
     rethrows -> T {
-    var kret: kern_return_t = KERN_SUCCESS
+    var kret = __swift_kern_return_t(_SWIFT_KERN_SUCCESS)
     let dyldInfo = _dyld_process_info_create(task, 0, &kret)
 
-    if kret != KERN_SUCCESS {
+    if kret != _SWIFT_KERN_SUCCESS {
       fatalError("error: cannot create dyld process info")
     }
 
@@ -357,7 +356,7 @@ public struct Backtrace: CustomStringConvertible, Sendable {
     var images: [Image] = []
 
     #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-    let task = process as! task_t
+    let task = process as! __swift_task_t
 
     withDyldProcessInfo(for: task) { dyldInfo in
       _dyld_process_info_for_each_image(dyldInfo) {
@@ -366,7 +365,7 @@ public struct Backtrace: CustomStringConvertible, Sendable {
         if let path = path, let uuid = uuid {
           let pathString = String(cString: path)
           let theUUID = Array(UnsafeBufferPointer(start: uuid,
-                                                count: MemoryLayout<uuid_t>.size))
+                                                  count: MemoryLayout<__swift_uuid_t>.size))
           let name: String
           if let slashIndex = pathString.lastIndex(of: "/") {
             name = String(pathString.suffix(from:
@@ -404,7 +403,7 @@ public struct Backtrace: CustomStringConvertible, Sendable {
   /// @returns A `SharedCacheInfo`.
   public static func captureSharedCacheInfo() -> SharedCacheInfo? {
     #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-    return captureSharedCacheInfo(for: mach_task_self_)
+    return captureSharedCacheInfo(for: _swift_backtrace_task_self())
     #else
     return nil
     #endif
@@ -413,13 +412,13 @@ public struct Backtrace: CustomStringConvertible, Sendable {
   @_spi(Internal)
   public static func captureSharedCacheInfo(for t: Any) -> SharedCacheInfo? {
     #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-    let task = t as! task_t
+    let task = t as! __swift_task_t
     return withDyldProcessInfo(for: task) { dyldInfo in
       var cacheInfo = dyld_process_cache_info()
       _dyld_process_info_get_cache(dyldInfo, &cacheInfo)
       let theUUID = withUnsafePointer(to: cacheInfo.cacheUUID) {
         Array(UnsafeRawBufferPointer(start: $0,
-                                     count: MemoryLayout<uuid_t>.size))
+                                     count: MemoryLayout<__swift_uuid_t>.size))
       }
       return SharedCacheInfo(uuid: theUUID,
                              baseAddress: Address(cacheInfo.cacheBaseAddress),

stdlib/public/Backtracing/BacktraceFormatter.swift

@@ -17,14 +17,6 @@
 
 import Swift
 
-#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-@_implementationOnly import Darwin
-#elseif os(Windows)
-@_implementationOnly import CRT
-#elseif os(Linux)
-@_implementationOnly import Glibc
-#endif
-
 @_implementationOnly import _SwiftBacktracingShims
 
 /// A backtrace formatting theme.
@@ -621,9 +613,11 @@ public struct BacktraceFormatter {
   /// with the point at which the program crashed highlighted.
   private func formattedSourceLines(from sourceLocation: SymbolicatedBacktrace.SourceLocation,
                                     indent theIndent: Int = 2) -> String? {
-    guard let fp = fopen(sourceLocation.path, "rt") else { return nil }
+    guard let fp = _swift_backtrace_fopen(sourceLocation.path, "rt") else {
+      return nil
+    }
     defer {
-      fclose(fp)
+      _swift_backtrace_fclose(fp)
     }
 
     let indent = String(repeating: " ", count: theIndent)
@@ -690,8 +684,8 @@ public struct BacktraceFormatter {
       }
     }
 
-    while feof(fp) == 0 && ferror(fp) == 0 {
-      guard let result = fgets(buffer.baseAddress,
+    while _swift_backtrace_feof(fp) == 0 && _swift_backtrace_ferror(fp) == 0 {
+      guard let result = _swift_backtrace_fgets(buffer.baseAddress,
                                CInt(buffer.count), fp) else {
         break
       }

stdlib/public/Backtracing/CMakeLists.txt

@@ -12,8 +12,14 @@
 
 set(swift_backtracing_link_libraries
   swiftCore
+  swift_Concurrency
 )
 
+set(concurrency)
+if(SWIFT_BUILD_STDLIB AND SWIFT_ENABLE_EXPERIMENTAL_CONCURRENCY)
+  set(concurrency _Concurrency)
+endif()
+
 set(BACKTRACING_SOURCES
   Backtrace.swift
   BacktraceFormatter.swift
@@ -24,6 +30,7 @@ set(BACKTRACING_SOURCES
   Registers.swift
   SymbolicatedBacktrace.swift
   Utils.swift
+  Shims.cpp
 
   get-cpu-context.${SWIFT_ASM_EXT}
 )
@@ -45,13 +52,7 @@ set(LLVM_OPTIONAL_SOURCES
 add_swift_target_library(swift_Backtracing ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES} IS_STDLIB
   ${BACKTRACING_SOURCES}
 
-  SWIFT_MODULE_DEPENDS_IOS Darwin _Concurrency
-  SWIFT_MODULE_DEPENDS_OSX Darwin _Concurrency
-  SWIFT_MODULE_DEPENDS_TVOS Darwin _Concurrency
-  SWIFT_MODULE_DEPENDS_WATCHOS Darwin _Concurrency
-  SWIFT_MODULE_DEPENDS_MACCATALYST Darwin _Concurrency
-  SWIFT_MODULE_DEPENDS_LINUX Glibc _Concurrency
-  SWIFT_MODULE_DEPENDS_WINDOWS CRT _Concurrency
+  SWIFT_MODULE_DEPENDS ${concurrency}
 
   LINK_LIBRARIES ${swift_backtracing_link_libraries}