include/llvm/Transforms/Utils/LoopVersioning.h

   1 //===- LoopVersioning.h - Utility to version a loop -------------*- 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 a utility class to perform loop versioning.  The versioned
  11 // loop speculates that otherwise may-aliasing memory accesses don't overlap and
  12 // emits checks to prove this.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_TRANSFORMS_UTILS_LOOPVERSIONING_H
  17 #define LLVM_TRANSFORMS_UTILS_LOOPVERSIONING_H
  18
  19 #include "llvm/Transforms/Utils/ValueMapper.h"
  20
  21 namespace llvm {
  22
  23 class Loop;
  24 class LoopAccessInfo;
  25 class LoopInfo;
  26
  27 /// \brief This class emits a version of the loop where run-time checks ensure
  28 /// that may-alias pointers can't overlap.
  29 ///
  30 /// It currently only supports single-exit loops and assumes that the loop
  31 /// already has a preheader.
  32 class LoopVersioning {
  33 public:
  34   LoopVersioning(SmallVector<RuntimePointerChecking::PointerCheck, 4> Checks,
  35                  const LoopAccessInfo &LAI, Loop *L, LoopInfo *LI,
  36                  DominatorTree *DT,
  37                  const SmallVector<int, 8> *PtrToPartition = nullptr);
  38
  39   /// \brief Returns true if we need memchecks to disambiguate may-aliasing
  40   /// accesses.
  41   bool needsRuntimeChecks() const;
  42
  43   /// \brief Performs the CFG manipulation part of versioning the loop including
  44   /// the DominatorTree and LoopInfo updates.
  45   ///
  46   /// The loop that was used to construct the class will be the "versioned" loop
  47   /// i.e. the loop that will receive control if all the memchecks pass.
  48   ///
  49   /// This allows the loop transform pass to operate on the same loop regardless
  50   /// of whether versioning was necessary or not:
  51   ///
  52   ///    for each loop L:
  53   ///        analyze L
  54   ///        if versioning is necessary version L
  55   ///        transform L
  56   void versionLoop(Pass *P);
  57
  58   /// \brief Adds the necessary PHI nodes for the versioned loops based on the
  59   /// loop-defined values used outside of the loop.
  60   ///
  61   /// This needs to be called after versionLoop if there are defs in the loop
  62   /// that are used outside the loop.  FIXME: this should be invoked internally
  63   /// by versionLoop and made private.
  64   void addPHINodes(const SmallVectorImpl<Instruction *> &DefsUsedOutside);
  65
  66   /// \brief Returns the versioned loop.  Control flows here if pointers in the
  67   /// loop don't alias (i.e. all memchecks passed).  (This loop is actually the
  68   /// same as the original loop that we got constructed with.)
  69   Loop *getVersionedLoop() { return VersionedLoop; }
  70
  71   /// \brief Returns the fall-back loop.  Control flows here if pointers in the
  72   /// loop may alias (i.e. one of the memchecks failed).
  73   Loop *getNonVersionedLoop() { return NonVersionedLoop; }
  74
  75 private:
  76   /// \brief The original loop.  This becomes the "versioned" one.  I.e.,
  77   /// control flows here if pointers in the loop don't alias.
  78   Loop *VersionedLoop;
  79   /// \brief The fall-back loop.  I.e. control flows here if pointers in the
  80   /// loop may alias (memchecks failed).
  81   Loop *NonVersionedLoop;
  82
  83   /// \brief For each memory pointer it contains the partitionId it is used in.
  84   /// If nullptr, no partitioning is used.
  85   ///
  86   /// The I-th entry corresponds to I-th entry in LAI.getRuntimePointerCheck().
  87   /// If the pointer is used in multiple partitions the entry is set to -1.
  88   const SmallVector<int, 8> *PtrToPartition;
  89
  90   /// \brief This maps the instructions from VersionedLoop to their counterpart
  91   /// in NonVersionedLoop.
  92   ValueToValueMapTy VMap;
  93
  94   /// \brief The set of checks that we are versioning for.
  95   SmallVector<RuntimePointerChecking::PointerCheck, 4> Checks;
  96
  97   /// \brief Analyses used.
  98   const LoopAccessInfo &LAI;
  99   LoopInfo *LI;
 100   DominatorTree *DT;
 101 };
 102 }
 103
 104 #endif