[llvm] 46e409c - [ORC] Add a JITDylib::addToLinkOrder convenience method.

[Lang Hames via llvm-commits]

Author: Lang Hames
Date: 2023-04-07T02:46:12Z
New Revision: 46e409cb1cd99b6b1a677922c2aa256802533cf3

URL: https://github.com/llvm/llvm-project/commit/46e409cb1cd99b6b1a677922c2aa256802533cf3
DIFF: https://github.com/llvm/llvm-project/commit/46e409cb1cd99b6b1a677922c2aa256802533cf3.diff

LOG: [ORC] Add a JITDylib::addToLinkOrder convenience method.

This appends the given JITDylibSearchOrder to the JITDylib's existing one.

Added: 
    

Modified: 
    llvm/include/llvm/ExecutionEngine/Orc/Core.h
    llvm/lib/ExecutionEngine/Orc/Core.cpp
    llvm/unittests/ExecutionEngine/Orc/CoreAPIsTest.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/ExecutionEngine/Orc/Core.h b/llvm/include/llvm/ExecutionEngine/Orc/Core.h
index 6aab88fde2adf..2c6484f1795cd 100644
--- a/llvm/include/llvm/ExecutionEngine/Orc/Core.h
+++ b/llvm/include/llvm/ExecutionEngine/Orc/Core.h
@@ -1056,6 +1056,11 @@ class JITDylib : public ThreadSafeRefCountedBase<JITDylib>,
   void setLinkOrder(JITDylibSearchOrder NewSearchOrder,
                     bool LinkAgainstThisJITDylibFirst = true);
 
+  /// Append the given JITDylibSearchOrder to the link order for this
+  /// JITDylib (discarding any elements already present in this JITDylib's
+  /// link order).
+  void addToLinkOrder(const JITDylibSearchOrder &NewLinks);
+
   /// Add the given JITDylib to the link order for definitions in this
   /// JITDylib.
   ///

diff  --git a/llvm/lib/ExecutionEngine/Orc/Core.cpp b/llvm/lib/ExecutionEngine/Orc/Core.cpp
index 1ea700cb91843..1926d60ac015f 100644
--- a/llvm/lib/ExecutionEngine/Orc/Core.cpp
+++ b/llvm/lib/ExecutionEngine/Orc/Core.cpp
@@ -1329,6 +1329,18 @@ void JITDylib::setLinkOrder(JITDylibSearchOrder NewLinkOrder,
   });
 }
 
+void JITDylib::addToLinkOrder(const JITDylibSearchOrder &NewLinks) {
+  ES.runSessionLocked([&]() {
+    for (auto &KV : NewLinks) {
+      // Skip elements of NewLinks that are already in the link order.
+      if (llvm::find(LinkOrder, KV) != LinkOrder.end())
+        continue;
+
+      LinkOrder.push_back(std::move(KV));
+    }
+  });
+}
+
 void JITDylib::addToLinkOrder(JITDylib &JD, JITDylibLookupFlags JDLookupFlags) {
   ES.runSessionLocked([&]() { LinkOrder.push_back({&JD, JDLookupFlags}); });
 }

diff  --git a/llvm/unittests/ExecutionEngine/Orc/CoreAPIsTest.cpp b/llvm/unittests/ExecutionEngine/Orc/CoreAPIsTest.cpp
index 9064e0cdaf5d1..10806a6f52b9e 100644
--- a/llvm/unittests/ExecutionEngine/Orc/CoreAPIsTest.cpp
+++ b/llvm/unittests/ExecutionEngine/Orc/CoreAPIsTest.cpp
@@ -23,6 +23,29 @@ class CoreAPIsStandardTest : public CoreAPIsBasedStandardTest {};
 
 namespace {
 
+TEST_F(CoreAPIsStandardTest, JITDylibAddToLinkOrder) {
+  // Check that the JITDylib::addToLinkOrder methods behave as expected.
+  auto &JD2 = ES.createBareJITDylib("JD2");
+  auto &JD3 = ES.createBareJITDylib("JD3");
+
+  JD.addToLinkOrder(JD2);
+  JD.withLinkOrderDo([&](const JITDylibSearchOrder &SO) {
+    EXPECT_EQ(SO.size(), 2U);
+    EXPECT_EQ(SO[0].first, &JD);
+    EXPECT_EQ(SO[1].first, &JD2);
+  });
+
+  JD.addToLinkOrder(makeJITDylibSearchOrder({&JD2, &JD3}));
+  JD.withLinkOrderDo([&](const JITDylibSearchOrder &SO) {
+    // JD2 was already in the search order, so we expect just one extra item
+    // here.
+    EXPECT_EQ(SO.size(), 3U);
+    EXPECT_EQ(SO[0].first, &JD);
+    EXPECT_EQ(SO[1].first, &JD2);
+    EXPECT_EQ(SO[2].first, &JD3);
+  });
+}
+
 TEST_F(CoreAPIsStandardTest, BasicSuccessfulLookup) {
   bool OnCompletionRun = false;