e643f5bb4c312416fc3f7027d76c55cde14325c7
[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/Hashing.h"
17 #include "llvm/ADT/Optional.h"
18 #include "llvm/ADT/SetVector.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/Statistic.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/DiagnosticInfo.h"
23 #include "llvm/IR/DiagnosticPrinter.h"
24 #include "llvm/IR/LLVMContext.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/IR/TypeFinder.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/Transforms/Utils/Cloning.h"
31 #include <cctype>
32 #include <tuple>
33 using namespace llvm;
34
35
36 //===----------------------------------------------------------------------===//
37 // TypeMap implementation.
38 //===----------------------------------------------------------------------===//
39
40 namespace {
41 class TypeMapTy : public ValueMapTypeRemapper {
42   /// This is a mapping from a source type to a destination type to use.
43   DenseMap<Type*, Type*> MappedTypes;
44
45   /// When checking to see if two subgraphs are isomorphic, we speculatively
46   /// add types to MappedTypes, but keep track of them here in case we need to
47   /// roll back.
48   SmallVector<Type*, 16> SpeculativeTypes;
49
50   SmallVector<StructType*, 16> SpeculativeDstOpaqueTypes;
51
52   /// This is a list of non-opaque structs in the source module that are mapped
53   /// to an opaque struct in the destination module.
54   SmallVector<StructType*, 16> SrcDefinitionsToResolve;
55
56   /// This is the set of opaque types in the destination modules who are
57   /// getting a body from the source module.
58   SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes;
59
60 public:
61   TypeMapTy(Linker::IdentifiedStructTypeSet &DstStructTypesSet)
62       : DstStructTypesSet(DstStructTypesSet) {}
63
64   Linker::IdentifiedStructTypeSet &DstStructTypesSet;
65   /// Indicate that the specified type in the destination module is conceptually
66   /// equivalent to the specified type in the source module.
67   void addTypeMapping(Type *DstTy, Type *SrcTy);
68
69   /// Produce a body for an opaque type in the dest module from a type
70   /// definition in the source module.
71   void linkDefinedTypeBodies();
72
73   /// Return the mapped type to use for the specified input type from the
74   /// source module.
75   Type *get(Type *SrcTy);
76   Type *get(Type *SrcTy, SmallPtrSet<StructType *, 8> &Visited);
77
78   void finishType(StructType *DTy, StructType *STy, ArrayRef<Type *> ETypes);
79
80   FunctionType *get(FunctionType *T) {
81     return cast<FunctionType>(get((Type *)T));
82   }
83
84   /// Dump out the type map for debugging purposes.
85   void dump() const {
86     for (auto &Pair : MappedTypes) {
87       dbgs() << "TypeMap: ";
88       Pair.first->print(dbgs());
89       dbgs() << " => ";
90       Pair.second->print(dbgs());
91       dbgs() << '\n';
92     }
93   }
94
95 private:
96   Type *remapType(Type *SrcTy) override { return get(SrcTy); }
97
98   bool areTypesIsomorphic(Type *DstTy, Type *SrcTy);
99 };
100 }
101
102 void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) {
103   assert(SpeculativeTypes.empty());
104   assert(SpeculativeDstOpaqueTypes.empty());
105
106   // Check to see if these types are recursively isomorphic and establish a
107   // mapping between them if so.
108   if (!areTypesIsomorphic(DstTy, SrcTy)) {
109     // Oops, they aren't isomorphic.  Just discard this request by rolling out
110     // any speculative mappings we've established.
111     for (Type *Ty : SpeculativeTypes)
112       MappedTypes.erase(Ty);
113
114     SrcDefinitionsToResolve.resize(SrcDefinitionsToResolve.size() -
115                                    SpeculativeDstOpaqueTypes.size());
116     for (StructType *Ty : SpeculativeDstOpaqueTypes)
117       DstResolvedOpaqueTypes.erase(Ty);
118   } else {
119     for (Type *Ty : SpeculativeTypes)
120       if (auto *STy = dyn_cast<StructType>(Ty))
121         if (STy->hasName())
122           STy->setName("");
123   }
124   SpeculativeTypes.clear();
125   SpeculativeDstOpaqueTypes.clear();
126 }
127
128 /// Recursively walk this pair of types, returning true if they are isomorphic,
129 /// false if they are not.
130 bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) {
131   // Two types with differing kinds are clearly not isomorphic.
132   if (DstTy->getTypeID() != SrcTy->getTypeID())
133     return false;
134
135   // If we have an entry in the MappedTypes table, then we have our answer.
136   Type *&Entry = MappedTypes[SrcTy];
137   if (Entry)
138     return Entry == DstTy;
139
140   // Two identical types are clearly isomorphic.  Remember this
141   // non-speculatively.
142   if (DstTy == SrcTy) {
143     Entry = DstTy;
144     return true;
145   }
146
147   // Okay, we have two types with identical kinds that we haven't seen before.
148
149   // If this is an opaque struct type, special case it.
150   if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) {
151     // Mapping an opaque type to any struct, just keep the dest struct.
152     if (SSTy->isOpaque()) {
153       Entry = DstTy;
154       SpeculativeTypes.push_back(SrcTy);
155       return true;
156     }
157
158     // Mapping a non-opaque source type to an opaque dest.  If this is the first
159     // type that we're mapping onto this destination type then we succeed.  Keep
160     // the dest, but fill it in later. If this is the second (different) type
161     // that we're trying to map onto the same opaque type then we fail.
162     if (cast<StructType>(DstTy)->isOpaque()) {
163       // We can only map one source type onto the opaque destination type.
164       if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy)).second)
165         return false;
166       SrcDefinitionsToResolve.push_back(SSTy);
167       SpeculativeTypes.push_back(SrcTy);
168       SpeculativeDstOpaqueTypes.push_back(cast<StructType>(DstTy));
169       Entry = DstTy;
170       return true;
171     }
172   }
173
174   // If the number of subtypes disagree between the two types, then we fail.
175   if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes())
176     return false;
177
178   // Fail if any of the extra properties (e.g. array size) of the type disagree.
179   if (isa<IntegerType>(DstTy))
180     return false;  // bitwidth disagrees.
181   if (PointerType *PT = dyn_cast<PointerType>(DstTy)) {
182     if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace())
183       return false;
184
185   } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) {
186     if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg())
187       return false;
188   } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) {
189     StructType *SSTy = cast<StructType>(SrcTy);
190     if (DSTy->isLiteral() != SSTy->isLiteral() ||
191         DSTy->isPacked() != SSTy->isPacked())
192       return false;
193   } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) {
194     if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
195       return false;
196   } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
197     if (DVTy->getNumElements() != cast<VectorType>(SrcTy)->getNumElements())
198       return false;
199   }
200
201   // Otherwise, we speculate that these two types will line up and recursively
202   // check the subelements.
203   Entry = DstTy;
204   SpeculativeTypes.push_back(SrcTy);
205
206   for (unsigned I = 0, E = SrcTy->getNumContainedTypes(); I != E; ++I)
207     if (!areTypesIsomorphic(DstTy->getContainedType(I),
208                             SrcTy->getContainedType(I)))
209       return false;
210
211   // If everything seems to have lined up, then everything is great.
212   return true;
213 }
214
215 void TypeMapTy::linkDefinedTypeBodies() {
216   SmallVector<Type*, 16> Elements;
217   for (StructType *SrcSTy : SrcDefinitionsToResolve) {
218     StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]);
219     assert(DstSTy->isOpaque());
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] = get(SrcSTy->getElementType(I));
225
226     DstSTy->setBody(Elements, SrcSTy->isPacked());
227   }
228   SrcDefinitionsToResolve.clear();
229   DstResolvedOpaqueTypes.clear();
230 }
231
232 void TypeMapTy::finishType(StructType *DTy, StructType *STy,
233                            ArrayRef<Type *> ETypes) {
234   DTy->setBody(ETypes, STy->isPacked());
235
236   // Steal STy's name.
237   if (STy->hasName()) {
238     SmallString<16> TmpName = STy->getName();
239     STy->setName("");
240     DTy->setName(TmpName);
241   }
242
243   DstStructTypesSet.addNonOpaque(DTy);
244 }
245
246 Type *TypeMapTy::get(Type *Ty) {
247   SmallPtrSet<StructType *, 8> Visited;
248   return get(Ty, Visited);
249 }
250
251 Type *TypeMapTy::get(Type *Ty, SmallPtrSet<StructType *, 8> &Visited) {
252   // If we already have an entry for this type, return it.
253   Type **Entry = &MappedTypes[Ty];
254   if (*Entry)
255     return *Entry;
256
257   // These are types that LLVM itself will unique.
258   bool IsUniqued = !isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral();
259
260 #ifndef NDEBUG
261   if (!IsUniqued) {
262     for (auto &Pair : MappedTypes) {
263       assert(!(Pair.first != Ty && Pair.second == Ty) &&
264              "mapping to a source type");
265     }
266   }
267 #endif
268
269   if (!IsUniqued && !Visited.insert(cast<StructType>(Ty)).second) {
270     StructType *DTy = StructType::create(Ty->getContext());
271     return *Entry = DTy;
272   }
273
274   // If this is not a recursive type, then just map all of the elements and
275   // then rebuild the type from inside out.
276   SmallVector<Type *, 4> ElementTypes;
277
278   // If there are no element types to map, then the type is itself.  This is
279   // true for the anonymous {} struct, things like 'float', integers, etc.
280   if (Ty->getNumContainedTypes() == 0 && IsUniqued)
281     return *Entry = Ty;
282
283   // Remap all of the elements, keeping track of whether any of them change.
284   bool AnyChange = false;
285   ElementTypes.resize(Ty->getNumContainedTypes());
286   for (unsigned I = 0, E = Ty->getNumContainedTypes(); I != E; ++I) {
287     ElementTypes[I] = get(Ty->getContainedType(I), Visited);
288     AnyChange |= ElementTypes[I] != Ty->getContainedType(I);
289   }
290
291   // If we found our type while recursively processing stuff, just use it.
292   Entry = &MappedTypes[Ty];
293   if (*Entry) {
294     if (auto *DTy = dyn_cast<StructType>(*Entry)) {
295       if (DTy->isOpaque()) {
296         auto *STy = cast<StructType>(Ty);
297         finishType(DTy, STy, ElementTypes);
298       }
299     }
300     return *Entry;
301   }
302
303   // If all of the element types mapped directly over and the type is not
304   // a nomed struct, then the type is usable as-is.
305   if (!AnyChange && IsUniqued)
306     return *Entry = Ty;
307
308   // Otherwise, rebuild a modified type.
309   switch (Ty->getTypeID()) {
310   default:
311     llvm_unreachable("unknown derived type to remap");
312   case Type::ArrayTyID:
313     return *Entry = ArrayType::get(ElementTypes[0],
314                                    cast<ArrayType>(Ty)->getNumElements());
315   case Type::VectorTyID:
316     return *Entry = VectorType::get(ElementTypes[0],
317                                     cast<VectorType>(Ty)->getNumElements());
318   case Type::PointerTyID:
319     return *Entry = PointerType::get(ElementTypes[0],
320                                      cast<PointerType>(Ty)->getAddressSpace());
321   case Type::FunctionTyID:
322     return *Entry = FunctionType::get(ElementTypes[0],
323                                       makeArrayRef(ElementTypes).slice(1),
324                                       cast<FunctionType>(Ty)->isVarArg());
325   case Type::StructTyID: {
326     auto *STy = cast<StructType>(Ty);
327     bool IsPacked = STy->isPacked();
328     if (IsUniqued)
329       return *Entry = StructType::get(Ty->getContext(), ElementTypes, IsPacked);
330
331     // If the type is opaque, we can just use it directly.
332     if (STy->isOpaque()) {
333       DstStructTypesSet.addOpaque(STy);
334       return *Entry = Ty;
335     }
336
337     if (StructType *OldT =
338             DstStructTypesSet.findNonOpaque(ElementTypes, IsPacked)) {
339       STy->setName("");
340       return *Entry = OldT;
341     }
342
343     if (!AnyChange) {
344       DstStructTypesSet.addNonOpaque(STy);
345       return *Entry = Ty;
346     }
347
348     StructType *DTy = StructType::create(Ty->getContext());
349     finishType(DTy, STy, ElementTypes);
350     return *Entry = DTy;
351   }
352   }
353 }
354
355 //===----------------------------------------------------------------------===//
356 // ModuleLinker implementation.
357 //===----------------------------------------------------------------------===//
358
359 namespace {
360 class ModuleLinker;
361
362 /// Creates prototypes for functions that are lazily linked on the fly. This
363 /// speeds up linking for modules with many/ lazily linked functions of which
364 /// few get used.
365 class ValueMaterializerTy : public ValueMaterializer {
366   TypeMapTy &TypeMap;
367   Module *DstM;
368   std::vector<Function *> &LazilyLinkFunctions;
369
370 public:
371   ValueMaterializerTy(TypeMapTy &TypeMap, Module *DstM,
372                       std::vector<Function *> &LazilyLinkFunctions)
373       : ValueMaterializer(), TypeMap(TypeMap), DstM(DstM),
374         LazilyLinkFunctions(LazilyLinkFunctions) {}
375
376   Value *materializeValueFor(Value *V) override;
377 };
378
379 class LinkDiagnosticInfo : public DiagnosticInfo {
380   const Twine &Msg;
381
382 public:
383   LinkDiagnosticInfo(DiagnosticSeverity Severity, const Twine &Msg);
384   void print(DiagnosticPrinter &DP) const override;
385 };
386 LinkDiagnosticInfo::LinkDiagnosticInfo(DiagnosticSeverity Severity,
387                                        const Twine &Msg)
388     : DiagnosticInfo(DK_Linker, Severity), Msg(Msg) {}
389 void LinkDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
390
391 /// This is an implementation class for the LinkModules function, which is the
392 /// entrypoint for this file.
393 class ModuleLinker {
394   Module *DstM, *SrcM;
395
396   TypeMapTy TypeMap;
397   ValueMaterializerTy ValMaterializer;
398
399   /// Mapping of values from what they used to be in Src, to what they are now
400   /// in DstM.  ValueToValueMapTy is a ValueMap, which involves some overhead
401   /// due to the use of Value handles which the Linker doesn't actually need,
402   /// but this allows us to reuse the ValueMapper code.
403   ValueToValueMapTy ValueMap;
404
405   struct AppendingVarInfo {
406     GlobalVariable *NewGV;   // New aggregate global in dest module.
407     const Constant *DstInit; // Old initializer from dest module.
408     const Constant *SrcInit; // Old initializer from src module.
409   };
410
411   std::vector<AppendingVarInfo> AppendingVars;
412
413   // Set of items not to link in from source.
414   SmallPtrSet<const Value *, 16> DoNotLinkFromSource;
415
416   // Vector of functions to lazily link in.
417   std::vector<Function *> LazilyLinkFunctions;
418
419   Linker::DiagnosticHandlerFunction DiagnosticHandler;
420
421 public:
422   ModuleLinker(Module *dstM, Linker::IdentifiedStructTypeSet &Set, Module *srcM,
423                Linker::DiagnosticHandlerFunction DiagnosticHandler)
424       : DstM(dstM), SrcM(srcM), TypeMap(Set),
425         ValMaterializer(TypeMap, DstM, LazilyLinkFunctions),
426         DiagnosticHandler(DiagnosticHandler) {}
427
428   bool run();
429
430 private:
431   bool shouldLinkFromSource(bool &LinkFromSrc, const GlobalValue &Dest,
432                             const GlobalValue &Src);
433
434   /// Helper method for setting a message and returning an error code.
435   bool emitError(const Twine &Message) {
436     DiagnosticHandler(LinkDiagnosticInfo(DS_Error, Message));
437     return true;
438   }
439
440   void emitWarning(const Twine &Message) {
441     DiagnosticHandler(LinkDiagnosticInfo(DS_Warning, Message));
442   }
443
444   bool getComdatLeader(Module *M, StringRef ComdatName,
445                        const GlobalVariable *&GVar);
446   bool computeResultingSelectionKind(StringRef ComdatName,
447                                      Comdat::SelectionKind Src,
448                                      Comdat::SelectionKind Dst,
449                                      Comdat::SelectionKind &Result,
450                                      bool &LinkFromSrc);
451   std::map<const Comdat *, std::pair<Comdat::SelectionKind, bool>>
452       ComdatsChosen;
453   bool getComdatResult(const Comdat *SrcC, Comdat::SelectionKind &SK,
454                        bool &LinkFromSrc);
455
456   /// Given a global in the source module, return the global in the
457   /// destination module that is being linked to, if any.
458   GlobalValue *getLinkedToGlobal(const GlobalValue *SrcGV) {
459     // If the source has no name it can't link.  If it has local linkage,
460     // there is no name match-up going on.
461     if (!SrcGV->hasName() || SrcGV->hasLocalLinkage())
462       return nullptr;
463
464     // Otherwise see if we have a match in the destination module's symtab.
465     GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName());
466     if (!DGV)
467       return nullptr;
468
469     // If we found a global with the same name in the dest module, but it has
470     // internal linkage, we are really not doing any linkage here.
471     if (DGV->hasLocalLinkage())
472       return nullptr;
473
474     // Otherwise, we do in fact link to the destination global.
475     return DGV;
476   }
477
478   void computeTypeMapping();
479
480   void upgradeMismatchedGlobalArray(StringRef Name);
481   void upgradeMismatchedGlobals();
482
483   bool linkAppendingVarProto(GlobalVariable *DstGV,
484                              const GlobalVariable *SrcGV);
485
486   bool linkGlobalValueProto(GlobalValue *GV);
487   GlobalValue *linkGlobalVariableProto(const GlobalVariable *SGVar,
488                                        GlobalValue *DGV, bool LinkFromSrc);
489   GlobalValue *linkFunctionProto(const Function *SF, GlobalValue *DGV,
490                                  bool LinkFromSrc);
491   GlobalValue *linkGlobalAliasProto(const GlobalAlias *SGA, GlobalValue *DGV,
492                                     bool LinkFromSrc);
493
494   bool linkModuleFlagsMetadata();
495
496   void linkAppendingVarInit(const AppendingVarInfo &AVI);
497   void linkGlobalInits();
498   void linkFunctionBody(Function *Dst, Function *Src);
499   void linkAliasBodies();
500   void linkNamedMDNodes();
501 };
502 }
503
504 /// The LLVM SymbolTable class autorenames globals that conflict in the symbol
505 /// table. This is good for all clients except for us. Go through the trouble
506 /// to force this back.
507 static void forceRenaming(GlobalValue *GV, StringRef Name) {
508   // If the global doesn't force its name or if it already has the right name,
509   // there is nothing for us to do.
510   if (GV->hasLocalLinkage() || GV->getName() == Name)
511     return;
512
513   Module *M = GV->getParent();
514
515   // If there is a conflict, rename the conflict.
516   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
517     GV->takeName(ConflictGV);
518     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
519     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
520   } else {
521     GV->setName(Name);              // Force the name back
522   }
523 }
524
525 /// copy additional attributes (those not needed to construct a GlobalValue)
526 /// from the SrcGV to the DestGV.
527 static void copyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) {
528   // Use the maximum alignment, rather than just copying the alignment of SrcGV.
529   auto *DestGO = dyn_cast<GlobalObject>(DestGV);
530   unsigned Alignment;
531   if (DestGO)
532     Alignment = std::max(DestGO->getAlignment(), SrcGV->getAlignment());
533
534   DestGV->copyAttributesFrom(SrcGV);
535
536   if (DestGO)
537     DestGO->setAlignment(Alignment);
538
539   forceRenaming(DestGV, SrcGV->getName());
540 }
541
542 static bool isLessConstraining(GlobalValue::VisibilityTypes a,
543                                GlobalValue::VisibilityTypes b) {
544   if (a == GlobalValue::HiddenVisibility)
545     return false;
546   if (b == GlobalValue::HiddenVisibility)
547     return true;
548   if (a == GlobalValue::ProtectedVisibility)
549     return false;
550   if (b == GlobalValue::ProtectedVisibility)
551     return true;
552   return false;
553 }
554
555 Value *ValueMaterializerTy::materializeValueFor(Value *V) {
556   Function *SF = dyn_cast<Function>(V);
557   if (!SF)
558     return nullptr;
559
560   Function *DF = Function::Create(TypeMap.get(SF->getFunctionType()),
561                                   SF->getLinkage(), SF->getName(), DstM);
562   copyGVAttributes(DF, SF);
563
564   if (Comdat *SC = SF->getComdat()) {
565     Comdat *DC = DstM->getOrInsertComdat(SC->getName());
566     DF->setComdat(DC);
567   }
568
569   LazilyLinkFunctions.push_back(SF);
570   return DF;
571 }
572
573 bool ModuleLinker::getComdatLeader(Module *M, StringRef ComdatName,
574                                    const GlobalVariable *&GVar) {
575   const GlobalValue *GVal = M->getNamedValue(ComdatName);
576   if (const auto *GA = dyn_cast_or_null<GlobalAlias>(GVal)) {
577     GVal = GA->getBaseObject();
578     if (!GVal)
579       // We cannot resolve the size of the aliasee yet.
580       return emitError("Linking COMDATs named '" + ComdatName +
581                        "': COMDAT key involves incomputable alias size.");
582   }
583
584   GVar = dyn_cast_or_null<GlobalVariable>(GVal);
585   if (!GVar)
586     return emitError(
587         "Linking COMDATs named '" + ComdatName +
588         "': GlobalVariable required for data dependent selection!");
589
590   return false;
591 }
592
593 bool ModuleLinker::computeResultingSelectionKind(StringRef ComdatName,
594                                                  Comdat::SelectionKind Src,
595                                                  Comdat::SelectionKind Dst,
596                                                  Comdat::SelectionKind &Result,
597                                                  bool &LinkFromSrc) {
598   // The ability to mix Comdat::SelectionKind::Any with
599   // Comdat::SelectionKind::Largest is a behavior that comes from COFF.
600   bool DstAnyOrLargest = Dst == Comdat::SelectionKind::Any ||
601                          Dst == Comdat::SelectionKind::Largest;
602   bool SrcAnyOrLargest = Src == Comdat::SelectionKind::Any ||
603                          Src == Comdat::SelectionKind::Largest;
604   if (DstAnyOrLargest && SrcAnyOrLargest) {
605     if (Dst == Comdat::SelectionKind::Largest ||
606         Src == Comdat::SelectionKind::Largest)
607       Result = Comdat::SelectionKind::Largest;
608     else
609       Result = Comdat::SelectionKind::Any;
610   } else if (Src == Dst) {
611     Result = Dst;
612   } else {
613     return emitError("Linking COMDATs named '" + ComdatName +
614                      "': invalid selection kinds!");
615   }
616
617   switch (Result) {
618   case Comdat::SelectionKind::Any:
619     // Go with Dst.
620     LinkFromSrc = false;
621     break;
622   case Comdat::SelectionKind::NoDuplicates:
623     return emitError("Linking COMDATs named '" + ComdatName +
624                      "': noduplicates has been violated!");
625   case Comdat::SelectionKind::ExactMatch:
626   case Comdat::SelectionKind::Largest:
627   case Comdat::SelectionKind::SameSize: {
628     const GlobalVariable *DstGV;
629     const GlobalVariable *SrcGV;
630     if (getComdatLeader(DstM, ComdatName, DstGV) ||
631         getComdatLeader(SrcM, ComdatName, SrcGV))
632       return true;
633
634     const DataLayout *DstDL = DstM->getDataLayout();
635     const DataLayout *SrcDL = SrcM->getDataLayout();
636     if (!DstDL || !SrcDL) {
637       return emitError(
638           "Linking COMDATs named '" + ComdatName +
639           "': can't do size dependent selection without DataLayout!");
640     }
641     uint64_t DstSize =
642         DstDL->getTypeAllocSize(DstGV->getType()->getPointerElementType());
643     uint64_t SrcSize =
644         SrcDL->getTypeAllocSize(SrcGV->getType()->getPointerElementType());
645     if (Result == Comdat::SelectionKind::ExactMatch) {
646       if (SrcGV->getInitializer() != DstGV->getInitializer())
647         return emitError("Linking COMDATs named '" + ComdatName +
648                          "': ExactMatch violated!");
649       LinkFromSrc = false;
650     } else if (Result == Comdat::SelectionKind::Largest) {
651       LinkFromSrc = SrcSize > DstSize;
652     } else if (Result == Comdat::SelectionKind::SameSize) {
653       if (SrcSize != DstSize)
654         return emitError("Linking COMDATs named '" + ComdatName +
655                          "': SameSize violated!");
656       LinkFromSrc = false;
657     } else {
658       llvm_unreachable("unknown selection kind");
659     }
660     break;
661   }
662   }
663
664   return false;
665 }
666
667 bool ModuleLinker::getComdatResult(const Comdat *SrcC,
668                                    Comdat::SelectionKind &Result,
669                                    bool &LinkFromSrc) {
670   Comdat::SelectionKind SSK = SrcC->getSelectionKind();
671   StringRef ComdatName = SrcC->getName();
672   Module::ComdatSymTabType &ComdatSymTab = DstM->getComdatSymbolTable();
673   Module::ComdatSymTabType::iterator DstCI = ComdatSymTab.find(ComdatName);
674
675   if (DstCI == ComdatSymTab.end()) {
676     // Use the comdat if it is only available in one of the modules.
677     LinkFromSrc = true;
678     Result = SSK;
679     return false;
680   }
681
682   const Comdat *DstC = &DstCI->second;
683   Comdat::SelectionKind DSK = DstC->getSelectionKind();
684   return computeResultingSelectionKind(ComdatName, SSK, DSK, Result,
685                                        LinkFromSrc);
686 }
687
688 bool ModuleLinker::shouldLinkFromSource(bool &LinkFromSrc,
689                                         const GlobalValue &Dest,
690                                         const GlobalValue &Src) {
691   // We always have to add Src if it has appending linkage.
692   if (Src.hasAppendingLinkage()) {
693     LinkFromSrc = true;
694     return false;
695   }
696
697   bool SrcIsDeclaration = Src.isDeclarationForLinker();
698   bool DestIsDeclaration = Dest.isDeclarationForLinker();
699
700   if (SrcIsDeclaration) {
701     // If Src is external or if both Src & Dest are external..  Just link the
702     // external globals, we aren't adding anything.
703     if (Src.hasDLLImportStorageClass()) {
704       // If one of GVs is marked as DLLImport, result should be dllimport'ed.
705       LinkFromSrc = DestIsDeclaration;
706       return false;
707     }
708     // If the Dest is weak, use the source linkage.
709     LinkFromSrc = Dest.hasExternalWeakLinkage();
710     return false;
711   }
712
713   if (DestIsDeclaration) {
714     // If Dest is external but Src is not:
715     LinkFromSrc = true;
716     return false;
717   }
718
719   if (Src.hasCommonLinkage()) {
720     if (Dest.hasLinkOnceLinkage() || Dest.hasWeakLinkage()) {
721       LinkFromSrc = true;
722       return false;
723     }
724
725     if (!Dest.hasCommonLinkage()) {
726       LinkFromSrc = false;
727       return false;
728     }
729
730     // FIXME: Make datalayout mandatory and just use getDataLayout().
731     DataLayout DL(Dest.getParent());
732
733     uint64_t DestSize = DL.getTypeAllocSize(Dest.getType()->getElementType());
734     uint64_t SrcSize = DL.getTypeAllocSize(Src.getType()->getElementType());
735     LinkFromSrc = SrcSize > DestSize;
736     return false;
737   }
738
739   if (Src.isWeakForLinker()) {
740     assert(!Dest.hasExternalWeakLinkage());
741     assert(!Dest.hasAvailableExternallyLinkage());
742
743     if (Dest.hasLinkOnceLinkage() && Src.hasWeakLinkage()) {
744       LinkFromSrc = true;
745       return false;
746     }
747
748     LinkFromSrc = false;
749     return false;
750   }
751
752   if (Dest.isWeakForLinker()) {
753     assert(Src.hasExternalLinkage());
754     LinkFromSrc = true;
755     return false;
756   }
757
758   assert(!Src.hasExternalWeakLinkage());
759   assert(!Dest.hasExternalWeakLinkage());
760   assert(Dest.hasExternalLinkage() && Src.hasExternalLinkage() &&
761          "Unexpected linkage type!");
762   return emitError("Linking globals named '" + Src.getName() +
763                    "': symbol multiply defined!");
764 }
765
766 /// Loop over all of the linked values to compute type mappings.  For example,
767 /// if we link "extern Foo *x" and "Foo *x = NULL", then we have two struct
768 /// types 'Foo' but one got renamed when the module was loaded into the same
769 /// LLVMContext.
770 void ModuleLinker::computeTypeMapping() {
771   for (GlobalValue &SGV : SrcM->globals()) {
772     GlobalValue *DGV = getLinkedToGlobal(&SGV);
773     if (!DGV)
774       continue;
775
776     if (!DGV->hasAppendingLinkage() || !SGV.hasAppendingLinkage()) {
777       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
778       continue;
779     }
780
781     // Unify the element type of appending arrays.
782     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
783     ArrayType *SAT = cast<ArrayType>(SGV.getType()->getElementType());
784     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
785   }
786
787   for (GlobalValue &SGV : *SrcM) {
788     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
789       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
790   }
791
792   for (GlobalValue &SGV : SrcM->aliases()) {
793     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
794       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
795   }
796
797   // Incorporate types by name, scanning all the types in the source module.
798   // At this point, the destination module may have a type "%foo = { i32 }" for
799   // example.  When the source module got loaded into the same LLVMContext, if
800   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
801   std::vector<StructType *> Types = SrcM->getIdentifiedStructTypes();
802   for (StructType *ST : Types) {
803     if (!ST->hasName())
804       continue;
805
806     // Check to see if there is a dot in the name followed by a digit.
807     size_t DotPos = ST->getName().rfind('.');
808     if (DotPos == 0 || DotPos == StringRef::npos ||
809         ST->getName().back() == '.' ||
810         !isdigit(static_cast<unsigned char>(ST->getName()[DotPos + 1])))
811       continue;
812
813     // Check to see if the destination module has a struct with the prefix name.
814     StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos));
815     if (!DST)
816       continue;
817
818     // Don't use it if this actually came from the source module. They're in
819     // the same LLVMContext after all. Also don't use it unless the type is
820     // actually used in the destination module. This can happen in situations
821     // like this:
822     //
823     //      Module A                         Module B
824     //      --------                         --------
825     //   %Z = type { %A }                %B = type { %C.1 }
826     //   %A = type { %B.1, [7 x i8] }    %C.1 = type { i8* }
827     //   %B.1 = type { %C }              %A.2 = type { %B.3, [5 x i8] }
828     //   %C = type { i8* }               %B.3 = type { %C.1 }
829     //
830     // When we link Module B with Module A, the '%B' in Module B is
831     // used. However, that would then use '%C.1'. But when we process '%C.1',
832     // we prefer to take the '%C' version. So we are then left with both
833     // '%C.1' and '%C' being used for the same types. This leads to some
834     // variables using one type and some using the other.
835     if (TypeMap.DstStructTypesSet.hasType(DST))
836       TypeMap.addTypeMapping(DST, ST);
837   }
838
839   // Now that we have discovered all of the type equivalences, get a body for
840   // any 'opaque' types in the dest module that are now resolved.
841   TypeMap.linkDefinedTypeBodies();
842 }
843
844 static void upgradeGlobalArray(GlobalVariable *GV) {
845   ArrayType *ATy = cast<ArrayType>(GV->getType()->getElementType());
846   StructType *OldTy = cast<StructType>(ATy->getElementType());
847   assert(OldTy->getNumElements() == 2 && "Expected to upgrade from 2 elements");
848
849   // Get the upgraded 3 element type.
850   PointerType *VoidPtrTy = Type::getInt8Ty(GV->getContext())->getPointerTo();
851   Type *Tys[3] = {OldTy->getElementType(0), OldTy->getElementType(1),
852                   VoidPtrTy};
853   StructType *NewTy = StructType::get(GV->getContext(), Tys, false);
854
855   // Build new constants with a null third field filled in.
856   Constant *OldInitC = GV->getInitializer();
857   ConstantArray *OldInit = dyn_cast<ConstantArray>(OldInitC);
858   if (!OldInit && !isa<ConstantAggregateZero>(OldInitC))
859     // Invalid initializer; give up.
860     return;
861   std::vector<Constant *> Initializers;
862   if (OldInit && OldInit->getNumOperands()) {
863     Value *Null = Constant::getNullValue(VoidPtrTy);
864     for (Use &U : OldInit->operands()) {
865       ConstantStruct *Init = cast<ConstantStruct>(U.get());
866       Initializers.push_back(ConstantStruct::get(
867           NewTy, Init->getOperand(0), Init->getOperand(1), Null, nullptr));
868     }
869   }
870   assert(Initializers.size() == ATy->getNumElements() &&
871          "Failed to copy all array elements");
872
873   // Replace the old GV with a new one.
874   ATy = ArrayType::get(NewTy, Initializers.size());
875   Constant *NewInit = ConstantArray::get(ATy, Initializers);
876   GlobalVariable *NewGV = new GlobalVariable(
877       *GV->getParent(), ATy, GV->isConstant(), GV->getLinkage(), NewInit, "",
878       GV, GV->getThreadLocalMode(), GV->getType()->getAddressSpace(),
879       GV->isExternallyInitialized());
880   NewGV->copyAttributesFrom(GV);
881   NewGV->takeName(GV);
882   assert(GV->use_empty() && "program cannot use initializer list");
883   GV->eraseFromParent();
884 }
885
886 void ModuleLinker::upgradeMismatchedGlobalArray(StringRef Name) {
887   // Look for the global arrays.
888   auto *DstGV = dyn_cast_or_null<GlobalVariable>(DstM->getNamedValue(Name));
889   if (!DstGV)
890     return;
891   auto *SrcGV = dyn_cast_or_null<GlobalVariable>(SrcM->getNamedValue(Name));
892   if (!SrcGV)
893     return;
894
895   // Check if the types already match.
896   auto *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
897   auto *SrcTy =
898       cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
899   if (DstTy == SrcTy)
900     return;
901
902   // Grab the element types.  We can only upgrade an array of a two-field
903   // struct.  Only bother if the other one has three-fields.
904   auto *DstEltTy = cast<StructType>(DstTy->getElementType());
905   auto *SrcEltTy = cast<StructType>(SrcTy->getElementType());
906   if (DstEltTy->getNumElements() == 2 && SrcEltTy->getNumElements() == 3) {
907     upgradeGlobalArray(DstGV);
908     return;
909   }
910   if (DstEltTy->getNumElements() == 3 && SrcEltTy->getNumElements() == 2)
911     upgradeGlobalArray(SrcGV);
912
913   // We can't upgrade any other differences.
914 }
915
916 void ModuleLinker::upgradeMismatchedGlobals() {
917   upgradeMismatchedGlobalArray("llvm.global_ctors");
918   upgradeMismatchedGlobalArray("llvm.global_dtors");
919 }
920
921 /// If there were any appending global variables, link them together now.
922 /// Return true on error.
923 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
924                                          const GlobalVariable *SrcGV) {
925
926   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
927     return emitError("Linking globals named '" + SrcGV->getName() +
928            "': can only link appending global with another appending global!");
929
930   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
931   ArrayType *SrcTy =
932     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
933   Type *EltTy = DstTy->getElementType();
934
935   // Check to see that they two arrays agree on type.
936   if (EltTy != SrcTy->getElementType())
937     return emitError("Appending variables with different element types!");
938   if (DstGV->isConstant() != SrcGV->isConstant())
939     return emitError("Appending variables linked with different const'ness!");
940
941   if (DstGV->getAlignment() != SrcGV->getAlignment())
942     return emitError(
943              "Appending variables with different alignment need to be linked!");
944
945   if (DstGV->getVisibility() != SrcGV->getVisibility())
946     return emitError(
947             "Appending variables with different visibility need to be linked!");
948
949   if (DstGV->hasUnnamedAddr() != SrcGV->hasUnnamedAddr())
950     return emitError(
951         "Appending variables with different unnamed_addr need to be linked!");
952
953   if (StringRef(DstGV->getSection()) != SrcGV->getSection())
954     return emitError(
955           "Appending variables with different section name need to be linked!");
956
957   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
958   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
959
960   // Create the new global variable.
961   GlobalVariable *NG =
962     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
963                        DstGV->getLinkage(), /*init*/nullptr, /*name*/"", DstGV,
964                        DstGV->getThreadLocalMode(),
965                        DstGV->getType()->getAddressSpace());
966
967   // Propagate alignment, visibility and section info.
968   copyGVAttributes(NG, DstGV);
969
970   AppendingVarInfo AVI;
971   AVI.NewGV = NG;
972   AVI.DstInit = DstGV->getInitializer();
973   AVI.SrcInit = SrcGV->getInitializer();
974   AppendingVars.push_back(AVI);
975
976   // Replace any uses of the two global variables with uses of the new
977   // global.
978   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
979
980   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
981   DstGV->eraseFromParent();
982
983   // Track the source variable so we don't try to link it.
984   DoNotLinkFromSource.insert(SrcGV);
985
986   return false;
987 }
988
989 bool ModuleLinker::linkGlobalValueProto(GlobalValue *SGV) {
990   GlobalValue *DGV = getLinkedToGlobal(SGV);
991
992   // Handle the ultra special appending linkage case first.
993   if (DGV && DGV->hasAppendingLinkage())
994     return linkAppendingVarProto(cast<GlobalVariable>(DGV),
995                                  cast<GlobalVariable>(SGV));
996
997   bool LinkFromSrc = true;
998   Comdat *C = nullptr;
999   GlobalValue::VisibilityTypes Visibility = SGV->getVisibility();
1000   bool HasUnnamedAddr = SGV->hasUnnamedAddr();
1001
1002   if (const Comdat *SC = SGV->getComdat()) {
1003     Comdat::SelectionKind SK;
1004     std::tie(SK, LinkFromSrc) = ComdatsChosen[SC];
1005     C = DstM->getOrInsertComdat(SC->getName());
1006     C->setSelectionKind(SK);
1007   } else if (DGV) {
1008     if (shouldLinkFromSource(LinkFromSrc, *DGV, *SGV))
1009       return true;
1010   }
1011
1012   if (!LinkFromSrc) {
1013     // Track the source global so that we don't attempt to copy it over when
1014     // processing global initializers.
1015     DoNotLinkFromSource.insert(SGV);
1016
1017     if (DGV)
1018       // Make sure to remember this mapping.
1019       ValueMap[SGV] =
1020           ConstantExpr::getBitCast(DGV, TypeMap.get(SGV->getType()));
1021   }
1022
1023   if (DGV) {
1024     Visibility = isLessConstraining(Visibility, DGV->getVisibility())
1025                      ? DGV->getVisibility()
1026                      : Visibility;
1027     HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr();
1028   }
1029
1030   if (!LinkFromSrc && !DGV)
1031     return false;
1032
1033   GlobalValue *NewGV;
1034   if (auto *SGVar = dyn_cast<GlobalVariable>(SGV)) {
1035     NewGV = linkGlobalVariableProto(SGVar, DGV, LinkFromSrc);
1036     if (!NewGV)
1037       return true;
1038   } else if (auto *SF = dyn_cast<Function>(SGV)) {
1039     NewGV = linkFunctionProto(SF, DGV, LinkFromSrc);
1040   } else {
1041     NewGV = linkGlobalAliasProto(cast<GlobalAlias>(SGV), DGV, LinkFromSrc);
1042   }
1043
1044   if (NewGV) {
1045     if (NewGV != DGV)
1046       copyGVAttributes(NewGV, SGV);
1047
1048     NewGV->setUnnamedAddr(HasUnnamedAddr);
1049     NewGV->setVisibility(Visibility);
1050
1051     if (auto *NewGO = dyn_cast<GlobalObject>(NewGV)) {
1052       if (C)
1053         NewGO->setComdat(C);
1054     }
1055
1056     // Make sure to remember this mapping.
1057     if (NewGV != DGV) {
1058       if (DGV) {
1059         DGV->replaceAllUsesWith(
1060             ConstantExpr::getBitCast(NewGV, DGV->getType()));
1061         DGV->eraseFromParent();
1062       }
1063       ValueMap[SGV] = NewGV;
1064     }
1065   }
1066
1067   return false;
1068 }
1069
1070 /// Loop through the global variables in the src module and merge them into the
1071 /// dest module.
1072 GlobalValue *ModuleLinker::linkGlobalVariableProto(const GlobalVariable *SGVar,
1073                                                    GlobalValue *DGV,
1074                                                    bool LinkFromSrc) {
1075   unsigned Alignment = 0;
1076   bool ClearConstant = false;
1077
1078   if (DGV) {
1079     if (DGV->hasCommonLinkage() && SGVar->hasCommonLinkage())
1080       Alignment = std::max(SGVar->getAlignment(), DGV->getAlignment());
1081
1082     auto *DGVar = dyn_cast<GlobalVariable>(DGV);
1083     if (!SGVar->isConstant() || (DGVar && !DGVar->isConstant()))
1084       ClearConstant = true;
1085   }
1086
1087   if (!LinkFromSrc) {
1088     if (auto *NewGVar = dyn_cast<GlobalVariable>(DGV)) {
1089       if (Alignment)
1090         NewGVar->setAlignment(Alignment);
1091       if (NewGVar->isDeclaration() && ClearConstant)
1092         NewGVar->setConstant(false);
1093     }
1094     return DGV;
1095   }
1096
1097   // No linking to be performed or linking from the source: simply create an
1098   // identical version of the symbol over in the dest module... the
1099   // initializer will be filled in later by LinkGlobalInits.
1100   GlobalVariable *NewDGV = new GlobalVariable(
1101       *DstM, TypeMap.get(SGVar->getType()->getElementType()),
1102       SGVar->isConstant(), SGVar->getLinkage(), /*init*/ nullptr,
1103       SGVar->getName(), /*insertbefore*/ nullptr, SGVar->getThreadLocalMode(),
1104       SGVar->getType()->getAddressSpace());
1105
1106   if (Alignment)
1107     NewDGV->setAlignment(Alignment);
1108
1109   return NewDGV;
1110 }
1111
1112 /// Link the function in the source module into the destination module if
1113 /// needed, setting up mapping information.
1114 GlobalValue *ModuleLinker::linkFunctionProto(const Function *SF,
1115                                              GlobalValue *DGV,
1116                                              bool LinkFromSrc) {
1117   if (!LinkFromSrc)
1118     return DGV;
1119
1120   // If the function is to be lazily linked, don't create it just yet.
1121   // The ValueMaterializerTy will deal with creating it if it's used.
1122   if (!DGV && (SF->hasLocalLinkage() || SF->hasLinkOnceLinkage() ||
1123                SF->hasAvailableExternallyLinkage())) {
1124     DoNotLinkFromSource.insert(SF);
1125     return nullptr;
1126   }
1127
1128   // If there is no linkage to be performed or we are linking from the source,
1129   // bring SF over.
1130   return Function::Create(TypeMap.get(SF->getFunctionType()), SF->getLinkage(),
1131                           SF->getName(), DstM);
1132 }
1133
1134 /// Set up prototypes for any aliases that come over from the source module.
1135 GlobalValue *ModuleLinker::linkGlobalAliasProto(const GlobalAlias *SGA,
1136                                                 GlobalValue *DGV,
1137                                                 bool LinkFromSrc) {
1138   if (!LinkFromSrc)
1139     return DGV;
1140
1141   // If there is no linkage to be performed or we're linking from the source,
1142   // bring over SGA.
1143   auto *PTy = cast<PointerType>(TypeMap.get(SGA->getType()));
1144   return GlobalAlias::create(PTy->getElementType(), PTy->getAddressSpace(),
1145                              SGA->getLinkage(), SGA->getName(), DstM);
1146 }
1147
1148 static void getArrayElements(const Constant *C,
1149                              SmallVectorImpl<Constant *> &Dest) {
1150   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
1151
1152   for (unsigned i = 0; i != NumElements; ++i)
1153     Dest.push_back(C->getAggregateElement(i));
1154 }
1155
1156 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
1157   // Merge the initializer.
1158   SmallVector<Constant *, 16> DstElements;
1159   getArrayElements(AVI.DstInit, DstElements);
1160
1161   SmallVector<Constant *, 16> SrcElements;
1162   getArrayElements(AVI.SrcInit, SrcElements);
1163
1164   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
1165
1166   StringRef Name = AVI.NewGV->getName();
1167   bool IsNewStructor =
1168       (Name == "llvm.global_ctors" || Name == "llvm.global_dtors") &&
1169       cast<StructType>(NewType->getElementType())->getNumElements() == 3;
1170
1171   for (auto *V : SrcElements) {
1172     if (IsNewStructor) {
1173       Constant *Key = V->getAggregateElement(2);
1174       if (DoNotLinkFromSource.count(Key))
1175         continue;
1176     }
1177     DstElements.push_back(
1178         MapValue(V, ValueMap, RF_None, &TypeMap, &ValMaterializer));
1179   }
1180   if (IsNewStructor) {
1181     NewType = ArrayType::get(NewType->getElementType(), DstElements.size());
1182     AVI.NewGV->mutateType(PointerType::get(NewType, 0));
1183   }
1184
1185   AVI.NewGV->setInitializer(ConstantArray::get(NewType, DstElements));
1186 }
1187
1188 /// Update the initializers in the Dest module now that all globals that may be
1189 /// referenced are in Dest.
1190 void ModuleLinker::linkGlobalInits() {
1191   // Loop over all of the globals in the src module, mapping them over as we go
1192   for (Module::const_global_iterator I = SrcM->global_begin(),
1193        E = SrcM->global_end(); I != E; ++I) {
1194
1195     // Only process initialized GV's or ones not already in dest.
1196     if (!I->hasInitializer() || DoNotLinkFromSource.count(I)) continue;
1197
1198     // Grab destination global variable.
1199     GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[I]);
1200     // Figure out what the initializer looks like in the dest module.
1201     DGV->setInitializer(MapValue(I->getInitializer(), ValueMap,
1202                                  RF_None, &TypeMap, &ValMaterializer));
1203   }
1204 }
1205
1206 /// Copy the source function over into the dest function and fix up references
1207 /// to values. At this point we know that Dest is an external function, and
1208 /// that Src is not.
1209 void ModuleLinker::linkFunctionBody(Function *Dst, Function *Src) {
1210   assert(Src && Dst && Dst->isDeclaration() && !Src->isDeclaration());
1211
1212   // Go through and convert function arguments over, remembering the mapping.
1213   Function::arg_iterator DI = Dst->arg_begin();
1214   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
1215        I != E; ++I, ++DI) {
1216     DI->setName(I->getName());  // Copy the name over.
1217
1218     // Add a mapping to our mapping.
1219     ValueMap[I] = DI;
1220   }
1221
1222   // Splice the body of the source function into the dest function.
1223   Dst->getBasicBlockList().splice(Dst->end(), Src->getBasicBlockList());
1224
1225   // At this point, all of the instructions and values of the function are now
1226   // copied over.  The only problem is that they are still referencing values in
1227   // the Source function as operands.  Loop through all of the operands of the
1228   // functions and patch them up to point to the local versions.
1229   for (Function::iterator BB = Dst->begin(), BE = Dst->end(); BB != BE; ++BB)
1230     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1231       RemapInstruction(I, ValueMap, RF_IgnoreMissingEntries, &TypeMap,
1232                        &ValMaterializer);
1233
1234   // There is no need to map the arguments anymore.
1235   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
1236        I != E; ++I)
1237     ValueMap.erase(I);
1238
1239 }
1240
1241 /// Insert all of the aliases in Src into the Dest module.
1242 void ModuleLinker::linkAliasBodies() {
1243   for (Module::alias_iterator I = SrcM->alias_begin(), E = SrcM->alias_end();
1244        I != E; ++I) {
1245     if (DoNotLinkFromSource.count(I))
1246       continue;
1247     if (Constant *Aliasee = I->getAliasee()) {
1248       GlobalAlias *DA = cast<GlobalAlias>(ValueMap[I]);
1249       Constant *Val =
1250           MapValue(Aliasee, ValueMap, RF_None, &TypeMap, &ValMaterializer);
1251       DA->setAliasee(Val);
1252     }
1253   }
1254 }
1255
1256 /// Insert all of the named MDNodes in Src into the Dest module.
1257 void ModuleLinker::linkNamedMDNodes() {
1258   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1259   for (Module::const_named_metadata_iterator I = SrcM->named_metadata_begin(),
1260        E = SrcM->named_metadata_end(); I != E; ++I) {
1261     // Don't link module flags here. Do them separately.
1262     if (&*I == SrcModFlags) continue;
1263     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(I->getName());
1264     // Add Src elements into Dest node.
1265     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1266       DestNMD->addOperand(MapValue(I->getOperand(i), ValueMap,
1267                                    RF_None, &TypeMap, &ValMaterializer));
1268   }
1269 }
1270
1271 /// Merge the linker flags in Src into the Dest module.
1272 bool ModuleLinker::linkModuleFlagsMetadata() {
1273   // If the source module has no module flags, we are done.
1274   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1275   if (!SrcModFlags) return false;
1276
1277   // If the destination module doesn't have module flags yet, then just copy
1278   // over the source module's flags.
1279   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
1280   if (DstModFlags->getNumOperands() == 0) {
1281     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
1282       DstModFlags->addOperand(SrcModFlags->getOperand(I));
1283
1284     return false;
1285   }
1286
1287   // First build a map of the existing module flags and requirements.
1288   DenseMap<MDString*, MDNode*> Flags;
1289   SmallSetVector<MDNode*, 16> Requirements;
1290   for (unsigned I = 0, E = DstModFlags->getNumOperands(); I != E; ++I) {
1291     MDNode *Op = DstModFlags->getOperand(I);
1292     ConstantInt *Behavior = cast<ConstantInt>(Op->getOperand(0));
1293     MDString *ID = cast<MDString>(Op->getOperand(1));
1294
1295     if (Behavior->getZExtValue() == Module::Require) {
1296       Requirements.insert(cast<MDNode>(Op->getOperand(2)));
1297     } else {
1298       Flags[ID] = Op;
1299     }
1300   }
1301
1302   // Merge in the flags from the source module, and also collect its set of
1303   // requirements.
1304   bool HasErr = false;
1305   for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) {
1306     MDNode *SrcOp = SrcModFlags->getOperand(I);
1307     ConstantInt *SrcBehavior = cast<ConstantInt>(SrcOp->getOperand(0));
1308     MDString *ID = cast<MDString>(SrcOp->getOperand(1));
1309     MDNode *DstOp = Flags.lookup(ID);
1310     unsigned SrcBehaviorValue = SrcBehavior->getZExtValue();
1311
1312     // If this is a requirement, add it and continue.
1313     if (SrcBehaviorValue == Module::Require) {
1314       // If the destination module does not already have this requirement, add
1315       // it.
1316       if (Requirements.insert(cast<MDNode>(SrcOp->getOperand(2)))) {
1317         DstModFlags->addOperand(SrcOp);
1318       }
1319       continue;
1320     }
1321
1322     // If there is no existing flag with this ID, just add it.
1323     if (!DstOp) {
1324       Flags[ID] = SrcOp;
1325       DstModFlags->addOperand(SrcOp);
1326       continue;
1327     }
1328
1329     // Otherwise, perform a merge.
1330     ConstantInt *DstBehavior = cast<ConstantInt>(DstOp->getOperand(0));
1331     unsigned DstBehaviorValue = DstBehavior->getZExtValue();
1332
1333     // If either flag has override behavior, handle it first.
1334     if (DstBehaviorValue == Module::Override) {
1335       // Diagnose inconsistent flags which both have override behavior.
1336       if (SrcBehaviorValue == Module::Override &&
1337           SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1338         HasErr |= emitError("linking module flags '" + ID->getString() +
1339                             "': IDs have conflicting override values");
1340       }
1341       continue;
1342     } else if (SrcBehaviorValue == Module::Override) {
1343       // Update the destination flag to that of the source.
1344       DstOp->replaceOperandWith(0, SrcBehavior);
1345       DstOp->replaceOperandWith(2, SrcOp->getOperand(2));
1346       continue;
1347     }
1348
1349     // Diagnose inconsistent merge behavior types.
1350     if (SrcBehaviorValue != DstBehaviorValue) {
1351       HasErr |= emitError("linking module flags '" + ID->getString() +
1352                           "': IDs have conflicting behaviors");
1353       continue;
1354     }
1355
1356     // Perform the merge for standard behavior types.
1357     switch (SrcBehaviorValue) {
1358     case Module::Require:
1359     case Module::Override: llvm_unreachable("not possible");
1360     case Module::Error: {
1361       // Emit an error if the values differ.
1362       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1363         HasErr |= emitError("linking module flags '" + ID->getString() +
1364                             "': IDs have conflicting values");
1365       }
1366       continue;
1367     }
1368     case Module::Warning: {
1369       // Emit a warning if the values differ.
1370       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1371         emitWarning("linking module flags '" + ID->getString() +
1372                     "': IDs have conflicting values");
1373       }
1374       continue;
1375     }
1376     case Module::Append: {
1377       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1378       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1379       unsigned NumOps = DstValue->getNumOperands() + SrcValue->getNumOperands();
1380       Value **VP, **Values = VP = new Value*[NumOps];
1381       for (unsigned i = 0, e = DstValue->getNumOperands(); i != e; ++i, ++VP)
1382         *VP = DstValue->getOperand(i);
1383       for (unsigned i = 0, e = SrcValue->getNumOperands(); i != e; ++i, ++VP)
1384         *VP = SrcValue->getOperand(i);
1385       DstOp->replaceOperandWith(2, MDNode::get(DstM->getContext(),
1386                                                ArrayRef<Value*>(Values,
1387                                                                 NumOps)));
1388       delete[] Values;
1389       break;
1390     }
1391     case Module::AppendUnique: {
1392       SmallSetVector<Value*, 16> Elts;
1393       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1394       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1395       for (unsigned i = 0, e = DstValue->getNumOperands(); i != e; ++i)
1396         Elts.insert(DstValue->getOperand(i));
1397       for (unsigned i = 0, e = SrcValue->getNumOperands(); i != e; ++i)
1398         Elts.insert(SrcValue->getOperand(i));
1399       DstOp->replaceOperandWith(2, MDNode::get(DstM->getContext(),
1400                                                ArrayRef<Value*>(Elts.begin(),
1401                                                                 Elts.end())));
1402       break;
1403     }
1404     }
1405   }
1406
1407   // Check all of the requirements.
1408   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1409     MDNode *Requirement = Requirements[I];
1410     MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1411     Value *ReqValue = Requirement->getOperand(1);
1412
1413     MDNode *Op = Flags[Flag];
1414     if (!Op || Op->getOperand(2) != ReqValue) {
1415       HasErr |= emitError("linking module flags '" + Flag->getString() +
1416                           "': does not have the required value");
1417       continue;
1418     }
1419   }
1420
1421   return HasErr;
1422 }
1423
1424 bool ModuleLinker::run() {
1425   assert(DstM && "Null destination module");
1426   assert(SrcM && "Null source module");
1427
1428   // Inherit the target data from the source module if the destination module
1429   // doesn't have one already.
1430   if (!DstM->getDataLayout() && SrcM->getDataLayout())
1431     DstM->setDataLayout(SrcM->getDataLayout());
1432
1433   // Copy the target triple from the source to dest if the dest's is empty.
1434   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1435     DstM->setTargetTriple(SrcM->getTargetTriple());
1436
1437   if (SrcM->getDataLayout() && DstM->getDataLayout() &&
1438       *SrcM->getDataLayout() != *DstM->getDataLayout()) {
1439     emitWarning("Linking two modules of different data layouts: '" +
1440                 SrcM->getModuleIdentifier() + "' is '" +
1441                 SrcM->getDataLayoutStr() + "' whereas '" +
1442                 DstM->getModuleIdentifier() + "' is '" +
1443                 DstM->getDataLayoutStr() + "'\n");
1444   }
1445   if (!SrcM->getTargetTriple().empty() &&
1446       DstM->getTargetTriple() != SrcM->getTargetTriple()) {
1447     emitWarning("Linking two modules of different target triples: " +
1448                 SrcM->getModuleIdentifier() + "' is '" +
1449                 SrcM->getTargetTriple() + "' whereas '" +
1450                 DstM->getModuleIdentifier() + "' is '" +
1451                 DstM->getTargetTriple() + "'\n");
1452   }
1453
1454   // Append the module inline asm string.
1455   if (!SrcM->getModuleInlineAsm().empty()) {
1456     if (DstM->getModuleInlineAsm().empty())
1457       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1458     else
1459       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1460                                SrcM->getModuleInlineAsm());
1461   }
1462
1463   // Loop over all of the linked values to compute type mappings.
1464   computeTypeMapping();
1465
1466   ComdatsChosen.clear();
1467   for (const auto &SMEC : SrcM->getComdatSymbolTable()) {
1468     const Comdat &C = SMEC.getValue();
1469     if (ComdatsChosen.count(&C))
1470       continue;
1471     Comdat::SelectionKind SK;
1472     bool LinkFromSrc;
1473     if (getComdatResult(&C, SK, LinkFromSrc))
1474       return true;
1475     ComdatsChosen[&C] = std::make_pair(SK, LinkFromSrc);
1476   }
1477
1478   // Upgrade mismatched global arrays.
1479   upgradeMismatchedGlobals();
1480
1481   // Insert all of the globals in src into the DstM module... without linking
1482   // initializers (which could refer to functions not yet mapped over).
1483   for (Module::global_iterator I = SrcM->global_begin(),
1484        E = SrcM->global_end(); I != E; ++I)
1485     if (linkGlobalValueProto(I))
1486       return true;
1487
1488   // Link the functions together between the two modules, without doing function
1489   // bodies... this just adds external function prototypes to the DstM
1490   // function...  We do this so that when we begin processing function bodies,
1491   // all of the global values that may be referenced are available in our
1492   // ValueMap.
1493   for (Module::iterator I = SrcM->begin(), E = SrcM->end(); I != E; ++I)
1494     if (linkGlobalValueProto(I))
1495       return true;
1496
1497   // If there were any aliases, link them now.
1498   for (Module::alias_iterator I = SrcM->alias_begin(),
1499        E = SrcM->alias_end(); I != E; ++I)
1500     if (linkGlobalValueProto(I))
1501       return true;
1502
1503   for (unsigned i = 0, e = AppendingVars.size(); i != e; ++i)
1504     linkAppendingVarInit(AppendingVars[i]);
1505
1506   // Link in the function bodies that are defined in the source module into
1507   // DstM.
1508   for (Module::iterator SF = SrcM->begin(), E = SrcM->end(); SF != E; ++SF) {
1509     // Skip if not linking from source.
1510     if (DoNotLinkFromSource.count(SF)) continue;
1511
1512     Function *DF = cast<Function>(ValueMap[SF]);
1513
1514     // Link in the prefix data.
1515     if (SF->hasPrefixData())
1516       DF->setPrefixData(MapValue(
1517           SF->getPrefixData(), ValueMap, RF_None, &TypeMap, &ValMaterializer));
1518
1519     // Link in the prologue data.
1520     if (SF->hasPrologueData())
1521       DF->setPrologueData(MapValue(
1522           SF->getPrologueData(), ValueMap, RF_None, &TypeMap, &ValMaterializer));
1523
1524     // Materialize if needed.
1525     if (std::error_code EC = SF->materialize())
1526       return emitError(EC.message());
1527
1528     // Skip if no body (function is external).
1529     if (SF->isDeclaration())
1530       continue;
1531
1532     linkFunctionBody(DF, SF);
1533     SF->Dematerialize();
1534   }
1535
1536   // Resolve all uses of aliases with aliasees.
1537   linkAliasBodies();
1538
1539   // Remap all of the named MDNodes in Src into the DstM module. We do this
1540   // after linking GlobalValues so that MDNodes that reference GlobalValues
1541   // are properly remapped.
1542   linkNamedMDNodes();
1543
1544   // Merge the module flags into the DstM module.
1545   if (linkModuleFlagsMetadata())
1546     return true;
1547
1548   // Update the initializers in the DstM module now that all globals that may
1549   // be referenced are in DstM.
1550   linkGlobalInits();
1551
1552   // Process vector of lazily linked in functions.
1553   bool LinkedInAnyFunctions;
1554   do {
1555     LinkedInAnyFunctions = false;
1556
1557     for(std::vector<Function*>::iterator I = LazilyLinkFunctions.begin(),
1558         E = LazilyLinkFunctions.end(); I != E; ++I) {
1559       Function *SF = *I;
1560       if (!SF)
1561         continue;
1562
1563       Function *DF = cast<Function>(ValueMap[SF]);
1564       if (SF->hasPrefixData()) {
1565         // Link in the prefix data.
1566         DF->setPrefixData(MapValue(SF->getPrefixData(),
1567                                    ValueMap,
1568                                    RF_None,
1569                                    &TypeMap,
1570                                    &ValMaterializer));
1571       }
1572
1573       // Materialize if needed.
1574       if (std::error_code EC = SF->materialize())
1575         return emitError(EC.message());
1576
1577       // Skip if no body (function is external).
1578       if (SF->isDeclaration())
1579         continue;
1580
1581       // Erase from vector *before* the function body is linked - linkFunctionBody could
1582       // invalidate I.
1583       LazilyLinkFunctions.erase(I);
1584
1585       // Link in function body.
1586       linkFunctionBody(DF, SF);
1587       SF->Dematerialize();
1588
1589       // Set flag to indicate we may have more functions to lazily link in
1590       // since we linked in a function.
1591       LinkedInAnyFunctions = true;
1592       break;
1593     }
1594   } while (LinkedInAnyFunctions);
1595
1596   return false;
1597 }
1598
1599 Linker::StructTypeKeyInfo::KeyTy::KeyTy(ArrayRef<Type *> E, bool P)
1600     : ETypes(E), IsPacked(P) {}
1601
1602 Linker::StructTypeKeyInfo::KeyTy::KeyTy(const StructType *ST)
1603     : ETypes(ST->elements()), IsPacked(ST->isPacked()) {}
1604
1605 bool Linker::StructTypeKeyInfo::KeyTy::operator==(const KeyTy &That) const {
1606   if (IsPacked != That.IsPacked)
1607     return false;
1608   if (ETypes != That.ETypes)
1609     return false;
1610   return true;
1611 }
1612
1613 bool Linker::StructTypeKeyInfo::KeyTy::operator!=(const KeyTy &That) const {
1614   return !this->operator==(That);
1615 }
1616
1617 StructType *Linker::StructTypeKeyInfo::getEmptyKey() {
1618   return DenseMapInfo<StructType *>::getEmptyKey();
1619 }
1620
1621 StructType *Linker::StructTypeKeyInfo::getTombstoneKey() {
1622   return DenseMapInfo<StructType *>::getTombstoneKey();
1623 }
1624
1625 unsigned Linker::StructTypeKeyInfo::getHashValue(const KeyTy &Key) {
1626   return hash_combine(hash_combine_range(Key.ETypes.begin(), Key.ETypes.end()),
1627                       Key.IsPacked);
1628 }
1629
1630 unsigned Linker::StructTypeKeyInfo::getHashValue(const StructType *ST) {
1631   return getHashValue(KeyTy(ST));
1632 }
1633
1634 bool Linker::StructTypeKeyInfo::isEqual(const KeyTy &LHS,
1635                                         const StructType *RHS) {
1636   if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1637     return false;
1638   return LHS == KeyTy(RHS);
1639 }
1640
1641 bool Linker::StructTypeKeyInfo::isEqual(const StructType *LHS,
1642                                         const StructType *RHS) {
1643   if (RHS == getEmptyKey())
1644     return LHS == getEmptyKey();
1645
1646   if (RHS == getTombstoneKey())
1647     return LHS == getTombstoneKey();
1648
1649   return KeyTy(LHS) == KeyTy(RHS);
1650 }
1651
1652 void Linker::IdentifiedStructTypeSet::addNonOpaque(StructType *Ty) {
1653   assert(!Ty->isOpaque());
1654   bool &Entry = NonOpaqueStructTypes[Ty];
1655   Entry = true;
1656 }
1657
1658 void Linker::IdentifiedStructTypeSet::addOpaque(StructType *Ty) {
1659   assert(Ty->isOpaque());
1660   OpaqueStructTypes.insert(Ty);
1661 }
1662
1663 StructType *
1664 Linker::IdentifiedStructTypeSet::findNonOpaque(ArrayRef<Type *> ETypes,
1665                                                bool IsPacked) {
1666   Linker::StructTypeKeyInfo::KeyTy Key(ETypes, IsPacked);
1667   auto I = NonOpaqueStructTypes.find_as(Key);
1668   if (I == NonOpaqueStructTypes.end())
1669     return nullptr;
1670   return I->first;
1671 }
1672
1673 bool Linker::IdentifiedStructTypeSet::hasType(StructType *Ty) {
1674   if (Ty->isOpaque())
1675     return OpaqueStructTypes.count(Ty);
1676   auto I = NonOpaqueStructTypes.find(Ty);
1677   if (I == NonOpaqueStructTypes.end())
1678     return false;
1679   return I->first == Ty;
1680 }
1681
1682 void Linker::init(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
1683   this->Composite = M;
1684   this->DiagnosticHandler = DiagnosticHandler;
1685
1686   TypeFinder StructTypes;
1687   StructTypes.run(*M, true);
1688   for (StructType *Ty : StructTypes) {
1689     if (Ty->isOpaque())
1690       IdentifiedStructTypes.addOpaque(Ty);
1691     else
1692       IdentifiedStructTypes.addNonOpaque(Ty);
1693   }
1694 }
1695
1696 Linker::Linker(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
1697   init(M, DiagnosticHandler);
1698 }
1699
1700 Linker::Linker(Module *M) {
1701   init(M, [this](const DiagnosticInfo &DI) {
1702     Composite->getContext().diagnose(DI);
1703   });
1704 }
1705
1706 Linker::~Linker() {
1707 }
1708
1709 void Linker::deleteModule() {
1710   delete Composite;
1711   Composite = nullptr;
1712 }
1713
1714 bool Linker::linkInModule(Module *Src) {
1715   ModuleLinker TheLinker(Composite, IdentifiedStructTypes, Src,
1716                          DiagnosticHandler);
1717   return TheLinker.run();
1718 }
1719
1720 //===----------------------------------------------------------------------===//
1721 // LinkModules entrypoint.
1722 //===----------------------------------------------------------------------===//
1723
1724 /// This function links two modules together, with the resulting Dest module
1725 /// modified to be the composite of the two input modules. If an error occurs,
1726 /// true is returned and ErrorMsg (if not null) is set to indicate the problem.
1727 /// Upon failure, the Dest module could be in a modified state, and shouldn't be
1728 /// relied on to be consistent.
1729 bool Linker::LinkModules(Module *Dest, Module *Src,
1730                          DiagnosticHandlerFunction DiagnosticHandler) {
1731   Linker L(Dest, DiagnosticHandler);
1732   return L.linkInModule(Src);
1733 }
1734
1735 bool Linker::LinkModules(Module *Dest, Module *Src) {
1736   Linker L(Dest);
1737   return L.linkInModule(Src);
1738 }
1739
1740 //===----------------------------------------------------------------------===//
1741 // C API.
1742 //===----------------------------------------------------------------------===//
1743
1744 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
1745                          LLVMLinkerMode Mode, char **OutMessages) {
1746   Module *D = unwrap(Dest);
1747   std::string Message;
1748   raw_string_ostream Stream(Message);
1749   DiagnosticPrinterRawOStream DP(Stream);
1750
1751   LLVMBool Result = Linker::LinkModules(
1752       D, unwrap(Src), [&](const DiagnosticInfo &DI) { DI.print(DP); });
1753
1754   if (OutMessages && Result)
1755     *OutMessages = strdup(Message.c_str());
1756   return Result;
1757 }