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