Modify comment to reflect the importance of this code.
[oota-llvm.git] / lib / Linker / LinkModules.cpp
1 //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the LLVM module linker.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/Linker.h"
15 #include "llvm/Constants.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Instructions.h"
18 #include "llvm/Module.h"
19 #include "llvm/ADT/DenseSet.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/SetVector.h"
22 #include "llvm/ADT/SmallPtrSet.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/Support/Path.h"
25 #include "llvm/Transforms/Utils/Cloning.h"
26 #include "llvm/Transforms/Utils/ValueMapper.h"
27
28 #include "llvm/Support/Debug.h"
29 using namespace llvm;
30
31 //===----------------------------------------------------------------------===//
32 // TypeMap implementation.
33 //===----------------------------------------------------------------------===//
34
35 namespace {
36
37 class TypeMapTy : public ValueMapTypeRemapper {
38   /// MappedTypes - This is a mapping from a source type to a destination type
39   /// to use.
40   DenseMap<Type*, Type*> MappedTypes;
41
42   /// SpeculativeTypes - When checking to see if two subgraphs are isomorphic,
43   /// we speculatively add types to MappedTypes, but keep track of them here in
44   /// case we need to roll back.
45   SmallVector<Type*, 16> SpeculativeTypes;
46   
47   /// SrcDefinitionsToResolve - This is a list of non-opaque structs in the
48   /// source module that are mapped to an opaque struct in the destination
49   /// module.
50   SmallVector<StructType*, 16> SrcDefinitionsToResolve;
51   
52   /// DstResolvedOpaqueTypes - This is the set of opaque types in the
53   /// destination modules who are getting a body from the source module.
54   SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes;
55
56 public:
57   /// addTypeMapping - Indicate that the specified type in the destination
58   /// module is conceptually equivalent to the specified type in the source
59   /// module.
60   void addTypeMapping(Type *DstTy, Type *SrcTy);
61
62   /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest
63   /// module from a type definition in the source module.
64   void linkDefinedTypeBodies();
65   
66   /// get - Return the mapped type to use for the specified input type from the
67   /// source module.
68   Type *get(Type *SrcTy);
69
70   FunctionType *get(FunctionType *T) {return cast<FunctionType>(get((Type*)T));}
71
72 private:
73   Type *getImpl(Type *T);
74   /// remapType - Implement the ValueMapTypeRemapper interface.
75   Type *remapType(Type *SrcTy) {
76     return get(SrcTy);
77   }
78   
79   bool areTypesIsomorphic(Type *DstTy, Type *SrcTy);
80 };
81
82 } // end anonymous namespace
83
84 /// endsInDotNumber - Check to see if there is a dot in the name followed by a
85 /// digit.
86 static bool endsInDotNumber(StructType *Ty) {
87   size_t DotPos = Ty->getName().rfind('.');
88   return DotPos != 0 && DotPos != StringRef::npos &&
89     Ty->getName().back() != '.' && isdigit(Ty->getName()[DotPos + 1]);
90 }
91
92 void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) {
93   Type *&Entry = MappedTypes[SrcTy];
94   if (Entry) return;
95   
96   if (DstTy == SrcTy) {
97     Entry = DstTy;
98     return;
99   }
100
101   // Check to see if these types are recursively isomorphic and establish a
102   // mapping between them if so.
103   if (!areTypesIsomorphic(DstTy, SrcTy))
104     // Oops, they aren't isomorphic.  Just discard this request by rolling out
105     // any speculative mappings we've established.
106     for (unsigned i = 0, e = SpeculativeTypes.size(); i != e; ++i)
107       MappedTypes.erase(SpeculativeTypes[i]);
108
109   SpeculativeTypes.clear();
110 }
111
112 /// areTypesIsomorphic - Recursively walk this pair of types, returning true
113 /// if they are isomorphic, false if they are not.
114 bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) {
115   // Two types with differing kinds are clearly not isomorphic.
116   if (DstTy->getTypeID() != SrcTy->getTypeID()) return false;
117
118   // If we have an entry in the MappedTypes table, then we have our answer.
119   Type *&Entry = MappedTypes[SrcTy];
120   if (Entry)
121     return Entry == DstTy;
122
123   // Two identical types are clearly isomorphic.  Remember this
124   // non-speculatively.
125   if (DstTy == SrcTy) {
126     Entry = DstTy;
127     return true;
128   }
129
130   // Okay, we have two types with identical kinds that we haven't seen before.
131
132   // If this is an opaque struct type, special case it.
133   if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) {
134     // Mapping an opaque type to any struct, just keep the dest struct.
135     if (SSTy->isOpaque()) {
136       Entry = DstTy;
137       SpeculativeTypes.push_back(SrcTy);
138       return true;
139     }
140
141     // Mapping a non-opaque source type to an opaque dest.  If this is the first
142     // type that we're mapping onto this destination type then we succeed.  Keep
143     // the dest, but fill it in later.  This doesn't need to be speculative.  If
144     // this is the second (different) type that we're trying to map onto the
145     // same opaque type then we fail.
146     if (cast<StructType>(DstTy)->isOpaque()) {
147       // We can only map one source type onto the opaque destination type.
148       if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy)))
149         return false;
150       SrcDefinitionsToResolve.push_back(SSTy);
151       Entry = DstTy;
152       return true;
153     }
154   }
155   
156   // If the number of subtypes disagree between the two types, then we fail.
157   if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes())
158     return false;
159   
160   // Fail if any of the extra properties (e.g. array size) of the type disagree.
161   if (isa<IntegerType>(DstTy))
162     return false;  // bitwidth disagrees.
163   if (PointerType *PT = dyn_cast<PointerType>(DstTy)) {
164     if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace())
165       return false;
166     
167   } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) {
168     if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg())
169       return false;
170   } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) {
171     StructType *SSTy = cast<StructType>(SrcTy);
172     if (DSTy->isLiteral() != SSTy->isLiteral() ||
173         DSTy->isPacked() != SSTy->isPacked())
174       return false;
175   } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) {
176     if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
177       return false;
178   } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
179     if (DVTy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
180       return false;
181   }
182
183   // Otherwise, we speculate that these two types will line up and recursively
184   // check the subelements.
185   Entry = DstTy;
186   SpeculativeTypes.push_back(SrcTy);
187
188   for (unsigned i = 0, e = SrcTy->getNumContainedTypes(); i != e; ++i) {
189     Type *SrcSubTy = SrcTy->getContainedType(i);
190     Type *DstSubTy = DstTy->getContainedType(i);
191
192     if (StructType *DST = dyn_cast<StructType>(DstSubTy))
193       if (DST->hasName() && endsInDotNumber(DST))
194         std::swap(SrcSubTy, DstSubTy);
195
196     if (!areTypesIsomorphic(DstSubTy, SrcSubTy))
197       return false;
198   }
199   
200   // If everything seems to have lined up, then everything is great.
201   return true;
202 }
203
204 /// linkDefinedTypeBodies - Produce a body for an opaque type in the dest
205 /// module from a type definition in the source module.
206 void TypeMapTy::linkDefinedTypeBodies() {
207   SmallVector<Type*, 16> Elements;
208   SmallString<16> TmpName;
209   
210   // Note that processing entries in this loop (calling 'get') can add new
211   // entries to the SrcDefinitionsToResolve vector.
212   while (!SrcDefinitionsToResolve.empty()) {
213     StructType *SrcSTy = SrcDefinitionsToResolve.pop_back_val();
214     StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]);
215     
216     // TypeMap is a many-to-one mapping, if there were multiple types that
217     // provide a body for DstSTy then previous iterations of this loop may have
218     // already handled it.  Just ignore this case.
219     if (!DstSTy->isOpaque()) continue;
220     assert(!SrcSTy->isOpaque() && "Not resolving a definition?");
221     
222     // Map the body of the source type over to a new body for the dest type.
223     Elements.resize(SrcSTy->getNumElements());
224     for (unsigned i = 0, e = Elements.size(); i != e; ++i)
225       Elements[i] = getImpl(SrcSTy->getElementType(i));
226     
227     DstSTy->setBody(Elements, SrcSTy->isPacked());
228     
229     // If DstSTy has no name or has a longer name than STy, then viciously steal
230     // STy's name.
231     if (!SrcSTy->hasName()) continue;
232     StringRef SrcName = SrcSTy->getName();
233     
234     if (!DstSTy->hasName() || DstSTy->getName().size() > SrcName.size()) {
235       TmpName.insert(TmpName.end(), SrcName.begin(), SrcName.end());
236       SrcSTy->setName("");
237       DstSTy->setName(TmpName.str());
238       TmpName.clear();
239     }
240   }
241   
242   DstResolvedOpaqueTypes.clear();
243 }
244
245 /// get - Return the mapped type to use for the specified input type from the
246 /// source module.
247 Type *TypeMapTy::get(Type *Ty) {
248   Type *Result = getImpl(Ty);
249   
250   // If this caused a reference to any struct type, resolve it before returning.
251   if (!SrcDefinitionsToResolve.empty())
252     linkDefinedTypeBodies();
253   return Result;
254 }
255
256 /// getImpl - This is the recursive version of get().
257 Type *TypeMapTy::getImpl(Type *Ty) {
258   // If we already have an entry for this type, return it.
259   Type **Entry = &MappedTypes[Ty];
260   if (*Entry) return *Entry;
261
262   // If this is not a named struct type, then just map all of the elements and
263   // then rebuild the type from inside out.
264   if (!isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral()) {
265     // If there are no element types to map, then the type is itself.  This is
266     // true for the anonymous {} struct, things like 'float', integers, etc.
267     if (Ty->getNumContainedTypes() == 0)
268       return *Entry = Ty;
269     
270     // Remap all of the elements, keeping track of whether any of them change.
271     bool AnyChange = false;
272     SmallVector<Type*, 4> ElementTypes;
273     ElementTypes.resize(Ty->getNumContainedTypes());
274     for (unsigned i = 0, e = Ty->getNumContainedTypes(); i != e; ++i) {
275       ElementTypes[i] = getImpl(Ty->getContainedType(i));
276       AnyChange |= ElementTypes[i] != Ty->getContainedType(i);
277     }
278     
279     // If we found our type while recursively processing stuff, just use it.
280     Entry = &MappedTypes[Ty];
281     if (*Entry) return *Entry;
282     
283     // If all of the element types mapped directly over, then the type is usable
284     // as-is.
285     if (!AnyChange)
286       return *Entry = Ty;
287     
288     // Otherwise, rebuild a modified type.
289     switch (Ty->getTypeID()) {
290     default: llvm_unreachable("unknown derived type to remap");
291     case Type::ArrayTyID:
292       return *Entry = ArrayType::get(ElementTypes[0],
293                                      cast<ArrayType>(Ty)->getNumElements());
294     case Type::VectorTyID: 
295       return *Entry = VectorType::get(ElementTypes[0],
296                                       cast<VectorType>(Ty)->getNumElements());
297     case Type::PointerTyID:
298       return *Entry = PointerType::get(ElementTypes[0],
299                                       cast<PointerType>(Ty)->getAddressSpace());
300     case Type::FunctionTyID:
301       return *Entry = FunctionType::get(ElementTypes[0],
302                                         makeArrayRef(ElementTypes).slice(1),
303                                         cast<FunctionType>(Ty)->isVarArg());
304     case Type::StructTyID:
305       // Note that this is only reached for anonymous structs.
306       return *Entry = StructType::get(Ty->getContext(), ElementTypes,
307                                       cast<StructType>(Ty)->isPacked());
308     }
309   }
310
311   // Otherwise, this is an unmapped named struct.  If the struct can be directly
312   // mapped over, just use it as-is.  This happens in a case when the linked-in
313   // module has something like:
314   //   %T = type {%T*, i32}
315   //   @GV = global %T* null
316   // where T does not exist at all in the destination module.
317   //
318   // The other case we watch for is when the type is not in the destination
319   // module, but that it has to be rebuilt because it refers to something that
320   // is already mapped.  For example, if the destination module has:
321   //  %A = type { i32 }
322   // and the source module has something like
323   //  %A' = type { i32 }
324   //  %B = type { %A'* }
325   //  @GV = global %B* null
326   // then we want to create a new type: "%B = type { %A*}" and have it take the
327   // pristine "%B" name from the source module.
328   //
329   // To determine which case this is, we have to recursively walk the type graph
330   // speculating that we'll be able to reuse it unmodified.  Only if this is
331   // safe would we map the entire thing over.  Because this is an optimization,
332   // and is not required for the prettiness of the linked module, we just skip
333   // it and always rebuild a type here.
334   StructType *STy = cast<StructType>(Ty);
335   
336   // If the type is opaque, we can just use it directly.
337   if (STy->isOpaque())
338     return *Entry = STy;
339
340   // Otherwise we create a new type and resolve its body later.  This will be
341   // resolved by the top level of get().
342   SrcDefinitionsToResolve.push_back(STy);
343   StructType *DTy = StructType::create(STy->getContext());
344   DstResolvedOpaqueTypes.insert(DTy);
345   return *Entry = DTy;
346 }
347
348 //===----------------------------------------------------------------------===//
349 // ModuleLinker implementation.
350 //===----------------------------------------------------------------------===//
351
352 namespace {
353   /// ModuleLinker - This is an implementation class for the LinkModules
354   /// function, which is the entrypoint for this file.
355   class ModuleLinker {
356     Module *DstM, *SrcM;
357     
358     TypeMapTy TypeMap; 
359
360     /// ValueMap - Mapping of values from what they used to be in Src, to what
361     /// they are now in DstM.  ValueToValueMapTy is a ValueMap, which involves
362     /// some overhead due to the use of Value handles which the Linker doesn't
363     /// actually need, but this allows us to reuse the ValueMapper code.
364     ValueToValueMapTy ValueMap;
365     
366     struct AppendingVarInfo {
367       GlobalVariable *NewGV;  // New aggregate global in dest module.
368       Constant *DstInit;      // Old initializer from dest module.
369       Constant *SrcInit;      // Old initializer from src module.
370     };
371     
372     std::vector<AppendingVarInfo> AppendingVars;
373     
374     unsigned Mode; // Mode to treat source module.
375     
376     // Set of items not to link in from source.
377     SmallPtrSet<const Value*, 16> DoNotLinkFromSource;
378     
379     // Vector of functions to lazily link in.
380     std::vector<Function*> LazilyLinkFunctions;
381     
382   public:
383     std::string ErrorMsg;
384     
385     ModuleLinker(Module *dstM, Module *srcM, unsigned mode)
386       : DstM(dstM), SrcM(srcM), Mode(mode) { }
387     
388     bool run();
389     
390   private:
391     /// emitError - Helper method for setting a message and returning an error
392     /// code.
393     bool emitError(const Twine &Message) {
394       ErrorMsg = Message.str();
395       return true;
396     }
397     
398     /// getLinkageResult - This analyzes the two global values and determines
399     /// what the result will look like in the destination module.
400     bool getLinkageResult(GlobalValue *Dest, const GlobalValue *Src,
401                           GlobalValue::LinkageTypes &LT,
402                           GlobalValue::VisibilityTypes &Vis,
403                           bool &LinkFromSrc);
404
405     /// getLinkedToGlobal - Given a global in the source module, return the
406     /// global in the destination module that is being linked to, if any.
407     GlobalValue *getLinkedToGlobal(GlobalValue *SrcGV) {
408       // If the source has no name it can't link.  If it has local linkage,
409       // there is no name match-up going on.
410       if (!SrcGV->hasName() || SrcGV->hasLocalLinkage())
411         return 0;
412
413       // Otherwise see if we have a match in the destination module's symtab.
414       GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName());
415       if (DGV == 0) return 0;
416
417       // If we found a global with the same name in the dest module, but it has
418       // internal linkage, we are really not doing any linkage here.
419       if (DGV->hasLocalLinkage())
420         return 0;
421
422       // Otherwise, we do in fact link to the destination global.
423       return DGV;
424     }
425     
426     void computeTypeMapping();
427     bool categorizeModuleFlagNodes(const NamedMDNode *ModFlags,
428                                    DenseMap<MDString*, MDNode*> &ErrorNode,
429                                    DenseMap<MDString*, MDNode*> &WarningNode,
430                                    DenseMap<MDString*, MDNode*> &OverrideNode,
431                                    DenseMap<MDString*,
432                                    SmallSetVector<MDNode*, 8> > &RequireNodes,
433                                    SmallSetVector<MDString*, 16> &SeenIDs);
434     
435     bool linkAppendingVarProto(GlobalVariable *DstGV, GlobalVariable *SrcGV);
436     bool linkGlobalProto(GlobalVariable *SrcGV);
437     bool linkFunctionProto(Function *SrcF);
438     bool linkAliasProto(GlobalAlias *SrcA);
439     bool linkModuleFlagsMetadata();
440     
441     void linkAppendingVarInit(const AppendingVarInfo &AVI);
442     void linkGlobalInits();
443     void linkFunctionBody(Function *Dst, Function *Src);
444     void linkAliasBodies();
445     void linkNamedMDNodes();
446   };
447 } // end anonymous namespace
448
449 /// forceRenaming - The LLVM SymbolTable class autorenames globals that conflict
450 /// in the symbol table.  This is good for all clients except for us.  Go
451 /// through the trouble to force this back.
452 static void forceRenaming(GlobalValue *GV, StringRef Name) {
453   // If the global doesn't force its name or if it already has the right name,
454   // there is nothing for us to do.
455   if (GV->hasLocalLinkage() || GV->getName() == Name)
456     return;
457
458   Module *M = GV->getParent();
459
460   // If there is a conflict, rename the conflict.
461   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
462     GV->takeName(ConflictGV);
463     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
464     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
465   } else {
466     GV->setName(Name);              // Force the name back
467   }
468 }
469
470 /// CopyGVAttributes - copy additional attributes (those not needed to construct
471 /// a GlobalValue) from the SrcGV to the DestGV.
472 static void CopyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) {
473   // Use the maximum alignment, rather than just copying the alignment of SrcGV.
474   unsigned Alignment = std::max(DestGV->getAlignment(), SrcGV->getAlignment());
475   DestGV->copyAttributesFrom(SrcGV);
476   DestGV->setAlignment(Alignment);
477   
478   forceRenaming(DestGV, SrcGV->getName());
479 }
480
481 static bool isLessConstraining(GlobalValue::VisibilityTypes a,
482                                GlobalValue::VisibilityTypes b) {
483   if (a == GlobalValue::HiddenVisibility)
484     return false;
485   if (b == GlobalValue::HiddenVisibility)
486     return true;
487   if (a == GlobalValue::ProtectedVisibility)
488     return false;
489   if (b == GlobalValue::ProtectedVisibility)
490     return true;
491   return false;
492 }
493
494 /// getLinkageResult - This analyzes the two global values and determines what
495 /// the result will look like in the destination module.  In particular, it
496 /// computes the resultant linkage type and visibility, computes whether the
497 /// global in the source should be copied over to the destination (replacing
498 /// the existing one), and computes whether this linkage is an error or not.
499 bool ModuleLinker::getLinkageResult(GlobalValue *Dest, const GlobalValue *Src,
500                                     GlobalValue::LinkageTypes &LT,
501                                     GlobalValue::VisibilityTypes &Vis,
502                                     bool &LinkFromSrc) {
503   assert(Dest && "Must have two globals being queried");
504   assert(!Src->hasLocalLinkage() &&
505          "If Src has internal linkage, Dest shouldn't be set!");
506   
507   bool SrcIsDeclaration = Src->isDeclaration() && !Src->isMaterializable();
508   bool DestIsDeclaration = Dest->isDeclaration();
509   
510   if (SrcIsDeclaration) {
511     // If Src is external or if both Src & Dest are external..  Just link the
512     // external globals, we aren't adding anything.
513     if (Src->hasDLLImportLinkage()) {
514       // If one of GVs has DLLImport linkage, result should be dllimport'ed.
515       if (DestIsDeclaration) {
516         LinkFromSrc = true;
517         LT = Src->getLinkage();
518       }
519     } else if (Dest->hasExternalWeakLinkage()) {
520       // If the Dest is weak, use the source linkage.
521       LinkFromSrc = true;
522       LT = Src->getLinkage();
523     } else {
524       LinkFromSrc = false;
525       LT = Dest->getLinkage();
526     }
527   } else if (DestIsDeclaration && !Dest->hasDLLImportLinkage()) {
528     // If Dest is external but Src is not:
529     LinkFromSrc = true;
530     LT = Src->getLinkage();
531   } else if (Src->isWeakForLinker()) {
532     // At this point we know that Dest has LinkOnce, External*, Weak, Common,
533     // or DLL* linkage.
534     if (Dest->hasExternalWeakLinkage() ||
535         Dest->hasAvailableExternallyLinkage() ||
536         (Dest->hasLinkOnceLinkage() &&
537          (Src->hasWeakLinkage() || Src->hasCommonLinkage()))) {
538       LinkFromSrc = true;
539       LT = Src->getLinkage();
540     } else {
541       LinkFromSrc = false;
542       LT = Dest->getLinkage();
543     }
544   } else if (Dest->isWeakForLinker()) {
545     // At this point we know that Src has External* or DLL* linkage.
546     if (Src->hasExternalWeakLinkage()) {
547       LinkFromSrc = false;
548       LT = Dest->getLinkage();
549     } else {
550       LinkFromSrc = true;
551       LT = GlobalValue::ExternalLinkage;
552     }
553   } else {
554     assert((Dest->hasExternalLinkage()  || Dest->hasDLLImportLinkage() ||
555             Dest->hasDLLExportLinkage() || Dest->hasExternalWeakLinkage()) &&
556            (Src->hasExternalLinkage()   || Src->hasDLLImportLinkage() ||
557             Src->hasDLLExportLinkage()  || Src->hasExternalWeakLinkage()) &&
558            "Unexpected linkage type!");
559     return emitError("Linking globals named '" + Src->getName() +
560                  "': symbol multiply defined!");
561   }
562
563   // Compute the visibility. We follow the rules in the System V Application
564   // Binary Interface.
565   Vis = isLessConstraining(Src->getVisibility(), Dest->getVisibility()) ?
566     Dest->getVisibility() : Src->getVisibility();
567   return false;
568 }
569
570 /// computeTypeMapping - Loop over all of the linked values to compute type
571 /// mappings.  For example, if we link "extern Foo *x" and "Foo *x = NULL", then
572 /// we have two struct types 'Foo' but one got renamed when the module was
573 /// loaded into the same LLVMContext.
574 void ModuleLinker::computeTypeMapping() {
575   return;
576   // Incorporate globals.
577   for (Module::global_iterator I = SrcM->global_begin(),
578        E = SrcM->global_end(); I != E; ++I) {
579     GlobalValue *DGV = getLinkedToGlobal(I);
580     if (DGV == 0) continue;
581     
582     if (!DGV->hasAppendingLinkage() || !I->hasAppendingLinkage()) {
583       TypeMap.addTypeMapping(DGV->getType(), I->getType());
584       continue;      
585     }
586     
587     // Unify the element type of appending arrays.
588     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
589     ArrayType *SAT = cast<ArrayType>(I->getType()->getElementType());
590     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
591   }
592   
593   // Incorporate functions.
594   for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I) {
595     if (GlobalValue *DGV = getLinkedToGlobal(I))
596       TypeMap.addTypeMapping(DGV->getType(), I->getType());
597   }
598
599   // Incorporate types by name, scanning all the types in the source module.  At
600   // this point, the destination module may have a type "%foo = { i32 }" for
601   // example.  When the source module got loaded into the same LLVMContext, if
602   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
603   // Attempt to link these up to clean up the IR.
604   std::vector<StructType*> SrcStructTypes;
605   SrcM->findUsedStructTypes(SrcStructTypes);
606   
607   SmallPtrSet<StructType*, 32> SrcStructTypesSet(SrcStructTypes.begin(),
608                                                  SrcStructTypes.end());
609   
610   for (unsigned i = 0, e = SrcStructTypes.size(); i != e; ++i) {
611     StructType *ST = SrcStructTypes[i];
612     if (!ST->hasName()) continue;
613     
614     // Check to see if there is a dot in the name followed by a digit.
615     if (endsInDotNumber(ST)) continue;
616
617     if (endsInDotNumber(ST))
618       DstM->dump();
619     
620     // Check to see if the destination module has a struct with the prefix name.
621     size_t DotPos = ST->getName().rfind('.');
622     if (StructType *DST = DstM->getTypeByName(ST->getName().substr(0,DotPos))) {
623       // Don't use it if this actually came from the source module.  They're in
624       // the same LLVMContext after all.
625       if (!SrcStructTypesSet.count(DST))
626         TypeMap.addTypeMapping(DST, ST);
627     }
628   }
629
630   // Don't bother incorporating aliases, they aren't generally typed well.
631
632   // Now that we have discovered all of the type equivalences, get a body for
633   // any 'opaque' types in the dest module that are now resolved. 
634   TypeMap.linkDefinedTypeBodies();
635 }
636
637 /// linkAppendingVarProto - If there were any appending global variables, link
638 /// them together now.  Return true on error.
639 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
640                                          GlobalVariable *SrcGV) {
641   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
642     return emitError("Linking globals named '" + SrcGV->getName() +
643            "': can only link appending global with another appending global!");
644   
645   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
646   ArrayType *SrcTy =
647     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
648   Type *EltTy = DstTy->getElementType();
649   
650   // Check to see that they two arrays agree on type.
651   if (EltTy != SrcTy->getElementType())
652     return emitError("Appending variables with different element types!");
653   if (DstGV->isConstant() != SrcGV->isConstant())
654     return emitError("Appending variables linked with different const'ness!");
655   
656   if (DstGV->getAlignment() != SrcGV->getAlignment())
657     return emitError(
658              "Appending variables with different alignment need to be linked!");
659   
660   if (DstGV->getVisibility() != SrcGV->getVisibility())
661     return emitError(
662             "Appending variables with different visibility need to be linked!");
663   
664   if (DstGV->getSection() != SrcGV->getSection())
665     return emitError(
666           "Appending variables with different section name need to be linked!");
667   
668   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
669   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
670   
671   // Create the new global variable.
672   GlobalVariable *NG =
673     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
674                        DstGV->getLinkage(), /*init*/0, /*name*/"", DstGV,
675                        DstGV->isThreadLocal(),
676                        DstGV->getType()->getAddressSpace());
677   
678   // Propagate alignment, visibility and section info.
679   CopyGVAttributes(NG, DstGV);
680   
681   AppendingVarInfo AVI;
682   AVI.NewGV = NG;
683   AVI.DstInit = DstGV->getInitializer();
684   AVI.SrcInit = SrcGV->getInitializer();
685   AppendingVars.push_back(AVI);
686
687   // Replace any uses of the two global variables with uses of the new
688   // global.
689   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
690
691   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
692   DstGV->eraseFromParent();
693   
694   // Track the source variable so we don't try to link it.
695   DoNotLinkFromSource.insert(SrcGV);
696   
697   return false;
698 }
699
700 /// linkGlobalProto - Loop through the global variables in the src module and
701 /// merge them into the dest module.
702 bool ModuleLinker::linkGlobalProto(GlobalVariable *SGV) {
703   GlobalValue *DGV = getLinkedToGlobal(SGV);
704   llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility;
705
706   if (DGV) {
707     // Concatenation of appending linkage variables is magic and handled later.
708     if (DGV->hasAppendingLinkage() || SGV->hasAppendingLinkage())
709       return linkAppendingVarProto(cast<GlobalVariable>(DGV), SGV);
710     
711     // Determine whether linkage of these two globals follows the source
712     // module's definition or the destination module's definition.
713     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
714     GlobalValue::VisibilityTypes NV;
715     bool LinkFromSrc = false;
716     if (getLinkageResult(DGV, SGV, NewLinkage, NV, LinkFromSrc))
717       return true;
718     NewVisibility = NV;
719
720     // If we're not linking from the source, then keep the definition that we
721     // have.
722     if (!LinkFromSrc) {
723       // Special case for const propagation.
724       if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV))
725         if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant())
726           DGVar->setConstant(true);
727       
728       // Set calculated linkage and visibility.
729       DGV->setLinkage(NewLinkage);
730       DGV->setVisibility(*NewVisibility);
731
732       // Make sure to remember this mapping.
733       ValueMap[SGV] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGV->getType()));
734       
735       // Track the source global so that we don't attempt to copy it over when 
736       // processing global initializers.
737       DoNotLinkFromSource.insert(SGV);
738       
739       return false;
740     }
741   }
742   
743   // No linking to be performed or linking from the source: simply create an
744   // identical version of the symbol over in the dest module... the
745   // initializer will be filled in later by LinkGlobalInits.
746   GlobalVariable *NewDGV =
747     new GlobalVariable(*DstM, TypeMap.get(SGV->getType()->getElementType()),
748                        SGV->isConstant(), SGV->getLinkage(), /*init*/0,
749                        SGV->getName(), /*insertbefore*/0,
750                        SGV->isThreadLocal(),
751                        SGV->getType()->getAddressSpace());
752   // Propagate alignment, visibility and section info.
753   CopyGVAttributes(NewDGV, SGV);
754   if (NewVisibility)
755     NewDGV->setVisibility(*NewVisibility);
756
757   if (DGV) {
758     DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDGV, DGV->getType()));
759     DGV->eraseFromParent();
760   }
761   
762   // Make sure to remember this mapping.
763   ValueMap[SGV] = NewDGV;
764   return false;
765 }
766
767 /// linkFunctionProto - Link the function in the source module into the
768 /// destination module if needed, setting up mapping information.
769 bool ModuleLinker::linkFunctionProto(Function *SF) {
770   GlobalValue *DGV = getLinkedToGlobal(SF);
771   llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility;
772
773   if (DGV) {
774     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
775     bool LinkFromSrc = false;
776     GlobalValue::VisibilityTypes NV;
777     if (getLinkageResult(DGV, SF, NewLinkage, NV, LinkFromSrc))
778       return true;
779     NewVisibility = NV;
780
781     if (!LinkFromSrc) {
782       // Set calculated linkage
783       DGV->setLinkage(NewLinkage);
784       DGV->setVisibility(*NewVisibility);
785
786       // Make sure to remember this mapping.
787       ValueMap[SF] = ConstantExpr::getBitCast(DGV, TypeMap.get(SF->getType()));
788       
789       // Track the function from the source module so we don't attempt to remap 
790       // it.
791       DoNotLinkFromSource.insert(SF);
792       
793       return false;
794     }
795   }
796   
797   // If there is no linkage to be performed or we are linking from the source,
798   // bring SF over.
799   Function *NewDF = Function::Create(TypeMap.get(SF->getFunctionType()),
800                                      SF->getLinkage(), SF->getName(), DstM);
801   CopyGVAttributes(NewDF, SF);
802   if (NewVisibility)
803     NewDF->setVisibility(*NewVisibility);
804
805   if (DGV) {
806     // Any uses of DF need to change to NewDF, with cast.
807     DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDF, DGV->getType()));
808     DGV->eraseFromParent();
809   } else {
810     // Internal, LO_ODR, or LO linkage - stick in set to ignore and lazily link.
811     if (SF->hasLocalLinkage() || SF->hasLinkOnceLinkage() ||
812         SF->hasAvailableExternallyLinkage()) {
813       DoNotLinkFromSource.insert(SF);
814       LazilyLinkFunctions.push_back(SF);
815     }
816   }
817   
818   ValueMap[SF] = NewDF;
819   return false;
820 }
821
822 /// LinkAliasProto - Set up prototypes for any aliases that come over from the
823 /// source module.
824 bool ModuleLinker::linkAliasProto(GlobalAlias *SGA) {
825   GlobalValue *DGV = getLinkedToGlobal(SGA);
826   llvm::Optional<GlobalValue::VisibilityTypes> NewVisibility;
827
828   if (DGV) {
829     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
830     GlobalValue::VisibilityTypes NV;
831     bool LinkFromSrc = false;
832     if (getLinkageResult(DGV, SGA, NewLinkage, NV, LinkFromSrc))
833       return true;
834     NewVisibility = NV;
835
836     if (!LinkFromSrc) {
837       // Set calculated linkage.
838       DGV->setLinkage(NewLinkage);
839       DGV->setVisibility(*NewVisibility);
840
841       // Make sure to remember this mapping.
842       ValueMap[SGA] = ConstantExpr::getBitCast(DGV,TypeMap.get(SGA->getType()));
843       
844       // Track the alias from the source module so we don't attempt to remap it.
845       DoNotLinkFromSource.insert(SGA);
846       
847       return false;
848     }
849   }
850   
851   // If there is no linkage to be performed or we're linking from the source,
852   // bring over SGA.
853   GlobalAlias *NewDA = new GlobalAlias(TypeMap.get(SGA->getType()),
854                                        SGA->getLinkage(), SGA->getName(),
855                                        /*aliasee*/0, DstM);
856   CopyGVAttributes(NewDA, SGA);
857   if (NewVisibility)
858     NewDA->setVisibility(*NewVisibility);
859
860   if (DGV) {
861     // Any uses of DGV need to change to NewDA, with cast.
862     DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewDA, DGV->getType()));
863     DGV->eraseFromParent();
864   }
865   
866   ValueMap[SGA] = NewDA;
867   return false;
868 }
869
870 static void getArrayElements(Constant *C, SmallVectorImpl<Constant*> &Dest) {
871   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
872
873   for (unsigned i = 0; i != NumElements; ++i)
874     Dest.push_back(C->getAggregateElement(i));
875 }
876                              
877 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
878   // Merge the initializer.
879   SmallVector<Constant*, 16> Elements;
880   getArrayElements(AVI.DstInit, Elements);
881   
882   Constant *SrcInit = MapValue(AVI.SrcInit, ValueMap, RF_None, &TypeMap);
883   getArrayElements(SrcInit, Elements);
884   
885   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
886   AVI.NewGV->setInitializer(ConstantArray::get(NewType, Elements));
887 }
888
889
890 // linkGlobalInits - Update the initializers in the Dest module now that all
891 // globals that may be referenced are in Dest.
892 void ModuleLinker::linkGlobalInits() {
893   // Loop over all of the globals in the src module, mapping them over as we go
894   for (Module::const_global_iterator I = SrcM->global_begin(),
895        E = SrcM->global_end(); I != E; ++I) {
896     
897     // Only process initialized GV's or ones not already in dest.
898     if (!I->hasInitializer() || DoNotLinkFromSource.count(I)) continue;          
899     
900     // Grab destination global variable.
901     GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[I]);
902     // Figure out what the initializer looks like in the dest module.
903     DGV->setInitializer(MapValue(I->getInitializer(), ValueMap,
904                                  RF_None, &TypeMap));
905   }
906 }
907
908 // linkFunctionBody - Copy the source function over into the dest function and
909 // fix up references to values.  At this point we know that Dest is an external
910 // function, and that Src is not.
911 void ModuleLinker::linkFunctionBody(Function *Dst, Function *Src) {
912   assert(Src && Dst && Dst->isDeclaration() && !Src->isDeclaration());
913
914   // Go through and convert function arguments over, remembering the mapping.
915   Function::arg_iterator DI = Dst->arg_begin();
916   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
917        I != E; ++I, ++DI) {
918     DI->setName(I->getName());  // Copy the name over.
919
920     // Add a mapping to our mapping.
921     ValueMap[I] = DI;
922   }
923
924   if (Mode == Linker::DestroySource) {
925     // Splice the body of the source function into the dest function.
926     Dst->getBasicBlockList().splice(Dst->end(), Src->getBasicBlockList());
927     
928     // At this point, all of the instructions and values of the function are now
929     // copied over.  The only problem is that they are still referencing values in
930     // the Source function as operands.  Loop through all of the operands of the
931     // functions and patch them up to point to the local versions.
932     for (Function::iterator BB = Dst->begin(), BE = Dst->end(); BB != BE; ++BB)
933       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
934         RemapInstruction(I, ValueMap, RF_IgnoreMissingEntries, &TypeMap);
935     
936   } else {
937     // Clone the body of the function into the dest function.
938     SmallVector<ReturnInst*, 8> Returns; // Ignore returns.
939     CloneFunctionInto(Dst, Src, ValueMap, false, Returns, "", NULL, &TypeMap);
940   }
941   
942   // There is no need to map the arguments anymore.
943   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
944        I != E; ++I)
945     ValueMap.erase(I);
946   
947 }
948
949
950 void ModuleLinker::linkAliasBodies() {
951   for (Module::alias_iterator I = SrcM->alias_begin(), E = SrcM->alias_end();
952        I != E; ++I) {
953     if (DoNotLinkFromSource.count(I))
954       continue;
955     if (Constant *Aliasee = I->getAliasee()) {
956       GlobalAlias *DA = cast<GlobalAlias>(ValueMap[I]);
957       DA->setAliasee(MapValue(Aliasee, ValueMap, RF_None, &TypeMap));
958     }
959   }
960 }
961
962 /// linkNamedMDNodes - Insert all of the named mdnodes in Src into the Dest
963 /// module.
964 void ModuleLinker::linkNamedMDNodes() {
965   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
966   for (Module::const_named_metadata_iterator I = SrcM->named_metadata_begin(),
967        E = SrcM->named_metadata_end(); I != E; ++I) {
968     // Don't link module flags here. Do them separately.
969     if (&*I == SrcModFlags) continue;
970     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(I->getName());
971     // Add Src elements into Dest node.
972     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
973       DestNMD->addOperand(MapValue(I->getOperand(i), ValueMap,
974                                    RF_None, &TypeMap));
975   }
976 }
977
978 /// categorizeModuleFlagNodes -
979 bool ModuleLinker::
980 categorizeModuleFlagNodes(const NamedMDNode *ModFlags,
981                           DenseMap<MDString*, MDNode*> &ErrorNode,
982                           DenseMap<MDString*, MDNode*> &WarningNode,
983                           DenseMap<MDString*, MDNode*> &OverrideNode,
984                           DenseMap<MDString*,
985                             SmallSetVector<MDNode*, 8> > &RequireNodes,
986                           SmallSetVector<MDString*, 16> &SeenIDs) {
987   bool HasErr = false;
988
989   for (unsigned I = 0, E = ModFlags->getNumOperands(); I != E; ++I) {
990     MDNode *Op = ModFlags->getOperand(I);
991     assert(Op->getNumOperands() == 3 && "Invalid module flag metadata!");
992     assert(isa<ConstantInt>(Op->getOperand(0)) &&
993            "Module flag's first operand must be an integer!");
994     assert(isa<MDString>(Op->getOperand(1)) &&
995            "Module flag's second operand must be an MDString!");
996
997     ConstantInt *Behavior = cast<ConstantInt>(Op->getOperand(0));
998     MDString *ID = cast<MDString>(Op->getOperand(1));
999     Value *Val = Op->getOperand(2);
1000     switch (Behavior->getZExtValue()) {
1001     default:
1002       assert(false && "Invalid behavior in module flag metadata!");
1003       break;
1004     case Module::Error: {
1005       MDNode *&ErrNode = ErrorNode[ID];
1006       if (!ErrNode) ErrNode = Op;
1007       if (ErrNode->getOperand(2) != Val)
1008         HasErr = emitError("linking module flags '" + ID->getString() +
1009                            "': IDs have conflicting values");
1010       break;
1011     }
1012     case Module::Warning: {
1013       MDNode *&WarnNode = WarningNode[ID];
1014       if (!WarnNode) WarnNode = Op;
1015       if (WarnNode->getOperand(2) != Val)
1016         errs() << "WARNING: linking module flags '" << ID->getString()
1017                << "': IDs have conflicting values";
1018       break;
1019     }
1020     case Module::Require:  RequireNodes[ID].insert(Op);     break;
1021     case Module::Override: {
1022       MDNode *&OvrNode = OverrideNode[ID];
1023       if (!OvrNode) OvrNode = Op;
1024       if (OvrNode->getOperand(2) != Val)
1025         HasErr = emitError("linking module flags '" + ID->getString() +
1026                            "': IDs have conflicting override values");
1027       break;
1028     }
1029     }
1030
1031     SeenIDs.insert(ID);
1032   }
1033
1034   return HasErr;
1035 }
1036
1037 /// linkModuleFlagsMetadata - Merge the linker flags in Src into the Dest
1038 /// module.
1039 bool ModuleLinker::linkModuleFlagsMetadata() {
1040   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1041   if (!SrcModFlags) return false;
1042
1043   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
1044
1045   // If the destination module doesn't have module flags yet, then just copy
1046   // over the source module's flags.
1047   if (DstModFlags->getNumOperands() == 0) {
1048     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
1049       DstModFlags->addOperand(SrcModFlags->getOperand(I));
1050
1051     return false;
1052   }
1053
1054   bool HasErr = false;
1055
1056   // Otherwise, we have to merge them based on their behaviors. First,
1057   // categorize all of the nodes in the modules' module flags. If an error or
1058   // warning occurs, then emit the appropriate message(s).
1059   DenseMap<MDString*, MDNode*> ErrorNode;
1060   DenseMap<MDString*, MDNode*> WarningNode;
1061   DenseMap<MDString*, MDNode*> OverrideNode;
1062   DenseMap<MDString*, SmallSetVector<MDNode*, 8> > RequireNodes;
1063   SmallSetVector<MDString*, 16> SeenIDs;
1064
1065   HasErr |= categorizeModuleFlagNodes(SrcModFlags, ErrorNode, WarningNode,
1066                                       OverrideNode, RequireNodes, SeenIDs);
1067   HasErr |= categorizeModuleFlagNodes(DstModFlags, ErrorNode, WarningNode,
1068                                       OverrideNode, RequireNodes, SeenIDs);
1069
1070   // Check that there isn't both an error and warning node for a flag.
1071   for (SmallSetVector<MDString*, 16>::iterator
1072          I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) {
1073     MDString *ID = *I;
1074     if (ErrorNode[ID] && WarningNode[ID])
1075       HasErr = emitError("linking module flags '" + ID->getString() +
1076                          "': IDs have conflicting behaviors");
1077   }
1078
1079   // Early exit if we had an error.
1080   if (HasErr) return true;
1081
1082   // Get the destination's module flags ready for new operands.
1083   DstModFlags->dropAllReferences();
1084
1085   // Add all of the module flags to the destination module.
1086   DenseMap<MDString*, SmallVector<MDNode*, 4> > AddedNodes;
1087   for (SmallSetVector<MDString*, 16>::iterator
1088          I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) {
1089     MDString *ID = *I;
1090     if (OverrideNode[ID]) {
1091       DstModFlags->addOperand(OverrideNode[ID]);
1092       AddedNodes[ID].push_back(OverrideNode[ID]);
1093     } else if (ErrorNode[ID]) {
1094       DstModFlags->addOperand(ErrorNode[ID]);
1095       AddedNodes[ID].push_back(ErrorNode[ID]);
1096     } else if (WarningNode[ID]) {
1097       DstModFlags->addOperand(WarningNode[ID]);
1098       AddedNodes[ID].push_back(WarningNode[ID]);
1099     }
1100
1101     for (SmallSetVector<MDNode*, 8>::iterator
1102            II = RequireNodes[ID].begin(), IE = RequireNodes[ID].end();
1103          II != IE; ++II)
1104       DstModFlags->addOperand(*II);
1105   }
1106
1107   // Now check that all of the requirements have been satisfied.
1108   for (SmallSetVector<MDString*, 16>::iterator
1109          I = SeenIDs.begin(), E = SeenIDs.end(); I != E; ++I) {
1110     MDString *ID = *I;
1111     SmallSetVector<MDNode*, 8> &Set = RequireNodes[ID];
1112
1113     for (SmallSetVector<MDNode*, 8>::iterator
1114            II = Set.begin(), IE = Set.end(); II != IE; ++II) {
1115       MDNode *Node = *II;
1116       assert(isa<MDNode>(Node->getOperand(2)) &&
1117              "Module flag's third operand must be an MDNode!");
1118       MDNode *Val = cast<MDNode>(Node->getOperand(2));
1119
1120       MDString *ReqID = cast<MDString>(Val->getOperand(0));
1121       Value *ReqVal = Val->getOperand(1);
1122
1123       bool HasValue = false;
1124       for (SmallVectorImpl<MDNode*>::iterator
1125              RI = AddedNodes[ReqID].begin(), RE = AddedNodes[ReqID].end();
1126            RI != RE; ++RI) {
1127         MDNode *ReqNode = *RI;
1128         if (ReqNode->getOperand(2) == ReqVal) {
1129           HasValue = true;
1130           break;
1131         }
1132       }
1133
1134       if (!HasValue)
1135         HasErr = emitError("linking module flags '" + ReqID->getString() +
1136                            "': does not have the required value");
1137     }
1138   }
1139
1140   return HasErr;
1141 }
1142   
1143 bool ModuleLinker::run() {
1144   assert(DstM && "Null destination module");
1145   assert(SrcM && "Null source module");
1146
1147   // Inherit the target data from the source module if the destination module
1148   // doesn't have one already.
1149   if (DstM->getDataLayout().empty() && !SrcM->getDataLayout().empty())
1150     DstM->setDataLayout(SrcM->getDataLayout());
1151
1152   // Copy the target triple from the source to dest if the dest's is empty.
1153   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1154     DstM->setTargetTriple(SrcM->getTargetTriple());
1155
1156   if (!SrcM->getDataLayout().empty() && !DstM->getDataLayout().empty() &&
1157       SrcM->getDataLayout() != DstM->getDataLayout())
1158     errs() << "WARNING: Linking two modules of different data layouts!\n";
1159   if (!SrcM->getTargetTriple().empty() &&
1160       DstM->getTargetTriple() != SrcM->getTargetTriple()) {
1161     errs() << "WARNING: Linking two modules of different target triples: ";
1162     if (!SrcM->getModuleIdentifier().empty())
1163       errs() << SrcM->getModuleIdentifier() << ": ";
1164     errs() << "'" << SrcM->getTargetTriple() << "' and '" 
1165            << DstM->getTargetTriple() << "'\n";
1166   }
1167
1168   // Append the module inline asm string.
1169   if (!SrcM->getModuleInlineAsm().empty()) {
1170     if (DstM->getModuleInlineAsm().empty())
1171       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1172     else
1173       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1174                                SrcM->getModuleInlineAsm());
1175   }
1176
1177   // Update the destination module's dependent libraries list with the libraries
1178   // from the source module. There's no opportunity for duplicates here as the
1179   // Module ensures that duplicate insertions are discarded.
1180   for (Module::lib_iterator SI = SrcM->lib_begin(), SE = SrcM->lib_end();
1181        SI != SE; ++SI)
1182     DstM->addLibrary(*SI);
1183   
1184   // If the source library's module id is in the dependent library list of the
1185   // destination library, remove it since that module is now linked in.
1186   StringRef ModuleId = SrcM->getModuleIdentifier();
1187   if (!ModuleId.empty())
1188     DstM->removeLibrary(sys::path::stem(ModuleId));
1189   
1190   // Loop over all of the linked values to compute type mappings.
1191   computeTypeMapping();
1192
1193   // Insert all of the globals in src into the DstM module... without linking
1194   // initializers (which could refer to functions not yet mapped over).
1195   for (Module::global_iterator I = SrcM->global_begin(),
1196        E = SrcM->global_end(); I != E; ++I)
1197     if (linkGlobalProto(I))
1198       return true;
1199
1200   // Link the functions together between the two modules, without doing function
1201   // bodies... this just adds external function prototypes to the DstM
1202   // function...  We do this so that when we begin processing function bodies,
1203   // all of the global values that may be referenced are available in our
1204   // ValueMap.
1205   for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I)
1206     if (linkFunctionProto(I))
1207       return true;
1208
1209   // If there were any aliases, link them now.
1210   for (Module::alias_iterator I = SrcM->alias_begin(),
1211        E = SrcM->alias_end(); I != E; ++I)
1212     if (linkAliasProto(I))
1213       return true;
1214
1215   for (unsigned i = 0, e = AppendingVars.size(); i != e; ++i)
1216     linkAppendingVarInit(AppendingVars[i]);
1217   
1218   // Update the initializers in the DstM module now that all globals that may
1219   // be referenced are in DstM.
1220   linkGlobalInits();
1221
1222   // Link in the function bodies that are defined in the source module into
1223   // DstM.
1224   for (Module::iterator SF = SrcM->begin(), E = SrcM->end(); SF != E; ++SF) {
1225     // Skip if not linking from source.
1226     if (DoNotLinkFromSource.count(SF)) continue;
1227     
1228     // Skip if no body (function is external) or materialize.
1229     if (SF->isDeclaration()) {
1230       if (!SF->isMaterializable())
1231         continue;
1232       if (SF->Materialize(&ErrorMsg))
1233         return true;
1234     }
1235     
1236     linkFunctionBody(cast<Function>(ValueMap[SF]), SF);
1237   }
1238
1239   // Resolve all uses of aliases with aliasees.
1240   linkAliasBodies();
1241
1242   // Remap all of the named MDNodes in Src into the DstM module. We do this
1243   // after linking GlobalValues so that MDNodes that reference GlobalValues
1244   // are properly remapped.
1245   linkNamedMDNodes();
1246
1247   // Merge the module flags into the DstM module.
1248   if (linkModuleFlagsMetadata())
1249     return true;
1250
1251   // Process vector of lazily linked in functions.
1252   bool LinkedInAnyFunctions;
1253   do {
1254     LinkedInAnyFunctions = false;
1255     
1256     for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(),
1257         E = LazilyLinkFunctions.end(); I != E; ++I) {
1258       if (!*I)
1259         continue;
1260       
1261       Function *SF = *I;
1262       Function *DF = cast<Function>(ValueMap[SF]);
1263       
1264       if (!DF->use_empty()) {
1265         
1266         // Materialize if necessary.
1267         if (SF->isDeclaration()) {
1268           if (!SF->isMaterializable())
1269             continue;
1270           if (SF->Materialize(&ErrorMsg))
1271             return true;
1272         }
1273         
1274         // Link in function body.
1275         linkFunctionBody(DF, SF);
1276         
1277         // "Remove" from vector by setting the element to 0.
1278         *I = 0;
1279         
1280         // Set flag to indicate we may have more functions to lazily link in
1281         // since we linked in a function.
1282         LinkedInAnyFunctions = true;
1283       }
1284     }
1285   } while (LinkedInAnyFunctions);
1286   
1287   // Remove any prototypes of functions that were not actually linked in.
1288   for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(),
1289       E = LazilyLinkFunctions.end(); I != E; ++I) {
1290     if (!*I)
1291       continue;
1292     
1293     Function *SF = *I;
1294     Function *DF = cast<Function>(ValueMap[SF]);
1295     if (DF->use_empty())
1296       DF->eraseFromParent();
1297   }
1298   
1299   // Now that all of the types from the source are used, resolve any structs
1300   // copied over to the dest that didn't exist there.
1301   TypeMap.linkDefinedTypeBodies();
1302   
1303   return false;
1304 }
1305
1306 //===----------------------------------------------------------------------===//
1307 // LinkModules entrypoint.
1308 //===----------------------------------------------------------------------===//
1309
1310 // LinkModules - This function links two modules together, with the resulting
1311 // left module modified to be the composite of the two input modules.  If an
1312 // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
1313 // the problem.  Upon failure, the Dest module could be in a modified state, and
1314 // shouldn't be relied on to be consistent.
1315 bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Mode, 
1316                          std::string *ErrorMsg) {
1317   ModuleLinker TheLinker(Dest, Src, Mode);
1318   if (TheLinker.run()) {
1319     if (ErrorMsg) *ErrorMsg = TheLinker.ErrorMsg;
1320     return true;
1321   }
1322   
1323   return false;
1324 }