lib/Analysis/ConstantFolding.cpp

   1 //===-- ConstantFolding.cpp - Analyze constant folding possibilities ------===//
   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 family of functions determines the possibility of performing constant
  11 // folding.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/ConstantFolding.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Function.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Intrinsics.h"
  21 #include "llvm/ADT/SmallVector.h"
  22 #include "llvm/ADT/StringMap.h"
  23 #include "llvm/Target/TargetData.h"
  24 #include "llvm/Support/GetElementPtrTypeIterator.h"
  25 #include "llvm/Support/MathExtras.h"
  26 #include <cerrno>
  27 #include <cmath>
  28 using namespace llvm;
  29
  30 //===----------------------------------------------------------------------===//
  31 // Constant Folding internal helper functions
  32 //===----------------------------------------------------------------------===//
  33
  34 /// IsConstantOffsetFromGlobal - If this constant is actually a constant offset
  35 /// from a global, return the global and the constant.  Because of
  36 /// constantexprs, this function is recursive.
  37 static bool IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV,
  38                                        int64_t &Offset, const TargetData &TD) {
  39   // Trivial case, constant is the global.
  40   if ((GV = dyn_cast<GlobalValue>(C))) {
  41     Offset = 0;
  42     return true;
  43   }
  44
  45   // Otherwise, if this isn't a constant expr, bail out.
  46   ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
  47   if (!CE) return false;
  48
  49   // Look through ptr->int and ptr->ptr casts.
  50   if (CE->getOpcode() == Instruction::PtrToInt ||
  51       CE->getOpcode() == Instruction::BitCast)
  52     return IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD);
  53
  54   // i32* getelementptr ([5 x i32]* @a, i32 0, i32 5)
  55   if (CE->getOpcode() == Instruction::GetElementPtr) {
  56     // Cannot compute this if the element type of the pointer is missing size
  57     // info.
  58     if (!cast<PointerType>(CE->getOperand(0)->getType())
  59                  ->getElementType()->isSized())
  60       return false;
  61
  62     // If the base isn't a global+constant, we aren't either.
  63     if (!IsConstantOffsetFromGlobal(CE->getOperand(0), GV, Offset, TD))
  64       return false;
  65
  66     // Otherwise, add any offset that our operands provide.
  67     gep_type_iterator GTI = gep_type_begin(CE);
  68     for (User::const_op_iterator i = CE->op_begin() + 1, e = CE->op_end();
  69          i != e; ++i, ++GTI) {
  70       ConstantInt *CI = dyn_cast<ConstantInt>(*i);
  71       if (!CI) return false;  // Index isn't a simple constant?
  72       if (CI->getZExtValue() == 0) continue;  // Not adding anything.
  73
  74       if (const StructType *ST = dyn_cast<StructType>(*GTI)) {
  75         // N = N + Offset
  76         Offset += TD.getStructLayout(ST)->getElementOffset(CI->getZExtValue());
  77       } else {
  78         const SequentialType *SQT = cast<SequentialType>(*GTI);
  79         Offset += TD.getABITypeSize(SQT->getElementType())*CI->getSExtValue();
  80       }
  81     }
  82     return true;
  83   }
  84
  85   return false;
  86 }
  87
  88
  89 /// SymbolicallyEvaluateBinop - One of Op0/Op1 is a constant expression.
  90 /// Attempt to symbolically evaluate the result of  a binary operator merging
  91 /// these together.  If target data info is available, it is provided as TD,
  92 /// otherwise TD is null.
  93 static Constant *SymbolicallyEvaluateBinop(unsigned Opc, Constant *Op0,
  94                                            Constant *Op1, const TargetData *TD){
  95   // SROA
  96
  97   // Fold (and 0xffffffff00000000, (shl x, 32)) -> shl.
  98   // Fold (lshr (or X, Y), 32) -> (lshr [X/Y], 32) if one doesn't contribute
  99   // bits.
 100
 101
 102   // If the constant expr is something like &A[123] - &A[4].f, fold this into a
 103   // constant.  This happens frequently when iterating over a global array.
 104   if (Opc == Instruction::Sub && TD) {
 105     GlobalValue *GV1, *GV2;
 106     int64_t Offs1, Offs2;
 107
 108     if (IsConstantOffsetFromGlobal(Op0, GV1, Offs1, *TD))
 109       if (IsConstantOffsetFromGlobal(Op1, GV2, Offs2, *TD) &&
 110           GV1 == GV2) {
 111         // (&GV+C1) - (&GV+C2) -> C1-C2, pointer arithmetic cannot overflow.
 112         return ConstantInt::get(Op0->getType(), Offs1-Offs2);
 113       }
 114   }
 115
 116   // TODO: Fold icmp setne/seteq as well.
 117   return 0;
 118 }
 119
 120 /// SymbolicallyEvaluateGEP - If we can symbolically evaluate the specified GEP
 121 /// constant expression, do so.
 122 static Constant *SymbolicallyEvaluateGEP(Constant* const* Ops, unsigned NumOps,
 123                                          const Type *ResultTy,
 124                                          const TargetData *TD) {
 125   Constant *Ptr = Ops[0];
 126   if (!TD || !cast<PointerType>(Ptr->getType())->getElementType()->isSized())
 127     return 0;
 128
 129   uint64_t BasePtr = 0;
 130   if (!Ptr->isNullValue()) {
 131     // If this is a inttoptr from a constant int, we can fold this as the base,
 132     // otherwise we can't.
 133     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr))
 134       if (CE->getOpcode() == Instruction::IntToPtr)
 135         if (ConstantInt *Base = dyn_cast<ConstantInt>(CE->getOperand(0)))
 136           BasePtr = Base->getZExtValue();
 137
 138     if (BasePtr == 0)
 139       return 0;
 140   }
 141
 142   // If this is a constant expr gep that is effectively computing an
 143   // "offsetof", fold it into 'cast int Size to T*' instead of 'gep 0, 0, 12'
 144   for (unsigned i = 1; i != NumOps; ++i)
 145     if (!isa<ConstantInt>(Ops[i]))
 146       return false;
 147
 148   uint64_t Offset = TD->getIndexedOffset(Ptr->getType(),
 149                                          (Value**)Ops+1, NumOps-1);
 150   Constant *C = ConstantInt::get(TD->getIntPtrType(), Offset+BasePtr);
 151   return ConstantExpr::getIntToPtr(C, ResultTy);
 152 }
 153
 154 /// FoldBitCast - Constant fold bitcast, symbolically evaluating it with
 155 /// targetdata.  Return 0 if unfoldable.
 156 static Constant *FoldBitCast(Constant *C, const Type *DestTy,
 157                              const TargetData &TD) {
 158   // If this is a bitcast from constant vector -> vector, fold it.
 159   if (ConstantVector *CV = dyn_cast<ConstantVector>(C)) {
 160     if (const VectorType *DestVTy = dyn_cast<VectorType>(DestTy)) {
 161       // If the element types match, VMCore can fold it.
 162       unsigned NumDstElt = DestVTy->getNumElements();
 163       unsigned NumSrcElt = CV->getNumOperands();
 164       if (NumDstElt == NumSrcElt)
 165         return 0;
 166
 167       const Type *SrcEltTy = CV->getType()->getElementType();
 168       const Type *DstEltTy = DestVTy->getElementType();
 169
 170       // Otherwise, we're changing the number of elements in a vector, which
 171       // requires endianness information to do the right thing.  For example,
 172       //    bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
 173       // folds to (little endian):
 174       //    <4 x i32> <i32 0, i32 0, i32 1, i32 0>
 175       // and to (big endian):
 176       //    <4 x i32> <i32 0, i32 0, i32 0, i32 1>
 177
 178       // First thing is first.  We only want to think about integer here, so if
 179       // we have something in FP form, recast it as integer.
 180       if (DstEltTy->isFloatingPoint()) {
 181         // Fold to an vector of integers with same size as our FP type.
 182         unsigned FPWidth = DstEltTy->getPrimitiveSizeInBits();
 183         const Type *DestIVTy = VectorType::get(IntegerType::get(FPWidth),
 184                                                NumDstElt);
 185         // Recursively handle this integer conversion, if possible.
 186         C = FoldBitCast(C, DestIVTy, TD);
 187         if (!C) return 0;
 188
 189         // Finally, VMCore can handle this now that #elts line up.
 190         return ConstantExpr::getBitCast(C, DestTy);
 191       }
 192
 193       // Okay, we know the destination is integer, if the input is FP, convert
 194       // it to integer first.
 195       if (SrcEltTy->isFloatingPoint()) {
 196         unsigned FPWidth = SrcEltTy->getPrimitiveSizeInBits();
 197         const Type *SrcIVTy = VectorType::get(IntegerType::get(FPWidth),
 198                                               NumSrcElt);
 199         // Ask VMCore to do the conversion now that #elts line up.
 200         C = ConstantExpr::getBitCast(C, SrcIVTy);
 201         CV = dyn_cast<ConstantVector>(C);
 202         if (!CV) return 0;  // If VMCore wasn't able to fold it, bail out.
 203       }
 204
 205       // Now we know that the input and output vectors are both integer vectors
 206       // of the same size, and that their #elements is not the same.  Do the
 207       // conversion here, which depends on whether the input or output has
 208       // more elements.
 209       bool isLittleEndian = TD.isLittleEndian();
 210
 211       SmallVector<Constant*, 32> Result;
 212       if (NumDstElt < NumSrcElt) {
 213         // Handle: bitcast (<4 x i32> <i32 0, i32 1, i32 2, i32 3> to <2 x i64>)
 214         Constant *Zero = Constant::getNullValue(DstEltTy);
 215         unsigned Ratio = NumSrcElt/NumDstElt;
 216         unsigned SrcBitSize = SrcEltTy->getPrimitiveSizeInBits();
 217         unsigned SrcElt = 0;
 218         for (unsigned i = 0; i != NumDstElt; ++i) {
 219           // Build each element of the result.
 220           Constant *Elt = Zero;
 221           unsigned ShiftAmt = isLittleEndian ? 0 : SrcBitSize*(Ratio-1);
 222           for (unsigned j = 0; j != Ratio; ++j) {
 223             Constant *Src = dyn_cast<ConstantInt>(CV->getOperand(SrcElt++));
 224             if (!Src) return 0;  // Reject constantexpr elements.
 225
 226             // Zero extend the element to the right size.
 227             Src = ConstantExpr::getZExt(Src, Elt->getType());
 228
 229             // Shift it to the right place, depending on endianness.
 230             Src = ConstantExpr::getShl(Src,
 231                                     ConstantInt::get(Src->getType(), ShiftAmt));
 232             ShiftAmt += isLittleEndian ? SrcBitSize : -SrcBitSize;
 233
 234             // Mix it in.
 235             Elt = ConstantExpr::getOr(Elt, Src);
 236           }
 237           Result.push_back(Elt);
 238         }
 239       } else {
 240         // Handle: bitcast (<2 x i64> <i64 0, i64 1> to <4 x i32>)
 241         unsigned Ratio = NumDstElt/NumSrcElt;
 242         unsigned DstBitSize = DstEltTy->getPrimitiveSizeInBits();
 243
 244         // Loop over each source value, expanding into multiple results.
 245         for (unsigned i = 0; i != NumSrcElt; ++i) {
 246           Constant *Src = dyn_cast<ConstantInt>(CV->getOperand(i));
 247           if (!Src) return 0;  // Reject constantexpr elements.
 248
 249           unsigned ShiftAmt = isLittleEndian ? 0 : DstBitSize*(Ratio-1);
 250           for (unsigned j = 0; j != Ratio; ++j) {
 251             // Shift the piece of the value into the right place, depending on
 252             // endianness.
 253             Constant *Elt = ConstantExpr::getLShr(Src,
 254                                 ConstantInt::get(Src->getType(), ShiftAmt));
 255             ShiftAmt += isLittleEndian ? DstBitSize : -DstBitSize;
 256
 257             // Truncate and remember this piece.
 258             Result.push_back(ConstantExpr::getTrunc(Elt, DstEltTy));
 259           }
 260         }
 261       }
 262
 263       return ConstantVector::get(&Result[0], Result.size());
 264     }
 265   }
 266
 267   return 0;
 268 }
 269
 270
 271 //===----------------------------------------------------------------------===//
 272 // Constant Folding public APIs
 273 //===----------------------------------------------------------------------===//
 274
 275
 276 /// ConstantFoldInstruction - Attempt to constant fold the specified
 277 /// instruction.  If successful, the constant result is returned, if not, null
 278 /// is returned.  Note that this function can only fail when attempting to fold
 279 /// instructions like loads and stores, which have no constant expression form.
 280 ///
 281 Constant *llvm::ConstantFoldInstruction(Instruction *I, const TargetData *TD) {
 282   if (PHINode *PN = dyn_cast<PHINode>(I)) {
 283     if (PN->getNumIncomingValues() == 0)
 284       return Constant::getNullValue(PN->getType());
 285
 286     Constant *Result = dyn_cast<Constant>(PN->getIncomingValue(0));
 287     if (Result == 0) return 0;
 288
 289     // Handle PHI nodes specially here...
 290     for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i)
 291       if (PN->getIncomingValue(i) != Result && PN->getIncomingValue(i) != PN)
 292         return 0;   // Not all the same incoming constants...
 293
 294     // If we reach here, all incoming values are the same constant.
 295     return Result;
 296   }
 297
 298   // Scan the operand list, checking to see if they are all constants, if so,
 299   // hand off to ConstantFoldInstOperands.
 300   SmallVector<Constant*, 8> Ops;
 301   for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
 302     if (Constant *Op = dyn_cast<Constant>(*i))
 303       Ops.push_back(Op);
 304     else
 305       return 0;  // All operands not constant!
 306
 307   if (const CmpInst *CI = dyn_cast<CmpInst>(I))
 308     return ConstantFoldCompareInstOperands(CI->getPredicate(),
 309                                            &Ops[0], Ops.size(), TD);
 310   else
 311     return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
 312                                     &Ops[0], Ops.size(), TD);
 313 }
 314
 315 /// ConstantFoldConstantExpression - Attempt to fold the constant expression
 316 /// using the specified TargetData.  If successful, the constant result is
 317 /// result is returned, if not, null is returned.
 318 Constant *llvm::ConstantFoldConstantExpression(ConstantExpr *CE,
 319                                                const TargetData *TD) {
 320   assert(TD && "ConstantFoldConstantExpression requires a valid TargetData.");
 321
 322   SmallVector<Constant*, 8> Ops;
 323   for (User::op_iterator i = CE->op_begin(), e = CE->op_end(); i != e; ++i)
 324     Ops.push_back(cast<Constant>(*i));
 325
 326   if (CE->isCompare())
 327     return ConstantFoldCompareInstOperands(CE->getPredicate(),
 328                                            &Ops[0], Ops.size(), TD);
 329   else
 330     return ConstantFoldInstOperands(CE->getOpcode(), CE->getType(),
 331                                     &Ops[0], Ops.size(), TD);
 332 }
 333
 334 /// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
 335 /// specified opcode and operands.  If successful, the constant result is
 336 /// returned, if not, null is returned.  Note that this function can fail when
 337 /// attempting to fold instructions like loads and stores, which have no
 338 /// constant expression form.
 339 ///
 340 Constant *llvm::ConstantFoldInstOperands(unsigned Opcode, const Type *DestTy,
 341                                          Constant* const* Ops, unsigned NumOps,
 342                                          const TargetData *TD) {
 343   // Handle easy binops first.
 344   if (Instruction::isBinaryOp(Opcode)) {
 345     if (isa<ConstantExpr>(Ops[0]) || isa<ConstantExpr>(Ops[1]))
 346       if (Constant *C = SymbolicallyEvaluateBinop(Opcode, Ops[0], Ops[1], TD))
 347         return C;
 348
 349     return ConstantExpr::get(Opcode, Ops[0], Ops[1]);
 350   }
 351
 352   switch (Opcode) {
 353   default: return 0;
 354   case Instruction::Call:
 355     if (Function *F = dyn_cast<Function>(Ops[0]))
 356       if (canConstantFoldCallTo(F))
 357         return ConstantFoldCall(F, Ops+1, NumOps-1);
 358     return 0;
 359   case Instruction::ICmp:
 360   case Instruction::FCmp:
 361   case Instruction::VICmp:
 362   case Instruction::VFCmp:
 363     assert(0 &&"This function is invalid for compares: no predicate specified");
 364   case Instruction::PtrToInt:
 365     // If the input is a inttoptr, eliminate the pair.  This requires knowing
 366     // the width of a pointer, so it can't be done in ConstantExpr::getCast.
 367     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
 368       if (TD && CE->getOpcode() == Instruction::IntToPtr) {
 369         Constant *Input = CE->getOperand(0);
 370         unsigned InWidth = Input->getType()->getPrimitiveSizeInBits();
 371         Constant *Mask =
 372           ConstantInt::get(APInt::getLowBitsSet(InWidth,
 373                                                 TD->getPointerSizeInBits()));
 374         Input = ConstantExpr::getAnd(Input, Mask);
 375         // Do a zext or trunc to get to the dest size.
 376         return ConstantExpr::getIntegerCast(Input, DestTy, false);
 377       }
 378     }
 379     return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
 380   case Instruction::IntToPtr:
 381     // If the input is a ptrtoint, turn the pair into a ptr to ptr bitcast if
 382     // the int size is >= the ptr size.  This requires knowing the width of a
 383     // pointer, so it can't be done in ConstantExpr::getCast.
 384     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0])) {
 385       if (TD && CE->getOpcode() == Instruction::PtrToInt &&
 386           TD->getPointerSizeInBits() <=
 387           CE->getType()->getPrimitiveSizeInBits()) {
 388         Constant *Input = CE->getOperand(0);
 389         Constant *C = FoldBitCast(Input, DestTy, *TD);
 390         return C ? C : ConstantExpr::getBitCast(Input, DestTy);
 391       }
 392     }
 393     return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
 394   case Instruction::Trunc:
 395   case Instruction::ZExt:
 396   case Instruction::SExt:
 397   case Instruction::FPTrunc:
 398   case Instruction::FPExt:
 399   case Instruction::UIToFP:
 400   case Instruction::SIToFP:
 401   case Instruction::FPToUI:
 402   case Instruction::FPToSI:
 403       return ConstantExpr::getCast(Opcode, Ops[0], DestTy);
 404   case Instruction::BitCast:
 405     if (TD)
 406       if (Constant *C = FoldBitCast(Ops[0], DestTy, *TD))
 407         return C;
 408     return ConstantExpr::getBitCast(Ops[0], DestTy);
 409   case Instruction::Select:
 410     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
 411   case Instruction::ExtractElement:
 412     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
 413   case Instruction::InsertElement:
 414     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
 415   case Instruction::ShuffleVector:
 416     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
 417   case Instruction::GetElementPtr:
 418     if (Constant *C = SymbolicallyEvaluateGEP(Ops, NumOps, DestTy, TD))
 419       return C;
 420
 421     return ConstantExpr::getGetElementPtr(Ops[0], Ops+1, NumOps-1);
 422   }
 423 }
 424
 425 /// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
 426 /// instruction (icmp/fcmp) with the specified operands.  If it fails, it
 427 /// returns a constant expression of the specified operands.
 428 ///
 429 Constant *llvm::ConstantFoldCompareInstOperands(unsigned Predicate,
 430                                                 Constant*const * Ops,
 431                                                 unsigned NumOps,
 432                                                 const TargetData *TD) {
 433   // fold: icmp (inttoptr x), null         -> icmp x, 0
 434   // fold: icmp (ptrtoint x), 0            -> icmp x, null
 435   // fold: icmp (inttoptr x), (inttoptr y) -> icmp trunc/zext x, trunc/zext y
 436   // fold: icmp (ptrtoint x), (ptrtoint y) -> icmp x, y
 437   //
 438   // ConstantExpr::getCompare cannot do this, because it doesn't have TD
 439   // around to know if bit truncation is happening.
 440   if (ConstantExpr *CE0 = dyn_cast<ConstantExpr>(Ops[0])) {
 441     if (TD && Ops[1]->isNullValue()) {
 442       const Type *IntPtrTy = TD->getIntPtrType();
 443       if (CE0->getOpcode() == Instruction::IntToPtr) {
 444         // Convert the integer value to the right size to ensure we get the
 445         // proper extension or truncation.
 446         Constant *C = ConstantExpr::getIntegerCast(CE0->getOperand(0),
 447                                                    IntPtrTy, false);
 448         Constant *NewOps[] = { C, Constant::getNullValue(C->getType()) };
 449         return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
 450       }
 451
 452       // Only do this transformation if the int is intptrty in size, otherwise
 453       // there is a truncation or extension that we aren't modeling.
 454       if (CE0->getOpcode() == Instruction::PtrToInt &&
 455           CE0->getType() == IntPtrTy) {
 456         Constant *C = CE0->getOperand(0);
 457         Constant *NewOps[] = { C, Constant::getNullValue(C->getType()) };
 458         // FIXME!
 459         return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
 460       }
 461     }
 462
 463     if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(Ops[1])) {
 464       if (TD && CE0->getOpcode() == CE1->getOpcode()) {
 465         const Type *IntPtrTy = TD->getIntPtrType();
 466
 467         if (CE0->getOpcode() == Instruction::IntToPtr) {
 468           // Convert the integer value to the right size to ensure we get the
 469           // proper extension or truncation.
 470           Constant *C0 = ConstantExpr::getIntegerCast(CE0->getOperand(0),
 471                                                       IntPtrTy, false);
 472           Constant *C1 = ConstantExpr::getIntegerCast(CE1->getOperand(0),
 473                                                       IntPtrTy, false);
 474           Constant *NewOps[] = { C0, C1 };
 475           return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
 476         }
 477
 478         // Only do this transformation if the int is intptrty in size, otherwise
 479         // there is a truncation or extension that we aren't modeling.
 480         if ((CE0->getOpcode() == Instruction::PtrToInt &&
 481              CE0->getType() == IntPtrTy &&
 482              CE0->getOperand(0)->getType() == CE1->getOperand(0)->getType())) {
 483           Constant *NewOps[] = {
 484             CE0->getOperand(0), CE1->getOperand(0)
 485           };
 486           return ConstantFoldCompareInstOperands(Predicate, NewOps, 2, TD);
 487         }
 488       }
 489     }
 490   }
 491   return ConstantExpr::getCompare(Predicate, Ops[0], Ops[1]);
 492 }
 493
 494
 495 /// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
 496 /// getelementptr constantexpr, return the constant value being addressed by the
 497 /// constant expression, or null if something is funny and we can't decide.
 498 Constant *llvm::ConstantFoldLoadThroughGEPConstantExpr(Constant *C,
 499                                                        ConstantExpr *CE) {
 500   if (CE->getOperand(1) != Constant::getNullValue(CE->getOperand(1)->getType()))
 501     return 0;  // Do not allow stepping over the value!
 502
 503   // Loop over all of the operands, tracking down which value we are
 504   // addressing...
 505   gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
 506   for (++I; I != E; ++I)
 507     if (const StructType *STy = dyn_cast<StructType>(*I)) {
 508       ConstantInt *CU = cast<ConstantInt>(I.getOperand());
 509       assert(CU->getZExtValue() < STy->getNumElements() &&
 510              "Struct index out of range!");
 511       unsigned El = (unsigned)CU->getZExtValue();
 512       if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
 513         C = CS->getOperand(El);
 514       } else if (isa<ConstantAggregateZero>(C)) {
 515         C = Constant::getNullValue(STy->getElementType(El));
 516       } else if (isa<UndefValue>(C)) {
 517         C = UndefValue::get(STy->getElementType(El));
 518       } else {
 519         return 0;
 520       }
 521     } else if (ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand())) {
 522       if (const ArrayType *ATy = dyn_cast<ArrayType>(*I)) {
 523         if (CI->getZExtValue() >= ATy->getNumElements())
 524          return 0;
 525         if (ConstantArray *CA = dyn_cast<ConstantArray>(C))
 526           C = CA->getOperand(CI->getZExtValue());
 527         else if (isa<ConstantAggregateZero>(C))
 528           C = Constant::getNullValue(ATy->getElementType());
 529         else if (isa<UndefValue>(C))
 530           C = UndefValue::get(ATy->getElementType());
 531         else
 532           return 0;
 533       } else if (const VectorType *PTy = dyn_cast<VectorType>(*I)) {
 534         if (CI->getZExtValue() >= PTy->getNumElements())
 535           return 0;
 536         if (ConstantVector *CP = dyn_cast<ConstantVector>(C))
 537           C = CP->getOperand(CI->getZExtValue());
 538         else if (isa<ConstantAggregateZero>(C))
 539           C = Constant::getNullValue(PTy->getElementType());
 540         else if (isa<UndefValue>(C))
 541           C = UndefValue::get(PTy->getElementType());
 542         else
 543           return 0;
 544       } else {
 545         return 0;
 546       }
 547     } else {
 548       return 0;
 549     }
 550   return C;
 551 }
 552
 553
 554 //===----------------------------------------------------------------------===//
 555 //  Constant Folding for Calls
 556 //
 557
 558 /// canConstantFoldCallTo - Return true if its even possible to fold a call to
 559 /// the specified function.
 560 bool
 561 llvm::canConstantFoldCallTo(const Function *F) {
 562   switch (F->getIntrinsicID()) {
 563   case Intrinsic::sqrt:
 564   case Intrinsic::powi:
 565   case Intrinsic::bswap:
 566   case Intrinsic::ctpop:
 567   case Intrinsic::ctlz:
 568   case Intrinsic::cttz:
 569     return true;
 570   default: break;
 571   }
 572
 573   const ValueName *NameVal = F->getValueName();
 574   if (NameVal == 0) return false;
 575   const char *Str = NameVal->getKeyData();
 576   unsigned Len = NameVal->getKeyLength();
 577
 578   // In these cases, the check of the length is required.  We don't want to
 579   // return true for a name like "cos\0blah" which strcmp would return equal to
 580   // "cos", but has length 8.
 581   switch (Str[0]) {
 582   default: return false;
 583   case 'a':
 584     if (Len == 4)
 585       return !strcmp(Str, "acos") || !strcmp(Str, "asin") ||
 586              !strcmp(Str, "atan");
 587     else if (Len == 5)
 588       return !strcmp(Str, "atan2");
 589     return false;
 590   case 'c':
 591     if (Len == 3)
 592       return !strcmp(Str, "cos");
 593     else if (Len == 4)
 594       return !strcmp(Str, "ceil") || !strcmp(Str, "cosf") ||
 595              !strcmp(Str, "cosh");
 596     return false;
 597   case 'e':
 598     if (Len == 3)
 599       return !strcmp(Str, "exp");
 600     return false;
 601   case 'f':
 602     if (Len == 4)
 603       return !strcmp(Str, "fabs") || !strcmp(Str, "fmod");
 604     else if (Len == 5)
 605       return !strcmp(Str, "floor");
 606     return false;
 607     break;
 608   case 'l':
 609     if (Len == 3 && !strcmp(Str, "log"))
 610       return true;
 611     if (Len == 5 && !strcmp(Str, "log10"))
 612       return true;
 613     return false;
 614   case 'p':
 615     if (Len == 3 && !strcmp(Str, "pow"))
 616       return true;
 617     return false;
 618   case 's':
 619     if (Len == 3)
 620       return !strcmp(Str, "sin");
 621     if (Len == 4)
 622       return !strcmp(Str, "sinh") || !strcmp(Str, "sqrt") ||
 623              !strcmp(Str, "sinf");
 624     if (Len == 5)
 625       return !strcmp(Str, "sqrtf");
 626     return false;
 627   case 't':
 628     if (Len == 3 && !strcmp(Str, "tan"))
 629       return true;
 630     else if (Len == 4 && !strcmp(Str, "tanh"))
 631       return true;
 632     return false;
 633   }
 634 }
 635
 636 static Constant *ConstantFoldFP(double (*NativeFP)(double), double V,
 637                                 const Type *Ty) {
 638   errno = 0;
 639   V = NativeFP(V);
 640   if (errno != 0) {
 641     errno = 0;
 642     return 0;
 643   }
 644
 645   if (Ty == Type::FloatTy)
 646     return ConstantFP::get(APFloat((float)V));
 647   if (Ty == Type::DoubleTy)
 648     return ConstantFP::get(APFloat(V));
 649   assert(0 && "Can only constant fold float/double");
 650   return 0; // dummy return to suppress warning
 651 }
 652
 653 static Constant *ConstantFoldBinaryFP(double (*NativeFP)(double, double),
 654                                       double V, double W,
 655                                       const Type *Ty) {
 656   errno = 0;
 657   V = NativeFP(V, W);
 658   if (errno != 0) {
 659     errno = 0;
 660     return 0;
 661   }
 662
 663   if (Ty == Type::FloatTy)
 664     return ConstantFP::get(APFloat((float)V));
 665   if (Ty == Type::DoubleTy)
 666     return ConstantFP::get(APFloat(V));
 667   assert(0 && "Can only constant fold float/double");
 668   return 0; // dummy return to suppress warning
 669 }
 670
 671 /// ConstantFoldCall - Attempt to constant fold a call to the specified function
 672 /// with the specified arguments, returning null if unsuccessful.
 673
 674 Constant *
 675 llvm::ConstantFoldCall(Function *F,
 676                        Constant* const* Operands, unsigned NumOperands) {
 677   const ValueName *NameVal = F->getValueName();
 678   if (NameVal == 0) return 0;
 679   const char *Str = NameVal->getKeyData();
 680   unsigned Len = NameVal->getKeyLength();
 681
 682   const Type *Ty = F->getReturnType();
 683   if (NumOperands == 1) {
 684     if (ConstantFP *Op = dyn_cast<ConstantFP>(Operands[0])) {
 685       if (Ty!=Type::FloatTy && Ty!=Type::DoubleTy)
 686         return 0;
 687       /// Currently APFloat versions of these functions do not exist, so we use
 688       /// the host native double versions.  Float versions are not called
 689       /// directly but for all these it is true (float)(f((double)arg)) ==
 690       /// f(arg).  Long double not supported yet.
 691       double V = Ty==Type::FloatTy ? (double)Op->getValueAPF().convertToFloat():
 692                                      Op->getValueAPF().convertToDouble();
 693       switch (Str[0]) {
 694       case 'a':
 695         if (Len == 4 && !strcmp(Str, "acos"))
 696           return ConstantFoldFP(acos, V, Ty);
 697         else if (Len == 4 && !strcmp(Str, "asin"))
 698           return ConstantFoldFP(asin, V, Ty);
 699         else if (Len == 4 && !strcmp(Str, "atan"))
 700           return ConstantFoldFP(atan, V, Ty);
 701         break;
 702       case 'c':
 703         if (Len == 4 && !strcmp(Str, "ceil"))
 704           return ConstantFoldFP(ceil, V, Ty);
 705         else if (Len == 3 && !strcmp(Str, "cos"))
 706           return ConstantFoldFP(cos, V, Ty);
 707         else if (Len == 4 && !strcmp(Str, "cosh"))
 708           return ConstantFoldFP(cosh, V, Ty);
 709         else if (Len == 4 && !strcmp(Str, "cosf"))
 710           return ConstantFoldFP(cos, V, Ty);
 711         break;
 712       case 'e':
 713         if (Len == 3 && !strcmp(Str, "exp"))
 714           return ConstantFoldFP(exp, V, Ty);
 715         break;
 716       case 'f':
 717         if (Len == 4 && !strcmp(Str, "fabs"))
 718           return ConstantFoldFP(fabs, V, Ty);
 719         else if (Len == 5 && !strcmp(Str, "floor"))
 720           return ConstantFoldFP(floor, V, Ty);
 721         break;
 722       case 'l':
 723         if (Len == 3 && !strcmp(Str, "log") && V > 0)
 724           return ConstantFoldFP(log, V, Ty);
 725         else if (Len == 5 && !strcmp(Str, "log10") && V > 0)
 726           return ConstantFoldFP(log10, V, Ty);
 727         else if (!strcmp(Str, "llvm.sqrt.f32") ||
 728                  !strcmp(Str, "llvm.sqrt.f64")) {
 729           if (V >= -0.0)
 730             return ConstantFoldFP(sqrt, V, Ty);
 731           else // Undefined
 732             return Constant::getNullValue(Ty);
 733         }
 734         break;
 735       case 's':
 736         if (Len == 3 && !strcmp(Str, "sin"))
 737           return ConstantFoldFP(sin, V, Ty);
 738         else if (Len == 4 && !strcmp(Str, "sinh"))
 739           return ConstantFoldFP(sinh, V, Ty);
 740         else if (Len == 4 && !strcmp(Str, "sqrt") && V >= 0)
 741           return ConstantFoldFP(sqrt, V, Ty);
 742         else if (Len == 5 && !strcmp(Str, "sqrtf") && V >= 0)
 743           return ConstantFoldFP(sqrt, V, Ty);
 744         else if (Len == 4 && !strcmp(Str, "sinf"))
 745           return ConstantFoldFP(sin, V, Ty);
 746         break;
 747       case 't':
 748         if (Len == 3 && !strcmp(Str, "tan"))
 749           return ConstantFoldFP(tan, V, Ty);
 750         else if (Len == 4 && !strcmp(Str, "tanh"))
 751           return ConstantFoldFP(tanh, V, Ty);
 752         break;
 753       default:
 754         break;
 755       }
 756     } else if (ConstantInt *Op = dyn_cast<ConstantInt>(Operands[0])) {
 757       if (Len > 11 && !memcmp(Str, "llvm.bswap", 10))
 758         return ConstantInt::get(Op->getValue().byteSwap());
 759       else if (Len > 11 && !memcmp(Str, "llvm.ctpop", 10))
 760         return ConstantInt::get(Ty, Op->getValue().countPopulation());
 761       else if (Len > 10 && !memcmp(Str, "llvm.cttz", 9))
 762         return ConstantInt::get(Ty, Op->getValue().countTrailingZeros());
 763       else if (Len > 10 && !memcmp(Str, "llvm.ctlz", 9))
 764         return ConstantInt::get(Ty, Op->getValue().countLeadingZeros());
 765     }
 766   } else if (NumOperands == 2) {
 767     if (ConstantFP *Op1 = dyn_cast<ConstantFP>(Operands[0])) {
 768       if (Ty!=Type::FloatTy && Ty!=Type::DoubleTy)
 769         return 0;
 770       double Op1V = Ty==Type::FloatTy ?
 771                       (double)Op1->getValueAPF().convertToFloat():
 772                       Op1->getValueAPF().convertToDouble();
 773       if (ConstantFP *Op2 = dyn_cast<ConstantFP>(Operands[1])) {
 774         double Op2V = Ty==Type::FloatTy ?
 775                       (double)Op2->getValueAPF().convertToFloat():
 776                       Op2->getValueAPF().convertToDouble();
 777
 778         if (Len == 3 && !strcmp(Str, "pow")) {
 779           return ConstantFoldBinaryFP(pow, Op1V, Op2V, Ty);
 780         } else if (Len == 4 && !strcmp(Str, "fmod")) {
 781           return ConstantFoldBinaryFP(fmod, Op1V, Op2V, Ty);
 782         } else if (Len == 5 && !strcmp(Str, "atan2")) {
 783           return ConstantFoldBinaryFP(atan2, Op1V, Op2V, Ty);
 784         }
 785       } else if (ConstantInt *Op2C = dyn_cast<ConstantInt>(Operands[1])) {
 786         if (!strcmp(Str, "llvm.powi.f32")) {
 787           return ConstantFP::get(APFloat((float)std::pow((float)Op1V,
 788                                                  (int)Op2C->getZExtValue())));
 789         } else if (!strcmp(Str, "llvm.powi.f64")) {
 790           return ConstantFP::get(APFloat((double)std::pow((double)Op1V,
 791                                                  (int)Op2C->getZExtValue())));
 792         }
 793       }
 794     }
 795   }
 796   return 0;
 797 }
 798