annotate llvm/tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp @ 201:a96fbbdf2d0f

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Fri, 04 Jun 2021 21:07:06 +0900
parents 1d019706d866
children 5f17cb93ff66
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===-- llvm-bcanalyzer.cpp - Bitcode Analyzer --------------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8 //
anatofuz
parents:
diff changeset
9 // This tool may be invoked in the following manner:
anatofuz
parents:
diff changeset
10 // llvm-bcanalyzer [options] - Read LLVM bitcode from stdin
anatofuz
parents:
diff changeset
11 // llvm-bcanalyzer [options] x.bc - Read LLVM bitcode from the x.bc file
anatofuz
parents:
diff changeset
12 //
anatofuz
parents:
diff changeset
13 // Options:
anatofuz
parents:
diff changeset
14 // --help - Output information about command line switches
anatofuz
parents:
diff changeset
15 // --dump - Dump low-level bitcode structure in readable format
anatofuz
parents:
diff changeset
16 //
anatofuz
parents:
diff changeset
17 // This tool provides analytical information about a bitcode file. It is
anatofuz
parents:
diff changeset
18 // intended as an aid to developers of bitcode reading and writing software. It
anatofuz
parents:
diff changeset
19 // produces on std::out a summary of the bitcode file that shows various
anatofuz
parents:
diff changeset
20 // statistics about the contents of the file. By default this information is
anatofuz
parents:
diff changeset
21 // detailed and contains information about individual bitcode blocks and the
anatofuz
parents:
diff changeset
22 // functions in the module.
anatofuz
parents:
diff changeset
23 // The tool is also able to print a bitcode file in a straight forward text
anatofuz
parents:
diff changeset
24 // format that shows the containment and relationships of the information in
anatofuz
parents:
diff changeset
25 // the bitcode file (-dump option).
anatofuz
parents:
diff changeset
26 //
anatofuz
parents:
diff changeset
27 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
28
anatofuz
parents:
diff changeset
29 #include "llvm/ADT/Optional.h"
anatofuz
parents:
diff changeset
30 #include "llvm/Bitcode/BitcodeAnalyzer.h"
anatofuz
parents:
diff changeset
31 #include "llvm/Support/CommandLine.h"
anatofuz
parents:
diff changeset
32 #include "llvm/Support/Error.h"
anatofuz
parents:
diff changeset
33 #include "llvm/Support/InitLLVM.h"
anatofuz
parents:
diff changeset
34 #include "llvm/Support/MemoryBuffer.h"
anatofuz
parents:
diff changeset
35 #include "llvm/Support/raw_ostream.h"
anatofuz
parents:
diff changeset
36 #include <memory>
anatofuz
parents:
diff changeset
37 using namespace llvm;
anatofuz
parents:
diff changeset
38
anatofuz
parents:
diff changeset
39 static cl::opt<std::string>
anatofuz
parents:
diff changeset
40 InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
anatofuz
parents:
diff changeset
41
anatofuz
parents:
diff changeset
42 static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));
anatofuz
parents:
diff changeset
43
anatofuz
parents:
diff changeset
44 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
45 // Bitcode specific analysis.
anatofuz
parents:
diff changeset
46 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
47
anatofuz
parents:
diff changeset
48 static cl::opt<bool> NoHistogram("disable-histogram",
anatofuz
parents:
diff changeset
49 cl::desc("Do not print per-code histogram"));
anatofuz
parents:
diff changeset
50
anatofuz
parents:
diff changeset
51 static cl::opt<bool> NonSymbolic("non-symbolic",
anatofuz
parents:
diff changeset
52 cl::desc("Emit numeric info in dump even if"
anatofuz
parents:
diff changeset
53 " symbolic info is available"));
anatofuz
parents:
diff changeset
54
anatofuz
parents:
diff changeset
55 static cl::opt<std::string>
anatofuz
parents:
diff changeset
56 BlockInfoFilename("block-info",
anatofuz
parents:
diff changeset
57 cl::desc("Use the BLOCK_INFO from the given file"));
anatofuz
parents:
diff changeset
58
anatofuz
parents:
diff changeset
59 static cl::opt<bool>
anatofuz
parents:
diff changeset
60 ShowBinaryBlobs("show-binary-blobs",
anatofuz
parents:
diff changeset
61 cl::desc("Print binary blobs using hex escapes"));
anatofuz
parents:
diff changeset
62
anatofuz
parents:
diff changeset
63 static cl::opt<std::string> CheckHash(
anatofuz
parents:
diff changeset
64 "check-hash",
anatofuz
parents:
diff changeset
65 cl::desc("Check module hash using the argument as a string table"));
anatofuz
parents:
diff changeset
66
anatofuz
parents:
diff changeset
67 static Error reportError(StringRef Message) {
anatofuz
parents:
diff changeset
68 return createStringError(std::errc::illegal_byte_sequence, Message.data());
anatofuz
parents:
diff changeset
69 }
anatofuz
parents:
diff changeset
70
anatofuz
parents:
diff changeset
71 static Expected<std::unique_ptr<MemoryBuffer>> openBitcodeFile(StringRef Path) {
anatofuz
parents:
diff changeset
72 // Read the input file.
anatofuz
parents:
diff changeset
73 Expected<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
anatofuz
parents:
diff changeset
74 errorOrToExpected(MemoryBuffer::getFileOrSTDIN(Path));
anatofuz
parents:
diff changeset
75 if (Error E = MemBufOrErr.takeError())
anatofuz
parents:
diff changeset
76 return std::move(E);
anatofuz
parents:
diff changeset
77
anatofuz
parents:
diff changeset
78 std::unique_ptr<MemoryBuffer> MemBuf = std::move(*MemBufOrErr);
anatofuz
parents:
diff changeset
79
anatofuz
parents:
diff changeset
80 if (MemBuf->getBufferSize() & 3)
anatofuz
parents:
diff changeset
81 return reportError(
anatofuz
parents:
diff changeset
82 "Bitcode stream should be a multiple of 4 bytes in length");
anatofuz
parents:
diff changeset
83 return std::move(MemBuf);
anatofuz
parents:
diff changeset
84 }
anatofuz
parents:
diff changeset
85
anatofuz
parents:
diff changeset
86 int main(int argc, char **argv) {
anatofuz
parents:
diff changeset
87 InitLLVM X(argc, argv);
anatofuz
parents:
diff changeset
88 cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
anatofuz
parents:
diff changeset
89 ExitOnError ExitOnErr("llvm-bcanalyzer: ");
anatofuz
parents:
diff changeset
90
anatofuz
parents:
diff changeset
91 std::unique_ptr<MemoryBuffer> MB = ExitOnErr(openBitcodeFile(InputFilename));
anatofuz
parents:
diff changeset
92 std::unique_ptr<MemoryBuffer> BlockInfoMB = nullptr;
anatofuz
parents:
diff changeset
93 if (!BlockInfoFilename.empty())
anatofuz
parents:
diff changeset
94 BlockInfoMB = ExitOnErr(openBitcodeFile(BlockInfoFilename));
anatofuz
parents:
diff changeset
95
anatofuz
parents:
diff changeset
96 BitcodeAnalyzer BA(MB->getBuffer(),
anatofuz
parents:
diff changeset
97 BlockInfoMB ? Optional<StringRef>(BlockInfoMB->getBuffer())
anatofuz
parents:
diff changeset
98 : None);
anatofuz
parents:
diff changeset
99
anatofuz
parents:
diff changeset
100 BCDumpOptions O(outs());
anatofuz
parents:
diff changeset
101 O.Histogram = !NoHistogram;
anatofuz
parents:
diff changeset
102 O.Symbolic = !NonSymbolic;
anatofuz
parents:
diff changeset
103 O.ShowBinaryBlobs = ShowBinaryBlobs;
anatofuz
parents:
diff changeset
104
anatofuz
parents:
diff changeset
105 ExitOnErr(BA.analyze(
anatofuz
parents:
diff changeset
106 Dump ? Optional<BCDumpOptions>(O) : Optional<BCDumpOptions>(None),
anatofuz
parents:
diff changeset
107 CheckHash.empty() ? None : Optional<StringRef>(CheckHash)));
anatofuz
parents:
diff changeset
108
anatofuz
parents:
diff changeset
109 if (Dump)
anatofuz
parents:
diff changeset
110 outs() << "\n\n";
anatofuz
parents:
diff changeset
111
anatofuz
parents:
diff changeset
112 BA.printStats(O, StringRef(InputFilename.getValue()));
anatofuz
parents:
diff changeset
113 return 0;
anatofuz
parents:
diff changeset
114 }