blob: c826f757e6dde6e1afd2f1c34a022d4a19036ad0 [file] [log] [blame]
Reid Spencer81658a82007-02-27 06:23:51 +00001//===- ConstantFold.cpp - LLVM constant folder ----------------------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner5a945e32004-01-12 21:13:12 +000010// This file implements folding of constants for LLVM. This implements the
Reid Spencer81658a82007-02-27 06:23:51 +000011// (internal) ConstantFold.h interface, which is used by the
Chris Lattner5a945e32004-01-12 21:13:12 +000012// ConstantExpr::get* methods to automatically fold constants when possible.
Chris Lattner2f7c9632001-06-06 20:29:01 +000013//
Chris Lattner1dd054c2004-01-12 22:07:24 +000014// The current constant folding implementation is implemented in two pieces: the
Micah Villmowcdfe20b2012-10-08 16:38:25 +000015// pieces that don't need DataLayout, and the pieces that do. This is to avoid
Chandler Carruthef860a22013-01-02 09:10:48 +000016// a dependence in IR on Target.
Chris Lattner1dd054c2004-01-12 22:07:24 +000017//
Chris Lattner2f7c9632001-06-06 20:29:01 +000018//===----------------------------------------------------------------------===//
19
Chris Lattner33e93b82007-02-27 03:05:06 +000020#include "ConstantFold.h"
Simon Pilgrim8424df72017-03-19 16:50:25 +000021#include "llvm/ADT/APSInt.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000022#include "llvm/ADT/SmallVector.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000023#include "llvm/IR/Constants.h"
24#include "llvm/IR/DerivedTypes.h"
25#include "llvm/IR/Function.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000026#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/GlobalAlias.h"
28#include "llvm/IR/GlobalVariable.h"
29#include "llvm/IR/Instructions.h"
30#include "llvm/IR/Operator.h"
David Majnemer7b86b772014-12-10 09:14:55 +000031#include "llvm/IR/PatternMatch.h"
Torok Edwin56d06592009-07-11 20:10:48 +000032#include "llvm/Support/ErrorHandling.h"
Chris Lattner057083f2006-10-13 17:22:21 +000033#include "llvm/Support/ManagedStatic.h"
34#include "llvm/Support/MathExtras.h"
Chris Lattner9d9cbcf2003-11-17 19:05:17 +000035using namespace llvm;
David Majnemer7b86b772014-12-10 09:14:55 +000036using namespace llvm::PatternMatch;
Chris Lattner61607ee2001-09-09 21:01:20 +000037
Chris Lattner1dd054c2004-01-12 22:07:24 +000038//===----------------------------------------------------------------------===//
39// ConstantFold*Instruction Implementations
40//===----------------------------------------------------------------------===//
Chris Lattner1dd054c2004-01-12 22:07:24 +000041
Sanjay Patelf3bb6c52016-04-05 18:23:30 +000042/// Convert the specified vector Constant node to the specified vector type.
43/// At this point, we know that the elements of the input vector constant are
44/// all simple integer or FP values.
Chris Lattnerfa775002012-01-26 02:32:04 +000045static Constant *BitCastConstantVector(Constant *CV, VectorType *DstTy) {
Nadav Rotem10134c32011-02-11 19:37:55 +000046
Nadav Rotem7cc6d122011-02-17 21:22:27 +000047 if (CV->isAllOnesValue()) return Constant::getAllOnesValue(DstTy);
Nadav Rotem10134c32011-02-11 19:37:55 +000048 if (CV->isNullValue()) return Constant::getNullValue(DstTy);
49
Chris Lattner5c6399e2007-12-11 06:07:39 +000050 // If this cast changes element count then we can't handle it here:
51 // doing so requires endianness information. This should be handled by
52 // Analysis/ConstantFolding.cpp
53 unsigned NumElts = DstTy->getNumElements();
Chris Lattnerfa775002012-01-26 02:32:04 +000054 if (NumElts != CV->getType()->getVectorNumElements())
Craig Topperc6207612014-04-09 06:08:46 +000055 return nullptr;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +000056
Chris Lattnerfa775002012-01-26 02:32:04 +000057 Type *DstEltTy = DstTy->getElementType();
Dan Gohman062d3782009-08-29 23:35:16 +000058
Chris Lattnerfa775002012-01-26 02:32:04 +000059 SmallVector<Constant*, 16> Result;
Dan Gohman1ccecdb2012-04-27 17:50:22 +000060 Type *Ty = IntegerType::get(CV->getContext(), 32);
Chris Lattner5c6399e2007-12-11 06:07:39 +000061 for (unsigned i = 0; i != NumElts; ++i) {
Dan Gohman1ccecdb2012-04-27 17:50:22 +000062 Constant *C =
63 ConstantExpr::getExtractElement(CV, ConstantInt::get(Ty, i));
Chris Lattnerfa775002012-01-26 02:32:04 +000064 C = ConstantExpr::getBitCast(C, DstEltTy);
Chris Lattnerfa775002012-01-26 02:32:04 +000065 Result.push_back(C);
Chris Lattner6b3f4752006-04-02 01:38:28 +000066 }
Chris Lattner5c6399e2007-12-11 06:07:39 +000067
Owen Anderson4aa32952009-07-28 21:19:26 +000068 return ConstantVector::get(Result);
Chris Lattner6b3f4752006-04-02 01:38:28 +000069}
70
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +000071/// This function determines which opcode to use to fold two constant cast
Reid Spencer6c38f0b2006-11-27 01:05:10 +000072/// expressions together. It uses CastInst::isEliminableCastPair to determine
73/// the opcode. Consequently its just a wrapper around that function.
Reid Spencer05d55b32007-08-05 19:27:01 +000074/// @brief Determine if it is valid to fold a cast of a cast
Reid Spencer6c38f0b2006-11-27 01:05:10 +000075static unsigned
76foldConstantCastPair(
77 unsigned opc, ///< opcode of the second cast constant expression
Nick Lewyckye0332982009-09-20 01:35:59 +000078 ConstantExpr *Op, ///< the first cast constant expression
Matt Arsenault130e0ef2013-07-30 22:27:10 +000079 Type *DstTy ///< destination type of the first cast
Reid Spencer6c38f0b2006-11-27 01:05:10 +000080) {
81 assert(Op && Op->isCast() && "Can't fold cast of cast without a cast!");
82 assert(DstTy && DstTy->isFirstClassType() && "Invalid cast destination type");
83 assert(CastInst::isCast(opc) && "Invalid cast opcode");
Dan Gohman062d3782009-08-29 23:35:16 +000084
Bruce Mitchenere9ffb452015-09-12 01:17:08 +000085 // The types and opcodes for the two Cast constant expressions
Chris Lattner229907c2011-07-18 04:54:35 +000086 Type *SrcTy = Op->getOperand(0)->getType();
87 Type *MidTy = Op->getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +000088 Instruction::CastOps firstOp = Instruction::CastOps(Op->getOpcode());
89 Instruction::CastOps secondOp = Instruction::CastOps(opc);
Chris Lattner6b3f4752006-04-02 01:38:28 +000090
Matt Arsenault130e0ef2013-07-30 22:27:10 +000091 // Assume that pointers are never more than 64 bits wide, and only use this
92 // for the middle type. Otherwise we could end up folding away illegal
93 // bitcasts between address spaces with different sizes.
Duncan Sandse2395dc2012-10-30 16:03:32 +000094 IntegerType *FakeIntPtrTy = Type::getInt64Ty(DstTy->getContext());
95
Reid Spencer6c38f0b2006-11-27 01:05:10 +000096 // Let CastInst::isEliminableCastPair do the heavy lifting.
97 return CastInst::isEliminableCastPair(firstOp, secondOp, SrcTy, MidTy, DstTy,
Craig Topperc6207612014-04-09 06:08:46 +000098 nullptr, FakeIntPtrTy, nullptr);
Reid Spencer6c38f0b2006-11-27 01:05:10 +000099}
100
Chris Lattner229907c2011-07-18 04:54:35 +0000101static Constant *FoldBitCast(Constant *V, Type *DestTy) {
102 Type *SrcTy = V->getType();
Chris Lattnere8ea0372007-12-11 05:55:02 +0000103 if (SrcTy == DestTy)
104 return V; // no-op cast
Dan Gohman062d3782009-08-29 23:35:16 +0000105
Chris Lattnere8ea0372007-12-11 05:55:02 +0000106 // Check to see if we are casting a pointer to an aggregate to a pointer to
107 // the first element. If so, return the appropriate GEP instruction.
Chris Lattner229907c2011-07-18 04:54:35 +0000108 if (PointerType *PTy = dyn_cast<PointerType>(V->getType()))
109 if (PointerType *DPTy = dyn_cast<PointerType>(DestTy))
Duncan Sands0bf46b532012-01-11 12:20:08 +0000110 if (PTy->getAddressSpace() == DPTy->getAddressSpace()
David Majnemer59be1d62015-12-14 19:30:32 +0000111 && PTy->getElementType()->isSized()) {
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000112 SmallVector<Value*, 8> IdxList;
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000113 Value *Zero =
114 Constant::getNullValue(Type::getInt32Ty(DPTy->getContext()));
Dan Gohman76733742009-08-12 00:32:55 +0000115 IdxList.push_back(Zero);
Chris Lattner229907c2011-07-18 04:54:35 +0000116 Type *ElTy = PTy->getElementType();
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000117 while (ElTy != DPTy->getElementType()) {
Chris Lattner229907c2011-07-18 04:54:35 +0000118 if (StructType *STy = dyn_cast<StructType>(ElTy)) {
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000119 if (STy->getNumElements() == 0) break;
120 ElTy = STy->getElementType(0);
Dan Gohman76733742009-08-12 00:32:55 +0000121 IdxList.push_back(Zero);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000122 } else if (SequentialType *STy =
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000123 dyn_cast<SequentialType>(ElTy)) {
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000124 ElTy = STy->getElementType();
Dan Gohman76733742009-08-12 00:32:55 +0000125 IdxList.push_back(Zero);
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000126 } else {
127 break;
128 }
Chris Lattnere8ea0372007-12-11 05:55:02 +0000129 }
Dan Gohman062d3782009-08-29 23:35:16 +0000130
Nate Begemanf2b0b0e2008-03-31 00:22:16 +0000131 if (ElTy == DPTy->getElementType())
Dan Gohmane4ca02d2009-09-03 23:34:49 +0000132 // This GEP is inbounds because all indices are zero.
David Blaikie4a2e73b2015-04-02 18:55:32 +0000133 return ConstantExpr::getInBoundsGetElementPtr(PTy->getElementType(),
134 V, IdxList);
Chris Lattnere8ea0372007-12-11 05:55:02 +0000135 }
Dan Gohman062d3782009-08-29 23:35:16 +0000136
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000137 // Handle casts from one vector constant to another. We know that the src
Chris Lattnere8ea0372007-12-11 05:55:02 +0000138 // and dest type have the same size (otherwise its an illegal cast).
Chris Lattner229907c2011-07-18 04:54:35 +0000139 if (VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
140 if (VectorType *SrcTy = dyn_cast<VectorType>(V->getType())) {
Chris Lattnere8ea0372007-12-11 05:55:02 +0000141 assert(DestPTy->getBitWidth() == SrcTy->getBitWidth() &&
142 "Not cast between same sized vectors!");
Craig Topperc6207612014-04-09 06:08:46 +0000143 SrcTy = nullptr;
Chris Lattnere8ea0372007-12-11 05:55:02 +0000144 // First, check for null. Undef is already handled.
145 if (isa<ConstantAggregateZero>(V))
Owen Anderson5a1acd92009-07-31 20:28:14 +0000146 return Constant::getNullValue(DestTy);
Dan Gohman062d3782009-08-29 23:35:16 +0000147
Chris Lattnerfa775002012-01-26 02:32:04 +0000148 // Handle ConstantVector and ConstantAggregateVector.
149 return BitCastConstantVector(V, DestPTy);
Chris Lattnere8ea0372007-12-11 05:55:02 +0000150 }
Chris Lattner1baace02008-10-16 05:26:51 +0000151
152 // Canonicalize scalar-to-vector bitcasts into vector-to-vector bitcasts
153 // This allows for other simplifications (although some of them
154 // can only be handled by Analysis/ConstantFolding.cpp).
155 if (isa<ConstantInt>(V) || isa<ConstantFP>(V))
Chris Lattner69229312011-02-15 00:14:00 +0000156 return ConstantExpr::getBitCast(ConstantVector::get(V), DestPTy);
Chris Lattnere8ea0372007-12-11 05:55:02 +0000157 }
Dan Gohman062d3782009-08-29 23:35:16 +0000158
Chris Lattnere8ea0372007-12-11 05:55:02 +0000159 // Finally, implement bitcast folding now. The code below doesn't handle
160 // bitcast right.
161 if (isa<ConstantPointerNull>(V)) // ptr->ptr cast.
Owen Andersonb292b8c2009-07-30 23:03:37 +0000162 return ConstantPointerNull::get(cast<PointerType>(DestTy));
Dan Gohman062d3782009-08-29 23:35:16 +0000163
Chris Lattnere8ea0372007-12-11 05:55:02 +0000164 // Handle integral constant input.
Nick Lewyckye0332982009-09-20 01:35:59 +0000165 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Duncan Sands9dff9be2010-02-15 16:12:20 +0000166 if (DestTy->isIntegerTy())
Chris Lattnere8ea0372007-12-11 05:55:02 +0000167 // Integral -> Integral. This is a no-op because the bit widths must
168 // be the same. Consequently, we just fold to V.
169 return V;
Duncan Sands1ea11732009-02-04 10:17:14 +0000170
Hal Finkelcd5553e2015-03-28 16:44:57 +0000171 // See note below regarding the PPC_FP128 restriction.
172 if (DestTy->isFloatingPointTy() && !DestTy->isPPC_FP128Ty())
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000173 return ConstantFP::get(DestTy->getContext(),
Tim Northover29178a32013-01-22 09:46:31 +0000174 APFloat(DestTy->getFltSemantics(),
175 CI->getValue()));
Duncan Sands1ea11732009-02-04 10:17:14 +0000176
Chris Lattnere8ea0372007-12-11 05:55:02 +0000177 // Otherwise, can't fold this (vector?)
Craig Topperc6207612014-04-09 06:08:46 +0000178 return nullptr;
Chris Lattnere8ea0372007-12-11 05:55:02 +0000179 }
Duncan Sandse7d54792009-02-04 11:17:06 +0000180
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000181 // Handle ConstantFP input: FP -> Integral.
Hal Finkelcd5553e2015-03-28 16:44:57 +0000182 if (ConstantFP *FP = dyn_cast<ConstantFP>(V)) {
183 // PPC_FP128 is really the sum of two consecutive doubles, where the first
184 // double is always stored first in memory, regardless of the target
185 // endianness. The memory layout of i128, however, depends on the target
186 // endianness, and so we can't fold this without target endianness
187 // information. This should instead be handled by
188 // Analysis/ConstantFolding.cpp
189 if (FP->getType()->isPPC_FP128Ty())
190 return nullptr;
191
Teresa Johnsonf4cf1c32016-04-04 23:50:46 +0000192 // Make sure dest type is compatible with the folded integer constant.
193 if (!DestTy->isIntegerTy())
194 return nullptr;
195
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000196 return ConstantInt::get(FP->getContext(),
197 FP->getValueAPF().bitcastToAPInt());
Hal Finkelcd5553e2015-03-28 16:44:57 +0000198 }
Duncan Sandse7d54792009-02-04 11:17:06 +0000199
Craig Topperc6207612014-04-09 06:08:46 +0000200 return nullptr;
Chris Lattnere8ea0372007-12-11 05:55:02 +0000201}
202
203
Sanjay Patelf3bb6c52016-04-05 18:23:30 +0000204/// V is an integer constant which only has a subset of its bytes used.
205/// The bytes used are indicated by ByteStart (which is the first byte used,
206/// counting from the least significant byte) and ByteSize, which is the number
207/// of bytes used.
Chris Lattnerf67d2972009-10-17 21:53:27 +0000208///
209/// This function analyzes the specified constant to see if the specified byte
210/// range can be returned as a simplified constant. If so, the constant is
211/// returned, otherwise null is returned.
Chris Lattnerf67d2972009-10-17 21:53:27 +0000212static Constant *ExtractConstantBytes(Constant *C, unsigned ByteStart,
213 unsigned ByteSize) {
Duncan Sands19d0b472010-02-16 11:11:14 +0000214 assert(C->getType()->isIntegerTy() &&
Chris Lattnerf67d2972009-10-17 21:53:27 +0000215 (cast<IntegerType>(C->getType())->getBitWidth() & 7) == 0 &&
216 "Non-byte sized integer input");
217 unsigned CSize = cast<IntegerType>(C->getType())->getBitWidth()/8;
218 assert(ByteSize && "Must be accessing some piece");
219 assert(ByteStart+ByteSize <= CSize && "Extracting invalid piece from input");
220 assert(ByteSize != CSize && "Should not extract everything");
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000221
Chris Lattnerf67d2972009-10-17 21:53:27 +0000222 // Constant Integers are simple.
223 if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
224 APInt V = CI->getValue();
225 if (ByteStart)
Craig Topperfc947bc2017-04-18 17:14:21 +0000226 V.lshrInPlace(ByteStart*8);
Jay Foad583abbc2010-12-07 08:25:19 +0000227 V = V.trunc(ByteSize*8);
Chris Lattnerf67d2972009-10-17 21:53:27 +0000228 return ConstantInt::get(CI->getContext(), V);
229 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000230
Chris Lattnerf67d2972009-10-17 21:53:27 +0000231 // In the input is a constant expr, we might be able to recursively simplify.
232 // If not, we definitely can't do anything.
233 ConstantExpr *CE = dyn_cast<ConstantExpr>(C);
Craig Topperc6207612014-04-09 06:08:46 +0000234 if (!CE) return nullptr;
235
Chris Lattnerf67d2972009-10-17 21:53:27 +0000236 switch (CE->getOpcode()) {
Craig Topperc6207612014-04-09 06:08:46 +0000237 default: return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000238 case Instruction::Or: {
Chris Lattnera91a5632009-10-28 05:14:34 +0000239 Constant *RHS = ExtractConstantBytes(CE->getOperand(1), ByteStart,ByteSize);
Craig Topperc6207612014-04-09 06:08:46 +0000240 if (!RHS)
241 return nullptr;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000242
Chris Lattnerf67d2972009-10-17 21:53:27 +0000243 // X | -1 -> -1.
244 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS))
Craig Topper79ab6432017-07-06 18:39:47 +0000245 if (RHSC->isMinusOne())
Chris Lattnerf67d2972009-10-17 21:53:27 +0000246 return RHSC;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000247
Chris Lattnera91a5632009-10-28 05:14:34 +0000248 Constant *LHS = ExtractConstantBytes(CE->getOperand(0), ByteStart,ByteSize);
Craig Topperc6207612014-04-09 06:08:46 +0000249 if (!LHS)
250 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000251 return ConstantExpr::getOr(LHS, RHS);
252 }
253 case Instruction::And: {
Chris Lattnera91a5632009-10-28 05:14:34 +0000254 Constant *RHS = ExtractConstantBytes(CE->getOperand(1), ByteStart,ByteSize);
Craig Topperc6207612014-04-09 06:08:46 +0000255 if (!RHS)
256 return nullptr;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000257
Chris Lattnerf67d2972009-10-17 21:53:27 +0000258 // X & 0 -> 0.
259 if (RHS->isNullValue())
260 return RHS;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000261
Chris Lattnera91a5632009-10-28 05:14:34 +0000262 Constant *LHS = ExtractConstantBytes(CE->getOperand(0), ByteStart,ByteSize);
Craig Topperc6207612014-04-09 06:08:46 +0000263 if (!LHS)
264 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000265 return ConstantExpr::getAnd(LHS, RHS);
266 }
267 case Instruction::LShr: {
268 ConstantInt *Amt = dyn_cast<ConstantInt>(CE->getOperand(1));
Craig Topperc6207612014-04-09 06:08:46 +0000269 if (!Amt)
270 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000271 unsigned ShAmt = Amt->getZExtValue();
272 // Cannot analyze non-byte shifts.
273 if ((ShAmt & 7) != 0)
Craig Topperc6207612014-04-09 06:08:46 +0000274 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000275 ShAmt >>= 3;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000276
Chris Lattnerf67d2972009-10-17 21:53:27 +0000277 // If the extract is known to be all zeros, return zero.
278 if (ByteStart >= CSize-ShAmt)
279 return Constant::getNullValue(IntegerType::get(CE->getContext(),
280 ByteSize*8));
281 // If the extract is known to be fully in the input, extract it.
282 if (ByteStart+ByteSize+ShAmt <= CSize)
Chris Lattnera91a5632009-10-28 05:14:34 +0000283 return ExtractConstantBytes(CE->getOperand(0), ByteStart+ShAmt, ByteSize);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000284
Chris Lattnerf67d2972009-10-17 21:53:27 +0000285 // TODO: Handle the 'partially zero' case.
Craig Topperc6207612014-04-09 06:08:46 +0000286 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000287 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000288
Chris Lattnerf67d2972009-10-17 21:53:27 +0000289 case Instruction::Shl: {
290 ConstantInt *Amt = dyn_cast<ConstantInt>(CE->getOperand(1));
Craig Topperc6207612014-04-09 06:08:46 +0000291 if (!Amt)
292 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000293 unsigned ShAmt = Amt->getZExtValue();
294 // Cannot analyze non-byte shifts.
295 if ((ShAmt & 7) != 0)
Craig Topperc6207612014-04-09 06:08:46 +0000296 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000297 ShAmt >>= 3;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000298
Chris Lattnerf67d2972009-10-17 21:53:27 +0000299 // If the extract is known to be all zeros, return zero.
300 if (ByteStart+ByteSize <= ShAmt)
301 return Constant::getNullValue(IntegerType::get(CE->getContext(),
302 ByteSize*8));
303 // If the extract is known to be fully in the input, extract it.
304 if (ByteStart >= ShAmt)
Chris Lattnera91a5632009-10-28 05:14:34 +0000305 return ExtractConstantBytes(CE->getOperand(0), ByteStart-ShAmt, ByteSize);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000306
Chris Lattnerf67d2972009-10-17 21:53:27 +0000307 // TODO: Handle the 'partially zero' case.
Craig Topperc6207612014-04-09 06:08:46 +0000308 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000309 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000310
Chris Lattnerf67d2972009-10-17 21:53:27 +0000311 case Instruction::ZExt: {
312 unsigned SrcBitSize =
Chris Lattnera91a5632009-10-28 05:14:34 +0000313 cast<IntegerType>(CE->getOperand(0)->getType())->getBitWidth();
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000314
Chris Lattnerf67d2972009-10-17 21:53:27 +0000315 // If extracting something that is completely zero, return 0.
316 if (ByteStart*8 >= SrcBitSize)
317 return Constant::getNullValue(IntegerType::get(CE->getContext(),
318 ByteSize*8));
319
320 // If exactly extracting the input, return it.
321 if (ByteStart == 0 && ByteSize*8 == SrcBitSize)
Chris Lattnera91a5632009-10-28 05:14:34 +0000322 return CE->getOperand(0);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000323
Chris Lattnerf67d2972009-10-17 21:53:27 +0000324 // If extracting something completely in the input, if if the input is a
325 // multiple of 8 bits, recurse.
326 if ((SrcBitSize&7) == 0 && (ByteStart+ByteSize)*8 <= SrcBitSize)
Chris Lattnera91a5632009-10-28 05:14:34 +0000327 return ExtractConstantBytes(CE->getOperand(0), ByteStart, ByteSize);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000328
Chris Lattnerf67d2972009-10-17 21:53:27 +0000329 // Otherwise, if extracting a subset of the input, which is not multiple of
330 // 8 bits, do a shift and trunc to get the bits.
331 if ((ByteStart+ByteSize)*8 < SrcBitSize) {
332 assert((SrcBitSize&7) && "Shouldn't get byte sized case here");
Chris Lattnera91a5632009-10-28 05:14:34 +0000333 Constant *Res = CE->getOperand(0);
Chris Lattnerf67d2972009-10-17 21:53:27 +0000334 if (ByteStart)
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000335 Res = ConstantExpr::getLShr(Res,
Chris Lattnerf67d2972009-10-17 21:53:27 +0000336 ConstantInt::get(Res->getType(), ByteStart*8));
337 return ConstantExpr::getTrunc(Res, IntegerType::get(C->getContext(),
338 ByteSize*8));
339 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000340
Chris Lattnerf67d2972009-10-17 21:53:27 +0000341 // TODO: Handle the 'partially zero' case.
Craig Topperc6207612014-04-09 06:08:46 +0000342 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000343 }
344 }
345}
346
Sanjay Patelf3bb6c52016-04-05 18:23:30 +0000347/// Return a ConstantExpr with type DestTy for sizeof on Ty, with any known
348/// factors factored out. If Folded is false, return null if no factoring was
349/// possible, to avoid endlessly bouncing an unfoldable expression back into the
350/// top-level folder.
Sanjay Patel2ad88f82017-06-12 22:34:37 +0000351static Constant *getFoldedSizeOf(Type *Ty, Type *DestTy, bool Folded) {
Chris Lattner229907c2011-07-18 04:54:35 +0000352 if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000353 Constant *N = ConstantInt::get(DestTy, ATy->getNumElements());
354 Constant *E = getFoldedSizeOf(ATy->getElementType(), DestTy, true);
355 return ConstantExpr::getNUWMul(E, N);
356 }
Dan Gohman935faff2010-02-25 16:05:33 +0000357
Chris Lattner229907c2011-07-18 04:54:35 +0000358 if (StructType *STy = dyn_cast<StructType>(Ty))
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000359 if (!STy->isPacked()) {
360 unsigned NumElems = STy->getNumElements();
361 // An empty struct has size zero.
362 if (NumElems == 0)
363 return ConstantExpr::getNullValue(DestTy);
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000364 // Check for a struct with all members having the same size.
365 Constant *MemberSize =
366 getFoldedSizeOf(STy->getElementType(0), DestTy, true);
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000367 bool AllSame = true;
368 for (unsigned i = 1; i != NumElems; ++i)
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000369 if (MemberSize !=
370 getFoldedSizeOf(STy->getElementType(i), DestTy, true)) {
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000371 AllSame = false;
372 break;
373 }
374 if (AllSame) {
375 Constant *N = ConstantInt::get(DestTy, NumElems);
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000376 return ConstantExpr::getNUWMul(MemberSize, N);
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000377 }
378 }
379
Dan Gohman183a4232010-02-10 06:13:07 +0000380 // Pointer size doesn't depend on the pointee type, so canonicalize them
381 // to an arbitrary pointee.
Chris Lattner229907c2011-07-18 04:54:35 +0000382 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
Duncan Sands9dff9be2010-02-15 16:12:20 +0000383 if (!PTy->getElementType()->isIntegerTy(1))
Dan Gohman183a4232010-02-10 06:13:07 +0000384 return
385 getFoldedSizeOf(PointerType::get(IntegerType::get(PTy->getContext(), 1),
386 PTy->getAddressSpace()),
387 DestTy, true);
388
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000389 // If there's no interesting folding happening, bail so that we don't create
390 // a constant that looks like it needs folding but really doesn't.
391 if (!Folded)
Craig Topperc6207612014-04-09 06:08:46 +0000392 return nullptr;
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000393
394 // Base case: Get a regular sizeof expression.
395 Constant *C = ConstantExpr::getSizeOf(Ty);
396 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
397 DestTy, false),
398 C, DestTy);
399 return C;
400}
401
Sanjay Patelf3bb6c52016-04-05 18:23:30 +0000402/// Return a ConstantExpr with type DestTy for alignof on Ty, with any known
403/// factors factored out. If Folded is false, return null if no factoring was
404/// possible, to avoid endlessly bouncing an unfoldable expression back into the
405/// top-level folder.
Sanjay Patel2ad88f82017-06-12 22:34:37 +0000406static Constant *getFoldedAlignOf(Type *Ty, Type *DestTy, bool Folded) {
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000407 // The alignment of an array is equal to the alignment of the
408 // array element. Note that this is not always true for vectors.
Chris Lattner229907c2011-07-18 04:54:35 +0000409 if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000410 Constant *C = ConstantExpr::getAlignOf(ATy->getElementType());
411 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
412 DestTy,
413 false),
414 C, DestTy);
415 return C;
416 }
417
Chris Lattner229907c2011-07-18 04:54:35 +0000418 if (StructType *STy = dyn_cast<StructType>(Ty)) {
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000419 // Packed structs always have an alignment of 1.
420 if (STy->isPacked())
421 return ConstantInt::get(DestTy, 1);
422
423 // Otherwise, struct alignment is the maximum alignment of any member.
424 // Without target data, we can't compare much, but we can check to see
425 // if all the members have the same alignment.
426 unsigned NumElems = STy->getNumElements();
427 // An empty struct has minimal alignment.
428 if (NumElems == 0)
429 return ConstantInt::get(DestTy, 1);
430 // Check for a struct with all members having the same alignment.
431 Constant *MemberAlign =
432 getFoldedAlignOf(STy->getElementType(0), DestTy, true);
433 bool AllSame = true;
434 for (unsigned i = 1; i != NumElems; ++i)
435 if (MemberAlign != getFoldedAlignOf(STy->getElementType(i), DestTy, true)) {
436 AllSame = false;
437 break;
438 }
439 if (AllSame)
440 return MemberAlign;
441 }
442
Dan Gohman183a4232010-02-10 06:13:07 +0000443 // Pointer alignment doesn't depend on the pointee type, so canonicalize them
444 // to an arbitrary pointee.
Chris Lattner229907c2011-07-18 04:54:35 +0000445 if (PointerType *PTy = dyn_cast<PointerType>(Ty))
Duncan Sands9dff9be2010-02-15 16:12:20 +0000446 if (!PTy->getElementType()->isIntegerTy(1))
Dan Gohman183a4232010-02-10 06:13:07 +0000447 return
448 getFoldedAlignOf(PointerType::get(IntegerType::get(PTy->getContext(),
449 1),
450 PTy->getAddressSpace()),
451 DestTy, true);
452
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000453 // If there's no interesting folding happening, bail so that we don't create
454 // a constant that looks like it needs folding but really doesn't.
455 if (!Folded)
Craig Topperc6207612014-04-09 06:08:46 +0000456 return nullptr;
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000457
458 // Base case: Get a regular alignof expression.
459 Constant *C = ConstantExpr::getAlignOf(Ty);
460 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
461 DestTy, false),
462 C, DestTy);
463 return C;
464}
465
Sanjay Patelf3bb6c52016-04-05 18:23:30 +0000466/// Return a ConstantExpr with type DestTy for offsetof on Ty and FieldNo, with
467/// any known factors factored out. If Folded is false, return null if no
468/// factoring was possible, to avoid endlessly bouncing an unfoldable expression
469/// back into the top-level folder.
Sanjay Patel2ad88f82017-06-12 22:34:37 +0000470static Constant *getFoldedOffsetOf(Type *Ty, Constant *FieldNo, Type *DestTy,
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000471 bool Folded) {
Chris Lattner229907c2011-07-18 04:54:35 +0000472 if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000473 Constant *N = ConstantExpr::getCast(CastInst::getCastOpcode(FieldNo, false,
474 DestTy, false),
475 FieldNo, DestTy);
476 Constant *E = getFoldedSizeOf(ATy->getElementType(), DestTy, true);
477 return ConstantExpr::getNUWMul(E, N);
478 }
Dan Gohman935faff2010-02-25 16:05:33 +0000479
Chris Lattner229907c2011-07-18 04:54:35 +0000480 if (StructType *STy = dyn_cast<StructType>(Ty))
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000481 if (!STy->isPacked()) {
482 unsigned NumElems = STy->getNumElements();
483 // An empty struct has no members.
484 if (NumElems == 0)
Craig Topperc6207612014-04-09 06:08:46 +0000485 return nullptr;
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000486 // Check for a struct with all members having the same size.
487 Constant *MemberSize =
488 getFoldedSizeOf(STy->getElementType(0), DestTy, true);
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000489 bool AllSame = true;
490 for (unsigned i = 1; i != NumElems; ++i)
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000491 if (MemberSize !=
492 getFoldedSizeOf(STy->getElementType(i), DestTy, true)) {
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000493 AllSame = false;
494 break;
495 }
496 if (AllSame) {
497 Constant *N = ConstantExpr::getCast(CastInst::getCastOpcode(FieldNo,
498 false,
499 DestTy,
500 false),
501 FieldNo, DestTy);
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000502 return ConstantExpr::getNUWMul(MemberSize, N);
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000503 }
504 }
505
506 // If there's no interesting folding happening, bail so that we don't create
507 // a constant that looks like it needs folding but really doesn't.
508 if (!Folded)
Craig Topperc6207612014-04-09 06:08:46 +0000509 return nullptr;
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000510
511 // Base case: Get a regular offsetof expression.
512 Constant *C = ConstantExpr::getOffsetOf(Ty, FieldNo);
513 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
514 DestTy, false),
515 C, DestTy);
516 return C;
517}
Chris Lattnerf67d2972009-10-17 21:53:27 +0000518
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000519Constant *llvm::ConstantFoldCastInstruction(unsigned opc, Constant *V,
Chris Lattner229907c2011-07-18 04:54:35 +0000520 Type *DestTy) {
Chris Lattner363485d2007-07-20 22:09:02 +0000521 if (isa<UndefValue>(V)) {
522 // zext(undef) = 0, because the top bits will be zero.
523 // sext(undef) = 0, because the top bits will all be the same.
Chris Lattnerb4c6cc92008-02-19 06:22:12 +0000524 // [us]itofp(undef) = 0, because the result value is bounded.
525 if (opc == Instruction::ZExt || opc == Instruction::SExt ||
526 opc == Instruction::UIToFP || opc == Instruction::SIToFP)
Owen Anderson5a1acd92009-07-31 20:28:14 +0000527 return Constant::getNullValue(DestTy);
Owen Andersonb292b8c2009-07-30 23:03:37 +0000528 return UndefValue::get(DestTy);
Chris Lattner363485d2007-07-20 22:09:02 +0000529 }
Nick Lewycky39b12c02011-01-21 01:12:09 +0000530
Matt Arsenault2907e512016-05-21 00:14:04 +0000531 if (V->isNullValue() && !DestTy->isX86_MMXTy() &&
532 opc != Instruction::AddrSpaceCast)
Nick Lewycky39b12c02011-01-21 01:12:09 +0000533 return Constant::getNullValue(DestTy);
534
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000535 // If the cast operand is a constant expression, there's a few things we can
536 // do to try to simplify it.
Nick Lewyckye0332982009-09-20 01:35:59 +0000537 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000538 if (CE->isCast()) {
Reid Spencer1a063892006-12-04 02:46:44 +0000539 // Try hard to fold cast of cast because they are often eliminable.
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000540 if (unsigned newOpc = foldConstantCastPair(opc, CE, DestTy))
Owen Anderson487375e2009-07-29 18:55:55 +0000541 return ConstantExpr::getCast(newOpc, CE->getOperand(0), DestTy);
Jingyue Wubaabe502014-06-15 21:40:57 +0000542 } else if (CE->getOpcode() == Instruction::GetElementPtr &&
543 // Do not fold addrspacecast (gep 0, .., 0). It might make the
544 // addrspacecast uncanonicalized.
Peter Collingbourned93620b2016-11-10 22:34:55 +0000545 opc != Instruction::AddrSpaceCast &&
546 // Do not fold bitcast (gep) with inrange index, as this loses
547 // information.
548 !cast<GEPOperator>(CE)->getInRangeIndex().hasValue()) {
Chris Lattner1dd054c2004-01-12 22:07:24 +0000549 // If all of the indexes in the GEP are null values, there is no pointer
550 // adjustment going on. We might as well cast the source pointer.
551 bool isAllNull = true;
552 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
553 if (!CE->getOperand(i)->isNullValue()) {
554 isAllNull = false;
555 break;
556 }
557 if (isAllNull)
Reid Spencer1a063892006-12-04 02:46:44 +0000558 // This is casting one pointer type to another, always BitCast
Owen Anderson487375e2009-07-29 18:55:55 +0000559 return ConstantExpr::getPointerCast(CE->getOperand(0), DestTy);
Chris Lattner1dd054c2004-01-12 22:07:24 +0000560 }
Chris Lattnerfd7bf722004-10-16 23:31:32 +0000561 }
Chris Lattner1dd054c2004-01-12 22:07:24 +0000562
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000563 // If the cast operand is a constant vector, perform the cast by
564 // operating on each element. In the cast of bitcasts, the element
565 // count may be mismatched; don't attempt to handle that here.
Chris Lattner0256be92012-01-27 03:08:05 +0000566 if ((isa<ConstantVector>(V) || isa<ConstantDataVector>(V)) &&
567 DestTy->isVectorTy() &&
568 DestTy->getVectorNumElements() == V->getType()->getVectorNumElements()) {
569 SmallVector<Constant*, 16> res;
570 VectorType *DestVecTy = cast<VectorType>(DestTy);
571 Type *DstEltTy = DestVecTy->getElementType();
Dan Gohman1ccecdb2012-04-27 17:50:22 +0000572 Type *Ty = IntegerType::get(V->getContext(), 32);
573 for (unsigned i = 0, e = V->getType()->getVectorNumElements(); i != e; ++i) {
574 Constant *C =
575 ConstantExpr::getExtractElement(V, ConstantInt::get(Ty, i));
576 res.push_back(ConstantExpr::getCast(opc, C, DstEltTy));
577 }
Chris Lattner0256be92012-01-27 03:08:05 +0000578 return ConstantVector::get(res);
579 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000580
Reid Spencerf5fc34a2006-12-19 03:15:47 +0000581 // We actually have to do a cast now. Perform the cast according to the
582 // opcode specified.
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000583 switch (opc) {
Chris Lattnerf67d2972009-10-17 21:53:27 +0000584 default:
585 llvm_unreachable("Failed to cast constant expression");
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000586 case Instruction::FPTrunc:
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000587 case Instruction::FPExt:
Nick Lewyckye0332982009-09-20 01:35:59 +0000588 if (ConstantFP *FPC = dyn_cast<ConstantFP>(V)) {
Dale Johannesen4f0bd682008-10-09 23:00:39 +0000589 bool ignored;
Dale Johannesenf4bad972007-09-19 14:22:58 +0000590 APFloat Val = FPC->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +0000591 Val.convert(DestTy->isHalfTy() ? APFloat::IEEEhalf() :
592 DestTy->isFloatTy() ? APFloat::IEEEsingle() :
593 DestTy->isDoubleTy() ? APFloat::IEEEdouble() :
594 DestTy->isX86_FP80Ty() ? APFloat::x87DoubleExtended() :
595 DestTy->isFP128Ty() ? APFloat::IEEEquad() :
596 DestTy->isPPC_FP128Ty() ? APFloat::PPCDoubleDouble() :
597 APFloat::Bogus(),
Dale Johannesen4f0bd682008-10-09 23:00:39 +0000598 APFloat::rmNearestTiesToEven, &ignored);
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000599 return ConstantFP::get(V->getContext(), Val);
Dale Johannesenbed9dc42007-09-06 18:13:44 +0000600 }
Craig Topperc6207612014-04-09 06:08:46 +0000601 return nullptr; // Can't fold.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000602 case Instruction::FPToUI:
Reid Spencer8dabca42006-12-19 07:41:40 +0000603 case Instruction::FPToSI:
Nick Lewyckye0332982009-09-20 01:35:59 +0000604 if (ConstantFP *FPC = dyn_cast<ConstantFP>(V)) {
Chris Lattner2b827fd2007-10-15 05:34:10 +0000605 const APFloat &V = FPC->getValueAPF();
Dale Johannesen4f0bd682008-10-09 23:00:39 +0000606 bool ignored;
Reid Spencer81658a82007-02-27 06:23:51 +0000607 uint32_t DestBitWidth = cast<IntegerType>(DestTy)->getBitWidth();
Simon Pilgrim8424df72017-03-19 16:50:25 +0000608 APSInt IntVal(DestBitWidth, opc == Instruction::FPToUI);
Sanjay Patelad8b6662014-10-10 23:00:21 +0000609 if (APFloat::opInvalidOp ==
Simon Pilgrim8424df72017-03-19 16:50:25 +0000610 V.convertToInteger(IntVal, APFloat::rmTowardZero, &ignored)) {
Sanjay Patelad8b6662014-10-10 23:00:21 +0000611 // Undefined behavior invoked - the destination type can't represent
612 // the input constant.
613 return UndefValue::get(DestTy);
614 }
Simon Pilgrim8424df72017-03-19 16:50:25 +0000615 return ConstantInt::get(FPC->getContext(), IntVal);
Reid Spencer81658a82007-02-27 06:23:51 +0000616 }
Craig Topperc6207612014-04-09 06:08:46 +0000617 return nullptr; // Can't fold.
Reid Spencer8dabca42006-12-19 07:41:40 +0000618 case Instruction::IntToPtr: //always treated as unsigned
619 if (V->isNullValue()) // Is it an integral null value?
Owen Andersonb292b8c2009-07-30 23:03:37 +0000620 return ConstantPointerNull::get(cast<PointerType>(DestTy));
Craig Topperc6207612014-04-09 06:08:46 +0000621 return nullptr; // Other pointer types cannot be casted
Reid Spencer8dabca42006-12-19 07:41:40 +0000622 case Instruction::PtrToInt: // always treated as unsigned
Dan Gohmancf913832010-01-28 02:15:55 +0000623 // Is it a null pointer value?
624 if (V->isNullValue())
Owen Andersonedb4a702009-07-24 23:12:02 +0000625 return ConstantInt::get(DestTy, 0);
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000626 // If this is a sizeof-like expression, pull out multiplications by
627 // known factors to expose them to subsequent folding. If it's an
628 // alignof-like expression, factor out known factors.
Dan Gohmancf913832010-01-28 02:15:55 +0000629 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
630 if (CE->getOpcode() == Instruction::GetElementPtr &&
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000631 CE->getOperand(0)->isNullValue()) {
Bjorn Pettersson1c043a92017-10-24 12:08:11 +0000632 // FIXME: Looks like getFoldedSizeOf(), getFoldedOffsetOf() and
633 // getFoldedAlignOf() don't handle the case when DestTy is a vector of
634 // pointers yet. We end up in asserts in CastInst::getCastOpcode (see
635 // test/Analysis/ConstantFolding/cast-vector.ll). I've only seen this
636 // happen in one "real" C-code test case, so it does not seem to be an
637 // important optimization to handle vectors here. For now, simply bail
638 // out.
639 if (DestTy->isVectorTy())
640 return nullptr;
David Blaikie4c2814e2015-05-13 18:35:29 +0000641 GEPOperator *GEPO = cast<GEPOperator>(CE);
642 Type *Ty = GEPO->getSourceElementType();
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000643 if (CE->getNumOperands() == 2) {
644 // Handle a sizeof-like expression.
645 Constant *Idx = CE->getOperand(1);
646 bool isOne = isa<ConstantInt>(Idx) && cast<ConstantInt>(Idx)->isOne();
647 if (Constant *C = getFoldedSizeOf(Ty, DestTy, !isOne)) {
648 Idx = ConstantExpr::getCast(CastInst::getCastOpcode(Idx, true,
Dan Gohmancf913832010-01-28 02:15:55 +0000649 DestTy, false),
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000650 Idx, DestTy);
651 return ConstantExpr::getMul(C, Idx);
Dan Gohmancf913832010-01-28 02:15:55 +0000652 }
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000653 } else if (CE->getNumOperands() == 3 &&
654 CE->getOperand(1)->isNullValue()) {
655 // Handle an alignof-like expression.
Chris Lattner229907c2011-07-18 04:54:35 +0000656 if (StructType *STy = dyn_cast<StructType>(Ty))
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000657 if (!STy->isPacked()) {
658 ConstantInt *CI = cast<ConstantInt>(CE->getOperand(2));
659 if (CI->isOne() &&
660 STy->getNumElements() == 2 &&
Duncan Sands9dff9be2010-02-15 16:12:20 +0000661 STy->getElementType(0)->isIntegerTy(1)) {
Dan Gohmanf644af8b2010-02-02 01:41:39 +0000662 return getFoldedAlignOf(STy->getElementType(1), DestTy, false);
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000663 }
664 }
665 // Handle an offsetof-like expression.
Dan Gohman520913c2010-06-05 00:47:34 +0000666 if (Ty->isStructTy() || Ty->isArrayTy()) {
Dan Gohmane5e1b7b2010-02-01 18:27:38 +0000667 if (Constant *C = getFoldedOffsetOf(Ty, CE->getOperand(2),
668 DestTy, false))
669 return C;
670 }
671 }
672 }
Dan Gohmancf913832010-01-28 02:15:55 +0000673 // Other pointer types cannot be casted
Craig Topperc6207612014-04-09 06:08:46 +0000674 return nullptr;
Reid Spencer8dabca42006-12-19 07:41:40 +0000675 case Instruction::UIToFP:
Reid Spencer8dabca42006-12-19 07:41:40 +0000676 case Instruction::SIToFP:
Nick Lewyckye0332982009-09-20 01:35:59 +0000677 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Benjamin Kramer8f59adb2016-02-13 16:54:14 +0000678 const APInt &api = CI->getValue();
Tim Northover29178a32013-01-22 09:46:31 +0000679 APFloat apf(DestTy->getFltSemantics(),
680 APInt::getNullValue(DestTy->getPrimitiveSizeInBits()));
Sanjay Patelad8b6662014-10-10 23:00:21 +0000681 if (APFloat::opOverflow &
682 apf.convertFromAPInt(api, opc==Instruction::SIToFP,
683 APFloat::rmNearestTiesToEven)) {
684 // Undefined behavior invoked - the destination type can't represent
685 // the input constant.
686 return UndefValue::get(DestTy);
687 }
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000688 return ConstantFP::get(V->getContext(), apf);
Dale Johannesenbed9dc42007-09-06 18:13:44 +0000689 }
Craig Topperc6207612014-04-09 06:08:46 +0000690 return nullptr;
Reid Spencerf5fc34a2006-12-19 03:15:47 +0000691 case Instruction::ZExt:
Nick Lewyckye0332982009-09-20 01:35:59 +0000692 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Reid Spencer81658a82007-02-27 06:23:51 +0000693 uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
Jay Foad583abbc2010-12-07 08:25:19 +0000694 return ConstantInt::get(V->getContext(),
695 CI->getValue().zext(BitWidth));
Reid Spencer81658a82007-02-27 06:23:51 +0000696 }
Craig Topperc6207612014-04-09 06:08:46 +0000697 return nullptr;
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000698 case Instruction::SExt:
Nick Lewyckye0332982009-09-20 01:35:59 +0000699 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Reid Spencer81658a82007-02-27 06:23:51 +0000700 uint32_t BitWidth = cast<IntegerType>(DestTy)->getBitWidth();
Jay Foad583abbc2010-12-07 08:25:19 +0000701 return ConstantInt::get(V->getContext(),
702 CI->getValue().sext(BitWidth));
Reid Spencer81658a82007-02-27 06:23:51 +0000703 }
Craig Topperc6207612014-04-09 06:08:46 +0000704 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000705 case Instruction::Trunc: {
Jiangning Liu950844f2014-08-21 02:12:35 +0000706 if (V->getType()->isVectorTy())
707 return nullptr;
708
Chris Lattnerf67d2972009-10-17 21:53:27 +0000709 uint32_t DestBitWidth = cast<IntegerType>(DestTy)->getBitWidth();
Nick Lewyckye0332982009-09-20 01:35:59 +0000710 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Jay Foad583abbc2010-12-07 08:25:19 +0000711 return ConstantInt::get(V->getContext(),
712 CI->getValue().trunc(DestBitWidth));
Reid Spencer81658a82007-02-27 06:23:51 +0000713 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000714
Chris Lattnerf67d2972009-10-17 21:53:27 +0000715 // The input must be a constantexpr. See if we can simplify this based on
716 // the bytes we are demanding. Only do this if the source and dest are an
717 // even multiple of a byte.
718 if ((DestBitWidth & 7) == 0 &&
719 (cast<IntegerType>(V->getType())->getBitWidth() & 7) == 0)
720 if (Constant *Res = ExtractConstantBytes(V, 0, DestBitWidth / 8))
721 return Res;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000722
Craig Topperc6207612014-04-09 06:08:46 +0000723 return nullptr;
Chris Lattnerf67d2972009-10-17 21:53:27 +0000724 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000725 case Instruction::BitCast:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000726 return FoldBitCast(V, DestTy);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +0000727 case Instruction::AddrSpaceCast:
Craig Topperc6207612014-04-09 06:08:46 +0000728 return nullptr;
Chris Lattner6b3f4752006-04-02 01:38:28 +0000729 }
Chris Lattner1dd054c2004-01-12 22:07:24 +0000730}
731
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000732Constant *llvm::ConstantFoldSelectInstruction(Constant *Cond,
Nick Lewyckye0332982009-09-20 01:35:59 +0000733 Constant *V1, Constant *V2) {
Chris Lattnerfa775002012-01-26 02:32:04 +0000734 // Check for i1 and vector true/false conditions.
Nadav Rotem10134c32011-02-11 19:37:55 +0000735 if (Cond->isNullValue()) return V2;
Chris Lattnerfa775002012-01-26 02:32:04 +0000736 if (Cond->isAllOnesValue()) return V1;
Nadav Rotem10134c32011-02-11 19:37:55 +0000737
Chris Lattnerfa775002012-01-26 02:32:04 +0000738 // If the condition is a vector constant, fold the result elementwise.
739 if (ConstantVector *CondV = dyn_cast<ConstantVector>(Cond)) {
740 SmallVector<Constant*, 16> Result;
Dan Gohman1ccecdb2012-04-27 17:50:22 +0000741 Type *Ty = IntegerType::get(CondV->getContext(), 32);
Chris Lattnerfa775002012-01-26 02:32:04 +0000742 for (unsigned i = 0, e = V1->getType()->getVectorNumElements(); i != e;++i){
Nick Lewycky2d4ba2e2013-12-31 19:30:47 +0000743 Constant *V;
744 Constant *V1Element = ConstantExpr::getExtractElement(V1,
745 ConstantInt::get(Ty, i));
746 Constant *V2Element = ConstantExpr::getExtractElement(V2,
747 ConstantInt::get(Ty, i));
748 Constant *Cond = dyn_cast<Constant>(CondV->getOperand(i));
749 if (V1Element == V2Element) {
750 V = V1Element;
751 } else if (isa<UndefValue>(Cond)) {
752 V = isa<UndefValue>(V1Element) ? V1Element : V2Element;
753 } else {
754 if (!isa<ConstantInt>(Cond)) break;
755 V = Cond->isNullValue() ? V2Element : V1Element;
756 }
757 Result.push_back(V);
Nadav Rotem10134c32011-02-11 19:37:55 +0000758 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000759
Chris Lattnerfa775002012-01-26 02:32:04 +0000760 // If we were able to build the vector, return it.
761 if (Result.size() == V1->getType()->getVectorNumElements())
762 return ConstantVector::get(Result);
Nadav Rotem10134c32011-02-11 19:37:55 +0000763 }
Nadav Rotem10134c32011-02-11 19:37:55 +0000764
Dan Gohman54664ed2011-07-01 01:03:43 +0000765 if (isa<UndefValue>(Cond)) {
766 if (isa<UndefValue>(V1)) return V1;
767 return V2;
768 }
Nick Lewyckye0332982009-09-20 01:35:59 +0000769 if (isa<UndefValue>(V1)) return V2;
770 if (isa<UndefValue>(V2)) return V1;
Nick Lewyckye0332982009-09-20 01:35:59 +0000771 if (V1 == V2) return V1;
Nick Lewycky97a28952011-01-29 20:35:06 +0000772
773 if (ConstantExpr *TrueVal = dyn_cast<ConstantExpr>(V1)) {
774 if (TrueVal->getOpcode() == Instruction::Select)
775 if (TrueVal->getOperand(0) == Cond)
Bill Wendlingea6397f2012-07-19 00:11:40 +0000776 return ConstantExpr::getSelect(Cond, TrueVal->getOperand(1), V2);
Nick Lewycky97a28952011-01-29 20:35:06 +0000777 }
778 if (ConstantExpr *FalseVal = dyn_cast<ConstantExpr>(V2)) {
779 if (FalseVal->getOpcode() == Instruction::Select)
780 if (FalseVal->getOperand(0) == Cond)
Bill Wendlingea6397f2012-07-19 00:11:40 +0000781 return ConstantExpr::getSelect(Cond, V1, FalseVal->getOperand(2));
Nick Lewycky97a28952011-01-29 20:35:06 +0000782 }
783
Craig Topperc6207612014-04-09 06:08:46 +0000784 return nullptr;
Chris Lattner6ea4b522004-03-12 05:53:32 +0000785}
786
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000787Constant *llvm::ConstantFoldExtractElementInstruction(Constant *Val,
Nick Lewyckye0332982009-09-20 01:35:59 +0000788 Constant *Idx) {
Chris Lattnere52f29b2006-03-31 18:31:40 +0000789 if (isa<UndefValue>(Val)) // ee(undef, x) -> undef
Chris Lattner0256be92012-01-27 03:08:05 +0000790 return UndefValue::get(Val->getType()->getVectorElementType());
Chris Lattnere4f9d7b2006-04-07 04:44:06 +0000791 if (Val->isNullValue()) // ee(zero, x) -> zero
Chris Lattner0256be92012-01-27 03:08:05 +0000792 return Constant::getNullValue(Val->getType()->getVectorElementType());
793 // ee({w,x,y,z}, undef) -> undef
794 if (isa<UndefValue>(Idx))
795 return UndefValue::get(Val->getType()->getVectorElementType());
Dan Gohman062d3782009-08-29 23:35:16 +0000796
Chris Lattner0256be92012-01-27 03:08:05 +0000797 if (ConstantInt *CIdx = dyn_cast<ConstantInt>(Idx)) {
Chris Lattner0256be92012-01-27 03:08:05 +0000798 // ee({w,x,y,z}, wrong_value) -> undef
Pawel Bylicabce9c2e2015-04-24 07:42:35 +0000799 if (CIdx->uge(Val->getType()->getVectorNumElements()))
Chris Lattner0256be92012-01-27 03:08:05 +0000800 return UndefValue::get(Val->getType()->getVectorElementType());
Pawel Bylicabce9c2e2015-04-24 07:42:35 +0000801 return Val->getAggregateElement(CIdx->getZExtValue());
Chris Lattnere52f29b2006-03-31 18:31:40 +0000802 }
Craig Topperc6207612014-04-09 06:08:46 +0000803 return nullptr;
Robert Bocchinode7f1c92006-01-10 20:03:46 +0000804}
805
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000806Constant *llvm::ConstantFoldInsertElementInstruction(Constant *Val,
Nick Lewyckye0332982009-09-20 01:35:59 +0000807 Constant *Elt,
808 Constant *Idx) {
Pawel Bylicac25918a2015-04-27 09:30:49 +0000809 if (isa<UndefValue>(Idx))
810 return UndefValue::get(Val->getType());
811
Nick Lewyckye0332982009-09-20 01:35:59 +0000812 ConstantInt *CIdx = dyn_cast<ConstantInt>(Idx);
Craig Topperc6207612014-04-09 06:08:46 +0000813 if (!CIdx) return nullptr;
Pawel Bylicac25918a2015-04-27 09:30:49 +0000814
815 unsigned NumElts = Val->getType()->getVectorNumElements();
816 if (CIdx->uge(NumElts))
817 return UndefValue::get(Val->getType());
818
Chris Lattnerfa775002012-01-26 02:32:04 +0000819 SmallVector<Constant*, 16> Result;
Pawel Bylicac25918a2015-04-27 09:30:49 +0000820 Result.reserve(NumElts);
821 auto *Ty = Type::getInt32Ty(Val->getContext());
822 uint64_t IdxVal = CIdx->getZExtValue();
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000823 for (unsigned i = 0; i != NumElts; ++i) {
Chris Lattnerfa775002012-01-26 02:32:04 +0000824 if (i == IdxVal) {
825 Result.push_back(Elt);
826 continue;
Robert Bocchinoca27f032006-01-17 20:07:22 +0000827 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000828
Pawel Bylicac25918a2015-04-27 09:30:49 +0000829 Constant *C = ConstantExpr::getExtractElement(Val, ConstantInt::get(Ty, i));
Dan Gohman1ccecdb2012-04-27 17:50:22 +0000830 Result.push_back(C);
Robert Bocchinoca27f032006-01-17 20:07:22 +0000831 }
Pawel Bylicac25918a2015-04-27 09:30:49 +0000832
Chris Lattnerfa775002012-01-26 02:32:04 +0000833 return ConstantVector::get(Result);
Chris Lattner8e6a8f92007-12-11 07:49:37 +0000834}
835
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000836Constant *llvm::ConstantFoldShuffleVectorInstruction(Constant *V1,
Nick Lewyckye0332982009-09-20 01:35:59 +0000837 Constant *V2,
838 Constant *Mask) {
Chris Lattnerc2783002012-01-30 05:34:13 +0000839 unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
840 Type *EltTy = V1->getType()->getVectorElementType();
841
Chris Lattner8e6a8f92007-12-11 07:49:37 +0000842 // Undefined shuffle mask -> undefined value.
Chris Lattnerc2783002012-01-30 05:34:13 +0000843 if (isa<UndefValue>(Mask))
844 return UndefValue::get(VectorType::get(EltTy, MaskNumElts));
Mon P Wang25f01062008-11-10 04:46:22 +0000845
Chris Lattner34d9a172012-01-26 03:10:45 +0000846 // Don't break the bitcode reader hack.
Craig Topperc6207612014-04-09 06:08:46 +0000847 if (isa<ConstantExpr>(Mask)) return nullptr;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000848
Chris Lattner8722fe52012-01-26 02:54:54 +0000849 unsigned SrcNumElts = V1->getType()->getVectorNumElements();
Mon P Wang25f01062008-11-10 04:46:22 +0000850
Chris Lattner8e6a8f92007-12-11 07:49:37 +0000851 // Loop over the shuffle mask, evaluating each element.
852 SmallVector<Constant*, 32> Result;
Mon P Wang25f01062008-11-10 04:46:22 +0000853 for (unsigned i = 0; i != MaskNumElts; ++i) {
Chris Lattner8722fe52012-01-26 02:54:54 +0000854 int Elt = ShuffleVectorInst::getMaskValue(Mask, i);
855 if (Elt == -1) {
Chris Lattnerfa775002012-01-26 02:32:04 +0000856 Result.push_back(UndefValue::get(EltTy));
857 continue;
Chris Lattner8e6a8f92007-12-11 07:49:37 +0000858 }
Chris Lattner8722fe52012-01-26 02:54:54 +0000859 Constant *InElt;
860 if (unsigned(Elt) >= SrcNumElts*2)
Chris Lattnerfa775002012-01-26 02:32:04 +0000861 InElt = UndefValue::get(EltTy);
Dan Gohman1ccecdb2012-04-27 17:50:22 +0000862 else if (unsigned(Elt) >= SrcNumElts) {
863 Type *Ty = IntegerType::get(V2->getContext(), 32);
864 InElt =
865 ConstantExpr::getExtractElement(V2,
866 ConstantInt::get(Ty, Elt - SrcNumElts));
867 } else {
868 Type *Ty = IntegerType::get(V1->getContext(), 32);
869 InElt = ConstantExpr::getExtractElement(V1, ConstantInt::get(Ty, Elt));
870 }
Chris Lattner8e6a8f92007-12-11 07:49:37 +0000871 Result.push_back(InElt);
872 }
Mon P Wang25f01062008-11-10 04:46:22 +0000873
Chris Lattner69229312011-02-15 00:14:00 +0000874 return ConstantVector::get(Result);
Chris Lattnerbbe0a422006-04-08 01:18:18 +0000875}
876
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000877Constant *llvm::ConstantFoldExtractValueInstruction(Constant *Agg,
Jay Foad57aa6362011-07-13 10:26:04 +0000878 ArrayRef<unsigned> Idxs) {
Dan Gohman3db11c22008-06-03 00:15:20 +0000879 // Base case: no indices, so return the entire value.
Jay Foad57aa6362011-07-13 10:26:04 +0000880 if (Idxs.empty())
Nick Lewyckye0332982009-09-20 01:35:59 +0000881 return Agg;
Dan Gohman3db11c22008-06-03 00:15:20 +0000882
Chris Lattnerfa775002012-01-26 02:32:04 +0000883 if (Constant *C = Agg->getAggregateElement(Idxs[0]))
884 return ConstantFoldExtractValueInstruction(C, Idxs.slice(1));
Dan Gohman3db11c22008-06-03 00:15:20 +0000885
Craig Topperc6207612014-04-09 06:08:46 +0000886 return nullptr;
Dan Gohman12fce772008-05-15 19:50:34 +0000887}
888
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000889Constant *llvm::ConstantFoldInsertValueInstruction(Constant *Agg,
Nick Lewyckye0332982009-09-20 01:35:59 +0000890 Constant *Val,
Jay Foad57aa6362011-07-13 10:26:04 +0000891 ArrayRef<unsigned> Idxs) {
Dan Gohman3db11c22008-06-03 00:15:20 +0000892 // Base case: no indices, so replace the entire value.
Jay Foad57aa6362011-07-13 10:26:04 +0000893 if (Idxs.empty())
Nick Lewyckye0332982009-09-20 01:35:59 +0000894 return Val;
Dan Gohman3db11c22008-06-03 00:15:20 +0000895
Chris Lattnerfa775002012-01-26 02:32:04 +0000896 unsigned NumElts;
897 if (StructType *ST = dyn_cast<StructType>(Agg->getType()))
898 NumElts = ST->getNumElements();
Chris Lattnerfa775002012-01-26 02:32:04 +0000899 else
Peter Collingbournebc070522016-12-02 03:20:58 +0000900 NumElts = cast<SequentialType>(Agg->getType())->getNumElements();
Nadav Rotem0e488032013-02-19 19:36:59 +0000901
Chris Lattnerfa775002012-01-26 02:32:04 +0000902 SmallVector<Constant*, 32> Result;
903 for (unsigned i = 0; i != NumElts; ++i) {
904 Constant *C = Agg->getAggregateElement(i);
Craig Topperc6207612014-04-09 06:08:46 +0000905 if (!C) return nullptr;
906
Chris Lattnerfa775002012-01-26 02:32:04 +0000907 if (Idxs[0] == i)
908 C = ConstantFoldInsertValueInstruction(C, Val, Idxs.slice(1));
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000909
Chris Lattnerfa775002012-01-26 02:32:04 +0000910 Result.push_back(C);
Dan Gohman3db11c22008-06-03 00:15:20 +0000911 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +0000912
Chris Lattnerfa775002012-01-26 02:32:04 +0000913 if (StructType *ST = dyn_cast<StructType>(Agg->getType()))
914 return ConstantStruct::get(ST, Result);
915 if (ArrayType *AT = dyn_cast<ArrayType>(Agg->getType()))
916 return ConstantArray::get(AT, Result);
917 return ConstantVector::get(Result);
Dan Gohman12fce772008-05-15 19:50:34 +0000918}
919
Reid Spencer266e42b2006-12-23 06:05:41 +0000920
Chris Lattnerf5edeeb2010-02-01 20:48:08 +0000921Constant *llvm::ConstantFoldBinaryInstruction(unsigned Opcode,
Nick Lewyckye0332982009-09-20 01:35:59 +0000922 Constant *C1, Constant *C2) {
Simon Pilgrimb57b0022016-03-21 22:15:50 +0000923 assert(Instruction::isBinaryOp(Opcode) && "Non-binary instruction detected");
924
Chris Lattneree8f74f2009-09-15 06:28:12 +0000925 // Handle UndefValue up front.
Reid Spencer266e42b2006-12-23 06:05:41 +0000926 if (isa<UndefValue>(C1) || isa<UndefValue>(C2)) {
Simon Pilgrimb57b0022016-03-21 22:15:50 +0000927 switch (static_cast<Instruction::BinaryOps>(Opcode)) {
Evan Chengdf1690d2008-03-25 20:08:07 +0000928 case Instruction::Xor:
929 if (isa<UndefValue>(C1) && isa<UndefValue>(C2))
930 // Handle undef ^ undef -> 0 special case. This is a common
931 // idiom (misuse).
Owen Anderson5a1acd92009-07-31 20:28:14 +0000932 return Constant::getNullValue(C1->getType());
Justin Bognerb03fd122016-08-17 05:10:15 +0000933 LLVM_FALLTHROUGH;
Reid Spencer266e42b2006-12-23 06:05:41 +0000934 case Instruction::Add:
935 case Instruction::Sub:
Owen Andersonb292b8c2009-07-30 23:03:37 +0000936 return UndefValue::get(C1->getType());
Reid Spencer266e42b2006-12-23 06:05:41 +0000937 case Instruction::And:
Dan Gohmanca8d9e12011-07-01 00:42:17 +0000938 if (isa<UndefValue>(C1) && isa<UndefValue>(C2)) // undef & undef -> undef
939 return C1;
940 return Constant::getNullValue(C1->getType()); // undef & X -> 0
941 case Instruction::Mul: {
David Majnemer37296682014-12-10 21:58:17 +0000942 // undef * undef -> undef
943 if (isa<UndefValue>(C1) && isa<UndefValue>(C2))
944 return C1;
945 const APInt *CV;
946 // X * undef -> undef if X is odd
947 if (match(C1, m_APInt(CV)) || match(C2, m_APInt(CV)))
948 if ((*CV)[0])
949 return UndefValue::get(C1->getType());
Dan Gohmanca8d9e12011-07-01 00:42:17 +0000950
951 // X * undef -> 0 otherwise
Owen Anderson5a1acd92009-07-31 20:28:14 +0000952 return Constant::getNullValue(C1->getType());
Dan Gohmanca8d9e12011-07-01 00:42:17 +0000953 }
Reid Spencer266e42b2006-12-23 06:05:41 +0000954 case Instruction::SDiv:
David Majnemer7b86b772014-12-10 09:14:55 +0000955 case Instruction::UDiv:
956 // X / undef -> undef
Justin Bogner08154bf2016-02-25 01:02:18 +0000957 if (isa<UndefValue>(C2))
David Majnemer7b86b772014-12-10 09:14:55 +0000958 return C2;
959 // undef / 0 -> undef
Dan Gohmanca8d9e12011-07-01 00:42:17 +0000960 // undef / 1 -> undef
David Majnemer7b86b772014-12-10 09:14:55 +0000961 if (match(C2, m_Zero()) || match(C2, m_One()))
962 return C1;
963 // undef / X -> 0 otherwise
964 return Constant::getNullValue(C1->getType());
Reid Spencer266e42b2006-12-23 06:05:41 +0000965 case Instruction::URem:
966 case Instruction::SRem:
David Majnemer7b86b772014-12-10 09:14:55 +0000967 // X % undef -> undef
968 if (match(C2, m_Undef()))
969 return C2;
970 // undef % 0 -> undef
971 if (match(C2, m_Zero()))
972 return C1;
973 // undef % X -> 0 otherwise
974 return Constant::getNullValue(C1->getType());
Reid Spencer266e42b2006-12-23 06:05:41 +0000975 case Instruction::Or: // X | undef -> -1
Dan Gohmanca8d9e12011-07-01 00:42:17 +0000976 if (isa<UndefValue>(C1) && isa<UndefValue>(C2)) // undef | undef -> undef
977 return C1;
978 return Constant::getAllOnesValue(C1->getType()); // undef | X -> ~0
Reid Spencer266e42b2006-12-23 06:05:41 +0000979 case Instruction::LShr:
David Majnemer89cf6d72014-12-10 21:38:05 +0000980 // X >>l undef -> undef
981 if (isa<UndefValue>(C2))
982 return C2;
David Majnemer824e0112014-12-18 23:54:43 +0000983 // undef >>l 0 -> undef
984 if (match(C2, m_Zero()))
985 return C1;
David Majnemer89cf6d72014-12-10 21:38:05 +0000986 // undef >>l X -> 0
987 return Constant::getNullValue(C1->getType());
Reid Spencer266e42b2006-12-23 06:05:41 +0000988 case Instruction::AShr:
David Majnemer89cf6d72014-12-10 21:38:05 +0000989 // X >>a undef -> undef
990 if (isa<UndefValue>(C2))
991 return C2;
David Majnemer824e0112014-12-18 23:54:43 +0000992 // undef >>a 0 -> undef
993 if (match(C2, m_Zero()))
994 return C1;
David Majnemer5a7717e2014-12-10 21:58:15 +0000995 // TODO: undef >>a X -> undef if the shift is exact
996 // undef >>a X -> 0
997 return Constant::getNullValue(C1->getType());
Reid Spencer266e42b2006-12-23 06:05:41 +0000998 case Instruction::Shl:
David Majnemer89cf6d72014-12-10 21:38:05 +0000999 // X << undef -> undef
1000 if (isa<UndefValue>(C2))
1001 return C2;
David Majnemer824e0112014-12-18 23:54:43 +00001002 // undef << 0 -> undef
1003 if (match(C2, m_Zero()))
1004 return C1;
David Majnemer89cf6d72014-12-10 21:38:05 +00001005 // undef << X -> 0
Owen Anderson5a1acd92009-07-31 20:28:14 +00001006 return Constant::getNullValue(C1->getType());
Simon Pilgrimb57b0022016-03-21 22:15:50 +00001007 case Instruction::FAdd:
1008 case Instruction::FSub:
1009 case Instruction::FMul:
1010 case Instruction::FDiv:
1011 case Instruction::FRem:
1012 // TODO: UNDEF handling for binary float instructions.
1013 return nullptr;
1014 case Instruction::BinaryOpsEnd:
1015 llvm_unreachable("Invalid BinaryOp");
Reid Spencer266e42b2006-12-23 06:05:41 +00001016 }
1017 }
1018
Simon Pilgrimb57b0022016-03-21 22:15:50 +00001019 // At this point neither constant should be an UndefValue.
1020 assert(!isa<UndefValue>(C1) && !isa<UndefValue>(C2) &&
1021 "Unexpected UndefValue");
1022
Nick Lewycky6b8320f2009-06-21 01:56:41 +00001023 // Handle simplifications when the RHS is a constant int.
Nick Lewyckye0332982009-09-20 01:35:59 +00001024 if (ConstantInt *CI2 = dyn_cast<ConstantInt>(C2)) {
Chris Lattner334d33c2008-04-19 21:58:19 +00001025 switch (Opcode) {
1026 case Instruction::Add:
Craig Topperca2c8762017-07-06 18:39:49 +00001027 if (CI2->isZero()) return C1; // X + 0 == X
Chris Lattner334d33c2008-04-19 21:58:19 +00001028 break;
1029 case Instruction::Sub:
Craig Topperca2c8762017-07-06 18:39:49 +00001030 if (CI2->isZero()) return C1; // X - 0 == X
Chris Lattner334d33c2008-04-19 21:58:19 +00001031 break;
1032 case Instruction::Mul:
Craig Topperca2c8762017-07-06 18:39:49 +00001033 if (CI2->isZero()) return C2; // X * 0 == 0
1034 if (CI2->isOne())
Nick Lewyckye0332982009-09-20 01:35:59 +00001035 return C1; // X * 1 == X
Chris Lattner334d33c2008-04-19 21:58:19 +00001036 break;
1037 case Instruction::UDiv:
1038 case Instruction::SDiv:
Craig Topperca2c8762017-07-06 18:39:49 +00001039 if (CI2->isOne())
Nick Lewyckye0332982009-09-20 01:35:59 +00001040 return C1; // X / 1 == X
Craig Topperca2c8762017-07-06 18:39:49 +00001041 if (CI2->isZero())
Owen Andersonb292b8c2009-07-30 23:03:37 +00001042 return UndefValue::get(CI2->getType()); // X / 0 == undef
Chris Lattner334d33c2008-04-19 21:58:19 +00001043 break;
1044 case Instruction::URem:
1045 case Instruction::SRem:
Craig Topperca2c8762017-07-06 18:39:49 +00001046 if (CI2->isOne())
Owen Anderson5a1acd92009-07-31 20:28:14 +00001047 return Constant::getNullValue(CI2->getType()); // X % 1 == 0
Craig Topperca2c8762017-07-06 18:39:49 +00001048 if (CI2->isZero())
Owen Andersonb292b8c2009-07-30 23:03:37 +00001049 return UndefValue::get(CI2->getType()); // X % 0 == undef
Chris Lattner334d33c2008-04-19 21:58:19 +00001050 break;
1051 case Instruction::And:
Nick Lewyckye0332982009-09-20 01:35:59 +00001052 if (CI2->isZero()) return C2; // X & 0 == 0
Craig Topper79ab6432017-07-06 18:39:47 +00001053 if (CI2->isMinusOne())
Nick Lewyckye0332982009-09-20 01:35:59 +00001054 return C1; // X & -1 == X
Dan Gohman062d3782009-08-29 23:35:16 +00001055
Nick Lewyckye0332982009-09-20 01:35:59 +00001056 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001057 // (zext i32 to i64) & 4294967295 -> (zext i32 to i64)
Chris Lattner334d33c2008-04-19 21:58:19 +00001058 if (CE1->getOpcode() == Instruction::ZExt) {
1059 unsigned DstWidth = CI2->getType()->getBitWidth();
1060 unsigned SrcWidth =
1061 CE1->getOperand(0)->getType()->getPrimitiveSizeInBits();
1062 APInt PossiblySetBits(APInt::getLowBitsSet(DstWidth, SrcWidth));
1063 if ((PossiblySetBits & CI2->getValue()) == PossiblySetBits)
Nick Lewyckye0332982009-09-20 01:35:59 +00001064 return C1;
Chris Lattner6d94bb72007-03-25 05:47:04 +00001065 }
Dan Gohman062d3782009-08-29 23:35:16 +00001066
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001067 // If and'ing the address of a global with a constant, fold it.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001068 if (CE1->getOpcode() == Instruction::PtrToInt &&
Chris Lattner334d33c2008-04-19 21:58:19 +00001069 isa<GlobalValue>(CE1->getOperand(0))) {
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001070 GlobalValue *GV = cast<GlobalValue>(CE1->getOperand(0));
Dan Gohman062d3782009-08-29 23:35:16 +00001071
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001072 // Functions are at least 4-byte aligned.
1073 unsigned GVAlign = GV->getAlignment();
1074 if (isa<Function>(GV))
1075 GVAlign = std::max(GVAlign, 4U);
Dan Gohman062d3782009-08-29 23:35:16 +00001076
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001077 if (GVAlign > 1) {
1078 unsigned DstWidth = CI2->getType()->getBitWidth();
Yaron Keren004756d2015-05-19 11:46:27 +00001079 unsigned SrcWidth = std::min(DstWidth, Log2_32(GVAlign));
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001080 APInt BitsNotSet(APInt::getLowBitsSet(DstWidth, SrcWidth));
1081
1082 // If checking bits we know are clear, return zero.
1083 if ((CI2->getValue() & BitsNotSet) == CI2->getValue())
Owen Anderson5a1acd92009-07-31 20:28:14 +00001084 return Constant::getNullValue(CI2->getType());
Chris Lattnerbc26e1b2008-04-19 22:17:26 +00001085 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001086 }
Chris Lattner334d33c2008-04-19 21:58:19 +00001087 }
1088 break;
1089 case Instruction::Or:
Craig Topperca2c8762017-07-06 18:39:49 +00001090 if (CI2->isZero()) return C1; // X | 0 == X
Craig Topper79ab6432017-07-06 18:39:47 +00001091 if (CI2->isMinusOne())
Nick Lewyckye0332982009-09-20 01:35:59 +00001092 return C2; // X | -1 == -1
Chris Lattner334d33c2008-04-19 21:58:19 +00001093 break;
1094 case Instruction::Xor:
Craig Topperca2c8762017-07-06 18:39:49 +00001095 if (CI2->isZero()) return C1; // X ^ 0 == X
Nick Lewycky28260402009-09-20 06:24:51 +00001096
1097 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
1098 switch (CE1->getOpcode()) {
1099 default: break;
1100 case Instruction::ICmp:
1101 case Instruction::FCmp:
Nick Lewyckyff550aa2009-09-20 06:27:35 +00001102 // cmp pred ^ true -> cmp !pred
Craig Topperca2c8762017-07-06 18:39:49 +00001103 assert(CI2->isOne());
Nick Lewycky0f8348e2009-09-20 06:26:34 +00001104 CmpInst::Predicate pred = (CmpInst::Predicate)CE1->getPredicate();
Nick Lewycky28260402009-09-20 06:24:51 +00001105 pred = CmpInst::getInversePredicate(pred);
1106 return ConstantExpr::getCompare(pred, CE1->getOperand(0),
1107 CE1->getOperand(1));
1108 }
1109 }
Chris Lattner334d33c2008-04-19 21:58:19 +00001110 break;
1111 case Instruction::AShr:
1112 // ashr (zext C to Ty), C2 -> lshr (zext C, CSA), C2
Nick Lewyckye0332982009-09-20 01:35:59 +00001113 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1))
Chris Lattner6d94bb72007-03-25 05:47:04 +00001114 if (CE1->getOpcode() == Instruction::ZExt) // Top bits known zero.
Nick Lewyckye0332982009-09-20 01:35:59 +00001115 return ConstantExpr::getLShr(C1, C2);
Chris Lattner334d33c2008-04-19 21:58:19 +00001116 break;
Reid Spencer266e42b2006-12-23 06:05:41 +00001117 }
Dan Gohman6c5ac6d2010-02-22 22:43:23 +00001118 } else if (isa<ConstantInt>(C1)) {
1119 // If C1 is a ConstantInt and C2 is not, swap the operands.
1120 if (Instruction::isCommutative(Opcode))
1121 return ConstantExpr::get(Opcode, C2, C1);
Chris Lattner334d33c2008-04-19 21:58:19 +00001122 }
Dan Gohman062d3782009-08-29 23:35:16 +00001123
Nick Lewyckye0332982009-09-20 01:35:59 +00001124 if (ConstantInt *CI1 = dyn_cast<ConstantInt>(C1)) {
1125 if (ConstantInt *CI2 = dyn_cast<ConstantInt>(C2)) {
Chris Lattner6b056052008-04-20 18:24:14 +00001126 const APInt &C1V = CI1->getValue();
1127 const APInt &C2V = CI2->getValue();
Chris Lattner344da522007-01-12 18:42:52 +00001128 switch (Opcode) {
1129 default:
1130 break;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001131 case Instruction::Add:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001132 return ConstantInt::get(CI1->getContext(), C1V + C2V);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001133 case Instruction::Sub:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001134 return ConstantInt::get(CI1->getContext(), C1V - C2V);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001135 case Instruction::Mul:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001136 return ConstantInt::get(CI1->getContext(), C1V * C2V);
Chris Lattner344da522007-01-12 18:42:52 +00001137 case Instruction::UDiv:
Craig Topper79ab6432017-07-06 18:39:47 +00001138 assert(!CI2->isZero() && "Div by zero handled above");
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001139 return ConstantInt::get(CI1->getContext(), C1V.udiv(C2V));
Chris Lattner344da522007-01-12 18:42:52 +00001140 case Instruction::SDiv:
Craig Topper79ab6432017-07-06 18:39:47 +00001141 assert(!CI2->isZero() && "Div by zero handled above");
Reid Spencer81658a82007-02-27 06:23:51 +00001142 if (C2V.isAllOnesValue() && C1V.isMinSignedValue())
Owen Andersonb292b8c2009-07-30 23:03:37 +00001143 return UndefValue::get(CI1->getType()); // MIN_INT / -1 -> undef
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001144 return ConstantInt::get(CI1->getContext(), C1V.sdiv(C2V));
Reid Spencer81658a82007-02-27 06:23:51 +00001145 case Instruction::URem:
Craig Topper79ab6432017-07-06 18:39:47 +00001146 assert(!CI2->isZero() && "Div by zero handled above");
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001147 return ConstantInt::get(CI1->getContext(), C1V.urem(C2V));
Chris Lattnerdd8ef1b2009-01-19 21:55:26 +00001148 case Instruction::SRem:
Craig Topper79ab6432017-07-06 18:39:47 +00001149 assert(!CI2->isZero() && "Div by zero handled above");
Reid Spencer81658a82007-02-27 06:23:51 +00001150 if (C2V.isAllOnesValue() && C1V.isMinSignedValue())
Owen Andersonb292b8c2009-07-30 23:03:37 +00001151 return UndefValue::get(CI1->getType()); // MIN_INT % -1 -> undef
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001152 return ConstantInt::get(CI1->getContext(), C1V.srem(C2V));
Chris Lattner344da522007-01-12 18:42:52 +00001153 case Instruction::And:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001154 return ConstantInt::get(CI1->getContext(), C1V & C2V);
Chris Lattner344da522007-01-12 18:42:52 +00001155 case Instruction::Or:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001156 return ConstantInt::get(CI1->getContext(), C1V | C2V);
Chris Lattner344da522007-01-12 18:42:52 +00001157 case Instruction::Xor:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001158 return ConstantInt::get(CI1->getContext(), C1V ^ C2V);
David Majnemere2a4b852015-03-13 16:39:46 +00001159 case Instruction::Shl:
1160 if (C2V.ult(C1V.getBitWidth()))
1161 return ConstantInt::get(CI1->getContext(), C1V.shl(C2V));
1162 return UndefValue::get(C1->getType()); // too big shift is undef
1163 case Instruction::LShr:
1164 if (C2V.ult(C1V.getBitWidth()))
1165 return ConstantInt::get(CI1->getContext(), C1V.lshr(C2V));
1166 return UndefValue::get(C1->getType()); // too big shift is undef
1167 case Instruction::AShr:
1168 if (C2V.ult(C1V.getBitWidth()))
1169 return ConstantInt::get(CI1->getContext(), C1V.ashr(C2V));
1170 return UndefValue::get(C1->getType()); // too big shift is undef
Reid Spencer266e42b2006-12-23 06:05:41 +00001171 }
1172 }
Nick Lewycky6b8320f2009-06-21 01:56:41 +00001173
1174 switch (Opcode) {
1175 case Instruction::SDiv:
1176 case Instruction::UDiv:
1177 case Instruction::URem:
1178 case Instruction::SRem:
1179 case Instruction::LShr:
1180 case Instruction::AShr:
1181 case Instruction::Shl:
Craig Topperca2c8762017-07-06 18:39:49 +00001182 if (CI1->isZero()) return C1;
Nick Lewycky6b8320f2009-06-21 01:56:41 +00001183 break;
1184 default:
1185 break;
1186 }
Nick Lewyckye0332982009-09-20 01:35:59 +00001187 } else if (ConstantFP *CFP1 = dyn_cast<ConstantFP>(C1)) {
1188 if (ConstantFP *CFP2 = dyn_cast<ConstantFP>(C2)) {
Benjamin Kramer8f59adb2016-02-13 16:54:14 +00001189 const APFloat &C1V = CFP1->getValueAPF();
1190 const APFloat &C2V = CFP2->getValueAPF();
Dale Johannesenbed9dc42007-09-06 18:13:44 +00001191 APFloat C3V = C1V; // copy for modification
Reid Spencer266e42b2006-12-23 06:05:41 +00001192 switch (Opcode) {
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001193 default:
Reid Spencer266e42b2006-12-23 06:05:41 +00001194 break;
Dan Gohmana5b96452009-06-04 22:49:04 +00001195 case Instruction::FAdd:
Dale Johannesenbed9dc42007-09-06 18:13:44 +00001196 (void)C3V.add(C2V, APFloat::rmNearestTiesToEven);
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001197 return ConstantFP::get(C1->getContext(), C3V);
Dan Gohmana5b96452009-06-04 22:49:04 +00001198 case Instruction::FSub:
Dale Johannesenbed9dc42007-09-06 18:13:44 +00001199 (void)C3V.subtract(C2V, APFloat::rmNearestTiesToEven);
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001200 return ConstantFP::get(C1->getContext(), C3V);
Dan Gohmana5b96452009-06-04 22:49:04 +00001201 case Instruction::FMul:
Dale Johannesenbed9dc42007-09-06 18:13:44 +00001202 (void)C3V.multiply(C2V, APFloat::rmNearestTiesToEven);
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001203 return ConstantFP::get(C1->getContext(), C3V);
Reid Spencer266e42b2006-12-23 06:05:41 +00001204 case Instruction::FDiv:
Dale Johannesenbed9dc42007-09-06 18:13:44 +00001205 (void)C3V.divide(C2V, APFloat::rmNearestTiesToEven);
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001206 return ConstantFP::get(C1->getContext(), C3V);
Reid Spencer266e42b2006-12-23 06:05:41 +00001207 case Instruction::FRem:
Stephen Canonb12db0e2015-09-21 19:29:25 +00001208 (void)C3V.mod(C2V);
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001209 return ConstantFP::get(C1->getContext(), C3V);
Reid Spencer266e42b2006-12-23 06:05:41 +00001210 }
1211 }
Chris Lattner229907c2011-07-18 04:54:35 +00001212 } else if (VectorType *VTy = dyn_cast<VectorType>(C1->getType())) {
Chris Lattnerfa775002012-01-26 02:32:04 +00001213 // Perform elementwise folding.
1214 SmallVector<Constant*, 16> Result;
Dan Gohman1ccecdb2012-04-27 17:50:22 +00001215 Type *Ty = IntegerType::get(VTy->getContext(), 32);
Chris Lattnerfa775002012-01-26 02:32:04 +00001216 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
Sanjay Patel7e563662017-03-09 20:42:30 +00001217 Constant *ExtractIdx = ConstantInt::get(Ty, i);
1218 Constant *LHS = ConstantExpr::getExtractElement(C1, ExtractIdx);
1219 Constant *RHS = ConstantExpr::getExtractElement(C2, ExtractIdx);
1220
1221 // If any element of a divisor vector is zero, the whole op is undef.
1222 if ((Opcode == Instruction::SDiv || Opcode == Instruction::UDiv ||
1223 Opcode == Instruction::SRem || Opcode == Instruction::URem) &&
1224 RHS->isNullValue())
1225 return UndefValue::get(VTy);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001226
Chris Lattnerfa775002012-01-26 02:32:04 +00001227 Result.push_back(ConstantExpr::get(Opcode, LHS, RHS));
Reid Spencer266e42b2006-12-23 06:05:41 +00001228 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001229
Dan Gohman1ccecdb2012-04-27 17:50:22 +00001230 return ConstantVector::get(Result);
Reid Spencer266e42b2006-12-23 06:05:41 +00001231 }
1232
Dan Gohmane5e1b7b2010-02-01 18:27:38 +00001233 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
Chris Lattner6b056052008-04-20 18:24:14 +00001234 // There are many possible foldings we could do here. We should probably
1235 // at least fold add of a pointer with an integer into the appropriate
1236 // getelementptr. This will improve alias analysis a bit.
Dan Gohmane5e1b7b2010-02-01 18:27:38 +00001237
1238 // Given ((a + b) + c), if (b + c) folds to something interesting, return
1239 // (a + (b + c)).
Duncan Sands70db5e72010-12-20 13:10:23 +00001240 if (Instruction::isAssociative(Opcode) && CE1->getOpcode() == Opcode) {
Dan Gohmane5e1b7b2010-02-01 18:27:38 +00001241 Constant *T = ConstantExpr::get(Opcode, CE1->getOperand(1), C2);
1242 if (!isa<ConstantExpr>(T) || cast<ConstantExpr>(T)->getOpcode() != Opcode)
1243 return ConstantExpr::get(Opcode, CE1->getOperand(0), T);
1244 }
Chris Lattner6b056052008-04-20 18:24:14 +00001245 } else if (isa<ConstantExpr>(C2)) {
1246 // If C2 is a constant expr and C1 isn't, flop them around and fold the
1247 // other way if possible.
Dan Gohman6eeabaa2010-02-22 22:05:18 +00001248 if (Instruction::isCommutative(Opcode))
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001249 return ConstantFoldBinaryInstruction(Opcode, C2, C1);
Chris Lattner6b056052008-04-20 18:24:14 +00001250 }
Dan Gohman062d3782009-08-29 23:35:16 +00001251
Nick Lewycky605109d2009-09-20 00:04:02 +00001252 // i1 can be simplified in many cases.
Duncan Sands9dff9be2010-02-15 16:12:20 +00001253 if (C1->getType()->isIntegerTy(1)) {
Nick Lewycky605109d2009-09-20 00:04:02 +00001254 switch (Opcode) {
1255 case Instruction::Add:
1256 case Instruction::Sub:
Nick Lewyckye0332982009-09-20 01:35:59 +00001257 return ConstantExpr::getXor(C1, C2);
Nick Lewycky605109d2009-09-20 00:04:02 +00001258 case Instruction::Mul:
Nick Lewyckye0332982009-09-20 01:35:59 +00001259 return ConstantExpr::getAnd(C1, C2);
Nick Lewycky605109d2009-09-20 00:04:02 +00001260 case Instruction::Shl:
1261 case Instruction::LShr:
1262 case Instruction::AShr:
1263 // We can assume that C2 == 0. If it were one the result would be
1264 // undefined because the shift value is as large as the bitwidth.
Nick Lewyckye0332982009-09-20 01:35:59 +00001265 return C1;
Nick Lewycky605109d2009-09-20 00:04:02 +00001266 case Instruction::SDiv:
1267 case Instruction::UDiv:
1268 // We can assume that C2 == 1. If it were zero the result would be
1269 // undefined through division by zero.
Nick Lewyckye0332982009-09-20 01:35:59 +00001270 return C1;
Nick Lewycky605109d2009-09-20 00:04:02 +00001271 case Instruction::URem:
1272 case Instruction::SRem:
1273 // We can assume that C2 == 1. If it were zero the result would be
1274 // undefined through division by zero.
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001275 return ConstantInt::getFalse(C1->getContext());
Nick Lewycky605109d2009-09-20 00:04:02 +00001276 default:
1277 break;
1278 }
1279 }
1280
Chris Lattner6b056052008-04-20 18:24:14 +00001281 // We don't know how to fold this.
Craig Topperc6207612014-04-09 06:08:46 +00001282 return nullptr;
Reid Spencer266e42b2006-12-23 06:05:41 +00001283}
Chris Lattnerbbe0a422006-04-08 01:18:18 +00001284
Sanjay Patelf3bb6c52016-04-05 18:23:30 +00001285/// This type is zero-sized if it's an array or structure of zero-sized types.
1286/// The only leaf zero-sized type is an empty structure.
Chris Lattner229907c2011-07-18 04:54:35 +00001287static bool isMaybeZeroSizedType(Type *Ty) {
1288 if (StructType *STy = dyn_cast<StructType>(Ty)) {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001289 if (STy->isOpaque()) return true; // Can't say.
Chris Lattner60c47262005-01-28 19:09:51 +00001290
1291 // If all of elements have zero size, this does too.
1292 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Chris Lattnerfeaf92f2005-01-28 23:17:27 +00001293 if (!isMaybeZeroSizedType(STy->getElementType(i))) return false;
Chris Lattner60c47262005-01-28 19:09:51 +00001294 return true;
1295
Chris Lattner229907c2011-07-18 04:54:35 +00001296 } else if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
Chris Lattner60c47262005-01-28 19:09:51 +00001297 return isMaybeZeroSizedType(ATy->getElementType());
1298 }
1299 return false;
1300}
Chris Lattner6ea4b522004-03-12 05:53:32 +00001301
Sanjay Patelf3bb6c52016-04-05 18:23:30 +00001302/// Compare the two constants as though they were getelementptr indices.
1303/// This allows coercion of the types to be the same thing.
Chris Lattner061da2f2004-01-13 05:51:55 +00001304///
Bruce Mitchenere9ffb452015-09-12 01:17:08 +00001305/// If the two constants are the "same" (after coercion), return 0. If the
Chris Lattner061da2f2004-01-13 05:51:55 +00001306/// first is less than the second, return -1, if the second is less than the
1307/// first, return 1. If the constants are not integral, return -2.
1308///
Chris Lattner229907c2011-07-18 04:54:35 +00001309static int IdxCompare(Constant *C1, Constant *C2, Type *ElTy) {
Chris Lattner061da2f2004-01-13 05:51:55 +00001310 if (C1 == C2) return 0;
1311
Reid Spencerc90cf772006-12-31 21:43:30 +00001312 // Ok, we found a different index. If they are not ConstantInt, we can't do
1313 // anything with them.
Chris Lattner061da2f2004-01-13 05:51:55 +00001314 if (!isa<ConstantInt>(C1) || !isa<ConstantInt>(C2))
1315 return -2; // don't know!
Misha Brukmanb1c93172005-04-21 23:48:37 +00001316
David Majnemer8b774542015-02-16 19:10:02 +00001317 // We cannot compare the indices if they don't fit in an int64_t.
1318 if (cast<ConstantInt>(C1)->getValue().getActiveBits() > 64 ||
1319 cast<ConstantInt>(C2)->getValue().getActiveBits() > 64)
1320 return -2; // don't know!
1321
Chris Lattner69193f92004-04-05 01:30:19 +00001322 // Ok, we have two differing integer indices. Sign extend them to be the same
David Majnemer8b774542015-02-16 19:10:02 +00001323 // type.
1324 int64_t C1Val = cast<ConstantInt>(C1)->getSExtValue();
1325 int64_t C2Val = cast<ConstantInt>(C2)->getSExtValue();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00001326
David Majnemer8b774542015-02-16 19:10:02 +00001327 if (C1Val == C2Val) return 0; // They are equal
Chris Lattner061da2f2004-01-13 05:51:55 +00001328
Chris Lattner60c47262005-01-28 19:09:51 +00001329 // If the type being indexed over is really just a zero sized type, there is
1330 // no pointer difference being made here.
1331 if (isMaybeZeroSizedType(ElTy))
1332 return -2; // dunno.
1333
Chris Lattner061da2f2004-01-13 05:51:55 +00001334 // If they are really different, now that they are the same type, then we
1335 // found a difference!
David Majnemer8b774542015-02-16 19:10:02 +00001336 if (C1Val < C2Val)
Chris Lattner061da2f2004-01-13 05:51:55 +00001337 return -1;
1338 else
1339 return 1;
1340}
1341
Sanjay Patelf3bb6c52016-04-05 18:23:30 +00001342/// This function determines if there is anything we can decide about the two
1343/// constants provided. This doesn't need to handle simple things like
1344/// ConstantFP comparisons, but should instead handle ConstantExprs.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001345/// If we can determine that the two constants have a particular relation to
1346/// each other, we should return the corresponding FCmpInst predicate,
Reid Spencer9d36acf2006-12-24 18:52:08 +00001347/// otherwise return FCmpInst::BAD_FCMP_PREDICATE. This is used below in
1348/// ConstantFoldCompareInstruction.
Reid Spencer266e42b2006-12-23 06:05:41 +00001349///
1350/// To simplify this code we canonicalize the relation so that the first
Reid Spencer9d36acf2006-12-24 18:52:08 +00001351/// operand is always the most "complex" of the two. We consider ConstantFP
1352/// to be the simplest, and ConstantExprs to be the most complex.
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001353static FCmpInst::Predicate evaluateFCmpRelation(Constant *V1, Constant *V2) {
Reid Spencer266e42b2006-12-23 06:05:41 +00001354 assert(V1->getType() == V2->getType() &&
Reid Spencer9d36acf2006-12-24 18:52:08 +00001355 "Cannot compare values of different types!");
Dale Johannesen19db0932007-10-14 01:56:47 +00001356
Reid Spencer9d36acf2006-12-24 18:52:08 +00001357 // Handle degenerate case quickly
Reid Spencer266e42b2006-12-23 06:05:41 +00001358 if (V1 == V2) return FCmpInst::FCMP_OEQ;
1359
Reid Spencer9d36acf2006-12-24 18:52:08 +00001360 if (!isa<ConstantExpr>(V1)) {
1361 if (!isa<ConstantExpr>(V2)) {
Mehdi Aminieb242a52015-03-09 03:20:25 +00001362 // Simple case, use the standard constant folder.
Craig Topperc6207612014-04-09 06:08:46 +00001363 ConstantInt *R = nullptr;
Zhou Sheng75b871f2007-01-11 12:24:14 +00001364 R = dyn_cast<ConstantInt>(
Nick Lewyckye0332982009-09-20 01:35:59 +00001365 ConstantExpr::getFCmp(FCmpInst::FCMP_OEQ, V1, V2));
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001366 if (R && !R->isZero())
Reid Spencer266e42b2006-12-23 06:05:41 +00001367 return FCmpInst::FCMP_OEQ;
Zhou Sheng75b871f2007-01-11 12:24:14 +00001368 R = dyn_cast<ConstantInt>(
Nick Lewyckye0332982009-09-20 01:35:59 +00001369 ConstantExpr::getFCmp(FCmpInst::FCMP_OLT, V1, V2));
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001370 if (R && !R->isZero())
Reid Spencer266e42b2006-12-23 06:05:41 +00001371 return FCmpInst::FCMP_OLT;
Zhou Sheng75b871f2007-01-11 12:24:14 +00001372 R = dyn_cast<ConstantInt>(
Nick Lewyckye0332982009-09-20 01:35:59 +00001373 ConstantExpr::getFCmp(FCmpInst::FCMP_OGT, V1, V2));
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001374 if (R && !R->isZero())
Reid Spencer9d36acf2006-12-24 18:52:08 +00001375 return FCmpInst::FCMP_OGT;
1376
1377 // Nothing more we can do
Reid Spencer266e42b2006-12-23 06:05:41 +00001378 return FCmpInst::BAD_FCMP_PREDICATE;
1379 }
Dan Gohman062d3782009-08-29 23:35:16 +00001380
Reid Spencer9d36acf2006-12-24 18:52:08 +00001381 // If the first operand is simple and second is ConstantExpr, swap operands.
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001382 FCmpInst::Predicate SwappedRelation = evaluateFCmpRelation(V2, V1);
Reid Spencer9d36acf2006-12-24 18:52:08 +00001383 if (SwappedRelation != FCmpInst::BAD_FCMP_PREDICATE)
1384 return FCmpInst::getSwappedPredicate(SwappedRelation);
1385 } else {
1386 // Ok, the LHS is known to be a constantexpr. The RHS can be any of a
1387 // constantexpr or a simple constant.
Nick Lewyckye0332982009-09-20 01:35:59 +00001388 ConstantExpr *CE1 = cast<ConstantExpr>(V1);
Reid Spencer9d36acf2006-12-24 18:52:08 +00001389 switch (CE1->getOpcode()) {
1390 case Instruction::FPTrunc:
1391 case Instruction::FPExt:
1392 case Instruction::UIToFP:
1393 case Instruction::SIToFP:
1394 // We might be able to do something with these but we don't right now.
1395 break;
1396 default:
1397 break;
1398 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001399 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001400 // There are MANY other foldings that we could perform here. They will
1401 // probably be added on demand, as they seem needed.
1402 return FCmpInst::BAD_FCMP_PREDICATE;
1403}
1404
David Majnemerd1bea692014-07-04 22:05:26 +00001405static ICmpInst::Predicate areGlobalsPotentiallyEqual(const GlobalValue *GV1,
1406 const GlobalValue *GV2) {
David Majnemer770fd822014-12-08 19:35:31 +00001407 auto isGlobalUnsafeForEquality = [](const GlobalValue *GV) {
1408 if (GV->hasExternalWeakLinkage() || GV->hasWeakAnyLinkage())
1409 return true;
1410 if (const auto *GVar = dyn_cast<GlobalVariable>(GV)) {
David Blaikiee7107062015-05-13 22:54:54 +00001411 Type *Ty = GVar->getValueType();
David Majnemer770fd822014-12-08 19:35:31 +00001412 // A global with opaque type might end up being zero sized.
1413 if (!Ty->isSized())
1414 return true;
1415 // A global with an empty type might lie at the address of any other
1416 // global.
1417 if (Ty->isEmptyTy())
1418 return true;
1419 }
1420 return false;
David Majnemer64ba3262014-12-06 11:58:33 +00001421 };
David Majnemerd1bea692014-07-04 22:05:26 +00001422 // Don't try to decide equality of aliases.
1423 if (!isa<GlobalAlias>(GV1) && !isa<GlobalAlias>(GV2))
David Majnemer770fd822014-12-08 19:35:31 +00001424 if (!isGlobalUnsafeForEquality(GV1) && !isGlobalUnsafeForEquality(GV2))
David Majnemerd1bea692014-07-04 22:05:26 +00001425 return ICmpInst::ICMP_NE;
1426 return ICmpInst::BAD_ICMP_PREDICATE;
1427}
1428
Sanjay Patelf3bb6c52016-04-05 18:23:30 +00001429/// This function determines if there is anything we can decide about the two
1430/// constants provided. This doesn't need to handle simple things like integer
1431/// comparisons, but should instead handle ConstantExprs and GlobalValues.
1432/// If we can determine that the two constants have a particular relation to
1433/// each other, we should return the corresponding ICmp predicate, otherwise
1434/// return ICmpInst::BAD_ICMP_PREDICATE.
Chris Lattner061da2f2004-01-13 05:51:55 +00001435///
1436/// To simplify this code we canonicalize the relation so that the first
1437/// operand is always the most "complex" of the two. We consider simple
1438/// constants (like ConstantInt) to be the simplest, followed by
Reid Spenceraccd7c72004-07-17 23:47:01 +00001439/// GlobalValues, followed by ConstantExpr's (the most complex).
Chris Lattner061da2f2004-01-13 05:51:55 +00001440///
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001441static ICmpInst::Predicate evaluateICmpRelation(Constant *V1, Constant *V2,
Reid Spencer266e42b2006-12-23 06:05:41 +00001442 bool isSigned) {
Chris Lattner061da2f2004-01-13 05:51:55 +00001443 assert(V1->getType() == V2->getType() &&
1444 "Cannot compare different types of values!");
Reid Spencer266e42b2006-12-23 06:05:41 +00001445 if (V1 == V2) return ICmpInst::ICMP_EQ;
Chris Lattner061da2f2004-01-13 05:51:55 +00001446
Chris Lattner3c46e142010-02-01 19:35:08 +00001447 if (!isa<ConstantExpr>(V1) && !isa<GlobalValue>(V1) &&
1448 !isa<BlockAddress>(V1)) {
1449 if (!isa<GlobalValue>(V2) && !isa<ConstantExpr>(V2) &&
1450 !isa<BlockAddress>(V2)) {
Chris Lattnerfed8ceb2006-01-05 07:49:30 +00001451 // We distilled this down to a simple case, use the standard constant
1452 // folder.
Craig Topperc6207612014-04-09 06:08:46 +00001453 ConstantInt *R = nullptr;
Reid Spencer266e42b2006-12-23 06:05:41 +00001454 ICmpInst::Predicate pred = ICmpInst::ICMP_EQ;
Nick Lewyckye0332982009-09-20 01:35:59 +00001455 R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, V1, V2));
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001456 if (R && !R->isZero())
Reid Spencer266e42b2006-12-23 06:05:41 +00001457 return pred;
1458 pred = isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
Nick Lewyckye0332982009-09-20 01:35:59 +00001459 R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, V1, V2));
Reid Spencer2e54a152007-03-02 00:28:52 +00001460 if (R && !R->isZero())
Reid Spencer266e42b2006-12-23 06:05:41 +00001461 return pred;
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001462 pred = isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
Nick Lewyckye0332982009-09-20 01:35:59 +00001463 R = dyn_cast<ConstantInt>(ConstantExpr::getICmp(pred, V1, V2));
Reid Spencer2e54a152007-03-02 00:28:52 +00001464 if (R && !R->isZero())
Reid Spencer266e42b2006-12-23 06:05:41 +00001465 return pred;
Dan Gohman062d3782009-08-29 23:35:16 +00001466
Chris Lattnerfed8ceb2006-01-05 07:49:30 +00001467 // If we couldn't figure it out, bail.
Reid Spencer266e42b2006-12-23 06:05:41 +00001468 return ICmpInst::BAD_ICMP_PREDICATE;
Chris Lattnerfed8ceb2006-01-05 07:49:30 +00001469 }
Dan Gohman062d3782009-08-29 23:35:16 +00001470
Chris Lattner061da2f2004-01-13 05:51:55 +00001471 // If the first operand is simple, swap operands.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001472 ICmpInst::Predicate SwappedRelation =
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001473 evaluateICmpRelation(V2, V1, isSigned);
Reid Spencer266e42b2006-12-23 06:05:41 +00001474 if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1475 return ICmpInst::getSwappedPredicate(SwappedRelation);
Chris Lattner061da2f2004-01-13 05:51:55 +00001476
Chris Lattner3c46e142010-02-01 19:35:08 +00001477 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V1)) {
Chris Lattner125ed542004-02-01 01:23:19 +00001478 if (isa<ConstantExpr>(V2)) { // Swap as necessary.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001479 ICmpInst::Predicate SwappedRelation =
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001480 evaluateICmpRelation(V2, V1, isSigned);
Reid Spencer266e42b2006-12-23 06:05:41 +00001481 if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1482 return ICmpInst::getSwappedPredicate(SwappedRelation);
Chris Lattner3c46e142010-02-01 19:35:08 +00001483 return ICmpInst::BAD_ICMP_PREDICATE;
Chris Lattner125ed542004-02-01 01:23:19 +00001484 }
Chris Lattner061da2f2004-01-13 05:51:55 +00001485
Chris Lattner3c46e142010-02-01 19:35:08 +00001486 // Now we know that the RHS is a GlobalValue, BlockAddress or simple
1487 // constant (which, since the types must match, means that it's a
1488 // ConstantPointerNull).
1489 if (const GlobalValue *GV2 = dyn_cast<GlobalValue>(V2)) {
David Majnemerd1bea692014-07-04 22:05:26 +00001490 return areGlobalsPotentiallyEqual(GV, GV2);
Chris Lattner3c46e142010-02-01 19:35:08 +00001491 } else if (isa<BlockAddress>(V2)) {
1492 return ICmpInst::ICMP_NE; // Globals never equal labels.
Chris Lattner061da2f2004-01-13 05:51:55 +00001493 } else {
1494 assert(isa<ConstantPointerNull>(V2) && "Canonicalization guarantee!");
Chris Lattner3c46e142010-02-01 19:35:08 +00001495 // GlobalVals can never be null unless they have external weak linkage.
1496 // We don't try to evaluate aliases here.
1497 if (!GV->hasExternalWeakLinkage() && !isa<GlobalAlias>(GV))
Reid Spencer266e42b2006-12-23 06:05:41 +00001498 return ICmpInst::ICMP_NE;
Chris Lattner061da2f2004-01-13 05:51:55 +00001499 }
Chris Lattner3c46e142010-02-01 19:35:08 +00001500 } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(V1)) {
1501 if (isa<ConstantExpr>(V2)) { // Swap as necessary.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001502 ICmpInst::Predicate SwappedRelation =
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001503 evaluateICmpRelation(V2, V1, isSigned);
Chris Lattner3c46e142010-02-01 19:35:08 +00001504 if (SwappedRelation != ICmpInst::BAD_ICMP_PREDICATE)
1505 return ICmpInst::getSwappedPredicate(SwappedRelation);
1506 return ICmpInst::BAD_ICMP_PREDICATE;
1507 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001508
Chris Lattner3c46e142010-02-01 19:35:08 +00001509 // Now we know that the RHS is a GlobalValue, BlockAddress or simple
1510 // constant (which, since the types must match, means that it is a
1511 // ConstantPointerNull).
1512 if (const BlockAddress *BA2 = dyn_cast<BlockAddress>(V2)) {
1513 // Block address in another function can't equal this one, but block
1514 // addresses in the current function might be the same if blocks are
1515 // empty.
1516 if (BA2->getFunction() != BA->getFunction())
1517 return ICmpInst::ICMP_NE;
1518 } else {
1519 // Block addresses aren't null, don't equal the address of globals.
1520 assert((isa<ConstantPointerNull>(V2) || isa<GlobalValue>(V2)) &&
1521 "Canonicalization guarantee!");
1522 return ICmpInst::ICMP_NE;
1523 }
Chris Lattner061da2f2004-01-13 05:51:55 +00001524 } else {
1525 // Ok, the LHS is known to be a constantexpr. The RHS can be any of a
Chris Lattner3c46e142010-02-01 19:35:08 +00001526 // constantexpr, a global, block address, or a simple constant.
Nick Lewyckye0332982009-09-20 01:35:59 +00001527 ConstantExpr *CE1 = cast<ConstantExpr>(V1);
1528 Constant *CE1Op0 = CE1->getOperand(0);
Chris Lattner061da2f2004-01-13 05:51:55 +00001529
1530 switch (CE1->getOpcode()) {
Reid Spencer6c38f0b2006-11-27 01:05:10 +00001531 case Instruction::Trunc:
1532 case Instruction::FPTrunc:
1533 case Instruction::FPExt:
1534 case Instruction::FPToUI:
1535 case Instruction::FPToSI:
Reid Spencer266e42b2006-12-23 06:05:41 +00001536 break; // We can't evaluate floating point casts or truncations.
1537
Reid Spencer6c38f0b2006-11-27 01:05:10 +00001538 case Instruction::UIToFP:
1539 case Instruction::SIToFP:
Reid Spencer6c38f0b2006-11-27 01:05:10 +00001540 case Instruction::BitCast:
Reid Spencer266e42b2006-12-23 06:05:41 +00001541 case Instruction::ZExt:
1542 case Instruction::SExt:
Hal Finkele2b89112016-05-04 19:37:08 +00001543 // We can't evaluate floating point casts or truncations.
1544 if (CE1Op0->getType()->isFloatingPointTy())
1545 break;
1546
Chris Lattner061da2f2004-01-13 05:51:55 +00001547 // If the cast is not actually changing bits, and the second operand is a
1548 // null pointer, do the comparison with the pre-casted value.
1549 if (V2->isNullValue() &&
Duncan Sands19d0b472010-02-16 11:11:14 +00001550 (CE1->getType()->isPointerTy() || CE1->getType()->isIntegerTy())) {
Chris Lattnerd2265b42007-12-10 22:53:04 +00001551 if (CE1->getOpcode() == Instruction::ZExt) isSigned = false;
1552 if (CE1->getOpcode() == Instruction::SExt) isSigned = true;
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001553 return evaluateICmpRelation(CE1Op0,
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001554 Constant::getNullValue(CE1Op0->getType()),
Nick Lewycky2949a232009-09-20 03:48:46 +00001555 isSigned);
Reid Spencer266e42b2006-12-23 06:05:41 +00001556 }
Chris Lattner192e3262004-04-11 01:29:30 +00001557 break;
Chris Lattner061da2f2004-01-13 05:51:55 +00001558
David Majnemerd1bea692014-07-04 22:05:26 +00001559 case Instruction::GetElementPtr: {
1560 GEPOperator *CE1GEP = cast<GEPOperator>(CE1);
Chris Lattner061da2f2004-01-13 05:51:55 +00001561 // Ok, since this is a getelementptr, we know that the constant has a
1562 // pointer type. Check the various cases.
1563 if (isa<ConstantPointerNull>(V2)) {
1564 // If we are comparing a GEP to a null pointer, check to see if the base
1565 // of the GEP equals the null pointer.
Reid Spencer9d36acf2006-12-24 18:52:08 +00001566 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CE1Op0)) {
Reid Spencer876f7222006-12-06 00:25:09 +00001567 if (GV->hasExternalWeakLinkage())
1568 // Weak linkage GVals could be zero or not. We're comparing that
1569 // to null pointer so its greater-or-equal
Reid Spencer266e42b2006-12-23 06:05:41 +00001570 return isSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001571 else
Reid Spencer876f7222006-12-06 00:25:09 +00001572 // If its not weak linkage, the GVal must have a non-zero address
1573 // so the result is greater-than
Nick Lewycky9e085542009-09-20 04:27:06 +00001574 return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
Chris Lattner061da2f2004-01-13 05:51:55 +00001575 } else if (isa<ConstantPointerNull>(CE1Op0)) {
1576 // If we are indexing from a null pointer, check to see if we have any
1577 // non-zero indices.
1578 for (unsigned i = 1, e = CE1->getNumOperands(); i != e; ++i)
1579 if (!CE1->getOperand(i)->isNullValue())
1580 // Offsetting from null, must not be equal.
Reid Spencer266e42b2006-12-23 06:05:41 +00001581 return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
Chris Lattner061da2f2004-01-13 05:51:55 +00001582 // Only zero indexes from null, must still be zero.
Reid Spencer266e42b2006-12-23 06:05:41 +00001583 return ICmpInst::ICMP_EQ;
Chris Lattner061da2f2004-01-13 05:51:55 +00001584 }
1585 // Otherwise, we can't really say if the first operand is null or not.
Chris Lattner3c46e142010-02-01 19:35:08 +00001586 } else if (const GlobalValue *GV2 = dyn_cast<GlobalValue>(V2)) {
Chris Lattner061da2f2004-01-13 05:51:55 +00001587 if (isa<ConstantPointerNull>(CE1Op0)) {
Chris Lattner3c46e142010-02-01 19:35:08 +00001588 if (GV2->hasExternalWeakLinkage())
Reid Spencer876f7222006-12-06 00:25:09 +00001589 // Weak linkage GVals could be zero or not. We're comparing it to
1590 // a null pointer, so its less-or-equal
Reid Spencer266e42b2006-12-23 06:05:41 +00001591 return isSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE;
Reid Spencer876f7222006-12-06 00:25:09 +00001592 else
1593 // If its not weak linkage, the GVal must have a non-zero address
1594 // so the result is less-than
Reid Spencer266e42b2006-12-23 06:05:41 +00001595 return isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
Chris Lattner3c46e142010-02-01 19:35:08 +00001596 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CE1Op0)) {
1597 if (GV == GV2) {
Chris Lattner061da2f2004-01-13 05:51:55 +00001598 // If this is a getelementptr of the same global, then it must be
1599 // different. Because the types must match, the getelementptr could
1600 // only have at most one index, and because we fold getelementptr's
1601 // with a single zero index, it must be nonzero.
1602 assert(CE1->getNumOperands() == 2 &&
1603 !CE1->getOperand(1)->isNullValue() &&
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001604 "Surprising getelementptr!");
Reid Spencer266e42b2006-12-23 06:05:41 +00001605 return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
Chris Lattner061da2f2004-01-13 05:51:55 +00001606 } else {
David Majnemerd1bea692014-07-04 22:05:26 +00001607 if (CE1GEP->hasAllZeroIndices())
1608 return areGlobalsPotentiallyEqual(GV, GV2);
Dan Gohman6a61fcc2013-01-31 00:01:45 +00001609 return ICmpInst::BAD_ICMP_PREDICATE;
Chris Lattner061da2f2004-01-13 05:51:55 +00001610 }
1611 }
1612 } else {
Nick Lewyckye0332982009-09-20 01:35:59 +00001613 ConstantExpr *CE2 = cast<ConstantExpr>(V2);
1614 Constant *CE2Op0 = CE2->getOperand(0);
Chris Lattner061da2f2004-01-13 05:51:55 +00001615
1616 // There are MANY other foldings that we could perform here. They will
1617 // probably be added on demand, as they seem needed.
1618 switch (CE2->getOpcode()) {
1619 default: break;
1620 case Instruction::GetElementPtr:
1621 // By far the most common case to handle is when the base pointers are
Dan Gohman6a61fcc2013-01-31 00:01:45 +00001622 // obviously to the same global.
Reid Spenceraccd7c72004-07-17 23:47:01 +00001623 if (isa<GlobalValue>(CE1Op0) && isa<GlobalValue>(CE2Op0)) {
David Majnemerd1bea692014-07-04 22:05:26 +00001624 // Don't know relative ordering, but check for inequality.
1625 if (CE1Op0 != CE2Op0) {
1626 GEPOperator *CE2GEP = cast<GEPOperator>(CE2);
1627 if (CE1GEP->hasAllZeroIndices() && CE2GEP->hasAllZeroIndices())
1628 return areGlobalsPotentiallyEqual(cast<GlobalValue>(CE1Op0),
1629 cast<GlobalValue>(CE2Op0));
Dan Gohman6a61fcc2013-01-31 00:01:45 +00001630 return ICmpInst::BAD_ICMP_PREDICATE;
David Majnemerd1bea692014-07-04 22:05:26 +00001631 }
Chris Lattner061da2f2004-01-13 05:51:55 +00001632 // Ok, we know that both getelementptr instructions are based on the
1633 // same global. From this, we can precisely determine the relative
1634 // ordering of the resultant pointers.
1635 unsigned i = 1;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001636
Dan Gohman7190d482009-09-10 23:37:55 +00001637 // The logic below assumes that the result of the comparison
1638 // can be determined by finding the first index that differs.
1639 // This doesn't work if there is over-indexing in any
1640 // subsequent indices, so check for that case first.
1641 if (!CE1->isGEPWithNoNotionalOverIndexing() ||
1642 !CE2->isGEPWithNoNotionalOverIndexing())
1643 return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
1644
Chris Lattner061da2f2004-01-13 05:51:55 +00001645 // Compare all of the operands the GEP's have in common.
Chris Lattner60c47262005-01-28 19:09:51 +00001646 gep_type_iterator GTI = gep_type_begin(CE1);
1647 for (;i != CE1->getNumOperands() && i != CE2->getNumOperands();
1648 ++i, ++GTI)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001649 switch (IdxCompare(CE1->getOperand(i),
Owen Anderson53a52212009-07-13 04:09:18 +00001650 CE2->getOperand(i), GTI.getIndexedType())) {
Reid Spencer266e42b2006-12-23 06:05:41 +00001651 case -1: return isSigned ? ICmpInst::ICMP_SLT:ICmpInst::ICMP_ULT;
1652 case 1: return isSigned ? ICmpInst::ICMP_SGT:ICmpInst::ICMP_UGT;
1653 case -2: return ICmpInst::BAD_ICMP_PREDICATE;
Chris Lattner061da2f2004-01-13 05:51:55 +00001654 }
1655
1656 // Ok, we ran out of things they have in common. If any leftovers
1657 // are non-zero then we have a difference, otherwise we are equal.
1658 for (; i < CE1->getNumOperands(); ++i)
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001659 if (!CE1->getOperand(i)->isNullValue()) {
Zhou Sheng75b871f2007-01-11 12:24:14 +00001660 if (isa<ConstantInt>(CE1->getOperand(i)))
Reid Spencer266e42b2006-12-23 06:05:41 +00001661 return isSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT;
Chris Lattner60c47262005-01-28 19:09:51 +00001662 else
Reid Spencer266e42b2006-12-23 06:05:41 +00001663 return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001664 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001665
Chris Lattner061da2f2004-01-13 05:51:55 +00001666 for (; i < CE2->getNumOperands(); ++i)
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001667 if (!CE2->getOperand(i)->isNullValue()) {
Zhou Sheng75b871f2007-01-11 12:24:14 +00001668 if (isa<ConstantInt>(CE2->getOperand(i)))
Reid Spencer266e42b2006-12-23 06:05:41 +00001669 return isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT;
Chris Lattner60c47262005-01-28 19:09:51 +00001670 else
Reid Spencer266e42b2006-12-23 06:05:41 +00001671 return ICmpInst::BAD_ICMP_PREDICATE; // Might be equal.
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001672 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001673 return ICmpInst::ICMP_EQ;
Chris Lattner061da2f2004-01-13 05:51:55 +00001674 }
1675 }
1676 }
David Majnemerd1bea692014-07-04 22:05:26 +00001677 }
Chris Lattner061da2f2004-01-13 05:51:55 +00001678 default:
1679 break;
1680 }
1681 }
1682
Reid Spencer266e42b2006-12-23 06:05:41 +00001683 return ICmpInst::BAD_ICMP_PREDICATE;
Chris Lattner061da2f2004-01-13 05:51:55 +00001684}
1685
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001686Constant *llvm::ConstantFoldCompareInstruction(unsigned short pred,
Nick Lewyckye0332982009-09-20 01:35:59 +00001687 Constant *C1, Constant *C2) {
Chris Lattner229907c2011-07-18 04:54:35 +00001688 Type *ResultTy;
1689 if (VectorType *VT = dyn_cast<VectorType>(C1->getType()))
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001690 ResultTy = VectorType::get(Type::getInt1Ty(C1->getContext()),
1691 VT->getNumElements());
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001692 else
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001693 ResultTy = Type::getInt1Ty(C1->getContext());
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001694
Chris Lattnerd137a082008-07-08 05:46:34 +00001695 // Fold FCMP_FALSE/FCMP_TRUE unconditionally.
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001696 if (pred == FCmpInst::FCMP_FALSE)
Owen Anderson5a1acd92009-07-31 20:28:14 +00001697 return Constant::getNullValue(ResultTy);
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001698
1699 if (pred == FCmpInst::FCMP_TRUE)
Owen Anderson5a1acd92009-07-31 20:28:14 +00001700 return Constant::getAllOnesValue(ResultTy);
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001701
Reid Spencer266e42b2006-12-23 06:05:41 +00001702 // Handle some degenerate cases first
Dan Gohmane697a6f2010-06-28 21:30:07 +00001703 if (isa<UndefValue>(C1) || isa<UndefValue>(C2)) {
Mehdi Aminieb242a52015-03-09 03:20:25 +00001704 CmpInst::Predicate Predicate = CmpInst::Predicate(pred);
1705 bool isIntegerPredicate = ICmpInst::isIntPredicate(Predicate);
Dan Gohmane697a6f2010-06-28 21:30:07 +00001706 // For EQ and NE, we can always pick a value for the undef to make the
1707 // predicate pass or fail, so we can return undef.
Mehdi Aminieb242a52015-03-09 03:20:25 +00001708 // Also, if both operands are undef, we can return undef for int comparison.
1709 if (ICmpInst::isEquality(Predicate) || (isIntegerPredicate && C1 == C2))
Dan Gohmane697a6f2010-06-28 21:30:07 +00001710 return UndefValue::get(ResultTy);
Mehdi Aminieb242a52015-03-09 03:20:25 +00001711
1712 // Otherwise, for integer compare, pick the same value as the non-undef
1713 // operand, and fold it to true or false.
1714 if (isIntegerPredicate)
Craig Topper1c3f2832015-12-15 06:11:33 +00001715 return ConstantInt::get(ResultTy, CmpInst::isTrueWhenEqual(Predicate));
Mehdi Aminieb242a52015-03-09 03:20:25 +00001716
1717 // Choosing NaN for the undef will always make unordered comparison succeed
1718 // and ordered comparison fails.
1719 return ConstantInt::get(ResultTy, CmpInst::isUnordered(Predicate));
Dan Gohmane697a6f2010-06-28 21:30:07 +00001720 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001721
1722 // icmp eq/ne(null,GV) -> false/true
1723 if (C1->isNullValue()) {
1724 if (const GlobalValue *GV = dyn_cast<GlobalValue>(C2))
Duncan Sandsa38e5272007-09-19 10:16:17 +00001725 // Don't try to evaluate aliases. External weak GV can be null.
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001726 if (!isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage()) {
Reid Spencer9d36acf2006-12-24 18:52:08 +00001727 if (pred == ICmpInst::ICMP_EQ)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001728 return ConstantInt::getFalse(C1->getContext());
Reid Spencer9d36acf2006-12-24 18:52:08 +00001729 else if (pred == ICmpInst::ICMP_NE)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001730 return ConstantInt::getTrue(C1->getContext());
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001731 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001732 // icmp eq/ne(GV,null) -> false/true
1733 } else if (C2->isNullValue()) {
1734 if (const GlobalValue *GV = dyn_cast<GlobalValue>(C1))
Duncan Sandsa38e5272007-09-19 10:16:17 +00001735 // Don't try to evaluate aliases. External weak GV can be null.
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001736 if (!isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage()) {
Reid Spencer9d36acf2006-12-24 18:52:08 +00001737 if (pred == ICmpInst::ICMP_EQ)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001738 return ConstantInt::getFalse(C1->getContext());
Reid Spencer9d36acf2006-12-24 18:52:08 +00001739 else if (pred == ICmpInst::ICMP_NE)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001740 return ConstantInt::getTrue(C1->getContext());
Anton Korobeynikov579f0712008-02-20 11:08:44 +00001741 }
Chris Lattner1dd054c2004-01-12 22:07:24 +00001742 }
1743
Nick Lewyckyb0225ba2009-09-20 07:21:39 +00001744 // If the comparison is a comparison between two i1's, simplify it.
Duncan Sands9dff9be2010-02-15 16:12:20 +00001745 if (C1->getType()->isIntegerTy(1)) {
Nick Lewyckyb0225ba2009-09-20 07:21:39 +00001746 switch(pred) {
1747 case ICmpInst::ICMP_EQ:
1748 if (isa<ConstantInt>(C2))
1749 return ConstantExpr::getXor(C1, ConstantExpr::getNot(C2));
1750 return ConstantExpr::getXor(ConstantExpr::getNot(C1), C2);
1751 case ICmpInst::ICMP_NE:
1752 return ConstantExpr::getXor(C1, C2);
1753 default:
1754 break;
1755 }
1756 }
1757
Chris Lattner344da522007-01-12 18:42:52 +00001758 if (isa<ConstantInt>(C1) && isa<ConstantInt>(C2)) {
Benjamin Kramer8f59adb2016-02-13 16:54:14 +00001759 const APInt &V1 = cast<ConstantInt>(C1)->getValue();
1760 const APInt &V2 = cast<ConstantInt>(C2)->getValue();
Reid Spencer81658a82007-02-27 06:23:51 +00001761 switch (pred) {
David Blaikie46a9f012012-01-20 21:51:11 +00001762 default: llvm_unreachable("Invalid ICmp Predicate");
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001763 case ICmpInst::ICMP_EQ: return ConstantInt::get(ResultTy, V1 == V2);
1764 case ICmpInst::ICMP_NE: return ConstantInt::get(ResultTy, V1 != V2);
1765 case ICmpInst::ICMP_SLT: return ConstantInt::get(ResultTy, V1.slt(V2));
1766 case ICmpInst::ICMP_SGT: return ConstantInt::get(ResultTy, V1.sgt(V2));
1767 case ICmpInst::ICMP_SLE: return ConstantInt::get(ResultTy, V1.sle(V2));
1768 case ICmpInst::ICMP_SGE: return ConstantInt::get(ResultTy, V1.sge(V2));
1769 case ICmpInst::ICMP_ULT: return ConstantInt::get(ResultTy, V1.ult(V2));
1770 case ICmpInst::ICMP_UGT: return ConstantInt::get(ResultTy, V1.ugt(V2));
1771 case ICmpInst::ICMP_ULE: return ConstantInt::get(ResultTy, V1.ule(V2));
1772 case ICmpInst::ICMP_UGE: return ConstantInt::get(ResultTy, V1.uge(V2));
Chris Lattner061da2f2004-01-13 05:51:55 +00001773 }
Reid Spencer266e42b2006-12-23 06:05:41 +00001774 } else if (isa<ConstantFP>(C1) && isa<ConstantFP>(C2)) {
Benjamin Kramer8f59adb2016-02-13 16:54:14 +00001775 const APFloat &C1V = cast<ConstantFP>(C1)->getValueAPF();
1776 const APFloat &C2V = cast<ConstantFP>(C2)->getValueAPF();
Dale Johannesenbed9dc42007-09-06 18:13:44 +00001777 APFloat::cmpResult R = C1V.compare(C2V);
Reid Spencer9d36acf2006-12-24 18:52:08 +00001778 switch (pred) {
David Blaikie46a9f012012-01-20 21:51:11 +00001779 default: llvm_unreachable("Invalid FCmp Predicate");
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001780 case FCmpInst::FCMP_FALSE: return Constant::getNullValue(ResultTy);
1781 case FCmpInst::FCMP_TRUE: return Constant::getAllOnesValue(ResultTy);
Reid Spencer266e42b2006-12-23 06:05:41 +00001782 case FCmpInst::FCMP_UNO:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001783 return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered);
Reid Spencer74bd0362007-01-11 00:25:45 +00001784 case FCmpInst::FCMP_ORD:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001785 return ConstantInt::get(ResultTy, R!=APFloat::cmpUnordered);
Reid Spencer266e42b2006-12-23 06:05:41 +00001786 case FCmpInst::FCMP_UEQ:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001787 return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered ||
1788 R==APFloat::cmpEqual);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001789 case FCmpInst::FCMP_OEQ:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001790 return ConstantInt::get(ResultTy, R==APFloat::cmpEqual);
Reid Spencer74bd0362007-01-11 00:25:45 +00001791 case FCmpInst::FCMP_UNE:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001792 return ConstantInt::get(ResultTy, R!=APFloat::cmpEqual);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001793 case FCmpInst::FCMP_ONE:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001794 return ConstantInt::get(ResultTy, R==APFloat::cmpLessThan ||
1795 R==APFloat::cmpGreaterThan);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001796 case FCmpInst::FCMP_ULT:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001797 return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered ||
1798 R==APFloat::cmpLessThan);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001799 case FCmpInst::FCMP_OLT:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001800 return ConstantInt::get(ResultTy, R==APFloat::cmpLessThan);
Reid Spencer266e42b2006-12-23 06:05:41 +00001801 case FCmpInst::FCMP_UGT:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001802 return ConstantInt::get(ResultTy, R==APFloat::cmpUnordered ||
1803 R==APFloat::cmpGreaterThan);
Reid Spencercddc9df2007-01-12 04:24:46 +00001804 case FCmpInst::FCMP_OGT:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001805 return ConstantInt::get(ResultTy, R==APFloat::cmpGreaterThan);
Reid Spencer74bd0362007-01-11 00:25:45 +00001806 case FCmpInst::FCMP_ULE:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001807 return ConstantInt::get(ResultTy, R!=APFloat::cmpGreaterThan);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001808 case FCmpInst::FCMP_OLE:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001809 return ConstantInt::get(ResultTy, R==APFloat::cmpLessThan ||
1810 R==APFloat::cmpEqual);
Reid Spencer266e42b2006-12-23 06:05:41 +00001811 case FCmpInst::FCMP_UGE:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001812 return ConstantInt::get(ResultTy, R!=APFloat::cmpLessThan);
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001813 case FCmpInst::FCMP_OGE:
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001814 return ConstantInt::get(ResultTy, R==APFloat::cmpGreaterThan ||
1815 R==APFloat::cmpEqual);
Reid Spencer266e42b2006-12-23 06:05:41 +00001816 }
Duncan Sands19d0b472010-02-16 11:11:14 +00001817 } else if (C1->getType()->isVectorTy()) {
Chris Lattner67136cf2008-07-10 00:29:28 +00001818 // If we can constant fold the comparison of each element, constant fold
1819 // the whole vector comparison.
1820 SmallVector<Constant*, 4> ResElts;
Dan Gohman1ccecdb2012-04-27 17:50:22 +00001821 Type *Ty = IntegerType::get(C1->getContext(), 32);
Chris Lattner69229312011-02-15 00:14:00 +00001822 // Compare the elements, producing an i1 result or constant expr.
Chris Lattnercf129702012-01-26 02:51:13 +00001823 for (unsigned i = 0, e = C1->getType()->getVectorNumElements(); i != e;++i){
Dan Gohman1ccecdb2012-04-27 17:50:22 +00001824 Constant *C1E =
1825 ConstantExpr::getExtractElement(C1, ConstantInt::get(Ty, i));
1826 Constant *C2E =
1827 ConstantExpr::getExtractElement(C2, ConstantInt::get(Ty, i));
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001828
Chris Lattnercf129702012-01-26 02:51:13 +00001829 ResElts.push_back(ConstantExpr::getCompare(pred, C1E, C2E));
1830 }
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001831
Dan Gohman1ccecdb2012-04-27 17:50:22 +00001832 return ConstantVector::get(ResElts);
Reid Spencer266e42b2006-12-23 06:05:41 +00001833 }
Chris Lattner061da2f2004-01-13 05:51:55 +00001834
Mehdi Aminieb242a52015-03-09 03:20:25 +00001835 if (C1->getType()->isFloatingPointTy() &&
1836 // Only call evaluateFCmpRelation if we have a constant expr to avoid
1837 // infinite recursive loop
1838 (isa<ConstantExpr>(C1) || isa<ConstantExpr>(C2))) {
Chris Lattner350e4172008-07-08 18:47:38 +00001839 int Result = -1; // -1 = unknown, 0 = known false, 1 = known true.
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001840 switch (evaluateFCmpRelation(C1, C2)) {
Torok Edwinfbcc6632009-07-14 16:55:14 +00001841 default: llvm_unreachable("Unknown relation!");
Reid Spencer9d36acf2006-12-24 18:52:08 +00001842 case FCmpInst::FCMP_UNO:
1843 case FCmpInst::FCMP_ORD:
1844 case FCmpInst::FCMP_UEQ:
1845 case FCmpInst::FCMP_UNE:
1846 case FCmpInst::FCMP_ULT:
1847 case FCmpInst::FCMP_UGT:
1848 case FCmpInst::FCMP_ULE:
1849 case FCmpInst::FCMP_UGE:
1850 case FCmpInst::FCMP_TRUE:
1851 case FCmpInst::FCMP_FALSE:
1852 case FCmpInst::BAD_FCMP_PREDICATE:
1853 break; // Couldn't determine anything about these constants.
1854 case FCmpInst::FCMP_OEQ: // We know that C1 == C2
Chris Lattnerd137a082008-07-08 05:46:34 +00001855 Result = (pred == FCmpInst::FCMP_UEQ || pred == FCmpInst::FCMP_OEQ ||
1856 pred == FCmpInst::FCMP_ULE || pred == FCmpInst::FCMP_OLE ||
1857 pred == FCmpInst::FCMP_UGE || pred == FCmpInst::FCMP_OGE);
1858 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001859 case FCmpInst::FCMP_OLT: // We know that C1 < C2
Chris Lattnerd137a082008-07-08 05:46:34 +00001860 Result = (pred == FCmpInst::FCMP_UNE || pred == FCmpInst::FCMP_ONE ||
1861 pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT ||
1862 pred == FCmpInst::FCMP_ULE || pred == FCmpInst::FCMP_OLE);
1863 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001864 case FCmpInst::FCMP_OGT: // We know that C1 > C2
Chris Lattnerd137a082008-07-08 05:46:34 +00001865 Result = (pred == FCmpInst::FCMP_UNE || pred == FCmpInst::FCMP_ONE ||
1866 pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT ||
1867 pred == FCmpInst::FCMP_UGE || pred == FCmpInst::FCMP_OGE);
1868 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001869 case FCmpInst::FCMP_OLE: // We know that C1 <= C2
1870 // We can only partially decide this relation.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001871 if (pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT)
Chris Lattnerd137a082008-07-08 05:46:34 +00001872 Result = 0;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001873 else if (pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT)
Chris Lattnerd137a082008-07-08 05:46:34 +00001874 Result = 1;
Chris Lattner061da2f2004-01-13 05:51:55 +00001875 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001876 case FCmpInst::FCMP_OGE: // We known that C1 >= C2
1877 // We can only partially decide this relation.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001878 if (pred == FCmpInst::FCMP_ULT || pred == FCmpInst::FCMP_OLT)
Chris Lattnerd137a082008-07-08 05:46:34 +00001879 Result = 0;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001880 else if (pred == FCmpInst::FCMP_UGT || pred == FCmpInst::FCMP_OGT)
Chris Lattnerd137a082008-07-08 05:46:34 +00001881 Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001882 break;
Nick Lewyckyc15dd6f2011-01-30 01:49:58 +00001883 case FCmpInst::FCMP_ONE: // We know that C1 != C2
Reid Spencer9d36acf2006-12-24 18:52:08 +00001884 // We can only partially decide this relation.
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001885 if (pred == FCmpInst::FCMP_OEQ || pred == FCmpInst::FCMP_UEQ)
Chris Lattnerd137a082008-07-08 05:46:34 +00001886 Result = 0;
Simon Pilgrim8c9f00f2016-03-10 20:58:11 +00001887 else if (pred == FCmpInst::FCMP_ONE || pred == FCmpInst::FCMP_UNE)
Chris Lattnerd137a082008-07-08 05:46:34 +00001888 Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001889 break;
1890 }
Dan Gohman062d3782009-08-29 23:35:16 +00001891
Chris Lattnerd137a082008-07-08 05:46:34 +00001892 // If we evaluated the result, return it now.
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001893 if (Result != -1)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001894 return ConstantInt::get(ResultTy, Result);
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001895
Reid Spencer9d36acf2006-12-24 18:52:08 +00001896 } else {
1897 // Evaluate the relation between the two constants, per the predicate.
Chris Lattnerd137a082008-07-08 05:46:34 +00001898 int Result = -1; // -1 = unknown, 0 = known false, 1 = known true.
Craig Topper1c3f2832015-12-15 06:11:33 +00001899 switch (evaluateICmpRelation(C1, C2,
1900 CmpInst::isSigned((CmpInst::Predicate)pred))) {
Torok Edwinfbcc6632009-07-14 16:55:14 +00001901 default: llvm_unreachable("Unknown relational!");
Reid Spencer9d36acf2006-12-24 18:52:08 +00001902 case ICmpInst::BAD_ICMP_PREDICATE:
1903 break; // Couldn't determine anything about these constants.
1904 case ICmpInst::ICMP_EQ: // We know the constants are equal!
1905 // If we know the constants are equal, we can decide the result of this
1906 // computation precisely.
Nick Lewycky9e085542009-09-20 04:27:06 +00001907 Result = ICmpInst::isTrueWhenEqual((ICmpInst::Predicate)pred);
Chris Lattnerd137a082008-07-08 05:46:34 +00001908 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001909 case ICmpInst::ICMP_ULT:
Nick Lewycky9e085542009-09-20 04:27:06 +00001910 switch (pred) {
1911 case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_ULE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001912 Result = 1; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001913 case ICmpInst::ICMP_UGT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_UGE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001914 Result = 0; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001915 }
Chris Lattnerd137a082008-07-08 05:46:34 +00001916 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001917 case ICmpInst::ICMP_SLT:
Nick Lewycky9e085542009-09-20 04:27:06 +00001918 switch (pred) {
1919 case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_SLE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001920 Result = 1; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001921 case ICmpInst::ICMP_SGT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_SGE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001922 Result = 0; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001923 }
Chris Lattnerd137a082008-07-08 05:46:34 +00001924 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001925 case ICmpInst::ICMP_UGT:
Nick Lewycky9e085542009-09-20 04:27:06 +00001926 switch (pred) {
1927 case ICmpInst::ICMP_UGT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_UGE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001928 Result = 1; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001929 case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_ULE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001930 Result = 0; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001931 }
Chris Lattnerd137a082008-07-08 05:46:34 +00001932 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001933 case ICmpInst::ICMP_SGT:
Nick Lewycky9e085542009-09-20 04:27:06 +00001934 switch (pred) {
1935 case ICmpInst::ICMP_SGT: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_SGE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001936 Result = 1; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001937 case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_SLE:
Nick Lewycky2b31b532009-09-20 05:47:45 +00001938 Result = 0; break;
Nick Lewycky9e085542009-09-20 04:27:06 +00001939 }
Chris Lattnerd137a082008-07-08 05:46:34 +00001940 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001941 case ICmpInst::ICMP_ULE:
Chris Lattnerd137a082008-07-08 05:46:34 +00001942 if (pred == ICmpInst::ICMP_UGT) Result = 0;
Nick Lewycky9e085542009-09-20 04:27:06 +00001943 if (pred == ICmpInst::ICMP_ULT || pred == ICmpInst::ICMP_ULE) Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001944 break;
1945 case ICmpInst::ICMP_SLE:
Chris Lattnerd137a082008-07-08 05:46:34 +00001946 if (pred == ICmpInst::ICMP_SGT) Result = 0;
Nick Lewycky9e085542009-09-20 04:27:06 +00001947 if (pred == ICmpInst::ICMP_SLT || pred == ICmpInst::ICMP_SLE) Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001948 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001949 case ICmpInst::ICMP_UGE:
Chris Lattnerd137a082008-07-08 05:46:34 +00001950 if (pred == ICmpInst::ICMP_ULT) Result = 0;
Nick Lewycky9e085542009-09-20 04:27:06 +00001951 if (pred == ICmpInst::ICMP_UGT || pred == ICmpInst::ICMP_UGE) Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001952 break;
1953 case ICmpInst::ICMP_SGE:
Chris Lattnerd137a082008-07-08 05:46:34 +00001954 if (pred == ICmpInst::ICMP_SLT) Result = 0;
Nick Lewycky9e085542009-09-20 04:27:06 +00001955 if (pred == ICmpInst::ICMP_SGT || pred == ICmpInst::ICMP_SGE) Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001956 break;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001957 case ICmpInst::ICMP_NE:
Chris Lattnerd137a082008-07-08 05:46:34 +00001958 if (pred == ICmpInst::ICMP_EQ) Result = 0;
1959 if (pred == ICmpInst::ICMP_NE) Result = 1;
Reid Spencer9d36acf2006-12-24 18:52:08 +00001960 break;
1961 }
Dan Gohman062d3782009-08-29 23:35:16 +00001962
Chris Lattnerd137a082008-07-08 05:46:34 +00001963 // If we evaluated the result, return it now.
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001964 if (Result != -1)
Chris Lattnerf5edeeb2010-02-01 20:48:08 +00001965 return ConstantInt::get(ResultTy, Result);
Dan Gohman062d3782009-08-29 23:35:16 +00001966
Nick Lewycky4a034522009-09-20 05:48:50 +00001967 // If the right hand side is a bitcast, try using its inverse to simplify
Chris Lattner94eb4b22010-02-01 20:04:40 +00001968 // it by moving it to the left hand side. We can't do this if it would turn
Duncan Sandsdddba062010-02-01 20:42:02 +00001969 // a vector compare into a scalar compare or visa versa.
Nick Lewycky4a034522009-09-20 05:48:50 +00001970 if (ConstantExpr *CE2 = dyn_cast<ConstantExpr>(C2)) {
Chris Lattner94eb4b22010-02-01 20:04:40 +00001971 Constant *CE2Op0 = CE2->getOperand(0);
1972 if (CE2->getOpcode() == Instruction::BitCast &&
Nick Lewycky1a7ed582010-03-04 06:54:10 +00001973 CE2->getType()->isVectorTy() == CE2Op0->getType()->isVectorTy()) {
Nick Lewycky4a034522009-09-20 05:48:50 +00001974 Constant *Inverse = ConstantExpr::getBitCast(C1, CE2Op0->getType());
1975 return ConstantExpr::getICmp(pred, Inverse, CE2Op0);
1976 }
1977 }
1978
Nick Lewycky9b3ed872009-09-20 07:31:25 +00001979 // If the left hand side is an extension, try eliminating it.
1980 if (ConstantExpr *CE1 = dyn_cast<ConstantExpr>(C1)) {
Craig Topper1c3f2832015-12-15 06:11:33 +00001981 if ((CE1->getOpcode() == Instruction::SExt &&
1982 ICmpInst::isSigned((ICmpInst::Predicate)pred)) ||
1983 (CE1->getOpcode() == Instruction::ZExt &&
1984 !ICmpInst::isSigned((ICmpInst::Predicate)pred))){
Nick Lewycky9b3ed872009-09-20 07:31:25 +00001985 Constant *CE1Op0 = CE1->getOperand(0);
1986 Constant *CE1Inverse = ConstantExpr::getTrunc(CE1, CE1Op0->getType());
1987 if (CE1Inverse == CE1Op0) {
1988 // Check whether we can safely truncate the right hand side.
1989 Constant *C2Inverse = ConstantExpr::getTrunc(C2, CE1Op0->getType());
Benjamin Kramercc846012013-06-30 13:47:43 +00001990 if (ConstantExpr::getCast(CE1->getOpcode(), C2Inverse,
1991 C2->getType()) == C2)
Nick Lewycky9b3ed872009-09-20 07:31:25 +00001992 return ConstantExpr::getICmp(pred, CE1Inverse, C2Inverse);
Nick Lewycky9b3ed872009-09-20 07:31:25 +00001993 }
1994 }
1995 }
1996
Eli Friedmane67cae32009-12-17 06:07:04 +00001997 if ((!isa<ConstantExpr>(C1) && isa<ConstantExpr>(C2)) ||
1998 (C1->isNullValue() && !C2->isNullValue())) {
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001999 // If C2 is a constant expr and C1 isn't, flip them around and fold the
Reid Spencer9d36acf2006-12-24 18:52:08 +00002000 // other way if possible.
Eli Friedmane67cae32009-12-17 06:07:04 +00002001 // Also, if C1 is null and C2 isn't, flip them around.
Nick Lewycky1a7ed582010-03-04 06:54:10 +00002002 pred = ICmpInst::getSwappedPredicate((ICmpInst::Predicate)pred);
2003 return ConstantExpr::getICmp(pred, C2, C1);
Chris Lattner061da2f2004-01-13 05:51:55 +00002004 }
2005 }
Craig Topperc6207612014-04-09 06:08:46 +00002006 return nullptr;
Dan Gohman062d3782009-08-29 23:35:16 +00002007}
Chris Lattner1dd054c2004-01-12 22:07:24 +00002008
Sanjay Patelf3bb6c52016-04-05 18:23:30 +00002009/// Test whether the given sequence of *normalized* indices is "inbounds".
Jay Foad1d4a8fe2011-01-14 08:07:43 +00002010template<typename IndexTy>
Jay Foaded8db7d2011-07-21 14:31:17 +00002011static bool isInBoundsIndices(ArrayRef<IndexTy> Idxs) {
Dan Gohman21c62162009-09-11 00:04:14 +00002012 // No indices means nothing that could be out of bounds.
Jay Foaded8db7d2011-07-21 14:31:17 +00002013 if (Idxs.empty()) return true;
Dan Gohman21c62162009-09-11 00:04:14 +00002014
2015 // If the first index is zero, it's in bounds.
Jay Foad1d4a8fe2011-01-14 08:07:43 +00002016 if (cast<Constant>(Idxs[0])->isNullValue()) return true;
Dan Gohman21c62162009-09-11 00:04:14 +00002017
2018 // If the first index is one and all the rest are zero, it's in bounds,
2019 // by the one-past-the-end rule.
2020 if (!cast<ConstantInt>(Idxs[0])->isOne())
2021 return false;
Jay Foaded8db7d2011-07-21 14:31:17 +00002022 for (unsigned i = 1, e = Idxs.size(); i != e; ++i)
Jay Foad1d4a8fe2011-01-14 08:07:43 +00002023 if (!cast<Constant>(Idxs[i])->isNullValue())
Dan Gohman21c62162009-09-11 00:04:14 +00002024 return false;
2025 return true;
2026}
2027
Sanjay Patelf3bb6c52016-04-05 18:23:30 +00002028/// Test whether a given ConstantInt is in-range for a SequentialType.
Peter Collingbourneab85225b2016-12-02 02:24:42 +00002029static bool isIndexInRangeOfArrayType(uint64_t NumElements,
2030 const ConstantInt *CI) {
David Majnemer3c93dc92013-11-10 01:36:22 +00002031 // We cannot bounds check the index if it doesn't fit in an int64_t.
2032 if (CI->getValue().getActiveBits() > 64)
2033 return false;
2034
2035 // A negative index or an index past the end of our sequential type is
2036 // considered out-of-range.
2037 int64_t IndexVal = CI->getSExtValue();
2038 if (IndexVal < 0 || (NumElements > 0 && (uint64_t)IndexVal >= NumElements))
2039 return false;
2040
2041 // Otherwise, it is in-range.
2042 return true;
2043}
2044
Peter Collingbourned93620b2016-11-10 22:34:55 +00002045Constant *llvm::ConstantFoldGetElementPtr(Type *PointeeTy, Constant *C,
2046 bool InBounds,
2047 Optional<unsigned> InRangeIndex,
2048 ArrayRef<Value *> Idxs) {
Jay Foadca3fc382011-07-19 15:30:30 +00002049 if (Idxs.empty()) return C;
Chris Lattner1dd054c2004-01-12 22:07:24 +00002050
Chris Lattnerf6013752004-10-17 21:54:55 +00002051 if (isa<UndefValue>(C)) {
Davide Italiano6231a7e2016-10-28 01:41:56 +00002052 Type *GEPTy = GetElementPtrInst::getGEPReturnType(
2053 C, makeArrayRef((Value * const *)Idxs.data(), Idxs.size()));
Manuel Jacobc784e6a2016-01-19 16:34:31 +00002054 return UndefValue::get(GEPTy);
Chris Lattnerf6013752004-10-17 21:54:55 +00002055 }
2056
Daniel Berlin0f2af7f2017-05-08 17:37:33 +00002057 Constant *Idx0 = cast<Constant>(Idxs[0]);
2058 if (Idxs.size() == 1 && (Idx0->isNullValue() || isa<UndefValue>(Idx0)))
2059 return C;
2060
Chris Lattner04b60fe2004-02-16 20:46:13 +00002061 if (C->isNullValue()) {
2062 bool isNull = true;
Jay Foadca3fc382011-07-19 15:30:30 +00002063 for (unsigned i = 0, e = Idxs.size(); i != e; ++i)
Daniel Berlin74ffa5c2017-05-08 17:37:29 +00002064 if (!isa<UndefValue>(Idxs[i]) &&
2065 !cast<Constant>(Idxs[i])->isNullValue()) {
Chris Lattner04b60fe2004-02-16 20:46:13 +00002066 isNull = false;
2067 break;
2068 }
2069 if (isNull) {
Manuel Jacobc784e6a2016-01-19 16:34:31 +00002070 PointerType *PtrTy = cast<PointerType>(C->getType()->getScalarType());
Eduard Burtescu19eb0312016-01-19 17:28:00 +00002071 Type *Ty = GetElementPtrInst::getIndexedType(PointeeTy, Idxs);
2072
Craig Topper2617dcc2014-04-15 06:32:26 +00002073 assert(Ty && "Invalid indices for GEP!");
Davide Italianodee018c2017-09-15 20:53:05 +00002074 Type *OrigGEPTy = PointerType::get(Ty, PtrTy->getAddressSpace());
Manuel Jacobc784e6a2016-01-19 16:34:31 +00002075 Type *GEPTy = PointerType::get(Ty, PtrTy->getAddressSpace());
2076 if (VectorType *VT = dyn_cast<VectorType>(C->getType()))
Davide Italianodee018c2017-09-15 20:53:05 +00002077 GEPTy = VectorType::get(OrigGEPTy, VT->getNumElements());
2078
2079 // The GEP returns a vector of pointers when one of more of
2080 // its arguments is a vector.
2081 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2082 if (auto *VT = dyn_cast<VectorType>(Idxs[i]->getType())) {
2083 GEPTy = VectorType::get(OrigGEPTy, VT->getNumElements());
2084 break;
2085 }
2086 }
2087
Manuel Jacobc784e6a2016-01-19 16:34:31 +00002088 return Constant::getNullValue(GEPTy);
Chris Lattner04b60fe2004-02-16 20:46:13 +00002089 }
2090 }
Chris Lattner1dd054c2004-01-12 22:07:24 +00002091
Nick Lewyckye0332982009-09-20 01:35:59 +00002092 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner1dd054c2004-01-12 22:07:24 +00002093 // Combine Indices - If the source pointer to this getelementptr instruction
2094 // is a getelementptr instruction, combine the indices of the two
2095 // getelementptr instructions into a single instruction.
2096 //
2097 if (CE->getOpcode() == Instruction::GetElementPtr) {
Peter Collingbourneab85225b2016-12-02 02:24:42 +00002098 gep_type_iterator LastI = gep_type_end(CE);
Chris Lattner1dd054c2004-01-12 22:07:24 +00002099 for (gep_type_iterator I = gep_type_begin(CE), E = gep_type_end(CE);
2100 I != E; ++I)
Peter Collingbourneab85225b2016-12-02 02:24:42 +00002101 LastI = I;
Chris Lattner1dd054c2004-01-12 22:07:24 +00002102
David Majnemerbd4fef42013-11-07 22:15:53 +00002103 // We cannot combine indices if doing so would take us outside of an
2104 // array or vector. Doing otherwise could trick us if we evaluated such a
2105 // GEP as part of a load.
2106 //
2107 // e.g. Consider if the original GEP was:
2108 // i8* getelementptr ({ [2 x i8], i32, i8, [3 x i8] }* @main.c,
2109 // i32 0, i32 0, i64 0)
2110 //
2111 // If we then tried to offset it by '8' to get to the third element,
2112 // an i8, we should *not* get:
2113 // i8* getelementptr ({ [2 x i8], i32, i8, [3 x i8] }* @main.c,
2114 // i32 0, i32 0, i64 8)
2115 //
2116 // This GEP tries to index array element '8 which runs out-of-bounds.
2117 // Subsequent evaluation would get confused and produce erroneous results.
2118 //
2119 // The following prohibits such a GEP from being formed by checking to see
Davide Italiano1a26f242017-07-27 22:20:44 +00002120 // if the index is in-range with respect to an array.
2121 // TODO: This code may be extended to handle vectors as well.
David Majnemer3c93dc92013-11-10 01:36:22 +00002122 bool PerformFold = false;
2123 if (Idx0->isNullValue())
2124 PerformFold = true;
Peter Collingbourneab85225b2016-12-02 02:24:42 +00002125 else if (LastI.isSequential())
David Majnemer3c93dc92013-11-10 01:36:22 +00002126 if (ConstantInt *CI = dyn_cast<ConstantInt>(Idx0))
Davide Italiano1a26f242017-07-27 22:20:44 +00002127 PerformFold = (!LastI.isBoundedSequential() ||
2128 isIndexInRangeOfArrayType(
2129 LastI.getSequentialNumElements(), CI)) &&
2130 !CE->getOperand(CE->getNumOperands() - 1)
2131 ->getType()
2132 ->isVectorTy();
David Majnemerbd4fef42013-11-07 22:15:53 +00002133
David Majnemer3c93dc92013-11-10 01:36:22 +00002134 if (PerformFold) {
Chris Lattner302116a2007-01-31 04:40:28 +00002135 SmallVector<Value*, 16> NewIndices;
Jay Foadca3fc382011-07-19 15:30:30 +00002136 NewIndices.reserve(Idxs.size() + CE->getNumOperands());
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00002137 NewIndices.append(CE->op_begin() + 1, CE->op_end() - 1);
Chris Lattner1dd054c2004-01-12 22:07:24 +00002138
2139 // Add the last index of the source with the first index of the new GEP.
2140 // Make sure to handle the case when they are actually different types.
2141 Constant *Combined = CE->getOperand(CE->getNumOperands()-1);
Chris Lattner13128ab2004-10-11 22:52:25 +00002142 // Otherwise it must be an array.
2143 if (!Idx0->isNullValue()) {
Chris Lattner229907c2011-07-18 04:54:35 +00002144 Type *IdxTy = Combined->getType();
Reid Spencer1a063892006-12-04 02:46:44 +00002145 if (IdxTy != Idx0->getType()) {
David Majnemer8b774542015-02-16 19:10:02 +00002146 unsigned CommonExtendedWidth =
2147 std::max(IdxTy->getIntegerBitWidth(),
2148 Idx0->getType()->getIntegerBitWidth());
2149 CommonExtendedWidth = std::max(CommonExtendedWidth, 64U);
2150
2151 Type *CommonTy =
2152 Type::getIntNTy(IdxTy->getContext(), CommonExtendedWidth);
2153 Constant *C1 = ConstantExpr::getSExtOrBitCast(Idx0, CommonTy);
2154 Constant *C2 = ConstantExpr::getSExtOrBitCast(Combined, CommonTy);
Owen Anderson487375e2009-07-29 18:55:55 +00002155 Combined = ConstantExpr::get(Instruction::Add, C1, C2);
Reid Spencer1a063892006-12-04 02:46:44 +00002156 } else {
2157 Combined =
Owen Anderson487375e2009-07-29 18:55:55 +00002158 ConstantExpr::get(Instruction::Add, Idx0, Combined);
Reid Spencer1a063892006-12-04 02:46:44 +00002159 }
Chris Lattner71068a02004-07-07 04:45:13 +00002160 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002161
Chris Lattner1dd054c2004-01-12 22:07:24 +00002162 NewIndices.push_back(Combined);
Jay Foadca3fc382011-07-19 15:30:30 +00002163 NewIndices.append(Idxs.begin() + 1, Idxs.end());
Peter Collingbourned93620b2016-11-10 22:34:55 +00002164
2165 // The combined GEP normally inherits its index inrange attribute from
2166 // the inner GEP, but if the inner GEP's last index was adjusted by the
2167 // outer GEP, any inbounds attribute on that index is invalidated.
2168 Optional<unsigned> IRIndex = cast<GEPOperator>(CE)->getInRangeIndex();
2169 if (IRIndex && *IRIndex == CE->getNumOperands() - 2 && !Idx0->isNullValue())
2170 IRIndex = None;
2171
David Blaikie4a2e73b2015-04-02 18:55:32 +00002172 return ConstantExpr::getGetElementPtr(
2173 cast<GEPOperator>(CE)->getSourceElementType(), CE->getOperand(0),
Peter Collingbourned93620b2016-11-10 22:34:55 +00002174 NewIndices, InBounds && cast<GEPOperator>(CE)->isInBounds(),
2175 IRIndex);
Chris Lattner1dd054c2004-01-12 22:07:24 +00002176 }
2177 }
2178
Meador Inge9b47f642013-02-27 02:26:42 +00002179 // Attempt to fold casts to the same type away. For example, folding:
Chris Lattner1dd054c2004-01-12 22:07:24 +00002180 //
Meador Inge9b47f642013-02-27 02:26:42 +00002181 // i32* getelementptr ([2 x i32]* bitcast ([3 x i32]* %X to [2 x i32]*),
2182 // i64 0, i64 0)
2183 // into:
2184 //
2185 // i32* getelementptr ([3 x i32]* %X, i64 0, i64 0)
2186 //
2187 // Don't fold if the cast is changing address spaces.
Jay Foadca3fc382011-07-19 15:30:30 +00002188 if (CE->isCast() && Idxs.size() > 1 && Idx0->isNullValue()) {
Meador Inge9b47f642013-02-27 02:26:42 +00002189 PointerType *SrcPtrTy =
2190 dyn_cast<PointerType>(CE->getOperand(0)->getType());
2191 PointerType *DstPtrTy = dyn_cast<PointerType>(CE->getType());
2192 if (SrcPtrTy && DstPtrTy) {
2193 ArrayType *SrcArrayTy =
2194 dyn_cast<ArrayType>(SrcPtrTy->getElementType());
2195 ArrayType *DstArrayTy =
2196 dyn_cast<ArrayType>(DstPtrTy->getElementType());
2197 if (SrcArrayTy && DstArrayTy
2198 && SrcArrayTy->getElementType() == DstArrayTy->getElementType()
2199 && SrcPtrTy->getAddressSpace() == DstPtrTy->getAddressSpace())
Peter Collingbourned93620b2016-11-10 22:34:55 +00002200 return ConstantExpr::getGetElementPtr(SrcArrayTy,
2201 (Constant *)CE->getOperand(0),
2202 Idxs, InBounds, InRangeIndex);
Meador Inge9b47f642013-02-27 02:26:42 +00002203 }
Chris Lattneraadc7782007-08-13 17:09:08 +00002204 }
Chris Lattner1dd054c2004-01-12 22:07:24 +00002205 }
Dan Gohman21c62162009-09-11 00:04:14 +00002206
2207 // Check to see if any array indices are not within the corresponding
David Majnemer3c93dc92013-11-10 01:36:22 +00002208 // notional array or vector bounds. If so, try to determine if they can be
2209 // factored out into preceding dimensions.
Dan Gohman21c62162009-09-11 00:04:14 +00002210 SmallVector<Constant *, 8> NewIdxs;
David Blaikie473b9432015-06-12 18:22:03 +00002211 Type *Ty = PointeeTy;
2212 Type *Prev = C->getType();
2213 bool Unknown = !isa<ConstantInt>(Idxs[0]);
2214 for (unsigned i = 1, e = Idxs.size(); i != e;
Dan Gohman21c62162009-09-11 00:04:14 +00002215 Prev = Ty, Ty = cast<CompositeType>(Ty)->getTypeAtIndex(Idxs[i]), ++i) {
David Majnemera7b6c972016-07-13 03:24:41 +00002216 auto *CI = dyn_cast<ConstantInt>(Idxs[i]);
2217 if (!CI) {
Dan Gohman21c62162009-09-11 00:04:14 +00002218 // We don't know if it's in range or not.
2219 Unknown = true;
David Majnemera7b6c972016-07-13 03:24:41 +00002220 continue;
Dan Gohman21c62162009-09-11 00:04:14 +00002221 }
Haicheng Wueb92e562017-10-28 02:27:14 +00002222 if (!isa<ConstantInt>(Idxs[i - 1]))
2223 // FIXME: add the support of cosntant vector index.
2224 continue;
Peter Collingbourned93620b2016-11-10 22:34:55 +00002225 if (InRangeIndex && i == *InRangeIndex + 1) {
2226 // If an index is marked inrange, we cannot apply this canonicalization to
2227 // the following index, as that will cause the inrange index to point to
2228 // the wrong element.
2229 continue;
2230 }
David Majnemera7b6c972016-07-13 03:24:41 +00002231 if (isa<StructType>(Ty)) {
2232 // The verify makes sure that GEPs into a struct are in range.
2233 continue;
2234 }
2235 auto *STy = cast<SequentialType>(Ty);
David Majnemera7b6c972016-07-13 03:24:41 +00002236 if (isa<VectorType>(STy)) {
2237 // There can be awkward padding in after a non-power of two vector.
2238 Unknown = true;
2239 continue;
2240 }
Peter Collingbournebc070522016-12-02 03:20:58 +00002241 if (isIndexInRangeOfArrayType(STy->getNumElements(), CI))
David Majnemera7b6c972016-07-13 03:24:41 +00002242 // It's in range, skip to the next index.
2243 continue;
Peter Collingbourne45681582016-12-02 03:05:41 +00002244 if (isa<StructType>(Prev)) {
David Majnemera7b6c972016-07-13 03:24:41 +00002245 // It's out of range, but the prior dimension is a struct
2246 // so we can't do anything about it.
2247 Unknown = true;
2248 continue;
2249 }
2250 if (CI->getSExtValue() < 0) {
2251 // It's out of range and negative, don't try to factor it.
2252 Unknown = true;
2253 continue;
2254 }
2255 // It's out of range, but we can factor it into the prior
2256 // dimension.
2257 NewIdxs.resize(Idxs.size());
2258 // Determine the number of elements in our sequential type.
2259 uint64_t NumElements = STy->getArrayNumElements();
2260
2261 ConstantInt *Factor = ConstantInt::get(CI->getType(), NumElements);
2262 NewIdxs[i] = ConstantExpr::getSRem(CI, Factor);
2263
Javed Absar382f9872017-03-08 23:01:50 +00002264 Constant *PrevIdx = NewIdxs[i-1] ? NewIdxs[i-1] :
2265 cast<Constant>(Idxs[i - 1]);
David Majnemera7b6c972016-07-13 03:24:41 +00002266 Constant *Div = ConstantExpr::getSDiv(CI, Factor);
2267
2268 unsigned CommonExtendedWidth =
2269 std::max(PrevIdx->getType()->getIntegerBitWidth(),
2270 Div->getType()->getIntegerBitWidth());
2271 CommonExtendedWidth = std::max(CommonExtendedWidth, 64U);
2272
2273 // Before adding, extend both operands to i64 to avoid
2274 // overflow trouble.
2275 if (!PrevIdx->getType()->isIntegerTy(CommonExtendedWidth))
2276 PrevIdx = ConstantExpr::getSExt(
2277 PrevIdx, Type::getIntNTy(Div->getContext(), CommonExtendedWidth));
2278 if (!Div->getType()->isIntegerTy(CommonExtendedWidth))
2279 Div = ConstantExpr::getSExt(
2280 Div, Type::getIntNTy(Div->getContext(), CommonExtendedWidth));
2281
2282 NewIdxs[i - 1] = ConstantExpr::getAdd(PrevIdx, Div);
Dan Gohman21c62162009-09-11 00:04:14 +00002283 }
2284
2285 // If we did any factoring, start over with the adjusted indices.
2286 if (!NewIdxs.empty()) {
Jay Foadca3fc382011-07-19 15:30:30 +00002287 for (unsigned i = 0, e = Idxs.size(); i != e; ++i)
Jay Foad1d4a8fe2011-01-14 08:07:43 +00002288 if (!NewIdxs[i]) NewIdxs[i] = cast<Constant>(Idxs[i]);
Peter Collingbourned93620b2016-11-10 22:34:55 +00002289 return ConstantExpr::getGetElementPtr(PointeeTy, C, NewIdxs, InBounds,
2290 InRangeIndex);
Dan Gohman21c62162009-09-11 00:04:14 +00002291 }
2292
2293 // If all indices are known integers and normalized, we can do a simple
2294 // check for the "inbounds" property.
Peter Collingbourned93620b2016-11-10 22:34:55 +00002295 if (!Unknown && !InBounds)
Duncan P. N. Exon Smith0c39d402014-08-16 01:54:32 +00002296 if (auto *GV = dyn_cast<GlobalVariable>(C))
2297 if (!GV->hasExternalWeakLinkage() && isInBoundsIndices(Idxs))
Peter Collingbourned93620b2016-11-10 22:34:55 +00002298 return ConstantExpr::getGetElementPtr(PointeeTy, C, Idxs,
2299 /*InBounds=*/true, InRangeIndex);
Dan Gohman21c62162009-09-11 00:04:14 +00002300
Craig Topperc6207612014-04-09 06:08:46 +00002301 return nullptr;
Chris Lattner1dd054c2004-01-12 22:07:24 +00002302}