API change for {BinaryOperator|CmpInst|CastInst}::create*() --> Create. Legacy interf...
[oota-llvm.git] / lib / VMCore / AutoUpgrade.cpp
index 98a8d31325b4c16563ba725ddef76bcc5546bcbd..bed8fee8bbeb2a38966efe7cae1f14837416377e 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencer and is distributed under the 
-// University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Assembly/AutoUpgrade.h"
+#include "llvm/AutoUpgrade.h"
 #include "llvm/Constants.h"
-#include "llvm/DerivedTypes.h"
 #include "llvm/Function.h"
 #include "llvm/Module.h"
 #include "llvm/Instructions.h"
 #include "llvm/Intrinsics.h"
-#include "llvm/SymbolTable.h"
-#include <iostream>
+#include "llvm/ADT/SmallVector.h"
+#include <cstring>
 using namespace llvm;
 
-static Function *getUpgradedUnaryFn(Function *F) {
-  const std::string &Name = F->getName();
-  Module *M = F->getParent();
-  switch (F->getReturnType()->getTypeID()) {
-  default: return 0;
-  case Type::UByteTyID:
-  case Type::SByteTyID:
-    return M->getOrInsertFunction(Name+".i8", 
-                                  Type::UByteTy, Type::UByteTy, NULL);
-  case Type::UShortTyID:
-  case Type::ShortTyID:
-    return M->getOrInsertFunction(Name+".i16", 
-                                  Type::UShortTy, Type::UShortTy, NULL);
-  case Type::UIntTyID:
-  case Type::IntTyID:
-    return M->getOrInsertFunction(Name+".i32", 
-                                  Type::UIntTy, Type::UIntTy, NULL);
-  case Type::ULongTyID:
-  case Type::LongTyID:
-    return M->getOrInsertFunction(Name+".i64",
-                                  Type::ULongTy, Type::ULongTy, NULL);
-  case Type::FloatTyID:
-    return M->getOrInsertFunction(Name+".f32",
-                                  Type::FloatTy, Type::FloatTy, NULL);
-  case Type::DoubleTyID:
-    return M->getOrInsertFunction(Name+".f64",
-                                  Type::DoubleTy, Type::DoubleTy, NULL);
-  }
-}
 
-static Function *getUpgradedIntrinsic(Function *F) {
-  // If there's no function, we can't get the argument type.
-  if (!F) return 0;
+static bool UpgradeIntrinsicFunction1(Function *F, Function *&NewFn) {
+  assert(F && "Illegal to upgrade a non-existent Function.");
 
   // Get the Function's name.
   const std::string& Name = F->getName();
 
+  // Convenience
+  const FunctionType *FTy = F->getFunctionType();
+
   // Quickly eliminate it, if it's not a candidate.
   if (Name.length() <= 8 || Name[0] != 'l' || Name[1] != 'l' || 
       Name[2] != 'v' || Name[3] != 'm' || Name[4] != '.')
-    return 0;
+    return false;
 
   Module *M = F->getParent();
   switch (Name[5]) {
   default: break;
   case 'b':
-    if (Name == "llvm.bswap") return getUpgradedUnaryFn(F);
+    //  This upgrades the name of the llvm.bswap intrinsic function to only use 
+    //  a single type name for overloading. We only care about the old format
+    //  'llvm.bswap.i*.i*', so check for 'bswap.' and then for there being 
+    //  a '.' after 'bswap.'
+    if (Name.compare(5,6,"bswap.",6) == 0) {
+      std::string::size_type delim = Name.find('.',11);
+      
+      if (delim != std::string::npos) {
+        //  Construct the new name as 'llvm.bswap' + '.i*'
+        F->setName(Name.substr(0,10)+Name.substr(delim));
+        NewFn = F;
+        return true;
+      }
+    }
     break;
+
   case 'c':
-    if (Name == "llvm.ctpop" || Name == "llvm.ctlz" || Name == "llvm.cttz")
-      return getUpgradedUnaryFn(F);
-    break;
-  case 'd':
-    if (Name == "llvm.dbg.stoppoint") {
-      if (F->getReturnType() != Type::VoidTy) {
-        return M->getOrInsertFunction(Name, Type::VoidTy,
-                                      Type::UIntTy,
-                                      Type::UIntTy,
-                                      F->getFunctionType()->getParamType(3),
-                                      NULL);
-      }
-    } else if (Name == "llvm.dbg.func.start") {
-      if (F->getReturnType()  != Type::VoidTy) {
-        return M->getOrInsertFunction(Name, Type::VoidTy,
-                                      F->getFunctionType()->getParamType(0),
-                                      NULL);
-      }
-    } else if (Name == "llvm.dbg.region.start") {
-      if (F->getReturnType() != Type::VoidTy) {
-        return M->getOrInsertFunction(Name, Type::VoidTy, NULL);
-      }
-    } else if (Name == "llvm.dbg.region.end") {
-      if (F->getReturnType() != Type::VoidTy) {
-        return M->getOrInsertFunction(Name, Type::VoidTy, NULL);
-      }
-    } else if (Name == "llvm.dbg.declare") {
+    //  We only want to fix the 'llvm.ct*' intrinsics which do not have the 
+    //  correct return type, so we check for the name, and then check if the 
+    //  return type does not match the parameter type.
+    if ( (Name.compare(5,5,"ctpop",5) == 0 ||
+          Name.compare(5,4,"ctlz",4) == 0 ||
+          Name.compare(5,4,"cttz",4) == 0) &&
+        FTy->getReturnType() != FTy->getParamType(0)) {
+      //  We first need to change the name of the old (bad) intrinsic, because 
+      //  its type is incorrect, but we cannot overload that name. We 
+      //  arbitrarily unique it here allowing us to construct a correctly named 
+      //  and typed function below.
       F->setName("");
-      return NULL;
+
+      //  Now construct the new intrinsic with the correct name and type. We 
+      //  leave the old function around in order to query its type, whatever it 
+      //  may be, and correctly convert up to the new type.
+      NewFn = cast<Function>(M->getOrInsertFunction(Name, 
+                                                    FTy->getParamType(0),
+                                                    FTy->getParamType(0),
+                                                    (Type *)0));
+      return true;
     }
     break;
-  case 'i':
-    if (Name == "llvm.isunordered" && F->arg_begin() != F->arg_end()) {
-      if (F->arg_begin()->getType() == Type::FloatTy)
-        return M->getOrInsertFunction(Name+".f32", F->getFunctionType());
-      if (F->arg_begin()->getType() == Type::DoubleTy)
-        return M->getOrInsertFunction(Name+".f64", F->getFunctionType());
+
+  case 'p':
+    //  This upgrades the llvm.part.select overloaded intrinsic names to only 
+    //  use one type specifier in the name. We only care about the old format
+    //  'llvm.part.select.i*.i*', and solve as above with bswap.
+    if (Name.compare(5,12,"part.select.",12) == 0) {
+      std::string::size_type delim = Name.find('.',17);
+      
+      if (delim != std::string::npos) {
+        //  Construct a new name as 'llvm.part.select' + '.i*'
+        F->setName(Name.substr(0,16)+Name.substr(delim));
+        NewFn = F;
+        return true;
+      }
+      break;
     }
-    break;
-  case 'm':
-    if (Name == "llvm.memcpy" || Name == "llvm.memset" || 
-        Name == "llvm.memmove") {
-      if (F->getFunctionType()->getParamType(2) == Type::UIntTy ||
-          F->getFunctionType()->getParamType(2) == Type::IntTy)
-        return M->getOrInsertFunction(Name+".i32", Type::VoidTy,
-                                      PointerType::get(Type::SByteTy),
-                                      F->getFunctionType()->getParamType(1),
-                                      Type::UIntTy, Type::UIntTy, NULL);
-      if (F->getFunctionType()->getParamType(2) == Type::ULongTy ||
-          F->getFunctionType()->getParamType(2) == Type::LongTy)
-        return M->getOrInsertFunction(Name+".i64", Type::VoidTy,
-                                      PointerType::get(Type::SByteTy),
-                                      F->getFunctionType()->getParamType(1),
-                                      Type::ULongTy, Type::UIntTy, NULL);
+
+    //  This upgrades the llvm.part.set intrinsics similarly as above, however 
+    //  we care about 'llvm.part.set.i*.i*.i*', but only the first two types 
+    //  must match. There is an additional type specifier after these two 
+    //  matching types that we must retain when upgrading.  Thus, we require 
+    //  finding 2 periods, not just one, after the intrinsic name.
+    if (Name.compare(5,9,"part.set.",9) == 0) {
+      std::string::size_type delim = Name.find('.',14);
+
+      if (delim != std::string::npos &&
+          Name.find('.',delim+1) != std::string::npos) {
+        //  Construct a new name as 'llvm.part.select' + '.i*.i*'
+        F->setName(Name.substr(0,13)+Name.substr(delim));
+        NewFn = F;
+        return true;
+      }
+      break;
     }
+
     break;
-  case 's':
-    if (Name == "llvm.sqrt")
-      return getUpgradedUnaryFn(F);
-    break;
-  }
-  return 0;
-}
+  case 'x': 
+    // This fixes all MMX shift intrinsic instructions to take a
+    // v1i64 instead of a v2i32 as the second parameter.
+    if (Name.compare(5,10,"x86.mmx.ps",10) == 0 &&
+        (Name.compare(13,4,"psll", 4) == 0 ||
+         Name.compare(13,4,"psra", 4) == 0 ||
+         Name.compare(13,4,"psrl", 4) == 0) && Name[17] != 'i') {
+      
+      const llvm::Type *VT = VectorType::get(IntegerType::get(64), 1);
+      
+      // We don't have to do anything if the parameter already has
+      // the correct type.
+      if (FTy->getParamType(1) == VT)
+        break;
+      
+      //  We first need to change the name of the old (bad) intrinsic, because 
+      //  its type is incorrect, but we cannot overload that name. We 
+      //  arbitrarily unique it here allowing us to construct a correctly named 
+      //  and typed function below.
+      F->setName("");
 
-// Occasionally upgraded function call site arguments need to be permutated to
-// some new order.  The result of getArgumentPermutation is an array of size 
-// F->getFunctionType()getNumParams() indicating the new operand order.  A value
-// of zero in the array indicates replacing with UndefValue for the arg type.
-// NULL is returned if there is no permutation.  It's assumed that the function
-// name is in the form "llvm.?????"
-static unsigned *getArgumentPermutation(Function* F) {
-  // Get the Function's name.
-  const std::string& Name = F->getName();
-  switch (Name[5]) {
-  case 'd':
-    if (Name == "llvm.dbg.stoppoint") {
-      static unsigned Permutation[] = { 2, 3, 4 };
-      assert(F->getFunctionType()->getNumParams() ==
-             (sizeof(Permutation) / sizeof(unsigned)) &&
-             "Permutation is wrong length");
-      return Permutation;
+      assert(FTy->getNumParams() == 2 && "MMX shift intrinsics take 2 args!");
+      
+      //  Now construct the new intrinsic with the correct name and type. We 
+      //  leave the old function around in order to query its type, whatever it 
+      //  may be, and correctly convert up to the new type.
+      NewFn = cast<Function>(M->getOrInsertFunction(Name, 
+                                                    FTy->getReturnType(),
+                                                    FTy->getParamType(0),
+                                                    VT,
+                                                    (Type *)0));
+      return true;
+    } else if (Name.compare(5,16,"x86.sse2.movl.dq",16) == 0) {
+      // Calls to this intrinsic are transformed into ShuffleVector's.
+      NewFn = 0;
+      return true;
     }
+
     break;
   }
-  return NULL;
-}
 
-// UpgradeIntrinsicFunction - Convert overloaded intrinsic function names to
-// their non-overloaded variants by appending the appropriate suffix based on
-// the argument types.
-Function *llvm::UpgradeIntrinsicFunction(Function* F) {
-  // See if its one of the name's we're interested in.
-  if (Function *R = getUpgradedIntrinsic(F)) {
-    std::cerr << "WARNING: change " << F->getName() << " to "
-              << R->getName() << "\n";
-    return R;
-  }
-  return 0;
+  //  This may not belong here. This function is effectively being overloaded 
+  //  to both detect an intrinsic which needs upgrading, and to provide the 
+  //  upgraded form of the intrinsic. We should perhaps have two separate 
+  //  functions for this.
+  return false;
 }
 
+bool llvm::UpgradeIntrinsicFunction(Function *F, Function *&NewFn) {
+  NewFn = 0;
+  bool Upgraded = UpgradeIntrinsicFunction1(F, NewFn);
 
-Instruction* llvm::MakeUpgradedCall(Function *F, 
-                                    const std::vector<Value*> &Params,
-                                    BasicBlock *BB, bool isTailCall,
-                                    unsigned CallingConv) {
-  assert(F && "Need a Function to make a CallInst");
-  assert(BB && "Need a BasicBlock to make a CallInst");
-
-  // Convert the params
-  bool signedArg = false;
-  std::vector<Value*> Oprnds;
-  for (std::vector<Value*>::const_iterator PI = Params.begin(), 
-       PE = Params.end(); PI != PE; ++PI) {
-    const Type* opTy = (*PI)->getType();
-    if (opTy->isSigned()) {
-      signedArg = true;
-      CastInst* cast = 
-        new CastInst(*PI,opTy->getUnsignedVersion(), "autoupgrade_cast");
-      BB->getInstList().push_back(cast);
-      Oprnds.push_back(cast);
-    }
-    else
-      Oprnds.push_back(*PI);
-  }
-
-  Instruction *result = new CallInst(F, Oprnds);
-  if (result->getType() != Type::VoidTy) result->setName("autoupgrade_call");
-  if (isTailCall) cast<CallInst>(result)->setTailCall();
-  if (CallingConv) cast<CallInst>(result)->setCallingConv(CallingConv);
-  if (signedArg) {
-    const Type* newTy = F->getReturnType()->getUnsignedVersion();
-    CastInst* final = new CastInst(result, newTy, "autoupgrade_uncast");
-    BB->getInstList().push_back(result);
-    result = final;
-  }
-  return result;
+  // Upgrade intrinsic attributes.  This does not change the function.
+  if (NewFn)
+    F = NewFn;
+  if (unsigned id = F->getIntrinsicID(true))
+    F->setParamAttrs(Intrinsic::getParamAttrs((Intrinsic::ID)id));
+  return Upgraded;
 }
 
-// UpgradeIntrinsicCall - In the BC reader, change a call to an intrinsic to be
-// a call to an upgraded intrinsic.  We may have to permute the order or promote
-// some arguments with a cast.
+// UpgradeIntrinsicCall - Upgrade a call to an old intrinsic to be a call the 
+// upgraded intrinsic. All argument and return casting must be provided in 
+// order to seamlessly integrate with existing context.
 void llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) {
   Function *F = CI->getCalledFunction();
+  assert(F && "CallInst has no function associated with it.");
+
+  if (!NewFn) {
+    if (strcmp(F->getNameStart(), "llvm.x86.sse2.movl.dq") == 0) {
+      std::vector<Constant*> Idxs;
+      Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
+      Idxs.push_back(Zero);
+      Idxs.push_back(Zero);
+      Idxs.push_back(Zero);
+      Idxs.push_back(Zero);
+      Value *ZeroV = ConstantVector::get(Idxs);
 
-  const FunctionType *NewFnTy = NewFn->getFunctionType();
-  std::vector<Value*> Oprnds;
-  
-  unsigned *Permutation = getArgumentPermutation(NewFn);
-  unsigned N = NewFnTy->getNumParams();
+      Idxs.clear(); 
+      Idxs.push_back(ConstantInt::get(Type::Int32Ty, 4));
+      Idxs.push_back(ConstantInt::get(Type::Int32Ty, 5));
+      Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
+      Idxs.push_back(ConstantInt::get(Type::Int32Ty, 3));
+      Value *Mask = ConstantVector::get(Idxs);
+      ShuffleVectorInst *SI = new ShuffleVectorInst(ZeroV, CI->getOperand(1),
+                                                    Mask, "upgraded", CI);
 
-  if (Permutation) {
-    for (unsigned i = 0; i != N; ++i) {
-      unsigned p = Permutation[i];
+      // Handle any uses of the old CallInst.
+      if (!CI->use_empty())
+        //  Replace all uses of the old call with the new cast which has the 
+        //  correct type.
+        CI->replaceAllUsesWith(SI);
       
-      if (p) {
-        Value *V = CI->getOperand(p);
-        if (V->getType() != NewFnTy->getParamType(i))
-          V = new CastInst(V, NewFnTy->getParamType(i), V->getName(), CI);
-        Oprnds.push_back(V);
-      } else
-        Oprnds.push_back(UndefValue::get(NewFnTy->getParamType(i)));
-    }
-  } else if (N) {
-    assert(N == (CI->getNumOperands() - 1) &&
-           "Upgraded function needs permutation");
-    for (unsigned i = 0; i != N; ++i) {
-      Value *V = CI->getOperand(i + 1);
-      if (V->getType() != NewFnTy->getParamType(i))
-        V = new CastInst(V, NewFnTy->getParamType(i), V->getName(), CI);
-      Oprnds.push_back(V);
+      //  Clean up the old call now that it has been completely upgraded.
+      CI->eraseFromParent();
+    } else {
+      assert(0 && "Unknown function for CallInst upgrade.");
     }
+    return;
   }
-  
-  bool NewIsVoid = NewFn->getReturnType() == Type::VoidTy;
-  
-  CallInst *NewCI = new CallInst(NewFn, Oprnds,
-                                 NewIsVoid ? "" : CI->getName(),
-                                 CI);
-  NewCI->setTailCall(CI->isTailCall());
-  NewCI->setCallingConv(CI->getCallingConv());
-  
-  if (!CI->use_empty()) {
-    if (NewIsVoid) {
-      CI->replaceAllUsesWith(UndefValue::get(CI->getType()));
-    } else {
-      Instruction *RetVal = NewCI;
-      
-      if (F->getReturnType() != NewFn->getReturnType()) {
-        RetVal = new CastInst(NewCI, F->getReturnType(), 
-                              NewCI->getName(), CI);
-        NewCI->moveBefore(RetVal);
-      }
+
+  switch (NewFn->getIntrinsicID()) {
+  default:  assert(0 && "Unknown function for CallInst upgrade.");
+  case Intrinsic::x86_mmx_psll_d:
+  case Intrinsic::x86_mmx_psll_q:
+  case Intrinsic::x86_mmx_psll_w:
+  case Intrinsic::x86_mmx_psra_d:
+  case Intrinsic::x86_mmx_psra_w:
+  case Intrinsic::x86_mmx_psrl_d:
+  case Intrinsic::x86_mmx_psrl_q:
+  case Intrinsic::x86_mmx_psrl_w: {
+    Value *Operands[2];
+    
+    Operands[0] = CI->getOperand(1);
+    
+    // Cast the second parameter to the correct type.
+    BitCastInst *BC = new BitCastInst(CI->getOperand(2), 
+                                      NewFn->getFunctionType()->getParamType(1),
+                                      "upgraded", CI);
+    Operands[1] = BC;
+    
+    //  Construct a new CallInst
+    CallInst *NewCI = CallInst::Create(NewFn, Operands, Operands+2, 
+                                       "upgraded."+CI->getName(), CI);
+    NewCI->setTailCall(CI->isTailCall());
+    NewCI->setCallingConv(CI->getCallingConv());
+    
+    //  Handle any uses of the old CallInst.
+    if (!CI->use_empty())
+      //  Replace all uses of the old call with the new cast which has the 
+      //  correct type.
+      CI->replaceAllUsesWith(NewCI);
+    
+    //  Clean up the old call now that it has been completely upgraded.
+    CI->eraseFromParent();
+    break;
+  }        
+  case Intrinsic::ctlz:
+  case Intrinsic::ctpop:
+  case Intrinsic::cttz: {
+    //  Build a small vector of the 1..(N-1) operands, which are the 
+    //  parameters.
+    SmallVector<Value*, 8> Operands(CI->op_begin()+1, CI->op_end());
+
+    //  Construct a new CallInst
+    CallInst *NewCI = CallInst::Create(NewFn, Operands.begin(), Operands.end(),
+                                       "upgraded."+CI->getName(), CI);
+    NewCI->setTailCall(CI->isTailCall());
+    NewCI->setCallingConv(CI->getCallingConv());
+
+    //  Handle any uses of the old CallInst.
+    if (!CI->use_empty()) {
+      //  Check for sign extend parameter attributes on the return values.
+      bool SrcSExt = NewFn->getParamAttrs().paramHasAttr(0, ParamAttr::SExt);
+      bool DestSExt = F->getParamAttrs().paramHasAttr(0, ParamAttr::SExt);
       
-      CI->replaceAllUsesWith(RetVal);
+      //  Construct an appropriate cast from the new return type to the old.
+      CastInst *RetCast = CastInst::Create(
+                            CastInst::getCastOpcode(NewCI, SrcSExt,
+                                                    F->getReturnType(),
+                                                    DestSExt),
+                            NewCI, F->getReturnType(),
+                            NewCI->getName(), CI);
+      NewCI->moveBefore(RetCast);
+
+      //  Replace all uses of the old call with the new cast which has the 
+      //  correct type.
+      CI->replaceAllUsesWith(RetCast);
     }
+
+    //  Clean up the old call now that it has been completely upgraded.
+    CI->eraseFromParent();
+  }
+  break;
   }
-  CI->eraseFromParent();
 }
 
-bool llvm::UpgradeCallsToIntrinsic(Function* F) {
-  if (Function* NewFn = UpgradeIntrinsicFunction(F)) {
-    for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
-         UI != UE; ) {
-      if (CallInst* CI = dyn_cast<CallInst>(*UI++)) 
-        UpgradeIntrinsicCall(CI, NewFn);
-    }
-    if (NewFn != F)
+// This tests each Function to determine if it needs upgrading. When we find 
+// one we are interested in, we then upgrade all calls to reflect the new 
+// function.
+void llvm::UpgradeCallsToIntrinsic(Function* F) {
+  assert(F && "Illegal attempt to upgrade a non-existent intrinsic.");
+
+  // Upgrade the function and check if it is a totaly new function.
+  Function* NewFn;
+  if (UpgradeIntrinsicFunction(F, NewFn)) {
+    if (NewFn != F) {
+      // Replace all uses to the old function with the new one if necessary.
+      for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
+           UI != UE; ) {
+        if (CallInst* CI = dyn_cast<CallInst>(*UI++))
+          UpgradeIntrinsicCall(CI, NewFn);
+      }
+      // Remove old function, no longer used, from the module.
       F->eraseFromParent();
-    return true;
+    }
   }
-  return false;
 }
+