1 //===-- AutoUpgrade.cpp - Implement auto-upgrade helper functions ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the auto-upgrade helper functions
12 //===----------------------------------------------------------------------===//
14 #include "llvm/AutoUpgrade.h"
15 #include "llvm/Constants.h"
16 #include "llvm/Function.h"
17 #include "llvm/LLVMContext.h"
18 #include "llvm/Module.h"
19 #include "llvm/IntrinsicInst.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/Support/ErrorHandling.h"
26 static bool UpgradeIntrinsicFunction1(Function *F, Function *&NewFn) {
27 assert(F && "Illegal to upgrade a non-existent Function.");
29 // Get the Function's name.
30 const std::string& Name = F->getName();
33 const FunctionType *FTy = F->getFunctionType();
35 // Quickly eliminate it, if it's not a candidate.
36 if (Name.length() <= 8 || Name[0] != 'l' || Name[1] != 'l' ||
37 Name[2] != 'v' || Name[3] != 'm' || Name[4] != '.')
40 Module *M = F->getParent();
44 // This upgrades the llvm.atomic.lcs, llvm.atomic.las, llvm.atomic.lss,
45 // and atomics with default address spaces to their new names to their new
46 // function name (e.g. llvm.atomic.add.i32 => llvm.atomic.add.i32.p0i32)
47 if (Name.compare(5,7,"atomic.",7) == 0) {
48 if (Name.compare(12,3,"lcs",3) == 0) {
49 std::string::size_type delim = Name.find('.',12);
50 F->setName("llvm.atomic.cmp.swap" + Name.substr(delim) +
51 ".p0" + Name.substr(delim+1));
55 else if (Name.compare(12,3,"las",3) == 0) {
56 std::string::size_type delim = Name.find('.',12);
57 F->setName("llvm.atomic.load.add"+Name.substr(delim)
58 + ".p0" + Name.substr(delim+1));
62 else if (Name.compare(12,3,"lss",3) == 0) {
63 std::string::size_type delim = Name.find('.',12);
64 F->setName("llvm.atomic.load.sub"+Name.substr(delim)
65 + ".p0" + Name.substr(delim+1));
69 else if (Name.rfind(".p") == std::string::npos) {
70 // We don't have an address space qualifier so this has be upgraded
71 // to the new name. Copy the type name at the end of the intrinsic
73 std::string::size_type delim = Name.find_last_of('.');
74 assert(delim != std::string::npos && "can not find type");
75 F->setName(Name + ".p0" + Name.substr(delim+1));
82 // This upgrades the name of the llvm.bswap intrinsic function to only use
83 // a single type name for overloading. We only care about the old format
84 // 'llvm.bswap.i*.i*', so check for 'bswap.' and then for there being
85 // a '.' after 'bswap.'
86 if (Name.compare(5,6,"bswap.",6) == 0) {
87 std::string::size_type delim = Name.find('.',11);
89 if (delim != std::string::npos) {
90 // Construct the new name as 'llvm.bswap' + '.i*'
91 F->setName(Name.substr(0,10)+Name.substr(delim));
99 // We only want to fix the 'llvm.ct*' intrinsics which do not have the
100 // correct return type, so we check for the name, and then check if the
101 // return type does not match the parameter type.
102 if ( (Name.compare(5,5,"ctpop",5) == 0 ||
103 Name.compare(5,4,"ctlz",4) == 0 ||
104 Name.compare(5,4,"cttz",4) == 0) &&
105 FTy->getReturnType() != FTy->getParamType(0)) {
106 // We first need to change the name of the old (bad) intrinsic, because
107 // its type is incorrect, but we cannot overload that name. We
108 // arbitrarily unique it here allowing us to construct a correctly named
109 // and typed function below.
112 // Now construct the new intrinsic with the correct name and type. We
113 // leave the old function around in order to query its type, whatever it
114 // may be, and correctly convert up to the new type.
115 NewFn = cast<Function>(M->getOrInsertFunction(Name,
116 FTy->getParamType(0),
117 FTy->getParamType(0),
124 // The old llvm.eh.selector.i32 is equivalent to the new llvm.eh.selector.
125 if (Name.compare("llvm.eh.selector.i32") == 0) {
126 F->setName("llvm.eh.selector");
130 // The old llvm.eh.typeid.for.i32 is equivalent to llvm.eh.typeid.for.
131 if (Name.compare("llvm.eh.typeid.for.i32") == 0) {
132 F->setName("llvm.eh.typeid.for");
136 // Convert the old llvm.eh.selector.i64 to a call to llvm.eh.selector.
137 if (Name.compare("llvm.eh.selector.i64") == 0) {
138 NewFn = Intrinsic::getDeclaration(M, Intrinsic::eh_selector);
141 // Convert the old llvm.eh.typeid.for.i64 to a call to llvm.eh.typeid.for.
142 if (Name.compare("llvm.eh.typeid.for.i64") == 0) {
143 NewFn = Intrinsic::getDeclaration(M, Intrinsic::eh_typeid_for);
149 // This upgrades the llvm.memcpy, llvm.memmove, and llvm.memset to the
150 // new format that allows overloading the pointer for different address
151 // space (e.g., llvm.memcpy.i16 => llvm.memcpy.p0i8.p0i8.i16)
152 const char* NewFnName = NULL;
153 if (Name.compare(5,8,"memcpy.i",8) == 0) {
155 NewFnName = "llvm.memcpy.p0i8.p0i8.i8";
156 else if (Name.compare(13,2,"16") == 0)
157 NewFnName = "llvm.memcpy.p0i8.p0i8.i16";
158 else if (Name.compare(13,2,"32") == 0)
159 NewFnName = "llvm.memcpy.p0i8.p0i8.i32";
160 else if (Name.compare(13,2,"64") == 0)
161 NewFnName = "llvm.memcpy.p0i8.p0i8.i64";
162 } else if (Name.compare(5,9,"memmove.i",9) == 0) {
164 NewFnName = "llvm.memmove.p0i8.p0i8.i8";
165 else if (Name.compare(14,2,"16") == 0)
166 NewFnName = "llvm.memmove.p0i8.p0i8.i16";
167 else if (Name.compare(14,2,"32") == 0)
168 NewFnName = "llvm.memmove.p0i8.p0i8.i32";
169 else if (Name.compare(14,2,"64") == 0)
170 NewFnName = "llvm.memmove.p0i8.p0i8.i64";
172 else if (Name.compare(5,8,"memset.i",8) == 0) {
174 NewFnName = "llvm.memset.p0i8.i8";
175 else if (Name.compare(13,2,"16") == 0)
176 NewFnName = "llvm.memset.p0i8.i16";
177 else if (Name.compare(13,2,"32") == 0)
178 NewFnName = "llvm.memset.p0i8.i32";
179 else if (Name.compare(13,2,"64") == 0)
180 NewFnName = "llvm.memset.p0i8.i64";
183 const FunctionType *FTy = F->getFunctionType();
184 NewFn = cast<Function>(M->getOrInsertFunction(NewFnName,
185 FTy->getReturnType(),
186 FTy->getParamType(0),
187 FTy->getParamType(1),
188 FTy->getParamType(2),
189 FTy->getParamType(3),
190 Type::getInt1Ty(F->getContext()),
197 // This upgrades the llvm.part.select overloaded intrinsic names to only
198 // use one type specifier in the name. We only care about the old format
199 // 'llvm.part.select.i*.i*', and solve as above with bswap.
200 if (Name.compare(5,12,"part.select.",12) == 0) {
201 std::string::size_type delim = Name.find('.',17);
203 if (delim != std::string::npos) {
204 // Construct a new name as 'llvm.part.select' + '.i*'
205 F->setName(Name.substr(0,16)+Name.substr(delim));
212 // This upgrades the llvm.part.set intrinsics similarly as above, however
213 // we care about 'llvm.part.set.i*.i*.i*', but only the first two types
214 // must match. There is an additional type specifier after these two
215 // matching types that we must retain when upgrading. Thus, we require
216 // finding 2 periods, not just one, after the intrinsic name.
217 if (Name.compare(5,9,"part.set.",9) == 0) {
218 std::string::size_type delim = Name.find('.',14);
220 if (delim != std::string::npos &&
221 Name.find('.',delim+1) != std::string::npos) {
222 // Construct a new name as 'llvm.part.select' + '.i*.i*'
223 F->setName(Name.substr(0,13)+Name.substr(delim));
232 // This fixes all MMX shift intrinsic instructions to take a
233 // v1i64 instead of a v2i32 as the second parameter.
234 if (Name.compare(5,10,"x86.mmx.ps",10) == 0 &&
235 (Name.compare(13,4,"psll", 4) == 0 ||
236 Name.compare(13,4,"psra", 4) == 0 ||
237 Name.compare(13,4,"psrl", 4) == 0) && Name[17] != 'i') {
239 const llvm::Type *VT =
240 VectorType::get(IntegerType::get(FTy->getContext(), 64), 1);
242 // We don't have to do anything if the parameter already has
244 if (FTy->getParamType(1) == VT)
247 // We first need to change the name of the old (bad) intrinsic, because
248 // its type is incorrect, but we cannot overload that name. We
249 // arbitrarily unique it here allowing us to construct a correctly named
250 // and typed function below.
253 assert(FTy->getNumParams() == 2 && "MMX shift intrinsics take 2 args!");
255 // Now construct the new intrinsic with the correct name and type. We
256 // leave the old function around in order to query its type, whatever it
257 // may be, and correctly convert up to the new type.
258 NewFn = cast<Function>(M->getOrInsertFunction(Name,
259 FTy->getReturnType(),
260 FTy->getParamType(0),
264 } else if (Name.compare(5,17,"x86.sse2.loadh.pd",17) == 0 ||
265 Name.compare(5,17,"x86.sse2.loadl.pd",17) == 0 ||
266 Name.compare(5,16,"x86.sse2.movl.dq",16) == 0 ||
267 Name.compare(5,15,"x86.sse2.movs.d",15) == 0 ||
268 Name.compare(5,16,"x86.sse2.shuf.pd",16) == 0 ||
269 Name.compare(5,18,"x86.sse2.unpckh.pd",18) == 0 ||
270 Name.compare(5,18,"x86.sse2.unpckl.pd",18) == 0 ||
271 Name.compare(5,20,"x86.sse2.punpckh.qdq",20) == 0 ||
272 Name.compare(5,20,"x86.sse2.punpckl.qdq",20) == 0) {
273 // Calls to these intrinsics are transformed into ShuffleVector's.
276 } else if (Name.compare(5, 16, "x86.sse41.pmulld", 16) == 0) {
277 // Calls to these intrinsics are transformed into vector multiplies.
286 // This may not belong here. This function is effectively being overloaded
287 // to both detect an intrinsic which needs upgrading, and to provide the
288 // upgraded form of the intrinsic. We should perhaps have two separate
289 // functions for this.
293 bool llvm::UpgradeIntrinsicFunction(Function *F, Function *&NewFn) {
295 bool Upgraded = UpgradeIntrinsicFunction1(F, NewFn);
297 // Upgrade intrinsic attributes. This does not change the function.
300 if (unsigned id = F->getIntrinsicID())
301 F->setAttributes(Intrinsic::getAttributes((Intrinsic::ID)id));
305 // UpgradeIntrinsicCall - Upgrade a call to an old intrinsic to be a call the
306 // upgraded intrinsic. All argument and return casting must be provided in
307 // order to seamlessly integrate with existing context.
308 void llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) {
309 Function *F = CI->getCalledFunction();
310 LLVMContext &C = CI->getContext();
312 assert(F && "CallInst has no function associated with it.");
315 bool isLoadH = false, isLoadL = false, isMovL = false;
316 bool isMovSD = false, isShufPD = false;
317 bool isUnpckhPD = false, isUnpcklPD = false;
318 bool isPunpckhQPD = false, isPunpcklQPD = false;
319 if (F->getName() == "llvm.x86.sse2.loadh.pd")
321 else if (F->getName() == "llvm.x86.sse2.loadl.pd")
323 else if (F->getName() == "llvm.x86.sse2.movl.dq")
325 else if (F->getName() == "llvm.x86.sse2.movs.d")
327 else if (F->getName() == "llvm.x86.sse2.shuf.pd")
329 else if (F->getName() == "llvm.x86.sse2.unpckh.pd")
331 else if (F->getName() == "llvm.x86.sse2.unpckl.pd")
333 else if (F->getName() == "llvm.x86.sse2.punpckh.qdq")
335 else if (F->getName() == "llvm.x86.sse2.punpckl.qdq")
338 if (isLoadH || isLoadL || isMovL || isMovSD || isShufPD ||
339 isUnpckhPD || isUnpcklPD || isPunpckhQPD || isPunpcklQPD) {
340 std::vector<Constant*> Idxs;
341 Value *Op0 = CI->getOperand(1);
342 ShuffleVectorInst *SI = NULL;
343 if (isLoadH || isLoadL) {
344 Value *Op1 = UndefValue::get(Op0->getType());
345 Value *Addr = new BitCastInst(CI->getOperand(2),
346 Type::getDoublePtrTy(C),
348 Value *Load = new LoadInst(Addr, "upgraded.", false, 8, CI);
349 Value *Idx = ConstantInt::get(Type::getInt32Ty(C), 0);
350 Op1 = InsertElementInst::Create(Op1, Load, Idx, "upgraded.", CI);
353 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 0));
354 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 2));
356 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 2));
357 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 1));
359 Value *Mask = ConstantVector::get(Idxs);
360 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
362 Constant *Zero = ConstantInt::get(Type::getInt32Ty(C), 0);
363 Idxs.push_back(Zero);
364 Idxs.push_back(Zero);
365 Idxs.push_back(Zero);
366 Idxs.push_back(Zero);
367 Value *ZeroV = ConstantVector::get(Idxs);
370 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 4));
371 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 5));
372 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 2));
373 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 3));
374 Value *Mask = ConstantVector::get(Idxs);
375 SI = new ShuffleVectorInst(ZeroV, Op0, Mask, "upgraded.", CI);
376 } else if (isMovSD ||
377 isUnpckhPD || isUnpcklPD || isPunpckhQPD || isPunpcklQPD) {
378 Value *Op1 = CI->getOperand(2);
380 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 2));
381 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 1));
382 } else if (isUnpckhPD || isPunpckhQPD) {
383 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 1));
384 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 3));
386 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 0));
387 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), 2));
389 Value *Mask = ConstantVector::get(Idxs);
390 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
391 } else if (isShufPD) {
392 Value *Op1 = CI->getOperand(2);
393 unsigned MaskVal = cast<ConstantInt>(CI->getOperand(3))->getZExtValue();
394 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C), MaskVal & 1));
395 Idxs.push_back(ConstantInt::get(Type::getInt32Ty(C),
396 ((MaskVal >> 1) & 1)+2));
397 Value *Mask = ConstantVector::get(Idxs);
398 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
401 assert(SI && "Unexpected!");
403 // Handle any uses of the old CallInst.
404 if (!CI->use_empty())
405 // Replace all uses of the old call with the new cast which has the
407 CI->replaceAllUsesWith(SI);
409 // Clean up the old call now that it has been completely upgraded.
410 CI->eraseFromParent();
411 } else if (F->getName() == "llvm.x86.sse41.pmulld") {
412 // Upgrade this set of intrinsics into vector multiplies.
413 Instruction *Mul = BinaryOperator::CreateMul(CI->getOperand(1),
417 // Fix up all the uses with our new multiply.
418 if (!CI->use_empty())
419 CI->replaceAllUsesWith(Mul);
421 // Remove upgraded multiply.
422 CI->eraseFromParent();
424 llvm_unreachable("Unknown function for CallInst upgrade.");
429 switch (NewFn->getIntrinsicID()) {
430 default: llvm_unreachable("Unknown function for CallInst upgrade.");
431 case Intrinsic::x86_mmx_psll_d:
432 case Intrinsic::x86_mmx_psll_q:
433 case Intrinsic::x86_mmx_psll_w:
434 case Intrinsic::x86_mmx_psra_d:
435 case Intrinsic::x86_mmx_psra_w:
436 case Intrinsic::x86_mmx_psrl_d:
437 case Intrinsic::x86_mmx_psrl_q:
438 case Intrinsic::x86_mmx_psrl_w: {
441 Operands[0] = CI->getOperand(1);
443 // Cast the second parameter to the correct type.
444 BitCastInst *BC = new BitCastInst(CI->getOperand(2),
445 NewFn->getFunctionType()->getParamType(1),
449 // Construct a new CallInst
450 CallInst *NewCI = CallInst::Create(NewFn, Operands, Operands+2,
451 "upgraded."+CI->getName(), CI);
452 NewCI->setTailCall(CI->isTailCall());
453 NewCI->setCallingConv(CI->getCallingConv());
455 // Handle any uses of the old CallInst.
456 if (!CI->use_empty())
457 // Replace all uses of the old call with the new cast which has the
459 CI->replaceAllUsesWith(NewCI);
461 // Clean up the old call now that it has been completely upgraded.
462 CI->eraseFromParent();
465 case Intrinsic::ctlz:
466 case Intrinsic::ctpop:
467 case Intrinsic::cttz: {
468 // Build a small vector of the 1..(N-1) operands, which are the
470 SmallVector<Value*, 8> Operands(CI->op_begin()+1, CI->op_end());
472 // Construct a new CallInst
473 CallInst *NewCI = CallInst::Create(NewFn, Operands.begin(), Operands.end(),
474 "upgraded."+CI->getName(), CI);
475 NewCI->setTailCall(CI->isTailCall());
476 NewCI->setCallingConv(CI->getCallingConv());
478 // Handle any uses of the old CallInst.
479 if (!CI->use_empty()) {
480 // Check for sign extend parameter attributes on the return values.
481 bool SrcSExt = NewFn->getAttributes().paramHasAttr(0, Attribute::SExt);
482 bool DestSExt = F->getAttributes().paramHasAttr(0, Attribute::SExt);
484 // Construct an appropriate cast from the new return type to the old.
485 CastInst *RetCast = CastInst::Create(
486 CastInst::getCastOpcode(NewCI, SrcSExt,
489 NewCI, F->getReturnType(),
490 NewCI->getName(), CI);
491 NewCI->moveBefore(RetCast);
493 // Replace all uses of the old call with the new cast which has the
495 CI->replaceAllUsesWith(RetCast);
498 // Clean up the old call now that it has been completely upgraded.
499 CI->eraseFromParent();
502 case Intrinsic::eh_selector:
503 case Intrinsic::eh_typeid_for: {
504 // Only the return type changed.
505 SmallVector<Value*, 8> Operands(CI->op_begin() + 1, CI->op_end());
506 CallInst *NewCI = CallInst::Create(NewFn, Operands.begin(), Operands.end(),
507 "upgraded." + CI->getName(), CI);
508 NewCI->setTailCall(CI->isTailCall());
509 NewCI->setCallingConv(CI->getCallingConv());
511 // Handle any uses of the old CallInst.
512 if (!CI->use_empty()) {
513 // Construct an appropriate cast from the new return type to the old.
515 CastInst::Create(CastInst::getCastOpcode(NewCI, true,
516 F->getReturnType(), true),
517 NewCI, F->getReturnType(), NewCI->getName(), CI);
518 CI->replaceAllUsesWith(RetCast);
520 CI->eraseFromParent();
523 case Intrinsic::memcpy:
524 case Intrinsic::memmove:
525 case Intrinsic::memset: {
527 const llvm::Type *I1Ty = llvm::Type::getInt1Ty(CI->getContext());
528 Value *Operands[5] = { CI->getOperand(1), CI->getOperand(2),
529 CI->getOperand(3), CI->getOperand(4),
530 llvm::ConstantInt::get(I1Ty, 0) };
531 CallInst *NewCI = CallInst::Create(NewFn, Operands, Operands+5,
533 NewCI->setTailCall(CI->isTailCall());
534 NewCI->setCallingConv(CI->getCallingConv());
535 // Handle any uses of the old CallInst.
536 if (!CI->use_empty())
537 // Replace all uses of the old call with the new cast which has the
539 CI->replaceAllUsesWith(NewCI);
541 // Clean up the old call now that it has been completely upgraded.
542 CI->eraseFromParent();
548 // This tests each Function to determine if it needs upgrading. When we find
549 // one we are interested in, we then upgrade all calls to reflect the new
551 void llvm::UpgradeCallsToIntrinsic(Function* F) {
552 assert(F && "Illegal attempt to upgrade a non-existent intrinsic.");
554 // Upgrade the function and check if it is a totaly new function.
556 if (UpgradeIntrinsicFunction(F, NewFn)) {
558 // Replace all uses to the old function with the new one if necessary.
559 for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
561 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
562 UpgradeIntrinsicCall(CI, NewFn);
564 // Remove old function, no longer used, from the module.
565 F->eraseFromParent();
570 /// This function strips all debug info intrinsics, except for llvm.dbg.declare.
571 /// If an llvm.dbg.declare intrinsic is invalid, then this function simply
573 void llvm::CheckDebugInfoIntrinsics(Module *M) {
576 if (Function *FuncStart = M->getFunction("llvm.dbg.func.start")) {
577 while (!FuncStart->use_empty()) {
578 CallInst *CI = cast<CallInst>(FuncStart->use_back());
579 CI->eraseFromParent();
581 FuncStart->eraseFromParent();
584 if (Function *StopPoint = M->getFunction("llvm.dbg.stoppoint")) {
585 while (!StopPoint->use_empty()) {
586 CallInst *CI = cast<CallInst>(StopPoint->use_back());
587 CI->eraseFromParent();
589 StopPoint->eraseFromParent();
592 if (Function *RegionStart = M->getFunction("llvm.dbg.region.start")) {
593 while (!RegionStart->use_empty()) {
594 CallInst *CI = cast<CallInst>(RegionStart->use_back());
595 CI->eraseFromParent();
597 RegionStart->eraseFromParent();
600 if (Function *RegionEnd = M->getFunction("llvm.dbg.region.end")) {
601 while (!RegionEnd->use_empty()) {
602 CallInst *CI = cast<CallInst>(RegionEnd->use_back());
603 CI->eraseFromParent();
605 RegionEnd->eraseFromParent();
608 if (Function *Declare = M->getFunction("llvm.dbg.declare")) {
609 if (!Declare->use_empty()) {
610 DbgDeclareInst *DDI = cast<DbgDeclareInst>(Declare->use_back());
611 if (!isa<MDNode>(DDI->getOperand(1)) ||!isa<MDNode>(DDI->getOperand(2))) {
612 while (!Declare->use_empty()) {
613 CallInst *CI = cast<CallInst>(Declare->use_back());
614 CI->eraseFromParent();
616 Declare->eraseFromParent();