1 //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the LLVM module linker.
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
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Linker.h"
20 #include "llvm/Constants.h"
21 #include "llvm/DerivedTypes.h"
22 #include "llvm/Module.h"
23 #include "llvm/SymbolTable.h"
24 #include "llvm/TypeSymbolTable.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/Assembly/Writer.h"
27 #include "llvm/Support/Streams.h"
28 #include "llvm/System/Path.h"
32 // Error - Simple wrapper function to conditionally assign to E and return true.
33 // This just makes error return conditions a little bit simpler...
34 static inline bool Error(std::string *E, const std::string &Message) {
39 // ToStr - Simple wrapper function to convert a type to a string.
40 static std::string ToStr(const Type *Ty, const Module *M) {
41 std::ostringstream OS;
42 WriteTypeSymbolic(OS, Ty, M);
47 // Function: ResolveTypes()
50 // Attempt to link the two specified types together.
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.
58 // DestST - The symbol table in which the new type should be placed.
61 // true - There is an error and the types cannot yet be linked.
64 static 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
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);
73 return true; // Cannot link types... neither is opaque and not-equal
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));
85 static const FunctionType *getFT(const PATypeHolder &TH) {
86 return cast<FunctionType>(TH.get());
88 static const StructType *getST(const PATypeHolder &TH) {
89 return cast<StructType>(TH.get());
92 // RecursiveResolveTypes - This is just like ResolveTypes, except that it
93 // recurses down into derived types, merging the used types if the parent types
95 static 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
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);
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;
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())
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())
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, "",
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, "",
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);
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;
159 // Otherwise, add the current pointers to the vector to stop recursion on
161 Pointers.push_back(std::make_pair(DestTyT, SrcTyT));
163 RecursiveResolveTypesI(cast<PointerType>(DestTy.get())->getElementType(),
164 cast<PointerType>(SrcTy.get())->getElementType(),
165 DestST, "", Pointers);
169 default: assert(0 && "Unexpected type!"); return true;
173 static 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);
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.
185 static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
186 TypeSymbolTable *DestST = &Dest->getTypeSymbolTable();
187 const TypeSymbolTable *SrcST = &Src->getTypeSymbolTable();
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.
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;
199 for ( ; TI != TE; ++TI ) {
200 const std::string &Name = TI->first;
201 const Type *RHS = TI->second;
203 // Check to see if this type name is already in the dest module...
204 Type *Entry = DestST->lookup(Name);
206 if (ResolveTypes(Entry, RHS, DestST, Name)) {
207 // They look different, save the types 'till later to resolve.
208 DelayedTypesToResolve.push_back(Name);
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();
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);
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));
238 if (!RecursiveResolveTypes(T2, T1, DestST, Name)) {
239 // We are making progress!
240 DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
242 // Go back to the main loop, perhaps we can resolve directly by name
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();
260 static void PrintMap(const std::map<const Value*, Value*> &M) {
261 for (std::map<const Value*, Value*>::const_iterator I = M.begin(), E =M.end();
263 cerr << " Fr: " << (void*)I->first << " ";
265 cerr << " To: " << (void*)I->second << " ";
272 // RemapOperand - Use ValueMap to convert references from one module to another.
273 // This is somewhat sophisticated in that it can automatically handle constant
274 // references correctly as well.
275 static Value *RemapOperand(const Value *In,
276 std::map<const Value*, Value*> &ValueMap) {
277 std::map<const Value*,Value*>::const_iterator I = ValueMap.find(In);
278 if (I != ValueMap.end()) return I->second;
280 // Check to see if it's a constant that we are interesting in transforming.
282 if (const Constant *CPV = dyn_cast<Constant>(In)) {
283 if ((!isa<DerivedType>(CPV->getType()) && !isa<ConstantExpr>(CPV)) ||
284 isa<ConstantInt>(CPV) || isa<ConstantAggregateZero>(CPV))
285 return const_cast<Constant*>(CPV); // Simple constants stay identical.
287 if (const ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
288 std::vector<Constant*> Operands(CPA->getNumOperands());
289 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
290 Operands[i] =cast<Constant>(RemapOperand(CPA->getOperand(i), ValueMap));
291 Result = ConstantArray::get(cast<ArrayType>(CPA->getType()), Operands);
292 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
293 std::vector<Constant*> Operands(CPS->getNumOperands());
294 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
295 Operands[i] =cast<Constant>(RemapOperand(CPS->getOperand(i), ValueMap));
296 Result = ConstantStruct::get(cast<StructType>(CPS->getType()), Operands);
297 } else if (isa<ConstantPointerNull>(CPV) || isa<UndefValue>(CPV)) {
298 Result = const_cast<Constant*>(CPV);
299 } else if (isa<GlobalValue>(CPV)) {
300 Result = cast<Constant>(RemapOperand(CPV, ValueMap));
301 } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CPV)) {
302 std::vector<Constant*> Operands(CP->getNumOperands());
303 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
304 Operands[i] = cast<Constant>(RemapOperand(CP->getOperand(i), ValueMap));
305 Result = ConstantPacked::get(Operands);
306 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
307 std::vector<Constant*> Ops;
308 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
309 Ops.push_back(cast<Constant>(RemapOperand(CE->getOperand(i),ValueMap)));
310 Result = CE->getWithOperands(Ops);
312 assert(0 && "Unknown type of derived type constant value!");
314 } else if (isa<InlineAsm>(In)) {
315 Result = const_cast<Value*>(In);
318 // Cache the mapping in our local map structure...
320 ValueMap.insert(std::make_pair(In, Result));
325 cerr << "LinkModules ValueMap: \n";
328 cerr << "Couldn't remap value: " << (void*)In << " " << *In << "\n";
329 assert(0 && "Couldn't remap value!");
333 /// ForceRenaming - The LLVM SymbolTable class autorenames globals that conflict
334 /// in the symbol table. This is good for all clients except for us. Go
335 /// through the trouble to force this back.
336 static void ForceRenaming(GlobalValue *GV, const std::string &Name) {
337 assert(GV->getName() != Name && "Can't force rename to self");
338 SymbolTable &ST = GV->getParent()->getValueSymbolTable();
340 // If there is a conflict, rename the conflict.
341 Value *ConflictVal = ST.lookup(GV->getType(), Name);
342 assert(ConflictVal&&"Why do we have to force rename if there is no conflic?");
343 GlobalValue *ConflictGV = cast<GlobalValue>(ConflictVal);
344 assert(ConflictGV->hasInternalLinkage() &&
345 "Not conflicting with a static global, should link instead!");
347 ConflictGV->setName(""); // Eliminate the conflict
348 GV->setName(Name); // Force the name back
349 ConflictGV->setName(Name); // This will cause ConflictGV to get renamed
350 assert(GV->getName() == Name && ConflictGV->getName() != Name &&
351 "ForceRenaming didn't work");
354 /// GetLinkageResult - This analyzes the two global values and determines what
355 /// the result will look like in the destination module. In particular, it
356 /// computes the resultant linkage type, computes whether the global in the
357 /// source should be copied over to the destination (replacing the existing
358 /// one), and computes whether this linkage is an error or not.
359 static bool GetLinkageResult(GlobalValue *Dest, GlobalValue *Src,
360 GlobalValue::LinkageTypes <, bool &LinkFromSrc,
362 assert((!Dest || !Src->hasInternalLinkage()) &&
363 "If Src has internal linkage, Dest shouldn't be set!");
365 // Linking something to nothing.
367 LT = Src->getLinkage();
368 } else if (Src->isDeclaration()) {
369 // If Src is external or if both Src & Drc are external.. Just link the
370 // external globals, we aren't adding anything.
371 if (Src->hasDLLImportLinkage()) {
372 // If one of GVs has DLLImport linkage, result should be dllimport'ed.
373 if (Dest->isDeclaration()) {
375 LT = Src->getLinkage();
377 } else if (Dest->hasExternalWeakLinkage()) {
378 //If the Dest is weak, use the source linkage
380 LT = Src->getLinkage();
383 LT = Dest->getLinkage();
385 } else if (Dest->isDeclaration() && !Dest->hasDLLImportLinkage()) {
386 // If Dest is external but Src is not:
388 LT = Src->getLinkage();
389 } else if (Src->hasAppendingLinkage() || Dest->hasAppendingLinkage()) {
390 if (Src->getLinkage() != Dest->getLinkage())
391 return Error(Err, "Linking globals named '" + Src->getName() +
392 "': can only link appending global with another appending global!");
393 LinkFromSrc = true; // Special cased.
394 LT = Src->getLinkage();
395 } else if (Src->hasWeakLinkage() || Src->hasLinkOnceLinkage()) {
396 // At this point we know that Dest has LinkOnce, External*, Weak, DLL* linkage.
397 if ((Dest->hasLinkOnceLinkage() && Src->hasWeakLinkage()) ||
398 Dest->hasExternalWeakLinkage()) {
400 LT = Src->getLinkage();
403 LT = Dest->getLinkage();
405 } else if (Dest->hasWeakLinkage() || Dest->hasLinkOnceLinkage()) {
406 // At this point we know that Src has External* or DLL* linkage.
407 if (Src->hasExternalWeakLinkage()) {
409 LT = Dest->getLinkage();
412 LT = GlobalValue::ExternalLinkage;
415 assert((Dest->hasExternalLinkage() ||
416 Dest->hasDLLImportLinkage() ||
417 Dest->hasDLLExportLinkage() ||
418 Dest->hasExternalWeakLinkage()) &&
419 (Src->hasExternalLinkage() ||
420 Src->hasDLLImportLinkage() ||
421 Src->hasDLLExportLinkage() ||
422 Src->hasExternalWeakLinkage()) &&
423 "Unexpected linkage type!");
424 return Error(Err, "Linking globals named '" + Src->getName() +
425 "': symbol multiply defined!");
430 // LinkGlobals - Loop through the global variables in the src module and merge
431 // them into the dest module.
432 static bool LinkGlobals(Module *Dest, Module *Src,
433 std::map<const Value*, Value*> &ValueMap,
434 std::multimap<std::string, GlobalVariable *> &AppendingVars,
435 std::map<std::string, GlobalValue*> &GlobalsByName,
437 // We will need a module level symbol table if the src module has a module
438 // level symbol table...
439 TypeSymbolTable *TST = &Dest->getTypeSymbolTable();
441 // Loop over all of the globals in the src module, mapping them over as we go
442 for (Module::global_iterator I = Src->global_begin(), E = Src->global_end();
444 GlobalVariable *SGV = I;
445 GlobalVariable *DGV = 0;
446 // Check to see if may have to link the global.
447 if (SGV->hasName() && !SGV->hasInternalLinkage())
448 if (!(DGV = Dest->getGlobalVariable(SGV->getName(),
449 SGV->getType()->getElementType()))) {
450 std::map<std::string, GlobalValue*>::iterator EGV =
451 GlobalsByName.find(SGV->getName());
452 if (EGV != GlobalsByName.end())
453 DGV = dyn_cast<GlobalVariable>(EGV->second);
455 // If types don't agree due to opaque types, try to resolve them.
456 RecursiveResolveTypes(SGV->getType(), DGV->getType(), TST, "");
459 if (DGV && DGV->hasInternalLinkage())
462 assert(SGV->hasInitializer() || SGV->hasExternalWeakLinkage() ||
463 SGV->hasExternalLinkage() || SGV->hasDLLImportLinkage() &&
464 "Global must either be external or have an initializer!");
466 GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
467 bool LinkFromSrc = false;
468 if (GetLinkageResult(DGV, SGV, NewLinkage, LinkFromSrc, Err))
472 // No linking to be performed, simply create an identical version of the
473 // symbol over in the dest module... the initializer will be filled in
474 // later by LinkGlobalInits...
475 GlobalVariable *NewDGV =
476 new GlobalVariable(SGV->getType()->getElementType(),
477 SGV->isConstant(), SGV->getLinkage(), /*init*/0,
478 SGV->getName(), Dest);
479 // Propagate alignment, visibility and section info.
480 NewDGV->setAlignment(SGV->getAlignment());
481 NewDGV->setSection(SGV->getSection());
482 NewDGV->setVisibility(SGV->getVisibility());
484 // If the LLVM runtime renamed the global, but it is an externally visible
485 // symbol, DGV must be an existing global with internal linkage. Rename
487 if (NewDGV->getName() != SGV->getName() && !NewDGV->hasInternalLinkage())
488 ForceRenaming(NewDGV, SGV->getName());
490 // Make sure to remember this mapping...
491 ValueMap.insert(std::make_pair(SGV, NewDGV));
492 if (SGV->hasAppendingLinkage())
493 // Keep track that this is an appending variable...
494 AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
495 } else if (DGV->hasAppendingLinkage()) {
496 // No linking is performed yet. Just insert a new copy of the global, and
497 // keep track of the fact that it is an appending variable in the
498 // AppendingVars map. The name is cleared out so that no linkage is
500 GlobalVariable *NewDGV =
501 new GlobalVariable(SGV->getType()->getElementType(),
502 SGV->isConstant(), SGV->getLinkage(), /*init*/0,
505 // Propagate alignment, section and visibility info.
506 NewDGV->setAlignment(std::max(DGV->getAlignment(), SGV->getAlignment()));
507 NewDGV->setSection(SGV->getSection());
508 NewDGV->setVisibility(SGV->getVisibility());
510 // Make sure to remember this mapping...
511 ValueMap.insert(std::make_pair(SGV, NewDGV));
513 // Keep track that this is an appending variable...
514 AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
516 // Propagate alignment, section, and visibility info.
517 DGV->setAlignment(std::max(DGV->getAlignment(), SGV->getAlignment()));
518 DGV->setSection(SGV->getSection());
519 DGV->setVisibility(SGV->getVisibility());
521 // Otherwise, perform the mapping as instructed by GetLinkageResult. If
522 // the types don't match, and if we are to link from the source, nuke DGV
523 // and create a new one of the appropriate type.
524 if (SGV->getType() != DGV->getType() && LinkFromSrc) {
525 GlobalVariable *NewDGV =
526 new GlobalVariable(SGV->getType()->getElementType(),
527 DGV->isConstant(), DGV->getLinkage());
528 NewDGV->setAlignment(DGV->getAlignment());
529 NewDGV->setSection(DGV->getSection());
530 NewDGV->setVisibility(DGV->getVisibility());
531 Dest->getGlobalList().insert(DGV, NewDGV);
532 DGV->replaceAllUsesWith(
533 ConstantExpr::getBitCast(NewDGV, DGV->getType()));
534 DGV->eraseFromParent();
535 NewDGV->setName(SGV->getName());
539 DGV->setLinkage(NewLinkage);
542 // Inherit const as appropriate
543 DGV->setConstant(SGV->isConstant());
544 DGV->setInitializer(0);
546 if (SGV->isConstant() && !DGV->isConstant()) {
547 if (DGV->isDeclaration())
548 DGV->setConstant(true);
550 SGV->setLinkage(GlobalValue::ExternalLinkage);
551 SGV->setInitializer(0);
555 std::make_pair(SGV, ConstantExpr::getBitCast(DGV, SGV->getType())));
562 // LinkGlobalInits - Update the initializers in the Dest module now that all
563 // globals that may be referenced are in Dest.
564 static bool LinkGlobalInits(Module *Dest, const Module *Src,
565 std::map<const Value*, Value*> &ValueMap,
568 // Loop over all of the globals in the src module, mapping them over as we go
569 for (Module::const_global_iterator I = Src->global_begin(),
570 E = Src->global_end(); I != E; ++I) {
571 const GlobalVariable *SGV = I;
573 if (SGV->hasInitializer()) { // Only process initialized GV's
574 // Figure out what the initializer looks like in the dest module...
576 cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap));
578 GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[SGV]);
579 if (DGV->hasInitializer()) {
580 if (SGV->hasExternalLinkage()) {
581 if (DGV->getInitializer() != SInit)
582 return Error(Err, "Global Variable Collision on '" +
583 ToStr(SGV->getType(), Src) +"':%"+SGV->getName()+
584 " - Global variables have different initializers");
585 } else if (DGV->hasLinkOnceLinkage() || DGV->hasWeakLinkage()) {
586 // Nothing is required, mapped values will take the new global
588 } else if (SGV->hasLinkOnceLinkage() || SGV->hasWeakLinkage()) {
589 // Nothing is required, mapped values will take the new global
591 } else if (DGV->hasAppendingLinkage()) {
592 assert(0 && "Appending linkage unimplemented!");
594 assert(0 && "Unknown linkage!");
597 // Copy the initializer over now...
598 DGV->setInitializer(SInit);
605 // LinkFunctionProtos - Link the functions together between the two modules,
606 // without doing function bodies... this just adds external function prototypes
607 // to the Dest function...
609 static bool LinkFunctionProtos(Module *Dest, const Module *Src,
610 std::map<const Value*, Value*> &ValueMap,
611 std::map<std::string,
612 GlobalValue*> &GlobalsByName,
614 TypeSymbolTable *TST = &Dest->getTypeSymbolTable();
616 // Loop over all of the functions in the src module, mapping them over as we
618 for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
619 const Function *SF = I; // SrcFunction
621 if (SF->hasName() && !SF->hasInternalLinkage()) {
622 // Check to see if may have to link the function.
623 if (!(DF = Dest->getFunction(SF->getName(), SF->getFunctionType()))) {
624 std::map<std::string, GlobalValue*>::iterator EF =
625 GlobalsByName.find(SF->getName());
626 if (EF != GlobalsByName.end())
627 DF = dyn_cast<Function>(EF->second);
628 if (DF && RecursiveResolveTypes(SF->getType(), DF->getType(), TST, ""))
629 DF = 0; // FIXME: gross.
633 if (!DF || SF->hasInternalLinkage() || DF->hasInternalLinkage()) {
634 // Function does not already exist, simply insert an function signature
635 // identical to SF into the dest module...
636 Function *NewDF = new Function(SF->getFunctionType(), SF->getLinkage(),
637 SF->getName(), Dest);
638 NewDF->setCallingConv(SF->getCallingConv());
640 // If the LLVM runtime renamed the function, but it is an externally
641 // visible symbol, DF must be an existing function with internal linkage.
643 if (NewDF->getName() != SF->getName() && !NewDF->hasInternalLinkage())
644 ForceRenaming(NewDF, SF->getName());
646 // ... and remember this mapping...
647 ValueMap.insert(std::make_pair(SF, NewDF));
648 } else if (SF->isDeclaration()) {
649 // If SF is external or if both SF & DF are external.. Just link the
650 // external functions, we aren't adding anything.
651 if (SF->hasDLLImportLinkage()) {
652 if (DF->isDeclaration()) {
653 ValueMap.insert(std::make_pair(SF, DF));
654 DF->setLinkage(SF->getLinkage());
657 ValueMap.insert(std::make_pair(SF, DF));
659 } else if (DF->isDeclaration() && !DF->hasDLLImportLinkage()) {
660 // If DF is external but SF is not...
661 // Link the external functions, update linkage qualifiers
662 ValueMap.insert(std::make_pair(SF, DF));
663 DF->setLinkage(SF->getLinkage());
664 } else if (SF->hasWeakLinkage() || SF->hasLinkOnceLinkage()) {
665 // At this point we know that DF has LinkOnce, Weak, or External* linkage.
666 ValueMap.insert(std::make_pair(SF, DF));
668 // Linkonce+Weak = Weak
669 // *+External Weak = *
670 if ((DF->hasLinkOnceLinkage() && SF->hasWeakLinkage()) ||
671 DF->hasExternalWeakLinkage())
672 DF->setLinkage(SF->getLinkage());
675 } else if (DF->hasWeakLinkage() || DF->hasLinkOnceLinkage()) {
676 // At this point we know that SF has LinkOnce or External* linkage.
677 ValueMap.insert(std::make_pair(SF, DF));
678 if (!SF->hasLinkOnceLinkage() && !SF->hasExternalWeakLinkage())
679 // Don't inherit linkonce & external weak linkage
680 DF->setLinkage(SF->getLinkage());
681 } else if (SF->getLinkage() != DF->getLinkage()) {
682 return Error(Err, "Functions named '" + SF->getName() +
683 "' have different linkage specifiers!");
684 } else if (SF->hasExternalLinkage()) {
685 // The function is defined in both modules!!
686 return Error(Err, "Function '" +
687 ToStr(SF->getFunctionType(), Src) + "':\"" +
688 SF->getName() + "\" - Function is already defined!");
690 assert(0 && "Unknown linkage configuration found!");
696 // LinkFunctionBody - Copy the source function over into the dest function and
697 // fix up references to values. At this point we know that Dest is an external
698 // function, and that Src is not.
699 static bool LinkFunctionBody(Function *Dest, Function *Src,
700 std::map<const Value*, Value*> &GlobalMap,
702 assert(Src && Dest && Dest->isDeclaration() && !Src->isDeclaration());
704 // Go through and convert function arguments over, remembering the mapping.
705 Function::arg_iterator DI = Dest->arg_begin();
706 for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
708 DI->setName(I->getName()); // Copy the name information over...
710 // Add a mapping to our local map
711 GlobalMap.insert(std::make_pair(I, DI));
714 // Splice the body of the source function into the dest function.
715 Dest->getBasicBlockList().splice(Dest->end(), Src->getBasicBlockList());
717 // At this point, all of the instructions and values of the function are now
718 // copied over. The only problem is that they are still referencing values in
719 // the Source function as operands. Loop through all of the operands of the
720 // functions and patch them up to point to the local versions...
722 for (Function::iterator BB = Dest->begin(), BE = Dest->end(); BB != BE; ++BB)
723 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
724 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
726 if (!isa<Instruction>(*OI) && !isa<BasicBlock>(*OI))
727 *OI = RemapOperand(*OI, GlobalMap);
729 // There is no need to map the arguments anymore.
730 for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
738 // LinkFunctionBodies - Link in the function bodies that are defined in the
739 // source module into the DestModule. This consists basically of copying the
740 // function over and fixing up references to values.
741 static bool LinkFunctionBodies(Module *Dest, Module *Src,
742 std::map<const Value*, Value*> &ValueMap,
745 // Loop over all of the functions in the src module, mapping them over as we
747 for (Module::iterator SF = Src->begin(), E = Src->end(); SF != E; ++SF) {
748 if (!SF->isDeclaration()) { // No body if function is external
749 Function *DF = cast<Function>(ValueMap[SF]); // Destination function
751 // DF not external SF external?
752 if (DF->isDeclaration()) {
753 // Only provide the function body if there isn't one already.
754 if (LinkFunctionBody(DF, SF, ValueMap, Err))
762 // LinkAppendingVars - If there were any appending global variables, link them
763 // together now. Return true on error.
764 static bool LinkAppendingVars(Module *M,
765 std::multimap<std::string, GlobalVariable *> &AppendingVars,
766 std::string *ErrorMsg) {
767 if (AppendingVars.empty()) return false; // Nothing to do.
769 // Loop over the multimap of appending vars, processing any variables with the
770 // same name, forming a new appending global variable with both of the
771 // initializers merged together, then rewrite references to the old variables
773 std::vector<Constant*> Inits;
774 while (AppendingVars.size() > 1) {
775 // Get the first two elements in the map...
776 std::multimap<std::string,
777 GlobalVariable*>::iterator Second = AppendingVars.begin(), First=Second++;
779 // If the first two elements are for different names, there is no pair...
780 // Otherwise there is a pair, so link them together...
781 if (First->first == Second->first) {
782 GlobalVariable *G1 = First->second, *G2 = Second->second;
783 const ArrayType *T1 = cast<ArrayType>(G1->getType()->getElementType());
784 const ArrayType *T2 = cast<ArrayType>(G2->getType()->getElementType());
786 // Check to see that they two arrays agree on type...
787 if (T1->getElementType() != T2->getElementType())
788 return Error(ErrorMsg,
789 "Appending variables with different element types need to be linked!");
790 if (G1->isConstant() != G2->isConstant())
791 return Error(ErrorMsg,
792 "Appending variables linked with different const'ness!");
794 unsigned NewSize = T1->getNumElements() + T2->getNumElements();
795 ArrayType *NewType = ArrayType::get(T1->getElementType(), NewSize);
797 G1->setName(""); // Clear G1's name in case of a conflict!
799 // Create the new global variable...
801 new GlobalVariable(NewType, G1->isConstant(), G1->getLinkage(),
802 /*init*/0, First->first, M);
804 // Merge the initializer...
805 Inits.reserve(NewSize);
806 if (ConstantArray *I = dyn_cast<ConstantArray>(G1->getInitializer())) {
807 for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
808 Inits.push_back(I->getOperand(i));
810 assert(isa<ConstantAggregateZero>(G1->getInitializer()));
811 Constant *CV = Constant::getNullValue(T1->getElementType());
812 for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
815 if (ConstantArray *I = dyn_cast<ConstantArray>(G2->getInitializer())) {
816 for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
817 Inits.push_back(I->getOperand(i));
819 assert(isa<ConstantAggregateZero>(G2->getInitializer()));
820 Constant *CV = Constant::getNullValue(T2->getElementType());
821 for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
824 NG->setInitializer(ConstantArray::get(NewType, Inits));
827 // Replace any uses of the two global variables with uses of the new
830 // FIXME: This should rewrite simple/straight-forward uses such as
831 // getelementptr instructions to not use the Cast!
832 G1->replaceAllUsesWith(ConstantExpr::getBitCast(NG, G1->getType()));
833 G2->replaceAllUsesWith(ConstantExpr::getBitCast(NG, G2->getType()));
835 // Remove the two globals from the module now...
836 M->getGlobalList().erase(G1);
837 M->getGlobalList().erase(G2);
839 // Put the new global into the AppendingVars map so that we can handle
840 // linking of more than two vars...
843 AppendingVars.erase(First);
850 // LinkModules - This function links two modules together, with the resulting
851 // left module modified to be the composite of the two input modules. If an
852 // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
853 // the problem. Upon failure, the Dest module could be in a modified state, and
854 // shouldn't be relied on to be consistent.
856 Linker::LinkModules(Module *Dest, Module *Src, std::string *ErrorMsg) {
857 assert(Dest != 0 && "Invalid Destination module");
858 assert(Src != 0 && "Invalid Source Module");
860 if (Dest->getDataLayout().empty()) {
861 if (!Src->getDataLayout().empty()) {
862 Dest->setDataLayout(Src->getDataLayout());
864 std::string DataLayout;
866 if (Dest->getEndianness() == Module::AnyEndianness)
867 if (Src->getEndianness() == Module::BigEndian)
868 DataLayout.append("E");
869 else if (Src->getEndianness() == Module::LittleEndian)
870 DataLayout.append("e");
871 if (Dest->getPointerSize() == Module::AnyPointerSize)
872 if (Src->getPointerSize() == Module::Pointer64)
873 DataLayout.append(DataLayout.length() == 0 ? "p:64:64" : "-p:64:64");
874 else if (Src->getPointerSize() == Module::Pointer32)
875 DataLayout.append(DataLayout.length() == 0 ? "p:32:32" : "-p:32:32");
876 Dest->setDataLayout(DataLayout);
880 if (Dest->getTargetTriple().empty() && !Src->getTargetTriple().empty())
881 Dest->setTargetTriple(Src->getTargetTriple());
883 if (!Src->getDataLayout().empty() && !Dest->getDataLayout().empty() &&
884 Src->getDataLayout() != Dest->getDataLayout())
885 cerr << "WARNING: Linking two modules of different data layouts!\n";
886 if (!Src->getTargetTriple().empty() &&
887 Dest->getTargetTriple() != Src->getTargetTriple())
888 cerr << "WARNING: Linking two modules of different target triples!\n";
890 if (!Src->getModuleInlineAsm().empty()) {
891 if (Dest->getModuleInlineAsm().empty())
892 Dest->setModuleInlineAsm(Src->getModuleInlineAsm());
894 Dest->setModuleInlineAsm(Dest->getModuleInlineAsm()+"\n"+
895 Src->getModuleInlineAsm());
898 // Update the destination module's dependent libraries list with the libraries
899 // from the source module. There's no opportunity for duplicates here as the
900 // Module ensures that duplicate insertions are discarded.
901 Module::lib_iterator SI = Src->lib_begin();
902 Module::lib_iterator SE = Src->lib_end();
904 Dest->addLibrary(*SI);
908 // LinkTypes - Go through the symbol table of the Src module and see if any
909 // types are named in the src module that are not named in the Dst module.
910 // Make sure there are no type name conflicts.
911 if (LinkTypes(Dest, Src, ErrorMsg)) return true;
913 // ValueMap - Mapping of values from what they used to be in Src, to what they
915 std::map<const Value*, Value*> ValueMap;
917 // AppendingVars - Keep track of global variables in the destination module
918 // with appending linkage. After the module is linked together, they are
919 // appended and the module is rewritten.
920 std::multimap<std::string, GlobalVariable *> AppendingVars;
922 // GlobalsByName - The LLVM SymbolTable class fights our best efforts at
923 // linking by separating globals by type. Until PR411 is fixed, we replicate
924 // it's functionality here.
925 std::map<std::string, GlobalValue*> GlobalsByName;
927 for (Module::global_iterator I = Dest->global_begin(), E = Dest->global_end();
929 // Add all of the appending globals already in the Dest module to
931 if (I->hasAppendingLinkage())
932 AppendingVars.insert(std::make_pair(I->getName(), I));
934 // Keep track of all globals by name.
935 if (!I->hasInternalLinkage() && I->hasName())
936 GlobalsByName[I->getName()] = I;
939 // Keep track of all globals by name.
940 for (Module::iterator I = Dest->begin(), E = Dest->end(); I != E; ++I)
941 if (!I->hasInternalLinkage() && I->hasName())
942 GlobalsByName[I->getName()] = I;
944 // Insert all of the globals in src into the Dest module... without linking
945 // initializers (which could refer to functions not yet mapped over).
946 if (LinkGlobals(Dest, Src, ValueMap, AppendingVars, GlobalsByName, ErrorMsg))
949 // Link the functions together between the two modules, without doing function
950 // bodies... this just adds external function prototypes to the Dest
951 // function... We do this so that when we begin processing function bodies,
952 // all of the global values that may be referenced are available in our
954 if (LinkFunctionProtos(Dest, Src, ValueMap, GlobalsByName, ErrorMsg))
957 // Update the initializers in the Dest module now that all globals that may
958 // be referenced are in Dest.
959 if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
961 // Link in the function bodies that are defined in the source module into the
962 // DestModule. This consists basically of copying the function over and
963 // fixing up references to values.
964 if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
966 // If there were any appending global variables, link them together now.
967 if (LinkAppendingVars(Dest, AppendingVars, ErrorMsg)) return true;
969 // If the source library's module id is in the dependent library list of the
970 // destination library, remove it since that module is now linked in.
972 modId.set(Src->getModuleIdentifier());
973 if (!modId.isEmpty())
974 Dest->removeLibrary(modId.getBasename());