[mlir][Transform] Add an example of a preloaded reference lowering to LLVM

[nicolasvasilache]

mlir/test/Dialect/LLVM/lower-to-llvm-e2e.mlir

57

@ftynse I think we could simplify some genuflexions here around wrapping payload in a transform.target_tag="payload" if we had a transform.module op.
Thoughts ?

[ftynse]

@ftynse I think we could simplify some genuflexions here around wrapping payload in a transform.target_tag="payload" if we had a transform.module op.

Thoughts ?

It would make it impossible to target a single op, rather than a region attached to the module op. It could also interfere with verification rules in some cases (e.g. when we cannot just inject random module around an op, such as GPU module/kernel verification). I really don't see a problem with attaching an attribute for debugging purposes.

mlir/test/Dialect/LLVM/lower-to-llvm-e2e.mlir

57

@ftynse I think we could simplify some genuflexions here around wrapping payload in a transform.target_tag="payload" if we had a transform.module op.
Thoughts ?

mlir/lib/Dialect/Linalg/TransformOps/CMakeLists.txt

add_mlir_dialect_library(MLIRLinalgTransformOps
 
   LINK_LIBS PUBLIC
   MLIRAffineDialect
   MLIRArithDialect
   MLIRBufferizationDialect
   MLIRBufferizationTransforms
   MLIRFuncDialect
   MLIRFunctionInterfaces
+  MLIRIndexDialect
   MLIRIR
   MLIRLinalgDialect
   MLIRLinalgTransforms
   MLIRParser
   MLIRSCFDialect
   MLIRSideEffectInterfaces
   MLIRTransformDialect
   MLIRTransformDialectUtils
   MLIRVectorTransforms
   )

mlir/lib/Dialect/Linalg/TransformOps/DialectExtension.cpp

 //===- DialectExtension.cpp - Linalg transform dialect extension ----------===//
 //
 // 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/Linalg/TransformOps/DialectExtension.h"
 #include "mlir/Dialect/Affine/IR/AffineOps.h"
 #include "mlir/Dialect/Arith/IR/Arith.h"
 #include "mlir/Dialect/GPU/IR/GPUDialect.h"
+#include "mlir/Dialect/Index/IR/IndexDialect.h"
 #include "mlir/Dialect/Linalg/IR/Linalg.h"
 #include "mlir/Dialect/Linalg/TransformOps/LinalgMatchOps.h"
 #include "mlir/Dialect/Linalg/TransformOps/LinalgTransformOps.h"
 #include "mlir/Dialect/Linalg/Transforms/Transforms.h"
 #include "mlir/Dialect/SCF/IR/SCF.h"
 #include "mlir/Dialect/Tensor/IR/Tensor.h"
 #include "mlir/Dialect/Transform/IR/TransformDialect.h"
 #include "mlir/Dialect/Transform/IR/TransformOps.h"

 public:
   using Base::Base;
 
   void init() {
     declareDependentDialect<linalg::LinalgDialect>();
 
     declareGeneratedDialect<affine::AffineDialect>();
     declareGeneratedDialect<arith::ArithDialect>();
+    declareGeneratedDialect<index::IndexDialect>();
     declareGeneratedDialect<scf::SCFDialect>();
     declareGeneratedDialect<vector::VectorDialect>();
     declareGeneratedDialect<gpu::GPUDialect>();
     declareGeneratedDialect<tensor::TensorDialect>();
 
     registerTransformOps<
 #define GET_OP_LIST
 #include "mlir/Dialect/Linalg/TransformOps/LinalgTransformOps.cpp.inc"

mlir/test/Dialect/LLVM/lower-to-llvm-e2e.mlir

-// RUN: mlir-opt %s -o - -test-lower-to-llvm -cse -split-input-file | FileCheck %s
 // Note: We run CSE here to make the pattern matching more direct.
 
+// RUN: mlir-opt %s -test-lower-to-llvm -cse | FileCheck %s
+
+// RUN: mlir-opt %s -test-transform-dialect-interpreter="transform-library-file-name=%p/lower-to-llvm-transform-symbol-def.mlir debug-payload-root-tag=payload" \
+// RUN:   -test-transform-dialect-erase-schedule -cse \
+// RUN: | FileCheck %s
+
+module attributes {transform.target_tag="payload"} {
+
 // Check that we properly lower to llvm memref operations that require to be
 // expanded first, like `memref.subview`.
 func.func @subview(%0 : memref<64x4xf32, strided<[4, 1], offset: 0>>, %arg0 : index, %arg1 : index, %arg2 : index)
 -> memref<?x?xf32, strided<[?, ?], offset: ?>> {
   // CHECK-LABEL: @subview
   // CHECK-SAME: %[[BASE:[^:]*]]: !llvm.ptr
   // CHECK-SAME: %[[BASE_ALIGNED:[^:]*]]: !llvm.ptr,
   // CHECK-SAME: %[[BASE_OFFSET:[^:]*]]: i64,
-> memref<?x?xf32, strided<[?, ?], offset: ?>> {
   // Stride 1 == 1 * %arg1.
   // CHECK: %[[DESC6:.*]] = llvm.insertvalue %[[ARG1]], %[[DESC5]][4, 1] : !llvm.struct<(ptr, ptr, i64, array<2 x i64>, array<2 x i64>)>
 
   %1 = memref.subview %0[%arg0, %arg1][%arg0, %arg1][%arg0, %arg1] :
     memref<64x4xf32, strided<[4, 1], offset: 0>>
   to memref<?x?xf32, strided<[?, ?], offset: ?>>
   return %1 : memref<?x?xf32, strided<[?, ?], offset: ?>>
 }
+
+} // transform payload
+
+module @named_inclusion_in_named attributes { transform.with_named_sequence } {
+  transform.named_sequence private @lower_to_cpu(!transform.any_op {transform.consumed}) -> !transform.any_op
+
+  transform.sequence failures(propagate) {
+  ^bb1(%toplevel_module: !transform.any_op):
+    %m2 = transform.include @lower_to_cpu failures(suppress) (%toplevel_module) 
+      : (!transform.any_op) -> (!transform.any_op)
+  }
+}

mlir/test/Dialect/LLVM/lower-to-llvm-transform-symbol-def.mlir

+// RUN: mlir-opt %s
+
+/// Schedule to lower to LLVM.
+module @lower_module_to_cpu attributes { transform.with_named_sequence } {
+
+transform.named_sequence @lower_to_cpu(
+    %module: !transform.any_op {transform.consumed}) -> !transform.any_op {
+
+  %func = transform.structured.match ops{["func.func"]} in %module : (!transform.any_op) -> !transform.any_op
+  %f = transform.apply_registered_pass "convert-vector-to-scf" to %func : (!transform.any_op) -> !transform.any_op
+  %f2 = transform.apply_registered_pass "convert-linalg-to-loops" to %f : (!transform.any_op) -> !transform.any_op
+  %f3 = transform.apply_registered_pass "convert-scf-to-cf" to %f2 : (!transform.any_op) -> !transform.any_op
+  %f4 = transform.apply_registered_pass "expand-strided-metadata" to %f3 : (!transform.any_op) -> !transform.any_op
+  %f5 = transform.apply_registered_pass "lower-affine" to %f4 : (!transform.any_op) -> !transform.any_op
+
+  transform.apply_conversion_patterns to %f5 {
+    transform.apply_conversion_patterns.dialect_to_llvm "math"
+    transform.apply_conversion_patterns.vector.vector_to_llvm
+    transform.apply_conversion_patterns.dialect_to_llvm "memref"
+    transform.apply_conversion_patterns.func.func_to_llvm
+    transform.apply_conversion_patterns.dialect_to_llvm "index"
+    transform.apply_conversion_patterns.dialect_to_llvm "arith"
+    transform.apply_conversion_patterns.dialect_to_llvm "cf"
+  } with type_converter {
+    transform.apply_conversion_patterns.memref.memref_to_llvm_type_converter
+      {index_bitwidth = 64,
+       use_bare_ptr = false,
+       use_bare_ptr_memref_call_conv = false,
+       use_opaque_pointers = true}
+  } {
+    legal_dialects = ["llvm"],
+    partial_conversion
+  } : !transform.any_op
+
+  %m2 = transform.apply_registered_pass "reconcile-unrealized-casts" to %module : (!transform.any_op) -> !transform.any_op
+  transform.yield %m2 : !transform.any_op
+}
+
+} // transform module

utils/bazel/llvm-project-overlay/mlir/BUILD.bazel

deps = [
         ":ArithDialect",
         ":AsmParser",
         ":BufferizationDialect",
         ":BufferizationTransforms",
         ":DialectUtils",
         ":FuncDialect",
         ":FunctionInterfaces",
         ":GPUDialect",
+        ":IndexDialect",
         ":IR",
         ":LinalgDialect",
         ":LinalgMatchOpsIncGen",
         ":LinalgTransformEnumsIncGen",
         ":LinalgTransformOpsIncGen",
         ":LinalgTransforms",
         ":LinalgUtils",
         ":SCFDialect",

utils/bazel/llvm-project-overlay/mlir/test/Dialect/BUILD.bazel

lit_test(
             "Transform/*-symbol-def.mlir",
             "Transform/*-symbol-decl-and-schedule.mlir",
         ]),
     )
     for src in glob(
         include = ["**/*.mlir"],
         exclude = [
             "IRDL/*.irdl.mlir",
+            "LLVM/*-symbol-def.mlir",
             "Transform/*-source.mlir",
             "Transform/*-symbol-def.mlir",
             "Transform/*-symbol-decl-and-schedule.mlir",
             "Transform/test-repro-dump.mlir",
         ],
     )
 ]