xref: /llvm-project/llvm/unittests/ExecutionEngine/Orc/JITLinkRedirectionManagerTest.cpp (revision e5f7e73d90dd8ea7b1fa0e4e77ae11eabf398da9)
1 #include "OrcTestCommon.h"
2 #include "llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h"
3 #include "llvm/ExecutionEngine/Orc/ExecutorProcessControl.h"
4 #include "llvm/ExecutionEngine/Orc/JITLinkRedirectableSymbolManager.h"
5 #include "llvm/ExecutionEngine/Orc/JITTargetMachineBuilder.h"
6 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
7 #include "llvm/ExecutionEngine/Orc/Shared/ExecutorAddress.h"
8 #include "llvm/Testing/Support/Error.h"
9 #include "gtest/gtest.h"
10 
11 using namespace llvm;
12 using namespace llvm::orc;
13 using namespace llvm::jitlink;
14 
15 static int initialTarget() { return 42; }
16 static int middleTarget() { return 13; }
17 static int finalTarget() { return 53; }
18 
19 class JITLinkRedirectionManagerTest : public testing::Test {
20 public:
21   ~JITLinkRedirectionManagerTest() {
22     if (ES)
23       if (auto Err = ES->endSession())
24         ES->reportError(std::move(Err));
25   }
26 
27 protected:
28   void SetUp() override {
29     auto JTMB = JITTargetMachineBuilder::detectHost();
30     // Bail out if we can not detect the host.
31     if (!JTMB) {
32       consumeError(JTMB.takeError());
33       GTEST_SKIP();
34     }
35     auto DLOrErr = JTMB->getDefaultDataLayoutForTarget();
36     if (!DLOrErr) {
37       consumeError(DLOrErr.takeError());
38       GTEST_SKIP();
39     }
40 
41     // COFF-ARM64 is not supported yet
42     auto Triple = JTMB->getTargetTriple();
43     if (Triple.isOSBinFormatCOFF() && Triple.isAArch64())
44       GTEST_SKIP();
45 
46     ES = std::make_unique<ExecutionSession>(
47         std::make_unique<UnsupportedExecutorProcessControl>(
48             nullptr, nullptr, JTMB->getTargetTriple().getTriple()));
49     JD = &ES->createBareJITDylib("main");
50     ObjLinkingLayer = std::make_unique<ObjectLinkingLayer>(
51         *ES, std::make_unique<InProcessMemoryManager>(16384));
52     DL = std::make_unique<DataLayout>(std::move(*DLOrErr));
53   }
54   JITDylib *JD{nullptr};
55   std::unique_ptr<ExecutionSession> ES;
56   std::unique_ptr<ObjectLinkingLayer> ObjLinkingLayer;
57   std::unique_ptr<DataLayout> DL;
58 };
59 
60 TEST_F(JITLinkRedirectionManagerTest, BasicRedirectionOperation) {
61   auto RM = JITLinkRedirectableSymbolManager::Create(*ObjLinkingLayer, *JD);
62   // Bail out if we can not create
63   if (!RM) {
64     consumeError(RM.takeError());
65     GTEST_SKIP();
66   }
67 
68   auto DefineTarget = [&](StringRef TargetName, ExecutorAddr Addr) {
69     SymbolStringPtr Target = ES->intern(TargetName);
70     cantFail(JD->define(std::make_unique<SimpleMaterializationUnit>(
71         SymbolFlagsMap({{Target, JITSymbolFlags::Exported}}),
72         [&](std::unique_ptr<MaterializationResponsibility> R) -> void {
73           // No dependencies registered, can't fail.
74           cantFail(
75               R->notifyResolved({{Target, {Addr, JITSymbolFlags::Exported}}}));
76           cantFail(R->notifyEmitted({}));
77         })));
78     return cantFail(ES->lookup({JD}, TargetName));
79   };
80 
81   auto InitialTarget =
82       DefineTarget("InitialTarget", ExecutorAddr::fromPtr(&initialTarget));
83   auto MiddleTarget =
84       DefineTarget("MiddleTarget", ExecutorAddr::fromPtr(&middleTarget));
85   auto FinalTarget =
86       DefineTarget("FinalTarget", ExecutorAddr::fromPtr(&finalTarget));
87 
88   auto RedirectableSymbol = ES->intern("RedirectableTarget");
89   EXPECT_THAT_ERROR(
90       (*RM)->createRedirectableSymbols(JD->getDefaultResourceTracker(),
91                                        {{RedirectableSymbol, InitialTarget}}),
92       Succeeded());
93   auto RTDef = cantFail(ES->lookup({JD}, RedirectableSymbol));
94 
95   auto RTPtr = RTDef.getAddress().toPtr<int (*)()>();
96   auto Result = RTPtr();
97   EXPECT_EQ(Result, 42) << "Failed to call initial target";
98 
99   EXPECT_THAT_ERROR((*RM)->redirect(*JD, {{RedirectableSymbol, MiddleTarget}}),
100                     Succeeded());
101   Result = RTPtr();
102   EXPECT_EQ(Result, 13) << "Failed to call middle redirected target";
103 
104   EXPECT_THAT_ERROR((*RM)->redirect(*JD, {{RedirectableSymbol, FinalTarget}}),
105                     Succeeded());
106   Result = RTPtr();
107   EXPECT_EQ(Result, 53) << "Failed to call redirected target";
108 }
109