1 | //===- bolt/Utils/CommandLineOpts.h - BOLT CLI options ----------*- C++ -*-===// |
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 | // BOLT CLI options |
10 | // |
11 | //===----------------------------------------------------------------------===// |
12 | |
13 | #ifndef BOLT_UTILS_COMMAND_LINE_OPTS_H |
14 | #define BOLT_UTILS_COMMAND_LINE_OPTS_H |
15 | |
16 | #include "llvm/Support/CommandLine.h" |
17 | |
18 | namespace opts { |
19 | |
20 | extern bool HeatmapMode; |
21 | |
22 | extern llvm::cl::OptionCategory BoltCategory; |
23 | extern llvm::cl::OptionCategory BoltDiffCategory; |
24 | extern llvm::cl::OptionCategory BoltOptCategory; |
25 | extern llvm::cl::OptionCategory BoltRelocCategory; |
26 | extern llvm::cl::OptionCategory BoltOutputCategory; |
27 | extern llvm::cl::OptionCategory AggregatorCategory; |
28 | extern llvm::cl::OptionCategory BoltInstrCategory; |
29 | extern llvm::cl::OptionCategory HeatmapCategory; |
30 | |
31 | extern llvm::cl::opt<unsigned> AlignText; |
32 | extern llvm::cl::opt<unsigned> AlignFunctions; |
33 | extern llvm::cl::opt<bool> AggregateOnly; |
34 | extern llvm::cl::opt<unsigned> BucketsPerLine; |
35 | extern llvm::cl::opt<bool> DiffOnly; |
36 | extern llvm::cl::opt<bool> EnableBAT; |
37 | extern llvm::cl::opt<bool> EqualizeBBCounts; |
38 | extern llvm::cl::opt<bool> RemoveSymtab; |
39 | extern llvm::cl::opt<unsigned> ExecutionCountThreshold; |
40 | extern llvm::cl::opt<unsigned> HeatmapBlock; |
41 | extern llvm::cl::opt<unsigned long long> HeatmapMaxAddress; |
42 | extern llvm::cl::opt<unsigned long long> HeatmapMinAddress; |
43 | extern llvm::cl::opt<bool> HotData; |
44 | extern llvm::cl::opt<bool> HotFunctionsAtEnd; |
45 | extern llvm::cl::opt<bool> HotText; |
46 | extern llvm::cl::opt<bool> Hugify; |
47 | extern llvm::cl::opt<bool> Instrument; |
48 | extern llvm::cl::opt<std::string> OutputFilename; |
49 | extern llvm::cl::opt<std::string> PerfData; |
50 | extern llvm::cl::opt<bool> PrintCacheMetrics; |
51 | extern llvm::cl::opt<bool> PrintSections; |
52 | |
53 | // The format to use with -o in aggregation mode (perf2bolt) |
54 | enum ProfileFormatKind { PF_Fdata, PF_YAML }; |
55 | |
56 | extern llvm::cl::opt<ProfileFormatKind> ProfileFormat; |
57 | extern llvm::cl::opt<bool> SplitEH; |
58 | extern llvm::cl::opt<bool> StrictMode; |
59 | extern llvm::cl::opt<bool> TimeOpts; |
60 | extern llvm::cl::opt<bool> UseOldText; |
61 | extern llvm::cl::opt<bool> UpdateDebugSections; |
62 | |
63 | // The default verbosity level (0) is pretty terse, level 1 is fairly |
64 | // verbose and usually prints some informational message for every |
65 | // function processed. Level 2 is for the noisiest of messages and |
66 | // often prints a message per basic block. |
67 | // Error messages should never be suppressed by the verbosity level. |
68 | // Only warnings and info messages should be affected. |
69 | // |
70 | // The rationale behind stream usage is as follows: |
71 | // outs() for info and debugging controlled by command line flags. |
72 | // errs() for errors and warnings. |
73 | // dbgs() for output within DEBUG(). |
74 | extern llvm::cl::opt<unsigned> Verbosity; |
75 | |
76 | /// Return true if we should process all functions in the binary. |
77 | bool processAllFunctions(); |
78 | |
79 | } // namespace opts |
80 | |
81 | namespace llvm { |
82 | namespace bolt { |
83 | extern const char *BoltRevision; |
84 | } |
85 | } // namespace llvm |
86 | |
87 | #endif |
88 | |