blob: 67570e60bb5a8602dff7c34fe2e59e938d103b3f [file] [log] [blame]
Misha Brukman82c89b92003-05-20 21:01:22 +00001//===- SCCP.cpp - Sparse Conditional Constant Propagation -----------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner138a1242001-06-27 23:38:11 +00009//
Misha Brukman82c89b92003-05-20 21:01:22 +000010// This file implements sparse conditional constant propagation and merging:
Chris Lattner138a1242001-06-27 23:38:11 +000011//
12// Specifically, this:
13// * Assumes values are constant unless proven otherwise
14// * Assumes BasicBlocks are dead unless proven otherwise
15// * Proves values to be constant, and replaces them with constants
Chris Lattner2a88bb72002-08-30 23:39:00 +000016// * Proves conditional branches to be unconditional
Chris Lattner138a1242001-06-27 23:38:11 +000017//
Chris Lattner138a1242001-06-27 23:38:11 +000018//===----------------------------------------------------------------------===//
19
Chris Lattneref36dfd2004-11-15 05:03:30 +000020#define DEBUG_TYPE "sccp"
Chris Lattner022103b2002-05-07 20:03:00 +000021#include "llvm/Transforms/Scalar.h"
Chris Lattner59acc7d2004-12-10 08:02:06 +000022#include "llvm/Transforms/IPO.h"
Chris Lattnerb7a5d3e2004-01-12 17:43:40 +000023#include "llvm/Constants.h"
Chris Lattnerdd336d12004-12-11 05:15:59 +000024#include "llvm/DerivedTypes.h"
Chris Lattner9de28282003-04-25 02:50:03 +000025#include "llvm/Instructions.h"
Chris Lattnerbd0ef772002-02-26 21:46:54 +000026#include "llvm/Pass.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000027#include "llvm/Analysis/ConstantFolding.h"
Dan Gohmanc4b65ea2008-06-20 01:15:44 +000028#include "llvm/Analysis/ValueTracking.h"
Chris Lattner58b7b082004-04-13 19:43:54 +000029#include "llvm/Transforms/Utils/Local.h"
Chris Lattner5638dc62009-11-02 06:06:14 +000030#include "llvm/Target/TargetData.h"
Chris Lattner59acc7d2004-12-10 08:02:06 +000031#include "llvm/Support/CallSite.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000032#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000033#include "llvm/Support/ErrorHandling.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000034#include "llvm/Support/InstVisitor.h"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +000035#include "llvm/Support/raw_ostream.h"
Chris Lattnerb59673e2007-02-02 20:38:30 +000036#include "llvm/ADT/DenseMap.h"
Chris Lattnercf712de2008-08-23 23:36:38 +000037#include "llvm/ADT/DenseSet.h"
Chris Lattner79272202009-11-02 02:20:32 +000038#include "llvm/ADT/PointerIntPair.h"
Chris Lattner09275292009-11-02 06:11:23 +000039#include "llvm/ADT/SmallPtrSet.h"
Chris Lattnercd2492e2007-01-30 23:15:19 +000040#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000041#include "llvm/ADT/Statistic.h"
42#include "llvm/ADT/STLExtras.h"
Chris Lattner138a1242001-06-27 23:38:11 +000043#include <algorithm>
Dan Gohmanc9235d22008-03-21 23:51:57 +000044#include <map>
Chris Lattnerd7456022004-01-09 06:02:20 +000045using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000046
Chris Lattner0e5f4992006-12-19 21:40:18 +000047STATISTIC(NumInstRemoved, "Number of instructions removed");
48STATISTIC(NumDeadBlocks , "Number of basic blocks unreachable");
49
Nick Lewycky6c36a0f2008-03-08 07:48:41 +000050STATISTIC(IPNumInstRemoved, "Number of instructions removed by IPSCCP");
Chris Lattner0e5f4992006-12-19 21:40:18 +000051STATISTIC(IPNumArgsElimed ,"Number of arguments constant propagated by IPSCCP");
52STATISTIC(IPNumGlobalConst, "Number of globals found to be constant by IPSCCP");
53
Chris Lattner0dbfc052002-04-29 21:26:08 +000054namespace {
Chris Lattner3bad2532006-12-20 06:21:33 +000055/// LatticeVal class - This class represents the different lattice values that
56/// an LLVM value may occupy. It is a simple class with value semantics.
57///
Chris Lattner3e8b6632009-09-02 06:11:42 +000058class LatticeVal {
Chris Lattner79272202009-11-02 02:20:32 +000059 enum LatticeValueTy {
Chris Lattner3bad2532006-12-20 06:21:33 +000060 /// undefined - This LLVM Value has no known value yet.
61 undefined,
62
63 /// constant - This LLVM Value has a specific constant value.
64 constant,
65
66 /// forcedconstant - This LLVM Value was thought to be undef until
67 /// ResolvedUndefsIn. This is treated just like 'constant', but if merged
68 /// with another (different) constant, it goes to overdefined, instead of
69 /// asserting.
70 forcedconstant,
71
72 /// overdefined - This instruction is not known to be constant, and we know
73 /// it has a value.
74 overdefined
Chris Lattner79272202009-11-02 02:20:32 +000075 };
76
77 /// Val: This stores the current lattice value along with the Constant* for
78 /// the constant if this is a 'constant' or 'forcedconstant' value.
79 PointerIntPair<Constant *, 2, LatticeValueTy> Val;
Chris Lattner3bad2532006-12-20 06:21:33 +000080
Chris Lattner79272202009-11-02 02:20:32 +000081 LatticeValueTy getLatticeValue() const {
82 return Val.getInt();
83 }
84
Chris Lattner138a1242001-06-27 23:38:11 +000085public:
Chris Lattner38871e42009-11-02 03:03:42 +000086 LatticeVal() : Val(0, undefined) {}
Chris Lattner3bad2532006-12-20 06:21:33 +000087
Chris Lattner38871e42009-11-02 03:03:42 +000088 bool isUndefined() const { return getLatticeValue() == undefined; }
89 bool isConstant() const {
Chris Lattner79272202009-11-02 02:20:32 +000090 return getLatticeValue() == constant || getLatticeValue() == forcedconstant;
91 }
Chris Lattner38871e42009-11-02 03:03:42 +000092 bool isOverdefined() const { return getLatticeValue() == overdefined; }
Chris Lattner79272202009-11-02 02:20:32 +000093
Chris Lattner38871e42009-11-02 03:03:42 +000094 Constant *getConstant() const {
Chris Lattner79272202009-11-02 02:20:32 +000095 assert(isConstant() && "Cannot get the constant of a non-constant!");
96 return Val.getPointer();
97 }
98
99 /// markOverdefined - Return true if this is a change in status.
Chris Lattner38871e42009-11-02 03:03:42 +0000100 bool markOverdefined() {
Chris Lattner79272202009-11-02 02:20:32 +0000101 if (isOverdefined())
102 return false;
103
104 Val.setInt(overdefined);
105 return true;
Chris Lattner138a1242001-06-27 23:38:11 +0000106 }
107
Chris Lattner79272202009-11-02 02:20:32 +0000108 /// markConstant - Return true if this is a change in status.
Chris Lattner38871e42009-11-02 03:03:42 +0000109 bool markConstant(Constant *V) {
Chris Lattnerc175e5d2009-11-03 16:50:11 +0000110 if (getLatticeValue() == constant) { // Constant but not forcedconstant.
Chris Lattner79272202009-11-02 02:20:32 +0000111 assert(getConstant() == V && "Marking constant with different value");
112 return false;
Chris Lattner138a1242001-06-27 23:38:11 +0000113 }
Chris Lattner79272202009-11-02 02:20:32 +0000114
115 if (isUndefined()) {
116 Val.setInt(constant);
117 assert(V && "Marking constant with NULL");
118 Val.setPointer(V);
119 } else {
120 assert(getLatticeValue() == forcedconstant &&
121 "Cannot move from overdefined to constant!");
122 // Stay at forcedconstant if the constant is the same.
123 if (V == getConstant()) return false;
124
125 // Otherwise, we go to overdefined. Assumptions made based on the
126 // forced value are possibly wrong. Assuming this is another constant
127 // could expose a contradiction.
128 Val.setInt(overdefined);
129 }
130 return true;
Chris Lattner138a1242001-06-27 23:38:11 +0000131 }
132
Chris Lattner36c99522009-11-02 03:21:36 +0000133 /// getConstantInt - If this is a constant with a ConstantInt value, return it
134 /// otherwise return null.
135 ConstantInt *getConstantInt() const {
136 if (isConstant())
137 return dyn_cast<ConstantInt>(getConstant());
138 return 0;
139 }
140
Chris Lattner38871e42009-11-02 03:03:42 +0000141 void markForcedConstant(Constant *V) {
Chris Lattner79272202009-11-02 02:20:32 +0000142 assert(isUndefined() && "Can't force a defined value!");
143 Val.setInt(forcedconstant);
144 Val.setPointer(V);
Chris Lattner1daee8b2004-01-12 03:57:30 +0000145 }
Chris Lattner138a1242001-06-27 23:38:11 +0000146};
Chris Lattnercc4f60b2009-11-02 02:47:51 +0000147} // end anonymous namespace.
148
149
150namespace {
Chris Lattner138a1242001-06-27 23:38:11 +0000151
Chris Lattner138a1242001-06-27 23:38:11 +0000152//===----------------------------------------------------------------------===//
Chris Lattner138a1242001-06-27 23:38:11 +0000153//
Chris Lattner82bec2c2004-11-15 04:44:20 +0000154/// SCCPSolver - This class is a general purpose solver for Sparse Conditional
155/// Constant Propagation.
156///
157class SCCPSolver : public InstVisitor<SCCPSolver> {
Chris Lattner5638dc62009-11-02 06:06:14 +0000158 const TargetData *TD;
Nick Lewyckyfd47a592011-07-25 21:16:04 +0000159 SmallPtrSet<BasicBlock*, 8> BBExecutable; // The BBs that are executable.
Chris Lattner2a0433b2009-11-02 05:55:40 +0000160 DenseMap<Value*, LatticeVal> ValueState; // The state each value is in.
Chris Lattner138a1242001-06-27 23:38:11 +0000161
Chris Lattnerfc36a562009-11-03 23:40:48 +0000162 /// StructValueState - This maintains ValueState for values that have
163 /// StructType, for example for formal arguments, calls, insertelement, etc.
164 ///
165 DenseMap<std::pair<Value*, unsigned>, LatticeVal> StructValueState;
166
Chris Lattnerdd336d12004-12-11 05:15:59 +0000167 /// GlobalValue - If we are tracking any values for the contents of a global
168 /// variable, we keep a mapping from the constant accessor to the element of
169 /// the global, to the currently known value. If the value becomes
170 /// overdefined, it's entry is simply removed from this map.
Chris Lattnerb59673e2007-02-02 20:38:30 +0000171 DenseMap<GlobalVariable*, LatticeVal> TrackedGlobals;
Chris Lattnerdd336d12004-12-11 05:15:59 +0000172
Devang Patel7c490d42008-03-11 05:46:42 +0000173 /// TrackedRetVals - If we are tracking arguments into and the return
Chris Lattner59acc7d2004-12-10 08:02:06 +0000174 /// value out of a function, it will have an entry in this map, indicating
175 /// what the known return value for the function is.
Devang Patel7c490d42008-03-11 05:46:42 +0000176 DenseMap<Function*, LatticeVal> TrackedRetVals;
177
178 /// TrackedMultipleRetVals - Same as TrackedRetVals, but used for functions
179 /// that return multiple values.
Chris Lattnercf712de2008-08-23 23:36:38 +0000180 DenseMap<std::pair<Function*, unsigned>, LatticeVal> TrackedMultipleRetVals;
Chris Lattnerfc36a562009-11-03 23:40:48 +0000181
182 /// MRVFunctionsTracked - Each function in TrackedMultipleRetVals is
183 /// represented here for efficient lookup.
184 SmallPtrSet<Function*, 16> MRVFunctionsTracked;
Chris Lattner59acc7d2004-12-10 08:02:06 +0000185
Chris Lattnerabf67ef2009-11-03 20:52:57 +0000186 /// TrackingIncomingArguments - This is the set of functions for whose
187 /// arguments we make optimistic assumptions about and try to prove as
188 /// constants.
Chris Lattner2396cc32009-11-03 19:24:51 +0000189 SmallPtrSet<Function*, 16> TrackingIncomingArguments;
190
Chris Lattner38871e42009-11-02 03:03:42 +0000191 /// The reason for two worklists is that overdefined is the lowest state
192 /// on the lattice, and moving things to overdefined as fast as possible
193 /// makes SCCP converge much faster.
194 ///
195 /// By having a separate worklist, we accomplish this because everything
196 /// possibly overdefined will become overdefined at the soonest possible
197 /// point.
Chris Lattnercf712de2008-08-23 23:36:38 +0000198 SmallVector<Value*, 64> OverdefinedInstWorkList;
199 SmallVector<Value*, 64> InstWorkList;
Chris Lattner80b2d6c2004-07-15 23:36:43 +0000200
201
Chris Lattnercf712de2008-08-23 23:36:38 +0000202 SmallVector<BasicBlock*, 64> BBWorkList; // The BasicBlock work list
Chris Lattner16b18fd2003-10-08 16:55:34 +0000203
Chris Lattner1daee8b2004-01-12 03:57:30 +0000204 /// UsersOfOverdefinedPHIs - Keep track of any users of PHI nodes that are not
205 /// overdefined, despite the fact that the PHI node is overdefined.
206 std::multimap<PHINode*, Instruction*> UsersOfOverdefinedPHIs;
207
Chris Lattner16b18fd2003-10-08 16:55:34 +0000208 /// KnownFeasibleEdges - Entries in this set are edges which have already had
209 /// PHI nodes retriggered.
Chris Lattnercf712de2008-08-23 23:36:38 +0000210 typedef std::pair<BasicBlock*, BasicBlock*> Edge;
211 DenseSet<Edge> KnownFeasibleEdges;
Chris Lattner138a1242001-06-27 23:38:11 +0000212public:
Chris Lattner5638dc62009-11-02 06:06:14 +0000213 SCCPSolver(const TargetData *td) : TD(td) {}
Chris Lattner138a1242001-06-27 23:38:11 +0000214
Chris Lattner82bec2c2004-11-15 04:44:20 +0000215 /// MarkBlockExecutable - This method can be used by clients to mark all of
216 /// the blocks that are known to be intrinsically live in the processed unit.
Chris Lattner09275292009-11-02 06:11:23 +0000217 ///
218 /// This returns true if the block was not considered live before.
219 bool MarkBlockExecutable(BasicBlock *BB) {
220 if (!BBExecutable.insert(BB)) return false;
David Greene971cc7e2010-01-05 01:27:15 +0000221 DEBUG(dbgs() << "Marking Block Executable: " << BB->getName() << "\n");
Chris Lattner82bec2c2004-11-15 04:44:20 +0000222 BBWorkList.push_back(BB); // Add the block to the work list!
Chris Lattner09275292009-11-02 06:11:23 +0000223 return true;
Chris Lattner0dbfc052002-04-29 21:26:08 +0000224 }
225
Chris Lattnerdd336d12004-12-11 05:15:59 +0000226 /// TrackValueOfGlobalVariable - Clients can use this method to
Chris Lattner59acc7d2004-12-10 08:02:06 +0000227 /// inform the SCCPSolver that it should track loads and stores to the
228 /// specified global variable if it can. This is only legal to call if
229 /// performing Interprocedural SCCP.
Chris Lattnerdd336d12004-12-11 05:15:59 +0000230 void TrackValueOfGlobalVariable(GlobalVariable *GV) {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000231 // We only track the contents of scalar globals.
232 if (GV->getType()->getElementType()->isSingleValueType()) {
Chris Lattnerdd336d12004-12-11 05:15:59 +0000233 LatticeVal &IV = TrackedGlobals[GV];
234 if (!isa<UndefValue>(GV->getInitializer()))
235 IV.markConstant(GV->getInitializer());
236 }
237 }
Chris Lattner59acc7d2004-12-10 08:02:06 +0000238
239 /// AddTrackedFunction - If the SCCP solver is supposed to track calls into
240 /// and out of the specified function (which cannot have its address taken),
241 /// this method must be called.
242 void AddTrackedFunction(Function *F) {
Chris Lattner59acc7d2004-12-10 08:02:06 +0000243 // Add an entry, F -> undef.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000244 if (StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000245 MRVFunctionsTracked.insert(F);
Devang Patel7c490d42008-03-11 05:46:42 +0000246 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Chris Lattnerc6ee00b2008-04-23 05:38:20 +0000247 TrackedMultipleRetVals.insert(std::make_pair(std::make_pair(F, i),
248 LatticeVal()));
249 } else
250 TrackedRetVals.insert(std::make_pair(F, LatticeVal()));
Chris Lattner59acc7d2004-12-10 08:02:06 +0000251 }
252
Chris Lattner2396cc32009-11-03 19:24:51 +0000253 void AddArgumentTrackedFunction(Function *F) {
254 TrackingIncomingArguments.insert(F);
255 }
256
Chris Lattner82bec2c2004-11-15 04:44:20 +0000257 /// Solve - Solve for constants and executable blocks.
258 ///
259 void Solve();
Chris Lattner138a1242001-06-27 23:38:11 +0000260
Chris Lattner3bad2532006-12-20 06:21:33 +0000261 /// ResolvedUndefsIn - While solving the dataflow for a function, we assume
Chris Lattnerfc6ac502004-12-10 20:41:50 +0000262 /// that branches on undef values cannot reach any of their successors.
263 /// However, this is not a safe assumption. After we solve dataflow, this
264 /// method should be use to handle this. If this returns true, the solver
265 /// should be rerun.
Chris Lattner3bad2532006-12-20 06:21:33 +0000266 bool ResolvedUndefsIn(Function &F);
Chris Lattnerfc6ac502004-12-10 20:41:50 +0000267
Chris Lattner7eb01bf2008-08-23 23:39:31 +0000268 bool isBlockExecutable(BasicBlock *BB) const {
269 return BBExecutable.count(BB);
Chris Lattner82bec2c2004-11-15 04:44:20 +0000270 }
271
Chris Lattner8db50122009-11-02 02:54:24 +0000272 LatticeVal getLatticeValueFor(Value *V) const {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000273 DenseMap<Value*, LatticeVal>::const_iterator I = ValueState.find(V);
Chris Lattner8db50122009-11-02 02:54:24 +0000274 assert(I != ValueState.end() && "V is not in valuemap!");
275 return I->second;
Chris Lattner82bec2c2004-11-15 04:44:20 +0000276 }
Chris Lattnerfc36a562009-11-03 23:40:48 +0000277
Chris Lattner473fc962010-08-18 02:41:56 +0000278 /*LatticeVal getStructLatticeValueFor(Value *V, unsigned i) const {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000279 DenseMap<std::pair<Value*, unsigned>, LatticeVal>::const_iterator I =
280 StructValueState.find(std::make_pair(V, i));
281 assert(I != StructValueState.end() && "V is not in valuemap!");
282 return I->second;
Chris Lattner473fc962010-08-18 02:41:56 +0000283 }*/
Chris Lattner82bec2c2004-11-15 04:44:20 +0000284
Devang Patel7c490d42008-03-11 05:46:42 +0000285 /// getTrackedRetVals - Get the inferred return value map.
Chris Lattner0417feb2004-12-11 02:53:57 +0000286 ///
Devang Patel7c490d42008-03-11 05:46:42 +0000287 const DenseMap<Function*, LatticeVal> &getTrackedRetVals() {
288 return TrackedRetVals;
Chris Lattner0417feb2004-12-11 02:53:57 +0000289 }
290
Chris Lattnerdd336d12004-12-11 05:15:59 +0000291 /// getTrackedGlobals - Get and return the set of inferred initializers for
292 /// global variables.
Chris Lattnerb59673e2007-02-02 20:38:30 +0000293 const DenseMap<GlobalVariable*, LatticeVal> &getTrackedGlobals() {
Chris Lattnerdd336d12004-12-11 05:15:59 +0000294 return TrackedGlobals;
295 }
296
Chris Lattner36c99522009-11-02 03:21:36 +0000297 void markOverdefined(Value *V) {
Duncan Sands1df98592010-02-16 11:11:14 +0000298 assert(!V->getType()->isStructTy() && "Should use other method");
Chris Lattner57939df2007-03-04 04:50:21 +0000299 markOverdefined(ValueState[V], V);
300 }
Chris Lattner0417feb2004-12-11 02:53:57 +0000301
Chris Lattnerfc36a562009-11-03 23:40:48 +0000302 /// markAnythingOverdefined - Mark the specified value overdefined. This
303 /// works with both scalars and structs.
304 void markAnythingOverdefined(Value *V) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000305 if (StructType *STy = dyn_cast<StructType>(V->getType()))
Chris Lattnerfc36a562009-11-03 23:40:48 +0000306 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
307 markOverdefined(getStructValueState(V, i), V);
308 else
309 markOverdefined(V);
310 }
311
Chris Lattner138a1242001-06-27 23:38:11 +0000312private:
Chris Lattner80b2d6c2004-07-15 23:36:43 +0000313 // markConstant - Make a value be marked as "constant". If the value
Misha Brukmanfd939082005-04-21 23:48:37 +0000314 // is not already a constant, add it to the instruction work list so that
Chris Lattner138a1242001-06-27 23:38:11 +0000315 // the users of the instruction are updated later.
316 //
Chris Lattner38871e42009-11-02 03:03:42 +0000317 void markConstant(LatticeVal &IV, Value *V, Constant *C) {
318 if (!IV.markConstant(C)) return;
David Greene971cc7e2010-01-05 01:27:15 +0000319 DEBUG(dbgs() << "markConstant: " << *C << ": " << *V << '\n');
Chris Lattner8829cec2010-04-09 01:14:31 +0000320 if (IV.isOverdefined())
321 OverdefinedInstWorkList.push_back(V);
322 else
323 InstWorkList.push_back(V);
Chris Lattner3d405b02003-10-08 16:21:03 +0000324 }
Chris Lattner3bad2532006-12-20 06:21:33 +0000325
Chris Lattner38871e42009-11-02 03:03:42 +0000326 void markConstant(Value *V, Constant *C) {
Duncan Sands1df98592010-02-16 11:11:14 +0000327 assert(!V->getType()->isStructTy() && "Should use other method");
Chris Lattner59acc7d2004-12-10 08:02:06 +0000328 markConstant(ValueState[V], V, C);
Chris Lattner138a1242001-06-27 23:38:11 +0000329 }
330
Chris Lattner2a0433b2009-11-02 05:55:40 +0000331 void markForcedConstant(Value *V, Constant *C) {
Duncan Sands1df98592010-02-16 11:11:14 +0000332 assert(!V->getType()->isStructTy() && "Should use other method");
Chris Lattner8829cec2010-04-09 01:14:31 +0000333 LatticeVal &IV = ValueState[V];
334 IV.markForcedConstant(C);
David Greene971cc7e2010-01-05 01:27:15 +0000335 DEBUG(dbgs() << "markForcedConstant: " << *C << ": " << *V << '\n');
Chris Lattner8829cec2010-04-09 01:14:31 +0000336 if (IV.isOverdefined())
337 OverdefinedInstWorkList.push_back(V);
338 else
339 InstWorkList.push_back(V);
Chris Lattner2a0433b2009-11-02 05:55:40 +0000340 }
341
342
Chris Lattner80b2d6c2004-07-15 23:36:43 +0000343 // markOverdefined - Make a value be marked as "overdefined". If the
Misha Brukmanfd939082005-04-21 23:48:37 +0000344 // value is not already overdefined, add it to the overdefined instruction
Chris Lattner80b2d6c2004-07-15 23:36:43 +0000345 // work list so that the users of the instruction are updated later.
Chris Lattner38871e42009-11-02 03:03:42 +0000346 void markOverdefined(LatticeVal &IV, Value *V) {
347 if (!IV.markOverdefined()) return;
348
David Greene971cc7e2010-01-05 01:27:15 +0000349 DEBUG(dbgs() << "markOverdefined: ";
Chris Lattner38871e42009-11-02 03:03:42 +0000350 if (Function *F = dyn_cast<Function>(V))
David Greene971cc7e2010-01-05 01:27:15 +0000351 dbgs() << "Function '" << F->getName() << "'\n";
Chris Lattner38871e42009-11-02 03:03:42 +0000352 else
David Greene971cc7e2010-01-05 01:27:15 +0000353 dbgs() << *V << '\n');
Chris Lattner38871e42009-11-02 03:03:42 +0000354 // Only instructions go on the work list
355 OverdefinedInstWorkList.push_back(V);
Chris Lattner3d405b02003-10-08 16:21:03 +0000356 }
Chris Lattner59acc7d2004-12-10 08:02:06 +0000357
Chris Lattner2a0433b2009-11-02 05:55:40 +0000358 void mergeInValue(LatticeVal &IV, Value *V, LatticeVal MergeWithV) {
Chris Lattner59acc7d2004-12-10 08:02:06 +0000359 if (IV.isOverdefined() || MergeWithV.isUndefined())
360 return; // Noop.
361 if (MergeWithV.isOverdefined())
362 markOverdefined(IV, V);
363 else if (IV.isUndefined())
364 markConstant(IV, V, MergeWithV.getConstant());
365 else if (IV.getConstant() != MergeWithV.getConstant())
366 markOverdefined(IV, V);
Chris Lattner138a1242001-06-27 23:38:11 +0000367 }
Chris Lattnerfe243eb2006-02-08 02:38:11 +0000368
Chris Lattner2a0433b2009-11-02 05:55:40 +0000369 void mergeInValue(Value *V, LatticeVal MergeWithV) {
Duncan Sands1df98592010-02-16 11:11:14 +0000370 assert(!V->getType()->isStructTy() && "Should use other method");
Chris Lattner36c99522009-11-02 03:21:36 +0000371 mergeInValue(ValueState[V], V, MergeWithV);
Chris Lattnerfe243eb2006-02-08 02:38:11 +0000372 }
373
Chris Lattner138a1242001-06-27 23:38:11 +0000374
Chris Lattner2a0433b2009-11-02 05:55:40 +0000375 /// getValueState - Return the LatticeVal object that corresponds to the
376 /// value. This function handles the case when the value hasn't been seen yet
377 /// by properly seeding constants etc.
Chris Lattner38871e42009-11-02 03:03:42 +0000378 LatticeVal &getValueState(Value *V) {
Duncan Sands1df98592010-02-16 11:11:14 +0000379 assert(!V->getType()->isStructTy() && "Should use getStructValueState");
Chris Lattner5d356a72004-10-16 18:09:41 +0000380
Benjamin Kramerbcaa2152009-11-05 14:33:27 +0000381 std::pair<DenseMap<Value*, LatticeVal>::iterator, bool> I =
382 ValueState.insert(std::make_pair(V, LatticeVal()));
383 LatticeVal &LV = I.first->second;
384
385 if (!I.second)
386 return LV; // Common case, already in the map.
Chris Lattner36c99522009-11-02 03:21:36 +0000387
Chris Lattner3bad2532006-12-20 06:21:33 +0000388 if (Constant *C = dyn_cast<Constant>(V)) {
Chris Lattner36c99522009-11-02 03:21:36 +0000389 // Undef values remain undefined.
390 if (!isa<UndefValue>(V))
Chris Lattnerb59673e2007-02-02 20:38:30 +0000391 LV.markConstant(C); // Constants are constant
Chris Lattner2a88bb72002-08-30 23:39:00 +0000392 }
Chris Lattner36c99522009-11-02 03:21:36 +0000393
Chris Lattner2f096252009-11-02 02:33:50 +0000394 // All others are underdefined by default.
Chris Lattner36c99522009-11-02 03:21:36 +0000395 return LV;
Chris Lattner138a1242001-06-27 23:38:11 +0000396 }
397
Chris Lattnerfc36a562009-11-03 23:40:48 +0000398 /// getStructValueState - Return the LatticeVal object that corresponds to the
399 /// value/field pair. This function handles the case when the value hasn't
400 /// been seen yet by properly seeding constants etc.
401 LatticeVal &getStructValueState(Value *V, unsigned i) {
Duncan Sands1df98592010-02-16 11:11:14 +0000402 assert(V->getType()->isStructTy() && "Should use getValueState");
Chris Lattnerfc36a562009-11-03 23:40:48 +0000403 assert(i < cast<StructType>(V->getType())->getNumElements() &&
404 "Invalid element #");
Benjamin Kramerbcaa2152009-11-05 14:33:27 +0000405
406 std::pair<DenseMap<std::pair<Value*, unsigned>, LatticeVal>::iterator,
407 bool> I = StructValueState.insert(
408 std::make_pair(std::make_pair(V, i), LatticeVal()));
409 LatticeVal &LV = I.first->second;
410
411 if (!I.second)
412 return LV; // Common case, already in the map.
413
Chris Lattnerfc36a562009-11-03 23:40:48 +0000414 if (Constant *C = dyn_cast<Constant>(V)) {
415 if (isa<UndefValue>(C))
416 ; // Undef values remain undefined.
417 else if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C))
418 LV.markConstant(CS->getOperand(i)); // Constants are constant.
419 else if (isa<ConstantAggregateZero>(C)) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000420 Type *FieldTy = cast<StructType>(V->getType())->getElementType(i);
Chris Lattnerfc36a562009-11-03 23:40:48 +0000421 LV.markConstant(Constant::getNullValue(FieldTy));
422 } else
423 LV.markOverdefined(); // Unknown sort of constant.
424 }
425
426 // All others are underdefined by default.
427 return LV;
428 }
429
430
Chris Lattner2a0433b2009-11-02 05:55:40 +0000431 /// markEdgeExecutable - Mark a basic block as executable, adding it to the BB
432 /// work list if it is not already executable.
Chris Lattner16b18fd2003-10-08 16:55:34 +0000433 void markEdgeExecutable(BasicBlock *Source, BasicBlock *Dest) {
434 if (!KnownFeasibleEdges.insert(Edge(Source, Dest)).second)
435 return; // This edge is already known to be executable!
436
Chris Lattner09275292009-11-02 06:11:23 +0000437 if (!MarkBlockExecutable(Dest)) {
438 // If the destination is already executable, we just made an *edge*
439 // feasible that wasn't before. Revisit the PHI nodes in the block
440 // because they have potentially new operands.
David Greene971cc7e2010-01-05 01:27:15 +0000441 DEBUG(dbgs() << "Marking Edge Executable: " << Source->getName()
Daniel Dunbar93b67e42009-07-26 07:49:05 +0000442 << " -> " << Dest->getName() << "\n");
Chris Lattner16b18fd2003-10-08 16:55:34 +0000443
Chris Lattner09275292009-11-02 06:11:23 +0000444 PHINode *PN;
445 for (BasicBlock::iterator I = Dest->begin();
446 (PN = dyn_cast<PHINode>(I)); ++I)
447 visitPHINode(*PN);
Chris Lattner9de28282003-04-25 02:50:03 +0000448 }
Chris Lattner138a1242001-06-27 23:38:11 +0000449 }
450
Chris Lattner82bec2c2004-11-15 04:44:20 +0000451 // getFeasibleSuccessors - Return a vector of booleans to indicate which
452 // successors are reachable from a given terminator instruction.
453 //
Chris Lattner1c1f1122007-02-02 21:15:06 +0000454 void getFeasibleSuccessors(TerminatorInst &TI, SmallVector<bool, 16> &Succs);
Chris Lattner82bec2c2004-11-15 04:44:20 +0000455
456 // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
Chris Lattner2f096252009-11-02 02:33:50 +0000457 // block to the 'To' basic block is currently feasible.
Chris Lattner82bec2c2004-11-15 04:44:20 +0000458 //
459 bool isEdgeFeasible(BasicBlock *From, BasicBlock *To);
460
461 // OperandChangedState - This method is invoked on all of the users of an
Chris Lattner2f096252009-11-02 02:33:50 +0000462 // instruction that was just changed state somehow. Based on this
Chris Lattner82bec2c2004-11-15 04:44:20 +0000463 // information, we need to update the specified user of this instruction.
464 //
Chris Lattner14532d02009-11-03 03:42:51 +0000465 void OperandChangedState(Instruction *I) {
466 if (BBExecutable.count(I->getParent())) // Inst is executable?
467 visit(*I);
Chris Lattner82bec2c2004-11-15 04:44:20 +0000468 }
Chris Lattnere01985c2009-11-02 06:28:16 +0000469
470 /// RemoveFromOverdefinedPHIs - If I has any entries in the
471 /// UsersOfOverdefinedPHIs map for PN, remove them now.
472 void RemoveFromOverdefinedPHIs(Instruction *I, PHINode *PN) {
473 if (UsersOfOverdefinedPHIs.empty()) return;
Chris Lattnerc30a38f2011-07-21 06:21:31 +0000474 typedef std::multimap<PHINode*, Instruction*>::iterator ItTy;
475 std::pair<ItTy, ItTy> Range = UsersOfOverdefinedPHIs.equal_range(PN);
476 for (ItTy It = Range.first, E = Range.second; It != E;) {
Chris Lattnere01985c2009-11-02 06:28:16 +0000477 if (It->second == I)
478 UsersOfOverdefinedPHIs.erase(It++);
479 else
480 ++It;
481 }
482 }
Chris Lattner82bec2c2004-11-15 04:44:20 +0000483
Dale Johannesenf619b5a2010-11-30 20:23:21 +0000484 /// InsertInOverdefinedPHIs - Insert an entry in the UsersOfOverdefinedPHIS
485 /// map for I and PN, but if one is there already, do not create another.
486 /// (Duplicate entries do not break anything directly, but can lead to
487 /// exponential growth of the table in rare cases.)
488 void InsertInOverdefinedPHIs(Instruction *I, PHINode *PN) {
Chris Lattnerc30a38f2011-07-21 06:21:31 +0000489 typedef std::multimap<PHINode*, Instruction*>::iterator ItTy;
490 std::pair<ItTy, ItTy> Range = UsersOfOverdefinedPHIs.equal_range(PN);
491 for (ItTy J = Range.first, E = Range.second; J != E; ++J)
Chris Lattner54cfe7e2011-01-16 07:11:21 +0000492 if (J->second == I)
493 return;
494 UsersOfOverdefinedPHIs.insert(std::make_pair(PN, I));
Dale Johannesenf619b5a2010-11-30 20:23:21 +0000495 }
496
Chris Lattner82bec2c2004-11-15 04:44:20 +0000497private:
498 friend class InstVisitor<SCCPSolver>;
Chris Lattner138a1242001-06-27 23:38:11 +0000499
Chris Lattner2f096252009-11-02 02:33:50 +0000500 // visit implementations - Something changed in this instruction. Either an
Chris Lattnercb056de2001-06-29 23:56:23 +0000501 // operand made a transition, or the instruction is newly executable. Change
502 // the value type of I to reflect these changes if appropriate.
Chris Lattner7e708292002-06-25 16:13:24 +0000503 void visitPHINode(PHINode &I);
Chris Lattner2a632552002-04-18 15:13:15 +0000504
505 // Terminators
Chris Lattner59acc7d2004-12-10 08:02:06 +0000506 void visitReturnInst(ReturnInst &I);
Chris Lattner7e708292002-06-25 16:13:24 +0000507 void visitTerminatorInst(TerminatorInst &TI);
Chris Lattner2a632552002-04-18 15:13:15 +0000508
Chris Lattnerb8047602002-08-14 17:53:45 +0000509 void visitCastInst(CastInst &I);
Chris Lattner6e323722004-03-12 05:52:44 +0000510 void visitSelectInst(SelectInst &I);
Chris Lattner7e708292002-06-25 16:13:24 +0000511 void visitBinaryOperator(Instruction &I);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000512 void visitCmpInst(CmpInst &I);
Robert Bocchino56107e22006-01-10 19:05:05 +0000513 void visitExtractElementInst(ExtractElementInst &I);
Robert Bocchino8fcf01e2006-01-17 20:06:55 +0000514 void visitInsertElementInst(InsertElementInst &I);
Chris Lattner543abdf2006-04-08 01:19:12 +0000515 void visitShuffleVectorInst(ShuffleVectorInst &I);
Dan Gohmanc4b65ea2008-06-20 01:15:44 +0000516 void visitExtractValueInst(ExtractValueInst &EVI);
517 void visitInsertValueInst(InsertValueInst &IVI);
Chris Lattner2a632552002-04-18 15:13:15 +0000518
Chris Lattner2f096252009-11-02 02:33:50 +0000519 // Instructions that cannot be folded away.
Chris Lattner2a0433b2009-11-02 05:55:40 +0000520 void visitStoreInst (StoreInst &I);
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +0000521 void visitLoadInst (LoadInst &I);
Chris Lattner2a88bb72002-08-30 23:39:00 +0000522 void visitGetElementPtrInst(GetElementPtrInst &I);
Victor Hernandez66284e02009-10-24 04:23:03 +0000523 void visitCallInst (CallInst &I) {
Gabor Greif7d3056b2010-07-28 22:50:26 +0000524 visitCallSite(&I);
Victor Hernandez83d63912009-09-18 22:35:49 +0000525 }
Chris Lattner59acc7d2004-12-10 08:02:06 +0000526 void visitInvokeInst (InvokeInst &II) {
Gabor Greif7d3056b2010-07-28 22:50:26 +0000527 visitCallSite(&II);
Chris Lattner59acc7d2004-12-10 08:02:06 +0000528 visitTerminatorInst(II);
Chris Lattner99b28e62003-08-27 01:08:35 +0000529 }
Chris Lattner59acc7d2004-12-10 08:02:06 +0000530 void visitCallSite (CallSite CS);
Chris Lattner36143fc2003-09-08 18:54:55 +0000531 void visitUnwindInst (TerminatorInst &I) { /*returns void*/ }
Chris Lattner5d356a72004-10-16 18:09:41 +0000532 void visitUnreachableInst(TerminatorInst &I) { /*returns void*/ }
Victor Hernandez7b929da2009-10-23 21:09:37 +0000533 void visitAllocaInst (Instruction &I) { markOverdefined(&I); }
Chris Lattnerfc36a562009-11-03 23:40:48 +0000534 void visitVAArgInst (Instruction &I) { markAnythingOverdefined(&I); }
Chris Lattner2a632552002-04-18 15:13:15 +0000535
Chris Lattner7e708292002-06-25 16:13:24 +0000536 void visitInstruction(Instruction &I) {
Chris Lattner2f096252009-11-02 02:33:50 +0000537 // If a new instruction is added to LLVM that we don't handle.
David Greene971cc7e2010-01-05 01:27:15 +0000538 dbgs() << "SCCP: Don't know how to handle: " << I;
Chris Lattnerfc36a562009-11-03 23:40:48 +0000539 markAnythingOverdefined(&I); // Just in case
Chris Lattner2a632552002-04-18 15:13:15 +0000540 }
Chris Lattnercb056de2001-06-29 23:56:23 +0000541};
Chris Lattnerf6293092002-07-23 18:06:35 +0000542
Duncan Sandse2abf122007-07-20 08:56:21 +0000543} // end anonymous namespace
544
545
Chris Lattnerb9a66342002-05-02 21:44:00 +0000546// getFeasibleSuccessors - Return a vector of booleans to indicate which
547// successors are reachable from a given terminator instruction.
548//
Chris Lattner82bec2c2004-11-15 04:44:20 +0000549void SCCPSolver::getFeasibleSuccessors(TerminatorInst &TI,
Chris Lattner1c1f1122007-02-02 21:15:06 +0000550 SmallVector<bool, 16> &Succs) {
Chris Lattner9de28282003-04-25 02:50:03 +0000551 Succs.resize(TI.getNumSuccessors());
Chris Lattner7e708292002-06-25 16:13:24 +0000552 if (BranchInst *BI = dyn_cast<BranchInst>(&TI)) {
Chris Lattnerb9a66342002-05-02 21:44:00 +0000553 if (BI->isUnconditional()) {
554 Succs[0] = true;
Chris Lattnerea0db072009-11-02 02:30:06 +0000555 return;
Chris Lattnerb9a66342002-05-02 21:44:00 +0000556 }
Chris Lattnerea0db072009-11-02 02:30:06 +0000557
Chris Lattner2a0433b2009-11-02 05:55:40 +0000558 LatticeVal BCValue = getValueState(BI->getCondition());
Chris Lattner36c99522009-11-02 03:21:36 +0000559 ConstantInt *CI = BCValue.getConstantInt();
560 if (CI == 0) {
Chris Lattnerea0db072009-11-02 02:30:06 +0000561 // Overdefined condition variables, and branches on unfoldable constant
562 // conditions, mean the branch could go either way.
Chris Lattner36c99522009-11-02 03:21:36 +0000563 if (!BCValue.isUndefined())
564 Succs[0] = Succs[1] = true;
Chris Lattnerea0db072009-11-02 02:30:06 +0000565 return;
566 }
567
568 // Constant condition variables mean the branch can only go a single way.
Chris Lattner36c99522009-11-02 03:21:36 +0000569 Succs[CI->isZero()] = true;
Chris Lattner4c0236f2009-10-29 01:21:20 +0000570 return;
571 }
572
Chris Lattner36c99522009-11-02 03:21:36 +0000573 if (isa<InvokeInst>(TI)) {
Chris Lattnerb9a66342002-05-02 21:44:00 +0000574 // Invoke instructions successors are always executable.
575 Succs[0] = Succs[1] = true;
Chris Lattner4c0236f2009-10-29 01:21:20 +0000576 return;
577 }
578
579 if (SwitchInst *SI = dyn_cast<SwitchInst>(&TI)) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000580 LatticeVal SCValue = getValueState(SI->getCondition());
Chris Lattner36c99522009-11-02 03:21:36 +0000581 ConstantInt *CI = SCValue.getConstantInt();
582
583 if (CI == 0) { // Overdefined or undefined condition?
Chris Lattnerb9a66342002-05-02 21:44:00 +0000584 // All destinations are executable!
Chris Lattner36c99522009-11-02 03:21:36 +0000585 if (!SCValue.isUndefined())
586 Succs.assign(TI.getNumSuccessors(), true);
587 return;
588 }
589
590 Succs[SI->findCaseValue(CI)] = true;
Chris Lattner4c0236f2009-10-29 01:21:20 +0000591 return;
Chris Lattnerb9a66342002-05-02 21:44:00 +0000592 }
Chris Lattner4c0236f2009-10-29 01:21:20 +0000593
594 // TODO: This could be improved if the operand is a [cast of a] BlockAddress.
595 if (isa<IndirectBrInst>(&TI)) {
596 // Just mark all destinations executable!
597 Succs.assign(TI.getNumSuccessors(), true);
598 return;
599 }
600
601#ifndef NDEBUG
David Greene971cc7e2010-01-05 01:27:15 +0000602 dbgs() << "Unknown terminator instruction: " << TI << '\n';
Chris Lattner4c0236f2009-10-29 01:21:20 +0000603#endif
604 llvm_unreachable("SCCP: Don't know how to handle this terminator!");
Chris Lattnerb9a66342002-05-02 21:44:00 +0000605}
606
607
Chris Lattner59f0ce22002-05-02 21:18:01 +0000608// isEdgeFeasible - Return true if the control flow edge from the 'From' basic
Chris Lattner2f096252009-11-02 02:33:50 +0000609// block to the 'To' basic block is currently feasible.
Chris Lattner59f0ce22002-05-02 21:18:01 +0000610//
Chris Lattner82bec2c2004-11-15 04:44:20 +0000611bool SCCPSolver::isEdgeFeasible(BasicBlock *From, BasicBlock *To) {
Chris Lattner59f0ce22002-05-02 21:18:01 +0000612 assert(BBExecutable.count(To) && "Dest should always be alive!");
613
614 // Make sure the source basic block is executable!!
615 if (!BBExecutable.count(From)) return false;
Misha Brukmanfd939082005-04-21 23:48:37 +0000616
Chris Lattner2f096252009-11-02 02:33:50 +0000617 // Check to make sure this edge itself is actually feasible now.
Chris Lattner7d275f42003-10-08 15:47:41 +0000618 TerminatorInst *TI = From->getTerminator();
619 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
620 if (BI->isUnconditional())
Chris Lattnerb9a66342002-05-02 21:44:00 +0000621 return true;
Chris Lattner4c0236f2009-10-29 01:21:20 +0000622
Chris Lattner2a0433b2009-11-02 05:55:40 +0000623 LatticeVal BCValue = getValueState(BI->getCondition());
Chris Lattner84831642004-01-12 17:40:36 +0000624
Chris Lattnerea0db072009-11-02 02:30:06 +0000625 // Overdefined condition variables mean the branch could go either way,
626 // undef conditions mean that neither edge is feasible yet.
Chris Lattner36c99522009-11-02 03:21:36 +0000627 ConstantInt *CI = BCValue.getConstantInt();
628 if (CI == 0)
629 return !BCValue.isUndefined();
Chris Lattnerea0db072009-11-02 02:30:06 +0000630
Chris Lattnerea0db072009-11-02 02:30:06 +0000631 // Constant condition variables mean the branch can only go a single way.
Chris Lattner36c99522009-11-02 03:21:36 +0000632 return BI->getSuccessor(CI->isZero()) == To;
Chris Lattner4c0236f2009-10-29 01:21:20 +0000633 }
634
635 // Invoke instructions successors are always executable.
636 if (isa<InvokeInst>(TI))
Chris Lattner7d275f42003-10-08 15:47:41 +0000637 return true;
Chris Lattner4c0236f2009-10-29 01:21:20 +0000638
639 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000640 LatticeVal SCValue = getValueState(SI->getCondition());
Chris Lattner36c99522009-11-02 03:21:36 +0000641 ConstantInt *CI = SCValue.getConstantInt();
642
643 if (CI == 0)
644 return !SCValue.isUndefined();
Chris Lattner84831642004-01-12 17:40:36 +0000645
Chris Lattner36c99522009-11-02 03:21:36 +0000646 // Make sure to skip the "default value" which isn't a value
647 for (unsigned i = 1, E = SI->getNumSuccessors(); i != E; ++i)
648 if (SI->getSuccessorValue(i) == CI) // Found the taken branch.
649 return SI->getSuccessor(i) == To;
Chris Lattner7d275f42003-10-08 15:47:41 +0000650
Chris Lattner36c99522009-11-02 03:21:36 +0000651 // If the constant value is not equal to any of the branches, we must
652 // execute default branch.
653 return SI->getDefaultDest() == To;
Chris Lattner7d275f42003-10-08 15:47:41 +0000654 }
Chris Lattner4c0236f2009-10-29 01:21:20 +0000655
656 // Just mark all destinations executable!
657 // TODO: This could be improved if the operand is a [cast of a] BlockAddress.
Eli Friedman21c60902011-05-21 19:13:10 +0000658 if (isa<IndirectBrInst>(TI))
Chris Lattner4c0236f2009-10-29 01:21:20 +0000659 return true;
660
661#ifndef NDEBUG
David Greene971cc7e2010-01-05 01:27:15 +0000662 dbgs() << "Unknown terminator instruction: " << *TI << '\n';
Chris Lattner4c0236f2009-10-29 01:21:20 +0000663#endif
664 llvm_unreachable(0);
Chris Lattner59f0ce22002-05-02 21:18:01 +0000665}
Chris Lattner138a1242001-06-27 23:38:11 +0000666
Chris Lattner2f096252009-11-02 02:33:50 +0000667// visit Implementations - Something changed in this instruction, either an
Chris Lattner138a1242001-06-27 23:38:11 +0000668// operand made a transition, or the instruction is newly executable. Change
669// the value type of I to reflect these changes if appropriate. This method
670// makes sure to do the following actions:
671//
672// 1. If a phi node merges two constants in, and has conflicting value coming
673// from different branches, or if the PHI node merges in an overdefined
674// value, then the PHI node becomes overdefined.
675// 2. If a phi node merges only constants in, and they all agree on value, the
676// PHI node becomes a constant value equal to that.
677// 3. If V <- x (op) y && isConstant(x) && isConstant(y) V = Constant
678// 4. If V <- x (op) y && (isOverdefined(x) || isOverdefined(y)) V = Overdefined
679// 5. If V <- MEM or V <- CALL or V <- (unknown) then V = Overdefined
680// 6. If a conditional branch has a value that is constant, make the selected
681// destination executable
682// 7. If a conditional branch has a value that is overdefined, make all
683// successors executable.
684//
Chris Lattner82bec2c2004-11-15 04:44:20 +0000685void SCCPSolver::visitPHINode(PHINode &PN) {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000686 // If this PN returns a struct, just mark the result overdefined.
687 // TODO: We could do a lot better than this if code actually uses this.
Duncan Sands1df98592010-02-16 11:11:14 +0000688 if (PN.getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +0000689 return markAnythingOverdefined(&PN);
690
Chris Lattner2a0433b2009-11-02 05:55:40 +0000691 if (getValueState(&PN).isOverdefined()) {
Chris Lattner1daee8b2004-01-12 03:57:30 +0000692 // There may be instructions using this PHI node that are not overdefined
693 // themselves. If so, make sure that they know that the PHI node operand
694 // changed.
Chris Lattnerc30a38f2011-07-21 06:21:31 +0000695 typedef std::multimap<PHINode*, Instruction*>::iterator ItTy;
696 std::pair<ItTy, ItTy> Range = UsersOfOverdefinedPHIs.equal_range(&PN);
697
698 if (Range.first == Range.second)
Chris Lattner2a0433b2009-11-02 05:55:40 +0000699 return;
700
701 SmallVector<Instruction*, 16> Users;
Chris Lattnerc30a38f2011-07-21 06:21:31 +0000702 for (ItTy I = Range.first, E = Range.second; I != E; ++I)
Chris Lattner2a0433b2009-11-02 05:55:40 +0000703 Users.push_back(I->second);
704 while (!Users.empty())
705 visit(Users.pop_back_val());
Chris Lattner1daee8b2004-01-12 03:57:30 +0000706 return; // Quick exit
707 }
Chris Lattner138a1242001-06-27 23:38:11 +0000708
Chris Lattnera2f652d2004-03-16 19:49:59 +0000709 // Super-extra-high-degree PHI nodes are unlikely to ever be marked constant,
710 // and slow us down a lot. Just mark them overdefined.
Chris Lattner38871e42009-11-02 03:03:42 +0000711 if (PN.getNumIncomingValues() > 64)
Chris Lattner2a0433b2009-11-02 05:55:40 +0000712 return markOverdefined(&PN);
Chris Lattnerfc36a562009-11-03 23:40:48 +0000713
Chris Lattner2a632552002-04-18 15:13:15 +0000714 // Look at all of the executable operands of the PHI node. If any of them
715 // are overdefined, the PHI becomes overdefined as well. If they are all
716 // constant, and they agree with each other, the PHI becomes the identical
717 // constant. If they are constant and don't agree, the PHI is overdefined.
718 // If there are no executable operands, the PHI remains undefined.
719 //
Chris Lattner9de28282003-04-25 02:50:03 +0000720 Constant *OperandVal = 0;
721 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000722 LatticeVal IV = getValueState(PN.getIncomingValue(i));
Chris Lattner9de28282003-04-25 02:50:03 +0000723 if (IV.isUndefined()) continue; // Doesn't influence PHI node.
Misha Brukmanfd939082005-04-21 23:48:37 +0000724
Chris Lattner38871e42009-11-02 03:03:42 +0000725 if (!isEdgeFeasible(PN.getIncomingBlock(i), PN.getParent()))
726 continue;
727
728 if (IV.isOverdefined()) // PHI node becomes overdefined!
729 return markOverdefined(&PN);
Chris Lattner38b5ae42003-06-24 20:29:52 +0000730
Chris Lattner38871e42009-11-02 03:03:42 +0000731 if (OperandVal == 0) { // Grab the first value.
732 OperandVal = IV.getConstant();
733 continue;
Chris Lattner138a1242001-06-27 23:38:11 +0000734 }
Chris Lattner38871e42009-11-02 03:03:42 +0000735
736 // There is already a reachable operand. If we conflict with it,
737 // then the PHI node becomes overdefined. If we agree with it, we
738 // can continue on.
739
740 // Check to see if there are two different constants merging, if so, the PHI
741 // node is overdefined.
742 if (IV.getConstant() != OperandVal)
743 return markOverdefined(&PN);
Chris Lattner138a1242001-06-27 23:38:11 +0000744 }
745
Chris Lattner2a632552002-04-18 15:13:15 +0000746 // If we exited the loop, this means that the PHI node only has constant
Chris Lattner9de28282003-04-25 02:50:03 +0000747 // arguments that agree with each other(and OperandVal is the constant) or
748 // OperandVal is null because there are no defined incoming arguments. If
749 // this is the case, the PHI remains undefined.
Chris Lattner138a1242001-06-27 23:38:11 +0000750 //
Chris Lattner9de28282003-04-25 02:50:03 +0000751 if (OperandVal)
Chris Lattnercf712de2008-08-23 23:36:38 +0000752 markConstant(&PN, OperandVal); // Acquire operand value
Chris Lattner138a1242001-06-27 23:38:11 +0000753}
754
Chris Lattner14532d02009-11-03 03:42:51 +0000755
756
757
Chris Lattner59acc7d2004-12-10 08:02:06 +0000758void SCCPSolver::visitReturnInst(ReturnInst &I) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000759 if (I.getNumOperands() == 0) return; // ret void
Chris Lattner59acc7d2004-12-10 08:02:06 +0000760
Chris Lattner59acc7d2004-12-10 08:02:06 +0000761 Function *F = I.getParent()->getParent();
Chris Lattnerfc36a562009-11-03 23:40:48 +0000762 Value *ResultOp = I.getOperand(0);
Chris Lattner14532d02009-11-03 03:42:51 +0000763
Devang Patel7c490d42008-03-11 05:46:42 +0000764 // If we are tracking the return value of this function, merge it in.
Duncan Sands1df98592010-02-16 11:11:14 +0000765 if (!TrackedRetVals.empty() && !ResultOp->getType()->isStructTy()) {
Chris Lattnerb59673e2007-02-02 20:38:30 +0000766 DenseMap<Function*, LatticeVal>::iterator TFRVI =
Devang Patel7c490d42008-03-11 05:46:42 +0000767 TrackedRetVals.find(F);
Chris Lattner14532d02009-11-03 03:42:51 +0000768 if (TFRVI != TrackedRetVals.end()) {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000769 mergeInValue(TFRVI->second, F, getValueState(ResultOp));
Devang Patel7c490d42008-03-11 05:46:42 +0000770 return;
771 }
772 }
773
Chris Lattnerc6ee00b2008-04-23 05:38:20 +0000774 // Handle functions that return multiple values.
Chris Lattnerfc36a562009-11-03 23:40:48 +0000775 if (!TrackedMultipleRetVals.empty()) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000776 if (StructType *STy = dyn_cast<StructType>(ResultOp->getType()))
Chris Lattnerfc36a562009-11-03 23:40:48 +0000777 if (MRVFunctionsTracked.count(F))
778 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
779 mergeInValue(TrackedMultipleRetVals[std::make_pair(F, i)], F,
780 getStructValueState(ResultOp, i));
781
Chris Lattner59acc7d2004-12-10 08:02:06 +0000782 }
783}
784
Chris Lattner82bec2c2004-11-15 04:44:20 +0000785void SCCPSolver::visitTerminatorInst(TerminatorInst &TI) {
Chris Lattner1c1f1122007-02-02 21:15:06 +0000786 SmallVector<bool, 16> SuccFeasible;
Chris Lattnerb9a66342002-05-02 21:44:00 +0000787 getFeasibleSuccessors(TI, SuccFeasible);
Chris Lattner138a1242001-06-27 23:38:11 +0000788
Chris Lattner16b18fd2003-10-08 16:55:34 +0000789 BasicBlock *BB = TI.getParent();
790
Chris Lattner2f096252009-11-02 02:33:50 +0000791 // Mark all feasible successors executable.
Chris Lattnerb9a66342002-05-02 21:44:00 +0000792 for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
Chris Lattner16b18fd2003-10-08 16:55:34 +0000793 if (SuccFeasible[i])
794 markEdgeExecutable(BB, TI.getSuccessor(i));
Chris Lattner2a632552002-04-18 15:13:15 +0000795}
796
Chris Lattner82bec2c2004-11-15 04:44:20 +0000797void SCCPSolver::visitCastInst(CastInst &I) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000798 LatticeVal OpSt = getValueState(I.getOperand(0));
799 if (OpSt.isOverdefined()) // Inherit overdefinedness of operand
Chris Lattner7e708292002-06-25 16:13:24 +0000800 markOverdefined(&I);
Chris Lattner2a0433b2009-11-02 05:55:40 +0000801 else if (OpSt.isConstant()) // Propagate constant value
Owen Andersonbaf3c402009-07-29 18:55:55 +0000802 markConstant(&I, ConstantExpr::getCast(I.getOpcode(),
Chris Lattner2a0433b2009-11-02 05:55:40 +0000803 OpSt.getConstant(), I.getType()));
Chris Lattner2a632552002-04-18 15:13:15 +0000804}
805
Chris Lattnerfc36a562009-11-03 23:40:48 +0000806
Dan Gohmanc4b65ea2008-06-20 01:15:44 +0000807void SCCPSolver::visitExtractValueInst(ExtractValueInst &EVI) {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000808 // If this returns a struct, mark all elements over defined, we don't track
809 // structs in structs.
Duncan Sands1df98592010-02-16 11:11:14 +0000810 if (EVI.getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +0000811 return markAnythingOverdefined(&EVI);
812
813 // If this is extracting from more than one level of struct, we don't know.
Chris Lattner38871e42009-11-02 03:03:42 +0000814 if (EVI.getNumIndices() != 1)
815 return markOverdefined(&EVI);
Dan Gohmanc4b65ea2008-06-20 01:15:44 +0000816
Chris Lattnerfc36a562009-11-03 23:40:48 +0000817 Value *AggVal = EVI.getAggregateOperand();
Duncan Sands1df98592010-02-16 11:11:14 +0000818 if (AggVal->getType()->isStructTy()) {
Chris Lattner103f2432009-11-10 22:02:09 +0000819 unsigned i = *EVI.idx_begin();
820 LatticeVal EltVal = getStructValueState(AggVal, i);
821 mergeInValue(getValueState(&EVI), &EVI, EltVal);
822 } else {
823 // Otherwise, must be extracting from an array.
824 return markOverdefined(&EVI);
825 }
Dan Gohmanc4b65ea2008-06-20 01:15:44 +0000826}
827
828void SCCPSolver::visitInsertValueInst(InsertValueInst &IVI) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000829 StructType *STy = dyn_cast<StructType>(IVI.getType());
Chris Lattnerfc36a562009-11-03 23:40:48 +0000830 if (STy == 0)
Chris Lattner38871e42009-11-02 03:03:42 +0000831 return markOverdefined(&IVI);
Dan Gohmanc4b65ea2008-06-20 01:15:44 +0000832
Chris Lattnerfc36a562009-11-03 23:40:48 +0000833 // If this has more than one index, we can't handle it, drive all results to
834 // undef.
835 if (IVI.getNumIndices() != 1)
836 return markAnythingOverdefined(&IVI);
837
838 Value *Aggr = IVI.getAggregateOperand();
839 unsigned Idx = *IVI.idx_begin();
840
841 // Compute the result based on what we're inserting.
842 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
843 // This passes through all values that aren't the inserted element.
844 if (i != Idx) {
845 LatticeVal EltVal = getStructValueState(Aggr, i);
846 mergeInValue(getStructValueState(&IVI, i), &IVI, EltVal);
847 continue;
848 }
849
850 Value *Val = IVI.getInsertedValueOperand();
Duncan Sands1df98592010-02-16 11:11:14 +0000851 if (Val->getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +0000852 // We don't track structs in structs.
853 markOverdefined(getStructValueState(&IVI, i), &IVI);
854 else {
855 LatticeVal InVal = getValueState(Val);
856 mergeInValue(getStructValueState(&IVI, i), &IVI, InVal);
857 }
858 }
Dan Gohmanc4b65ea2008-06-20 01:15:44 +0000859}
860
Chris Lattner82bec2c2004-11-15 04:44:20 +0000861void SCCPSolver::visitSelectInst(SelectInst &I) {
Chris Lattnerfc36a562009-11-03 23:40:48 +0000862 // If this select returns a struct, just mark the result overdefined.
863 // TODO: We could do a lot better than this if code actually uses this.
Duncan Sands1df98592010-02-16 11:11:14 +0000864 if (I.getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +0000865 return markAnythingOverdefined(&I);
866
Chris Lattner2a0433b2009-11-02 05:55:40 +0000867 LatticeVal CondValue = getValueState(I.getCondition());
Chris Lattnerfe243eb2006-02-08 02:38:11 +0000868 if (CondValue.isUndefined())
869 return;
Chris Lattner36c99522009-11-02 03:21:36 +0000870
871 if (ConstantInt *CondCB = CondValue.getConstantInt()) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000872 Value *OpVal = CondCB->isZero() ? I.getFalseValue() : I.getTrueValue();
873 mergeInValue(&I, getValueState(OpVal));
Chris Lattner36c99522009-11-02 03:21:36 +0000874 return;
Chris Lattnerfe243eb2006-02-08 02:38:11 +0000875 }
876
877 // Otherwise, the condition is overdefined or a constant we can't evaluate.
878 // See if we can produce something better than overdefined based on the T/F
879 // value.
Chris Lattner2a0433b2009-11-02 05:55:40 +0000880 LatticeVal TVal = getValueState(I.getTrueValue());
881 LatticeVal FVal = getValueState(I.getFalseValue());
Chris Lattnerfe243eb2006-02-08 02:38:11 +0000882
883 // select ?, C, C -> C.
884 if (TVal.isConstant() && FVal.isConstant() &&
Chris Lattner38871e42009-11-02 03:03:42 +0000885 TVal.getConstant() == FVal.getConstant())
886 return markConstant(&I, FVal.getConstant());
Chris Lattnerfe243eb2006-02-08 02:38:11 +0000887
Chris Lattner2a0433b2009-11-02 05:55:40 +0000888 if (TVal.isUndefined()) // select ?, undef, X -> X.
889 return mergeInValue(&I, FVal);
890 if (FVal.isUndefined()) // select ?, X, undef -> X.
891 return mergeInValue(&I, TVal);
892 markOverdefined(&I);
Chris Lattner6e323722004-03-12 05:52:44 +0000893}
894
Chris Lattner2a0433b2009-11-02 05:55:40 +0000895// Handle Binary Operators.
Chris Lattner82bec2c2004-11-15 04:44:20 +0000896void SCCPSolver::visitBinaryOperator(Instruction &I) {
Chris Lattner2a0433b2009-11-02 05:55:40 +0000897 LatticeVal V1State = getValueState(I.getOperand(0));
898 LatticeVal V2State = getValueState(I.getOperand(1));
899
Chris Lattneref36dfd2004-11-15 05:03:30 +0000900 LatticeVal &IV = ValueState[&I];
Chris Lattner1daee8b2004-01-12 03:57:30 +0000901 if (IV.isOverdefined()) return;
902
Chris Lattner2a0433b2009-11-02 05:55:40 +0000903 if (V1State.isConstant() && V2State.isConstant())
904 return markConstant(IV, &I,
905 ConstantExpr::get(I.getOpcode(), V1State.getConstant(),
906 V2State.getConstant()));
907
908 // If something is undef, wait for it to resolve.
909 if (!V1State.isOverdefined() && !V2State.isOverdefined())
910 return;
911
912 // Otherwise, one of our operands is overdefined. Try to produce something
913 // better than overdefined with some tricks.
914
915 // If this is an AND or OR with 0 or -1, it doesn't matter that the other
916 // operand is overdefined.
917 if (I.getOpcode() == Instruction::And || I.getOpcode() == Instruction::Or) {
918 LatticeVal *NonOverdefVal = 0;
919 if (!V1State.isOverdefined())
920 NonOverdefVal = &V1State;
921 else if (!V2State.isOverdefined())
922 NonOverdefVal = &V2State;
Chris Lattner1daee8b2004-01-12 03:57:30 +0000923
Chris Lattner2a0433b2009-11-02 05:55:40 +0000924 if (NonOverdefVal) {
925 if (NonOverdefVal->isUndefined()) {
926 // Could annihilate value.
927 if (I.getOpcode() == Instruction::And)
928 markConstant(IV, &I, Constant::getNullValue(I.getType()));
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000929 else if (VectorType *PT = dyn_cast<VectorType>(I.getType()))
Chris Lattner2a0433b2009-11-02 05:55:40 +0000930 markConstant(IV, &I, Constant::getAllOnesValue(PT));
931 else
932 markConstant(IV, &I,
933 Constant::getAllOnesValue(I.getType()));
934 return;
Chris Lattnera177c672004-12-11 23:15:19 +0000935 }
Chris Lattner2a0433b2009-11-02 05:55:40 +0000936
937 if (I.getOpcode() == Instruction::And) {
938 // X and 0 = 0
939 if (NonOverdefVal->getConstant()->isNullValue())
940 return markConstant(IV, &I, NonOverdefVal->getConstant());
941 } else {
942 if (ConstantInt *CI = NonOverdefVal->getConstantInt())
943 if (CI->isAllOnesValue()) // X or -1 = -1
944 return markConstant(IV, &I, NonOverdefVal->getConstant());
Chris Lattnera177c672004-12-11 23:15:19 +0000945 }
946 }
Chris Lattner2a0433b2009-11-02 05:55:40 +0000947 }
Chris Lattnera177c672004-12-11 23:15:19 +0000948
949
Chris Lattner2a0433b2009-11-02 05:55:40 +0000950 // If both operands are PHI nodes, it is possible that this instruction has
951 // a constant value, despite the fact that the PHI node doesn't. Check for
952 // this condition now.
953 if (PHINode *PN1 = dyn_cast<PHINode>(I.getOperand(0)))
954 if (PHINode *PN2 = dyn_cast<PHINode>(I.getOperand(1)))
955 if (PN1->getParent() == PN2->getParent()) {
956 // Since the two PHI nodes are in the same basic block, they must have
957 // entries for the same predecessors. Walk the predecessor list, and
958 // if all of the incoming values are constants, and the result of
959 // evaluating this expression with all incoming value pairs is the
960 // same, then this expression is a constant even though the PHI node
961 // is not a constant!
962 LatticeVal Result;
963 for (unsigned i = 0, e = PN1->getNumIncomingValues(); i != e; ++i) {
964 LatticeVal In1 = getValueState(PN1->getIncomingValue(i));
965 BasicBlock *InBlock = PN1->getIncomingBlock(i);
966 LatticeVal In2 =getValueState(PN2->getIncomingValueForBlock(InBlock));
Chris Lattner1daee8b2004-01-12 03:57:30 +0000967
Chris Lattner2a0433b2009-11-02 05:55:40 +0000968 if (In1.isOverdefined() || In2.isOverdefined()) {
969 Result.markOverdefined();
970 break; // Cannot fold this operation over the PHI nodes!
971 }
972
973 if (In1.isConstant() && In2.isConstant()) {
974 Constant *V = ConstantExpr::get(I.getOpcode(), In1.getConstant(),
975 In2.getConstant());
976 if (Result.isUndefined())
977 Result.markConstant(V);
978 else if (Result.isConstant() && Result.getConstant() != V) {
Chris Lattner1daee8b2004-01-12 03:57:30 +0000979 Result.markOverdefined();
Chris Lattner2a0433b2009-11-02 05:55:40 +0000980 break;
Chris Lattner38871e42009-11-02 03:03:42 +0000981 }
Chris Lattner1daee8b2004-01-12 03:57:30 +0000982 }
983 }
984
Chris Lattner2a0433b2009-11-02 05:55:40 +0000985 // If we found a constant value here, then we know the instruction is
986 // constant despite the fact that the PHI nodes are overdefined.
987 if (Result.isConstant()) {
988 markConstant(IV, &I, Result.getConstant());
989 // Remember that this instruction is virtually using the PHI node
Dale Johannesenf619b5a2010-11-30 20:23:21 +0000990 // operands.
991 InsertInOverdefinedPHIs(&I, PN1);
992 InsertInOverdefinedPHIs(&I, PN2);
Chris Lattner2a0433b2009-11-02 05:55:40 +0000993 return;
994 }
995
996 if (Result.isUndefined())
997 return;
998
999 // Okay, this really is overdefined now. Since we might have
1000 // speculatively thought that this was not overdefined before, and
1001 // added ourselves to the UsersOfOverdefinedPHIs list for the PHIs,
1002 // make sure to clean out any entries that we put there, for
1003 // efficiency.
Chris Lattnere01985c2009-11-02 06:28:16 +00001004 RemoveFromOverdefinedPHIs(&I, PN1);
1005 RemoveFromOverdefinedPHIs(&I, PN2);
Chris Lattner2a0433b2009-11-02 05:55:40 +00001006 }
1007
1008 markOverdefined(&I);
Chris Lattner2a632552002-04-18 15:13:15 +00001009}
Chris Lattner2a88bb72002-08-30 23:39:00 +00001010
Chris Lattner2f096252009-11-02 02:33:50 +00001011// Handle ICmpInst instruction.
Reid Spencere4d87aa2006-12-23 06:05:41 +00001012void SCCPSolver::visitCmpInst(CmpInst &I) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001013 LatticeVal V1State = getValueState(I.getOperand(0));
1014 LatticeVal V2State = getValueState(I.getOperand(1));
1015
Reid Spencere4d87aa2006-12-23 06:05:41 +00001016 LatticeVal &IV = ValueState[&I];
1017 if (IV.isOverdefined()) return;
1018
Chris Lattner2a0433b2009-11-02 05:55:40 +00001019 if (V1State.isConstant() && V2State.isConstant())
1020 return markConstant(IV, &I, ConstantExpr::getCompare(I.getPredicate(),
1021 V1State.getConstant(),
1022 V2State.getConstant()));
1023
1024 // If operands are still undefined, wait for it to resolve.
1025 if (!V1State.isOverdefined() && !V2State.isOverdefined())
1026 return;
1027
1028 // If something is overdefined, use some tricks to avoid ending up and over
1029 // defined if we can.
1030
1031 // If both operands are PHI nodes, it is possible that this instruction has
1032 // a constant value, despite the fact that the PHI node doesn't. Check for
1033 // this condition now.
1034 if (PHINode *PN1 = dyn_cast<PHINode>(I.getOperand(0)))
1035 if (PHINode *PN2 = dyn_cast<PHINode>(I.getOperand(1)))
1036 if (PN1->getParent() == PN2->getParent()) {
1037 // Since the two PHI nodes are in the same basic block, they must have
1038 // entries for the same predecessors. Walk the predecessor list, and
1039 // if all of the incoming values are constants, and the result of
1040 // evaluating this expression with all incoming value pairs is the
1041 // same, then this expression is a constant even though the PHI node
1042 // is not a constant!
1043 LatticeVal Result;
1044 for (unsigned i = 0, e = PN1->getNumIncomingValues(); i != e; ++i) {
1045 LatticeVal In1 = getValueState(PN1->getIncomingValue(i));
1046 BasicBlock *InBlock = PN1->getIncomingBlock(i);
1047 LatticeVal In2 =getValueState(PN2->getIncomingValueForBlock(InBlock));
Reid Spencere4d87aa2006-12-23 06:05:41 +00001048
Chris Lattner2a0433b2009-11-02 05:55:40 +00001049 if (In1.isOverdefined() || In2.isOverdefined()) {
1050 Result.markOverdefined();
1051 break; // Cannot fold this operation over the PHI nodes!
1052 }
1053
1054 if (In1.isConstant() && In2.isConstant()) {
1055 Constant *V = ConstantExpr::getCompare(I.getPredicate(),
1056 In1.getConstant(),
1057 In2.getConstant());
1058 if (Result.isUndefined())
1059 Result.markConstant(V);
1060 else if (Result.isConstant() && Result.getConstant() != V) {
Reid Spencere4d87aa2006-12-23 06:05:41 +00001061 Result.markOverdefined();
Chris Lattner2a0433b2009-11-02 05:55:40 +00001062 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00001063 }
1064 }
Reid Spencere4d87aa2006-12-23 06:05:41 +00001065 }
1066
Chris Lattner2a0433b2009-11-02 05:55:40 +00001067 // If we found a constant value here, then we know the instruction is
1068 // constant despite the fact that the PHI nodes are overdefined.
1069 if (Result.isConstant()) {
1070 markConstant(&I, Result.getConstant());
1071 // Remember that this instruction is virtually using the PHI node
1072 // operands.
Dale Johannesenf619b5a2010-11-30 20:23:21 +00001073 InsertInOverdefinedPHIs(&I, PN1);
1074 InsertInOverdefinedPHIs(&I, PN2);
Chris Lattner2a0433b2009-11-02 05:55:40 +00001075 return;
1076 }
1077
1078 if (Result.isUndefined())
1079 return;
1080
1081 // Okay, this really is overdefined now. Since we might have
1082 // speculatively thought that this was not overdefined before, and
1083 // added ourselves to the UsersOfOverdefinedPHIs list for the PHIs,
1084 // make sure to clean out any entries that we put there, for
1085 // efficiency.
Chris Lattnere01985c2009-11-02 06:28:16 +00001086 RemoveFromOverdefinedPHIs(&I, PN1);
1087 RemoveFromOverdefinedPHIs(&I, PN2);
Chris Lattner2a0433b2009-11-02 05:55:40 +00001088 }
1089
1090 markOverdefined(&I);
Reid Spencere4d87aa2006-12-23 06:05:41 +00001091}
1092
Robert Bocchino56107e22006-01-10 19:05:05 +00001093void SCCPSolver::visitExtractElementInst(ExtractElementInst &I) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001094 // TODO : SCCP does not handle vectors properly.
Chris Lattner38871e42009-11-02 03:03:42 +00001095 return markOverdefined(&I);
Devang Patel67a821d2006-12-04 23:54:59 +00001096
1097#if 0
Robert Bocchino56107e22006-01-10 19:05:05 +00001098 LatticeVal &ValState = getValueState(I.getOperand(0));
1099 LatticeVal &IdxState = getValueState(I.getOperand(1));
1100
1101 if (ValState.isOverdefined() || IdxState.isOverdefined())
1102 markOverdefined(&I);
1103 else if(ValState.isConstant() && IdxState.isConstant())
1104 markConstant(&I, ConstantExpr::getExtractElement(ValState.getConstant(),
1105 IdxState.getConstant()));
Devang Patel67a821d2006-12-04 23:54:59 +00001106#endif
Robert Bocchino56107e22006-01-10 19:05:05 +00001107}
1108
Robert Bocchino8fcf01e2006-01-17 20:06:55 +00001109void SCCPSolver::visitInsertElementInst(InsertElementInst &I) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001110 // TODO : SCCP does not handle vectors properly.
Chris Lattner38871e42009-11-02 03:03:42 +00001111 return markOverdefined(&I);
Devang Patel67a821d2006-12-04 23:54:59 +00001112#if 0
Robert Bocchino8fcf01e2006-01-17 20:06:55 +00001113 LatticeVal &ValState = getValueState(I.getOperand(0));
1114 LatticeVal &EltState = getValueState(I.getOperand(1));
1115 LatticeVal &IdxState = getValueState(I.getOperand(2));
1116
1117 if (ValState.isOverdefined() || EltState.isOverdefined() ||
1118 IdxState.isOverdefined())
1119 markOverdefined(&I);
1120 else if(ValState.isConstant() && EltState.isConstant() &&
1121 IdxState.isConstant())
1122 markConstant(&I, ConstantExpr::getInsertElement(ValState.getConstant(),
1123 EltState.getConstant(),
1124 IdxState.getConstant()));
1125 else if (ValState.isUndefined() && EltState.isConstant() &&
Devang Patel67a821d2006-12-04 23:54:59 +00001126 IdxState.isConstant())
Chris Lattnere34e9a22007-04-14 23:32:02 +00001127 markConstant(&I,ConstantExpr::getInsertElement(UndefValue::get(I.getType()),
1128 EltState.getConstant(),
1129 IdxState.getConstant()));
Devang Patel67a821d2006-12-04 23:54:59 +00001130#endif
Robert Bocchino8fcf01e2006-01-17 20:06:55 +00001131}
1132
Chris Lattner543abdf2006-04-08 01:19:12 +00001133void SCCPSolver::visitShuffleVectorInst(ShuffleVectorInst &I) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001134 // TODO : SCCP does not handle vectors properly.
Chris Lattner38871e42009-11-02 03:03:42 +00001135 return markOverdefined(&I);
Devang Patel67a821d2006-12-04 23:54:59 +00001136#if 0
Chris Lattner543abdf2006-04-08 01:19:12 +00001137 LatticeVal &V1State = getValueState(I.getOperand(0));
1138 LatticeVal &V2State = getValueState(I.getOperand(1));
1139 LatticeVal &MaskState = getValueState(I.getOperand(2));
1140
1141 if (MaskState.isUndefined() ||
1142 (V1State.isUndefined() && V2State.isUndefined()))
1143 return; // Undefined output if mask or both inputs undefined.
1144
1145 if (V1State.isOverdefined() || V2State.isOverdefined() ||
1146 MaskState.isOverdefined()) {
1147 markOverdefined(&I);
1148 } else {
1149 // A mix of constant/undef inputs.
1150 Constant *V1 = V1State.isConstant() ?
1151 V1State.getConstant() : UndefValue::get(I.getType());
1152 Constant *V2 = V2State.isConstant() ?
1153 V2State.getConstant() : UndefValue::get(I.getType());
1154 Constant *Mask = MaskState.isConstant() ?
1155 MaskState.getConstant() : UndefValue::get(I.getOperand(2)->getType());
1156 markConstant(&I, ConstantExpr::getShuffleVector(V1, V2, Mask));
1157 }
Devang Patel67a821d2006-12-04 23:54:59 +00001158#endif
Chris Lattner543abdf2006-04-08 01:19:12 +00001159}
1160
Chris Lattner2f096252009-11-02 02:33:50 +00001161// Handle getelementptr instructions. If all operands are constants then we
Chris Lattner2a88bb72002-08-30 23:39:00 +00001162// can turn this into a getelementptr ConstantExpr.
1163//
Chris Lattner82bec2c2004-11-15 04:44:20 +00001164void SCCPSolver::visitGetElementPtrInst(GetElementPtrInst &I) {
Chris Lattner5cc66d92009-11-02 23:25:39 +00001165 if (ValueState[&I].isOverdefined()) return;
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +00001166
Chris Lattnere777ff22007-02-02 20:51:48 +00001167 SmallVector<Constant*, 8> Operands;
Chris Lattner2a88bb72002-08-30 23:39:00 +00001168 Operands.reserve(I.getNumOperands());
1169
1170 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001171 LatticeVal State = getValueState(I.getOperand(i));
Chris Lattner2a88bb72002-08-30 23:39:00 +00001172 if (State.isUndefined())
Chris Lattner2f096252009-11-02 02:33:50 +00001173 return; // Operands are not resolved yet.
1174
Chris Lattner38871e42009-11-02 03:03:42 +00001175 if (State.isOverdefined())
Chris Lattner5cc66d92009-11-02 23:25:39 +00001176 return markOverdefined(&I);
Chris Lattner38871e42009-11-02 03:03:42 +00001177
Chris Lattner2a88bb72002-08-30 23:39:00 +00001178 assert(State.isConstant() && "Unknown state!");
1179 Operands.push_back(State.getConstant());
1180 }
1181
1182 Constant *Ptr = Operands[0];
Jay Foaddab3d292011-07-21 14:31:17 +00001183 ArrayRef<Constant *> Indices(Operands.begin() + 1, Operands.end());
1184 markConstant(&I, ConstantExpr::getGetElementPtr(Ptr, Indices));
Chris Lattner2a88bb72002-08-30 23:39:00 +00001185}
Brian Gaeked0fde302003-11-11 22:41:34 +00001186
Chris Lattner2a0433b2009-11-02 05:55:40 +00001187void SCCPSolver::visitStoreInst(StoreInst &SI) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001188 // If this store is of a struct, ignore it.
Duncan Sands1df98592010-02-16 11:11:14 +00001189 if (SI.getOperand(0)->getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +00001190 return;
1191
Chris Lattnerdd336d12004-12-11 05:15:59 +00001192 if (TrackedGlobals.empty() || !isa<GlobalVariable>(SI.getOperand(1)))
1193 return;
Chris Lattner2a0433b2009-11-02 05:55:40 +00001194
Chris Lattnerdd336d12004-12-11 05:15:59 +00001195 GlobalVariable *GV = cast<GlobalVariable>(SI.getOperand(1));
Chris Lattnerb59673e2007-02-02 20:38:30 +00001196 DenseMap<GlobalVariable*, LatticeVal>::iterator I = TrackedGlobals.find(GV);
Chris Lattnerdd336d12004-12-11 05:15:59 +00001197 if (I == TrackedGlobals.end() || I->second.isOverdefined()) return;
1198
Chris Lattner2a0433b2009-11-02 05:55:40 +00001199 // Get the value we are storing into the global, then merge it.
1200 mergeInValue(I->second, GV, getValueState(SI.getOperand(0)));
Chris Lattnerdd336d12004-12-11 05:15:59 +00001201 if (I->second.isOverdefined())
1202 TrackedGlobals.erase(I); // No need to keep tracking this!
1203}
1204
1205
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +00001206// Handle load instructions. If the operand is a constant pointer to a constant
1207// global, we can replace the load with the loaded constant value!
Chris Lattner82bec2c2004-11-15 04:44:20 +00001208void SCCPSolver::visitLoadInst(LoadInst &I) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001209 // If this load is of a struct, just mark the result overdefined.
Duncan Sands1df98592010-02-16 11:11:14 +00001210 if (I.getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +00001211 return markAnythingOverdefined(&I);
1212
Chris Lattner2a0433b2009-11-02 05:55:40 +00001213 LatticeVal PtrVal = getValueState(I.getOperand(0));
Chris Lattner5638dc62009-11-02 06:06:14 +00001214 if (PtrVal.isUndefined()) return; // The pointer is not resolved yet!
Chris Lattner2a0433b2009-11-02 05:55:40 +00001215
Chris Lattneref36dfd2004-11-15 05:03:30 +00001216 LatticeVal &IV = ValueState[&I];
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +00001217 if (IV.isOverdefined()) return;
1218
Chris Lattner2a0433b2009-11-02 05:55:40 +00001219 if (!PtrVal.isConstant() || I.isVolatile())
1220 return markOverdefined(IV, &I);
1221
Chris Lattner5638dc62009-11-02 06:06:14 +00001222 Constant *Ptr = PtrVal.getConstant();
Misha Brukmanfd939082005-04-21 23:48:37 +00001223
Chris Lattner2a0433b2009-11-02 05:55:40 +00001224 // load null -> null
1225 if (isa<ConstantPointerNull>(Ptr) && I.getPointerAddressSpace() == 0)
1226 return markConstant(IV, &I, Constant::getNullValue(I.getType()));
1227
1228 // Transform load (constant global) into the value loaded.
1229 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
Chris Lattner5638dc62009-11-02 06:06:14 +00001230 if (!TrackedGlobals.empty()) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001231 // If we are tracking this global, merge in the known value for it.
1232 DenseMap<GlobalVariable*, LatticeVal>::iterator It =
1233 TrackedGlobals.find(GV);
1234 if (It != TrackedGlobals.end()) {
1235 mergeInValue(IV, &I, It->second);
1236 return;
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +00001237 }
Chris Lattnerdd336d12004-12-11 05:15:59 +00001238 }
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +00001239 }
1240
Chris Lattner5638dc62009-11-02 06:06:14 +00001241 // Transform load from a constant into a constant if possible.
1242 if (Constant *C = ConstantFoldLoadFromConstPtr(Ptr, TD))
1243 return markConstant(IV, &I, C);
Chris Lattner2a0433b2009-11-02 05:55:40 +00001244
Chris Lattnerc6a4d6a2004-01-12 04:29:41 +00001245 // Otherwise we cannot say for certain what value this load will produce.
1246 // Bail out.
1247 markOverdefined(IV, &I);
1248}
Chris Lattner58b7b082004-04-13 19:43:54 +00001249
Chris Lattner59acc7d2004-12-10 08:02:06 +00001250void SCCPSolver::visitCallSite(CallSite CS) {
1251 Function *F = CS.getCalledFunction();
Chris Lattner59acc7d2004-12-10 08:02:06 +00001252 Instruction *I = CS.getInstruction();
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001253
1254 // The common case is that we aren't tracking the callee, either because we
1255 // are not doing interprocedural analysis or the callee is indirect, or is
1256 // external. Handle these cases first.
Chris Lattner14532d02009-11-03 03:42:51 +00001257 if (F == 0 || F->isDeclaration()) {
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001258CallOverdefined:
1259 // Void return and not tracking callee, just bail.
Chris Lattnercf0fe8d2009-10-05 05:54:46 +00001260 if (I->getType()->isVoidTy()) return;
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001261
1262 // Otherwise, if we have a single return value case, and if the function is
1263 // a declaration, maybe we can constant fold it.
Duncan Sands1df98592010-02-16 11:11:14 +00001264 if (F && F->isDeclaration() && !I->getType()->isStructTy() &&
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001265 canConstantFoldCallTo(F)) {
1266
1267 SmallVector<Constant*, 8> Operands;
1268 for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
1269 AI != E; ++AI) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001270 LatticeVal State = getValueState(*AI);
Chris Lattner38871e42009-11-02 03:03:42 +00001271
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001272 if (State.isUndefined())
1273 return; // Operands are not resolved yet.
Chris Lattner38871e42009-11-02 03:03:42 +00001274 if (State.isOverdefined())
1275 return markOverdefined(I);
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001276 assert(State.isConstant() && "Unknown state!");
1277 Operands.push_back(State.getConstant());
1278 }
1279
1280 // If we can constant fold this, mark the result of the call as a
1281 // constant.
Jay Foad1d2f5692011-07-19 13:32:40 +00001282 if (Constant *C = ConstantFoldCall(F, Operands))
Chris Lattner38871e42009-11-02 03:03:42 +00001283 return markConstant(I, C);
Chris Lattner58b7b082004-04-13 19:43:54 +00001284 }
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001285
1286 // Otherwise, we don't know anything about this call, mark it overdefined.
Chris Lattnerfc36a562009-11-03 23:40:48 +00001287 return markAnythingOverdefined(I);
Chris Lattner58b7b082004-04-13 19:43:54 +00001288 }
1289
Chris Lattner2396cc32009-11-03 19:24:51 +00001290 // If this is a local function that doesn't have its address taken, mark its
1291 // entry block executable and merge in the actual arguments to the call into
1292 // the formal arguments of the function.
1293 if (!TrackingIncomingArguments.empty() && TrackingIncomingArguments.count(F)){
1294 MarkBlockExecutable(F->begin());
1295
1296 // Propagate information from this call site into the callee.
1297 CallSite::arg_iterator CAI = CS.arg_begin();
1298 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1299 AI != E; ++AI, ++CAI) {
1300 // If this argument is byval, and if the function is not readonly, there
1301 // will be an implicit copy formed of the input aggregate.
1302 if (AI->hasByValAttr() && !F->onlyReadsMemory()) {
1303 markOverdefined(AI);
1304 continue;
1305 }
1306
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001307 if (StructType *STy = dyn_cast<StructType>(AI->getType())) {
Chris Lattner0fb7e182009-11-04 18:57:42 +00001308 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1309 LatticeVal CallArg = getStructValueState(*CAI, i);
1310 mergeInValue(getStructValueState(AI, i), AI, CallArg);
1311 }
Chris Lattnerfc36a562009-11-03 23:40:48 +00001312 } else {
1313 mergeInValue(AI, getValueState(*CAI));
1314 }
Chris Lattner2396cc32009-11-03 19:24:51 +00001315 }
1316 }
1317
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001318 // If this is a single/zero retval case, see if we're tracking the function.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001319 if (StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001320 if (!MRVFunctionsTracked.count(F))
1321 goto CallOverdefined; // Not tracking this callee.
1322
1323 // If we are tracking this callee, propagate the result of the function
1324 // into this call site.
1325 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1326 mergeInValue(getStructValueState(I, i), I,
1327 TrackedMultipleRetVals[std::make_pair(F, i)]);
1328 } else {
1329 DenseMap<Function*, LatticeVal>::iterator TFRVI = TrackedRetVals.find(F);
1330 if (TFRVI == TrackedRetVals.end())
1331 goto CallOverdefined; // Not tracking this callee.
1332
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001333 // If so, propagate the return value of the callee into this call result.
1334 mergeInValue(I, TFRVI->second);
Chris Lattnerc6ee00b2008-04-23 05:38:20 +00001335 }
Chris Lattner58b7b082004-04-13 19:43:54 +00001336}
Chris Lattner82bec2c2004-11-15 04:44:20 +00001337
Chris Lattner82bec2c2004-11-15 04:44:20 +00001338void SCCPSolver::Solve() {
1339 // Process the work lists until they are empty!
Misha Brukmanfd939082005-04-21 23:48:37 +00001340 while (!BBWorkList.empty() || !InstWorkList.empty() ||
Jeff Cohen9d809302005-04-23 21:38:35 +00001341 !OverdefinedInstWorkList.empty()) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001342 // Process the overdefined instruction's work list first, which drives other
1343 // things to overdefined more quickly.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001344 while (!OverdefinedInstWorkList.empty()) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001345 Value *I = OverdefinedInstWorkList.pop_back_val();
Chris Lattner82bec2c2004-11-15 04:44:20 +00001346
David Greene971cc7e2010-01-05 01:27:15 +00001347 DEBUG(dbgs() << "\nPopped off OI-WL: " << *I << '\n');
Misha Brukmanfd939082005-04-21 23:48:37 +00001348
Chris Lattner82bec2c2004-11-15 04:44:20 +00001349 // "I" got into the work list because it either made the transition from
1350 // bottom to constant
1351 //
1352 // Anything on this worklist that is overdefined need not be visited
1353 // since all of its users will have already been marked as overdefined
Chris Lattner2f096252009-11-02 02:33:50 +00001354 // Update all of the users of this instruction's value.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001355 //
1356 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1357 UI != E; ++UI)
Chris Lattner14532d02009-11-03 03:42:51 +00001358 if (Instruction *I = dyn_cast<Instruction>(*UI))
1359 OperandChangedState(I);
Chris Lattner82bec2c2004-11-15 04:44:20 +00001360 }
Chris Lattner2f096252009-11-02 02:33:50 +00001361
1362 // Process the instruction work list.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001363 while (!InstWorkList.empty()) {
Chris Lattner2a0433b2009-11-02 05:55:40 +00001364 Value *I = InstWorkList.pop_back_val();
Chris Lattner82bec2c2004-11-15 04:44:20 +00001365
David Greene971cc7e2010-01-05 01:27:15 +00001366 DEBUG(dbgs() << "\nPopped off I-WL: " << *I << '\n');
Misha Brukmanfd939082005-04-21 23:48:37 +00001367
Chris Lattner2a0433b2009-11-02 05:55:40 +00001368 // "I" got into the work list because it made the transition from undef to
1369 // constant.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001370 //
1371 // Anything on this worklist that is overdefined need not be visited
1372 // since all of its users will have already been marked as overdefined.
Chris Lattner2f096252009-11-02 02:33:50 +00001373 // Update all of the users of this instruction's value.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001374 //
Duncan Sands1df98592010-02-16 11:11:14 +00001375 if (I->getType()->isStructTy() || !getValueState(I).isOverdefined())
Chris Lattner82bec2c2004-11-15 04:44:20 +00001376 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1377 UI != E; ++UI)
Chris Lattner14532d02009-11-03 03:42:51 +00001378 if (Instruction *I = dyn_cast<Instruction>(*UI))
1379 OperandChangedState(I);
Chris Lattner82bec2c2004-11-15 04:44:20 +00001380 }
Misha Brukmanfd939082005-04-21 23:48:37 +00001381
Chris Lattner2f096252009-11-02 02:33:50 +00001382 // Process the basic block work list.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001383 while (!BBWorkList.empty()) {
1384 BasicBlock *BB = BBWorkList.back();
1385 BBWorkList.pop_back();
Misha Brukmanfd939082005-04-21 23:48:37 +00001386
David Greene971cc7e2010-01-05 01:27:15 +00001387 DEBUG(dbgs() << "\nPopped off BBWL: " << *BB << '\n');
Misha Brukmanfd939082005-04-21 23:48:37 +00001388
Chris Lattner82bec2c2004-11-15 04:44:20 +00001389 // Notify all instructions in this basic block that they are newly
1390 // executable.
1391 visit(BB);
1392 }
1393 }
1394}
1395
Chris Lattner3bad2532006-12-20 06:21:33 +00001396/// ResolvedUndefsIn - While solving the dataflow for a function, we assume
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001397/// that branches on undef values cannot reach any of their successors.
1398/// However, this is not a safe assumption. After we solve dataflow, this
1399/// method should be use to handle this. If this returns true, the solver
1400/// should be rerun.
Chris Lattnerd2d86702006-10-22 05:59:17 +00001401///
1402/// This method handles this by finding an unresolved branch and marking it one
1403/// of the edges from the block as being feasible, even though the condition
1404/// doesn't say it would otherwise be. This allows SCCP to find the rest of the
1405/// CFG and only slightly pessimizes the analysis results (by marking one,
Chris Lattner3bad2532006-12-20 06:21:33 +00001406/// potentially infeasible, edge feasible). This cannot usefully modify the
Chris Lattnerd2d86702006-10-22 05:59:17 +00001407/// constraints on the condition of the branch, as that would impact other users
1408/// of the value.
Chris Lattner3bad2532006-12-20 06:21:33 +00001409///
1410/// This scan also checks for values that use undefs, whose results are actually
1411/// defined. For example, 'zext i8 undef to i32' should produce all zeros
1412/// conservatively, as "(zext i8 X -> i32) & 0xFF00" must always return zero,
1413/// even if X isn't defined.
1414bool SCCPSolver::ResolvedUndefsIn(Function &F) {
Chris Lattnerd2d86702006-10-22 05:59:17 +00001415 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
1416 if (!BBExecutable.count(BB))
1417 continue;
Chris Lattner3bad2532006-12-20 06:21:33 +00001418
1419 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1420 // Look for instructions which produce undef values.
Chris Lattnercf0fe8d2009-10-05 05:54:46 +00001421 if (I->getType()->isVoidTy()) continue;
Chris Lattner3bad2532006-12-20 06:21:33 +00001422
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001423 if (StructType *STy = dyn_cast<StructType>(I->getType())) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001424 // Only a few things that can be structs matter for undef. Just send
1425 // all their results to overdefined. We could be more precise than this
1426 // but it isn't worth bothering.
1427 if (isa<CallInst>(I) || isa<SelectInst>(I)) {
1428 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1429 LatticeVal &LV = getStructValueState(I, i);
1430 if (LV.isUndefined())
1431 markOverdefined(LV, I);
1432 }
1433 }
1434 continue;
1435 }
1436
Chris Lattner3bad2532006-12-20 06:21:33 +00001437 LatticeVal &LV = getValueState(I);
1438 if (!LV.isUndefined()) continue;
1439
Chris Lattnerfc36a562009-11-03 23:40:48 +00001440 // No instructions using structs need disambiguation.
Duncan Sands1df98592010-02-16 11:11:14 +00001441 if (I->getOperand(0)->getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +00001442 continue;
1443
Chris Lattner3bad2532006-12-20 06:21:33 +00001444 // Get the lattice values of the first two operands for use below.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001445 LatticeVal Op0LV = getValueState(I->getOperand(0));
Chris Lattner3bad2532006-12-20 06:21:33 +00001446 LatticeVal Op1LV;
1447 if (I->getNumOperands() == 2) {
Chris Lattnerfc36a562009-11-03 23:40:48 +00001448 // No instructions using structs need disambiguation.
Duncan Sands1df98592010-02-16 11:11:14 +00001449 if (I->getOperand(1)->getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +00001450 continue;
1451
Chris Lattner3bad2532006-12-20 06:21:33 +00001452 // If this is a two-operand instruction, and if both operands are
1453 // undefs, the result stays undef.
1454 Op1LV = getValueState(I->getOperand(1));
1455 if (Op0LV.isUndefined() && Op1LV.isUndefined())
1456 continue;
1457 }
1458
1459 // If this is an instructions whose result is defined even if the input is
1460 // not fully defined, propagate the information.
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001461 Type *ITy = I->getType();
Chris Lattner3bad2532006-12-20 06:21:33 +00001462 switch (I->getOpcode()) {
1463 default: break; // Leave the instruction as an undef.
1464 case Instruction::ZExt:
1465 // After a zero extend, we know the top part is zero. SExt doesn't have
1466 // to be handled here, because we don't know whether the top part is 1's
1467 // or 0's.
Chris Lattner8581c262010-04-26 18:21:23 +00001468 case Instruction::SIToFP: // some FP values are not possible, just use 0.
1469 case Instruction::UIToFP: // some FP values are not possible, just use 0.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001470 markForcedConstant(I, Constant::getNullValue(ITy));
Chris Lattner3bad2532006-12-20 06:21:33 +00001471 return true;
1472 case Instruction::Mul:
1473 case Instruction::And:
1474 // undef * X -> 0. X could be zero.
1475 // undef & X -> 0. X could be zero.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001476 markForcedConstant(I, Constant::getNullValue(ITy));
Chris Lattner3bad2532006-12-20 06:21:33 +00001477 return true;
1478
1479 case Instruction::Or:
1480 // undef | X -> -1. X could be -1.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001481 markForcedConstant(I, Constant::getAllOnesValue(ITy));
Chris Lattner7ce2f8b2007-01-04 02:12:40 +00001482 return true;
Chris Lattner3bad2532006-12-20 06:21:33 +00001483
1484 case Instruction::SDiv:
1485 case Instruction::UDiv:
1486 case Instruction::SRem:
1487 case Instruction::URem:
1488 // X / undef -> undef. No change.
1489 // X % undef -> undef. No change.
1490 if (Op1LV.isUndefined()) break;
1491
1492 // undef / X -> 0. X could be maxint.
1493 // undef % X -> 0. X could be 1.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001494 markForcedConstant(I, Constant::getNullValue(ITy));
Chris Lattner3bad2532006-12-20 06:21:33 +00001495 return true;
1496
1497 case Instruction::AShr:
1498 // undef >>s X -> undef. No change.
1499 if (Op0LV.isUndefined()) break;
1500
1501 // X >>s undef -> X. X could be 0, X could have the high-bit known set.
1502 if (Op0LV.isConstant())
Chris Lattner2a0433b2009-11-02 05:55:40 +00001503 markForcedConstant(I, Op0LV.getConstant());
Chris Lattner3bad2532006-12-20 06:21:33 +00001504 else
Chris Lattner2a0433b2009-11-02 05:55:40 +00001505 markOverdefined(I);
Chris Lattner3bad2532006-12-20 06:21:33 +00001506 return true;
1507 case Instruction::LShr:
1508 case Instruction::Shl:
1509 // undef >> X -> undef. No change.
1510 // undef << X -> undef. No change.
1511 if (Op0LV.isUndefined()) break;
1512
1513 // X >> undef -> 0. X could be 0.
1514 // X << undef -> 0. X could be 0.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001515 markForcedConstant(I, Constant::getNullValue(ITy));
Chris Lattner3bad2532006-12-20 06:21:33 +00001516 return true;
1517 case Instruction::Select:
1518 // undef ? X : Y -> X or Y. There could be commonality between X/Y.
1519 if (Op0LV.isUndefined()) {
1520 if (!Op1LV.isConstant()) // Pick the constant one if there is any.
1521 Op1LV = getValueState(I->getOperand(2));
1522 } else if (Op1LV.isUndefined()) {
1523 // c ? undef : undef -> undef. No change.
1524 Op1LV = getValueState(I->getOperand(2));
1525 if (Op1LV.isUndefined())
1526 break;
1527 // Otherwise, c ? undef : x -> x.
1528 } else {
1529 // Leave Op1LV as Operand(1)'s LatticeValue.
1530 }
1531
1532 if (Op1LV.isConstant())
Chris Lattner2a0433b2009-11-02 05:55:40 +00001533 markForcedConstant(I, Op1LV.getConstant());
Chris Lattner3bad2532006-12-20 06:21:33 +00001534 else
Chris Lattner2a0433b2009-11-02 05:55:40 +00001535 markOverdefined(I);
Chris Lattner3bad2532006-12-20 06:21:33 +00001536 return true;
Chris Lattner60301602008-05-24 03:59:33 +00001537 case Instruction::Call:
1538 // If a call has an undef result, it is because it is constant foldable
1539 // but one of the inputs was undef. Just force the result to
1540 // overdefined.
Chris Lattner2a0433b2009-11-02 05:55:40 +00001541 markOverdefined(I);
Chris Lattner60301602008-05-24 03:59:33 +00001542 return true;
Chris Lattner3bad2532006-12-20 06:21:33 +00001543 }
1544 }
Chris Lattnerd2d86702006-10-22 05:59:17 +00001545
Chris Lattnere597f002010-04-05 22:14:48 +00001546 // Check to see if we have a branch or switch on an undefined value. If so
1547 // we force the branch to go one way or the other to make the successor
1548 // values live. It doesn't really matter which way we force it.
Chris Lattnerd2d86702006-10-22 05:59:17 +00001549 TerminatorInst *TI = BB->getTerminator();
1550 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1551 if (!BI->isConditional()) continue;
1552 if (!getValueState(BI->getCondition()).isUndefined())
1553 continue;
Chris Lattnere597f002010-04-05 22:14:48 +00001554
1555 // If the input to SCCP is actually branch on undef, fix the undef to
1556 // false.
1557 if (isa<UndefValue>(BI->getCondition())) {
1558 BI->setCondition(ConstantInt::getFalse(BI->getContext()));
1559 markEdgeExecutable(BB, TI->getSuccessor(1));
1560 return true;
1561 }
1562
1563 // Otherwise, it is a branch on a symbolic value which is currently
1564 // considered to be undef. Handle this by forcing the input value to the
1565 // branch to false.
1566 markForcedConstant(BI->getCondition(),
1567 ConstantInt::getFalse(TI->getContext()));
1568 return true;
1569 }
1570
1571 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Chris Lattnerea0db072009-11-02 02:30:06 +00001572 if (SI->getNumSuccessors() < 2) // no cases
Dale Johannesen9bca5832008-05-23 01:01:31 +00001573 continue;
Chris Lattnerd2d86702006-10-22 05:59:17 +00001574 if (!getValueState(SI->getCondition()).isUndefined())
1575 continue;
Chris Lattnere597f002010-04-05 22:14:48 +00001576
1577 // If the input to SCCP is actually switch on undef, fix the undef to
1578 // the first constant.
1579 if (isa<UndefValue>(SI->getCondition())) {
1580 SI->setCondition(SI->getCaseValue(1));
1581 markEdgeExecutable(BB, TI->getSuccessor(1));
1582 return true;
1583 }
1584
1585 markForcedConstant(SI->getCondition(), SI->getCaseValue(1));
1586 return true;
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001587 }
Chris Lattnerd2d86702006-10-22 05:59:17 +00001588 }
Chris Lattnerdade2d22004-12-11 06:05:53 +00001589
Chris Lattnerd2d86702006-10-22 05:59:17 +00001590 return false;
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001591}
1592
Chris Lattner82bec2c2004-11-15 04:44:20 +00001593
1594namespace {
Chris Lattner14051812004-11-15 07:15:04 +00001595 //===--------------------------------------------------------------------===//
Chris Lattner82bec2c2004-11-15 04:44:20 +00001596 //
Chris Lattner14051812004-11-15 07:15:04 +00001597 /// SCCP Class - This class uses the SCCPSolver to implement a per-function
Reid Spenceree5d25e2006-12-31 22:26:06 +00001598 /// Sparse Conditional Constant Propagator.
Chris Lattner14051812004-11-15 07:15:04 +00001599 ///
Chris Lattner3e8b6632009-09-02 06:11:42 +00001600 struct SCCP : public FunctionPass {
Nick Lewyckyecd94c82007-05-06 13:37:16 +00001601 static char ID; // Pass identification, replacement for typeid
Owen Anderson081c34b2010-10-19 17:21:58 +00001602 SCCP() : FunctionPass(ID) {
1603 initializeSCCPPass(*PassRegistry::getPassRegistry());
1604 }
Devang Patel794fd752007-05-01 21:15:47 +00001605
Chris Lattner14051812004-11-15 07:15:04 +00001606 // runOnFunction - Run the Sparse Conditional Constant Propagation
1607 // algorithm, and return true if the function was modified.
1608 //
1609 bool runOnFunction(Function &F);
Chris Lattner14051812004-11-15 07:15:04 +00001610 };
Chris Lattner82bec2c2004-11-15 04:44:20 +00001611} // end anonymous namespace
1612
Dan Gohman844731a2008-05-13 00:00:25 +00001613char SCCP::ID = 0;
Owen Andersond13db2c2010-07-21 22:09:45 +00001614INITIALIZE_PASS(SCCP, "sccp",
Owen Andersonce665bd2010-10-07 22:25:06 +00001615 "Sparse Conditional Constant Propagation", false, false)
Chris Lattner82bec2c2004-11-15 04:44:20 +00001616
Chris Lattner2f096252009-11-02 02:33:50 +00001617// createSCCPPass - This is the public interface to this file.
Chris Lattner82bec2c2004-11-15 04:44:20 +00001618FunctionPass *llvm::createSCCPPass() {
1619 return new SCCP();
1620}
1621
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001622static void DeleteInstructionInBlock(BasicBlock *BB) {
David Greene971cc7e2010-01-05 01:27:15 +00001623 DEBUG(dbgs() << " BasicBlock Dead:" << *BB);
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001624 ++NumDeadBlocks;
1625
1626 // Delete the instructions backwards, as it has a reduced likelihood of
1627 // having to update as many def-use and use-def chains.
1628 while (!isa<TerminatorInst>(BB->begin())) {
1629 Instruction *I = --BasicBlock::iterator(BB->getTerminator());
1630
1631 if (!I->use_empty())
1632 I->replaceAllUsesWith(UndefValue::get(I->getType()));
1633 BB->getInstList().erase(I);
1634 ++NumInstRemoved;
1635 }
1636}
Chris Lattner82bec2c2004-11-15 04:44:20 +00001637
Chris Lattner82bec2c2004-11-15 04:44:20 +00001638// runOnFunction() - Run the Sparse Conditional Constant Propagation algorithm,
1639// and return true if the function was modified.
1640//
1641bool SCCP::runOnFunction(Function &F) {
David Greene971cc7e2010-01-05 01:27:15 +00001642 DEBUG(dbgs() << "SCCP on function '" << F.getName() << "'\n");
Chris Lattner5638dc62009-11-02 06:06:14 +00001643 SCCPSolver Solver(getAnalysisIfAvailable<TargetData>());
Chris Lattner82bec2c2004-11-15 04:44:20 +00001644
1645 // Mark the first block of the function as being executable.
1646 Solver.MarkBlockExecutable(F.begin());
1647
Chris Lattner7e529e42004-11-15 05:45:33 +00001648 // Mark all arguments to the function as being overdefined.
Chris Lattnere34e9a22007-04-14 23:32:02 +00001649 for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end(); AI != E;++AI)
Chris Lattnerfc36a562009-11-03 23:40:48 +00001650 Solver.markAnythingOverdefined(AI);
Chris Lattner7e529e42004-11-15 05:45:33 +00001651
Chris Lattner82bec2c2004-11-15 04:44:20 +00001652 // Solve for constants.
Chris Lattner3bad2532006-12-20 06:21:33 +00001653 bool ResolvedUndefs = true;
1654 while (ResolvedUndefs) {
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001655 Solver.Solve();
David Greene971cc7e2010-01-05 01:27:15 +00001656 DEBUG(dbgs() << "RESOLVING UNDEFs\n");
Chris Lattner3bad2532006-12-20 06:21:33 +00001657 ResolvedUndefs = Solver.ResolvedUndefsIn(F);
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001658 }
Chris Lattner82bec2c2004-11-15 04:44:20 +00001659
Chris Lattner7e529e42004-11-15 05:45:33 +00001660 bool MadeChanges = false;
1661
1662 // If we decided that there are basic blocks that are dead in this function,
1663 // delete their contents now. Note that we cannot actually delete the blocks,
1664 // as we cannot modify the CFG of the function.
Chris Lattner57939df2007-03-04 04:50:21 +00001665
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001666 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
Chris Lattner7eb01bf2008-08-23 23:39:31 +00001667 if (!Solver.isBlockExecutable(BB)) {
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001668 DeleteInstructionInBlock(BB);
1669 MadeChanges = true;
1670 continue;
Chris Lattner82bec2c2004-11-15 04:44:20 +00001671 }
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001672
1673 // Iterate over all of the instructions in a function, replacing them with
1674 // constants if we have found them to be of constant values.
1675 //
1676 for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
1677 Instruction *Inst = BI++;
1678 if (Inst->getType()->isVoidTy() || isa<TerminatorInst>(Inst))
1679 continue;
1680
Chris Lattnerfc36a562009-11-03 23:40:48 +00001681 // TODO: Reconstruct structs from their elements.
Duncan Sands1df98592010-02-16 11:11:14 +00001682 if (Inst->getType()->isStructTy())
Chris Lattnerfc36a562009-11-03 23:40:48 +00001683 continue;
1684
Chris Lattner8db50122009-11-02 02:54:24 +00001685 LatticeVal IV = Solver.getLatticeValueFor(Inst);
1686 if (IV.isOverdefined())
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001687 continue;
1688
1689 Constant *Const = IV.isConstant()
1690 ? IV.getConstant() : UndefValue::get(Inst->getType());
David Greene971cc7e2010-01-05 01:27:15 +00001691 DEBUG(dbgs() << " Constant: " << *Const << " = " << *Inst);
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001692
1693 // Replaces all of the uses of a variable with uses of the constant.
1694 Inst->replaceAllUsesWith(Const);
1695
1696 // Delete the instruction.
1697 Inst->eraseFromParent();
1698
1699 // Hey, we just changed something!
1700 MadeChanges = true;
1701 ++NumInstRemoved;
1702 }
1703 }
Chris Lattner82bec2c2004-11-15 04:44:20 +00001704
1705 return MadeChanges;
1706}
Chris Lattner59acc7d2004-12-10 08:02:06 +00001707
1708namespace {
Chris Lattner59acc7d2004-12-10 08:02:06 +00001709 //===--------------------------------------------------------------------===//
1710 //
1711 /// IPSCCP Class - This class implements interprocedural Sparse Conditional
1712 /// Constant Propagation.
1713 ///
Chris Lattner3e8b6632009-09-02 06:11:42 +00001714 struct IPSCCP : public ModulePass {
Devang Patel19974732007-05-03 01:11:54 +00001715 static char ID;
Owen Anderson081c34b2010-10-19 17:21:58 +00001716 IPSCCP() : ModulePass(ID) {
1717 initializeIPSCCPPass(*PassRegistry::getPassRegistry());
1718 }
Chris Lattner59acc7d2004-12-10 08:02:06 +00001719 bool runOnModule(Module &M);
1720 };
Chris Lattner59acc7d2004-12-10 08:02:06 +00001721} // end anonymous namespace
1722
Dan Gohman844731a2008-05-13 00:00:25 +00001723char IPSCCP::ID = 0;
Owen Andersond13db2c2010-07-21 22:09:45 +00001724INITIALIZE_PASS(IPSCCP, "ipsccp",
1725 "Interprocedural Sparse Conditional Constant Propagation",
Owen Andersonce665bd2010-10-07 22:25:06 +00001726 false, false)
Dan Gohman844731a2008-05-13 00:00:25 +00001727
Chris Lattner2f096252009-11-02 02:33:50 +00001728// createIPSCCPPass - This is the public interface to this file.
Chris Lattner59acc7d2004-12-10 08:02:06 +00001729ModulePass *llvm::createIPSCCPPass() {
1730 return new IPSCCP();
1731}
1732
1733
Gabor Greifbd1f9932010-03-24 10:29:52 +00001734static bool AddressIsTaken(const GlobalValue *GV) {
Chris Lattner7d27fc02005-04-19 19:16:19 +00001735 // Delete any dead constantexpr klingons.
1736 GV->removeDeadConstantUsers();
1737
Gabor Greif60ad7812010-03-25 23:06:16 +00001738 for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
Gabor Greifbd1f9932010-03-24 10:29:52 +00001739 UI != E; ++UI) {
1740 const User *U = *UI;
1741 if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnerdd336d12004-12-11 05:15:59 +00001742 if (SI->getOperand(0) == GV || SI->isVolatile())
1743 return true; // Storing addr of GV.
Gabor Greifbd1f9932010-03-24 10:29:52 +00001744 } else if (isa<InvokeInst>(U) || isa<CallInst>(U)) {
Chris Lattner59acc7d2004-12-10 08:02:06 +00001745 // Make sure we are calling the function, not passing the address.
Gabor Greifc8b82cc2010-04-01 08:21:08 +00001746 ImmutableCallSite CS(cast<Instruction>(U));
Gabor Greifc9f75002010-03-24 13:21:49 +00001747 if (!CS.isCallee(UI))
Nick Lewyckyaf386132008-11-03 03:49:14 +00001748 return true;
Gabor Greifbd1f9932010-03-24 10:29:52 +00001749 } else if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattnerdd336d12004-12-11 05:15:59 +00001750 if (LI->isVolatile())
1751 return true;
Gabor Greifbd1f9932010-03-24 10:29:52 +00001752 } else if (isa<BlockAddress>(U)) {
Chris Lattnerb2710042009-11-01 06:11:53 +00001753 // blockaddress doesn't take the address of the function, it takes addr
1754 // of label.
Chris Lattnerdd336d12004-12-11 05:15:59 +00001755 } else {
Chris Lattner59acc7d2004-12-10 08:02:06 +00001756 return true;
1757 }
Gabor Greifbd1f9932010-03-24 10:29:52 +00001758 }
Chris Lattner59acc7d2004-12-10 08:02:06 +00001759 return false;
1760}
1761
1762bool IPSCCP::runOnModule(Module &M) {
Chris Lattner5638dc62009-11-02 06:06:14 +00001763 SCCPSolver Solver(getAnalysisIfAvailable<TargetData>());
Chris Lattner59acc7d2004-12-10 08:02:06 +00001764
Chris Lattner1522ce92010-08-12 22:25:23 +00001765 // AddressTakenFunctions - This set keeps track of the address-taken functions
1766 // that are in the input. As IPSCCP runs through and simplifies code,
1767 // functions that were address taken can end up losing their
1768 // address-taken-ness. Because of this, we keep track of their addresses from
1769 // the first pass so we can use them for the later simplification pass.
1770 SmallPtrSet<Function*, 32> AddressTakenFunctions;
1771
Chris Lattner59acc7d2004-12-10 08:02:06 +00001772 // Loop over all functions, marking arguments to those with their addresses
1773 // taken or that are external as overdefined.
1774 //
Chris Lattnerff3ca152009-11-02 06:34:04 +00001775 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
1776 if (F->isDeclaration())
1777 continue;
1778
Chris Lattner14532d02009-11-03 03:42:51 +00001779 // If this is a strong or ODR definition of this function, then we can
1780 // propagate information about its result into callsites of it.
Chris Lattnerfc36a562009-11-03 23:40:48 +00001781 if (!F->mayBeOverridden())
Chris Lattner59acc7d2004-12-10 08:02:06 +00001782 Solver.AddTrackedFunction(F);
Chris Lattner14532d02009-11-03 03:42:51 +00001783
1784 // If this function only has direct calls that we can see, we can track its
1785 // arguments and return value aggressively, and can assume it is not called
1786 // unless we see evidence to the contrary.
Chris Lattner1522ce92010-08-12 22:25:23 +00001787 if (F->hasLocalLinkage()) {
1788 if (AddressIsTaken(F))
1789 AddressTakenFunctions.insert(F);
1790 else {
1791 Solver.AddArgumentTrackedFunction(F);
1792 continue;
1793 }
Chris Lattner2396cc32009-11-03 19:24:51 +00001794 }
Chris Lattner14532d02009-11-03 03:42:51 +00001795
1796 // Assume the function is called.
1797 Solver.MarkBlockExecutable(F->begin());
1798
1799 // Assume nothing about the incoming arguments.
1800 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1801 AI != E; ++AI)
Chris Lattnerfc36a562009-11-03 23:40:48 +00001802 Solver.markAnythingOverdefined(AI);
Chris Lattnerff3ca152009-11-02 06:34:04 +00001803 }
Chris Lattner59acc7d2004-12-10 08:02:06 +00001804
Chris Lattnerdd336d12004-12-11 05:15:59 +00001805 // Loop over global variables. We inform the solver about any internal global
1806 // variables that do not have their 'addresses taken'. If they don't have
1807 // their addresses taken, we can propagate constants through them.
Chris Lattner7d27fc02005-04-19 19:16:19 +00001808 for (Module::global_iterator G = M.global_begin(), E = M.global_end();
1809 G != E; ++G)
Rafael Espindolabb46f522009-01-15 20:18:42 +00001810 if (!G->isConstant() && G->hasLocalLinkage() && !AddressIsTaken(G))
Chris Lattnerdd336d12004-12-11 05:15:59 +00001811 Solver.TrackValueOfGlobalVariable(G);
1812
Chris Lattner59acc7d2004-12-10 08:02:06 +00001813 // Solve for constants.
Chris Lattner3bad2532006-12-20 06:21:33 +00001814 bool ResolvedUndefs = true;
1815 while (ResolvedUndefs) {
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001816 Solver.Solve();
1817
David Greene971cc7e2010-01-05 01:27:15 +00001818 DEBUG(dbgs() << "RESOLVING UNDEFS\n");
Chris Lattner3bad2532006-12-20 06:21:33 +00001819 ResolvedUndefs = false;
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001820 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
Chris Lattner3bad2532006-12-20 06:21:33 +00001821 ResolvedUndefs |= Solver.ResolvedUndefsIn(*F);
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001822 }
Chris Lattner59acc7d2004-12-10 08:02:06 +00001823
1824 bool MadeChanges = false;
1825
1826 // Iterate over all of the instructions in the module, replacing them with
1827 // constants if we have found them to be of constant values.
1828 //
Chris Lattnercf712de2008-08-23 23:36:38 +00001829 SmallVector<BasicBlock*, 512> BlocksToErase;
Chris Lattner1c1f1122007-02-02 21:15:06 +00001830
Chris Lattner59acc7d2004-12-10 08:02:06 +00001831 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
Chris Lattner89112b62009-11-02 03:25:55 +00001832 if (Solver.isBlockExecutable(F->begin())) {
1833 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1834 AI != E; ++AI) {
Duncan Sands1df98592010-02-16 11:11:14 +00001835 if (AI->use_empty() || AI->getType()->isStructTy()) continue;
Chris Lattner89112b62009-11-02 03:25:55 +00001836
Chris Lattnerfc36a562009-11-03 23:40:48 +00001837 // TODO: Could use getStructLatticeValueFor to find out if the entire
1838 // result is a constant and replace it entirely if so.
1839
Chris Lattner89112b62009-11-02 03:25:55 +00001840 LatticeVal IV = Solver.getLatticeValueFor(AI);
1841 if (IV.isOverdefined()) continue;
1842
1843 Constant *CST = IV.isConstant() ?
1844 IV.getConstant() : UndefValue::get(AI->getType());
David Greene971cc7e2010-01-05 01:27:15 +00001845 DEBUG(dbgs() << "*** Arg " << *AI << " = " << *CST <<"\n");
Chris Lattner89112b62009-11-02 03:25:55 +00001846
1847 // Replaces all of the uses of a variable with uses of the
1848 // constant.
1849 AI->replaceAllUsesWith(CST);
1850 ++IPNumArgsElimed;
1851 }
Chris Lattner8db50122009-11-02 02:54:24 +00001852 }
Chris Lattner59acc7d2004-12-10 08:02:06 +00001853
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001854 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
Chris Lattner7eb01bf2008-08-23 23:39:31 +00001855 if (!Solver.isBlockExecutable(BB)) {
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001856 DeleteInstructionInBlock(BB);
1857 MadeChanges = true;
Chris Lattnerfc6ac502004-12-10 20:41:50 +00001858
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001859 TerminatorInst *TI = BB->getTerminator();
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001860 for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1861 BasicBlock *Succ = TI->getSuccessor(i);
Dan Gohmancb406c22007-10-03 19:26:29 +00001862 if (!Succ->empty() && isa<PHINode>(Succ->begin()))
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001863 TI->getSuccessor(i)->removePredecessor(BB);
1864 }
Chris Lattner0417feb2004-12-11 02:53:57 +00001865 if (!TI->use_empty())
Owen Anderson9e9a0d52009-07-30 23:03:37 +00001866 TI->replaceAllUsesWith(UndefValue::get(TI->getType()));
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001867 TI->eraseFromParent();
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001868
Chris Lattner864737b2004-12-11 05:32:19 +00001869 if (&*BB != &F->front())
1870 BlocksToErase.push_back(BB);
1871 else
Owen Anderson1d0be152009-08-13 21:58:54 +00001872 new UnreachableInst(M.getContext(), BB);
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001873 continue;
Chris Lattner59acc7d2004-12-10 08:02:06 +00001874 }
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001875
1876 for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
1877 Instruction *Inst = BI++;
Duncan Sands1df98592010-02-16 11:11:14 +00001878 if (Inst->getType()->isVoidTy() || Inst->getType()->isStructTy())
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001879 continue;
1880
Chris Lattnerfc36a562009-11-03 23:40:48 +00001881 // TODO: Could use getStructLatticeValueFor to find out if the entire
1882 // result is a constant and replace it entirely if so.
1883
Chris Lattner8db50122009-11-02 02:54:24 +00001884 LatticeVal IV = Solver.getLatticeValueFor(Inst);
1885 if (IV.isOverdefined())
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001886 continue;
1887
1888 Constant *Const = IV.isConstant()
1889 ? IV.getConstant() : UndefValue::get(Inst->getType());
David Greene971cc7e2010-01-05 01:27:15 +00001890 DEBUG(dbgs() << " Constant: " << *Const << " = " << *Inst);
Chris Lattnercc4f60b2009-11-02 02:47:51 +00001891
1892 // Replaces all of the uses of a variable with uses of the
1893 // constant.
1894 Inst->replaceAllUsesWith(Const);
1895
1896 // Delete the instruction.
1897 if (!isa<CallInst>(Inst) && !isa<TerminatorInst>(Inst))
1898 Inst->eraseFromParent();
1899
1900 // Hey, we just changed something!
1901 MadeChanges = true;
1902 ++IPNumInstRemoved;
1903 }
1904 }
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001905
1906 // Now that all instructions in the function are constant folded, erase dead
1907 // blocks, because we can now use ConstantFoldTerminator to get rid of
1908 // in-edges.
1909 for (unsigned i = 0, e = BlocksToErase.size(); i != e; ++i) {
1910 // If there are any PHI nodes in this successor, drop entries for BB now.
1911 BasicBlock *DeadBB = BlocksToErase[i];
Dan Gohman6a239212009-11-20 20:19:14 +00001912 for (Value::use_iterator UI = DeadBB->use_begin(), UE = DeadBB->use_end();
1913 UI != UE; ) {
Dan Gohman8f3817f2009-11-23 16:13:39 +00001914 // Grab the user and then increment the iterator early, as the user
1915 // will be deleted. Step past all adjacent uses from the same user.
1916 Instruction *I = dyn_cast<Instruction>(*UI);
1917 do { ++UI; } while (UI != UE && *UI == I);
1918
Dan Gohman6a239212009-11-20 20:19:14 +00001919 // Ignore blockaddress users; BasicBlock's dtor will handle them.
Dan Gohman6a239212009-11-20 20:19:14 +00001920 if (!I) continue;
1921
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001922 bool Folded = ConstantFoldTerminator(I->getParent());
Chris Lattnerddaaa372006-10-23 18:57:02 +00001923 if (!Folded) {
Reid Spencera54b7cb2007-01-12 07:05:14 +00001924 // The constant folder may not have been able to fold the terminator
Chris Lattnerddaaa372006-10-23 18:57:02 +00001925 // if this is a branch or switch on undef. Fold it manually as a
1926 // branch to the first successor.
Devang Patelcb9a3542008-11-21 01:52:59 +00001927#ifndef NDEBUG
Chris Lattnerddaaa372006-10-23 18:57:02 +00001928 if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1929 assert(BI->isConditional() && isa<UndefValue>(BI->getCondition()) &&
1930 "Branch should be foldable!");
1931 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
1932 assert(isa<UndefValue>(SI->getCondition()) && "Switch should fold");
1933 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00001934 llvm_unreachable("Didn't fold away reference to block!");
Chris Lattnerddaaa372006-10-23 18:57:02 +00001935 }
Devang Patelcb9a3542008-11-21 01:52:59 +00001936#endif
Chris Lattnerddaaa372006-10-23 18:57:02 +00001937
1938 // Make this an uncond branch to the first successor.
1939 TerminatorInst *TI = I->getParent()->getTerminator();
Gabor Greif051a9502008-04-06 20:25:17 +00001940 BranchInst::Create(TI->getSuccessor(0), TI);
Chris Lattnerddaaa372006-10-23 18:57:02 +00001941
1942 // Remove entries in successor phi nodes to remove edges.
1943 for (unsigned i = 1, e = TI->getNumSuccessors(); i != e; ++i)
1944 TI->getSuccessor(i)->removePredecessor(TI->getParent());
1945
1946 // Remove the old terminator.
1947 TI->eraseFromParent();
1948 }
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001949 }
Misha Brukmanfd939082005-04-21 23:48:37 +00001950
Chris Lattner5f9e8b42004-12-10 22:29:08 +00001951 // Finally, delete the basic block.
1952 F->getBasicBlockList().erase(DeadBB);
1953 }
Chris Lattner1c1f1122007-02-02 21:15:06 +00001954 BlocksToErase.clear();
Chris Lattner59acc7d2004-12-10 08:02:06 +00001955 }
Chris Lattner0417feb2004-12-11 02:53:57 +00001956
1957 // If we inferred constant or undef return values for a function, we replaced
1958 // all call uses with the inferred value. This means we don't need to bother
1959 // actually returning anything from the function. Replace all return
1960 // instructions with return undef.
Chris Lattnerd38cdb02010-02-27 00:07:42 +00001961 //
1962 // Do this in two stages: first identify the functions we should process, then
1963 // actually zap their returns. This is important because we can only do this
Chris Lattner9fcd72b2010-02-27 07:50:40 +00001964 // if the address of the function isn't taken. In cases where a return is the
Chris Lattnerd38cdb02010-02-27 00:07:42 +00001965 // last use of a function, the order of processing functions would affect
Chris Lattner9fcd72b2010-02-27 07:50:40 +00001966 // whether other functions are optimizable.
Chris Lattnerd38cdb02010-02-27 00:07:42 +00001967 SmallVector<ReturnInst*, 8> ReturnsToZap;
1968
Devang Patel9af014f2008-03-11 17:32:05 +00001969 // TODO: Process multiple value ret instructions also.
Devang Patel7c490d42008-03-11 05:46:42 +00001970 const DenseMap<Function*, LatticeVal> &RV = Solver.getTrackedRetVals();
Chris Lattnerb59673e2007-02-02 20:38:30 +00001971 for (DenseMap<Function*, LatticeVal>::const_iterator I = RV.begin(),
Chris Lattner14532d02009-11-03 03:42:51 +00001972 E = RV.end(); I != E; ++I) {
1973 Function *F = I->first;
1974 if (I->second.isOverdefined() || F->getReturnType()->isVoidTy())
1975 continue;
1976
1977 // We can only do this if we know that nothing else can call the function.
Chris Lattner1522ce92010-08-12 22:25:23 +00001978 if (!F->hasLocalLinkage() || AddressTakenFunctions.count(F))
Chris Lattner14532d02009-11-03 03:42:51 +00001979 continue;
1980
1981 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
1982 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
1983 if (!isa<UndefValue>(RI->getOperand(0)))
Chris Lattnerd38cdb02010-02-27 00:07:42 +00001984 ReturnsToZap.push_back(RI);
1985 }
1986
1987 // Zap all returns which we've identified as zap to change.
1988 for (unsigned i = 0, e = ReturnsToZap.size(); i != e; ++i) {
1989 Function *F = ReturnsToZap[i]->getParent()->getParent();
1990 ReturnsToZap[i]->setOperand(0, UndefValue::get(F->getReturnType()));
Chris Lattner14532d02009-11-03 03:42:51 +00001991 }
1992
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001993 // If we inferred constant or undef values for globals variables, we can delete
Chris Lattnerdd336d12004-12-11 05:15:59 +00001994 // the global and any stores that remain to it.
Chris Lattnerb59673e2007-02-02 20:38:30 +00001995 const DenseMap<GlobalVariable*, LatticeVal> &TG = Solver.getTrackedGlobals();
1996 for (DenseMap<GlobalVariable*, LatticeVal>::const_iterator I = TG.begin(),
Chris Lattnerdd336d12004-12-11 05:15:59 +00001997 E = TG.end(); I != E; ++I) {
1998 GlobalVariable *GV = I->first;
1999 assert(!I->second.isOverdefined() &&
2000 "Overdefined values should have been taken out of the map!");
David Greene971cc7e2010-01-05 01:27:15 +00002001 DEBUG(dbgs() << "Found that GV '" << GV->getName() << "' is constant!\n");
Chris Lattnerdd336d12004-12-11 05:15:59 +00002002 while (!GV->use_empty()) {
2003 StoreInst *SI = cast<StoreInst>(GV->use_back());
2004 SI->eraseFromParent();
2005 }
2006 M.getGlobalList().erase(GV);
Chris Lattnerdade2d22004-12-11 06:05:53 +00002007 ++IPNumGlobalConst;
Chris Lattnerdd336d12004-12-11 05:15:59 +00002008 }
Misha Brukmanfd939082005-04-21 23:48:37 +00002009
Chris Lattner59acc7d2004-12-10 08:02:06 +00002010 return MadeChanges;
2011}