1 //===- Passes.h - Pass Entrypoints ------------------------------*- C++ -*-===//
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 // This header file defines utility functions exposed by the GPU dialect
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef MLIR_DIALECT_GPU_TRANSFORMS_UTILS_H_
14 #define MLIR_DIALECT_GPU_TRANSFORMS_UTILS_H_
15 
16 #include "mlir/Support/LLVM.h"
17 
18 namespace mlir {
19 struct LogicalResult;
20 class Operation;
21 class Value;
22 
23 namespace gpu {
24 class GPUFuncOp;
25 class LaunchOp;
26 } // namespace gpu
27 
28 /// Get a gpu.func created from outlining the region of a gpu.launch op with the
29 /// given `kernelFnName`. The region of the `launchOp` can use values from
30 /// above. These need to be captured and passed as arguments to the generated
31 /// gpu.func. The generated function has arguments
32 /// - corresponding to the values passed in as `operands`, in that order.
33 /// - any additional values that might be used within the region of the
34 ///   `launchOp` and defined above it. These captured values are appended to the
35 ///   `operands` list.
36 gpu::GPUFuncOp outlineKernelFunc(gpu::LaunchOp launchOp, StringRef kernelFnName,
37                                  SmallVectorImpl<Value> &operands);
38 
39 /// Sink operations into the `launchOp` to reduce the number of values that are
40 /// used within the region of the operation, but defined outside of the
41 /// region.
42 LogicalResult sinkOperationsIntoLaunchOp(
43     gpu::LaunchOp launchOp,
44     llvm::function_ref<bool(Operation *)> isSinkingBeneficiary);
45 
46 } // namespace mlir
47 #endif // MLIR_DIALECT_GPU_TRANSFORMS_UTILS_H_
48