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   void clearInterestingDependences() { InterestingDependences.clear(); }
 229
 230   /// \brief The vector of memory access instructions.  The indices are used as
 231   /// instruction identifiers in the Dependence class.
 232   const SmallVectorImpl<Instruction *> &getMemoryInstructions() const {
 233     return InstMap;
 234   }
 235
 236   /// \brief Find the set of instructions that read or write via \p Ptr.
 237   SmallVector<Instruction *, 4> getInstructionsForAccess(Value *Ptr,
 238                                                          bool isWrite) const;
 239
 240 private:
 241   ScalarEvolution *SE;
 242   const Loop *InnermostLoop;
 243
 244   /// \brief Maps access locations (ptr, read/write) to program order.
 245   DenseMap<MemAccessInfo, std::vector<unsigned> > Accesses;
 246
 247   /// \brief Memory access instructions in program order.
 248   SmallVector<Instruction *, 16> InstMap;
 249
 250   /// \brief The program order index to be used for the next instruction.
 251   unsigned AccessIdx;
 252
 253   // We can access this many bytes in parallel safely.
 254   unsigned MaxSafeDepDistBytes;
 255
 256   /// \brief If we see a non-constant dependence distance we can still try to
 257   /// vectorize this loop with runtime checks.
 258   bool ShouldRetryWithRuntimeCheck;
 259
 260   /// \brief No memory dependence was encountered that would inhibit
 261   /// vectorization.
 262   bool SafeForVectorization;
 263
 264   //// \brief True if InterestingDependences reflects the dependences in the
 265   //// loop.  If false we exceeded MaxInterestingDependence and
 266   //// InterestingDependences is invalid.
 267   bool RecordInterestingDependences;
 268
 269   /// \brief Interesting memory dependences collected during the analysis as
 270   /// defined by isInterestingDependence.  Only valid if
 271   /// RecordInterestingDependences is true.
 272   SmallVector<Dependence, 8> InterestingDependences;
 273
 274   /// \brief Check whether there is a plausible dependence between the two
 275   /// accesses.
 276   ///
 277   /// Access \p A must happen before \p B in program order. The two indices
 278   /// identify the index into the program order map.
 279   ///
 280   /// This function checks  whether there is a plausible dependence (or the
 281   /// absence of such can't be proved) between the two accesses. If there is a
 282   /// plausible dependence but the dependence distance is bigger than one
 283   /// element access it records this distance in \p MaxSafeDepDistBytes (if this
 284   /// distance is smaller than any other distance encountered so far).
 285   /// Otherwise, this function returns true signaling a possible dependence.
 286   Dependence::DepType isDependent(const MemAccessInfo &A, unsigned AIdx,
 287                                   const MemAccessInfo &B, unsigned BIdx,
 288                                   const ValueToValueMap &Strides);
 289
 290   /// \brief Check whether the data dependence could prevent store-load
 291   /// forwarding.
 292   bool couldPreventStoreLoadForward(unsigned Distance, unsigned TypeByteSize);
 293 };
 294
 295 /// This struct holds information about the memory runtime legality check that
 296 /// a group of pointers do not overlap.
 297 struct RuntimePointerChecking {
 298   RuntimePointerChecking(ScalarEvolution *SE) : Need(false), SE(SE) {}
 299
 300   /// Reset the state of the pointer runtime information.
 301   void reset() {
 302     Need = false;
 303     Pointers.clear();
 304     Starts.clear();
 305     Ends.clear();
 306     IsWritePtr.clear();
 307     DependencySetId.clear();
 308     AliasSetId.clear();
 309     Exprs.clear();
 310   }
 311
 312   /// Insert a pointer and calculate the start and end SCEVs.
 313   void insert(Loop *Lp, Value *Ptr, bool WritePtr, unsigned DepSetId,
 314               unsigned ASId, const ValueToValueMap &Strides);
 315
 316   /// \brief No run-time memory checking is necessary.
 317   bool empty() const { return Pointers.empty(); }
 318
 319   /// A grouping of pointers. A single memcheck is required between
 320   /// two groups.
 321   struct CheckingPtrGroup {
 322     /// \brief Create a new pointer checking group containing a single
 323     /// pointer, with index \p Index in RtCheck.
 324     CheckingPtrGroup(unsigned Index, RuntimePointerChecking &RtCheck)
 325         : RtCheck(RtCheck), High(RtCheck.Ends[Index]),
 326           Low(RtCheck.Starts[Index]) {
 327       Members.push_back(Index);
 328     }
 329
 330     /// \brief Tries to add the pointer recorded in RtCheck at index
 331     /// \p Index to this pointer checking group. We can only add a pointer
 332     /// to a checking group if we will still be able to get
 333     /// the upper and lower bounds of the check. Returns true in case
 334     /// of success, false otherwise.
 335     bool addPointer(unsigned Index);
 336
 337     /// Constitutes the context of this pointer checking group. For each
 338     /// pointer that is a member of this group we will retain the index
 339     /// at which it appears in RtCheck.
 340     RuntimePointerChecking &RtCheck;
 341     /// The SCEV expression which represents the upper bound of all the
 342     /// pointers in this group.
 343     const SCEV *High;
 344     /// The SCEV expression which represents the lower bound of all the
 345     /// pointers in this group.
 346     const SCEV *Low;
 347     /// Indices of all the pointers that constitute this grouping.
 348     SmallVector<unsigned, 2> Members;
 349   };
 350
 351   /// \brief Groups pointers such that a single memcheck is required
 352   /// between two different groups. This will clear the CheckingGroups vector
 353   /// and re-compute it. We will only group dependecies if \p UseDependencies
 354   /// is true, otherwise we will create a separate group for each pointer.
 355   void groupChecks(MemoryDepChecker::DepCandidates &DepCands,
 356                    bool UseDependencies);
 357
 358   /// \brief Decide whether we need to issue a run-time check for pointer at
 359   /// index \p I and \p J to prove their independence.
 360   ///
 361   /// If \p PtrPartition is set, it contains the partition number for
 362   /// pointers (-1 if the pointer belongs to multiple partitions).  In this
 363   /// case omit checks between pointers belonging to the same partition.
 364   bool needsChecking(unsigned I, unsigned J,
 365                      const SmallVectorImpl<int> *PtrPartition) const;
 366
 367   /// \brief Decide if we need to add a check between two groups of pointers,
 368   /// according to needsChecking.
 369   bool needsChecking(const CheckingPtrGroup &M, const CheckingPtrGroup &N,
 370                      const SmallVectorImpl<int> *PtrPartition) const;
 371
 372   /// \brief Return true if any pointer requires run-time checking according
 373   /// to needsChecking.
 374   bool needsAnyChecking(const SmallVectorImpl<int> *PtrPartition) const;
 375
 376   /// \brief Returns the number of run-time checks required according to
 377   /// needsChecking.
 378   unsigned getNumberOfChecks(const SmallVectorImpl<int> *PtrPartition) const;
 379
 380   /// \brief Print the list run-time memory checks necessary.
 381   ///
 382   /// If \p PtrPartition is set, it contains the partition number for
 383   /// pointers (-1 if the pointer belongs to multiple partitions).  In this
 384   /// case omit checks between pointers belonging to the same partition.
 385   void print(raw_ostream &OS, unsigned Depth = 0,
 386              const SmallVectorImpl<int> *PtrPartition = nullptr) const;
 387
 388   /// This flag indicates if we need to add the runtime check.
 389   bool Need;
 390   /// Holds the pointers that we need to check.
 391   SmallVector<TrackingVH<Value>, 2> Pointers;
 392   /// Holds the pointer value at the beginning of the loop.
 393   SmallVector<const SCEV *, 2> Starts;
 394   /// Holds the pointer value at the end of the loop.
 395   SmallVector<const SCEV *, 2> Ends;
 396   /// Holds the information if this pointer is used for writing to memory.
 397   SmallVector<bool, 2> IsWritePtr;
 398   /// Holds the id of the set of pointers that could be dependent because of a
 399   /// shared underlying object.
 400   SmallVector<unsigned, 2> DependencySetId;
 401   /// Holds the id of the disjoint alias set to which this pointer belongs.
 402   SmallVector<unsigned, 2> AliasSetId;
 403   /// Holds at position i the SCEV for the access i
 404   SmallVector<const SCEV *, 2> Exprs;
 405   /// Holds a partitioning of pointers into "check groups".
 406   SmallVector<CheckingPtrGroup, 2> CheckingGroups;
 407   /// Holds a pointer to the ScalarEvolution analysis.
 408   ScalarEvolution *SE;
 409 };
 410
 411 /// \brief Drive the analysis of memory accesses in the loop
 412 ///
 413 /// This class is responsible for analyzing the memory accesses of a loop.  It
 414 /// collects the accesses and then its main helper the AccessAnalysis class
 415 /// finds and categorizes the dependences in buildDependenceSets.
 416 ///
 417 /// For memory dependences that can be analyzed at compile time, it determines
 418 /// whether the dependence is part of cycle inhibiting vectorization.  This work
 419 /// is delegated to the MemoryDepChecker class.
 420 ///
 421 /// For memory dependences that cannot be determined at compile time, it
 422 /// generates run-time checks to prove independence.  This is done by
 423 /// AccessAnalysis::canCheckPtrAtRT and the checks are maintained by the
 424 /// RuntimePointerCheck class.
 425 class LoopAccessInfo {
 426 public:
 427   LoopAccessInfo(Loop *L, ScalarEvolution *SE, const DataLayout &DL,
 428                  const TargetLibraryInfo *TLI, AliasAnalysis *AA,
 429                  DominatorTree *DT, LoopInfo *LI,
 430                  const ValueToValueMap &Strides);
 431
 432   /// Return true we can analyze the memory accesses in the loop and there are
 433   /// no memory dependence cycles.
 434   bool canVectorizeMemory() const { return CanVecMem; }
 435
 436   const RuntimePointerChecking *getRuntimePointerChecking() const {
 437     return &PtrRtChecking;
 438   }
 439
 440   /// \brief Number of memchecks required to prove independence of otherwise
 441   /// may-alias pointers.
 442   unsigned getNumRuntimePointerChecks(
 443     const SmallVectorImpl<int> *PtrPartition = nullptr) const {
 444     return PtrRtChecking.getNumberOfChecks(PtrPartition);
 445   }
 446
 447   /// Return true if the block BB needs to be predicated in order for the loop
 448   /// to be vectorized.
 449   static bool blockNeedsPredication(BasicBlock *BB, Loop *TheLoop,
 450                                     DominatorTree *DT);
 451
 452   /// Returns true if the value V is uniform within the loop.
 453   bool isUniform(Value *V) const;
 454
 455   unsigned getMaxSafeDepDistBytes() const { return MaxSafeDepDistBytes; }
 456   unsigned getNumStores() const { return NumStores; }
 457   unsigned getNumLoads() const { return NumLoads;}
 458
 459   /// \brief Add code that checks at runtime if the accessed arrays overlap.
 460   ///
 461   /// Returns a pair of instructions where the first element is the first
 462   /// instruction generated in possibly a sequence of instructions and the
 463   /// second value is the final comparator value or NULL if no check is needed.
 464   ///
 465   /// If \p PtrPartition is set, it contains the partition number for pointers
 466   /// (-1 if the pointer belongs to multiple partitions).  In this case omit
 467   /// checks between pointers belonging to the same partition.
 468   std::pair<Instruction *, Instruction *>
 469   addRuntimeCheck(Instruction *Loc,
 470                   const SmallVectorImpl<int> *PtrPartition = nullptr) const;
 471
 472   /// \brief The diagnostics report generated for the analysis.  E.g. why we
 473   /// couldn't analyze the loop.
 474   const Optional<LoopAccessReport> &getReport() const { return Report; }
 475
 476   /// \brief the Memory Dependence Checker which can determine the
 477   /// loop-independent and loop-carried dependences between memory accesses.
 478   const MemoryDepChecker &getDepChecker() const { return DepChecker; }
 479
 480   /// \brief Return the list of instructions that use \p Ptr to read or write
 481   /// memory.
 482   SmallVector<Instruction *, 4> getInstructionsForAccess(Value *Ptr,
 483                                                          bool isWrite) const {
 484     return DepChecker.getInstructionsForAccess(Ptr, isWrite);
 485   }
 486
 487   /// \brief Print the information about the memory accesses in the loop.
 488   void print(raw_ostream &OS, unsigned Depth = 0) const;
 489
 490   /// \brief Used to ensure that if the analysis was run with speculating the
 491   /// value of symbolic strides, the client queries it with the same assumption.
 492   /// Only used in DEBUG build but we don't want NDEBUG-dependent ABI.
 493   unsigned NumSymbolicStrides;
 494
 495   /// \brief Checks existence of store to invariant address inside loop.
 496   /// If the loop has any store to invariant address, then it returns true,
 497   /// else returns false.
 498   bool hasStoreToLoopInvariantAddress() const {
 499     return StoreToLoopInvariantAddress;
 500   }
 501
 502 private:
 503   /// \brief Analyze the loop.  Substitute symbolic strides using Strides.
 504   void analyzeLoop(const ValueToValueMap &Strides);
 505
 506   /// \brief Check if the structure of the loop allows it to be analyzed by this
 507   /// pass.
 508   bool canAnalyzeLoop();
 509
 510   void emitAnalysis(LoopAccessReport &Message);
 511
 512   /// We need to check that all of the pointers in this list are disjoint
 513   /// at runtime.
 514   RuntimePointerChecking PtrRtChecking;
 515
 516   /// \brief the Memory Dependence Checker which can determine the
 517   /// loop-independent and loop-carried dependences between memory accesses.
 518   MemoryDepChecker DepChecker;
 519
 520   Loop *TheLoop;
 521   ScalarEvolution *SE;
 522   const DataLayout &DL;
 523   const TargetLibraryInfo *TLI;
 524   AliasAnalysis *AA;
 525   DominatorTree *DT;
 526   LoopInfo *LI;
 527
 528   unsigned NumLoads;
 529   unsigned NumStores;
 530
 531   unsigned MaxSafeDepDistBytes;
 532
 533   /// \brief Cache the result of analyzeLoop.
 534   bool CanVecMem;
 535
 536   /// \brief Indicator for storing to uniform addresses.
 537   /// If a loop has write to a loop invariant address then it should be true.
 538   bool StoreToLoopInvariantAddress;
 539
 540   /// \brief The diagnostics report generated for the analysis.  E.g. why we
 541   /// couldn't analyze the loop.
 542   Optional<LoopAccessReport> Report;
 543 };
 544
 545 Value *stripIntegerCast(Value *V);
 546
 547 ///\brief Return the SCEV corresponding to a pointer with the symbolic stride
 548 ///replaced with constant one.
 549 ///
 550 /// If \p OrigPtr is not null, use it to look up the stride value instead of \p
 551 /// Ptr.  \p PtrToStride provides the mapping between the pointer value and its
 552 /// stride as collected by LoopVectorizationLegality::collectStridedAccess.
 553 const SCEV *replaceSymbolicStrideSCEV(ScalarEvolution *SE,
 554                                       const ValueToValueMap &PtrToStride,
 555                                       Value *Ptr, Value *OrigPtr = nullptr);
 556
 557 /// \brief Check the stride of the pointer and ensure that it does not wrap in
 558 /// the address space.
 559 int isStridedPtr(ScalarEvolution *SE, Value *Ptr, const Loop *Lp,
 560                  const ValueToValueMap &StridesMap);
 561
 562 /// \brief This analysis provides dependence information for the memory accesses
 563 /// of a loop.
 564 ///
 565 /// It runs the analysis for a loop on demand.  This can be initiated by
 566 /// querying the loop access info via LAA::getInfo.  getInfo return a
 567 /// LoopAccessInfo object.  See this class for the specifics of what information
 568 /// is provided.
 569 class LoopAccessAnalysis : public FunctionPass {
 570 public:
 571   static char ID;
 572
 573   LoopAccessAnalysis() : FunctionPass(ID) {
 574     initializeLoopAccessAnalysisPass(*PassRegistry::getPassRegistry());
 575   }
 576
 577   bool runOnFunction(Function &F) override;
 578
 579   void getAnalysisUsage(AnalysisUsage &AU) const override;
 580
 581   /// \brief Query the result of the loop access information for the loop \p L.
 582   ///
 583   /// If the client speculates (and then issues run-time checks) for the values
 584   /// of symbolic strides, \p Strides provides the mapping (see
 585   /// replaceSymbolicStrideSCEV).  If there is no cached result available run
 586   /// the analysis.
 587   const LoopAccessInfo &getInfo(Loop *L, const ValueToValueMap &Strides);
 588
 589   void releaseMemory() override {
 590     // Invalidate the cache when the pass is freed.
 591     LoopAccessInfoMap.clear();
 592   }
 593
 594   /// \brief Print the result of the analysis when invoked with -analyze.
 595   void print(raw_ostream &OS, const Module *M = nullptr) const override;
 596
 597 private:
 598   /// \brief The cache.
 599   DenseMap<Loop *, std::unique_ptr<LoopAccessInfo>> LoopAccessInfoMap;
 600
 601   // The used analysis passes.
 602   ScalarEvolution *SE;
 603   const TargetLibraryInfo *TLI;
 604   AliasAnalysis *AA;
 605   DominatorTree *DT;
 606   LoopInfo *LI;
 607 };
 608 } // End llvm namespace
 609
 610 #endif