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