blob: 8c784ab1e682c805fd3f1df53f50de5f29bec71b [file] [log] [blame]
Chandler Carrutha9174582015-01-22 05:25:13 +00001//===- InstCombineInternal.h - InstCombine pass internals -------*- C++ -*-===//
Chris Lattner35522b72010-01-04 07:12:23 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Chandler Carrutha9174582015-01-22 05:25:13 +00009/// \file
10///
11/// This file provides internal interfaces used to implement the InstCombine.
12///
13//===----------------------------------------------------------------------===//
Chris Lattner35522b72010-01-04 07:12:23 +000014
Chandler Carrutha9174582015-01-22 05:25:13 +000015#ifndef LLVM_LIB_TRANSFORMS_INSTCOMBINE_INSTCOMBINEINTERNAL_H
16#define LLVM_LIB_TRANSFORMS_INSTCOMBINE_INSTCOMBINEINTERNAL_H
Chris Lattner35522b72010-01-04 07:12:23 +000017
Chandler Carruth66b31302015-01-04 12:03:27 +000018#include "llvm/Analysis/AssumptionCache.h"
Chandler Carruth5175b9a2015-01-20 08:35:24 +000019#include "llvm/Analysis/LoopInfo.h"
Chandler Carruth452a0072014-03-04 11:59:06 +000020#include "llvm/Analysis/TargetFolder.h"
Chandler Carruth802d7552012-12-04 07:12:27 +000021#include "llvm/Analysis/ValueTracking.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000022#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000023#include "llvm/IR/IRBuilder.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000024#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000025#include "llvm/IR/IntrinsicInst.h"
26#include "llvm/IR/Operator.h"
Hal Finkel74c2f352014-09-07 12:44:26 +000027#include "llvm/IR/PatternMatch.h"
Chris Lattner35522b72010-01-04 07:12:23 +000028#include "llvm/Pass.h"
Chandler Carruth83ba2692015-01-24 04:19:17 +000029#include "llvm/Transforms/InstCombine/InstCombineWorklist.h"
Chris Lattner35522b72010-01-04 07:12:23 +000030
Chandler Carruth964daaa2014-04-22 02:55:47 +000031#define DEBUG_TYPE "instcombine"
32
Chris Lattner35522b72010-01-04 07:12:23 +000033namespace llvm {
Chandler Carruthd70cc602014-05-07 17:36:59 +000034class CallSite;
35class DataLayout;
Hal Finkel60db0582014-09-07 18:57:58 +000036class DominatorTree;
Chandler Carruthd70cc602014-05-07 17:36:59 +000037class TargetLibraryInfo;
38class DbgDeclareInst;
39class MemIntrinsic;
40class MemSetInst;
Jakub Staszak190db2f2013-01-14 23:16:36 +000041
Chandler Carruth3a622162015-01-20 19:27:58 +000042/// \brief Specific patterns of select instructions we can match.
Chris Lattner35522b72010-01-04 07:12:23 +000043enum SelectPatternFlavor {
44 SPF_UNKNOWN = 0,
Chandler Carruthd70cc602014-05-07 17:36:59 +000045 SPF_SMIN,
46 SPF_UMIN,
47 SPF_SMAX,
Dinesh Dwivedi3217b6c2014-06-06 06:54:45 +000048 SPF_UMAX,
49 SPF_ABS,
50 SPF_NABS
Chris Lattner35522b72010-01-04 07:12:23 +000051};
Jakub Staszak190db2f2013-01-14 23:16:36 +000052
Chandler Carruth3a622162015-01-20 19:27:58 +000053/// \brief Assign a complexity or rank value to LLVM Values.
54///
55/// This routine maps IR values to various complexity ranks:
56/// 0 -> undef
57/// 1 -> Constants
58/// 2 -> Other non-instructions
59/// 3 -> Arguments
60/// 3 -> Unary operations
61/// 4 -> Other instructions
Chris Lattner2188e402010-01-04 07:37:31 +000062static inline unsigned getComplexity(Value *V) {
63 if (isa<Instruction>(V)) {
Chandler Carruthd70cc602014-05-07 17:36:59 +000064 if (BinaryOperator::isNeg(V) || BinaryOperator::isFNeg(V) ||
Chris Lattner2188e402010-01-04 07:37:31 +000065 BinaryOperator::isNot(V))
66 return 3;
67 return 4;
68 }
Chandler Carruthd70cc602014-05-07 17:36:59 +000069 if (isa<Argument>(V))
70 return 3;
Chris Lattner2188e402010-01-04 07:37:31 +000071 return isa<Constant>(V) ? (isa<UndefValue>(V) ? 0 : 1) : 2;
72}
Chris Lattner35522b72010-01-04 07:12:23 +000073
Chandler Carruth3a622162015-01-20 19:27:58 +000074/// \brief Add one to a Constant
Benjamin Kramer970f4952014-01-19 16:56:10 +000075static inline Constant *AddOne(Constant *C) {
76 return ConstantExpr::getAdd(C, ConstantInt::get(C->getType(), 1));
77}
Chandler Carruth3a622162015-01-20 19:27:58 +000078/// \brief Subtract one from a Constant
Benjamin Kramer970f4952014-01-19 16:56:10 +000079static inline Constant *SubOne(Constant *C) {
80 return ConstantExpr::getSub(C, ConstantInt::get(C->getType(), 1));
81}
82
Sanjoy Das82ea3d42015-02-24 00:08:41 +000083/// \brief Return true if the specified value is free to invert (apply ~ to).
84/// This happens in cases where the ~ can be eliminated. If WillInvertAllUses
85/// is true, work under the assumption that the caller intends to remove all
86/// uses of V and only keep uses of ~V.
87///
88static inline bool IsFreeToInvert(Value *V, bool WillInvertAllUses) {
89 // ~(~(X)) -> X.
90 if (BinaryOperator::isNot(V))
91 return true;
92
93 // Constants can be considered to be not'ed values.
94 if (isa<ConstantInt>(V))
95 return true;
96
97 // Compares can be inverted if all of their uses are being modified to use the
98 // ~V.
99 if (isa<CmpInst>(V))
100 return WillInvertAllUses;
101
102 // If `V` is of the form `A + Constant` then `-1 - V` can be folded into `(-1
103 // - Constant) - A` if we are willing to invert all of the uses.
104 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(V))
105 if (BO->getOpcode() == Instruction::Add ||
106 BO->getOpcode() == Instruction::Sub)
107 if (isa<Constant>(BO->getOperand(0)) || isa<Constant>(BO->getOperand(1)))
108 return WillInvertAllUses;
109
110 return false;
111}
112
Chandler Carruth3a622162015-01-20 19:27:58 +0000113/// \brief An IRBuilder inserter that adds new instructions to the instcombine
114/// worklist.
Jakub Staszak190db2f2013-01-14 23:16:36 +0000115class LLVM_LIBRARY_VISIBILITY InstCombineIRInserter
Chris Lattner35522b72010-01-04 07:12:23 +0000116 : public IRBuilderDefaultInserter<true> {
117 InstCombineWorklist &Worklist;
Chandler Carruth66b31302015-01-04 12:03:27 +0000118 AssumptionCache *AC;
Chandler Carruthd70cc602014-05-07 17:36:59 +0000119
Chris Lattner35522b72010-01-04 07:12:23 +0000120public:
Chandler Carruth66b31302015-01-04 12:03:27 +0000121 InstCombineIRInserter(InstCombineWorklist &WL, AssumptionCache *AC)
122 : Worklist(WL), AC(AC) {}
Jakub Staszak190db2f2013-01-14 23:16:36 +0000123
Chandler Carruthd70cc602014-05-07 17:36:59 +0000124 void InsertHelper(Instruction *I, const Twine &Name, BasicBlock *BB,
125 BasicBlock::iterator InsertPt) const {
Chris Lattner35522b72010-01-04 07:12:23 +0000126 IRBuilderDefaultInserter<true>::InsertHelper(I, Name, BB, InsertPt);
127 Worklist.Add(I);
Hal Finkel74c2f352014-09-07 12:44:26 +0000128
129 using namespace llvm::PatternMatch;
Benjamin Kramer63207bc2014-10-25 18:09:01 +0000130 if (match(I, m_Intrinsic<Intrinsic::assume>()))
Chandler Carruth66b31302015-01-04 12:03:27 +0000131 AC->registerAssumption(cast<CallInst>(I));
Chris Lattner35522b72010-01-04 07:12:23 +0000132 }
133};
Jakub Staszak190db2f2013-01-14 23:16:36 +0000134
Chandler Carruth3a622162015-01-20 19:27:58 +0000135/// \brief The core instruction combiner logic.
136///
137/// This class provides both the logic to recursively visit instructions and
138/// combine them, as well as the pass infrastructure for running this as part
139/// of the LLVM pass pipeline.
Duncan Sands6c5e4352010-05-11 20:16:09 +0000140class LLVM_LIBRARY_VISIBILITY InstCombiner
Chandler Carruth1edb9d62015-01-20 22:44:35 +0000141 : public InstVisitor<InstCombiner, Instruction *> {
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000142 // FIXME: These members shouldn't be public.
Chris Lattner35522b72010-01-04 07:12:23 +0000143public:
Chandler Carruth3a622162015-01-20 19:27:58 +0000144 /// \brief A worklist of the instructions that need to be simplified.
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000145 InstCombineWorklist &Worklist;
Chris Lattner35522b72010-01-04 07:12:23 +0000146
Chandler Carruth3a622162015-01-20 19:27:58 +0000147 /// \brief An IRBuilder that automatically inserts new instructions into the
148 /// worklist.
Chris Lattner35522b72010-01-04 07:12:23 +0000149 typedef IRBuilder<true, TargetFolder, InstCombineIRInserter> BuilderTy;
150 BuilderTy *Builder;
Jakub Staszak190db2f2013-01-14 23:16:36 +0000151
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000152private:
153 // Mode in which we are running the combiner.
154 const bool MinimizeSize;
155
156 // Required analyses.
157 // FIXME: These can never be null and should be references.
158 AssumptionCache *AC;
159 TargetLibraryInfo *TLI;
160 DominatorTree *DT;
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000161 const DataLayout &DL;
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000162
163 // Optional analyses. When non-null, these can both be used to do better
164 // combining and will be updated to reflect any changes.
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000165 LoopInfo *LI;
166
167 bool MadeIRChange;
Chris Lattner35522b72010-01-04 07:12:23 +0000168
169public:
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000170 InstCombiner(InstCombineWorklist &Worklist, BuilderTy *Builder,
171 bool MinimizeSize, AssumptionCache *AC, TargetLibraryInfo *TLI,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000172 DominatorTree *DT, const DataLayout &DL, LoopInfo *LI)
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000173 : Worklist(Worklist), Builder(Builder), MinimizeSize(MinimizeSize),
174 AC(AC), TLI(TLI), DT(DT), DL(DL), LI(LI), MadeIRChange(false) {}
Jakub Staszak190db2f2013-01-14 23:16:36 +0000175
Chandler Carruthdf5747a2015-01-21 11:38:17 +0000176 /// \brief Run the combiner over the entire worklist until it is empty.
177 ///
178 /// \returns true if the IR is changed.
179 bool run();
Chris Lattner35522b72010-01-04 07:12:23 +0000180
Chandler Carruth66b31302015-01-04 12:03:27 +0000181 AssumptionCache *getAssumptionCache() const { return AC; }
Hal Finkel74c2f352014-09-07 12:44:26 +0000182
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000183 const DataLayout &getDataLayout() const { return DL; }
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000184
Hal Finkel60db0582014-09-07 18:57:58 +0000185 DominatorTree *getDominatorTree() const { return DT; }
Chris Lattner35522b72010-01-04 07:12:23 +0000186
Chandler Carruth5175b9a2015-01-20 08:35:24 +0000187 LoopInfo *getLoopInfo() const { return LI; }
188
Chad Rosier43a33062011-12-02 01:26:24 +0000189 TargetLibraryInfo *getTargetLibraryInfo() const { return TLI; }
190
Chris Lattner35522b72010-01-04 07:12:23 +0000191 // Visitation implementation - Implement instruction combining for different
192 // instruction types. The semantics are as follows:
193 // Return Value:
194 // null - No change was made
195 // I - Change was made, I is still valid, I may be dead though
196 // otherwise - Change was made, replace I with returned instruction
197 //
198 Instruction *visitAdd(BinaryOperator &I);
199 Instruction *visitFAdd(BinaryOperator &I);
Chris Lattner229907c2011-07-18 04:54:35 +0000200 Value *OptimizePointerDifference(Value *LHS, Value *RHS, Type *Ty);
Chris Lattner35522b72010-01-04 07:12:23 +0000201 Instruction *visitSub(BinaryOperator &I);
202 Instruction *visitFSub(BinaryOperator &I);
203 Instruction *visitMul(BinaryOperator &I);
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000204 Value *foldFMulConst(Instruction *FMulOrDiv, Constant *C,
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000205 Instruction *InsertBefore);
Chris Lattner35522b72010-01-04 07:12:23 +0000206 Instruction *visitFMul(BinaryOperator &I);
207 Instruction *visitURem(BinaryOperator &I);
208 Instruction *visitSRem(BinaryOperator &I);
209 Instruction *visitFRem(BinaryOperator &I);
210 bool SimplifyDivRemOfSelect(BinaryOperator &I);
211 Instruction *commonRemTransforms(BinaryOperator &I);
212 Instruction *commonIRemTransforms(BinaryOperator &I);
213 Instruction *commonDivTransforms(BinaryOperator &I);
214 Instruction *commonIDivTransforms(BinaryOperator &I);
215 Instruction *visitUDiv(BinaryOperator &I);
216 Instruction *visitSDiv(BinaryOperator &I);
Frits van Bommel2a559512011-01-29 17:50:27 +0000217 Instruction *visitFDiv(BinaryOperator &I);
Erik Ecksteind1817522014-12-03 10:39:15 +0000218 Value *simplifyRangeCheck(ICmpInst *Cmp0, ICmpInst *Cmp1, bool Inverted);
Chris Lattner067459c2010-03-05 08:46:26 +0000219 Value *FoldAndOfICmps(ICmpInst *LHS, ICmpInst *RHS);
220 Value *FoldAndOfFCmps(FCmpInst *LHS, FCmpInst *RHS);
Chris Lattner35522b72010-01-04 07:12:23 +0000221 Instruction *visitAnd(BinaryOperator &I);
Hal Finkel60db0582014-09-07 18:57:58 +0000222 Value *FoldOrOfICmps(ICmpInst *LHS, ICmpInst *RHS, Instruction *CxtI);
Chris Lattner067459c2010-03-05 08:46:26 +0000223 Value *FoldOrOfFCmps(FCmpInst *LHS, FCmpInst *RHS);
Chandler Carruthd70cc602014-05-07 17:36:59 +0000224 Instruction *FoldOrWithConstants(BinaryOperator &I, Value *Op, Value *A,
225 Value *B, Value *C);
David Majnemer5d1aeba2014-08-21 05:14:48 +0000226 Instruction *FoldXorWithConstants(BinaryOperator &I, Value *Op, Value *A,
227 Value *B, Value *C);
Chandler Carruthd70cc602014-05-07 17:36:59 +0000228 Instruction *visitOr(BinaryOperator &I);
Chris Lattner35522b72010-01-04 07:12:23 +0000229 Instruction *visitXor(BinaryOperator &I);
230 Instruction *visitShl(BinaryOperator &I);
231 Instruction *visitAShr(BinaryOperator &I);
232 Instruction *visitLShr(BinaryOperator &I);
233 Instruction *commonShiftTransforms(BinaryOperator &I);
234 Instruction *FoldFCmp_IntToFP_Cst(FCmpInst &I, Instruction *LHSI,
235 Constant *RHSC);
236 Instruction *FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP,
237 GlobalVariable *GV, CmpInst &ICI,
Craig Toppere73658d2014-04-28 04:05:08 +0000238 ConstantInt *AndCst = nullptr);
Chris Lattner35522b72010-01-04 07:12:23 +0000239 Instruction *visitFCmpInst(FCmpInst &I);
240 Instruction *visitICmpInst(ICmpInst &I);
241 Instruction *visitICmpInstWithCastAndCast(ICmpInst &ICI);
Chandler Carruthd70cc602014-05-07 17:36:59 +0000242 Instruction *visitICmpInstWithInstAndIntCst(ICmpInst &ICI, Instruction *LHS,
Chris Lattner35522b72010-01-04 07:12:23 +0000243 ConstantInt *RHS);
244 Instruction *FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
245 ConstantInt *DivRHS);
Chris Lattnerd369f572011-02-13 07:43:07 +0000246 Instruction *FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *DivI,
247 ConstantInt *DivRHS);
Suyog Sarda3a8c2c12014-07-22 19:19:36 +0000248 Instruction *FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
249 ConstantInt *CI1, ConstantInt *CI2);
David Majnemer59939ac2014-10-19 08:23:08 +0000250 Instruction *FoldICmpCstShlCst(ICmpInst &I, Value *Op, Value *A,
251 ConstantInt *CI1, ConstantInt *CI2);
Benjamin Kramer0e2d1622013-09-20 22:12:42 +0000252 Instruction *FoldICmpAddOpCst(Instruction &ICI, Value *X, ConstantInt *CI,
253 ICmpInst::Predicate Pred);
Chris Lattner35522b72010-01-04 07:12:23 +0000254 Instruction *FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
255 ICmpInst::Predicate Cond, Instruction &I);
Matt Arsenaultfed3dc82014-04-14 21:50:37 +0000256 Instruction *FoldShiftByConstant(Value *Op0, Constant *Op1,
Chris Lattner35522b72010-01-04 07:12:23 +0000257 BinaryOperator &I);
258 Instruction *commonCastTransforms(CastInst &CI);
Chris Lattner35522b72010-01-04 07:12:23 +0000259 Instruction *commonPointerCastTransforms(CastInst &CI);
260 Instruction *visitTrunc(TruncInst &CI);
261 Instruction *visitZExt(ZExtInst &CI);
262 Instruction *visitSExt(SExtInst &CI);
263 Instruction *visitFPTrunc(FPTruncInst &CI);
264 Instruction *visitFPExt(CastInst &CI);
265 Instruction *visitFPToUI(FPToUIInst &FI);
266 Instruction *visitFPToSI(FPToSIInst &FI);
267 Instruction *visitUIToFP(CastInst &CI);
268 Instruction *visitSIToFP(CastInst &CI);
269 Instruction *visitPtrToInt(PtrToIntInst &CI);
270 Instruction *visitIntToPtr(IntToPtrInst &CI);
271 Instruction *visitBitCast(BitCastInst &CI);
Matt Arsenaulta9e95ab2013-11-15 05:45:08 +0000272 Instruction *visitAddrSpaceCast(AddrSpaceCastInst &CI);
Chandler Carruthd70cc602014-05-07 17:36:59 +0000273 Instruction *FoldSelectOpOp(SelectInst &SI, Instruction *TI, Instruction *FI);
274 Instruction *FoldSelectIntoOp(SelectInst &SI, Value *, Value *);
Chris Lattner35522b72010-01-04 07:12:23 +0000275 Instruction *FoldSPFofSPF(Instruction *Inner, SelectPatternFlavor SPF1,
276 Value *A, Value *B, Instruction &Outer,
277 SelectPatternFlavor SPF2, Value *C);
Mehdi Aminib9a0fa42015-02-16 21:47:54 +0000278 Instruction *FoldItoFPtoI(Instruction &FI);
Chris Lattner35522b72010-01-04 07:12:23 +0000279 Instruction *visitSelectInst(SelectInst &SI);
280 Instruction *visitSelectInstWithICmp(SelectInst &SI, ICmpInst *ICI);
281 Instruction *visitCallInst(CallInst &CI);
282 Instruction *visitInvokeInst(InvokeInst &II);
283
284 Instruction *SliceUpIllegalIntegerPHI(PHINode &PN);
285 Instruction *visitPHINode(PHINode &PN);
286 Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
287 Instruction *visitAllocaInst(AllocaInst &AI);
Nuno Lopes95cc4f32012-07-09 18:38:20 +0000288 Instruction *visitAllocSite(Instruction &FI);
Gabor Greif75f69432010-06-24 12:21:15 +0000289 Instruction *visitFree(CallInst &FI);
Chris Lattner35522b72010-01-04 07:12:23 +0000290 Instruction *visitLoadInst(LoadInst &LI);
291 Instruction *visitStoreInst(StoreInst &SI);
292 Instruction *visitBranchInst(BranchInst &BI);
293 Instruction *visitSwitchInst(SwitchInst &SI);
Hal Finkel93873cc12014-09-07 21:28:34 +0000294 Instruction *visitReturnInst(ReturnInst &RI);
Michael Zolotukhin7d6293a2014-05-07 14:30:18 +0000295 Instruction *visitInsertValueInst(InsertValueInst &IV);
Chris Lattner35522b72010-01-04 07:12:23 +0000296 Instruction *visitInsertElementInst(InsertElementInst &IE);
297 Instruction *visitExtractElementInst(ExtractElementInst &EI);
298 Instruction *visitShuffleVectorInst(ShuffleVectorInst &SVI);
299 Instruction *visitExtractValueInst(ExtractValueInst &EV);
Duncan Sands5c055792011-09-30 13:12:16 +0000300 Instruction *visitLandingPadInst(LandingPadInst &LI);
Chris Lattner35522b72010-01-04 07:12:23 +0000301
302 // visitInstruction - Specify what to return for unhandled instructions...
Craig Toppere73658d2014-04-28 04:05:08 +0000303 Instruction *visitInstruction(Instruction &I) { return nullptr; }
Chris Lattner35522b72010-01-04 07:12:23 +0000304
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +0000305 // True when DB dominates all uses of DI execpt UI.
306 // UI must be in the same block as DI.
307 // The routine checks that the DI parent and DB are different.
308 bool dominatesAllUses(const Instruction *DI, const Instruction *UI,
309 const BasicBlock *DB) const;
310
311 // Replace select with select operand SIOpd in SI-ICmp sequence when possible
312 bool replacedSelectWithOperand(SelectInst *SI, const ICmpInst *Icmp,
313 const unsigned SIOpd);
314
Chris Lattner35522b72010-01-04 07:12:23 +0000315private:
Chris Lattner229907c2011-07-18 04:54:35 +0000316 bool ShouldChangeType(Type *From, Type *To) const;
Chris Lattner2188e402010-01-04 07:37:31 +0000317 Value *dyn_castNegVal(Value *V) const;
Chandler Carruthd70cc602014-05-07 17:36:59 +0000318 Value *dyn_castFNegVal(Value *V, bool NoSignedZero = false) const;
Matt Arsenaultd79f7d92013-08-19 22:17:40 +0000319 Type *FindElementAtOffset(Type *PtrTy, int64_t Offset,
Chandler Carruthd70cc602014-05-07 17:36:59 +0000320 SmallVectorImpl<Value *> &NewIndices);
Chris Lattner2b295a02010-01-04 07:53:58 +0000321 Instruction *FoldOpIntoSelect(Instruction &Op, SelectInst *SI);
Jakub Staszak190db2f2013-01-14 23:16:36 +0000322
Chandler Carruth3a622162015-01-20 19:27:58 +0000323 /// \brief Classify whether a cast is worth optimizing.
324 ///
325 /// Returns true if the cast from "V to Ty" actually results in any code
326 /// being generated and is interesting to optimize out. If the cast can be
327 /// eliminated by some other simple transformation, we prefer to do the
328 /// simplification first.
Chandler Carruthd70cc602014-05-07 17:36:59 +0000329 bool ShouldOptimizeCast(Instruction::CastOps opcode, const Value *V,
Chris Lattner229907c2011-07-18 04:54:35 +0000330 Type *Ty);
Chris Lattner2188e402010-01-04 07:37:31 +0000331
Chris Lattner35522b72010-01-04 07:12:23 +0000332 Instruction *visitCallSite(CallSite CS);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000333 Instruction *tryOptimizeCall(CallInst *CI);
Chris Lattner35522b72010-01-04 07:12:23 +0000334 bool transformConstExprCastCall(CallSite CS);
Duncan Sandsa0984362011-09-06 13:37:06 +0000335 Instruction *transformCallThroughTrampoline(CallSite CS,
336 IntrinsicInst *Tramp);
Chris Lattner35522b72010-01-04 07:12:23 +0000337 Instruction *transformZExtICmp(ICmpInst *ICI, Instruction &CI,
338 bool DoXform = true);
Benjamin Kramer398b8c52011-04-01 20:09:03 +0000339 Instruction *transformSExtICmp(ICmpInst *ICI, Instruction &CI);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000340 bool WillNotOverflowSignedAdd(Value *LHS, Value *RHS, Instruction &CxtI);
341 bool WillNotOverflowSignedSub(Value *LHS, Value *RHS, Instruction &CxtI);
342 bool WillNotOverflowUnsignedSub(Value *LHS, Value *RHS, Instruction &CxtI);
343 bool WillNotOverflowSignedMul(Value *LHS, Value *RHS, Instruction &CxtI);
Nuno Lopesa2f6cec2012-05-22 17:19:09 +0000344 Value *EmitGEPOffset(User *GEP);
Anat Shemer0c95efa2013-04-18 19:35:39 +0000345 Instruction *scalarizePHI(ExtractElementInst &EI, PHINode *PN);
Nick Lewyckya2b77202013-05-31 00:59:42 +0000346 Value *EvaluateInDifferentElementOrder(Value *V, ArrayRef<int> Mask);
Chris Lattner35522b72010-01-04 07:12:23 +0000347
348public:
Chandler Carruth3a622162015-01-20 19:27:58 +0000349 /// \brief Inserts an instruction \p New before instruction \p Old
350 ///
351 /// Also adds the new instruction to the worklist and returns \p New so that
352 /// it is suitable for use as the return from the visitation patterns.
Chris Lattner35522b72010-01-04 07:12:23 +0000353 Instruction *InsertNewInstBefore(Instruction *New, Instruction &Old) {
Craig Toppere73658d2014-04-28 04:05:08 +0000354 assert(New && !New->getParent() &&
Chris Lattner35522b72010-01-04 07:12:23 +0000355 "New instruction already inserted into a basic block!");
356 BasicBlock *BB = Old.getParent();
Chandler Carruthd70cc602014-05-07 17:36:59 +0000357 BB->getInstList().insert(&Old, New); // Insert inst
Chris Lattner35522b72010-01-04 07:12:23 +0000358 Worklist.Add(New);
359 return New;
360 }
Eli Friedman6efb64e2011-05-19 01:20:42 +0000361
Chandler Carruth3a622162015-01-20 19:27:58 +0000362 /// \brief Same as InsertNewInstBefore, but also sets the debug loc.
Eli Friedman6efb64e2011-05-19 01:20:42 +0000363 Instruction *InsertNewInstWith(Instruction *New, Instruction &Old) {
364 New->setDebugLoc(Old.getDebugLoc());
365 return InsertNewInstBefore(New, Old);
366 }
367
Chandler Carruth3a622162015-01-20 19:27:58 +0000368 /// \brief A combiner-aware RAUW-like routine.
369 ///
370 /// This method is to be used when an instruction is found to be dead,
371 /// replacable with another preexisting expression. Here we add all uses of
372 /// I to the worklist, replace all uses of I with the new value, then return
373 /// I, so that the inst combiner will know that I was modified.
Chris Lattner35522b72010-01-04 07:12:23 +0000374 Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
Chandler Carruthd70cc602014-05-07 17:36:59 +0000375 Worklist.AddUsersToWorkList(I); // Add all modified instrs to worklist.
Jakub Staszak190db2f2013-01-14 23:16:36 +0000376
Chris Lattner35522b72010-01-04 07:12:23 +0000377 // If we are replacing the instruction with itself, this must be in a
378 // segment of unreachable code, so just clobber the instruction.
Jakub Staszak190db2f2013-01-14 23:16:36 +0000379 if (&I == V)
Chris Lattner35522b72010-01-04 07:12:23 +0000380 V = UndefValue::get(I.getType());
Frits van Bommeld14d9912011-03-27 23:32:31 +0000381
Matt Arsenaulte6db7602013-09-05 19:48:28 +0000382 DEBUG(dbgs() << "IC: Replacing " << I << "\n"
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000383 << " with " << *V << '\n');
Frits van Bommeld14d9912011-03-27 23:32:31 +0000384
Chris Lattner35522b72010-01-04 07:12:23 +0000385 I.replaceAllUsesWith(V);
386 return &I;
387 }
388
Erik Eckstein096ff7d2014-12-11 08:02:30 +0000389 /// Creates a result tuple for an overflow intrinsic \p II with a given
390 /// \p Result and a constant \p Overflow value. If \p ReUseName is true the
391 /// \p Result's name is taken from \p II.
392 Instruction *CreateOverflowTuple(IntrinsicInst *II, Value *Result,
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000393 bool Overflow, bool ReUseName = true) {
Erik Eckstein096ff7d2014-12-11 08:02:30 +0000394 if (ReUseName)
395 Result->takeName(II);
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000396 Constant *V[] = {UndefValue::get(Result->getType()),
397 Overflow ? Builder->getTrue() : Builder->getFalse()};
Erik Eckstein096ff7d2014-12-11 08:02:30 +0000398 StructType *ST = cast<StructType>(II->getType());
399 Constant *Struct = ConstantStruct::get(ST, V);
400 return InsertValueInst::Create(Struct, Result, 0);
401 }
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000402
Chandler Carruth3a622162015-01-20 19:27:58 +0000403 /// \brief Combiner aware instruction erasure.
404 ///
405 /// When dealing with an instruction that has side effects or produces a void
406 /// value, we can't rely on DCE to delete the instruction. Instead, visit
407 /// methods should return the value returned by this function.
Chris Lattner35522b72010-01-04 07:12:23 +0000408 Instruction *EraseInstFromFunction(Instruction &I) {
Matt Arsenaulte6db7602013-09-05 19:48:28 +0000409 DEBUG(dbgs() << "IC: ERASE " << I << '\n');
Chris Lattner35522b72010-01-04 07:12:23 +0000410
411 assert(I.use_empty() && "Cannot erase instruction that is used!");
412 // Make sure that we reprocess all operands now that we reduced their
413 // use counts.
414 if (I.getNumOperands() < 8) {
415 for (User::op_iterator i = I.op_begin(), e = I.op_end(); i != e; ++i)
416 if (Instruction *Op = dyn_cast<Instruction>(*i))
417 Worklist.Add(Op);
418 }
419 Worklist.Remove(&I);
420 I.eraseFromParent();
421 MadeIRChange = true;
Chandler Carruthd70cc602014-05-07 17:36:59 +0000422 return nullptr; // Don't do anything with FI
Chris Lattner35522b72010-01-04 07:12:23 +0000423 }
Jakub Staszak190db2f2013-01-14 23:16:36 +0000424
Jay Foada0653a32014-05-14 21:14:37 +0000425 void computeKnownBits(Value *V, APInt &KnownZero, APInt &KnownOne,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000426 unsigned Depth, Instruction *CxtI) const {
Chandler Carruth66b31302015-01-04 12:03:27 +0000427 return llvm::computeKnownBits(V, KnownZero, KnownOne, DL, Depth, AC, CxtI,
428 DT);
Chris Lattner35522b72010-01-04 07:12:23 +0000429 }
Jakub Staszak190db2f2013-01-14 23:16:36 +0000430
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000431 bool MaskedValueIsZero(Value *V, const APInt &Mask, unsigned Depth = 0,
Hal Finkel60db0582014-09-07 18:57:58 +0000432 Instruction *CxtI = nullptr) const {
Chandler Carruth66b31302015-01-04 12:03:27 +0000433 return llvm::MaskedValueIsZero(V, Mask, DL, Depth, AC, CxtI, DT);
Chris Lattner35522b72010-01-04 07:12:23 +0000434 }
Hal Finkel60db0582014-09-07 18:57:58 +0000435 unsigned ComputeNumSignBits(Value *Op, unsigned Depth = 0,
436 Instruction *CxtI = nullptr) const {
Chandler Carruth66b31302015-01-04 12:03:27 +0000437 return llvm::ComputeNumSignBits(Op, DL, Depth, AC, CxtI, DT);
Chris Lattner35522b72010-01-04 07:12:23 +0000438 }
David Majnemer54c2ca22014-12-26 09:10:14 +0000439 void ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
440 unsigned Depth = 0, Instruction *CxtI = nullptr) const {
Chandler Carruth66b31302015-01-04 12:03:27 +0000441 return llvm::ComputeSignBit(V, KnownZero, KnownOne, DL, Depth, AC, CxtI,
David Majnemer54c2ca22014-12-26 09:10:14 +0000442 DT);
443 }
David Majnemer491331a2015-01-02 07:29:43 +0000444 OverflowResult computeOverflowForUnsignedMul(Value *LHS, Value *RHS,
445 const Instruction *CxtI) {
Chandler Carruth66b31302015-01-04 12:03:27 +0000446 return llvm::computeOverflowForUnsignedMul(LHS, RHS, DL, AC, CxtI, DT);
David Majnemer491331a2015-01-02 07:29:43 +0000447 }
David Majnemer5310c1e2015-01-07 00:39:50 +0000448 OverflowResult computeOverflowForUnsignedAdd(Value *LHS, Value *RHS,
449 const Instruction *CxtI) {
450 return llvm::computeOverflowForUnsignedAdd(LHS, RHS, DL, AC, CxtI, DT);
451 }
Chris Lattner35522b72010-01-04 07:12:23 +0000452
453private:
Chandler Carruth3a622162015-01-20 19:27:58 +0000454 /// \brief Performs a few simplifications for operators which are associative
455 /// or commutative.
Duncan Sands641baf12010-11-13 15:10:37 +0000456 bool SimplifyAssociativeOrCommutative(BinaryOperator &I);
Chris Lattner35522b72010-01-04 07:12:23 +0000457
Chandler Carruthb3d03df2015-01-20 21:10:35 +0000458 /// \brief Tries to simplify binary operations which some other binary
459 /// operation distributes over.
Chandler Carruth3a622162015-01-20 19:27:58 +0000460 ///
461 /// It does this by either by factorizing out common terms (eg "(A*B)+(A*C)"
462 /// -> "A*(B+C)") or expanding out if this results in simplifications (eg: "A
463 /// & (B | C) -> (A&B) | (A&C)" if this is a win). Returns the simplified
464 /// value, or null if it didn't simplify.
Duncan Sandsfbb9ac32010-12-22 13:36:08 +0000465 Value *SimplifyUsingDistributiveLaws(BinaryOperator &I);
Duncan Sandsadc7771f2010-11-23 14:23:47 +0000466
Chandler Carruth3a622162015-01-20 19:27:58 +0000467 /// \brief Attempts to replace V with a simpler value based on the demanded
468 /// bits.
Chandler Carruthd70cc602014-05-07 17:36:59 +0000469 Value *SimplifyDemandedUseBits(Value *V, APInt DemandedMask, APInt &KnownZero,
Hal Finkel60db0582014-09-07 18:57:58 +0000470 APInt &KnownOne, unsigned Depth,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000471 Instruction *CxtI);
Chandler Carruthd70cc602014-05-07 17:36:59 +0000472 bool SimplifyDemandedBits(Use &U, APInt DemandedMask, APInt &KnownZero,
473 APInt &KnownOne, unsigned Depth = 0);
Shuxin Yang63e999e2012-12-04 00:04:54 +0000474 /// Helper routine of SimplifyDemandedUseBits. It tries to simplify demanded
475 /// bit for "r1 = shr x, c1; r2 = shl r1, c2" instruction sequence.
476 Value *SimplifyShrShlDemandedBits(Instruction *Lsr, Instruction *Sftl,
477 APInt DemandedMask, APInt &KnownZero,
478 APInt &KnownOne);
Jakub Staszak190db2f2013-01-14 23:16:36 +0000479
Chandler Carruth3a622162015-01-20 19:27:58 +0000480 /// \brief Tries to simplify operands to an integer instruction based on its
481 /// demanded bits.
Chris Lattner35522b72010-01-04 07:12:23 +0000482 bool SimplifyDemandedInstructionBits(Instruction &Inst);
Jakub Staszak190db2f2013-01-14 23:16:36 +0000483
Chris Lattner35522b72010-01-04 07:12:23 +0000484 Value *SimplifyDemandedVectorElts(Value *V, APInt DemandedElts,
Chandler Carruthd70cc602014-05-07 17:36:59 +0000485 APInt &UndefElts, unsigned Depth = 0);
Jakub Staszak190db2f2013-01-14 23:16:36 +0000486
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000487 Value *SimplifyVectorOp(BinaryOperator &Inst);
Simon Pilgrimbe24ab32014-12-04 09:44:01 +0000488 Value *SimplifyBSwap(BinaryOperator &Inst);
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000489
Chris Lattner35522b72010-01-04 07:12:23 +0000490 // FoldOpIntoPhi - Given a binary operator, cast instruction, or select
491 // which has a PHI node as operand #0, see if we can fold the instruction
492 // into the PHI (which is only possible if all operands to the PHI are
493 // constants).
494 //
Chris Lattnerea7131a2011-01-16 05:14:26 +0000495 Instruction *FoldOpIntoPhi(Instruction &I);
Chris Lattner35522b72010-01-04 07:12:23 +0000496
Chandler Carruth3a622162015-01-20 19:27:58 +0000497 /// \brief Try to rotate an operation below a PHI node, using PHI nodes for
498 /// its operands.
Chris Lattner35522b72010-01-04 07:12:23 +0000499 Instruction *FoldPHIArgOpIntoPHI(PHINode &PN);
500 Instruction *FoldPHIArgBinOpIntoPHI(PHINode &PN);
501 Instruction *FoldPHIArgGEPIntoPHI(PHINode &PN);
502 Instruction *FoldPHIArgLoadIntoPHI(PHINode &PN);
503
Chris Lattner35522b72010-01-04 07:12:23 +0000504 Instruction *OptAndOp(Instruction *Op, ConstantInt *OpRHS,
505 ConstantInt *AndRHS, BinaryOperator &TheAnd);
Jakub Staszak190db2f2013-01-14 23:16:36 +0000506
Chris Lattner35522b72010-01-04 07:12:23 +0000507 Value *FoldLogicalPlusAnd(Value *LHS, Value *RHS, ConstantInt *Mask,
508 bool isSub, Instruction &I);
Chandler Carruthd70cc602014-05-07 17:36:59 +0000509 Value *InsertRangeTest(Value *V, Constant *Lo, Constant *Hi, bool isSigned,
510 bool Inside);
Chris Lattner35522b72010-01-04 07:12:23 +0000511 Instruction *PromoteCastOfAllocation(BitCastInst &CI, AllocaInst &AI);
512 Instruction *MatchBSwap(BinaryOperator &I);
513 bool SimplifyStoreAtEndOfBlock(StoreInst &SI);
514 Instruction *SimplifyMemTransfer(MemIntrinsic *MI);
515 Instruction *SimplifyMemSet(MemSetInst *MI);
516
Chris Lattner229907c2011-07-18 04:54:35 +0000517 Value *EvaluateInDifferentType(Value *V, Type *Ty, bool isSigned);
Duncan Sands533c8ae2012-10-23 08:28:26 +0000518
Chandler Carruth3a622162015-01-20 19:27:58 +0000519 /// \brief Returns a value X such that Val = X * Scale, or null if none.
520 ///
521 /// If the multiplication is known not to overflow then NoSignedWrap is set.
Duncan Sands533c8ae2012-10-23 08:28:26 +0000522 Value *Descale(Value *Val, APInt Scale, bool &NoSignedWrap);
Chris Lattner35522b72010-01-04 07:12:23 +0000523};
524
Chris Lattner35522b72010-01-04 07:12:23 +0000525} // end namespace llvm.
526
Chandler Carruth964daaa2014-04-22 02:55:47 +0000527#undef DEBUG_TYPE
528
Chris Lattner35522b72010-01-04 07:12:23 +0000529#endif