annotate tools/llvm-xray/xray-extract.cc @ 148:63bd29f05246

merged
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Wed, 14 Aug 2019 19:46:37 +0900
parents 3a76565eade5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
1 //===- xray-extract.cc - XRay Instrumentation Map Extraction --------------===//
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
2 //
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
3 // The LLVM Compiler Infrastructure
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
4 //
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
5 // This file is distributed under the University of Illinois Open Source
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
6 // License. See LICENSE.TXT for details.
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
7 //
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
8 //===----------------------------------------------------------------------===//
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
9 //
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
10 // Implementation of the xray-extract.h interface.
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
11 //
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
12 // FIXME: Support other XRay-instrumented binary formats other than ELF.
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
13 //
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
14 //===----------------------------------------------------------------------===//
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
15
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
16
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
17 #include "func-id-helper.h"
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
18 #include "xray-registry.h"
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
19 #include "llvm/Object/ObjectFile.h"
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
20 #include "llvm/Support/CommandLine.h"
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
21 #include "llvm/Support/Error.h"
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
22 #include "llvm/Support/FileSystem.h"
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
23 #include "llvm/Support/Format.h"
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
24 #include "llvm/Support/raw_ostream.h"
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
25 #include "llvm/XRay/InstrumentationMap.h"
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
26
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
27 using namespace llvm;
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
28 using namespace llvm::xray;
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
29 using namespace llvm::yaml;
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
30
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
31 // llvm-xray extract
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
32 // ----------------------------------------------------------------------------
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
33 static cl::SubCommand Extract("extract", "Extract instrumentation maps");
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
34 static cl::opt<std::string> ExtractInput(cl::Positional,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
35 cl::desc("<input file>"), cl::Required,
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
36 cl::sub(Extract));
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
37 static cl::opt<std::string>
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
38 ExtractOutput("output", cl::value_desc("output file"), cl::init("-"),
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
39 cl::desc("output file; use '-' for stdout"),
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
40 cl::sub(Extract));
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
41 static cl::alias ExtractOutput2("o", cl::aliasopt(ExtractOutput),
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
42 cl::desc("Alias for -output"),
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
43 cl::sub(Extract));
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
44 static cl::opt<bool> ExtractSymbolize("symbolize", cl::value_desc("symbolize"),
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
45 cl::init(false),
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
46 cl::desc("symbolize functions"),
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
47 cl::sub(Extract));
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
48 static cl::alias ExtractSymbolize2("s", cl::aliasopt(ExtractSymbolize),
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
49 cl::desc("alias for -symbolize"),
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
50 cl::sub(Extract));
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
51
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
52 namespace {
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
53
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
54 void exportAsYAML(const InstrumentationMap &Map, raw_ostream &OS,
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
55 FuncIdConversionHelper &FH) {
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
56 // First we translate the sleds into the YAMLXRaySledEntry objects in a deque.
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
57 std::vector<YAMLXRaySledEntry> YAMLSleds;
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
58 auto Sleds = Map.sleds();
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
59 YAMLSleds.reserve(std::distance(Sleds.begin(), Sleds.end()));
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
60 for (const auto &Sled : Sleds) {
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
61 auto FuncId = Map.getFunctionId(Sled.Function);
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
62 if (!FuncId)
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
63 return;
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
64 YAMLSleds.push_back({*FuncId, Sled.Address, Sled.Function, Sled.Kind,
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
65 Sled.AlwaysInstrument,
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
66 ExtractSymbolize ? FH.SymbolOrNumber(*FuncId) : ""});
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
67 }
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
68 Output Out(OS, nullptr, 0);
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
69 Out << YAMLSleds;
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
70 }
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
71
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
72 } // namespace
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
73
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
74 static CommandRegistration Unused(&Extract, []() -> Error {
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
75 auto InstrumentationMapOrError = loadInstrumentationMap(ExtractInput);
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
76 if (!InstrumentationMapOrError)
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
77 return joinErrors(make_error<StringError>(
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
78 Twine("Cannot extract instrumentation map from '") +
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
79 ExtractInput + "'.",
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
80 std::make_error_code(std::errc::invalid_argument)),
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
81 InstrumentationMapOrError.takeError());
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
82
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
83 std::error_code EC;
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
84 raw_fd_ostream OS(ExtractOutput, EC, sys::fs::OpenFlags::F_Text);
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
85 if (EC)
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
86 return make_error<StringError>(
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
87 Twine("Cannot open file '") + ExtractOutput + "' for writing.", EC);
121
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
88 const auto &FunctionAddresses =
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
89 InstrumentationMapOrError->getFunctionAddresses();
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
90 symbolize::LLVMSymbolizer::Options Opts(
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
91 symbolize::FunctionNameKind::LinkageName, true, true, false, "");
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
92 symbolize::LLVMSymbolizer Symbolizer(Opts);
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
93 llvm::xray::FuncIdConversionHelper FuncIdHelper(ExtractInput, Symbolizer,
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
94 FunctionAddresses);
803732b1fca8 LLVM 5.0
kono
parents: 120
diff changeset
95 exportAsYAML(*InstrumentationMapOrError, OS, FuncIdHelper);
120
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
96 return Error::success();
1172e4bd9c6f update 4.0.0
mir3636
parents:
diff changeset
97 });