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/Instructions.h"
20 #include "llvm/Intrinsics.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/Support/ErrorHandling.h"
27 static bool UpgradeIntrinsicFunction1(Function *F, Function *&NewFn) {
28 assert(F && "Illegal to upgrade a non-existent Function.");
30 LLVMContext &Context = F->getContext();
32 // Get the Function's name.
33 const std::string& Name = F->getName();
36 const FunctionType *FTy = F->getFunctionType();
38 // Quickly eliminate it, if it's not a candidate.
39 if (Name.length() <= 8 || Name[0] != 'l' || Name[1] != 'l' ||
40 Name[2] != 'v' || Name[3] != 'm' || Name[4] != '.')
43 Module *M = F->getParent();
47 // This upgrades the llvm.atomic.lcs, llvm.atomic.las, llvm.atomic.lss,
48 // and atomics with default address spaces to their new names to their new
49 // function name (e.g. llvm.atomic.add.i32 => llvm.atomic.add.i32.p0i32)
50 if (Name.compare(5,7,"atomic.",7) == 0) {
51 if (Name.compare(12,3,"lcs",3) == 0) {
52 std::string::size_type delim = Name.find('.',12);
53 F->setName("llvm.atomic.cmp.swap" + Name.substr(delim) +
54 ".p0" + Name.substr(delim+1));
58 else if (Name.compare(12,3,"las",3) == 0) {
59 std::string::size_type delim = Name.find('.',12);
60 F->setName("llvm.atomic.load.add"+Name.substr(delim)
61 + ".p0" + Name.substr(delim+1));
65 else if (Name.compare(12,3,"lss",3) == 0) {
66 std::string::size_type delim = Name.find('.',12);
67 F->setName("llvm.atomic.load.sub"+Name.substr(delim)
68 + ".p0" + Name.substr(delim+1));
72 else if (Name.rfind(".p") == std::string::npos) {
73 // We don't have an address space qualifier so this has be upgraded
74 // to the new name. Copy the type name at the end of the intrinsic
76 std::string::size_type delim = Name.find_last_of('.');
77 assert(delim != std::string::npos && "can not find type");
78 F->setName(Name + ".p0" + Name.substr(delim+1));
85 // This upgrades the name of the llvm.bswap intrinsic function to only use
86 // a single type name for overloading. We only care about the old format
87 // 'llvm.bswap.i*.i*', so check for 'bswap.' and then for there being
88 // a '.' after 'bswap.'
89 if (Name.compare(5,6,"bswap.",6) == 0) {
90 std::string::size_type delim = Name.find('.',11);
92 if (delim != std::string::npos) {
93 // Construct the new name as 'llvm.bswap' + '.i*'
94 F->setName(Name.substr(0,10)+Name.substr(delim));
102 // We only want to fix the 'llvm.ct*' intrinsics which do not have the
103 // correct return type, so we check for the name, and then check if the
104 // return type does not match the parameter type.
105 if ( (Name.compare(5,5,"ctpop",5) == 0 ||
106 Name.compare(5,4,"ctlz",4) == 0 ||
107 Name.compare(5,4,"cttz",4) == 0) &&
108 FTy->getReturnType() != FTy->getParamType(0)) {
109 // We first need to change the name of the old (bad) intrinsic, because
110 // its type is incorrect, but we cannot overload that name. We
111 // arbitrarily unique it here allowing us to construct a correctly named
112 // and typed function below.
115 // Now construct the new intrinsic with the correct name and type. We
116 // leave the old function around in order to query its type, whatever it
117 // may be, and correctly convert up to the new type.
118 NewFn = cast<Function>(M->getOrInsertFunction(Name,
119 FTy->getParamType(0),
120 FTy->getParamType(0),
127 // This upgrades the llvm.part.select overloaded intrinsic names to only
128 // use one type specifier in the name. We only care about the old format
129 // 'llvm.part.select.i*.i*', and solve as above with bswap.
130 if (Name.compare(5,12,"part.select.",12) == 0) {
131 std::string::size_type delim = Name.find('.',17);
133 if (delim != std::string::npos) {
134 // Construct a new name as 'llvm.part.select' + '.i*'
135 F->setName(Name.substr(0,16)+Name.substr(delim));
142 // This upgrades the llvm.part.set intrinsics similarly as above, however
143 // we care about 'llvm.part.set.i*.i*.i*', but only the first two types
144 // must match. There is an additional type specifier after these two
145 // matching types that we must retain when upgrading. Thus, we require
146 // finding 2 periods, not just one, after the intrinsic name.
147 if (Name.compare(5,9,"part.set.",9) == 0) {
148 std::string::size_type delim = Name.find('.',14);
150 if (delim != std::string::npos &&
151 Name.find('.',delim+1) != std::string::npos) {
152 // Construct a new name as 'llvm.part.select' + '.i*.i*'
153 F->setName(Name.substr(0,13)+Name.substr(delim));
162 // This fixes all MMX shift intrinsic instructions to take a
163 // v1i64 instead of a v2i32 as the second parameter.
164 if (Name.compare(5,10,"x86.mmx.ps",10) == 0 &&
165 (Name.compare(13,4,"psll", 4) == 0 ||
166 Name.compare(13,4,"psra", 4) == 0 ||
167 Name.compare(13,4,"psrl", 4) == 0) && Name[17] != 'i') {
169 const llvm::Type *VT =
170 Context.getVectorType(Context.getIntegerType(64), 1);
172 // We don't have to do anything if the parameter already has
174 if (FTy->getParamType(1) == VT)
177 // We first need to change the name of the old (bad) intrinsic, because
178 // its type is incorrect, but we cannot overload that name. We
179 // arbitrarily unique it here allowing us to construct a correctly named
180 // and typed function below.
183 assert(FTy->getNumParams() == 2 && "MMX shift intrinsics take 2 args!");
185 // Now construct the new intrinsic with the correct name and type. We
186 // leave the old function around in order to query its type, whatever it
187 // may be, and correctly convert up to the new type.
188 NewFn = cast<Function>(M->getOrInsertFunction(Name,
189 FTy->getReturnType(),
190 FTy->getParamType(0),
194 } else if (Name.compare(5,17,"x86.sse2.loadh.pd",17) == 0 ||
195 Name.compare(5,17,"x86.sse2.loadl.pd",17) == 0 ||
196 Name.compare(5,16,"x86.sse2.movl.dq",16) == 0 ||
197 Name.compare(5,15,"x86.sse2.movs.d",15) == 0 ||
198 Name.compare(5,16,"x86.sse2.shuf.pd",16) == 0 ||
199 Name.compare(5,18,"x86.sse2.unpckh.pd",18) == 0 ||
200 Name.compare(5,18,"x86.sse2.unpckl.pd",18) == 0 ||
201 Name.compare(5,20,"x86.sse2.punpckh.qdq",20) == 0 ||
202 Name.compare(5,20,"x86.sse2.punpckl.qdq",20) == 0) {
203 // Calls to these intrinsics are transformed into ShuffleVector's.
211 // This may not belong here. This function is effectively being overloaded
212 // to both detect an intrinsic which needs upgrading, and to provide the
213 // upgraded form of the intrinsic. We should perhaps have two separate
214 // functions for this.
218 bool llvm::UpgradeIntrinsicFunction(Function *F, Function *&NewFn) {
220 bool Upgraded = UpgradeIntrinsicFunction1(F, NewFn);
222 // Upgrade intrinsic attributes. This does not change the function.
225 if (unsigned id = F->getIntrinsicID())
226 F->setAttributes(Intrinsic::getAttributes((Intrinsic::ID)id));
230 // UpgradeIntrinsicCall - Upgrade a call to an old intrinsic to be a call the
231 // upgraded intrinsic. All argument and return casting must be provided in
232 // order to seamlessly integrate with existing context.
233 void llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) {
234 Function *F = CI->getCalledFunction();
235 LLVMContext &Context = F->getContext();
237 assert(F && "CallInst has no function associated with it.");
240 bool isLoadH = false, isLoadL = false, isMovL = false;
241 bool isMovSD = false, isShufPD = false;
242 bool isUnpckhPD = false, isUnpcklPD = false;
243 bool isPunpckhQPD = false, isPunpcklQPD = false;
244 if (F->getName() == "llvm.x86.sse2.loadh.pd")
246 else if (F->getName() == "llvm.x86.sse2.loadl.pd")
248 else if (F->getName() == "llvm.x86.sse2.movl.dq")
250 else if (F->getName() == "llvm.x86.sse2.movs.d")
252 else if (F->getName() == "llvm.x86.sse2.shuf.pd")
254 else if (F->getName() == "llvm.x86.sse2.unpckh.pd")
256 else if (F->getName() == "llvm.x86.sse2.unpckl.pd")
258 else if (F->getName() == "llvm.x86.sse2.punpckh.qdq")
260 else if (F->getName() == "llvm.x86.sse2.punpckl.qdq")
263 if (isLoadH || isLoadL || isMovL || isMovSD || isShufPD ||
264 isUnpckhPD || isUnpcklPD || isPunpckhQPD || isPunpcklQPD) {
265 std::vector<Constant*> Idxs;
266 Value *Op0 = CI->getOperand(1);
267 ShuffleVectorInst *SI = NULL;
268 if (isLoadH || isLoadL) {
269 Value *Op1 = Context.getUndef(Op0->getType());
270 Value *Addr = new BitCastInst(CI->getOperand(2),
271 Context.getPointerTypeUnqual(Type::DoubleTy),
273 Value *Load = new LoadInst(Addr, "upgraded.", false, 8, CI);
274 Value *Idx = ConstantInt::get(Type::Int32Ty, 0);
275 Op1 = InsertElementInst::Create(Op1, Load, Idx, "upgraded.", CI);
278 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 0));
279 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
281 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
282 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 1));
284 Value *Mask = Context.getConstantVector(Idxs);
285 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
287 Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
288 Idxs.push_back(Zero);
289 Idxs.push_back(Zero);
290 Idxs.push_back(Zero);
291 Idxs.push_back(Zero);
292 Value *ZeroV = Context.getConstantVector(Idxs);
295 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 4));
296 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 5));
297 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
298 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 3));
299 Value *Mask = Context.getConstantVector(Idxs);
300 SI = new ShuffleVectorInst(ZeroV, Op0, Mask, "upgraded.", CI);
301 } else if (isMovSD ||
302 isUnpckhPD || isUnpcklPD || isPunpckhQPD || isPunpcklQPD) {
303 Value *Op1 = CI->getOperand(2);
305 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
306 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 1));
307 } else if (isUnpckhPD || isPunpckhQPD) {
308 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 1));
309 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 3));
311 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 0));
312 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
314 Value *Mask = Context.getConstantVector(Idxs);
315 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
316 } else if (isShufPD) {
317 Value *Op1 = CI->getOperand(2);
318 unsigned MaskVal = cast<ConstantInt>(CI->getOperand(3))->getZExtValue();
319 Idxs.push_back(ConstantInt::get(Type::Int32Ty, MaskVal & 1));
320 Idxs.push_back(ConstantInt::get(Type::Int32Ty,
321 ((MaskVal >> 1) & 1)+2));
322 Value *Mask = Context.getConstantVector(Idxs);
323 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
326 assert(SI && "Unexpected!");
328 // Handle any uses of the old CallInst.
329 if (!CI->use_empty())
330 // Replace all uses of the old call with the new cast which has the
332 CI->replaceAllUsesWith(SI);
334 // Clean up the old call now that it has been completely upgraded.
335 CI->eraseFromParent();
337 llvm_unreachable("Unknown function for CallInst upgrade.");
342 switch (NewFn->getIntrinsicID()) {
343 default: llvm_unreachable("Unknown function for CallInst upgrade.");
344 case Intrinsic::x86_mmx_psll_d:
345 case Intrinsic::x86_mmx_psll_q:
346 case Intrinsic::x86_mmx_psll_w:
347 case Intrinsic::x86_mmx_psra_d:
348 case Intrinsic::x86_mmx_psra_w:
349 case Intrinsic::x86_mmx_psrl_d:
350 case Intrinsic::x86_mmx_psrl_q:
351 case Intrinsic::x86_mmx_psrl_w: {
354 Operands[0] = CI->getOperand(1);
356 // Cast the second parameter to the correct type.
357 BitCastInst *BC = new BitCastInst(CI->getOperand(2),
358 NewFn->getFunctionType()->getParamType(1),
362 // Construct a new CallInst
363 CallInst *NewCI = CallInst::Create(NewFn, Operands, Operands+2,
364 "upgraded."+CI->getName(), CI);
365 NewCI->setTailCall(CI->isTailCall());
366 NewCI->setCallingConv(CI->getCallingConv());
368 // Handle any uses of the old CallInst.
369 if (!CI->use_empty())
370 // Replace all uses of the old call with the new cast which has the
372 CI->replaceAllUsesWith(NewCI);
374 // Clean up the old call now that it has been completely upgraded.
375 CI->eraseFromParent();
378 case Intrinsic::ctlz:
379 case Intrinsic::ctpop:
380 case Intrinsic::cttz: {
381 // Build a small vector of the 1..(N-1) operands, which are the
383 SmallVector<Value*, 8> Operands(CI->op_begin()+1, CI->op_end());
385 // Construct a new CallInst
386 CallInst *NewCI = CallInst::Create(NewFn, Operands.begin(), Operands.end(),
387 "upgraded."+CI->getName(), CI);
388 NewCI->setTailCall(CI->isTailCall());
389 NewCI->setCallingConv(CI->getCallingConv());
391 // Handle any uses of the old CallInst.
392 if (!CI->use_empty()) {
393 // Check for sign extend parameter attributes on the return values.
394 bool SrcSExt = NewFn->getAttributes().paramHasAttr(0, Attribute::SExt);
395 bool DestSExt = F->getAttributes().paramHasAttr(0, Attribute::SExt);
397 // Construct an appropriate cast from the new return type to the old.
398 CastInst *RetCast = CastInst::Create(
399 CastInst::getCastOpcode(NewCI, SrcSExt,
402 NewCI, F->getReturnType(),
403 NewCI->getName(), CI);
404 NewCI->moveBefore(RetCast);
406 // Replace all uses of the old call with the new cast which has the
408 CI->replaceAllUsesWith(RetCast);
411 // Clean up the old call now that it has been completely upgraded.
412 CI->eraseFromParent();
418 // This tests each Function to determine if it needs upgrading. When we find
419 // one we are interested in, we then upgrade all calls to reflect the new
421 void llvm::UpgradeCallsToIntrinsic(Function* F) {
422 assert(F && "Illegal attempt to upgrade a non-existent intrinsic.");
424 // Upgrade the function and check if it is a totaly new function.
426 if (UpgradeIntrinsicFunction(F, NewFn)) {
428 // Replace all uses to the old function with the new one if necessary.
429 for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
431 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
432 UpgradeIntrinsicCall(CI, NewFn);
434 // Remove old function, no longer used, from the module.
435 F->eraseFromParent();