LLVM 19.0.0git
Go to the documentation of this file.
1//===- PrintPasses.cpp ----------------------------------------------------===//
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
11#include "llvm/Support/Errc.h"
15#include <unordered_set>
17using namespace llvm;
19// Print IR out before/after specified passes.
21 PrintBefore("print-before",
22 llvm::cl::desc("Print IR before specified passes"),
26 PrintAfter("print-after", llvm::cl::desc("Print IR after specified passes"),
29static cl::opt<bool> PrintBeforeAll("print-before-all",
30 llvm::cl::desc("Print IR before each pass"),
31 cl::init(false), cl::Hidden);
32static cl::opt<bool> PrintAfterAll("print-after-all",
33 llvm::cl::desc("Print IR after each pass"),
34 cl::init(false), cl::Hidden);
36// Print out the IR after passes, similar to -print-after-all except that it
37// only prints the IR after passes that change the IR. Those passes that do not
38// make changes to the IR are reported as not making any changes. In addition,
39// the initial IR is also reported. Other hidden options affect the output from
40// this option. -filter-passes will limit the output to the named passes that
41// actually change the IR and other passes are reported as filtered out. The
42// specified passes will either be reported as making no changes (with no IR
43// reported) or the changed IR will be reported. Also, the -filter-print-funcs
44// and -print-module-scope options will do similar filtering based on function
45// name, reporting changed IRs as functions(or modules if -print-module-scope is
46// specified) for a particular function or indicating that the IR has been
47// filtered out. The extra options can be combined, allowing only changed IRs
48// for certain passes on certain functions to be reported in different formats,
49// with the rest being reported as filtered out. The -print-before-changed
50// option will print the IR as it was before each pass that changed it. The
51// optional value of quiet will only report when the IR changes, suppressing all
52// other messages, including the initial IR. The values "diff" and "diff-quiet"
53// will present the changes in a form similar to a patch, in either verbose or
54// quiet mode, respectively. The lines that are removed and added are prefixed
55// with '-' and '+', respectively. The -filter-print-funcs and -filter-passes
56// can be used to filter the output. This reporter relies on the linux diff
57// utility to do comparisons and insert the prefixes. For systems that do not
58// have the necessary facilities, the error message will be shown in place of
59// the expected output.
61 "print-changed", cl::desc("Print changed IRs"), cl::Hidden,
62 cl::ValueOptional, cl::init(ChangePrinter::None),
64 clEnumValN(ChangePrinter::Quiet, "quiet", "Run in quiet mode"),
65 clEnumValN(ChangePrinter::DiffVerbose, "diff",
66 "Display patch-like changes"),
67 clEnumValN(ChangePrinter::DiffQuiet, "diff-quiet",
68 "Display patch-like changes in quiet mode"),
69 clEnumValN(ChangePrinter::ColourDiffVerbose, "cdiff",
70 "Display patch-like changes with color"),
71 clEnumValN(ChangePrinter::ColourDiffQuiet, "cdiff-quiet",
72 "Display patch-like changes in quiet mode with color"),
73 clEnumValN(ChangePrinter::DotCfgVerbose, "dot-cfg",
74 "Create a website with graphical changes"),
75 clEnumValN(ChangePrinter::DotCfgQuiet, "dot-cfg-quiet",
76 "Create a website with graphical changes in quiet mode"),
77 // Sentinel value for unspecified option.
78 clEnumValN(ChangePrinter::Verbose, "", "")));
80// An option for specifying the diff used by print-changed=[diff | diff-quiet]
82 DiffBinary("print-changed-diff-path", cl::Hidden, cl::init("diff"),
83 cl::desc("system diff used by change reporters"));
85static cl::opt<bool>
86 PrintModuleScope("print-module-scope",
87 cl::desc("When printing IR for print-[before|after]{-all} "
88 "always print a module IR"),
89 cl::init(false), cl::Hidden);
91// See the description for -print-changed for an explanation of the use
92// of this option.
94 "filter-passes", cl::value_desc("pass names"),
95 cl::desc("Only consider IR changes for passes whose names "
96 "match the specified value. No-op without -print-changed"),
100 PrintFuncsList("filter-print-funcs", cl::value_desc("function names"),
101 cl::desc("Only print IR for functions whose name "
102 "match this for all print-[before|after][-all] "
103 "options"),
106/// This is a helper to determine whether to print IR before or
107/// after a pass.
110 return PrintBeforeAll || !PrintBefore.empty();
114 return PrintAfterAll || !PrintAfter.empty();
118 ArrayRef<std::string> PassesToPrint) {
119 return llvm::is_contained(PassesToPrint, PassID);
134std::vector<std::string> llvm::printBeforePasses() {
135 return std::vector<std::string>(PrintBefore);
138std::vector<std::string> llvm::printAfterPasses() {
139 return std::vector<std::string>(PrintAfter);
145 static std::unordered_set<std::string> Set(FilterPasses.begin(),
146 FilterPasses.end());
147 return Set.empty() || Set.count(std::string(PassName));
150bool llvm::isFilterPassesEmpty() { return FilterPasses.empty(); }
153 static std::unordered_set<std::string> PrintFuncNames(PrintFuncsList.begin(),
154 PrintFuncsList.end());
155 return PrintFuncNames.empty() ||
156 PrintFuncNames.count(std::string(FunctionName));
160 unsigned N) {
161 std::error_code RC;
162 for (unsigned I = 0; I < N; ++I) {
163 std::error_code EC = sys::fs::remove(FileName[I]);
164 if (EC)
165 RC = EC;
166 }
167 return RC;
172 SmallVector<std::string> &FileName) {
173 assert(FD.size() >= SR.size() && FileName.size() == FD.size() &&
174 "Unexpected array sizes");
175 std::error_code EC;
176 unsigned I = 0;
177 for (; I < FD.size(); ++I) {
178 if (FD[I] == -1) {
180 EC = sys::fs::createTemporaryFile("tmpfile", "txt", FD[I], SV);
181 if (EC)
182 break;
183 FileName[I] = Twine(SV).str();
184 }
185 if (I < SR.size()) {
186 EC = sys::fs::openFileForWrite(FileName[I], FD[I]);
187 if (EC)
188 break;
189 raw_fd_ostream OutStream(FD[I], /*shouldClose=*/true);
190 if (FD[I] == -1) {
191 EC = make_error_code(errc::io_error);
192 break;
193 }
194 OutStream << SR[I];
195 }
196 }
197 if (EC && I > 0)
198 // clean up created temporary files
199 cleanUpTempFilesImpl(FileName, I);
200 return EC;
204 return cleanUpTempFilesImpl(FileName, FileName.size());
208 StringRef OldLineFormat, StringRef NewLineFormat,
209 StringRef UnchangedLineFormat) {
210 // Store the 2 bodies into temporary files and call diff on them
211 // to get the body of the node.
212 static SmallVector<int> FD{-1, -1, -1};
214 static SmallVector<std::string> FileName{"", "", ""};
215 if (prepareTempFiles(FD, SR, FileName))
216 return "Unable to create temporary file.";
219 if (!DiffExe)
220 return "Unable to find diff executable.";
222 SmallString<128> OLF, NLF, ULF;
223 ("--old-line-format=" + OldLineFormat).toVector(OLF);
224 ("--new-line-format=" + NewLineFormat).toVector(NLF);
225 ("--unchanged-line-format=" + UnchangedLineFormat).toVector(ULF);
227 StringRef Args[] = {DiffBinary, "-w", "-d", OLF,
228 NLF, ULF, FileName[0], FileName[1]};
229 std::optional<StringRef> Redirects[] = {std::nullopt, StringRef(FileName[2]),
230 std::nullopt};
231 int Result = sys::ExecuteAndWait(*DiffExe, Args, std::nullopt, Redirects);
232 if (Result < 0)
233 return "Error executing system diff.";
234 std::string Diff;
235 auto B = MemoryBuffer::getFile(FileName[2]);
236 if (B && *B)
237 Diff = (*B)->getBuffer().str();
238 else
239 return "Unable to read result.";
241 if (cleanUpTempFiles(FileName))
242 return "Unable to remove temporary file.";
244 return Diff;
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
Definition: CommandLine.h:693
#define I(x, y, z)
Definition: MD5.cpp:58
static bool shouldPrintBeforeOrAfterPass(StringRef PassID, ArrayRef< std::string > PassesToPrint)
static cl::opt< bool > PrintBeforeAll("print-before-all", llvm::cl::desc("Print IR before each pass"), cl::init(false), cl::Hidden)
static cl::opt< bool > PrintModuleScope("print-module-scope", cl::desc("When printing IR for print-[before|after]{-all} " "always print a module IR"), cl::init(false), cl::Hidden)
static cl::list< std::string > PrintBefore("print-before", llvm::cl::desc("Print IR before specified passes"), cl::CommaSeparated, cl::Hidden)
static cl::list< std::string > FilterPasses("filter-passes", cl::value_desc("pass names"), cl::desc("Only consider IR changes for passes whose names " "match the specified value. No-op without -print-changed"), cl::CommaSeparated, cl::Hidden)
static cl::list< std::string > PrintAfter("print-after", llvm::cl::desc("Print IR after specified passes"), cl::CommaSeparated, cl::Hidden)
static cl::opt< bool > PrintAfterAll("print-after-all", llvm::cl::desc("Print IR after each pass"), cl::init(false), cl::Hidden)
static cl::opt< std::string > DiffBinary("print-changed-diff-path", cl::Hidden, cl::init("diff"), cl::desc("system diff used by change reporters"))
std::error_code cleanUpTempFilesImpl(ArrayRef< std::string > FileName, unsigned N)
static cl::list< std::string > PrintFuncsList("filter-print-funcs", cl::value_desc("function names"), cl::desc("Only print IR for functions whose name " "match this for all print-[before|after][-all] " "options"), cl::CommaSeparated, cl::Hidden)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
static const char PassName[]
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:165
Represents either an error or a value T.
Definition: ErrorOr.h:56
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile(const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful,...
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
size_t size() const
Definition: SmallVector.h:91
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
std::string str() const
Return the twine contents as a std::string.
Definition: Twine.cpp:17
A raw_ostream that writes to a file descriptor.
Definition: raw_ostream.h:471
@ ValueOptional
Definition: CommandLine.h:131
ValuesClass values(OptsTy... Options)
Helper to build a ValuesClass by forwarding a variable number of arguments as an initializer list to ...
Definition: CommandLine.h:718
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:450
@ CommaSeparated
Definition: CommandLine.h:164
std::error_code remove(const Twine &path, bool IgnoreNonExisting=true)
Remove path.
std::error_code openFileForWrite(const Twine &Name, int &ResultFD, CreationDisposition Disp=CD_CreateAlways, OpenFlags Flags=OF_None, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
Definition: FileSystem.h:1063
std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix, int &ResultFD, SmallVectorImpl< char > &ResultPath, OpenFlags Flags=OF_None)
Create a file in the system temporary directory.
Definition: Path.cpp:864
int ExecuteAndWait(StringRef Program, ArrayRef< StringRef > Args, std::optional< ArrayRef< StringRef > > Env=std::nullopt, ArrayRef< std::optional< StringRef > > Redirects={}, unsigned SecondsToWait=0, unsigned MemoryLimit=0, std::string *ErrMsg=nullptr, bool *ExecutionFailed=nullptr, std::optional< ProcessStatistics > *ProcStat=nullptr, BitVector *AffinityMask=nullptr)
This function executes the program using the arguments provided.
Definition: Program.cpp:32
ErrorOr< std::string > findProgramByName(StringRef Name, ArrayRef< StringRef > Paths={})
Find the first executable file Name in Paths.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
std::error_code prepareTempFiles(SmallVector< int > &FD, ArrayRef< StringRef > SR, SmallVector< std::string > &FileName)
bool forcePrintModuleIR()
std::error_code make_error_code(BitcodeError E)
std::vector< std::string > printAfterPasses()
bool shouldPrintBeforeAll()
bool shouldPrintAfterAll()
cl::opt< ChangePrinter > PrintChanged
std::vector< std::string > printBeforePasses()
bool shouldPrintBeforeSomePass()
This is a helper to determine whether to print IR before or after a pass.
bool shouldPrintAfterSomePass()
bool isFunctionInPrintList(StringRef FunctionName)
bool isPassInPrintList(StringRef PassName)
std::error_code cleanUpTempFiles(ArrayRef< std::string > FileName)
std::string doSystemDiff(StringRef Before, StringRef After, StringRef OldLineFormat, StringRef NewLineFormat, StringRef UnchangedLineFormat)
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition: STLExtras.h:1879
bool shouldPrintBeforePass(StringRef PassID)
bool shouldPrintAfterPass(StringRef PassID)
bool isFilterPassesEmpty()
#define N