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