include/llvm/Transforms/Utils/SimplifyIndVar.h

   1 //===-- llvm/Transforms/Utils/SimplifyIndVar.h - Indvar Utils ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines in interface for induction variable simplification. It does
  11 // not define any actual pass or policy, but provides a single function to
  12 // simplify a loop's induction variables based on ScalarEvolution.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_TRANSFORMS_UTILS_SIMPLIFYINDVAR_H
  17 #define LLVM_TRANSFORMS_UTILS_SIMPLIFYINDVAR_H
  18
  19 #include "llvm/Support/CommandLine.h"
  20 #include "llvm/Support/ValueHandle.h"
  21
  22 namespace llvm {
  23
  24 extern cl::opt<bool> DisableIVRewrite;
  25
  26 class CastInst;
  27 class IVUsers;
  28 class Loop;
  29 class LPPassManager;
  30 class PHINode;
  31 class ScalarEvolution;
  32
  33 /// Interface for visiting interesting IV users that are recognized but not
  34 /// simplified by this utility.
  35 class IVVisitor {
  36 public:
  37   virtual ~IVVisitor() {}
  38   virtual void visitCast(CastInst *Cast) = 0;
  39 };
  40
  41 /// simplifyUsersOfIV - Simplify instructions that use this induction variable
  42 /// by using ScalarEvolution to analyze the IV's recurrence.
  43 bool simplifyUsersOfIV(PHINode *CurrIV, ScalarEvolution *SE, LPPassManager *LPM,
  44                        SmallVectorImpl<WeakVH> &Dead, IVVisitor *V = NULL);
  45
  46 /// SimplifyLoopIVs - Simplify users of induction variables within this
  47 /// loop. This does not actually change or add IVs.
  48 bool simplifyLoopIVs(Loop *L, ScalarEvolution *SE, LPPassManager *LPM,
  49                      SmallVectorImpl<WeakVH> &Dead);
  50
  51 /// simplifyIVUsers - Simplify instructions recorded by the IVUsers pass.
  52 /// This is a legacy implementation to reproduce the behavior of the
  53 /// IndVarSimplify pass prior to DisableIVRewrite.
  54 bool simplifyIVUsers(IVUsers *IU, ScalarEvolution *SE, LPPassManager *LPM,
  55                      SmallVectorImpl<WeakVH> &Dead);
  56
  57 } // namespace llvm
  58
  59 #endif