2005-07-30 02:12:19 +02:00
|
|
|
//===---- llvm/Analysis/ScalarEvolutionExpander.h - SCEV Exprs --*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 20:59:42 +01:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-07-30 02:12:19 +02:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file defines the classes used to generate code from scalar expressions.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_ANALYSIS_SCALAREVOLUTION_EXPANDER_H
|
|
|
|
#define LLVM_ANALYSIS_SCALAREVOLUTION_EXPANDER_H
|
|
|
|
|
|
|
|
#include "llvm/Analysis/ScalarEvolutionExpressions.h"
|
2010-04-08 00:27:08 +02:00
|
|
|
#include "llvm/Analysis/ScalarEvolutionNormalization.h"
|
2009-06-27 23:18:18 +02:00
|
|
|
#include "llvm/Support/IRBuilder.h"
|
|
|
|
#include "llvm/Support/TargetFolder.h"
|
2010-07-27 03:19:06 +02:00
|
|
|
#include "llvm/Support/ValueHandle.h"
|
2009-07-14 00:19:41 +02:00
|
|
|
#include <set>
|
2005-07-30 02:12:19 +02:00
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
/// SCEVExpander - This class uses information about analyze scalars to
|
|
|
|
/// rewrite expressions in canonical form.
|
|
|
|
///
|
|
|
|
/// Clients should create an instance of this class when rewriting is needed,
|
2009-08-20 18:42:55 +02:00
|
|
|
/// and destroy it when finished to allow the release of the associated
|
2005-07-30 02:12:19 +02:00
|
|
|
/// memory.
|
2010-01-21 03:09:26 +01:00
|
|
|
class SCEVExpander : public SCEVVisitor<SCEVExpander, Value*> {
|
2005-07-30 02:12:19 +02:00
|
|
|
ScalarEvolution &SE;
|
2009-06-27 00:53:46 +02:00
|
|
|
std::map<std::pair<const SCEV *, Instruction *>, AssertingVH<Value> >
|
|
|
|
InsertedExpressions;
|
2010-07-27 03:19:06 +02:00
|
|
|
std::set<AssertingVH<Value> > InsertedValues;
|
|
|
|
std::set<AssertingVH<Value> > InsertedPostIncValues;
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2010-04-08 00:27:08 +02:00
|
|
|
/// PostIncLoops - Addrecs referring to any of the given loops are expanded
|
|
|
|
/// in post-inc mode. For example, expanding {1,+,1}<L> in post-inc mode
|
|
|
|
/// returns the add instruction that adds one to the phi for {0,+,1}<L>,
|
|
|
|
/// as opposed to a new phi starting at 1. This is only supported in
|
|
|
|
/// non-canonical mode.
|
|
|
|
PostIncLoopSet PostIncLoops;
|
2010-01-21 03:09:26 +01:00
|
|
|
|
|
|
|
/// IVIncInsertPos - When this is non-null, addrecs expanded in the
|
|
|
|
/// loop it indicates should be inserted with increments at
|
|
|
|
/// IVIncInsertPos.
|
|
|
|
const Loop *IVIncInsertLoop;
|
|
|
|
|
|
|
|
/// IVIncInsertPos - When expanding addrecs in the IVIncInsertLoop loop,
|
|
|
|
/// insert the IV increment at this position.
|
|
|
|
Instruction *IVIncInsertPos;
|
|
|
|
|
|
|
|
/// CanonicalMode - When true, expressions are expanded in "canonical"
|
|
|
|
/// form. In particular, addrecs are expanded as arithmetic based on
|
|
|
|
/// a canonical induction variable. When false, expression are expanded
|
|
|
|
/// in a more literal form.
|
|
|
|
bool CanonicalMode;
|
|
|
|
|
2009-06-27 23:18:18 +02:00
|
|
|
typedef IRBuilder<true, TargetFolder> BuilderType;
|
|
|
|
BuilderType Builder;
|
2005-07-30 02:12:19 +02:00
|
|
|
|
|
|
|
friend struct SCEVVisitor<SCEVExpander, Value*>;
|
2010-02-14 03:47:26 +01:00
|
|
|
|
2005-07-30 02:12:19 +02:00
|
|
|
public:
|
2010-01-21 03:09:26 +01:00
|
|
|
/// SCEVExpander - Construct a SCEVExpander in "canonical" mode.
|
2009-05-19 04:15:55 +02:00
|
|
|
explicit SCEVExpander(ScalarEvolution &se)
|
2010-04-08 00:27:08 +02:00
|
|
|
: SE(se), IVIncInsertLoop(0), CanonicalMode(true),
|
2010-01-21 03:09:26 +01:00
|
|
|
Builder(se.getContext(), TargetFolder(se.TD)) {}
|
2006-02-04 06:49:01 +01:00
|
|
|
|
2005-07-30 02:12:19 +02:00
|
|
|
/// clear - Erase the contents of the InsertedExpressions map so that users
|
2005-07-30 20:33:25 +02:00
|
|
|
/// trying to expand the same expression into multiple BasicBlocks or
|
2005-07-30 02:12:19 +02:00
|
|
|
/// different places within the same BasicBlock can do so.
|
2010-07-27 03:19:06 +02:00
|
|
|
void clear() {
|
|
|
|
InsertedExpressions.clear();
|
|
|
|
InsertedValues.clear();
|
|
|
|
InsertedPostIncValues.clear();
|
|
|
|
}
|
2005-07-30 20:33:25 +02:00
|
|
|
|
2005-07-30 02:12:19 +02:00
|
|
|
/// getOrInsertCanonicalInductionVariable - This method returns the
|
|
|
|
/// canonical induction variable of the specified type for the specified
|
|
|
|
/// loop (inserting one if there is none). A canonical induction variable
|
|
|
|
/// starts at zero and steps by one on each iteration.
|
2010-07-20 18:44:52 +02:00
|
|
|
PHINode *getOrInsertCanonicalInductionVariable(const Loop *L,
|
|
|
|
const Type *Ty);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
|
|
|
/// expandCodeFor - Insert code to directly compute the specified SCEV
|
|
|
|
/// expression into the program. The inserted code is inserted into the
|
|
|
|
/// specified block.
|
2010-03-19 22:51:03 +01:00
|
|
|
Value *expandCodeFor(const SCEV *SH, const Type *Ty, Instruction *I);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2010-01-21 03:09:26 +01:00
|
|
|
/// setIVIncInsertPos - Set the current IV increment loop and position.
|
|
|
|
void setIVIncInsertPos(const Loop *L, Instruction *Pos) {
|
|
|
|
assert(!CanonicalMode &&
|
|
|
|
"IV increment positions are not supported in CanonicalMode");
|
|
|
|
IVIncInsertLoop = L;
|
|
|
|
IVIncInsertPos = Pos;
|
|
|
|
}
|
|
|
|
|
2010-04-08 00:27:08 +02:00
|
|
|
/// setPostInc - Enable post-inc expansion for addrecs referring to the
|
|
|
|
/// given loops. Post-inc expansion is only supported in non-canonical
|
2010-01-21 03:09:26 +01:00
|
|
|
/// mode.
|
2010-04-08 00:27:08 +02:00
|
|
|
void setPostInc(const PostIncLoopSet &L) {
|
2010-01-21 03:09:26 +01:00
|
|
|
assert(!CanonicalMode &&
|
|
|
|
"Post-inc expansion is not supported in CanonicalMode");
|
2010-04-08 00:27:08 +02:00
|
|
|
PostIncLoops = L;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// clearPostInc - Disable all post-inc expansion.
|
|
|
|
void clearPostInc() {
|
|
|
|
PostIncLoops.clear();
|
2010-06-05 02:33:07 +02:00
|
|
|
|
|
|
|
// When we change the post-inc loop set, cached expansions may no
|
|
|
|
// longer be valid.
|
|
|
|
InsertedPostIncValues.clear();
|
2010-01-21 03:09:26 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// disableCanonicalMode - Disable the behavior of expanding expressions in
|
|
|
|
/// canonical form rather than in a more literal form. Non-canonical mode
|
|
|
|
/// is useful for late optimization passes.
|
|
|
|
void disableCanonicalMode() { CanonicalMode = false; }
|
|
|
|
|
2010-03-20 04:53:53 +01:00
|
|
|
/// clearInsertPoint - Clear the current insertion point. This is useful
|
|
|
|
/// if the instruction that had been serving as the insertion point may
|
|
|
|
/// have been deleted.
|
|
|
|
void clearInsertPoint() {
|
|
|
|
Builder.ClearInsertionPoint();
|
|
|
|
}
|
|
|
|
|
2009-06-27 23:18:18 +02:00
|
|
|
private:
|
2009-07-22 02:24:57 +02:00
|
|
|
LLVMContext &getContext() const { return SE.getContext(); }
|
2009-08-20 18:42:55 +02:00
|
|
|
|
2009-06-27 23:18:18 +02:00
|
|
|
/// InsertBinop - Insert the specified binary operator, doing a small amount
|
|
|
|
/// of work to avoid inserting an obviously redundant operation.
|
|
|
|
Value *InsertBinop(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS);
|
2009-04-21 03:07:12 +02:00
|
|
|
|
2010-06-19 15:25:23 +02:00
|
|
|
/// ReuseOrCreateCast - Arange for there to be a cast of V to Ty at IP,
|
|
|
|
/// reusing an existing cast if a suitable one exists, moving an existing
|
|
|
|
/// cast if a suitable one exists but isn't in the right place, or
|
|
|
|
/// or creating a new one.
|
|
|
|
Value *ReuseOrCreateCast(Value *V, const Type *Ty,
|
|
|
|
Instruction::CastOps Op,
|
|
|
|
BasicBlock::iterator IP);
|
|
|
|
|
2009-04-21 03:07:12 +02:00
|
|
|
/// InsertNoopCastOfTo - Insert a cast of V to the specified type,
|
2009-06-27 23:18:18 +02:00
|
|
|
/// which must be possible with a noop cast, doing what we can to
|
|
|
|
/// share the casts.
|
2009-04-21 03:07:12 +02:00
|
|
|
Value *InsertNoopCastOfTo(Value *V, const Type *Ty);
|
|
|
|
|
2009-05-19 04:15:55 +02:00
|
|
|
/// expandAddToGEP - Expand a SCEVAddExpr with a pointer type into a GEP
|
|
|
|
/// instead of using ptrtoint+arithmetic+inttoptr.
|
2009-07-07 19:06:11 +02:00
|
|
|
Value *expandAddToGEP(const SCEV *const *op_begin,
|
|
|
|
const SCEV *const *op_end,
|
2009-05-24 20:06:31 +02:00
|
|
|
const PointerType *PTy, const Type *Ty, Value *V);
|
2009-05-19 04:15:55 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *expand(const SCEV *S);
|
2009-04-16 05:18:22 +02:00
|
|
|
|
2009-06-27 00:53:46 +02:00
|
|
|
/// expandCodeFor - Insert code to directly compute the specified SCEV
|
|
|
|
/// expression into the program. The inserted code is inserted into the
|
|
|
|
/// SCEVExpander's current insertion point. If a type is specified, the
|
|
|
|
/// result will be expanded to have that type, with a cast if necessary.
|
2009-07-07 19:06:11 +02:00
|
|
|
Value *expandCodeFor(const SCEV *SH, const Type *Ty = 0);
|
2009-06-27 00:53:46 +02:00
|
|
|
|
|
|
|
/// isInsertedInstruction - Return true if the specified instruction was
|
|
|
|
/// inserted by the code rewriter. If so, the client should not modify the
|
|
|
|
/// instruction.
|
|
|
|
bool isInsertedInstruction(Instruction *I) const {
|
2010-06-05 02:33:07 +02:00
|
|
|
return InsertedValues.count(I) || InsertedPostIncValues.count(I);
|
2009-06-27 00:53:46 +02:00
|
|
|
}
|
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitConstant(const SCEVConstant *S) {
|
2005-07-30 02:12:19 +02:00
|
|
|
return S->getValue();
|
|
|
|
}
|
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitTruncateExpr(const SCEVTruncateExpr *S);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitZeroExtendExpr(const SCEVZeroExtendExpr *S);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitSignExtendExpr(const SCEVSignExtendExpr *S);
|
2007-06-15 16:38:12 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitAddExpr(const SCEVAddExpr *S);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitMulExpr(const SCEVMulExpr *S);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitUDivExpr(const SCEVUDivExpr *S);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitAddRecExpr(const SCEVAddRecExpr *S);
|
2005-07-30 02:12:19 +02:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitSMaxExpr(const SCEVSMaxExpr *S);
|
2007-11-25 23:41:31 +01:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitUMaxExpr(const SCEVUMaxExpr *S);
|
2008-02-20 07:48:22 +01:00
|
|
|
|
2009-04-18 19:56:28 +02:00
|
|
|
Value *visitUnknown(const SCEVUnknown *S) {
|
2005-07-30 02:12:19 +02:00
|
|
|
return S->getValue();
|
|
|
|
}
|
2010-01-21 03:09:26 +01:00
|
|
|
|
2010-02-14 04:12:47 +01:00
|
|
|
void rememberInstruction(Value *I);
|
2010-01-21 03:09:26 +01:00
|
|
|
|
2010-02-15 01:21:43 +01:00
|
|
|
void restoreInsertPoint(BasicBlock *BB, BasicBlock::iterator I);
|
|
|
|
|
2010-01-21 03:09:26 +01:00
|
|
|
Value *expandAddRecExprLiterally(const SCEVAddRecExpr *);
|
|
|
|
PHINode *getAddRecExprPHILiterally(const SCEVAddRecExpr *Normalized,
|
|
|
|
const Loop *L,
|
|
|
|
const Type *ExpandTy,
|
|
|
|
const Type *IntTy);
|
2005-07-30 02:12:19 +02:00
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|