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