Eliminate the PromoteInstance class, incorporating it into the PromotePass
[oota-llvm.git] / lib / Transforms / Utils / Linker.cpp
index f2c08dcb46e2398f1fec593a492afd07fa2d4caa..086c6c6b28f062fc4b897297a6f37989ac20cbfb 100644 (file)
@@ -3,18 +3,26 @@
 // This file implements the LLVM module linker.
 //
 // Specifically, this:
-//  - Merges global variables between the two modules
-//    - Uninit + Uninit = Init, Init + Uninit = Init, Init + Init = Error if !=
+//  * Merges global variables between the two modules
+//    * Uninit + Uninit = Init, Init + Uninit = Init, Init + Init = Error if !=
+//  * Merges methods between two modules
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Transforms/Linker.h"
 #include "llvm/Module.h"
-#include "llvm/Method.h"
+#include "llvm/Function.h"
+#include "llvm/BasicBlock.h"
 #include "llvm/GlobalVariable.h"
 #include "llvm/SymbolTable.h"
 #include "llvm/DerivedTypes.h"
 #include "llvm/iOther.h"
+#include "llvm/ConstantVals.h"
+#include "llvm/Argument.h"
+#include <iostream>
+using std::cerr;
+using std::string;
+using std::map;
 
 // Error - Simple wrapper function to conditionally assign to E and return true.
 // This just makes error return conditions a little bit simpler...
@@ -24,13 +32,60 @@ static inline bool Error(string *E, string Message) {
   return true;
 }
 
-#include "llvm/Assembly/Writer.h" // TODO: REMOVE
+// LinkTypes - Go through the symbol table of the Src module and see if any
+// types are named in the src module that are not named in the Dst module.
+// Make sure there are no type name conflicts.
+//
+static bool LinkTypes(Module *Dest, const Module *Src, string *Err = 0) {
+  // No symbol table?  Can't have named types.
+  if (!Src->hasSymbolTable()) return false;
+
+  SymbolTable       *DestST = Dest->getSymbolTableSure();
+  const SymbolTable *SrcST  = Src->getSymbolTable();
+
+  // Look for a type plane for Type's...
+  SymbolTable::const_iterator PI = SrcST->find(Type::TypeTy);
+  if (PI == SrcST->end()) return false;  // No named types, do nothing.
+
+  const SymbolTable::VarMap &VM = PI->second;
+  for (SymbolTable::type_const_iterator I = VM.begin(), E = VM.end();
+       I != E; ++I) {
+    const string &Name = I->first;
+    const Type *RHS = cast<Type>(I->second);
+
+    // Check to see if this type name is already in the dest module...
+    const Type *Entry = cast_or_null<Type>(DestST->lookup(Type::TypeTy, Name));
+    if (Entry) {     // Yup, the value already exists...
+      if (Entry != RHS)            // If it's the same, noop.  Otherwise, error.
+        return Error(Err, "Type named '" + Name + 
+                     "' of different shape in modules.\n  Src='" + 
+                     Entry->getDescription() + "'.\n  Dst='" + 
+                     RHS->getDescription() + "'");
+    } else {                       // Type not in dest module.  Add it now.
+      // TODO: FIXME WHEN TYPES AREN'T CONST
+      DestST->insert(Name, const_cast<Type*>(RHS));
+    }
+  }
+  return false;
+}
+
+static void PrintMap(const map<const Value*, Value*> &M) {
+  for (map<const Value*, Value*>::const_iterator I = M.begin(), E = M.end();
+       I != E; ++I) {
+    cerr << " Fr: " << (void*)I->first << " ";
+    I->first->dump();
+    cerr << " To: " << (void*)I->second << " ";
+    I->second->dump();
+    cerr << "\n";
+  }
+}
+
 
 // RemapOperand - Use LocalMap and GlobalMap to convert references from one
 // module to another.  This is somewhat sophisticated in that it can
 // automatically handle constant references correctly as well...
 //
-static Value *RemapOperand(Value *In, map<const Value*, Value*> &LocalMap,
+static Value *RemapOperand(const Value *In, map<const Value*, Value*> &LocalMap,
                            const map<const Value*, Value*> *GlobalMap = 0) {
   map<const Value*,Value*>::const_iterator I = LocalMap.find(In);
   if (I != LocalMap.end()) return I->second;
@@ -40,9 +95,54 @@ static Value *RemapOperand(Value *In, map<const Value*, Value*> &LocalMap,
     if (I != GlobalMap->end()) return I->second;
   }
 
-  if (!isa<ConstPoolVal>(In))
-    cerr << "Couldn't remap value: " << In << endl;
-  return In;
+  // Check to see if it's a constant that we are interesting in transforming...
+  if (Constant *CPV = dyn_cast<Constant>(In)) {
+    if (!isa<DerivedType>(CPV->getType()))
+      return CPV;              // Simple constants stay identical...
+
+    Constant *Result = 0;
+
+    if (ConstantArray *CPA = dyn_cast<ConstantArray>(CPV)) {
+      const std::vector<Use> &Ops = CPA->getValues();
+      std::vector<Constant*> Operands(Ops.size());
+      for (unsigned i = 0; i < Ops.size(); ++i)
+        Operands[i] = 
+          cast<Constant>(RemapOperand(Ops[i], LocalMap, GlobalMap));
+      Result = ConstantArray::get(cast<ArrayType>(CPA->getType()), Operands);
+    } else if (ConstantStruct *CPS = dyn_cast<ConstantStruct>(CPV)) {
+      const std::vector<Use> &Ops = CPS->getValues();
+      std::vector<Constant*> Operands(Ops.size());
+      for (unsigned i = 0; i < Ops.size(); ++i)
+        Operands[i] = 
+          cast<Constant>(RemapOperand(Ops[i], LocalMap, GlobalMap));
+      Result = ConstantStruct::get(cast<StructType>(CPS->getType()), Operands);
+    } else if (isa<ConstantPointerNull>(CPV)) {
+      Result = CPV;
+    } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CPV)) {
+      Value *V = RemapOperand(CPR->getValue(), LocalMap, GlobalMap);
+      Result = ConstantPointerRef::get(cast<GlobalValue>(V));
+    } else {
+      assert(0 && "Unknown type of derived type constant value!");
+    }
+
+    // Cache the mapping in our local map structure...
+    LocalMap.insert(std::make_pair(In, CPV));
+    return Result;
+  }
+
+  cerr << "XXX LocalMap: \n";
+  PrintMap(LocalMap);
+
+  if (GlobalMap) {
+    cerr << "XXX GlobalMap: \n";
+    PrintMap(*GlobalMap);
+  }
+
+  cerr << "Couldn't remap value: " << (void*)In << " ";
+  In->dump();
+  cerr << "\n";
+  assert(0 && "Couldn't remap value!");
+  return 0;
 }
 
 
@@ -58,72 +158,89 @@ static bool LinkGlobals(Module *Dest, const Module *Src,
   // Loop over all of the globals in the src module, mapping them over as we go
   //
   for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
-    const GlobalVariable *GV = *I;
+    const GlobalVariable *SGV = *I;
     Value *V;
 
     // If the global variable has a name, and that name is already in use in the
     // Dest module, make sure that the name is a compatible global variable...
     //
-    if (GV->hasName() && (V = ST->lookup(GV->getType(), GV->getName()))) {
+    if (SGV->hasExternalLinkage() && SGV->hasName() &&
+       (V = ST->lookup(SGV->getType(), SGV->getName())) &&
+       cast<GlobalVariable>(V)->hasExternalLinkage()) {
       // The same named thing is a global variable, because the only two things
-      // that may be in a module level symbol table are Global Vars and Methods,
-      // and they both have distinct, nonoverlapping, possible types.
+      // that may be in a module level symbol table are Global Vars and
+      // Functions, and they both have distinct, nonoverlapping, possible types.
       // 
       GlobalVariable *DGV = cast<GlobalVariable>(V);
 
       // Check to see if the two GV's have the same Const'ness...
-      if (GV->isConstant() != DGV->isConstant())
+      if (SGV->isConstant() != DGV->isConstant())
         return Error(Err, "Global Variable Collision on '" + 
-                     GV->getType()->getDescription() + "':%" + GV->getName() +
+                     SGV->getType()->getDescription() + "':%" + SGV->getName() +
                      " - Global variables differ in const'ness");
 
-      // Check to make sure that they both have the same initializer if they are
-      // both initialized...
-      //
- // TODO: Check to see if they have DEEP equality.  For Module level constants
-      if (GV->hasInitializer() && DGV->hasInitializer() &&
-          GV->getInitializer() != DGV->getInitializer())
-        return Error(Err, "Global Variable Collision on '" + 
-                     GV->getType()->getDescription() + "':%" + GV->getName() +
-                     " - Global variables have different initializers");
-
-      // Okay, everything is cool, remember the mapping and update the
-      // initializer if neccesary...
-      //
-// TODO: We might have to map module level constants here!
-      if (GV->hasInitializer() && !DGV->hasInitializer())
-        DGV->setInitializer(GV->getInitializer());
-
-      ValueMap.insert(make_pair(GV, DGV));
+      // Okay, everything is cool, remember the mapping...
+      ValueMap.insert(std::make_pair(SGV, DGV));
     } else {
       // No linking to be performed, simply create an identical version of the
-      // symbol over in the dest module...
-// TODO: Provide constpoolval mapping for initializer if using module local
-// initializers!
-      GlobalVariable *NGV = 
-        new GlobalVariable(GV->getType()->getValueType(), GV->isConstant(),
-                           GV->hasInitializer() ? GV->getInitializer() : 0,
-                           GV->getName());
+      // symbol over in the dest module... the initializer will be filled in
+      // later by LinkGlobalInits...
+      //
+      GlobalVariable *DGV = 
+        new GlobalVariable(SGV->getType()->getElementType(), SGV->isConstant(),
+                           SGV->hasInternalLinkage(), 0, SGV->getName());
 
       // Add the new global to the dest module
-      Dest->getGlobalList().push_back(NGV);
+      Dest->getGlobalList().push_back(DGV);
 
       // Make sure to remember this mapping...
-      ValueMap.insert(make_pair(GV, NGV));
+      ValueMap.insert(std::make_pair(SGV, DGV));
     }
   }
   return false;
 }
 
 
+// LinkGlobalInits - Update the initializers in the Dest module now that all
+// globals that may be referenced are in Dest.
+//
+static bool LinkGlobalInits(Module *Dest, const Module *Src,
+                            map<const Value*, Value*> &ValueMap,
+                            string *Err = 0) {
 
-// LinkMethodProtos - Link the methods together between the two modules, without
-// doing method bodies... this just adds external method prototypes to the Dest
-// method...
+  // Loop over all of the globals in the src module, mapping them over as we go
+  //
+  for (Module::const_giterator I = Src->gbegin(), E = Src->gend(); I != E; ++I){
+    const GlobalVariable *SGV = *I;
+
+    if (SGV->hasInitializer()) {      // Only process initialized GV's
+      // Figure out what the initializer looks like in the dest module...
+      Constant *DInit =
+        cast<Constant>(RemapOperand(SGV->getInitializer(), ValueMap));
+
+      GlobalVariable *DGV = cast<GlobalVariable>(ValueMap[SGV]);    
+      if (DGV->hasInitializer() && SGV->hasExternalLinkage() &&
+         DGV->hasExternalLinkage()) {
+        if (DGV->getInitializer() != DInit)
+          return Error(Err, "Global Variable Collision on '" + 
+                       SGV->getType()->getDescription() + "':%" +SGV->getName()+
+                       " - Global variables have different initializers");
+      } else {
+        // Copy the initializer over now...
+        DGV->setInitializer(DInit);
+      }
+    }
+  }
+  return false;
+}
+
+// LinkFunctionProtos - Link the functions together between the two modules,
+// without doing method bodies... this just adds external method prototypes to
+// the Dest function...
 //
-static bool LinkMethodProtos(Module *Dest, const Module *Src,
-                             map<const Value*, Value*> &ValueMap,
-                             string *Err = 0) {
+static bool LinkFunctionProtos(Module *Dest, const Module *Src,
+                               map<const Value*, Value*> &ValueMap,
+                               string *Err = 0) {
   // We will need a module level symbol table if the src module has a module
   // level symbol table...
   SymbolTable *ST = Src->getSymbolTable() ? Dest->getSymbolTableSure() : 0;
@@ -131,74 +248,78 @@ static bool LinkMethodProtos(Module *Dest, const Module *Src,
   // Loop over all of the methods in the src module, mapping them over as we go
   //
   for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
-    const Method *SM = *I;   // SrcMethod
+    const Function *SM = *I;   // SrcFunction
     Value *V;
 
     // If the method has a name, and that name is already in use in the
     // Dest module, make sure that the name is a compatible method...
     //
-    if (SM->hasName() && (V = ST->lookup(SM->getType(), SM->getName()))) {
-      // The same named thing is a Method, because the only two things
-      // that may be in a module level symbol table are Global Vars and Methods,
-      // and they both have distinct, nonoverlapping, possible types.
+    if (SM->hasExternalLinkage() && SM->hasName() &&
+       (V = ST->lookup(SM->getType(), SM->getName())) &&
+       cast<Function>(V)->hasExternalLinkage()) {
+      // The same named thing is a Function, because the only two things
+      // that may be in a module level symbol table are Global Vars and
+      // Functions, and they both have distinct, nonoverlapping, possible types.
       // 
-      Method *DM = cast<Method>(V);   // DestMethod
+      Function *DM = cast<Function>(V);   // DestFunction
 
       // Check to make sure the method is not defined in both modules...
       if (!SM->isExternal() && !DM->isExternal())
-        return Error(Err, "Method '" + 
-                     SM->getMethodType()->getDescription() + "':\"" + 
-                     SM->getName() + "\" - Method is already defined!");
+        return Error(Err, "Function '" + 
+                     SM->getFunctionType()->getDescription() + "':\"" + 
+                     SM->getName() + "\" - Function is already defined!");
 
       // Otherwise, just remember this mapping...
-      ValueMap.insert(make_pair(SM, DM));
+      ValueMap.insert(std::make_pair(SM, DM));
     } else {
-      // Method does not already exist, simply insert an external method
+      // Function does not already exist, simply insert an external method
       // signature identical to SM into the dest module...
-      Method *DM = new Method(SM->getMethodType(), SM->getName());
+      Function *DM = new Function(SM->getFunctionType(),
+                                  SM->hasInternalLinkage(),
+                                  SM->getName());
 
       // Add the method signature to the dest module...
-      Dest->getMethodList().push_back(DM);
+      Dest->getFunctionList().push_back(DM);
 
       // ... and remember this mapping...
-      ValueMap.insert(make_pair(SM, DM));
+      ValueMap.insert(std::make_pair(SM, DM));
     }
   }
   return false;
 }
 
-// LinkMethodBody - Copy the source method over into the dest method and fix up
-// references to values.  At this point we know that Dest is an external method,
-// and that Src is not.
+// LinkFunctionBody - Copy the source method over into the dest method
+// and fix up references to values.  At this point we know that Dest
+// is an external method, and that Src is not.
 //
-static bool LinkMethodBody(Method *Dest, const Method *Src,
-                           const map<const Value*, Value*> &GlobalMap,
-                           string *Err = 0) {
+static bool LinkFunctionBody(Function *Dest, const Function *Src,
+                             const map<const Value*, Value*> &GlobalMap,
+                             string *Err = 0) {
   assert(Src && Dest && Dest->isExternal() && !Src->isExternal());
   map<const Value*, Value*> LocalMap;   // Map for method local values
 
   // Go through and convert method arguments over...
-  for (Method::ArgumentListType::const_iterator 
+  for (Function::ArgumentListType::const_iterator 
          I = Src->getArgumentList().begin(),
          E = Src->getArgumentList().end(); I != E; ++I) {
-    const MethodArgument *SMA = *I;
+    const Argument *SMA = *I;
 
     // Create the new method argument and add to the dest method...
-    MethodArgument *DMA = new MethodArgument(SMA->getType(), SMA->getName());
+    Argument *DMA = new Argument(SMA->getType(), SMA->getName());
     Dest->getArgumentList().push_back(DMA);
 
     // Add a mapping to our local map
-    LocalMap.insert(make_pair(SMA, DMA));
+    LocalMap.insert(std::make_pair(SMA, DMA));
   }
 
   // Loop over all of the basic blocks, copying the instructions over...
   //
-  for (Method::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
+  for (Function::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
     const BasicBlock *SBB = *I;
 
     // Create new basic block and add to mapping and the Dest method...
     BasicBlock *DBB = new BasicBlock(SBB->getName(), Dest);
-    LocalMap.insert(make_pair(SBB, DBB));
+    LocalMap.insert(std::make_pair(SBB, DBB));
 
     // Loop over all of the instructions in the src basic block, copying them
     // over.  Note that this is broken in a strict sense because the cloned
@@ -210,8 +331,9 @@ static bool LinkMethodBody(Method *Dest, const Method *Src,
          II != IE; ++II) {
       const Instruction *SI = *II;
       Instruction *DI = SI->clone();
+      DI->setName(SI->getName());
       DBB->getInstList().push_back(DI);
-      LocalMap.insert(make_pair(SI, DI));
+      LocalMap.insert(std::make_pair(SI, DI));
     }
   }
 
@@ -220,36 +342,47 @@ static bool LinkMethodBody(Method *Dest, const Method *Src,
   // in the Source method as operands.  Loop through all of the operands of the
   // methods and patch them up to point to the local versions...
   //
-  for (Method::inst_iterator I = Dest->inst_begin(), E = Dest->inst_end();
-       I != E; ++I) {
-    Instruction *Inst = *I;
-
-    for (Instruction::op_iterator OI = Inst->op_begin(), OE = Inst->op_end();
-         OI != OE; ++OI)
-      *OI = RemapOperand(*OI, LocalMap, &GlobalMap);
+  for (Function::iterator BI = Dest->begin(), BE = Dest->end();
+       BI != BE; ++BI) {
+    BasicBlock *BB = *BI;
+    for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
+      Instruction *Inst = *I;
+      
+      for (Instruction::op_iterator OI = Inst->op_begin(), OE = Inst->op_end();
+           OI != OE; ++OI)
+        *OI = RemapOperand(*OI, LocalMap, &GlobalMap);
+    }
   }
 
   return false;
 }
 
 
-// LinkMethodBodies - Link in the method bodies that are defined in the source
+// LinkFunctionBodies - Link in the method bodies that are defined in the source
 // module into the DestModule.  This consists basically of copying the method
 // over and fixing up references to values.
 //
-static bool LinkMethodBodies(Module *Dest, const Module *Src,
-                             map<const Value*, Value*> &ValueMap,
-                             string *Err = 0) {
+static bool LinkFunctionBodies(Module *Dest, const Module *Src,
+                               map<const Value*, Value*> &ValueMap,
+                               string *Err = 0) {
 
   // Loop over all of the methods in the src module, mapping them over as we go
   //
   for (Module::const_iterator I = Src->begin(), E = Src->end(); I != E; ++I) {
-    const Method *SM = *I;                   // Source Method
-    Method *DM = cast<Method>(ValueMap[SM]); // Destination method
-
-    assert(DM && DM->isExternal() && "LinkMethodProtos failed!");
-    if (!SM->isExternal())  // External methods are already done
-      if (LinkMethodBody(DM, SM, ValueMap, Err)) return true;
+    const Function *SM = *I;                   // Source Function
+    if (!SM->isExternal()) {                   // No body if method is external
+      Function *DM = cast<Function>(ValueMap[SM]); // Destination method
+
+      // DM not external SM external?
+      if (!DM->isExternal()) {
+        if (Err)
+          *Err = "Function '" + (SM->hasName() ? SM->getName() : string("")) +
+                 "' body multiply defined!";
+        return true;
+      }
+
+      if (LinkFunctionBody(DM, SM, ValueMap, Err)) return true;
+    }
   }
   return false;
 }
@@ -263,26 +396,40 @@ static bool LinkMethodBodies(Module *Dest, const Module *Src,
 // shouldn't be relied on to be consistent.
 //
 bool LinkModules(Module *Dest, const Module *Src, string *ErrorMsg = 0) {
+
+  // LinkTypes - Go through the symbol table of the Src module and see if any
+  // types are named in the src module that are not named in the Dst module.
+  // Make sure there are no type name conflicts.
+  //
+  if (LinkTypes(Dest, Src, ErrorMsg)) return true;
+
   // ValueMap - Mapping of values from what they used to be in Src, to what they
   // are now in Dest.
   //
   map<const Value*, Value*> ValueMap;
 
-  // Link the globals variables together between the two modules...
+  // Insert all of the globals in src into the Dest module... without
+  // initializers
   if (LinkGlobals(Dest, Src, ValueMap, ErrorMsg)) return true;
 
+  // Update the initializers in the Dest module now that all globals that may
+  // be referenced are in Dest.
+  //
+  if (LinkGlobalInits(Dest, Src, ValueMap, ErrorMsg)) return true;
+
   // Link the methods together between the two modules, without doing method
   // bodies... this just adds external method prototypes to the Dest method...
   // We do this so that when we begin processing method bodies, all of the
   // global values that may be referenced are available in our ValueMap.
   //
-  if (LinkMethodProtos(Dest, Src, ValueMap, ErrorMsg)) return true;
+  if (LinkFunctionProtos(Dest, Src, ValueMap, ErrorMsg)) return true;
 
   // Link in the method bodies that are defined in the source module into the
   // DestModule.  This consists basically of copying the method over and fixing
   // up references to values.
   //
-  if (LinkMethodBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
+  if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
 
   return false;
 }
+