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 // Specifically, this:
  13 //  * Merges global variables between the two modules
  14 //    * Uninit + Uninit = Init, Init + Uninit = Init, Init + Init = Error if !=
  15 //  * Merges functions between two modules
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/Linker.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/LLVMContext.h"
  23 #include "llvm/Module.h"
  24 #include "llvm/TypeSymbolTable.h"
  25 #include "llvm/ValueSymbolTable.h"
  26 #include "llvm/Instructions.h"
  27 #include "llvm/Assembly/Writer.h"
  28 #include "llvm/Support/Streams.h"
  29 #include "llvm/System/Path.h"
  30 #include "llvm/ADT/DenseMap.h"
  31 #include <sstream>
  32 using namespace llvm;
  33
  34 // Error - Simple wrapper function to conditionally assign to E and return true.
  35 // This just makes error return conditions a little bit simpler...
  36 static inline bool Error(std::string *E, const std::string &Message) {
  37   if (E) *E = Message;
  38   return true;
  39 }
  40
  41 // Function: ResolveTypes()
  42 //
  43 // Description:
  44 //  Attempt to link the two specified types together.
  45 //
  46 // Inputs:
  47 //  DestTy - The type to which we wish to resolve.
  48 //  SrcTy  - The original type which we want to resolve.
  49 //
  50 // Outputs:
  51 //  DestST - The symbol table in which the new type should be placed.
  52 //
  53 // Return value:
  54 //  true  - There is an error and the types cannot yet be linked.
  55 //  false - No errors.
  56 //
  57 static bool ResolveTypes(const Type *DestTy, const Type *SrcTy) {
  58   if (DestTy == SrcTy) return false;       // If already equal, noop
  59   assert(DestTy && SrcTy && "Can't handle null types");
  60
  61   if (const OpaqueType *OT = dyn_cast<OpaqueType>(DestTy)) {
  62     // Type _is_ in module, just opaque...
  63     const_cast<OpaqueType*>(OT)->refineAbstractTypeTo(SrcTy);
  64   } else if (const OpaqueType *OT = dyn_cast<OpaqueType>(SrcTy)) {
  65     const_cast<OpaqueType*>(OT)->refineAbstractTypeTo(DestTy);
  66   } else {
  67     return true;  // Cannot link types... not-equal and neither is opaque.
  68   }
  69   return false;
  70 }
  71
  72 /// LinkerTypeMap - This implements a map of types that is stable
  73 /// even if types are resolved/refined to other types.  This is not a general
  74 /// purpose map, it is specific to the linker's use.
  75 namespace {
  76 class LinkerTypeMap : public AbstractTypeUser {
  77   typedef DenseMap<const Type*, PATypeHolder> TheMapTy;
  78   TheMapTy TheMap;
  79
  80   LinkerTypeMap(const LinkerTypeMap&); // DO NOT IMPLEMENT
  81   void operator=(const LinkerTypeMap&); // DO NOT IMPLEMENT
  82 public:
  83   LinkerTypeMap() {}
  84   ~LinkerTypeMap() {
  85     for (DenseMap<const Type*, PATypeHolder>::iterator I = TheMap.begin(),
  86          E = TheMap.end(); I != E; ++I)
  87       I->first->removeAbstractTypeUser(this);
  88   }
  89
  90   /// lookup - Return the value for the specified type or null if it doesn't
  91   /// exist.
  92   const Type *lookup(const Type *Ty) const {
  93     TheMapTy::const_iterator I = TheMap.find(Ty);
  94     if (I != TheMap.end()) return I->second;
  95     return 0;
  96   }
  97
  98   /// erase - Remove the specified type, returning true if it was in the set.
  99   bool erase(const Type *Ty) {
 100     if (!TheMap.erase(Ty))
 101       return false;
 102     if (Ty->isAbstract())
 103       Ty->removeAbstractTypeUser(this);
 104     return true;
 105   }
 106
 107   /// insert - This returns true if the pointer was new to the set, false if it
 108   /// was already in the set.
 109   bool insert(const Type *Src, const Type *Dst) {
 110     if (!TheMap.insert(std::make_pair(Src, PATypeHolder(Dst))).second)
 111       return false;  // Already in map.
 112     if (Src->isAbstract())
 113       Src->addAbstractTypeUser(this);
 114     return true;
 115   }
 116
 117 protected:
 118   /// refineAbstractType - The callback method invoked when an abstract type is
 119   /// resolved to another type.  An object must override this method to update
 120   /// its internal state to reference NewType instead of OldType.
 121   ///
 122   virtual void refineAbstractType(const DerivedType *OldTy,
 123                                   const Type *NewTy) {
 124     TheMapTy::iterator I = TheMap.find(OldTy);
 125     const Type *DstTy = I->second;
 126
 127     TheMap.erase(I);
 128     if (OldTy->isAbstract())
 129       OldTy->removeAbstractTypeUser(this);
 130
 131     // Don't reinsert into the map if the key is concrete now.
 132     if (NewTy->isAbstract())
 133       insert(NewTy, DstTy);
 134   }
 135
 136   /// The other case which AbstractTypeUsers must be aware of is when a type
 137   /// makes the transition from being abstract (where it has clients on it's
 138   /// AbstractTypeUsers list) to concrete (where it does not).  This method
 139   /// notifies ATU's when this occurs for a type.
 140   virtual void typeBecameConcrete(const DerivedType *AbsTy) {
 141     TheMap.erase(AbsTy);
 142     AbsTy->removeAbstractTypeUser(this);
 143   }
 144
 145   // for debugging...
 146   virtual void dump() const {
 147     cerr << "AbstractTypeSet!\n";
 148   }
 149 };
 150 }
 151
 152
 153 // RecursiveResolveTypes - This is just like ResolveTypes, except that it
 154 // recurses down into derived types, merging the used types if the parent types
 155 // are compatible.
 156 static bool RecursiveResolveTypesI(const Type *DstTy, const Type *SrcTy,
 157                                    LinkerTypeMap &Pointers) {
 158   if (DstTy == SrcTy) return false;       // If already equal, noop
 159
 160   // If we found our opaque type, resolve it now!
 161   if (isa<OpaqueType>(DstTy) || isa<OpaqueType>(SrcTy))
 162     return ResolveTypes(DstTy, SrcTy);
 163
 164   // Two types cannot be resolved together if they are of different primitive
 165   // type.  For example, we cannot resolve an int to a float.
 166   if (DstTy->getTypeID() != SrcTy->getTypeID()) return true;
 167
 168   // If neither type is abstract, then they really are just different types.
 169   if (!DstTy->isAbstract() && !SrcTy->isAbstract())
 170     return true;
 171
 172   // Otherwise, resolve the used type used by this derived type...
 173   switch (DstTy->getTypeID()) {
 174   default:
 175     return true;
 176   case Type::FunctionTyID: {
 177     const FunctionType *DstFT = cast<FunctionType>(DstTy);
 178     const FunctionType *SrcFT = cast<FunctionType>(SrcTy);
 179     if (DstFT->isVarArg() != SrcFT->isVarArg() ||
 180         DstFT->getNumContainedTypes() != SrcFT->getNumContainedTypes())
 181       return true;
 182
 183     // Use TypeHolder's so recursive resolution won't break us.
 184     PATypeHolder ST(SrcFT), DT(DstFT);
 185     for (unsigned i = 0, e = DstFT->getNumContainedTypes(); i != e; ++i) {
 186       const Type *SE = ST->getContainedType(i), *DE = DT->getContainedType(i);
 187       if (SE != DE && RecursiveResolveTypesI(DE, SE, Pointers))
 188         return true;
 189     }
 190     return false;
 191   }
 192   case Type::StructTyID: {
 193     const StructType *DstST = cast<StructType>(DstTy);
 194     const StructType *SrcST = cast<StructType>(SrcTy);
 195     if (DstST->getNumContainedTypes() != SrcST->getNumContainedTypes())
 196       return true;
 197
 198     PATypeHolder ST(SrcST), DT(DstST);
 199     for (unsigned i = 0, e = DstST->getNumContainedTypes(); i != e; ++i) {
 200       const Type *SE = ST->getContainedType(i), *DE = DT->getContainedType(i);
 201       if (SE != DE && RecursiveResolveTypesI(DE, SE, Pointers))
 202         return true;
 203     }
 204     return false;
 205   }
 206   case Type::ArrayTyID: {
 207     const ArrayType *DAT = cast<ArrayType>(DstTy);
 208     const ArrayType *SAT = cast<ArrayType>(SrcTy);
 209     if (DAT->getNumElements() != SAT->getNumElements()) return true;
 210     return RecursiveResolveTypesI(DAT->getElementType(), SAT->getElementType(),
 211                                   Pointers);
 212   }
 213   case Type::VectorTyID: {
 214     const VectorType *DVT = cast<VectorType>(DstTy);
 215     const VectorType *SVT = cast<VectorType>(SrcTy);
 216     if (DVT->getNumElements() != SVT->getNumElements()) return true;
 217     return RecursiveResolveTypesI(DVT->getElementType(), SVT->getElementType(),
 218                                   Pointers);
 219   }
 220   case Type::PointerTyID: {
 221     const PointerType *DstPT = cast<PointerType>(DstTy);
 222     const PointerType *SrcPT = cast<PointerType>(SrcTy);
 223
 224     if (DstPT->getAddressSpace() != SrcPT->getAddressSpace())
 225       return true;
 226
 227     // If this is a pointer type, check to see if we have already seen it.  If
 228     // so, we are in a recursive branch.  Cut off the search now.  We cannot use
 229     // an associative container for this search, because the type pointers (keys
 230     // in the container) change whenever types get resolved.
 231     if (SrcPT->isAbstract())
 232       if (const Type *ExistingDestTy = Pointers.lookup(SrcPT))
 233         return ExistingDestTy != DstPT;
 234
 235     if (DstPT->isAbstract())
 236       if (const Type *ExistingSrcTy = Pointers.lookup(DstPT))
 237         return ExistingSrcTy != SrcPT;
 238     // Otherwise, add the current pointers to the vector to stop recursion on
 239     // this pair.
 240     if (DstPT->isAbstract())
 241       Pointers.insert(DstPT, SrcPT);
 242     if (SrcPT->isAbstract())
 243       Pointers.insert(SrcPT, DstPT);
 244
 245     return RecursiveResolveTypesI(DstPT->getElementType(),
 246                                   SrcPT->getElementType(), Pointers);
 247   }
 248   }
 249 }
 250
 251 static bool RecursiveResolveTypes(const Type *DestTy, const Type *SrcTy) {
 252   LinkerTypeMap PointerTypes;
 253   return RecursiveResolveTypesI(DestTy, SrcTy, PointerTypes);
 254 }
 255
 256
 257 // LinkTypes - Go through the symbol table of the Src module and see if any
 258 // types are named in the src module that are not named in the Dst module.
 259 // Make sure there are no type name conflicts.
 260 static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
 261         TypeSymbolTable *DestST = &Dest->getTypeSymbolTable();
 262   const TypeSymbolTable *SrcST  = &Src->getTypeSymbolTable();
 263
 264   // Look for a type plane for Type's...
 265   TypeSymbolTable::const_iterator TI = SrcST->begin();
 266   TypeSymbolTable::const_iterator TE = SrcST->end();
 267   if (TI == TE) return false;  // No named types, do nothing.
 268
 269   // Some types cannot be resolved immediately because they depend on other
 270   // types being resolved to each other first.  This contains a list of types we
 271   // are waiting to recheck.
 272   std::vector<std::string> DelayedTypesToResolve;
 273
 274   for ( ; TI != TE; ++TI ) {
 275     const std::string &Name = TI->first;
 276     const Type *RHS = TI->second;
 277
 278     // Check to see if this type name is already in the dest module.
 279     Type *Entry = DestST->lookup(Name);
 280
 281     // If the name is just in the source module, bring it over to the dest.
 282     if (Entry == 0) {
 283       if (!Name.empty())
 284         DestST->insert(Name, const_cast<Type*>(RHS));
 285     } else if (ResolveTypes(Entry, RHS)) {
 286       // They look different, save the types 'till later to resolve.
 287       DelayedTypesToResolve.push_back(Name);
 288     }
 289   }
 290
 291   // Iteratively resolve types while we can...
 292   while (!DelayedTypesToResolve.empty()) {
 293     // Loop over all of the types, attempting to resolve them if possible...
 294     unsigned OldSize = DelayedTypesToResolve.size();
 295
 296     // Try direct resolution by name...
 297     for (unsigned i = 0; i != DelayedTypesToResolve.size(); ++i) {
 298       const std::string &Name = DelayedTypesToResolve[i];
 299       Type *T1 = SrcST->lookup(Name);
 300       Type *T2 = DestST->lookup(Name);
 301       if (!ResolveTypes(T2, T1)) {
 302         // We are making progress!
 303         DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
 304         --i;
 305       }
 306     }
 307
 308     // Did we not eliminate any types?
 309     if (DelayedTypesToResolve.size() == OldSize) {
 310       // Attempt to resolve subelements of types.  This allows us to merge these
 311       // two types: { int* } and { opaque* }
 312       for (unsigned i = 0, e = DelayedTypesToResolve.size(); i != e; ++i) {
 313         const std::string &Name = DelayedTypesToResolve[i];
 314         if (!RecursiveResolveTypes(SrcST->lookup(Name), DestST->lookup(Name))) {
 315           // We are making progress!
 316           DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
 317
 318           // Go back to the main loop, perhaps we can resolve directly by name
 319           // now...
 320           break;
 321         }
 322       }
 323
 324       // If we STILL cannot resolve the types, then there is something wrong.
 325       if (DelayedTypesToResolve.size() == OldSize) {
 326         // Remove the symbol name from the destination.
 327         DelayedTypesToResolve.pop_back();
 328       }
 329     }
 330   }
 331
 332
 333   return false;
 334 }
 335
 336 #ifndef NDEBUG
 337 static void PrintMap(const std::map<const Value*, Value*> &M) {
 338   for (std::map<const Value*, Value*>::const_iterator I = M.begin(), E =M.end();
 339        I != E; ++I) {
 340     cerr << " Fr: " << (void*)I->first << " ";
 341     I->first->dump();
 342     cerr << " To: " << (void*)I->second << " ";
 343     I->second->dump();
 344     cerr << "\n";
 345   }
 346 }
 347 #endif
 348
 349
 350 // RemapOperand - Use ValueMap to convert constants from one module to another.
 351 static Value *RemapOperand(const Value *In,
 352                            std::map<const Value*, Value*> &ValueMap,
 353                            LLVMContext &Context) {
 354   std::map<const Value*,Value*>::const_iterator I = ValueMap.find(In);
 355   if (I != ValueMap.end())
 356     return I->second;
 357
 358   // Check to see if it's a constant that we are interested in transforming.
 359   Value *Result = 0;
 360   if (const Constant *CPV = dyn_cast<Constant>(In)) {
 361     if ((!isa<DerivedType>(CPV->getType()) && !isa<ConstantExpr>(CPV)) ||
 362         isa<ConstantInt>(CPV) || isa<ConstantAggregateZero>(CPV))
 363       return const_cast<Constant*>(CPV);   // Simple constants stay identical.
 364
 365     if (const ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
 366       std::vector<Constant*> Operands(CPA->getNumOperands());
 367       for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
 368         Operands[i] =cast<Constant>(RemapOperand(CPA->getOperand(i), ValueMap,
 369                                                  Context));
 370       Result =
 371           Context.getConstantArray(cast<ArrayType>(CPA->getType()), Operands);
 372     } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
 373       std::vector<Constant*> Operands(CPS->getNumOperands());
 374       for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
 375         Operands[i] =cast<Constant>(RemapOperand(CPS->getOperand(i), ValueMap,
 376                                                  Context));
 377       Result =
 378          Context.getConstantStruct(cast<StructType>(CPS->getType()), Operands);
 379     } else if (isa<ConstantPointerNull>(CPV) || isa<UndefValue>(CPV)) {
 380       Result = const_cast<Constant*>(CPV);
 381     } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CPV)) {
 382       std::vector<Constant*> Operands(CP->getNumOperands());
 383       for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
 384         Operands[i] = cast<Constant>(RemapOperand(CP->getOperand(i), ValueMap,
 385                                      Context));
 386       Result = Context.getConstantVector(Operands);
 387     } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
 388       std::vector<Constant*> Ops;
 389       for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
 390         Ops.push_back(cast<Constant>(RemapOperand(CE->getOperand(i),ValueMap,
 391                                      Context)));
 392       Result = CE->getWithOperands(Ops);
 393     } else {
 394       assert(!isa<GlobalValue>(CPV) && "Unmapped global?");
 395       assert(0 && "Unknown type of derived type constant value!");
 396     }
 397   } else if (isa<InlineAsm>(In)) {
 398     Result = const_cast<Value*>(In);
 399   }
 400
 401   // Cache the mapping in our local map structure
 402   if (Result) {
 403     ValueMap[In] = Result;
 404     return Result;
 405   }
 406
 407 #ifndef NDEBUG
 408   cerr << "LinkModules ValueMap: \n";
 409   PrintMap(ValueMap);
 410
 411   cerr << "Couldn't remap value: " << (void*)In << " " << *In << "\n";
 412   assert(0 && "Couldn't remap value!");
 413 #endif
 414   return 0;
 415 }
 416
 417 /// ForceRenaming - The LLVM SymbolTable class autorenames globals that conflict
 418 /// in the symbol table.  This is good for all clients except for us.  Go
 419 /// through the trouble to force this back.
 420 static void ForceRenaming(GlobalValue *GV, const std::string &Name) {
 421   assert(GV->getName() != Name && "Can't force rename to self");
 422   ValueSymbolTable &ST = GV->getParent()->getValueSymbolTable();
 423
 424   // If there is a conflict, rename the conflict.
 425   if (GlobalValue *ConflictGV = cast_or_null<GlobalValue>(ST.lookup(Name))) {
 426     assert(ConflictGV->hasLocalLinkage() &&
 427            "Not conflicting with a static global, should link instead!");
 428     GV->takeName(ConflictGV);
 429     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
 430     assert(ConflictGV->getName() != Name && "ForceRenaming didn't work");
 431   } else {
 432     GV->setName(Name);              // Force the name back
 433   }
 434 }
 435
 436 /// CopyGVAttributes - copy additional attributes (those not needed to construct
 437 /// a GlobalValue) from the SrcGV to the DestGV.
 438 static void CopyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) {
 439   // Use the maximum alignment, rather than just copying the alignment of SrcGV.
 440   unsigned Alignment = std::max(DestGV->getAlignment(), SrcGV->getAlignment());
 441   DestGV->copyAttributesFrom(SrcGV);
 442   DestGV->setAlignment(Alignment);
 443 }
 444
 445 /// GetLinkageResult - This analyzes the two global values and determines what
 446 /// the result will look like in the destination module.  In particular, it
 447 /// computes the resultant linkage type, computes whether the global in the
 448 /// source should be copied over to the destination (replacing the existing
 449 /// one), and computes whether this linkage is an error or not. It also performs
 450 /// visibility checks: we cannot link together two symbols with different
 451 /// visibilities.
 452 static bool GetLinkageResult(GlobalValue *Dest, const GlobalValue *Src,
 453                              GlobalValue::LinkageTypes &LT, bool &LinkFromSrc,
 454                              std::string *Err) {
 455   assert((!Dest || !Src->hasLocalLinkage()) &&
 456          "If Src has internal linkage, Dest shouldn't be set!");
 457   if (!Dest) {
 458     // Linking something to nothing.
 459     LinkFromSrc = true;
 460     LT = Src->getLinkage();
 461   } else if (Src->isDeclaration()) {
 462     // If Src is external or if both Src & Dest are external..  Just link the
 463     // external globals, we aren't adding anything.
 464     if (Src->hasDLLImportLinkage()) {
 465       // If one of GVs has DLLImport linkage, result should be dllimport'ed.
 466       if (Dest->isDeclaration()) {
 467         LinkFromSrc = true;
 468         LT = Src->getLinkage();
 469       }
 470     } else if (Dest->hasExternalWeakLinkage()) {
 471       // If the Dest is weak, use the source linkage.
 472       LinkFromSrc = true;
 473       LT = Src->getLinkage();
 474     } else {
 475       LinkFromSrc = false;
 476       LT = Dest->getLinkage();
 477     }
 478   } else if (Dest->isDeclaration() && !Dest->hasDLLImportLinkage()) {
 479     // If Dest is external but Src is not:
 480     LinkFromSrc = true;
 481     LT = Src->getLinkage();
 482   } else if (Src->hasAppendingLinkage() || Dest->hasAppendingLinkage()) {
 483     if (Src->getLinkage() != Dest->getLinkage())
 484       return Error(Err, "Linking globals named '" + Src->getName() +
 485             "': can only link appending global with another appending global!");
 486     LinkFromSrc = true; // Special cased.
 487     LT = Src->getLinkage();
 488   } else if (Src->isWeakForLinker()) {
 489     // At this point we know that Dest has LinkOnce, External*, Weak, Common,
 490     // or DLL* linkage.
 491     if (Dest->hasExternalWeakLinkage() ||
 492         Dest->hasAvailableExternallyLinkage() ||
 493         (Dest->hasLinkOnceLinkage() &&
 494          (Src->hasWeakLinkage() || Src->hasCommonLinkage()))) {
 495       LinkFromSrc = true;
 496       LT = Src->getLinkage();
 497     } else {
 498       LinkFromSrc = false;
 499       LT = Dest->getLinkage();
 500     }
 501   } else if (Dest->isWeakForLinker()) {
 502     // At this point we know that Src has External* or DLL* linkage.
 503     if (Src->hasExternalWeakLinkage()) {
 504       LinkFromSrc = false;
 505       LT = Dest->getLinkage();
 506     } else {
 507       LinkFromSrc = true;
 508       LT = GlobalValue::ExternalLinkage;
 509     }
 510   } else {
 511     assert((Dest->hasExternalLinkage() ||
 512             Dest->hasDLLImportLinkage() ||
 513             Dest->hasDLLExportLinkage() ||
 514             Dest->hasExternalWeakLinkage()) &&
 515            (Src->hasExternalLinkage() ||
 516             Src->hasDLLImportLinkage() ||
 517             Src->hasDLLExportLinkage() ||
 518             Src->hasExternalWeakLinkage()) &&
 519            "Unexpected linkage type!");
 520     return Error(Err, "Linking globals named '" + Src->getName() +
 521                  "': symbol multiply defined!");
 522   }
 523
 524   // Check visibility
 525   if (Dest && Src->getVisibility() != Dest->getVisibility())
 526     if (!Src->isDeclaration() && !Dest->isDeclaration())
 527       return Error(Err, "Linking globals named '" + Src->getName() +
 528                    "': symbols have different visibilities!");
 529   return false;
 530 }
 531
 532 // LinkGlobals - Loop through the global variables in the src module and merge
 533 // them into the dest module.
 534 static bool LinkGlobals(Module *Dest, const Module *Src,
 535                         std::map<const Value*, Value*> &ValueMap,
 536                     std::multimap<std::string, GlobalVariable *> &AppendingVars,
 537                         std::string *Err) {
 538   ValueSymbolTable &DestSymTab = Dest->getValueSymbolTable();
 539   LLVMContext &Context = Dest->getContext();
 540
 541   // Loop over all of the globals in the src module, mapping them over as we go
 542   for (Module::const_global_iterator I = Src->global_begin(),
 543        E = Src->global_end(); I != E; ++I) {
 544     const GlobalVariable *SGV = I;
 545     GlobalValue *DGV = 0;
 546
 547     // Check to see if may have to link the global with the global, alias or
 548     // function.
 549     if (SGV->hasName() && !SGV->hasLocalLinkage())
 550       DGV = cast_or_null<GlobalValue>(DestSymTab.lookup(SGV->getNameStart(),
 551                                                         SGV->getNameEnd()));
 552
 553     // If we found a global with the same name in the dest module, but it has
 554     // internal linkage, we are really not doing any linkage here.
 555     if (DGV && DGV->hasLocalLinkage())
 556       DGV = 0;
 557
 558     // If types don't agree due to opaque types, try to resolve them.
 559     if (DGV && DGV->getType() != SGV->getType())
 560       RecursiveResolveTypes(SGV->getType(), DGV->getType());
 561
 562     assert((SGV->hasInitializer() || SGV->hasExternalWeakLinkage() ||
 563             SGV->hasExternalLinkage() || SGV->hasDLLImportLinkage()) &&
 564            "Global must either be external or have an initializer!");
 565
 566     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
 567     bool LinkFromSrc = false;
 568     if (GetLinkageResult(DGV, SGV, NewLinkage, LinkFromSrc, Err))
 569       return true;
 570
 571     if (DGV == 0) {
 572       // No linking to be performed, simply create an identical version of the
 573       // symbol over in the dest module... the initializer will be filled in
 574       // later by LinkGlobalInits.
 575       GlobalVariable *NewDGV =
 576         new GlobalVariable(*Dest, SGV->getType()->getElementType(),
 577                            SGV->isConstant(), SGV->getLinkage(), /*init*/0,
 578                            SGV->getName(), 0, false,
 579                            SGV->getType()->getAddressSpace());
 580       // Propagate alignment, visibility and section info.
 581       CopyGVAttributes(NewDGV, SGV);
 582
 583       // If the LLVM runtime renamed the global, but it is an externally visible
 584       // symbol, DGV must be an existing global with internal linkage.  Rename
 585       // it.
 586       if (!NewDGV->hasLocalLinkage() && NewDGV->getName() != SGV->getName())
 587         ForceRenaming(NewDGV, SGV->getName());
 588
 589       // Make sure to remember this mapping.
 590       ValueMap[SGV] = NewDGV;
 591
 592       // Keep track that this is an appending variable.
 593       if (SGV->hasAppendingLinkage())
 594         AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
 595       continue;
 596     }
 597
 598     // If the visibilities of the symbols disagree and the destination is a
 599     // prototype, take the visibility of its input.
 600     if (DGV->isDeclaration())
 601       DGV->setVisibility(SGV->getVisibility());
 602
 603     if (DGV->hasAppendingLinkage()) {
 604       // No linking is performed yet.  Just insert a new copy of the global, and
 605       // keep track of the fact that it is an appending variable in the
 606       // AppendingVars map.  The name is cleared out so that no linkage is
 607       // performed.
 608       GlobalVariable *NewDGV =
 609         new GlobalVariable(*Dest, SGV->getType()->getElementType(),
 610                            SGV->isConstant(), SGV->getLinkage(), /*init*/0,
 611                            "", 0, false,
 612                            SGV->getType()->getAddressSpace());
 613
 614       // Set alignment allowing CopyGVAttributes merge it with alignment of SGV.
 615       NewDGV->setAlignment(DGV->getAlignment());
 616       // Propagate alignment, section and visibility info.
 617       CopyGVAttributes(NewDGV, SGV);
 618
 619       // Make sure to remember this mapping...
 620       ValueMap[SGV] = NewDGV;
 621
 622       // Keep track that this is an appending variable...
 623       AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
 624       continue;
 625     }
 626
 627     if (LinkFromSrc) {
 628       if (isa<GlobalAlias>(DGV))
 629         return Error(Err, "Global-Alias Collision on '" + SGV->getName() +
 630                      "': symbol multiple defined");
 631
 632       // If the types don't match, and if we are to link from the source, nuke
 633       // DGV and create a new one of the appropriate type.  Note that the thing
 634       // we are replacing may be a function (if a prototype, weak, etc) or a
 635       // global variable.
 636       GlobalVariable *NewDGV =
 637         new GlobalVariable(*Dest, SGV->getType()->getElementType(),
 638                            SGV->isConstant(), NewLinkage, /*init*/0,
 639                            DGV->getName(), 0, false,
 640                            SGV->getType()->getAddressSpace());
 641
 642       // Propagate alignment, section, and visibility info.
 643       CopyGVAttributes(NewDGV, SGV);
 644       DGV->replaceAllUsesWith(Context.getConstantExprBitCast(NewDGV,
 645                                                               DGV->getType()));
 646
 647       // DGV will conflict with NewDGV because they both had the same
 648       // name. We must erase this now so ForceRenaming doesn't assert
 649       // because DGV might not have internal linkage.
 650       if (GlobalVariable *Var = dyn_cast<GlobalVariable>(DGV))
 651         Var->eraseFromParent();
 652       else
 653         cast<Function>(DGV)->eraseFromParent();
 654       DGV = NewDGV;
 655
 656       // If the symbol table renamed the global, but it is an externally visible
 657       // symbol, DGV must be an existing global with internal linkage.  Rename.
 658       if (NewDGV->getName() != SGV->getName() && !NewDGV->hasLocalLinkage())
 659         ForceRenaming(NewDGV, SGV->getName());
 660
 661       // Inherit const as appropriate.
 662       NewDGV->setConstant(SGV->isConstant());
 663
 664       // Make sure to remember this mapping.
 665       ValueMap[SGV] = NewDGV;
 666       continue;
 667     }
 668
 669     // Not "link from source", keep the one in the DestModule and remap the
 670     // input onto it.
 671
 672     // Special case for const propagation.
 673     if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV))
 674       if (DGVar->isDeclaration() && SGV->isConstant() && !DGVar->isConstant())
 675         DGVar->setConstant(true);
 676
 677     // SGV is global, but DGV is alias.
 678     if (isa<GlobalAlias>(DGV)) {
 679       // The only valid mappings are:
 680       // - SGV is external declaration, which is effectively a no-op.
 681       // - SGV is weak, when we just need to throw SGV out.
 682       if (!SGV->isDeclaration() && !SGV->isWeakForLinker())
 683         return Error(Err, "Global-Alias Collision on '" + SGV->getName() +
 684                      "': symbol multiple defined");
 685     }
 686
 687     // Set calculated linkage
 688     DGV->setLinkage(NewLinkage);
 689
 690     // Make sure to remember this mapping...
 691     ValueMap[SGV] = Context.getConstantExprBitCast(DGV, SGV->getType());
 692   }
 693   return false;
 694 }
 695
 696 static GlobalValue::LinkageTypes
 697 CalculateAliasLinkage(const GlobalValue *SGV, const GlobalValue *DGV) {
 698   GlobalValue::LinkageTypes SL = SGV->getLinkage();
 699   GlobalValue::LinkageTypes DL = DGV->getLinkage();
 700   if (SL == GlobalValue::ExternalLinkage || DL == GlobalValue::ExternalLinkage)
 701     return GlobalValue::ExternalLinkage;
 702   else if (SL == GlobalValue::WeakAnyLinkage ||
 703            DL == GlobalValue::WeakAnyLinkage)
 704     return GlobalValue::WeakAnyLinkage;
 705   else if (SL == GlobalValue::WeakODRLinkage ||
 706            DL == GlobalValue::WeakODRLinkage)
 707     return GlobalValue::WeakODRLinkage;
 708   else if (SL == GlobalValue::InternalLinkage &&
 709            DL == GlobalValue::InternalLinkage)
 710     return GlobalValue::InternalLinkage;
 711   else {
 712     assert (SL == GlobalValue::PrivateLinkage &&
 713             DL == GlobalValue::PrivateLinkage && "Unexpected linkage type");
 714     return GlobalValue::PrivateLinkage;
 715   }
 716 }
 717
 718 // LinkAlias - Loop through the alias in the src module and link them into the
 719 // dest module. We're assuming, that all functions/global variables were already
 720 // linked in.
 721 static bool LinkAlias(Module *Dest, const Module *Src,
 722                       std::map<const Value*, Value*> &ValueMap,
 723                       std::string *Err) {
 724   LLVMContext &Context = Dest->getContext();
 725
 726   // Loop over all alias in the src module
 727   for (Module::const_alias_iterator I = Src->alias_begin(),
 728          E = Src->alias_end(); I != E; ++I) {
 729     const GlobalAlias *SGA = I;
 730     const GlobalValue *SAliasee = SGA->getAliasedGlobal();
 731     GlobalAlias *NewGA = NULL;
 732
 733     // Globals were already linked, thus we can just query ValueMap for variant
 734     // of SAliasee in Dest.
 735     std::map<const Value*,Value*>::const_iterator VMI = ValueMap.find(SAliasee);
 736     assert(VMI != ValueMap.end() && "Aliasee not linked");
 737     GlobalValue* DAliasee = cast<GlobalValue>(VMI->second);
 738     GlobalValue* DGV = NULL;
 739
 740     // Try to find something 'similar' to SGA in destination module.
 741     if (!DGV && !SGA->hasLocalLinkage()) {
 742       DGV = Dest->getNamedAlias(SGA->getName());
 743
 744       // If types don't agree due to opaque types, try to resolve them.
 745       if (DGV && DGV->getType() != SGA->getType())
 746         RecursiveResolveTypes(SGA->getType(), DGV->getType());
 747     }
 748
 749     if (!DGV && !SGA->hasLocalLinkage()) {
 750       DGV = Dest->getGlobalVariable(SGA->getName());
 751
 752       // If types don't agree due to opaque types, try to resolve them.
 753       if (DGV && DGV->getType() != SGA->getType())
 754         RecursiveResolveTypes(SGA->getType(), DGV->getType());
 755     }
 756
 757     if (!DGV && !SGA->hasLocalLinkage()) {
 758       DGV = Dest->getFunction(SGA->getName());
 759
 760       // If types don't agree due to opaque types, try to resolve them.
 761       if (DGV && DGV->getType() != SGA->getType())
 762         RecursiveResolveTypes(SGA->getType(), DGV->getType());
 763     }
 764
 765     // No linking to be performed on internal stuff.
 766     if (DGV && DGV->hasLocalLinkage())
 767       DGV = NULL;
 768
 769     if (GlobalAlias *DGA = dyn_cast_or_null<GlobalAlias>(DGV)) {
 770       // Types are known to be the same, check whether aliasees equal. As
 771       // globals are already linked we just need query ValueMap to find the
 772       // mapping.
 773       if (DAliasee == DGA->getAliasedGlobal()) {
 774         // This is just two copies of the same alias. Propagate linkage, if
 775         // necessary.
 776         DGA->setLinkage(CalculateAliasLinkage(SGA, DGA));
 777
 778         NewGA = DGA;
 779         // Proceed to 'common' steps
 780       } else
 781         return Error(Err, "Alias Collision on '"  + SGA->getName()+
 782                      "': aliases have different aliasees");
 783     } else if (GlobalVariable *DGVar = dyn_cast_or_null<GlobalVariable>(DGV)) {
 784       // The only allowed way is to link alias with external declaration or weak
 785       // symbol..
 786       if (DGVar->isDeclaration() || DGVar->isWeakForLinker()) {
 787         // But only if aliasee is global too...
 788         if (!isa<GlobalVariable>(DAliasee))
 789           return Error(Err, "Global-Alias Collision on '" + SGA->getName() +
 790                        "': aliasee is not global variable");
 791
 792         NewGA = new GlobalAlias(SGA->getType(), SGA->getLinkage(),
 793                                 SGA->getName(), DAliasee, Dest);
 794         CopyGVAttributes(NewGA, SGA);
 795
 796         // Any uses of DGV need to change to NewGA, with cast, if needed.
 797         if (SGA->getType() != DGVar->getType())
 798           DGVar->replaceAllUsesWith(Context.getConstantExprBitCast(NewGA,
 799                                                              DGVar->getType()));
 800         else
 801           DGVar->replaceAllUsesWith(NewGA);
 802
 803         // DGVar will conflict with NewGA because they both had the same
 804         // name. We must erase this now so ForceRenaming doesn't assert
 805         // because DGV might not have internal linkage.
 806         DGVar->eraseFromParent();
 807
 808         // Proceed to 'common' steps
 809       } else
 810         return Error(Err, "Global-Alias Collision on '" + SGA->getName() +
 811                      "': symbol multiple defined");
 812     } else if (Function *DF = dyn_cast_or_null<Function>(DGV)) {
 813       // The only allowed way is to link alias with external declaration or weak
 814       // symbol...
 815       if (DF->isDeclaration() || DF->isWeakForLinker()) {
 816         // But only if aliasee is function too...
 817         if (!isa<Function>(DAliasee))
 818           return Error(Err, "Function-Alias Collision on '" + SGA->getName() +
 819                        "': aliasee is not function");
 820
 821         NewGA = new GlobalAlias(SGA->getType(), SGA->getLinkage(),
 822                                 SGA->getName(), DAliasee, Dest);
 823         CopyGVAttributes(NewGA, SGA);
 824
 825         // Any uses of DF need to change to NewGA, with cast, if needed.
 826         if (SGA->getType() != DF->getType())
 827           DF->replaceAllUsesWith(Context.getConstantExprBitCast(NewGA,
 828                                                           DF->getType()));
 829         else
 830           DF->replaceAllUsesWith(NewGA);
 831
 832         // DF will conflict with NewGA because they both had the same
 833         // name. We must erase this now so ForceRenaming doesn't assert
 834         // because DF might not have internal linkage.
 835         DF->eraseFromParent();
 836
 837         // Proceed to 'common' steps
 838       } else
 839         return Error(Err, "Function-Alias Collision on '" + SGA->getName() +
 840                      "': symbol multiple defined");
 841     } else {
 842       // No linking to be performed, simply create an identical version of the
 843       // alias over in the dest module...
 844
 845       NewGA = new GlobalAlias(SGA->getType(), SGA->getLinkage(),
 846                               SGA->getName(), DAliasee, Dest);
 847       CopyGVAttributes(NewGA, SGA);
 848
 849       // Proceed to 'common' steps
 850     }
 851
 852     assert(NewGA && "No alias was created in destination module!");
 853
 854     // If the symbol table renamed the alias, but it is an externally visible
 855     // symbol, DGA must be an global value with internal linkage. Rename it.
 856     if (NewGA->getName() != SGA->getName() &&
 857         !NewGA->hasLocalLinkage())
 858       ForceRenaming(NewGA, SGA->getName());
 859
 860     // Remember this mapping so uses in the source module get remapped
 861     // later by RemapOperand.
 862     ValueMap[SGA] = NewGA;
 863   }
 864
 865   return false;
 866 }
 867
 868
 869 // LinkGlobalInits - Update the initializers in the Dest module now that all
 870 // globals that may be referenced are in Dest.
 871 static bool LinkGlobalInits(Module *Dest, const Module *Src,
 872                             std::map<const Value*, Value*> &ValueMap,
 873                             std::string *Err) {
 874   // Loop over all of the globals in the src module, mapping them over as we go
 875   for (Module::const_global_iterator I = Src->global_begin(),
 876        E = Src->global_end(); I != E; ++I) {
 877     const GlobalVariable *SGV = I;
 878
 879     if (SGV->hasInitializer()) {      // Only process initialized GV's
 880       // Figure out what the initializer looks like in the dest module...
 881       Constant *SInit =
 882         cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap,
 883                        Dest->getContext()));
 884       // Grab destination global variable or alias.
 885       GlobalValue *DGV = cast<GlobalValue>(ValueMap[SGV]->stripPointerCasts());
 886
 887       // If dest if global variable, check that initializers match.
 888       if (GlobalVariable *DGVar = dyn_cast<GlobalVariable>(DGV)) {
 889         if (DGVar->hasInitializer()) {
 890           if (SGV->hasExternalLinkage()) {
 891             if (DGVar->getInitializer() != SInit)
 892               return Error(Err, "Global Variable Collision on '" +
 893                            SGV->getName() +
 894                            "': global variables have different initializers");
 895           } else if (DGVar->isWeakForLinker()) {
 896             // Nothing is required, mapped values will take the new global
 897             // automatically.
 898           } else if (SGV->isWeakForLinker()) {
 899             // Nothing is required, mapped values will take the new global
 900             // automatically.
 901           } else if (DGVar->hasAppendingLinkage()) {
 902             assert(0 && "Appending linkage unimplemented!");
 903           } else {
 904             assert(0 && "Unknown linkage!");
 905           }
 906         } else {
 907           // Copy the initializer over now...
 908           DGVar->setInitializer(SInit);
 909         }
 910       } else {
 911         // Destination is alias, the only valid situation is when source is
 912         // weak. Also, note, that we already checked linkage in LinkGlobals(),
 913         // thus we assert here.
 914         // FIXME: Should we weaken this assumption, 'dereference' alias and
 915         // check for initializer of aliasee?
 916         assert(SGV->isWeakForLinker());
 917       }
 918     }
 919   }
 920   return false;
 921 }
 922
 923 // LinkFunctionProtos - Link the functions together between the two modules,
 924 // without doing function bodies... this just adds external function prototypes
 925 // to the Dest function...
 926 //
 927 static bool LinkFunctionProtos(Module *Dest, const Module *Src,
 928                                std::map<const Value*, Value*> &ValueMap,
 929                                std::string *Err) {
 930   ValueSymbolTable &DestSymTab = Dest->getValueSymbolTable();
 931   LLVMContext &Context = Dest->getContext();
 932
 933   // Loop over all of the functions in the src module, mapping them over
 934   for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
 935     const Function *SF = I;   // SrcFunction
 936     GlobalValue *DGV = 0;
 937
 938     // Check to see if may have to link the function with the global, alias or
 939     // function.
 940     if (SF->hasName() && !SF->hasLocalLinkage())
 941       DGV = cast_or_null<GlobalValue>(DestSymTab.lookup(SF->getNameStart(),
 942                                                         SF->getNameEnd()));
 943
 944     // If we found a global with the same name in the dest module, but it has
 945     // internal linkage, we are really not doing any linkage here.
 946     if (DGV && DGV->hasLocalLinkage())
 947       DGV = 0;
 948
 949     // If types don't agree due to opaque types, try to resolve them.
 950     if (DGV && DGV->getType() != SF->getType())
 951       RecursiveResolveTypes(SF->getType(), DGV->getType());
 952
 953     GlobalValue::LinkageTypes NewLinkage = GlobalValue::InternalLinkage;
 954     bool LinkFromSrc = false;
 955     if (GetLinkageResult(DGV, SF, NewLinkage, LinkFromSrc, Err))
 956       return true;
 957
 958     // If there is no linkage to be performed, just bring over SF without
 959     // modifying it.
 960     if (DGV == 0) {
 961       // Function does not already exist, simply insert an function signature
 962       // identical to SF into the dest module.
 963       Function *NewDF = Function::Create(SF->getFunctionType(),
 964                                          SF->getLinkage(),
 965                                          SF->getName(), Dest);
 966       CopyGVAttributes(NewDF, SF);
 967
 968       // If the LLVM runtime renamed the function, but it is an externally
 969       // visible symbol, DF must be an existing function with internal linkage.
 970       // Rename it.
 971       if (!NewDF->hasLocalLinkage() && NewDF->getName() != SF->getName())
 972         ForceRenaming(NewDF, SF->getName());
 973
 974       // ... and remember this mapping...
 975       ValueMap[SF] = NewDF;
 976       continue;
 977     }
 978
 979     // If the visibilities of the symbols disagree and the destination is a
 980     // prototype, take the visibility of its input.
 981     if (DGV->isDeclaration())
 982       DGV->setVisibility(SF->getVisibility());
 983
 984     if (LinkFromSrc) {
 985       if (isa<GlobalAlias>(DGV))
 986         return Error(Err, "Function-Alias Collision on '" + SF->getName() +
 987                      "': symbol multiple defined");
 988
 989       // We have a definition of the same name but different type in the
 990       // source module. Copy the prototype to the destination and replace
 991       // uses of the destination's prototype with the new prototype.
 992       Function *NewDF = Function::Create(SF->getFunctionType(), NewLinkage,
 993                                          SF->getName(), Dest);
 994       CopyGVAttributes(NewDF, SF);
 995
 996       // Any uses of DF need to change to NewDF, with cast
 997       DGV->replaceAllUsesWith(Context.getConstantExprBitCast(NewDF,
 998                                                               DGV->getType()));
 999
1000       // DF will conflict with NewDF because they both had the same. We must
1001       // erase this now so ForceRenaming doesn't assert because DF might
1002       // not have internal linkage.
1003       if (GlobalVariable *Var = dyn_cast<GlobalVariable>(DGV))
1004         Var->eraseFromParent();
1005       else
1006         cast<Function>(DGV)->eraseFromParent();
1007
1008       // If the symbol table renamed the function, but it is an externally
1009       // visible symbol, DF must be an existing function with internal
1010       // linkage.  Rename it.
1011       if (NewDF->getName() != SF->getName() && !NewDF->hasLocalLinkage())
1012         ForceRenaming(NewDF, SF->getName());
1013
1014       // Remember this mapping so uses in the source module get remapped
1015       // later by RemapOperand.
1016       ValueMap[SF] = NewDF;
1017       continue;
1018     }
1019
1020     // Not "link from source", keep the one in the DestModule and remap the
1021     // input onto it.
1022
1023     if (isa<GlobalAlias>(DGV)) {
1024       // The only valid mappings are:
1025       // - SF is external declaration, which is effectively a no-op.
1026       // - SF is weak, when we just need to throw SF out.
1027       if (!SF->isDeclaration() && !SF->isWeakForLinker())
1028         return Error(Err, "Function-Alias Collision on '" + SF->getName() +
1029                      "': symbol multiple defined");
1030     }
1031
1032     // Set calculated linkage
1033     DGV->setLinkage(NewLinkage);
1034
1035     // Make sure to remember this mapping.
1036     ValueMap[SF] = Context.getConstantExprBitCast(DGV, SF->getType());
1037   }
1038   return false;
1039 }
1040
1041 // LinkFunctionBody - Copy the source function over into the dest function and
1042 // fix up references to values.  At this point we know that Dest is an external
1043 // function, and that Src is not.
1044 static bool LinkFunctionBody(Function *Dest, Function *Src,
1045                              std::map<const Value*, Value*> &ValueMap,
1046                              std::string *Err) {
1047   assert(Src && Dest && Dest->isDeclaration() && !Src->isDeclaration());
1048
1049   // Go through and convert function arguments over, remembering the mapping.
1050   Function::arg_iterator DI = Dest->arg_begin();
1051   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
1052        I != E; ++I, ++DI) {
1053     DI->setName(I->getName());  // Copy the name information over...
1054
1055     // Add a mapping to our local map
1056     ValueMap[I] = DI;
1057   }
1058
1059   // Splice the body of the source function into the dest function.
1060   Dest->getBasicBlockList().splice(Dest->end(), Src->getBasicBlockList());
1061
1062   // At this point, all of the instructions and values of the function are now
1063   // copied over.  The only problem is that they are still referencing values in
1064   // the Source function as operands.  Loop through all of the operands of the
1065   // functions and patch them up to point to the local versions...
1066   //
1067   for (Function::iterator BB = Dest->begin(), BE = Dest->end(); BB != BE; ++BB)
1068     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1069       for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
1070            OI != OE; ++OI)
1071         if (!isa<Instruction>(*OI) && !isa<BasicBlock>(*OI))
1072           *OI = RemapOperand(*OI, ValueMap, *Dest->getContext());
1073
1074   // There is no need to map the arguments anymore.
1075   for (Function::arg_iterator I = Src->arg_begin(), E = Src->arg_end();
1076        I != E; ++I)
1077     ValueMap.erase(I);
1078
1079   return false;
1080 }
1081
1082
1083 // LinkFunctionBodies - Link in the function bodies that are defined in the
1084 // source module into the DestModule.  This consists basically of copying the
1085 // function over and fixing up references to values.
1086 static bool LinkFunctionBodies(Module *Dest, Module *Src,
1087                                std::map<const Value*, Value*> &ValueMap,
1088                                std::string *Err) {
1089
1090   // Loop over all of the functions in the src module, mapping them over as we
1091   // go
1092   for (Module::iterator SF = Src->begin(), E = Src->end(); SF != E; ++SF) {
1093     if (!SF->isDeclaration()) {               // No body if function is external
1094       Function *DF = dyn_cast<Function>(ValueMap[SF]); // Destination function
1095
1096       // DF not external SF external?
1097       if (DF && DF->isDeclaration())
1098         // Only provide the function body if there isn't one already.
1099         if (LinkFunctionBody(DF, SF, ValueMap, Err))
1100           return true;
1101     }
1102   }
1103   return false;
1104 }
1105
1106 // LinkAppendingVars - If there were any appending global variables, link them
1107 // together now.  Return true on error.
1108 static bool LinkAppendingVars(Module *M,
1109                   std::multimap<std::string, GlobalVariable *> &AppendingVars,
1110                               std::string *ErrorMsg) {
1111   if (AppendingVars.empty()) return false; // Nothing to do.
1112
1113   LLVMContext &Context = M->getContext();
1114
1115   // Loop over the multimap of appending vars, processing any variables with the
1116   // same name, forming a new appending global variable with both of the
1117   // initializers merged together, then rewrite references to the old variables
1118   // and delete them.
1119   std::vector<Constant*> Inits;
1120   while (AppendingVars.size() > 1) {
1121     // Get the first two elements in the map...
1122     std::multimap<std::string,
1123       GlobalVariable*>::iterator Second = AppendingVars.begin(), First=Second++;
1124
1125     // If the first two elements are for different names, there is no pair...
1126     // Otherwise there is a pair, so link them together...
1127     if (First->first == Second->first) {
1128       GlobalVariable *G1 = First->second, *G2 = Second->second;
1129       const ArrayType *T1 = cast<ArrayType>(G1->getType()->getElementType());
1130       const ArrayType *T2 = cast<ArrayType>(G2->getType()->getElementType());
1131
1132       // Check to see that they two arrays agree on type...
1133       if (T1->getElementType() != T2->getElementType())
1134         return Error(ErrorMsg,
1135          "Appending variables with different element types need to be linked!");
1136       if (G1->isConstant() != G2->isConstant())
1137         return Error(ErrorMsg,
1138                      "Appending variables linked with different const'ness!");
1139
1140       if (G1->getAlignment() != G2->getAlignment())
1141         return Error(ErrorMsg,
1142          "Appending variables with different alignment need to be linked!");
1143
1144       if (G1->getVisibility() != G2->getVisibility())
1145         return Error(ErrorMsg,
1146          "Appending variables with different visibility need to be linked!");
1147
1148       if (G1->getSection() != G2->getSection())
1149         return Error(ErrorMsg,
1150          "Appending variables with different section name need to be linked!");
1151
1152       unsigned NewSize = T1->getNumElements() + T2->getNumElements();
1153       ArrayType *NewType = Context.getArrayType(T1->getElementType(),
1154                                                          NewSize);
1155
1156       G1->setName("");   // Clear G1's name in case of a conflict!
1157
1158       // Create the new global variable...
1159       GlobalVariable *NG =
1160         new GlobalVariable(*M, NewType, G1->isConstant(), G1->getLinkage(),
1161                            /*init*/0, First->first, 0, G1->isThreadLocal(),
1162                            G1->getType()->getAddressSpace());
1163
1164       // Propagate alignment, visibility and section info.
1165       CopyGVAttributes(NG, G1);
1166
1167       // Merge the initializer...
1168       Inits.reserve(NewSize);
1169       if (ConstantArray *I = dyn_cast<ConstantArray>(G1->getInitializer())) {
1170         for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
1171           Inits.push_back(I->getOperand(i));
1172       } else {
1173         assert(isa<ConstantAggregateZero>(G1->getInitializer()));
1174         Constant *CV = Context.getNullValue(T1->getElementType());
1175         for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
1176           Inits.push_back(CV);
1177       }
1178       if (ConstantArray *I = dyn_cast<ConstantArray>(G2->getInitializer())) {
1179         for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
1180           Inits.push_back(I->getOperand(i));
1181       } else {
1182         assert(isa<ConstantAggregateZero>(G2->getInitializer()));
1183         Constant *CV = Context.getNullValue(T2->getElementType());
1184         for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
1185           Inits.push_back(CV);
1186       }
1187       NG->setInitializer(Context.getConstantArray(NewType, Inits));
1188       Inits.clear();
1189
1190       // Replace any uses of the two global variables with uses of the new
1191       // global...
1192
1193       // FIXME: This should rewrite simple/straight-forward uses such as
1194       // getelementptr instructions to not use the Cast!
1195       G1->replaceAllUsesWith(Context.getConstantExprBitCast(NG,
1196                              G1->getType()));
1197       G2->replaceAllUsesWith(Context.getConstantExprBitCast(NG,
1198                              G2->getType()));
1199
1200       // Remove the two globals from the module now...
1201       M->getGlobalList().erase(G1);
1202       M->getGlobalList().erase(G2);
1203
1204       // Put the new global into the AppendingVars map so that we can handle
1205       // linking of more than two vars...
1206       Second->second = NG;
1207     }
1208     AppendingVars.erase(First);
1209   }
1210
1211   return false;
1212 }
1213
1214 static bool ResolveAliases(Module *Dest) {
1215   for (Module::alias_iterator I = Dest->alias_begin(), E = Dest->alias_end();
1216        I != E; ++I)
1217     if (const GlobalValue *GV = I->resolveAliasedGlobal())
1218       if (GV != I && !GV->isDeclaration())
1219         I->replaceAllUsesWith(const_cast<GlobalValue*>(GV));
1220
1221   return false;
1222 }
1223
1224 // LinkModules - This function links two modules together, with the resulting
1225 // left module modified to be the composite of the two input modules.  If an
1226 // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
1227 // the problem.  Upon failure, the Dest module could be in a modified state, and
1228 // shouldn't be relied on to be consistent.
1229 bool
1230 Linker::LinkModules(Module *Dest, Module *Src, std::string *ErrorMsg) {
1231   assert(Dest != 0 && "Invalid Destination module");
1232   assert(Src  != 0 && "Invalid Source Module");
1233
1234   if (Dest->getDataLayout().empty()) {
1235     if (!Src->getDataLayout().empty()) {
1236       Dest->setDataLayout(Src->getDataLayout());
1237     } else {
1238       std::string DataLayout;
1239
1240       if (Dest->getEndianness() == Module::AnyEndianness) {
1241         if (Src->getEndianness() == Module::BigEndian)
1242           DataLayout.append("E");
1243         else if (Src->getEndianness() == Module::LittleEndian)
1244           DataLayout.append("e");
1245       }
1246
1247       if (Dest->getPointerSize() == Module::AnyPointerSize) {
1248         if (Src->getPointerSize() == Module::Pointer64)
1249           DataLayout.append(DataLayout.length() == 0 ? "p:64:64" : "-p:64:64");
1250         else if (Src->getPointerSize() == Module::Pointer32)
1251           DataLayout.append(DataLayout.length() == 0 ? "p:32:32" : "-p:32:32");
1252       }
1253       Dest->setDataLayout(DataLayout);
1254     }
1255   }
1256
1257   // Copy the target triple from the source to dest if the dest's is empty.
1258   if (Dest->getTargetTriple().empty() && !Src->getTargetTriple().empty())
1259     Dest->setTargetTriple(Src->getTargetTriple());
1260
1261   if (!Src->getDataLayout().empty() && !Dest->getDataLayout().empty() &&
1262       Src->getDataLayout() != Dest->getDataLayout())
1263     cerr << "WARNING: Linking two modules of different data layouts!\n";
1264   if (!Src->getTargetTriple().empty() &&
1265       Dest->getTargetTriple() != Src->getTargetTriple())
1266     cerr << "WARNING: Linking two modules of different target triples!\n";
1267
1268   // Append the module inline asm string.
1269   if (!Src->getModuleInlineAsm().empty()) {
1270     if (Dest->getModuleInlineAsm().empty())
1271       Dest->setModuleInlineAsm(Src->getModuleInlineAsm());
1272     else
1273       Dest->setModuleInlineAsm(Dest->getModuleInlineAsm()+"\n"+
1274                                Src->getModuleInlineAsm());
1275   }
1276
1277   // Update the destination module's dependent libraries list with the libraries
1278   // from the source module. There's no opportunity for duplicates here as the
1279   // Module ensures that duplicate insertions are discarded.
1280   for (Module::lib_iterator SI = Src->lib_begin(), SE = Src->lib_end();
1281        SI != SE; ++SI)
1282     Dest->addLibrary(*SI);
1283
1284   // LinkTypes - Go through the symbol table of the Src module and see if any
1285   // types are named in the src module that are not named in the Dst module.
1286   // Make sure there are no type name conflicts.
1287   if (LinkTypes(Dest, Src, ErrorMsg))
1288     return true;
1289
1290   // ValueMap - Mapping of values from what they used to be in Src, to what they
1291   // are now in Dest.
1292   std::map<const Value*, Value*> ValueMap;
1293
1294   // AppendingVars - Keep track of global variables in the destination module
1295   // with appending linkage.  After the module is linked together, they are
1296   // appended and the module is rewritten.
1297   std::multimap<std::string, GlobalVariable *> AppendingVars;
1298   for (Module::global_iterator I = Dest->global_begin(), E = Dest->global_end();
1299        I != E; ++I) {
1300     // Add all of the appending globals already in the Dest module to
1301     // AppendingVars.
1302     if (I->hasAppendingLinkage())
1303       AppendingVars.insert(std::make_pair(I->getName(), I));
1304   }
1305
1306   // Insert all of the globals in src into the Dest module... without linking
1307   // initializers (which could refer to functions not yet mapped over).
1308   if (LinkGlobals(Dest, Src, ValueMap, AppendingVars, ErrorMsg))
1309     return true;
1310
1311   // Link the functions together between the two modules, without doing function
1312   // bodies... this just adds external function prototypes to the Dest
1313   // function...  We do this so that when we begin processing function bodies,
1314   // all of the global values that may be referenced are available in our
1315   // ValueMap.
1316   if (LinkFunctionProtos(Dest, Src, ValueMap, ErrorMsg))
1317     return true;
1318
1319   // If there were any alias, link them now. We really need to do this now,
1320   // because all of the aliases that may be referenced need to be available in
1321   // ValueMap
1322   if (LinkAlias(Dest, Src, ValueMap, ErrorMsg)) return true;
1323
1324   // Update the initializers in the Dest module now that all globals that may
1325   // be referenced are in Dest.
1326   if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
1327
1328   // Link in the function bodies that are defined in the source module into the
1329   // DestModule.  This consists basically of copying the function over and
1330   // fixing up references to values.
1331   if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
1332
1333   // If there were any appending global variables, link them together now.
1334   if (LinkAppendingVars(Dest, AppendingVars, ErrorMsg)) return true;
1335
1336   // Resolve all uses of aliases with aliasees
1337   if (ResolveAliases(Dest)) return true;
1338
1339   // If the source library's module id is in the dependent library list of the
1340   // destination library, remove it since that module is now linked in.
1341   sys::Path modId;
1342   modId.set(Src->getModuleIdentifier());
1343   if (!modId.isEmpty())
1344     Dest->removeLibrary(modId.getBasename());
1345
1346   return false;
1347 }
1348
1349 // vim: sw=2