[mlir][tosa] Create a profile validation pass for TOSA dialect

[tatwaichong]

Summary

Add a separate validation pass to check if TOSA operations match with
the specification against given requirement. Perform profile type
checking as the initial feature in the pass.

This is an optional pass that can be enabled via command line. e.g.
$mlir-opt --tosa-validate="profile=bi" for validating against the
base inference profile.

Description:
TOSA defines a variety of operator behavior and requirements in the
specification. It would be helpful to have a separate validation pass
to keep TOSA operation input match with TOSA specification for given
criteria, and also diminish the burden of dialect validation during
compilation.

TOSA supports three profiles of which two are for inference purposes.
The main inference profile supports both integer and floating-point
data types, but the base inference profile only supports integers.
In this initial PR, validate the operations against a given profile
of TOSA, so that validation would fail if a floating point tensor is
present when the base inference profile is selected. Afterward, others
checking will be added to the pass if needed. e.g. control flow
operators and custom operators validation.

The pass is expected to be able to run on any point of TOSA dialect
conversion/transformation pipeline, and not depend on a particular
pass run ahead. So that it is can be used to validate the initial tosa
operations just converted from other dialects, the intermediate form,
or the final tosa operations output.

Change-Id: Ib58349c873c783056e89d2ab3b3312b8d2c61863

[rsuderman]

mlir/lib/Dialect/Tosa/Transforms/TosaValidation.cpp

43

You should be able to define the enum in tablegen for the pass.

[tatwaichong]

Define the enum in tablegen for the pass, and use a walk on the operation instead.

[tatwaichong]

Thanks. Good to know the enum can be defined in Tblgen. Also change to use walk function as suggested.

[tatwaichong]

fix compilation error.

[tatwaichong]

fix: include header in the wrong place.

[tatwaichong]

fix clang format error

[rsuderman]

mlir/lib/Conversion/TosaToSCF/TosaToSCFPass.cpp

56 ↗

(On Diff #474855)

Why is this included in TosaToSCF? This seems independent of the SCF pass.

[tatwaichong]

mlir/lib/Conversion/TosaToSCF/TosaToSCFPass.cpp

56 ↗

(On Diff #474855)

This question has been asked internally. My thought was to land this pass on the passes named with "Tosa" as use cases. Let's remove this pass from the SCF pass as these dialects aren't relevant.

[tatwaichong]

Remove this pass from the SCF pass as these dialects is independent of each other.

mlir/include/mlir/Dialect/Tosa/Transforms/CMakeLists.txt

 set(LLVM_TARGET_DEFINITIONS Passes.td)
 mlir_tablegen(Passes.h.inc -gen-pass-decls -name TosaOpt)
+mlir_tablegen(PassesEnums.h.inc -gen-enum-decls)
+mlir_tablegen(PassesEnums.cpp.inc -gen-enum-defs)
 add_public_tablegen_target(MLIRTosaPassIncGen)
 add_dependencies(mlir-headers MLIRTosaPassIncGen)
 
 add_mlir_doc(Passes TosaPasses ./ -gen-pass-doc)

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

 //===-- Passes.h - TOSA optimization pass declarations ----------*- C++ -*-===//
 //
 // 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 declares the optimization passes for the TOSA Dialect in MLIR.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef MLIR_DIALECT_TOSA_TRANSFORMS_PASSES_H
 #define MLIR_DIALECT_TOSA_TRANSFORMS_PASSES_H
 
 #include "mlir/Dialect/Tensor/IR/Tensor.h"
+#include "mlir/Dialect/Tosa/Transforms/PassesEnums.h.inc"
 #include "mlir/Pass/Pass.h"
 
 namespace mlir {
 namespace tosa {
 
 #define GEN_PASS_DECL
 #include "mlir/Dialect/Tosa/Transforms/Passes.h.inc"
 
 // Expose Rewrite Functions that decompose TOSA Ops into further TOSA Ops.
 // The rewrites can be selectively added to a conversion pass.
 void populateTosaDecomposeConv2D(MLIRContext *ctx, RewritePatternSet &patterns);
 void populateTosaDecomposeTransposeConv(MLIRContext *ctx,
                                         RewritePatternSet &patterns);
 void populateTosaDecomposeDepthwise(MLIRContext *ctx,
                                     RewritePatternSet &patterns);
 void populateTosaFoldConstantTransposePatterns(MLIRContext *ctx,
                                                RewritePatternSet &patterns);
 
 std::unique_ptr<Pass> createTosaLayerwiseConstantFoldPass();
 std::unique_ptr<Pass> createTosaInferShapesPass();
 std::unique_ptr<Pass> createTosaMakeBroadcastablePass();
 std::unique_ptr<Pass> createTosaTestQuantUtilAPIPass();
 std::unique_ptr<Pass> createTosaOptionalDecompositions();
+std::unique_ptr<Pass> createTosaValidationPass();
 
 #define GEN_PASS_REGISTRATION
 #include "mlir/Dialect/Tosa/Transforms/Passes.h.inc"
 
 } // namespace tosa
 } // namespace mlir
 
 #endif // MLIR_DIALECT_TOSA_TRANSFORMS_PASSES_H

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

 //===-- Passes.td - TOSA pass declarations ----*- tablegen -*-===//
 //
 // 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 declares the passes for the TOSA Dialect in MLIR.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef MLIR_DIALECT_TOSA_TRANSFORMS_PASSES
 #define MLIR_DIALECT_TOSA_TRANSFORMS_PASSES
 
+include "mlir/IR/EnumAttr.td"
 include "mlir/Pass/PassBase.td"
 
 def TosaLayerwiseConstantFoldPass : Pass<"tosa-layerwise-constant-fold", "func::FuncOp"> {
   let summary = "Fold layerwise operations on constant tensors";
   let description = [{
     Pass that enables folding of full-layer operations on constant tensors.
   }];
 
def TosaOptionalDecompositions
   let description = [{
     Pass to apply the Tosa operations decompositions 
     exposed as populate functions in include/mlir/Dialect/Tosa/Transforms/Passes.h
   }];
 
   let constructor = "tosa::createTosaOptionalDecompositions()";
 }
 
+def TosaProfileType : I32EnumAttr<"TosaProfileEnum", "Tosa profile",
+    [
+      I32EnumAttrCase<"BaseInference", 0, "bi">,
+      I32EnumAttrCase<"MainInference", 1, "mi">,
+      I32EnumAttrCase<"MainTraining", 2, "mt">,
+      I32EnumAttrCase<"Undefined", 3>
+    ]>{
+  let cppNamespace = "mlir::tosa";
+}
+
+def TosaValidation : Pass<"tosa-validate", "func::FuncOp"> {
+  let summary = "Validates TOSA dialect";
+  let description = [{
+    This pass validates if input TOSA operations match the specification for given
+    criteria, e.g. TOSA profile.
+  }];
+  let constructor = "createTosaValidationPass()";
+
+  let options = [
+      Option<"profileName", "profile", "std::string",
+      /*default=*/"\"undefined\"",
+      "Validation if ops match for given profile">];
+}
+
 #endif // MLIR_DIALECT_TOSA_TRANSFORMS_PASSES

mlir/lib/Conversion/TosaToLinalg/TosaToLinalgPass.cpp

void mlir::tosa::addTosaToLinalgPasses(OpPassManager &pm,
   pm.addNestedPass<func::FuncOp>(createCanonicalizerPass());
 
   pm.addNestedPass<func::FuncOp>(tosa::createTosaMakeBroadcastablePass());
   pm.addNestedPass<func::FuncOp>(tosa::createTosaToLinalgNamed());
   pm.addNestedPass<func::FuncOp>(createCanonicalizerPass());
   // TODO: Remove pass that operates on const tensor and enable optionality
   pm.addNestedPass<func::FuncOp>(tosa::createTosaLayerwiseConstantFoldPass());
   pm.addNestedPass<func::FuncOp>(tosa::createTosaMakeBroadcastablePass());
+  pm.addNestedPass<func::FuncOp>(tosa::createTosaValidationPass());
   pm.addNestedPass<func::FuncOp>(tosa::createTosaToLinalg());
 }

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

 add_mlir_dialect_library(MLIRTosaTransforms
   TosaDecomposeTransposeConv.cpp
   TosaDecomposeConv2D.cpp
   TosaDecomposeDepthwise.cpp
   TosaFoldConstantTranspose.cpp
   TosaInferShapes.cpp
   TosaLayerwiseConstantFoldPass.cpp
   TosaMakeBroadcastable.cpp
   TosaOptionalDecompositions.cpp
+  TosaValidation.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/Dialect/Tosa/Transforms
 
   DEPENDS
   MLIRTosaPassIncGen
 
   LINK_LIBS PUBLIC
   MLIRFuncDialect
   MLIRPass
   MLIRTosaDialect
   MLIRTransformUtils
   )

mlir/lib/Dialect/Tosa/Transforms/TosaValidation.cpp

+//===- TosaValidation.cpp ------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+// Validate if TOSA dialect input matchs with the specification for given
+// requirements.
+//
+//===----------------------------------------------------------------------===//
+
+#include "mlir/Dialect/Tosa/Transforms/Passes.h"
+#include "mlir/Dialect/Tosa/Transforms/PassesEnums.cpp.inc"
+
+#include "mlir/Dialect/Func/IR/FuncOps.h"
+#include "mlir/Dialect/Tosa/IR/TosaOps.h"
+#include "mlir/IR/Builders.h"
+#include "mlir/IR/BuiltinOps.h"
+#include "mlir/IR/Matchers.h"
+#include "mlir/IR/TypeUtilities.h"
+#include "mlir/Pass/Pass.h"
+#include "mlir/Transforms/DialectConversion.h"
+
+namespace mlir {
+namespace tosa {
+#define GEN_PASS_DEF_TOSAVALIDATION
+#include "mlir/Dialect/Tosa/Transforms/Passes.h.inc"
+} // namespace tosa
+} // namespace mlir
+
+using namespace mlir;
+using namespace mlir::tosa;
+
+namespace {
+
+//===----------------------------------------------------------------------===//
+// TOSA Validation Pass.
+//===----------------------------------------------------------------------===//
+
+struct TosaValidation : public tosa::impl::TosaValidationBase<TosaValidation> {
+public:
+  explicit TosaValidation() {}
+
+private:
+  void runOnOperation() override;
+
+  llvm::Optional<TosaProfileEnum> profile_type;
+};
+
+void TosaValidation::runOnOperation() {
+  profile_type = symbolizeEnum<TosaProfileEnum>(profileName);
+
+  getOperation().walk([&](Operation *op) {
+    for (Value operand : op->getOperands()) {
+      if ((profile_type == TosaProfileEnum::BaseInference) &&
+          getElementTypeOrSelf(operand).isa<FloatType>()) {
+        return signalPassFailure();
+      }
+    }
+  });
+}
+} // namespace
+
+std::unique_ptr<Pass> mlir::tosa::createTosaValidationPass() {
+  return std::make_unique<TosaValidation>();
+}