MLIR  19.0.0git
Passes.h
Go to the documentation of this file.
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 prototypes that expose pass constructors in the loop
10 // transformation library.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef MLIR_TRANSFORMS_PASSES_H
15 #define MLIR_TRANSFORMS_PASSES_H
16 
17 #include "mlir/Pass/Pass.h"
21 #include "llvm/Support/Debug.h"
22 #include <limits>
23 #include <memory>
24 
25 namespace mlir {
26 
27 class GreedyRewriteConfig;
28 
29 //===----------------------------------------------------------------------===//
30 // Passes
31 //===----------------------------------------------------------------------===//
32 
33 #define GEN_PASS_DECL_CANONICALIZER
34 #define GEN_PASS_DECL_CONTROLFLOWSINK
35 #define GEN_PASS_DECL_CSEPASS
36 #define GEN_PASS_DECL_INLINER
37 #define GEN_PASS_DECL_LOOPINVARIANTCODEMOTION
38 #define GEN_PASS_DECL_MEM2REG
39 #define GEN_PASS_DECL_PRINTIRPASS
40 #define GEN_PASS_DECL_PRINTOPSTATS
41 #define GEN_PASS_DECL_SROA
42 #define GEN_PASS_DECL_STRIPDEBUGINFO
43 #define GEN_PASS_DECL_SCCP
44 #define GEN_PASS_DECL_SYMBOLDCE
45 #define GEN_PASS_DECL_SYMBOLPRIVATIZE
46 #define GEN_PASS_DECL_TOPOLOGICALSORT
47 #define GEN_PASS_DECL_COMPOSITEFIXEDPOINTPASS
48 #include "mlir/Transforms/Passes.h.inc"
49 
50 /// Creates an instance of the Canonicalizer pass, configured with default
51 /// settings (which can be overridden by pass options on the command line).
52 std::unique_ptr<Pass> createCanonicalizerPass();
53 
54 /// Creates an instance of the Canonicalizer pass with the specified config.
55 /// `disabledPatterns` is a set of labels used to filter out input patterns with
56 /// a debug label or debug name in this set. `enabledPatterns` is a set of
57 /// labels used to filter out input patterns that do not have one of the labels
58 /// in this set. Debug labels must be set explicitly on patterns or when adding
59 /// them with `RewritePatternSet::addWithLabel`. Debug names may be empty, but
60 /// patterns created with `RewritePattern::create` have their default debug name
61 /// set to their type name.
62 std::unique_ptr<Pass>
63 createCanonicalizerPass(const GreedyRewriteConfig &config,
64  ArrayRef<std::string> disabledPatterns = std::nullopt,
65  ArrayRef<std::string> enabledPatterns = std::nullopt);
66 
67 /// Creates a pass to perform control-flow sinking.
68 std::unique_ptr<Pass> createControlFlowSinkPass();
69 
70 /// Creates a pass to perform common sub expression elimination.
71 std::unique_ptr<Pass> createCSEPass();
72 
73 /// Creates a pass to print IR on the debug stream.
74 std::unique_ptr<Pass> createPrintIRPass(const PrintIRPassOptions & = {});
75 
76 /// Creates a pass that generates IR to verify ops at runtime.
77 std::unique_ptr<Pass> createGenerateRuntimeVerificationPass();
78 
79 /// Creates a loop invariant code motion pass that hoists loop invariant
80 /// instructions out of the loop.
81 std::unique_ptr<Pass> createLoopInvariantCodeMotionPass();
82 
83 /// Creates a pass that hoists loop-invariant subset ops.
84 std::unique_ptr<Pass> createLoopInvariantSubsetHoistingPass();
85 
86 /// Creates a pass to strip debug information from a function.
87 std::unique_ptr<Pass> createStripDebugInfoPass();
88 
89 /// Creates a pass which prints the list of ops and the number of occurrences in
90 /// the module.
91 std::unique_ptr<Pass> createPrintOpStatsPass(raw_ostream &os = llvm::errs());
92 
93 /// Creates a pass which prints the list of ops and the number of occurrences in
94 /// the module with the output format option.
95 std::unique_ptr<Pass> createPrintOpStatsPass(raw_ostream &os, bool printAsJSON);
96 
97 /// Creates a pass which inlines calls and callable operations as defined by
98 /// the CallGraph.
99 std::unique_ptr<Pass> createInlinerPass();
100 /// Creates an instance of the inliner pass, and use the provided pass managers
101 /// when optimizing callable operations with names matching the key type.
102 /// Callable operations with a name not within the provided map will use the
103 /// default inliner pipeline during optimization.
104 std::unique_ptr<Pass>
105 createInlinerPass(llvm::StringMap<OpPassManager> opPipelines);
106 /// Creates an instance of the inliner pass, and use the provided pass managers
107 /// when optimizing callable operations with names matching the key type.
108 /// Callable operations with a name not within the provided map will use the
109 /// provided default pipeline builder.
110 std::unique_ptr<Pass>
111 createInlinerPass(llvm::StringMap<OpPassManager> opPipelines,
112  std::function<void(OpPassManager &)> defaultPipelineBuilder);
113 
114 /// Creates an optimization pass to remove dead values.
115 std::unique_ptr<Pass> createRemoveDeadValuesPass();
116 
117 /// Creates a pass which performs sparse conditional constant propagation over
118 /// nested operations.
119 std::unique_ptr<Pass> createSCCPPass();
120 
121 /// Creates a pass which delete symbol operations that are unreachable. This
122 /// pass may *only* be scheduled on an operation that defines a SymbolTable.
123 std::unique_ptr<Pass> createSymbolDCEPass();
124 
125 /// Creates a pass which marks top-level symbol operations as `private` unless
126 /// listed in `excludeSymbols`.
127 std::unique_ptr<Pass>
128 createSymbolPrivatizePass(ArrayRef<std::string> excludeSymbols = {});
129 
130 /// Creates a pass that recursively sorts nested regions without SSA dominance
131 /// topologically such that, as much as possible, users of values appear after
132 /// their producers.
133 std::unique_ptr<Pass> createTopologicalSortPass();
134 
135 /// Create composite pass, which runs provided set of passes until fixed point
136 /// or maximum number of iterations reached.
137 std::unique_ptr<Pass> createCompositeFixedPointPass(
138  std::string name, llvm::function_ref<void(OpPassManager &)> populateFunc,
139  int maxIterations = 10);
140 
141 //===----------------------------------------------------------------------===//
142 // Registration
143 //===----------------------------------------------------------------------===//
144 
145 /// Generate the code for registering passes.
146 #define GEN_PASS_REGISTRATION
147 #include "mlir/Transforms/Passes.h.inc"
148 
149 } // namespace mlir
150 
151 #endif // MLIR_TRANSFORMS_PASSES_H
Include the generated interface declarations.
std::unique_ptr< Pass > createPrintIRPass(const PrintIRPassOptions &={})
Creates a pass to print IR on the debug stream.
Definition: PrintIR.cpp:33
std::unique_ptr< Pass > createCSEPass()
Creates a pass to perform common sub expression elimination.
Definition: CSE.cpp:416
std::unique_ptr< Pass > createLoopInvariantCodeMotionPass()
Creates a loop invariant code motion pass that hoists loop invariant instructions out of the loop.
std::unique_ptr< Pass > createStripDebugInfoPass()
Creates a pass to strip debug information from a function.
std::unique_ptr< Pass > createTopologicalSortPass()
Creates a pass that recursively sorts nested regions without SSA dominance topologically such that,...
std::unique_ptr< Pass > createCompositeFixedPointPass(std::string name, llvm::function_ref< void(OpPassManager &)> populateFunc, int maxIterations=10)
Create composite pass, which runs provided set of passes until fixed point or maximum number of itera...
std::unique_ptr< Pass > createSCCPPass()
Creates a pass which performs sparse conditional constant propagation over nested operations.
Definition: SCCP.cpp:133
std::unique_ptr< Pass > createSymbolDCEPass()
Creates a pass which delete symbol operations that are unreachable.
Definition: SymbolDCE.cpp:149
std::unique_ptr< Pass > createInlinerPass()
Creates a pass which inlines calls and callable operations as defined by the CallGraph.
std::unique_ptr< Pass > createGenerateRuntimeVerificationPass()
Creates a pass that generates IR to verify ops at runtime.
std::unique_ptr< Pass > createCanonicalizerPass()
Creates an instance of the Canonicalizer pass, configured with default settings (which can be overrid...
std::unique_ptr< Pass > createRemoveDeadValuesPass()
Creates an optimization pass to remove dead values.
std::unique_ptr< Pass > createPrintOpStatsPass(raw_ostream &os=llvm::errs())
Creates a pass which prints the list of ops and the number of occurrences in the module.
Definition: OpStats.cpp:115
std::unique_ptr< Pass > createControlFlowSinkPass()
Creates a pass to perform control-flow sinking.
std::unique_ptr< Pass > createLoopInvariantSubsetHoistingPass()
Creates a pass that hoists loop-invariant subset ops.
std::unique_ptr< Pass > createSymbolPrivatizePass(ArrayRef< std::string > excludeSymbols={})
Creates a pass which marks top-level symbol operations as private unless listed in excludeSymbols.