ScalarEvolutionExpressions.h revision 203a7239ae928568fe7a34c03ead4b1b3133870e
14950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner//===- llvm/Analysis/ScalarEvolutionExpressions.h - SCEV Exprs --*- C++ -*-===// 29769ab22265b313171d201b5928688524a01bd87Misha Brukman// 34950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner// The LLVM Compiler Infrastructure 44950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 79769ab22265b313171d201b5928688524a01bd87Misha Brukman// 84950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner//===----------------------------------------------------------------------===// 94950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner// 104950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner// This file defines the classes used to represent and build scalar expressions. 119769ab22265b313171d201b5928688524a01bd87Misha Brukman// 124950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner//===----------------------------------------------------------------------===// 134950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 144950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner#ifndef LLVM_ANALYSIS_SCALAREVOLUTION_EXPRESSIONS_H 154950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner#define LLVM_ANALYSIS_SCALAREVOLUTION_EXPRESSIONS_H 164950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 174950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner#include "llvm/Analysis/ScalarEvolution.h" 18c25e7581b9b8088910da31702d4ca21c4734c6d7Torok Edwin#include "llvm/Support/ErrorHandling.h" 194950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 204950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattnernamespace llvm { 214950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner class ConstantInt; 224950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner class ConstantRange; 235a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng class DominatorTree; 244950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 254950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner enum SCEVTypes { 264950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner // These should be ordered in terms of increasing complexity to make the 274950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner // folders simpler. 28d19534add90a2a894af61523b830887097bb780bDan Gohman scConstant, scTruncate, scZeroExtend, scSignExtend, scAddExpr, scMulExpr, 29c40f17b08774c2dcc5787fd83241e3c64ba82974Dan Gohman scUDivExpr, scAddRecExpr, scUMaxExpr, scSMaxExpr, 300f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman scUnknown, scCouldNotCompute 314950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 324950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 334950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 344950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// SCEVConstant - This class represents a constant integer value. 354950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 364950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner class SCEVConstant : public SCEV { 37246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 38246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 394950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner ConstantInt *V; 403bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVConstant(const FoldingSetNodeIDRef ID, ConstantInt *v) : 413bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEV(ID, scConstant), V(v) {} 424950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner public: 434950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner ConstantInt *getValue() const { return V; } 444950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 454950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool isLoopInvariant(const Loop *L) const { 464950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return true; 474950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 484950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 494950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool hasComputableLoopEvolution(const Loop *L) const { 504950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return false; // Not loop variant 514950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 524950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 534950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const Type *getType() const; 544950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 55fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman virtual bool hasOperand(const SCEV *) const { 56fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman return false; 57afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner } 58afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner 595a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng bool dominates(BasicBlock *BB, DominatorTree *DT) const { 605a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng return true; 615a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng } 625a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng 636e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman bool properlyDominates(BasicBlock *BB, DominatorTree *DT) const { 646e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman return true; 656e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman } 666e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman 67b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 684950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 694950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 704950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVConstant *S) { return true; } 714950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 724950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scConstant; 734950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 744950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 754950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 764950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 7784923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman /// SCEVCastExpr - This is the base class for unary cast operator classes. 784950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 7984923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman class SCEVCastExpr : public SCEV { 8084923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman protected: 810bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *Op; 824950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner const Type *Ty; 8384923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman 843bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVCastExpr(const FoldingSetNodeIDRef ID, 85c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman unsigned SCEVTy, const SCEV *op, const Type *ty); 8684923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman 874950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner public: 880bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getOperand() const { return Op; } 894950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const Type *getType() const { return Ty; } 909769ab22265b313171d201b5928688524a01bd87Misha Brukman 914950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool isLoopInvariant(const Loop *L) const { 924950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return Op->isLoopInvariant(L); 934950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 944950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 954950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool hasComputableLoopEvolution(const Loop *L) const { 964950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return Op->hasComputableLoopEvolution(L); 974950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 984950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 99fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman virtual bool hasOperand(const SCEV *O) const { 100fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman return Op == O || Op->hasOperand(O); 101fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman } 102fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman 10384923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman virtual bool dominates(BasicBlock *BB, DominatorTree *DT) const; 10484923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman 1056e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman virtual bool properlyDominates(BasicBlock *BB, DominatorTree *DT) const; 1066e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman 10784923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman /// Methods for support type inquiry through isa, cast, and dyn_cast: 10884923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman static inline bool classof(const SCEVCastExpr *S) { return true; } 10984923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman static inline bool classof(const SCEV *S) { 11084923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman return S->getSCEVType() == scTruncate || 11184923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman S->getSCEVType() == scZeroExtend || 11284923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman S->getSCEVType() == scSignExtend; 11384923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman } 11484923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman }; 11584923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman 11684923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman //===--------------------------------------------------------------------===// 11784923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman /// SCEVTruncateExpr - This class represents a truncation of an integer value 11884923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman /// to a smaller integer value. 11984923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman /// 12084923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman class SCEVTruncateExpr : public SCEVCastExpr { 12184923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman friend class ScalarEvolution; 12284923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman 1233bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVTruncateExpr(const FoldingSetNodeIDRef ID, 124c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman const SCEV *op, const Type *ty); 12584923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman 12684923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman public: 127b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 1284950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 1294950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 1304950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVTruncateExpr *S) { return true; } 1314950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 1324950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scTruncate; 1334950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 1344950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 1354950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 1364950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 1374950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// SCEVZeroExtendExpr - This class represents a zero extension of a small 1384950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// integer value to a larger integer value. 1394950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 14084923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman class SCEVZeroExtendExpr : public SCEVCastExpr { 141246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 142246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 1433bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID, 144c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman const SCEV *op, const Type *ty); 1454950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 14684923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman public: 147b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 1484950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 1494950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 1504950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVZeroExtendExpr *S) { return true; } 1514950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 1524950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scZeroExtend; 1534950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 1544950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 1554950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 156d19534add90a2a894af61523b830887097bb780bDan Gohman //===--------------------------------------------------------------------===// 157d19534add90a2a894af61523b830887097bb780bDan Gohman /// SCEVSignExtendExpr - This class represents a sign extension of a small 158d19534add90a2a894af61523b830887097bb780bDan Gohman /// integer value to a larger integer value. 159d19534add90a2a894af61523b830887097bb780bDan Gohman /// 16084923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman class SCEVSignExtendExpr : public SCEVCastExpr { 161246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 162246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 1633bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVSignExtendExpr(const FoldingSetNodeIDRef ID, 164c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman const SCEV *op, const Type *ty); 165d19534add90a2a894af61523b830887097bb780bDan Gohman 16684923602fdc2a81957e5dee178d5737ad8e72f55Dan Gohman public: 167b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 168d19534add90a2a894af61523b830887097bb780bDan Gohman 169d19534add90a2a894af61523b830887097bb780bDan Gohman /// Methods for support type inquiry through isa, cast, and dyn_cast: 170d19534add90a2a894af61523b830887097bb780bDan Gohman static inline bool classof(const SCEVSignExtendExpr *S) { return true; } 171d19534add90a2a894af61523b830887097bb780bDan Gohman static inline bool classof(const SCEV *S) { 172d19534add90a2a894af61523b830887097bb780bDan Gohman return S->getSCEVType() == scSignExtend; 173d19534add90a2a894af61523b830887097bb780bDan Gohman } 174d19534add90a2a894af61523b830887097bb780bDan Gohman }; 175d19534add90a2a894af61523b830887097bb780bDan Gohman 1764950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 177d9480d0f6875d8aa3a0d91942d24f0ee416b1ff1Dan Gohman //===--------------------------------------------------------------------===// 178d9480d0f6875d8aa3a0d91942d24f0ee416b1ff1Dan Gohman /// SCEVNAryExpr - This node is a base class providing common 179d9480d0f6875d8aa3a0d91942d24f0ee416b1ff1Dan Gohman /// functionality for n'ary operators. 180d9480d0f6875d8aa3a0d91942d24f0ee416b1ff1Dan Gohman /// 181ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman class SCEVNAryExpr : public SCEV { 182ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman protected: 183f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman // Since SCEVs are immutable, ScalarEvolution allocates operand 184f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman // arrays with its SCEVAllocator, so this class just needs a simple 185f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman // pointer rather than a more elaborate vector-like data structure. 186f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman // This also avoids the need for a non-trivial destructor. 187f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman const SCEV *const *Operands; 188f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman size_t NumOperands; 1894950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 1903bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVNAryExpr(const FoldingSetNodeIDRef ID, 191f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman enum SCEVTypes T, const SCEV *const *O, size_t N) 1923bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEV(ID, T), Operands(O), NumOperands(N) {} 1934950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 1944950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner public: 195f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman size_t getNumOperands() const { return NumOperands; } 1960bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getOperand(unsigned i) const { 197f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman assert(i < NumOperands && "Operand index out of range!"); 1984950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return Operands[i]; 1994950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 2004950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 201f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman typedef const SCEV *const *op_iterator; 202f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman op_iterator op_begin() const { return Operands; } 203f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman op_iterator op_end() const { return Operands + NumOperands; } 2044950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2052f199f9952b9dd62b5a0d0f4350b8fa780ebb9ccDan Gohman virtual bool isLoopInvariant(const Loop *L) const; 2064950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 20739592233304acbbeea8c53bac2b6a822a63a4c4bDan Gohman // hasComputableLoopEvolution - N-ary expressions have computable loop 208803513b364e27d303285d396fd8ee5b32149962aChris Lattner // evolutions iff they have at least one operand that varies with the loop, 209803513b364e27d303285d396fd8ee5b32149962aChris Lattner // but that all varying operands are computable. 2102f199f9952b9dd62b5a0d0f4350b8fa780ebb9ccDan Gohman virtual bool hasComputableLoopEvolution(const Loop *L) const; 2114950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2122f199f9952b9dd62b5a0d0f4350b8fa780ebb9ccDan Gohman virtual bool hasOperand(const SCEV *O) const; 213fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman 214ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman bool dominates(BasicBlock *BB, DominatorTree *DT) const; 215ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman 2166e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman bool properlyDominates(BasicBlock *BB, DominatorTree *DT) const; 2176e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman 218ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman virtual const Type *getType() const { return getOperand(0)->getType(); } 219ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman 2203645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman bool hasNoUnsignedWrap() const { return SubclassData & (1 << 0); } 2213645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman void setHasNoUnsignedWrap(bool B) { 2223645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman SubclassData = (SubclassData & ~(1 << 0)) | (B << 0); 2233645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman } 2243645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman bool hasNoSignedWrap() const { return SubclassData & (1 << 1); } 2253645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman void setHasNoSignedWrap(bool B) { 2263645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman SubclassData = (SubclassData & ~(1 << 1)) | (B << 1); 2273645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman } 2283645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman 229ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman /// Methods for support type inquiry through isa, cast, and dyn_cast: 230ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman static inline bool classof(const SCEVNAryExpr *S) { return true; } 231ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman static inline bool classof(const SCEV *S) { 232ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman return S->getSCEVType() == scAddExpr || 233ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman S->getSCEVType() == scMulExpr || 234ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman S->getSCEVType() == scSMaxExpr || 235ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman S->getSCEVType() == scUMaxExpr || 236ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman S->getSCEVType() == scAddRecExpr; 237ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman } 238ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman }; 239ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman 240ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman //===--------------------------------------------------------------------===// 241ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman /// SCEVCommutativeExpr - This node is the base class for n'ary commutative 242ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman /// operators. 243ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman /// 244ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman class SCEVCommutativeExpr : public SCEVNAryExpr { 245ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman protected: 2463bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVCommutativeExpr(const FoldingSetNodeIDRef ID, 247c93b4cff89d85a13d4eaf1551af9fab276b88450Dan Gohman enum SCEVTypes T, const SCEV *const *O, size_t N) 2483bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEVNAryExpr(ID, T, O, N) {} 249ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman 250ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman public: 2514950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const char *getOperationStr() const = 0; 2524950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 253b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 2544950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2554950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 2564950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVCommutativeExpr *S) { return true; } 2574950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 2584950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scAddExpr || 259c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky S->getSCEVType() == scMulExpr || 2603e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky S->getSCEVType() == scSMaxExpr || 2613e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky S->getSCEVType() == scUMaxExpr; 2624950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 2634950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 2644950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2654950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2664950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 2674950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// SCEVAddExpr - This node represents an addition of some number of SCEVs. 2684950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 2694950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner class SCEVAddExpr : public SCEVCommutativeExpr { 270246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 271246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 2723bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVAddExpr(const FoldingSetNodeIDRef ID, 273f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman const SCEV *const *O, size_t N) 2743bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEVCommutativeExpr(ID, scAddExpr, O, N) { 2754950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 2764950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2774950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner public: 2784950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const char *getOperationStr() const { return " + "; } 2794950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2802b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman virtual const Type *getType() const { 2812b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman // Use the type of the last operand, which is likely to be a pointer 2822b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman // type, if there is one. This doesn't usually matter, but it can help 2832b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman // reduce casts when the expressions are expanded. 2842b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman return getOperand(getNumOperands() - 1)->getType(); 2852b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman } 2862b98bd23cb0bfa0dc09e1bcaef83a0e606e6ec1aDan Gohman 2874950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 2884950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVAddExpr *S) { return true; } 2894950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 2904950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scAddExpr; 2914950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 2924950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 2934950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 2944950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 2954950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// SCEVMulExpr - This node represents multiplication of some number of SCEVs. 2964950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 2974950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner class SCEVMulExpr : public SCEVCommutativeExpr { 298246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 299246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 3003bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVMulExpr(const FoldingSetNodeIDRef ID, 301f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman const SCEV *const *O, size_t N) 3023bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEVCommutativeExpr(ID, scMulExpr, O, N) { 3034950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3044950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3054950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner public: 3064950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const char *getOperationStr() const { return " * "; } 3074950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3084950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 3094950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVMulExpr *S) { return true; } 3104950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 3114950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scMulExpr; 3124950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3134950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 3144950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3154950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3164950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 317e3320a1bcce3f6653e109cc86ee1011b0a61d808Wojciech Matyjewicz /// SCEVUDivExpr - This class represents a binary unsigned division operation. 3184950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 319e3320a1bcce3f6653e109cc86ee1011b0a61d808Wojciech Matyjewicz class SCEVUDivExpr : public SCEV { 320246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 321246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 3220bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *LHS; 3230bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *RHS; 3243bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVUDivExpr(const FoldingSetNodeIDRef ID, const SCEV *lhs, const SCEV *rhs) 3253bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEV(ID, scUDivExpr), LHS(lhs), RHS(rhs) {} 3264950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3274950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner public: 3280bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getLHS() const { return LHS; } 3290bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getRHS() const { return RHS; } 3304950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3314950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool isLoopInvariant(const Loop *L) const { 3324950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return LHS->isLoopInvariant(L) && RHS->isLoopInvariant(L); 3334950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3344950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3354950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool hasComputableLoopEvolution(const Loop *L) const { 3364950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return LHS->hasComputableLoopEvolution(L) && 3374950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner RHS->hasComputableLoopEvolution(L); 3384950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3394950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 340fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman virtual bool hasOperand(const SCEV *O) const { 341fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman return O == LHS || O == RHS || LHS->hasOperand(O) || RHS->hasOperand(O); 342afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner } 343afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner 3445a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng bool dominates(BasicBlock *BB, DominatorTree *DT) const; 345afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner 3466e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman bool properlyDominates(BasicBlock *BB, DominatorTree *DT) const; 3476e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman 3484950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const Type *getType() const; 3494950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 350b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman void print(raw_ostream &OS) const; 3514950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3524950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 353e3320a1bcce3f6653e109cc86ee1011b0a61d808Wojciech Matyjewicz static inline bool classof(const SCEVUDivExpr *S) { return true; } 3544950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 355e3320a1bcce3f6653e109cc86ee1011b0a61d808Wojciech Matyjewicz return S->getSCEVType() == scUDivExpr; 3564950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3574950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 3584950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3594950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3604950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 3614950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// SCEVAddRecExpr - This node represents a polynomial recurrence on the trip 3621e59aa1332b67256dc0e76237eab7f6dd21a25b4Dan Gohman /// count of the specified loop. This is the primary focus of the 3631e59aa1332b67256dc0e76237eab7f6dd21a25b4Dan Gohman /// ScalarEvolution framework; all the other SCEV subclasses are mostly just 3641e59aa1332b67256dc0e76237eab7f6dd21a25b4Dan Gohman /// supporting infrastructure to allow SCEVAddRecExpr expressions to be 3651e59aa1332b67256dc0e76237eab7f6dd21a25b4Dan Gohman /// created and analyzed. 3664950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 3674950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// All operands of an AddRec are required to be loop invariant. 3684950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 369ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman class SCEVAddRecExpr : public SCEVNAryExpr { 370246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 371246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 3724950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner const Loop *L; 3734950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3743bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVAddRecExpr(const FoldingSetNodeIDRef ID, 375f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman const SCEV *const *O, size_t N, const Loop *l) 376203a7239ae928568fe7a34c03ead4b1b3133870eDan Gohman : SCEVNAryExpr(ID, scAddRecExpr, O, N), L(l) {} 3774950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 378ecb403a9d3a340009c266d05cfca2bd778c7b156Dan Gohman public: 3790bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getStart() const { return Operands[0]; } 3804950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner const Loop *getLoop() const { return L; } 3814950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3824950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// getStepRecurrence - This method constructs and returns the recurrence 3834950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// indicating how much this expression steps by. If this is a polynomial 3844950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// of degree N, it returns a chrec of degree N-1. 3850bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getStepRecurrence(ScalarEvolution &SE) const { 38617f1972c770dc18f5c7c3c95776b4d62ae9e121dDan Gohman if (isAffine()) return getOperand(1); 3870bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman return SE.getAddRecExpr(SmallVector<const SCEV *, 3>(op_begin()+1, 3880bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman op_end()), 389246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman getLoop()); 3904950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3914950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3924950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool hasComputableLoopEvolution(const Loop *QL) const { 393c056baed8704bd715ee58e5dfe724c255e68abbdDan Gohman return L == QL; 3944950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 3954950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 3964950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool isLoopInvariant(const Loop *QueryLoop) const; 3974950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 39839125d8ef94cbadccd7339d3344e114dedaab12cDan Gohman bool dominates(BasicBlock *BB, DominatorTree *DT) const; 39939125d8ef94cbadccd7339d3344e114dedaab12cDan Gohman 40039125d8ef94cbadccd7339d3344e114dedaab12cDan Gohman bool properlyDominates(BasicBlock *BB, DominatorTree *DT) const; 40139125d8ef94cbadccd7339d3344e114dedaab12cDan Gohman 4024950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// isAffine - Return true if this is an affine AddRec (i.e., it represents 4034950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// an expressions A+B*x where A and B are loop invariant values. 4044950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner bool isAffine() const { 4054950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner // We know that the start value is invariant. This expression is thus 4064950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner // affine iff the step is also invariant. 4074950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return getNumOperands() == 2; 4084950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 4094950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 4104950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// isQuadratic - Return true if this is an quadratic AddRec (i.e., it 4114950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// represents an expressions A+B*x+C*x^2 where A, B and C are loop 4124950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// invariant values. This corresponds to an addrec of the form {L,+,M,+,N} 4134950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner bool isQuadratic() const { 4144950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return getNumOperands() == 3; 4154950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 4164950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 4174950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// evaluateAtIteration - Return the value of this chain of recurrences at 4184950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// the specified iteration number. 4190bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *evaluateAtIteration(const SCEV *It, ScalarEvolution &SE) const; 4204950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 4214950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// getNumIterationsInRange - Return the number of iterations of this loop 4224950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// that produce values in the specified constant range. Another way of 4234950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// looking at this is that it returns the first iteration number where the 4244950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// value is not in the condition, thus computing the exit count. If the 4254950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// iteration count can't be computed, an instance of SCEVCouldNotCompute is 426eefdebe002ede066bf80859e72aec831cfd1d92dNick Lewycky /// returned. 4270bba49cebc50c7bd4662a4807bcb3ee7f42cb470Dan Gohman const SCEV *getNumIterationsInRange(ConstantRange Range, 428246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman ScalarEvolution &SE) const; 4294950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 430c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman /// getPostIncExpr - Return an expression representing the value of 431c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman /// this expression one iteration of the loop ahead. 432fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman const SCEVAddRecExpr *getPostIncExpr(ScalarEvolution &SE) const { 433fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman return cast<SCEVAddRecExpr>(SE.getAddExpr(this, getStepRecurrence(SE))); 434c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman } 435c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman 436b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 4374950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 4384950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 4394950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVAddRecExpr *S) { return true; } 4404950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 4414950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scAddRecExpr; 4424950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 4434950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 4444950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 445c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky 446c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky //===--------------------------------------------------------------------===// 447c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky /// SCEVSMaxExpr - This class represents a signed maximum selection. 448c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky /// 449c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky class SCEVSMaxExpr : public SCEVCommutativeExpr { 450c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky friend class ScalarEvolution; 451c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky 4523bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVSMaxExpr(const FoldingSetNodeIDRef ID, 453f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman const SCEV *const *O, size_t N) 4543bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEVCommutativeExpr(ID, scSMaxExpr, O, N) { 4553645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman // Max never overflows. 4563645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman setHasNoUnsignedWrap(true); 4573645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman setHasNoSignedWrap(true); 458c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky } 459c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky 460c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky public: 461c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky virtual const char *getOperationStr() const { return " smax "; } 462c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky 463c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky /// Methods for support type inquiry through isa, cast, and dyn_cast: 464c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky static inline bool classof(const SCEVSMaxExpr *S) { return true; } 465c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky static inline bool classof(const SCEV *S) { 466c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky return S->getSCEVType() == scSMaxExpr; 467c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky } 468c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky }; 469c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky 470c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky 4714950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner //===--------------------------------------------------------------------===// 4723e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky /// SCEVUMaxExpr - This class represents an unsigned maximum selection. 4733e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky /// 4743e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky class SCEVUMaxExpr : public SCEVCommutativeExpr { 4753e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky friend class ScalarEvolution; 4763e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky 4773bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman SCEVUMaxExpr(const FoldingSetNodeIDRef ID, 478f9e64729afec646fe93b51417e66e552e8e630a4Dan Gohman const SCEV *const *O, size_t N) 4793bf63768e574a2065de1aebba12f6c2e80f4fb16Dan Gohman : SCEVCommutativeExpr(ID, scUMaxExpr, O, N) { 4803645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman // Max never overflows. 4813645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman setHasNoUnsignedWrap(true); 4823645b01002e7ac244c1f3d163e5e350df21d869dDan Gohman setHasNoSignedWrap(true); 4833e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky } 4843e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky 4853e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky public: 4863e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky virtual const char *getOperationStr() const { return " umax "; } 4873e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky 4883e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky /// Methods for support type inquiry through isa, cast, and dyn_cast: 4893e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky static inline bool classof(const SCEVUMaxExpr *S) { return true; } 4903e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky static inline bool classof(const SCEV *S) { 4913e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky return S->getSCEVType() == scUMaxExpr; 4923e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky } 4933e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky }; 4943e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky 495c40f17b08774c2dcc5787fd83241e3c64ba82974Dan Gohman //===--------------------------------------------------------------------===// 4964950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// SCEVUnknown - This means that we are dealing with an entirely unknown SCEV 49775144f93eb7e4dbf22d308d21581ae255dd520c6Dan Gohman /// value, and only represent it as its LLVM Value. This is the "bottom" 4984950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// value for the analysis. 4994950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// 500ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman class SCEVUnknown : public SCEV, private CallbackVH { 501246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman friend class ScalarEvolution; 502246b2564d3bbbafe06ebf6a67745cd24141b5cb4Dan Gohman 503ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman // Implement CallbackVH. 504ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman virtual void deleted(); 505ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman virtual void allUsesReplacedWith(Value *New); 506ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman 507ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman /// SE - The parent ScalarEvolution value. This is used to update 508ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman /// the parent's maps when the value associated with a SCEVUnknown 509ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman /// is deleted or RAUW'd. 510ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman ScalarEvolution *SE; 511ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman 512ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman /// Next - The next pointer in the linked list of all 513ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman /// SCEVUnknown instances owned by a ScalarEvolution. 514ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman SCEVUnknown *Next; 515ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman 516ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman SCEVUnknown(const FoldingSetNodeIDRef ID, Value *V, 517ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman ScalarEvolution *se, SCEVUnknown *next) : 518ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman SCEV(ID, scUnknown), CallbackVH(V), SE(se), Next(next) {} 5191c34375f79b7786351c27ae45f0412cfdfa004edDan Gohman 520c050fd94c29e31414591e3a18aa20049e6b3a84fDan Gohman public: 521ab37f50838350e1104579fbd1f7c8820473485a5Dan Gohman Value *getValue() const { return getValPtr(); } 5224950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 5230f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman /// isSizeOf, isAlignOf, isOffsetOf - Test whether this is a special 5240f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman /// constant representing a type size, alignment, or field offset in 5250f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman /// a target-independent manner, and hasn't happened to have been 5260f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman /// folded with other operations into something unrecognizable. This 5270f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman /// is mainly only useful for pretty-printing and other situations 5280f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman /// where it isn't absolutely required for these to succeed. 5290f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman bool isSizeOf(const Type *&AllocTy) const; 5300f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman bool isAlignOf(const Type *&AllocTy) const; 5314f8eea82d8967cffa85b9df6c9255717b059009eDan Gohman bool isOffsetOf(const Type *&STy, Constant *&FieldNo) const; 5320f5efe56258f8cd6ceff4d7955a5d80144cd9cb0Dan Gohman 5334950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool isLoopInvariant(const Loop *L) const; 5344950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual bool hasComputableLoopEvolution(const Loop *QL) const { 5354950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return false; // not computable 5364950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 5374950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 538fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman virtual bool hasOperand(const SCEV *) const { 539fef8bb24de86ff41d09a7787c6c52b058a853e39Dan Gohman return false; 540afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner } 541afc0dc7184cf73ff7ac64e516284fbe0c7023ba4Chris Lattner 5425a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng bool dominates(BasicBlock *BB, DominatorTree *DT) const; 5435a6c1a840ad343c0ed2fa54a0edb50b61f828f0fEvan Cheng 5446e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman bool properlyDominates(BasicBlock *BB, DominatorTree *DT) const; 5456e70e31810464289a9e9b37e0345847e3ca5d5cfDan Gohman 5464950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner virtual const Type *getType() const; 5474950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 548b7ef72963b2215ca23c27fa8ea777bada06994d0Dan Gohman virtual void print(raw_ostream &OS) const; 5494950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 5504950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner /// Methods for support type inquiry through isa, cast, and dyn_cast: 5514950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEVUnknown *S) { return true; } 5524950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner static inline bool classof(const SCEV *S) { 5534950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner return S->getSCEVType() == scUnknown; 5544950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner } 5554950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner }; 5562cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner 5572cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner /// SCEVVisitor - This class defines a simple visitor class that may be used 5582cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner /// for various SCEV analysis purposes. 5592cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner template<typename SC, typename RetVal=void> 5602cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner struct SCEVVisitor { 561890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman RetVal visit(const SCEV *S) { 5622cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner switch (S->getSCEVType()) { 5632cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scConstant: 564890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitConstant((const SCEVConstant*)S); 5652cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scTruncate: 566890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitTruncateExpr((const SCEVTruncateExpr*)S); 5672cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scZeroExtend: 568890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitZeroExtendExpr((const SCEVZeroExtendExpr*)S); 569d19534add90a2a894af61523b830887097bb780bDan Gohman case scSignExtend: 570890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitSignExtendExpr((const SCEVSignExtendExpr*)S); 5712cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scAddExpr: 572890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitAddExpr((const SCEVAddExpr*)S); 5732cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scMulExpr: 574890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitMulExpr((const SCEVMulExpr*)S); 575e3320a1bcce3f6653e109cc86ee1011b0a61d808Wojciech Matyjewicz case scUDivExpr: 576890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitUDivExpr((const SCEVUDivExpr*)S); 5772cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scAddRecExpr: 578890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitAddRecExpr((const SCEVAddRecExpr*)S); 579c54c561c9f7270c055dd7ba75a3a003b771a42d9Nick Lewycky case scSMaxExpr: 580890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitSMaxExpr((const SCEVSMaxExpr*)S); 5813e6307698084e7adfc10b739442ae29742beefd0Nick Lewycky case scUMaxExpr: 582890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitUMaxExpr((const SCEVUMaxExpr*)S); 5832cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scUnknown: 584890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitUnknown((const SCEVUnknown*)S); 5852cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner case scCouldNotCompute: 586890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman return ((SC*)this)->visitCouldNotCompute((const SCEVCouldNotCompute*)S); 5872cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner default: 588c23197a26f34f559ea9797de51e187087c039c42Torok Edwin llvm_unreachable("Unknown SCEV type!"); 5892cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner } 5902cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner } 5912cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner 592890f92b744fb074465bc2b7006ee753a181f62a4Dan Gohman RetVal visitCouldNotCompute(const SCEVCouldNotCompute *S) { 593c23197a26f34f559ea9797de51e187087c039c42Torok Edwin llvm_unreachable("Invalid use of SCEVCouldNotCompute!"); 5942cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner return RetVal(); 5952cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner } 5962cdf0a7a32f08674562b0cf6b071b96b36421f87Chris Lattner }; 5974950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner} 5984950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner 5994950e88e0fa7c44c0b54e2f64ddf57415ed83d40Chris Lattner#endif 600