[ORC] Extract hasInitializerSection for testing (NFC)

[keith]

Summary

Based on the discussion in https://reviews.llvm.org/D130221 and https://reviews.llvm.org/D139223

[dblaikie]

llvm/lib/ExecutionEngine/Orc/ObjectFileInterface.cpp

300

Aside/@lhames - I /think/ maybe this is meant to be detected by flag rather than name? ( https://docs.oracle.com/cd/E19683-01/816-1386/6m7qcobks/index.html "When creating a dynamic object, the link-editor identifies these arrays with the .dynamic tags DT_PREINIT_ARRAY and DT_PREINIT_ARRAYSZ, DT_INIT_ARRAY and DT_INIT_ARRAYSZ, and DT_FINI_ARRAY and DT_FINI_ARRAYSZ accordingly, so that they may be called by the runtime linker." - so maybe these shouldn't be being detected by name, but by these tags? In any case, that could be fixed here separately from this change in review, but something to keep in mind, perhaps.

llvm/unittests/ExecutionEngine/JITLink/LinkGraphTests.cpp

714–749

Could you use data expansion to test this and reduce duplication (& then it might not be too bad to test all the cases, rather than only a sample/exemplar)? Sometihng like the pet thing using ValuesIn shown here: https://github.com/google/googletest/blob/main/docs/advanced.md (maybe have a separate Darwin and Linux test (or maybe even have that as a parameter too) and then pairs of section name + true/false for whether it has an initializer))

[keith]

Parameterize tests and add all test cases

[dblaikie]

Looks good (:

[keith]

rebase to run CI

[dblaikie]

Do you have commit access, or do you need me/someone to commit this for you?

[keith]

I landed, thanks all!

llvm/include/llvm/ExecutionEngine/Orc/ObjectFileInterface.h

void addInitSymbol(MaterializationUnit::Interface &I, ExecutionSession &ES,
                    StringRef ObjFileName);
 
 /// Returns a MaterializationUnit::Interface for the object file contained in
 /// the given buffer, or an error if the buffer does not contain a valid object
 /// file.
 Expected<MaterializationUnit::Interface>
 getObjectFileInterface(ExecutionSession &ES, MemoryBufferRef ObjBuffer);
 
+bool hasInitializerSection(jitlink::LinkGraph &G);
+
 } // End namespace orc
 } // End namespace llvm
 
 #endif // LLVM_EXECUTIONENGINE_ORC_OBJECTFILEINTERFACE_H

llvm/lib/ExecutionEngine/Orc/ObjectFileInterface.cpp

getObjectFileInterface(ExecutionSession &ES, MemoryBufferRef ObjBuffer) {
   else if (auto *ELFObj = dyn_cast<object::ELFObjectFileBase>(Obj->get()))
     return getELFObjectFileSymbolInfo(ES, *ELFObj);
   else if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj->get()))
     return getCOFFObjectFileSymbolInfo(ES, *COFFObj);
 
   return getGenericObjectFileSymbolInfo(ES, **Obj);
 }
 
+bool hasInitializerSection(jitlink::LinkGraph &G) {
+  bool IsMachO = G.getTargetTriple().isOSBinFormatMachO();
+  bool IsElf = G.getTargetTriple().isOSBinFormatELF();
+  if (!IsMachO && !IsElf)
+    return false;
+
+  for (auto &Sec : G.sections()) {
+    if (IsMachO && std::apply(MachOPlatform::isInitializerSection,
+                              Sec.getName().split(",")))
+      return true;
+    if (IsElf && ELFNixPlatform::isInitializerSection(Sec.getName()))
+      return true;
+  }
+
+  return false;
+}
+
 } // End namespace orc.
 } // End namespace llvm.

llvm/lib/ExecutionEngine/Orc/ObjectLinkingLayer.cpp

 //===------- ObjectLinkingLayer.cpp - JITLink backed ORC ObjectLayer ------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
 #include "llvm/ExecutionEngine/JITLink/EHFrameSupport.h"
 #include "llvm/ExecutionEngine/Orc/DebugObjectManagerPlugin.h"
+#include "llvm/ExecutionEngine/Orc/ObjectFileInterface.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include <string>
 #include <vector>
 
 #define DEBUG_TYPE "orc"
 
 using namespace llvm;
 using namespace llvm::jitlink;
for (auto *Sym : G.defined_symbols()) {
         Flags |= JITSymbolFlags::Exported;
 
       if (Sym->isCallable())
         Flags |= JITSymbolFlags::Callable;
 
       LGI.SymbolFlags[ES.intern(Sym->getName())] = Flags;
     }
 
-    if ((G.getTargetTriple().isOSBinFormatMachO() && hasMachOInitSection(G)) ||
-        (G.getTargetTriple().isOSBinFormatELF() && hasELFInitSection(G)))
+    if (hasInitializerSection(G))
       LGI.InitSymbol = makeInitSymbol(ES, G);
 
     return LGI;
   }
 
-  static bool hasMachOInitSection(LinkGraph &G) {
-    for (auto &Sec : G.sections())
-      if (Sec.getName() == "__DATA,__objc_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()) {
-      auto SecName = Sec.getName();
-      if (SecName.consume_front(".init_array") &&
-          (SecName.empty() || SecName[0] == '.'))
-        return true;
-    }
-    return false;
-  }
-
   static SymbolStringPtr makeInitSymbol(ExecutionSession &ES, LinkGraph &G) {
     std::string InitSymString;
     raw_string_ostream(InitSymString)
         << "$." << G.getName() << ".__inits" << Counter++;
     return ES.intern(InitSymString);
   }
 
   LinkGraphMaterializationUnit(ObjectLinkingLayer &ObjLinkingLayer,

llvm/unittests/ExecutionEngine/JITLink/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   ${LLVM_TARGETS_TO_BUILD}
   JITLink
   Object
+  OrcJIT
   OrcShared
   OrcTargetProcess
   RuntimeDyld
   Support
   )
 
 add_llvm_unittest(JITLinkTests
     EHFrameSupportTests.cpp
     LinkGraphTests.cpp
   )
 
 target_link_libraries(JITLinkTests PRIVATE LLVMTestingSupport)
 
 set_property(TARGET JITLinkTests PROPERTY FOLDER "Tests/UnitTests/ExecutionTests")

llvm/unittests/ExecutionEngine/JITLink/LinkGraphTests.cpp

 //===------ LinkGraphTests.cpp - Unit tests for core JITLink classes ------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ExecutionEngine/JITLink/JITLink.h"
+#include "llvm/ExecutionEngine/Orc/ObjectFileInterface.h"
 #include "llvm/Support/Endian.h"
 #include "llvm/Support/Memory.h"
 
 #include "llvm/Testing/Support/Error.h"
 #include "gtest/gtest.h"
 
 using namespace llvm;
 using namespace llvm::jitlink;
if (size(B2.edges()) == 2) {
     auto *E1 = &*B2.edges().begin();
     auto *E2 = &*(B2.edges().begin() + 1);
     if (E2->getOffset() < E1->getOffset())
       std::swap(E1, E2);
     EXPECT_EQ(E1->getOffset(), 0U);
     EXPECT_EQ(E2->getOffset(), 4U);
   }
 }
+
+struct InitSymbolsTestParams {
+  InitSymbolsTestParams(StringRef Triple, StringRef Section,
+                        bool ExpectedHasInitializerSection)
+      : Triple(Triple), Section(Section),
+        ExpectedHasInitializerSection(ExpectedHasInitializerSection) {}
+
+  StringRef Triple;
+  StringRef Section;
+  bool ExpectedHasInitializerSection;
+};
+
+class InitSymbolsTestFixture
+    : public ::testing::TestWithParam<InitSymbolsTestParams> {};
+
+TEST_P(InitSymbolsTestFixture, InitSymbolSections) {
+  InitSymbolsTestParams Params = GetParam();
+  auto Graph = std::make_unique<LinkGraph>(
+      "foo", Triple(Params.Triple), 8, support::little, getGenericEdgeKindName);
+  Graph->createSection(Params.Section,
+                       orc::MemProt::Read | orc::MemProt::Write);
+  EXPECT_EQ(orc::hasInitializerSection(*Graph),
+            Params.ExpectedHasInitializerSection);
+}
+
+INSTANTIATE_TEST_SUITE_P(
+    InitSymbolsTests, InitSymbolsTestFixture,
+    ::testing::Values(
+        InitSymbolsTestParams("x86_64-apple-darwin", "__DATA,__objc_selrefs",
+                              true),
+        InitSymbolsTestParams("x86_64-apple-darwin", "__DATA,__mod_init_func",
+                              true),
+        InitSymbolsTestParams("x86_64-apple-darwin", "__DATA,__objc_classlist",
+                              true),
+        InitSymbolsTestParams("x86_64-apple-darwin", "__TEXT,__swift5_proto",
+                              true),
+        InitSymbolsTestParams("x86_64-apple-darwin", "__TEXT,__swift5_protos",
+                              true),
+        InitSymbolsTestParams("x86_64-apple-darwin", "__TEXT,__swift5_types",
+                              true),
+        InitSymbolsTestParams("x86_64-apple-darwin", "__DATA,__not_an_init_sec",
+                              false),
+        InitSymbolsTestParams("x86_64-unknown-linux", ".init_array", true),
+        InitSymbolsTestParams("x86_64-unknown-linux", ".init_array.0", true),
+        InitSymbolsTestParams("x86_64-unknown-linux", ".text", false)));