[ORC-RT] Configure the ORC runtime for more architectures and platforms

[benlangmuir]

Summary

Enable building the ORC runtime for 64-bit and 32-bit ARM architectures, and for all Darwin embedded platforms (iOS, tvOS, and watchOS). This covers building the cross-platform code, but does not add TLV runtime support for the new architectures, which can be added independently.

[benlangmuir]

compiler-rt/cmake/Modules/AllSupportedArchDefs.cmake

81

Any concerns about adding this for Linux, etc.? I could if(APPLE) the new additons if so.

compiler-rt/lib/orc/simple_packed_serialization.h

404

Does this need a range check on 32-bit platforms? If so, is this the correct place to do so or is there a more central place?

[lhames]

compiler-rt/cmake/Modules/AllSupportedArchDefs.cmake

81

No -- I think we want to enable this for Linux. @sgraenitz added a JITLink ELF/AArch64 backend recently, and this would let us start building out runtime support for that.

compiler-rt/lib/orc/simple_packed_serialization.h

404

Yes -- this needs a range check and this is the right place for it. Thanks for spotting that!

[benlangmuir]

• Added check against size_t max to avoid truncation on 32-bit platforms
• Improved cmake configuration -- on non-Apple platforms I missed updating a place looking for x86_64_SOURCES, and I also improved it so that we consistently build either the macho or elfnix TLS support, but not both (before my changes it was doing that on Apple but on Linux). We should probably further constrain the elfnix TLS to only build on ELF platforms, but I'm not changing that here.

[lhames]

LGTM. Thanks Ben!

[kstoimenov]

Looks like you broke this build: https://lab.llvm.org/buildbot/#/builders/77/builds/10681

Do you mind reverting this change?

[benlangmuir]

@kstoimenov thanks for the heads up, reverted in f3671de5500ff1f8210419226a9603a7d83b1a31.

[lhames]

In D112111#3076624, @benlangmuir wrote:

@kstoimenov thanks for the heads up, reverted in f3671de5500ff1f8210419226a9603a7d83b1a31.

This error was in some old debug info that was accidentally left in the library. I have removed it in 27d53cc10786f723f6cc9e9fd451ab83870b0d3a. This should be safe to re-land.

[kstoimenov]

The build is green now, thanks!

[lhames]

Oops -- I actually didn't push 27d53cc1078. I've landed it in 5c72323141e4.

[benlangmuir]

Reapplying this change via https://reviews.llvm.org/D112229

compiler-rt/cmake/Modules/AllSupportedArchDefs.cmake

 if(APPLE)
 set(ALL_XRAY_SUPPORTED_ARCH ${X86_64})
 else()
 set(ALL_XRAY_SUPPORTED_ARCH ${X86_64} ${ARM32} ${ARM64} ${MIPS32} ${MIPS64} powerpc64le)
 endif()
 set(ALL_SHADOWCALLSTACK_SUPPORTED_ARCH ${ARM64})
 
 if (UNIX)
-set(ALL_ORC_SUPPORTED_ARCH ${X86_64})
+set(ALL_ORC_SUPPORTED_ARCH ${X86_64} ${ARM64} ${ARM32})
 endif()

compiler-rt/cmake/config-ix.cmake

foreach(platform ${DARWIN_EMBEDDED_PLATFORMS})
           DARWIN_${platform}sim_ARCHS
           ${toolchain_arches})
         message(STATUS "${platform} Simulator supported arches: ${DARWIN_${platform}sim_ARCHS}")
         if(DARWIN_${platform}sim_ARCHS)
           list(APPEND SANITIZER_COMMON_SUPPORTED_OS ${platform}sim)
           list(APPEND PROFILE_SUPPORTED_OS ${platform}sim)
           list(APPEND TSAN_SUPPORTED_OS ${platform}sim)
           list(APPEND FUZZER_SUPPORTED_OS ${platform}sim)
+          list(APPEND ORC_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(DARWIN_${platform}_SYSROOT)
foreach(platform ${DARWIN_EMBEDDED_PLATFORMS})
           list(APPEND SANITIZER_COMMON_SUPPORTED_OS ${platform})
           list(APPEND PROFILE_SUPPORTED_OS ${platform})
 
           list_intersect(DARWIN_${platform}_TSAN_ARCHS DARWIN_${platform}_ARCHS ALL_TSAN_SUPPORTED_ARCH)
           if(DARWIN_${platform}_TSAN_ARCHS)
             list(APPEND TSAN_SUPPORTED_OS ${platform})
           endif()
           list(APPEND FUZZER_SUPPORTED_OS ${platform})
+          list(APPEND ORC_SUPPORTED_OS ${platform})
         endif()
         foreach(arch ${DARWIN_${platform}_ARCHS})
           list(APPEND COMPILER_RT_SUPPORTED_ARCH ${arch})
           set(CAN_TARGET_${arch} 1)
         endforeach()
       endif()
     endforeach()
   endif()

compiler-rt/lib/orc/CMakeLists.txt

 # Build for all components of the ORC runtime support library.
 
 # ORC runtime library implementation files.
 set(ORC_SOURCES
   extensible_rtti.cpp
   log_error_to_stderr.cpp
   macho_platform.cpp
   elfnix_platform.cpp
   run_program_wrapper.cpp
   )
 
 # Implementation files for all ORC architectures.
-set(x86_64_SOURCES
-# x86-64 specific assembly files will go here.
+set(ALL_ORC_ASM_SOURCES
   macho_tlv.x86-64.S
   elfnix_tls.x86-64.S
 )
 
 set(ORC_IMPL_HEADERS
 # Implementation headers will go here.
   adt.h
   c_api.h
   common.h
   compiler.h
   endianness.h
   error.h
   executor_address.h
   extensible_rtti.h
   macho_platform.h
   simple_packed_serialization.h
   stl_extras.h
   wrapper_function_utils.h
 )
 
 # Create list of all source files for
 # consumption by tests.
 set(ORC_ALL_SOURCE_FILES
   ${ORC_SOURCES}
-  ${x86_64_SOURCES}
+  ${ALL_ORC_ASM_SOURCES}
   ${ORC_IMPL_HEADERS}
   )
 
 list(REMOVE_DUPLICATES ORC_ALL_SOURCE_FILES)
 
 # Now put it all together...
 include_directories(..)
 include_directories(../../include)
 
 set(ORC_CFLAGS ${COMPILER_RT_COMMON_CFLAGS})
 
 # Allow the ORC runtime to reference LLVM headers.
 foreach (DIR ${LLVM_INCLUDE_DIR} ${LLVM_MAIN_INCLUDE_DIR})
   list(APPEND ORC_CFLAGS -I${DIR})
 endforeach()
 
 add_compiler_rt_component(orc)
 
 # ORC uses C++ standard library headers.
 if (TARGET cxx-headers OR HAVE_LIBCXX)
   set(ORC_DEPS cxx-headers)
 endif()
 
 if (APPLE)
-   add_asm_sources(ORC_ASM_SOURCES macho_tlv.x86-64.S)
 
   add_compiler_rt_object_libraries(RTOrc
     OS ${ORC_SUPPORTED_OS}
     ARCHS ${ORC_SUPPORTED_ARCH}
-    SOURCES ${ORC_SOURCES} ${x86_64_SOURCES}
+    SOURCES ${ORC_SOURCES} ${ORC_ASM_SOURCES}
     ADDITIONAL_HEADERS ${ORC_IMPL_HEADERS}
     CFLAGS ${ORC_CFLAGS}
     DEPS ${ORC_DEPS})
 
-  # We only support running on osx for now.
   add_compiler_rt_runtime(clang_rt.orc
     STATIC
     OS ${ORC_SUPPORTED_OS}
     ARCHS ${ORC_SUPPORTED_ARCH}
     OBJECT_LIBS RTOrc
     CFLAGS ${ORC_CFLAGS}
     LINK_FLAGS ${SANITIZER_COMMON_LINK_FLAGS} ${WEAK_SYMBOL_LINK_FLAGS}
     LINK_LIBS ${ORC_LINK_LIBS}
     PARENT_TARGET orc)
 else() # not Apple
+  add_asm_sources(ORC_ASM_SOURCES elfnix_tls.x86-64.S)
+
   foreach(arch ${ORC_SUPPORTED_ARCH})
     if(NOT CAN_TARGET_${arch})
       continue()
     endif()
+
     add_compiler_rt_object_libraries(RTOrc
       ARCHS ${arch}
-      SOURCES ${ORC_SOURCES} ${${arch}_SOURCES}
+      SOURCES ${ORC_SOURCES} ${ORC_ASM_SOURCES}
       ADDITIONAL_HEADERS ${ORC_IMPL_HEADERS}
       CFLAGS ${ORC_CFLAGS}
       DEPS ${ORC_DEPS})
 
     # Common ORC archive for instrumented binaries.
     add_compiler_rt_runtime(clang_rt.orc
      STATIC
      ARCHS ${arch}

compiler-rt/lib/orc/elfnix_tls.x86-64.S

 
 //===-- orc_rt_elfnix_tls_x86-64.s -------------------------------*- ASM -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file is a part of the ORC runtime support library.
 //
 //===----------------------------------------------------------------------===//
 
+// The content of this file is x86_64-only
+#if defined(__x86_64__)
+
 #define REGISTER_SAVE_SPACE_SIZE        512
 
         .text
 
   // returns address of TLV in %rax, all other registers preserved
   .globl ___orc_rt_elfnix_tls_get_addr
 ___orc_rt_elfnix_tls_get_addr:
         pushq           %rbp
___orc_rt_elfnix_tls_get_addr:
   movdqa          -176(%rbp),     %xmm3
   movdqa          -192(%rbp),     %xmm4
   movdqa          -208(%rbp),     %xmm5
   movdqa          -224(%rbp),     %xmm6
   movdqa          -240(%rbp),     %xmm7
         addq            $REGISTER_SAVE_SPACE_SIZE, %rsp
         popq            %rbp
         ret
+
+#endif // defined(__x86_64__)

compiler-rt/lib/orc/macho_tlv.x86-64.S

 //===-- orc_rt_macho_tlv.x86-64.s -------------------------------*- ASM -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file is a part of the ORC runtime support library.
 //
 //===----------------------------------------------------------------------===//
 
+// The content of this file is x86_64-only
+#if defined(__x86_64__)
+
 #define REGISTER_SAVE_SPACE_SIZE        512
 
         .text
 
   // returns address of TLV in %rax, all other registers preserved
   .globl ___orc_rt_macho_tlv_get_addr
 ___orc_rt_macho_tlv_get_addr:
         pushq           %rbp
___orc_rt_macho_tlv_get_addr:
   movdqa          -176(%rbp),     %xmm3
   movdqa          -192(%rbp),     %xmm4
   movdqa          -208(%rbp),     %xmm5
   movdqa          -224(%rbp),     %xmm6
   movdqa          -240(%rbp),     %xmm7
         addq            $REGISTER_SAVE_SPACE_SIZE, %rsp
         popq            %rbp
         ret
+
+#endif // defined(__x86_64__)

compiler-rt/lib/orc/simple_packed_serialization.h

static bool serialize(SPSOutputBuffer &OB, const __orc_rt::string_view &S) {
     return OB.write(S.data(), S.size());
   }
 
   static bool deserialize(SPSInputBuffer &IB, __orc_rt::string_view &S) {
     const char *Data = nullptr;
     uint64_t Size;
     if (!SPSArgList<uint64_t>::deserialize(IB, Size))
       return false;
+    if (Size > std::numeric_limits<size_t>::max())
+      return false;
     Data = IB.data();
     if (!IB.skip(Size))
       return false;
-    S = {Data, Size};
+    S = {Data, static_cast<size_t>(Size)};
     return true;
   }
 };
 
 /// SPS tag type for errors.
 class SPSError;
 
 /// SPS tag type for expecteds, which are either a T or a string representing