[mlir] Canonicalizer constructor should accept disabled/enabled patterns

[Mogball]

Summary

There is no way to programmatically configure the list of disabled and enabled patterns in the canonicalizer pass, other than the duplicate the whole pass. This patch exposes the disabledPatterns and enabledPatterns options.

[mehdi_amini]

Does this work in non-debug builds? I don't remember if pattern names weren't just a debugging thing? It probably should be reflected in the name if we want to expose this publicly.

[Mogball]

It apparently does. See https://github.com/llvm/llvm-project/blob/main/mlir/test/Transforms/test-canonicalize-filter.mlir

By default, the "debugName" of a pattern is set to its type name, even in non-debug builds

[mehdi_amini]

In D116055#3203477, @Mogball wrote:

It apparently does. See https://github.com/llvm/llvm-project/blob/main/mlir/test/Transforms/test-canonicalize-filter.mlir

By default, the "debugName" of a pattern is set to its type name, even in non-debug builds

OK, that is still a "debugName" which I'm wary of providing more expectation than that on, so we should still reflect this in the API.

[Mogball]

In D116055#3203487, @mehdi_amini wrote:

OK, that is still a "debugName" which I'm wary of providing more expectation than that on, so we should still reflect this in the API.

Sure, sounds good.

[Mogball]

Update description of API to match that of FrozenRewritePatternSet.

@mehdi_amini I copied the description over from FrozenRewritePatternSet,
which is actually where the capability comes from. Based on how this was
set up in https://github.com/llvm/llvm-project/blob/main/mlir/include/mlir/Rewrite/PassUtil.td,
I think this is intended to be a somewhat commonly-used API.

[Mogball]

Fix diff

[Hardcode84]

It is possible to have pattern with empty name (when added using function pointer api).

[mehdi_amini]

In D116055#3203502, @Mogball wrote:

Update description of API to match that of FrozenRewritePatternSet.

@mehdi_amini I copied the description over from FrozenRewritePatternSet,
which is actually where the capability comes from. Based on how this was
set up in https://github.com/llvm/llvm-project/blob/main/mlir/include/mlir/Rewrite/PassUtil.td,
I think this is intended to be a somewhat commonly-used API.

Well the issue may be instead into how it is presented in FrozenRewritePatternSet: this does not match the fact that patterns can have naming collision or no name at all (as Ivan indicated).

[Mogball]

In D116055#3203546, @mehdi_amini wrote:

In D116055#3203502, @Mogball wrote:

Update description of API to match that of FrozenRewritePatternSet.

@mehdi_amini I copied the description over from FrozenRewritePatternSet,
which is actually where the capability comes from. Based on how this was
set up in https://github.com/llvm/llvm-project/blob/main/mlir/include/mlir/Rewrite/PassUtil.td,
I think this is intended to be a somewhat commonly-used API.

Well the issue may be instead into how it is presented in FrozenRewritePatternSet: this does not match the fact that patterns can have naming collision or no name at all (as Ivan indicated).

That's true. I can update the comment over there too

[Mogball]

Make clear that the labels used to filter patterns are debug names, and may be empty.

mlir/include/mlir/Rewrite/FrozenRewritePatternSet.h

public:
   FrozenRewritePatternSet &
   operator=(const FrozenRewritePatternSet &patterns) = default;
   FrozenRewritePatternSet &
   operator=(FrozenRewritePatternSet &&patterns) = default;
   ~FrozenRewritePatternSet();
 
   /// Freeze the patterns held in `patterns`, and take ownership.
   /// `disabledPatternLabels` is a set of labels used to filter out input
-  /// patterns with a label in this set. `enabledPatternLabels` is a set of
-  /// labels used to filter out input patterns that do not have one of the
-  /// labels in this set.
+  /// patterns with a debug label or debug name in this set.
+  /// `enabledPatternLabels` is a set of labels used to filter out input
+  /// patterns that do not have one of the labels in this set. Debug labels must
+  /// be set explicitly on patterns or when adding them with
+  /// `RewritePatternSet::addWithLabel`. Debug names may be empty, but patterns
+  /// created with `RewritePattern::create` have their default debug name set to
+  /// their type name.
   FrozenRewritePatternSet(
       RewritePatternSet &&patterns,
       ArrayRef<std::string> disabledPatternLabels = llvm::None,
       ArrayRef<std::string> enabledPatternLabels = llvm::None);
 
   /// Return the op specific native patterns held by this list.
   const OpSpecificNativePatternListT &getOpSpecificNativePatterns() const {
     return impl->nativeOpSpecificPatternMap;

mlir/include/mlir/Transforms/Passes.h

 /// Creates a pass that converts memref function results to out-params.
 std::unique_ptr<Pass> createBufferResultsToOutParamsPass();
 
 /// Creates an instance of the Canonicalizer pass, configured with default
 /// settings (which can be overridden by pass options on the command line).
 std::unique_ptr<Pass> createCanonicalizerPass();
 
 /// Creates an instance of the Canonicalizer pass with the specified config.
+/// `disabledPatterns` is a set of labels used to filter out input patterns with
+/// a debug label or debug name in this set. `enabledPatterns` is a set of
+/// labels used to filter out input patterns that do not have one of the labels
+/// in this set. Debug labels must be set explicitly on patterns or when adding
+/// them with `RewritePatternSet::addWithLabel`. Debug names may be empty, but
+/// patterns created with `RewritePattern::create` have their default debug name
+/// set to their type name.
 std::unique_ptr<Pass>
-createCanonicalizerPass(const GreedyRewriteConfig &config);
+createCanonicalizerPass(const GreedyRewriteConfig &config,
+                        ArrayRef<std::string> disabledPatterns = llvm::None,
+                        ArrayRef<std::string> enabledPatterns = llvm::None);
 
 /// Creates a pass to perform common sub expression elimination.
 std::unique_ptr<Pass> createCSEPass();
 
 /// Creates a loop fusion pass which fuses loops according to type of fusion
 /// specified in `fusionMode`. Buffers of size less than or equal to
 /// `localBufSizeThreshold` are promoted to memory space `fastMemorySpace`.
 std::unique_ptr<OperationPass<FuncOp>>

mlir/lib/Transforms/Canonicalizer.cpp

 #include "mlir/Transforms/GreedyPatternRewriteDriver.h"
 #include "mlir/Transforms/Passes.h"
 
 using namespace mlir;
 
 namespace {
 /// Canonicalize operations in nested regions.
 struct Canonicalizer : public CanonicalizerBase<Canonicalizer> {
-  Canonicalizer(const GreedyRewriteConfig &config) : config(config) {}
+  Canonicalizer(const GreedyRewriteConfig &config,
+                ArrayRef<std::string> disabledPatterns,
+                ArrayRef<std::string> enabledPatterns)
+      : config(config) {
+    this->disabledPatterns = disabledPatterns;
+    this->enabledPatterns = enabledPatterns;
+  }
 
   Canonicalizer() {
     // Default constructed Canonicalizer takes its settings from command line
     // options.
     config.useTopDownTraversal = topDownProcessingEnabled;
     config.enableRegionSimplification = enableRegionSimplification;
     config.maxIterations = maxIterations;
   }

 
 /// Create a Canonicalizer pass.
 std::unique_ptr<Pass> mlir::createCanonicalizerPass() {
   return std::make_unique<Canonicalizer>();
 }
 
 /// Creates an instance of the Canonicalizer pass with the specified config.
 std::unique_ptr<Pass>
-mlir::createCanonicalizerPass(const GreedyRewriteConfig &config) {
-  return std::make_unique<Canonicalizer>(config);
+createCanonicalizerPass(const GreedyRewriteConfig &config,
+                        ArrayRef<std::string> disabledPatterns = llvm::None,
+                        ArrayRef<std::string> enabledPatterns = llvm::None) {
+  return std::make_unique<Canonicalizer>(config, disabledPatterns,
+                                         enabledPatterns);
 }