blob: cd8d52c1c465beb5a6d5b64575631f4167a5b371 [file] [log] [blame]
Dan Gohman83e3c4f2009-09-10 23:07:18 +00001//===-- ConstantFolding.cpp - Fold instructions into constants ------------===//
John Criswellbd9d3702005-10-27 16:00:10 +00002//
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//
Dan Gohman83e3c4f2009-09-10 23:07:18 +000010// This file defines routines for folding instructions into constants.
11//
12// Also, to supplement the basic VMCore ConstantExpr simplifications,
13// this file defines some additional folding routines that can make use of
14// TargetData information. These functions cannot go in VMCore due to library
15// dependency issues.
John Criswellbd9d3702005-10-27 16:00:10 +000016//
17//===----------------------------------------------------------------------===//
18
19#include "llvm/Analysis/ConstantFolding.h"
20#include "llvm/Constants.h"
21#include "llvm/DerivedTypes.h"
Chris Lattner55207322007-01-30 23:45:45 +000022#include "llvm/Function.h"
Dan Gohman9a38e3e2009-05-07 19:46:24 +000023#include "llvm/GlobalVariable.h"
John Criswellbd9d3702005-10-27 16:00:10 +000024#include "llvm/Instructions.h"
25#include "llvm/Intrinsics.h"
Chris Lattner62d327e2009-10-22 06:38:35 +000026#include "llvm/Analysis/ValueTracking.h"
27#include "llvm/Target/TargetData.h"
Chris Lattner55207322007-01-30 23:45:45 +000028#include "llvm/ADT/SmallVector.h"
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +000029#include "llvm/ADT/StringMap.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000030#include "llvm/Support/ErrorHandling.h"
John Criswellbd9d3702005-10-27 16:00:10 +000031#include "llvm/Support/GetElementPtrTypeIterator.h"
32#include "llvm/Support/MathExtras.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000033#include "llvm/Support/FEnv.h"
John Criswellbd9d3702005-10-27 16:00:10 +000034#include <cerrno>
Jeff Cohen97af7512006-12-02 02:22:01 +000035#include <cmath>
John Criswellbd9d3702005-10-27 16:00:10 +000036using namespace llvm;
37
Chris Lattner03dd25c2007-01-31 00:51:48 +000038//===----------------------------------------------------------------------===//
39// Constant Folding internal helper functions
40//===----------------------------------------------------------------------===//
41
Chris Lattner6333c392009-10-25 06:08:26 +000042/// FoldBitCast - Constant fold bitcast, symbolically evaluating it with
43/// TargetData. This always returns a non-null constant, but it may be a
44/// ConstantExpr if unfoldable.
45static Constant *FoldBitCast(Constant *C, const Type *DestTy,
46 const TargetData &TD) {
Chris Lattner93798da2009-10-25 06:15:37 +000047
48 // This only handles casts to vectors currently.
49 const VectorType *DestVTy = dyn_cast<VectorType>(DestTy);
50 if (DestVTy == 0)
51 return ConstantExpr::getBitCast(C, DestTy);
52
53 // If this is a scalar -> vector cast, convert the input into a <1 x scalar>
54 // vector so the code below can handle it uniformly.
55 if (isa<ConstantFP>(C) || isa<ConstantInt>(C)) {
56 Constant *Ops = C; // don't take the address of C!
Chris Lattner2ca5c862011-02-15 00:14:00 +000057 return FoldBitCast(ConstantVector::get(Ops), DestTy, TD);
Chris Lattner93798da2009-10-25 06:15:37 +000058 }
59
Chris Lattner6333c392009-10-25 06:08:26 +000060 // If this is a bitcast from constant vector -> vector, fold it.
61 ConstantVector *CV = dyn_cast<ConstantVector>(C);
62 if (CV == 0)
63 return ConstantExpr::getBitCast(C, DestTy);
64
Chris Lattner6333c392009-10-25 06:08:26 +000065 // If the element types match, VMCore can fold it.
66 unsigned NumDstElt = DestVTy->getNumElements();
67 unsigned NumSrcElt = CV->getNumOperands();
68 if (NumDstElt == NumSrcElt)
69 return ConstantExpr::getBitCast(C, DestTy);
70
71 const Type *SrcEltTy = CV->getType()->getElementType();
72 const Type *DstEltTy = DestVTy->getElementType();
73
74 // Otherwise, we're changing the number of elements in a vector, which
75 // requires endianness information to do the right thing. For example,
76 // bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
77 // folds to (little endian):
78 // <4 x i32> <i32 0, i32 0, i32 1, i32 0>
79 // and to (big endian):
80 // <4 x i32> <i32 0, i32 0, i32 0, i32 1>
81
82 // First thing is first. We only want to think about integer here, so if
83 // we have something in FP form, recast it as integer.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +000084 if (DstEltTy->isFloatingPointTy()) {
Chris Lattner6333c392009-10-25 06:08:26 +000085 // Fold to an vector of integers with same size as our FP type.
86 unsigned FPWidth = DstEltTy->getPrimitiveSizeInBits();
87 const Type *DestIVTy =
88 VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumDstElt);
89 // Recursively handle this integer conversion, if possible.
90 C = FoldBitCast(C, DestIVTy, TD);
91 if (!C) return ConstantExpr::getBitCast(C, DestTy);
92
93 // Finally, VMCore can handle this now that #elts line up.
94 return ConstantExpr::getBitCast(C, DestTy);
95 }
96
97 // Okay, we know the destination is integer, if the input is FP, convert
98 // it to integer first.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +000099 if (SrcEltTy->isFloatingPointTy()) {
Chris Lattner6333c392009-10-25 06:08:26 +0000100 unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
101 const Type *SrcIVTy =
102 VectorType::get(IntegerType::get(C->getContext(), FPWidth), NumSrcElt);
103 // Ask VMCore to do the conversion now that #elts line up.
104 C = ConstantExpr::getBitCast(C, SrcIVTy);
105 CV = dyn_cast<ConstantVector>(C);
106 if (!CV) // If VMCore wasn't able to fold it, bail out.
107 return C;
108 }
109
110 // Now we know that the input and output vectors are both integer vectors
111 // of the same size, and that their #elements is not the same. Do the
112 // conversion here, which depends on whether the input or output has
113 // more elements.
114 bool isLittleEndian = TD.isLittleEndian();
115
116 SmallVector<Constant*, 32> Result;
117 if (NumDstElt < NumSrcElt) {
118 // Handle: bitcast (<4 x i32> <i32 0, i32 1, i32 2, i32 3> to <2 x i64>)
119 Constant *Zero = Constant::getNullValue(DstEltTy);
120 unsigned Ratio = NumSrcElt/NumDstElt;
121 unsigned SrcBitSize = SrcEltTy->getPrimitiveSizeInBits();
122 unsigned SrcElt = 0;
123 for (unsigned i = 0; i != NumDstElt; ++i) {
124 // Build each element of the result.
125 Constant *Elt = Zero;
126 unsigned ShiftAmt = isLittleEndian ? 0 : SrcBitSize*(Ratio-1);
127 for (unsigned j = 0; j != Ratio; ++j) {
128 Constant *Src = dyn_cast<ConstantInt>(CV->getOperand(SrcElt++));
129 if (!Src) // Reject constantexpr elements.
130 return ConstantExpr::getBitCast(C, DestTy);
131
132 // Zero extend the element to the right size.
133 Src = ConstantExpr::getZExt(Src, Elt->getType());
134
135 // Shift it to the right place, depending on endianness.
136 Src = ConstantExpr::getShl(Src,
137 ConstantInt::get(Src->getType(), ShiftAmt));
138 ShiftAmt += isLittleEndian ? SrcBitSize : -SrcBitSize;
139
140 // Mix it in.
141 Elt = ConstantExpr::getOr(Elt, Src);
142 }
143 Result.push_back(Elt);
144 }
145 } else {
146 // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
147 unsigned Ratio = NumDstElt/NumSrcElt;
148 unsigned DstBitSize = DstEltTy->getPrimitiveSizeInBits();
149
150 // Loop over each source value, expanding into multiple results.
151 for (unsigned i = 0; i != NumSrcElt; ++i) {
152 Constant *Src = dyn_cast<ConstantInt>(CV->getOperand(i));
153 if (!Src) // Reject constantexpr elements.
154 return ConstantExpr::getBitCast(C, DestTy);
155
156 unsigned ShiftAmt = isLittleEndian ? 0 : DstBitSize*(Ratio-1);
157 for (unsigned j = 0; j != Ratio; ++j) {
158 // Shift the piece of the value into the right place, depending on
159 // endianness.
160 Constant *Elt = ConstantExpr::getLShr(Src,
161 ConstantInt::get(Src->getType(), ShiftAmt));
162 ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
163
164 // Truncate and remember this piece.
165 Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
166 }
167 }
168 }
169
Chris Lattner2ca5c862011-02-15 00:14:00 +0000170 return ConstantVector::get(Result);
Chris Lattner6333c392009-10-25 06:08:26 +0000171}
172
173
Chris Lattner03dd25c2007-01-31 00:51:48 +0000174/// IsConstantOffsetFromGlobal - If this constant is actually a constant offset
175/// from a global, return the global and the constant. Because of
176/// constantexprs, this function is recursive.
177static bool IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV,
178 int64_t &Offset, const TargetData &TD) {
179 // Trivial case, constant is the global.
180 if ((GV = dyn_cast<GlobalValue>(C))) {
181 Offset = 0;
182 return true;
183 }
184
185 // Otherwise, if this isn't a constant expr, bail out.
186 ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
187 if (!CE) return false;
188
189 // Look through ptr->int and ptr->ptr casts.
190 if (CE->getOpcode() == Instruction::PtrToInt ||
191 CE->getOpcode() == Instruction::BitCast)
192 return IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD);
193
194 // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
195 if (CE->getOpcode() == Instruction::GetElementPtr) {
196 // Cannot compute this if the element type of the pointer is missing size
197 // info.
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000198 if (!cast<PointerType>(CE->getOperand(0)->getType())
199 ->getElementType()->isSized())
Chris Lattner03dd25c2007-01-31 00:51:48 +0000200 return false;
201
202 // If the base isn't a global+constant, we aren't either.
203 if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD))
204 return false;
205
206 // Otherwise, add any offset that our operands provide.
207 gep_type_iterator GTI = gep_type_begin(CE);
Gabor Greifde2d74b2008-05-22 06:43:33 +0000208 for (User::const_op_iterator i = CE->op_begin() + 1, e = CE->op_end();
Gabor Greif785c6af2008-05-22 19:24:54 +0000209 i != e; ++i, ++GTI) {
Gabor Greifde2d74b2008-05-22 06:43:33 +0000210 ConstantInt *CI = dyn_cast<ConstantInt>(*i);
Chris Lattner03dd25c2007-01-31 00:51:48 +0000211 if (!CI) return false; // Index isn't a simple constant?
Dan Gohmane368b462010-06-18 14:22:04 +0000212 if (CI->isZero()) continue; // Not adding anything.
Chris Lattner03dd25c2007-01-31 00:51:48 +0000213
214 if (const StructType *ST = dyn_cast<StructType>(*GTI)) {
215 // N = N + Offset
Chris Lattnerb1919e22007-02-10 19:55:17 +0000216 Offset += TD.getStructLayout(ST)->getElementOffset(CI->getZExtValue());
Chris Lattner03dd25c2007-01-31 00:51:48 +0000217 } else {
Jeff Cohenca5183d2007-03-05 00:00:42 +0000218 const SequentialType *SQT = cast<SequentialType>(*GTI);
Duncan Sands777d2302009-05-09 07:06:46 +0000219 Offset += TD.getTypeAllocSize(SQT->getElementType())*CI->getSExtValue();
Chris Lattner03dd25c2007-01-31 00:51:48 +0000220 }
221 }
222 return true;
223 }
224
225 return false;
226}
227
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000228/// ReadDataFromGlobal - Recursive helper to read bits out of global. C is the
229/// constant being copied out of. ByteOffset is an offset into C. CurPtr is the
230/// pointer to copy results into and BytesLeft is the number of bytes left in
231/// the CurPtr buffer. TD is the target data.
232static bool ReadDataFromGlobal(Constant *C, uint64_t ByteOffset,
233 unsigned char *CurPtr, unsigned BytesLeft,
234 const TargetData &TD) {
235 assert(ByteOffset <= TD.getTypeAllocSize(C->getType()) &&
236 "Out of range access");
237
Chris Lattnerc7b13822009-10-24 05:27:19 +0000238 // If this element is zero or undefined, we can just return since *CurPtr is
239 // zero initialized.
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000240 if (isa<ConstantAggregateZero>(C) || isa<UndefValue>(C))
241 return true;
242
243 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
244 if (CI->getBitWidth() > 64 ||
245 (CI->getBitWidth() & 7) != 0)
246 return false;
247
248 uint64_t Val = CI->getZExtValue();
249 unsigned IntBytes = unsigned(CI->getBitWidth()/8);
250
251 for (unsigned i = 0; i != BytesLeft && ByteOffset != IntBytes; ++i) {
Chris Lattnerc7b13822009-10-24 05:27:19 +0000252 CurPtr[i] = (unsigned char)(Val >> (ByteOffset * 8));
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000253 ++ByteOffset;
254 }
255 return true;
256 }
257
258 if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
259 if (CFP->getType()->isDoubleTy()) {
Chris Lattner6333c392009-10-25 06:08:26 +0000260 C = FoldBitCast(C, Type::getInt64Ty(C->getContext()), TD);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000261 return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
262 }
263 if (CFP->getType()->isFloatTy()){
Chris Lattner6333c392009-10-25 06:08:26 +0000264 C = FoldBitCast(C, Type::getInt32Ty(C->getContext()), TD);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000265 return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
266 }
Chris Lattnerc7b13822009-10-24 05:27:19 +0000267 return false;
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000268 }
269
270 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
271 const StructLayout *SL = TD.getStructLayout(CS->getType());
272 unsigned Index = SL->getElementContainingOffset(ByteOffset);
273 uint64_t CurEltOffset = SL->getElementOffset(Index);
274 ByteOffset -= CurEltOffset;
275
276 while (1) {
277 // If the element access is to the element itself and not to tail padding,
278 // read the bytes from the element.
279 uint64_t EltSize = TD.getTypeAllocSize(CS->getOperand(Index)->getType());
280
281 if (ByteOffset < EltSize &&
282 !ReadDataFromGlobal(CS->getOperand(Index), ByteOffset, CurPtr,
283 BytesLeft, TD))
284 return false;
285
286 ++Index;
287
288 // Check to see if we read from the last struct element, if so we're done.
289 if (Index == CS->getType()->getNumElements())
290 return true;
291
292 // If we read all of the bytes we needed from this element we're done.
293 uint64_t NextEltOffset = SL->getElementOffset(Index);
294
295 if (BytesLeft <= NextEltOffset-CurEltOffset-ByteOffset)
296 return true;
297
298 // Move to the next element of the struct.
Chris Lattnerc5af6492009-10-24 05:22:15 +0000299 CurPtr += NextEltOffset-CurEltOffset-ByteOffset;
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000300 BytesLeft -= NextEltOffset-CurEltOffset-ByteOffset;
301 ByteOffset = 0;
302 CurEltOffset = NextEltOffset;
303 }
304 // not reached.
305 }
306
307 if (ConstantArray *CA = dyn_cast<ConstantArray>(C)) {
308 uint64_t EltSize = TD.getTypeAllocSize(CA->getType()->getElementType());
309 uint64_t Index = ByteOffset / EltSize;
310 uint64_t Offset = ByteOffset - Index * EltSize;
311 for (; Index != CA->getType()->getNumElements(); ++Index) {
312 if (!ReadDataFromGlobal(CA->getOperand(Index), Offset, CurPtr,
313 BytesLeft, TD))
314 return false;
315 if (EltSize >= BytesLeft)
316 return true;
317
318 Offset = 0;
319 BytesLeft -= EltSize;
320 CurPtr += EltSize;
321 }
322 return true;
323 }
324
325 if (ConstantVector *CV = dyn_cast<ConstantVector>(C)) {
326 uint64_t EltSize = TD.getTypeAllocSize(CV->getType()->getElementType());
327 uint64_t Index = ByteOffset / EltSize;
328 uint64_t Offset = ByteOffset - Index * EltSize;
329 for (; Index != CV->getType()->getNumElements(); ++Index) {
330 if (!ReadDataFromGlobal(CV->getOperand(Index), Offset, CurPtr,
331 BytesLeft, TD))
332 return false;
333 if (EltSize >= BytesLeft)
334 return true;
335
336 Offset = 0;
337 BytesLeft -= EltSize;
338 CurPtr += EltSize;
339 }
340 return true;
341 }
342
Anders Carlsson6475d942011-02-06 20:11:56 +0000343 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Anders Carlsson5d43ff42011-02-06 20:22:49 +0000344 if (CE->getOpcode() == Instruction::IntToPtr &&
345 CE->getOperand(0)->getType() == TD.getIntPtrType(CE->getContext()))
Anders Carlsson6475d942011-02-06 20:11:56 +0000346 return ReadDataFromGlobal(CE->getOperand(0), ByteOffset, CurPtr,
347 BytesLeft, TD);
Anders Carlsson6475d942011-02-06 20:11:56 +0000348 }
349
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000350 // Otherwise, unknown initializer type.
351 return false;
352}
353
354static Constant *FoldReinterpretLoadFromConstPtr(Constant *C,
355 const TargetData &TD) {
Chris Lattner17f0cd32009-10-23 06:57:37 +0000356 const Type *LoadTy = cast<PointerType>(C->getType())->getElementType();
357 const IntegerType *IntType = dyn_cast<IntegerType>(LoadTy);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000358
359 // If this isn't an integer load we can't fold it directly.
360 if (!IntType) {
361 // If this is a float/double load, we can try folding it as an int32/64 load
Chris Lattner17f0cd32009-10-23 06:57:37 +0000362 // and then bitcast the result. This can be useful for union cases. Note
363 // that address spaces don't matter here since we're not going to result in
364 // an actual new load.
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000365 const Type *MapTy;
Chris Lattner17f0cd32009-10-23 06:57:37 +0000366 if (LoadTy->isFloatTy())
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000367 MapTy = Type::getInt32PtrTy(C->getContext());
Chris Lattner17f0cd32009-10-23 06:57:37 +0000368 else if (LoadTy->isDoubleTy())
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000369 MapTy = Type::getInt64PtrTy(C->getContext());
Duncan Sands1df98592010-02-16 11:11:14 +0000370 else if (LoadTy->isVectorTy()) {
Chris Lattner17f0cd32009-10-23 06:57:37 +0000371 MapTy = IntegerType::get(C->getContext(),
372 TD.getTypeAllocSizeInBits(LoadTy));
373 MapTy = PointerType::getUnqual(MapTy);
374 } else
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000375 return 0;
376
Chris Lattner6333c392009-10-25 06:08:26 +0000377 C = FoldBitCast(C, MapTy, TD);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000378 if (Constant *Res = FoldReinterpretLoadFromConstPtr(C, TD))
Chris Lattner6333c392009-10-25 06:08:26 +0000379 return FoldBitCast(Res, LoadTy, TD);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000380 return 0;
381 }
382
383 unsigned BytesLoaded = (IntType->getBitWidth() + 7) / 8;
Chris Lattner739208a2009-10-23 06:50:36 +0000384 if (BytesLoaded > 32 || BytesLoaded == 0) return 0;
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000385
386 GlobalValue *GVal;
387 int64_t Offset;
388 if (!IsConstantOffsetFromGlobal(C, GVal, Offset, TD))
389 return 0;
390
391 GlobalVariable *GV = dyn_cast<GlobalVariable>(GVal);
Chris Lattnerc7b13822009-10-24 05:27:19 +0000392 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000393 !GV->getInitializer()->getType()->isSized())
394 return 0;
395
396 // If we're loading off the beginning of the global, some bytes may be valid,
397 // but we don't try to handle this.
398 if (Offset < 0) return 0;
399
400 // If we're not accessing anything in this constant, the result is undefined.
401 if (uint64_t(Offset) >= TD.getTypeAllocSize(GV->getInitializer()->getType()))
402 return UndefValue::get(IntType);
403
Chris Lattner739208a2009-10-23 06:50:36 +0000404 unsigned char RawBytes[32] = {0};
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000405 if (!ReadDataFromGlobal(GV->getInitializer(), Offset, RawBytes,
406 BytesLoaded, TD))
407 return 0;
408
Chris Lattnerb31189f2010-01-08 19:02:23 +0000409 APInt ResultVal = APInt(IntType->getBitWidth(), RawBytes[BytesLoaded-1]);
410 for (unsigned i = 1; i != BytesLoaded; ++i) {
Chris Lattner739208a2009-10-23 06:50:36 +0000411 ResultVal <<= 8;
Dan Gohmance800512010-04-12 02:22:30 +0000412 ResultVal |= RawBytes[BytesLoaded-1-i];
Chris Lattner739208a2009-10-23 06:50:36 +0000413 }
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000414
Chris Lattner739208a2009-10-23 06:50:36 +0000415 return ConstantInt::get(IntType->getContext(), ResultVal);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000416}
417
Chris Lattner878e4942009-10-22 06:25:11 +0000418/// ConstantFoldLoadFromConstPtr - Return the value that a load from C would
419/// produce if it is constant and determinable. If this is not determinable,
420/// return null.
421Constant *llvm::ConstantFoldLoadFromConstPtr(Constant *C,
422 const TargetData *TD) {
423 // First, try the easy cases:
424 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
425 if (GV->isConstant() && GV->hasDefinitiveInitializer())
426 return GV->getInitializer();
427
Chris Lattnere00c43f2009-10-22 06:44:07 +0000428 // If the loaded value isn't a constant expr, we can't handle it.
429 ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
430 if (!CE) return 0;
431
432 if (CE->getOpcode() == Instruction::GetElementPtr) {
433 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(CE->getOperand(0)))
434 if (GV->isConstant() && GV->hasDefinitiveInitializer())
435 if (Constant *V =
436 ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE))
437 return V;
438 }
439
440 // Instead of loading constant c string, use corresponding integer value
441 // directly if string length is small enough.
442 std::string Str;
Chris Lattner44a7a382009-12-04 06:29:29 +0000443 if (TD && GetConstantStringInfo(CE, Str) && !Str.empty()) {
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000444 unsigned StrLen = Str.length();
Chris Lattnere00c43f2009-10-22 06:44:07 +0000445 const Type *Ty = cast<PointerType>(CE->getType())->getElementType();
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000446 unsigned NumBits = Ty->getPrimitiveSizeInBits();
Chris Lattnereae28952010-07-12 00:22:51 +0000447 // Replace load with immediate integer if the result is an integer or fp
448 // value.
449 if ((NumBits >> 3) == StrLen + 1 && (NumBits & 7) == 0 &&
Chandler Carruth490b8f52010-07-12 06:47:05 +0000450 (isa<IntegerType>(Ty) || Ty->isFloatingPointTy())) {
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000451 APInt StrVal(NumBits, 0);
452 APInt SingleChar(NumBits, 0);
Chris Lattnere00c43f2009-10-22 06:44:07 +0000453 if (TD->isLittleEndian()) {
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000454 for (signed i = StrLen-1; i >= 0; i--) {
Chris Lattnere00c43f2009-10-22 06:44:07 +0000455 SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
Chris Lattner62d327e2009-10-22 06:38:35 +0000456 StrVal = (StrVal << 8) | SingleChar;
457 }
Chris Lattnere00c43f2009-10-22 06:44:07 +0000458 } else {
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000459 for (unsigned i = 0; i < StrLen; i++) {
Chris Lattnere00c43f2009-10-22 06:44:07 +0000460 SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
461 StrVal = (StrVal << 8) | SingleChar;
462 }
463 // Append NULL at the end.
464 SingleChar = 0;
465 StrVal = (StrVal << 8) | SingleChar;
Chris Lattner62d327e2009-10-22 06:38:35 +0000466 }
Chris Lattnereae28952010-07-12 00:22:51 +0000467
468 Constant *Res = ConstantInt::get(CE->getContext(), StrVal);
469 if (Ty->isFloatingPointTy())
470 Res = ConstantExpr::getBitCast(Res, Ty);
471 return Res;
Chris Lattner62d327e2009-10-22 06:38:35 +0000472 }
Chris Lattner878e4942009-10-22 06:25:11 +0000473 }
Chris Lattnere00c43f2009-10-22 06:44:07 +0000474
475 // If this load comes from anywhere in a constant global, and if the global
476 // is all undef or zero, we know what it loads.
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000477 if (GlobalVariable *GV =
478 dyn_cast<GlobalVariable>(GetUnderlyingObject(CE, TD))) {
Chris Lattnere00c43f2009-10-22 06:44:07 +0000479 if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
480 const Type *ResTy = cast<PointerType>(C->getType())->getElementType();
481 if (GV->getInitializer()->isNullValue())
482 return Constant::getNullValue(ResTy);
483 if (isa<UndefValue>(GV->getInitializer()))
484 return UndefValue::get(ResTy);
485 }
486 }
487
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000488 // Try hard to fold loads from bitcasted strange and non-type-safe things. We
489 // currently don't do any of this for big endian systems. It can be
490 // generalized in the future if someone is interested.
491 if (TD && TD->isLittleEndian())
492 return FoldReinterpretLoadFromConstPtr(CE, *TD);
Chris Lattner878e4942009-10-22 06:25:11 +0000493 return 0;
494}
495
496static Constant *ConstantFoldLoadInst(const LoadInst *LI, const TargetData *TD){
497 if (LI->isVolatile()) return 0;
498
499 if (Constant *C = dyn_cast<Constant>(LI->getOperand(0)))
500 return ConstantFoldLoadFromConstPtr(C, TD);
Chris Lattnerfe8c7c82009-10-23 06:23:49 +0000501
Chris Lattner878e4942009-10-22 06:25:11 +0000502 return 0;
503}
Chris Lattner03dd25c2007-01-31 00:51:48 +0000504
505/// SymbolicallyEvaluateBinop - One of Op0/Op1 is a constant expression.
Nick Lewycky67e35662008-12-15 01:35:36 +0000506/// Attempt to symbolically evaluate the result of a binary operator merging
Chris Lattner03dd25c2007-01-31 00:51:48 +0000507/// these together. If target data info is available, it is provided as TD,
508/// otherwise TD is null.
509static Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0,
Chris Lattner7b550cc2009-11-06 04:27:31 +0000510 Constant *Op1, const TargetData *TD){
Chris Lattner03dd25c2007-01-31 00:51:48 +0000511 // SROA
512
513 // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
514 // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
515 // bits.
516
517
518 // If the constant expr is something like &A[123] - &A[4].f, fold this into a
519 // constant. This happens frequently when iterating over a global array.
520 if (Opc == Instruction::Sub && TD) {
521 GlobalValue *GV1, *GV2;
522 int64_t Offs1, Offs2;
523
524 if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, *TD))
525 if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, *TD) &&
526 GV1 == GV2) {
527 // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
Owen Andersoneed707b2009-07-24 23:12:02 +0000528 return ConstantInt::get(Op0->getType(), Offs1-Offs2);
Chris Lattner03dd25c2007-01-31 00:51:48 +0000529 }
530 }
531
Chris Lattner03dd25c2007-01-31 00:51:48 +0000532 return 0;
533}
534
Dan Gohman4f8eea82010-02-01 18:27:38 +0000535/// CastGEPIndices - If array indices are not pointer-sized integers,
536/// explicitly cast them so that they aren't implicitly casted by the
537/// getelementptr.
538static Constant *CastGEPIndices(Constant *const *Ops, unsigned NumOps,
539 const Type *ResultTy,
540 const TargetData *TD) {
541 if (!TD) return 0;
542 const Type *IntPtrTy = TD->getIntPtrType(ResultTy->getContext());
543
544 bool Any = false;
545 SmallVector<Constant*, 32> NewIdxs;
546 for (unsigned i = 1; i != NumOps; ++i) {
547 if ((i == 1 ||
548 !isa<StructType>(GetElementPtrInst::getIndexedType(Ops[0]->getType(),
Chris Lattnerc1da2042010-11-21 08:39:01 +0000549 reinterpret_cast<Value *const *>(Ops+1),
Dan Gohman4f8eea82010-02-01 18:27:38 +0000550 i-1))) &&
551 Ops[i]->getType() != IntPtrTy) {
552 Any = true;
553 NewIdxs.push_back(ConstantExpr::getCast(CastInst::getCastOpcode(Ops[i],
554 true,
555 IntPtrTy,
556 true),
557 Ops[i], IntPtrTy));
558 } else
559 NewIdxs.push_back(Ops[i]);
560 }
561 if (!Any) return 0;
562
563 Constant *C =
564 ConstantExpr::getGetElementPtr(Ops[0], &NewIdxs[0], NewIdxs.size());
565 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
566 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
567 C = Folded;
568 return C;
569}
570
Chris Lattner03dd25c2007-01-31 00:51:48 +0000571/// SymbolicallyEvaluateGEP - If we can symbolically evaluate the specified GEP
572/// constant expression, do so.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000573static Constant *SymbolicallyEvaluateGEP(Constant *const *Ops, unsigned NumOps,
Chris Lattner03dd25c2007-01-31 00:51:48 +0000574 const Type *ResultTy,
575 const TargetData *TD) {
576 Constant *Ptr = Ops[0];
Chris Lattner268e7d72008-05-08 04:54:43 +0000577 if (!TD || !cast<PointerType>(Ptr->getType())->getElementType()->isSized())
Chris Lattner03dd25c2007-01-31 00:51:48 +0000578 return 0;
Chris Lattnerf1cadf22011-01-06 22:24:29 +0000579
580 const Type *IntPtrTy = TD->getIntPtrType(Ptr->getContext());
Chris Lattner268e7d72008-05-08 04:54:43 +0000581
582 // If this is a constant expr gep that is effectively computing an
583 // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
584 for (unsigned i = 1; i != NumOps; ++i)
Chris Lattner8cd4efb2011-01-06 06:19:46 +0000585 if (!isa<ConstantInt>(Ops[i])) {
586
587 // If this is "gep i8* Ptr, (sub 0, V)", fold this as:
588 // "inttoptr (sub (ptrtoint Ptr), V)"
589 if (NumOps == 2 &&
590 cast<PointerType>(ResultTy)->getElementType()->isIntegerTy(8)) {
591 ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[1]);
Chris Lattner156eb0a2011-01-16 03:43:53 +0000592 assert((CE == 0 || CE->getType() == IntPtrTy) &&
Chris Lattnerf1cadf22011-01-06 22:24:29 +0000593 "CastGEPIndices didn't canonicalize index types!");
Chris Lattner8cd4efb2011-01-06 06:19:46 +0000594 if (CE && CE->getOpcode() == Instruction::Sub &&
Chris Lattnerf1cadf22011-01-06 22:24:29 +0000595 CE->getOperand(0)->isNullValue()) {
Chris Lattner8cd4efb2011-01-06 06:19:46 +0000596 Constant *Res = ConstantExpr::getPtrToInt(Ptr, CE->getType());
597 Res = ConstantExpr::getSub(Res, CE->getOperand(1));
598 Res = ConstantExpr::getIntToPtr(Res, ResultTy);
599 if (ConstantExpr *ResCE = dyn_cast<ConstantExpr>(Res))
600 Res = ConstantFoldConstantExpression(ResCE, TD);
601 return Res;
602 }
603 }
Dan Gohmande0e5872009-08-19 18:18:36 +0000604 return 0;
Chris Lattner8cd4efb2011-01-06 06:19:46 +0000605 }
Chris Lattner268e7d72008-05-08 04:54:43 +0000606
Chris Lattnerf1cadf22011-01-06 22:24:29 +0000607 unsigned BitWidth = TD->getTypeSizeInBits(IntPtrTy);
Dan Gohmancda97062009-08-21 16:52:54 +0000608 APInt Offset = APInt(BitWidth,
609 TD->getIndexedOffset(Ptr->getType(),
610 (Value**)Ops+1, NumOps-1));
Duncan Sands890edda2010-03-12 17:55:20 +0000611 Ptr = cast<Constant>(Ptr->stripPointerCasts());
Dan Gohman0891d752010-03-10 19:31:51 +0000612
613 // If this is a GEP of a GEP, fold it all into a single GEP.
614 while (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
615 SmallVector<Value *, 4> NestedOps(GEP->op_begin()+1, GEP->op_end());
Duncan Sands890edda2010-03-12 17:55:20 +0000616
617 // Do not try the incorporate the sub-GEP if some index is not a number.
618 bool AllConstantInt = true;
619 for (unsigned i = 0, e = NestedOps.size(); i != e; ++i)
620 if (!isa<ConstantInt>(NestedOps[i])) {
621 AllConstantInt = false;
622 break;
623 }
624 if (!AllConstantInt)
625 break;
626
Dan Gohman0891d752010-03-10 19:31:51 +0000627 Ptr = cast<Constant>(GEP->getOperand(0));
628 Offset += APInt(BitWidth,
629 TD->getIndexedOffset(Ptr->getType(),
630 (Value**)NestedOps.data(),
631 NestedOps.size()));
Duncan Sands890edda2010-03-12 17:55:20 +0000632 Ptr = cast<Constant>(Ptr->stripPointerCasts());
Dan Gohman0891d752010-03-10 19:31:51 +0000633 }
634
Dan Gohmande0e5872009-08-19 18:18:36 +0000635 // If the base value for this address is a literal integer value, fold the
636 // getelementptr to the resulting integer value casted to the pointer type.
Dan Gohman40b037e2010-03-18 19:34:33 +0000637 APInt BasePtr(BitWidth, 0);
638 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
639 if (CE->getOpcode() == Instruction::IntToPtr)
Jay Foad40f8f622010-12-07 08:25:19 +0000640 if (ConstantInt *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
641 BasePtr = Base->getValue().zextOrTrunc(BitWidth);
Dan Gohman40b037e2010-03-18 19:34:33 +0000642 if (Ptr->isNullValue() || BasePtr != 0) {
Chris Lattner7b550cc2009-11-06 04:27:31 +0000643 Constant *C = ConstantInt::get(Ptr->getContext(), Offset+BasePtr);
Dan Gohmande0e5872009-08-19 18:18:36 +0000644 return ConstantExpr::getIntToPtr(C, ResultTy);
645 }
646
647 // Otherwise form a regular getelementptr. Recompute the indices so that
648 // we eliminate over-indexing of the notional static type array bounds.
649 // This makes it easy to determine if the getelementptr is "inbounds".
650 // Also, this helps GlobalOpt do SROA on GlobalVariables.
651 const Type *Ty = Ptr->getType();
652 SmallVector<Constant*, 32> NewIdxs;
Dan Gohman3d013342009-08-19 22:46:59 +0000653 do {
Dan Gohmande0e5872009-08-19 18:18:36 +0000654 if (const SequentialType *ATy = dyn_cast<SequentialType>(Ty)) {
Duncan Sands1df98592010-02-16 11:11:14 +0000655 if (ATy->isPointerTy()) {
Chris Lattnere568fa22009-12-03 01:05:45 +0000656 // The only pointer indexing we'll do is on the first index of the GEP.
657 if (!NewIdxs.empty())
658 break;
659
660 // Only handle pointers to sized types, not pointers to functions.
661 if (!ATy->getElementType()->isSized())
662 return 0;
663 }
664
Dan Gohmande0e5872009-08-19 18:18:36 +0000665 // Determine which element of the array the offset points into.
Dan Gohmancda97062009-08-21 16:52:54 +0000666 APInt ElemSize(BitWidth, TD->getTypeAllocSize(ATy->getElementType()));
Chris Lattnerc1da2042010-11-21 08:39:01 +0000667 const IntegerType *IntPtrTy = TD->getIntPtrType(Ty->getContext());
Dan Gohmande0e5872009-08-19 18:18:36 +0000668 if (ElemSize == 0)
Chris Lattnerc1da2042010-11-21 08:39:01 +0000669 // The element size is 0. This may be [0 x Ty]*, so just use a zero
Duncan Sandse5839102010-11-21 12:43:13 +0000670 // index for this level and proceed to the next level to see if it can
671 // accommodate the offset.
Chris Lattnerc1da2042010-11-21 08:39:01 +0000672 NewIdxs.push_back(ConstantInt::get(IntPtrTy, 0));
673 else {
674 // The element size is non-zero divide the offset by the element
675 // size (rounding down), to compute the index at this level.
676 APInt NewIdx = Offset.udiv(ElemSize);
677 Offset -= NewIdx * ElemSize;
678 NewIdxs.push_back(ConstantInt::get(IntPtrTy, NewIdx));
679 }
Dan Gohmande0e5872009-08-19 18:18:36 +0000680 Ty = ATy->getElementType();
681 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
Dan Gohmancda97062009-08-21 16:52:54 +0000682 // Determine which field of the struct the offset points into. The
683 // getZExtValue is at least as safe as the StructLayout API because we
684 // know the offset is within the struct at this point.
Dan Gohmande0e5872009-08-19 18:18:36 +0000685 const StructLayout &SL = *TD->getStructLayout(STy);
Dan Gohmancda97062009-08-21 16:52:54 +0000686 unsigned ElIdx = SL.getElementContainingOffset(Offset.getZExtValue());
Chris Lattner7b550cc2009-11-06 04:27:31 +0000687 NewIdxs.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
688 ElIdx));
Dan Gohmancda97062009-08-21 16:52:54 +0000689 Offset -= APInt(BitWidth, SL.getElementOffset(ElIdx));
Dan Gohmande0e5872009-08-19 18:18:36 +0000690 Ty = STy->getTypeAtIndex(ElIdx);
691 } else {
Dan Gohman3d013342009-08-19 22:46:59 +0000692 // We've reached some non-indexable type.
693 break;
Dan Gohmande0e5872009-08-19 18:18:36 +0000694 }
Dan Gohman3d013342009-08-19 22:46:59 +0000695 } while (Ty != cast<PointerType>(ResultTy)->getElementType());
696
697 // If we haven't used up the entire offset by descending the static
698 // type, then the offset is pointing into the middle of an indivisible
699 // member, so we can't simplify it.
700 if (Offset != 0)
701 return 0;
Dan Gohmande0e5872009-08-19 18:18:36 +0000702
Dan Gohman3bfbc452009-09-11 00:04:14 +0000703 // Create a GEP.
704 Constant *C =
Dan Gohman6e7ad952009-09-03 23:34:49 +0000705 ConstantExpr::getGetElementPtr(Ptr, &NewIdxs[0], NewIdxs.size());
706 assert(cast<PointerType>(C->getType())->getElementType() == Ty &&
707 "Computed GetElementPtr has unexpected type!");
Dan Gohmande0e5872009-08-19 18:18:36 +0000708
Dan Gohman3d013342009-08-19 22:46:59 +0000709 // If we ended up indexing a member with a type that doesn't match
Dan Gohman4c0d5d52009-08-20 16:42:55 +0000710 // the type of what the original indices indexed, add a cast.
Dan Gohman3d013342009-08-19 22:46:59 +0000711 if (Ty != cast<PointerType>(ResultTy)->getElementType())
Chris Lattner6333c392009-10-25 06:08:26 +0000712 C = FoldBitCast(C, ResultTy, *TD);
Dan Gohman3d013342009-08-19 22:46:59 +0000713
714 return C;
Chris Lattner03dd25c2007-01-31 00:51:48 +0000715}
716
Chris Lattner1afab9c2007-12-11 07:29:44 +0000717
Chris Lattner03dd25c2007-01-31 00:51:48 +0000718
719//===----------------------------------------------------------------------===//
720// Constant Folding public APIs
721//===----------------------------------------------------------------------===//
722
Duncan Sandsb9b369f2010-11-23 10:16:18 +0000723/// ConstantFoldInstruction - Try to constant fold the specified instruction.
724/// If successful, the constant result is returned, if not, null is returned.
725/// Note that this fails if not all of the operands are constant. Otherwise,
726/// this function can only fail when attempting to fold instructions like loads
727/// and stores, which have no constant expression form.
Chris Lattner7b550cc2009-11-06 04:27:31 +0000728Constant *llvm::ConstantFoldInstruction(Instruction *I, const TargetData *TD) {
Duncan Sandsb9b369f2010-11-23 10:16:18 +0000729 // Handle PHI nodes quickly here...
Chris Lattner55207322007-01-30 23:45:45 +0000730 if (PHINode *PN = dyn_cast<PHINode>(I)) {
Duncan Sandsc0362d52010-11-14 12:53:18 +0000731 Constant *CommonValue = 0;
John Criswellbd9d3702005-10-27 16:00:10 +0000732
Duncan Sandsc0362d52010-11-14 12:53:18 +0000733 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
734 Value *Incoming = PN->getIncomingValue(i);
Duncan Sandsb9b369f2010-11-23 10:16:18 +0000735 // If the incoming value is undef then skip it. Note that while we could
736 // skip the value if it is equal to the phi node itself we choose not to
737 // because that would break the rule that constant folding only applies if
738 // all operands are constants.
739 if (isa<UndefValue>(Incoming))
Duncan Sandsc0362d52010-11-14 12:53:18 +0000740 continue;
741 // If the incoming value is not a constant, or is a different constant to
742 // the one we saw previously, then give up.
743 Constant *C = dyn_cast<Constant>(Incoming);
744 if (!C || (CommonValue && C != CommonValue))
745 return 0;
746 CommonValue = C;
747 }
Chris Lattner55207322007-01-30 23:45:45 +0000748
Duncan Sandsc0362d52010-11-14 12:53:18 +0000749 // If we reach here, all incoming values are the same constant or undef.
750 return CommonValue ? CommonValue : UndefValue::get(PN->getType());
Chris Lattner55207322007-01-30 23:45:45 +0000751 }
752
753 // Scan the operand list, checking to see if they are all constants, if so,
754 // hand off to ConstantFoldInstOperands.
755 SmallVector<Constant*, 8> Ops;
Gabor Greifde2d74b2008-05-22 06:43:33 +0000756 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
757 if (Constant *Op = dyn_cast<Constant>(*i))
Chris Lattner55207322007-01-30 23:45:45 +0000758 Ops.push_back(Op);
759 else
760 return 0; // All operands not constant!
761
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000762 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
Chris Lattner8f73dea2009-11-09 23:06:58 +0000763 return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
764 TD);
Chris Lattner58665d42009-09-16 00:08:07 +0000765
Chris Lattner878e4942009-10-22 06:25:11 +0000766 if (const LoadInst *LI = dyn_cast<LoadInst>(I))
767 return ConstantFoldLoadInst(LI, TD);
Frits van Bommel3ee0af32010-11-29 20:36:52 +0000768
769 if (InsertValueInst *IVI = dyn_cast<InsertValueInst>(I))
770 return ConstantExpr::getInsertValue(
771 cast<Constant>(IVI->getAggregateOperand()),
772 cast<Constant>(IVI->getInsertedValueOperand()),
773 IVI->idx_begin(), IVI->getNumIndices());
774
775 if (ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(I))
776 return ConstantExpr::getExtractValue(
777 cast<Constant>(EVI->getAggregateOperand()),
778 EVI->idx_begin(), EVI->getNumIndices());
779
Chris Lattner58665d42009-09-16 00:08:07 +0000780 return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
Chris Lattner7b550cc2009-11-06 04:27:31 +0000781 Ops.data(), Ops.size(), TD);
Chris Lattner55207322007-01-30 23:45:45 +0000782}
783
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000784/// ConstantFoldConstantExpression - Attempt to fold the constant expression
785/// using the specified TargetData. If successful, the constant result is
786/// result is returned, if not, null is returned.
Dan Gohmanbaf0c672010-02-08 22:00:06 +0000787Constant *llvm::ConstantFoldConstantExpression(const ConstantExpr *CE,
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000788 const TargetData *TD) {
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000789 SmallVector<Constant*, 8> Ops;
Chris Lattnerc1da2042010-11-21 08:39:01 +0000790 for (User::const_op_iterator i = CE->op_begin(), e = CE->op_end();
791 i != e; ++i) {
Dan Gohman01b97dd2009-11-23 16:22:21 +0000792 Constant *NewC = cast<Constant>(*i);
793 // Recursively fold the ConstantExpr's operands.
794 if (ConstantExpr *NewCE = dyn_cast<ConstantExpr>(NewC))
795 NewC = ConstantFoldConstantExpression(NewCE, TD);
796 Ops.push_back(NewC);
797 }
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000798
799 if (CE->isCompare())
Chris Lattner8f73dea2009-11-09 23:06:58 +0000800 return ConstantFoldCompareInstOperands(CE->getPredicate(), Ops[0], Ops[1],
801 TD);
Chris Lattner58665d42009-09-16 00:08:07 +0000802 return ConstantFoldInstOperands(CE->getOpcode(), CE->getType(),
Chris Lattner7b550cc2009-11-06 04:27:31 +0000803 Ops.data(), Ops.size(), TD);
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000804}
805
Chris Lattner55207322007-01-30 23:45:45 +0000806/// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
807/// specified opcode and operands. If successful, the constant result is
808/// returned, if not, null is returned. Note that this function can fail when
809/// attempting to fold instructions like loads and stores, which have no
810/// constant expression form.
811///
Dan Gohman01b97dd2009-11-23 16:22:21 +0000812/// TODO: This function neither utilizes nor preserves nsw/nuw/inbounds/etc
813/// information, due to only being passed an opcode and operands. Constant
814/// folding using this function strips this information.
815///
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000816Constant *llvm::ConstantFoldInstOperands(unsigned Opcode, const Type *DestTy,
817 Constant* const* Ops, unsigned NumOps,
Chris Lattner55207322007-01-30 23:45:45 +0000818 const TargetData *TD) {
Chris Lattner03dd25c2007-01-31 00:51:48 +0000819 // Handle easy binops first.
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000820 if (Instruction::isBinaryOp(Opcode)) {
Chris Lattner03dd25c2007-01-31 00:51:48 +0000821 if (isa<ConstantExpr>(Ops[0]) || isa<ConstantExpr>(Ops[1]))
Chris Lattner7b550cc2009-11-06 04:27:31 +0000822 if (Constant *C = SymbolicallyEvaluateBinop(Opcode, Ops[0], Ops[1], TD))
Chris Lattner03dd25c2007-01-31 00:51:48 +0000823 return C;
824
Owen Andersonbaf3c402009-07-29 18:55:55 +0000825 return ConstantExpr::get(Opcode, Ops[0], Ops[1]);
Chris Lattner03dd25c2007-01-31 00:51:48 +0000826 }
Chris Lattner55207322007-01-30 23:45:45 +0000827
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000828 switch (Opcode) {
Chris Lattner55207322007-01-30 23:45:45 +0000829 default: return 0;
Chris Lattner79fa3cf2010-01-02 01:22:23 +0000830 case Instruction::ICmp:
831 case Instruction::FCmp: assert(0 && "Invalid for compares");
Chris Lattner55207322007-01-30 23:45:45 +0000832 case Instruction::Call:
Gabor Greifa6aac4c2010-07-16 09:38:02 +0000833 if (Function *F = dyn_cast<Function>(Ops[NumOps - 1]))
Chris Lattner55207322007-01-30 23:45:45 +0000834 if (canConstantFoldCallTo(F))
Gabor Greifa6aac4c2010-07-16 09:38:02 +0000835 return ConstantFoldCall(F, Ops, NumOps - 1);
Chris Lattner55207322007-01-30 23:45:45 +0000836 return 0;
Chris Lattner001f7532007-08-11 23:49:01 +0000837 case Instruction::PtrToInt:
838 // If the input is a inttoptr, eliminate the pair. This requires knowing
839 // the width of a pointer, so it can't be done in ConstantExpr::getCast.
840 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
841 if (TD && CE->getOpcode() == Instruction::IntToPtr) {
842 Constant *Input = CE->getOperand(0);
Dan Gohman6de29f82009-06-15 22:12:54 +0000843 unsigned InWidth = Input->getType()->getScalarSizeInBits();
Nick Lewycky04aa2c32008-10-24 06:14:27 +0000844 if (TD->getPointerSizeInBits() < InWidth) {
845 Constant *Mask =
Chris Lattner7b550cc2009-11-06 04:27:31 +0000846 ConstantInt::get(CE->getContext(), APInt::getLowBitsSet(InWidth,
Nick Lewycky04aa2c32008-10-24 06:14:27 +0000847 TD->getPointerSizeInBits()));
Owen Andersonbaf3c402009-07-29 18:55:55 +0000848 Input = ConstantExpr::getAnd(Input, Mask);
Nick Lewycky04aa2c32008-10-24 06:14:27 +0000849 }
Chris Lattner001f7532007-08-11 23:49:01 +0000850 // Do a zext or trunc to get to the dest size.
Owen Andersonbaf3c402009-07-29 18:55:55 +0000851 return ConstantExpr::getIntegerCast(Input, DestTy, false);
Chris Lattner001f7532007-08-11 23:49:01 +0000852 }
853 }
Owen Andersonbaf3c402009-07-29 18:55:55 +0000854 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
Chris Lattner001f7532007-08-11 23:49:01 +0000855 case Instruction::IntToPtr:
Duncan Sands81b06be2008-08-13 20:20:35 +0000856 // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
857 // the int size is >= the ptr size. This requires knowing the width of a
858 // pointer, so it can't be done in ConstantExpr::getCast.
Dan Gohmanb80a2a62010-02-23 16:35:41 +0000859 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0]))
Dan Gohman9a38e3e2009-05-07 19:46:24 +0000860 if (TD &&
Dan Gohmanb80a2a62010-02-23 16:35:41 +0000861 TD->getPointerSizeInBits() <= CE->getType()->getScalarSizeInBits() &&
862 CE->getOpcode() == Instruction::PtrToInt)
863 return FoldBitCast(CE->getOperand(0), DestTy, *TD);
864
Owen Andersonbaf3c402009-07-29 18:55:55 +0000865 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
Chris Lattner55207322007-01-30 23:45:45 +0000866 case Instruction::Trunc:
867 case Instruction::ZExt:
868 case Instruction::SExt:
869 case Instruction::FPTrunc:
870 case Instruction::FPExt:
871 case Instruction::UIToFP:
872 case Instruction::SIToFP:
873 case Instruction::FPToUI:
874 case Instruction::FPToSI:
Owen Andersonbaf3c402009-07-29 18:55:55 +0000875 return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
Chris Lattner55207322007-01-30 23:45:45 +0000876 case Instruction::BitCast:
Chris Lattner1afab9c2007-12-11 07:29:44 +0000877 if (TD)
Chris Lattner6333c392009-10-25 06:08:26 +0000878 return FoldBitCast(Ops[0], DestTy, *TD);
Owen Andersonbaf3c402009-07-29 18:55:55 +0000879 return ConstantExpr::getBitCast(Ops[0], DestTy);
Chris Lattner55207322007-01-30 23:45:45 +0000880 case Instruction::Select:
Owen Andersonbaf3c402009-07-29 18:55:55 +0000881 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
Chris Lattner55207322007-01-30 23:45:45 +0000882 case Instruction::ExtractElement:
Owen Andersonbaf3c402009-07-29 18:55:55 +0000883 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
Chris Lattner55207322007-01-30 23:45:45 +0000884 case Instruction::InsertElement:
Owen Andersonbaf3c402009-07-29 18:55:55 +0000885 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
Chris Lattner55207322007-01-30 23:45:45 +0000886 case Instruction::ShuffleVector:
Owen Andersonbaf3c402009-07-29 18:55:55 +0000887 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
Chris Lattner55207322007-01-30 23:45:45 +0000888 case Instruction::GetElementPtr:
Dan Gohman4f8eea82010-02-01 18:27:38 +0000889 if (Constant *C = CastGEPIndices(Ops, NumOps, DestTy, TD))
890 return C;
Chris Lattner7b550cc2009-11-06 04:27:31 +0000891 if (Constant *C = SymbolicallyEvaluateGEP(Ops, NumOps, DestTy, TD))
Chris Lattner03dd25c2007-01-31 00:51:48 +0000892 return C;
893
Owen Andersonbaf3c402009-07-29 18:55:55 +0000894 return ConstantExpr::getGetElementPtr(Ops[0], Ops+1, NumOps-1);
Chris Lattner55207322007-01-30 23:45:45 +0000895 }
896}
897
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000898/// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
899/// instruction (icmp/fcmp) with the specified operands. If it fails, it
900/// returns a constant expression of the specified operands.
901///
902Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
Chris Lattner8f73dea2009-11-09 23:06:58 +0000903 Constant *Ops0, Constant *Ops1,
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000904 const TargetData *TD) {
905 // fold: icmp (inttoptr x), null -> icmp x, 0
906 // fold: icmp (ptrtoint x), 0 -> icmp x, null
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000907 // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000908 // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
909 //
910 // ConstantExpr::getCompare cannot do this, because it doesn't have TD
911 // around to know if bit truncation is happening.
Chris Lattner8f73dea2009-11-09 23:06:58 +0000912 if (ConstantExpr *CE0 = dyn_cast<ConstantExpr>(Ops0)) {
913 if (TD && Ops1->isNullValue()) {
Chris Lattner7b550cc2009-11-06 04:27:31 +0000914 const Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000915 if (CE0->getOpcode() == Instruction::IntToPtr) {
916 // Convert the integer value to the right size to ensure we get the
917 // proper extension or truncation.
Owen Andersonbaf3c402009-07-29 18:55:55 +0000918 Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000919 IntPtrTy, false);
Chris Lattner8f73dea2009-11-09 23:06:58 +0000920 Constant *Null = Constant::getNullValue(C->getType());
921 return ConstantFoldCompareInstOperands(Predicate, C, Null, TD);
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000922 }
923
924 // Only do this transformation if the int is intptrty in size, otherwise
925 // there is a truncation or extension that we aren't modeling.
926 if (CE0->getOpcode() == Instruction::PtrToInt &&
927 CE0->getType() == IntPtrTy) {
928 Constant *C = CE0->getOperand(0);
Chris Lattner8f73dea2009-11-09 23:06:58 +0000929 Constant *Null = Constant::getNullValue(C->getType());
930 return ConstantFoldCompareInstOperands(Predicate, C, Null, TD);
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000931 }
932 }
933
Chris Lattner8f73dea2009-11-09 23:06:58 +0000934 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(Ops1)) {
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000935 if (TD && CE0->getOpcode() == CE1->getOpcode()) {
Chris Lattner7b550cc2009-11-06 04:27:31 +0000936 const Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000937
938 if (CE0->getOpcode() == Instruction::IntToPtr) {
939 // Convert the integer value to the right size to ensure we get the
940 // proper extension or truncation.
Owen Andersonbaf3c402009-07-29 18:55:55 +0000941 Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000942 IntPtrTy, false);
Owen Andersonbaf3c402009-07-29 18:55:55 +0000943 Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000944 IntPtrTy, false);
Chris Lattner8f73dea2009-11-09 23:06:58 +0000945 return ConstantFoldCompareInstOperands(Predicate, C0, C1, TD);
Nick Lewycky3dfd7bf2008-05-25 20:56:15 +0000946 }
947
948 // Only do this transformation if the int is intptrty in size, otherwise
949 // there is a truncation or extension that we aren't modeling.
950 if ((CE0->getOpcode() == Instruction::PtrToInt &&
951 CE0->getType() == IntPtrTy &&
Chris Lattner8f73dea2009-11-09 23:06:58 +0000952 CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType()))
953 return ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0),
954 CE1->getOperand(0), TD);
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000955 }
956 }
Chris Lattner79fa3cf2010-01-02 01:22:23 +0000957
958 // icmp eq (or x, y), 0 -> (icmp eq x, 0) & (icmp eq y, 0)
959 // icmp ne (or x, y), 0 -> (icmp ne x, 0) | (icmp ne y, 0)
960 if ((Predicate == ICmpInst::ICMP_EQ || Predicate == ICmpInst::ICMP_NE) &&
961 CE0->getOpcode() == Instruction::Or && Ops1->isNullValue()) {
962 Constant *LHS =
963 ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0), Ops1,TD);
964 Constant *RHS =
965 ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(1), Ops1,TD);
966 unsigned OpC =
967 Predicate == ICmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
968 Constant *Ops[] = { LHS, RHS };
969 return ConstantFoldInstOperands(OpC, LHS->getType(), Ops, 2, TD);
970 }
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000971 }
Chris Lattner8f73dea2009-11-09 23:06:58 +0000972
973 return ConstantExpr::getCompare(Predicate, Ops0, Ops1);
Chris Lattnerf286f6f2007-12-10 22:53:04 +0000974}
975
976
Chris Lattner55207322007-01-30 23:45:45 +0000977/// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
978/// getelementptr constantexpr, return the constant value being addressed by the
979/// constant expression, or null if something is funny and we can't decide.
980Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
Dan Gohmanc6f69e92009-10-05 16:36:26 +0000981 ConstantExpr *CE) {
Owen Andersona7235ea2009-07-31 20:28:14 +0000982 if (CE->getOperand(1) != Constant::getNullValue(CE->getOperand(1)->getType()))
Chris Lattner55207322007-01-30 23:45:45 +0000983 return 0; // Do not allow stepping over the value!
984
985 // Loop over all of the operands, tracking down which value we are
986 // addressing...
987 gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
988 for (++I; I != E; ++I)
989 if (const StructType *STy = dyn_cast<StructType>(*I)) {
990 ConstantInt *CU = cast<ConstantInt>(I.getOperand());
991 assert(CU->getZExtValue() < STy->getNumElements() &&
992 "Struct index out of range!");
993 unsigned El = (unsigned)CU->getZExtValue();
994 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
995 C = CS->getOperand(El);
996 } else if (isa<ConstantAggregateZero>(C)) {
Owen Andersona7235ea2009-07-31 20:28:14 +0000997 C = Constant::getNullValue(STy->getElementType(El));
Chris Lattner55207322007-01-30 23:45:45 +0000998 } else if (isa<UndefValue>(C)) {
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000999 C = UndefValue::get(STy->getElementType(El));
Chris Lattner55207322007-01-30 23:45:45 +00001000 } else {
1001 return 0;
1002 }
1003 } else if (ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand())) {
1004 if (const ArrayType *ATy = dyn_cast<ArrayType>(*I)) {
1005 if (CI->getZExtValue() >= ATy->getNumElements())
1006 return 0;
1007 if (ConstantArray *CA = dyn_cast<ConstantArray>(C))
1008 C = CA->getOperand(CI->getZExtValue());
1009 else if (isa<ConstantAggregateZero>(C))
Owen Andersona7235ea2009-07-31 20:28:14 +00001010 C = Constant::getNullValue(ATy->getElementType());
Chris Lattner55207322007-01-30 23:45:45 +00001011 else if (isa<UndefValue>(C))
Owen Anderson9e9a0d52009-07-30 23:03:37 +00001012 C = UndefValue::get(ATy->getElementType());
Chris Lattner55207322007-01-30 23:45:45 +00001013 else
1014 return 0;
Chris Lattner62d327e2009-10-22 06:38:35 +00001015 } else if (const VectorType *VTy = dyn_cast<VectorType>(*I)) {
1016 if (CI->getZExtValue() >= VTy->getNumElements())
Chris Lattner55207322007-01-30 23:45:45 +00001017 return 0;
Reid Spencer9d6565a2007-02-15 02:26:10 +00001018 if (ConstantVector *CP = dyn_cast<ConstantVector>(C))
Chris Lattner55207322007-01-30 23:45:45 +00001019 C = CP->getOperand(CI->getZExtValue());
1020 else if (isa<ConstantAggregateZero>(C))
Chris Lattner62d327e2009-10-22 06:38:35 +00001021 C = Constant::getNullValue(VTy->getElementType());
Chris Lattner55207322007-01-30 23:45:45 +00001022 else if (isa<UndefValue>(C))
Chris Lattner62d327e2009-10-22 06:38:35 +00001023 C = UndefValue::get(VTy->getElementType());
Chris Lattner55207322007-01-30 23:45:45 +00001024 else
1025 return 0;
1026 } else {
1027 return 0;
1028 }
1029 } else {
1030 return 0;
1031 }
1032 return C;
1033}
1034
1035
1036//===----------------------------------------------------------------------===//
1037// Constant Folding for Calls
1038//
John Criswellbd9d3702005-10-27 16:00:10 +00001039
1040/// canConstantFoldCallTo - Return true if its even possible to fold a call to
1041/// the specified function.
1042bool
Dan Gohmanfa9b80e2008-01-31 01:05:10 +00001043llvm::canConstantFoldCallTo(const Function *F) {
John Criswellbd9d3702005-10-27 16:00:10 +00001044 switch (F->getIntrinsicID()) {
Dale Johannesen9ab7fb32007-10-02 17:43:59 +00001045 case Intrinsic::sqrt:
1046 case Intrinsic::powi:
Reid Spencere9391fd2007-04-01 07:35:23 +00001047 case Intrinsic::bswap:
1048 case Intrinsic::ctpop:
1049 case Intrinsic::ctlz:
1050 case Intrinsic::cttz:
Chris Lattnere65cd402009-10-05 05:26:04 +00001051 case Intrinsic::uadd_with_overflow:
1052 case Intrinsic::usub_with_overflow:
Evan Phoenix1614e502009-10-05 22:53:52 +00001053 case Intrinsic::sadd_with_overflow:
1054 case Intrinsic::ssub_with_overflow:
Chris Lattnereafc5cb2010-10-14 00:05:07 +00001055 case Intrinsic::smul_with_overflow:
Anton Korobeynikovfaa75f6e2010-03-19 00:36:35 +00001056 case Intrinsic::convert_from_fp16:
1057 case Intrinsic::convert_to_fp16:
Chandler Carruth15ed90c2011-01-11 01:07:24 +00001058 case Intrinsic::x86_sse_cvtss2si:
1059 case Intrinsic::x86_sse_cvtss2si64:
1060 case Intrinsic::x86_sse_cvttss2si:
1061 case Intrinsic::x86_sse_cvttss2si64:
1062 case Intrinsic::x86_sse2_cvtsd2si:
1063 case Intrinsic::x86_sse2_cvtsd2si64:
1064 case Intrinsic::x86_sse2_cvttsd2si:
1065 case Intrinsic::x86_sse2_cvttsd2si64:
John Criswellbd9d3702005-10-27 16:00:10 +00001066 return true;
Chris Lattner68a06032009-10-05 05:00:35 +00001067 default:
1068 return false;
1069 case 0: break;
John Criswellbd9d3702005-10-27 16:00:10 +00001070 }
1071
Chris Lattner6f532a92009-04-03 00:02:39 +00001072 if (!F->hasName()) return false;
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001073 StringRef Name = F->getName();
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001074
1075 // In these cases, the check of the length is required. We don't want to
1076 // return true for a name like "cos\0blah" which strcmp would return equal to
1077 // "cos", but has length 8.
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001078 switch (Name[0]) {
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001079 default: return false;
1080 case 'a':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001081 return Name == "acos" || Name == "asin" ||
1082 Name == "atan" || Name == "atan2";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001083 case 'c':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001084 return Name == "cos" || Name == "ceil" || Name == "cosf" || Name == "cosh";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001085 case 'e':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001086 return Name == "exp";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001087 case 'f':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001088 return Name == "fabs" || Name == "fmod" || Name == "floor";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001089 case 'l':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001090 return Name == "log" || Name == "log10";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001091 case 'p':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001092 return Name == "pow";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001093 case 's':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001094 return Name == "sin" || Name == "sinh" || Name == "sqrt" ||
1095 Name == "sinf" || Name == "sqrtf";
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001096 case 't':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001097 return Name == "tan" || Name == "tanh";
John Criswellbd9d3702005-10-27 16:00:10 +00001098 }
1099}
1100
Chris Lattner72d88ae2007-01-30 23:15:43 +00001101static Constant *ConstantFoldFP(double (*NativeFP)(double), double V,
Chris Lattner7b550cc2009-11-06 04:27:31 +00001102 const Type *Ty) {
Dan Gohman3f2f21e2010-09-17 20:06:27 +00001103 sys::llvm_fenv_clearexcept();
John Criswellbd9d3702005-10-27 16:00:10 +00001104 V = NativeFP(V);
Dan Gohman3f2f21e2010-09-17 20:06:27 +00001105 if (sys::llvm_fenv_testexcept()) {
1106 sys::llvm_fenv_clearexcept();
Chris Lattnerf19f58a2008-03-30 18:02:00 +00001107 return 0;
Dale Johannesen43421b32007-09-06 18:13:44 +00001108 }
Chris Lattnerf19f58a2008-03-30 18:02:00 +00001109
Chris Lattnerd0806a12009-10-05 05:06:24 +00001110 if (Ty->isFloatTy())
Chris Lattner7b550cc2009-11-06 04:27:31 +00001111 return ConstantFP::get(Ty->getContext(), APFloat((float)V));
Chris Lattnerd0806a12009-10-05 05:06:24 +00001112 if (Ty->isDoubleTy())
Chris Lattner7b550cc2009-11-06 04:27:31 +00001113 return ConstantFP::get(Ty->getContext(), APFloat(V));
Torok Edwinc23197a2009-07-14 16:55:14 +00001114 llvm_unreachable("Can only constant fold float/double");
Gabor Greif33e456d2008-05-21 14:07:30 +00001115 return 0; // dummy return to suppress warning
John Criswellbd9d3702005-10-27 16:00:10 +00001116}
1117
Dan Gohman38415242007-07-16 15:26:22 +00001118static Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
Chris Lattner7b550cc2009-11-06 04:27:31 +00001119 double V, double W, const Type *Ty) {
Dan Gohman3f2f21e2010-09-17 20:06:27 +00001120 sys::llvm_fenv_clearexcept();
Dan Gohman38415242007-07-16 15:26:22 +00001121 V = NativeFP(V, W);
Dan Gohman3f2f21e2010-09-17 20:06:27 +00001122 if (sys::llvm_fenv_testexcept()) {
1123 sys::llvm_fenv_clearexcept();
Chris Lattnerf19f58a2008-03-30 18:02:00 +00001124 return 0;
Dale Johannesen43421b32007-09-06 18:13:44 +00001125 }
Chris Lattnerf19f58a2008-03-30 18:02:00 +00001126
Chris Lattnerd0806a12009-10-05 05:06:24 +00001127 if (Ty->isFloatTy())
Chris Lattner7b550cc2009-11-06 04:27:31 +00001128 return ConstantFP::get(Ty->getContext(), APFloat((float)V));
Chris Lattnerd0806a12009-10-05 05:06:24 +00001129 if (Ty->isDoubleTy())
Chris Lattner7b550cc2009-11-06 04:27:31 +00001130 return ConstantFP::get(Ty->getContext(), APFloat(V));
Torok Edwinc23197a2009-07-14 16:55:14 +00001131 llvm_unreachable("Can only constant fold float/double");
Gabor Greif33e456d2008-05-21 14:07:30 +00001132 return 0; // dummy return to suppress warning
Dan Gohman38415242007-07-16 15:26:22 +00001133}
1134
Chandler Carruth15ed90c2011-01-11 01:07:24 +00001135/// ConstantFoldConvertToInt - Attempt to an SSE floating point to integer
1136/// conversion of a constant floating point. If roundTowardZero is false, the
1137/// default IEEE rounding is used (toward nearest, ties to even). This matches
1138/// the behavior of the non-truncating SSE instructions in the default rounding
1139/// mode. The desired integer type Ty is used to select how many bits are
1140/// available for the result. Returns null if the conversion cannot be
1141/// performed, otherwise returns the Constant value resulting from the
1142/// conversion.
1143static Constant *ConstantFoldConvertToInt(ConstantFP *Op, bool roundTowardZero,
1144 const Type *Ty) {
1145 assert(Op && "Called with NULL operand");
1146 APFloat Val(Op->getValueAPF());
1147
1148 // All of these conversion intrinsics form an integer of at most 64bits.
1149 unsigned ResultWidth = cast<IntegerType>(Ty)->getBitWidth();
1150 assert(ResultWidth <= 64 &&
1151 "Can only constant fold conversions to 64 and 32 bit ints");
1152
1153 uint64_t UIntVal;
1154 bool isExact = false;
1155 APFloat::roundingMode mode = roundTowardZero? APFloat::rmTowardZero
1156 : APFloat::rmNearestTiesToEven;
1157 APFloat::opStatus status = Val.convertToInteger(&UIntVal, ResultWidth,
1158 /*isSigned=*/true, mode,
1159 &isExact);
1160 if (status != APFloat::opOK && status != APFloat::opInexact)
1161 return 0;
1162 return ConstantInt::get(Ty, UIntVal, /*isSigned=*/true);
1163}
1164
John Criswellbd9d3702005-10-27 16:00:10 +00001165/// ConstantFoldCall - Attempt to constant fold a call to the specified function
1166/// with the specified arguments, returning null if unsuccessful.
1167Constant *
Chris Lattnerf286f6f2007-12-10 22:53:04 +00001168llvm::ConstantFoldCall(Function *F,
Chris Lattner68a06032009-10-05 05:00:35 +00001169 Constant *const *Operands, unsigned NumOperands) {
Chris Lattner6f532a92009-04-03 00:02:39 +00001170 if (!F->hasName()) return 0;
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001171 StringRef Name = F->getName();
Chris Lattnere65cd402009-10-05 05:26:04 +00001172
John Criswellbd9d3702005-10-27 16:00:10 +00001173 const Type *Ty = F->getReturnType();
Chris Lattner72d88ae2007-01-30 23:15:43 +00001174 if (NumOperands == 1) {
John Criswellbd9d3702005-10-27 16:00:10 +00001175 if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
Chandler Carruthf4db8772011-01-10 09:02:58 +00001176 if (F->getIntrinsicID() == Intrinsic::convert_to_fp16) {
Anton Korobeynikovfaa75f6e2010-03-19 00:36:35 +00001177 APFloat Val(Op->getValueAPF());
1178
1179 bool lost = false;
1180 Val.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &lost);
1181
1182 return ConstantInt::get(F->getContext(), Val.bitcastToAPInt());
1183 }
1184
Chris Lattnerd0806a12009-10-05 05:06:24 +00001185 if (!Ty->isFloatTy() && !Ty->isDoubleTy())
Dale Johannesen43421b32007-09-06 18:13:44 +00001186 return 0;
Jakob Stoklund Olesen1f386c42010-09-27 21:29:20 +00001187
1188 /// We only fold functions with finite arguments. Folding NaN and inf is
1189 /// likely to be aborted with an exception anyway, and some host libms
1190 /// have known errors raising exceptions.
1191 if (Op->getValueAPF().isNaN() || Op->getValueAPF().isInfinity())
1192 return 0;
1193
Dale Johannesen43421b32007-09-06 18:13:44 +00001194 /// Currently APFloat versions of these functions do not exist, so we use
1195 /// the host native double versions. Float versions are not called
1196 /// directly but for all these it is true (float)(f((double)arg)) ==
1197 /// f(arg). Long double not supported yet.
Chris Lattnerd0806a12009-10-05 05:06:24 +00001198 double V = Ty->isFloatTy() ? (double)Op->getValueAPF().convertToFloat() :
Dale Johannesen43421b32007-09-06 18:13:44 +00001199 Op->getValueAPF().convertToDouble();
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001200 switch (Name[0]) {
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001201 case 'a':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001202 if (Name == "acos")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001203 return ConstantFoldFP(acos, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001204 else if (Name == "asin")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001205 return ConstantFoldFP(asin, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001206 else if (Name == "atan")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001207 return ConstantFoldFP(atan, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001208 break;
1209 case 'c':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001210 if (Name == "ceil")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001211 return ConstantFoldFP(ceil, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001212 else if (Name == "cos")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001213 return ConstantFoldFP(cos, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001214 else if (Name == "cosh")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001215 return ConstantFoldFP(cosh, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001216 else if (Name == "cosf")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001217 return ConstantFoldFP(cos, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001218 break;
1219 case 'e':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001220 if (Name == "exp")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001221 return ConstantFoldFP(exp, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001222 break;
1223 case 'f':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001224 if (Name == "fabs")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001225 return ConstantFoldFP(fabs, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001226 else if (Name == "floor")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001227 return ConstantFoldFP(floor, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001228 break;
1229 case 'l':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001230 if (Name == "log" && V > 0)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001231 return ConstantFoldFP(log, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001232 else if (Name == "log10" && V > 0)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001233 return ConstantFoldFP(log10, V, Ty);
Chandler Carruthf4db8772011-01-10 09:02:58 +00001234 else if (F->getIntrinsicID() == Intrinsic::sqrt &&
1235 (Ty->isFloatTy() || Ty->isDoubleTy())) {
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001236 if (V >= -0.0)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001237 return ConstantFoldFP(sqrt, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001238 else // Undefined
Owen Andersona7235ea2009-07-31 20:28:14 +00001239 return Constant::getNullValue(Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001240 }
1241 break;
1242 case 's':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001243 if (Name == "sin")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001244 return ConstantFoldFP(sin, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001245 else if (Name == "sinh")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001246 return ConstantFoldFP(sinh, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001247 else if (Name == "sqrt" && V >= 0)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001248 return ConstantFoldFP(sqrt, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001249 else if (Name == "sqrtf" && V >= 0)
Chris Lattner7b550cc2009-11-06 04:27:31 +00001250 return ConstantFoldFP(sqrt, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001251 else if (Name == "sinf")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001252 return ConstantFoldFP(sin, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001253 break;
1254 case 't':
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001255 if (Name == "tan")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001256 return ConstantFoldFP(tan, V, Ty);
Daniel Dunbarf0443c12009-07-26 08:34:35 +00001257 else if (Name == "tanh")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001258 return ConstantFoldFP(tanh, V, Ty);
Chris Lattnerc5f6a1f2007-08-08 06:55:43 +00001259 break;
1260 default:
1261 break;
John Criswellbd9d3702005-10-27 16:00:10 +00001262 }
Chris Lattner68a06032009-10-05 05:00:35 +00001263 return 0;
1264 }
Chandler Carruthf4db8772011-01-10 09:02:58 +00001265
Chris Lattner68a06032009-10-05 05:00:35 +00001266 if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
Chandler Carruthf4db8772011-01-10 09:02:58 +00001267 switch (F->getIntrinsicID()) {
1268 case Intrinsic::bswap:
Chris Lattner7b550cc2009-11-06 04:27:31 +00001269 return ConstantInt::get(F->getContext(), Op->getValue().byteSwap());
Chandler Carruthf4db8772011-01-10 09:02:58 +00001270 case Intrinsic::ctpop:
Owen Andersoneed707b2009-07-24 23:12:02 +00001271 return ConstantInt::get(Ty, Op->getValue().countPopulation());
Chandler Carruthf4db8772011-01-10 09:02:58 +00001272 case Intrinsic::cttz:
Owen Andersoneed707b2009-07-24 23:12:02 +00001273 return ConstantInt::get(Ty, Op->getValue().countTrailingZeros());
Chandler Carruthf4db8772011-01-10 09:02:58 +00001274 case Intrinsic::ctlz:
Owen Andersoneed707b2009-07-24 23:12:02 +00001275 return ConstantInt::get(Ty, Op->getValue().countLeadingZeros());
Chandler Carruthf4db8772011-01-10 09:02:58 +00001276 case Intrinsic::convert_from_fp16: {
Anton Korobeynikovfaa75f6e2010-03-19 00:36:35 +00001277 APFloat Val(Op->getValue());
1278
1279 bool lost = false;
1280 APFloat::opStatus status =
1281 Val.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &lost);
1282
1283 // Conversion is always precise.
Jeffrey Yasskin8e68c382010-12-23 00:58:24 +00001284 (void)status;
Anton Korobeynikovfaa75f6e2010-03-19 00:36:35 +00001285 assert(status == APFloat::opOK && !lost &&
1286 "Precision lost during fp16 constfolding");
1287
1288 return ConstantFP::get(F->getContext(), Val);
1289 }
Chandler Carruthf4db8772011-01-10 09:02:58 +00001290 default:
1291 return 0;
1292 }
John Criswellbd9d3702005-10-27 16:00:10 +00001293 }
Chandler Carruthf4db8772011-01-10 09:02:58 +00001294
Chandler Carruth15ed90c2011-01-11 01:07:24 +00001295 if (ConstantVector *Op = dyn_cast<ConstantVector>(Operands[0])) {
1296 switch (F->getIntrinsicID()) {
1297 default: break;
1298 case Intrinsic::x86_sse_cvtss2si:
1299 case Intrinsic::x86_sse_cvtss2si64:
1300 case Intrinsic::x86_sse2_cvtsd2si:
1301 case Intrinsic::x86_sse2_cvtsd2si64:
1302 if (ConstantFP *FPOp = dyn_cast<ConstantFP>(Op->getOperand(0)))
1303 return ConstantFoldConvertToInt(FPOp, /*roundTowardZero=*/false, Ty);
1304 case Intrinsic::x86_sse_cvttss2si:
1305 case Intrinsic::x86_sse_cvttss2si64:
1306 case Intrinsic::x86_sse2_cvttsd2si:
1307 case Intrinsic::x86_sse2_cvttsd2si64:
1308 if (ConstantFP *FPOp = dyn_cast<ConstantFP>(Op->getOperand(0)))
1309 return ConstantFoldConvertToInt(FPOp, /*roundTowardZero=*/true, Ty);
1310 }
1311 }
1312
Dan Gohman9ee71232010-02-17 00:54:58 +00001313 if (isa<UndefValue>(Operands[0])) {
Chandler Carruthf4db8772011-01-10 09:02:58 +00001314 if (F->getIntrinsicID() == Intrinsic::bswap)
Dan Gohman9ee71232010-02-17 00:54:58 +00001315 return Operands[0];
1316 return 0;
1317 }
1318
Chris Lattner68a06032009-10-05 05:00:35 +00001319 return 0;
1320 }
Chandler Carruthf4db8772011-01-10 09:02:58 +00001321
Chris Lattner68a06032009-10-05 05:00:35 +00001322 if (NumOperands == 2) {
John Criswellbd9d3702005-10-27 16:00:10 +00001323 if (ConstantFP *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
Chris Lattnerd0806a12009-10-05 05:06:24 +00001324 if (!Ty->isFloatTy() && !Ty->isDoubleTy())
Dale Johannesen9ab7fb32007-10-02 17:43:59 +00001325 return 0;
Chris Lattnerd0806a12009-10-05 05:06:24 +00001326 double Op1V = Ty->isFloatTy() ?
1327 (double)Op1->getValueAPF().convertToFloat() :
Dale Johannesen43421b32007-09-06 18:13:44 +00001328 Op1->getValueAPF().convertToDouble();
John Criswellbd9d3702005-10-27 16:00:10 +00001329 if (ConstantFP *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
Chris Lattnerd0806a12009-10-05 05:06:24 +00001330 if (Op2->getType() != Op1->getType())
1331 return 0;
1332
1333 double Op2V = Ty->isFloatTy() ?
Dale Johannesen43421b32007-09-06 18:13:44 +00001334 (double)Op2->getValueAPF().convertToFloat():
1335 Op2->getValueAPF().convertToDouble();
John Criswellbd9d3702005-10-27 16:00:10 +00001336
Chris Lattner68a06032009-10-05 05:00:35 +00001337 if (Name == "pow")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001338 return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
Chris Lattner68a06032009-10-05 05:00:35 +00001339 if (Name == "fmod")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001340 return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
Chris Lattner68a06032009-10-05 05:00:35 +00001341 if (Name == "atan2")
Chris Lattner7b550cc2009-11-06 04:27:31 +00001342 return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
Chris Lattnerb5282dc2007-01-15 06:27:37 +00001343 } else if (ConstantInt *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
Chandler Carruthf4db8772011-01-10 09:02:58 +00001344 if (F->getIntrinsicID() == Intrinsic::powi && Ty->isFloatTy())
Chris Lattner7b550cc2009-11-06 04:27:31 +00001345 return ConstantFP::get(F->getContext(),
1346 APFloat((float)std::pow((float)Op1V,
Chris Lattner02a260a2008-04-20 00:41:09 +00001347 (int)Op2C->getZExtValue())));
Chandler Carruthf4db8772011-01-10 09:02:58 +00001348 if (F->getIntrinsicID() == Intrinsic::powi && Ty->isDoubleTy())
Chris Lattner7b550cc2009-11-06 04:27:31 +00001349 return ConstantFP::get(F->getContext(),
1350 APFloat((double)std::pow((double)Op1V,
1351 (int)Op2C->getZExtValue())));
John Criswellbd9d3702005-10-27 16:00:10 +00001352 }
Chris Lattner68a06032009-10-05 05:00:35 +00001353 return 0;
John Criswellbd9d3702005-10-27 16:00:10 +00001354 }
Chris Lattnere65cd402009-10-05 05:26:04 +00001355
1356
1357 if (ConstantInt *Op1 = dyn_cast<ConstantInt>(Operands[0])) {
1358 if (ConstantInt *Op2 = dyn_cast<ConstantInt>(Operands[1])) {
1359 switch (F->getIntrinsicID()) {
1360 default: break;
Chris Lattnereafc5cb2010-10-14 00:05:07 +00001361 case Intrinsic::sadd_with_overflow:
1362 case Intrinsic::uadd_with_overflow:
1363 case Intrinsic::ssub_with_overflow:
1364 case Intrinsic::usub_with_overflow:
1365 case Intrinsic::smul_with_overflow: {
1366 APInt Res;
1367 bool Overflow;
1368 switch (F->getIntrinsicID()) {
1369 default: assert(0 && "Invalid case");
1370 case Intrinsic::sadd_with_overflow:
1371 Res = Op1->getValue().sadd_ov(Op2->getValue(), Overflow);
1372 break;
1373 case Intrinsic::uadd_with_overflow:
1374 Res = Op1->getValue().uadd_ov(Op2->getValue(), Overflow);
1375 break;
1376 case Intrinsic::ssub_with_overflow:
1377 Res = Op1->getValue().ssub_ov(Op2->getValue(), Overflow);
1378 break;
1379 case Intrinsic::usub_with_overflow:
1380 Res = Op1->getValue().usub_ov(Op2->getValue(), Overflow);
1381 break;
1382 case Intrinsic::smul_with_overflow:
1383 Res = Op1->getValue().smul_ov(Op2->getValue(), Overflow);
1384 break;
1385 }
Chris Lattnere65cd402009-10-05 05:26:04 +00001386 Constant *Ops[] = {
Chris Lattnereafc5cb2010-10-14 00:05:07 +00001387 ConstantInt::get(F->getContext(), Res),
1388 ConstantInt::get(Type::getInt1Ty(F->getContext()), Overflow)
Chris Lattnere65cd402009-10-05 05:26:04 +00001389 };
1390 return ConstantStruct::get(F->getContext(), Ops, 2, false);
1391 }
Chris Lattnere65cd402009-10-05 05:26:04 +00001392 }
1393 }
1394
1395 return 0;
1396 }
1397 return 0;
John Criswellbd9d3702005-10-27 16:00:10 +00001398 }
1399 return 0;
1400}