LLVM  9.0.0svn
MemorySSA.h
Go to the documentation of this file.
1 //===- MemorySSA.h - Build Memory SSA ---------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// This file exposes an interface to building/using memory SSA to
11 /// walk memory instructions using a use/def graph.
12 ///
13 /// Memory SSA class builds an SSA form that links together memory access
14 /// instructions such as loads, stores, atomics, and calls. Additionally, it
15 /// does a trivial form of "heap versioning" Every time the memory state changes
16 /// in the program, we generate a new heap version. It generates
17 /// MemoryDef/Uses/Phis that are overlayed on top of the existing instructions.
18 ///
19 /// As a trivial example,
20 /// define i32 @main() #0 {
21 /// entry:
22 /// %call = call noalias i8* @_Znwm(i64 4) #2
23 /// %0 = bitcast i8* %call to i32*
24 /// %call1 = call noalias i8* @_Znwm(i64 4) #2
25 /// %1 = bitcast i8* %call1 to i32*
26 /// store i32 5, i32* %0, align 4
27 /// store i32 7, i32* %1, align 4
28 /// %2 = load i32* %0, align 4
29 /// %3 = load i32* %1, align 4
30 /// %add = add nsw i32 %2, %3
31 /// ret i32 %add
32 /// }
33 ///
34 /// Will become
35 /// define i32 @main() #0 {
36 /// entry:
37 /// ; 1 = MemoryDef(0)
38 /// %call = call noalias i8* @_Znwm(i64 4) #3
39 /// %2 = bitcast i8* %call to i32*
40 /// ; 2 = MemoryDef(1)
41 /// %call1 = call noalias i8* @_Znwm(i64 4) #3
42 /// %4 = bitcast i8* %call1 to i32*
43 /// ; 3 = MemoryDef(2)
44 /// store i32 5, i32* %2, align 4
45 /// ; 4 = MemoryDef(3)
46 /// store i32 7, i32* %4, align 4
47 /// ; MemoryUse(3)
48 /// %7 = load i32* %2, align 4
49 /// ; MemoryUse(4)
50 /// %8 = load i32* %4, align 4
51 /// %add = add nsw i32 %7, %8
52 /// ret i32 %add
53 /// }
54 ///
55 /// Given this form, all the stores that could ever effect the load at %8 can be
56 /// gotten by using the MemoryUse associated with it, and walking from use to
57 /// def until you hit the top of the function.
58 ///
59 /// Each def also has a list of users associated with it, so you can walk from
60 /// both def to users, and users to defs. Note that we disambiguate MemoryUses,
61 /// but not the RHS of MemoryDefs. You can see this above at %7, which would
62 /// otherwise be a MemoryUse(4). Being disambiguated means that for a given
63 /// store, all the MemoryUses on its use lists are may-aliases of that store
64 /// (but the MemoryDefs on its use list may not be).
65 ///
66 /// MemoryDefs are not disambiguated because it would require multiple reaching
67 /// definitions, which would require multiple phis, and multiple memoryaccesses
68 /// per instruction.
69 //
70 //===----------------------------------------------------------------------===//
71 
72 #ifndef LLVM_ANALYSIS_MEMORYSSA_H
73 #define LLVM_ANALYSIS_MEMORYSSA_H
74 
75 #include "llvm/ADT/DenseMap.h"
76 #include "llvm/ADT/GraphTraits.h"
77 #include "llvm/ADT/SmallPtrSet.h"
78 #include "llvm/ADT/SmallVector.h"
79 #include "llvm/ADT/ilist.h"
80 #include "llvm/ADT/ilist_node.h"
81 #include "llvm/ADT/iterator.h"
83 #include "llvm/ADT/simple_ilist.h"
87 #include "llvm/IR/BasicBlock.h"
88 #include "llvm/IR/DerivedUser.h"
89 #include "llvm/IR/Dominators.h"
90 #include "llvm/IR/Module.h"
91 #include "llvm/IR/Type.h"
92 #include "llvm/IR/Use.h"
93 #include "llvm/IR/User.h"
94 #include "llvm/IR/Value.h"
95 #include "llvm/IR/ValueHandle.h"
96 #include "llvm/Pass.h"
97 #include "llvm/Support/Casting.h"
98 #include <algorithm>
99 #include <cassert>
100 #include <cstddef>
101 #include <iterator>
102 #include <memory>
103 #include <utility>
104 
105 namespace llvm {
106 
107 class Function;
108 class Instruction;
109 class MemoryAccess;
110 class MemorySSAWalker;
111 class LLVMContext;
112 class raw_ostream;
113 
114 namespace MSSAHelpers {
115 
116 struct AllAccessTag {};
117 struct DefsOnlyTag {};
118 
119 } // end namespace MSSAHelpers
120 
121 enum : unsigned {
122  // Used to signify what the default invalid ID is for MemoryAccess's
123  // getID()
125 };
126 
127 template <class T> class memoryaccess_def_iterator_base;
131 
132 // The base for all memory accesses. All memory accesses in a block are
133 // linked together using an intrusive list.
135  : public DerivedUser,
136  public ilist_node<MemoryAccess, ilist_tag<MSSAHelpers::AllAccessTag>>,
137  public ilist_node<MemoryAccess, ilist_tag<MSSAHelpers::DefsOnlyTag>> {
138 public:
139  using AllAccessType =
141  using DefsOnlyType =
143 
144  MemoryAccess(const MemoryAccess &) = delete;
145  MemoryAccess &operator=(const MemoryAccess &) = delete;
146 
147  void *operator new(size_t) = delete;
148 
149  // Methods for support type inquiry through isa, cast, and
150  // dyn_cast
151  static bool classof(const Value *V) {
152  unsigned ID = V->getValueID();
153  return ID == MemoryUseVal || ID == MemoryPhiVal || ID == MemoryDefVal;
154  }
155 
156  BasicBlock *getBlock() const { return Block; }
157 
158  void print(raw_ostream &OS) const;
159  void dump() const;
160 
161  /// The user iterators for a memory access
164 
165  /// This iterator walks over all of the defs in a given
166  /// MemoryAccess. For MemoryPhi nodes, this walks arguments. For
167  /// MemoryUse/MemoryDef, this walks the defining access.
168  memoryaccess_def_iterator defs_begin();
169  const_memoryaccess_def_iterator defs_begin() const;
170  memoryaccess_def_iterator defs_end();
171  const_memoryaccess_def_iterator defs_end() const;
172 
173  /// Get the iterators for the all access list and the defs only list
174  /// We default to the all access list.
176  return this->AllAccessType::getIterator();
177  }
179  return this->AllAccessType::getIterator();
180  }
182  return this->AllAccessType::getReverseIterator();
183  }
185  return this->AllAccessType::getReverseIterator();
186  }
188  return this->DefsOnlyType::getIterator();
189  }
191  return this->DefsOnlyType::getIterator();
192  }
194  return this->DefsOnlyType::getReverseIterator();
195  }
197  return this->DefsOnlyType::getReverseIterator();
198  }
199 
200 protected:
201  friend class MemoryDef;
202  friend class MemoryPhi;
203  friend class MemorySSA;
204  friend class MemoryUse;
205  friend class MemoryUseOrDef;
206 
207  /// Used by MemorySSA to change the block of a MemoryAccess when it is
208  /// moved.
209  void setBlock(BasicBlock *BB) { Block = BB; }
210 
211  /// Used for debugging and tracking things about MemoryAccesses.
212  /// Guaranteed unique among MemoryAccesses, no guarantees otherwise.
213  inline unsigned getID() const;
214 
215  MemoryAccess(LLVMContext &C, unsigned Vty, DeleteValueTy DeleteValue,
216  BasicBlock *BB, unsigned NumOperands)
217  : DerivedUser(Type::getVoidTy(C), Vty, nullptr, NumOperands, DeleteValue),
218  Block(BB) {}
219 
220  // Use deleteValue() to delete a generic MemoryAccess.
221  ~MemoryAccess() = default;
222 
223 private:
224  BasicBlock *Block;
225 };
226 
227 template <>
229  static void deleteNode(MemoryAccess *MA) { MA->deleteValue(); }
230 };
231 
233  MA.print(OS);
234  return OS;
235 }
236 
237 /// Class that has the common methods + fields of memory uses/defs. It's
238 /// a little awkward to have, but there are many cases where we want either a
239 /// use or def, and there are many cases where uses are needed (defs aren't
240 /// acceptable), and vice-versa.
241 ///
242 /// This class should never be instantiated directly; make a MemoryUse or
243 /// MemoryDef instead.
244 class MemoryUseOrDef : public MemoryAccess {
245 public:
246  void *operator new(size_t) = delete;
247 
249 
250  /// Get the instruction that this MemoryUse represents.
251  Instruction *getMemoryInst() const { return MemoryInstruction; }
252 
253  /// Get the access that produces the memory state used by this Use.
254  MemoryAccess *getDefiningAccess() const { return getOperand(0); }
255 
256  static bool classof(const Value *MA) {
257  return MA->getValueID() == MemoryUseVal || MA->getValueID() == MemoryDefVal;
258  }
259 
260  // Sadly, these have to be public because they are needed in some of the
261  // iterators.
262  inline bool isOptimized() const;
263  inline MemoryAccess *getOptimized() const;
264  inline void setOptimized(MemoryAccess *);
265 
266  // Retrieve AliasResult type of the optimized access. Ideally this would be
267  // returned by the caching walker and may go away in the future.
269  return OptimizedAccessAlias;
270  }
271 
272  /// Reset the ID of what this MemoryUse was optimized to, causing it to
273  /// be rewalked by the walker if necessary.
274  /// This really should only be called by tests.
275  inline void resetOptimized();
276 
277 protected:
278  friend class MemorySSA;
279  friend class MemorySSAUpdater;
280 
281  MemoryUseOrDef(LLVMContext &C, MemoryAccess *DMA, unsigned Vty,
282  DeleteValueTy DeleteValue, Instruction *MI, BasicBlock *BB,
283  unsigned NumOperands)
284  : MemoryAccess(C, Vty, DeleteValue, BB, NumOperands),
285  MemoryInstruction(MI), OptimizedAccessAlias(MayAlias) {
286  setDefiningAccess(DMA);
287  }
288 
289  // Use deleteValue() to delete a generic MemoryUseOrDef.
290  ~MemoryUseOrDef() = default;
291 
293  OptimizedAccessAlias = AR;
294  }
295 
296  void setDefiningAccess(MemoryAccess *DMA, bool Optimized = false,
298  if (!Optimized) {
299  setOperand(0, DMA);
300  return;
301  }
302  setOptimized(DMA);
303  setOptimizedAccessType(AR);
304  }
305 
306 private:
307  Instruction *MemoryInstruction;
308  Optional<AliasResult> OptimizedAccessAlias;
309 };
310 
311 /// Represents read-only accesses to memory
312 ///
313 /// In particular, the set of Instructions that will be represented by
314 /// MemoryUse's is exactly the set of Instructions for which
315 /// AliasAnalysis::getModRefInfo returns "Ref".
316 class MemoryUse final : public MemoryUseOrDef {
317 public:
319 
321  : MemoryUseOrDef(C, DMA, MemoryUseVal, deleteMe, MI, BB,
322  /*NumOperands=*/1) {}
323 
324  // allocate space for exactly one operand
325  void *operator new(size_t s) { return User::operator new(s, 1); }
326 
327  static bool classof(const Value *MA) {
328  return MA->getValueID() == MemoryUseVal;
329  }
330 
331  void print(raw_ostream &OS) const;
332 
334  OptimizedID = DMA->getID();
335  setOperand(0, DMA);
336  }
337 
338  bool isOptimized() const {
339  return getDefiningAccess() && OptimizedID == getDefiningAccess()->getID();
340  }
341 
343  return getDefiningAccess();
344  }
345 
346  void resetOptimized() {
347  OptimizedID = INVALID_MEMORYACCESS_ID;
348  }
349 
350 protected:
351  friend class MemorySSA;
352 
353 private:
354  static void deleteMe(DerivedUser *Self);
355 
356  unsigned OptimizedID = INVALID_MEMORYACCESS_ID;
357 };
358 
359 template <>
360 struct OperandTraits<MemoryUse> : public FixedNumOperandTraits<MemoryUse, 1> {};
362 
363 /// Represents a read-write access to memory, whether it is a must-alias,
364 /// or a may-alias.
365 ///
366 /// In particular, the set of Instructions that will be represented by
367 /// MemoryDef's is exactly the set of Instructions for which
368 /// AliasAnalysis::getModRefInfo returns "Mod" or "ModRef".
369 /// Note that, in order to provide def-def chains, all defs also have a use
370 /// associated with them. This use points to the nearest reaching
371 /// MemoryDef/MemoryPhi.
372 class MemoryDef final : public MemoryUseOrDef {
373 public:
374  friend class MemorySSA;
375 
377 
379  unsigned Ver)
380  : MemoryUseOrDef(C, DMA, MemoryDefVal, deleteMe, MI, BB,
381  /*NumOperands=*/2),
382  ID(Ver) {}
383 
384  // allocate space for exactly two operands
385  void *operator new(size_t s) { return User::operator new(s, 2); }
386 
387  static bool classof(const Value *MA) {
388  return MA->getValueID() == MemoryDefVal;
389  }
390 
392  setOperand(1, MA);
393  OptimizedID = MA->getID();
394  }
395 
397  return cast_or_null<MemoryAccess>(getOperand(1));
398  }
399 
400  bool isOptimized() const {
401  return getOptimized() && OptimizedID == getOptimized()->getID();
402  }
403 
404  void resetOptimized() {
405  OptimizedID = INVALID_MEMORYACCESS_ID;
406  setOperand(1, nullptr);
407  }
408 
409  void print(raw_ostream &OS) const;
410 
411  unsigned getID() const { return ID; }
412 
413 private:
414  static void deleteMe(DerivedUser *Self);
415 
416  const unsigned ID;
417  unsigned OptimizedID = INVALID_MEMORYACCESS_ID;
418 };
419 
420 template <>
421 struct OperandTraits<MemoryDef> : public FixedNumOperandTraits<MemoryDef, 2> {};
423 
424 template <>
426  static Use *op_begin(MemoryUseOrDef *MUD) {
427  if (auto *MU = dyn_cast<MemoryUse>(MUD))
429  return OperandTraits<MemoryDef>::op_begin(cast<MemoryDef>(MUD));
430  }
431 
432  static Use *op_end(MemoryUseOrDef *MUD) {
433  if (auto *MU = dyn_cast<MemoryUse>(MUD))
435  return OperandTraits<MemoryDef>::op_end(cast<MemoryDef>(MUD));
436  }
437 
438  static unsigned operands(const MemoryUseOrDef *MUD) {
439  if (const auto *MU = dyn_cast<MemoryUse>(MUD))
441  return OperandTraits<MemoryDef>::operands(cast<MemoryDef>(MUD));
442  }
443 };
445 
446 /// Represents phi nodes for memory accesses.
447 ///
448 /// These have the same semantic as regular phi nodes, with the exception that
449 /// only one phi will ever exist in a given basic block.
450 /// Guaranteeing one phi per block means guaranteeing there is only ever one
451 /// valid reaching MemoryDef/MemoryPHI along each path to the phi node.
452 /// This is ensured by not allowing disambiguation of the RHS of a MemoryDef or
453 /// a MemoryPhi's operands.
454 /// That is, given
455 /// if (a) {
456 /// store %a
457 /// store %b
458 /// }
459 /// it *must* be transformed into
460 /// if (a) {
461 /// 1 = MemoryDef(liveOnEntry)
462 /// store %a
463 /// 2 = MemoryDef(1)
464 /// store %b
465 /// }
466 /// and *not*
467 /// if (a) {
468 /// 1 = MemoryDef(liveOnEntry)
469 /// store %a
470 /// 2 = MemoryDef(liveOnEntry)
471 /// store %b
472 /// }
473 /// even if the two stores do not conflict. Otherwise, both 1 and 2 reach the
474 /// end of the branch, and if there are not two phi nodes, one will be
475 /// disconnected completely from the SSA graph below that point.
476 /// Because MemoryUse's do not generate new definitions, they do not have this
477 /// issue.
478 class MemoryPhi final : public MemoryAccess {
479  // allocate space for exactly zero operands
480  void *operator new(size_t s) { return User::operator new(s); }
481 
482 public:
483  /// Provide fast operand accessors
485 
486  MemoryPhi(LLVMContext &C, BasicBlock *BB, unsigned Ver, unsigned NumPreds = 0)
487  : MemoryAccess(C, MemoryPhiVal, deleteMe, BB, 0), ID(Ver),
488  ReservedSpace(NumPreds) {
489  allocHungoffUses(ReservedSpace);
490  }
491 
492  // Block iterator interface. This provides access to the list of incoming
493  // basic blocks, which parallels the list of incoming values.
496 
498  auto *Ref = reinterpret_cast<Use::UserRef *>(op_begin() + ReservedSpace);
499  return reinterpret_cast<block_iterator>(Ref + 1);
500  }
501 
503  const auto *Ref =
504  reinterpret_cast<const Use::UserRef *>(op_begin() + ReservedSpace);
505  return reinterpret_cast<const_block_iterator>(Ref + 1);
506  }
507 
508  block_iterator block_end() { return block_begin() + getNumOperands(); }
509 
511  return block_begin() + getNumOperands();
512  }
513 
515  return make_range(block_begin(), block_end());
516  }
517 
519  return make_range(block_begin(), block_end());
520  }
521 
522  op_range incoming_values() { return operands(); }
523 
524  const_op_range incoming_values() const { return operands(); }
525 
526  /// Return the number of incoming edges
527  unsigned getNumIncomingValues() const { return getNumOperands(); }
528 
529  /// Return incoming value number x
530  MemoryAccess *getIncomingValue(unsigned I) const { return getOperand(I); }
531  void setIncomingValue(unsigned I, MemoryAccess *V) {
532  assert(V && "PHI node got a null value!");
533  setOperand(I, V);
534  }
535 
536  static unsigned getOperandNumForIncomingValue(unsigned I) { return I; }
537  static unsigned getIncomingValueNumForOperand(unsigned I) { return I; }
538 
539  /// Return incoming basic block number @p i.
540  BasicBlock *getIncomingBlock(unsigned I) const { return block_begin()[I]; }
541 
542  /// Return incoming basic block corresponding
543  /// to an operand of the PHI.
544  BasicBlock *getIncomingBlock(const Use &U) const {
545  assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
546  return getIncomingBlock(unsigned(&U - op_begin()));
547  }
548 
549  /// Return incoming basic block corresponding
550  /// to value use iterator.
552  return getIncomingBlock(I.getUse());
553  }
554 
555  void setIncomingBlock(unsigned I, BasicBlock *BB) {
556  assert(BB && "PHI node got a null basic block!");
557  block_begin()[I] = BB;
558  }
559 
560  /// Add an incoming value to the end of the PHI list
562  if (getNumOperands() == ReservedSpace)
563  growOperands(); // Get more space!
564  // Initialize some new operands.
565  setNumHungOffUseOperands(getNumOperands() + 1);
566  setIncomingValue(getNumOperands() - 1, V);
567  setIncomingBlock(getNumOperands() - 1, BB);
568  }
569 
570  /// Return the first index of the specified basic
571  /// block in the value list for this PHI. Returns -1 if no instance.
572  int getBasicBlockIndex(const BasicBlock *BB) const {
573  for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
574  if (block_begin()[I] == BB)
575  return I;
576  return -1;
577  }
578 
580  int Idx = getBasicBlockIndex(BB);
581  assert(Idx >= 0 && "Invalid basic block argument!");
582  return getIncomingValue(Idx);
583  }
584 
585  // After deleting incoming position I, the order of incoming may be changed.
586  void unorderedDeleteIncoming(unsigned I) {
587  unsigned E = getNumOperands();
588  assert(I < E && "Cannot remove out of bounds Phi entry.");
589  // MemoryPhi must have at least two incoming values, otherwise the MemoryPhi
590  // itself should be deleted.
591  assert(E >= 2 && "Cannot only remove incoming values in MemoryPhis with "
592  "at least 2 values.");
593  setIncomingValue(I, getIncomingValue(E - 1));
594  setIncomingBlock(I, block_begin()[E - 1]);
595  setOperand(E - 1, nullptr);
596  block_begin()[E - 1] = nullptr;
597  setNumHungOffUseOperands(getNumOperands() - 1);
598  }
599 
600  // After deleting entries that satisfy Pred, remaining entries may have
601  // changed order.
602  template <typename Fn> void unorderedDeleteIncomingIf(Fn &&Pred) {
603  for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
604  if (Pred(getIncomingValue(I), getIncomingBlock(I))) {
605  unorderedDeleteIncoming(I);
606  E = getNumOperands();
607  --I;
608  }
609  assert(getNumOperands() >= 1 &&
610  "Cannot remove all incoming blocks in a MemoryPhi.");
611  }
612 
613  // After deleting incoming block BB, the incoming blocks order may be changed.
615  unorderedDeleteIncomingIf(
616  [&](const MemoryAccess *, const BasicBlock *B) { return BB == B; });
617  }
618 
619  // After deleting incoming memory access MA, the incoming accesses order may
620  // be changed.
622  unorderedDeleteIncomingIf(
623  [&](const MemoryAccess *M, const BasicBlock *) { return MA == M; });
624  }
625 
626  static bool classof(const Value *V) {
627  return V->getValueID() == MemoryPhiVal;
628  }
629 
630  void print(raw_ostream &OS) const;
631 
632  unsigned getID() const { return ID; }
633 
634 protected:
635  friend class MemorySSA;
636 
637  /// this is more complicated than the generic
638  /// User::allocHungoffUses, because we have to allocate Uses for the incoming
639  /// values and pointers to the incoming blocks, all in one allocation.
640  void allocHungoffUses(unsigned N) {
641  User::allocHungoffUses(N, /* IsPhi */ true);
642  }
643 
644 private:
645  // For debugging only
646  const unsigned ID;
647  unsigned ReservedSpace;
648 
649  /// This grows the operand list in response to a push_back style of
650  /// operation. This grows the number of ops by 1.5 times.
651  void growOperands() {
652  unsigned E = getNumOperands();
653  // 2 op PHI nodes are VERY common, so reserve at least enough for that.
654  ReservedSpace = std::max(E + E / 2, 2u);
655  growHungoffUses(ReservedSpace, /* IsPhi */ true);
656  }
657 
658  static void deleteMe(DerivedUser *Self);
659 };
660 
661 inline unsigned MemoryAccess::getID() const {
662  assert((isa<MemoryDef>(this) || isa<MemoryPhi>(this)) &&
663  "only memory defs and phis have ids");
664  if (const auto *MD = dyn_cast<MemoryDef>(this))
665  return MD->getID();
666  return cast<MemoryPhi>(this)->getID();
667 }
668 
669 inline bool MemoryUseOrDef::isOptimized() const {
670  if (const auto *MD = dyn_cast<MemoryDef>(this))
671  return MD->isOptimized();
672  return cast<MemoryUse>(this)->isOptimized();
673 }
674 
676  if (const auto *MD = dyn_cast<MemoryDef>(this))
677  return MD->getOptimized();
678  return cast<MemoryUse>(this)->getOptimized();
679 }
680 
682  if (auto *MD = dyn_cast<MemoryDef>(this))
683  MD->setOptimized(MA);
684  else
685  cast<MemoryUse>(this)->setOptimized(MA);
686 }
687 
689  if (auto *MD = dyn_cast<MemoryDef>(this))
690  MD->resetOptimized();
691  else
692  cast<MemoryUse>(this)->resetOptimized();
693 }
694 
695 template <> struct OperandTraits<MemoryPhi> : public HungoffOperandTraits<2> {};
697 
698 /// Encapsulates MemorySSA, including all data associated with memory
699 /// accesses.
700 class MemorySSA {
701 public:
703 
704  // MemorySSA must remain where it's constructed; Walkers it creates store
705  // pointers to it.
706  MemorySSA(MemorySSA &&) = delete;
707 
708  ~MemorySSA();
709 
710  MemorySSAWalker *getWalker();
711  MemorySSAWalker *getSkipSelfWalker();
712 
713  /// Given a memory Mod/Ref'ing instruction, get the MemorySSA
714  /// access associated with it. If passed a basic block gets the memory phi
715  /// node that exists for that block, if there is one. Otherwise, this will get
716  /// a MemoryUseOrDef.
718  return cast_or_null<MemoryUseOrDef>(ValueToMemoryAccess.lookup(I));
719  }
720 
721  MemoryPhi *getMemoryAccess(const BasicBlock *BB) const {
722  return cast_or_null<MemoryPhi>(ValueToMemoryAccess.lookup(cast<Value>(BB)));
723  }
724 
725  void dump() const;
726  void print(raw_ostream &) const;
727 
728  /// Return true if \p MA represents the live on entry value
729  ///
730  /// Loads and stores from pointer arguments and other global values may be
731  /// defined by memory operations that do not occur in the current function, so
732  /// they may be live on entry to the function. MemorySSA represents such
733  /// memory state by the live on entry definition, which is guaranteed to occur
734  /// before any other memory access in the function.
735  inline bool isLiveOnEntryDef(const MemoryAccess *MA) const {
736  return MA == LiveOnEntryDef.get();
737  }
738 
739  inline MemoryAccess *getLiveOnEntryDef() const {
740  return LiveOnEntryDef.get();
741  }
742 
743  // Sadly, iplists, by default, owns and deletes pointers added to the
744  // list. It's not currently possible to have two iplists for the same type,
745  // where one owns the pointers, and one does not. This is because the traits
746  // are per-type, not per-tag. If this ever changes, we should make the
747  // DefList an iplist.
749  using DefsList =
751 
752  /// Return the list of MemoryAccess's for a given basic block.
753  ///
754  /// This list is not modifiable by the user.
755  const AccessList *getBlockAccesses(const BasicBlock *BB) const {
756  return getWritableBlockAccesses(BB);
757  }
758 
759  /// Return the list of MemoryDef's and MemoryPhi's for a given basic
760  /// block.
761  ///
762  /// This list is not modifiable by the user.
763  const DefsList *getBlockDefs(const BasicBlock *BB) const {
764  return getWritableBlockDefs(BB);
765  }
766 
767  /// Given two memory accesses in the same basic block, determine
768  /// whether MemoryAccess \p A dominates MemoryAccess \p B.
769  bool locallyDominates(const MemoryAccess *A, const MemoryAccess *B) const;
770 
771  /// Given two memory accesses in potentially different blocks,
772  /// determine whether MemoryAccess \p A dominates MemoryAccess \p B.
773  bool dominates(const MemoryAccess *A, const MemoryAccess *B) const;
774 
775  /// Given a MemoryAccess and a Use, determine whether MemoryAccess \p A
776  /// dominates Use \p B.
777  bool dominates(const MemoryAccess *A, const Use &B) const;
778 
779  /// Verify that MemorySSA is self consistent (IE definitions dominate
780  /// all uses, uses appear in the right places). This is used by unit tests.
781  void verifyMemorySSA() const;
782 
783  /// Used in various insertion functions to specify whether we are talking
784  /// about the beginning or end of a block.
785  enum InsertionPlace { Beginning, End };
786 
787 protected:
788  // Used by Memory SSA annotater, dumpers, and wrapper pass
791  friend class MemorySSAUpdater;
792 
793  void verifyDefUses(Function &F) const;
794  void verifyDomination(Function &F) const;
795  void verifyOrdering(Function &F) const;
796  void verifyDominationNumbers(const Function &F) const;
797 
798  // This is used by the use optimizer and updater.
800  auto It = PerBlockAccesses.find(BB);
801  return It == PerBlockAccesses.end() ? nullptr : It->second.get();
802  }
803 
804  // This is used by the use optimizer and updater.
806  auto It = PerBlockDefs.find(BB);
807  return It == PerBlockDefs.end() ? nullptr : It->second.get();
808  }
809 
810  // These is used by the updater to perform various internal MemorySSA
811  // machinsations. They do not always leave the IR in a correct state, and
812  // relies on the updater to fixup what it breaks, so it is not public.
813 
814  void moveTo(MemoryUseOrDef *What, BasicBlock *BB, AccessList::iterator Where);
815  void moveTo(MemoryAccess *What, BasicBlock *BB, InsertionPlace Point);
816 
817  // Rename the dominator tree branch rooted at BB.
818  void renamePass(BasicBlock *BB, MemoryAccess *IncomingVal,
820  renamePass(DT->getNode(BB), IncomingVal, Visited, true, true);
821  }
822 
823  void removeFromLookups(MemoryAccess *);
824  void removeFromLists(MemoryAccess *, bool ShouldDelete = true);
825  void insertIntoListsForBlock(MemoryAccess *, const BasicBlock *,
827  void insertIntoListsBefore(MemoryAccess *, const BasicBlock *,
828  AccessList::iterator);
829  MemoryUseOrDef *createDefinedAccess(Instruction *, MemoryAccess *,
830  const MemoryUseOrDef *Template = nullptr);
831 
832 private:
833  template <class AliasAnalysisType> class ClobberWalkerBase;
834  template <class AliasAnalysisType> class CachingWalker;
835  template <class AliasAnalysisType> class SkipSelfWalker;
836  class OptimizeUses;
837 
838  CachingWalker<AliasAnalysis> *getWalkerImpl();
839  void buildMemorySSA(BatchAAResults &BAA);
840  void optimizeUses();
841 
842  void prepareForMoveTo(MemoryAccess *, BasicBlock *);
843  void verifyUseInDefs(MemoryAccess *, MemoryAccess *) const;
844 
847 
848  void
849  determineInsertionPoint(const SmallPtrSetImpl<BasicBlock *> &DefiningBlocks);
850  void markUnreachableAsLiveOnEntry(BasicBlock *BB);
851  bool dominatesUse(const MemoryAccess *, const MemoryAccess *) const;
852  MemoryPhi *createMemoryPhi(BasicBlock *BB);
853  template <typename AliasAnalysisType>
854  MemoryUseOrDef *createNewAccess(Instruction *, AliasAnalysisType *,
855  const MemoryUseOrDef *Template = nullptr);
856  MemoryAccess *findDominatingDef(BasicBlock *, enum InsertionPlace);
857  void placePHINodes(const SmallPtrSetImpl<BasicBlock *> &);
858  MemoryAccess *renameBlock(BasicBlock *, MemoryAccess *, bool);
859  void renameSuccessorPhis(BasicBlock *, MemoryAccess *, bool);
860  void renamePass(DomTreeNode *, MemoryAccess *IncomingVal,
862  bool SkipVisited = false, bool RenameAllUses = false);
863  AccessList *getOrCreateAccessList(const BasicBlock *);
864  DefsList *getOrCreateDefsList(const BasicBlock *);
865  void renumberBlock(const BasicBlock *) const;
866  AliasAnalysis *AA;
867  DominatorTree *DT;
868  Function &F;
869 
870  // Memory SSA mappings
871  DenseMap<const Value *, MemoryAccess *> ValueToMemoryAccess;
872 
873  // These two mappings contain the main block to access/def mappings for
874  // MemorySSA. The list contained in PerBlockAccesses really owns all the
875  // MemoryAccesses.
876  // Both maps maintain the invariant that if a block is found in them, the
877  // corresponding list is not empty, and if a block is not found in them, the
878  // corresponding list is empty.
879  AccessMap PerBlockAccesses;
880  DefsMap PerBlockDefs;
881  std::unique_ptr<MemoryAccess, ValueDeleter> LiveOnEntryDef;
882 
883  // Domination mappings
884  // Note that the numbering is local to a block, even though the map is
885  // global.
886  mutable SmallPtrSet<const BasicBlock *, 16> BlockNumberingValid;
887  mutable DenseMap<const MemoryAccess *, unsigned long> BlockNumbering;
888 
889  // Memory SSA building info
890  std::unique_ptr<ClobberWalkerBase<AliasAnalysis>> WalkerBase;
891  std::unique_ptr<CachingWalker<AliasAnalysis>> Walker;
892  std::unique_ptr<SkipSelfWalker<AliasAnalysis>> SkipWalker;
893  unsigned NextID;
894 };
895 
896 // Internal MemorySSA utils, for use by MemorySSA classes and walkers
898 protected:
899  friend class GVNHoist;
900  friend class MemorySSAWalker;
901 
902  // This function should not be used by new passes.
903  static bool defClobbersUseOrDef(MemoryDef *MD, const MemoryUseOrDef *MU,
904  AliasAnalysis &AA);
905 };
906 
907 // This pass does eager building and then printing of MemorySSA. It is used by
908 // the tests to be able to build, dump, and verify Memory SSA.
910 public:
912 
913  bool runOnFunction(Function &) override;
914  void getAnalysisUsage(AnalysisUsage &AU) const override;
915 
916  static char ID;
917 };
918 
919 /// An analysis that produces \c MemorySSA for a function.
920 ///
921 class MemorySSAAnalysis : public AnalysisInfoMixin<MemorySSAAnalysis> {
923 
924  static AnalysisKey Key;
925 
926 public:
927  // Wrap MemorySSA result to ensure address stability of internal MemorySSA
928  // pointers after construction. Use a wrapper class instead of plain
929  // unique_ptr<MemorySSA> to avoid build breakage on MSVC.
930  struct Result {
931  Result(std::unique_ptr<MemorySSA> &&MSSA) : MSSA(std::move(MSSA)) {}
932 
933  MemorySSA &getMSSA() { return *MSSA.get(); }
934 
935  std::unique_ptr<MemorySSA> MSSA;
936  };
937 
939 };
940 
941 /// Printer pass for \c MemorySSA.
942 class MemorySSAPrinterPass : public PassInfoMixin<MemorySSAPrinterPass> {
943  raw_ostream &OS;
944 
945 public:
946  explicit MemorySSAPrinterPass(raw_ostream &OS) : OS(OS) {}
947 
949 };
950 
951 /// Verifier pass for \c MemorySSA.
952 struct MemorySSAVerifierPass : PassInfoMixin<MemorySSAVerifierPass> {
954 };
955 
956 /// Legacy analysis pass which computes \c MemorySSA.
958 public:
960 
961  static char ID;
962 
963  bool runOnFunction(Function &) override;
964  void releaseMemory() override;
965  MemorySSA &getMSSA() { return *MSSA; }
966  const MemorySSA &getMSSA() const { return *MSSA; }
967 
968  void getAnalysisUsage(AnalysisUsage &AU) const override;
969 
970  void verifyAnalysis() const override;
971  void print(raw_ostream &OS, const Module *M = nullptr) const override;
972 
973 private:
974  std::unique_ptr<MemorySSA> MSSA;
975 };
976 
977 /// This is the generic walker interface for walkers of MemorySSA.
978 /// Walkers are used to be able to further disambiguate the def-use chains
979 /// MemorySSA gives you, or otherwise produce better info than MemorySSA gives
980 /// you.
981 /// In particular, while the def-use chains provide basic information, and are
982 /// guaranteed to give, for example, the nearest may-aliasing MemoryDef for a
983 /// MemoryUse as AliasAnalysis considers it, a user mant want better or other
984 /// information. In particular, they may want to use SCEV info to further
985 /// disambiguate memory accesses, or they may want the nearest dominating
986 /// may-aliasing MemoryDef for a call or a store. This API enables a
987 /// standardized interface to getting and using that info.
989 public:
991  virtual ~MemorySSAWalker() = default;
992 
994 
995  /// Given a memory Mod/Ref/ModRef'ing instruction, calling this
996  /// will give you the nearest dominating MemoryAccess that Mod's the location
997  /// the instruction accesses (by skipping any def which AA can prove does not
998  /// alias the location(s) accessed by the instruction given).
999  ///
1000  /// Note that this will return a single access, and it must dominate the
1001  /// Instruction, so if an operand of a MemoryPhi node Mod's the instruction,
1002  /// this will return the MemoryPhi, not the operand. This means that
1003  /// given:
1004  /// if (a) {
1005  /// 1 = MemoryDef(liveOnEntry)
1006  /// store %a
1007  /// } else {
1008  /// 2 = MemoryDef(liveOnEntry)
1009  /// store %b
1010  /// }
1011  /// 3 = MemoryPhi(2, 1)
1012  /// MemoryUse(3)
1013  /// load %a
1014  ///
1015  /// calling this API on load(%a) will return the MemoryPhi, not the MemoryDef
1016  /// in the if (a) branch.
1018  MemoryAccess *MA = MSSA->getMemoryAccess(I);
1019  assert(MA && "Handed an instruction that MemorySSA doesn't recognize?");
1020  return getClobberingMemoryAccess(MA);
1021  }
1022 
1023  /// Does the same thing as getClobberingMemoryAccess(const Instruction *I),
1024  /// but takes a MemoryAccess instead of an Instruction.
1025  virtual MemoryAccess *getClobberingMemoryAccess(MemoryAccess *) = 0;
1026 
1027  /// Given a potentially clobbering memory access and a new location,
1028  /// calling this will give you the nearest dominating clobbering MemoryAccess
1029  /// (by skipping non-aliasing def links).
1030  ///
1031  /// This version of the function is mainly used to disambiguate phi translated
1032  /// pointers, where the value of a pointer may have changed from the initial
1033  /// memory access. Note that this expects to be handed either a MemoryUse,
1034  /// or an already potentially clobbering access. Unlike the above API, if
1035  /// given a MemoryDef that clobbers the pointer as the starting access, it
1036  /// will return that MemoryDef, whereas the above would return the clobber
1037  /// starting from the use side of the memory def.
1038  virtual MemoryAccess *getClobberingMemoryAccess(MemoryAccess *,
1039  const MemoryLocation &) = 0;
1040 
1041  /// Given a memory access, invalidate anything this walker knows about
1042  /// that access.
1043  /// This API is used by walkers that store information to perform basic cache
1044  /// invalidation. This will be called by MemorySSA at appropriate times for
1045  /// the walker it uses or returns.
1046  virtual void invalidateInfo(MemoryAccess *) {}
1047 
1048 protected:
1049  friend class MemorySSA; // For updating MSSA pointer in MemorySSA move
1050  // constructor.
1052 };
1053 
1054 /// A MemorySSAWalker that does no alias queries, or anything else. It
1055 /// simply returns the links as they were constructed by the builder.
1057 public:
1058  // Keep the overrides below from hiding the Instruction overload of
1059  // getClobberingMemoryAccess.
1061 
1062  MemoryAccess *getClobberingMemoryAccess(MemoryAccess *) override;
1063  MemoryAccess *getClobberingMemoryAccess(MemoryAccess *,
1064  const MemoryLocation &) override;
1065 };
1066 
1067 using MemoryAccessPair = std::pair<MemoryAccess *, MemoryLocation>;
1068 using ConstMemoryAccessPair = std::pair<const MemoryAccess *, MemoryLocation>;
1069 
1070 /// Iterator base class used to implement const and non-const iterators
1071 /// over the defining accesses of a MemoryAccess.
1072 template <class T>
1074  : public iterator_facade_base<memoryaccess_def_iterator_base<T>,
1075  std::forward_iterator_tag, T, ptrdiff_t, T *,
1076  T *> {
1077  using BaseT = typename memoryaccess_def_iterator_base::iterator_facade_base;
1078 
1079 public:
1080  memoryaccess_def_iterator_base(T *Start) : Access(Start) {}
1081  memoryaccess_def_iterator_base() = default;
1082 
1083  bool operator==(const memoryaccess_def_iterator_base &Other) const {
1084  return Access == Other.Access && (!Access || ArgNo == Other.ArgNo);
1085  }
1086 
1087  // This is a bit ugly, but for MemoryPHI's, unlike PHINodes, you can't get the
1088  // block from the operand in constant time (In a PHINode, the uselist has
1089  // both, so it's just subtraction). We provide it as part of the
1090  // iterator to avoid callers having to linear walk to get the block.
1091  // If the operation becomes constant time on MemoryPHI's, this bit of
1092  // abstraction breaking should be removed.
1094  MemoryPhi *MP = dyn_cast<MemoryPhi>(Access);
1095  assert(MP && "Tried to get phi arg block when not iterating over a PHI");
1096  return MP->getIncomingBlock(ArgNo);
1097  }
1098 
1099  typename BaseT::iterator::pointer operator*() const {
1100  assert(Access && "Tried to access past the end of our iterator");
1101  // Go to the first argument for phis, and the defining access for everything
1102  // else.
1103  if (MemoryPhi *MP = dyn_cast<MemoryPhi>(Access))
1104  return MP->getIncomingValue(ArgNo);
1105  return cast<MemoryUseOrDef>(Access)->getDefiningAccess();
1106  }
1107 
1108  using BaseT::operator++;
1110  assert(Access && "Hit end of iterator");
1111  if (MemoryPhi *MP = dyn_cast<MemoryPhi>(Access)) {
1112  if (++ArgNo >= MP->getNumIncomingValues()) {
1113  ArgNo = 0;
1114  Access = nullptr;
1115  }
1116  } else {
1117  Access = nullptr;
1118  }
1119  return *this;
1120  }
1121 
1122 private:
1123  T *Access = nullptr;
1124  unsigned ArgNo = 0;
1125 };
1126 
1128  return memoryaccess_def_iterator(this);
1129 }
1130 
1132  return const_memoryaccess_def_iterator(this);
1133 }
1134 
1136  return memoryaccess_def_iterator();
1137 }
1138 
1141 }
1142 
1143 /// GraphTraits for a MemoryAccess, which walks defs in the normal case,
1144 /// and uses in the inverse case.
1145 template <> struct GraphTraits<MemoryAccess *> {
1148 
1149  static NodeRef getEntryNode(NodeRef N) { return N; }
1151  static ChildIteratorType child_end(NodeRef N) { return N->defs_end(); }
1152 };
1153 
1154 template <> struct GraphTraits<Inverse<MemoryAccess *>> {
1157 
1158  static NodeRef getEntryNode(NodeRef N) { return N; }
1160  static ChildIteratorType child_end(NodeRef N) { return N->user_end(); }
1161 };
1162 
1163 /// Provide an iterator that walks defs, giving both the memory access,
1164 /// and the current pointer location, updating the pointer location as it
1165 /// changes due to phi node translation.
1166 ///
1167 /// This iterator, while somewhat specialized, is what most clients actually
1168 /// want when walking upwards through MemorySSA def chains. It takes a pair of
1169 /// <MemoryAccess,MemoryLocation>, and walks defs, properly translating the
1170 /// memory location through phi nodes for the user.
1172  : public iterator_facade_base<upward_defs_iterator,
1173  std::forward_iterator_tag,
1174  const MemoryAccessPair> {
1175  using BaseT = upward_defs_iterator::iterator_facade_base;
1176 
1177 public:
1179  : DefIterator(Info.first), Location(Info.second),
1180  OriginalAccess(Info.first) {
1181  CurrentPair.first = nullptr;
1182 
1183  WalkingPhi = Info.first && isa<MemoryPhi>(Info.first);
1184  fillInCurrentPair();
1185  }
1186 
1187  upward_defs_iterator() { CurrentPair.first = nullptr; }
1188 
1189  bool operator==(const upward_defs_iterator &Other) const {
1190  return DefIterator == Other.DefIterator;
1191  }
1192 
1193  BaseT::iterator::reference operator*() const {
1194  assert(DefIterator != OriginalAccess->defs_end() &&
1195  "Tried to access past the end of our iterator");
1196  return CurrentPair;
1197  }
1198 
1199  using BaseT::operator++;
1201  assert(DefIterator != OriginalAccess->defs_end() &&
1202  "Tried to access past the end of the iterator");
1203  ++DefIterator;
1204  if (DefIterator != OriginalAccess->defs_end())
1205  fillInCurrentPair();
1206  return *this;
1207  }
1208 
1209  BasicBlock *getPhiArgBlock() const { return DefIterator.getPhiArgBlock(); }
1210 
1211 private:
1212  void fillInCurrentPair() {
1213  CurrentPair.first = *DefIterator;
1214  if (WalkingPhi && Location.Ptr) {
1215  PHITransAddr Translator(
1216  const_cast<Value *>(Location.Ptr),
1217  OriginalAccess->getBlock()->getModule()->getDataLayout(), nullptr);
1218  if (!Translator.PHITranslateValue(OriginalAccess->getBlock(),
1219  DefIterator.getPhiArgBlock(), nullptr,
1220  false))
1221  if (Translator.getAddr() != Location.Ptr) {
1222  CurrentPair.second = Location.getWithNewPtr(Translator.getAddr());
1223  return;
1224  }
1225  }
1226  CurrentPair.second = Location;
1227  }
1228 
1229  MemoryAccessPair CurrentPair;
1230  memoryaccess_def_iterator DefIterator;
1231  MemoryLocation Location;
1232  MemoryAccess *OriginalAccess = nullptr;
1233  bool WalkingPhi = false;
1234 };
1235 
1237  return upward_defs_iterator(Pair);
1238 }
1239 
1241 
1244  return make_range(upward_defs_begin(Pair), upward_defs_end());
1245 }
1246 
1247 /// Walks the defining accesses of MemoryDefs. Stops after we hit something that
1248 /// has no defining use (e.g. a MemoryPhi or liveOnEntry). Note that, when
1249 /// comparing against a null def_chain_iterator, this will compare equal only
1250 /// after walking said Phi/liveOnEntry.
1251 ///
1252 /// The UseOptimizedChain flag specifies whether to walk the clobbering
1253 /// access chain, or all the accesses.
1254 ///
1255 /// Normally, MemoryDef are all just def/use linked together, so a def_chain on
1256 /// a MemoryDef will walk all MemoryDefs above it in the program until it hits
1257 /// a phi node. The optimized chain walks the clobbering access of a store.
1258 /// So if you are just trying to find, given a store, what the next
1259 /// thing that would clobber the same memory is, you want the optimized chain.
1260 template <class T, bool UseOptimizedChain = false>
1262  : public iterator_facade_base<def_chain_iterator<T, UseOptimizedChain>,
1263  std::forward_iterator_tag, MemoryAccess *> {
1264  def_chain_iterator() : MA(nullptr) {}
1265  def_chain_iterator(T MA) : MA(MA) {}
1266 
1267  T operator*() const { return MA; }
1268 
1270  // N.B. liveOnEntry has a null defining access.
1271  if (auto *MUD = dyn_cast<MemoryUseOrDef>(MA)) {
1272  if (UseOptimizedChain && MUD->isOptimized())
1273  MA = MUD->getOptimized();
1274  else
1275  MA = MUD->getDefiningAccess();
1276  } else {
1277  MA = nullptr;
1278  }
1279 
1280  return *this;
1281  }
1282 
1283  bool operator==(const def_chain_iterator &O) const { return MA == O.MA; }
1284 
1285 private:
1286  T MA;
1287 };
1288 
1289 template <class T>
1291 def_chain(T MA, MemoryAccess *UpTo = nullptr) {
1292 #ifdef EXPENSIVE_CHECKS
1293  assert((!UpTo || find(def_chain(MA), UpTo) != def_chain_iterator<T>()) &&
1294  "UpTo isn't in the def chain!");
1295 #endif
1297 }
1298 
1299 template <class T>
1302  def_chain_iterator<T, true>(nullptr));
1303 }
1304 
1305 } // end namespace llvm
1306 
1307 #endif // LLVM_ANALYSIS_MEMORYSSA_H
uint64_t CallInst * C
AccessList * getWritableBlockAccesses(const BasicBlock *BB) const
Definition: MemorySSA.h:799
memoryaccess_def_iterator & operator++()
Definition: MemorySSA.h:1109
BasicBlock * getIncomingBlock(MemoryAccess::const_user_iterator I) const
Return incoming basic block corresponding to value use iterator.
Definition: MemorySSA.h:551
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition: Value.h:463
void unorderedDeleteIncomingValue(const MemoryAccess *MA)
Definition: MemorySSA.h:621
This class represents lattice values for constants.
Definition: AllocatorList.h:23
void unorderedDeleteIncomingIf(Fn &&Pred)
Definition: MemorySSA.h:602
Result(std::unique_ptr< MemorySSA > &&MSSA)
Definition: MemorySSA.h:931
AllAccessType::self_iterator getIterator()
Get the iterators for the all access list and the defs only list We default to the all access list...
Definition: MemorySSA.h:175
BasicBlock * getIncomingBlock(const Use &U) const
Return incoming basic block corresponding to an operand of the PHI.
Definition: MemorySSA.h:544
MemoryAccess * getDefiningAccess() const
Get the access that produces the memory state used by this Use.
Definition: MemorySSA.h:254
MemorySSAPrinterPass(raw_ostream &OS)
Definition: MemorySSA.h:946
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
void resetOptimized()
Definition: MemorySSA.h:346
const MemorySSA & getMSSA() const
Definition: MemorySSA.h:966
const AccessList * getBlockAccesses(const BasicBlock *BB) const
Return the list of MemoryAccess&#39;s for a given basic block.
Definition: MemorySSA.h:755
BasicBlock *const * const_block_iterator
Definition: MemorySSA.h:495
This provides a very simple, boring adaptor for a begin and end iterator into a range type...
MemoryAccess * getOptimized() const
Definition: MemorySSA.h:396
Extension point for the Value hierarchy.
Definition: DerivedUser.h:27
Represents a read-write access to memory, whether it is a must-alias, or a may-alias.
Definition: MemorySSA.h:372
BaseT::iterator::reference operator*() const
Definition: MemorySSA.h:1193
void setOptimized(MemoryAccess *)
Definition: MemorySSA.h:681
void deleteValue()
Delete a pointer to a generic Value.
Definition: Value.cpp:98
BasicBlock * getPhiArgBlock() const
Definition: MemorySSA.h:1093
memoryaccess_def_iterator defs_begin()
This iterator walks over all of the defs in a given MemoryAccess.
Definition: MemorySSA.h:1127
unsigned second
F(f)
int getBasicBlockIndex(const BasicBlock *BB) const
Return the first index of the specified basic block in the value list for this PHI.
Definition: MemorySSA.h:572
void(*)(DerivedUser *) DeleteValueTy
Definition: DerivedUser.h:29
This defines the Use class.
AllAccessType::const_self_iterator getIterator() const
Definition: MemorySSA.h:178
DefsOnlyType::self_iterator getDefsIterator()
Definition: MemorySSA.h:187
void setIncomingValue(unsigned I, MemoryAccess *V)
Definition: MemorySSA.h:531
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:343
MemoryPhi * getMemoryAccess(const BasicBlock *BB) const
Definition: MemorySSA.h:721
Represents read-only accesses to memory.
Definition: MemorySSA.h:316
This class is a batch walker of all MemoryUse&#39;s in the program, and points their defining access at t...
Definition: MemorySSA.cpp:1254
Legacy analysis pass which computes MemorySSA.
Definition: MemorySSA.h:957
Definition: BitVector.h:937
void resetOptimized()
Reset the ID of what this MemoryUse was optimized to, causing it to be rewalked by the walker if nece...
Definition: MemorySSA.h:688
void renamePass(BasicBlock *BB, MemoryAccess *IncomingVal, SmallPtrSetImpl< BasicBlock *> &Visited)
Definition: MemorySSA.h:818
block_iterator block_begin()
Definition: MemorySSA.h:497
A Use represents the edge between a Value definition and its users.
Definition: Use.h:55
Encapsulates MemorySSA, including all data associated with memory accesses.
Definition: MemorySSA.h:700
The access may reference the value stored in memory.
const DefsList * getBlockDefs(const BasicBlock *BB) const
Return the list of MemoryDef&#39;s and MemoryPhi&#39;s for a given basic block.
Definition: MemorySSA.h:763
const_block_iterator block_end() const
Definition: MemorySSA.h:510
bool isOptimized() const
Definition: MemorySSA.h:400
Walks the defining accesses of MemoryDefs.
Definition: MemorySSA.h:1261
def_chain_iterator & operator++()
Definition: MemorySSA.h:1269
bool isOptimized() const
Definition: MemorySSA.h:669
BaseT::iterator::pointer operator*() const
Definition: MemorySSA.h:1099
static bool classof(const Value *MA)
Definition: MemorySSA.h:387
iterator_range< block_iterator > blocks()
Definition: MemorySSA.h:514
A simple intrusive list implementation.
Definition: simple_ilist.h:78
Key
PAL metadata keys.
#define DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CLASS, VALUECLASS)
Macro for generating out-of-class operand accessor definitions.
User * getUser() const LLVM_READONLY
Returns the User that contains this Use.
Definition: Use.cpp:40
static ChildIteratorType child_end(NodeRef N)
Definition: MemorySSA.h:1160
static int getID(struct InternalInstruction *insn, const void *miiArg)
MemoryUseOrDef * getMemoryAccess(const Instruction *I) const
Given a memory Mod/Ref&#39;ing instruction, get the MemorySSA access associated with it.
Definition: MemorySSA.h:717
MemoryAccess * getOptimized() const
Definition: MemorySSA.h:342
AllAccessType::const_reverse_self_iterator getReverseIterator() const
Definition: MemorySSA.h:184
upward_defs_iterator upward_defs_end()
Definition: MemorySSA.h:1240
std::unique_ptr< MemorySSA > MSSA
Definition: MemorySSA.h:935
void unorderedDeleteIncoming(unsigned I)
Definition: MemorySSA.h:586
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:365
This class is a wrapper over an AAResults, and it is intended to be used only when there are no IR ch...
This is the generic walker interface for walkers of MemorySSA.
Definition: MemorySSA.h:988
CRTP base class which implements the entire standard iterator facade in terms of a minimal subset of ...
Definition: iterator.h:67
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree...
Definition: Dominators.h:144
op_range incoming_values()
Definition: MemorySSA.h:522
memoryaccess_def_iterator defs_end()
Definition: MemorySSA.h:1135
Analysis containing CSE Info
Definition: CSEInfo.cpp:20
unsigned getID() const
Definition: MemorySSA.h:632
MemoryAccess * getIncomingValue(unsigned I) const
Return incoming value number x.
Definition: MemorySSA.h:530
const_block_iterator block_begin() const
Definition: MemorySSA.h:502
An assembly annotator class to print Memory SSA information in comments.
Definition: MemorySSA.cpp:92
Use delete by default for iplist and ilist.
Definition: ilist.h:40
static bool runOnFunction(Function &F, bool PostInlining)
static Use * op_end(MemoryUseOrDef *MUD)
Definition: MemorySSA.h:432
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
void dump(const SparseBitVector< ElementSize > &LHS, raw_ostream &out)
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:153
DefsOnlyType::const_reverse_self_iterator getReverseDefsIterator() const
Definition: MemorySSA.h:196
AllAccessType::reverse_self_iterator getReverseIterator()
Definition: MemorySSA.h:181
LLVM Basic Block Representation.
Definition: BasicBlock.h:57
PointerIntPair - This class implements a pair of a pointer and small integer.
PHITransAddr - An address value which tracks and handles phi translation.
Definition: PHITransAddr.h:35
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:64
const_op_range incoming_values() const
Definition: MemorySSA.h:524
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
upward_defs_iterator & operator++()
Definition: MemorySSA.h:1200
void addIncoming(MemoryAccess *V, BasicBlock *BB)
Add an incoming value to the end of the PHI list.
Definition: MemorySSA.h:561
early cse Early CSE w MemorySSA
Definition: EarlyCSE.cpp:1372
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:382
static unsigned getIncomingValueNumForOperand(unsigned I)
Definition: MemorySSA.h:537
void setIncomingBlock(unsigned I, BasicBlock *BB)
Definition: MemorySSA.h:555
upward_defs_iterator(const MemoryAccessPair &Info)
Definition: MemorySSA.h:1178
InsertionPlace
Used in various insertion functions to specify whether we are talking about the beginning or end of a...
Definition: MemorySSA.h:785
Represent the analysis usage information of a pass.
iterator_range< def_chain_iterator< T, true > > optimized_def_chain(T MA)
Definition: MemorySSA.h:1300
void print(raw_ostream &OS) const
Definition: MemorySSA.cpp:2104
Printer pass for MemorySSA.
Definition: MemorySSA.h:942
static unsigned getOperandNumForIncomingValue(unsigned I)
Definition: MemorySSA.h:536
FunctionPass class - This class is used to implement most global optimizations.
Definition: Pass.h:284
static bool classof(const Value *MA)
Definition: MemorySSA.h:327
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
static unsigned operands(const MemoryUseOrDef *MUD)
Definition: MemorySSA.h:438
BasicBlock * getPhiArgBlock() const
Definition: MemorySSA.h:1209
virtual void invalidateInfo(MemoryAccess *)
Given a memory access, invalidate anything this walker knows about that access.
Definition: MemorySSA.h:1046
Iterator base class used to implement const and non-const iterators over the defining accesses of a M...
Definition: MemorySSA.h:127
#define DECLARE_TRANSPARENT_OPERAND_ACCESSORS(VALUECLASS)
Macro for generating in-class operand accessor declarations.
Provide an iterator that walks defs, giving both the memory access, and the current pointer location...
Definition: MemorySSA.h:1171
auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range))
Provide wrappers to std::find which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1206
An intrusive list with ownership and callbacks specified/controlled by ilist_traits, only with API safe for polymorphic types.
Definition: ilist.h:388
MemoryAccess * getOptimized() const
Definition: MemorySSA.h:675
A MemorySSAWalker that does no alias queries, or anything else.
Definition: MemorySSA.h:1056
std::pair< const MemoryAccess *, MemoryLocation > ConstMemoryAccessPair
Definition: MemorySSA.h:1068
static void deleteNode(MemoryAccess *MA)
Definition: MemorySSA.h:229
unsigned first
bool operator==(const memoryaccess_def_iterator_base &Other) const
Definition: MemorySSA.h:1083
bool isOptimized() const
Definition: MemorySSA.h:338
The two locations may or may not alias. This is the least precise result.
Definition: AliasAnalysis.h:86
Representation for a specific memory location.
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
void setDefiningAccess(MemoryAccess *DMA, bool Optimized=false, Optional< AliasResult > AR=MayAlias)
Definition: MemorySSA.h:296
Iterator for intrusive lists based on ilist_node.
static bool classof(const Value *V)
Definition: MemorySSA.h:626
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements...
Definition: SmallPtrSet.h:417
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:841
Module.h This file contains the declarations for the Module class.
An analysis that produces MemorySSA for a function.
Definition: MemorySSA.h:921
BasicBlock * getBlock() const
Definition: MemorySSA.h:156
void unorderedDeleteIncomingBlock(const BasicBlock *BB)
Definition: MemorySSA.h:614
MemoryUseOrDef(LLVMContext &C, MemoryAccess *DMA, unsigned Vty, DeleteValueTy DeleteValue, Instruction *MI, BasicBlock *BB, unsigned NumOperands)
Definition: MemorySSA.h:281
MemoryAccess * getLiveOnEntryDef() const
Definition: MemorySSA.h:739
Verifier pass for MemorySSA.
Definition: MemorySSA.h:952
A range adaptor for a pair of iterators.
MemoryPhi(LLVMContext &C, BasicBlock *BB, unsigned Ver, unsigned NumPreds=0)
Definition: MemorySSA.h:486
static Use * op_begin(MemoryUseOrDef *MUD)
Definition: MemorySSA.h:426
Class that has the common methods + fields of memory uses/defs.
Definition: MemorySSA.h:244
unsigned getNumIncomingValues() const
Return the number of incoming edges.
Definition: MemorySSA.h:527
BasicBlock * getIncomingBlock(unsigned I) const
Return incoming basic block number i.
Definition: MemorySSA.h:540
Instruction * getMemoryInst() const
Get the instruction that this MemoryUse represents.
Definition: MemorySSA.h:251
iterator_range< const_block_iterator > blocks() const
Definition: MemorySSA.h:518
user_iterator_impl< const User > const_user_iterator
Definition: Value.h:369
DefsOnlyType::const_self_iterator getDefsIterator() const
Definition: MemorySSA.h:190
void setOptimizedAccessType(Optional< AliasResult > AR)
Definition: MemorySSA.h:292
iterator_range< def_chain_iterator< T > > def_chain(T MA, MemoryAccess *UpTo=nullptr)
Definition: MemorySSA.h:1291
memoryaccess_def_iterator_base< MemoryAccess > memoryaccess_def_iterator
Definition: MemorySSA.h:128
block_iterator block_end()
Definition: MemorySSA.h:508
bool operator==(const def_chain_iterator &O) const
Definition: MemorySSA.h:1283
This file provides utility analysis objects describing memory locations.
#define I(x, y, z)
Definition: MD5.cpp:58
#define N
user_iterator_impl< User > user_iterator
Definition: Value.h:368
MemoryAccess * getIncomingValueForBlock(const BasicBlock *BB) const
Definition: MemorySSA.h:579
Compile-time customization of User operands.
Definition: User.h:42
MemoryAccess(LLVMContext &C, unsigned Vty, DeleteValueTy DeleteValue, BasicBlock *BB, unsigned NumOperands)
Definition: MemorySSA.h:215
LLVM_NODISCARD std::enable_if<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >::type dyn_cast(const Y &Val)
Definition: Casting.h:332
bool isLiveOnEntryDef(const MemoryAccess *MA) const
Return true if MA represents the live on entry value.
Definition: MemorySSA.h:735
Optional< AliasResult > getOptimizedAccessType() const
Definition: MemorySSA.h:268
raw_ostream & operator<<(raw_ostream &OS, const APInt &I)
Definition: APInt.h:2038
static ChildIteratorType child_begin(NodeRef N)
Definition: MemorySSA.h:1159
MemoryAccess * getClobberingMemoryAccess(const Instruction *I)
Given a memory Mod/Ref/ModRef&#39;ing instruction, calling this will give you the nearest dominating Memo...
Definition: MemorySSA.h:1017
static ChildIteratorType child_begin(NodeRef N)
Definition: MemorySSA.h:1150
static bool classof(const Value *MA)
Definition: MemorySSA.h:256
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
user_iterator user_begin()
Definition: Value.h:375
void setOptimized(MemoryAccess *MA)
Definition: MemorySSA.h:391
static NodeRef getEntryNode(NodeRef N)
Definition: MemorySSA.h:1149
LLVM Value Representation.
Definition: Value.h:72
MemoryDef(LLVMContext &C, MemoryAccess *DMA, Instruction *MI, BasicBlock *BB, unsigned Ver)
Definition: MemorySSA.h:378
DefsOnlyType::reverse_self_iterator getReverseDefsIterator()
Definition: MemorySSA.h:193
upward_defs_iterator upward_defs_begin(const MemoryAccessPair &Pair)
Definition: MemorySSA.h:1236
HungoffOperandTraits - determine the allocation regime of the Use array when it is not a prefix to th...
Definition: OperandTraits.h:95
void allocHungoffUses(unsigned N, bool IsPhi=false)
Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.
Definition: User.cpp:39
unsigned getID() const
Used for debugging and tracking things about MemoryAccesses.
Definition: MemorySSA.h:661
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
const_user_iterator const_iterator
Definition: MemorySSA.h:163
IRTranslator LLVM IR MI
FixedNumOperandTraits - determine the allocation regime of the Use array when it is a prefix to the U...
Definition: OperandTraits.h:30
A container for analyses that lazily runs them and caches their results.
void setBlock(BasicBlock *BB)
Used by MemorySSA to change the block of a MemoryAccess when it is moved.
Definition: MemorySSA.h:209
MemoryUse(LLVMContext &C, MemoryAccess *DMA, Instruction *MI, BasicBlock *BB)
Definition: MemorySSA.h:320
static bool classof(const Value *V)
Definition: MemorySSA.h:151
iterator_range< upward_defs_iterator > upward_defs(const MemoryAccessPair &Pair)
Definition: MemorySSA.h:1243
Represents phi nodes for memory accesses.
Definition: MemorySSA.h:478
unsigned getID() const
Definition: MemorySSA.h:411
static ChildIteratorType child_end(NodeRef N)
Definition: MemorySSA.h:1151
DefsList * getWritableBlockDefs(const BasicBlock *BB) const
Definition: MemorySSA.h:805
user_iterator iterator
The user iterators for a memory access.
Definition: MemorySSA.h:162
memoryaccess_def_iterator_base< const MemoryAccess > const_memoryaccess_def_iterator
Definition: MemorySSA.h:130
bool operator==(const upward_defs_iterator &Other) const
Definition: MemorySSA.h:1189
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:70
void resetOptimized()
Definition: MemorySSA.h:404
void setOptimized(MemoryAccess *DMA)
Definition: MemorySSA.h:333
std::pair< MemoryAccess *, MemoryLocation > MemoryAccessPair
Definition: MemorySSA.h:1067
void allocHungoffUses(unsigned N)
this is more complicated than the generic User::allocHungoffUses, because we have to allocate Uses fo...
Definition: MemorySSA.h:640
user_iterator user_end()
Definition: Value.h:383