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