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/ReduceFunctionBodies.h"
23 #include "deltas/ReduceFunctions.h"
24 #include "deltas/ReduceGlobalObjects.h"
25 #include "deltas/ReduceGlobalValues.h"
26 #include "deltas/ReduceGlobalVarInitializers.h"
27 #include "deltas/ReduceGlobalVars.h"
28 #include "deltas/ReduceIRReferences.h"
29 #include "deltas/ReduceInstructionFlagsMIR.h"
30 #include "deltas/ReduceInstructions.h"
31 #include "deltas/ReduceInstructionsMIR.h"
32 #include "deltas/ReduceMetadata.h"
33 #include "deltas/ReduceModuleData.h"
34 #include "deltas/ReduceOperandBundles.h"
35 #include "deltas/ReduceOperands.h"
36 #include "deltas/ReduceOperandsSkip.h"
37 #include "deltas/ReduceOperandsToArgs.h"
38 #include "deltas/ReduceRegisterUses.h"
39 #include "deltas/ReduceSpecialGlobals.h"
40 #include "deltas/ReduceVirtualRegisters.h"
41 #include "deltas/SimplifyInstructions.h"
42 #include "llvm/Support/CommandLine.h"
43 
44 using namespace llvm;
45 
46 extern cl::OptionCategory LLVMReduceOptions;
47 static cl::opt<std::string>
48     DeltaPasses("delta-passes",
49                 cl::desc("Delta passes to run, separated by commas. By "
50                          "default, run all delta passes."),
51                 cl::cat(LLVMReduceOptions));
52 
53 #define DELTA_PASSES                                                           \
54   do {                                                                         \
55     DELTA_PASS("special-globals", reduceSpecialGlobalsDeltaPass)               \
56     DELTA_PASS("aliases", reduceAliasesDeltaPass)                              \
57     DELTA_PASS("function-bodies", reduceFunctionBodiesDeltaPass)               \
58     DELTA_PASS("functions", reduceFunctionsDeltaPass)                          \
59     DELTA_PASS("basic-blocks", reduceBasicBlocksDeltaPass)                     \
60     DELTA_PASS("global-values", reduceGlobalValuesDeltaPass)                   \
61     DELTA_PASS("global-objects", reduceGlobalObjectsDeltaPass)                 \
62     DELTA_PASS("global-initializers", reduceGlobalsInitializersDeltaPass)      \
63     DELTA_PASS("global-variables", reduceGlobalsDeltaPass)                     \
64     DELTA_PASS("metadata", reduceMetadataDeltaPass)                            \
65     DELTA_PASS("arguments", reduceArgumentsDeltaPass)                          \
66     DELTA_PASS("instructions", reduceInstructionsDeltaPass)                    \
67     DELTA_PASS("simplify-instructions", simplifyInstructionsDeltaPass)         \
68     DELTA_PASS("operands-zero", reduceOperandsZeroDeltaPass)                   \
69     DELTA_PASS("operands-one", reduceOperandsOneDeltaPass)                     \
70     DELTA_PASS("operands-nan", reduceOperandsNaNDeltaPass)                     \
71     DELTA_PASS("operands-to-args", reduceOperandsToArgsDeltaPass)              \
72     DELTA_PASS("operands-skip", reduceOperandsSkipDeltaPass)                   \
73     DELTA_PASS("operand-bundles", reduceOperandBundesDeltaPass)                \
74     DELTA_PASS("attributes", reduceAttributesDeltaPass)                        \
75     DELTA_PASS("module-data", reduceModuleDataDeltaPass)                       \
76   } while (false)
77 
78 #define DELTA_PASSES_MIR                                                       \
79   do {                                                                         \
80     DELTA_PASS("instructions", reduceInstructionsMIRDeltaPass)                 \
81     DELTA_PASS("ir-instruction-references",                                    \
82                reduceIRInstructionReferencesDeltaPass)                         \
83     DELTA_PASS("ir-block-references", reduceIRBlockReferencesDeltaPass)        \
84     DELTA_PASS("ir-function-references", reduceIRFunctionReferencesDeltaPass)  \
85     DELTA_PASS("instruction-flags", reduceInstructionFlagsMIRDeltaPass)        \
86     DELTA_PASS("register-uses", reduceRegisterUsesMIRDeltaPass)                \
87     DELTA_PASS("register-hints", reduceVirtualRegisterHintsDeltaPass)          \
88   } while (false)
89 
90 static void runAllDeltaPasses(TestRunner &Tester) {
91 #define DELTA_PASS(NAME, FUNC) FUNC(Tester);
92   if (Tester.getProgram().isMIR()) {
93     DELTA_PASSES_MIR;
94   } else {
95     DELTA_PASSES;
96   }
97 #undef DELTA_PASS
98 }
99 
100 static void runDeltaPassName(TestRunner &Tester, StringRef PassName) {
101 #define DELTA_PASS(NAME, FUNC)                                                 \
102   if (PassName == NAME) {                                                      \
103     FUNC(Tester);                                                              \
104     return;                                                                    \
105   }
106   if (Tester.getProgram().isMIR()) {
107     DELTA_PASSES_MIR;
108   } else {
109     DELTA_PASSES;
110   }
111 #undef DELTA_PASS
112   errs() << "unknown pass \"" << PassName << "\"\n";
113   exit(1);
114 }
115 
116 void llvm::printDeltaPasses(raw_ostream &OS) {
117   OS << "Delta passes (pass to `--delta-passes=` as a comma separated list):\n";
118 #define DELTA_PASS(NAME, FUNC) OS << "  " << NAME << "\n";
119   OS << " IR:\n";
120   DELTA_PASSES;
121   OS << " MIR:\n";
122   DELTA_PASSES_MIR;
123 #undef DELTA_PASS
124 }
125 
126 void llvm::runDeltaPasses(TestRunner &Tester, int MaxPassIterations) {
127   uint64_t OldComplexity = Tester.getProgram().getComplexityScore();
128   for (int Iter = 0; Iter < MaxPassIterations; ++Iter) {
129     if (DeltaPasses.empty()) {
130       runAllDeltaPasses(Tester);
131     } else {
132       StringRef Passes = DeltaPasses;
133       while (!Passes.empty()) {
134         auto Split = Passes.split(",");
135         runDeltaPassName(Tester, Split.first);
136         Passes = Split.second;
137       }
138     }
139     uint64_t NewComplexity = Tester.getProgram().getComplexityScore();
140     if (NewComplexity >= OldComplexity)
141       break;
142     OldComplexity = NewComplexity;
143   }
144 }
145