The process of linking types can cause their addresses to become invalid. For this...
[oota-llvm.git] / lib / Linker / LinkModules.cpp
index b5cec060763206c1fc0c158f96aa2705e973fde7..e6e89c36d30dd9f5f570d92925ec2b78a2939bc7 100644 (file)
 // Error - Simple wrapper function to conditionally assign to E and return true.
 // This just makes error return conditions a little bit simpler...
 //
-static inline bool Error(std::string *E, std::string Message) {
+static inline bool Error(std::string *E, const std::string &Message) {
   if (E) *E = Message;
   return true;
 }
 
+// ResolveTypes - Attempt to link the two specified types together.  Return true
+// if there is an error and they cannot yet be linked.
+//
+static bool ResolveTypes(const Type *DestTy, const Type *SrcTy,
+                         SymbolTable *DestST, const std::string &Name) {
+  if (DestTy == SrcTy) return false;       // If already equal, noop
+
+  // Does the type already exist in the module?
+  if (DestTy && !isa<OpaqueType>(DestTy)) {  // Yup, the type already exists...
+    if (const OpaqueType *OT = dyn_cast<OpaqueType>(SrcTy)) {
+      const_cast<OpaqueType*>(OT)->refineAbstractTypeTo(DestTy);
+    } else {
+      return true;  // Cannot link types... neither is opaque and not-equal
+    }
+  } else {                       // Type not in dest module.  Add it now.
+    if (DestTy)                  // Type _is_ in module, just opaque...
+      const_cast<OpaqueType*>(cast<OpaqueType>(DestTy))
+                           ->refineAbstractTypeTo(SrcTy);
+    else
+      DestST->insert(Name, const_cast<Type*>(SrcTy));
+  }
+  return false;
+}
+
+static const FunctionType *getFT(const PATypeHolder &TH) {
+  return cast<FunctionType>(TH.get());
+}
+static const StructType *getsT(const PATypeHolder &TH) {
+  return cast<StructType>(TH.get());
+}
+
+// RecursiveResolveTypes - This is just like ResolveTypes, except that it
+// recurses down into derived types, merging the used types if the parent types
+// are compatible.
+//
+static bool RecursiveResolveTypes(const PATypeHolder &DestTy,
+                                  const PATypeHolder &SrcTy,
+                                  SymbolTable *DestST, const std::string &Name){
+  const Type *SrcTyT = SrcTy.get();
+  const Type *DestTyT = DestTy.get();
+  if (DestTyT == SrcTyT) return false;       // If already equal, noop
+  
+  // If we found our opaque type, resolve it now!
+  if (isa<OpaqueType>(DestTyT) || isa<OpaqueType>(SrcTyT))
+    return ResolveTypes(DestTyT, SrcTyT, DestST, Name);
+  
+  // Two types cannot be resolved together if they are of different primitive
+  // type.  For example, we cannot resolve an int to a float.
+  if (DestTyT->getPrimitiveID() != SrcTyT->getPrimitiveID()) return true;
+
+  // Otherwise, resolve the used type used by this derived type...
+  switch (DestTyT->getPrimitiveID()) {
+  case Type::FunctionTyID: {
+    if (cast<FunctionType>(DestTyT)->isVarArg() !=
+        cast<FunctionType>(SrcTyT)->isVarArg())
+      return true;
+    for (unsigned i = 0, e = getFT(DestTy)->getNumContainedTypes(); i != e; ++i)
+      if (RecursiveResolveTypes(getFT(DestTy)->getContainedType(i),
+                                getFT(SrcTy)->getContainedType(i), DestST,Name))
+        return true;
+    return false;
+  }
+  case Type::StructTyID: {
+    if (getST(DestTy)->getNumContainedTypes() != 
+        getST(SrcTy)->getNumContainedTypes()) return 1;
+    for (unsigned i = 0, e = getST(DestTy)->getNumContainedTypes(); i != e; ++i)
+      if (RecursiveResolveTypes(getST(DestTy)->getContainedType(i),
+                                getST(SrcTy)->getContainedType(i), DestST,Name))
+        return true;
+    return false;
+  }
+  case Type::ArrayTyID: {
+    const ArrayType *DAT = cast<ArrayType>(DestTy.get());
+    const ArrayType *SAT = cast<ArrayType>(SrcTy.get());
+    if (DAT->getNumElements() != SAT->getNumElements()) return true;
+    return RecursiveResolveTypes(DAT->getElementType(), SAT->getElementType(),
+                                 DestST, Name);
+  }
+  case Type::PointerTyID:
+    return RecursiveResolveTypes(
+                              cast<PointerType>(DestTy.get())->getElementType(),
+                              cast<PointerType>(SrcTy.get())->getElementType(),
+                                 DestST, Name);
+  default: assert(0 && "Unexpected type!"); return true;
+  }  
+}
+
+
 // 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.
@@ -36,36 +124,82 @@ static bool LinkTypes(Module *Dest, const Module *Src, std::string *Err) {
   SymbolTable::const_iterator PI = SrcST->find(Type::TypeTy);
   if (PI == SrcST->end()) return false;  // No named types, do nothing.
 
+  // Some types cannot be resolved immediately becuse they depend on other types
+  // being resolved to each other first.  This contains a list of types we are
+  // waiting to recheck.
+  std::vector<std::string> DelayedTypesToResolve;
+
   const SymbolTable::VarMap &VM = PI->second;
   for (SymbolTable::type_const_iterator I = VM.begin(), E = VM.end();
        I != E; ++I) {
     const std::string &Name = I->first;
-    const Type *RHS = cast<Type>(I->second);
+    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 && !isa<OpaqueType>(Entry)) {  // Yup, the value already exists...
-      if (Entry != RHS) {
-        if (OpaqueType *OT = dyn_cast<OpaqueType>(const_cast<Type*>(RHS))) {
-          OT->refineAbstractTypeTo(Entry);
-        } else {
-          // 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() + "'");
-        }
+    Type *Entry = cast_or_null<Type>(DestST->lookup(Type::TypeTy, Name));
+
+    if (ResolveTypes(Entry, RHS, DestST, Name)) {
+      // They look different, save the types 'till later to resolve.
+      DelayedTypesToResolve.push_back(Name);
+    }
+  }
+
+  // Iteratively resolve types while we can...
+  while (!DelayedTypesToResolve.empty()) {
+    // Loop over all of the types, attempting to resolve them if possible...
+    unsigned OldSize = DelayedTypesToResolve.size();
+
+    // Try direct resolution by name...
+    for (unsigned i = 0; i != DelayedTypesToResolve.size(); ++i) {
+      const std::string &Name = DelayedTypesToResolve[i];
+      Type *T1 = cast<Type>(VM.find(Name)->second);
+      Type *T2 = cast<Type>(DestST->lookup(Type::TypeTy, Name));
+      if (!ResolveTypes(T2, T1, DestST, Name)) {
+        // We are making progress!
+        DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
+        --i;
       }
-    } else {                       // Type not in dest module.  Add it now.
-      if (Entry) {
-        OpaqueType *OT = cast<OpaqueType>(const_cast<Type*>(Entry));
-        OT->refineAbstractTypeTo(RHS);
+    }
+
+    // Did we not eliminate any types?
+    if (DelayedTypesToResolve.size() == OldSize) {
+      // Attempt to resolve subelements of types.  This allows us to merge these
+      // two types: { int* } and { opaque* }
+      for (unsigned i = 0, e = DelayedTypesToResolve.size(); i != e; ++i) {
+        const std::string &Name = DelayedTypesToResolve[i];
+        PATypeHolder T1(cast<Type>(VM.find(Name)->second));
+        PATypeHolder T2(cast<Type>(DestST->lookup(Type::TypeTy, Name)));
+
+        if (!RecursiveResolveTypes(T2, T1, DestST, Name)) {
+          // We are making progress!
+          DelayedTypesToResolve.erase(DelayedTypesToResolve.begin()+i);
+          
+          // Go back to the main loop, perhaps we can resolve directly by name
+          // now...
+          break;
+        }
       }
 
-      // TODO: FIXME WHEN TYPES AREN'T CONST
-      DestST->insert(Name, const_cast<Type*>(RHS));
+      // If we STILL cannot resolve the types, then there is something wrong.
+      // Report the error.
+      if (DelayedTypesToResolve.size() == OldSize) {
+        // Build up an error message of all of the mismatched types.
+        std::string ErrorMessage;
+        for (unsigned i = 0, e = DelayedTypesToResolve.size(); i != e; ++i) {
+          const std::string &Name = DelayedTypesToResolve[i];
+          const Type *T1 = cast<Type>(VM.find(Name)->second);
+          const Type *T2 = cast<Type>(DestST->lookup(Type::TypeTy, Name));
+          ErrorMessage += "  Type named '" + Name + 
+                          "' conflicts.\n    Src='" + T1->getDescription() +
+                          "'.\n   Dest='" + T2->getDescription() + "'\n";
+        }
+        return Error(Err, "Type conflict between types in modules:\n" +
+                     ErrorMessage);
+      }
     }
   }
+
+
   return false;
 }
 
@@ -176,10 +310,11 @@ static Value *RemapOperand(const Value *In,
 
 
 // LinkGlobals - Loop through the global variables in the src module and merge
-// them into the dest module...
+// them into the dest module.
 //
 static bool LinkGlobals(Module *Dest, const Module *Src,
                         std::map<const Value*, Value*> &ValueMap,
+                    std::multimap<std::string, GlobalVariable *> &AppendingVars,
                         std::string *Err) {
   // We will need a module level symbol table if the src module has a module
   // level symbol table...
@@ -230,11 +365,30 @@ static bool LinkGlobals(Module *Dest, const Module *Src,
 
       // Make sure to remember this mapping...
       ValueMap.insert(std::make_pair(SGV, NewDGV));
-    } else if (!SGExtern && !DGExtern && SGV->getLinkage() !=DGV->getLinkage()){
+      if (SGV->hasAppendingLinkage())
+        // Keep track that this is an appending variable...
+        AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
+
+    } else if (SGV->isExternal()) {
+      // If SGV is external or if both SGV & DGV are external..  Just link the
+      // external globals, we aren't adding anything.
+      ValueMap.insert(std::make_pair(SGV, DGV));
+
+    } else if (DGV->isExternal()) {   // If DGV is external but SGV is not...
+      ValueMap.insert(std::make_pair(SGV, DGV));
+      DGV->setLinkage(SGV->getLinkage());    // Inherit linkage!
+    } else if (SGV->getLinkage() != DGV->getLinkage()) {
       return Error(Err, "Global variables named '" + SGV->getName() +
                    "' have different linkage specifiers!");
-    } else if (SGV->hasExternalLinkage() || SGV->hasLinkOnceLinkage() ||
-               SGV->hasAppendingLinkage()) {
+    } else if (SGV->hasExternalLinkage()) {
+      // Allow linking two exactly identical external global variables...
+      if (SGV->isConstant() != DGV->isConstant() ||
+          SGV->getInitializer() != DGV->getInitializer())
+        return Error(Err, "Global Variable Collision on '" + 
+                     SGV->getType()->getDescription() + " %" + SGV->getName() +
+                     "' - Global variables differ in const'ness");
+      ValueMap.insert(std::make_pair(SGV, DGV));
+    } else if (SGV->hasLinkOnceLinkage()) {
       // 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...
@@ -242,13 +396,26 @@ static bool LinkGlobals(Module *Dest, const Module *Src,
       // Check to see if the two GV's have the same Const'ness...
       if (SGV->isConstant() != DGV->isConstant())
         return Error(Err, "Global Variable Collision on '" + 
-                     SGV->getType()->getDescription() + "':%" + SGV->getName() +
-                     " - Global variables differ in const'ness");
-      if (DGExtern)
-        DGV->setLinkage(SGV->getLinkage());
+                     SGV->getType()->getDescription() + " %" + SGV->getName() +
+                     "' - Global variables differ in const'ness");
 
       // Okay, everything is cool, remember the mapping...
       ValueMap.insert(std::make_pair(SGV, DGV));
+    } else if (SGV->hasAppendingLinkage()) {
+      // No linking is performed yet.  Just insert a new copy of the global, and
+      // keep track of the fact that it is an appending variable in the
+      // AppendingVars map.  The name is cleared out so that no linkage is
+      // performed.
+      GlobalVariable *NewDGV =
+        new GlobalVariable(SGV->getType()->getElementType(),
+                           SGV->isConstant(), SGV->getLinkage(), /*init*/0,
+                           "", Dest);
+
+      // Make sure to remember this mapping...
+      ValueMap.insert(std::make_pair(SGV, NewDGV));
+
+      // Keep track that this is an appending variable...
+      AppendingVars.insert(std::make_pair(SGV->getName(), NewDGV));
     } else {
       assert(0 && "Unknown linkage!");
     }
@@ -321,9 +488,6 @@ static bool LinkFunctionProtos(Module *Dest, const Module *Src,
       // 
       DF = cast_or_null<Function>(ST->lookup(SF->getType(), SF->getName()));
 
-    bool SFExtern = SF->isExternal();
-    bool DFExtern = DF ? DF->isExternal() : false;
-
     if (!DF || SF->hasInternalLinkage() || DF->hasInternalLinkage()) {
       // Function does not already exist, simply insert an function signature
       // identical to SF into the dest module...
@@ -344,30 +508,28 @@ static bool LinkFunctionProtos(Module *Dest, const Module *Src,
 
       // ... and remember this mapping...
       ValueMap.insert(std::make_pair(SF, NewDF));
-    } else if (SF->getLinkage() == GlobalValue::AppendingLinkage) {
-      return Error(Err, "Functions named '" + SF->getName() +
-                   "' have appending linkage!");
-    } else if (!SFExtern && !DFExtern && SF->getLinkage() != DF->getLinkage()) {
+    } else if (SF->isExternal()) {
+      // If SF is external or if both SF & DF are external..  Just link the
+      // external functions, we aren't adding anything.
+      ValueMap.insert(std::make_pair(SF, DF));
+    } else if (DF->isExternal()) {   // If DF is external but SF is not...
+      // Link the external functions, update linkage qualifiers
+      ValueMap.insert(std::make_pair(SF, DF));
+      DF->setLinkage(SF->getLinkage());
+
+    } else if (SF->getLinkage() != DF->getLinkage()) {
       return Error(Err, "Functions named '" + SF->getName() +
                    "' have different linkage specifiers!");
-    } else if (SF->getLinkage() == GlobalValue::ExternalLinkage) {
-      // If the function has a name, and that name is already in use in the Dest
-      // module, make sure that the name is a compatible function...
-      //
-      // Check to make sure the function is not defined in both modules...
-      if (!SF->isExternal() && !DF->isExternal())
-        return Error(Err, "Function '" + 
-                     SF->getFunctionType()->getDescription() + "':\"" + 
-                     SF->getName() + "\" - Function is already defined!");
-      
-      if (DFExtern)
-        DF->setLinkage(SF->getLinkage());
-      
-      // Otherwise, just remember this mapping...
-      ValueMap.insert(std::make_pair(SF, DF));
-    } else if (SF->getLinkage() == GlobalValue::LinkOnceLinkage) {
+    } else if (SF->hasExternalLinkage()) {
+      // The function is defined in both modules!!
+      return Error(Err, "Function '" + 
+                   SF->getFunctionType()->getDescription() + "':\"" + 
+                   SF->getName() + "\" - Function is already defined!");
+    } else if (SF->hasLinkOnceLinkage()) {
       // Completely ignore the source function.
       ValueMap.insert(std::make_pair(SF, DF));
+    } else {
+      assert(0 && "Unknown linkage configuration found!");
     }
   }
   return false;
@@ -460,6 +622,81 @@ static bool LinkFunctionBodies(Module *Dest, const Module *Src,
   return false;
 }
 
+// LinkAppendingVars - If there were any appending global variables, link them
+// together now.  Return true on error.
+//
+static bool LinkAppendingVars(Module *M,
+                  std::multimap<std::string, GlobalVariable *> &AppendingVars,
+                              std::string *ErrorMsg) {
+  if (AppendingVars.empty()) return false; // Nothing to do.
+  
+  // Loop over the multimap of appending vars, processing any variables with the
+  // same name, forming a new appending global variable with both of the
+  // initializers merged together, then rewrite references to the old variables
+  // and delete them.
+  //
+  std::vector<Constant*> Inits;
+  while (AppendingVars.size() > 1) {
+    // Get the first two elements in the map...
+    std::multimap<std::string,
+      GlobalVariable*>::iterator Second = AppendingVars.begin(), First=Second++;
+
+    // If the first two elements are for different names, there is no pair...
+    // Otherwise there is a pair, so link them together...
+    if (First->first == Second->first) {
+      GlobalVariable *G1 = First->second, *G2 = Second->second;
+      const ArrayType *T1 = cast<ArrayType>(G1->getType()->getElementType());
+      const ArrayType *T2 = cast<ArrayType>(G2->getType()->getElementType());
+      
+      // Check to see that they two arrays agree on type...
+      if (T1->getElementType() != T2->getElementType())
+        return Error(ErrorMsg,
+         "Appending variables with different element types need to be linked!");
+      if (G1->isConstant() != G2->isConstant())
+        return Error(ErrorMsg,
+                     "Appending variables linked with different const'ness!");
+
+      unsigned NewSize = T1->getNumElements() + T2->getNumElements();
+      ArrayType *NewType = ArrayType::get(T1->getElementType(), NewSize);
+
+      // Create the new global variable...
+      GlobalVariable *NG =
+        new GlobalVariable(NewType, G1->isConstant(), G1->getLinkage(),
+                           /*init*/0, First->first, M);
+
+      // Merge the initializer...
+      Inits.reserve(NewSize);
+      ConstantArray *I = cast<ConstantArray>(G1->getInitializer());
+      for (unsigned i = 0, e = T1->getNumElements(); i != e; ++i)
+        Inits.push_back(cast<Constant>(I->getValues()[i]));
+      I = cast<ConstantArray>(G2->getInitializer());
+      for (unsigned i = 0, e = T2->getNumElements(); i != e; ++i)
+        Inits.push_back(cast<Constant>(I->getValues()[i]));
+      NG->setInitializer(ConstantArray::get(NewType, Inits));
+      Inits.clear();
+
+      // Replace any uses of the two global variables with uses of the new
+      // global...
+
+      // FIXME: This should rewrite simple/straight-forward uses such as
+      // getelementptr instructions to not use the Cast!
+      ConstantPointerRef *NGCP = ConstantPointerRef::get(NG);
+      G1->replaceAllUsesWith(ConstantExpr::getCast(NGCP, G1->getType()));
+      G2->replaceAllUsesWith(ConstantExpr::getCast(NGCP, G2->getType()));
+
+      // Remove the two globals from the module now...
+      M->getGlobalList().erase(G1);
+      M->getGlobalList().erase(G2);
+
+      // Put the new global into the AppendingVars map so that we can handle
+      // linking of more than two vars...
+      Second->second = NG;
+    }
+    AppendingVars.erase(First);
+  }
+
+  return false;
+}
 
 
 // LinkModules - This function links two modules together, with the resulting
@@ -485,9 +722,22 @@ bool LinkModules(Module *Dest, const Module *Src, std::string *ErrorMsg) {
   //
   std::map<const Value*, Value*> ValueMap;
 
-  // Insert all of the globals in src into the Dest module... without
-  // initializers
-  if (LinkGlobals(Dest, Src, ValueMap, ErrorMsg)) return true;
+  // AppendingVars - Keep track of global variables in the destination module
+  // with appending linkage.  After the module is linked together, they are
+  // appended and the module is rewritten.
+  //
+  std::multimap<std::string, GlobalVariable *> AppendingVars;
+
+  // Add all of the appending globals already in the Dest module to
+  // AppendingVars.
+  for (Module::giterator I = Dest->gbegin(), E = Dest->gend(); I != E; ++I)
+    if (I->hasAppendingLinkage())
+      AppendingVars.insert(std::make_pair(I->getName(), I));
+
+  // Insert all of the globals in src into the Dest module... without linking
+  // initializers (which could refer to functions not yet mapped over).
+  //
+  if (LinkGlobals(Dest, Src, ValueMap, AppendingVars, ErrorMsg)) return true;
 
   // Link the functions together between the two modules, without doing function
   // bodies... this just adds external function prototypes to the Dest
@@ -508,6 +758,10 @@ bool LinkModules(Module *Dest, const Module *Src, std::string *ErrorMsg) {
   //
   if (LinkFunctionBodies(Dest, Src, ValueMap, ErrorMsg)) return true;
 
+  // If there were any appending global variables, link them together now.
+  //
+  if (LinkAppendingVars(Dest, AppendingVars, ErrorMsg)) return true;
+
   return false;
 }