[ORC][ORC-RT] Register type metadata from __swift5_types MachO section

[benlangmuir]

Summary

Similar to how the other swift sections are registered by the ORC
runtime's macho platform, add the __swift5_types section, which contains
type metadata. Add a simple test that demonstrates that the swift
runtime recognized the registered types.

rdar://85358530

[lhames]

LGTM. Thanks Ben!

compiler-rt/lib/orc/macho_platform.cpp

 extern "C" id objc_msgSend(id, SEL, ...) ORC_RT_WEAK_IMPORT;
 extern "C" Class objc_readClassPair(Class,
                                     const objc_image_info *) ORC_RT_WEAK_IMPORT;
 extern "C" SEL sel_registerName(const char *) ORC_RT_WEAK_IMPORT;
 
 // Swift types.
 class ProtocolRecord;
 class ProtocolConformanceRecord;
+class TypeMetadataRecord;
 
 extern "C" void
 swift_registerProtocols(const ProtocolRecord *begin,
                         const ProtocolRecord *end) ORC_RT_WEAK_IMPORT;
 
 extern "C" void swift_registerProtocolConformances(
     const ProtocolConformanceRecord *begin,
     const ProtocolConformanceRecord *end) ORC_RT_WEAK_IMPORT;
 
+extern "C" void swift_registerTypeMetadataRecords(
+    const TypeMetadataRecord *begin,
+    const TypeMetadataRecord *end) ORC_RT_WEAK_IMPORT;
+
 namespace {
 
 Error validatePointerSectionExtent(const char *SectionName,
                                    const ExecutorAddrRange &SE) {
   if (SE.size().getValue() % sizeof(uintptr_t)) {
     std::ostringstream ErrMsg;
     ErrMsg << std::hex << "Size of " << SectionName << " 0x"
            << SE.Start.getValue() << " -- 0x" << SE.End.getValue()
Error registerSwift5ProtocolConformances(
   for (const auto &ProtoConfSec : Swift5ProtocolConformanceSections)
     swift_registerProtocolConformances(
         ProtoConfSec.Start.toPtr<const ProtocolConformanceRecord *>(),
         ProtoConfSec.End.toPtr<const ProtocolConformanceRecord *>());
 
   return Error::success();
 }
 
+Error registerSwift5Types(const std::vector<ExecutorAddrRange> &Sections,
+                          const MachOJITDylibInitializers &MOJDIs) {
+
+  if (ORC_RT_UNLIKELY(!Sections.empty() && !swift_registerTypeMetadataRecords))
+    return make_error<StringError>(
+        "swift_registerTypeMetadataRecords is not available");
+
+  for (const auto &Section : Sections)
+    swift_registerTypeMetadataRecords(
+        Section.Start.toPtr<const TypeMetadataRecord *>(),
+        Section.End.toPtr<const TypeMetadataRecord *>());
+
+  return Error::success();
+}
+
 Error runModInits(const std::vector<ExecutorAddrRange> &ModInitsSections,
                   const MachOJITDylibInitializers &MOJDIs) {
 
   for (const auto &ModInits : ModInitsSections) {
     if (auto Err = validatePointerSectionExtent("__mod_inits", ModInits))
       return Err;
 
     using InitFunc = void (*)();
private:
   using InitSectionHandler =
       Error (*)(const std::vector<ExecutorAddrRange> &Sections,
                 const MachOJITDylibInitializers &MOJDIs);
   const std::vector<std::pair<const char *, InitSectionHandler>> InitSections =
       {{"__DATA,__objc_selrefs", registerObjCSelectors},
        {"__DATA,__objc_classlist", registerObjCClasses},
        {"__TEXT,__swift5_protos", registerSwift5Protocols},
        {"__TEXT,__swift5_proto", registerSwift5ProtocolConformances},
+       {"__TEXT,__swift5_types", registerSwift5Types},
        {"__DATA,__mod_init_func", runModInits}};
 
   // FIXME: Move to thread-state.
   std::string DLFcnError;
 
   std::recursive_mutex JDStatesMutex;
   std::unordered_map<void *, PerJITDylibState> JDStates;
   std::unordered_map<std::string, void *> JDNameToHeader;

compiler-rt/test/lit.common.cfg.py

if config.host_os == 'Darwin':
   try:
     osx_version = subprocess.check_output(["sw_vers", "-productVersion"],
                                           universal_newlines=True)
     osx_version = tuple(int(x) for x in osx_version.split('.'))
     if len(osx_version) == 2: osx_version = (osx_version[0], osx_version[1], 0)
     if osx_version >= (10, 11):
       config.available_features.add('osx-autointerception')
       config.available_features.add('osx-ld64-live_support')
+    if osx_version >= (10, 15):
+      config.available_features.add('osx-swift-runtime')
   except subprocess.CalledProcessError:
     pass
 
   config.darwin_osx_version = osx_version
 
   # Detect x86_64h
   try:
     output = subprocess.check_output(["sysctl", "hw.cpusubtype"])

compiler-rt/test/orc/TestCases/Darwin/x86-64/trivial-swift-types-section.S

+# RUN: %clang -c -o %t %s
+# RUN: %llvm_jitlink -dlopen /usr/lib/swift/libswiftCore.dylib %t
+
+# REQUIRES: osx-swift-runtime
+
+# Check that _typeByName is able to find a type registered by metadata in
+# the __swift5_types section.
+
+  .section  __TEXT,__text,regular,pure_instructions
+  .globl  _main
+  .p2align  4, 0x90
+_main:
+  .cfi_startproc
+  pushq %rbp
+  .cfi_def_cfa_offset 16
+  .cfi_offset %rbp, -16
+  movq  %rsp, %rbp
+  .cfi_def_cfa_register %rbp
+  # Constant String for "4Test3FooV"
+  movabsq $8018152761824990260, %rdi
+  movabsq $-1585267068834392465, %rsi
+  callq _$ss11_typeByNameyypXpSgSSF
+  xorl  %edi, %edi
+  testq %rax, %rax
+  sete  %dil
+  callq _exit
+  .cfi_endproc
+
+  .private_extern _$s4Test3FooVMa
+  .globl  _$s4Test3FooVMa
+  .p2align  4, 0x90
+_$s4Test3FooVMa:
+  leaq  _$s4Test3FooVMf+8(%rip), %rax
+  xorl  %edx, %edx
+  retq
+
+  .section  __TEXT,__const
+l___unnamed_1:
+  .asciz  "Test"
+
+  .private_extern _$s4TestMXM
+  .globl  _$s4TestMXM
+  .weak_definition  _$s4TestMXM
+  .p2align  2
+_$s4TestMXM:
+  .long 0
+  .long 0
+  .long (l___unnamed_1-_$s4TestMXM)-8
+
+l___unnamed_2:
+  .asciz  "Foo"
+
+  .private_extern _$s4Test3FooVMn
+  .globl  _$s4Test3FooVMn
+  .p2align  2
+_$s4Test3FooVMn:
+  .long 81
+  .long (_$s4TestMXM-_$s4Test3FooVMn)-4
+  .long (l___unnamed_2-_$s4Test3FooVMn)-8
+  .long (_$s4Test3FooVMa-_$s4Test3FooVMn)-12
+  .long (_$s4Test3FooVMF-_$s4Test3FooVMn)-16
+  .long 0
+  .long 2
+
+  .section  __DATA,__const
+  .p2align  3
+_$s4Test3FooVMf:
+  .quad _$sytWV
+  .quad 512
+  .quad _$s4Test3FooVMn
+
+  .private_extern "_symbolic _____ 4Test3FooV"
+  .section  __TEXT,__swift5_typeref,regular,no_dead_strip
+  .globl  "_symbolic _____ 4Test3FooV"
+  .weak_definition  "_symbolic _____ 4Test3FooV"
+  .p2align  1
+"_symbolic _____ 4Test3FooV":
+  .byte 1
+  .long (_$s4Test3FooVMn-"_symbolic _____ 4Test3FooV")-1
+  .byte 0
+
+  .section  __TEXT,__swift5_fieldmd,regular,no_dead_strip
+  .p2align  2
+_$s4Test3FooVMF:
+  .long "_symbolic _____ 4Test3FooV"-_$s4Test3FooVMF
+  .long 0
+  .short  0
+  .short  12
+  .long 0
+
+  .section  __TEXT,__swift5_types,regular,no_dead_strip
+  .p2align  2
+l_type_metadata_table:
+  .long _$s4Test3FooVMn-l_type_metadata_table

llvm/lib/ExecutionEngine/Orc/MachOPlatform.cpp

 
 StringRef EHFrameSectionName = "__TEXT,__eh_frame";
 StringRef ModInitFuncSectionName = "__DATA,__mod_init_func";
 StringRef ObjCClassListSectionName = "__DATA,__objc_classlist";
 StringRef ObjCImageInfoSectionName = "__DATA,__objc_image_info";
 StringRef ObjCSelRefsSectionName = "__DATA,__objc_selrefs";
 StringRef Swift5ProtoSectionName = "__TEXT,__swift5_proto";
 StringRef Swift5ProtosSectionName = "__TEXT,__swift5_protos";
+StringRef Swift5TypesSectionName = "__TEXT,__swift5_types";
 StringRef ThreadBSSSectionName = "__DATA,__thread_bss";
 StringRef ThreadDataSectionName = "__DATA,__thread_data";
 StringRef ThreadVarsSectionName = "__DATA,__thread_vars";
 
 StringRef InitSectionNames[] = {
     ModInitFuncSectionName, ObjCSelRefsSectionName, ObjCClassListSectionName,
-    Swift5ProtosSectionName, Swift5ProtoSectionName};
+    Swift5ProtosSectionName, Swift5ProtoSectionName, Swift5TypesSectionName};
 
 } // end anonymous namespace
 
 namespace llvm {
 namespace orc {
 
 Expected<std::unique_ptr<MachOPlatform>>
 MachOPlatform::Create(ExecutionSession &ES, ObjectLinkingLayer &ObjLinkingLayer,

llvm/lib/ExecutionEngine/Orc/ObjectLinkingLayer.cpp

private:
   }
 
   static bool hasMachOInitSection(LinkGraph &G) {
     for (auto &Sec : G.sections())
       if (Sec.getName() == "__DATA,__obj_selrefs" ||
           Sec.getName() == "__DATA,__objc_classlist" ||
           Sec.getName() == "__TEXT,__swift5_protos" ||
           Sec.getName() == "__TEXT,__swift5_proto" ||
+          Sec.getName() == "__TEXT,__swift5_types" ||
           Sec.getName() == "__DATA,__mod_init_func")
         return true;
     return false;
   }
 
   static bool hasELFInitSection(LinkGraph &G) {
     for (auto &Sec : G.sections())
       if (Sec.getName() == ".init_array")