blob: 33da6684575407d76e3e7edd93eda49b17fd95eb [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the LLVM module linker.
11//
12// Specifically, this:
13// * Merges global variables between the two modules
14// * Uninit + Uninit = Init, Init + Uninit = Init, Init + Init = Error if !=
15// * Merges functions between two modules
16//
17//===----------------------------------------------------------------------===//
18
19#include "llvm/Linker.h"
20#include "llvm/Constants.h"
21#include "llvm/DerivedTypes.h"
22#include "llvm/Module.h"
23#include "llvm/TypeSymbolTable.h"
24#include "llvm/ValueSymbolTable.h"
25#include "llvm/Instructions.h"
26#include "llvm/Assembly/Writer.h"
27#include "llvm/Support/Streams.h"
28#include "llvm/System/Path.h"
29#include <sstream>
30using namespace llvm;
31
32// Error - Simple wrapper function to conditionally assign to E and return true.
33// This just makes error return conditions a little bit simpler...
34static inline bool Error(std::string *E, const std::string &Message) {
35 if (E) *E = Message;
36 return true;
37}
38
39// ToStr - Simple wrapper function to convert a type to a string.
40static std::string ToStr(const Type *Ty, const Module *M) {
41 std::ostringstream OS;
42 WriteTypeSymbolic(OS, Ty, M);
43 return OS.str();
44}
45
46//
47// Function: ResolveTypes()
48//
49// Description:
50// Attempt to link the two specified types together.
51//
52// Inputs:
53// DestTy - The type to which we wish to resolve.
54// SrcTy - The original type which we want to resolve.
55// Name - The name of the type.
56//
57// Outputs:
58// DestST - The symbol table in which the new type should be placed.
59//
60// Return value:
61// true - There is an error and the types cannot yet be linked.
62// false - No errors.
63//
64static bool ResolveTypes(const Type *DestTy, const Type *SrcTy,
65 TypeSymbolTable *DestST, const std::string &Name) {
66 if (DestTy == SrcTy) return false; // If already equal, noop
67
68 // Does the type already exist in the module?
69 if (DestTy && !isa<OpaqueType>(DestTy)) { // Yup, the type already exists...
70 if (const OpaqueType *OT = dyn_cast<OpaqueType>(SrcTy)) {
71 const_cast<OpaqueType*>(OT)->refineAbstractTypeTo(DestTy);
72 } else {
73 return true; // Cannot link types... neither is opaque and not-equal
74 }
75 } else { // Type not in dest module. Add it now.
76 if (DestTy) // Type _is_ in module, just opaque...
77 const_cast<OpaqueType*>(cast<OpaqueType>(DestTy))
78 ->refineAbstractTypeTo(SrcTy);
79 else if (!Name.empty())
80 DestST->insert(Name, const_cast<Type*>(SrcTy));
81 }
82 return false;
83}
84
85static const FunctionType *getFT(const PATypeHolder &TH) {
86 return cast<FunctionType>(TH.get());
87}
88static const StructType *getST(const PATypeHolder &TH) {
89 return cast<StructType>(TH.get());
90}
91
92// RecursiveResolveTypes - This is just like ResolveTypes, except that it
93// recurses down into derived types, merging the used types if the parent types
94// are compatible.
95static bool RecursiveResolveTypesI(const PATypeHolder &DestTy,
96 const PATypeHolder &SrcTy,
97 TypeSymbolTable *DestST,
98 const std::string &Name,
99 std::vector<std::pair<PATypeHolder, PATypeHolder> > &Pointers) {
100 const Type *SrcTyT = SrcTy.get();
101 const Type *DestTyT = DestTy.get();
102 if (DestTyT == SrcTyT) return false; // If already equal, noop
103
104 // If we found our opaque type, resolve it now!
105 if (isa<OpaqueType>(DestTyT) || isa<OpaqueType>(SrcTyT))
106 return ResolveTypes(DestTyT, SrcTyT, DestST, Name);
107
108 // Two types cannot be resolved together if they are of different primitive
109 // type. For example, we cannot resolve an int to a float.
110 if (DestTyT->getTypeID() != SrcTyT->getTypeID()) return true;
111
112 // Otherwise, resolve the used type used by this derived type...
113 switch (DestTyT->getTypeID()) {
114 case Type::IntegerTyID: {
115 if (cast<IntegerType>(DestTyT)->getBitWidth() !=
116 cast<IntegerType>(SrcTyT)->getBitWidth())
117 return true;
118 return false;
119 }
120 case Type::FunctionTyID: {
121 if (cast<FunctionType>(DestTyT)->isVarArg() !=
122 cast<FunctionType>(SrcTyT)->isVarArg() ||
123 cast<FunctionType>(DestTyT)->getNumContainedTypes() !=
124 cast<FunctionType>(SrcTyT)->getNumContainedTypes())
125 return true;
126 for (unsigned i = 0, e = getFT(DestTy)->getNumContainedTypes(); i != e; ++i)
127 if (RecursiveResolveTypesI(getFT(DestTy)->getContainedType(i),
128 getFT(SrcTy)->getContainedType(i), DestST, "",
129 Pointers))
130 return true;
131 return false;
132 }
133 case Type::StructTyID: {
134 if (getST(DestTy)->getNumContainedTypes() !=
135 getST(SrcTy)->getNumContainedTypes()) return 1;
136 for (unsigned i = 0, e = getST(DestTy)->getNumContainedTypes(); i != e; ++i)
137 if (RecursiveResolveTypesI(getST(DestTy)->getContainedType(i),
138 getST(SrcTy)->getContainedType(i), DestST, "",
139 Pointers))
140 return true;
141 return false;
142 }
143 case Type::ArrayTyID: {
144 const ArrayType *DAT = cast<ArrayType>(DestTy.get());
145 const ArrayType *SAT = cast<ArrayType>(SrcTy.get());
146 if (DAT->getNumElements() != SAT->getNumElements()) return true;
147 return RecursiveResolveTypesI(DAT->getElementType(), SAT->getElementType(),
148 DestST, "", Pointers);
149 }
150 case Type::PointerTyID: {
151 // If this is a pointer type, check to see if we have already seen it. If
152 // so, we are in a recursive branch. Cut off the search now. We cannot use
153 // an associative container for this search, because the type pointers (keys
154 // in the container) change whenever types get resolved...
155 for (unsigned i = 0, e = Pointers.size(); i != e; ++i)
156 if (Pointers[i].first == DestTy)
157 return Pointers[i].second != SrcTy;
158
159 // Otherwise, add the current pointers to the vector to stop recursion on
160 // this pair.
161 Pointers.push_back(std::make_pair(DestTyT, SrcTyT));
162 bool Result =
163 RecursiveResolveTypesI(cast<PointerType>(DestTy.get())->getElementType(),
164 cast<PointerType>(SrcTy.get())->getElementType(),
165 DestST, "", Pointers);
166 Pointers.pop_back();
167 return Result;
168 }
169 default: assert(0 && "Unexpected type!"); return true;
170 }
171}
172
173static bool RecursiveResolveTypes(const PATypeHolder &DestTy,
174 const PATypeHolder &SrcTy,
175 TypeSymbolTable *DestST,
176 const std::string &Name){
177 std::vector<std::pair<PATypeHolder, PATypeHolder> > PointerTypes;
178 return RecursiveResolveTypesI(DestTy, SrcTy, DestST, Name, PointerTypes);
179}
180
181
182// LinkTypes - Go through the symbol table of the Src module and see if any
183// types are named in the src module that are not named in the Dst module.
184// Make sure there are no type name conflicts.
185static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
186 TypeSymbolTable *DestST = &Dest->getTypeSymbolTable();
187 const TypeSymbolTable *SrcST = &Src->getTypeSymbolTable();
188
189 // Look for a type plane for Type's...
190 TypeSymbolTable::const_iterator TI = SrcST->begin();
191 TypeSymbolTable::const_iterator TE = SrcST->end();
192 if (TI == TE) return false; // No named types, do nothing.
193
194 // Some types cannot be resolved immediately because they depend on other
195 // types being resolved to each other first. This contains a list of types we
196 // are waiting to recheck.
197 std::vector<std::string> DelayedTypesToResolve;
198
199 for ( ; TI != TE; ++TI ) {
200 const std::string &Name = TI->first;
201 const Type *RHS = TI->second;
202
203 // Check to see if this type name is already in the dest module...
204 Type *Entry = DestST->lookup(Name);
205
206 if (ResolveTypes(Entry, RHS, DestST, Name)) {
207 // They look different, save the types 'till later to resolve.
208 DelayedTypesToResolve.push_back(Name);
209 }
210 }
211
212 // Iteratively resolve types while we can...
213 while (!DelayedTypesToResolve.empty()) {
214 // Loop over all of the types, attempting to resolve them if possible...
215 unsigned OldSize = DelayedTypesToResolve.size();
216
217 // Try direct resolution by name...
218 for (unsigned i = 0; i != DelayedTypesToResolve.size(); ++i) {
219 const std::string &Name = DelayedTypesToResolve[i];
220 Type *T1 = SrcST->lookup(Name);
221 Type *T2 = DestST->lookup(Name);
222 if (!ResolveTypes(T2, T1, DestST, Name)) {
223 // We are making progress!
224 DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
225 --i;
226 }
227 }
228
229 // Did we not eliminate any types?
230 if (DelayedTypesToResolve.size() == OldSize) {
231 // Attempt to resolve subelements of types. This allows us to merge these
232 // two types: { int* } and { opaque* }
233 for (unsigned i = 0, e = DelayedTypesToResolve.size(); i != e; ++i) {
234 const std::string &Name = DelayedTypesToResolve[i];
235 PATypeHolder T1(SrcST->lookup(Name));
236 PATypeHolder T2(DestST->lookup(Name));
237
238 if (!RecursiveResolveTypes(T2, T1, DestST, Name)) {
239 // We are making progress!
240 DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
241
242 // Go back to the main loop, perhaps we can resolve directly by name
243 // now...
244 break;
245 }
246 }
247
248 // If we STILL cannot resolve the types, then there is something wrong.
249 if (DelayedTypesToResolve.size() == OldSize) {
250 // Remove the symbol name from the destination.
251 DelayedTypesToResolve.pop_back();
252 }
253 }
254 }
255
256
257 return false;
258}
259
260static void PrintMap(const std::map<const Value*, Value*> &M) {
261 for (std::map<const Value*, Value*>::const_iterator I = M.begin(), E =M.end();
262 I != E; ++I) {
263 cerr << " Fr: " << (void*)I->first << " ";
264 I->first->dump();
265 cerr << " To: " << (void*)I->second << " ";
266 I->second->dump();
267 cerr << "\n";
268 }
269}
270
271
272// RemapOperand - Use ValueMap to convert constants from one module to another.
273static Value *RemapOperand(const Value *In,
274 std::map<const Value*, Value*> &ValueMap) {
275 std::map<const Value*,Value*>::const_iterator I = ValueMap.find(In);
276 if (I != ValueMap.end())
277 return I->second;
278
279 // Check to see if it's a constant that we are interested in transforming.
280 Value *Result = 0;
281 if (const Constant *CPV = dyn_cast<Constant>(In)) {
282 if ((!isa<DerivedType>(CPV->getType()) && !isa<ConstantExpr>(CPV)) ||
283 isa<ConstantInt>(CPV) || isa<ConstantAggregateZero>(CPV))
284 return const_cast<Constant*>(CPV); // Simple constants stay identical.
285
286 if (const ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
287 std::vector<Constant*> Operands(CPA->getNumOperands());
288 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
289 Operands[i] =cast<Constant>(RemapOperand(CPA->getOperand(i), ValueMap));
290 Result = ConstantArray::get(cast<ArrayType>(CPA->getType()), Operands);
291 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
292 std::vector<Constant*> Operands(CPS->getNumOperands());
293 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
294 Operands[i] =cast<Constant>(RemapOperand(CPS->getOperand(i), ValueMap));
295 Result = ConstantStruct::get(cast<StructType>(CPS->getType()), Operands);
296 } else if (isa<ConstantPointerNull>(CPV) || isa<UndefValue>(CPV)) {
297 Result = const_cast<Constant*>(CPV);
298 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CPV)) {
299 std::vector<Constant*> Operands(CP->getNumOperands());
300 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
301 Operands[i] = cast<Constant>(RemapOperand(CP->getOperand(i), ValueMap));
302 Result = ConstantVector::get(Operands);
303 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
304 std::vector<Constant*> Ops;
305 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
306 Ops.push_back(cast<Constant>(RemapOperand(CE->getOperand(i),ValueMap)));
307 Result = CE->getWithOperands(Ops);
308 } else if (isa<GlobalValue>(CPV)) {
309 assert(0 && "Unmapped global?");
310 } else {
311 assert(0 && "Unknown type of derived type constant value!");
312 }
313 } else if (isa<InlineAsm>(In)) {
314 Result = const_cast<Value*>(In);
315 }
316
317 // Cache the mapping in our local map structure
318 if (Result) {
319 ValueMap.insert(std::make_pair(In, Result));
320 return Result;
321 }
322
323
324 cerr << "LinkModules ValueMap: \n";
325 PrintMap(ValueMap);
326
327 cerr << "Couldn't remap value: " << (void*)In << " " << *In << "\n";
328 assert(0 && "Couldn't remap value!");
329 return 0;
330}
331
332/// ForceRenaming - The LLVM SymbolTable class autorenames globals that conflict
333/// in the symbol table. This is good for all clients except for us. Go
334/// through the trouble to force this back.
335static void ForceRenaming(GlobalValue *GV, const std::string &Name) {
336 assert(GV->getName() != Name && "Can't force rename to self");
337 ValueSymbolTable &ST = GV->getParent()->getValueSymbolTable();
338
339 // If there is a conflict, rename the conflict.
340 if (GlobalValue *ConflictGV = cast_or_null<GlobalValue>(ST.lookup(Name))) {
341 assert(ConflictGV->hasInternalLinkage() &&
342 "Not conflicting with a static global, should link instead!");
343 GV->takeName(ConflictGV);
344 ConflictGV->setName(Name); // This will cause ConflictGV to get renamed
345 assert(ConflictGV->getName() != Name && "ForceRenaming didn't work");
346 } else {
347 GV->setName(Name); // Force the name back
348 }
349}
350
351/// CopyGVAttributes - copy additional attributes (those not needed to construct
352/// a GlobalValue) from the SrcGV to the DestGV.
353static void CopyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) {
354 // Propagate alignment, visibility and section info.
355 DestGV->setAlignment(std::max(DestGV->getAlignment(), SrcGV->getAlignment()));
356 DestGV->setSection(SrcGV->getSection());
357 DestGV->setVisibility(SrcGV->getVisibility());
358 if (const Function *SrcF = dyn_cast<Function>(SrcGV)) {
359 Function *DestF = cast<Function>(DestGV);
360 DestF->setCallingConv(SrcF->getCallingConv());
Duncan Sandsf5588dc2007-11-27 13:23:08 +0000361 DestF->setParamAttrs(SrcF->getParamAttrs());
Gordon Henriksen3e7ea1e2007-12-25 22:16:06 +0000362 if (SrcF->hasCollector())
363 DestF->setCollector(SrcF->getCollector());
Anton Korobeynikov2bde2d82008-03-07 18:32:18 +0000364 } else if (const GlobalVariable *SrcVar = dyn_cast<GlobalVariable>(SrcGV)) {
365 GlobalVariable *DestVar = cast<GlobalVariable>(DestGV);
366 DestVar->setThreadLocal(SrcVar->isThreadLocal());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000367 }
368}
369
370/// GetLinkageResult - This analyzes the two global values and determines what
371/// the result will look like in the destination module. In particular, it
372/// computes the resultant linkage type, computes whether the global in the
373/// source should be copied over to the destination (replacing the existing
374/// one), and computes whether this linkage is an error or not. It also performs
375/// visibility checks: we cannot link together two symbols with different
376/// visibilities.
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000377static bool GetLinkageResult(GlobalValue *Dest, const GlobalValue *Src,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000378 GlobalValue::LinkageTypes &LT, bool &LinkFromSrc,
379 std::string *Err) {
380 assert((!Dest || !Src->hasInternalLinkage()) &&
381 "If Src has internal linkage, Dest shouldn't be set!");
382 if (!Dest) {
383 // Linking something to nothing.
384 LinkFromSrc = true;
385 LT = Src->getLinkage();
386 } else if (Src->isDeclaration()) {
Anton Korobeynikov15520982008-03-10 22:33:22 +0000387 // If Src is external or if both Src & Dest are external.. Just link the
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000388 // external globals, we aren't adding anything.
389 if (Src->hasDLLImportLinkage()) {
390 // If one of GVs has DLLImport linkage, result should be dllimport'ed.
391 if (Dest->isDeclaration()) {
392 LinkFromSrc = true;
393 LT = Src->getLinkage();
394 }
395 } else if (Dest->hasExternalWeakLinkage()) {
396 //If the Dest is weak, use the source linkage
397 LinkFromSrc = true;
398 LT = Src->getLinkage();
399 } else {
400 LinkFromSrc = false;
401 LT = Dest->getLinkage();
402 }
403 } else if (Dest->isDeclaration() && !Dest->hasDLLImportLinkage()) {
404 // If Dest is external but Src is not:
405 LinkFromSrc = true;
406 LT = Src->getLinkage();
407 } else if (Src->hasAppendingLinkage() || Dest->hasAppendingLinkage()) {
408 if (Src->getLinkage() != Dest->getLinkage())
409 return Error(Err, "Linking globals named '" + Src->getName() +
410 "': can only link appending global with another appending global!");
411 LinkFromSrc = true; // Special cased.
412 LT = Src->getLinkage();
413 } else if (Src->hasWeakLinkage() || Src->hasLinkOnceLinkage()) {
414 // At this point we know that Dest has LinkOnce, External*, Weak, or
415 // DLL* linkage.
416 if ((Dest->hasLinkOnceLinkage() && Src->hasWeakLinkage()) ||
417 Dest->hasExternalWeakLinkage()) {
418 LinkFromSrc = true;
419 LT = Src->getLinkage();
420 } else {
421 LinkFromSrc = false;
422 LT = Dest->getLinkage();
423 }
424 } else if (Dest->hasWeakLinkage() || Dest->hasLinkOnceLinkage()) {
425 // At this point we know that Src has External* or DLL* linkage.
426 if (Src->hasExternalWeakLinkage()) {
427 LinkFromSrc = false;
428 LT = Dest->getLinkage();
429 } else {
430 LinkFromSrc = true;
431 LT = GlobalValue::ExternalLinkage;
432 }
433 } else {
434 assert((Dest->hasExternalLinkage() ||
435 Dest->hasDLLImportLinkage() ||
436 Dest->hasDLLExportLinkage() ||
437 Dest->hasExternalWeakLinkage()) &&
438 (Src->hasExternalLinkage() ||
439 Src->hasDLLImportLinkage() ||
440 Src->hasDLLExportLinkage() ||
441 Src->hasExternalWeakLinkage()) &&
442 "Unexpected linkage type!");
443 return Error(Err, "Linking globals named '" + Src->getName() +
444 "': symbol multiply defined!");
445 }
446
447 // Check visibility
448 if (Dest && Src->getVisibility() != Dest->getVisibility())
Chris Lattnerb69fcb82007-08-19 22:22:54 +0000449 if (!Src->isDeclaration() && !Dest->isDeclaration())
450 return Error(Err, "Linking globals named '" + Src->getName() +
451 "': symbols have different visibilities!");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000452 return false;
453}
454
455// LinkGlobals - Loop through the global variables in the src module and merge
456// them into the dest module.
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000457static bool LinkGlobals(Module *Dest, const Module *Src,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000458 std::map<const Value*, Value*> &ValueMap,
459 std::multimap<std::string, GlobalVariable *> &AppendingVars,
460 std::string *Err) {
461 // Loop over all of the globals in the src module, mapping them over as we go
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000462 for (Module::const_global_iterator I = Src->global_begin(), E = Src->global_end();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000463 I != E; ++I) {
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000464 const GlobalVariable *SGV = I;
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000465 GlobalValue *DGV = 0;
466
467 // Check to see if may have to link the global with the global
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000468 if (SGV->hasName() && !SGV->hasInternalLinkage()) {
469 DGV = Dest->getGlobalVariable(SGV->getName());
470 if (DGV && DGV->getType() != SGV->getType())
471 // If types don't agree due to opaque types, try to resolve them.
472 RecursiveResolveTypes(SGV->getType(), DGV->getType(),
473 &Dest->getTypeSymbolTable(), "");
474 }
475
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000476 // Check to see if may have to link the global with the alias
477 if (SGV->hasName() && !SGV->hasInternalLinkage()) {
478 DGV = Dest->getNamedAlias(SGV->getName());
479 if (DGV && DGV->getType() != SGV->getType())
480 // If types don't agree due to opaque types, try to resolve them.
481 RecursiveResolveTypes(SGV->getType(), DGV->getType(),
482 &Dest->getTypeSymbolTable(), "");
483 }
484
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000485 if (DGV && DGV->hasInternalLinkage())
486 DGV = 0;
487
Dan Gohman930191f2007-10-08 15:13:30 +0000488 assert((SGV->hasInitializer() || SGV->hasExternalWeakLinkage() ||
489 SGV->hasExternalLinkage() || SGV->hasDLLImportLinkage()) &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000490 "Global must either be external or have an initializer!");
491
492 GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
493 bool LinkFromSrc = false;
494 if (GetLinkageResult(DGV, SGV, NewLinkage, LinkFromSrc, Err))
495 return true;
496
497 if (!DGV) {
498 // No linking to be performed, simply create an identical version of the
499 // symbol over in the dest module... the initializer will be filled in
500 // later by LinkGlobalInits...
501 GlobalVariable *NewDGV =
502 new GlobalVariable(SGV->getType()->getElementType(),
503 SGV->isConstant(), SGV->getLinkage(), /*init*/0,
Anton Korobeynikov2bde2d82008-03-07 18:32:18 +0000504 SGV->getName(), Dest);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000505 // Propagate alignment, visibility and section info.
506 CopyGVAttributes(NewDGV, SGV);
507
508 // If the LLVM runtime renamed the global, but it is an externally visible
509 // symbol, DGV must be an existing global with internal linkage. Rename
510 // it.
511 if (NewDGV->getName() != SGV->getName() && !NewDGV->hasInternalLinkage())
512 ForceRenaming(NewDGV, SGV->getName());
513
514 // Make sure to remember this mapping...
515 ValueMap.insert(std::make_pair(SGV, NewDGV));
516 if (SGV->hasAppendingLinkage())
517 // Keep track that this is an appending variable...
518 AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
519 } else if (DGV->hasAppendingLinkage()) {
520 // No linking is performed yet. Just insert a new copy of the global, and
521 // keep track of the fact that it is an appending variable in the
522 // AppendingVars map. The name is cleared out so that no linkage is
523 // performed.
524 GlobalVariable *NewDGV =
525 new GlobalVariable(SGV->getType()->getElementType(),
526 SGV->isConstant(), SGV->getLinkage(), /*init*/0,
Anton Korobeynikov2bde2d82008-03-07 18:32:18 +0000527 "", Dest);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000528
Anton Korobeynikov4da527c2008-03-07 18:34:50 +0000529 // Set alignment allowing CopyGVAttributes merge it with alignment of SGV.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000530 NewDGV->setAlignment(DGV->getAlignment());
Anton Korobeynikov4da527c2008-03-07 18:34:50 +0000531 // Propagate alignment, section and visibility info.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000532 CopyGVAttributes(NewDGV, SGV);
533
534 // Make sure to remember this mapping...
535 ValueMap.insert(std::make_pair(SGV, NewDGV));
536
537 // Keep track that this is an appending variable...
538 AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000539 } else if (GlobalAlias *DGA = dyn_cast<GlobalAlias>(DGV)) {
540 // SGV is global, but DGV is alias. The only valid mapping is when SGV is
541 // external declaration, which is effectively a no-op. Also make sure
542 // linkage is correct.
543 if (SGV->isDeclaration() && !LinkFromSrc) {
544 // Make sure to remember this mapping...
545 ValueMap.insert(std::make_pair(SGV, DGA));
546 } else
547 return Error(Err, "Global-Alias Collision on '" +
548 ToStr(SGV->getType(), Src) +"':%"+SGV->getName()+
549 " - symbol multiple defined");
550 } else if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV)) {
Anton Korobeynikov2bde2d82008-03-07 18:32:18 +0000551 // Otherwise, perform the mapping as instructed by GetLinkageResult.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000552 if (LinkFromSrc) {
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000553 // Propagate alignment, section, and visibility info.
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000554 CopyGVAttributes(DGVar, SGV);
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000555
556 // If the types don't match, and if we are to link from the source, nuke
557 // DGV and create a new one of the appropriate type.
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000558 if (SGV->getType() != DGVar->getType()) {
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000559 GlobalVariable *NewDGV =
560 new GlobalVariable(SGV->getType()->getElementType(),
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000561 DGVar->isConstant(), DGVar->getLinkage(),
562 /*init*/0, DGVar->getName(), Dest);
563 CopyGVAttributes(NewDGV, DGVar);
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000564 DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDGV,
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000565 DGVar->getType()));
566 // DGVar will conflict with NewDGV because they both had the same
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000567 // name. We must erase this now so ForceRenaming doesn't assert
568 // because DGV might not have internal linkage.
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000569 DGVar->eraseFromParent();
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000570
571 // If the symbol table renamed the global, but it is an externally
572 // visible symbol, DGV must be an existing global with internal
573 // linkage. Rename it.
574 if (NewDGV->getName() != SGV->getName() &&
575 !NewDGV->hasInternalLinkage())
576 ForceRenaming(NewDGV, SGV->getName());
577
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000578 DGVar = NewDGV;
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000579 }
580
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000581 // Inherit const as appropriate
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000582 DGVar->setConstant(SGV->isConstant());
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000583
584 // Set initializer to zero, so we can link the stuff later
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000585 DGVar->setInitializer(0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000586 } else {
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000587 // Special case for const propagation
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000588 if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant())
589 DGVar->setConstant(true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000590 }
591
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000592 // Set calculated linkage
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000593 DGVar->setLinkage(NewLinkage);
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000594
595 // Make sure to remember this mapping...
596 ValueMap.insert(std::make_pair(SGV,
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000597 ConstantExpr::getBitCast(DGVar,
Anton Korobeynikovebb58502008-03-10 22:33:53 +0000598 SGV->getType())));
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000599 }
600 }
601 return false;
602}
603
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000604static GlobalValue::LinkageTypes
605CalculateAliasLinkage(const GlobalValue *SGV, const GlobalValue *DGV) {
606 if (SGV->hasExternalLinkage() || DGV->hasExternalLinkage())
607 return GlobalValue::ExternalLinkage;
608 else if (SGV->hasWeakLinkage() || DGV->hasWeakLinkage())
609 return GlobalValue::WeakLinkage;
610 else {
611 assert(SGV->hasInternalLinkage() && DGV->hasInternalLinkage() &&
612 "Unexpected linkage type");
613 return GlobalValue::InternalLinkage;
614 }
615}
616
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000617// LinkAlias - Loop through the alias in the src module and link them into the
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000618// dest module. We're assuming, that all functions/global variables were already
619// linked in.
Anton Korobeynikov3cfecfd2008-03-05 15:27:21 +0000620static bool LinkAlias(Module *Dest, const Module *Src,
621 std::map<const Value*, Value*> &ValueMap,
622 std::string *Err) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000623 // Loop over all alias in the src module
624 for (Module::const_alias_iterator I = Src->alias_begin(),
625 E = Src->alias_end(); I != E; ++I) {
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000626 const GlobalAlias *SGA = I;
627 const GlobalValue *SAliasee = SGA->getAliasedGlobal();
628 GlobalAlias *NewGA = NULL;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000629
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000630 // Globals were already linked, thus we can just query ValueMap for variant
631 // of SAliasee in Dest
Ted Kremenekd40cdd22008-03-09 18:32:50 +0000632 std::map<const Value*,Value*>::const_iterator VMI = ValueMap.find(SAliasee);
633 assert(VMI != ValueMap.end() && "Aliasee not linked");
634 GlobalValue* DAliasee = cast<GlobalValue>(VMI->second);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000635
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000636 // Try to find something 'similar' to SGA in destination module.
637 if (GlobalAlias *DGA = Dest->getNamedAlias(SGA->getName())) {
638 // If types don't agree due to opaque types, try to resolve them.
639 if (RecursiveResolveTypes(SGA->getType(), DGA->getType(),
640 &Dest->getTypeSymbolTable(), ""))
641 return Error(Err, "Alias Collision on '" +
642 ToStr(SGA->getType(), Src) +"':%"+SGA->getName()+
643 " - aliases have different types");
Anton Korobeynikov3cfecfd2008-03-05 15:27:21 +0000644
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000645 // Now types are known to be the same, check whether aliasees equal. As
646 // globals are already linked we just need query ValueMap to find the
647 // mapping.
648 if (DAliasee == DGA->getAliasedGlobal()) {
649 // This is just two copies of the same alias. Propagate linkage, if
650 // necessary.
651 DGA->setLinkage(CalculateAliasLinkage(SGA, DGA));
652
653 NewGA = DGA;
654 // Proceed to 'common' steps
655 } else
656 return Error(Err, "Alias Collision on '" +
657 ToStr(SGA->getType(), Src) +"':%"+SGA->getName()+
658 " - aliases have different aliasees");
659 } else if (GlobalVariable *DGV = Dest->getGlobalVariable(SGA->getName())) {
660 RecursiveResolveTypes(SGA->getType(), DGV->getType(),
661 &Dest->getTypeSymbolTable(), "");
Anton Korobeynikovcdf208a2008-03-05 23:08:16 +0000662
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000663 // The only allowed way is to link alias with external declaration.
664 if (DGV->isDeclaration()) {
665 NewGA = new GlobalAlias(SGA->getType(), SGA->getLinkage(),
666 SGA->getName(), DAliasee, Dest);
667 CopyGVAttributes(NewGA, SGA);
668
669 // Any uses of DGV need to change to NewGA, with cast, if needed.
670 if (SGA->getType() != DGV->getType())
671 DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewGA,
672 DGV->getType()));
673 else
674 DGV->replaceAllUsesWith(NewGA);
675
676 // DGV will conflict with NewGA because they both had the same
677 // name. We must erase this now so ForceRenaming doesn't assert
678 // because DGV might not have internal linkage.
679 DGV->eraseFromParent();
680
681 // Proceed to 'common' steps
682 } else
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000683 return Error(Err, "Global-Alias Collision on '" +
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000684 ToStr(SGA->getType(), Src) +"':%"+SGA->getName()+
685 " - symbol multiple defined");
686 } else if (Function *DF = Dest->getFunction(SGA->getName())) {
687 RecursiveResolveTypes(SGA->getType(), DF->getType(),
688 &Dest->getTypeSymbolTable(), "");
Anton Korobeynikovcdf208a2008-03-05 23:08:16 +0000689
690 // The only allowed way is to link alias with external declaration.
691 if (DF->isDeclaration()) {
692 NewGA = new GlobalAlias(SGA->getType(), SGA->getLinkage(),
693 SGA->getName(), DAliasee, Dest);
694 CopyGVAttributes(NewGA, SGA);
695
696 // Any uses of DF need to change to NewGA, with cast, if needed.
697 if (SGA->getType() != DF->getType())
698 DF->replaceAllUsesWith(ConstantExpr::getBitCast(NewGA,
699 DF->getType()));
700 else
701 DF->replaceAllUsesWith(NewGA);
702
703 // DF will conflict with NewGA because they both had the same
704 // name. We must erase this now so ForceRenaming doesn't assert
705 // because DF might not have internal linkage.
706 DF->eraseFromParent();
707
708 // Proceed to 'common' steps
709 } else
Anton Korobeynikov30dd7162008-03-10 22:34:28 +0000710 return Error(Err, "Function-Alias Collision on '" +
Anton Korobeynikovcdf208a2008-03-05 23:08:16 +0000711 ToStr(SGA->getType(), Src) +"':%"+SGA->getName()+
712 " - symbol multiple defined");
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000713 } else {
714 // Nothing similar found, just copy alias into destination module.
715
716 NewGA = new GlobalAlias(SGA->getType(), SGA->getLinkage(),
717 SGA->getName(), DAliasee, Dest);
718 CopyGVAttributes(NewGA, SGA);
719
720 // Proceed to 'common' steps
721 }
722
723 assert(NewGA && "No alias was created in destination module!");
724
725 // If the symbol table renamed the function, but it is an externally
726 // visible symbol, DGV must be an existing function with internal
727 // linkage. Rename it.
728 if (NewGA->getName() != SGA->getName() &&
729 !NewGA->hasInternalLinkage())
730 ForceRenaming(NewGA, SGA->getName());
731
732 // Remember this mapping so uses in the source module get remapped
733 // later by RemapOperand.
734 ValueMap.insert(std::make_pair(SGA, NewGA));
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000735 }
Anton Korobeynikovd0391562008-03-05 22:22:46 +0000736
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000737 return false;
738}
739
740
741// LinkGlobalInits - Update the initializers in the Dest module now that all
742// globals that may be referenced are in Dest.
743static bool LinkGlobalInits(Module *Dest, const Module *Src,
744 std::map<const Value*, Value*> &ValueMap,
745 std::string *Err) {
746
747 // Loop over all of the globals in the src module, mapping them over as we go
748 for (Module::const_global_iterator I = Src->global_begin(),
749 E = Src->global_end(); I != E; ++I) {
750 const GlobalVariable *SGV = I;
751
752 if (SGV->hasInitializer()) { // Only process initialized GV's
753 // Figure out what the initializer looks like in the dest module...
754 Constant *SInit =
755 cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap));
756
757 GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[SGV]);
758 if (DGV->hasInitializer()) {
759 if (SGV->hasExternalLinkage()) {
760 if (DGV->getInitializer() != SInit)
761 return Error(Err, "Global Variable Collision on '" +
762 ToStr(SGV->getType(), Src) +"':%"+SGV->getName()+
763 " - Global variables have different initializers");
764 } else if (DGV->hasLinkOnceLinkage() || DGV->hasWeakLinkage()) {
765 // Nothing is required, mapped values will take the new global
766 // automatically.
767 } else if (SGV->hasLinkOnceLinkage() || SGV->hasWeakLinkage()) {
768 // Nothing is required, mapped values will take the new global
769 // automatically.
770 } else if (DGV->hasAppendingLinkage()) {
771 assert(0 && "Appending linkage unimplemented!");
772 } else {
773 assert(0 && "Unknown linkage!");
774 }
775 } else {
776 // Copy the initializer over now...
777 DGV->setInitializer(SInit);
778 }
779 }
780 }
781 return false;
782}
783
784// LinkFunctionProtos - Link the functions together between the two modules,
785// without doing function bodies... this just adds external function prototypes
786// to the Dest function...
787//
788static bool LinkFunctionProtos(Module *Dest, const Module *Src,
789 std::map<const Value*, Value*> &ValueMap,
790 std::string *Err) {
791 // Loop over all of the functions in the src module, mapping them over
792 for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
793 const Function *SF = I; // SrcFunction
794 Function *DF = 0;
795 if (SF->hasName() && !SF->hasInternalLinkage()) {
796 // Check to see if may have to link the function.
797 DF = Dest->getFunction(SF->getName());
798 if (DF && SF->getType() != DF->getType())
799 // If types don't agree because of opaque, try to resolve them
800 RecursiveResolveTypes(SF->getType(), DF->getType(),
801 &Dest->getTypeSymbolTable(), "");
802 }
803
804 // Check visibility
805 if (DF && !DF->hasInternalLinkage() &&
Chris Lattnerb69fcb82007-08-19 22:22:54 +0000806 SF->getVisibility() != DF->getVisibility()) {
807 // If one is a prototype, ignore its visibility. Prototypes are always
808 // overridden by the definition.
809 if (!SF->isDeclaration() && !DF->isDeclaration())
810 return Error(Err, "Linking functions named '" + SF->getName() +
811 "': symbols have different visibilities!");
812 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000813
Anton Korobeynikovb06f0132007-12-27 23:21:57 +0000814 if (DF && DF->hasInternalLinkage())
815 DF = NULL;
816
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000817 if (DF && DF->getType() != SF->getType()) {
818 if (DF->isDeclaration() && !SF->isDeclaration()) {
819 // We have a definition of the same name but different type in the
820 // source module. Copy the prototype to the destination and replace
821 // uses of the destination's prototype with the new prototype.
822 Function *NewDF = new Function(SF->getFunctionType(), SF->getLinkage(),
823 SF->getName(), Dest);
824 CopyGVAttributes(NewDF, SF);
825
826 // Any uses of DF need to change to NewDF, with cast
827 DF->replaceAllUsesWith(ConstantExpr::getBitCast(NewDF, DF->getType()));
828
829 // DF will conflict with NewDF because they both had the same. We must
830 // erase this now so ForceRenaming doesn't assert because DF might
831 // not have internal linkage.
832 DF->eraseFromParent();
833
834 // If the symbol table renamed the function, but it is an externally
835 // visible symbol, DF must be an existing function with internal
836 // linkage. Rename it.
837 if (NewDF->getName() != SF->getName() && !NewDF->hasInternalLinkage())
838 ForceRenaming(NewDF, SF->getName());
839
840 // Remember this mapping so uses in the source module get remapped
841 // later by RemapOperand.
842 ValueMap[SF] = NewDF;
843 } else if (SF->isDeclaration()) {
844 // We have two functions of the same name but different type and the
845 // source is a declaration while the destination is not. Any use of
846 // the source must be mapped to the destination, with a cast.
847 ValueMap[SF] = ConstantExpr::getBitCast(DF, SF->getType());
848 } else {
849 // We have two functions of the same name but different types and they
850 // are both definitions. This is an error.
851 return Error(Err, "Function '" + DF->getName() + "' defined as both '" +
852 ToStr(SF->getFunctionType(), Src) + "' and '" +
853 ToStr(DF->getFunctionType(), Dest) + "'");
854 }
855 } else if (!DF || SF->hasInternalLinkage() || DF->hasInternalLinkage()) {
856 // Function does not already exist, simply insert an function signature
Chris Lattnerb69fcb82007-08-19 22:22:54 +0000857 // identical to SF into the dest module.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000858 Function *NewDF = new Function(SF->getFunctionType(), SF->getLinkage(),
859 SF->getName(), Dest);
860 CopyGVAttributes(NewDF, SF);
861
862 // If the LLVM runtime renamed the function, but it is an externally
863 // visible symbol, DF must be an existing function with internal linkage.
864 // Rename it.
865 if (NewDF->getName() != SF->getName() && !NewDF->hasInternalLinkage())
866 ForceRenaming(NewDF, SF->getName());
867
868 // ... and remember this mapping...
869 ValueMap.insert(std::make_pair(SF, NewDF));
870 } else if (SF->isDeclaration()) {
871 // If SF is a declaration or if both SF & DF are declarations, just link
872 // the declarations, we aren't adding anything.
873 if (SF->hasDLLImportLinkage()) {
874 if (DF->isDeclaration()) {
875 ValueMap.insert(std::make_pair(SF, DF));
876 DF->setLinkage(SF->getLinkage());
877 }
878 } else {
879 ValueMap.insert(std::make_pair(SF, DF));
880 }
881 } else if (DF->isDeclaration() && !DF->hasDLLImportLinkage()) {
882 // If DF is external but SF is not...
883 // Link the external functions, update linkage qualifiers
884 ValueMap.insert(std::make_pair(SF, DF));
885 DF->setLinkage(SF->getLinkage());
Chris Lattnerb69fcb82007-08-19 22:22:54 +0000886 // Visibility of prototype is overridden by vis of definition.
887 DF->setVisibility(SF->getVisibility());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000888 } else if (SF->hasWeakLinkage() || SF->hasLinkOnceLinkage()) {
889 // At this point we know that DF has LinkOnce, Weak, or External* linkage.
890 ValueMap.insert(std::make_pair(SF, DF));
891
892 // Linkonce+Weak = Weak
893 // *+External Weak = *
894 if ((DF->hasLinkOnceLinkage() && SF->hasWeakLinkage()) ||
895 DF->hasExternalWeakLinkage())
896 DF->setLinkage(SF->getLinkage());
897 } else if (DF->hasWeakLinkage() || DF->hasLinkOnceLinkage()) {
898 // At this point we know that SF has LinkOnce or External* linkage.
899 ValueMap.insert(std::make_pair(SF, DF));
900 if (!SF->hasLinkOnceLinkage() && !SF->hasExternalWeakLinkage())
901 // Don't inherit linkonce & external weak linkage
902 DF->setLinkage(SF->getLinkage());
903 } else if (SF->getLinkage() != DF->getLinkage()) {
904 return Error(Err, "Functions named '" + SF->getName() +
905 "' have different linkage specifiers!");
906 } else if (SF->hasExternalLinkage()) {
907 // The function is defined identically in both modules!!
908 return Error(Err, "Function '" +
909 ToStr(SF->getFunctionType(), Src) + "':\"" +
910 SF->getName() + "\" - Function is already defined!");
911 } else {
912 assert(0 && "Unknown linkage configuration found!");
913 }
914 }
915 return false;
916}
917
918// LinkFunctionBody - Copy the source function over into the dest function and
919// fix up references to values. At this point we know that Dest is an external
920// function, and that Src is not.
921static bool LinkFunctionBody(Function *Dest, Function *Src,
922 std::map<const Value*, Value*> &ValueMap,
923 std::string *Err) {
924 assert(Src && Dest && Dest->isDeclaration() && !Src->isDeclaration());
925
926 // Go through and convert function arguments over, remembering the mapping.
927 Function::arg_iterator DI = Dest->arg_begin();
928 for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
929 I != E; ++I, ++DI) {
930 DI->setName(I->getName()); // Copy the name information over...
931
932 // Add a mapping to our local map
933 ValueMap.insert(std::make_pair(I, DI));
934 }
935
936 // Splice the body of the source function into the dest function.
937 Dest->getBasicBlockList().splice(Dest->end(), Src->getBasicBlockList());
938
939 // At this point, all of the instructions and values of the function are now
940 // copied over. The only problem is that they are still referencing values in
941 // the Source function as operands. Loop through all of the operands of the
942 // functions and patch them up to point to the local versions...
943 //
944 for (Function::iterator BB = Dest->begin(), BE = Dest->end(); BB != BE; ++BB)
945 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
946 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
947 OI != OE; ++OI)
948 if (!isa<Instruction>(*OI) && !isa<BasicBlock>(*OI))
949 *OI = RemapOperand(*OI, ValueMap);
950
951 // There is no need to map the arguments anymore.
952 for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
953 I != E; ++I)
954 ValueMap.erase(I);
955
956 return false;
957}
958
959
960// LinkFunctionBodies - Link in the function bodies that are defined in the
961// source module into the DestModule. This consists basically of copying the
962// function over and fixing up references to values.
963static bool LinkFunctionBodies(Module *Dest, Module *Src,
964 std::map<const Value*, Value*> &ValueMap,
965 std::string *Err) {
966
967 // Loop over all of the functions in the src module, mapping them over as we
968 // go
969 for (Module::iterator SF = Src->begin(), E = Src->end(); SF != E; ++SF) {
970 if (!SF->isDeclaration()) { // No body if function is external
971 Function *DF = cast<Function>(ValueMap[SF]); // Destination function
972
973 // DF not external SF external?
974 if (DF->isDeclaration())
975 // Only provide the function body if there isn't one already.
976 if (LinkFunctionBody(DF, SF, ValueMap, Err))
977 return true;
978 }
979 }
980 return false;
981}
982
983// LinkAppendingVars - If there were any appending global variables, link them
984// together now. Return true on error.
985static bool LinkAppendingVars(Module *M,
986 std::multimap<std::string, GlobalVariable *> &AppendingVars,
987 std::string *ErrorMsg) {
988 if (AppendingVars.empty()) return false; // Nothing to do.
989
990 // Loop over the multimap of appending vars, processing any variables with the
991 // same name, forming a new appending global variable with both of the
992 // initializers merged together, then rewrite references to the old variables
993 // and delete them.
994 std::vector<Constant*> Inits;
995 while (AppendingVars.size() > 1) {
996 // Get the first two elements in the map...
997 std::multimap<std::string,
998 GlobalVariable*>::iterator Second = AppendingVars.begin(), First=Second++;
999
1000 // If the first two elements are for different names, there is no pair...
1001 // Otherwise there is a pair, so link them together...
1002 if (First->first == Second->first) {
1003 GlobalVariable *G1 = First->second, *G2 = Second->second;
1004 const ArrayType *T1 = cast<ArrayType>(G1->getType()->getElementType());
1005 const ArrayType *T2 = cast<ArrayType>(G2->getType()->getElementType());
1006
1007 // Check to see that they two arrays agree on type...
1008 if (T1->getElementType() != T2->getElementType())
1009 return Error(ErrorMsg,
1010 "Appending variables with different element types need to be linked!");
1011 if (G1->isConstant() != G2->isConstant())
1012 return Error(ErrorMsg,
1013 "Appending variables linked with different const'ness!");
1014
1015 if (G1->getAlignment() != G2->getAlignment())
1016 return Error(ErrorMsg,
1017 "Appending variables with different alignment need to be linked!");
1018
1019 if (G1->getVisibility() != G2->getVisibility())
1020 return Error(ErrorMsg,
1021 "Appending variables with different visibility need to be linked!");
1022
1023 if (G1->getSection() != G2->getSection())
1024 return Error(ErrorMsg,
1025 "Appending variables with different section name need to be linked!");
1026
1027 unsigned NewSize = T1->getNumElements() + T2->getNumElements();
1028 ArrayType *NewType = ArrayType::get(T1->getElementType(), NewSize);
1029
1030 G1->setName(""); // Clear G1's name in case of a conflict!
1031
1032 // Create the new global variable...
1033 GlobalVariable *NG =
1034 new GlobalVariable(NewType, G1->isConstant(), G1->getLinkage(),
1035 /*init*/0, First->first, M, G1->isThreadLocal());
1036
1037 // Propagate alignment, visibility and section info.
1038 CopyGVAttributes(NG, G1);
1039
1040 // Merge the initializer...
1041 Inits.reserve(NewSize);
1042 if (ConstantArray *I = dyn_cast<ConstantArray>(G1->getInitializer())) {
1043 for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
1044 Inits.push_back(I->getOperand(i));
1045 } else {
1046 assert(isa<ConstantAggregateZero>(G1->getInitializer()));
1047 Constant *CV = Constant::getNullValue(T1->getElementType());
1048 for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
1049 Inits.push_back(CV);
1050 }
1051 if (ConstantArray *I = dyn_cast<ConstantArray>(G2->getInitializer())) {
1052 for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
1053 Inits.push_back(I->getOperand(i));
1054 } else {
1055 assert(isa<ConstantAggregateZero>(G2->getInitializer()));
1056 Constant *CV = Constant::getNullValue(T2->getElementType());
1057 for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
1058 Inits.push_back(CV);
1059 }
1060 NG->setInitializer(ConstantArray::get(NewType, Inits));
1061 Inits.clear();
1062
1063 // Replace any uses of the two global variables with uses of the new
1064 // global...
1065
1066 // FIXME: This should rewrite simple/straight-forward uses such as
1067 // getelementptr instructions to not use the Cast!
1068 G1->replaceAllUsesWith(ConstantExpr::getBitCast(NG, G1->getType()));
1069 G2->replaceAllUsesWith(ConstantExpr::getBitCast(NG, G2->getType()));
1070
1071 // Remove the two globals from the module now...
1072 M->getGlobalList().erase(G1);
1073 M->getGlobalList().erase(G2);
1074
1075 // Put the new global into the AppendingVars map so that we can handle
1076 // linking of more than two vars...
1077 Second->second = NG;
1078 }
1079 AppendingVars.erase(First);
1080 }
1081
1082 return false;
1083}
1084
Anton Korobeynikovfdad2d82008-03-05 23:21:39 +00001085static bool ResolveAliases(Module *Dest) {
1086 for (Module::alias_iterator I = Dest->alias_begin(), E = Dest->alias_end();
1087 I != E; ++I) {
1088 GlobalValue* GV = const_cast<GlobalValue*>(I->getAliasedGlobal());
1089 if (!GV->isDeclaration())
1090 I->replaceAllUsesWith(GV);
1091 }
1092
1093 return false;
1094}
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001095
1096// LinkModules - This function links two modules together, with the resulting
1097// left module modified to be the composite of the two input modules. If an
1098// error occurs, true is returned and ErrorMsg (if not null) is set to indicate
1099// the problem. Upon failure, the Dest module could be in a modified state, and
1100// shouldn't be relied on to be consistent.
1101bool
1102Linker::LinkModules(Module *Dest, Module *Src, std::string *ErrorMsg) {
1103 assert(Dest != 0 && "Invalid Destination module");
1104 assert(Src != 0 && "Invalid Source Module");
1105
1106 if (Dest->getDataLayout().empty()) {
1107 if (!Src->getDataLayout().empty()) {
1108 Dest->setDataLayout(Src->getDataLayout());
1109 } else {
1110 std::string DataLayout;
1111
Anton Korobeynikovfb782ce2008-02-20 11:27:04 +00001112 if (Dest->getEndianness() == Module::AnyEndianness) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001113 if (Src->getEndianness() == Module::BigEndian)
1114 DataLayout.append("E");
1115 else if (Src->getEndianness() == Module::LittleEndian)
1116 DataLayout.append("e");
Anton Korobeynikovfb782ce2008-02-20 11:27:04 +00001117 }
1118
1119 if (Dest->getPointerSize() == Module::AnyPointerSize) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001120 if (Src->getPointerSize() == Module::Pointer64)
1121 DataLayout.append(DataLayout.length() == 0 ? "p:64:64" : "-p:64:64");
1122 else if (Src->getPointerSize() == Module::Pointer32)
1123 DataLayout.append(DataLayout.length() == 0 ? "p:32:32" : "-p:32:32");
Anton Korobeynikovfb782ce2008-02-20 11:27:04 +00001124 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001125 Dest->setDataLayout(DataLayout);
1126 }
1127 }
1128
Chris Lattner85dd49c2008-02-19 18:49:08 +00001129 // Copy the target triple from the source to dest if the dest's is empty.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001130 if (Dest->getTargetTriple().empty() && !Src->getTargetTriple().empty())
1131 Dest->setTargetTriple(Src->getTargetTriple());
1132
1133 if (!Src->getDataLayout().empty() && !Dest->getDataLayout().empty() &&
1134 Src->getDataLayout() != Dest->getDataLayout())
1135 cerr << "WARNING: Linking two modules of different data layouts!\n";
1136 if (!Src->getTargetTriple().empty() &&
1137 Dest->getTargetTriple() != Src->getTargetTriple())
1138 cerr << "WARNING: Linking two modules of different target triples!\n";
1139
Chris Lattner85dd49c2008-02-19 18:49:08 +00001140 // Append the module inline asm string.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001141 if (!Src->getModuleInlineAsm().empty()) {
1142 if (Dest->getModuleInlineAsm().empty())
1143 Dest->setModuleInlineAsm(Src->getModuleInlineAsm());
1144 else
1145 Dest->setModuleInlineAsm(Dest->getModuleInlineAsm()+"\n"+
1146 Src->getModuleInlineAsm());
1147 }
1148
1149 // Update the destination module's dependent libraries list with the libraries
1150 // from the source module. There's no opportunity for duplicates here as the
1151 // Module ensures that duplicate insertions are discarded.
Chris Lattner85dd49c2008-02-19 18:49:08 +00001152 for (Module::lib_iterator SI = Src->lib_begin(), SE = Src->lib_end();
1153 SI != SE; ++SI)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001154 Dest->addLibrary(*SI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001155
1156 // LinkTypes - Go through the symbol table of the Src module and see if any
1157 // types are named in the src module that are not named in the Dst module.
1158 // Make sure there are no type name conflicts.
1159 if (LinkTypes(Dest, Src, ErrorMsg))
1160 return true;
1161
1162 // ValueMap - Mapping of values from what they used to be in Src, to what they
1163 // are now in Dest.
1164 std::map<const Value*, Value*> ValueMap;
1165
1166 // AppendingVars - Keep track of global variables in the destination module
1167 // with appending linkage. After the module is linked together, they are
1168 // appended and the module is rewritten.
1169 std::multimap<std::string, GlobalVariable *> AppendingVars;
1170 for (Module::global_iterator I = Dest->global_begin(), E = Dest->global_end();
1171 I != E; ++I) {
1172 // Add all of the appending globals already in the Dest module to
1173 // AppendingVars.
1174 if (I->hasAppendingLinkage())
1175 AppendingVars.insert(std::make_pair(I->getName(), I));
1176 }
1177
1178 // Insert all of the globals in src into the Dest module... without linking
1179 // initializers (which could refer to functions not yet mapped over).
1180 if (LinkGlobals(Dest, Src, ValueMap, AppendingVars, ErrorMsg))
1181 return true;
1182
1183 // Link the functions together between the two modules, without doing function
1184 // bodies... this just adds external function prototypes to the Dest
1185 // function... We do this so that when we begin processing function bodies,
1186 // all of the global values that may be referenced are available in our
1187 // ValueMap.
1188 if (LinkFunctionProtos(Dest, Src, ValueMap, ErrorMsg))
1189 return true;
1190
Anton Korobeynikov3cfecfd2008-03-05 15:27:21 +00001191 // If there were any alias, link them now. We really need to do this now,
1192 // because all of the aliases that may be referenced need to be available in
1193 // ValueMap
1194 if (LinkAlias(Dest, Src, ValueMap, ErrorMsg)) return true;
1195
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001196 // Update the initializers in the Dest module now that all globals that may
1197 // be referenced are in Dest.
1198 if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
1199
1200 // Link in the function bodies that are defined in the source module into the
1201 // DestModule. This consists basically of copying the function over and
1202 // fixing up references to values.
1203 if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
1204
1205 // If there were any appending global variables, link them together now.
1206 if (LinkAppendingVars(Dest, AppendingVars, ErrorMsg)) return true;
1207
Anton Korobeynikova68796c2008-03-05 23:08:47 +00001208 // Resolve all uses of aliases with aliasees
1209 if (ResolveAliases(Dest)) return true;
1210
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001211 // If the source library's module id is in the dependent library list of the
1212 // destination library, remove it since that module is now linked in.
1213 sys::Path modId;
1214 modId.set(Src->getModuleIdentifier());
1215 if (!modId.isEmpty())
1216 Dest->removeLibrary(modId.getBasename());
1217
1218 return false;
1219}
1220
1221// vim: sw=2