[mlir][GPUToSPIRV] Add a test pass to set workgroup size for kernel functions.

[mravishankar]

Summary

This allows using command line flags to lowere from GPU to SPIR-V. The
pass added is only for testing/example purposes. Most uses cases will
need more fine-grained control on setting workgroup sizes for kernel
functions.

Depends On D84590

[rriddle]

mlir/lib/Conversion/GPUToSPIRV/ConvertGPUToSPIRVPass.cpp

42 ↗

(On Diff #280793)

Please do not add test passes to the main tree, they should only be in the test/ directory.

[mravishankar]

Addressing comments

[mravishankar]

mlir/lib/Conversion/GPUToSPIRV/ConvertGPUToSPIRVPass.cpp

42 ↗

(On Diff #280793)

Moved the pass to test directory

[rriddle]

(Leaving approval to Lei or Stephan)

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

29

This doesn't look used?

34

Why is this option int64_t if you only use it as int32_t?

[mravishankar]

Addressing comments

[mravishankar]

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

29

Right. Removed it.

34

Changed to int32_t.

[herhut]

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

29

Left-over comment?

[mravishankar]

Remove commented out code.

[mravishankar]

Adding missing new line at end of file.

mlir/test/Conversion/GPUToSPIRV/test_spirv_entry_point.mlir

+// RUN: mlir-opt -test-spirv-entry-point-abi %s | FileCheck %s -check-prefix=DEFAULT
+// RUN: mlir-opt -test-spirv-entry-point-abi="workgroup-size=32" %s | FileCheck %s -check-prefix=WG32
+
+//      DEFAULT: gpu.func @foo()
+// DEFAULT-SAME: spv.entry_point_abi = {local_size = dense<1> : vector<3xi32>}
+
+//      WG32: gpu.func @foo()
+// WG32-SAME:  spv.entry_point_abi = {local_size = dense<[32, 1, 1]> : vector<3xi32>}
+
+gpu.module @kernels {
+  gpu.func @foo() kernel {
+    gpu.return
+  }
+}

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

 # Exclude tests from libMLIR.so
 add_mlir_library(MLIRSPIRVTestPasses
   TestAvailability.cpp
+  TestEntryPointAbi.cpp
 
   EXCLUDE_FROM_LIBMLIR
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/Dialect/SPIRV
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/IR
 
   LINK_LIBS PUBLIC
+  MLIRGPU
   MLIRIR
   MLIRPass
   MLIRSPIRV
   MLIRSupport
   )

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

+//===- TestAvailability.cpp - Test pass for setting Entry point ABI info --===//
+//
+// 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 sets the spv.entry_point_abi attribute on
+// functions that are to be lowered as entry point functions.
+//
+//===----------------------------------------------------------------------===//
+
+#include "mlir/Dialect/GPU/GPUDialect.h"
+#include "mlir/Dialect/SPIRV/SPIRVDialect.h"
+#include "mlir/Dialect/SPIRV/TargetAndABI.h"
+#include "mlir/Pass/Pass.h"
+
+using namespace mlir;
+
+namespace {
+/// Pass to set the spv.entry_point_abi
+class TestSpirvEntryPointABIPass
+    : public PassWrapper<TestSpirvEntryPointABIPass,
+                         OperationPass<gpu::GPUModuleOp>> {
+public:
+  TestSpirvEntryPointABIPass() = default;
+  TestSpirvEntryPointABIPass(const TestSpirvEntryPointABIPass &) {}
+  void runOnOperation() override;
+
+private:
+  Pass::ListOption<int32_t> workgroupSize{
+      *this, "workgroup-size",
+      llvm::cl::desc(
+          "Workgroup size to use for all gpu.func kernels in the module, "
+          "specified with x-dimension first, y-dimension next and z-dimension "
+          "last. Unspecified dimensions will be set to 1"),
+      llvm::cl::ZeroOrMore, llvm::cl::MiscFlags::CommaSeparated};
+};
+} // namespace
+
+void TestSpirvEntryPointABIPass::runOnOperation() {
+  gpu::GPUModuleOp gpuModule = getOperation();
+  MLIRContext *context = &getContext();
+  StringRef attrName = spirv::getEntryPointABIAttrName();
+  for (gpu::GPUFuncOp gpuFunc : gpuModule.getOps<gpu::GPUFuncOp>()) {
+    if (!gpu::GPUDialect::isKernel(gpuFunc) || gpuFunc.getAttr(attrName))
+      continue;
+    SmallVector<int32_t, 3> workgroupSizeVec(workgroupSize.begin(),
+                                             workgroupSize.end());
+    workgroupSizeVec.resize(3, 1);
+    gpuFunc.setAttr(attrName,
+                    spirv::getEntryPointABIAttr(workgroupSizeVec, context));
+  }
+}
+
+namespace mlir {
+void registerTestSpirvEntryPointABIPass() {
+  PassRegistration<TestSpirvEntryPointABIPass> registration(
+      "test-spirv-entry-point-abi",
+      "Set the spv.entry_point_abi attribute on GPU kernel function within the "
+      "module, intended for testing only");
+}
+} // namespace mlir

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

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