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/SPIRV/IR/SPIRVDialect.h"
22 #include "mlir/Dialect/SPIRV/IR/SPIRVOps.h"
23 #include "mlir/Dialect/SPIRV/Transforms/Passes.h"
24 #include "mlir/Dialect/StandardOps/IR/Ops.h"
25 #include "mlir/ExecutionEngine/JitRunner.h"
26 #include "mlir/ExecutionEngine/OptUtils.h"
27 #include "mlir/Pass/Pass.h"
28 #include "mlir/Pass/PassManager.h"
29 #include "mlir/Target/LLVMIR.h"
30 #include "mlir/Target/LLVMIR/Export.h"
31 
32 #include "llvm/IR/LLVMContext.h"
33 #include "llvm/IR/Module.h"
34 #include "llvm/Linker/Linker.h"
35 #include "llvm/Support/InitLLVM.h"
36 #include "llvm/Support/TargetSelect.h"
37 
38 using namespace mlir;
39 
40 /// A utility function that builds llvm::Module from two nested MLIR modules.
41 ///
42 /// module @main {
43 ///   module @kernel {
44 ///     // Some ops
45 ///   }
46 ///   // Some other ops
47 /// }
48 ///
49 /// Each of these two modules is translated to LLVM IR module, then they are
50 /// linked together and returned.
51 static std::unique_ptr<llvm::Module>
52 convertMLIRModule(ModuleOp module, llvm::LLVMContext &context) {
53   // Verify that there is only one nested module.
54   auto modules = module.getOps<ModuleOp>();
55   if (!llvm::hasSingleElement(modules)) {
56     module.emitError("The module must contain exactly one nested module");
57     return nullptr;
58   }
59 
60   // Translate nested module and erase it.
61   ModuleOp nested = *modules.begin();
62   std::unique_ptr<llvm::Module> kernelModule =
63       translateModuleToLLVMIR(nested, context);
64   nested.erase();
65 
66   std::unique_ptr<llvm::Module> mainModule =
67       translateModuleToLLVMIR(module, context);
68   llvm::Linker::linkModules(*mainModule, std::move(kernelModule));
69   return mainModule;
70 }
71 
72 static LogicalResult runMLIRPasses(ModuleOp module) {
73   PassManager passManager(module.getContext());
74   applyPassManagerCLOptions(passManager);
75   passManager.addPass(createGpuKernelOutliningPass());
76   passManager.addPass(createConvertGPUToSPIRVPass());
77 
78   OpPassManager &nestedPM = passManager.nest<spirv::ModuleOp>();
79   nestedPM.addPass(spirv::createLowerABIAttributesPass());
80   nestedPM.addPass(spirv::createUpdateVersionCapabilityExtensionPass());
81   passManager.addPass(createLowerHostCodeToLLVMPass());
82   passManager.addPass(createConvertSPIRVToLLVMPass());
83   return passManager.run(module);
84 }
85 
86 int main(int argc, char **argv) {
87   llvm::InitLLVM y(argc, argv);
88 
89   llvm::InitializeNativeTarget();
90   llvm::InitializeNativeTargetAsmPrinter();
91   mlir::initializeLLVMPasses();
92 
93   mlir::JitRunnerConfig jitRunnerConfig;
94   jitRunnerConfig.mlirTransformer = runMLIRPasses;
95   jitRunnerConfig.llvmModuleBuilder = convertMLIRModule;
96 
97   mlir::DialectRegistry registry;
98   registry.insert<mlir::LLVM::LLVMDialect, mlir::gpu::GPUDialect,
99                   mlir::spirv::SPIRVDialect, mlir::StandardOpsDialect>();
100   mlir::registerLLVMDialectTranslation(registry);
101 
102   return mlir::JitRunnerMain(argc, argv, registry, jitRunnerConfig);
103 }
104