xref: /llvm-project/llvm/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp (revision 9a67b0739801e886b3a22a3dbbf2fe4f5e7f6e20)
1 //===- llvm/unittest/Support/DynamicLibrary/DynamicLibraryTest.cpp --------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/Support/DynamicLibrary.h"
11 #include "llvm/Config/config.h"
12 #include "llvm/Support/FileSystem.h"
13 #include "llvm/Support/ManagedStatic.h"
14 #include "llvm/Support/Path.h"
15 #include "gtest/gtest.h"
16 
17 #include "PipSqueak.h"
18 
19 using namespace llvm;
20 using namespace llvm::sys;
21 
22 extern "C" PIPSQUEAK_EXPORT const char *TestA() { return "ProcessCall"; }
23 
24 std::string LibPath(const std::string Name = "PipSqueak") {
25   const std::vector<testing::internal::string>& Argvs = testing::internal::GetArgvs();
26   const char *Argv0 = Argvs.size() > 0 ? Argvs[0].c_str() : "DynamicLibraryTests";
27   void *Ptr = (void*)(intptr_t)TestA;
28   std::string Path = fs::getMainExecutable(Argv0, Ptr);
29   llvm::SmallString<256> Buf(path::parent_path(Path));
30   path::append(Buf, (Name+".so").c_str());
31   return Buf.str();
32 }
33 
34 #if defined(_WIN32) || (defined(HAVE_DLFCN_H) && defined(HAVE_DLOPEN))
35 
36 typedef void (*SetStrings)(std::string &GStr, std::string &LStr);
37 typedef void (*TestOrder)(std::vector<std::string> &V);
38 typedef const char *(*GetString)();
39 
40 template <class T> static T FuncPtr(void *Ptr) {
41   union {
42     T F;
43     void *P;
44   } Tmp;
45   Tmp.P = Ptr;
46   return Tmp.F;
47 }
48 template <class T> static void* PtrFunc(T *Func) {
49   union {
50     T *F;
51     void *P;
52   } Tmp;
53   Tmp.F = Func;
54   return Tmp.P;
55 }
56 
57 static const char *OverloadTestA() { return "OverloadCall"; }
58 
59 std::string StdString(const char *Ptr) { return Ptr ? Ptr : ""; }
60 
61 TEST(DynamicLibrary, Overload) {
62   {
63     std::string Err;
64     llvm_shutdown_obj Shutdown;
65     DynamicLibrary DL =
66         DynamicLibrary::getPermanentLibrary(LibPath().c_str(), &Err);
67     EXPECT_TRUE(DL.isValid());
68     EXPECT_TRUE(Err.empty());
69 
70     GetString GS = FuncPtr<GetString>(DL.getAddressOfSymbol("TestA"));
71     EXPECT_TRUE(GS != nullptr && GS != &TestA);
72     EXPECT_EQ(StdString(GS()), "LibCall");
73 
74     GS = FuncPtr<GetString>(DynamicLibrary::SearchForAddressOfSymbol("TestA"));
75     EXPECT_TRUE(GS != nullptr && GS != &TestA);
76     EXPECT_EQ(StdString(GS()), "LibCall");
77 
78     DL = DynamicLibrary::getPermanentLibrary(nullptr, &Err);
79     EXPECT_TRUE(DL.isValid());
80     EXPECT_TRUE(Err.empty());
81 
82     GS = FuncPtr<GetString>(DynamicLibrary::SearchForAddressOfSymbol("TestA"));
83     EXPECT_TRUE(GS != nullptr && GS == &TestA);
84     EXPECT_EQ(StdString(GS()), "ProcessCall");
85 
86     GS = FuncPtr<GetString>(DL.getAddressOfSymbol("TestA"));
87     EXPECT_TRUE(GS != nullptr && GS == &TestA);
88     EXPECT_EQ(StdString(GS()), "ProcessCall");
89 
90     DynamicLibrary::AddSymbol("TestA", PtrFunc(&OverloadTestA));
91     GS = FuncPtr<GetString>(DL.getAddressOfSymbol("TestA"));
92     EXPECT_TRUE(GS != nullptr && GS != &OverloadTestA);
93 
94     GS = FuncPtr<GetString>(DynamicLibrary::SearchForAddressOfSymbol("TestA"));
95     EXPECT_TRUE(GS != nullptr && GS == &OverloadTestA);
96     EXPECT_EQ(StdString(GS()), "OverloadCall");
97   }
98   EXPECT_TRUE(FuncPtr<GetString>(DynamicLibrary::SearchForAddressOfSymbol(
99                   "TestA")) == nullptr);
100 }
101 
102 TEST(DynamicLibrary, Shutdown) {
103   std::string A("PipSqueak"), B, C("SecondLib");
104   std::vector<std::string> Order;
105   {
106     std::string Err;
107     llvm_shutdown_obj Shutdown;
108     DynamicLibrary DL =
109         DynamicLibrary::getPermanentLibrary(LibPath(A).c_str(), &Err);
110     EXPECT_TRUE(DL.isValid());
111     EXPECT_TRUE(Err.empty());
112 
113     SetStrings SS_0 = FuncPtr<SetStrings>(
114         DynamicLibrary::SearchForAddressOfSymbol("SetStrings"));
115     EXPECT_TRUE(SS_0 != nullptr);
116 
117     SS_0(A, B);
118     EXPECT_EQ(B, "Local::Local(PipSqueak)");
119 
120     TestOrder TO_0 = FuncPtr<TestOrder>(
121         DynamicLibrary::SearchForAddressOfSymbol("TestOrder"));
122     EXPECT_TRUE(TO_0 != nullptr);
123 
124     DynamicLibrary DL2 =
125         DynamicLibrary::getPermanentLibrary(LibPath(C).c_str(), &Err);
126     EXPECT_TRUE(DL2.isValid());
127     EXPECT_TRUE(Err.empty());
128 
129     // Should find latest version of symbols in SecondLib
130     SetStrings SS_1 = FuncPtr<SetStrings>(
131         DynamicLibrary::SearchForAddressOfSymbol("SetStrings"));
132     EXPECT_TRUE(SS_1 != nullptr);
133     EXPECT_TRUE(SS_0 != SS_1);
134 
135     TestOrder TO_1 = FuncPtr<TestOrder>(
136         DynamicLibrary::SearchForAddressOfSymbol("TestOrder"));
137     EXPECT_TRUE(TO_1 != nullptr);
138     EXPECT_TRUE(TO_0 != TO_1);
139 
140     B.clear();
141     SS_1(C, B);
142     EXPECT_EQ(B, "Local::Local(SecondLib)");
143 
144     TO_0(Order);
145     TO_1(Order);
146   }
147   EXPECT_EQ(A, "Global::~Global");
148   EXPECT_EQ(B, "Local::~Local");
149   EXPECT_TRUE(FuncPtr<SetStrings>(DynamicLibrary::SearchForAddressOfSymbol(
150                   "SetStrings")) == nullptr);
151 
152   // Test unload/destruction ordering
153   EXPECT_EQ(Order.size(), 2UL);
154   EXPECT_EQ(Order.front(), "SecondLib");
155   EXPECT_EQ(Order.back(), "PipSqueak");
156 }
157 
158 #else
159 
160 TEST(DynamicLibrary, Unsupported) {
161   std::string Err;
162   DynamicLibrary DL =
163       DynamicLibrary::getPermanentLibrary(LibPath().c_str(), &Err);
164   EXPECT_FALSE(DL.isValid());
165   EXPECT_EQ(Err, "dlopen() not supported on this platform");
166 }
167 
168 #endif
169