1 //===- llvm/unittest/Linker/LinkModulesTest.cpp - IRBuilder tests ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/ADT/STLExtras.h"
11 #include "llvm/AsmParser/Parser.h"
12 #include "llvm/IR/BasicBlock.h"
13 #include "llvm/IR/DataLayout.h"
14 #include "llvm/IR/Function.h"
15 #include "llvm/IR/IRBuilder.h"
16 #include "llvm/IR/Module.h"
17 #include "llvm/Linker/Linker.h"
18 #include "llvm/Support/SourceMgr.h"
19 #include "llvm-c/Core.h"
20 #include "llvm-c/Linker.h"
21 #include "gtest/gtest.h"
27 class LinkModuleTest : public testing::Test {
29 void SetUp() override {
30 M.reset(new Module("MyModule", Ctx));
31 FunctionType *FTy = FunctionType::get(
32 Type::getInt8PtrTy(Ctx), Type::getInt32Ty(Ctx), false /*=isVarArg*/);
33 F = Function::Create(FTy, Function::ExternalLinkage, "ba_func", M.get());
34 F->setCallingConv(CallingConv::C);
36 EntryBB = BasicBlock::Create(Ctx, "entry", F);
37 SwitchCase1BB = BasicBlock::Create(Ctx, "switch.case.1", F);
38 SwitchCase2BB = BasicBlock::Create(Ctx, "switch.case.2", F);
39 ExitBB = BasicBlock::Create(Ctx, "exit", F);
41 AT = ArrayType::get(Type::getInt8PtrTy(Ctx), 3);
43 GV = new GlobalVariable(*M.get(), AT, false /*=isConstant*/,
44 GlobalValue::InternalLinkage, nullptr,"switch.bas");
47 std::vector<Constant *> Init;
48 Constant *SwitchCase1BA = BlockAddress::get(SwitchCase1BB);
49 Init.push_back(SwitchCase1BA);
51 Constant *SwitchCase2BA = BlockAddress::get(SwitchCase2BB);
52 Init.push_back(SwitchCase2BA);
54 ConstantInt *One = ConstantInt::get(Type::getInt32Ty(Ctx), 1);
55 Constant *OnePtr = ConstantExpr::getCast(Instruction::IntToPtr, One,
56 Type::getInt8PtrTy(Ctx));
57 Init.push_back(OnePtr);
59 GV->setInitializer(ConstantArray::get(AT, Init));
62 void TearDown() override { M.reset(); }
65 std::unique_ptr<Module> M;
70 BasicBlock *SwitchCase1BB;
71 BasicBlock *SwitchCase2BB;
75 static void expectNoDiags(const DiagnosticInfo &DI, void *C) {
79 TEST_F(LinkModuleTest, BlockAddress) {
80 IRBuilder<> Builder(EntryBB);
82 std::vector<Value *> GEPIndices;
83 GEPIndices.push_back(ConstantInt::get(Type::getInt32Ty(Ctx), 0));
84 GEPIndices.push_back(&*F->arg_begin());
86 Value *GEP = Builder.CreateGEP(AT, GV, GEPIndices, "switch.gep");
87 Value *Load = Builder.CreateLoad(GEP, "switch.load");
89 Builder.CreateRet(Load);
91 Builder.SetInsertPoint(SwitchCase1BB);
92 Builder.CreateBr(ExitBB);
94 Builder.SetInsertPoint(SwitchCase2BB);
95 Builder.CreateBr(ExitBB);
97 Builder.SetInsertPoint(ExitBB);
98 Builder.CreateRet(ConstantPointerNull::get(Type::getInt8PtrTy(Ctx)));
100 Module *LinkedModule = new Module("MyModuleLinked", Ctx);
101 Ctx.setDiagnosticHandler(expectNoDiags);
102 Linker::linkModules(*LinkedModule, std::move(M));
104 // Check that the global "@switch.bas" is well-formed.
105 const GlobalVariable *LinkedGV = LinkedModule->getNamedGlobal("switch.bas");
106 const Constant *Init = LinkedGV->getInitializer();
108 // @switch.bas = internal global [3 x i8*]
109 // [i8* blockaddress(@ba_func, %switch.case.1),
110 // i8* blockaddress(@ba_func, %switch.case.2),
111 // i8* inttoptr (i32 1 to i8*)]
113 ArrayType *AT = ArrayType::get(Type::getInt8PtrTy(Ctx), 3);
114 EXPECT_EQ(AT, Init->getType());
116 Value *Elem = Init->getOperand(0);
117 ASSERT_TRUE(isa<BlockAddress>(Elem));
118 EXPECT_EQ(cast<BlockAddress>(Elem)->getFunction(),
119 LinkedModule->getFunction("ba_func"));
120 EXPECT_EQ(cast<BlockAddress>(Elem)->getBasicBlock()->getParent(),
121 LinkedModule->getFunction("ba_func"));
123 Elem = Init->getOperand(1);
124 ASSERT_TRUE(isa<BlockAddress>(Elem));
125 EXPECT_EQ(cast<BlockAddress>(Elem)->getFunction(),
126 LinkedModule->getFunction("ba_func"));
127 EXPECT_EQ(cast<BlockAddress>(Elem)->getBasicBlock()->getParent(),
128 LinkedModule->getFunction("ba_func"));
133 static Module *getExternal(LLVMContext &Ctx, StringRef FuncName) {
134 // Create a module with an empty externally-linked function
135 Module *M = new Module("ExternalModule", Ctx);
136 FunctionType *FTy = FunctionType::get(
137 Type::getVoidTy(Ctx), Type::getInt8PtrTy(Ctx), false /*=isVarArgs*/);
140 Function::Create(FTy, Function::ExternalLinkage, FuncName, M);
141 F->setCallingConv(CallingConv::C);
143 BasicBlock *BB = BasicBlock::Create(Ctx, "", F);
144 IRBuilder<> Builder(BB);
145 Builder.CreateRetVoid();
149 static Module *getInternal(LLVMContext &Ctx) {
150 Module *InternalM = new Module("InternalModule", Ctx);
151 FunctionType *FTy = FunctionType::get(
152 Type::getVoidTy(Ctx), Type::getInt8PtrTy(Ctx), false /*=isVarArgs*/);
155 Function::Create(FTy, Function::InternalLinkage, "bar", InternalM);
156 F->setCallingConv(CallingConv::C);
158 BasicBlock *BB = BasicBlock::Create(Ctx, "", F);
159 IRBuilder<> Builder(BB);
160 Builder.CreateRetVoid();
162 StructType *STy = StructType::create(Ctx, PointerType::get(FTy, 0));
165 new GlobalVariable(*InternalM, STy, false /*=isConstant*/,
166 GlobalValue::InternalLinkage, nullptr, "g");
168 GV->setInitializer(ConstantStruct::get(STy, F));
172 TEST_F(LinkModuleTest, EmptyModule) {
173 std::unique_ptr<Module> InternalM(getInternal(Ctx));
174 std::unique_ptr<Module> EmptyM(new Module("EmptyModule1", Ctx));
175 Ctx.setDiagnosticHandler(expectNoDiags);
176 Linker::linkModules(*EmptyM, std::move(InternalM));
179 TEST_F(LinkModuleTest, EmptyModule2) {
180 std::unique_ptr<Module> InternalM(getInternal(Ctx));
181 std::unique_ptr<Module> EmptyM(new Module("EmptyModule1", Ctx));
182 Ctx.setDiagnosticHandler(expectNoDiags);
183 Linker::linkModules(*InternalM, std::move(EmptyM));
186 TEST_F(LinkModuleTest, TypeMerge) {
190 const char *M1Str = "%t = type {i32}\n"
191 "@t1 = weak global %t zeroinitializer\n";
192 std::unique_ptr<Module> M1 = parseAssemblyString(M1Str, Err, C);
194 const char *M2Str = "%t = type {i32}\n"
195 "@t2 = weak global %t zeroinitializer\n";
196 std::unique_ptr<Module> M2 = parseAssemblyString(M2Str, Err, C);
198 Ctx.setDiagnosticHandler(expectNoDiags);
199 Linker::linkModules(*M1, std::move(M2));
201 EXPECT_EQ(M1->getNamedGlobal("t1")->getType(),
202 M1->getNamedGlobal("t2")->getType());
205 TEST_F(LinkModuleTest, CAPISuccess) {
206 std::unique_ptr<Module> DestM(getExternal(Ctx, "foo"));
207 std::unique_ptr<Module> SourceM(getExternal(Ctx, "bar"));
208 char *errout = nullptr;
209 LLVMBool result = LLVMLinkModules(wrap(DestM.get()), wrap(SourceM.get()),
210 LLVMLinkerDestroySource, &errout);
211 EXPECT_EQ(0, result);
212 EXPECT_EQ(nullptr, errout);
213 // "bar" is present in destination module
214 EXPECT_NE(nullptr, DestM->getFunction("bar"));
217 TEST_F(LinkModuleTest, CAPIFailure) {
218 // Symbol clash between two modules
219 std::unique_ptr<Module> DestM(getExternal(Ctx, "foo"));
220 std::unique_ptr<Module> SourceM(getExternal(Ctx, "foo"));
221 char *errout = nullptr;
222 LLVMBool result = LLVMLinkModules(wrap(DestM.get()), wrap(SourceM.get()),
223 LLVMLinkerDestroySource, &errout);
224 EXPECT_EQ(1, result);
225 EXPECT_STREQ("Linking globals named 'foo': symbol multiply defined!", errout);
226 LLVMDisposeMessage(errout);
229 TEST_F(LinkModuleTest, NewCAPISuccess) {
230 std::unique_ptr<Module> DestM(getExternal(Ctx, "foo"));
231 std::unique_ptr<Module> SourceM(getExternal(Ctx, "bar"));
233 LLVMLinkModules2(wrap(DestM.get()), wrap(SourceM.release()));
234 EXPECT_EQ(0, Result);
235 // "bar" is present in destination module
236 EXPECT_NE(nullptr, DestM->getFunction("bar"));
239 static void diagnosticHandler(LLVMDiagnosticInfoRef DI, void *C) {
240 auto *Err = reinterpret_cast<std::string *>(C);
241 char *CErr = LLVMGetDiagInfoDescription(DI);
243 LLVMDisposeMessage(CErr);
246 TEST_F(LinkModuleTest, NewCAPIFailure) {
247 // Symbol clash between two modules
250 LLVMContextSetDiagnosticHandler(wrap(&Ctx), diagnosticHandler, &Err);
252 std::unique_ptr<Module> DestM(getExternal(Ctx, "foo"));
253 std::unique_ptr<Module> SourceM(getExternal(Ctx, "foo"));
255 LLVMLinkModules2(wrap(DestM.get()), wrap(SourceM.release()));
256 EXPECT_EQ(1, Result);
257 EXPECT_EQ("Linking globals named 'foo': symbol multiply defined!", Err);
260 TEST_F(LinkModuleTest, MoveDistinctMDs) {
264 const char *SrcStr = "define void @foo() !attach !0 {\n"
266 " call void @llvm.md(metadata !1)\n"
267 " ret void, !attach !2\n"
269 "declare void @llvm.md(metadata)\n"
270 "!named = !{!3, !4}\n"
271 "!0 = distinct !{}\n"
272 "!1 = distinct !{}\n"
273 "!2 = distinct !{}\n"
274 "!3 = distinct !{}\n"
277 std::unique_ptr<Module> Src = parseAssemblyString(SrcStr, Err, C);
279 ASSERT_TRUE(Src.get());
281 // Get the addresses of the Metadata before merging.
282 Function *F = &*Src->begin();
283 ASSERT_EQ("foo", F->getName());
284 BasicBlock *BB = &F->getEntryBlock();
285 auto *CI = cast<CallInst>(&BB->front());
286 auto *RI = cast<ReturnInst>(BB->getTerminator());
287 NamedMDNode *NMD = &*Src->named_metadata_begin();
289 MDNode *M0 = F->getMetadata("attach");
291 cast<MDNode>(cast<MetadataAsValue>(CI->getArgOperand(0))->getMetadata());
292 MDNode *M2 = RI->getMetadata("attach");
293 MDNode *M3 = NMD->getOperand(0);
294 MDNode *M4 = NMD->getOperand(1);
296 // Confirm a few things about the IR.
297 EXPECT_TRUE(M0->isDistinct());
298 EXPECT_TRUE(M1->isDistinct());
299 EXPECT_TRUE(M2->isDistinct());
300 EXPECT_TRUE(M3->isDistinct());
301 EXPECT_TRUE(M4->isUniqued());
302 EXPECT_EQ(M3, M4->getOperand(0));
304 // Link into destination module.
305 auto Dst = llvm::make_unique<Module>("Linked", C);
306 ASSERT_TRUE(Dst.get());
307 Ctx.setDiagnosticHandler(expectNoDiags);
308 Linker::linkModules(*Dst, std::move(Src));
310 // Check that distinct metadata was moved, not cloned. Even !4, the uniqued
311 // node, should effectively be moved, since its only operand hasn't changed.
313 BB = &F->getEntryBlock();
314 CI = cast<CallInst>(&BB->front());
315 RI = cast<ReturnInst>(BB->getTerminator());
316 NMD = &*Dst->named_metadata_begin();
318 EXPECT_EQ(M0, F->getMetadata("attach"));
319 EXPECT_EQ(M1, cast<MetadataAsValue>(CI->getArgOperand(0))->getMetadata());
320 EXPECT_EQ(M2, RI->getMetadata("attach"));
321 EXPECT_EQ(M3, NMD->getOperand(0));
322 EXPECT_EQ(M4, NMD->getOperand(1));
324 // Confirm a few things about the IR. This shouldn't have changed.
325 EXPECT_TRUE(M0->isDistinct());
326 EXPECT_TRUE(M1->isDistinct());
327 EXPECT_TRUE(M2->isDistinct());
328 EXPECT_TRUE(M3->isDistinct());
329 EXPECT_TRUE(M4->isUniqued());
330 EXPECT_EQ(M3, M4->getOperand(0));
333 } // end anonymous namespace