AutoUpgrade.cpp revision 249259
1202375Srdivacky//===-- AutoUpgrade.cpp - Implement auto-upgrade helper functions ---------===// 2202375Srdivacky// 3202375Srdivacky// The LLVM Compiler Infrastructure 4202375Srdivacky// 5202375Srdivacky// This file is distributed under the University of Illinois Open Source 6202375Srdivacky// License. See LICENSE.TXT for details. 7202375Srdivacky// 8202375Srdivacky//===----------------------------------------------------------------------===// 9202375Srdivacky// 10202375Srdivacky// This file implements the auto-upgrade helper functions 11202375Srdivacky// 12202375Srdivacky//===----------------------------------------------------------------------===// 13202375Srdivacky 14202375Srdivacky#include "llvm/AutoUpgrade.h" 15202375Srdivacky#include "llvm/IR/Constants.h" 16249423Sdim#include "llvm/IR/Function.h" 17221345Sdim#include "llvm/IR/IRBuilder.h" 18202375Srdivacky#include "llvm/IR/Instruction.h" 19249423Sdim#include "llvm/IR/IntrinsicInst.h" 20202375Srdivacky#include "llvm/IR/LLVMContext.h" 21202375Srdivacky#include "llvm/IR/Module.h" 22202375Srdivacky#include "llvm/Support/CFG.h" 23202375Srdivacky#include "llvm/Support/CallSite.h" 24202375Srdivacky#include "llvm/Support/ErrorHandling.h" 25249423Sdim#include <cstring> 26249423Sdimusing namespace llvm; 27202375Srdivacky 28202375Srdivacky// Upgrade the declarations of the SSE4.1 functions whose arguments have 29202375Srdivacky// changed their type from v4f32 to v2i64. 30202375Srdivackystatic bool UpgradeSSE41Function(Function* F, Intrinsic::ID IID, 31202375Srdivacky Function *&NewFn) { 32202375Srdivacky // Check whether this is an old version of the function, which received 33202375Srdivacky // v4f32 arguments. 34202375Srdivacky Type *Arg0Type = F->getFunctionType()->getParamType(0); 35202375Srdivacky if (Arg0Type != VectorType::get(Type::getFloatTy(F->getContext()), 4)) 36202375Srdivacky return false; 37202375Srdivacky 38202375Srdivacky // Yes, it's old, replace it with new version. 39249423Sdim F->setName(F->getName() + ".old"); 40202375Srdivacky NewFn = Intrinsic::getDeclaration(F->getParent(), IID); 41202375Srdivacky return true; 42202375Srdivacky} 43249423Sdim 44202375Srdivackystatic bool UpgradeIntrinsicFunction1(Function *F, Function *&NewFn) { 45202375Srdivacky assert(F && "Illegal to upgrade a non-existent Function."); 46202375Srdivacky 47249423Sdim // Quickly eliminate it, if it's not a candidate. 48202375Srdivacky StringRef Name = F->getName(); 49202375Srdivacky if (Name.size() <= 8 || !Name.startswith("llvm.")) 50202375Srdivacky return false; 51202375Srdivacky Name = Name.substr(5); // Strip off "llvm." 52202375Srdivacky 53202375Srdivacky switch (Name[0]) { 54202375Srdivacky default: break; 55202375Srdivacky case 'a': { 56202375Srdivacky if (Name.startswith("arm.neon.vclz")) { 57202375Srdivacky Type* args[2] = { 58202375Srdivacky F->arg_begin()->getType(), 59249423Sdim Type::getInt1Ty(F->getContext()) 60202375Srdivacky }; 61202375Srdivacky // Can't use Intrinsic::getDeclaration here as it adds a ".i1" to 62202375Srdivacky // the end of the name. Change name from llvm.arm.neon.vclz.* to 63202375Srdivacky // llvm.ctlz.* 64202375Srdivacky FunctionType* fType = FunctionType::get(F->getReturnType(), args, false); 65202375Srdivacky NewFn = Function::Create(fType, F->getLinkage(), 66202375Srdivacky "llvm.ctlz." + Name.substr(14), F->getParent()); 67202375Srdivacky return true; 68202375Srdivacky } 69202375Srdivacky if (Name.startswith("arm.neon.vcnt")) { 70202375Srdivacky NewFn = Intrinsic::getDeclaration(F->getParent(), Intrinsic::ctpop, 71202375Srdivacky F->arg_begin()->getType()); 72202375Srdivacky return true; 73202375Srdivacky } 74202375Srdivacky break; 75202375Srdivacky } 76202375Srdivacky case 'c': { 77202375Srdivacky if (Name.startswith("ctlz.") && F->arg_size() == 1) { 78202375Srdivacky F->setName(Name + ".old"); 79202375Srdivacky NewFn = Intrinsic::getDeclaration(F->getParent(), Intrinsic::ctlz, 80202375Srdivacky F->arg_begin()->getType()); 81202375Srdivacky return true; 82202375Srdivacky } 83202375Srdivacky if (Name.startswith("cttz.") && F->arg_size() == 1) { 84202375Srdivacky F->setName(Name + ".old"); 85202375Srdivacky NewFn = Intrinsic::getDeclaration(F->getParent(), Intrinsic::cttz, 86202375Srdivacky F->arg_begin()->getType()); 87202375Srdivacky return true; 88202375Srdivacky } 89202375Srdivacky break; 90202375Srdivacky } 91202375Srdivacky case 'x': { 92202375Srdivacky if (Name.startswith("x86.sse2.pcmpeq.") || 93234353Sdim Name.startswith("x86.sse2.pcmpgt.") || 94249423Sdim Name.startswith("x86.avx2.pcmpeq.") || 95202375Srdivacky Name.startswith("x86.avx2.pcmpgt.") || 96202375Srdivacky Name.startswith("x86.avx.vpermil.") || 97234353Sdim Name == "x86.avx.movnt.dq.256" || 98234353Sdim Name == "x86.avx.movnt.pd.256" || 99234353Sdim Name == "x86.avx.movnt.ps.256" || 100234353Sdim (Name.startswith("x86.xop.vpcom") && F->arg_size() == 2)) { 101234353Sdim NewFn = 0; 102234353Sdim return true; 103202375Srdivacky } 104202375Srdivacky // SSE4.1 ptest functions may have an old signature. 105202375Srdivacky if (Name.startswith("x86.sse41.ptest")) { 106202375Srdivacky if (Name == "x86.sse41.ptestc") 107202375Srdivacky return UpgradeSSE41Function(F, Intrinsic::x86_sse41_ptestc, NewFn); 108202375Srdivacky if (Name == "x86.sse41.ptestz") 109204792Srdivacky return UpgradeSSE41Function(F, Intrinsic::x86_sse41_ptestz, NewFn); 110204792Srdivacky if (Name == "x86.sse41.ptestnzc") 111204792Srdivacky return UpgradeSSE41Function(F, Intrinsic::x86_sse41_ptestnzc, NewFn); 112202375Srdivacky } 113234353Sdim // frcz.ss/sd may need to have an argument dropped 114204792Srdivacky if (Name.startswith("x86.xop.vfrcz.ss") && F->arg_size() == 2) { 115204792Srdivacky F->setName(Name + ".old"); 116204792Srdivacky NewFn = Intrinsic::getDeclaration(F->getParent(), 117204792Srdivacky Intrinsic::x86_xop_vfrcz_ss); 118204792Srdivacky return true; 119204792Srdivacky } 120204792Srdivacky if (Name.startswith("x86.xop.vfrcz.sd") && F->arg_size() == 2) { 121249423Sdim F->setName(Name + ".old"); 122218893Sdim NewFn = Intrinsic::getDeclaration(F->getParent(), 123218893Sdim Intrinsic::x86_xop_vfrcz_sd); 124202375Srdivacky return true; 125204792Srdivacky } 126202375Srdivacky // Fix the FMA4 intrinsics to remove the 4 127202375Srdivacky if (Name.startswith("x86.fma4.")) { 128202375Srdivacky F->setName("llvm.x86.fma" + Name.substr(8)); 129202375Srdivacky NewFn = F; 130202375Srdivacky return true; 131202375Srdivacky } 132202375Srdivacky break; 133202375Srdivacky } 134202375Srdivacky } 135202375Srdivacky 136202375Srdivacky // This may not belong here. This function is effectively being overloaded 137202375Srdivacky // to both detect an intrinsic which needs upgrading, and to provide the 138202375Srdivacky // upgraded form of the intrinsic. We should perhaps have two separate 139202375Srdivacky // functions for this. 140202375Srdivacky return false; 141202375Srdivacky} 142202375Srdivacky 143202375Srdivackybool llvm::UpgradeIntrinsicFunction(Function *F, Function *&NewFn) { 144202375Srdivacky NewFn = 0; 145202375Srdivacky bool Upgraded = UpgradeIntrinsicFunction1(F, NewFn); 146202375Srdivacky 147202375Srdivacky // Upgrade intrinsic attributes. This does not change the function. 148202375Srdivacky if (NewFn) 149202375Srdivacky F = NewFn; 150218893Sdim if (unsigned id = F->getIntrinsicID()) 151218893Sdim F->setAttributes(Intrinsic::getAttributes(F->getContext(), 152218893Sdim (Intrinsic::ID)id)); 153218893Sdim return Upgraded; 154218893Sdim} 155218893Sdim 156218893Sdimbool llvm::UpgradeGlobalVariable(GlobalVariable *GV) { 157249423Sdim // Nothing to do yet. 158218893Sdim return false; 159218893Sdim} 160218893Sdim 161218893Sdim// UpgradeIntrinsicCall - Upgrade a call to an old intrinsic to be a call the 162218893Sdim// upgraded intrinsic. All argument and return casting must be provided in 163218893Sdim// order to seamlessly integrate with existing context. 164218893Sdimvoid llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) { 165218893Sdim Function *F = CI->getCalledFunction(); 166218893Sdim LLVMContext &C = CI->getContext(); 167218893Sdim IRBuilder<> Builder(C); 168202375Srdivacky Builder.SetInsertPoint(CI->getParent(), CI); 169249423Sdim 170202375Srdivacky assert(F && "Intrinsic call is not direct?"); 171202375Srdivacky 172202375Srdivacky if (!NewFn) { 173202375Srdivacky // Get the Function's name. 174202375Srdivacky StringRef Name = F->getName(); 175202375Srdivacky 176263508Sdim Value *Rep; 177202375Srdivacky // Upgrade packed integer vector compares intrinsics to compare instructions 178202375Srdivacky if (Name.startswith("llvm.x86.sse2.pcmpeq.") || 179202375Srdivacky Name.startswith("llvm.x86.avx2.pcmpeq.")) { 180202375Srdivacky Rep = Builder.CreateICmpEQ(CI->getArgOperand(0), CI->getArgOperand(1), 181202375Srdivacky "pcmpeq"); 182202375Srdivacky // need to sign extend since icmp returns vector of i1 183263508Sdim Rep = Builder.CreateSExt(Rep, CI->getType(), ""); 184202375Srdivacky } else if (Name.startswith("llvm.x86.sse2.pcmpgt.") || 185202375Srdivacky Name.startswith("llvm.x86.avx2.pcmpgt.")) { 186202375Srdivacky Rep = Builder.CreateICmpSGT(CI->getArgOperand(0), CI->getArgOperand(1), 187202375Srdivacky "pcmpgt"); 188202375Srdivacky // need to sign extend since icmp returns vector of i1 189202375Srdivacky Rep = Builder.CreateSExt(Rep, CI->getType(), ""); 190202375Srdivacky } else if (Name == "llvm.x86.avx.movnt.dq.256" || 191202375Srdivacky Name == "llvm.x86.avx.movnt.ps.256" || 192202375Srdivacky Name == "llvm.x86.avx.movnt.pd.256") { 193202375Srdivacky IRBuilder<> Builder(C); 194202375Srdivacky Builder.SetInsertPoint(CI->getParent(), CI); 195202375Srdivacky 196202375Srdivacky Module *M = F->getParent(); 197202375Srdivacky SmallVector<Value *, 1> Elts; 198202375Srdivacky Elts.push_back(ConstantInt::get(Type::getInt32Ty(C), 1)); 199202375Srdivacky MDNode *Node = MDNode::get(C, Elts); 200202375Srdivacky 201202375Srdivacky Value *Arg0 = CI->getArgOperand(0); 202202375Srdivacky Value *Arg1 = CI->getArgOperand(1); 203202375Srdivacky 204202375Srdivacky // Convert the type of the pointer to a pointer to the stored type. 205202375Srdivacky Value *BC = Builder.CreateBitCast(Arg0, 206202375Srdivacky PointerType::getUnqual(Arg1->getType()), 207202375Srdivacky "cast"); 208202375Srdivacky StoreInst *SI = Builder.CreateStore(Arg1, BC); 209202375Srdivacky SI->setMetadata(M->getMDKindID("nontemporal"), Node); 210202375Srdivacky SI->setAlignment(16); 211202375Srdivacky 212263508Sdim // Remove intrinsic. 213202375Srdivacky CI->eraseFromParent(); 214218893Sdim return; 215218893Sdim } else if (Name.startswith("llvm.x86.xop.vpcom")) { 216202375Srdivacky Intrinsic::ID intID; 217249423Sdim if (Name.endswith("ub")) 218218893Sdim intID = Intrinsic::x86_xop_vpcomub; 219202375Srdivacky else if (Name.endswith("uw")) 220202375Srdivacky intID = Intrinsic::x86_xop_vpcomuw; 221202375Srdivacky else if (Name.endswith("ud")) 222202375Srdivacky intID = Intrinsic::x86_xop_vpcomud; 223202375Srdivacky else if (Name.endswith("uq")) 224202375Srdivacky intID = Intrinsic::x86_xop_vpcomuq; 225202375Srdivacky else if (Name.endswith("b")) 226202375Srdivacky intID = Intrinsic::x86_xop_vpcomb; 227202375Srdivacky else if (Name.endswith("w")) 228202375Srdivacky intID = Intrinsic::x86_xop_vpcomw; 229202375Srdivacky else if (Name.endswith("d")) 230202375Srdivacky intID = Intrinsic::x86_xop_vpcomd; 231202375Srdivacky else if (Name.endswith("q")) 232263508Sdim intID = Intrinsic::x86_xop_vpcomq; 233202375Srdivacky else 234218893Sdim llvm_unreachable("Unknown suffix"); 235218893Sdim 236202375Srdivacky Name = Name.substr(18); // strip off "llvm.x86.xop.vpcom" 237249423Sdim unsigned Imm; 238218893Sdim if (Name.startswith("lt")) 239202375Srdivacky Imm = 0; 240202375Srdivacky else if (Name.startswith("le")) 241202375Srdivacky Imm = 1; 242202375Srdivacky else if (Name.startswith("gt")) 243202375Srdivacky Imm = 2; 244202375Srdivacky else if (Name.startswith("ge")) 245202375Srdivacky Imm = 3; 246202375Srdivacky else if (Name.startswith("eq")) 247202375Srdivacky Imm = 4; 248202375Srdivacky else if (Name.startswith("ne")) 249202375Srdivacky Imm = 5; 250202375Srdivacky else if (Name.startswith("true")) 251202375Srdivacky Imm = 6; 252263508Sdim else if (Name.startswith("false")) 253202375Srdivacky Imm = 7; 254202375Srdivacky else 255202375Srdivacky llvm_unreachable("Unknown condition"); 256202375Srdivacky 257202375Srdivacky Function *VPCOM = Intrinsic::getDeclaration(F->getParent(), intID); 258202375Srdivacky Rep = Builder.CreateCall3(VPCOM, CI->getArgOperand(0), 259202375Srdivacky CI->getArgOperand(1), Builder.getInt8(Imm)); 260202375Srdivacky } else { 261202375Srdivacky bool PD128 = false, PD256 = false, PS128 = false, PS256 = false; 262202375Srdivacky if (Name == "llvm.x86.avx.vpermil.pd.256") 263202375Srdivacky PD256 = true; 264202375Srdivacky else if (Name == "llvm.x86.avx.vpermil.pd") 265202375Srdivacky PD128 = true; 266251662Sdim else if (Name == "llvm.x86.avx.vpermil.ps.256") 267251662Sdim PS256 = true; 268249423Sdim else if (Name == "llvm.x86.avx.vpermil.ps") 269202375Srdivacky PS128 = true; 270202375Srdivacky 271204792Srdivacky if (PD256 || PD128 || PS256 || PS128) { 272204792Srdivacky Value *Op0 = CI->getArgOperand(0); 273249423Sdim unsigned Imm = cast<ConstantInt>(CI->getArgOperand(1))->getZExtValue(); 274202375Srdivacky SmallVector<Constant*, 8> Idxs; 275202375Srdivacky 276249423Sdim if (PD128) 277202375Srdivacky for (unsigned i = 0; i != 2; ++i) 278202375Srdivacky Idxs.push_back(Builder.getInt32((Imm >> i) & 0x1)); 279263508Sdim else if (PD256) 280202375Srdivacky for (unsigned l = 0; l != 4; l+=2) 281202375Srdivacky for (unsigned i = 0; i != 2; ++i) 282202375Srdivacky Idxs.push_back(Builder.getInt32(((Imm >> (l+i)) & 0x1) + l)); 283249423Sdim else if (PS128) 284202375Srdivacky for (unsigned i = 0; i != 4; ++i) 285204792Srdivacky Idxs.push_back(Builder.getInt32((Imm >> (2 * i)) & 0x3)); 286202375Srdivacky else if (PS256) 287202375Srdivacky for (unsigned l = 0; l != 8; l+=4) 288202375Srdivacky for (unsigned i = 0; i != 4; ++i) 289202375Srdivacky Idxs.push_back(Builder.getInt32(((Imm >> (2 * i)) & 0x3) + l)); 290202375Srdivacky else 291202375Srdivacky llvm_unreachable("Unexpected function"); 292204792Srdivacky 293202375Srdivacky Rep = Builder.CreateShuffleVector(Op0, Op0, ConstantVector::get(Idxs)); 294202375Srdivacky } else { 295202375Srdivacky llvm_unreachable("Unknown function for CallInst upgrade."); 296263508Sdim } 297202375Srdivacky } 298202375Srdivacky 299202375Srdivacky CI->replaceAllUsesWith(Rep); 300202375Srdivacky CI->eraseFromParent(); 301249423Sdim return; 302202375Srdivacky } 303204792Srdivacky 304202375Srdivacky std::string Name = CI->getName().str(); 305202375Srdivacky CI->setName(Name + ".old"); 306202375Srdivacky 307202375Srdivacky switch (NewFn->getIntrinsicID()) { 308202375Srdivacky default: 309202375Srdivacky llvm_unreachable("Unknown function for CallInst upgrade."); 310202375Srdivacky 311204792Srdivacky case Intrinsic::ctlz: 312202375Srdivacky case Intrinsic::cttz: 313202375Srdivacky assert(CI->getNumArgOperands() == 1 && 314202375Srdivacky "Mismatch between function args and call args"); 315202375Srdivacky CI->replaceAllUsesWith(Builder.CreateCall2(NewFn, CI->getArgOperand(0), 316202375Srdivacky Builder.getFalse(), Name)); 317202375Srdivacky CI->eraseFromParent(); 318202375Srdivacky return; 319202375Srdivacky 320202375Srdivacky case Intrinsic::arm_neon_vclz: { 321202375Srdivacky // Change name from llvm.arm.neon.vclz.* to llvm.ctlz.* 322202375Srdivacky CI->replaceAllUsesWith(Builder.CreateCall2(NewFn, CI->getArgOperand(0), 323202375Srdivacky Builder.getFalse(), 324202375Srdivacky "llvm.ctlz." + Name.substr(14))); 325202375Srdivacky CI->eraseFromParent(); 326249423Sdim return; 327202375Srdivacky } 328202375Srdivacky case Intrinsic::ctpop: { 329202375Srdivacky CI->replaceAllUsesWith(Builder.CreateCall(NewFn, CI->getArgOperand(0))); 330202375Srdivacky CI->eraseFromParent(); 331202375Srdivacky return; 332202375Srdivacky } 333249423Sdim 334202375Srdivacky case Intrinsic::x86_xop_vfrcz_ss: 335202375Srdivacky case Intrinsic::x86_xop_vfrcz_sd: 336202375Srdivacky CI->replaceAllUsesWith(Builder.CreateCall(NewFn, CI->getArgOperand(1), 337202375Srdivacky Name)); 338202375Srdivacky CI->eraseFromParent(); 339202375Srdivacky return; 340202375Srdivacky 341202375Srdivacky case Intrinsic::x86_sse41_ptestc: 342202375Srdivacky case Intrinsic::x86_sse41_ptestz: 343202375Srdivacky case Intrinsic::x86_sse41_ptestnzc: { 344202375Srdivacky // The arguments for these intrinsics used to be v4f32, and changed 345202375Srdivacky // to v2i64. This is purely a nop, since those are bitwise intrinsics. 346202375Srdivacky // So, the only thing required is a bitcast for both arguments. 347202375Srdivacky // First, check the arguments have the old type. 348202375Srdivacky Value *Arg0 = CI->getArgOperand(0); 349202375Srdivacky if (Arg0->getType() != VectorType::get(Type::getFloatTy(C), 4)) 350202375Srdivacky return; 351202375Srdivacky 352202375Srdivacky // Old intrinsic, add bitcasts 353202375Srdivacky Value *Arg1 = CI->getArgOperand(1); 354249423Sdim 355249423Sdim Value *BC0 = 356202375Srdivacky Builder.CreateBitCast(Arg0, 357202375Srdivacky VectorType::get(Type::getInt64Ty(C), 2), 358202375Srdivacky "cast"); 359202375Srdivacky Value *BC1 = 360202375Srdivacky Builder.CreateBitCast(Arg1, 361202375Srdivacky VectorType::get(Type::getInt64Ty(C), 2), 362202375Srdivacky "cast"); 363202375Srdivacky 364202375Srdivacky CallInst* NewCall = Builder.CreateCall2(NewFn, BC0, BC1, Name); 365202375Srdivacky CI->replaceAllUsesWith(NewCall); 366202375Srdivacky CI->eraseFromParent(); 367202375Srdivacky return; 368202375Srdivacky } 369202375Srdivacky } 370202375Srdivacky} 371202375Srdivacky 372202375Srdivacky// This tests each Function to determine if it needs upgrading. When we find 373202375Srdivacky// one we are interested in, we then upgrade all calls to reflect the new 374249423Sdim// function. 375202375Srdivackyvoid llvm::UpgradeCallsToIntrinsic(Function* F) { 376202375Srdivacky assert(F && "Illegal attempt to upgrade a non-existent intrinsic."); 377202375Srdivacky 378202375Srdivacky // Upgrade the function and check if it is a totaly new function. 379202375Srdivacky Function *NewFn; 380249423Sdim if (UpgradeIntrinsicFunction(F, NewFn)) { 381202375Srdivacky if (NewFn != F) { 382202375Srdivacky // Replace all uses to the old function with the new one if necessary. 383202375Srdivacky for (Value::use_iterator UI = F->use_begin(), UE = F->use_end(); 384202375Srdivacky UI != UE; ) { 385202375Srdivacky if (CallInst *CI = dyn_cast<CallInst>(*UI++)) 386218893Sdim UpgradeIntrinsicCall(CI, NewFn); 387249423Sdim } 388249423Sdim // Remove old function, no longer used, from the module. 389218893Sdim F->eraseFromParent(); 390218893Sdim } 391218893Sdim } 392218893Sdim} 393218893Sdim 394249423Sdim