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/Module.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/Intrinsics.h"
20 #include "llvm/ADT/SmallVector.h"
25 static bool UpgradeIntrinsicFunction1(Function *F, Function *&NewFn) {
26 assert(F && "Illegal to upgrade a non-existent Function.");
28 // Get the Function's name.
29 const std::string& Name = F->getName();
32 const FunctionType *FTy = F->getFunctionType();
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] != '.')
39 Module *M = F->getParent();
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);
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));
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.
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,
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);
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));
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);
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));
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) && Name[17] != 'i') {
127 const llvm::Type *VT = VectorType::get(IntegerType::get(64), 1);
129 // We don't have to do anything if the parameter already has
131 if (FTy->getParamType(1) == VT)
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.
140 assert(FTy->getNumParams() == 2 && "MMX shift intrinsics take 2 args!");
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),
151 } else if (Name.compare(5,17,"x86.sse2.loadh.pd",17) == 0 ||
152 Name.compare(5,17,"x86.sse2.loadl.pd",17) == 0 ||
153 Name.compare(5,16,"x86.sse2.movl.dq",16) == 0 ||
154 Name.compare(5,15,"x86.sse2.movs.d",15) == 0 ||
155 Name.compare(5,16,"x86.sse2.shuf.pd",16) == 0 ||
156 Name.compare(5,18,"x86.sse2.unpckh.pd",18) == 0 ||
157 Name.compare(5,18,"x86.sse2.unpckl.pd",18) == 0 ||
158 Name.compare(5,20,"x86.sse2.punpckh.qdq",20) == 0 ||
159 Name.compare(5,20,"x86.sse2.punpckl.qdq",20) == 0) {
160 // Calls to these intrinsics are transformed into ShuffleVector's.
168 // This may not belong here. This function is effectively being overloaded
169 // to both detect an intrinsic which needs upgrading, and to provide the
170 // upgraded form of the intrinsic. We should perhaps have two separate
171 // functions for this.
175 bool llvm::UpgradeIntrinsicFunction(Function *F, Function *&NewFn) {
177 bool Upgraded = UpgradeIntrinsicFunction1(F, NewFn);
179 // Upgrade intrinsic attributes. This does not change the function.
182 if (unsigned id = F->getIntrinsicID(true))
183 F->setParamAttrs(Intrinsic::getParamAttrs((Intrinsic::ID)id));
187 // UpgradeIntrinsicCall - Upgrade a call to an old intrinsic to be a call the
188 // upgraded intrinsic. All argument and return casting must be provided in
189 // order to seamlessly integrate with existing context.
190 void llvm::UpgradeIntrinsicCall(CallInst *CI, Function *NewFn) {
191 Function *F = CI->getCalledFunction();
192 assert(F && "CallInst has no function associated with it.");
195 bool isLoadH = false, isLoadL = false, isMovL = false;
196 bool isMovSD = false, isShufPD = false;
197 bool isUnpckhPD = false, isUnpcklPD = false;
198 bool isPunpckhQPD = false, isPunpcklQPD = false;
199 if (strcmp(F->getNameStart(), "llvm.x86.sse2.loadh.pd") == 0)
201 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.loadl.pd") == 0)
203 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.movl.dq") == 0)
205 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.movs.d") == 0)
207 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.shuf.pd") == 0)
209 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.unpckh.pd") == 0)
211 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.unpckl.pd") == 0)
213 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.punpckh.qdq") == 0)
215 else if (strcmp(F->getNameStart(), "llvm.x86.sse2.punpckl.qdq") == 0)
218 if (isLoadH || isLoadL || isMovL || isMovSD || isShufPD ||
219 isUnpckhPD || isUnpcklPD || isPunpckhQPD || isPunpcklQPD) {
220 std::vector<Constant*> Idxs;
221 Value *Op0 = CI->getOperand(1);
222 ShuffleVectorInst *SI = NULL;
223 if (isLoadH || isLoadL) {
224 Value *Op1 = UndefValue::get(Op0->getType());
225 Value *Addr = new BitCastInst(CI->getOperand(2),
226 PointerType::getUnqual(Type::DoubleTy),
228 Value *Load = new LoadInst(Addr, "upgraded.", false, 8, CI);
229 Value *Idx = ConstantInt::get(Type::Int32Ty, 0);
230 Op1 = InsertElementInst::Create(Op1, Load, Idx, "upgraded.", CI);
233 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 0));
234 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
236 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
237 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 1));
239 Value *Mask = ConstantVector::get(Idxs);
240 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
242 Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
243 Idxs.push_back(Zero);
244 Idxs.push_back(Zero);
245 Idxs.push_back(Zero);
246 Idxs.push_back(Zero);
247 Value *ZeroV = ConstantVector::get(Idxs);
250 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 4));
251 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 5));
252 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
253 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 3));
254 Value *Mask = ConstantVector::get(Idxs);
255 SI = new ShuffleVectorInst(ZeroV, Op0, Mask, "upgraded.", CI);
256 } else if (isMovSD ||
257 isUnpckhPD || isUnpcklPD || isPunpckhQPD || isPunpcklQPD) {
258 Value *Op1 = CI->getOperand(2);
260 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
261 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 1));
262 } else if (isUnpckhPD || isPunpckhQPD) {
263 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 1));
264 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 3));
266 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 0));
267 Idxs.push_back(ConstantInt::get(Type::Int32Ty, 2));
269 Value *Mask = ConstantVector::get(Idxs);
270 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
271 } else if (isShufPD) {
272 Value *Op1 = CI->getOperand(2);
273 unsigned MaskVal = cast<ConstantInt>(CI->getOperand(3))->getZExtValue();
274 Idxs.push_back(ConstantInt::get(Type::Int32Ty, MaskVal & 1));
275 Idxs.push_back(ConstantInt::get(Type::Int32Ty, ((MaskVal >> 1) & 1)+2));
276 Value *Mask = ConstantVector::get(Idxs);
277 SI = new ShuffleVectorInst(Op0, Op1, Mask, "upgraded.", CI);
280 assert(SI && "Unexpected!");
282 // Handle any uses of the old CallInst.
283 if (!CI->use_empty())
284 // Replace all uses of the old call with the new cast which has the
286 CI->replaceAllUsesWith(SI);
288 // Clean up the old call now that it has been completely upgraded.
289 CI->eraseFromParent();
291 assert(0 && "Unknown function for CallInst upgrade.");
296 switch (NewFn->getIntrinsicID()) {
297 default: assert(0 && "Unknown function for CallInst upgrade.");
298 case Intrinsic::x86_mmx_psll_d:
299 case Intrinsic::x86_mmx_psll_q:
300 case Intrinsic::x86_mmx_psll_w:
301 case Intrinsic::x86_mmx_psra_d:
302 case Intrinsic::x86_mmx_psra_w:
303 case Intrinsic::x86_mmx_psrl_d:
304 case Intrinsic::x86_mmx_psrl_q:
305 case Intrinsic::x86_mmx_psrl_w: {
308 Operands[0] = CI->getOperand(1);
310 // Cast the second parameter to the correct type.
311 BitCastInst *BC = new BitCastInst(CI->getOperand(2),
312 NewFn->getFunctionType()->getParamType(1),
316 // Construct a new CallInst
317 CallInst *NewCI = CallInst::Create(NewFn, Operands, Operands+2,
318 "upgraded."+CI->getName(), CI);
319 NewCI->setTailCall(CI->isTailCall());
320 NewCI->setCallingConv(CI->getCallingConv());
322 // Handle any uses of the old CallInst.
323 if (!CI->use_empty())
324 // Replace all uses of the old call with the new cast which has the
326 CI->replaceAllUsesWith(NewCI);
328 // Clean up the old call now that it has been completely upgraded.
329 CI->eraseFromParent();
332 case Intrinsic::ctlz:
333 case Intrinsic::ctpop:
334 case Intrinsic::cttz: {
335 // Build a small vector of the 1..(N-1) operands, which are the
337 SmallVector<Value*, 8> Operands(CI->op_begin()+1, CI->op_end());
339 // Construct a new CallInst
340 CallInst *NewCI = CallInst::Create(NewFn, Operands.begin(), Operands.end(),
341 "upgraded."+CI->getName(), CI);
342 NewCI->setTailCall(CI->isTailCall());
343 NewCI->setCallingConv(CI->getCallingConv());
345 // Handle any uses of the old CallInst.
346 if (!CI->use_empty()) {
347 // Check for sign extend parameter attributes on the return values.
348 bool SrcSExt = NewFn->getParamAttrs().paramHasAttr(0, ParamAttr::SExt);
349 bool DestSExt = F->getParamAttrs().paramHasAttr(0, ParamAttr::SExt);
351 // Construct an appropriate cast from the new return type to the old.
352 CastInst *RetCast = CastInst::Create(
353 CastInst::getCastOpcode(NewCI, SrcSExt,
356 NewCI, F->getReturnType(),
357 NewCI->getName(), CI);
358 NewCI->moveBefore(RetCast);
360 // Replace all uses of the old call with the new cast which has the
362 CI->replaceAllUsesWith(RetCast);
365 // Clean up the old call now that it has been completely upgraded.
366 CI->eraseFromParent();
372 // This tests each Function to determine if it needs upgrading. When we find
373 // one we are interested in, we then upgrade all calls to reflect the new
375 void llvm::UpgradeCallsToIntrinsic(Function* F) {
376 assert(F && "Illegal attempt to upgrade a non-existent intrinsic.");
378 // Upgrade the function and check if it is a totaly new function.
380 if (UpgradeIntrinsicFunction(F, NewFn)) {
382 // Replace all uses to the old function with the new one if necessary.
383 for (Value::use_iterator UI = F->use_begin(), UE = F->use_end();
385 if (CallInst* CI = dyn_cast<CallInst>(*UI++))
386 UpgradeIntrinsicCall(CI, NewFn);
388 // Remove old function, no longer used, from the module.
389 F->eraseFromParent();
394 /// This is an auto-upgrade hook for mutiple-value return statements.
395 /// This function auto-upgrades all such return statements in the given
396 /// function to use aggregate return values built with insertvalue
398 void llvm::UpgradeMultipleReturnValues(Function *CurrentFunction) {
399 for (Function::iterator I = CurrentFunction->begin(),
400 E = CurrentFunction->end(); I != E; ++I) {
402 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
403 unsigned NumVals = RI->getNumOperands();
405 std::vector<const Type *> Types(NumVals);
406 for (unsigned i = 0; i != NumVals; ++i)
407 Types[i] = RI->getOperand(i)->getType();
408 const Type *ReturnType = StructType::get(Types);
409 Value *RV = UndefValue::get(ReturnType);
410 for (unsigned i = 0; i != NumVals; ++i)
411 RV = InsertValueInst::Create(RV, RI->getOperand(i), i, "mrv", RI);
412 ReturnInst::Create(RV, RI);
413 RI->eraseFromParent();