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/ReduceInstructions.h"
28 #include "deltas/ReduceInstructionsMIR.h"
29 #include "deltas/ReduceMetadata.h"
30 #include "deltas/ReduceModuleData.h"
31 #include "deltas/ReduceOperandBundles.h"
32 #include "deltas/ReduceOperands.h"
33 #include "deltas/ReduceOperandsSkip.h"
34 #include "deltas/ReduceOperandsToArgs.h"
35 #include "deltas/ReduceSpecialGlobals.h"
36 #include "llvm/Support/CommandLine.h"
37 
38 using namespace llvm;
39 
40 extern cl::OptionCategory LLVMReduceOptions;
41 static cl::opt<std::string>
42     DeltaPasses("delta-passes",
43                 cl::desc("Delta passes to run, separated by commas. By "
44                          "default, run all delta passes."),
45                 cl::cat(LLVMReduceOptions));
46 
47 #define DELTA_PASSES                                                           \
48   DELTA_PASS("special-globals", reduceSpecialGlobalsDeltaPass)                 \
49   DELTA_PASS("aliases", reduceAliasesDeltaPass)                                \
50   DELTA_PASS("function-bodies", reduceFunctionBodiesDeltaPass)                 \
51   DELTA_PASS("functions", reduceFunctionsDeltaPass)                            \
52   DELTA_PASS("basic-blocks", reduceBasicBlocksDeltaPass)                       \
53   DELTA_PASS("global-values", reduceGlobalValuesDeltaPass)                     \
54   DELTA_PASS("global-objects", reduceGlobalObjectsDeltaPass)                   \
55   DELTA_PASS("global-initializers", reduceGlobalsInitializersDeltaPass)        \
56   DELTA_PASS("global-variables", reduceGlobalsDeltaPass)                       \
57   DELTA_PASS("metadata", reduceMetadataDeltaPass)                              \
58   DELTA_PASS("arguments", reduceArgumentsDeltaPass)                            \
59   DELTA_PASS("instructions", reduceInstructionsDeltaPass)                      \
60   DELTA_PASS("operands-zero", reduceOperandsZeroDeltaPass)                     \
61   DELTA_PASS("operands-one", reduceOperandsOneDeltaPass)                       \
62   DELTA_PASS("operands-undef", reduceOperandsUndefDeltaPass)                   \
63   DELTA_PASS("operands-to-args", reduceOperandsToArgsDeltaPass)                \
64   DELTA_PASS("operands-skip", reduceOperandsSkipDeltaPass)                     \
65   DELTA_PASS("operand-bundles", reduceOperandBundesDeltaPass)                  \
66   DELTA_PASS("attributes", reduceAttributesDeltaPass)                          \
67   DELTA_PASS("module-data", reduceModuleDataDeltaPass)
68 
69 #define DELTA_PASSES_MIR                                                       \
70   DELTA_PASS("instructions", reduceInstructionsMIRDeltaPass)
71 
72 static void runAllDeltaPasses(TestRunner &Tester) {
73 #define DELTA_PASS(NAME, FUNC) FUNC(Tester);
74   if (Tester.getProgram().isMIR()) {
75     DELTA_PASSES_MIR
76   } else {
77     DELTA_PASSES
78   }
79 #undef DELTA_PASS
80 }
81 
82 static void runDeltaPassName(TestRunner &Tester, StringRef PassName) {
83 #define DELTA_PASS(NAME, FUNC)                                                 \
84   if (PassName == NAME) {                                                      \
85     FUNC(Tester);                                                              \
86     return;                                                                    \
87   }
88   if (Tester.getProgram().isMIR()) {
89     DELTA_PASSES_MIR
90   } else {
91     DELTA_PASSES
92   }
93 #undef DELTA_PASS
94   errs() << "unknown pass \"" << PassName << "\"\n";
95   exit(1);
96 }
97 
98 void llvm::printDeltaPasses(raw_ostream &OS) {
99   OS << "Delta passes (pass to `--delta-passes=` as a comma separated list):\n";
100 #define DELTA_PASS(NAME, FUNC) OS << "  " << NAME << "\n";
101   OS << " IR:\n";
102   DELTA_PASSES
103   OS << " MIR:\n";
104   DELTA_PASSES_MIR
105 #undef DELTA_PASS
106 }
107 
108 // FIXME: We might want to use a different metric than "number of
109 // bytes in serialized IR" to detect non-progress of the main delta
110 // loop
111 static int getIRSize(TestRunner &Tester) {
112   std::string Str;
113   raw_string_ostream SS(Str);
114   Tester.getProgram().print(SS, /*AnnotationWriter=*/nullptr);
115   return Str.length();
116 }
117 
118 void llvm::runDeltaPasses(TestRunner &Tester, int MaxPassIterations) {
119   int OldSize = getIRSize(Tester);
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     int NewSize = getIRSize(Tester);
132     if (NewSize >= OldSize)
133       break;
134     OldSize = NewSize;
135   }
136 }
137