[SYCL-MLIR][NFC] Restructure Polygeist dialect (#8266)

Apply following changes to the dialect to follow MLIR dialects
conventions:

- Change headers locations:
  - Dialect definition: "mlir/Dialect/Polygeist/IR/"
  - Transform passes: "mlir/Dialect/Polygeist/Transforms/"
  - Conversion passes: "mlir/Conversion/PolygeistTo<dialect>/"
  - Dialect utils: "mlir/Dialect/Polygeist/Utils/<file>.h"
- Create a library for each conversion pass.
- Conversion passes are defined under the `mlir` namespace.

This commit does not intend to be a complete refactoring of the dialect.
This is a work in progress, not intending to refactor any code.

Signed-off-by: Victor Perez <[email protected]>

Author: victor-eds

mlir-sycl/include/mlir/Dialect/SYCL/Transforms/Passes.h

@@ -17,8 +17,7 @@
 
 #include "mlir/Pass/Pass.h"
 
-#include "polygeist/Dialect.h"
-#include "polygeist/Passes/Passes.h"
+#include "mlir/Dialect/Polygeist/IR/Polygeist.h"
 
 namespace mlir {
 namespace sycl {

mlir-sycl/lib/Conversion/SYCLToLLVM/SYCLToLLVM.cpp

@@ -16,13 +16,13 @@
 #include "mlir/Conversion/SYCLToLLVM/DialectBuilder.h"
 #include "mlir/Dialect/Func/IR/FuncOps.h"
 #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
+#include "mlir/Dialect/Polygeist/Utils/Utils.h"
 #include "mlir/Dialect/SYCL/IR/SYCLOps.h"
 #include "mlir/IR/Builders.h"
 #include "mlir/IR/BuiltinOps.h"
 #include "mlir/IR/PatternMatch.h"
 #include "mlir/Support/LogicalResult.h"
 #include "mlir/Transforms/DialectConversion.h"
-#include "polygeist/Passes/Utils.h"
 #include "llvm/Support/Debug.h"
 
 #define DEBUG_TYPE "sycl-to-llvm"

mlir-sycl/lib/Dialect/IR/MethodUtils.cpp

@@ -10,10 +10,10 @@
 
 #include "mlir/Dialect/Arith/IR/Arith.h"
 #include "mlir/Dialect/MemRef/IR/MemRef.h"
+#include "mlir/Dialect/Polygeist/IR/Ops.h"
 #include "mlir/Dialect/SYCL/IR/SYCLOps.h"
 #include "mlir/IR/Builders.h"
 #include "mlir/IR/ValueRange.h"
-#include "polygeist/Ops.h"
 #include "llvm/ADT/TypeSwitch.h"
 
 #include <algorithm>

mlir-sycl/lib/Transforms/SYCLMethodToSYCLCall.cpp

@@ -25,7 +25,7 @@
 #include "mlir/Rewrite/FrozenRewritePatternSet.h"
 #include "mlir/Transforms/GreedyPatternRewriteDriver.h"
 
-#include "polygeist/Ops.h"
+#include "mlir/Dialect/Polygeist/IR/Ops.h"
 #include "llvm/Support/Debug.h"
 
 #define DEBUG_TYPE "sycl-method-to-sycl-call"

polygeist/include/CMakeLists.txt

@@ -1 +1 @@
-add_subdirectory(polygeist)
+add_subdirectory(mlir)

polygeist/include/mlir/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(Conversion)
+add_subdirectory(Dialect)

polygeist/include/mlir/Conversion/CMakeLists.txt

@@ -0,0 +1,3 @@
+set(LLVM_TARGET_DEFINITIONS PolygeistPasses.td)
+mlir_tablegen(PolygeistPasses.h.inc -gen-pass-decls -name Conversion)
+add_public_tablegen_target(MLIRPolygeistConversionPassIncGen)

polygeist/include/mlir/Conversion/PolygeistPasses.h

@@ -0,0 +1,22 @@
+//===- PolygeistPasses.h - Conversion Pass Construction and Registration --===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef MLIR_CONVERSION_POLYGEISTPASSES_H
+#define MLIR_CONVERSION_POLYGEISTPASSES_H
+
+#include "mlir/Conversion/PolygeistToLLVM/PolygeistToLLVMPass.h"
+
+namespace mlir {
+namespace polygeist {
+/// Generate the code for registering conversion passes.
+#define GEN_PASS_REGISTRATION
+#include "mlir/Conversion/PolygeistPasses.h.inc"
+} // namespace polygeist
+} // namespace mlir
+
+#endif // MLIR_CONVERSION_POLYGEISTPASSES_H

polygeist/include/mlir/Conversion/PolygeistPasses.td

@@ -0,0 +1,53 @@
+#ifndef MLIR_CONVERSION_POLYGEISTPASSES
+#define MLIR_CONVERSION_POLYGEISTPASSES
+
+include "mlir/Pass/PassBase.td"
+
+def ConvertPolygeistToLLVM : Pass<"convert-polygeist-to-llvm", "mlir::ModuleOp"> {
+  let summary = "Convert scalar and vector operations from the Standard to the "
+                "LLVM dialect";
+  let description = [{
+    Convert standard operations into the LLVM IR dialect operations.
+
+    #### Input invariant
+
+    -   operations including: arithmetic on integers and floats, constants,
+        direct calls, returns and branches;
+    -   no `tensor` types;
+    -   all `vector` are one-dimensional;
+    -   all blocks are reachable by following the successors of the first basic
+        block;
+
+    If other operations are present and their results are required by the LLVM
+    IR dialect operations, the pass will fail.  Any LLVM IR operations or types
+    already present in the IR will be kept as is.
+
+    #### Output IR
+
+    Functions converted to LLVM IR. Function arguments types are converted
+    one-to-one. Function results are converted one-to-one and, in case more than
+    1 value is returned, packed into an LLVM IR struct type. Function calls and
+    returns are updated accordingly. Block argument types are updated to use
+    LLVM IR types.
+  }];
+  let constructor = "mlir::createConvertPolygeistToLLVMPass()";
+  let dependentDialects = ["LLVM::LLVMDialect"];
+  let options = [
+    Option<"useBarePtrCallConv", "use-bare-ptr-memref-call-conv", "bool",
+           /*default=*/"false",
+           "Replace FuncOp's MemRef arguments with bare pointers to the MemRef "
+           "element types">,
+    Option<"emitCWrappers", "emit-c-wrappers", "bool", /*default=*/"false",
+           "Emit wrappers for C-compatible pointer-to-struct memref "
+           "descriptors">,
+    Option<"indexBitwidth", "index-bitwidth", "unsigned",
+           /*default=kDeriveIndexBitwidthFromDataLayout*/"0",
+           "Bitwidth of the index type, 0 to use size of machine word">,
+    Option<"dataLayout", "data-layout", "std::string",
+           /*default=*/"\"\"",
+           "String description (LLVM format) of the data layout that is "
+           "expected on the produced module">
+  ];
+}
+
+#endif // MLIR_CONVERSION_POLYGEISTPASSES

polygeist/include/mlir/Conversion/PolygeistToLLVM/PolygeistToLLVMPass.h

@@ -0,0 +1,20 @@
+#ifndef MLIR_CONVERSION_POLYGEISTTOLLVM_POLYGEISTTOLLVMPASS_H
+#define MLIR_CONVERSION_POLYGEISTTOLLVM_POLYGEISTTOLLVMPASS_H
+
+#include "mlir/Pass/Pass.h"
+
+#include <memory>
+
+namespace mlir {
+class LowerToLLVMOptions;
+
+#define GEN_PASS_DECL_CONVERTPOLYGEISTTOLLVM
+#include "mlir/Conversion/PolygeistPasses.h.inc"
+#undef GEN_PASS_DECL_CONVERTPOLYGEISTTOLLVM
+
+std::unique_ptr<Pass> createConvertPolygeistToLLVMPass();
+std::unique_ptr<Pass>
+createConvertPolygeistToLLVMPass(const LowerToLLVMOptions &options);
+} // namespace mlir
+
+#endif // MLIR_CONVERSION_POLYGEISTTOLLVM_POLYGEISTTOLLVMPASS_H

polygeist/include/mlir/Dialect/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(Polygeist)

polygeist/include/mlir/Dialect/Polygeist/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(IR)
+add_subdirectory(Transforms)

polygeist/include/mlir/Dialect/Polygeist/IR/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_mlir_dialect(PolygeistOps polygeist)
+add_mlir_doc(PolygeistOps PolygeistOps Dialects/ -gen-dialect-doc -dialect=polygeist)

polygeist/include/polygeist/Ops.h renamed to polygeist/include/mlir/Dialect/Polygeist/IR/Ops.h

@@ -6,8 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef POLYGEISTOPS_H
-#define POLYGEISTOPS_H
+#ifndef MLIR_DIALECT_POLYGEIST_IR_OPS_H_
+#define MLIR_DIALECT_POLYGEIST_IR_OPS_H_
 
 #include "mlir/Dialect/Affine/IR/AffineOps.h"
 #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
@@ -22,7 +22,7 @@
 #include "llvm/Support/CommandLine.h"
 
 #define GET_OP_CLASSES
-#include "polygeist/PolygeistOps.h.inc"
+#include "mlir/Dialect/Polygeist/IR/PolygeistOps.h.inc"
 
 #include "mlir/Dialect/Affine/IR/AffineOps.h"
 #include "mlir/Dialect/SCF/IR/SCF.h"
@@ -147,4 +147,4 @@ class BarrierElim final
   }
 };
 
-#endif // POLYGEISTOPS_H
+#endif // MLIR_DIALECT_POLYGEIST_IR_OPS_H_

polygeist/include/polygeist/Dialect.h renamed to polygeist/include/mlir/Dialect/Polygeist/IR/Polygeist.h

@@ -6,11 +6,11 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef BFV_BFVDIALECT_H
-#define BFV_BFVDIALECT_H
+#ifndef MLIR_DIALECT_POLYGEIST_IR_POLYGEIST_H_
+#define MLIR_DIALECT_POLYGEIST_IR_POLYGEIST_H_
 
 #include "mlir/IR/Dialect.h"
 
-#include "polygeist/PolygeistOpsDialect.h.inc"
+#include "mlir/Dialect/Polygeist/IR/PolygeistOpsDialect.h.inc"
 
-#endif // BFV_BFVDIALECT_H
+#endif // MLIR_DIALECT_POLYGEIST_IR_POLYGEIST_H_

polygeist/include/mlir/Dialect/Polygeist/IR/PolygeistBase.td

@@ -0,0 +1,20 @@
+//=== PolygeistBase.td - Base definitions for polygeist dialect -*- tablegen =//
+//
+// This file is licensed 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef POLYGEIST_BASE
+#define POLYGEIST_BASE
+
+include "mlir/IR/OpBase.td"
+
+def Polygeist_Dialect : Dialect {
+  let name = "polygeist";
+  let cppNamespace = "::mlir::polygeist";
+  let description = [{}];
+}
+
+#endif // POLYGEIST_BASE

polygeist/include/polygeist/PolygeistOps.td renamed to polygeist/include/mlir/Dialect/Polygeist/IR/PolygeistOps.td

@@ -1,4 +1,4 @@
-//===- Polygeist.td - Polygeist dialect ops ----------------*- tablegen -*-===//
+//===- PolygeistOps.td - Polygeist op definitions ----------*- tablegen -*-===//
 //
 // This file is licensed under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -9,12 +9,14 @@
 #ifndef POLYGEIST_OPS
 #define POLYGEIST_OPS
 
-include "Dialect.td"
+include "mlir/Dialect/LLVMIR/LLVMOpBase.td"
+include "mlir/Dialect/LLVMIR/LLVMOpsInterfaces.td"
+include "mlir/Dialect/Polygeist/IR/PolygeistBase.td"
 include "mlir/Interfaces/SideEffectInterfaces.td"
 include "mlir/Interfaces/ViewLikeInterface.td"
 
-include "mlir/Dialect/LLVMIR/LLVMOpBase.td"
-include "mlir/Dialect/LLVMIR/LLVMOpsInterfaces.td"
+class Polygeist_Op<string mnemonic, list<Trait> traits = []>
+    : Op<Polygeist_Dialect, mnemonic, traits>;
 
 def CacheLoad
     : Polygeist_Op<"cacheload"> {

polygeist/include/polygeist/Passes/CMakeLists.txt renamed to polygeist/include/mlir/Dialect/Polygeist/Transforms/CMakeLists.txt

@@ -1,5 +1,6 @@
 set(LLVM_TARGET_DEFINITIONS Passes.td)
-mlir_tablegen(Passes.h.inc -gen-pass-decls -name polygeist)
+mlir_tablegen(Passes.h.inc -gen-pass-decls -name Polygeist)
 add_public_tablegen_target(MLIRPolygeistPassIncGen)
+add_dependencies(mlir-headers MLIRPolygeistPassIncGen)
 
 add_mlir_doc(Passes PolygeistPasses ./ -gen-pass-doc)

polygeist/include/polygeist/Passes/Passes.h renamed to polygeist/include/mlir/Dialect/Polygeist/Transforms/Passes.h

@@ -1,14 +1,28 @@
-#ifndef POLYGEIST_DIALECT_POLYGEIST_PASSES_H
-#define POLYGEIST_DIALECT_POLYGEIST_PASSES_H
+#ifndef MLIR_DIALECT_POLYGEIST_TRANSFORMS_PASSES_H
+#define MLIR_DIALECT_POLYGEIST_TRANSFORMS_PASSES_H
 
-#include "mlir/Conversion/LLVMCommon/LoweringOptions.h"
 #include "mlir/Pass/Pass.h"
+
 #include <memory>
+
 namespace mlir {
 class PatternRewriter;
 class DominanceInfo;
 class LLVMTypeConverter;
 namespace polygeist {
+//===----------------------------------------------------------------------===//
+// Patterns
+//===----------------------------------------------------------------------===//
+
+/// Collect a set of patterns to convert memory-related operations from the
+/// MemRef dialect to the LLVM dialect forcing a "bare pointer" calling
+/// convention.
+void populateBareMemRefToLLVMConversionPatterns(LLVMTypeConverter &converter,
+                                                RewritePatternSet &patterns);
+
+#define GEN_PASS_DECL
+#include "mlir/Dialect/Polygeist/Transforms/Passes.h.inc"
+
 std::unique_ptr<Pass> createParallelLICMPass();
 std::unique_ptr<Pass> createMem2RegPass();
 std::unique_ptr<Pass> createLoopRestructurePass();
@@ -23,49 +37,15 @@ std::unique_ptr<Pass> detectReductionPass();
 std::unique_ptr<Pass> createRemoveTrivialUsePass();
 std::unique_ptr<Pass> createParallelLowerPass();
 std::unique_ptr<Pass> createLegalizeForSPIRVPass();
-std::unique_ptr<Pass>
-createConvertPolygeistToLLVMPass(const LowerToLLVMOptions &options);
-std::unique_ptr<Pass> createConvertPolygeistToLLVMPass();
 
-/// Collect a set of patterns to convert memory-related operations from the
-/// MemRef dialect to the LLVM dialect forcing a "bare pointer" calling
-/// convention.
-void populateBareMemRefToLLVMConversionPatterns(LLVMTypeConverter &converter,
-                                                RewritePatternSet &patterns);
-
-} // namespace polygeist
-} // namespace mlir
-
-void fully2ComposeAffineMapAndOperands(
-    mlir::PatternRewriter &rewriter, mlir::AffineMap *map,
-    llvm::SmallVectorImpl<mlir::Value> *operands, mlir::DominanceInfo &DI);
-bool isValidIndex(mlir::Value val);
-
-namespace mlir {
-// Forward declaration from Dialect.h
-template <typename ConcreteDialect>
-void registerDialect(DialectRegistry &registry);
-
-namespace scf {
-class SCFDialect;
-} // end namespace scf
-
-namespace memref {
-class MemRefDialect;
-} // end namespace memref
-
-namespace func {
-class FuncDialect;
-}
-
-class AffineDialect;
-namespace LLVM {
-class LLVMDialect;
-}
+//===----------------------------------------------------------------------===//
+// Registration
+//===----------------------------------------------------------------------===//
 
 #define GEN_PASS_REGISTRATION
-#include "polygeist/Passes/Passes.h.inc"
+#include "mlir/Dialect/Polygeist/Transforms/Passes.h.inc"
 
-} // end namespace mlir
+} // namespace polygeist
+} // namespace mlir
 
-#endif // POLYGEIST_DIALECT_POLYGEIST_PASSES_H
+#endif // MLIR_DIALECT_POLYGEIST_TRANSFORMS_PASSES_H