include/llvm/Analysis/LoopAccessAnalysis.h

   1 //===- llvm/Analysis/LoopAccessAnalysis.h -----------------------*- 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 the interface for the loop memory dependence framework that
  11 // was originally developed for the Loop Vectorizer.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_LOOPACCESSANALYSIS_H
  16 #define LLVM_ANALYSIS_LOOPACCESSANALYSIS_H
  17
  18 #include "llvm/ADT/EquivalenceClasses.h"
  19 #include "llvm/ADT/SetVector.h"
  20 #include "llvm/Analysis/AliasAnalysis.h"
  21 #include "llvm/Analysis/AliasSetTracker.h"
  22 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  23 #include "llvm/IR/ValueHandle.h"
  24 #include "llvm/Support/raw_ostream.h"
  25
  26 namespace llvm {
  27
  28 class Value;
  29 class DataLayout;
  30 class AliasAnalysis;
  31 class ScalarEvolution;
  32 class Loop;
  33 class SCEV;
  34
  35 /// Optimization analysis message produced during vectorization. Messages inform
  36 /// the user why vectorization did not occur.
  37 class VectorizationReport {
  38   std::string Message;
  39   Instruction *Instr;
  40
  41 public:
  42   VectorizationReport(Instruction *I = nullptr)
  43       : Message("loop not vectorized: "), Instr(I) {}
  44
  45   template <typename A> VectorizationReport &operator<<(const A &Value) {
  46     raw_string_ostream Out(Message);
  47     Out << Value;
  48     return *this;
  49   }
  50
  51   Instruction *getInstr() { return Instr; }
  52
  53   std::string &str() { return Message; }
  54   operator Twine() { return Message; }
  55
  56   /// \brief Emit an analysis note with the debug location from the instruction
  57   /// in \p Message if available.  Otherwise use the location of \p TheLoop.
  58   static void emitAnalysis(VectorizationReport &Message,
  59                            const Function *TheFunction,
  60                            const Loop *TheLoop);
  61 };
  62
  63 /// \brief Collection of parameters shared beetween the Loop Vectorizer and the
  64 /// Loop Access Analysis.
  65 struct VectorizerParams {
  66   /// \brief Maximum SIMD width.
  67   static const unsigned MaxVectorWidth;
  68
  69   /// \brief VF as overridden by the user.
  70   static unsigned VectorizationFactor;
  71   /// \brief Interleave factor as overridden by the user.
  72   static unsigned VectorizationInterleave;
  73
  74   /// \\brief When performing memory disambiguation checks at runtime do not
  75   /// make more than this number of comparisons.
  76   static const unsigned RuntimeMemoryCheckThreshold;
  77 };
  78
  79 /// \brief Drive the analysis of memory accesses in the loop
  80 ///
  81 /// This class is responsible for analyzing the memory accesses of a loop.  It
  82 /// collects the accesses and then its main helper the AccessAnalysis class
  83 /// finds and categorizes the dependences in buildDependenceSets.
  84 ///
  85 /// For memory dependences that can be analyzed at compile time, it determines
  86 /// whether the dependence is part of cycle inhibiting vectorization.  This work
  87 /// is delegated to the MemoryDepChecker class.
  88 ///
  89 /// For memory dependences that cannot be determined at compile time, it
  90 /// generates run-time checks to prove independence.  This is done by
  91 /// AccessAnalysis::canCheckPtrAtRT and the checks are maintained by the
  92 /// RuntimePointerCheck class.
  93 class LoopAccessInfo {
  94 public:
  95   /// This struct holds information about the memory runtime legality check that
  96   /// a group of pointers do not overlap.
  97   struct RuntimePointerCheck {
  98     RuntimePointerCheck() : Need(false) {}
  99
 100     /// Reset the state of the pointer runtime information.
 101     void reset() {
 102       Need = false;
 103       Pointers.clear();
 104       Starts.clear();
 105       Ends.clear();
 106       IsWritePtr.clear();
 107       DependencySetId.clear();
 108       AliasSetId.clear();
 109     }
 110
 111     /// Insert a pointer and calculate the start and end SCEVs.
 112     void insert(ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr,
 113                 unsigned DepSetId, unsigned ASId, ValueToValueMap &Strides);
 114
 115     /// This flag indicates if we need to add the runtime check.
 116     bool Need;
 117     /// Holds the pointers that we need to check.
 118     SmallVector<TrackingVH<Value>, 2> Pointers;
 119     /// Holds the pointer value at the beginning of the loop.
 120     SmallVector<const SCEV*, 2> Starts;
 121     /// Holds the pointer value at the end of the loop.
 122     SmallVector<const SCEV*, 2> Ends;
 123     /// Holds the information if this pointer is used for writing to memory.
 124     SmallVector<bool, 2> IsWritePtr;
 125     /// Holds the id of the set of pointers that could be dependent because of a
 126     /// shared underlying object.
 127     SmallVector<unsigned, 2> DependencySetId;
 128     /// Holds the id of the disjoint alias set to which this pointer belongs.
 129     SmallVector<unsigned, 2> AliasSetId;
 130   };
 131
 132   LoopAccessInfo(Function *F, Loop *L, ScalarEvolution *SE,
 133                  const DataLayout *DL, const TargetLibraryInfo *TLI,
 134                  AliasAnalysis *AA, DominatorTree *DT) :
 135       TheFunction(F), TheLoop(L), SE(SE), DL(DL), TLI(TLI), AA(AA), DT(DT),
 136       NumLoads(0), NumStores(0), MaxSafeDepDistBytes(-1U) {}
 137
 138   /// Return true we can analyze the memory accesses in the loop and there are
 139   /// no memory dependence cycles.  Replaces symbolic strides using Strides.
 140   bool canVectorizeMemory(ValueToValueMap &Strides);
 141
 142   RuntimePointerCheck *getRuntimePointerCheck() { return &PtrRtCheck; }
 143
 144   /// Return true if the block BB needs to be predicated in order for the loop
 145   /// to be vectorized.
 146   bool blockNeedsPredication(BasicBlock *BB);
 147
 148   /// Returns true if the value V is uniform within the loop.
 149   bool isUniform(Value *V);
 150
 151   unsigned getMaxSafeDepDistBytes() const { return MaxSafeDepDistBytes; }
 152   unsigned getNumStores() const { return NumStores; }
 153   unsigned getNumLoads() const { return NumLoads;}
 154
 155   /// \brief Add code that checks at runtime if the accessed arrays overlap.
 156   ///
 157   /// Returns a pair of instructions where the first element is the first
 158   /// instruction generated in possibly a sequence of instructions and the
 159   /// second value is the final comparator value or NULL if no check is needed.
 160   std::pair<Instruction *, Instruction *> addRuntimeCheck(Instruction *Loc);
 161
 162 private:
 163   void emitAnalysis(VectorizationReport &Message);
 164
 165   /// We need to check that all of the pointers in this list are disjoint
 166   /// at runtime.
 167   RuntimePointerCheck PtrRtCheck;
 168   Function *TheFunction;
 169   Loop *TheLoop;
 170   ScalarEvolution *SE;
 171   const DataLayout *DL;
 172   const TargetLibraryInfo *TLI;
 173   AliasAnalysis *AA;
 174   DominatorTree *DT;
 175
 176   unsigned NumLoads;
 177   unsigned NumStores;
 178
 179   unsigned MaxSafeDepDistBytes;
 180 };
 181
 182 Value *stripIntegerCast(Value *V);
 183
 184 ///\brief Return the SCEV corresponding to a pointer with the symbolic stride
 185 ///replaced with constant one.
 186 ///
 187 /// If \p OrigPtr is not null, use it to look up the stride value instead of \p
 188 /// Ptr.  \p PtrToStride provides the mapping between the pointer value and its
 189 /// stride as collected by LoopVectorizationLegality::collectStridedAccess.
 190 const SCEV *replaceSymbolicStrideSCEV(ScalarEvolution *SE,
 191                                       ValueToValueMap &PtrToStride,
 192                                       Value *Ptr, Value *OrigPtr = nullptr);
 193
 194 } // End llvm namespace
 195
 196 #endif