[mlir][spirv] NFC: Move GLSL canonicalization pass to Transforms/

[antiagainst]

Summary

This is a pass that can be used by downstream consumers directly
to avoid the boilerplate to wrap around the populate*Patterns.

[antiagainst]

Update comment

[antiagainst]

Update

mlir/include/mlir/Dialect/SPIRV/IR/SPIRVGLSLCanonicalization.h

 #include "mlir/IR/PatternMatch.h"
 
 //===----------------------------------------------------------------------===//
 // GLSL canonicalization patterns
 //===----------------------------------------------------------------------===//
 
 namespace mlir {
 namespace spirv {
-void populateSPIRVGLSLCanonicalizationPatterns(
-    mlir::RewritePatternSet &results);
+/// Populates patterns to run canoncalization that involves GLSL ops.
+///
+/// These patterns cannot be run in default canonicalization because GLSL ops
+/// aren't always available. So they should be involed specifically when needed.
+void populateSPIRVGLSLCanonicalizationPatterns(RewritePatternSet &results);
 } // namespace spirv
 } // namespace mlir
 
 #endif // MLIR_DIALECT_SPIRV_IR_SPIRVGLSLCANONICALIZATION_H_

mlir/include/mlir/Dialect/SPIRV/Transforms/Passes.h

 #define MLIR_DIALECT_SPIRV_TRANSFORMS_PASSES_H_
 
 #include "mlir/Pass/Pass.h"
 
 namespace mlir {
 namespace spirv {
 
 class ModuleOp;
+class FuncOp;
 
 //===----------------------------------------------------------------------===//
 // Passes
 //===----------------------------------------------------------------------===//
 
+/// Creates a pass to run canoncalization patterns that involve GLSL ops.
+/// These patterns cannot be run in default canonicalization because GLSL ops
+/// aren't always available. So they should be involed specifically when needed.
+std::unique_ptr<OperationPass<>> createCanonicalizeGLSLPass();
+
 /// Creates a module pass that converts composite types used by objects in the
 /// StorageBuffer, PhysicalStorageBuffer, Uniform, and PushConstant storage
 /// classes with layout information.
 /// Right now this pass only supports Vulkan layout rules.
 std::unique_ptr<OperationPass<mlir::ModuleOp>>
 createDecorateSPIRVCompositeTypeLayoutPass();
 
 /// Creates an operation pass that deduces and attaches the minimal version/

mlir/include/mlir/Dialect/SPIRV/Transforms/Passes.td

 include "mlir/Pass/PassBase.td"
 
 def SPIRVCompositeTypeLayout
     : Pass<"decorate-spirv-composite-type-layout", "ModuleOp"> {
   let summary = "Decorate SPIR-V composite type with layout info";
   let constructor = "mlir::spirv::createDecorateSPIRVCompositeTypeLayoutPass()";
 }
 
+def SPIRVCanonicalizeGLSL : Pass<"spirv-canonicalize-glsl", ""> {
+  let summary = "Run canonicalization involving GLSL ops";
+  let constructor = "mlir::spirv::createCanonicalizeGLSLPass()";
+}
+
 def SPIRVLowerABIAttributes : Pass<"spirv-lower-abi-attrs", "spirv::ModuleOp"> {
   let summary = "Decorate SPIR-V composite type with layout info";
   let constructor = "mlir::spirv::createLowerABIAttributesPass()";
 }
 
 def SPIRVRewriteInsertsPass : Pass<"spirv-rewrite-inserts", "spirv::ModuleOp"> {
   let summary = "Rewrite sequential chains of spv.CompositeInsert operations into "
                 "spv.CompositeConstruct operations";

mlir/lib/Dialect/SPIRV/Transforms/CMakeLists.txt

 set(LLVM_OPTIONAL_SOURCES
+  CanonicalizeGLSLPass.cpp
   DecorateCompositeTypeLayoutPass.cpp
   LowerABIAttributesPass.cpp
   RewriteInsertsPass.cpp
   SPIRVConversion.cpp
   UnifyAliasedResourcePass.cpp
   UpdateVCEPass.cpp
 )
 
 add_mlir_dialect_library(MLIRSPIRVConversion
   SPIRVConversion.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/Dialect/SPIRV
 
   LINK_LIBS PUBLIC
   MLIRSPIRV
   MLIRTransformUtils
 )
 
 add_mlir_dialect_library(MLIRSPIRVTransforms
+  CanonicalizeGLSLPass.cpp
   DecorateCompositeTypeLayoutPass.cpp
   LowerABIAttributesPass.cpp
   RewriteInsertsPass.cpp
   UnifyAliasedResourcePass.cpp
   UpdateVCEPass.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/Dialect/SPIRV

mlir/lib/Dialect/SPIRV/Transforms/CanonicalizeGLSLPass.cpp

+//===- CanonicalizeGLSLPass.cpp - GLSL Related Canonicalization Pass ------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "PassDetail.h"
+#include "mlir/Dialect/SPIRV/IR/SPIRVGLSLCanonicalization.h"
+#include "mlir/Dialect/SPIRV/IR/SPIRVOps.h"
+#include "mlir/Dialect/SPIRV/Transforms/Passes.h"
+#include "mlir/Pass/Pass.h"
+#include "mlir/Transforms/GreedyPatternRewriteDriver.h"
+
+using namespace mlir;
+
+namespace {
+class CanonicalizeGLSLPass final
+    : public SPIRVCanonicalizeGLSLBase<CanonicalizeGLSLPass> {
+public:
+  void runOnOperation() override {
+    RewritePatternSet patterns(&getContext());
+    spirv::populateSPIRVGLSLCanonicalizationPatterns(patterns);
+    if (failed(
+            applyPatternsAndFoldGreedily(getOperation(), std::move(patterns))))
+      return signalPassFailure();
+  }
+};
+} // namespace
+
+std::unique_ptr<OperationPass<>> spirv::createCanonicalizeGLSLPass() {
+  return std::make_unique<CanonicalizeGLSLPass>();
+}

mlir/lib/Dialect/SPIRV/Transforms/PassDetail.h

 #define DIALECT_SPIRV_TRANSFORMS_PASSDETAIL_H_
 
 #include "mlir/Pass/Pass.h"
 
 namespace mlir {
 
 namespace spirv {
 class ModuleOp;
+class FuncOp;
 } // namespace spirv
 
 #define GEN_PASS_CLASSES
 #include "mlir/Dialect/SPIRV/Transforms/Passes.h.inc"
 
 } // namespace mlir
 
 #endif // DIALECT_SPIRV_TRANSFORMS_PASSDETAIL_H_

mlir/test/Dialect/SPIRV/Transforms/glsl-canonicalize.mlir

-// RUN: mlir-opt -test-spirv-glsl-canonicalization -split-input-file -verify-diagnostics %s | FileCheck %s
+// RUN: mlir-opt -split-input-file -spirv-canonicalize-glsl %s | FileCheck %s
 
 // CHECK: func @clamp_fordlessthan(%[[INPUT:.*]]: f32)
 func @clamp_fordlessthan(%input: f32) -> f32 {
   // CHECK: %[[MIN:.*]] = spv.Constant
   %min = spv.Constant 0.5 : f32
   // CHECK: %[[MAX:.*]] = spv.Constant
   %max = spv.Constant 1.0 : f32
 

mlir/test/lib/Dialect/SPIRV/CMakeLists.txt

 # Exclude tests from libMLIR.so
 add_mlir_library(MLIRSPIRVTestPasses
   TestAvailability.cpp
   TestEntryPointAbi.cpp
-  TestGLSLCanonicalization.cpp
   TestModuleCombiner.cpp
 
   EXCLUDE_FROM_LIBMLIR
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/Dialect/SPIRV
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/IR
 

mlir/test/lib/Dialect/SPIRV/TestGLSLCanonicalization.cpp

-//===- TestGLSLCanonicalization.cpp - Pass to test GLSL-specific pattterns ===//
-//
-// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
-// See https://llvm.org/LICENSE.txt for license information.
-// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
-//
-//===----------------------------------------------------------------------===//
-
-#include "mlir/Dialect/SPIRV/IR/SPIRVGLSLCanonicalization.h"
-#include "mlir/Pass/Pass.h"
-#include "mlir/Transforms/GreedyPatternRewriteDriver.h"
-
-using namespace mlir;
-
-namespace {
-class TestGLSLCanonicalizationPass
-    : public PassWrapper<TestGLSLCanonicalizationPass,
-                         OperationPass<mlir::ModuleOp>> {
-public:
-  TestGLSLCanonicalizationPass() = default;
-  TestGLSLCanonicalizationPass(const TestGLSLCanonicalizationPass &) {}
-  void runOnOperation() override;
-  StringRef getArgument() const final {
-    return "test-spirv-glsl-canonicalization";
-  }
-  StringRef getDescription() const final {
-    return "Tests SPIR-V canonicalization patterns for GLSL extension.";
-  }
-};
-} // namespace
-
-void TestGLSLCanonicalizationPass::runOnOperation() {
-  RewritePatternSet patterns(&getContext());
-  spirv::populateSPIRVGLSLCanonicalizationPatterns(patterns);
-  (void)applyPatternsAndFoldGreedily(getOperation(), std::move(patterns));
-}
-
-namespace mlir {
-void registerTestSpirvGLSLCanonicalizationPass() {
-  PassRegistration<TestGLSLCanonicalizationPass>();
-}
-} // namespace mlir

mlir/tools/mlir-opt/mlir-opt.cpp

 void registerTestGpuMemoryPromotionPass();
 void registerTestLoopPermutationPass();
 void registerTestMatchers();
 void registerTestOperationEqualPass();
 void registerTestPrintDefUsePass();
 void registerTestPrintNestingPass();
 void registerTestReducer();
 void registerTestSpirvEntryPointABIPass();
-void registerTestSpirvGLSLCanonicalizationPass();
 void registerTestSpirvModuleCombinerPass();
 void registerTestTraitsPass();
 void registerTosaTestQuantUtilAPIPass();
 void registerVectorizerTestPass();
 
 namespace test {
 void registerConvertCallOpPass();
 void registerInliner();
void registerTestPasses() {
   registerTestGpuMemoryPromotionPass();
   registerTestLoopPermutationPass();
   registerTestMatchers();
   registerTestOperationEqualPass();
   registerTestPrintDefUsePass();
   registerTestPrintNestingPass();
   registerTestReducer();
   registerTestSpirvEntryPointABIPass();
-  registerTestSpirvGLSLCanonicalizationPass();
   registerTestSpirvModuleCombinerPass();
   registerTestTraitsPass();
   registerVectorizerTestPass();
   registerTosaTestQuantUtilAPIPass();
 
   mlir::test::registerConvertCallOpPass();
   mlir::test::registerInliner();
   mlir::test::registerMemRefBoundCheck();