1 //===- llvm/Transforms/Utils/LoopUtils.h - Loop utilities -*- C++ -*-=========//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines some loop transformation utilities.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_TRANSFORMS_UTILS_LOOPUTILS_H
15 #define LLVM_TRANSFORMS_UTILS_LOOPUTILS_H
19 class AssumptionCache;
26 class ScalarEvolution;
28 BasicBlock *InsertPreheaderForLoop(Loop *L, Pass *P);
30 /// \brief Simplify each loop in a loop nest recursively.
32 /// This takes a potentially un-simplified loop L (and its children) and turns
33 /// it into a simplified loop nest with preheaders and single backedges. It
34 /// will optionally update \c AliasAnalysis and \c ScalarEvolution analyses if
36 bool simplifyLoop(Loop *L, DominatorTree *DT, LoopInfo *LI, Pass *PP,
37 AliasAnalysis *AA = nullptr, ScalarEvolution *SE = nullptr,
38 const DataLayout *DL = nullptr,
39 AssumptionCache *AC = nullptr);
41 /// \brief Put loop into LCSSA form.
43 /// Looks at all instructions in the loop which have uses outside of the
44 /// current loop. For each, an LCSSA PHI node is inserted and the uses outside
45 /// the loop are rewritten to use this node.
47 /// LoopInfo and DominatorTree are required and preserved.
49 /// If ScalarEvolution is passed in, it will be preserved.
51 /// Returns true if any modifications are made to the loop.
52 bool formLCSSA(Loop &L, DominatorTree &DT, LoopInfo *LI,
53 ScalarEvolution *SE = nullptr);
55 /// \brief Put a loop nest into LCSSA form.
57 /// This recursively forms LCSSA for a loop nest.
59 /// LoopInfo and DominatorTree are required and preserved.
61 /// If ScalarEvolution is passed in, it will be preserved.
63 /// Returns true if any modifications are made to the loop.
64 bool formLCSSARecursively(Loop &L, DominatorTree &DT, LoopInfo *LI,
65 ScalarEvolution *SE = nullptr);