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