lib/VMCore/AutoUpgrade.cpp

   1 //===-- AutoUpgrade.cpp - Implement auto-upgrade helper functions ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the auto-upgrade helper functions
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/AutoUpgrade.h"
  15 #include "llvm/Constants.h"
  16 #include "llvm/Function.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/Intrinsics.h"
  20 #include "llvm/ADT/SmallVector.h"
  21 #include <cstring>
  22 using namespace llvm;
  23
  24
  25 static bool UpgradeIntrinsicFunction1(Function *F, Function *&NewFn) {
  26   assert(F && "Illegal to upgrade a non-existent Function.");
  27
  28   // Get the Function's name.
  29   const std::string& Name = F->getName();
  30
  31   // Convenience
  32   const FunctionType *FTy = F->getFunctionType();
  33
  34   // Quickly eliminate it, if it's not a candidate.
  35   if (Name.length() <= 8 || Name[0] != 'l' || Name[1] != 'l' ||
  36       Name[2] != 'v' || Name[3] != 'm' || Name[4] != '.')
  37     return false;
  38
  39   Module *M = F->getParent();
  40   switch (Name[5]) {
  41   default: break;
  42   case 'b':
  43     //  This upgrades the name of the llvm.bswap intrinsic function to only use
  44     //  a single type name for overloading. We only care about the old format
  45     //  'llvm.bswap.i*.i*', so check for 'bswap.' and then for there being
  46     //  a '.' after 'bswap.'
  47     if (Name.compare(5,6,"bswap.",6) == 0) {
  48       std::string::size_type delim = Name.find('.',11);
  49
  50       if (delim != std::string::npos) {
  51         //  Construct the new name as 'llvm.bswap' + '.i*'
  52         F->setName(Name.substr(0,10)+Name.substr(delim));
  53         NewFn = F;
  54         return true;
  55       }
  56     }
  57     break;
  58
  59   case 'c':
  60     //  We only want to fix the 'llvm.ct*' intrinsics which do not have the
  61     //  correct return type, so we check for the name, and then check if the
  62     //  return type does not match the parameter type.
  63     if ( (Name.compare(5,5,"ctpop",5) == 0 ||
  64           Name.compare(5,4,"ctlz",4) == 0 ||
  65           Name.compare(5,4,"cttz",4) == 0) &&
  66         FTy->getReturnType() != FTy->getParamType(0)) {
  67       //  We first need to change the name of the old (bad) intrinsic, because
  68       //  its type is incorrect, but we cannot overload that name. We
  69       //  arbitrarily unique it here allowing us to construct a correctly named
  70       //  and typed function below.
  71       F->setName("");
  72
  73       //  Now construct the new intrinsic with the correct name and type. We
  74       //  leave the old function around in order to query its type, whatever it
  75       //  may be, and correctly convert up to the new type.
  76       NewFn = cast<Function>(M->getOrInsertFunction(Name,
  77                                                     FTy->getParamType(0),
  78                                                     FTy->getParamType(0),
  79                                                     (Type *)0));
  80       return true;
  81     }
  82     break;
  83
  84   case 'p':
  85     //  This upgrades the llvm.part.select overloaded intrinsic names to only
  86     //  use one type specifier in the name. We only care about the old format
  87     //  'llvm.part.select.i*.i*', and solve as above with bswap.
  88     if (Name.compare(5,12,"part.select.",12) == 0) {
  89       std::string::size_type delim = Name.find('.',17);
  90
  91       if (delim != std::string::npos) {
  92         //  Construct a new name as 'llvm.part.select' + '.i*'
  93         F->setName(Name.substr(0,16)+Name.substr(delim));
  94         NewFn = F;
  95         return true;
  96       }
  97       break;
  98     }
  99
 100     //  This upgrades the llvm.part.set intrinsics similarly as above, however
 101     //  we care about 'llvm.part.set.i*.i*.i*', but only the first two types
 102     //  must match. There is an additional type specifier after these two
 103     //  matching types that we must retain when upgrading.  Thus, we require
 104     //  finding 2 periods, not just one, after the intrinsic name.
 105     if (Name.compare(5,9,"part.set.",9) == 0) {
 106       std::string::size_type delim = Name.find('.',14);
 107
 108       if (delim != std::string::npos &&
 109           Name.find('.',delim+1) != std::string::npos) {
 110         //  Construct a new name as 'llvm.part.select' + '.i*.i*'
 111         F->setName(Name.substr(0,13)+Name.substr(delim));
 112         NewFn = F;
 113         return true;
 114       }
 115       break;
 116     }
 117
 118     break;
 119   case 'x':
 120     // This fixes all MMX shift intrinsic instructions to take a
 121     // v1i64 instead of a v2i32 as the second parameter.
 122     if (Name.compare(5,10,"x86.mmx.ps",10) == 0 &&
 123         (Name.compare(13,4,"psll", 4) == 0 ||
 124          Name.compare(13,4,"psra", 4) == 0 ||
 125          Name.compare(13,4,"psrl", 4) == 0)) {
 126
 127       const llvm::Type *VT = VectorType::get(IntegerType::get(64), 1);
 128
 129       // We don't have to do anything if the parameter already has
 130       // the correct type.
 131       if (FTy->getParamType(1) == VT)
 132         break;
 133
 134       //  We first need to change the name of the old (bad) intrinsic, because
 135       //  its type is incorrect, but we cannot overload that name. We
 136       //  arbitrarily unique it here allowing us to construct a correctly named
 137       //  and typed function below.
 138       F->setName("");
 139
 140       assert(FTy->getNumParams() == 2 && "MMX shift intrinsics take 2 args!");
 141
 142       //  Now construct the new intrinsic with the correct name and type. We
 143       //  leave the old function around in order to query its type, whatever it
 144       //  may be, and correctly convert up to the new type.
 145       NewFn = cast<Function>(M->getOrInsertFunction(Name,
 146                                                     FTy->getReturnType(),
 147                                                     FTy->getParamType(0),
 148                                                     VT,
 149                                                     (Type *)0));
 150       return true;
 151     } else if (Name.compare(5,16,"x86.sse2.movl.dq",16) == 0) {
 152       // Calls to this intrinsic are transformed into ShuffleVector's.
 153       NewFn = 0;
 154       return true;
 155     }
 156
 157     break;
 158   }
 159
 160   //  This may not belong here. This function is effectively being overloaded
 161   //  to both detect an intrinsic which needs upgrading, and to provide the
 162   //  upgraded form of the intrinsic. We should perhaps have two separate
 163   //  functions for this.
 164   return false;
 165 }
 166
 167 bool llvm::UpgradeIntrinsicFunction(Function *F, Function *&NewFn) {
 168   NewFn = 0;
 169   bool Upgraded = UpgradeIntrinsicFunction1(F, NewFn);
 170
 171   // Upgrade intrinsic attributes.  This does not change the function.
 172   if (NewFn)
 173     F = NewFn;
 174   if (unsigned id = F->getIntrinsicID(true))
 175     F->setParamAttrs(Intrinsic::getParamAttrs((Intrinsic::ID)id));
 176   return Upgraded;
 177 }
 178
 179 // UpgradeIntrinsicCall - Upgrade a call to an old intrinsic to be a call the
 180 // upgraded intrinsic. All argument and return casting must be provided in
 181 // order to seamlessly integrate with existing context.
 182 void llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) {
 183   Function *F = CI->getCalledFunction();
 184   assert(F && "CallInst has no function associated with it.");
 185
 186   if (!NewFn) {
 187     if (strcmp(F->getNameStart(), "llvm.x86.sse2.movl.dq") == 0) {
 188       std::vector<Constant*> Idxs;
 189       Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
 190       Idxs.push_back(Zero);
 191       Idxs.push_back(Zero);
 192       Idxs.push_back(Zero);
 193       Idxs.push_back(Zero);
 194       Value *ZeroV = ConstantVector::get(Idxs);
 195
 196       Idxs.clear();
 197       Idxs.push_back(ConstantInt::get(Type::Int32Ty, 4));
 198       Idxs.push_back(ConstantInt::get(Type::Int32Ty, 5));
 199       Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
 200       Idxs.push_back(ConstantInt::get(Type::Int32Ty, 3));
 201       Value *Mask = ConstantVector::get(Idxs);
 202       ShuffleVectorInst *SI = new ShuffleVectorInst(ZeroV, CI->getOperand(1),
 203                                                     Mask, "upgraded", CI);
 204
 205       // Handle any uses of the old CallInst.
 206       if (!CI->use_empty())
 207         //  Replace all uses of the old call with the new cast which has the
 208         //  correct type.
 209         CI->replaceAllUsesWith(SI);
 210
 211       //  Clean up the old call now that it has been completely upgraded.
 212       CI->eraseFromParent();
 213     } else {
 214       assert(0 && "Unknown function for CallInst upgrade.");
 215     }
 216     return;
 217   }
 218
 219   switch(NewFn->getIntrinsicID()) {
 220   default:  assert(0 && "Unknown function for CallInst upgrade.");
 221   case Intrinsic::x86_mmx_psll_d:
 222   case Intrinsic::x86_mmx_psll_q:
 223   case Intrinsic::x86_mmx_psll_w:
 224   case Intrinsic::x86_mmx_psra_d:
 225   case Intrinsic::x86_mmx_psra_w:
 226   case Intrinsic::x86_mmx_psrl_d:
 227   case Intrinsic::x86_mmx_psrl_q:
 228   case Intrinsic::x86_mmx_psrl_w: {
 229     Value *Operands[2];
 230
 231     Operands[0] = CI->getOperand(1);
 232
 233     // Cast the second parameter to the correct type.
 234     BitCastInst *BC = new BitCastInst(CI->getOperand(2),
 235                                       NewFn->getFunctionType()->getParamType(1),
 236                                       "upgraded", CI);
 237     Operands[1] = BC;
 238
 239     //  Construct a new CallInst
 240     CallInst *NewCI = new CallInst(NewFn, Operands, Operands+2,
 241                                    "upgraded."+CI->getName(), CI);
 242     NewCI->setTailCall(CI->isTailCall());
 243     NewCI->setCallingConv(CI->getCallingConv());
 244
 245     //  Handle any uses of the old CallInst.
 246     if (!CI->use_empty())
 247       //  Replace all uses of the old call with the new cast which has the
 248       //  correct type.
 249       CI->replaceAllUsesWith(NewCI);
 250
 251     //  Clean up the old call now that it has been completely upgraded.
 252     CI->eraseFromParent();
 253     break;
 254   }
 255   case Intrinsic::ctlz:
 256   case Intrinsic::ctpop:
 257   case Intrinsic::cttz:
 258     //  Build a small vector of the 1..(N-1) operands, which are the
 259     //  parameters.
 260     SmallVector<Value*, 8> Operands(CI->op_begin()+1, CI->op_end());
 261
 262     //  Construct a new CallInst
 263     CallInst *NewCI = new CallInst(NewFn, Operands.begin(), Operands.end(),
 264                                    "upgraded."+CI->getName(), CI);
 265     NewCI->setTailCall(CI->isTailCall());
 266     NewCI->setCallingConv(CI->getCallingConv());
 267
 268     //  Handle any uses of the old CallInst.
 269     if (!CI->use_empty()) {
 270       //  Check for sign extend parameter attributes on the return values.
 271       bool SrcSExt = NewFn->getParamAttrs().paramHasAttr(0, ParamAttr::SExt);
 272       bool DestSExt = F->getParamAttrs().paramHasAttr(0, ParamAttr::SExt);
 273
 274       //  Construct an appropriate cast from the new return type to the old.
 275       CastInst *RetCast = CastInst::create(
 276                             CastInst::getCastOpcode(NewCI, SrcSExt,
 277                                                     F->getReturnType(),
 278                                                     DestSExt),
 279                             NewCI, F->getReturnType(),
 280                             NewCI->getName(), CI);
 281       NewCI->moveBefore(RetCast);
 282
 283       //  Replace all uses of the old call with the new cast which has the
 284       //  correct type.
 285       CI->replaceAllUsesWith(RetCast);
 286     }
 287
 288     //  Clean up the old call now that it has been completely upgraded.
 289     CI->eraseFromParent();
 290     break;
 291   }
 292 }
 293
 294 // This tests each Function to determine if it needs upgrading. When we find
 295 // one we are interested in, we then upgrade all calls to reflect the new
 296 // function.
 297 void llvm::UpgradeCallsToIntrinsic(Function* F) {
 298   assert(F && "Illegal attempt to upgrade a non-existent intrinsic.");
 299
 300   // Upgrade the function and check if it is a totaly new function.
 301   Function* NewFn;
 302   if (UpgradeIntrinsicFunction(F, NewFn)) {
 303     if (NewFn != F) {
 304       // Replace all uses to the old function with the new one if necessary.
 305       for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
 306            UI != UE; ) {
 307         if (CallInst* CI = dyn_cast<CallInst>(*UI++))
 308           UpgradeIntrinsicCall(CI, NewFn);
 309       }
 310       // Remove old function, no longer used, from the module.
 311       F->eraseFromParent();
 312     }
 313   }
 314 }
 315