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