Create TestReducer pass

[msifontes]

Summary

• Create a pass that generates bugs based on trivially defined behavior for the purpose of testing the MLIR Reduce Tool.
• Implement the functionality inside the pass to crash mlir-opt in the presence of an operation with the name "crashOp".
• Register the pass as a test pass in the mlir-opt tool.

[stephenneuendorffer]

mlir/test/lib/Reducer/CMakeLists.txt

3

MLIRTestReducer?

mlir/test/lib/Reducer/TestReducer.cpp

17 ↗

(On Diff #276538)

test-mlir-reducer?

mlir/test/mlir-reduce/test-reducer-pass.mlir

3

Maybe also want an expected pass without -test-mlir-reduce? And a success without crashOp?

[mehdi_amini]

mlir/test/mlir-reduce/test-reducer-pass.mlir

3

+1

Also, don't use XFAIL: it means that the test is failing.
Instead mark the fact that mlir-opt is intended to crash by running it as RUN: not mlir-opt %s ....

[msifontes]

mlir/test/mlir-reduce/test-reducer-pass.mlir

3

The initial exit code of the crash is 134. When I use the 'not' keyword it changes it to 1. Should I change the fatal_error call used to produce the crash to an error that produces an exit code of 1?

[msifontes]

• Modify naming from test reduce to test reducer
• Add mlir-opt test case without test-mlir-reducer pass

[msifontes]

Modify TestReducer.cpp to MLIRTestReducer.cpp

[jpienaar]

mlir/test/lib/Reducer/TestReducer.cpp

9 ↗

(On Diff #276538)

Perhaps instead of bugs, error reproducers?

42 ↗

(On Diff #276538)

How about just checking for test.crashOp? (e.g., if dialect foo has a crashOp we should ignore it). You should be able to compare the stringref to the constant directly

44 ↗

(On Diff #276538)

s/Bug// ?

51 ↗

(On Diff #276538)

generating failures ? (depends on if you intend this to just crash or not, else you can say generating crashes)

[mehdi_amini]

mlir/test/mlir-reduce/test-reducer-pass.mlir

3

There is something fishy here... not will turn any non 0 exit code into a 0.

[msifontes]

• Modify error to exit with code 1
• Modify testcase to use the 'not' keyword
• Change 'bug' wording to 'failure'

mlir/test/lib/CMakeLists.txt

 add_subdirectory(DeclarativeTransforms)
 add_subdirectory(Dialect)
 add_subdirectory(IR)
 add_subdirectory(Pass)
+add_subdirectory(Reducer)
 add_subdirectory(Transforms)

mlir/test/lib/Reducer/CMakeLists.txt

+# Exclude tests from libMLIR.so
+add_mlir_library(MLIRTestReducer
+  MLIRTestReducer.cpp
+
+  EXCLUDE_FROM_LIBMLIR
+
+  ADDITIONAL_HEADER_DIRS
+  ${MLIR_MAIN_INCLUDE_DIR}/mlir/IR
+
+  LINK_COMPONENTS
+  Core
+
+  LINK_LIBS PUBLIC
+  MLIRIR
+  MLIRPass
+  MLIRSupport
+  )

mlir/test/lib/Reducer/MLIRTestReducer.cpp

+//===- TestReducer.cpp - Test MLIR Reduce ---------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+// This file implements a pass that reproduces errors based on trivially defined
+// patterns. It is used as a buggy optimization pass for the purpose of testing
+// the MLIR Reduce tool.
+//
+//===----------------------------------------------------------------------===//
+
+#include "mlir/Pass/Pass.h"
+
+#define PASS_NAME "test-mlir-reducer"
+
+using namespace mlir;
+
+static llvm::cl::OptionCategory clOptionsCategory(PASS_NAME " options");
+
+namespace {
+
+/// This pass looks for for the presence of an operation with the name
+/// "crashOp" in the input MLIR file and crashes the mlir-opt tool if the
+/// operation is found.
+struct TestReducer : public PassWrapper<TestReducer, FunctionPass> {
+  TestReducer() = default;
+  TestReducer(const TestReducer &pass){};
+  void runOnFunction() override;
+};
+
+} // end anonymous namespace
+
+void TestReducer::runOnFunction() {
+  for (auto &op : getOperation())
+    op.walk([&](Operation *op) {
+      StringRef opName = op->getName().getStringRef();
+
+      if (opName == "test.crashOp") {
+        llvm::errs() << "MLIR Reducer Test generated failure: Found "
+                        "\"crashOp\" operation\n";
+        exit(1);
+      }
+    });
+}
+
+namespace mlir {
+void registerTestReducer() {
+  PassRegistration<TestReducer>(
+      PASS_NAME, "Tests MLIR Reduce tool by generating failures");
+}
+} // namespace mlir

mlir/test/mlir-reduce/test-reducer-pass.mlir

+// RUN: mlir-opt %s
+// RUN: not mlir-opt %s -test-mlir-reducer
+
+func @test() {
+  "test.crashOp"() : () -> ()
+  return
+}

mlir/tools/mlir-opt/CMakeLists.txt

 
 if(MLIR_INCLUDE_TESTS)
   set(test_libs
     MLIRAffineTransformsTestPasses
     MLIRSPIRVTestPasses
     MLIRTestDialect
     MLIRTestIR
     MLIRTestPass
+    MLIRTestReducer
     MLIRTestTransforms
     )
 endif()
 
 set(LIBS
   ${dialect_libs}
   ${conversion_libs}
   ${test_libs}

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

 void registerTestLoopMappingPass();
 void registerTestLoopUnrollingPass();
 void registerTestMatchers();
 void registerTestMemRefDependenceCheck();
 void registerTestMemRefStrideCalculation();
 void registerTestOpaqueLoc();
 void registerTestParallelismDetection();
 void registerTestPreparationPassWithAllowedMemrefResults();
+void registerTestReducer();
 void registerTestGpuParallelLoopMappingPass();
 void registerTestSCFUtilsPass();
 void registerTestVectorConversions();
 void registerVectorizerTestPass();
 } // namespace mlir
 
 static cl::opt<std::string>
     inputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
#endif
   registerTestLoopMappingPass();
   registerTestLoopUnrollingPass();
   registerTestMatchers();
   registerTestMemRefDependenceCheck();
   registerTestMemRefStrideCalculation();
   registerTestOpaqueLoc();
   registerTestParallelismDetection();
   registerTestPreparationPassWithAllowedMemrefResults();
+  registerTestReducer();
   registerTestGpuParallelLoopMappingPass();
   registerTestSCFUtilsPass();
   registerTestVectorConversions();
   registerVectorizerTestPass();
 }
 #endif
 
 static cl::opt<bool>