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/Optional.h"
  20 #include "llvm/ADT/SetVector.h"
  21 #include "llvm/Analysis/AliasAnalysis.h"
  22 #include "llvm/Analysis/AliasSetTracker.h"
  23 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  24 #include "llvm/IR/ValueHandle.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/Support/raw_ostream.h"
  27
  28 namespace llvm {
  29
  30 class Value;
  31 class DataLayout;
  32 class AliasAnalysis;
  33 class ScalarEvolution;
  34 class Loop;
  35 class SCEV;
  36
  37 /// Optimization analysis message produced during vectorization. Messages inform
  38 /// the user why vectorization did not occur.
  39 class LoopAccessReport {
  40   std::string Message;
  41   const Instruction *Instr;
  42
  43 protected:
  44   LoopAccessReport(const Twine &Message, const Instruction *I)
  45       : Message(Message.str()), Instr(I) {}
  46
  47 public:
  48   LoopAccessReport(const Instruction *I = nullptr) : Instr(I) {}
  49
  50   template <typename A> LoopAccessReport &operator<<(const A &Value) {
  51     raw_string_ostream Out(Message);
  52     Out << Value;
  53     return *this;
  54   }
  55
  56   const Instruction *getInstr() const { return Instr; }
  57
  58   std::string &str() { return Message; }
  59   const std::string &str() const { return Message; }
  60   operator Twine() { return Message; }
  61
  62   /// \brief Emit an analysis note for \p PassName with the debug location from
  63   /// the instruction in \p Message if available.  Otherwise use the location of
  64   /// \p TheLoop.
  65   static void emitAnalysis(const LoopAccessReport &Message,
  66                            const Function *TheFunction,
  67                            const Loop *TheLoop,
  68                            const char *PassName);
  69 };
  70
  71 /// \brief Collection of parameters shared beetween the Loop Vectorizer and the
  72 /// Loop Access Analysis.
  73 struct VectorizerParams {
  74   /// \brief Maximum SIMD width.
  75   static const unsigned MaxVectorWidth;
  76
  77   /// \brief VF as overridden by the user.
  78   static unsigned VectorizationFactor;
  79   /// \brief Interleave factor as overridden by the user.
  80   static unsigned VectorizationInterleave;
  81   /// \brief True if force-vector-interleave was specified by the user.
  82   static bool isInterleaveForced();
  83
  84   /// \\brief When performing memory disambiguation checks at runtime do not
  85   /// make more than this number of comparisons.
  86   static unsigned RuntimeMemoryCheckThreshold;
  87 };
  88
  89 /// \brief Checks memory dependences among accesses to the same underlying
  90 /// object to determine whether there vectorization is legal or not (and at
  91 /// which vectorization factor).
  92 ///
  93 /// Note: This class will compute a conservative dependence for access to
  94 /// different underlying pointers. Clients, such as the loop vectorizer, will
  95 /// sometimes deal these potential dependencies by emitting runtime checks.
  96 ///
  97 /// We use the ScalarEvolution framework to symbolically evalutate access
  98 /// functions pairs. Since we currently don't restructure the loop we can rely
  99 /// on the program order of memory accesses to determine their safety.
 100 /// At the moment we will only deem accesses as safe for:
 101 ///  * A negative constant distance assuming program order.
 102 ///
 103 ///      Safe: tmp = a[i + 1];     OR     a[i + 1] = x;
 104 ///            a[i] = tmp;                y = a[i];
 105 ///
 106 ///   The latter case is safe because later checks guarantuee that there can't
 107 ///   be a cycle through a phi node (that is, we check that "x" and "y" is not
 108 ///   the same variable: a header phi can only be an induction or a reduction, a
 109 ///   reduction can't have a memory sink, an induction can't have a memory
 110 ///   source). This is important and must not be violated (or we have to
 111 ///   resort to checking for cycles through memory).
 112 ///
 113 ///  * A positive constant distance assuming program order that is bigger
 114 ///    than the biggest memory access.
 115 ///
 116 ///     tmp = a[i]        OR              b[i] = x
 117 ///     a[i+2] = tmp                      y = b[i+2];
 118 ///
 119 ///     Safe distance: 2 x sizeof(a[0]), and 2 x sizeof(b[0]), respectively.
 120 ///
 121 ///  * Zero distances and all accesses have the same size.
 122 ///
 123 class MemoryDepChecker {
 124 public:
 125   typedef PointerIntPair<Value *, 1, bool> MemAccessInfo;
 126   typedef SmallPtrSet<MemAccessInfo, 8> MemAccessInfoSet;
 127   /// \brief Set of potential dependent memory accesses.
 128   typedef EquivalenceClasses<MemAccessInfo> DepCandidates;
 129
 130   /// \brief Dependece between memory access instructions.
 131   struct Dependence {
 132     /// \brief The type of the dependence.
 133     enum DepType {
 134       // No dependence.
 135       NoDep,
 136       // We couldn't determine the direction or the distance.
 137       Unknown,
 138       // Lexically forward.
 139       Forward,
 140       // Forward, but if vectorized, is likely to prevent store-to-load
 141       // forwarding.
 142       ForwardButPreventsForwarding,
 143       // Lexically backward.
 144       Backward,
 145       // Backward, but the distance allows a vectorization factor of
 146       // MaxSafeDepDistBytes.
 147       BackwardVectorizable,
 148       // Same, but may prevent store-to-load forwarding.
 149       BackwardVectorizableButPreventsForwarding
 150     };
 151
 152     /// \brief String version of the types.
 153     static const char *DepName[];
 154
 155     /// \brief Index of the source of the dependence in the InstMap vector.
 156     unsigned Source;
 157     /// \brief Index of the destination of the dependence in the InstMap vector.
 158     unsigned Destination;
 159     /// \brief The type of the dependence.
 160     DepType Type;
 161
 162     Dependence(unsigned Source, unsigned Destination, DepType Type)
 163         : Source(Source), Destination(Destination), Type(Type) {}
 164
 165     /// \brief Dependence types that don't prevent vectorization.
 166     static bool isSafeForVectorization(DepType Type);
 167
 168     /// \brief Dependence types that can be queried from the analysis.
 169     static bool isInterestingDependence(DepType Type);
 170
 171     /// \brief Lexically backward dependence types.
 172     bool isPossiblyBackward() const;
 173
 174     /// \brief Print the dependence.  \p Instr is used to map the instruction
 175     /// indices to instructions.
 176     void print(raw_ostream &OS, unsigned Depth,
 177                const SmallVectorImpl<Instruction *> &Instrs) const;
 178   };
 179
 180   MemoryDepChecker(ScalarEvolution *Se, const Loop *L)
 181       : SE(Se), InnermostLoop(L), AccessIdx(0),
 182         ShouldRetryWithRuntimeCheck(false), SafeForVectorization(true),
 183         RecordInterestingDependences(true) {}
 184
 185   /// \brief Register the location (instructions are given increasing numbers)
 186   /// of a write access.
 187   void addAccess(StoreInst *SI) {
 188     Value *Ptr = SI->getPointerOperand();
 189     Accesses[MemAccessInfo(Ptr, true)].push_back(AccessIdx);
 190     InstMap.push_back(SI);
 191     ++AccessIdx;
 192   }
 193
 194   /// \brief Register the location (instructions are given increasing numbers)
 195   /// of a write access.
 196   void addAccess(LoadInst *LI) {
 197     Value *Ptr = LI->getPointerOperand();
 198     Accesses[MemAccessInfo(Ptr, false)].push_back(AccessIdx);
 199     InstMap.push_back(LI);
 200     ++AccessIdx;
 201   }
 202
 203   /// \brief Check whether the dependencies between the accesses are safe.
 204   ///
 205   /// Only checks sets with elements in \p CheckDeps.
 206   bool areDepsSafe(DepCandidates &AccessSets, MemAccessInfoSet &CheckDeps,
 207                    const ValueToValueMap &Strides);
 208
 209   /// \brief No memory dependence was encountered that would inhibit
 210   /// vectorization.
 211   bool isSafeForVectorization() const { return SafeForVectorization; }
 212
 213   /// \brief The maximum number of bytes of a vector register we can vectorize
 214   /// the accesses safely with.
 215   unsigned getMaxSafeDepDistBytes() { return MaxSafeDepDistBytes; }
 216
 217   /// \brief In same cases when the dependency check fails we can still
 218   /// vectorize the loop with a dynamic array access check.
 219   bool shouldRetryWithRuntimeCheck() { return ShouldRetryWithRuntimeCheck; }
 220
 221   /// \brief Returns the interesting dependences.  If null is returned we
 222   /// exceeded the MaxInterestingDependence threshold and this information is
 223   /// not available.
 224   const SmallVectorImpl<Dependence> *getInterestingDependences() const {
 225     return RecordInterestingDependences ? &InterestingDependences : nullptr;
 226   }
 227
 228   /// \brief The vector of memory access instructions.  The indices are used as
 229   /// instruction identifiers in the Dependence class.
 230   const SmallVectorImpl<Instruction *> &getMemoryInstructions() const {
 231     return InstMap;
 232   }
 233
 234 private:
 235   ScalarEvolution *SE;
 236   const Loop *InnermostLoop;
 237
 238   /// \brief Maps access locations (ptr, read/write) to program order.
 239   DenseMap<MemAccessInfo, std::vector<unsigned> > Accesses;
 240
 241   /// \brief Memory access instructions in program order.
 242   SmallVector<Instruction *, 16> InstMap;
 243
 244   /// \brief The program order index to be used for the next instruction.
 245   unsigned AccessIdx;
 246
 247   // We can access this many bytes in parallel safely.
 248   unsigned MaxSafeDepDistBytes;
 249
 250   /// \brief If we see a non-constant dependence distance we can still try to
 251   /// vectorize this loop with runtime checks.
 252   bool ShouldRetryWithRuntimeCheck;
 253
 254   /// \brief No memory dependence was encountered that would inhibit
 255   /// vectorization.
 256   bool SafeForVectorization;
 257
 258   //// \brief True if InterestingDependences reflects the dependences in the
 259   //// loop.  If false we exceeded MaxInterestingDependence and
 260   //// InterestingDependences is invalid.
 261   bool RecordInterestingDependences;
 262
 263   /// \brief Interesting memory dependences collected during the analysis as
 264   /// defined by isInterestingDependence.  Only valid if
 265   /// RecordInterestingDependences is true.
 266   SmallVector<Dependence, 8> InterestingDependences;
 267
 268   /// \brief Check whether there is a plausible dependence between the two
 269   /// accesses.
 270   ///
 271   /// Access \p A must happen before \p B in program order. The two indices
 272   /// identify the index into the program order map.
 273   ///
 274   /// This function checks  whether there is a plausible dependence (or the
 275   /// absence of such can't be proved) between the two accesses. If there is a
 276   /// plausible dependence but the dependence distance is bigger than one
 277   /// element access it records this distance in \p MaxSafeDepDistBytes (if this
 278   /// distance is smaller than any other distance encountered so far).
 279   /// Otherwise, this function returns true signaling a possible dependence.
 280   Dependence::DepType isDependent(const MemAccessInfo &A, unsigned AIdx,
 281                                   const MemAccessInfo &B, unsigned BIdx,
 282                                   const ValueToValueMap &Strides);
 283
 284   /// \brief Check whether the data dependence could prevent store-load
 285   /// forwarding.
 286   bool couldPreventStoreLoadForward(unsigned Distance, unsigned TypeByteSize);
 287 };
 288
 289 /// \brief Drive the analysis of memory accesses in the loop
 290 ///
 291 /// This class is responsible for analyzing the memory accesses of a loop.  It
 292 /// collects the accesses and then its main helper the AccessAnalysis class
 293 /// finds and categorizes the dependences in buildDependenceSets.
 294 ///
 295 /// For memory dependences that can be analyzed at compile time, it determines
 296 /// whether the dependence is part of cycle inhibiting vectorization.  This work
 297 /// is delegated to the MemoryDepChecker class.
 298 ///
 299 /// For memory dependences that cannot be determined at compile time, it
 300 /// generates run-time checks to prove independence.  This is done by
 301 /// AccessAnalysis::canCheckPtrAtRT and the checks are maintained by the
 302 /// RuntimePointerCheck class.
 303 class LoopAccessInfo {
 304 public:
 305   /// This struct holds information about the memory runtime legality check that
 306   /// a group of pointers do not overlap.
 307   struct RuntimePointerCheck {
 308     RuntimePointerCheck() : Need(false) {}
 309
 310     /// Reset the state of the pointer runtime information.
 311     void reset() {
 312       Need = false;
 313       Pointers.clear();
 314       Starts.clear();
 315       Ends.clear();
 316       IsWritePtr.clear();
 317       DependencySetId.clear();
 318       AliasSetId.clear();
 319     }
 320
 321     /// Insert a pointer and calculate the start and end SCEVs.
 322     void insert(ScalarEvolution *SE, Loop *Lp, Value *Ptr, bool WritePtr,
 323                 unsigned DepSetId, unsigned ASId,
 324                 const ValueToValueMap &Strides);
 325
 326     /// \brief No run-time memory checking is necessary.
 327     bool empty() const { return Pointers.empty(); }
 328
 329     /// \brief Decide whether we need to issue a run-time check for pointer at
 330     /// index \p I and \p J to prove their independence.
 331     bool needsChecking(unsigned I, unsigned J) const;
 332
 333     /// \brief Print the list run-time memory checks necessary.
 334     void print(raw_ostream &OS, unsigned Depth = 0) const;
 335
 336     /// This flag indicates if we need to add the runtime check.
 337     bool Need;
 338     /// Holds the pointers that we need to check.
 339     SmallVector<TrackingVH<Value>, 2> Pointers;
 340     /// Holds the pointer value at the beginning of the loop.
 341     SmallVector<const SCEV*, 2> Starts;
 342     /// Holds the pointer value at the end of the loop.
 343     SmallVector<const SCEV*, 2> Ends;
 344     /// Holds the information if this pointer is used for writing to memory.
 345     SmallVector<bool, 2> IsWritePtr;
 346     /// Holds the id of the set of pointers that could be dependent because of a
 347     /// shared underlying object.
 348     SmallVector<unsigned, 2> DependencySetId;
 349     /// Holds the id of the disjoint alias set to which this pointer belongs.
 350     SmallVector<unsigned, 2> AliasSetId;
 351   };
 352
 353   LoopAccessInfo(Loop *L, ScalarEvolution *SE, const DataLayout &DL,
 354                  const TargetLibraryInfo *TLI, AliasAnalysis *AA,
 355                  DominatorTree *DT, const ValueToValueMap &Strides);
 356
 357   /// Return true we can analyze the memory accesses in the loop and there are
 358   /// no memory dependence cycles.
 359   bool canVectorizeMemory() const { return CanVecMem; }
 360
 361   const RuntimePointerCheck *getRuntimePointerCheck() const {
 362     return &PtrRtCheck;
 363   }
 364
 365   /// Return true if the block BB needs to be predicated in order for the loop
 366   /// to be vectorized.
 367   static bool blockNeedsPredication(BasicBlock *BB, Loop *TheLoop,
 368                                     DominatorTree *DT);
 369
 370   /// Returns true if the value V is uniform within the loop.
 371   bool isUniform(Value *V) const;
 372
 373   unsigned getMaxSafeDepDistBytes() const { return MaxSafeDepDistBytes; }
 374   unsigned getNumStores() const { return NumStores; }
 375   unsigned getNumLoads() const { return NumLoads;}
 376
 377   /// \brief Add code that checks at runtime if the accessed arrays overlap.
 378   ///
 379   /// Returns a pair of instructions where the first element is the first
 380   /// instruction generated in possibly a sequence of instructions and the
 381   /// second value is the final comparator value or NULL if no check is needed.
 382   std::pair<Instruction *, Instruction *>
 383     addRuntimeCheck(Instruction *Loc) const;
 384
 385   /// \brief The diagnostics report generated for the analysis.  E.g. why we
 386   /// couldn't analyze the loop.
 387   const Optional<LoopAccessReport> &getReport() const { return Report; }
 388
 389   /// \brief the Memory Dependence Checker which can determine the
 390   /// loop-independent and loop-carried dependences between memory accesses.
 391   const MemoryDepChecker &getDepChecker() const { return DepChecker; }
 392
 393   /// \brief Print the information about the memory accesses in the loop.
 394   void print(raw_ostream &OS, unsigned Depth = 0) const;
 395
 396   /// \brief Used to ensure that if the analysis was run with speculating the
 397   /// value of symbolic strides, the client queries it with the same assumption.
 398   /// Only used in DEBUG build but we don't want NDEBUG-dependent ABI.
 399   unsigned NumSymbolicStrides;
 400
 401 private:
 402   /// \brief Analyze the loop.  Substitute symbolic strides using Strides.
 403   void analyzeLoop(const ValueToValueMap &Strides);
 404
 405   /// \brief Check if the structure of the loop allows it to be analyzed by this
 406   /// pass.
 407   bool canAnalyzeLoop();
 408
 409   void emitAnalysis(LoopAccessReport &Message);
 410
 411   /// We need to check that all of the pointers in this list are disjoint
 412   /// at runtime.
 413   RuntimePointerCheck PtrRtCheck;
 414
 415   /// \brief the Memory Dependence Checker which can determine the
 416   /// loop-independent and loop-carried dependences between memory accesses.
 417   MemoryDepChecker DepChecker;
 418
 419   Loop *TheLoop;
 420   ScalarEvolution *SE;
 421   const DataLayout &DL;
 422   const TargetLibraryInfo *TLI;
 423   AliasAnalysis *AA;
 424   DominatorTree *DT;
 425
 426   unsigned NumLoads;
 427   unsigned NumStores;
 428
 429   unsigned MaxSafeDepDistBytes;
 430
 431   /// \brief Cache the result of analyzeLoop.
 432   bool CanVecMem;
 433
 434   /// \brief The diagnostics report generated for the analysis.  E.g. why we
 435   /// couldn't analyze the loop.
 436   Optional<LoopAccessReport> Report;
 437 };
 438
 439 Value *stripIntegerCast(Value *V);
 440
 441 ///\brief Return the SCEV corresponding to a pointer with the symbolic stride
 442 ///replaced with constant one.
 443 ///
 444 /// If \p OrigPtr is not null, use it to look up the stride value instead of \p
 445 /// Ptr.  \p PtrToStride provides the mapping between the pointer value and its
 446 /// stride as collected by LoopVectorizationLegality::collectStridedAccess.
 447 const SCEV *replaceSymbolicStrideSCEV(ScalarEvolution *SE,
 448                                       const ValueToValueMap &PtrToStride,
 449                                       Value *Ptr, Value *OrigPtr = nullptr);
 450
 451 /// \brief This analysis provides dependence information for the memory accesses
 452 /// of a loop.
 453 ///
 454 /// It runs the analysis for a loop on demand.  This can be initiated by
 455 /// querying the loop access info via LAA::getInfo.  getInfo return a
 456 /// LoopAccessInfo object.  See this class for the specifics of what information
 457 /// is provided.
 458 class LoopAccessAnalysis : public FunctionPass {
 459 public:
 460   static char ID;
 461
 462   LoopAccessAnalysis() : FunctionPass(ID) {
 463     initializeLoopAccessAnalysisPass(*PassRegistry::getPassRegistry());
 464   }
 465
 466   bool runOnFunction(Function &F) override;
 467
 468   void getAnalysisUsage(AnalysisUsage &AU) const override;
 469
 470   /// \brief Query the result of the loop access information for the loop \p L.
 471   ///
 472   /// If the client speculates (and then issues run-time checks) for the values
 473   /// of symbolic strides, \p Strides provides the mapping (see
 474   /// replaceSymbolicStrideSCEV).  If there is no cached result available run
 475   /// the analysis.
 476   const LoopAccessInfo &getInfo(Loop *L, const ValueToValueMap &Strides);
 477
 478   void releaseMemory() override {
 479     // Invalidate the cache when the pass is freed.
 480     LoopAccessInfoMap.clear();
 481   }
 482
 483   /// \brief Print the result of the analysis when invoked with -analyze.
 484   void print(raw_ostream &OS, const Module *M = nullptr) const override;
 485
 486 private:
 487   /// \brief The cache.
 488   DenseMap<Loop *, std::unique_ptr<LoopAccessInfo>> LoopAccessInfoMap;
 489
 490   // The used analysis passes.
 491   ScalarEvolution *SE;
 492   const TargetLibraryInfo *TLI;
 493   AliasAnalysis *AA;
 494   DominatorTree *DT;
 495 };
 496 } // End llvm namespace
 497
 498 #endif