1 //===- mlir-spirv-cpu-runner.cpp - MLIR SPIR-V Execution on CPU -----------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Main entry point to a command line utility that executes an MLIR file on the
10 // CPU by translating MLIR GPU module and host part to LLVM IR before
11 // JIT-compiling and executing.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "mlir/Conversion/GPUToSPIRV/GPUToSPIRVPass.h"
16 #include "mlir/Conversion/SPIRVToLLVM/SPIRVToLLVMPass.h"
17 #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVMPass.h"
18 #include "mlir/Dialect/GPU/GPUDialect.h"
19 #include "mlir/Dialect/GPU/Passes.h"
20 #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
21 #include "mlir/Dialect/MemRef/IR/MemRef.h"
22 #include "mlir/Dialect/SPIRV/IR/SPIRVDialect.h"
23 #include "mlir/Dialect/SPIRV/IR/SPIRVOps.h"
24 #include "mlir/Dialect/SPIRV/Transforms/Passes.h"
25 #include "mlir/Dialect/StandardOps/IR/Ops.h"
26 #include "mlir/ExecutionEngine/JitRunner.h"
27 #include "mlir/ExecutionEngine/OptUtils.h"
28 #include "mlir/Pass/Pass.h"
29 #include "mlir/Pass/PassManager.h"
30 #include "mlir/Target/LLVMIR/Dialect/LLVMIR/LLVMToLLVMIRTranslation.h"
31 #include "mlir/Target/LLVMIR/Export.h"
32 
33 #include "llvm/IR/LLVMContext.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/Linker/Linker.h"
36 #include "llvm/Support/InitLLVM.h"
37 #include "llvm/Support/TargetSelect.h"
38 
39 using namespace mlir;
40 
41 /// A utility function that builds llvm::Module from two nested MLIR modules.
42 ///
43 /// module @main {
44 ///   module @kernel {
45 ///     // Some ops
46 ///   }
47 ///   // Some other ops
48 /// }
49 ///
50 /// Each of these two modules is translated to LLVM IR module, then they are
51 /// linked together and returned.
52 static std::unique_ptr<llvm::Module>
53 convertMLIRModule(ModuleOp module, llvm::LLVMContext &context) {
54   // Verify that there is only one nested module.
55   auto modules = module.getOps<ModuleOp>();
56   if (!llvm::hasSingleElement(modules)) {
57     module.emitError("The module must contain exactly one nested module");
58     return nullptr;
59   }
60 
61   // Translate nested module and erase it.
62   ModuleOp nested = *modules.begin();
63   std::unique_ptr<llvm::Module> kernelModule =
64       translateModuleToLLVMIR(nested, context);
65   nested.erase();
66 
67   std::unique_ptr<llvm::Module> mainModule =
68       translateModuleToLLVMIR(module, context);
69   llvm::Linker::linkModules(*mainModule, std::move(kernelModule));
70   return mainModule;
71 }
72 
73 static LogicalResult runMLIRPasses(ModuleOp module) {
74   PassManager passManager(module.getContext());
75   applyPassManagerCLOptions(passManager);
76   passManager.addPass(createGpuKernelOutliningPass());
77   passManager.addPass(createConvertGPUToSPIRVPass());
78 
79   OpPassManager &nestedPM = passManager.nest<spirv::ModuleOp>();
80   nestedPM.addPass(spirv::createLowerABIAttributesPass());
81   nestedPM.addPass(spirv::createUpdateVersionCapabilityExtensionPass());
82   passManager.addPass(createLowerHostCodeToLLVMPass());
83   passManager.addPass(createConvertSPIRVToLLVMPass());
84   return passManager.run(module);
85 }
86 
87 int main(int argc, char **argv) {
88   llvm::InitLLVM y(argc, argv);
89 
90   llvm::InitializeNativeTarget();
91   llvm::InitializeNativeTargetAsmPrinter();
92   mlir::initializeLLVMPasses();
93 
94   mlir::JitRunnerConfig jitRunnerConfig;
95   jitRunnerConfig.mlirTransformer = runMLIRPasses;
96   jitRunnerConfig.llvmModuleBuilder = convertMLIRModule;
97 
98   mlir::DialectRegistry registry;
99   registry.insert<mlir::LLVM::LLVMDialect, mlir::gpu::GPUDialect,
100                   mlir::spirv::SPIRVDialect, mlir::StandardOpsDialect,
101                   mlir::memref::MemRefDialect>();
102   mlir::registerLLVMDialectTranslation(registry);
103 
104   return mlir::JitRunnerMain(argc, argv, registry, jitRunnerConfig);
105 }
106