blob: 9f94ee383374abf100ae8bd1e714162771e99aac [file] [log] [blame]
John Criswellbd9d3702005-10-27 16:00:10 +00001//===-- ConstantFolding.cpp - Analyze constant folding possibilities ------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
John Criswellbd9d3702005-10-27 16:00:10 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This family of functions determines the possibility of performing constant
11// folding.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/Analysis/ConstantFolding.h"
16#include "llvm/Constants.h"
17#include "llvm/DerivedTypes.h"
Chris Lattner55207322007-01-30 23:45:45 +000018#include "llvm/Function.h"
John Criswellbd9d3702005-10-27 16:00:10 +000019#include "llvm/Instructions.h"
20#include "llvm/Intrinsics.h"
Chris Lattner55207322007-01-30 23:45:45 +000021#include "llvm/ADT/SmallVector.h"
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +000022#include "llvm/ADT/StringMap.h"
Chris Lattner03dd25c2007-01-31 00:51:48 +000023#include "llvm/Target/TargetData.h"
John Criswellbd9d3702005-10-27 16:00:10 +000024#include "llvm/Support/GetElementPtrTypeIterator.h"
25#include "llvm/Support/MathExtras.h"
26#include <cerrno>
Jeff Cohen97af7512006-12-02 02:22:01 +000027#include <cmath>
John Criswellbd9d3702005-10-27 16:00:10 +000028using namespace llvm;
29
Chris Lattner03dd25c2007-01-31 00:51:48 +000030//===----------------------------------------------------------------------===//
31// Constant Folding internal helper functions
32//===----------------------------------------------------------------------===//
33
34/// IsConstantOffsetFromGlobal - If this constant is actually a constant offset
35/// from a global, return the global and the constant. Because of
36/// constantexprs, this function is recursive.
37static bool IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV,
38 int64_t &Offset, const TargetData &TD) {
39 // Trivial case, constant is the global.
40 if ((GV = dyn_cast<GlobalValue>(C))) {
41 Offset = 0;
42 return true;
43 }
44
45 // Otherwise, if this isn't a constant expr, bail out.
46 ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
47 if (!CE) return false;
48
49 // Look through ptr->int and ptr->ptr casts.
50 if (CE->getOpcode() == Instruction::PtrToInt ||
51 CE->getOpcode() == Instruction::BitCast)
52 return IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD);
53
54 // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
55 if (CE->getOpcode() == Instruction::GetElementPtr) {
56 // Cannot compute this if the element type of the pointer is missing size
57 // info.
Chris Lattnerf286f6f2007-12-10 22:53:04 +000058 if (!cast<PointerType>(CE->getOperand(0)->getType())
59 ->getElementType()->isSized())
Chris Lattner03dd25c2007-01-31 00:51:48 +000060 return false;
61
62 // If the base isn't a global+constant, we aren't either.
63 if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD))
64 return false;
65
66 // Otherwise, add any offset that our operands provide.
67 gep_type_iterator GTI = gep_type_begin(CE);
Gabor Greifde2d74b2008-05-22 06:43:33 +000068 for (User::const_op_iterator i = CE->op_begin() + 1, e = CE->op_end();
Gabor Greif785c6af2008-05-22 19:24:54 +000069 i != e; ++i, ++GTI) {
Gabor Greifde2d74b2008-05-22 06:43:33 +000070 ConstantInt *CI = dyn_cast<ConstantInt>(*i);
Chris Lattner03dd25c2007-01-31 00:51:48 +000071 if (!CI) return false; // Index isn't a simple constant?
72 if (CI->getZExtValue() == 0) continue; // Not adding anything.
73
74 if (const StructType *ST = dyn_cast<StructType>(*GTI)) {
75 // N = N + Offset
Chris Lattnerb1919e22007-02-10 19:55:17 +000076 Offset += TD.getStructLayout(ST)->getElementOffset(CI->getZExtValue());
Chris Lattner03dd25c2007-01-31 00:51:48 +000077 } else {
Jeff Cohenca5183d2007-03-05 00:00:42 +000078 const SequentialType *SQT = cast<SequentialType>(*GTI);
Duncan Sands514ab342007-11-01 20:53:16 +000079 Offset += TD.getABITypeSize(SQT->getElementType())*CI->getSExtValue();
Chris Lattner03dd25c2007-01-31 00:51:48 +000080 }
81 }
82 return true;
83 }
84
85 return false;
86}
87
88
89/// SymbolicallyEvaluateBinop - One of Op0/Op1 is a constant expression.
90/// Attempt to symbolically evaluate the result of a binary operator merging
91/// these together. If target data info is available, it is provided as TD,
92/// otherwise TD is null.
93static Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0,
94 Constant *Op1, const TargetData *TD){
95 // SROA
96
97 // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
98 // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
99 // bits.
100
101
102 // If the constant expr is something like &A[123] - &A[4].f, fold this into a
103 // constant. This happens frequently when iterating over a global array.
104 if (Opc == Instruction::Sub && TD) {
105 GlobalValue *GV1, *GV2;
106 int64_t Offs1, Offs2;
107
108 if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, *TD))
109 if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, *TD) &&
110 GV1 == GV2) {
111 // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
112 return ConstantInt::get(Op0->getType(), Offs1-Offs2);
113 }
114 }
115
116 // TODO: Fold icmp setne/seteq as well.
117 return 0;
118}
119
120/// SymbolicallyEvaluateGEP - If we can symbolically evaluate the specified GEP
121/// constant expression, do so.
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000122static Constant *SymbolicallyEvaluateGEP(Constant* const* Ops, unsigned NumOps,
Chris Lattner03dd25c2007-01-31 00:51:48 +0000123 const Type *ResultTy,
124 const TargetData *TD) {
125 Constant *Ptr = Ops[0];
Chris Lattner268e7d72008-05-08 04:54:43 +0000126 if (!TD || !cast<PointerType>(Ptr->getType())->getElementType()->isSized())
Chris Lattner03dd25c2007-01-31 00:51:48 +0000127 return 0;
128
Chris Lattner268e7d72008-05-08 04:54:43 +0000129 uint64_t BasePtr = 0;
130 if (!Ptr->isNullValue()) {
131 // If this is a inttoptr from a constant int, we can fold this as the base,
132 // otherwise we can't.
133 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
134 if (CE->getOpcode() == Instruction::IntToPtr)
135 if (ConstantInt *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
136 BasePtr = Base->getZExtValue();
137
138 if (BasePtr == 0)
139 return 0;
Chris Lattner03dd25c2007-01-31 00:51:48 +0000140 }
Chris Lattner268e7d72008-05-08 04:54:43 +0000141
142 // If this is a constant expr gep that is effectively computing an
143 // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
144 for (unsigned i = 1; i != NumOps; ++i)
145 if (!isa<ConstantInt>(Ops[i]))
146 return false;
147
148 uint64_t Offset = TD->getIndexedOffset(Ptr->getType(),
149 (Value**)Ops+1, NumOps-1);
150 Constant *C = ConstantInt::get(TD->getIntPtrType(), Offset+BasePtr);
151 return ConstantExpr::getIntToPtr(C, ResultTy);
Chris Lattner03dd25c2007-01-31 00:51:48 +0000152}
153
Chris Lattner1afab9c2007-12-11 07:29:44 +0000154/// FoldBitCast - Constant fold bitcast, symbolically evaluating it with
155/// targetdata. Return 0 if unfoldable.
156static Constant *FoldBitCast(Constant *C, const Type *DestTy,
157 const TargetData &TD) {
158 // If this is a bitcast from constant vector -> vector, fold it.
159 if (ConstantVector *CV = dyn_cast<ConstantVector>(C)) {
160 if (const VectorType *DestVTy = dyn_cast<VectorType>(DestTy)) {
161 // If the element types match, VMCore can fold it.
162 unsigned NumDstElt = DestVTy->getNumElements();
163 unsigned NumSrcElt = CV->getNumOperands();
164 if (NumDstElt == NumSrcElt)
165 return 0;
166
167 const Type *SrcEltTy = CV->getType()->getElementType();
168 const Type *DstEltTy = DestVTy->getElementType();
169
170 // Otherwise, we're changing the number of elements in a vector, which
171 // requires endianness information to do the right thing. For example,
172 // bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
173 // folds to (little endian):
174 // <4 x i32> <i32 0, i32 0, i32 1, i32 0>
175 // and to (big endian):
176 // <4 x i32> <i32 0, i32 0, i32 0, i32 1>
177
178 // First thing is first. We only want to think about integer here, so if
179 // we have something in FP form, recast it as integer.
180 if (DstEltTy->isFloatingPoint()) {
181 // Fold to an vector of integers with same size as our FP type.
182 unsigned FPWidth = DstEltTy->getPrimitiveSizeInBits();
183 const Type *DestIVTy = VectorType::get(IntegerType::get(FPWidth),
184 NumDstElt);
185 // Recursively handle this integer conversion, if possible.
186 C = FoldBitCast(C, DestIVTy, TD);
187 if (!C) return 0;
188
189 // Finally, VMCore can handle this now that #elts line up.
190 return ConstantExpr::getBitCast(C, DestTy);
191 }
192
193 // Okay, we know the destination is integer, if the input is FP, convert
194 // it to integer first.
195 if (SrcEltTy->isFloatingPoint()) {
196 unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
197 const Type *SrcIVTy = VectorType::get(IntegerType::get(FPWidth),
198 NumSrcElt);
199 // Ask VMCore to do the conversion now that #elts line up.
200 C = ConstantExpr::getBitCast(C, SrcIVTy);
201 CV = dyn_cast<ConstantVector>(C);
202 if (!CV) return 0; // If VMCore wasn't able to fold it, bail out.
203 }
204
205 // Now we know that the input and output vectors are both integer vectors
206 // of the same size, and that their #elements is not the same. Do the
207 // conversion here, which depends on whether the input or output has
208 // more elements.
209 bool isLittleEndian = TD.isLittleEndian();
210
211 SmallVector<Constant*, 32> Result;
212 if (NumDstElt < NumSrcElt) {
213 // Handle: bitcast (<4 x i32> <i32 0, i32 1, i32 2, i32 3> to <2 x i64>)
214 Constant *Zero = Constant::getNullValue(DstEltTy);
215 unsigned Ratio = NumSrcElt/NumDstElt;
216 unsigned SrcBitSize = SrcEltTy->getPrimitiveSizeInBits();
217 unsigned SrcElt = 0;
218 for (unsigned i = 0; i != NumDstElt; ++i) {
219 // Build each element of the result.
220 Constant *Elt = Zero;
221 unsigned ShiftAmt = isLittleEndian ? 0 : SrcBitSize*(Ratio-1);
222 for (unsigned j = 0; j != Ratio; ++j) {
223 Constant *Src = dyn_cast<ConstantInt>(CV->getOperand(SrcElt++));
224 if (!Src) return 0; // Reject constantexpr elements.
225
226 // Zero extend the element to the right size.
227 Src = ConstantExpr::getZExt(Src, Elt->getType());
228
229 // Shift it to the right place, depending on endianness.
230 Src = ConstantExpr::getShl(Src,
231 ConstantInt::get(Src->getType(), ShiftAmt));
232 ShiftAmt += isLittleEndian ? SrcBitSize : -SrcBitSize;
233
234 // Mix it in.
235 Elt = ConstantExpr::getOr(Elt, Src);
236 }
237 Result.push_back(Elt);
238 }
239 } else {
240 // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
241 unsigned Ratio = NumDstElt/NumSrcElt;
242 unsigned DstBitSize = DstEltTy->getPrimitiveSizeInBits();
243
244 // Loop over each source value, expanding into multiple results.
245 for (unsigned i = 0; i != NumSrcElt; ++i) {
246 Constant *Src = dyn_cast<ConstantInt>(CV->getOperand(i));
247 if (!Src) return 0; // Reject constantexpr elements.
248
249 unsigned ShiftAmt = isLittleEndian ? 0 : DstBitSize*(Ratio-1);
250 for (unsigned j = 0; j != Ratio; ++j) {
251 // Shift the piece of the value into the right place, depending on
252 // endianness.
253 Constant *Elt = ConstantExpr::getLShr(Src,
254 ConstantInt::get(Src->getType(), ShiftAmt));
255 ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
256
257 // Truncate and remember this piece.
258 Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
259 }
260 }
261 }
262
263 return ConstantVector::get(&Result[0], Result.size());
264 }
265 }
266
267 return 0;
268}
269
Chris Lattner03dd25c2007-01-31 00:51:48 +0000270
271//===----------------------------------------------------------------------===//
272// Constant Folding public APIs
273//===----------------------------------------------------------------------===//
274
275
Chris Lattner55207322007-01-30 23:45:45 +0000276/// ConstantFoldInstruction - Attempt to constant fold the specified
277/// instruction. If successful, the constant result is returned, if not, null
278/// is returned. Note that this function can only fail when attempting to fold
279/// instructions like loads and stores, which have no constant expression form.
280///
281Constant *llvm::ConstantFoldInstruction(Instruction *I, const TargetData *TD) {
282 if (PHINode *PN = dyn_cast<PHINode>(I)) {
283 if (PN->getNumIncomingValues() == 0)
284 return Constant::getNullValue(PN->getType());
John Criswellbd9d3702005-10-27 16:00:10 +0000285
Chris Lattner55207322007-01-30 23:45:45 +0000286 Constant *Result = dyn_cast<Constant>(PN->getIncomingValue(0));
287 if (Result == 0) return 0;
288
289 // Handle PHI nodes specially here...
290 for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i)
291 if (PN->getIncomingValue(i) != Result && PN->getIncomingValue(i) != PN)
292 return 0; // Not all the same incoming constants...
293
294 // If we reach here, all incoming values are the same constant.
295 return Result;
296 }
297
298 // Scan the operand list, checking to see if they are all constants, if so,
299 // hand off to ConstantFoldInstOperands.
300 SmallVector<Constant*, 8> Ops;
Gabor Greifde2d74b2008-05-22 06:43:33 +0000301 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
302 if (Constant *Op = dyn_cast<Constant>(*i))
Chris Lattner55207322007-01-30 23:45:45 +0000303 Ops.push_back(Op);
304 else
305 return 0; // All operands not constant!
306
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000307 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
308 return ConstantFoldCompareInstOperands(CI->getPredicate(),
309 &Ops[0], Ops.size(), TD);
310 else
311 return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
312 &Ops[0], Ops.size(), TD);
Chris Lattner55207322007-01-30 23:45:45 +0000313}
314
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000315/// ConstantFoldConstantExpression - Attempt to fold the constant expression
316/// using the specified TargetData. If successful, the constant result is
317/// result is returned, if not, null is returned.
318Constant *llvm::ConstantFoldConstantExpression(ConstantExpr *CE,
319 const TargetData *TD) {
320 assert(TD && "ConstantFoldConstantExpression requires a valid TargetData.");
321
322 SmallVector<Constant*, 8> Ops;
323 for (User::op_iterator i = CE->op_begin(), e = CE->op_end(); i != e; ++i)
324 Ops.push_back(cast<Constant>(*i));
325
326 if (CE->isCompare())
327 return ConstantFoldCompareInstOperands(CE->getPredicate(),
328 &Ops[0], Ops.size(), TD);
329 else
330 return ConstantFoldInstOperands(CE->getOpcode(), CE->getType(),
331 &Ops[0], Ops.size(), TD);
332}
333
Chris Lattner55207322007-01-30 23:45:45 +0000334/// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
335/// specified opcode and operands. If successful, the constant result is
336/// returned, if not, null is returned. Note that this function can fail when
337/// attempting to fold instructions like loads and stores, which have no
338/// constant expression form.
339///
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000340Constant *llvm::ConstantFoldInstOperands(unsigned Opcode, const Type *DestTy,
341 Constant* const* Ops, unsigned NumOps,
Chris Lattner55207322007-01-30 23:45:45 +0000342 const TargetData *TD) {
Chris Lattner03dd25c2007-01-31 00:51:48 +0000343 // Handle easy binops first.
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000344 if (Instruction::isBinaryOp(Opcode)) {
Chris Lattner03dd25c2007-01-31 00:51:48 +0000345 if (isa<ConstantExpr>(Ops[0]) || isa<ConstantExpr>(Ops[1]))
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000346 if (Constant *C = SymbolicallyEvaluateBinop(Opcode, Ops[0], Ops[1], TD))
Chris Lattner03dd25c2007-01-31 00:51:48 +0000347 return C;
348
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000349 return ConstantExpr::get(Opcode, Ops[0], Ops[1]);
Chris Lattner03dd25c2007-01-31 00:51:48 +0000350 }
Chris Lattner55207322007-01-30 23:45:45 +0000351
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000352 switch (Opcode) {
Chris Lattner55207322007-01-30 23:45:45 +0000353 default: return 0;
354 case Instruction::Call:
355 if (Function *F = dyn_cast<Function>(Ops[0]))
356 if (canConstantFoldCallTo(F))
Chris Lattnerad58eb32007-01-31 18:04:55 +0000357 return ConstantFoldCall(F, Ops+1, NumOps-1);
Chris Lattner55207322007-01-30 23:45:45 +0000358 return 0;
359 case Instruction::ICmp:
360 case Instruction::FCmp:
Nate Begemanb5557ab2008-07-25 17:35:37 +0000361 case Instruction::VICmp:
362 case Instruction::VFCmp:
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000363 assert(0 &&"This function is invalid for compares: no predicate specified");
Chris Lattner001f7532007-08-11 23:49:01 +0000364 case Instruction::PtrToInt:
365 // If the input is a inttoptr, eliminate the pair. This requires knowing
366 // the width of a pointer, so it can't be done in ConstantExpr::getCast.
367 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
368 if (TD && CE->getOpcode() == Instruction::IntToPtr) {
369 Constant *Input = CE->getOperand(0);
370 unsigned InWidth = Input->getType()->getPrimitiveSizeInBits();
Nick Lewycky04aa2c32008-10-24 06:14:27 +0000371 if (TD->getPointerSizeInBits() < InWidth) {
372 Constant *Mask =
373 ConstantInt::get(APInt::getLowBitsSet(InWidth,
374 TD->getPointerSizeInBits()));
375 Input = ConstantExpr::getAnd(Input, Mask);
376 }
Chris Lattner001f7532007-08-11 23:49:01 +0000377 // Do a zext or trunc to get to the dest size.
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000378 return ConstantExpr::getIntegerCast(Input, DestTy, false);
Chris Lattner001f7532007-08-11 23:49:01 +0000379 }
380 }
Chris Lattner1afab9c2007-12-11 07:29:44 +0000381 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
Chris Lattner001f7532007-08-11 23:49:01 +0000382 case Instruction::IntToPtr:
Duncan Sands81b06be2008-08-13 20:20:35 +0000383 // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
384 // the int size is >= the ptr size. This requires knowing the width of a
385 // pointer, so it can't be done in ConstantExpr::getCast.
386 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
387 if (TD && CE->getOpcode() == Instruction::PtrToInt &&
388 TD->getPointerSizeInBits() <=
389 CE->getType()->getPrimitiveSizeInBits()) {
390 Constant *Input = CE->getOperand(0);
391 Constant *C = FoldBitCast(Input, DestTy, *TD);
392 return C ? C : ConstantExpr::getBitCast(Input, DestTy);
393 }
394 }
395 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
Chris Lattner55207322007-01-30 23:45:45 +0000396 case Instruction::Trunc:
397 case Instruction::ZExt:
398 case Instruction::SExt:
399 case Instruction::FPTrunc:
400 case Instruction::FPExt:
401 case Instruction::UIToFP:
402 case Instruction::SIToFP:
403 case Instruction::FPToUI:
404 case Instruction::FPToSI:
Chris Lattner1afab9c2007-12-11 07:29:44 +0000405 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
Chris Lattner55207322007-01-30 23:45:45 +0000406 case Instruction::BitCast:
Chris Lattner1afab9c2007-12-11 07:29:44 +0000407 if (TD)
408 if (Constant *C = FoldBitCast(Ops[0], DestTy, *TD))
409 return C;
410 return ConstantExpr::getBitCast(Ops[0], DestTy);
Chris Lattner55207322007-01-30 23:45:45 +0000411 case Instruction::Select:
412 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
413 case Instruction::ExtractElement:
414 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
415 case Instruction::InsertElement:
416 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
417 case Instruction::ShuffleVector:
418 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
419 case Instruction::GetElementPtr:
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000420 if (Constant *C = SymbolicallyEvaluateGEP(Ops, NumOps, DestTy, TD))
Chris Lattner03dd25c2007-01-31 00:51:48 +0000421 return C;
422
Chris Lattnerd917fe52007-01-31 04:42:05 +0000423 return ConstantExpr::getGetElementPtr(Ops[0], Ops+1, NumOps-1);
Chris Lattner55207322007-01-30 23:45:45 +0000424 }
425}
426
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000427/// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
428/// instruction (icmp/fcmp) with the specified operands. If it fails, it
429/// returns a constant expression of the specified operands.
430///
431Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
432 Constant*const * Ops,
433 unsigned NumOps,
434 const TargetData *TD) {
435 // fold: icmp (inttoptr x), null -> icmp x, 0
436 // fold: icmp (ptrtoint x), 0 -> icmp x, null
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000437 // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000438 // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
439 //
440 // ConstantExpr::getCompare cannot do this, because it doesn't have TD
441 // around to know if bit truncation is happening.
442 if (ConstantExpr *CE0 = dyn_cast<ConstantExpr>(Ops[0])) {
443 if (TD && Ops[1]->isNullValue()) {
444 const Type *IntPtrTy = TD->getIntPtrType();
445 if (CE0->getOpcode() == Instruction::IntToPtr) {
446 // Convert the integer value to the right size to ensure we get the
447 // proper extension or truncation.
448 Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
449 IntPtrTy, false);
450 Constant *NewOps[] = { C, Constant::getNullValue(C->getType()) };
451 return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
452 }
453
454 // Only do this transformation if the int is intptrty in size, otherwise
455 // there is a truncation or extension that we aren't modeling.
456 if (CE0->getOpcode() == Instruction::PtrToInt &&
457 CE0->getType() == IntPtrTy) {
458 Constant *C = CE0->getOperand(0);
459 Constant *NewOps[] = { C, Constant::getNullValue(C->getType()) };
460 // FIXME!
461 return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
462 }
463 }
464
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000465 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(Ops[1])) {
466 if (TD && CE0->getOpcode() == CE1->getOpcode()) {
467 const Type *IntPtrTy = TD->getIntPtrType();
468
469 if (CE0->getOpcode() == Instruction::IntToPtr) {
470 // Convert the integer value to the right size to ensure we get the
471 // proper extension or truncation.
472 Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
473 IntPtrTy, false);
474 Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
475 IntPtrTy, false);
476 Constant *NewOps[] = { C0, C1 };
477 return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
478 }
479
480 // Only do this transformation if the int is intptrty in size, otherwise
481 // there is a truncation or extension that we aren't modeling.
482 if ((CE0->getOpcode() == Instruction::PtrToInt &&
483 CE0->getType() == IntPtrTy &&
484 CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType())) {
485 Constant *NewOps[] = {
486 CE0->getOperand(0), CE1->getOperand(0)
487 };
488 return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
489 }
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000490 }
491 }
492 }
Nate Begemanb5557ab2008-07-25 17:35:37 +0000493 return ConstantExpr::getCompare(Predicate, Ops[0], Ops[1]);
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000494}
495
496
Chris Lattner55207322007-01-30 23:45:45 +0000497/// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
498/// getelementptr constantexpr, return the constant value being addressed by the
499/// constant expression, or null if something is funny and we can't decide.
500Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
501 ConstantExpr *CE) {
502 if (CE->getOperand(1) != Constant::getNullValue(CE->getOperand(1)->getType()))
503 return 0; // Do not allow stepping over the value!
504
505 // Loop over all of the operands, tracking down which value we are
506 // addressing...
507 gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
508 for (++I; I != E; ++I)
509 if (const StructType *STy = dyn_cast<StructType>(*I)) {
510 ConstantInt *CU = cast<ConstantInt>(I.getOperand());
511 assert(CU->getZExtValue() < STy->getNumElements() &&
512 "Struct index out of range!");
513 unsigned El = (unsigned)CU->getZExtValue();
514 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
515 C = CS->getOperand(El);
516 } else if (isa<ConstantAggregateZero>(C)) {
517 C = Constant::getNullValue(STy->getElementType(El));
518 } else if (isa<UndefValue>(C)) {
519 C = UndefValue::get(STy->getElementType(El));
520 } else {
521 return 0;
522 }
523 } else if (ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand())) {
524 if (const ArrayType *ATy = dyn_cast<ArrayType>(*I)) {
525 if (CI->getZExtValue() >= ATy->getNumElements())
526 return 0;
527 if (ConstantArray *CA = dyn_cast<ConstantArray>(C))
528 C = CA->getOperand(CI->getZExtValue());
529 else if (isa<ConstantAggregateZero>(C))
530 C = Constant::getNullValue(ATy->getElementType());
531 else if (isa<UndefValue>(C))
532 C = UndefValue::get(ATy->getElementType());
533 else
534 return 0;
Reid Spencer9d6565a2007-02-15 02:26:10 +0000535 } else if (const VectorType *PTy = dyn_cast<VectorType>(*I)) {
Chris Lattner55207322007-01-30 23:45:45 +0000536 if (CI->getZExtValue() >= PTy->getNumElements())
537 return 0;
Reid Spencer9d6565a2007-02-15 02:26:10 +0000538 if (ConstantVector *CP = dyn_cast<ConstantVector>(C))
Chris Lattner55207322007-01-30 23:45:45 +0000539 C = CP->getOperand(CI->getZExtValue());
540 else if (isa<ConstantAggregateZero>(C))
541 C = Constant::getNullValue(PTy->getElementType());
542 else if (isa<UndefValue>(C))
543 C = UndefValue::get(PTy->getElementType());
544 else
545 return 0;
546 } else {
547 return 0;
548 }
549 } else {
550 return 0;
551 }
552 return C;
553}
554
555
556//===----------------------------------------------------------------------===//
557// Constant Folding for Calls
558//
John Criswellbd9d3702005-10-27 16:00:10 +0000559
560/// canConstantFoldCallTo - Return true if its even possible to fold a call to
561/// the specified function.
562bool
Dan Gohmanfa9b80e2008-01-31 01:05:10 +0000563llvm::canConstantFoldCallTo(const Function *F) {
John Criswellbd9d3702005-10-27 16:00:10 +0000564 switch (F->getIntrinsicID()) {
Dale Johannesen9ab7fb32007-10-02 17:43:59 +0000565 case Intrinsic::sqrt:
566 case Intrinsic::powi:
Reid Spencere9391fd2007-04-01 07:35:23 +0000567 case Intrinsic::bswap:
568 case Intrinsic::ctpop:
569 case Intrinsic::ctlz:
570 case Intrinsic::cttz:
John Criswellbd9d3702005-10-27 16:00:10 +0000571 return true;
572 default: break;
573 }
574
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000575 const ValueName *NameVal = F->getValueName();
Chris Lattnera099b6c2007-08-08 16:07:23 +0000576 if (NameVal == 0) return false;
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000577 const char *Str = NameVal->getKeyData();
578 unsigned Len = NameVal->getKeyLength();
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000579
580 // In these cases, the check of the length is required. We don't want to
581 // return true for a name like "cos\0blah" which strcmp would return equal to
582 // "cos", but has length 8.
583 switch (Str[0]) {
584 default: return false;
585 case 'a':
586 if (Len == 4)
587 return !strcmp(Str, "acos") || !strcmp(Str, "asin") ||
588 !strcmp(Str, "atan");
589 else if (Len == 5)
590 return !strcmp(Str, "atan2");
591 return false;
592 case 'c':
593 if (Len == 3)
594 return !strcmp(Str, "cos");
595 else if (Len == 4)
596 return !strcmp(Str, "ceil") || !strcmp(Str, "cosf") ||
597 !strcmp(Str, "cosh");
598 return false;
599 case 'e':
600 if (Len == 3)
601 return !strcmp(Str, "exp");
602 return false;
603 case 'f':
604 if (Len == 4)
605 return !strcmp(Str, "fabs") || !strcmp(Str, "fmod");
606 else if (Len == 5)
607 return !strcmp(Str, "floor");
608 return false;
609 break;
610 case 'l':
611 if (Len == 3 && !strcmp(Str, "log"))
612 return true;
613 if (Len == 5 && !strcmp(Str, "log10"))
614 return true;
615 return false;
616 case 'p':
617 if (Len == 3 && !strcmp(Str, "pow"))
618 return true;
619 return false;
620 case 's':
621 if (Len == 3)
622 return !strcmp(Str, "sin");
623 if (Len == 4)
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000624 return !strcmp(Str, "sinh") || !strcmp(Str, "sqrt") ||
625 !strcmp(Str, "sinf");
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000626 if (Len == 5)
627 return !strcmp(Str, "sqrtf");
628 return false;
629 case 't':
630 if (Len == 3 && !strcmp(Str, "tan"))
631 return true;
632 else if (Len == 4 && !strcmp(Str, "tanh"))
633 return true;
634 return false;
John Criswellbd9d3702005-10-27 16:00:10 +0000635 }
636}
637
Chris Lattner72d88ae2007-01-30 23:15:43 +0000638static Constant *ConstantFoldFP(double (*NativeFP)(double), double V,
639 const Type *Ty) {
John Criswellbd9d3702005-10-27 16:00:10 +0000640 errno = 0;
641 V = NativeFP(V);
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000642 if (errno != 0) {
643 errno = 0;
644 return 0;
Dale Johannesen43421b32007-09-06 18:13:44 +0000645 }
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000646
647 if (Ty == Type::FloatTy)
Chris Lattner02a260a2008-04-20 00:41:09 +0000648 return ConstantFP::get(APFloat((float)V));
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000649 if (Ty == Type::DoubleTy)
Chris Lattner02a260a2008-04-20 00:41:09 +0000650 return ConstantFP::get(APFloat(V));
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000651 assert(0 && "Can only constant fold float/double");
Gabor Greif33e456d2008-05-21 14:07:30 +0000652 return 0; // dummy return to suppress warning
John Criswellbd9d3702005-10-27 16:00:10 +0000653}
654
Dan Gohman38415242007-07-16 15:26:22 +0000655static Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
656 double V, double W,
657 const Type *Ty) {
658 errno = 0;
659 V = NativeFP(V, W);
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000660 if (errno != 0) {
661 errno = 0;
662 return 0;
Dale Johannesen43421b32007-09-06 18:13:44 +0000663 }
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000664
665 if (Ty == Type::FloatTy)
Chris Lattner02a260a2008-04-20 00:41:09 +0000666 return ConstantFP::get(APFloat((float)V));
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000667 if (Ty == Type::DoubleTy)
Chris Lattner02a260a2008-04-20 00:41:09 +0000668 return ConstantFP::get(APFloat(V));
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000669 assert(0 && "Can only constant fold float/double");
Gabor Greif33e456d2008-05-21 14:07:30 +0000670 return 0; // dummy return to suppress warning
Dan Gohman38415242007-07-16 15:26:22 +0000671}
672
John Criswellbd9d3702005-10-27 16:00:10 +0000673/// ConstantFoldCall - Attempt to constant fold a call to the specified function
674/// with the specified arguments, returning null if unsuccessful.
Dale Johannesen43421b32007-09-06 18:13:44 +0000675
John Criswellbd9d3702005-10-27 16:00:10 +0000676Constant *
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000677llvm::ConstantFoldCall(Function *F,
678 Constant* const* Operands, unsigned NumOperands) {
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000679 const ValueName *NameVal = F->getValueName();
Chris Lattnera099b6c2007-08-08 16:07:23 +0000680 if (NameVal == 0) return 0;
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000681 const char *Str = NameVal->getKeyData();
682 unsigned Len = NameVal->getKeyLength();
683
John Criswellbd9d3702005-10-27 16:00:10 +0000684 const Type *Ty = F->getReturnType();
Chris Lattner72d88ae2007-01-30 23:15:43 +0000685 if (NumOperands == 1) {
John Criswellbd9d3702005-10-27 16:00:10 +0000686 if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
Dale Johannesen43421b32007-09-06 18:13:44 +0000687 if (Ty!=Type::FloatTy && Ty!=Type::DoubleTy)
688 return 0;
689 /// Currently APFloat versions of these functions do not exist, so we use
690 /// the host native double versions. Float versions are not called
691 /// directly but for all these it is true (float)(f((double)arg)) ==
692 /// f(arg). Long double not supported yet.
693 double V = Ty==Type::FloatTy ? (double)Op->getValueAPF().convertToFloat():
694 Op->getValueAPF().convertToDouble();
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000695 switch (Str[0]) {
696 case 'a':
697 if (Len == 4 && !strcmp(Str, "acos"))
698 return ConstantFoldFP(acos, V, Ty);
699 else if (Len == 4 && !strcmp(Str, "asin"))
700 return ConstantFoldFP(asin, V, Ty);
701 else if (Len == 4 && !strcmp(Str, "atan"))
702 return ConstantFoldFP(atan, V, Ty);
703 break;
704 case 'c':
705 if (Len == 4 && !strcmp(Str, "ceil"))
706 return ConstantFoldFP(ceil, V, Ty);
707 else if (Len == 3 && !strcmp(Str, "cos"))
708 return ConstantFoldFP(cos, V, Ty);
709 else if (Len == 4 && !strcmp(Str, "cosh"))
710 return ConstantFoldFP(cosh, V, Ty);
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000711 else if (Len == 4 && !strcmp(Str, "cosf"))
712 return ConstantFoldFP(cos, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000713 break;
714 case 'e':
715 if (Len == 3 && !strcmp(Str, "exp"))
716 return ConstantFoldFP(exp, V, Ty);
717 break;
718 case 'f':
719 if (Len == 4 && !strcmp(Str, "fabs"))
Dale Johannesen43421b32007-09-06 18:13:44 +0000720 return ConstantFoldFP(fabs, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000721 else if (Len == 5 && !strcmp(Str, "floor"))
722 return ConstantFoldFP(floor, V, Ty);
723 break;
724 case 'l':
725 if (Len == 3 && !strcmp(Str, "log") && V > 0)
726 return ConstantFoldFP(log, V, Ty);
727 else if (Len == 5 && !strcmp(Str, "log10") && V > 0)
728 return ConstantFoldFP(log10, V, Ty);
729 else if (!strcmp(Str, "llvm.sqrt.f32") ||
730 !strcmp(Str, "llvm.sqrt.f64")) {
731 if (V >= -0.0)
Dale Johannesen43421b32007-09-06 18:13:44 +0000732 return ConstantFoldFP(sqrt, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000733 else // Undefined
Chris Lattner02a260a2008-04-20 00:41:09 +0000734 return Constant::getNullValue(Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000735 }
736 break;
737 case 's':
738 if (Len == 3 && !strcmp(Str, "sin"))
739 return ConstantFoldFP(sin, V, Ty);
740 else if (Len == 4 && !strcmp(Str, "sinh"))
741 return ConstantFoldFP(sinh, V, Ty);
742 else if (Len == 4 && !strcmp(Str, "sqrt") && V >= 0)
743 return ConstantFoldFP(sqrt, V, Ty);
744 else if (Len == 5 && !strcmp(Str, "sqrtf") && V >= 0)
745 return ConstantFoldFP(sqrt, V, Ty);
Chris Lattnerf19f58a2008-03-30 18:02:00 +0000746 else if (Len == 4 && !strcmp(Str, "sinf"))
747 return ConstantFoldFP(sin, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000748 break;
749 case 't':
750 if (Len == 3 && !strcmp(Str, "tan"))
751 return ConstantFoldFP(tan, V, Ty);
752 else if (Len == 4 && !strcmp(Str, "tanh"))
753 return ConstantFoldFP(tanh, V, Ty);
754 break;
755 default:
756 break;
John Criswellbd9d3702005-10-27 16:00:10 +0000757 }
Reid Spencerb83eb642006-10-20 07:07:24 +0000758 } else if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
Chris Lattnerecc02742007-11-23 22:34:59 +0000759 if (Len > 11 && !memcmp(Str, "llvm.bswap", 10))
Reid Spencere9391fd2007-04-01 07:35:23 +0000760 return ConstantInt::get(Op->getValue().byteSwap());
Chris Lattnerecc02742007-11-23 22:34:59 +0000761 else if (Len > 11 && !memcmp(Str, "llvm.ctpop", 10))
762 return ConstantInt::get(Ty, Op->getValue().countPopulation());
763 else if (Len > 10 && !memcmp(Str, "llvm.cttz", 9))
764 return ConstantInt::get(Ty, Op->getValue().countTrailingZeros());
765 else if (Len > 10 && !memcmp(Str, "llvm.ctlz", 9))
766 return ConstantInt::get(Ty, Op->getValue().countLeadingZeros());
John Criswellbd9d3702005-10-27 16:00:10 +0000767 }
Chris Lattner72d88ae2007-01-30 23:15:43 +0000768 } else if (NumOperands == 2) {
John Criswellbd9d3702005-10-27 16:00:10 +0000769 if (ConstantFP *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
Dale Johannesen9ab7fb32007-10-02 17:43:59 +0000770 if (Ty!=Type::FloatTy && Ty!=Type::DoubleTy)
771 return 0;
Dale Johannesen43421b32007-09-06 18:13:44 +0000772 double Op1V = Ty==Type::FloatTy ?
773 (double)Op1->getValueAPF().convertToFloat():
774 Op1->getValueAPF().convertToDouble();
John Criswellbd9d3702005-10-27 16:00:10 +0000775 if (ConstantFP *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
Dale Johannesen43421b32007-09-06 18:13:44 +0000776 double Op2V = Ty==Type::FloatTy ?
777 (double)Op2->getValueAPF().convertToFloat():
778 Op2->getValueAPF().convertToDouble();
John Criswellbd9d3702005-10-27 16:00:10 +0000779
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000780 if (Len == 3 && !strcmp(Str, "pow")) {
Dan Gohman38415242007-07-16 15:26:22 +0000781 return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000782 } else if (Len == 4 && !strcmp(Str, "fmod")) {
Dan Gohman38415242007-07-16 15:26:22 +0000783 return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000784 } else if (Len == 5 && !strcmp(Str, "atan2")) {
Dan Gohman38415242007-07-16 15:26:22 +0000785 return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
Chris Lattnerb5282dc2007-01-15 06:27:37 +0000786 }
787 } else if (ConstantInt *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000788 if (!strcmp(Str, "llvm.powi.f32")) {
Chris Lattner02a260a2008-04-20 00:41:09 +0000789 return ConstantFP::get(APFloat((float)std::pow((float)Op1V,
790 (int)Op2C->getZExtValue())));
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +0000791 } else if (!strcmp(Str, "llvm.powi.f64")) {
Chris Lattner02a260a2008-04-20 00:41:09 +0000792 return ConstantFP::get(APFloat((double)std::pow((double)Op1V,
793 (int)Op2C->getZExtValue())));
Chris Lattnerb5282dc2007-01-15 06:27:37 +0000794 }
John Criswellbd9d3702005-10-27 16:00:10 +0000795 }
796 }
797 }
798 return 0;
799}
800