MLIR  22.0.0git
PatternMatch.h
Go to the documentation of this file.
1 //===- PatternMatch.h - PatternMatcher classes -------==---------*- 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 #ifndef MLIR_IR_PATTERNMATCH_H
10 #define MLIR_IR_PATTERNMATCH_H
11 
12 #include "mlir/IR/Builders.h"
13 #include "mlir/IR/BuiltinOps.h"
14 #include "llvm/ADT/FunctionExtras.h"
15 #include "llvm/Support/TypeName.h"
16 #include <optional>
17 
19 namespace mlir {
20 
21 class PatternRewriter;
22 
23 //===----------------------------------------------------------------------===//
24 // PatternBenefit class
25 //===----------------------------------------------------------------------===//
26 
27 /// This class represents the benefit of a pattern match in a unitless scheme
28 /// that ranges from 0 (very little benefit) to 65K. The most common unit to
29 /// use here is the "number of operations matched" by the pattern.
30 ///
31 /// This also has a sentinel representation that can be used for patterns that
32 /// fail to match.
33 ///
35  enum { ImpossibleToMatchSentinel = 65535 };
36 
37 public:
38  PatternBenefit() = default;
39  PatternBenefit(unsigned benefit);
40  PatternBenefit(const PatternBenefit &) = default;
42 
44  bool isImpossibleToMatch() const { return *this == impossibleToMatch(); }
45 
46  /// If the corresponding pattern can match, return its benefit. If the
47  // corresponding pattern isImpossibleToMatch() then this aborts.
48  unsigned short getBenefit() const;
49 
50  bool operator==(const PatternBenefit &rhs) const {
51  return representation == rhs.representation;
52  }
53  bool operator!=(const PatternBenefit &rhs) const { return !(*this == rhs); }
54  bool operator<(const PatternBenefit &rhs) const {
55  return representation < rhs.representation;
56  }
57  bool operator>(const PatternBenefit &rhs) const { return rhs < *this; }
58  bool operator<=(const PatternBenefit &rhs) const { return !(*this > rhs); }
59  bool operator>=(const PatternBenefit &rhs) const { return !(*this < rhs); }
60 
61 private:
62  unsigned short representation{ImpossibleToMatchSentinel};
63 };
64 
65 //===----------------------------------------------------------------------===//
66 // Pattern
67 //===----------------------------------------------------------------------===//
68 
69 /// This class contains all of the data related to a pattern, but does not
70 /// contain any methods or logic for the actual matching. This class is solely
71 /// used to interface with the metadata of a pattern, such as the benefit or
72 /// root operation.
73 class Pattern {
74  /// This enum represents the kind of value used to select the root operations
75  /// that match this pattern.
76  enum class RootKind {
77  /// The pattern root matches "any" operation.
78  Any,
79  /// The pattern root is matched using a concrete operation name.
81  /// The pattern root is matched using an interface ID.
82  InterfaceID,
83  /// The patter root is matched using a trait ID.
84  TraitID
85  };
86 
87 public:
88  /// Return a list of operations that may be generated when rewriting an
89  /// operation instance with this pattern.
90  ArrayRef<OperationName> getGeneratedOps() const { return generatedOps; }
91 
92  /// Return the root node that this pattern matches. Patterns that can match
93  /// multiple root types return std::nullopt.
94  std::optional<OperationName> getRootKind() const {
95  if (rootKind == RootKind::OperationName)
96  return OperationName::getFromOpaquePointer(rootValue);
97  return std::nullopt;
98  }
99 
100  /// Return the interface ID used to match the root operation of this pattern.
101  /// If the pattern does not use an interface ID for deciding the root match,
102  /// this returns std::nullopt.
103  std::optional<TypeID> getRootInterfaceID() const {
104  if (rootKind == RootKind::InterfaceID)
105  return TypeID::getFromOpaquePointer(rootValue);
106  return std::nullopt;
107  }
108 
109  /// Return the trait ID used to match the root operation of this pattern.
110  /// If the pattern does not use a trait ID for deciding the root match, this
111  /// returns std::nullopt.
112  std::optional<TypeID> getRootTraitID() const {
113  if (rootKind == RootKind::TraitID)
114  return TypeID::getFromOpaquePointer(rootValue);
115  return std::nullopt;
116  }
117 
118  /// Return the benefit (the inverse of "cost") of matching this pattern. The
119  /// benefit of a Pattern is always static - rewrites that may have dynamic
120  /// benefit can be instantiated multiple times (different Pattern instances)
121  /// for each benefit that they may return, and be guarded by different match
122  /// condition predicates.
123  PatternBenefit getBenefit() const { return benefit; }
124 
125  /// Returns true if this pattern is known to result in recursive application,
126  /// i.e. this pattern may generate IR that also matches this pattern, but is
127  /// known to bound the recursion. This signals to a rewrite driver that it is
128  /// safe to apply this pattern recursively to generated IR.
130  return contextAndHasBoundedRecursion.getInt();
131  }
132 
133  /// Return the MLIRContext used to create this pattern.
135  return contextAndHasBoundedRecursion.getPointer();
136  }
137 
138  /// Return a readable name for this pattern. This name should only be used for
139  /// debugging purposes, and may be empty.
140  StringRef getDebugName() const { return debugName; }
141 
142  /// Set the human readable debug name used for this pattern. This name will
143  /// only be used for debugging purposes.
144  void setDebugName(StringRef name) { debugName = name; }
145 
146  /// Return the set of debug labels attached to this pattern.
147  ArrayRef<StringRef> getDebugLabels() const { return debugLabels; }
148 
149  /// Add the provided debug labels to this pattern.
151  debugLabels.append(labels.begin(), labels.end());
152  }
153  void addDebugLabels(StringRef label) { debugLabels.push_back(label); }
154 
155 protected:
156  /// This class acts as a special tag that makes the desire to match "any"
157  /// operation type explicit. This helps to avoid unnecessary usages of this
158  /// feature, and ensures that the user is making a conscious decision.
159  struct MatchAnyOpTypeTag {};
160  /// This class acts as a special tag that makes the desire to match any
161  /// operation that implements a given interface explicit. This helps to avoid
162  /// unnecessary usages of this feature, and ensures that the user is making a
163  /// conscious decision.
165  /// This class acts as a special tag that makes the desire to match any
166  /// operation that implements a given trait explicit. This helps to avoid
167  /// unnecessary usages of this feature, and ensures that the user is making a
168  /// conscious decision.
170 
171  /// Construct a pattern with a certain benefit that matches the operation
172  /// with the given root name.
173  Pattern(StringRef rootName, PatternBenefit benefit, MLIRContext *context,
174  ArrayRef<StringRef> generatedNames = {});
175  /// Construct a pattern that may match any operation type. `generatedNames`
176  /// contains the names of operations that may be generated during a successful
177  /// rewrite. `MatchAnyOpTypeTag` is just a tag to ensure that the "match any"
178  /// behavior is what the user actually desired, `MatchAnyOpTypeTag()` should
179  /// always be supplied here.
180  Pattern(MatchAnyOpTypeTag tag, PatternBenefit benefit, MLIRContext *context,
181  ArrayRef<StringRef> generatedNames = {});
182  /// Construct a pattern that may match any operation that implements the
183  /// interface defined by the provided `interfaceID`. `generatedNames` contains
184  /// the names of operations that may be generated during a successful rewrite.
185  /// `MatchInterfaceOpTypeTag` is just a tag to ensure that the "match
186  /// interface" behavior is what the user actually desired,
187  /// `MatchInterfaceOpTypeTag()` should always be supplied here.
188  Pattern(MatchInterfaceOpTypeTag tag, TypeID interfaceID,
189  PatternBenefit benefit, MLIRContext *context,
190  ArrayRef<StringRef> generatedNames = {});
191  /// Construct a pattern that may match any operation that implements the
192  /// trait defined by the provided `traitID`. `generatedNames` contains the
193  /// names of operations that may be generated during a successful rewrite.
194  /// `MatchTraitOpTypeTag` is just a tag to ensure that the "match trait"
195  /// behavior is what the user actually desired, `MatchTraitOpTypeTag()` should
196  /// always be supplied here.
197  Pattern(MatchTraitOpTypeTag tag, TypeID traitID, PatternBenefit benefit,
198  MLIRContext *context, ArrayRef<StringRef> generatedNames = {});
199 
200  /// Set the flag detailing if this pattern has bounded rewrite recursion or
201  /// not.
202  void setHasBoundedRewriteRecursion(bool hasBoundedRecursionArg = true) {
203  contextAndHasBoundedRecursion.setInt(hasBoundedRecursionArg);
204  }
205 
206 private:
207  Pattern(const void *rootValue, RootKind rootKind,
208  ArrayRef<StringRef> generatedNames, PatternBenefit benefit,
209  MLIRContext *context);
210 
211  /// The value used to match the root operation of the pattern.
212  const void *rootValue;
213  RootKind rootKind;
214 
215  /// The expected benefit of matching this pattern.
216  const PatternBenefit benefit;
217 
218  /// The context this pattern was created from, and a boolean flag indicating
219  /// whether this pattern has bounded recursion or not.
220  llvm::PointerIntPair<MLIRContext *, 1, bool> contextAndHasBoundedRecursion;
221 
222  /// A list of the potential operations that may be generated when rewriting
223  /// an op with this pattern.
224  SmallVector<OperationName, 2> generatedOps;
225 
226  /// A readable name for this pattern. May be empty.
227  StringRef debugName;
228 
229  /// The set of debug labels attached to this pattern.
230  SmallVector<StringRef, 0> debugLabels;
231 };
232 
233 //===----------------------------------------------------------------------===//
234 // RewritePattern
235 //===----------------------------------------------------------------------===//
236 
237 /// RewritePattern is the common base class for all DAG to DAG replacements.
238 class RewritePattern : public Pattern {
239 public:
240  virtual ~RewritePattern() = default;
241 
242  /// Attempt to match against code rooted at the specified operation,
243  /// which is the same operation code as getRootKind(). If successful, perform
244  /// the rewrite.
245  ///
246  /// Note: Implementations must modify the IR if and only if the function
247  /// returns "success".
248  virtual LogicalResult matchAndRewrite(Operation *op,
249  PatternRewriter &rewriter) const = 0;
250 
251  /// This method provides a convenient interface for creating and initializing
252  /// derived rewrite patterns of the given type `T`.
253  template <typename T, typename... Args>
254  static std::unique_ptr<T> create(Args &&...args) {
255  std::unique_ptr<T> pattern =
256  std::make_unique<T>(std::forward<Args>(args)...);
257  initializePattern<T>(*pattern);
258 
259  // Set a default debug name if one wasn't provided.
260  if (pattern->getDebugName().empty())
261  pattern->setDebugName(llvm::getTypeName<T>());
262  return pattern;
263  }
264 
265 protected:
266  /// Inherit the base constructors from `Pattern`.
267  using Pattern::Pattern;
268 
269 private:
270  /// Trait to check if T provides a `initialize` method.
271  template <typename T, typename... Args>
272  using has_initialize = decltype(std::declval<T>().initialize());
273  template <typename T>
274  using detect_has_initialize = llvm::is_detected<has_initialize, T>;
275 
276  /// Initialize the derived pattern by calling its `initialize` method if
277  /// available.
278  template <typename T>
279  static void initializePattern(T &pattern) {
280  if constexpr (detect_has_initialize<T>::value)
281  pattern.initialize();
282  }
283 
284  /// An anchor for the virtual table.
285  virtual void anchor();
286 };
287 
288 namespace detail {
289 /// OpOrInterfaceRewritePatternBase is a wrapper around RewritePattern that
290 /// allows for matching and rewriting against an instance of a derived operation
291 /// class or Interface.
292 template <typename SourceOp>
294  using RewritePattern::RewritePattern;
295 
296  /// Wrapper around the RewritePattern method that passes the derived op type.
297  LogicalResult matchAndRewrite(Operation *op,
298  PatternRewriter &rewriter) const final {
299  return matchAndRewrite(cast<SourceOp>(op), rewriter);
300  }
301 
302  /// Method that operates on the SourceOp type. Must be overridden by the
303  /// derived pattern class.
304  virtual LogicalResult matchAndRewrite(SourceOp op,
305  PatternRewriter &rewriter) const = 0;
306 };
307 } // namespace detail
308 
309 /// OpRewritePattern is a wrapper around RewritePattern that allows for
310 /// matching and rewriting against an instance of a derived operation class as
311 /// opposed to a raw Operation.
312 template <typename SourceOp>
314  : public detail::OpOrInterfaceRewritePatternBase<SourceOp> {
315 
316  /// Patterns must specify the root operation name they match against, and can
317  /// also specify the benefit of the pattern matching and a list of generated
318  /// ops.
320  ArrayRef<StringRef> generatedNames = {})
322  SourceOp::getOperationName(), benefit, context, generatedNames) {}
323 };
324 
325 /// OpInterfaceRewritePattern is a wrapper around RewritePattern that allows for
326 /// matching and rewriting against an instance of an operation interface instead
327 /// of a raw Operation.
328 template <typename SourceOp>
330  : public detail::OpOrInterfaceRewritePatternBase<SourceOp> {
331 
333  : detail::OpOrInterfaceRewritePatternBase<SourceOp>(
334  Pattern::MatchInterfaceOpTypeTag(), SourceOp::getInterfaceID(),
335  benefit, context) {}
336 };
337 
338 /// OpTraitRewritePattern is a wrapper around RewritePattern that allows for
339 /// matching and rewriting against instances of an operation that possess a
340 /// given trait.
341 template <template <typename> class TraitType>
343 public:
346  benefit, context) {}
347 };
348 
349 //===----------------------------------------------------------------------===//
350 // RewriterBase
351 //===----------------------------------------------------------------------===//
352 
353 /// This class coordinates the application of a rewrite on a set of IR,
354 /// providing a way for clients to track mutations and create new operations.
355 /// This class serves as a common API for IR mutation between pattern rewrites
356 /// and non-pattern rewrites, and facilitates the development of shared
357 /// IR transformation utilities.
358 class RewriterBase : public OpBuilder {
359 public:
360  struct Listener : public OpBuilder::Listener {
362  : OpBuilder::Listener(ListenerBase::Kind::RewriterBaseListener) {}
363 
364  /// Notify the listener that the specified block is about to be erased.
365  /// At this point, the block has zero uses.
366  virtual void notifyBlockErased(Block *block) {}
367 
368  /// Notify the listener that the specified operation was modified in-place.
369  virtual void notifyOperationModified(Operation *op) {}
370 
371  /// Notify the listener that all uses of the specified operation's results
372  /// are about to be replaced with the results of another operation. This is
373  /// called before the uses of the old operation have been changed.
374  ///
375  /// By default, this function calls the "operation replaced with values"
376  /// notification.
378  Operation *replacement) {
379  notifyOperationReplaced(op, replacement->getResults());
380  }
381 
382  /// Notify the listener that all uses of the specified operation's results
383  /// are about to be replaced with the a range of values, potentially
384  /// produced by other operations. This is called before the uses of the
385  /// operation have been changed.
387  ValueRange replacement) {}
388 
389  /// Notify the listener that the specified operation is about to be erased.
390  /// At this point, the operation has zero uses.
391  ///
392  /// Note: This notification is not triggered when unlinking an operation.
393  virtual void notifyOperationErased(Operation *op) {}
394 
395  /// Notify the listener that the specified pattern is about to be applied
396  /// at the specified root operation.
397  virtual void notifyPatternBegin(const Pattern &pattern, Operation *op) {}
398 
399  /// Notify the listener that a pattern application finished with the
400  /// specified status. "success" indicates that the pattern was applied
401  /// successfully. "failure" indicates that the pattern could not be
402  /// applied. The pattern may have communicated the reason for the failure
403  /// with `notifyMatchFailure`.
404  virtual void notifyPatternEnd(const Pattern &pattern,
405  LogicalResult status) {}
406 
407  /// Notify the listener that the pattern failed to match, and provide a
408  /// callback to populate a diagnostic with the reason why the failure
409  /// occurred. This method allows for derived listeners to optionally hook
410  /// into the reason why a rewrite failed, and display it to users.
411  virtual void
413  function_ref<void(Diagnostic &)> reasonCallback) {}
414 
415  static bool classof(const OpBuilder::Listener *base);
416  };
417 
418  /// A listener that forwards all notifications to another listener. This
419  /// struct can be used as a base to create listener chains, so that multiple
420  /// listeners can be notified of IR changes.
423  : listener(listener),
424  rewriteListener(
425  dyn_cast_if_present<RewriterBase::Listener>(listener)) {}
426 
427  void notifyOperationInserted(Operation *op, InsertPoint previous) override {
428  if (listener)
429  listener->notifyOperationInserted(op, previous);
430  }
431  void notifyBlockInserted(Block *block, Region *previous,
432  Region::iterator previousIt) override {
433  if (listener)
434  listener->notifyBlockInserted(block, previous, previousIt);
435  }
436  void notifyBlockErased(Block *block) override {
437  if (rewriteListener)
438  rewriteListener->notifyBlockErased(block);
439  }
440  void notifyOperationModified(Operation *op) override {
441  if (rewriteListener)
442  rewriteListener->notifyOperationModified(op);
443  }
444  void notifyOperationReplaced(Operation *op, Operation *newOp) override {
445  if (rewriteListener)
446  rewriteListener->notifyOperationReplaced(op, newOp);
447  }
449  ValueRange replacement) override {
450  if (rewriteListener)
451  rewriteListener->notifyOperationReplaced(op, replacement);
452  }
453  void notifyOperationErased(Operation *op) override {
454  if (rewriteListener)
455  rewriteListener->notifyOperationErased(op);
456  }
457  void notifyPatternBegin(const Pattern &pattern, Operation *op) override {
458  if (rewriteListener)
459  rewriteListener->notifyPatternBegin(pattern, op);
460  }
461  void notifyPatternEnd(const Pattern &pattern,
462  LogicalResult status) override {
463  if (rewriteListener)
464  rewriteListener->notifyPatternEnd(pattern, status);
465  }
467  Location loc,
468  function_ref<void(Diagnostic &)> reasonCallback) override {
469  if (rewriteListener)
470  rewriteListener->notifyMatchFailure(loc, reasonCallback);
471  }
472 
473  private:
474  OpBuilder::Listener *listener;
475  RewriterBase::Listener *rewriteListener;
476  };
477 
478  /// A listener that logs notification events to llvm::dbgs() before
479  /// forwarding to the base listener.
481  PatternLoggingListener(OpBuilder::Listener *listener, StringRef patternName)
482  : RewriterBase::ForwardingListener(listener), patternName(patternName) {
483  }
484 
485  void notifyOperationInserted(Operation *op, InsertPoint previous) override;
486  void notifyOperationModified(Operation *op) override;
487  void notifyOperationReplaced(Operation *op, Operation *newOp) override;
489  ValueRange replacement) override;
490  void notifyOperationErased(Operation *op) override;
491  void notifyPatternBegin(const Pattern &pattern, Operation *op) override;
492 
493  private:
494  StringRef patternName;
495  };
496 
497  /// Move the blocks that belong to "region" before the given position in
498  /// another region "parent". The two regions must be different. The caller
499  /// is responsible for creating or updating the operation transferring flow
500  /// of control to the region and passing it the correct block arguments.
501  void inlineRegionBefore(Region &region, Region &parent,
502  Region::iterator before);
503  void inlineRegionBefore(Region &region, Block *before);
504 
505  /// Replace the results of the given (original) operation with the specified
506  /// list of values (replacements). The result types of the given op and the
507  /// replacements must match. The original op is erased.
508  virtual void replaceOp(Operation *op, ValueRange newValues);
509 
510  /// Replace the results of the given (original) operation with the specified
511  /// new op (replacement). The result types of the two ops must match. The
512  /// original op is erased.
513  virtual void replaceOp(Operation *op, Operation *newOp);
514 
515  /// Replace the results of the given (original) op with a new op that is
516  /// created without verification (replacement). The result values of the two
517  /// ops must match. The original op is erased.
518  template <typename OpTy, typename... Args>
519  OpTy replaceOpWithNewOp(Operation *op, Args &&...args) {
520  auto builder = static_cast<OpBuilder *>(this);
521  auto newOp =
522  OpTy::create(*builder, op->getLoc(), std::forward<Args>(args)...);
523  replaceOp(op, newOp.getOperation());
524  return newOp;
525  }
526 
527  /// This method erases an operation that is known to have no uses.
528  virtual void eraseOp(Operation *op);
529 
530  /// This method erases all operations in a block.
531  virtual void eraseBlock(Block *block);
532 
533  /// Inline the operations of block 'source' into block 'dest' before the given
534  /// position. The source block will be deleted and must have no uses.
535  /// 'argValues' is used to replace the block arguments of 'source'.
536  ///
537  /// If the source block is inserted at the end of the dest block, the dest
538  /// block must have no successors. Similarly, if the source block is inserted
539  /// somewhere in the middle (or beginning) of the dest block, the source block
540  /// must have no successors. Otherwise, the resulting IR would have
541  /// unreachable operations.
542  virtual void inlineBlockBefore(Block *source, Block *dest,
543  Block::iterator before,
544  ValueRange argValues = {});
545 
546  /// Inline the operations of block 'source' before the operation 'op'. The
547  /// source block will be deleted and must have no uses. 'argValues' is used to
548  /// replace the block arguments of 'source'
549  ///
550  /// The source block must have no successors. Otherwise, the resulting IR
551  /// would have unreachable operations.
552  void inlineBlockBefore(Block *source, Operation *op,
553  ValueRange argValues = {});
554 
555  /// Inline the operations of block 'source' into the end of block 'dest'. The
556  /// source block will be deleted and must have no uses. 'argValues' is used to
557  /// replace the block arguments of 'source'
558  ///
559  /// The dest block must have no successors. Otherwise, the resulting IR would
560  /// have unreachable operation.
561  void mergeBlocks(Block *source, Block *dest, ValueRange argValues = {});
562 
563  /// Split the operations starting at "before" (inclusive) out of the given
564  /// block into a new block, and return it.
565  Block *splitBlock(Block *block, Block::iterator before);
566 
567  /// Unlink this operation from its current block and insert it right before
568  /// `existingOp` which may be in the same or another block in the same
569  /// function.
570  void moveOpBefore(Operation *op, Operation *existingOp);
571 
572  /// Unlink this operation from its current block and insert it right before
573  /// `iterator` in the specified block.
574  void moveOpBefore(Operation *op, Block *block, Block::iterator iterator);
575 
576  /// Unlink this operation from its current block and insert it right after
577  /// `existingOp` which may be in the same or another block in the same
578  /// function.
579  void moveOpAfter(Operation *op, Operation *existingOp);
580 
581  /// Unlink this operation from its current block and insert it right after
582  /// `iterator` in the specified block.
583  void moveOpAfter(Operation *op, Block *block, Block::iterator iterator);
584 
585  /// Unlink this block and insert it right before `existingBlock`.
586  void moveBlockBefore(Block *block, Block *anotherBlock);
587 
588  /// Unlink this block and insert it right before the location that the given
589  /// iterator points to in the given region.
590  void moveBlockBefore(Block *block, Region *region, Region::iterator iterator);
591 
592  /// This method is used to notify the rewriter that an in-place operation
593  /// modification is about to happen. A call to this function *must* be
594  /// followed by a call to either `finalizeOpModification` or
595  /// `cancelOpModification`. This is a minor efficiency win (it avoids creating
596  /// a new operation and removing the old one) but also often allows simpler
597  /// code in the client.
598  virtual void startOpModification(Operation *op) {}
599 
600  /// This method is used to signal the end of an in-place modification of the
601  /// given operation. This can only be called on operations that were provided
602  /// to a call to `startOpModification`.
603  virtual void finalizeOpModification(Operation *op);
604 
605  /// This method cancels a pending in-place modification. This can only be
606  /// called on operations that were provided to a call to
607  /// `startOpModification`.
608  virtual void cancelOpModification(Operation *op) {}
609 
610  /// This method is a utility wrapper around an in-place modification of an
611  /// operation. It wraps calls to `startOpModification` and
612  /// `finalizeOpModification` around the given callable.
613  template <typename CallableT>
614  void modifyOpInPlace(Operation *root, CallableT &&callable) {
615  startOpModification(root);
616  callable();
618  }
619 
620  /// Find uses of `from` and replace them with `to`. Also notify the listener
621  /// about every in-place op modification (for every use that was replaced).
622  void replaceAllUsesWith(Value from, Value to) {
623  for (OpOperand &operand : llvm::make_early_inc_range(from.getUses())) {
624  Operation *op = operand.getOwner();
625  modifyOpInPlace(op, [&]() { operand.set(to); });
626  }
627  }
628  void replaceAllUsesWith(Block *from, Block *to) {
629  for (BlockOperand &operand : llvm::make_early_inc_range(from->getUses())) {
630  Operation *op = operand.getOwner();
631  modifyOpInPlace(op, [&]() { operand.set(to); });
632  }
633  }
635  assert(from.size() == to.size() && "incorrect number of replacements");
636  for (auto it : llvm::zip(from, to))
637  replaceAllUsesWith(std::get<0>(it), std::get<1>(it));
638  }
639 
640  /// Find uses of `from` and replace them with `to`. Also notify the listener
641  /// about every in-place op modification (for every use that was replaced)
642  /// and that the `from` operation is about to be replaced.
643  ///
644  /// Note: This function cannot be called `replaceAllUsesWith` because the
645  /// overload resolution, when called with an op that can be implicitly
646  /// converted to a Value, would be ambiguous.
647  void replaceAllOpUsesWith(Operation *from, ValueRange to);
648  void replaceAllOpUsesWith(Operation *from, Operation *to);
649 
650  /// Find uses of `from` and replace them with `to` if the `functor` returns
651  /// true. Also notify the listener about every in-place op modification (for
652  /// every use that was replaced). The optional `allUsesReplaced` flag is set
653  /// to "true" if all uses were replaced.
654  void replaceUsesWithIf(Value from, Value to,
655  function_ref<bool(OpOperand &)> functor,
656  bool *allUsesReplaced = nullptr);
658  function_ref<bool(OpOperand &)> functor,
659  bool *allUsesReplaced = nullptr);
660  // Note: This function cannot be called `replaceOpUsesWithIf` because the
661  // overload resolution, when called with an op that can be implicitly
662  // converted to a Value, would be ambiguous.
664  function_ref<bool(OpOperand &)> functor,
665  bool *allUsesReplaced = nullptr) {
666  replaceUsesWithIf(from->getResults(), to, functor, allUsesReplaced);
667  }
668 
669  /// Find uses of `from` within `block` and replace them with `to`. Also notify
670  /// the listener about every in-place op modification (for every use that was
671  /// replaced). The optional `allUsesReplaced` flag is set to "true" if all
672  /// uses were replaced.
674  Block *block, bool *allUsesReplaced = nullptr) {
676  op, newValues,
677  [block](OpOperand &use) {
678  return block->getParentOp()->isProperAncestor(use.getOwner());
679  },
680  allUsesReplaced);
681  }
682 
683  /// Find uses of `from` and replace them with `to` except if the user is
684  /// `exceptedUser`. Also notify the listener about every in-place op
685  /// modification (for every use that was replaced).
686  void replaceAllUsesExcept(Value from, Value to, Operation *exceptedUser) {
687  return replaceUsesWithIf(from, to, [&](OpOperand &use) {
688  Operation *user = use.getOwner();
689  return user != exceptedUser;
690  });
691  }
692  void replaceAllUsesExcept(Value from, Value to,
693  const SmallPtrSetImpl<Operation *> &preservedUsers);
694 
695  /// Used to notify the listener that the IR failed to be rewritten because of
696  /// a match failure, and provide a callback to populate a diagnostic with the
697  /// reason why the failure occurred. This method allows for derived rewriters
698  /// to optionally hook into the reason why a rewrite failed, and display it to
699  /// users.
700  template <typename CallbackT>
701  std::enable_if_t<!std::is_convertible<CallbackT, Twine>::value, LogicalResult>
702  notifyMatchFailure(Location loc, CallbackT &&reasonCallback) {
703  if (auto *rewriteListener = dyn_cast_if_present<Listener>(listener))
704  rewriteListener->notifyMatchFailure(
705  loc, function_ref<void(Diagnostic &)>(reasonCallback));
706  return failure();
707  }
708  template <typename CallbackT>
709  std::enable_if_t<!std::is_convertible<CallbackT, Twine>::value, LogicalResult>
710  notifyMatchFailure(Operation *op, CallbackT &&reasonCallback) {
711  if (auto *rewriteListener = dyn_cast_if_present<Listener>(listener))
712  rewriteListener->notifyMatchFailure(
713  op->getLoc(), function_ref<void(Diagnostic &)>(reasonCallback));
714  return failure();
715  }
716  template <typename ArgT>
717  LogicalResult notifyMatchFailure(ArgT &&arg, const Twine &msg) {
718  return notifyMatchFailure(std::forward<ArgT>(arg),
719  [&](Diagnostic &diag) { diag << msg; });
720  }
721  template <typename ArgT>
722  LogicalResult notifyMatchFailure(ArgT &&arg, const char *msg) {
723  return notifyMatchFailure(std::forward<ArgT>(arg), Twine(msg));
724  }
725 
726 protected:
727  /// Initialize the builder.
728  explicit RewriterBase(MLIRContext *ctx,
729  OpBuilder::Listener *listener = nullptr)
730  : OpBuilder(ctx, listener) {}
731  explicit RewriterBase(const OpBuilder &otherBuilder)
732  : OpBuilder(otherBuilder) {}
734  : OpBuilder(op, listener) {}
735  virtual ~RewriterBase();
736 
737 private:
738  void operator=(const RewriterBase &) = delete;
739  RewriterBase(const RewriterBase &) = delete;
740 };
741 
742 //===----------------------------------------------------------------------===//
743 // IRRewriter
744 //===----------------------------------------------------------------------===//
745 
746 /// This class coordinates rewriting a piece of IR outside of a pattern rewrite,
747 /// providing a way to keep track of the mutations made to the IR. This class
748 /// should only be used in situations where another `RewriterBase` instance,
749 /// such as a `PatternRewriter`, is not available.
750 class IRRewriter : public RewriterBase {
751 public:
753  : RewriterBase(ctx, listener) {}
754  explicit IRRewriter(const OpBuilder &builder) : RewriterBase(builder) {}
756  : RewriterBase(op, listener) {}
757 };
758 
759 //===----------------------------------------------------------------------===//
760 // PatternRewriter
761 //===----------------------------------------------------------------------===//
762 
763 /// A special type of `RewriterBase` that coordinates the application of a
764 /// rewrite pattern on the current IR being matched, providing a way to keep
765 /// track of any mutations made. This class should be used to perform all
766 /// necessary IR mutations within a rewrite pattern, as the pattern driver may
767 /// be tracking various state that would be invalidated when a mutation takes
768 /// place.
770 public:
771  explicit PatternRewriter(MLIRContext *ctx) : RewriterBase(ctx) {}
773 
774  /// A hook used to indicate if the pattern rewriter can recover from failure
775  /// during the rewrite stage of a pattern. For example, if the pattern
776  /// rewriter supports rollback, it may progress smoothly even if IR was
777  /// changed during the rewrite.
778  virtual bool canRecoverFromRewriteFailure() const { return false; }
779 };
780 
781 } // namespace mlir
782 
783 // Optionally expose PDL pattern matching methods.
784 #include "PDLPatternMatch.h.inc"
785 
786 namespace mlir {
787 
788 //===----------------------------------------------------------------------===//
789 // RewritePatternSet
790 //===----------------------------------------------------------------------===//
791 
793  using NativePatternListT = std::vector<std::unique_ptr<RewritePattern>>;
794 
795 public:
796  RewritePatternSet(MLIRContext *context) : context(context) {}
797 
798  /// Construct a RewritePatternSet populated with the given pattern.
800  std::unique_ptr<RewritePattern> pattern)
801  : context(context) {
802  nativePatterns.emplace_back(std::move(pattern));
803  }
804  RewritePatternSet(PDLPatternModule &&pattern)
805  : context(pattern.getContext()), pdlPatterns(std::move(pattern)) {}
806 
807  MLIRContext *getContext() const { return context; }
808 
809  /// Return the native patterns held in this list.
810  NativePatternListT &getNativePatterns() { return nativePatterns; }
811 
812  /// Return the PDL patterns held in this list.
813  PDLPatternModule &getPDLPatterns() { return pdlPatterns; }
814 
815  /// Clear out all of the held patterns in this list.
816  void clear() {
817  nativePatterns.clear();
818  pdlPatterns.clear();
819  }
820 
821  //===--------------------------------------------------------------------===//
822  // 'add' methods for adding patterns to the set.
823  //===--------------------------------------------------------------------===//
824 
825  /// Add an instance of each of the pattern types 'Ts' to the pattern list with
826  /// the given arguments. Return a reference to `this` for chaining insertions.
827  /// Note: ConstructorArg is necessary here to separate the two variadic lists.
828  template <typename... Ts, typename ConstructorArg,
829  typename... ConstructorArgs,
830  typename = std::enable_if_t<sizeof...(Ts) != 0>>
831  RewritePatternSet &add(ConstructorArg &&arg, ConstructorArgs &&...args) {
832  // The following expands a call to emplace_back for each of the pattern
833  // types 'Ts'.
834  (addImpl<Ts>(/*debugLabels=*/{}, std::forward<ConstructorArg>(arg),
835  std::forward<ConstructorArgs>(args)...),
836  ...);
837  return *this;
838  }
839  /// An overload of the above `add` method that allows for attaching a set
840  /// of debug labels to the attached patterns. This is useful for labeling
841  /// groups of patterns that may be shared between multiple different
842  /// passes/users.
843  template <typename... Ts, typename ConstructorArg,
844  typename... ConstructorArgs,
845  typename = std::enable_if_t<sizeof...(Ts) != 0>>
847  ConstructorArg &&arg,
848  ConstructorArgs &&...args) {
849  // The following expands a call to emplace_back for each of the pattern
850  // types 'Ts'.
851  (addImpl<Ts>(debugLabels, arg, args...), ...);
852  return *this;
853  }
854 
855  /// Add an instance of each of the pattern types 'Ts'. Return a reference to
856  /// `this` for chaining insertions.
857  template <typename... Ts>
859  (addImpl<Ts>(), ...);
860  return *this;
861  }
862 
863  /// Add the given native pattern to the pattern list. Return a reference to
864  /// `this` for chaining insertions.
865  RewritePatternSet &add(std::unique_ptr<RewritePattern> pattern) {
866  nativePatterns.emplace_back(std::move(pattern));
867  return *this;
868  }
869 
870  /// Add the given PDL pattern to the pattern list. Return a reference to
871  /// `this` for chaining insertions.
872  RewritePatternSet &add(PDLPatternModule &&pattern) {
873  pdlPatterns.mergeIn(std::move(pattern));
874  return *this;
875  }
876 
877  // Add a matchAndRewrite style pattern represented as a C function pointer.
878  template <typename OpType>
880  add(LogicalResult (*implFn)(OpType, PatternRewriter &rewriter),
881  PatternBenefit benefit = 1, ArrayRef<StringRef> generatedNames = {}) {
882  struct FnPattern final : public OpRewritePattern<OpType> {
883  FnPattern(LogicalResult (*implFn)(OpType, PatternRewriter &rewriter),
884  MLIRContext *context, PatternBenefit benefit,
885  ArrayRef<StringRef> generatedNames)
886  : OpRewritePattern<OpType>(context, benefit, generatedNames),
887  implFn(implFn) {}
888 
889  LogicalResult matchAndRewrite(OpType op,
890  PatternRewriter &rewriter) const override {
891  return implFn(op, rewriter);
892  }
893 
894  private:
895  LogicalResult (*implFn)(OpType, PatternRewriter &rewriter);
896  };
897  add(std::make_unique<FnPattern>(std::move(implFn), getContext(), benefit,
898  generatedNames));
899  return *this;
900  }
901 
902  //===--------------------------------------------------------------------===//
903  // Pattern Insertion
904  //===--------------------------------------------------------------------===//
905 
906  // TODO: These are soft deprecated in favor of the 'add' methods above.
907 
908  /// Add an instance of each of the pattern types 'Ts' to the pattern list with
909  /// the given arguments. Return a reference to `this` for chaining insertions.
910  /// Note: ConstructorArg is necessary here to separate the two variadic lists.
911  template <typename... Ts, typename ConstructorArg,
912  typename... ConstructorArgs,
913  typename = std::enable_if_t<sizeof...(Ts) != 0>>
914  RewritePatternSet &insert(ConstructorArg &&arg, ConstructorArgs &&...args) {
915  // The following expands a call to emplace_back for each of the pattern
916  // types 'Ts'.
917  (addImpl<Ts>(/*debugLabels=*/{}, arg, args...), ...);
918  return *this;
919  }
920 
921  /// Add an instance of each of the pattern types 'Ts'. Return a reference to
922  /// `this` for chaining insertions.
923  template <typename... Ts>
925  (addImpl<Ts>(), ...);
926  return *this;
927  }
928 
929  /// Add the given native pattern to the pattern list. Return a reference to
930  /// `this` for chaining insertions.
931  RewritePatternSet &insert(std::unique_ptr<RewritePattern> pattern) {
932  nativePatterns.emplace_back(std::move(pattern));
933  return *this;
934  }
935 
936  /// Add the given PDL pattern to the pattern list. Return a reference to
937  /// `this` for chaining insertions.
938  RewritePatternSet &insert(PDLPatternModule &&pattern) {
939  pdlPatterns.mergeIn(std::move(pattern));
940  return *this;
941  }
942 
943  // Add a matchAndRewrite style pattern represented as a C function pointer.
944  template <typename OpType>
946  insert(LogicalResult (*implFn)(OpType, PatternRewriter &rewriter)) {
947  struct FnPattern final : public OpRewritePattern<OpType> {
948  FnPattern(LogicalResult (*implFn)(OpType, PatternRewriter &rewriter),
949  MLIRContext *context)
950  : OpRewritePattern<OpType>(context), implFn(implFn) {
951  this->setDebugName(llvm::getTypeName<FnPattern>());
952  }
953 
954  LogicalResult matchAndRewrite(OpType op,
955  PatternRewriter &rewriter) const override {
956  return implFn(op, rewriter);
957  }
958 
959  private:
960  LogicalResult (*implFn)(OpType, PatternRewriter &rewriter);
961  };
962  add(std::make_unique<FnPattern>(std::move(implFn), getContext()));
963  return *this;
964  }
965 
966 private:
967  /// Add an instance of the pattern type 'T'. Return a reference to `this` for
968  /// chaining insertions.
969  template <typename T, typename... Args>
970  std::enable_if_t<std::is_base_of<RewritePattern, T>::value>
971  addImpl(ArrayRef<StringRef> debugLabels, Args &&...args) {
972  std::unique_ptr<T> pattern =
973  RewritePattern::create<T>(std::forward<Args>(args)...);
974  pattern->addDebugLabels(debugLabels);
975  nativePatterns.emplace_back(std::move(pattern));
976  }
977 
978  template <typename T, typename... Args>
979  std::enable_if_t<std::is_base_of<PDLPatternModule, T>::value>
980  addImpl(ArrayRef<StringRef> debugLabels, Args &&...args) {
981  // TODO: Add the provided labels to the PDL pattern when PDL supports
982  // labels.
983  pdlPatterns.mergeIn(T(std::forward<Args>(args)...));
984  }
985 
986  MLIRContext *const context;
987  NativePatternListT nativePatterns;
988 
989  // Patterns expressed with PDL. This will compile to a stub class when PDL is
990  // not enabled.
991  PDLPatternModule pdlPatterns;
992 };
993 
994 } // namespace mlir
995 
996 #endif // MLIR_IR_PATTERNMATCH_H
static std::string diag(const llvm::Value &value)
A block operand represents an operand that holds a reference to a Block, e.g.
Definition: BlockSupport.h:30
Block represents an ordered list of Operations.
Definition: Block.h:33
OpListType::iterator iterator
Definition: Block.h:140
Operation * getParentOp()
Returns the closest surrounding operation that contains this block.
Definition: Block.cpp:31
This class contains all of the information necessary to report a diagnostic to the DiagnosticEngine.
Definition: Diagnostics.h:155
use_range getUses() const
Returns a range of all uses, which is useful for iterating over all uses.
Definition: UseDefLists.h:253
This class coordinates rewriting a piece of IR outside of a pattern rewrite, providing a way to keep ...
Definition: PatternMatch.h:750
IRRewriter(MLIRContext *ctx, OpBuilder::Listener *listener=nullptr)
Definition: PatternMatch.h:752
IRRewriter(const OpBuilder &builder)
Definition: PatternMatch.h:754
IRRewriter(Operation *op, OpBuilder::Listener *listener=nullptr)
Definition: PatternMatch.h:755
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
Definition: Location.h:76
MLIRContext is the top-level object for a collection of MLIR operations.
Definition: MLIRContext.h:60
This class represents a saved insertion point.
Definition: Builders.h:325
This class helps build Operations.
Definition: Builders.h:205
Listener * listener
The optional listener for events of this builder.
Definition: Builders.h:608
This class represents an operand of an operation.
Definition: Value.h:257
OpTraitRewritePattern is a wrapper around RewritePattern that allows for matching and rewriting again...
Definition: PatternMatch.h:342
OpTraitRewritePattern(MLIRContext *context, PatternBenefit benefit=1)
Definition: PatternMatch.h:344
static OperationName getFromOpaquePointer(const void *pointer)
Operation is the basic unit of execution within MLIR.
Definition: Operation.h:88
Location getLoc()
The source location the operation was defined or derived from.
Definition: Operation.h:223
result_range getResults()
Definition: Operation.h:415
This class represents the benefit of a pattern match in a unitless scheme that ranges from 0 (very li...
Definition: PatternMatch.h:34
PatternBenefit & operator=(const PatternBenefit &)=default
bool operator<(const PatternBenefit &rhs) const
Definition: PatternMatch.h:54
bool operator==(const PatternBenefit &rhs) const
Definition: PatternMatch.h:50
static PatternBenefit impossibleToMatch()
Definition: PatternMatch.h:43
bool operator>=(const PatternBenefit &rhs) const
Definition: PatternMatch.h:59
bool operator<=(const PatternBenefit &rhs) const
Definition: PatternMatch.h:58
PatternBenefit(const PatternBenefit &)=default
bool isImpossibleToMatch() const
Definition: PatternMatch.h:44
bool operator!=(const PatternBenefit &rhs) const
Definition: PatternMatch.h:53
PatternBenefit()=default
bool operator>(const PatternBenefit &rhs) const
Definition: PatternMatch.h:57
unsigned short getBenefit() const
If the corresponding pattern can match, return its benefit. If the.
A special type of RewriterBase that coordinates the application of a rewrite pattern on the current I...
Definition: PatternMatch.h:769
PatternRewriter(MLIRContext *ctx)
Definition: PatternMatch.h:771
virtual bool canRecoverFromRewriteFailure() const
A hook used to indicate if the pattern rewriter can recover from failure during the rewrite stage of ...
Definition: PatternMatch.h:778
This class contains all of the data related to a pattern, but does not contain any methods or logic f...
Definition: PatternMatch.h:73
std::optional< TypeID > getRootInterfaceID() const
Return the interface ID used to match the root operation of this pattern.
Definition: PatternMatch.h:103
Pattern(StringRef rootName, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
Construct a pattern with a certain benefit that matches the operation with the given root name.
bool hasBoundedRewriteRecursion() const
Returns true if this pattern is known to result in recursive application, i.e.
Definition: PatternMatch.h:129
std::optional< OperationName > getRootKind() const
Return the root node that this pattern matches.
Definition: PatternMatch.h:94
MLIRContext * getContext() const
Return the MLIRContext used to create this pattern.
Definition: PatternMatch.h:134
ArrayRef< StringRef > getDebugLabels() const
Return the set of debug labels attached to this pattern.
Definition: PatternMatch.h:147
void setHasBoundedRewriteRecursion(bool hasBoundedRecursionArg=true)
Set the flag detailing if this pattern has bounded rewrite recursion or not.
Definition: PatternMatch.h:202
ArrayRef< OperationName > getGeneratedOps() const
Return a list of operations that may be generated when rewriting an operation instance with this patt...
Definition: PatternMatch.h:90
PatternBenefit getBenefit() const
Return the benefit (the inverse of "cost") of matching this pattern.
Definition: PatternMatch.h:123
std::optional< TypeID > getRootTraitID() const
Return the trait ID used to match the root operation of this pattern.
Definition: PatternMatch.h:112
void setDebugName(StringRef name)
Set the human readable debug name used for this pattern.
Definition: PatternMatch.h:144
void addDebugLabels(StringRef label)
Definition: PatternMatch.h:153
void addDebugLabels(ArrayRef< StringRef > labels)
Add the provided debug labels to this pattern.
Definition: PatternMatch.h:150
StringRef getDebugName() const
Return a readable name for this pattern.
Definition: PatternMatch.h:140
This class contains a list of basic blocks and a link to the parent operation it is attached to.
Definition: Region.h:26
BlockListType::iterator iterator
Definition: Region.h:52
RewritePatternSet & add(PDLPatternModule &&pattern)
Add the given PDL pattern to the pattern list.
Definition: PatternMatch.h:872
RewritePatternSet & add(LogicalResult(*implFn)(OpType, PatternRewriter &rewriter), PatternBenefit benefit=1, ArrayRef< StringRef > generatedNames={})
Definition: PatternMatch.h:880
NativePatternListT & getNativePatterns()
Return the native patterns held in this list.
Definition: PatternMatch.h:810
RewritePatternSet & add(std::unique_ptr< RewritePattern > pattern)
Add the given native pattern to the pattern list.
Definition: PatternMatch.h:865
RewritePatternSet(PDLPatternModule &&pattern)
Definition: PatternMatch.h:804
RewritePatternSet & insert(ConstructorArg &&arg, ConstructorArgs &&...args)
Add an instance of each of the pattern types 'Ts' to the pattern list with the given arguments.
Definition: PatternMatch.h:914
MLIRContext * getContext() const
Definition: PatternMatch.h:807
void clear()
Clear out all of the held patterns in this list.
Definition: PatternMatch.h:816
RewritePatternSet(MLIRContext *context)
Definition: PatternMatch.h:796
RewritePatternSet & add()
Add an instance of each of the pattern types 'Ts'.
Definition: PatternMatch.h:858
RewritePatternSet(MLIRContext *context, std::unique_ptr< RewritePattern > pattern)
Construct a RewritePatternSet populated with the given pattern.
Definition: PatternMatch.h:799
RewritePatternSet & insert(PDLPatternModule &&pattern)
Add the given PDL pattern to the pattern list.
Definition: PatternMatch.h:938
RewritePatternSet & insert(std::unique_ptr< RewritePattern > pattern)
Add the given native pattern to the pattern list.
Definition: PatternMatch.h:931
PDLPatternModule & getPDLPatterns()
Return the PDL patterns held in this list.
Definition: PatternMatch.h:813
RewritePatternSet & add(ConstructorArg &&arg, ConstructorArgs &&...args)
Add an instance of each of the pattern types 'Ts' to the pattern list with the given arguments.
Definition: PatternMatch.h:831
RewritePatternSet & insert()
Add an instance of each of the pattern types 'Ts'.
Definition: PatternMatch.h:924
RewritePatternSet & addWithLabel(ArrayRef< StringRef > debugLabels, ConstructorArg &&arg, ConstructorArgs &&...args)
An overload of the above add method that allows for attaching a set of debug labels to the attached p...
Definition: PatternMatch.h:846
RewritePatternSet & insert(LogicalResult(*implFn)(OpType, PatternRewriter &rewriter))
Definition: PatternMatch.h:946
RewritePattern is the common base class for all DAG to DAG replacements.
Definition: PatternMatch.h:238
static std::unique_ptr< T > create(Args &&...args)
This method provides a convenient interface for creating and initializing derived rewrite patterns of...
Definition: PatternMatch.h:254
virtual ~RewritePattern()=default
virtual LogicalResult matchAndRewrite(Operation *op, PatternRewriter &rewriter) const =0
Attempt to match against code rooted at the specified operation, which is the same operation code as ...
This class coordinates the application of a rewrite on a set of IR, providing a way for clients to tr...
Definition: PatternMatch.h:358
std::enable_if_t<!std::is_convertible< CallbackT, Twine >::value, LogicalResult > notifyMatchFailure(Location loc, CallbackT &&reasonCallback)
Used to notify the listener that the IR failed to be rewritten because of a match failure,...
Definition: PatternMatch.h:702
std::enable_if_t<!std::is_convertible< CallbackT, Twine >::value, LogicalResult > notifyMatchFailure(Operation *op, CallbackT &&reasonCallback)
Definition: PatternMatch.h:710
void replaceOpUsesWithIf(Operation *from, ValueRange to, function_ref< bool(OpOperand &)> functor, bool *allUsesReplaced=nullptr)
Definition: PatternMatch.h:663
virtual void eraseBlock(Block *block)
This method erases all operations in a block.
LogicalResult notifyMatchFailure(ArgT &&arg, const Twine &msg)
Definition: PatternMatch.h:717
Block * splitBlock(Block *block, Block::iterator before)
Split the operations starting at "before" (inclusive) out of the given block into a new block,...
virtual void replaceOp(Operation *op, ValueRange newValues)
Replace the results of the given (original) operation with the specified list of values (replacements...
RewriterBase(const OpBuilder &otherBuilder)
Definition: PatternMatch.h:731
void replaceAllUsesWith(ValueRange from, ValueRange to)
Definition: PatternMatch.h:634
void moveBlockBefore(Block *block, Block *anotherBlock)
Unlink this block and insert it right before existingBlock.
void replaceAllUsesWith(Value from, Value to)
Find uses of from and replace them with to.
Definition: PatternMatch.h:622
virtual void finalizeOpModification(Operation *op)
This method is used to signal the end of an in-place modification of the given operation.
RewriterBase(Operation *op, OpBuilder::Listener *listener=nullptr)
Definition: PatternMatch.h:733
virtual void eraseOp(Operation *op)
This method erases an operation that is known to have no uses.
virtual void cancelOpModification(Operation *op)
This method cancels a pending in-place modification.
Definition: PatternMatch.h:608
void replaceAllUsesWith(Block *from, Block *to)
Definition: PatternMatch.h:628
void replaceUsesWithIf(Value from, Value to, function_ref< bool(OpOperand &)> functor, bool *allUsesReplaced=nullptr)
Find uses of from and replace them with to if the functor returns true.
void replaceAllUsesExcept(Value from, Value to, Operation *exceptedUser)
Find uses of from and replace them with to except if the user is exceptedUser.
Definition: PatternMatch.h:686
RewriterBase(MLIRContext *ctx, OpBuilder::Listener *listener=nullptr)
Initialize the builder.
Definition: PatternMatch.h:728
virtual void inlineBlockBefore(Block *source, Block *dest, Block::iterator before, ValueRange argValues={})
Inline the operations of block 'source' into block 'dest' before the given position.
void moveOpBefore(Operation *op, Operation *existingOp)
Unlink this operation from its current block and insert it right before existingOp which may be in th...
void mergeBlocks(Block *source, Block *dest, ValueRange argValues={})
Inline the operations of block 'source' into the end of block 'dest'.
LogicalResult notifyMatchFailure(ArgT &&arg, const char *msg)
Definition: PatternMatch.h:722
void modifyOpInPlace(Operation *root, CallableT &&callable)
This method is a utility wrapper around an in-place modification of an operation.
Definition: PatternMatch.h:614
void moveOpAfter(Operation *op, Operation *existingOp)
Unlink this operation from its current block and insert it right after existingOp which may be in the...
void inlineRegionBefore(Region &region, Region &parent, Region::iterator before)
Move the blocks that belong to "region" before the given position in another region "parent".
void replaceOpUsesWithinBlock(Operation *op, ValueRange newValues, Block *block, bool *allUsesReplaced=nullptr)
Find uses of from within block and replace them with to.
Definition: PatternMatch.h:673
void replaceAllOpUsesWith(Operation *from, ValueRange to)
Find uses of from and replace them with to.
virtual void startOpModification(Operation *op)
This method is used to notify the rewriter that an in-place operation modification is about to happen...
Definition: PatternMatch.h:598
OpTy replaceOpWithNewOp(Operation *op, Args &&...args)
Replace the results of the given (original) op with a new op that is created without verification (re...
Definition: PatternMatch.h:519
This class provides an efficient unique identifier for a specific C++ type.
Definition: TypeID.h:107
static TypeID getFromOpaquePointer(const void *pointer)
Definition: TypeID.h:135
This class provides an abstraction over the different types of ranges over Values.
Definition: ValueRange.h:387
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
Definition: Value.h:96
use_range getUses() const
Returns a range of all uses, which is useful for iterating over all uses.
Definition: Value.h:188
Operation * getOwner() const
Return the owner of this operand.
Definition: UseDefLists.h:38
Include the generated interface declarations.
auto get(MLIRContext *context, Ts &&...params)
Helper method that injects context only if needed, this helps unify some of the attribute constructio...
Base class for listeners.
Definition: Builders.h:262
Kind
The kind of listener.
Definition: Builders.h:264
This class represents a listener that may be used to hook into various actions within an OpBuilder.
Definition: Builders.h:283
virtual void notifyBlockInserted(Block *block, Region *previous, Region::iterator previousIt)
Notify the listener that the specified block was inserted.
Definition: Builders.h:306
virtual void notifyOperationInserted(Operation *op, InsertPoint previous)
Notify the listener that the specified operation was inserted.
Definition: Builders.h:296
OpInterfaceRewritePattern is a wrapper around RewritePattern that allows for matching and rewriting a...
Definition: PatternMatch.h:330
OpInterfaceRewritePattern(MLIRContext *context, PatternBenefit benefit=1)
Definition: PatternMatch.h:332
OpRewritePattern is a wrapper around RewritePattern that allows for matching and rewriting against an...
Definition: PatternMatch.h:314
OpRewritePattern(MLIRContext *context, PatternBenefit benefit=1, ArrayRef< StringRef > generatedNames={})
Patterns must specify the root operation name they match against, and can also specify the benefit of...
Definition: PatternMatch.h:319
This class acts as a special tag that makes the desire to match "any" operation type explicit.
Definition: PatternMatch.h:159
This class acts as a special tag that makes the desire to match any operation that implements a given...
Definition: PatternMatch.h:164
This class acts as a special tag that makes the desire to match any operation that implements a given...
Definition: PatternMatch.h:169
A listener that forwards all notifications to another listener.
Definition: PatternMatch.h:421
void notifyMatchFailure(Location loc, function_ref< void(Diagnostic &)> reasonCallback) override
Notify the listener that the pattern failed to match, and provide a callback to populate a diagnostic...
Definition: PatternMatch.h:466
void notifyOperationInserted(Operation *op, InsertPoint previous) override
Notify the listener that the specified operation was inserted.
Definition: PatternMatch.h:427
void notifyPatternEnd(const Pattern &pattern, LogicalResult status) override
Notify the listener that a pattern application finished with the specified status.
Definition: PatternMatch.h:461
void notifyOperationModified(Operation *op) override
Notify the listener that the specified operation was modified in-place.
Definition: PatternMatch.h:440
void notifyPatternBegin(const Pattern &pattern, Operation *op) override
Notify the listener that the specified pattern is about to be applied at the specified root operation...
Definition: PatternMatch.h:457
void notifyOperationReplaced(Operation *op, Operation *newOp) override
Notify the listener that all uses of the specified operation's results are about to be replaced with ...
Definition: PatternMatch.h:444
void notifyOperationErased(Operation *op) override
Notify the listener that the specified operation is about to be erased.
Definition: PatternMatch.h:453
void notifyBlockErased(Block *block) override
Notify the listener that the specified block is about to be erased.
Definition: PatternMatch.h:436
ForwardingListener(OpBuilder::Listener *listener)
Definition: PatternMatch.h:422
void notifyOperationReplaced(Operation *op, ValueRange replacement) override
Notify the listener that all uses of the specified operation's results are about to be replaced with ...
Definition: PatternMatch.h:448
void notifyBlockInserted(Block *block, Region *previous, Region::iterator previousIt) override
Notify the listener that the specified block was inserted.
Definition: PatternMatch.h:431
virtual void notifyMatchFailure(Location loc, function_ref< void(Diagnostic &)> reasonCallback)
Notify the listener that the pattern failed to match, and provide a callback to populate a diagnostic...
Definition: PatternMatch.h:412
virtual void notifyOperationModified(Operation *op)
Notify the listener that the specified operation was modified in-place.
Definition: PatternMatch.h:369
virtual void notifyOperationErased(Operation *op)
Notify the listener that the specified operation is about to be erased.
Definition: PatternMatch.h:393
virtual void notifyOperationReplaced(Operation *op, Operation *replacement)
Notify the listener that all uses of the specified operation's results are about to be replaced with ...
Definition: PatternMatch.h:377
virtual void notifyBlockErased(Block *block)
Notify the listener that the specified block is about to be erased.
Definition: PatternMatch.h:366
virtual void notifyPatternEnd(const Pattern &pattern, LogicalResult status)
Notify the listener that a pattern application finished with the specified status.
Definition: PatternMatch.h:404
virtual void notifyPatternBegin(const Pattern &pattern, Operation *op)
Notify the listener that the specified pattern is about to be applied at the specified root operation...
Definition: PatternMatch.h:397
virtual void notifyOperationReplaced(Operation *op, ValueRange replacement)
Notify the listener that all uses of the specified operation's results are about to be replaced with ...
Definition: PatternMatch.h:386
static bool classof(const OpBuilder::Listener *base)
A listener that logs notification events to llvm::dbgs() before forwarding to the base listener.
Definition: PatternMatch.h:480
void notifyOperationModified(Operation *op) override
Notify the listener that the specified operation was modified in-place.
void notifyOperationErased(Operation *op) override
Notify the listener that the specified operation is about to be erased.
PatternLoggingListener(OpBuilder::Listener *listener, StringRef patternName)
Definition: PatternMatch.h:481
void notifyOperationReplaced(Operation *op, Operation *newOp) override
Notify the listener that all uses of the specified operation's results are about to be replaced with ...
void notifyOperationInserted(Operation *op, InsertPoint previous) override
Notify the listener that the specified operation was inserted.
void notifyPatternBegin(const Pattern &pattern, Operation *op) override
Notify the listener that the specified pattern is about to be applied at the specified root operation...
OpOrInterfaceRewritePatternBase is a wrapper around RewritePattern that allows for matching and rewri...
Definition: PatternMatch.h:293
LogicalResult matchAndRewrite(Operation *op, PatternRewriter &rewriter) const final
Wrapper around the RewritePattern method that passes the derived op type.
Definition: PatternMatch.h:297
virtual LogicalResult matchAndRewrite(SourceOp op, PatternRewriter &rewriter) const =0
Method that operates on the SourceOp type.