lib/VMCore/AutoUpgrade.cpp

   1 //===-- AutoUpgrade.cpp - Implement auto-upgrade helper functions ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the auto-upgrade helper functions
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Assembly/AutoUpgrade.h"
  15 #include "llvm/Constants.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Intrinsics.h"
  21 #include "llvm/SymbolTable.h"
  22 #include <iostream>
  23 using namespace llvm;
  24
  25 static Function *getUpgradedUnaryFn(Function *F) {
  26   const std::string &Name = F->getName();
  27   Module *M = F->getParent();
  28   switch (F->getReturnType()->getTypeID()) {
  29   default: return 0;
  30   case Type::UByteTyID:
  31   case Type::SByteTyID:
  32     return M->getOrInsertFunction(Name+".i8",
  33                                   Type::UByteTy, Type::UByteTy, NULL);
  34   case Type::UShortTyID:
  35   case Type::ShortTyID:
  36     return M->getOrInsertFunction(Name+".i16",
  37                                   Type::UShortTy, Type::UShortTy, NULL);
  38   case Type::UIntTyID:
  39   case Type::IntTyID:
  40     return M->getOrInsertFunction(Name+".i32",
  41                                   Type::UIntTy, Type::UIntTy, NULL);
  42   case Type::ULongTyID:
  43   case Type::LongTyID:
  44     return M->getOrInsertFunction(Name+".i64",
  45                                   Type::ULongTy, Type::ULongTy, NULL);
  46   case Type::FloatTyID:
  47     return M->getOrInsertFunction(Name+".f32",
  48                                   Type::FloatTy, Type::FloatTy, NULL);
  49   case Type::DoubleTyID:
  50     return M->getOrInsertFunction(Name+".f64",
  51                                   Type::DoubleTy, Type::DoubleTy, NULL);
  52   }
  53 }
  54
  55 static Function *getUpgradedIntrinsic(Function *F) {
  56   // If there's no function, we can't get the argument type.
  57   if (!F) return 0;
  58
  59   // Get the Function's name.
  60   const std::string& Name = F->getName();
  61
  62   // Quickly eliminate it, if it's not a candidate.
  63   if (Name.length() <= 8 || Name[0] != 'l' || Name[1] != 'l' ||
  64       Name[2] != 'v' || Name[3] != 'm' || Name[4] != '.')
  65     return 0;
  66
  67   Module *M = F->getParent();
  68   switch (Name[5]) {
  69   default: break;
  70   case 'b':
  71     if (Name == "llvm.bswap") return getUpgradedUnaryFn(F);
  72     break;
  73   case 'c':
  74     if (Name == "llvm.ctpop" || Name == "llvm.ctlz" || Name == "llvm.cttz")
  75       return getUpgradedUnaryFn(F);
  76     break;
  77   case 'd':
  78     if (Name == "llvm.dbg.stoppoint") {
  79       PointerType *ESP =
  80                   PointerType::get(StructType::get(std::vector<const Type*>()));
  81       if (F->getReturnType() != Type::VoidTy ||
  82           F->getFunctionType()->getParamType(2) != ESP) {
  83         return M->getOrInsertFunction(Name, Type::VoidTy,
  84                                       Type::UIntTy, Type::UIntTy, ESP, NULL);
  85       }
  86     } else if (Name == "llvm.dbg.func.start") {
  87       PointerType *ESP =
  88                   PointerType::get(StructType::get(std::vector<const Type*>()));
  89       if (F->getReturnType()  != Type::VoidTy ||
  90           F->getFunctionType()->getParamType(0) != ESP) {
  91         return M->getOrInsertFunction(Name, Type::VoidTy, ESP, NULL);
  92       }
  93     } else if (Name == "llvm.dbg.region.start") {
  94       PointerType *ESP =
  95                   PointerType::get(StructType::get(std::vector<const Type*>()));
  96       if (F->getReturnType() != Type::VoidTy ||
  97           F->getFunctionType()->getParamType(0) != ESP) {
  98         return M->getOrInsertFunction(Name, Type::VoidTy,  ESP, NULL);
  99       }
 100     } else if (Name == "llvm.dbg.region.end") {
 101       PointerType *ESP =
 102                   PointerType::get(StructType::get(std::vector<const Type*>()));
 103       if (F->getReturnType() != Type::VoidTy ||
 104           F->getFunctionType()->getParamType(0) != ESP) {
 105          return M->getOrInsertFunction(Name, Type::VoidTy,  ESP, NULL);
 106       }
 107     } else if (Name == "llvm.dbg.declare") {
 108       PointerType *ESP =
 109                   PointerType::get(StructType::get(std::vector<const Type*>()));
 110       if (F->getReturnType() != Type::VoidTy ||
 111           F->getFunctionType()->getParamType(0) != ESP ||
 112           F->getFunctionType()->getParamType(1) != ESP) {
 113         return M->getOrInsertFunction(Name, Type::VoidTy, ESP, ESP, NULL);
 114       }
 115     }
 116     break;
 117   case 'i':
 118     if (Name == "llvm.isunordered" && F->arg_begin() != F->arg_end()) {
 119       if (F->arg_begin()->getType() == Type::FloatTy)
 120         return M->getOrInsertFunction(Name+".f32", F->getFunctionType());
 121       if (F->arg_begin()->getType() == Type::DoubleTy)
 122         return M->getOrInsertFunction(Name+".f64", F->getFunctionType());
 123     }
 124     break;
 125   case 'm':
 126     if (Name == "llvm.memcpy" || Name == "llvm.memset" ||
 127         Name == "llvm.memmove") {
 128       if (F->getFunctionType()->getParamType(2) == Type::UIntTy ||
 129           F->getFunctionType()->getParamType(2) == Type::IntTy)
 130         return M->getOrInsertFunction(Name+".i32", Type::VoidTy,
 131                                       PointerType::get(Type::SByteTy),
 132                                       F->getFunctionType()->getParamType(1),
 133                                       Type::UIntTy, Type::UIntTy, NULL);
 134       if (F->getFunctionType()->getParamType(2) == Type::ULongTy ||
 135           F->getFunctionType()->getParamType(2) == Type::LongTy)
 136         return M->getOrInsertFunction(Name+".i64", Type::VoidTy,
 137                                       PointerType::get(Type::SByteTy),
 138                                       F->getFunctionType()->getParamType(1),
 139                                       Type::ULongTy, Type::UIntTy, NULL);
 140     }
 141     break;
 142   case 's':
 143     if (Name == "llvm.sqrt")
 144       return getUpgradedUnaryFn(F);
 145     break;
 146   }
 147   return 0;
 148 }
 149
 150 // Occasionally upgraded function call site arguments need to be permutated to
 151 // some new order.  The result of getArgumentPermutation is an array of size
 152 // F->getFunctionType()getNumParams() indicating the new operand order.  A value
 153 // of zero in the array indicates replacing with UndefValue for the arg type.
 154 // NULL is returned if there is no permutation.  It's assumed that the function
 155 // name is in the form "llvm.?????"
 156 static unsigned *getArgumentPermutation(Function* Fn, Function* NewFn) {
 157   const std::string& Name = Fn->getName();
 158   unsigned N = Fn->getFunctionType()->getNumParams();
 159   unsigned M = NewFn->getFunctionType()->getNumParams();
 160
 161   switch (Name[5]) {
 162   case 'd':
 163     if (Name == "llvm.dbg.stoppoint") {
 164       static unsigned Permutation[] = { 2, 3, 4 };
 165       assert(M == (sizeof(Permutation) / sizeof(unsigned)) &&
 166              "Permutation is wrong length");
 167       if (N == 4) return Permutation;
 168     } else if (Name == "llvm.dbg.region.start") {
 169       static unsigned Permutation[] = { 0 };
 170       assert(M == (sizeof(Permutation) / sizeof(unsigned)) &&
 171              "Permutation is wrong length");
 172       if (N == 0) return Permutation;
 173     } else if (Name == "llvm.dbg.region.end") {
 174       static unsigned Permutation[] = { 0 };
 175       assert(M == (sizeof(Permutation) / sizeof(unsigned)) &&
 176              "Permutation is wrong length");
 177       if (N == 0) return Permutation;
 178     } else if (Name == "llvm.dbg.declare") {
 179       static unsigned Permutation[] = { 0, 0 };
 180       assert(M == (sizeof(Permutation) / sizeof(unsigned)) &&
 181              "Permutation is wrong length");
 182       if (N == 0) return Permutation;
 183     }
 184     break;
 185   }
 186   return NULL;
 187 }
 188
 189 // UpgradeIntrinsicFunction - Convert overloaded intrinsic function names to
 190 // their non-overloaded variants by appending the appropriate suffix based on
 191 // the argument types.
 192 Function *llvm::UpgradeIntrinsicFunction(Function* F) {
 193   // See if its one of the name's we're interested in.
 194   if (Function *R = getUpgradedIntrinsic(F)) {
 195     std::cerr << "WARNING: change " << F->getName() << " to "
 196               << R->getName() << "\n";
 197     return R;
 198   }
 199   return 0;
 200 }
 201
 202 // CastArg - Perform the appropriate cast of an upgraded argument.
 203 //
 204 static Value *CastArg(Value *Arg, const Type *Ty) {
 205   if (Constant *C = dyn_cast<Constant>(Arg)) {
 206     return ConstantExpr::getCast(C, Ty);
 207   } else {
 208     return new CastInst(Arg, Ty, "autoupgrade_cast");
 209   }
 210 }
 211
 212 Instruction* llvm::MakeUpgradedCall(Function *F,
 213                                     const std::vector<Value*> &Params,
 214                                     BasicBlock *BB, bool isTailCall,
 215                                     unsigned CallingConv) {
 216   assert(F && "Need a Function to make a CallInst");
 217   assert(BB && "Need a BasicBlock to make a CallInst");
 218
 219   // Convert the params
 220   bool signedArg = false;
 221   std::vector<Value*> Oprnds;
 222   for (std::vector<Value*>::const_iterator PI = Params.begin(),
 223        PE = Params.end(); PI != PE; ++PI) {
 224     const Type* opTy = (*PI)->getType();
 225     if (opTy->isSigned()) {
 226       signedArg = true;
 227       Value *cast = CastArg(*PI, opTy->getUnsignedVersion());
 228       if (Instruction *I = dyn_cast<Instruction>(cast))
 229         BB->getInstList().push_back(I);
 230       Oprnds.push_back(cast);
 231     }
 232     else
 233       Oprnds.push_back(*PI);
 234   }
 235
 236   Instruction *result = new CallInst(F, Oprnds);
 237   if (result->getType() != Type::VoidTy) result->setName("autoupgrade_call");
 238   if (isTailCall) cast<CallInst>(result)->setTailCall();
 239   if (CallingConv) cast<CallInst>(result)->setCallingConv(CallingConv);
 240   if (signedArg) {
 241     const Type* newTy = F->getReturnType()->getUnsignedVersion();
 242     CastInst* final = new CastInst(result, newTy, "autoupgrade_uncast");
 243     BB->getInstList().push_back(result);
 244     result = final;
 245   }
 246   return result;
 247 }
 248
 249 // UpgradeIntrinsicCall - In the BC reader, change a call to an intrinsic to be
 250 // a call to an upgraded intrinsic.  We may have to permute the order or promote
 251 // some arguments with a cast.
 252 void llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) {
 253   Function *F = CI->getCalledFunction();
 254
 255   const FunctionType *NewFnTy = NewFn->getFunctionType();
 256   std::vector<Value*> Oprnds;
 257
 258   unsigned *Permutation = getArgumentPermutation(F, NewFn);
 259   unsigned N = NewFnTy->getNumParams();
 260
 261   if (Permutation) {
 262     for (unsigned i = 0; i != N; ++i) {
 263       unsigned p = Permutation[i];
 264
 265       if (p) {
 266         Value *V = CI->getOperand(p);
 267         if (V->getType() != NewFnTy->getParamType(i))
 268           V = CastArg(V, NewFnTy->getParamType(i));
 269         Oprnds.push_back(V);
 270       } else
 271         Oprnds.push_back(UndefValue::get(NewFnTy->getParamType(i)));
 272     }
 273   } else if (N) {
 274     assert(N == (CI->getNumOperands() - 1) &&
 275            "Upgraded function needs permutation");
 276     for (unsigned i = 0; i != N; ++i) {
 277       Value *V = CI->getOperand(i + 1);
 278       if (V->getType() != NewFnTy->getParamType(i))
 279         V = CastArg(V, NewFnTy->getParamType(i));
 280       Oprnds.push_back(V);
 281     }
 282   }
 283
 284   bool NewIsVoid = NewFn->getReturnType() == Type::VoidTy;
 285
 286   CallInst *NewCI = new CallInst(NewFn, Oprnds,
 287                                  NewIsVoid ? "" : CI->getName(),
 288                                  CI);
 289   NewCI->setTailCall(CI->isTailCall());
 290   NewCI->setCallingConv(CI->getCallingConv());
 291
 292   if (!CI->use_empty()) {
 293     if (NewIsVoid) {
 294       CI->replaceAllUsesWith(UndefValue::get(CI->getType()));
 295     } else {
 296       Instruction *RetVal = NewCI;
 297
 298       if (F->getReturnType() != NewFn->getReturnType()) {
 299         RetVal = new CastInst(NewCI, F->getReturnType(),
 300                               NewCI->getName(), CI);
 301         NewCI->moveBefore(RetVal);
 302       }
 303
 304       CI->replaceAllUsesWith(RetVal);
 305     }
 306   }
 307   CI->eraseFromParent();
 308 }
 309
 310 bool llvm::UpgradeCallsToIntrinsic(Function* F) {
 311   if (Function* NewFn = UpgradeIntrinsicFunction(F)) {
 312     for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
 313          UI != UE; ) {
 314       if (CallInst* CI = dyn_cast<CallInst>(*UI++))
 315         UpgradeIntrinsicCall(CI, NewFn);
 316     }
 317     if (NewFn != F)
 318       F->eraseFromParent();
 319     return true;
 320   }
 321   return false;
 322 }