1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
//===- bolt/tools/bat-dump/bat-dump.cpp - BAT dumper utility --------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "bolt/Profile/BoltAddressTranslation.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Object/Binary.h"
#include "llvm/Object/ELFObjectFile.h"
#include "llvm/Object/Error.h"
#include "llvm/Object/ObjectFile.h"
#include "llvm/Object/SymbolicFile.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Errc.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/ErrorOr.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Program.h"
#include "llvm/Support/raw_ostream.h"
#include <assert.h>
#include <cstdint>
#include <map>
#include <stdlib.h>
#include <string>
#include <system_error>
#include <type_traits>
#include <utility>
using namespace llvm;
using namespace bolt;
namespace opts {
static cl::OptionCategory BatDumpCategory("BAT dump options");
static cl::OptionCategory *BatDumpCategories[] = {&BatDumpCategory};
static cl::opt<std::string> InputFilename(cl::Positional,
cl::desc("<executable>"),
cl::Required,
cl::cat(BatDumpCategory));
static cl::list<uint64_t> Translate("translate",
cl::desc("translate addresses using BAT"),
cl::value_desc("addr"),
cl::cat(BatDumpCategory));
static cl::opt<bool> DumpAll("dump-all", cl::desc("dump all BAT tables"),
cl::cat(BatDumpCategory));
} // namespace opts
static StringRef ToolName;
static void report_error(StringRef Message, std::error_code EC) {
assert(EC);
errs() << ToolName << ": '" << Message << "': " << EC.message() << ".\n";
exit(1);
}
static void report_error(StringRef Message, Error E) {
assert(E);
errs() << ToolName << ": '" << Message << "': " << toString(std::move(E))
<< ".\n";
exit(1);
}
void dumpBATFor(llvm::object::ELFObjectFileBase *InputFile) {
BoltAddressTranslation BAT;
if (!BAT.enabledFor(InputFile)) {
errs() << "error: no BAT table found.\n";
exit(1);
}
// Look for BAT section
bool Found = false;
StringRef SectionContents;
for (const llvm::object::SectionRef &Section : InputFile->sections()) {
Expected<StringRef> SectionNameOrErr = Section.getName();
if (Error E = SectionNameOrErr.takeError())
continue;
if (SectionNameOrErr.get() != BoltAddressTranslation::SECTION_NAME)
continue;
Found = true;
Expected<StringRef> ContentsOrErr = Section.getContents();
if (Error E = ContentsOrErr.takeError())
continue;
SectionContents = ContentsOrErr.get();
}
if (!Found) {
errs() << "BOLT-ERROR: failed to parse BOLT address translation "
"table. No BAT section found\n";
exit(1);
}
if (std::error_code EC = BAT.parse(outs(), SectionContents)) {
errs() << "BOLT-ERROR: failed to parse BOLT address translation "
"table. Malformed BAT section\n";
exit(1);
}
if (opts::DumpAll)
BAT.dump(outs());
if (!opts::Translate.empty()) {
// Build map of <Address, SymbolName> for InputFile
std::map<uint64_t, StringRef> FunctionsMap;
for (const llvm::object::ELFSymbolRef &Symbol : InputFile->symbols()) {
Expected<StringRef> NameOrError = Symbol.getName();
if (NameOrError.takeError())
continue;
if (cantFail(Symbol.getType()) != llvm::object::SymbolRef::ST_Function)
continue;
const StringRef Name = *NameOrError;
const uint64_t Address = cantFail(Symbol.getAddress());
FunctionsMap[Address] = Name;
}
outs() << "Translating addresses according to parsed BAT tables:\n";
for (uint64_t Address : opts::Translate) {
auto FI = FunctionsMap.upper_bound(Address);
if (FI == FunctionsMap.begin()) {
outs() << "No function symbol found for 0x" << Twine::utohexstr(Address)
<< "\n";
continue;
}
--FI;
outs() << "0x" << Twine::utohexstr(Address) << " -> " << FI->second
<< " + 0x"
<< Twine::utohexstr(
BAT.translate(FI->first, Address - FI->first, false))
<< "\n";
}
}
}
int main(int argc, char **argv) {
cl::HideUnrelatedOptions(ArrayRef(opts::BatDumpCategories));
cl::ParseCommandLineOptions(argc, argv, "");
if (!sys::fs::exists(opts::InputFilename))
report_error(opts::InputFilename, errc::no_such_file_or_directory);
ToolName = argv[0];
Expected<llvm::object::OwningBinary<llvm::object::Binary>> BinaryOrErr =
llvm::object::createBinary(opts::InputFilename);
if (Error E = BinaryOrErr.takeError())
report_error(opts::InputFilename, std::move(E));
llvm::object::Binary &Binary = *BinaryOrErr.get().getBinary();
if (auto *InputFile = dyn_cast<llvm::object::ELFObjectFileBase>(&Binary))
dumpBATFor(InputFile);
else
report_error(opts::InputFilename,
llvm::object::object_error::invalid_file_type);
return EXIT_SUCCESS;
}
|
