ConstantFolding.cpp revision 1f6efa3996dd1929fbc129203ce5009b620e6969
1//===-- ConstantFolding.cpp - Fold instructions into constants ------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// 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.
16//
17//===----------------------------------------------------------------------===//
18
19#include "llvm/Analysis/ConstantFolding.h"
20#include "llvm/Constants.h"
21#include "llvm/DerivedTypes.h"
22#include "llvm/Function.h"
23#include "llvm/GlobalVariable.h"
24#include "llvm/Instructions.h"
25#include "llvm/Intrinsics.h"
26#include "llvm/Analysis/ValueTracking.h"
27#include "llvm/Target/TargetData.h"
28#include "llvm/ADT/SmallVector.h"
29#include "llvm/ADT/StringMap.h"
30#include "llvm/Support/ErrorHandling.h"
31#include "llvm/Support/GetElementPtrTypeIterator.h"
32#include "llvm/Support/MathExtras.h"
33#include "llvm/Support/FEnv.h"
34#include <cerrno>
35#include <cmath>
36using namespace llvm;
37
38//===----------------------------------------------------------------------===//
39// Constant Folding internal helper functions
40//===----------------------------------------------------------------------===//
41
42/// 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) {
47
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!
57    return FoldBitCast(ConstantVector::get(&Ops, 1), DestTy, TD);
58  }
59
60  // 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
65  // 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.
84  if (DstEltTy->isFloatingPointTy()) {
85    // 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.
99  if (SrcEltTy->isFloatingPointTy()) {
100    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
170  return ConstantVector::get(Result.data(), Result.size());
171}
172
173
174/// 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.
198    if (!cast<PointerType>(CE->getOperand(0)->getType())
199                 ->getElementType()->isSized())
200      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);
208    for (User::const_op_iterator i = CE->op_begin() + 1, e = CE->op_end();
209         i != e; ++i, ++GTI) {
210      ConstantInt *CI = dyn_cast<ConstantInt>(*i);
211      if (!CI) return false;  // Index isn't a simple constant?
212      if (CI->isZero()) continue;  // Not adding anything.
213
214      if (const StructType *ST = dyn_cast<StructType>(*GTI)) {
215        // N = N + Offset
216        Offset += TD.getStructLayout(ST)->getElementOffset(CI->getZExtValue());
217      } else {
218        const SequentialType *SQT = cast<SequentialType>(*GTI);
219        Offset += TD.getTypeAllocSize(SQT->getElementType())*CI->getSExtValue();
220      }
221    }
222    return true;
223  }
224
225  return false;
226}
227
228/// 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
238  // If this element is zero or undefined, we can just return since *CurPtr is
239  // zero initialized.
240  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) {
252      CurPtr[i] = (unsigned char)(Val >> (ByteOffset * 8));
253      ++ByteOffset;
254    }
255    return true;
256  }
257
258  if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
259    if (CFP->getType()->isDoubleTy()) {
260      C = FoldBitCast(C, Type::getInt64Ty(C->getContext()), TD);
261      return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
262    }
263    if (CFP->getType()->isFloatTy()){
264      C = FoldBitCast(C, Type::getInt32Ty(C->getContext()), TD);
265      return ReadDataFromGlobal(C, ByteOffset, CurPtr, BytesLeft, TD);
266    }
267    return false;
268  }
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.
299      CurPtr += NextEltOffset-CurEltOffset-ByteOffset;
300      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
343  // Otherwise, unknown initializer type.
344  return false;
345}
346
347static Constant *FoldReinterpretLoadFromConstPtr(Constant *C,
348                                                 const TargetData &TD) {
349  const Type *LoadTy = cast<PointerType>(C->getType())->getElementType();
350  const IntegerType *IntType = dyn_cast<IntegerType>(LoadTy);
351
352  // If this isn't an integer load we can't fold it directly.
353  if (!IntType) {
354    // If this is a float/double load, we can try folding it as an int32/64 load
355    // and then bitcast the result.  This can be useful for union cases.  Note
356    // that address spaces don't matter here since we're not going to result in
357    // an actual new load.
358    const Type *MapTy;
359    if (LoadTy->isFloatTy())
360      MapTy = Type::getInt32PtrTy(C->getContext());
361    else if (LoadTy->isDoubleTy())
362      MapTy = Type::getInt64PtrTy(C->getContext());
363    else if (LoadTy->isVectorTy()) {
364      MapTy = IntegerType::get(C->getContext(),
365                               TD.getTypeAllocSizeInBits(LoadTy));
366      MapTy = PointerType::getUnqual(MapTy);
367    } else
368      return 0;
369
370    C = FoldBitCast(C, MapTy, TD);
371    if (Constant *Res = FoldReinterpretLoadFromConstPtr(C, TD))
372      return FoldBitCast(Res, LoadTy, TD);
373    return 0;
374  }
375
376  unsigned BytesLoaded = (IntType->getBitWidth() + 7) / 8;
377  if (BytesLoaded > 32 || BytesLoaded == 0) return 0;
378
379  GlobalValue *GVal;
380  int64_t Offset;
381  if (!IsConstantOffsetFromGlobal(C, GVal, Offset, TD))
382    return 0;
383
384  GlobalVariable *GV = dyn_cast<GlobalVariable>(GVal);
385  if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
386      !GV->getInitializer()->getType()->isSized())
387    return 0;
388
389  // If we're loading off the beginning of the global, some bytes may be valid,
390  // but we don't try to handle this.
391  if (Offset < 0) return 0;
392
393  // If we're not accessing anything in this constant, the result is undefined.
394  if (uint64_t(Offset) >= TD.getTypeAllocSize(GV->getInitializer()->getType()))
395    return UndefValue::get(IntType);
396
397  unsigned char RawBytes[32] = {0};
398  if (!ReadDataFromGlobal(GV->getInitializer(), Offset, RawBytes,
399                          BytesLoaded, TD))
400    return 0;
401
402  APInt ResultVal = APInt(IntType->getBitWidth(), RawBytes[BytesLoaded-1]);
403  for (unsigned i = 1; i != BytesLoaded; ++i) {
404    ResultVal <<= 8;
405    ResultVal |= RawBytes[BytesLoaded-1-i];
406  }
407
408  return ConstantInt::get(IntType->getContext(), ResultVal);
409}
410
411/// ConstantFoldLoadFromConstPtr - Return the value that a load from C would
412/// produce if it is constant and determinable.  If this is not determinable,
413/// return null.
414Constant *llvm::ConstantFoldLoadFromConstPtr(Constant *C,
415                                             const TargetData *TD) {
416  // First, try the easy cases:
417  if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
418    if (GV->isConstant() && GV->hasDefinitiveInitializer())
419      return GV->getInitializer();
420
421  // If the loaded value isn't a constant expr, we can't handle it.
422  ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
423  if (!CE) return 0;
424
425  if (CE->getOpcode() == Instruction::GetElementPtr) {
426    if (GlobalVariable *GV = dyn_cast<GlobalVariable>(CE->getOperand(0)))
427      if (GV->isConstant() && GV->hasDefinitiveInitializer())
428        if (Constant *V =
429             ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE))
430          return V;
431  }
432
433  // Instead of loading constant c string, use corresponding integer value
434  // directly if string length is small enough.
435  std::string Str;
436  if (TD && GetConstantStringInfo(CE, Str) && !Str.empty()) {
437    unsigned StrLen = Str.length();
438    const Type *Ty = cast<PointerType>(CE->getType())->getElementType();
439    unsigned NumBits = Ty->getPrimitiveSizeInBits();
440    // Replace load with immediate integer if the result is an integer or fp
441    // value.
442    if ((NumBits >> 3) == StrLen + 1 && (NumBits & 7) == 0 &&
443        (isa<IntegerType>(Ty) || Ty->isFloatingPointTy())) {
444      APInt StrVal(NumBits, 0);
445      APInt SingleChar(NumBits, 0);
446      if (TD->isLittleEndian()) {
447        for (signed i = StrLen-1; i >= 0; i--) {
448          SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
449          StrVal = (StrVal << 8) | SingleChar;
450        }
451      } else {
452        for (unsigned i = 0; i < StrLen; i++) {
453          SingleChar = (uint64_t) Str[i] & UCHAR_MAX;
454          StrVal = (StrVal << 8) | SingleChar;
455        }
456        // Append NULL at the end.
457        SingleChar = 0;
458        StrVal = (StrVal << 8) | SingleChar;
459      }
460
461      Constant *Res = ConstantInt::get(CE->getContext(), StrVal);
462      if (Ty->isFloatingPointTy())
463        Res = ConstantExpr::getBitCast(Res, Ty);
464      return Res;
465    }
466  }
467
468  // If this load comes from anywhere in a constant global, and if the global
469  // is all undef or zero, we know what it loads.
470  if (GlobalVariable *GV = dyn_cast<GlobalVariable>(CE->getUnderlyingObject())){
471    if (GV->isConstant() && GV->hasDefinitiveInitializer()) {
472      const Type *ResTy = cast<PointerType>(C->getType())->getElementType();
473      if (GV->getInitializer()->isNullValue())
474        return Constant::getNullValue(ResTy);
475      if (isa<UndefValue>(GV->getInitializer()))
476        return UndefValue::get(ResTy);
477    }
478  }
479
480  // Try hard to fold loads from bitcasted strange and non-type-safe things.  We
481  // currently don't do any of this for big endian systems.  It can be
482  // generalized in the future if someone is interested.
483  if (TD && TD->isLittleEndian())
484    return FoldReinterpretLoadFromConstPtr(CE, *TD);
485  return 0;
486}
487
488static Constant *ConstantFoldLoadInst(const LoadInst *LI, const TargetData *TD){
489  if (LI->isVolatile()) return 0;
490
491  if (Constant *C = dyn_cast<Constant>(LI->getOperand(0)))
492    return ConstantFoldLoadFromConstPtr(C, TD);
493
494  return 0;
495}
496
497/// SymbolicallyEvaluateBinop - One of Op0/Op1 is a constant expression.
498/// Attempt to symbolically evaluate the result of a binary operator merging
499/// these together.  If target data info is available, it is provided as TD,
500/// otherwise TD is null.
501static Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0,
502                                           Constant *Op1, const TargetData *TD){
503  // SROA
504
505  // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
506  // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
507  // bits.
508
509
510  // If the constant expr is something like &A[123] - &A[4].f, fold this into a
511  // constant.  This happens frequently when iterating over a global array.
512  if (Opc == Instruction::Sub && TD) {
513    GlobalValue *GV1, *GV2;
514    int64_t Offs1, Offs2;
515
516    if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, *TD))
517      if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, *TD) &&
518          GV1 == GV2) {
519        // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
520        return ConstantInt::get(Op0->getType(), Offs1-Offs2);
521      }
522  }
523
524  return 0;
525}
526
527/// CastGEPIndices - If array indices are not pointer-sized integers,
528/// explicitly cast them so that they aren't implicitly casted by the
529/// getelementptr.
530static Constant *CastGEPIndices(Constant *const *Ops, unsigned NumOps,
531                                const Type *ResultTy,
532                                const TargetData *TD) {
533  if (!TD) return 0;
534  const Type *IntPtrTy = TD->getIntPtrType(ResultTy->getContext());
535
536  bool Any = false;
537  SmallVector<Constant*, 32> NewIdxs;
538  for (unsigned i = 1; i != NumOps; ++i) {
539    if ((i == 1 ||
540         !isa<StructType>(GetElementPtrInst::getIndexedType(Ops[0]->getType(),
541                                        reinterpret_cast<Value *const *>(Ops+1),
542                                                            i-1))) &&
543        Ops[i]->getType() != IntPtrTy) {
544      Any = true;
545      NewIdxs.push_back(ConstantExpr::getCast(CastInst::getCastOpcode(Ops[i],
546                                                                      true,
547                                                                      IntPtrTy,
548                                                                      true),
549                                              Ops[i], IntPtrTy));
550    } else
551      NewIdxs.push_back(Ops[i]);
552  }
553  if (!Any) return 0;
554
555  Constant *C =
556    ConstantExpr::getGetElementPtr(Ops[0], &NewIdxs[0], NewIdxs.size());
557  if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
558    if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
559      C = Folded;
560  return C;
561}
562
563/// SymbolicallyEvaluateGEP - If we can symbolically evaluate the specified GEP
564/// constant expression, do so.
565static Constant *SymbolicallyEvaluateGEP(Constant *const *Ops, unsigned NumOps,
566                                         const Type *ResultTy,
567                                         const TargetData *TD) {
568  Constant *Ptr = Ops[0];
569  if (!TD || !cast<PointerType>(Ptr->getType())->getElementType()->isSized())
570    return 0;
571
572  unsigned BitWidth =
573    TD->getTypeSizeInBits(TD->getIntPtrType(Ptr->getContext()));
574
575  // If this is a constant expr gep that is effectively computing an
576  // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
577  for (unsigned i = 1; i != NumOps; ++i)
578    if (!isa<ConstantInt>(Ops[i]))
579      return 0;
580
581  APInt Offset = APInt(BitWidth,
582                       TD->getIndexedOffset(Ptr->getType(),
583                                            (Value**)Ops+1, NumOps-1));
584  Ptr = cast<Constant>(Ptr->stripPointerCasts());
585
586  // If this is a GEP of a GEP, fold it all into a single GEP.
587  while (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
588    SmallVector<Value *, 4> NestedOps(GEP->op_begin()+1, GEP->op_end());
589
590    // Do not try the incorporate the sub-GEP if some index is not a number.
591    bool AllConstantInt = true;
592    for (unsigned i = 0, e = NestedOps.size(); i != e; ++i)
593      if (!isa<ConstantInt>(NestedOps[i])) {
594        AllConstantInt = false;
595        break;
596      }
597    if (!AllConstantInt)
598      break;
599
600    Ptr = cast<Constant>(GEP->getOperand(0));
601    Offset += APInt(BitWidth,
602                    TD->getIndexedOffset(Ptr->getType(),
603                                         (Value**)NestedOps.data(),
604                                         NestedOps.size()));
605    Ptr = cast<Constant>(Ptr->stripPointerCasts());
606  }
607
608  // If the base value for this address is a literal integer value, fold the
609  // getelementptr to the resulting integer value casted to the pointer type.
610  APInt BasePtr(BitWidth, 0);
611  if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
612    if (CE->getOpcode() == Instruction::IntToPtr)
613      if (ConstantInt *Base = dyn_cast<ConstantInt>(CE->getOperand(0))) {
614        BasePtr = Base->getValue();
615        BasePtr.zextOrTrunc(BitWidth);
616      }
617  if (Ptr->isNullValue() || BasePtr != 0) {
618    Constant *C = ConstantInt::get(Ptr->getContext(), Offset+BasePtr);
619    return ConstantExpr::getIntToPtr(C, ResultTy);
620  }
621
622  // Otherwise form a regular getelementptr. Recompute the indices so that
623  // we eliminate over-indexing of the notional static type array bounds.
624  // This makes it easy to determine if the getelementptr is "inbounds".
625  // Also, this helps GlobalOpt do SROA on GlobalVariables.
626  const Type *Ty = Ptr->getType();
627  SmallVector<Constant*, 32> NewIdxs;
628  do {
629    if (const SequentialType *ATy = dyn_cast<SequentialType>(Ty)) {
630      if (ATy->isPointerTy()) {
631        // The only pointer indexing we'll do is on the first index of the GEP.
632        if (!NewIdxs.empty())
633          break;
634
635        // Only handle pointers to sized types, not pointers to functions.
636        if (!ATy->getElementType()->isSized())
637          return 0;
638      }
639
640      // Determine which element of the array the offset points into.
641      APInt ElemSize(BitWidth, TD->getTypeAllocSize(ATy->getElementType()));
642      const IntegerType *IntPtrTy = TD->getIntPtrType(Ty->getContext());
643      if (ElemSize == 0)
644        // The element size is 0. This may be [0 x Ty]*, so just use a zero
645        // index for this level and proceed to the next level to see if it can
646        // accommodate the offset.
647        NewIdxs.push_back(ConstantInt::get(IntPtrTy, 0));
648      else {
649        // The element size is non-zero divide the offset by the element
650        // size (rounding down), to compute the index at this level.
651        APInt NewIdx = Offset.udiv(ElemSize);
652        Offset -= NewIdx * ElemSize;
653        NewIdxs.push_back(ConstantInt::get(IntPtrTy, NewIdx));
654      }
655      Ty = ATy->getElementType();
656    } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
657      // Determine which field of the struct the offset points into. The
658      // getZExtValue is at least as safe as the StructLayout API because we
659      // know the offset is within the struct at this point.
660      const StructLayout &SL = *TD->getStructLayout(STy);
661      unsigned ElIdx = SL.getElementContainingOffset(Offset.getZExtValue());
662      NewIdxs.push_back(ConstantInt::get(Type::getInt32Ty(Ty->getContext()),
663                                         ElIdx));
664      Offset -= APInt(BitWidth, SL.getElementOffset(ElIdx));
665      Ty = STy->getTypeAtIndex(ElIdx);
666    } else {
667      // We've reached some non-indexable type.
668      break;
669    }
670  } while (Ty != cast<PointerType>(ResultTy)->getElementType());
671
672  // If we haven't used up the entire offset by descending the static
673  // type, then the offset is pointing into the middle of an indivisible
674  // member, so we can't simplify it.
675  if (Offset != 0)
676    return 0;
677
678  // Create a GEP.
679  Constant *C =
680    ConstantExpr::getGetElementPtr(Ptr, &NewIdxs[0], NewIdxs.size());
681  assert(cast<PointerType>(C->getType())->getElementType() == Ty &&
682         "Computed GetElementPtr has unexpected type!");
683
684  // If we ended up indexing a member with a type that doesn't match
685  // the type of what the original indices indexed, add a cast.
686  if (Ty != cast<PointerType>(ResultTy)->getElementType())
687    C = FoldBitCast(C, ResultTy, *TD);
688
689  return C;
690}
691
692
693
694//===----------------------------------------------------------------------===//
695// Constant Folding public APIs
696//===----------------------------------------------------------------------===//
697
698/// ConstantFoldInstruction - Try to constant fold the specified instruction.
699/// If successful, the constant result is returned, if not, null is returned.
700/// Note that this fails if not all of the operands are constant.  Otherwise,
701/// this function can only fail when attempting to fold instructions like loads
702/// and stores, which have no constant expression form.
703Constant *llvm::ConstantFoldInstruction(Instruction *I, const TargetData *TD) {
704  // Handle PHI nodes quickly here...
705  if (PHINode *PN = dyn_cast<PHINode>(I)) {
706    Constant *CommonValue = 0;
707
708    for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
709      Value *Incoming = PN->getIncomingValue(i);
710      // If the incoming value is undef then skip it.  Note that while we could
711      // skip the value if it is equal to the phi node itself we choose not to
712      // because that would break the rule that constant folding only applies if
713      // all operands are constants.
714      if (isa<UndefValue>(Incoming))
715        continue;
716      // If the incoming value is not a constant, or is a different constant to
717      // the one we saw previously, then give up.
718      Constant *C = dyn_cast<Constant>(Incoming);
719      if (!C || (CommonValue && C != CommonValue))
720        return 0;
721      CommonValue = C;
722    }
723
724    // If we reach here, all incoming values are the same constant or undef.
725    return CommonValue ? CommonValue : UndefValue::get(PN->getType());
726  }
727
728  // Scan the operand list, checking to see if they are all constants, if so,
729  // hand off to ConstantFoldInstOperands.
730  SmallVector<Constant*, 8> Ops;
731  for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
732    if (Constant *Op = dyn_cast<Constant>(*i))
733      Ops.push_back(Op);
734    else
735      return 0;  // All operands not constant!
736
737  if (const CmpInst *CI = dyn_cast<CmpInst>(I))
738    return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
739                                           TD);
740
741  if (const LoadInst *LI = dyn_cast<LoadInst>(I))
742    return ConstantFoldLoadInst(LI, TD);
743
744  return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
745                                  Ops.data(), Ops.size(), TD);
746}
747
748/// ConstantFoldConstantExpression - Attempt to fold the constant expression
749/// using the specified TargetData.  If successful, the constant result is
750/// result is returned, if not, null is returned.
751Constant *llvm::ConstantFoldConstantExpression(const ConstantExpr *CE,
752                                               const TargetData *TD) {
753  SmallVector<Constant*, 8> Ops;
754  for (User::const_op_iterator i = CE->op_begin(), e = CE->op_end();
755       i != e; ++i) {
756    Constant *NewC = cast<Constant>(*i);
757    // Recursively fold the ConstantExpr's operands.
758    if (ConstantExpr *NewCE = dyn_cast<ConstantExpr>(NewC))
759      NewC = ConstantFoldConstantExpression(NewCE, TD);
760    Ops.push_back(NewC);
761  }
762
763  if (CE->isCompare())
764    return ConstantFoldCompareInstOperands(CE->getPredicate(), Ops[0], Ops[1],
765                                           TD);
766  return ConstantFoldInstOperands(CE->getOpcode(), CE->getType(),
767                                  Ops.data(), Ops.size(), TD);
768}
769
770/// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
771/// specified opcode and operands.  If successful, the constant result is
772/// returned, if not, null is returned.  Note that this function can fail when
773/// attempting to fold instructions like loads and stores, which have no
774/// constant expression form.
775///
776/// TODO: This function neither utilizes nor preserves nsw/nuw/inbounds/etc
777/// information, due to only being passed an opcode and operands. Constant
778/// folding using this function strips this information.
779///
780Constant *llvm::ConstantFoldInstOperands(unsigned Opcode, const Type *DestTy,
781                                         Constant* const* Ops, unsigned NumOps,
782                                         const TargetData *TD) {
783  // Handle easy binops first.
784  if (Instruction::isBinaryOp(Opcode)) {
785    if (isa<ConstantExpr>(Ops[0]) || isa<ConstantExpr>(Ops[1]))
786      if (Constant *C = SymbolicallyEvaluateBinop(Opcode, Ops[0], Ops[1], TD))
787        return C;
788
789    return ConstantExpr::get(Opcode, Ops[0], Ops[1]);
790  }
791
792  switch (Opcode) {
793  default: return 0;
794  case Instruction::ICmp:
795  case Instruction::FCmp: assert(0 && "Invalid for compares");
796  case Instruction::Call:
797    if (Function *F = dyn_cast<Function>(Ops[NumOps - 1]))
798      if (canConstantFoldCallTo(F))
799        return ConstantFoldCall(F, Ops, NumOps - 1);
800    return 0;
801  case Instruction::PtrToInt:
802    // If the input is a inttoptr, eliminate the pair.  This requires knowing
803    // the width of a pointer, so it can't be done in ConstantExpr::getCast.
804    if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
805      if (TD && CE->getOpcode() == Instruction::IntToPtr) {
806        Constant *Input = CE->getOperand(0);
807        unsigned InWidth = Input->getType()->getScalarSizeInBits();
808        if (TD->getPointerSizeInBits() < InWidth) {
809          Constant *Mask =
810            ConstantInt::get(CE->getContext(), APInt::getLowBitsSet(InWidth,
811                                                  TD->getPointerSizeInBits()));
812          Input = ConstantExpr::getAnd(Input, Mask);
813        }
814        // Do a zext or trunc to get to the dest size.
815        return ConstantExpr::getIntegerCast(Input, DestTy, false);
816      }
817    }
818    return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
819  case Instruction::IntToPtr:
820    // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
821    // the int size is >= the ptr size.  This requires knowing the width of a
822    // pointer, so it can't be done in ConstantExpr::getCast.
823    if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0]))
824      if (TD &&
825          TD->getPointerSizeInBits() <= CE->getType()->getScalarSizeInBits() &&
826          CE->getOpcode() == Instruction::PtrToInt)
827        return FoldBitCast(CE->getOperand(0), DestTy, *TD);
828
829    return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
830  case Instruction::Trunc:
831  case Instruction::ZExt:
832  case Instruction::SExt:
833  case Instruction::FPTrunc:
834  case Instruction::FPExt:
835  case Instruction::UIToFP:
836  case Instruction::SIToFP:
837  case Instruction::FPToUI:
838  case Instruction::FPToSI:
839      return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
840  case Instruction::BitCast:
841    if (TD)
842      return FoldBitCast(Ops[0], DestTy, *TD);
843    return ConstantExpr::getBitCast(Ops[0], DestTy);
844  case Instruction::Select:
845    return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
846  case Instruction::ExtractElement:
847    return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
848  case Instruction::InsertElement:
849    return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
850  case Instruction::ShuffleVector:
851    return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
852  case Instruction::GetElementPtr:
853    if (Constant *C = CastGEPIndices(Ops, NumOps, DestTy, TD))
854      return C;
855    if (Constant *C = SymbolicallyEvaluateGEP(Ops, NumOps, DestTy, TD))
856      return C;
857
858    return ConstantExpr::getGetElementPtr(Ops[0], Ops+1, NumOps-1);
859  }
860}
861
862/// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
863/// instruction (icmp/fcmp) with the specified operands.  If it fails, it
864/// returns a constant expression of the specified operands.
865///
866Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
867                                                Constant *Ops0, Constant *Ops1,
868                                                const TargetData *TD) {
869  // fold: icmp (inttoptr x), null         -> icmp x, 0
870  // fold: icmp (ptrtoint x), 0            -> icmp x, null
871  // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
872  // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
873  //
874  // ConstantExpr::getCompare cannot do this, because it doesn't have TD
875  // around to know if bit truncation is happening.
876  if (ConstantExpr *CE0 = dyn_cast<ConstantExpr>(Ops0)) {
877    if (TD && Ops1->isNullValue()) {
878      const Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
879      if (CE0->getOpcode() == Instruction::IntToPtr) {
880        // Convert the integer value to the right size to ensure we get the
881        // proper extension or truncation.
882        Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
883                                                   IntPtrTy, false);
884        Constant *Null = Constant::getNullValue(C->getType());
885        return ConstantFoldCompareInstOperands(Predicate, C, Null, TD);
886      }
887
888      // Only do this transformation if the int is intptrty in size, otherwise
889      // there is a truncation or extension that we aren't modeling.
890      if (CE0->getOpcode() == Instruction::PtrToInt &&
891          CE0->getType() == IntPtrTy) {
892        Constant *C = CE0->getOperand(0);
893        Constant *Null = Constant::getNullValue(C->getType());
894        return ConstantFoldCompareInstOperands(Predicate, C, Null, TD);
895      }
896    }
897
898    if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(Ops1)) {
899      if (TD && CE0->getOpcode() == CE1->getOpcode()) {
900        const Type *IntPtrTy = TD->getIntPtrType(CE0->getContext());
901
902        if (CE0->getOpcode() == Instruction::IntToPtr) {
903          // Convert the integer value to the right size to ensure we get the
904          // proper extension or truncation.
905          Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
906                                                      IntPtrTy, false);
907          Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
908                                                      IntPtrTy, false);
909          return ConstantFoldCompareInstOperands(Predicate, C0, C1, TD);
910        }
911
912        // Only do this transformation if the int is intptrty in size, otherwise
913        // there is a truncation or extension that we aren't modeling.
914        if ((CE0->getOpcode() == Instruction::PtrToInt &&
915             CE0->getType() == IntPtrTy &&
916             CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType()))
917          return ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0),
918                                                 CE1->getOperand(0), TD);
919      }
920    }
921
922    // icmp eq (or x, y), 0 -> (icmp eq x, 0) & (icmp eq y, 0)
923    // icmp ne (or x, y), 0 -> (icmp ne x, 0) | (icmp ne y, 0)
924    if ((Predicate == ICmpInst::ICMP_EQ || Predicate == ICmpInst::ICMP_NE) &&
925        CE0->getOpcode() == Instruction::Or && Ops1->isNullValue()) {
926      Constant *LHS =
927        ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(0), Ops1,TD);
928      Constant *RHS =
929        ConstantFoldCompareInstOperands(Predicate, CE0->getOperand(1), Ops1,TD);
930      unsigned OpC =
931        Predicate == ICmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
932      Constant *Ops[] = { LHS, RHS };
933      return ConstantFoldInstOperands(OpC, LHS->getType(), Ops, 2, TD);
934    }
935  }
936
937  return ConstantExpr::getCompare(Predicate, Ops0, Ops1);
938}
939
940
941/// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
942/// getelementptr constantexpr, return the constant value being addressed by the
943/// constant expression, or null if something is funny and we can't decide.
944Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
945                                                       ConstantExpr *CE) {
946  if (CE->getOperand(1) != Constant::getNullValue(CE->getOperand(1)->getType()))
947    return 0;  // Do not allow stepping over the value!
948
949  // Loop over all of the operands, tracking down which value we are
950  // addressing...
951  gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
952  for (++I; I != E; ++I)
953    if (const StructType *STy = dyn_cast<StructType>(*I)) {
954      ConstantInt *CU = cast<ConstantInt>(I.getOperand());
955      assert(CU->getZExtValue() < STy->getNumElements() &&
956             "Struct index out of range!");
957      unsigned El = (unsigned)CU->getZExtValue();
958      if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
959        C = CS->getOperand(El);
960      } else if (isa<ConstantAggregateZero>(C)) {
961        C = Constant::getNullValue(STy->getElementType(El));
962      } else if (isa<UndefValue>(C)) {
963        C = UndefValue::get(STy->getElementType(El));
964      } else {
965        return 0;
966      }
967    } else if (ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand())) {
968      if (const ArrayType *ATy = dyn_cast<ArrayType>(*I)) {
969        if (CI->getZExtValue() >= ATy->getNumElements())
970         return 0;
971        if (ConstantArray *CA = dyn_cast<ConstantArray>(C))
972          C = CA->getOperand(CI->getZExtValue());
973        else if (isa<ConstantAggregateZero>(C))
974          C = Constant::getNullValue(ATy->getElementType());
975        else if (isa<UndefValue>(C))
976          C = UndefValue::get(ATy->getElementType());
977        else
978          return 0;
979      } else if (const VectorType *VTy = dyn_cast<VectorType>(*I)) {
980        if (CI->getZExtValue() >= VTy->getNumElements())
981          return 0;
982        if (ConstantVector *CP = dyn_cast<ConstantVector>(C))
983          C = CP->getOperand(CI->getZExtValue());
984        else if (isa<ConstantAggregateZero>(C))
985          C = Constant::getNullValue(VTy->getElementType());
986        else if (isa<UndefValue>(C))
987          C = UndefValue::get(VTy->getElementType());
988        else
989          return 0;
990      } else {
991        return 0;
992      }
993    } else {
994      return 0;
995    }
996  return C;
997}
998
999
1000//===----------------------------------------------------------------------===//
1001//  Constant Folding for Calls
1002//
1003
1004/// canConstantFoldCallTo - Return true if its even possible to fold a call to
1005/// the specified function.
1006bool
1007llvm::canConstantFoldCallTo(const Function *F) {
1008  switch (F->getIntrinsicID()) {
1009  case Intrinsic::sqrt:
1010  case Intrinsic::powi:
1011  case Intrinsic::bswap:
1012  case Intrinsic::ctpop:
1013  case Intrinsic::ctlz:
1014  case Intrinsic::cttz:
1015  case Intrinsic::uadd_with_overflow:
1016  case Intrinsic::usub_with_overflow:
1017  case Intrinsic::sadd_with_overflow:
1018  case Intrinsic::ssub_with_overflow:
1019  case Intrinsic::smul_with_overflow:
1020  case Intrinsic::convert_from_fp16:
1021  case Intrinsic::convert_to_fp16:
1022    return true;
1023  default:
1024    return false;
1025  case 0: break;
1026  }
1027
1028  if (!F->hasName()) return false;
1029  StringRef Name = F->getName();
1030
1031  // In these cases, the check of the length is required.  We don't want to
1032  // return true for a name like "cos\0blah" which strcmp would return equal to
1033  // "cos", but has length 8.
1034  switch (Name[0]) {
1035  default: return false;
1036  case 'a':
1037    return Name == "acos" || Name == "asin" ||
1038      Name == "atan" || Name == "atan2";
1039  case 'c':
1040    return Name == "cos" || Name == "ceil" || Name == "cosf" || Name == "cosh";
1041  case 'e':
1042    return Name == "exp";
1043  case 'f':
1044    return Name == "fabs" || Name == "fmod" || Name == "floor";
1045  case 'l':
1046    return Name == "log" || Name == "log10";
1047  case 'p':
1048    return Name == "pow";
1049  case 's':
1050    return Name == "sin" || Name == "sinh" || Name == "sqrt" ||
1051      Name == "sinf" || Name == "sqrtf";
1052  case 't':
1053    return Name == "tan" || Name == "tanh";
1054  }
1055}
1056
1057static Constant *ConstantFoldFP(double (*NativeFP)(double), double V,
1058                                const Type *Ty) {
1059  sys::llvm_fenv_clearexcept();
1060  V = NativeFP(V);
1061  if (sys::llvm_fenv_testexcept()) {
1062    sys::llvm_fenv_clearexcept();
1063    return 0;
1064  }
1065
1066  if (Ty->isFloatTy())
1067    return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1068  if (Ty->isDoubleTy())
1069    return ConstantFP::get(Ty->getContext(), APFloat(V));
1070  llvm_unreachable("Can only constant fold float/double");
1071  return 0; // dummy return to suppress warning
1072}
1073
1074static Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
1075                                      double V, double W, const Type *Ty) {
1076  sys::llvm_fenv_clearexcept();
1077  V = NativeFP(V, W);
1078  if (sys::llvm_fenv_testexcept()) {
1079    sys::llvm_fenv_clearexcept();
1080    return 0;
1081  }
1082
1083  if (Ty->isFloatTy())
1084    return ConstantFP::get(Ty->getContext(), APFloat((float)V));
1085  if (Ty->isDoubleTy())
1086    return ConstantFP::get(Ty->getContext(), APFloat(V));
1087  llvm_unreachable("Can only constant fold float/double");
1088  return 0; // dummy return to suppress warning
1089}
1090
1091/// ConstantFoldCall - Attempt to constant fold a call to the specified function
1092/// with the specified arguments, returning null if unsuccessful.
1093Constant *
1094llvm::ConstantFoldCall(Function *F,
1095                       Constant *const *Operands, unsigned NumOperands) {
1096  if (!F->hasName()) return 0;
1097  StringRef Name = F->getName();
1098
1099  const Type *Ty = F->getReturnType();
1100  if (NumOperands == 1) {
1101    if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
1102      if (Name == "llvm.convert.to.fp16") {
1103        APFloat Val(Op->getValueAPF());
1104
1105        bool lost = false;
1106        Val.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &lost);
1107
1108        return ConstantInt::get(F->getContext(), Val.bitcastToAPInt());
1109      }
1110
1111      if (!Ty->isFloatTy() && !Ty->isDoubleTy())
1112        return 0;
1113
1114      /// We only fold functions with finite arguments. Folding NaN and inf is
1115      /// likely to be aborted with an exception anyway, and some host libms
1116      /// have known errors raising exceptions.
1117      if (Op->getValueAPF().isNaN() || Op->getValueAPF().isInfinity())
1118        return 0;
1119
1120      /// Currently APFloat versions of these functions do not exist, so we use
1121      /// the host native double versions.  Float versions are not called
1122      /// directly but for all these it is true (float)(f((double)arg)) ==
1123      /// f(arg).  Long double not supported yet.
1124      double V = Ty->isFloatTy() ? (double)Op->getValueAPF().convertToFloat() :
1125                                     Op->getValueAPF().convertToDouble();
1126      switch (Name[0]) {
1127      case 'a':
1128        if (Name == "acos")
1129          return ConstantFoldFP(acos, V, Ty);
1130        else if (Name == "asin")
1131          return ConstantFoldFP(asin, V, Ty);
1132        else if (Name == "atan")
1133          return ConstantFoldFP(atan, V, Ty);
1134        break;
1135      case 'c':
1136        if (Name == "ceil")
1137          return ConstantFoldFP(ceil, V, Ty);
1138        else if (Name == "cos")
1139          return ConstantFoldFP(cos, V, Ty);
1140        else if (Name == "cosh")
1141          return ConstantFoldFP(cosh, V, Ty);
1142        else if (Name == "cosf")
1143          return ConstantFoldFP(cos, V, Ty);
1144        break;
1145      case 'e':
1146        if (Name == "exp")
1147          return ConstantFoldFP(exp, V, Ty);
1148        break;
1149      case 'f':
1150        if (Name == "fabs")
1151          return ConstantFoldFP(fabs, V, Ty);
1152        else if (Name == "floor")
1153          return ConstantFoldFP(floor, V, Ty);
1154        break;
1155      case 'l':
1156        if (Name == "log" && V > 0)
1157          return ConstantFoldFP(log, V, Ty);
1158        else if (Name == "log10" && V > 0)
1159          return ConstantFoldFP(log10, V, Ty);
1160        else if (Name == "llvm.sqrt.f32" ||
1161                 Name == "llvm.sqrt.f64") {
1162          if (V >= -0.0)
1163            return ConstantFoldFP(sqrt, V, Ty);
1164          else // Undefined
1165            return Constant::getNullValue(Ty);
1166        }
1167        break;
1168      case 's':
1169        if (Name == "sin")
1170          return ConstantFoldFP(sin, V, Ty);
1171        else if (Name == "sinh")
1172          return ConstantFoldFP(sinh, V, Ty);
1173        else if (Name == "sqrt" && V >= 0)
1174          return ConstantFoldFP(sqrt, V, Ty);
1175        else if (Name == "sqrtf" && V >= 0)
1176          return ConstantFoldFP(sqrt, V, Ty);
1177        else if (Name == "sinf")
1178          return ConstantFoldFP(sin, V, Ty);
1179        break;
1180      case 't':
1181        if (Name == "tan")
1182          return ConstantFoldFP(tan, V, Ty);
1183        else if (Name == "tanh")
1184          return ConstantFoldFP(tanh, V, Ty);
1185        break;
1186      default:
1187        break;
1188      }
1189      return 0;
1190    }
1191
1192
1193    if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
1194      if (Name.startswith("llvm.bswap"))
1195        return ConstantInt::get(F->getContext(), Op->getValue().byteSwap());
1196      else if (Name.startswith("llvm.ctpop"))
1197        return ConstantInt::get(Ty, Op->getValue().countPopulation());
1198      else if (Name.startswith("llvm.cttz"))
1199        return ConstantInt::get(Ty, Op->getValue().countTrailingZeros());
1200      else if (Name.startswith("llvm.ctlz"))
1201        return ConstantInt::get(Ty, Op->getValue().countLeadingZeros());
1202      else if (Name == "llvm.convert.from.fp16") {
1203        APFloat Val(Op->getValue());
1204
1205        bool lost = false;
1206        APFloat::opStatus status =
1207          Val.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &lost);
1208
1209        // Conversion is always precise.
1210        status = status;
1211        assert(status == APFloat::opOK && !lost &&
1212               "Precision lost during fp16 constfolding");
1213
1214        return ConstantFP::get(F->getContext(), Val);
1215      }
1216      return 0;
1217    }
1218
1219    if (isa<UndefValue>(Operands[0])) {
1220      if (Name.startswith("llvm.bswap"))
1221        return Operands[0];
1222      return 0;
1223    }
1224
1225    return 0;
1226  }
1227
1228  if (NumOperands == 2) {
1229    if (ConstantFP *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
1230      if (!Ty->isFloatTy() && !Ty->isDoubleTy())
1231        return 0;
1232      double Op1V = Ty->isFloatTy() ?
1233                      (double)Op1->getValueAPF().convertToFloat() :
1234                      Op1->getValueAPF().convertToDouble();
1235      if (ConstantFP *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
1236        if (Op2->getType() != Op1->getType())
1237          return 0;
1238
1239        double Op2V = Ty->isFloatTy() ?
1240                      (double)Op2->getValueAPF().convertToFloat():
1241                      Op2->getValueAPF().convertToDouble();
1242
1243        if (Name == "pow")
1244          return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
1245        if (Name == "fmod")
1246          return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
1247        if (Name == "atan2")
1248          return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
1249      } else if (ConstantInt *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
1250        if (Name == "llvm.powi.f32")
1251          return ConstantFP::get(F->getContext(),
1252                                 APFloat((float)std::pow((float)Op1V,
1253                                                 (int)Op2C->getZExtValue())));
1254        if (Name == "llvm.powi.f64")
1255          return ConstantFP::get(F->getContext(),
1256                                 APFloat((double)std::pow((double)Op1V,
1257                                                   (int)Op2C->getZExtValue())));
1258      }
1259      return 0;
1260    }
1261
1262
1263    if (ConstantInt *Op1 = dyn_cast<ConstantInt>(Operands[0])) {
1264      if (ConstantInt *Op2 = dyn_cast<ConstantInt>(Operands[1])) {
1265        switch (F->getIntrinsicID()) {
1266        default: break;
1267        case Intrinsic::sadd_with_overflow:
1268        case Intrinsic::uadd_with_overflow:
1269        case Intrinsic::ssub_with_overflow:
1270        case Intrinsic::usub_with_overflow:
1271        case Intrinsic::smul_with_overflow: {
1272          APInt Res;
1273          bool Overflow;
1274          switch (F->getIntrinsicID()) {
1275          default: assert(0 && "Invalid case");
1276          case Intrinsic::sadd_with_overflow:
1277            Res = Op1->getValue().sadd_ov(Op2->getValue(), Overflow);
1278            break;
1279          case Intrinsic::uadd_with_overflow:
1280            Res = Op1->getValue().uadd_ov(Op2->getValue(), Overflow);
1281            break;
1282          case Intrinsic::ssub_with_overflow:
1283            Res = Op1->getValue().ssub_ov(Op2->getValue(), Overflow);
1284            break;
1285          case Intrinsic::usub_with_overflow:
1286            Res = Op1->getValue().usub_ov(Op2->getValue(), Overflow);
1287            break;
1288          case Intrinsic::smul_with_overflow:
1289            Res = Op1->getValue().smul_ov(Op2->getValue(), Overflow);
1290            break;
1291          }
1292          Constant *Ops[] = {
1293            ConstantInt::get(F->getContext(), Res),
1294            ConstantInt::get(Type::getInt1Ty(F->getContext()), Overflow)
1295          };
1296          return ConstantStruct::get(F->getContext(), Ops, 2, false);
1297        }
1298        }
1299      }
1300
1301      return 0;
1302    }
1303    return 0;
1304  }
1305  return 0;
1306}
1307
1308