[compiler_rt] Add a seperate runtime for Mac Catalyst

[bc-lee]

Summary

Mac Catalyst has different platform fields in build_version_command,
so it's natural to create a separate libclang_rt.

[delcypher]

@bc-lee Thanks for the patch. While I get what you're trying to do I have doubts about being able to accept the patch in its current form. Apple's ASan catalyst doesn't work by building a separate dylib, instead it builds the macosx dylib in a different way to make it work with catalyst code.

I've made @aralisza a blocking reviewer because she'll need to approve this.

[bc-lee]

It may not be appropriate to add other runtime libraries specifically for Mac Catalyst. However, currently lld does not allow linking with dynamic libraries with different types of build_version_command, whereas ld64 does allow for Mac Catalyst. Considering compatibility with lld, Mac Catalyst’s runtime libraries need to be added also.

See my other patch https://reviews.llvm.org/D117925 for more details.

[thakis]

In D117924#3274425, @bc-lee wrote:

It may not be appropriate to add other runtime libraries specifically for Mac Catalyst. However, currently lld does not allow linking with dynamic libraries with different types of build_version_command, whereas ld64 does allow for Mac Catalyst. Considering compatibility with lld

If lld doesn't support something we need, we should add support for the missing part to lld instead of working around it. Is there a bug on file for the missing lld bit?

[bc-lee]

For the Chromium side issue is https://crbug.com/1259122. Also I opened LLVM issue https://github.com/llvm/llvm-project/issues/53477.

[bc-lee]

Some changes in this patch were applied as https://reviews.llvm.org/D118759, so I'm re-uploading this patch to get rid of merge conflicts.

[tschuett]

https://reviews.llvm.org/D118862
https://reviews.llvm.org/D118875

[bc-lee]

Closed in favor of https://reviews.llvm.org/D118862 and https://reviews.llvm.org/D118875

clang/lib/Driver/ToolChains/Darwin.cpp

 }
 
 StringRef Darwin::getOSLibraryNameSuffix(bool IgnoreSim) const {
   switch (TargetPlatform) {
   case DarwinPlatformKind::MacOS:
     return "osx";
   case DarwinPlatformKind::IPhoneOS:
     if (TargetEnvironment == MacCatalyst)
-      return "osx";
+      return "catalyst";
     return TargetEnvironment == NativeEnvironment || IgnoreSim ? "ios"
                                                                : "iossim";
   case DarwinPlatformKind::TvOS:
     return TargetEnvironment == NativeEnvironment || IgnoreSim ? "tvos"
                                                                : "tvossim";
   case DarwinPlatformKind::WatchOS:
     return TargetEnvironment == NativeEnvironment || IgnoreSim ? "watchos"
                                                                : "watchossim";

clang/test/Driver/darwin-sanitizer-ld.c

 // RUN: %clang -no-canonical-prefixes -### -target x86_64-apple-ios13.1-macabi \
 // RUN:   -stdlib=platform -fsanitize=address \
 // RUN:   -resource-dir %S/Inputs/resource_dir \
 // RUN:   %s -o %t.o 2>&1 | FileCheck --check-prefix=CHECK-ASAN-MACCATALYST %s
 
 // CHECK-ASAN-MACCATALYST: "{{.*}}ld{{(.exe)?}}"
 // CHECK-ASAN-MACCATALYST-NOT: "-lstdc++"
 // CHECK-ASAN-MACCATALYST-NOT: "-lc++"
-// CHECK-ASAN-MACCATALYST: libclang_rt.asan_osx_dynamic.dylib"
+// CHECK-ASAN-MACCATALYST: libclang_rt.asan_catalyst_dynamic.dylib"
 // CHECK-ASAN-MACCATALYST: "-rpath" "@executable_path"
 // CHECK-ASAN-MACCATALYST: "-rpath" "{{.*}}lib{{.*}}darwin"
 
 // RUN: %clang -no-canonical-prefixes -### -target armv7-apple-ios  \
 // RUN:   -stdlib=platform -fsanitize=address -miphoneos-version-min=7 \
 // RUN:   %s -o %t.o 2>&1 | FileCheck --check-prefix=CHECK-ASAN-IOS %s
 
 // CHECK-ASAN-IOS: "{{.*}}ld{{(.exe)?}}"

compiler-rt/cmake/builtin-config-ix.cmake

set(ALL_BUILTIN_SUPPORTED_ARCH
   ${WASM32} ${WASM64} ${VE})
 
 include(CompilerRTUtils)
 include(CompilerRTDarwinUtils)
 
 if(APPLE)
 
   find_darwin_sdk_dir(DARWIN_osx_SYSROOT macosx)
+  find_darwin_sdk_dir(DARWIN_catalyst_SYSROOT macosx)
   find_darwin_sdk_dir(DARWIN_iossim_SYSROOT iphonesimulator)
   find_darwin_sdk_dir(DARWIN_ios_SYSROOT iphoneos)
   find_darwin_sdk_dir(DARWIN_watchossim_SYSROOT watchsimulator)
   find_darwin_sdk_dir(DARWIN_watchos_SYSROOT watchos)
   find_darwin_sdk_dir(DARWIN_tvossim_SYSROOT appletvsimulator)
   find_darwin_sdk_dir(DARWIN_tvos_SYSROOT appletvos)
 
   # Get supported architecture from SDKSettings.
if(APPLE)
   if(COMPILER_RT_ENABLE_IOS)
     list(APPEND DARWIN_EMBEDDED_PLATFORMS ios)
     set(DARWIN_ios_MIN_VER_FLAG -miphoneos-version-min)
     set(DARWIN_ios_BUILTIN_MIN_VER 6.0)
     set(DARWIN_ios_BUILTIN_MIN_VER_FLAG
       ${DARWIN_ios_MIN_VER_FLAG}=${DARWIN_ios_BUILTIN_MIN_VER})
     set(DARWIN_ios_BUILTIN_ALL_POSSIBLE_ARCHS ${ARM64} ${ARM32})
     set(DARWIN_iossim_BUILTIN_ALL_POSSIBLE_ARCHS ${X86} ${X86_64} arm64)
+    list(APPEND DARWIN_EMBEDDED_PLATFORMS catalyst)
+    set(DARWIN_catalyst_BUILTIN_MIN_VER 13.0)
+    set(DARWIN_catalyst_BUILTIN_MIN_VER_FLAG
+        ${DARWIN_ios_MIN_VER_FLAG}=${DARWIN_catalyst_BUILTIN_MIN_VER}
+        -target
+        ${LIB_ARCH}-apple-ios${DARWIN_catalyst_BUILTIN_MIN_VER}-macabi)
+    set(DARWIN_catalyst_BUILTIN_ALL_POSSIBLE_ARCHS ${X86_64} ${ARM64})
   endif()
   if(COMPILER_RT_ENABLE_WATCHOS)
     list(APPEND DARWIN_EMBEDDED_PLATFORMS watchos)
     set(DARWIN_watchos_MIN_VER_FLAG -mwatchos-version-min)
     set(DARWIN_watchos_BUILTIN_MIN_VER 2.0)
     set(DARWIN_watchos_BUILTIN_MIN_VER_FLAG
       ${DARWIN_watchos_MIN_VER_FLAG}=${DARWIN_watchos_BUILTIN_MIN_VER})
     set(DARWIN_watchos_BUILTIN_ALL_POSSIBLE_ARCHS armv7 armv7k arm64_32)
if(DARWIN_${platform}sim_SYSROOT)
         list(APPEND BUILTIN_SUPPORTED_OS ${platform}sim)
       endif()
       foreach(arch ${DARWIN_${platform}sim_BUILTIN_ARCHS})
         list(APPEND COMPILER_RT_SUPPORTED_ARCH ${arch})
         set(CAN_TARGET_${arch} 1)
       endforeach()
     endif()
 
+    if("${platform}" STREQUAL "catalyst")
+      set(DARWIN_${platform}_SKIP_CC_KEXT On)
+    endif()
+
     if(DARWIN_${platform}_SYSROOT)
       darwin_test_archs(${platform}
         DARWIN_${platform}_BUILTIN_ARCHS
         ${DARWIN_${platform}_BUILTIN_ALL_POSSIBLE_ARCHS}
       )
       message(STATUS "${platform} supported builtin arches: ${DARWIN_${platform}_BUILTIN_ARCHS}")
       if(DARWIN_${platform}_BUILTIN_ARCHS)
         list(APPEND BUILTIN_SUPPORTED_OS ${platform})

compiler-rt/cmake/config-ix.cmake

function(get_capitalized_apple_platform platform platform_capitalized)
   set(${platform_capitalized} "${platform_upper_capitalized}" PARENT_SCOPE)
 endfunction()
 
 function(is_valid_apple_platform platform is_valid_out)
   set(is_valid FALSE)
   if ("${platform}" STREQUAL "")
     message(FATAL_ERROR "platform cannot be empty")
   endif()
-  if ("${platform}" MATCHES "^(osx|((ios|watchos|tvos)(sim)?))$")
+  if ("${platform}" MATCHES "^(osx|((ios|watchos|tvos)(sim)?)|catalyst)$")
     set(is_valid TRUE)
   endif()
   set(${is_valid_out} ${is_valid} PARENT_SCOPE)
 endfunction()
 
 # Maps the Apple platform name used in Compiler-rt's CMake code
 # to the name recognised by xcrun's `--sdk` argument
 function(get_xcrun_platform_from_apple_platform platform out_var)

 endfunction()
 
 include(AllSupportedArchDefs)
 
 if(APPLE)
   include(CompilerRTDarwinUtils)
 
   find_darwin_sdk_dir(DARWIN_osx_SYSROOT macosx)
+  find_darwin_sdk_dir(DARWIN_catalyst_SYSROOT macosx)
   find_darwin_sdk_dir(DARWIN_iossim_SYSROOT iphonesimulator)
   find_darwin_sdk_dir(DARWIN_ios_SYSROOT iphoneos)
   find_darwin_sdk_dir(DARWIN_watchossim_SYSROOT watchsimulator)
   find_darwin_sdk_dir(DARWIN_watchos_SYSROOT watchos)
   find_darwin_sdk_dir(DARWIN_tvossim_SYSROOT appletvsimulator)
   find_darwin_sdk_dir(DARWIN_tvos_SYSROOT appletvos)
 
   if(NOT DARWIN_osx_SYSROOT)
if(COMPILER_RT_ENABLE_IOS)
     list(APPEND DARWIN_EMBEDDED_PLATFORMS ios)
     set(DARWIN_ios_MIN_VER 9.0)
     set(DARWIN_ios_MIN_VER_FLAG -miphoneos-version-min)
     set(DARWIN_ios_SANITIZER_MIN_VER_FLAG
       ${DARWIN_ios_MIN_VER_FLAG}=${DARWIN_ios_MIN_VER})
     set(DARWIN_iossim_MIN_VER_FLAG -mios-simulator-version-min)
     set(DARWIN_iossim_SANITIZER_MIN_VER_FLAG
       ${DARWIN_iossim_MIN_VER_FLAG}=${DARWIN_ios_MIN_VER})
+    list(APPEND DARWIN_EMBEDDED_PLATFORMS catalyst)
+    set(DARWIN_catalyst_MIN_VER 13.0)
+    set(DARWIN_catalyst_SANITIZER_MIN_VER_FLAG
+        ${DARWIN_ios_MIN_VER_FLAG}=${DARWIN_catalyst_MIN_VER}
+        -target
+        ${LIB_ARCH}-apple-ios${DARWIN_catalyst_MIN_VER}-macabi)
   endif()
   if(COMPILER_RT_ENABLE_WATCHOS)
     list(APPEND DARWIN_EMBEDDED_PLATFORMS watchos)
     set(DARWIN_watchos_MIN_VER 2.0)
     set(DARWIN_watchos_MIN_VER_FLAG -mwatchos-version-min)
     set(DARWIN_watchos_SANITIZER_MIN_VER_FLAG
       ${DARWIN_watchos_MIN_VER_FLAG}=${DARWIN_watchos_MIN_VER})
     set(DARWIN_watchossim_MIN_VER_FLAG -mwatchos-simulator-version-min)
foreach(platform ${DARWIN_EMBEDDED_PLATFORMS})
           list(APPEND STATS_SUPPORTED_OS ${platform}sim)
         endif()
         foreach(arch ${DARWIN_${platform}sim_ARCHS})
           list(APPEND COMPILER_RT_SUPPORTED_ARCH ${arch})
           set(CAN_TARGET_${arch} 1)
         endforeach()
       endif()
 
+      if("${platform}" STREQUAL "catalyst")
+        set(DARWIN_${platform}_SKIP_CC_KEXT On)
+      endif()
+
       if(DARWIN_${platform}_SYSROOT)
         set(DARWIN_${platform}_CFLAGS
           ${DARWIN_COMMON_CFLAGS}
           ${DARWIN_${platform}_SANITIZER_MIN_VER_FLAG}
           -isysroot ${DARWIN_${platform}_SYSROOT})
         set(DARWIN_${platform}_LINK_FLAGS
           ${DARWIN_COMMON_LINK_FLAGS}
           ${DARWIN_${platform}_SANITIZER_MIN_VER_FLAG}