Split the NO_DYLD CMake flag into separate HAS_DLADDR and STATIC_IMAGE_INSPECTION flags (#39339)

Author: kubamracek

stdlib/CMakeLists.txt

@@ -71,8 +71,12 @@ option(SWIFT_ENABLE_COMPATIBILITY_OVERRIDES
        "Support back-deploying compatibility fixes for newer apps running on older runtimes."
        TRUE)
 
-option(SWIFT_RUNTIME_MACHO_NO_DYLD
-       "Build stdlib assuming the runtime environment uses Mach-O but does not support dynamic modules."
+option(SWIFT_STDLIB_HAS_DLADDR
+       "Build stdlib assuming the runtime environment runtime environment provides dladdr API."
+       TRUE)
+
+option(SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION
+       "Build stdlib assuming the runtime environment runtime environment only supports a single runtime image with Swift code."
        FALSE)
 
 option(SWIFT_STDLIB_HAS_DARWIN_LIBMALLOC

stdlib/cmake/modules/AddSwiftStdlib.cmake

@@ -321,8 +321,12 @@ function(_add_target_variant_c_compile_flags)
     list(APPEND result "-DSWIFT_ENABLE_REFLECTION")
   endif()
 
-  if(SWIFT_RUNTIME_MACHO_NO_DYLD)
-    list(APPEND result "-DSWIFT_RUNTIME_MACHO_NO_DYLD")
+  if(SWIFT_STDLIB_HAS_DLADDR)
+    list(APPEND result "-DSWIFT_STDLIB_HAS_DLADDR")
+  endif()
+
+  if(SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION)
+    list(APPEND result "-DSWIFT_RUNTIME_STATIC_IMAGE_INSPECTION")
   endif()
 
   if(SWIFT_STDLIB_HAS_DARWIN_LIBMALLOC)

stdlib/public/runtime/Errors.cpp

@@ -73,7 +73,7 @@ enum: uint32_t {
 
 using namespace swift;
 
-#if SWIFT_SUPPORTS_BACKTRACE_REPORTING
+#if SWIFT_SUPPORTS_BACKTRACE_REPORTING && SWIFT_STDLIB_HAS_DLADDR
 static bool getSymbolNameAddr(llvm::StringRef libraryName,
                               const SymbolInfo &syminfo,
                               std::string &symbolName, uintptr_t &addrOut) {
@@ -136,7 +136,7 @@ static bool getSymbolNameAddr(llvm::StringRef libraryName,
 
 void swift::dumpStackTraceEntry(unsigned index, void *framePC,
                                 bool shortOutput) {
-#if SWIFT_SUPPORTS_BACKTRACE_REPORTING && !defined(SWIFT_RUNTIME_MACHO_NO_DYLD)
+#if SWIFT_SUPPORTS_BACKTRACE_REPORTING && SWIFT_STDLIB_HAS_DLADDR
   SymbolInfo syminfo;
 
   // 0 is failure for lookupSymbol

stdlib/public/runtime/ImageInspectionMachO.cpp

@@ -19,7 +19,7 @@
 //===----------------------------------------------------------------------===//
 
 #if defined(__APPLE__) && defined(__MACH__) &&                                 \
-    !defined(SWIFT_RUNTIME_MACHO_NO_DYLD)
+    !defined(SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION)
 
 #include "ImageInspection.h"
 #include "ImageInspectionCommon.h"
@@ -159,6 +159,7 @@ void swift::initializeDynamicReplacementLookup() {
                                 addImageDynamicReplacementBlockCallback>);
 }
 
+#if SWIFT_STDLIB_HAS_DLADDR
 int swift::lookupSymbol(const void *address, SymbolInfo *info) {
   Dl_info dlinfo;
   if (dladdr(address, &dlinfo) == 0) {
@@ -171,6 +172,7 @@ int swift::lookupSymbol(const void *address, SymbolInfo *info) {
   info->symbolAddress = dlinfo.dli_saddr;
   return 1;
 }
+#endif
 
 #endif // defined(__APPLE__) && defined(__MACH__) &&
-       // !defined(SWIFT_RUNTIME_MACHO_NO_DYLD)
+       // !defined(SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION)

stdlib/public/runtime/ImageInspectionStatic.cpp

@@ -17,7 +17,7 @@
 ///
 //===----------------------------------------------------------------------===//
 
-#if defined(__MACH__) && defined(SWIFT_RUNTIME_MACHO_NO_DYLD)
+#if defined(__MACH__) && defined(SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION)
 
 #include "ImageInspection.h"
 #include "ImageInspectionCommon.h"
@@ -75,4 +75,4 @@ void swift::initializeDynamicReplacementLookup() {
   addImageDynamicReplacementBlockCallback(start1, size1, start2, size2);
 }
 
-#endif // defined(__MACH__) && defined(SWIFT_RUNTIME_MACHO_NO_DYLD)
+#endif // defined(__MACH__) && defined(SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION)

stdlib/public/runtime/MetadataLookup.cpp

@@ -1034,7 +1034,7 @@ _gatherGenericParameters(const ContextDescriptor *context,
 
       str += "_gatherGenericParameters: context: ";
 
-#if !defined(SWIFT_RUNTIME_MACHO_NO_DYLD)
+#if SWIFT_STDLIB_HAS_DLADDR
       SymbolInfo contextInfo;
       if (lookupSymbol(context, &contextInfo)) {
         str += contextInfo.symbolName.get();

utils/build-presets.ini

@@ -2453,9 +2453,10 @@ build-swift-static-stdlib=1
 swift-objc-interop=0
 swift-enable-compatibility-overrides=0
 swift-enable-reflection=0
-swift-runtime-macho-no-dyld=1
+swift-stdlib-has-dladdr=0
 swift-stdlib-has-darwin-libmalloc=0
 swift-stdlib-has-stdin=0
+swift-runtime-static-image-inspection=1
 swift-stdlib-single-threaded-runtime=1
 swift-stdlib-os-versioning=0
 extra-cmake-options=
@@ -2478,6 +2479,9 @@ swift-freestanding-triple-name=macosx11.0
 swift-freestanding-module-name=macos
 swift-freestanding-archs=x86_64
 
+# For lit tests, we are producing dynamic executables with statically linked stdlib into the executable.
+swift-runtime-static-image-inspection=0
+
 [preset: stdlib_S_standalone_minimal_macho_x86_64,build,test]
 mixin-preset=stdlib_S_standalone_minimal_macho_x86_64,build
 

utils/build-script-impl

@@ -205,7 +205,8 @@ KNOWN_SETTINGS=(
     swift-objc-interop                            ""                "whether to enable interoperability with Objective-C, default is 1 on Apple platfors, 0 otherwise"
     swift-enable-compatibility-overrides          "1"               "whether to support back-deploying compatibility fixes for newer apps running on older runtimes"
     swift-enable-reflection                       "1"               "whether to support reflection and mirrors"
-    swift-runtime-macho-no-dyld                   "0"               "whether to build stdlib assuming the runtime environment does not support dynamic modules"
+    swift-stdlib-has-dladdr                       "1"               "whether to build stdlib assuming the runtime environment provides dladdr API"
+    swift-runtime-static-image-inspection         "0"               "whether to build stdlib assuming the runtime environment only supports a single runtime image with Swift code"
     swift-stdlib-single-threaded-runtime          "0"               "whether to build stdlib as a single-threaded runtime only"
     swift-stdlib-os-versioning                    "1"               "whether to build stdlib with availability based on OS versions (Darwin only)"
     swift-stdlib-stable-abi                       ""                "should stdlib be built with stable ABI, if not set defaults to true on Darwin, false otherwise"
@@ -1981,7 +1982,8 @@ for host in "${ALL_HOSTS[@]}"; do
                     -DSWIFT_ENABLE_COMPATIBILITY_OVERRIDES:BOOL=$(true_false "${SWIFT_ENABLE_COMPATIBILITY_OVERRIDES}")
                     -DSWIFT_STDLIB_SINGLE_THREADED_RUNTIME:BOOL=$(true_false "${SWIFT_STDLIB_SINGLE_THREADED_RUNTIME}")
                     -DSWIFT_ENABLE_RUNTIME_FUNCTION_COUNTERS:BOOL=$(true_false "${SWIFT_ENABLE_RUNTIME_FUNCTION_COUNTERS}")
-                    -DSWIFT_RUNTIME_MACHO_NO_DYLD:BOOL=$(true_false "${SWIFT_RUNTIME_MACHO_NO_DYLD}")
+                    -DSWIFT_STDLIB_HAS_DLADDR:BOOL=$(true_false "${SWIFT_STDLIB_HAS_DLADDR}")
+                    -DSWIFT_RUNTIME_STATIC_IMAGE_INSPECTION:BOOL=$(true_false "${SWIFT_RUNTIME_STATIC_IMAGE_INSPECTION}")
                     -DSWIFT_STDLIB_OS_VERSIONING:BOOL=$(true_false "${SWIFT_STDLIB_OS_VERSIONING}")
                     -DSWIFT_STDLIB_HAS_DARWIN_LIBMALLOC:BOOL=$(true_false "${SWIFT_STDLIB_HAS_DARWIN_LIBMALLOC}")
                     -DSWIFT_STDLIB_HAS_STDIN:BOOL=$(true_false "${SWIFT_STDLIB_HAS_STDIN}")