lib/Linker/LinkModules.cpp

   1 //===- Linker.cpp - Module Linker Implementation --------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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/Transforms/Utils/Linker.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/Module.h"
  23 #include "llvm/SymbolTable.h"
  24 #include "llvm/iOther.h"
  25 #include "llvm/Assembly/Writer.h"
  26 using namespace llvm;
  27
  28 // Error - Simple wrapper function to conditionally assign to E and return true.
  29 // This just makes error return conditions a little bit simpler...
  30 //
  31 static inline bool Error(std::string *E, const std::string &Message) {
  32   if (E) *E = Message;
  33   return true;
  34 }
  35
  36 //
  37 // Function: ResolveTypes()
  38 //
  39 // Description:
  40 //  Attempt to link the two specified types together.
  41 //
  42 // Inputs:
  43 //  DestTy - The type to which we wish to resolve.
  44 //  SrcTy  - The original type which we want to resolve.
  45 //  Name   - The name of the type.
  46 //
  47 // Outputs:
  48 //  DestST - The symbol table in which the new type should be placed.
  49 //
  50 // Return value:
  51 //  true  - There is an error and the types cannot yet be linked.
  52 //  false - No errors.
  53 //
  54 static bool ResolveTypes(const Type *DestTy, const Type *SrcTy,
  55                          SymbolTable *DestST, const std::string &Name) {
  56   if (DestTy == SrcTy) return false;       // If already equal, noop
  57
  58   // Does the type already exist in the module?
  59   if (DestTy && !isa<OpaqueType>(DestTy)) {  // Yup, the type already exists...
  60     if (const OpaqueType *OT = dyn_cast<OpaqueType>(SrcTy)) {
  61       const_cast<OpaqueType*>(OT)->refineAbstractTypeTo(DestTy);
  62     } else {
  63       return true;  // Cannot link types... neither is opaque and not-equal
  64     }
  65   } else {                       // Type not in dest module.  Add it now.
  66     if (DestTy)                  // Type _is_ in module, just opaque...
  67       const_cast<OpaqueType*>(cast<OpaqueType>(DestTy))
  68                            ->refineAbstractTypeTo(SrcTy);
  69     else if (!Name.empty())
  70       DestST->insert(Name, const_cast<Type*>(SrcTy));
  71   }
  72   return false;
  73 }
  74
  75 static const FunctionType *getFT(const PATypeHolder &TH) {
  76   return cast<FunctionType>(TH.get());
  77 }
  78 static const StructType *getST(const PATypeHolder &TH) {
  79   return cast<StructType>(TH.get());
  80 }
  81
  82 // RecursiveResolveTypes - This is just like ResolveTypes, except that it
  83 // recurses down into derived types, merging the used types if the parent types
  84 // are compatible.
  85 //
  86 static bool RecursiveResolveTypesI(const PATypeHolder &DestTy,
  87                                    const PATypeHolder &SrcTy,
  88                                    SymbolTable *DestST, const std::string &Name,
  89                 std::vector<std::pair<PATypeHolder, PATypeHolder> > &Pointers) {
  90   const Type *SrcTyT = SrcTy.get();
  91   const Type *DestTyT = DestTy.get();
  92   if (DestTyT == SrcTyT) return false;       // If already equal, noop
  93
  94   // If we found our opaque type, resolve it now!
  95   if (isa<OpaqueType>(DestTyT) || isa<OpaqueType>(SrcTyT))
  96     return ResolveTypes(DestTyT, SrcTyT, DestST, Name);
  97
  98   // Two types cannot be resolved together if they are of different primitive
  99   // type.  For example, we cannot resolve an int to a float.
 100   if (DestTyT->getPrimitiveID() != SrcTyT->getPrimitiveID()) return true;
 101
 102   // Otherwise, resolve the used type used by this derived type...
 103   switch (DestTyT->getPrimitiveID()) {
 104   case Type::FunctionTyID: {
 105     if (cast<FunctionType>(DestTyT)->isVarArg() !=
 106         cast<FunctionType>(SrcTyT)->isVarArg() ||
 107         cast<FunctionType>(DestTyT)->getNumContainedTypes() !=
 108         cast<FunctionType>(SrcTyT)->getNumContainedTypes())
 109       return true;
 110     for (unsigned i = 0, e = getFT(DestTy)->getNumContainedTypes(); i != e; ++i)
 111       if (RecursiveResolveTypesI(getFT(DestTy)->getContainedType(i),
 112                                  getFT(SrcTy)->getContainedType(i), DestST, "",
 113                                  Pointers))
 114         return true;
 115     return false;
 116   }
 117   case Type::StructTyID: {
 118     if (getST(DestTy)->getNumContainedTypes() !=
 119         getST(SrcTy)->getNumContainedTypes()) return 1;
 120     for (unsigned i = 0, e = getST(DestTy)->getNumContainedTypes(); i != e; ++i)
 121       if (RecursiveResolveTypesI(getST(DestTy)->getContainedType(i),
 122                                  getST(SrcTy)->getContainedType(i), DestST, "",
 123                                  Pointers))
 124         return true;
 125     return false;
 126   }
 127   case Type::ArrayTyID: {
 128     const ArrayType *DAT = cast<ArrayType>(DestTy.get());
 129     const ArrayType *SAT = cast<ArrayType>(SrcTy.get());
 130     if (DAT->getNumElements() != SAT->getNumElements()) return true;
 131     return RecursiveResolveTypesI(DAT->getElementType(), SAT->getElementType(),
 132                                   DestST, "", Pointers);
 133   }
 134   case Type::PointerTyID: {
 135     // If this is a pointer type, check to see if we have already seen it.  If
 136     // so, we are in a recursive branch.  Cut off the search now.  We cannot use
 137     // an associative container for this search, because the type pointers (keys
 138     // in the container) change whenever types get resolved...
 139     //
 140     for (unsigned i = 0, e = Pointers.size(); i != e; ++i)
 141       if (Pointers[i].first == DestTy)
 142         return Pointers[i].second != SrcTy;
 143
 144     // Otherwise, add the current pointers to the vector to stop recursion on
 145     // this pair.
 146     Pointers.push_back(std::make_pair(DestTyT, SrcTyT));
 147     bool Result =
 148       RecursiveResolveTypesI(cast<PointerType>(DestTy.get())->getElementType(),
 149                              cast<PointerType>(SrcTy.get())->getElementType(),
 150                              DestST, "", Pointers);
 151     Pointers.pop_back();
 152     return Result;
 153   }
 154   default: assert(0 && "Unexpected type!"); return true;
 155   }
 156 }
 157
 158 static bool RecursiveResolveTypes(const PATypeHolder &DestTy,
 159                                   const PATypeHolder &SrcTy,
 160                                   SymbolTable *DestST, const std::string &Name){
 161   std::vector<std::pair<PATypeHolder, PATypeHolder> > PointerTypes;
 162   return RecursiveResolveTypesI(DestTy, SrcTy, DestST, Name, PointerTypes);
 163 }
 164
 165
 166 // LinkTypes - Go through the symbol table of the Src module and see if any
 167 // types are named in the src module that are not named in the Dst module.
 168 // Make sure there are no type name conflicts.
 169 //
 170 static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
 171   SymbolTable       *DestST = &Dest->getSymbolTable();
 172   const SymbolTable *SrcST  = &Src->getSymbolTable();
 173
 174   // Look for a type plane for Type's...
 175   SymbolTable::const_iterator PI = SrcST->find(Type::TypeTy);
 176   if (PI == SrcST->end()) return false;  // No named types, do nothing.
 177
 178   // Some types cannot be resolved immediately because they depend on other
 179   // types being resolved to each other first.  This contains a list of types we
 180   // are waiting to recheck.
 181   std::vector<std::string> DelayedTypesToResolve;
 182
 183   const SymbolTable::VarMap &VM = PI->second;
 184   for (SymbolTable::type_const_iterator I = VM.begin(), E = VM.end();
 185        I != E; ++I) {
 186     const std::string &Name = I->first;
 187     Type *RHS = cast<Type>(I->second);
 188
 189     // Check to see if this type name is already in the dest module...
 190     Type *Entry = cast_or_null<Type>(DestST->lookup(Type::TypeTy, Name));
 191
 192     if (ResolveTypes(Entry, RHS, DestST, Name)) {
 193       // They look different, save the types 'till later to resolve.
 194       DelayedTypesToResolve.push_back(Name);
 195     }
 196   }
 197
 198   // Iteratively resolve types while we can...
 199   while (!DelayedTypesToResolve.empty()) {
 200     // Loop over all of the types, attempting to resolve them if possible...
 201     unsigned OldSize = DelayedTypesToResolve.size();
 202
 203     // Try direct resolution by name...
 204     for (unsigned i = 0; i != DelayedTypesToResolve.size(); ++i) {
 205       const std::string &Name = DelayedTypesToResolve[i];
 206       Type *T1 = cast<Type>(VM.find(Name)->second);
 207       Type *T2 = cast<Type>(DestST->lookup(Type::TypeTy, Name));
 208       if (!ResolveTypes(T2, T1, DestST, Name)) {
 209         // We are making progress!
 210         DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
 211         --i;
 212       }
 213     }
 214
 215     // Did we not eliminate any types?
 216     if (DelayedTypesToResolve.size() == OldSize) {
 217       // Attempt to resolve subelements of types.  This allows us to merge these
 218       // two types: { int* } and { opaque* }
 219       for (unsigned i = 0, e = DelayedTypesToResolve.size(); i != e; ++i) {
 220         const std::string &Name = DelayedTypesToResolve[i];
 221         PATypeHolder T1(cast<Type>(VM.find(Name)->second));
 222         PATypeHolder T2(cast<Type>(DestST->lookup(Type::TypeTy, Name)));
 223
 224         if (!RecursiveResolveTypes(T2, T1, DestST, Name)) {
 225           // We are making progress!
 226           DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
 227
 228           // Go back to the main loop, perhaps we can resolve directly by name
 229           // now...
 230           break;
 231         }
 232       }
 233
 234       // If we STILL cannot resolve the types, then there is something wrong.
 235       // Report the warning and delete one of the names.
 236       if (DelayedTypesToResolve.size() == OldSize) {
 237         const std::string &Name = DelayedTypesToResolve.back();
 238
 239         const Type *T1 = cast<Type>(VM.find(Name)->second);
 240         const Type *T2 = cast<Type>(DestST->lookup(Type::TypeTy, Name));
 241         std::cerr << "WARNING: Type conflict between types named '" << Name
 242                   <<  "'.\n    Src='";
 243         WriteTypeSymbolic(std::cerr, T1, Src);
 244         std::cerr << "'.\n   Dest='";
 245         WriteTypeSymbolic(std::cerr, T2, Dest);
 246         std::cerr << "'\n";
 247
 248         // Remove the symbol name from the destination.
 249         DelayedTypesToResolve.pop_back();
 250       }
 251     }
 252   }
 253
 254
 255   return false;
 256 }
 257
 258 static void PrintMap(const std::map<const Value*, Value*> &M) {
 259   for (std::map<const Value*, Value*>::const_iterator I = M.begin(), E =M.end();
 260        I != E; ++I) {
 261     std::cerr << " Fr: " << (void*)I->first << " ";
 262     I->first->dump();
 263     std::cerr << " To: " << (void*)I->second << " ";
 264     I->second->dump();
 265     std::cerr << "\n";
 266   }
 267 }
 268
 269
 270 // RemapOperand - Use LocalMap and GlobalMap to convert references from one
 271 // module to another.  This is somewhat sophisticated in that it can
 272 // automatically handle constant references correctly as well...
 273 //
 274 static Value *RemapOperand(const Value *In,
 275                            std::map<const Value*, Value*> &LocalMap,
 276                            std::map<const Value*, Value*> *GlobalMap) {
 277   std::map<const Value*,Value*>::const_iterator I = LocalMap.find(In);
 278   if (I != LocalMap.end()) return I->second;
 279
 280   if (GlobalMap) {
 281     I = GlobalMap->find(In);
 282     if (I != GlobalMap->end()) return I->second;
 283   }
 284
 285   // Check to see if it's a constant that we are interesting in transforming...
 286   if (const Constant *CPV = dyn_cast<Constant>(In)) {
 287     if ((!isa<DerivedType>(CPV->getType()) && !isa<ConstantExpr>(CPV)) ||
 288         isa<ConstantAggregateZero>(CPV))
 289       return const_cast<Constant*>(CPV);   // Simple constants stay identical...
 290
 291     Constant *Result = 0;
 292
 293     if (const ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
 294       const std::vector<Use> &Ops = CPA->getValues();
 295       std::vector<Constant*> Operands(Ops.size());
 296       for (unsigned i = 0, e = Ops.size(); i != e; ++i)
 297         Operands[i] =
 298           cast<Constant>(RemapOperand(Ops[i], LocalMap, GlobalMap));
 299       Result = ConstantArray::get(cast<ArrayType>(CPA->getType()), Operands);
 300     } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
 301       const std::vector<Use> &Ops = CPS->getValues();
 302       std::vector<Constant*> Operands(Ops.size());
 303       for (unsigned i = 0; i < Ops.size(); ++i)
 304         Operands[i] =
 305           cast<Constant>(RemapOperand(Ops[i], LocalMap, GlobalMap));
 306       Result = ConstantStruct::get(cast<StructType>(CPS->getType()), Operands);
 307     } else if (isa<ConstantPointerNull>(CPV)) {
 308       Result = const_cast<Constant*>(CPV);
 309     } else if (const ConstantPointerRef *CPR =
 310                       dyn_cast<ConstantPointerRef>(CPV)) {
 311       Value *V = RemapOperand(CPR->getValue(), LocalMap, GlobalMap);
 312       Result = ConstantPointerRef::get(cast<GlobalValue>(V));
 313     } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
 314       if (CE->getOpcode() == Instruction::GetElementPtr) {
 315         Value *Ptr = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
 316         std::vector<Constant*> Indices;
 317         Indices.reserve(CE->getNumOperands()-1);
 318         for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
 319           Indices.push_back(cast<Constant>(RemapOperand(CE->getOperand(i),
 320                                                         LocalMap, GlobalMap)));
 321
 322         Result = ConstantExpr::getGetElementPtr(cast<Constant>(Ptr), Indices);
 323       } else if (CE->getNumOperands() == 1) {
 324         // Cast instruction
 325         assert(CE->getOpcode() == Instruction::Cast);
 326         Value *V = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
 327         Result = ConstantExpr::getCast(cast<Constant>(V), CE->getType());
 328       } else if (CE->getNumOperands() == 2) {
 329         // Binary operator...
 330         Value *V1 = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
 331         Value *V2 = RemapOperand(CE->getOperand(1), LocalMap, GlobalMap);
 332
 333         Result = ConstantExpr::get(CE->getOpcode(), cast<Constant>(V1),
 334                                    cast<Constant>(V2));
 335       } else {
 336         assert(0 && "Unknown constant expr type!");
 337       }
 338
 339     } else {
 340       assert(0 && "Unknown type of derived type constant value!");
 341     }
 342
 343     // Cache the mapping in our local map structure...
 344     if (GlobalMap)
 345       GlobalMap->insert(std::make_pair(In, Result));
 346     else
 347       LocalMap.insert(std::make_pair(In, Result));
 348     return Result;
 349   }
 350
 351   std::cerr << "XXX LocalMap: \n";
 352   PrintMap(LocalMap);
 353
 354   if (GlobalMap) {
 355     std::cerr << "XXX GlobalMap: \n";
 356     PrintMap(*GlobalMap);
 357   }
 358
 359   std::cerr << "Couldn't remap value: " << (void*)In << " " << *In << "\n";
 360   assert(0 && "Couldn't remap value!");
 361   return 0;
 362 }
 363
 364 /// FindGlobalNamed - Look in the specified symbol table for a global with the
 365 /// specified name and type.  If an exactly matching global does not exist, see
 366 /// if there is a global which is "type compatible" with the specified
 367 /// name/type.  This allows us to resolve things like '%x = global int*' with
 368 /// '%x = global opaque*'.
 369 ///
 370 static GlobalValue *FindGlobalNamed(const std::string &Name, const Type *Ty,
 371                                     SymbolTable *ST) {
 372   // See if an exact match exists in the symbol table...
 373   if (Value *V = ST->lookup(Ty, Name)) return cast<GlobalValue>(V);
 374
 375   // It doesn't exist exactly, scan through all of the type planes in the symbol
 376   // table, checking each of them for a type-compatible version.
 377   //
 378   for (SymbolTable::iterator I = ST->begin(), E = ST->end(); I != E; ++I)
 379     if (I->first != Type::TypeTy) {
 380       SymbolTable::VarMap &VM = I->second;
 381
 382       // Does this type plane contain an entry with the specified name?
 383       SymbolTable::type_iterator TI = VM.find(Name);
 384       if (TI != VM.end()) {
 385         //
 386         // Ensure that this type if placed correctly into the symbol table.
 387         //
 388         assert(TI->second->getType() == I->first && "Type conflict!");
 389
 390         //
 391         // Save a reference to the new type.  Resolving the type can modify the
 392         // symbol table, invalidating the TI variable.
 393         //
 394         Value *ValPtr = TI->second;
 395
 396         //
 397         // Determine whether we can fold the two types together, resolving them.
 398         // If so, we can use this value.
 399         //
 400         if (!RecursiveResolveTypes(Ty, I->first, ST, ""))
 401           return cast<GlobalValue>(ValPtr);
 402       }
 403     }
 404   return 0;  // Otherwise, nothing could be found.
 405 }
 406
 407
 408 // LinkGlobals - Loop through the global variables in the src module and merge
 409 // them into the dest module.
 410 //
 411 static bool LinkGlobals(Module *Dest, const Module *Src,
 412                         std::map<const Value*, Value*> &ValueMap,
 413                     std::multimap<std::string, GlobalVariable *> &AppendingVars,
 414                         std::string *Err) {
 415   // We will need a module level symbol table if the src module has a module
 416   // level symbol table...
 417   SymbolTable *ST = (SymbolTable*)&Dest->getSymbolTable();
 418
 419   // Loop over all of the globals in the src module, mapping them over as we go
 420   //
 421   for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
 422     const GlobalVariable *SGV = I;
 423     GlobalVariable *DGV = 0;
 424     if (SGV->hasName()) {
 425       // A same named thing is a global variable, because the only two things
 426       // that may be in a module level symbol table are Global Vars and
 427       // Functions, and they both have distinct, nonoverlapping, possible types.
 428       //
 429       DGV = cast_or_null<GlobalVariable>(FindGlobalNamed(SGV->getName(),
 430                                                          SGV->getType(), ST));
 431     }
 432
 433     assert(SGV->hasInitializer() || SGV->hasExternalLinkage() &&
 434            "Global must either be external or have an initializer!");
 435
 436     bool SGExtern = SGV->isExternal();
 437     bool DGExtern = DGV ? DGV->isExternal() : false;
 438
 439     if (!DGV || DGV->hasInternalLinkage() || SGV->hasInternalLinkage()) {
 440       // No linking to be performed, simply create an identical version of the
 441       // symbol over in the dest module... the initializer will be filled in
 442       // later by LinkGlobalInits...
 443       //
 444       GlobalVariable *NewDGV =
 445         new GlobalVariable(SGV->getType()->getElementType(),
 446                            SGV->isConstant(), SGV->getLinkage(), /*init*/0,
 447                            SGV->getName(), Dest);
 448
 449       // If the LLVM runtime renamed the global, but it is an externally visible
 450       // symbol, DGV must be an existing global with internal linkage.  Rename
 451       // it.
 452       if (NewDGV->getName() != SGV->getName() && !NewDGV->hasInternalLinkage()){
 453         assert(DGV && DGV->getName() == SGV->getName() &&
 454                DGV->hasInternalLinkage());
 455         DGV->setName("");
 456         NewDGV->setName(SGV->getName());  // Force the name back
 457         DGV->setName(SGV->getName());     // This will cause a renaming
 458         assert(NewDGV->getName() == SGV->getName() &&
 459                DGV->getName() != SGV->getName());
 460       }
 461
 462       // Make sure to remember this mapping...
 463       ValueMap.insert(std::make_pair(SGV, NewDGV));
 464       if (SGV->hasAppendingLinkage())
 465         // Keep track that this is an appending variable...
 466         AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
 467
 468     } else if (SGV->isExternal()) {
 469       // If SGV is external or if both SGV & DGV are external..  Just link the
 470       // external globals, we aren't adding anything.
 471       ValueMap.insert(std::make_pair(SGV, DGV));
 472
 473     } else if (DGV->isExternal()) {   // If DGV is external but SGV is not...
 474       ValueMap.insert(std::make_pair(SGV, DGV));
 475       DGV->setLinkage(SGV->getLinkage());    // Inherit linkage!
 476     } else if (SGV->hasWeakLinkage() || SGV->hasLinkOnceLinkage()) {
 477       // At this point we know that DGV has LinkOnce, Appending, Weak, or
 478       // External linkage.  If DGV is Appending, this is an error.
 479       if (DGV->hasAppendingLinkage())
 480         return Error(Err, "Linking globals named '" + SGV->getName() +
 481                      " ' with 'weak' and 'appending' linkage is not allowed!");
 482
 483       if (SGV->isConstant() != DGV->isConstant())
 484         return Error(Err, "Global Variable Collision on '" +
 485                      SGV->getType()->getDescription() + " %" + SGV->getName() +
 486                      "' - Global variables differ in const'ness");
 487
 488       // Otherwise, just perform the link.
 489       ValueMap.insert(std::make_pair(SGV, DGV));
 490
 491       // Linkonce+Weak = Weak
 492       if (DGV->hasLinkOnceLinkage() && SGV->hasWeakLinkage())
 493         DGV->setLinkage(SGV->getLinkage());
 494
 495     } else if (DGV->hasWeakLinkage() || DGV->hasLinkOnceLinkage()) {
 496       // At this point we know that SGV has LinkOnce, Appending, or External
 497       // linkage.  If SGV is Appending, this is an error.
 498       if (SGV->hasAppendingLinkage())
 499         return Error(Err, "Linking globals named '" + SGV->getName() +
 500                      " ' with 'weak' and 'appending' linkage is not allowed!");
 501
 502       if (SGV->isConstant() != DGV->isConstant())
 503         return Error(Err, "Global Variable Collision on '" +
 504                      SGV->getType()->getDescription() + " %" + SGV->getName() +
 505                      "' - Global variables differ in const'ness");
 506
 507       if (!SGV->hasLinkOnceLinkage())
 508         DGV->setLinkage(SGV->getLinkage());    // Inherit linkage!
 509       ValueMap.insert(std::make_pair(SGV, DGV));
 510
 511     } else if (SGV->getLinkage() != DGV->getLinkage()) {
 512       return Error(Err, "Global variables named '" + SGV->getName() +
 513                    "' have different linkage specifiers!");
 514     } else if (SGV->hasExternalLinkage()) {
 515       // Allow linking two exactly identical external global variables...
 516       if (SGV->isConstant() != DGV->isConstant())
 517         return Error(Err, "Global Variable Collision on '" +
 518                      SGV->getType()->getDescription() + " %" + SGV->getName() +
 519                      "' - Global variables differ in const'ness");
 520
 521       if (SGV->getInitializer() != DGV->getInitializer())
 522         return Error(Err, "Global Variable Collision on '" +
 523                      SGV->getType()->getDescription() + " %" + SGV->getName() +
 524                     "' - External linkage globals have different initializers");
 525
 526       ValueMap.insert(std::make_pair(SGV, DGV));
 527     } else if (SGV->hasAppendingLinkage()) {
 528       // No linking is performed yet.  Just insert a new copy of the global, and
 529       // keep track of the fact that it is an appending variable in the
 530       // AppendingVars map.  The name is cleared out so that no linkage is
 531       // performed.
 532       GlobalVariable *NewDGV =
 533         new GlobalVariable(SGV->getType()->getElementType(),
 534                            SGV->isConstant(), SGV->getLinkage(), /*init*/0,
 535                            "", Dest);
 536
 537       // Make sure to remember this mapping...
 538       ValueMap.insert(std::make_pair(SGV, NewDGV));
 539
 540       // Keep track that this is an appending variable...
 541       AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
 542     } else {
 543       assert(0 && "Unknown linkage!");
 544     }
 545   }
 546   return false;
 547 }
 548
 549
 550 // LinkGlobalInits - Update the initializers in the Dest module now that all
 551 // globals that may be referenced are in Dest.
 552 //
 553 static bool LinkGlobalInits(Module *Dest, const Module *Src,
 554                             std::map<const Value*, Value*> &ValueMap,
 555                             std::string *Err) {
 556
 557   // Loop over all of the globals in the src module, mapping them over as we go
 558   //
 559   for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
 560     const GlobalVariable *SGV = I;
 561
 562     if (SGV->hasInitializer()) {      // Only process initialized GV's
 563       // Figure out what the initializer looks like in the dest module...
 564       Constant *SInit =
 565         cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap, 0));
 566
 567       GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[SGV]);
 568       if (DGV->hasInitializer()) {
 569         if (SGV->hasExternalLinkage()) {
 570           if (DGV->getInitializer() != SInit)
 571             return Error(Err, "Global Variable Collision on '" +
 572                          SGV->getType()->getDescription() +"':%"+SGV->getName()+
 573                          " - Global variables have different initializers");
 574         } else if (DGV->hasLinkOnceLinkage() || DGV->hasWeakLinkage()) {
 575           // Nothing is required, mapped values will take the new global
 576           // automatically.
 577         } else if (SGV->hasLinkOnceLinkage() || SGV->hasWeakLinkage()) {
 578           // Nothing is required, mapped values will take the new global
 579           // automatically.
 580         } else if (DGV->hasAppendingLinkage()) {
 581           assert(0 && "Appending linkage unimplemented!");
 582         } else {
 583           assert(0 && "Unknown linkage!");
 584         }
 585       } else {
 586         // Copy the initializer over now...
 587         DGV->setInitializer(SInit);
 588       }
 589     }
 590   }
 591   return false;
 592 }
 593
 594 // LinkFunctionProtos - Link the functions together between the two modules,
 595 // without doing function bodies... this just adds external function prototypes
 596 // to the Dest function...
 597 //
 598 static bool LinkFunctionProtos(Module *Dest, const Module *Src,
 599                                std::map<const Value*, Value*> &ValueMap,
 600                                std::string *Err) {
 601   SymbolTable *ST = (SymbolTable*)&Dest->getSymbolTable();
 602
 603   // Loop over all of the functions in the src module, mapping them over as we
 604   // go
 605   //
 606   for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
 607     const Function *SF = I;   // SrcFunction
 608     Function *DF = 0;
 609     if (SF->hasName())
 610       // The same named thing is a Function, because the only two things
 611       // that may be in a module level symbol table are Global Vars and
 612       // Functions, and they both have distinct, nonoverlapping, possible types.
 613       //
 614       DF = cast_or_null<Function>(FindGlobalNamed(SF->getName(), SF->getType(),
 615                                                   ST));
 616
 617     if (!DF || SF->hasInternalLinkage() || DF->hasInternalLinkage()) {
 618       // Function does not already exist, simply insert an function signature
 619       // identical to SF into the dest module...
 620       Function *NewDF = new Function(SF->getFunctionType(), SF->getLinkage(),
 621                                      SF->getName(), Dest);
 622
 623       // If the LLVM runtime renamed the function, but it is an externally
 624       // visible symbol, DF must be an existing function with internal linkage.
 625       // Rename it.
 626       if (NewDF->getName() != SF->getName() && !NewDF->hasInternalLinkage()) {
 627         assert(DF && DF->getName() == SF->getName() &&DF->hasInternalLinkage());
 628         DF->setName("");
 629         NewDF->setName(SF->getName());  // Force the name back
 630         DF->setName(SF->getName());     // This will cause a renaming
 631         assert(NewDF->getName() == SF->getName() &&
 632                DF->getName() != SF->getName());
 633       }
 634
 635       // ... and remember this mapping...
 636       ValueMap.insert(std::make_pair(SF, NewDF));
 637     } else if (SF->isExternal()) {
 638       // If SF is external or if both SF & DF are external..  Just link the
 639       // external functions, we aren't adding anything.
 640       ValueMap.insert(std::make_pair(SF, DF));
 641     } else if (DF->isExternal()) {   // If DF is external but SF is not...
 642       // Link the external functions, update linkage qualifiers
 643       ValueMap.insert(std::make_pair(SF, DF));
 644       DF->setLinkage(SF->getLinkage());
 645
 646     } else if (SF->hasWeakLinkage() || SF->hasLinkOnceLinkage()) {
 647       // At this point we know that DF has LinkOnce, Weak, or External linkage.
 648       ValueMap.insert(std::make_pair(SF, DF));
 649
 650       // Linkonce+Weak = Weak
 651       if (DF->hasLinkOnceLinkage() && SF->hasWeakLinkage())
 652         DF->setLinkage(SF->getLinkage());
 653
 654     } else if (DF->hasWeakLinkage() || DF->hasLinkOnceLinkage()) {
 655       // At this point we know that SF has LinkOnce or External linkage.
 656       ValueMap.insert(std::make_pair(SF, DF));
 657       if (!SF->hasLinkOnceLinkage())   // Don't inherit linkonce linkage
 658         DF->setLinkage(SF->getLinkage());
 659
 660     } else if (SF->getLinkage() != DF->getLinkage()) {
 661       return Error(Err, "Functions named '" + SF->getName() +
 662                    "' have different linkage specifiers!");
 663     } else if (SF->hasExternalLinkage()) {
 664       // The function is defined in both modules!!
 665       return Error(Err, "Function '" +
 666                    SF->getFunctionType()->getDescription() + "':\"" +
 667                    SF->getName() + "\" - Function is already defined!");
 668     } else {
 669       assert(0 && "Unknown linkage configuration found!");
 670     }
 671   }
 672   return false;
 673 }
 674
 675 // LinkFunctionBody - Copy the source function over into the dest function and
 676 // fix up references to values.  At this point we know that Dest is an external
 677 // function, and that Src is not.
 678 //
 679 static bool LinkFunctionBody(Function *Dest, const Function *Src,
 680                              std::map<const Value*, Value*> &GlobalMap,
 681                              std::string *Err) {
 682   assert(Src && Dest && Dest->isExternal() && !Src->isExternal());
 683   std::map<const Value*, Value*> LocalMap;   // Map for function local values
 684
 685   // Go through and convert function arguments over...
 686   Function::aiterator DI = Dest->abegin();
 687   for (Function::const_aiterator I = Src->abegin(), E = Src->aend();
 688        I != E; ++I, ++DI) {
 689     DI->setName(I->getName());  // Copy the name information over...
 690
 691     // Add a mapping to our local map
 692     LocalMap.insert(std::make_pair(I, DI));
 693   }
 694
 695   // Loop over all of the basic blocks, copying the instructions over...
 696   //
 697   for (Function::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
 698     // Create new basic block and add to mapping and the Dest function...
 699     BasicBlock *DBB = new BasicBlock(I->getName(), Dest);
 700     LocalMap.insert(std::make_pair(I, DBB));
 701
 702     // Loop over all of the instructions in the src basic block, copying them
 703     // over.  Note that this is broken in a strict sense because the cloned
 704     // instructions will still be referencing values in the Src module, not
 705     // the remapped values.  In our case, however, we will not get caught and
 706     // so we can delay patching the values up until later...
 707     //
 708     for (BasicBlock::const_iterator II = I->begin(), IE = I->end();
 709          II != IE; ++II) {
 710       Instruction *DI = II->clone();
 711       DI->setName(II->getName());
 712       DBB->getInstList().push_back(DI);
 713       LocalMap.insert(std::make_pair(II, DI));
 714     }
 715   }
 716
 717   // At this point, all of the instructions and values of the function are now
 718   // copied over.  The only problem is that they are still referencing values in
 719   // the Source function as operands.  Loop through all of the operands of the
 720   // functions and patch them up to point to the local versions...
 721   //
 722   for (Function::iterator BB = Dest->begin(), BE = Dest->end(); BB != BE; ++BB)
 723     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 724       for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
 725            OI != OE; ++OI)
 726         *OI = RemapOperand(*OI, LocalMap, &GlobalMap);
 727
 728   return false;
 729 }
 730
 731
 732 // LinkFunctionBodies - Link in the function bodies that are defined in the
 733 // source module into the DestModule.  This consists basically of copying the
 734 // function over and fixing up references to values.
 735 //
 736 static bool LinkFunctionBodies(Module *Dest, const Module *Src,
 737                                std::map<const Value*, Value*> &ValueMap,
 738                                std::string *Err) {
 739
 740   // Loop over all of the functions in the src module, mapping them over as we
 741   // go
 742   //
 743   for (Module::const_iterator SF = Src->begin(), E = Src->end(); SF != E; ++SF){
 744     if (!SF->isExternal()) {                  // No body if function is external
 745       Function *DF = cast<Function>(ValueMap[SF]); // Destination function
 746
 747       // DF not external SF external?
 748       if (DF->isExternal()) {
 749         // Only provide the function body if there isn't one already.
 750         if (LinkFunctionBody(DF, SF, ValueMap, Err))
 751           return true;
 752       }
 753     }
 754   }
 755   return false;
 756 }
 757
 758 // LinkAppendingVars - If there were any appending global variables, link them
 759 // together now.  Return true on error.
 760 //
 761 static bool LinkAppendingVars(Module *M,
 762                   std::multimap<std::string, GlobalVariable *> &AppendingVars,
 763                               std::string *ErrorMsg) {
 764   if (AppendingVars.empty()) return false; // Nothing to do.
 765
 766   // Loop over the multimap of appending vars, processing any variables with the
 767   // same name, forming a new appending global variable with both of the
 768   // initializers merged together, then rewrite references to the old variables
 769   // and delete them.
 770   //
 771   std::vector<Constant*> Inits;
 772   while (AppendingVars.size() > 1) {
 773     // Get the first two elements in the map...
 774     std::multimap<std::string,
 775       GlobalVariable*>::iterator Second = AppendingVars.begin(), First=Second++;
 776
 777     // If the first two elements are for different names, there is no pair...
 778     // Otherwise there is a pair, so link them together...
 779     if (First->first == Second->first) {
 780       GlobalVariable *G1 = First->second, *G2 = Second->second;
 781       const ArrayType *T1 = cast<ArrayType>(G1->getType()->getElementType());
 782       const ArrayType *T2 = cast<ArrayType>(G2->getType()->getElementType());
 783
 784       // Check to see that they two arrays agree on type...
 785       if (T1->getElementType() != T2->getElementType())
 786         return Error(ErrorMsg,
 787          "Appending variables with different element types need to be linked!");
 788       if (G1->isConstant() != G2->isConstant())
 789         return Error(ErrorMsg,
 790                      "Appending variables linked with different const'ness!");
 791
 792       unsigned NewSize = T1->getNumElements() + T2->getNumElements();
 793       ArrayType *NewType = ArrayType::get(T1->getElementType(), NewSize);
 794
 795       // Create the new global variable...
 796       GlobalVariable *NG =
 797         new GlobalVariable(NewType, G1->isConstant(), G1->getLinkage(),
 798                            /*init*/0, First->first, M);
 799
 800       // Merge the initializer...
 801       Inits.reserve(NewSize);
 802       if (ConstantArray *I = dyn_cast<ConstantArray>(G1->getInitializer())) {
 803         for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
 804           Inits.push_back(cast<Constant>(I->getValues()[i]));
 805       } else {
 806         assert(isa<ConstantAggregateZero>(G1->getInitializer()));
 807         Constant *CV = Constant::getNullValue(T1->getElementType());
 808         for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
 809           Inits.push_back(CV);
 810       }
 811       if (ConstantArray *I = dyn_cast<ConstantArray>(G2->getInitializer())) {
 812         for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
 813           Inits.push_back(cast<Constant>(I->getValues()[i]));
 814       } else {
 815         assert(isa<ConstantAggregateZero>(G2->getInitializer()));
 816         Constant *CV = Constant::getNullValue(T2->getElementType());
 817         for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
 818           Inits.push_back(CV);
 819       }
 820       NG->setInitializer(ConstantArray::get(NewType, Inits));
 821       Inits.clear();
 822
 823       // Replace any uses of the two global variables with uses of the new
 824       // global...
 825
 826       // FIXME: This should rewrite simple/straight-forward uses such as
 827       // getelementptr instructions to not use the Cast!
 828       ConstantPointerRef *NGCP = ConstantPointerRef::get(NG);
 829       G1->replaceAllUsesWith(ConstantExpr::getCast(NGCP, G1->getType()));
 830       G2->replaceAllUsesWith(ConstantExpr::getCast(NGCP, G2->getType()));
 831
 832       // Remove the two globals from the module now...
 833       M->getGlobalList().erase(G1);
 834       M->getGlobalList().erase(G2);
 835
 836       // Put the new global into the AppendingVars map so that we can handle
 837       // linking of more than two vars...
 838       Second->second = NG;
 839     }
 840     AppendingVars.erase(First);
 841   }
 842
 843   return false;
 844 }
 845
 846
 847 // LinkModules - This function links two modules together, with the resulting
 848 // left module modified to be the composite of the two input modules.  If an
 849 // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
 850 // the problem.  Upon failure, the Dest module could be in a modified state, and
 851 // shouldn't be relied on to be consistent.
 852 //
 853 bool llvm::LinkModules(Module *Dest, const Module *Src, std::string *ErrorMsg) {
 854   if (Dest->getEndianness() == Module::AnyEndianness)
 855     Dest->setEndianness(Src->getEndianness());
 856   if (Dest->getPointerSize() == Module::AnyPointerSize)
 857     Dest->setPointerSize(Src->getPointerSize());
 858
 859   if (Src->getEndianness() != Module::AnyEndianness &&
 860       Dest->getEndianness() != Src->getEndianness())
 861     std::cerr << "WARNING: Linking two modules of different endianness!\n";
 862   if (Src->getPointerSize() != Module::AnyPointerSize &&
 863       Dest->getPointerSize() != Src->getPointerSize())
 864     std::cerr << "WARNING: Linking two modules of different pointer size!\n";
 865
 866   // LinkTypes - Go through the symbol table of the Src module and see if any
 867   // types are named in the src module that are not named in the Dst module.
 868   // Make sure there are no type name conflicts.
 869   //
 870   if (LinkTypes(Dest, Src, ErrorMsg)) return true;
 871
 872   // ValueMap - Mapping of values from what they used to be in Src, to what they
 873   // are now in Dest.
 874   //
 875   std::map<const Value*, Value*> ValueMap;
 876
 877   // AppendingVars - Keep track of global variables in the destination module
 878   // with appending linkage.  After the module is linked together, they are
 879   // appended and the module is rewritten.
 880   //
 881   std::multimap<std::string, GlobalVariable *> AppendingVars;
 882
 883   // Add all of the appending globals already in the Dest module to
 884   // AppendingVars.
 885   for (Module::giterator I = Dest->gbegin(), E = Dest->gend(); I != E; ++I)
 886     if (I->hasAppendingLinkage())
 887       AppendingVars.insert(std::make_pair(I->getName(), I));
 888
 889   // Insert all of the globals in src into the Dest module... without linking
 890   // initializers (which could refer to functions not yet mapped over).
 891   //
 892   if (LinkGlobals(Dest, Src, ValueMap, AppendingVars, ErrorMsg)) return true;
 893
 894   // Link the functions together between the two modules, without doing function
 895   // bodies... this just adds external function prototypes to the Dest
 896   // function...  We do this so that when we begin processing function bodies,
 897   // all of the global values that may be referenced are available in our
 898   // ValueMap.
 899   //
 900   if (LinkFunctionProtos(Dest, Src, ValueMap, ErrorMsg)) return true;
 901
 902   // Update the initializers in the Dest module now that all globals that may
 903   // be referenced are in Dest.
 904   //
 905   if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
 906
 907   // Link in the function bodies that are defined in the source module into the
 908   // DestModule.  This consists basically of copying the function over and
 909   // fixing up references to values.
 910   //
 911   if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
 912
 913   // If there were any appending global variables, link them together now.
 914   //
 915   if (LinkAppendingVars(Dest, AppendingVars, ErrorMsg)) return true;
 916
 917   return false;
 918 }
 919