xref: /llvm-project/llvm/tools/llvm-reduce/DeltaManager.cpp (revision 596fdf75d99f83473295e6a619ffac5afa23dd8e)
1 //===- DeltaManager.cpp - Runs Delta Passes to reduce Input ---------------===//
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 file calls each specialized Delta pass in order to reduce the input IR
10 // file.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "DeltaManager.h"
15 #include "ReducerWorkItem.h"
16 #include "TestRunner.h"
17 #include "deltas/Delta.h"
18 #include "deltas/ReduceAliases.h"
19 #include "deltas/ReduceArguments.h"
20 #include "deltas/ReduceAttributes.h"
21 #include "deltas/ReduceBasicBlocks.h"
22 #include "deltas/ReduceDIMetadata.h"
23 #include "deltas/ReduceFunctionBodies.h"
24 #include "deltas/ReduceFunctions.h"
25 #include "deltas/ReduceGlobalObjects.h"
26 #include "deltas/ReduceGlobalValues.h"
27 #include "deltas/ReduceGlobalVarInitializers.h"
28 #include "deltas/ReduceGlobalVars.h"
29 #include "deltas/ReduceIRReferences.h"
30 #include "deltas/ReduceInstructionFlags.h"
31 #include "deltas/ReduceInstructionFlagsMIR.h"
32 #include "deltas/ReduceInstructions.h"
33 #include "deltas/ReduceInstructionsMIR.h"
34 #include "deltas/ReduceMemoryOperations.h"
35 #include "deltas/ReduceMetadata.h"
36 #include "deltas/ReduceModuleData.h"
37 #include "deltas/ReduceOpcodes.h"
38 #include "deltas/ReduceOperandBundles.h"
39 #include "deltas/ReduceOperands.h"
40 #include "deltas/ReduceOperandsSkip.h"
41 #include "deltas/ReduceOperandsToArgs.h"
42 #include "deltas/ReduceRegisterDefs.h"
43 #include "deltas/ReduceRegisterMasks.h"
44 #include "deltas/ReduceRegisterUses.h"
45 #include "deltas/ReduceSpecialGlobals.h"
46 #include "deltas/ReduceUsingSimplifyCFG.h"
47 #include "deltas/ReduceVirtualRegisters.h"
48 #include "deltas/RunIRPasses.h"
49 #include "deltas/SimplifyInstructions.h"
50 #include "deltas/StripDebugInfo.h"
51 #include "llvm/Support/CommandLine.h"
52 
53 using namespace llvm;
54 
55 using SmallStringSet = SmallSet<StringRef, 8>;
56 
57 extern cl::OptionCategory LLVMReduceOptions;
58 static cl::list<std::string>
59     DeltaPasses("delta-passes",
60                 cl::desc("Delta passes to run, separated by commas. By "
61                          "default, run all delta passes."),
62                 cl::cat(LLVMReduceOptions), cl::CommaSeparated);
63 
64 static cl::list<std::string>
65     SkipDeltaPasses("skip-delta-passes",
66                     cl::desc("Delta passes to not run, separated by commas. By "
67                              "default, run all delta passes."),
68                     cl::cat(LLVMReduceOptions), cl::CommaSeparated);
69 
70 #define DELTA_PASSES                                                           \
71   do {                                                                         \
72     DELTA_PASS("strip-debug-info", stripDebugInfoDeltaPass)                    \
73     DELTA_PASS("functions", reduceFunctionsDeltaPass)                          \
74     DELTA_PASS("function-bodies", reduceFunctionBodiesDeltaPass)               \
75     DELTA_PASS("special-globals", reduceSpecialGlobalsDeltaPass)               \
76     DELTA_PASS("aliases", reduceAliasesDeltaPass)                              \
77     DELTA_PASS("basic-blocks", reduceBasicBlocksDeltaPass)                     \
78     DELTA_PASS("global-values", reduceGlobalValuesDeltaPass)                   \
79     DELTA_PASS("global-objects", reduceGlobalObjectsDeltaPass)                 \
80     DELTA_PASS("global-initializers", reduceGlobalsInitializersDeltaPass)      \
81     DELTA_PASS("global-variables", reduceGlobalsDeltaPass)                     \
82     DELTA_PASS("di-metadata", reduceDIMetadataDeltaPass)                       \
83     DELTA_PASS("metadata", reduceMetadataDeltaPass)                            \
84     DELTA_PASS("arguments", reduceArgumentsDeltaPass)                          \
85     DELTA_PASS("instructions", reduceInstructionsDeltaPass)                    \
86     DELTA_PASS("simplify-instructions", simplifyInstructionsDeltaPass)         \
87     DELTA_PASS("ir-passes", runIRPassesDeltaPass)                              \
88     DELTA_PASS("operands-zero", reduceOperandsZeroDeltaPass)                   \
89     DELTA_PASS("operands-one", reduceOperandsOneDeltaPass)                     \
90     DELTA_PASS("operands-nan", reduceOperandsNaNDeltaPass)                     \
91     DELTA_PASS("operands-to-args", reduceOperandsToArgsDeltaPass)              \
92     DELTA_PASS("operands-skip", reduceOperandsSkipDeltaPass)                   \
93     DELTA_PASS("operand-bundles", reduceOperandBundesDeltaPass)                \
94     DELTA_PASS("simplify-cfg", reduceUsingSimplifyCFGDeltaPass)                \
95     DELTA_PASS("attributes", reduceAttributesDeltaPass)                        \
96     DELTA_PASS("module-data", reduceModuleDataDeltaPass)                       \
97     DELTA_PASS("opcodes", reduceOpcodesDeltaPass)                              \
98     DELTA_PASS("volatile", reduceVolatileInstructionsDeltaPass)                \
99     DELTA_PASS("instruction-flags", reduceInstructionFlagsDeltaPass)           \
100 } while (false)
101 
102 #define DELTA_PASSES_MIR                                                       \
103   do {                                                                         \
104     DELTA_PASS("instructions", reduceInstructionsMIRDeltaPass)                 \
105     DELTA_PASS("ir-instruction-references",                                    \
106                reduceIRInstructionReferencesDeltaPass)                         \
107     DELTA_PASS("ir-block-references", reduceIRBlockReferencesDeltaPass)        \
108     DELTA_PASS("ir-function-references", reduceIRFunctionReferencesDeltaPass)  \
109     DELTA_PASS("instruction-flags", reduceInstructionFlagsMIRDeltaPass)        \
110     DELTA_PASS("register-uses", reduceRegisterUsesMIRDeltaPass)                \
111     DELTA_PASS("register-defs", reduceRegisterDefsMIRDeltaPass)                \
112     DELTA_PASS("register-hints", reduceVirtualRegisterHintsDeltaPass)          \
113     DELTA_PASS("register-masks", reduceRegisterMasksMIRDeltaPass)              \
114   } while (false)
115 
116 static void runAllDeltaPasses(TestRunner &Tester,
117                               const SmallStringSet &SkipPass) {
118 #define DELTA_PASS(NAME, FUNC)                                                 \
119   if (!SkipPass.count(NAME)) {                                                 \
120     FUNC(Tester);                                                              \
121   }
122   if (Tester.getProgram().isMIR()) {
123     DELTA_PASSES_MIR;
124   } else {
125     DELTA_PASSES;
126   }
127 #undef DELTA_PASS
128 }
129 
130 static void runDeltaPassName(TestRunner &Tester, StringRef PassName) {
131 #define DELTA_PASS(NAME, FUNC)                                                 \
132   if (PassName == NAME) {                                                      \
133     FUNC(Tester);                                                              \
134     return;                                                                    \
135   }
136   if (Tester.getProgram().isMIR()) {
137     DELTA_PASSES_MIR;
138   } else {
139     DELTA_PASSES;
140   }
141 #undef DELTA_PASS
142 
143   // We should have errored on unrecognized passes before trying to run
144   // anything.
145   llvm_unreachable("unknown delta pass");
146 }
147 
148 void llvm::printDeltaPasses(raw_ostream &OS) {
149   OS << "Delta passes (pass to `--delta-passes=` as a comma separated list):\n";
150 #define DELTA_PASS(NAME, FUNC) OS << "  " << NAME << "\n";
151   OS << " IR:\n";
152   DELTA_PASSES;
153   OS << " MIR:\n";
154   DELTA_PASSES_MIR;
155 #undef DELTA_PASS
156 }
157 
158 // Built a set of available delta passes.
159 static void collectPassNames(const TestRunner &Tester,
160                              SmallStringSet &NameSet) {
161 #define DELTA_PASS(NAME, FUNC) NameSet.insert(NAME);
162   if (Tester.getProgram().isMIR()) {
163     DELTA_PASSES_MIR;
164   } else {
165     DELTA_PASSES;
166   }
167 #undef DELTA_PASS
168 }
169 
170 /// Verify all requested or skipped passes are valid names, and return them in a
171 /// set.
172 static SmallStringSet handlePassList(const TestRunner &Tester,
173                                      const cl::list<std::string> &PassList) {
174   SmallStringSet AllPasses;
175   collectPassNames(Tester, AllPasses);
176 
177   SmallStringSet PassSet;
178   for (StringRef PassName : PassList) {
179     if (!AllPasses.count(PassName)) {
180       errs() << "unknown pass \"" << PassName << "\"\n";
181       exit(1);
182     }
183 
184     PassSet.insert(PassName);
185   }
186 
187   return PassSet;
188 }
189 
190 void llvm::runDeltaPasses(TestRunner &Tester, int MaxPassIterations) {
191   uint64_t OldComplexity = Tester.getProgram().getComplexityScore();
192 
193   SmallStringSet RunPassSet, SkipPassSet;
194 
195   if (!DeltaPasses.empty())
196     RunPassSet = handlePassList(Tester, DeltaPasses);
197 
198   if (!SkipDeltaPasses.empty())
199     SkipPassSet = handlePassList(Tester, SkipDeltaPasses);
200 
201   for (int Iter = 0; Iter < MaxPassIterations; ++Iter) {
202     if (DeltaPasses.empty()) {
203       runAllDeltaPasses(Tester, SkipPassSet);
204     } else {
205       for (StringRef PassName : DeltaPasses) {
206         if (!SkipPassSet.count(PassName))
207           runDeltaPassName(Tester, PassName);
208       }
209     }
210 
211     uint64_t NewComplexity = Tester.getProgram().getComplexityScore();
212     if (NewComplexity >= OldComplexity)
213       break;
214     OldComplexity = NewComplexity;
215   }
216 }
217