lib/Linker/LinkModules.cpp

   1 //===- Linker.cpp - Module Linker Implementation --------------------------===//
   2 //
   3 // This file implements the LLVM module linker.
   4 //
   5 // Specifically, this:
   6 //  * Merges global variables between the two modules
   7 //    * Uninit + Uninit = Init, Init + Uninit = Init, Init + Init = Error if !=
   8 //  * Merges functions between two modules
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #include "llvm/Transforms/Utils/Linker.h"
  13 #include "llvm/Module.h"
  14 #include "llvm/SymbolTable.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/iOther.h"
  17 #include "llvm/Constants.h"
  18
  19 // Error - Simple wrapper function to conditionally assign to E and return true.
  20 // This just makes error return conditions a little bit simpler...
  21 //
  22 static inline bool Error(std::string *E, std::string Message) {
  23   if (E) *E = Message;
  24   return true;
  25 }
  26
  27 // LinkTypes - Go through the symbol table of the Src module and see if any
  28 // types are named in the src module that are not named in the Dst module.
  29 // Make sure there are no type name conflicts.
  30 //
  31 static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
  32   SymbolTable       *DestST = &Dest->getSymbolTable();
  33   const SymbolTable *SrcST  = &Src->getSymbolTable();
  34
  35   // Look for a type plane for Type's...
  36   SymbolTable::const_iterator PI = SrcST->find(Type::TypeTy);
  37   if (PI == SrcST->end()) return false;  // No named types, do nothing.
  38
  39   const SymbolTable::VarMap &VM = PI->second;
  40   for (SymbolTable::type_const_iterator I = VM.begin(), E = VM.end();
  41        I != E; ++I) {
  42     const std::string &Name = I->first;
  43     const Type *RHS = cast<Type>(I->second);
  44
  45     // Check to see if this type name is already in the dest module...
  46     const Type *Entry = cast_or_null<Type>(DestST->lookup(Type::TypeTy, Name));
  47     if (Entry && !isa<OpaqueType>(Entry)) {  // Yup, the value already exists...
  48       if (Entry != RHS) {
  49         if (OpaqueType *OT = dyn_cast<OpaqueType>(const_cast<Type*>(RHS))) {
  50           OT->refineAbstractTypeTo(Entry);
  51         } else {
  52           // If it's the same, noop.  Otherwise, error.
  53           return Error(Err, "Type named '" + Name +
  54                        "' of different shape in modules.\n  Src='" +
  55                        Entry->getDescription() + "'.\n  Dst='" +
  56                        RHS->getDescription() + "'");
  57         }
  58       }
  59     } else {                       // Type not in dest module.  Add it now.
  60       if (Entry) {
  61         OpaqueType *OT = cast<OpaqueType>(const_cast<Type*>(Entry));
  62         OT->refineAbstractTypeTo(RHS);
  63       }
  64
  65       // TODO: FIXME WHEN TYPES AREN'T CONST
  66       DestST->insert(Name, const_cast<Type*>(RHS));
  67     }
  68   }
  69   return false;
  70 }
  71
  72 static void PrintMap(const std::map<const Value*, Value*> &M) {
  73   for (std::map<const Value*, Value*>::const_iterator I = M.begin(), E =M.end();
  74        I != E; ++I) {
  75     std::cerr << " Fr: " << (void*)I->first << " ";
  76     I->first->dump();
  77     std::cerr << " To: " << (void*)I->second << " ";
  78     I->second->dump();
  79     std::cerr << "\n";
  80   }
  81 }
  82
  83
  84 // RemapOperand - Use LocalMap and GlobalMap to convert references from one
  85 // module to another.  This is somewhat sophisticated in that it can
  86 // automatically handle constant references correctly as well...
  87 //
  88 static Value *RemapOperand(const Value *In,
  89                            std::map<const Value*, Value*> &LocalMap,
  90                            std::map<const Value*, Value*> *GlobalMap) {
  91   std::map<const Value*,Value*>::const_iterator I = LocalMap.find(In);
  92   if (I != LocalMap.end()) return I->second;
  93
  94   if (GlobalMap) {
  95     I = GlobalMap->find(In);
  96     if (I != GlobalMap->end()) return I->second;
  97   }
  98
  99   // Check to see if it's a constant that we are interesting in transforming...
 100   if (const Constant *CPV = dyn_cast<Constant>(In)) {
 101     if (!isa<DerivedType>(CPV->getType()) && !isa<ConstantExpr>(CPV))
 102       return const_cast<Constant*>(CPV);   // Simple constants stay identical...
 103
 104     Constant *Result = 0;
 105
 106     if (const ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
 107       const std::vector<Use> &Ops = CPA->getValues();
 108       std::vector<Constant*> Operands(Ops.size());
 109       for (unsigned i = 0, e = Ops.size(); i != e; ++i)
 110         Operands[i] =
 111           cast<Constant>(RemapOperand(Ops[i], LocalMap, GlobalMap));
 112       Result = ConstantArray::get(cast<ArrayType>(CPA->getType()), Operands);
 113     } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
 114       const std::vector<Use> &Ops = CPS->getValues();
 115       std::vector<Constant*> Operands(Ops.size());
 116       for (unsigned i = 0; i < Ops.size(); ++i)
 117         Operands[i] =
 118           cast<Constant>(RemapOperand(Ops[i], LocalMap, GlobalMap));
 119       Result = ConstantStruct::get(cast<StructType>(CPS->getType()), Operands);
 120     } else if (isa<ConstantPointerNull>(CPV)) {
 121       Result = const_cast<Constant*>(CPV);
 122     } else if (const ConstantPointerRef *CPR =
 123                       dyn_cast<ConstantPointerRef>(CPV)) {
 124       Value *V = RemapOperand(CPR->getValue(), LocalMap, GlobalMap);
 125       Result = ConstantPointerRef::get(cast<GlobalValue>(V));
 126     } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
 127       if (CE->getOpcode() == Instruction::GetElementPtr) {
 128         Value *Ptr = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
 129         std::vector<Constant*> Indices;
 130         Indices.reserve(CE->getNumOperands()-1);
 131         for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
 132           Indices.push_back(cast<Constant>(RemapOperand(CE->getOperand(i),
 133                                                         LocalMap, GlobalMap)));
 134
 135         Result = ConstantExpr::getGetElementPtr(cast<Constant>(Ptr), Indices);
 136       } else if (CE->getNumOperands() == 1) {
 137         // Cast instruction
 138         assert(CE->getOpcode() == Instruction::Cast);
 139         Value *V = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
 140         Result = ConstantExpr::getCast(cast<Constant>(V), CE->getType());
 141       } else if (CE->getNumOperands() == 2) {
 142         // Binary operator...
 143         Value *V1 = RemapOperand(CE->getOperand(0), LocalMap, GlobalMap);
 144         Value *V2 = RemapOperand(CE->getOperand(1), LocalMap, GlobalMap);
 145
 146         Result = ConstantExpr::get(CE->getOpcode(), cast<Constant>(V1),
 147                                    cast<Constant>(V2));
 148       } else {
 149         assert(0 && "Unknown constant expr type!");
 150       }
 151
 152     } else {
 153       assert(0 && "Unknown type of derived type constant value!");
 154     }
 155
 156     // Cache the mapping in our local map structure...
 157     if (GlobalMap)
 158       GlobalMap->insert(std::make_pair(In, Result));
 159     else
 160       LocalMap.insert(std::make_pair(In, Result));
 161     return Result;
 162   }
 163
 164   std::cerr << "XXX LocalMap: \n";
 165   PrintMap(LocalMap);
 166
 167   if (GlobalMap) {
 168     std::cerr << "XXX GlobalMap: \n";
 169     PrintMap(*GlobalMap);
 170   }
 171
 172   std::cerr << "Couldn't remap value: " << (void*)In << " " << *In << "\n";
 173   assert(0 && "Couldn't remap value!");
 174   return 0;
 175 }
 176
 177
 178 // LinkGlobals - Loop through the global variables in the src module and merge
 179 // them into the dest module...
 180 //
 181 static bool LinkGlobals(Module *Dest, const Module *Src,
 182                         std::map<const Value*, Value*> &ValueMap,
 183                         std::string *Err) {
 184   // We will need a module level symbol table if the src module has a module
 185   // level symbol table...
 186   SymbolTable *ST = (SymbolTable*)&Dest->getSymbolTable();
 187
 188   // Loop over all of the globals in the src module, mapping them over as we go
 189   //
 190   for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
 191     const GlobalVariable *SGV = I;
 192     GlobalVariable *DGV = 0;
 193     if (SGV->hasName()) {
 194       // A same named thing is a global variable, because the only two things
 195       // that may be in a module level symbol table are Global Vars and
 196       // Functions, and they both have distinct, nonoverlapping, possible types.
 197       //
 198       DGV = cast_or_null<GlobalVariable>(ST->lookup(SGV->getType(),
 199                                                     SGV->getName()));
 200     }
 201
 202     assert(SGV->hasInitializer() || SGV->hasExternalLinkage() &&
 203            "Global must either be external or have an initializer!");
 204
 205     bool SGExtern = SGV->isExternal();
 206     bool DGExtern = DGV ? DGV->isExternal() : false;
 207
 208     if (!DGV || DGV->hasInternalLinkage() || SGV->hasInternalLinkage()) {
 209       // No linking to be performed, simply create an identical version of the
 210       // symbol over in the dest module... the initializer will be filled in
 211       // later by LinkGlobalInits...
 212       //
 213       GlobalVariable *NewDGV =
 214         new GlobalVariable(SGV->getType()->getElementType(),
 215                            SGV->isConstant(), SGV->getLinkage(), /*init*/0,
 216                            SGV->getName(), Dest);
 217
 218       // If the LLVM runtime renamed the global, but it is an externally visible
 219       // symbol, DGV must be an existing global with internal linkage.  Rename
 220       // it.
 221       if (NewDGV->getName() != SGV->getName() && !NewDGV->hasInternalLinkage()){
 222         assert(DGV && DGV->getName() == SGV->getName() &&
 223                DGV->hasInternalLinkage());
 224         DGV->setName("");
 225         NewDGV->setName(SGV->getName());  // Force the name back
 226         DGV->setName(SGV->getName());     // This will cause a renaming
 227         assert(NewDGV->getName() == SGV->getName() &&
 228                DGV->getName() != SGV->getName());
 229       }
 230
 231       // Make sure to remember this mapping...
 232       ValueMap.insert(std::make_pair(SGV, NewDGV));
 233     } else if (!SGExtern && !DGExtern && SGV->getLinkage() !=DGV->getLinkage()){
 234       return Error(Err, "Global variables named '" + SGV->getName() +
 235                    "' have different linkage specifiers!");
 236     } else if (SGV->hasExternalLinkage() || SGV->hasLinkOnceLinkage() ||
 237                SGV->hasAppendingLinkage()) {
 238       // If the global variable has a name, and that name is already in use in
 239       // the Dest module, make sure that the name is a compatible global
 240       // variable...
 241       //
 242       // Check to see if the two GV's have the same Const'ness...
 243       if (SGV->isConstant() != DGV->isConstant())
 244         return Error(Err, "Global Variable Collision on '" +
 245                      SGV->getType()->getDescription() + "':%" + SGV->getName() +
 246                      " - Global variables differ in const'ness");
 247       if (DGExtern)
 248         DGV->setLinkage(SGV->getLinkage());
 249
 250       // Okay, everything is cool, remember the mapping...
 251       ValueMap.insert(std::make_pair(SGV, DGV));
 252     } else {
 253       assert(0 && "Unknown linkage!");
 254     }
 255   }
 256   return false;
 257 }
 258
 259
 260 // LinkGlobalInits - Update the initializers in the Dest module now that all
 261 // globals that may be referenced are in Dest.
 262 //
 263 static bool LinkGlobalInits(Module *Dest, const Module *Src,
 264                             std::map<const Value*, Value*> &ValueMap,
 265                             std::string *Err) {
 266
 267   // Loop over all of the globals in the src module, mapping them over as we go
 268   //
 269   for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
 270     const GlobalVariable *SGV = I;
 271
 272     if (SGV->hasInitializer()) {      // Only process initialized GV's
 273       // Figure out what the initializer looks like in the dest module...
 274       Constant *SInit =
 275         cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap, 0));
 276
 277       GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[SGV]);
 278       if (DGV->hasInitializer()) {
 279         assert(SGV->getLinkage() == DGV->getLinkage());
 280         if (SGV->hasExternalLinkage()) {
 281           if (DGV->getInitializer() != SInit)
 282             return Error(Err, "Global Variable Collision on '" +
 283                          SGV->getType()->getDescription() +"':%"+SGV->getName()+
 284                          " - Global variables have different initializers");
 285         } else if (DGV->hasLinkOnceLinkage()) {
 286           // Nothing is required, mapped values will take the new global
 287           // automatically.
 288         } else if (DGV->hasAppendingLinkage()) {
 289           assert(0 && "Appending linkage unimplemented!");
 290         } else {
 291           assert(0 && "Unknown linkage!");
 292         }
 293       } else {
 294         // Copy the initializer over now...
 295         DGV->setInitializer(SInit);
 296       }
 297     }
 298   }
 299   return false;
 300 }
 301
 302 // LinkFunctionProtos - Link the functions together between the two modules,
 303 // without doing function bodies... this just adds external function prototypes
 304 // to the Dest function...
 305 //
 306 static bool LinkFunctionProtos(Module *Dest, const Module *Src,
 307                                std::map<const Value*, Value*> &ValueMap,
 308                                std::string *Err) {
 309   SymbolTable *ST = (SymbolTable*)&Dest->getSymbolTable();
 310
 311   // Loop over all of the functions in the src module, mapping them over as we
 312   // go
 313   //
 314   for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
 315     const Function *SF = I;   // SrcFunction
 316     Function *DF = 0;
 317     if (SF->hasName())
 318       // The same named thing is a Function, because the only two things
 319       // that may be in a module level symbol table are Global Vars and
 320       // Functions, and they both have distinct, nonoverlapping, possible types.
 321       //
 322       DF = cast_or_null<Function>(ST->lookup(SF->getType(), SF->getName()));
 323
 324     bool SFExtern = SF->isExternal();
 325     bool DFExtern = DF ? DF->isExternal() : false;
 326
 327     if (!DF || SF->hasInternalLinkage() || DF->hasInternalLinkage()) {
 328       // Function does not already exist, simply insert an function signature
 329       // identical to SF into the dest module...
 330       Function *NewDF = new Function(SF->getFunctionType(), SF->getLinkage(),
 331                                      SF->getName(), Dest);
 332
 333       // If the LLVM runtime renamed the function, but it is an externally
 334       // visible symbol, DF must be an existing function with internal linkage.
 335       // Rename it.
 336       if (NewDF->getName() != SF->getName() && !NewDF->hasInternalLinkage()) {
 337         assert(DF && DF->getName() == SF->getName() &&DF->hasInternalLinkage());
 338         DF->setName("");
 339         NewDF->setName(SF->getName());  // Force the name back
 340         DF->setName(SF->getName());     // This will cause a renaming
 341         assert(NewDF->getName() == SF->getName() &&
 342                DF->getName() != SF->getName());
 343       }
 344
 345       // ... and remember this mapping...
 346       ValueMap.insert(std::make_pair(SF, NewDF));
 347     } else if (SF->getLinkage() == GlobalValue::AppendingLinkage) {
 348       return Error(Err, "Functions named '" + SF->getName() +
 349                    "' have appending linkage!");
 350     } else if (!SFExtern && !DFExtern && SF->getLinkage() != DF->getLinkage()) {
 351       return Error(Err, "Functions named '" + SF->getName() +
 352                    "' have different linkage specifiers!");
 353     } else if (SF->getLinkage() == GlobalValue::ExternalLinkage) {
 354       // If the function has a name, and that name is already in use in the Dest
 355       // module, make sure that the name is a compatible function...
 356       //
 357       // Check to make sure the function is not defined in both modules...
 358       if (!SF->isExternal() && !DF->isExternal())
 359         return Error(Err, "Function '" +
 360                      SF->getFunctionType()->getDescription() + "':\"" +
 361                      SF->getName() + "\" - Function is already defined!");
 362
 363       if (DFExtern)
 364         DF->setLinkage(SF->getLinkage());
 365
 366       // Otherwise, just remember this mapping...
 367       ValueMap.insert(std::make_pair(SF, DF));
 368     } else if (SF->getLinkage() == GlobalValue::LinkOnceLinkage) {
 369       // Completely ignore the source function.
 370       ValueMap.insert(std::make_pair(SF, DF));
 371     }
 372   }
 373   return false;
 374 }
 375
 376 // LinkFunctionBody - Copy the source function over into the dest function and
 377 // fix up references to values.  At this point we know that Dest is an external
 378 // function, and that Src is not.
 379 //
 380 static bool LinkFunctionBody(Function *Dest, const Function *Src,
 381                              std::map<const Value*, Value*> &GlobalMap,
 382                              std::string *Err) {
 383   assert(Src && Dest && Dest->isExternal() && !Src->isExternal());
 384   std::map<const Value*, Value*> LocalMap;   // Map for function local values
 385
 386   // Go through and convert function arguments over...
 387   Function::aiterator DI = Dest->abegin();
 388   for (Function::const_aiterator I = Src->abegin(), E = Src->aend();
 389        I != E; ++I, ++DI) {
 390     DI->setName(I->getName());  // Copy the name information over...
 391
 392     // Add a mapping to our local map
 393     LocalMap.insert(std::make_pair(I, DI));
 394   }
 395
 396   // Loop over all of the basic blocks, copying the instructions over...
 397   //
 398   for (Function::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
 399     // Create new basic block and add to mapping and the Dest function...
 400     BasicBlock *DBB = new BasicBlock(I->getName(), Dest);
 401     LocalMap.insert(std::make_pair(I, DBB));
 402
 403     // Loop over all of the instructions in the src basic block, copying them
 404     // over.  Note that this is broken in a strict sense because the cloned
 405     // instructions will still be referencing values in the Src module, not
 406     // the remapped values.  In our case, however, we will not get caught and
 407     // so we can delay patching the values up until later...
 408     //
 409     for (BasicBlock::const_iterator II = I->begin(), IE = I->end();
 410          II != IE; ++II) {
 411       Instruction *DI = II->clone();
 412       DI->setName(II->getName());
 413       DBB->getInstList().push_back(DI);
 414       LocalMap.insert(std::make_pair(II, DI));
 415     }
 416   }
 417
 418   // At this point, all of the instructions and values of the function are now
 419   // copied over.  The only problem is that they are still referencing values in
 420   // the Source function as operands.  Loop through all of the operands of the
 421   // functions and patch them up to point to the local versions...
 422   //
 423   for (Function::iterator BB = Dest->begin(), BE = Dest->end(); BB != BE; ++BB)
 424     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 425       for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
 426            OI != OE; ++OI)
 427         *OI = RemapOperand(*OI, LocalMap, &GlobalMap);
 428
 429   return false;
 430 }
 431
 432
 433 // LinkFunctionBodies - Link in the function bodies that are defined in the
 434 // source module into the DestModule.  This consists basically of copying the
 435 // function over and fixing up references to values.
 436 //
 437 static bool LinkFunctionBodies(Module *Dest, const Module *Src,
 438                                std::map<const Value*, Value*> &ValueMap,
 439                                std::string *Err) {
 440
 441   // Loop over all of the functions in the src module, mapping them over as we
 442   // go
 443   //
 444   for (Module::const_iterator SF = Src->begin(), E = Src->end(); SF != E; ++SF){
 445     if (!SF->isExternal()) {                  // No body if function is external
 446       Function *DF = cast<Function>(ValueMap[SF]); // Destination function
 447
 448       // DF not external SF external?
 449       if (!DF->isExternal()) {
 450         if (DF->hasLinkOnceLinkage()) continue; // No relinkage for link-once!
 451         if (Err)
 452           *Err = "Function '" + (SF->hasName() ? SF->getName() :std::string(""))
 453                + "' body multiply defined!";
 454         return true;
 455       }
 456
 457       if (LinkFunctionBody(DF, SF, ValueMap, Err)) return true;
 458     }
 459   }
 460   return false;
 461 }
 462
 463
 464
 465 // LinkModules - This function links two modules together, with the resulting
 466 // left module modified to be the composite of the two input modules.  If an
 467 // error occurs, true is returned and ErrorMsg (if not null) is set to indicate
 468 // the problem.  Upon failure, the Dest module could be in a modified state, and
 469 // shouldn't be relied on to be consistent.
 470 //
 471 bool LinkModules(Module *Dest, const Module *Src, std::string *ErrorMsg) {
 472
 473   // LinkTypes - Go through the symbol table of the Src module and see if any
 474   // types are named in the src module that are not named in the Dst module.
 475   // Make sure there are no type name conflicts.
 476   //
 477   if (LinkTypes(Dest, Src, ErrorMsg)) return true;
 478
 479   // ValueMap - Mapping of values from what they used to be in Src, to what they
 480   // are now in Dest.
 481   //
 482   std::map<const Value*, Value*> ValueMap;
 483
 484   // Insert all of the globals in src into the Dest module... without
 485   // initializers
 486   if (LinkGlobals(Dest, Src, ValueMap, ErrorMsg)) return true;
 487
 488   // Link the functions together between the two modules, without doing function
 489   // bodies... this just adds external function prototypes to the Dest
 490   // function...  We do this so that when we begin processing function bodies,
 491   // all of the global values that may be referenced are available in our
 492   // ValueMap.
 493   //
 494   if (LinkFunctionProtos(Dest, Src, ValueMap, ErrorMsg)) return true;
 495
 496   // Update the initializers in the Dest module now that all globals that may
 497   // be referenced are in Dest.
 498   //
 499   if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
 500
 501   // Link in the function bodies that are defined in the source module into the
 502   // DestModule.  This consists basically of copying the function over and
 503   // fixing up references to values.
 504   //
 505   if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
 506
 507   return false;
 508 }
 509