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 Drive the analysis of memory accesses in the loop
  64 ///
  65 /// This class is responsible for analyzing the memory accesses of a loop.  It
  66 /// collects the accesses and then its main helper the AccessAnalysis class
  67 /// finds and categorizes the dependences in buildDependenceSets.
  68 ///
  69 /// For memory dependences that can be analyzed at compile time, it determines
  70 /// whether the dependence is part of cycle inhibiting vectorization.  This work
  71 /// is delegated to the MemoryDepChecker class.
  72 ///
  73 /// For memory dependences that cannot be determined at compile time, it
  74 /// generates run-time checks to prove independence.  This is done by
  75 /// AccessAnalysis::canCheckPtrAtRT and the checks are maintained by the
  76 /// RuntimePointerCheck class.
  77 class LoopAccessInfo {
  78 public:
  79   /// \brief Collection of parameters used from the vectorizer.
  80   struct VectorizerParams {
  81     /// \brief Maximum simd width.
  82     unsigned MaxVectorWidth;
  83
  84     /// \brief VF as overridden by the user.
  85     unsigned VectorizationFactor;
  86     /// \brief Interleave factor as overridden by the user.
  87     unsigned VectorizationInterleave;
  88
  89     /// \\brief When performing memory disambiguation checks at runtime do not
  90     /// make more than this number of comparisons.
  91     unsigned RuntimeMemoryCheckThreshold;
  92
  93     VectorizerParams(unsigned MaxVectorWidth,
  94                      unsigned VectorizationFactor,
  95                      unsigned VectorizationInterleave,
  96                      unsigned RuntimeMemoryCheckThreshold) :
  97         MaxVectorWidth(MaxVectorWidth),
  98         VectorizationFactor(VectorizationFactor),
  99         VectorizationInterleave(VectorizationInterleave),
 100         RuntimeMemoryCheckThreshold(RuntimeMemoryCheckThreshold) {}
 101   };
 102
 103   /// This struct holds information about the memory runtime legality check that
 104   /// a group of pointers do not overlap.
 105   struct RuntimePointerCheck {
 106     RuntimePointerCheck() : Need(false) {}
 107
 108     /// Reset the state of the pointer runtime information.
 109     void reset() {
 110       Need = false;
 111       Pointers.clear();
 112       Starts.clear();
 113       Ends.clear();
 114       IsWritePtr.clear();
 115       DependencySetId.clear();
 116       AliasSetId.clear();
 117     }
 118
 119     /// Insert a pointer and calculate the start and end SCEVs.
 120     void insert(ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr,
 121                 unsigned DepSetId, unsigned ASId, ValueToValueMap &Strides);
 122
 123     /// This flag indicates if we need to add the runtime check.
 124     bool Need;
 125     /// Holds the pointers that we need to check.
 126     SmallVector<TrackingVH<Value>, 2> Pointers;
 127     /// Holds the pointer value at the beginning of the loop.
 128     SmallVector<const SCEV*, 2> Starts;
 129     /// Holds the pointer value at the end of the loop.
 130     SmallVector<const SCEV*, 2> Ends;
 131     /// Holds the information if this pointer is used for writing to memory.
 132     SmallVector<bool, 2> IsWritePtr;
 133     /// Holds the id of the set of pointers that could be dependent because of a
 134     /// shared underlying object.
 135     SmallVector<unsigned, 2> DependencySetId;
 136     /// Holds the id of the disjoint alias set to which this pointer belongs.
 137     SmallVector<unsigned, 2> AliasSetId;
 138   };
 139
 140   LoopAccessInfo(Function *F, Loop *L, ScalarEvolution *SE,
 141                  const DataLayout *DL, const TargetLibraryInfo *TLI,
 142                  AliasAnalysis *AA, DominatorTree *DT,
 143                  const VectorizerParams &VectParams) :
 144       TheFunction(F), TheLoop(L), SE(SE), DL(DL), TLI(TLI), AA(AA), DT(DT),
 145       NumLoads(0), NumStores(0), MaxSafeDepDistBytes(-1U),
 146       VectParams(VectParams) {}
 147
 148   /// Return true we can analyze the memory accesses in the loop and there are
 149   /// no memory dependence cycles.  Replaces symbolic strides using Strides.
 150   bool canVectorizeMemory(ValueToValueMap &Strides);
 151
 152   RuntimePointerCheck *getRuntimePointerCheck() { return &PtrRtCheck; }
 153
 154   /// Return true if the block BB needs to be predicated in order for the loop
 155   /// to be vectorized.
 156   bool blockNeedsPredication(BasicBlock *BB);
 157
 158   /// Returns true if the value V is uniform within the loop.
 159   bool isUniform(Value *V);
 160
 161   unsigned getMaxSafeDepDistBytes() const { return MaxSafeDepDistBytes; }
 162   unsigned getNumStores() const { return NumStores; }
 163   unsigned getNumLoads() const { return NumLoads;}
 164
 165   /// \brief Add code that checks at runtime if the accessed arrays overlap.
 166   ///
 167   /// Returns a pair of instructions where the first element is the first
 168   /// instruction generated in possibly a sequence of instructions and the
 169   /// second value is the final comparator value or NULL if no check is needed.
 170   std::pair<Instruction *, Instruction *> addRuntimeCheck(Instruction *Loc);
 171
 172 private:
 173   void emitAnalysis(VectorizationReport &Message);
 174
 175   /// We need to check that all of the pointers in this list are disjoint
 176   /// at runtime.
 177   RuntimePointerCheck PtrRtCheck;
 178   Function *TheFunction;
 179   Loop *TheLoop;
 180   ScalarEvolution *SE;
 181   const DataLayout *DL;
 182   const TargetLibraryInfo *TLI;
 183   AliasAnalysis *AA;
 184   DominatorTree *DT;
 185
 186   unsigned NumLoads;
 187   unsigned NumStores;
 188
 189   unsigned MaxSafeDepDistBytes;
 190
 191   /// \brief Vectorizer parameters used by the analysis.
 192   VectorizerParams VectParams;
 193 };
 194
 195 Value *stripIntegerCast(Value *V);
 196
 197 ///\brief Return the SCEV corresponding to a pointer with the symbolic stride
 198 ///replaced with constant one.
 199 ///
 200 /// If \p OrigPtr is not null, use it to look up the stride value instead of \p
 201 /// Ptr.  \p PtrToStride provides the mapping between the pointer value and its
 202 /// stride as collected by LoopVectorizationLegality::collectStridedAccess.
 203 const SCEV *replaceSymbolicStrideSCEV(ScalarEvolution *SE,
 204                                       ValueToValueMap &PtrToStride,
 205                                       Value *Ptr, Value *OrigPtr = nullptr);
 206
 207 } // End llvm namespace
 208
 209 #endif