1 //===- Linker.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/Support/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/Instructions.h"
25 #include "llvm/Assembly/Writer.h"
30 // Error - Simple wrapper function to conditionally assign to E and return true.
31 // This just makes error return conditions a little bit simpler...
33 static inline bool Error(std::string *E, const std::string &Message) {
39 // Function: ResolveTypes()
42 // Attempt to link the two specified types together.
45 // DestTy - The type to which we wish to resolve.
46 // SrcTy - The original type which we want to resolve.
47 // Name - The name of the type.
50 // DestST - The symbol table in which the new type should be placed.
53 // true - There is an error and the types cannot yet be linked.
56 static bool ResolveTypes(const Type *DestTy, const Type *SrcTy,
57 SymbolTable *DestST, const std::string &Name) {
58 if (DestTy == SrcTy) return false; // If already equal, noop
60 // Does the type already exist in the module?
61 if (DestTy && !isa<OpaqueType>(DestTy)) { // Yup, the type already exists...
62 if (const OpaqueType *OT = dyn_cast<OpaqueType>(SrcTy)) {
63 const_cast<OpaqueType*>(OT)->refineAbstractTypeTo(DestTy);
65 return true; // Cannot link types... neither is opaque and not-equal
67 } else { // Type not in dest module. Add it now.
68 if (DestTy) // Type _is_ in module, just opaque...
69 const_cast<OpaqueType*>(cast<OpaqueType>(DestTy))
70 ->refineAbstractTypeTo(SrcTy);
71 else if (!Name.empty())
72 DestST->insert(Name, const_cast<Type*>(SrcTy));
77 static const FunctionType *getFT(const PATypeHolder &TH) {
78 return cast<FunctionType>(TH.get());
80 static const StructType *getST(const PATypeHolder &TH) {
81 return cast<StructType>(TH.get());
84 // RecursiveResolveTypes - This is just like ResolveTypes, except that it
85 // recurses down into derived types, merging the used types if the parent types
88 static bool RecursiveResolveTypesI(const PATypeHolder &DestTy,
89 const PATypeHolder &SrcTy,
90 SymbolTable *DestST, const std::string &Name,
91 std::vector<std::pair<PATypeHolder, PATypeHolder> > &Pointers) {
92 const Type *SrcTyT = SrcTy.get();
93 const Type *DestTyT = DestTy.get();
94 if (DestTyT == SrcTyT) return false; // If already equal, noop
96 // If we found our opaque type, resolve it now!
97 if (isa<OpaqueType>(DestTyT) || isa<OpaqueType>(SrcTyT))
98 return ResolveTypes(DestTyT, SrcTyT, DestST, Name);
100 // Two types cannot be resolved together if they are of different primitive
101 // type. For example, we cannot resolve an int to a float.
102 if (DestTyT->getTypeID() != SrcTyT->getTypeID()) return true;
104 // Otherwise, resolve the used type used by this derived type...
105 switch (DestTyT->getTypeID()) {
106 case Type::FunctionTyID: {
107 if (cast<FunctionType>(DestTyT)->isVarArg() !=
108 cast<FunctionType>(SrcTyT)->isVarArg() ||
109 cast<FunctionType>(DestTyT)->getNumContainedTypes() !=
110 cast<FunctionType>(SrcTyT)->getNumContainedTypes())
112 for (unsigned i = 0, e = getFT(DestTy)->getNumContainedTypes(); i != e; ++i)
113 if (RecursiveResolveTypesI(getFT(DestTy)->getContainedType(i),
114 getFT(SrcTy)->getContainedType(i), DestST, "",
119 case Type::StructTyID: {
120 if (getST(DestTy)->getNumContainedTypes() !=
121 getST(SrcTy)->getNumContainedTypes()) return 1;
122 for (unsigned i = 0, e = getST(DestTy)->getNumContainedTypes(); i != e; ++i)
123 if (RecursiveResolveTypesI(getST(DestTy)->getContainedType(i),
124 getST(SrcTy)->getContainedType(i), DestST, "",
129 case Type::ArrayTyID: {
130 const ArrayType *DAT = cast<ArrayType>(DestTy.get());
131 const ArrayType *SAT = cast<ArrayType>(SrcTy.get());
132 if (DAT->getNumElements() != SAT->getNumElements()) return true;
133 return RecursiveResolveTypesI(DAT->getElementType(), SAT->getElementType(),
134 DestST, "", Pointers);
136 case Type::PointerTyID: {
137 // If this is a pointer type, check to see if we have already seen it. If
138 // so, we are in a recursive branch. Cut off the search now. We cannot use
139 // an associative container for this search, because the type pointers (keys
140 // in the container) change whenever types get resolved...
142 for (unsigned i = 0, e = Pointers.size(); i != e; ++i)
143 if (Pointers[i].first == DestTy)
144 return Pointers[i].second != SrcTy;
146 // Otherwise, add the current pointers to the vector to stop recursion on
148 Pointers.push_back(std::make_pair(DestTyT, SrcTyT));
150 RecursiveResolveTypesI(cast<PointerType>(DestTy.get())->getElementType(),
151 cast<PointerType>(SrcTy.get())->getElementType(),
152 DestST, "", Pointers);
156 default: assert(0 && "Unexpected type!"); return true;
160 static bool RecursiveResolveTypes(const PATypeHolder &DestTy,
161 const PATypeHolder &SrcTy,
162 SymbolTable *DestST, const std::string &Name){
163 std::vector<std::pair<PATypeHolder, PATypeHolder> > PointerTypes;
164 return RecursiveResolveTypesI(DestTy, SrcTy, DestST, Name, PointerTypes);
168 // LinkTypes - Go through the symbol table of the Src module and see if any
169 // types are named in the src module that are not named in the Dst module.
170 // Make sure there are no type name conflicts.
172 static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
173 SymbolTable *DestST = &Dest->getSymbolTable();
174 const SymbolTable *SrcST = &Src->getSymbolTable();
176 // Look for a type plane for Type's...
177 SymbolTable::type_const_iterator TI = SrcST->type_begin();
178 SymbolTable::type_const_iterator TE = SrcST->type_end();
179 if (TI == TE) return false; // No named types, do nothing.
181 // Some types cannot be resolved immediately because they depend on other
182 // types being resolved to each other first. This contains a list of types we
183 // are waiting to recheck.
184 std::vector<std::string> DelayedTypesToResolve;
186 for ( ; TI != TE; ++TI ) {
187 const std::string &Name = TI->first;
188 const Type *RHS = TI->second;
190 // Check to see if this type name is already in the dest module...
191 Type *Entry = DestST->lookupType(Name);
193 if (ResolveTypes(Entry, RHS, DestST, Name)) {
194 // They look different, save the types 'till later to resolve.
195 DelayedTypesToResolve.push_back(Name);
199 // Iteratively resolve types while we can...
200 while (!DelayedTypesToResolve.empty()) {
201 // Loop over all of the types, attempting to resolve them if possible...
202 unsigned OldSize = DelayedTypesToResolve.size();
204 // Try direct resolution by name...
205 for (unsigned i = 0; i != DelayedTypesToResolve.size(); ++i) {
206 const std::string &Name = DelayedTypesToResolve[i];
207 Type *T1 = SrcST->lookupType(Name);
208 Type *T2 = DestST->lookupType(Name);
209 if (!ResolveTypes(T2, T1, DestST, Name)) {
210 // We are making progress!
211 DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
216 // Did we not eliminate any types?
217 if (DelayedTypesToResolve.size() == OldSize) {
218 // Attempt to resolve subelements of types. This allows us to merge these
219 // two types: { int* } and { opaque* }
220 for (unsigned i = 0, e = DelayedTypesToResolve.size(); i != e; ++i) {
221 const std::string &Name = DelayedTypesToResolve[i];
222 PATypeHolder T1(SrcST->lookupType(Name));
223 PATypeHolder T2(DestST->lookupType(Name));
225 if (!RecursiveResolveTypes(T2, T1, DestST, Name)) {
226 // We are making progress!
227 DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
229 // Go back to the main loop, perhaps we can resolve directly by name
235 // If we STILL cannot resolve the types, then there is something wrong.
236 // Report the warning and delete one of the names.
237 if (DelayedTypesToResolve.size() == OldSize) {
238 const std::string &Name = DelayedTypesToResolve.back();
240 const Type *T1 = SrcST->lookupType(Name);
241 const Type *T2 = DestST->lookupType(Name);
242 std::cerr << "WARNING: Type conflict between types named '" << Name
244 WriteTypeSymbolic(std::cerr, T1, Src);
245 std::cerr << "'.\n Dest='";
246 WriteTypeSymbolic(std::cerr, T2, Dest);
249 // Remove the symbol name from the destination.
250 DelayedTypesToResolve.pop_back();
259 static void PrintMap(const std::map<const Value*, Value*> &M) {
260 for (std::map<const Value*, Value*>::const_iterator I = M.begin(), E =M.end();
262 std::cerr << " Fr: " << (void*)I->first << " ";
264 std::cerr << " To: " << (void*)I->second << " ";
271 // RemapOperand - Use LocalMap and GlobalMap to convert references from one
272 // module to another. This is somewhat sophisticated in that it can
273 // automatically handle constant references correctly as well...
275 static Value *RemapOperand(const Value *In,
276 std::map<const Value*, Value*> &LocalMap,
277 std::map<const Value*, Value*> *GlobalMap) {
278 std::map<const Value*,Value*>::const_iterator I = LocalMap.find(In);
279 if (I != LocalMap.end()) return I->second;
282 I = GlobalMap->find(In);
283 if (I != GlobalMap->end()) return I->second;
286 // Check to see if it's a constant that we are interesting in transforming...
287 if (const Constant *CPV = dyn_cast<Constant>(In)) {
288 if ((!isa<DerivedType>(CPV->getType()) && !isa<ConstantExpr>(CPV)) ||
289 isa<ConstantAggregateZero>(CPV))
290 return const_cast<Constant*>(CPV); // Simple constants stay identical...
292 Constant *Result = 0;
294 if (const ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
295 std::vector<Constant*> Operands(CPA->getNumOperands());
296 for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
298 cast<Constant>(RemapOperand(CPA->getOperand(i), LocalMap, GlobalMap));
299 Result = ConstantArray::get(cast<ArrayType>(CPA->getType()), Operands);
300 } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
301 std::vector<Constant*> Operands(CPS->getNumOperands());
302 for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
304 cast<Constant>(RemapOperand(CPS->getOperand(i), LocalMap, GlobalMap));
305 Result = ConstantStruct::get(cast<StructType>(CPS->getType()), Operands);
306 } else if (isa<ConstantPointerNull>(CPV)) {
307 Result = const_cast<Constant*>(CPV);
308 } else if (isa<GlobalValue>(CPV)) {
309 Result = cast<Constant>(RemapOperand(CPV, LocalMap, GlobalMap));
310 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
311 if (CE->getOpcode() == Instruction::GetElementPtr) {
312 Value *Ptr = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
313 std::vector<Constant*> Indices;
314 Indices.reserve(CE->getNumOperands()-1);
315 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
316 Indices.push_back(cast<Constant>(RemapOperand(CE->getOperand(i),
317 LocalMap, GlobalMap)));
319 Result = ConstantExpr::getGetElementPtr(cast<Constant>(Ptr), Indices);
320 } else if (CE->getNumOperands() == 1) {
322 assert(CE->getOpcode() == Instruction::Cast);
323 Value *V = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
324 Result = ConstantExpr::getCast(cast<Constant>(V), CE->getType());
325 } else if (CE->getNumOperands() == 3) {
326 // Select instruction
327 assert(CE->getOpcode() == Instruction::Select);
328 Value *V1 = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
329 Value *V2 = RemapOperand(CE->getOperand(1), LocalMap, GlobalMap);
330 Value *V3 = RemapOperand(CE->getOperand(2), LocalMap, GlobalMap);
331 Result = ConstantExpr::getSelect(cast<Constant>(V1), cast<Constant>(V2),
333 } else if (CE->getNumOperands() == 2) {
334 // Binary operator...
335 Value *V1 = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
336 Value *V2 = RemapOperand(CE->getOperand(1), LocalMap, GlobalMap);
338 Result = ConstantExpr::get(CE->getOpcode(), cast<Constant>(V1),
341 assert(0 && "Unknown constant expr type!");
345 assert(0 && "Unknown type of derived type constant value!");
348 // Cache the mapping in our local map structure...
350 GlobalMap->insert(std::make_pair(In, Result));
352 LocalMap.insert(std::make_pair(In, Result));
356 std::cerr << "XXX LocalMap: \n";
360 std::cerr << "XXX GlobalMap: \n";
361 PrintMap(*GlobalMap);
364 std::cerr << "Couldn't remap value: " << (void*)In << " " << *In << "\n";
365 assert(0 && "Couldn't remap value!");
369 /// ForceRenaming - The LLVM SymbolTable class autorenames globals that conflict
370 /// in the symbol table. This is good for all clients except for us. Go
371 /// through the trouble to force this back.
372 static void ForceRenaming(GlobalValue *GV, const std::string &Name) {
373 assert(GV->getName() != Name && "Can't force rename to self");
374 SymbolTable &ST = GV->getParent()->getSymbolTable();
376 // If there is a conflict, rename the conflict.
377 Value *ConflictVal = ST.lookup(GV->getType(), Name);
378 assert(ConflictVal&&"Why do we have to force rename if there is no conflic?");
379 GlobalValue *ConflictGV = cast<GlobalValue>(ConflictVal);
380 assert(ConflictGV->hasInternalLinkage() &&
381 "Not conflicting with a static global, should link instead!");
383 ConflictGV->setName(""); // Eliminate the conflict
384 GV->setName(Name); // Force the name back
385 ConflictGV->setName(Name); // This will cause ConflictGV to get renamed
386 assert(GV->getName() == Name && ConflictGV->getName() != Name &&
387 "ForceRenaming didn't work");
391 // LinkGlobals - Loop through the global variables in the src module and merge
392 // them into the dest module.
394 static bool LinkGlobals(Module *Dest, const Module *Src,
395 std::map<const Value*, Value*> &ValueMap,
396 std::multimap<std::string, GlobalVariable *> &AppendingVars,
397 std::map<std::string, GlobalValue*> &GlobalsByName,
399 // We will need a module level symbol table if the src module has a module
400 // level symbol table...
401 SymbolTable *ST = (SymbolTable*)&Dest->getSymbolTable();
403 // Loop over all of the globals in the src module, mapping them over as we go
405 for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
406 const GlobalVariable *SGV = I;
407 GlobalVariable *DGV = 0;
408 // Check to see if may have to link the global.
409 if (SGV->hasName() && !SGV->hasInternalLinkage()) {
410 std::map<std::string, GlobalValue*>::iterator EGV =
411 GlobalsByName.find(SGV->getName());
412 if (EGV != GlobalsByName.end())
413 DGV = dyn_cast<GlobalVariable>(EGV->second);
416 assert(SGV->hasInitializer() || SGV->hasExternalLinkage() &&
417 "Global must either be external or have an initializer!");
419 bool SGExtern = SGV->isExternal();
420 bool DGExtern = DGV ? DGV->isExternal() : false;
422 if (!DGV || DGV->hasInternalLinkage() || SGV->hasInternalLinkage()) {
423 // No linking to be performed, simply create an identical version of the
424 // symbol over in the dest module... the initializer will be filled in
425 // later by LinkGlobalInits...
427 GlobalVariable *NewDGV =
428 new GlobalVariable(SGV->getType()->getElementType(),
429 SGV->isConstant(), SGV->getLinkage(), /*init*/0,
430 SGV->getName(), Dest);
432 // If the LLVM runtime renamed the global, but it is an externally visible
433 // symbol, DGV must be an existing global with internal linkage. Rename
435 if (NewDGV->getName() != SGV->getName() && !NewDGV->hasInternalLinkage())
436 ForceRenaming(NewDGV, SGV->getName());
438 // Make sure to remember this mapping...
439 ValueMap.insert(std::make_pair(SGV, NewDGV));
440 if (SGV->hasAppendingLinkage())
441 // Keep track that this is an appending variable...
442 AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
444 } else if (SGV->isExternal()) {
445 // If SGV is external or if both SGV & DGV are external.. Just link the
446 // external globals, we aren't adding anything.
447 ValueMap.insert(std::make_pair(SGV, DGV));
449 } else if (DGV->isExternal()) { // If DGV is external but SGV is not...
450 ValueMap.insert(std::make_pair(SGV, DGV));
451 DGV->setLinkage(SGV->getLinkage()); // Inherit linkage!
452 } else if (SGV->hasWeakLinkage() || SGV->hasLinkOnceLinkage()) {
453 // At this point we know that DGV has LinkOnce, Appending, Weak, or
454 // External linkage. If DGV is Appending, this is an error.
455 if (DGV->hasAppendingLinkage())
456 return Error(Err, "Linking globals named '" + SGV->getName() +
457 " ' with 'weak' and 'appending' linkage is not allowed!");
459 if (SGV->isConstant() != DGV->isConstant())
460 return Error(Err, "Global Variable Collision on '" +
461 SGV->getType()->getDescription() + " %" + SGV->getName() +
462 "' - Global variables differ in const'ness");
464 // Otherwise, just perform the link.
465 ValueMap.insert(std::make_pair(SGV, DGV));
467 // Linkonce+Weak = Weak
468 if (DGV->hasLinkOnceLinkage() && SGV->hasWeakLinkage())
469 DGV->setLinkage(SGV->getLinkage());
471 } else if (DGV->hasWeakLinkage() || DGV->hasLinkOnceLinkage()) {
472 // At this point we know that SGV has LinkOnce, Appending, or External
473 // linkage. If SGV is Appending, this is an error.
474 if (SGV->hasAppendingLinkage())
475 return Error(Err, "Linking globals named '" + SGV->getName() +
476 " ' with 'weak' and 'appending' linkage is not allowed!");
478 if (SGV->isConstant() != DGV->isConstant())
479 return Error(Err, "Global Variable Collision on '" +
480 SGV->getType()->getDescription() + " %" + SGV->getName() +
481 "' - Global variables differ in const'ness");
483 if (!SGV->hasLinkOnceLinkage())
484 DGV->setLinkage(SGV->getLinkage()); // Inherit linkage!
485 ValueMap.insert(std::make_pair(SGV, DGV));
487 } else if (SGV->getLinkage() != DGV->getLinkage()) {
488 return Error(Err, "Global variables named '" + SGV->getName() +
489 "' have different linkage specifiers!");
490 } else if (SGV->hasExternalLinkage()) {
491 // Allow linking two exactly identical external global variables...
492 if (SGV->isConstant() != DGV->isConstant())
493 return Error(Err, "Global Variable Collision on '" +
494 SGV->getType()->getDescription() + " %" + SGV->getName() +
495 "' - Global variables differ in const'ness");
497 if (SGV->getInitializer() != DGV->getInitializer())
498 return Error(Err, "Global Variable Collision on '" +
499 SGV->getType()->getDescription() + " %" + SGV->getName() +
500 "' - External linkage globals have different initializers");
502 ValueMap.insert(std::make_pair(SGV, DGV));
503 } else if (SGV->hasAppendingLinkage()) {
504 // No linking is performed yet. Just insert a new copy of the global, and
505 // keep track of the fact that it is an appending variable in the
506 // AppendingVars map. The name is cleared out so that no linkage is
508 GlobalVariable *NewDGV =
509 new GlobalVariable(SGV->getType()->getElementType(),
510 SGV->isConstant(), SGV->getLinkage(), /*init*/0,
513 // Make sure to remember this mapping...
514 ValueMap.insert(std::make_pair(SGV, NewDGV));
516 // Keep track that this is an appending variable...
517 AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
519 assert(0 && "Unknown linkage!");
526 // LinkGlobalInits - Update the initializers in the Dest module now that all
527 // globals that may be referenced are in Dest.
529 static bool LinkGlobalInits(Module *Dest, const Module *Src,
530 std::map<const Value*, Value*> &ValueMap,
533 // Loop over all of the globals in the src module, mapping them over as we go
535 for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
536 const GlobalVariable *SGV = I;
538 if (SGV->hasInitializer()) { // Only process initialized GV's
539 // Figure out what the initializer looks like in the dest module...
541 cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap, 0));
543 GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[SGV]);
544 if (DGV->hasInitializer()) {
545 if (SGV->hasExternalLinkage()) {
546 if (DGV->getInitializer() != SInit)
547 return Error(Err, "Global Variable Collision on '" +
548 SGV->getType()->getDescription() +"':%"+SGV->getName()+
549 " - Global variables have different initializers");
550 } else if (DGV->hasLinkOnceLinkage() || DGV->hasWeakLinkage()) {
551 // Nothing is required, mapped values will take the new global
553 } else if (SGV->hasLinkOnceLinkage() || SGV->hasWeakLinkage()) {
554 // Nothing is required, mapped values will take the new global
556 } else if (DGV->hasAppendingLinkage()) {
557 assert(0 && "Appending linkage unimplemented!");
559 assert(0 && "Unknown linkage!");
562 // Copy the initializer over now...
563 DGV->setInitializer(SInit);
570 // LinkFunctionProtos - Link the functions together between the two modules,
571 // without doing function bodies... this just adds external function prototypes
572 // to the Dest function...
574 static bool LinkFunctionProtos(Module *Dest, const Module *Src,
575 std::map<const Value*, Value*> &ValueMap,
576 std::map<std::string, GlobalValue*> &GlobalsByName,
578 SymbolTable *ST = (SymbolTable*)&Dest->getSymbolTable();
580 // Loop over all of the functions in the src module, mapping them over as we
583 for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
584 const Function *SF = I; // SrcFunction
586 if (SF->hasName() && !SF->hasInternalLinkage()) {
587 // Check to see if may have to link the function.
588 std::map<std::string, GlobalValue*>::iterator EF =
589 GlobalsByName.find(SF->getName());
590 if (EF != GlobalsByName.end())
591 DF = dyn_cast<Function>(EF->second);
594 if (!DF || SF->hasInternalLinkage() || DF->hasInternalLinkage()) {
595 // Function does not already exist, simply insert an function signature
596 // identical to SF into the dest module...
597 Function *NewDF = new Function(SF->getFunctionType(), SF->getLinkage(),
598 SF->getName(), Dest);
600 // If the LLVM runtime renamed the function, but it is an externally
601 // visible symbol, DF must be an existing function with internal linkage.
603 if (NewDF->getName() != SF->getName() && !NewDF->hasInternalLinkage())
604 ForceRenaming(DF, SF->getName());
606 // ... and remember this mapping...
607 ValueMap.insert(std::make_pair(SF, NewDF));
608 } else if (SF->isExternal()) {
609 // If SF is external or if both SF & DF are external.. Just link the
610 // external functions, we aren't adding anything.
611 ValueMap.insert(std::make_pair(SF, DF));
612 } else if (DF->isExternal()) { // If DF is external but SF is not...
613 // Link the external functions, update linkage qualifiers
614 ValueMap.insert(std::make_pair(SF, DF));
615 DF->setLinkage(SF->getLinkage());
617 } else if (SF->hasWeakLinkage() || SF->hasLinkOnceLinkage()) {
618 // At this point we know that DF has LinkOnce, Weak, or External linkage.
619 ValueMap.insert(std::make_pair(SF, DF));
621 // Linkonce+Weak = Weak
622 if (DF->hasLinkOnceLinkage() && SF->hasWeakLinkage())
623 DF->setLinkage(SF->getLinkage());
625 } else if (DF->hasWeakLinkage() || DF->hasLinkOnceLinkage()) {
626 // At this point we know that SF has LinkOnce or External linkage.
627 ValueMap.insert(std::make_pair(SF, DF));
628 if (!SF->hasLinkOnceLinkage()) // Don't inherit linkonce linkage
629 DF->setLinkage(SF->getLinkage());
631 } else if (SF->getLinkage() != DF->getLinkage()) {
632 return Error(Err, "Functions named '" + SF->getName() +
633 "' have different linkage specifiers!");
634 } else if (SF->hasExternalLinkage()) {
635 // The function is defined in both modules!!
636 return Error(Err, "Function '" +
637 SF->getFunctionType()->getDescription() + "':\"" +
638 SF->getName() + "\" - Function is already defined!");
640 assert(0 && "Unknown linkage configuration found!");
646 // LinkFunctionBody - Copy the source function over into the dest function and
647 // fix up references to values. At this point we know that Dest is an external
648 // function, and that Src is not.
650 static bool LinkFunctionBody(Function *Dest, const Function *Src,
651 std::map<const Value*, Value*> &GlobalMap,
653 assert(Src && Dest && Dest->isExternal() && !Src->isExternal());
654 std::map<const Value*, Value*> LocalMap; // Map for function local values
656 // Go through and convert function arguments over...
657 Function::aiterator DI = Dest->abegin();
658 for (Function::const_aiterator I = Src->abegin(), E = Src->aend();
660 DI->setName(I->getName()); // Copy the name information over...
662 // Add a mapping to our local map
663 LocalMap.insert(std::make_pair(I, DI));
666 // Loop over all of the basic blocks, copying the instructions over...
668 for (Function::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
669 // Create new basic block and add to mapping and the Dest function...
670 BasicBlock *DBB = new BasicBlock(I->getName(), Dest);
671 LocalMap.insert(std::make_pair(I, DBB));
673 // Loop over all of the instructions in the src basic block, copying them
674 // over. Note that this is broken in a strict sense because the cloned
675 // instructions will still be referencing values in the Src module, not
676 // the remapped values. In our case, however, we will not get caught and
677 // so we can delay patching the values up until later...
679 for (BasicBlock::const_iterator II = I->begin(), IE = I->end();
681 Instruction *DI = II->clone();
682 DI->setName(II->getName());
683 DBB->getInstList().push_back(DI);
684 LocalMap.insert(std::make_pair(II, DI));
688 // At this point, all of the instructions and values of the function are now
689 // copied over. The only problem is that they are still referencing values in
690 // the Source function as operands. Loop through all of the operands of the
691 // functions and patch them up to point to the local versions...
693 for (Function::iterator BB = Dest->begin(), BE = Dest->end(); BB != BE; ++BB)
694 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
695 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
697 *OI = RemapOperand(*OI, LocalMap, &GlobalMap);
703 // LinkFunctionBodies - Link in the function bodies that are defined in the
704 // source module into the DestModule. This consists basically of copying the
705 // function over and fixing up references to values.
707 static bool LinkFunctionBodies(Module *Dest, const Module *Src,
708 std::map<const Value*, Value*> &ValueMap,
711 // Loop over all of the functions in the src module, mapping them over as we
714 for (Module::const_iterator SF = Src->begin(), E = Src->end(); SF != E; ++SF){
715 if (!SF->isExternal()) { // No body if function is external
716 Function *DF = cast<Function>(ValueMap[SF]); // Destination function
718 // DF not external SF external?
719 if (DF->isExternal()) {
720 // Only provide the function body if there isn't one already.
721 if (LinkFunctionBody(DF, SF, ValueMap, Err))
729 // LinkAppendingVars - If there were any appending global variables, link them
730 // together now. Return true on error.
732 static bool LinkAppendingVars(Module *M,
733 std::multimap<std::string, GlobalVariable *> &AppendingVars,
734 std::string *ErrorMsg) {
735 if (AppendingVars.empty()) return false; // Nothing to do.
737 // Loop over the multimap of appending vars, processing any variables with the
738 // same name, forming a new appending global variable with both of the
739 // initializers merged together, then rewrite references to the old variables
742 std::vector<Constant*> Inits;
743 while (AppendingVars.size() > 1) {
744 // Get the first two elements in the map...
745 std::multimap<std::string,
746 GlobalVariable*>::iterator Second = AppendingVars.begin(), First=Second++;
748 // If the first two elements are for different names, there is no pair...
749 // Otherwise there is a pair, so link them together...
750 if (First->first == Second->first) {
751 GlobalVariable *G1 = First->second, *G2 = Second->second;
752 const ArrayType *T1 = cast<ArrayType>(G1->getType()->getElementType());
753 const ArrayType *T2 = cast<ArrayType>(G2->getType()->getElementType());
755 // Check to see that they two arrays agree on type...
756 if (T1->getElementType() != T2->getElementType())
757 return Error(ErrorMsg,
758 "Appending variables with different element types need to be linked!");
759 if (G1->isConstant() != G2->isConstant())
760 return Error(ErrorMsg,
761 "Appending variables linked with different const'ness!");
763 unsigned NewSize = T1->getNumElements() + T2->getNumElements();
764 ArrayType *NewType = ArrayType::get(T1->getElementType(), NewSize);
766 // Create the new global variable...
768 new GlobalVariable(NewType, G1->isConstant(), G1->getLinkage(),
769 /*init*/0, First->first, M);
771 // Merge the initializer...
772 Inits.reserve(NewSize);
773 if (ConstantArray *I = dyn_cast<ConstantArray>(G1->getInitializer())) {
774 for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
775 Inits.push_back(I->getOperand(i));
777 assert(isa<ConstantAggregateZero>(G1->getInitializer()));
778 Constant *CV = Constant::getNullValue(T1->getElementType());
779 for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
782 if (ConstantArray *I = dyn_cast<ConstantArray>(G2->getInitializer())) {
783 for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
784 Inits.push_back(I->getOperand(i));
786 assert(isa<ConstantAggregateZero>(G2->getInitializer()));
787 Constant *CV = Constant::getNullValue(T2->getElementType());
788 for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
791 NG->setInitializer(ConstantArray::get(NewType, Inits));
794 // Replace any uses of the two global variables with uses of the new
797 // FIXME: This should rewrite simple/straight-forward uses such as
798 // getelementptr instructions to not use the Cast!
799 G1->replaceAllUsesWith(ConstantExpr::getCast(NG, G1->getType()));
800 G2->replaceAllUsesWith(ConstantExpr::getCast(NG, G2->getType()));
802 // Remove the two globals from the module now...
803 M->getGlobalList().erase(G1);
804 M->getGlobalList().erase(G2);
806 // Put the new global into the AppendingVars map so that we can handle
807 // linking of more than two vars...
810 AppendingVars.erase(First);
817 // LinkModules - This function links two modules together, with the resulting
818 // left module modified to be the composite of the two input modules. If an
819 // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
820 // the problem. Upon failure, the Dest module could be in a modified state, and
821 // shouldn't be relied on to be consistent.
823 bool llvm::LinkModules(Module *Dest, const Module *Src, std::string *ErrorMsg) {
824 if (Dest->getEndianness() == Module::AnyEndianness)
825 Dest->setEndianness(Src->getEndianness());
826 if (Dest->getPointerSize() == Module::AnyPointerSize)
827 Dest->setPointerSize(Src->getPointerSize());
829 if (Src->getEndianness() != Module::AnyEndianness &&
830 Dest->getEndianness() != Src->getEndianness())
831 std::cerr << "WARNING: Linking two modules of different endianness!\n";
832 if (Src->getPointerSize() != Module::AnyPointerSize &&
833 Dest->getPointerSize() != Src->getPointerSize())
834 std::cerr << "WARNING: Linking two modules of different pointer size!\n";
836 // LinkTypes - Go through the symbol table of the Src module and see if any
837 // types are named in the src module that are not named in the Dst module.
838 // Make sure there are no type name conflicts.
840 if (LinkTypes(Dest, Src, ErrorMsg)) return true;
842 // ValueMap - Mapping of values from what they used to be in Src, to what they
845 std::map<const Value*, Value*> ValueMap;
847 // AppendingVars - Keep track of global variables in the destination module
848 // with appending linkage. After the module is linked together, they are
849 // appended and the module is rewritten.
851 std::multimap<std::string, GlobalVariable *> AppendingVars;
853 // GlobalsByName - The LLVM SymbolTable class fights our best efforts at
854 // linking by separating globals by type. Until PR411 is fixed, we replicate
855 // it's functionality here.
856 std::map<std::string, GlobalValue*> GlobalsByName;
858 for (Module::giterator I = Dest->gbegin(), E = Dest->gend(); I != E; ++I) {
859 // Add all of the appending globals already in the Dest module to
861 if (I->hasAppendingLinkage())
862 AppendingVars.insert(std::make_pair(I->getName(), I));
864 // Keep track of all globals by name.
865 if (!I->hasInternalLinkage() && I->hasName())
866 GlobalsByName[I->getName()] = I;
869 // Keep track of all globals by name.
870 for (Module::iterator I = Dest->begin(), E = Dest->end(); I != E; ++I)
871 if (!I->hasInternalLinkage() && I->hasName())
872 GlobalsByName[I->getName()] = I;
874 // Insert all of the globals in src into the Dest module... without linking
875 // initializers (which could refer to functions not yet mapped over).
877 if (LinkGlobals(Dest, Src, ValueMap, AppendingVars, GlobalsByName, ErrorMsg))
880 // Link the functions together between the two modules, without doing function
881 // bodies... this just adds external function prototypes to the Dest
882 // function... We do this so that when we begin processing function bodies,
883 // all of the global values that may be referenced are available in our
886 if (LinkFunctionProtos(Dest, Src, ValueMap, GlobalsByName, ErrorMsg))
889 // Update the initializers in the Dest module now that all globals that may
890 // be referenced are in Dest.
892 if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
894 // Link in the function bodies that are defined in the source module into the
895 // DestModule. This consists basically of copying the function over and
896 // fixing up references to values.
898 if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
900 // If there were any appending global variables, link them together now.
902 if (LinkAppendingVars(Dest, AppendingVars, ErrorMsg)) return true;