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
|
//===-- llvm-debuginfod-find.cpp - Simple CLI for libdebuginfod-client ----===//
//
// 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
//
//===----------------------------------------------------------------------===//
///
/// \file
/// This file contains the llvm-debuginfod-find tool. This tool
/// queries the debuginfod servers in the DEBUGINFOD_URLS environment
/// variable (delimited by space (" ")) for the executable,
/// debuginfo, or specified source file of the binary matching the
/// given build-id.
///
//===----------------------------------------------------------------------===//
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Debuginfod/BuildIDFetcher.h"
#include "llvm/Debuginfod/Debuginfod.h"
#include "llvm/Debuginfod/HTTPClient.h"
#include "llvm/Option/ArgList.h"
#include "llvm/Option/Option.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/InitLLVM.h"
#include "llvm/Support/LLVMDriver.h"
using namespace llvm;
// Command-line option boilerplate.
namespace {
enum ID {
OPT_INVALID = 0, // This is not an option ID.
#define OPTION(...) LLVM_MAKE_OPT_ID(__VA_ARGS__),
#include "Opts.inc"
#undef OPTION
};
#define OPTTABLE_STR_TABLE_CODE
#include "Opts.inc"
#undef OPTTABLE_STR_TABLE_CODE
#define OPTTABLE_PREFIXES_TABLE_CODE
#include "Opts.inc"
#undef OPTTABLE_PREFIXES_TABLE_CODE
using namespace llvm::opt;
static constexpr opt::OptTable::Info InfoTable[] = {
#define OPTION(...) LLVM_CONSTRUCT_OPT_INFO(__VA_ARGS__),
#include "Opts.inc"
#undef OPTION
};
class DebuginfodFindOptTable : public opt::GenericOptTable {
public:
DebuginfodFindOptTable()
: GenericOptTable(OptionStrTable, OptionPrefixesTable, InfoTable) {}
};
} // end anonymous namespace
static std::string InputBuildID;
static bool FetchExecutable;
static bool FetchDebuginfo;
static std::string FetchSource;
static bool DumpToStdout;
static std::vector<std::string> DebugFileDirectory;
static void parseArgs(int argc, char **argv) {
DebuginfodFindOptTable Tbl;
llvm::BumpPtrAllocator A;
llvm::StringSaver Saver{A};
opt::InputArgList Args =
Tbl.parseArgs(argc, argv, OPT_UNKNOWN, Saver, [&](StringRef Msg) {
llvm::errs() << Msg << '\n';
std::exit(1);
});
if (Args.hasArg(OPT_help)) {
Tbl.printHelp(
llvm::outs(), "llvm-debuginfod-find [options] <input build_id>",
"llvm-debuginfod-find: Fetch debuginfod artifacts\n\n"
"This program is a frontend to the debuginfod client library. The "
"cache directory, request timeout (in seconds), and debuginfod server "
"urls are set by these environment variables:\n"
"DEBUGINFOD_CACHE_PATH (default set by sys::path::cache_directory)\n"
"DEBUGINFOD_TIMEOUT (defaults to 90s)\n"
"DEBUGINFOD_URLS=[comma separated URLs] (defaults to empty)");
std::exit(0);
}
InputBuildID = Args.getLastArgValue(OPT_INPUT);
FetchExecutable = Args.hasArg(OPT_fetch_executable);
FetchDebuginfo = Args.hasArg(OPT_fetch_debuginfo);
DumpToStdout = Args.hasArg(OPT_dump_to_stdout);
FetchSource = Args.getLastArgValue(OPT_fetch_source, "");
DebugFileDirectory = Args.getAllArgValues(OPT_debug_file_directory);
}
[[noreturn]] static void helpExit() {
errs() << "Must specify exactly one of --executable, "
"--source=/path/to/file, or --debuginfo.\n";
exit(1);
}
ExitOnError ExitOnDebuginfodFindError;
static std::string fetchDebugInfo(object::BuildIDRef BuildID);
int llvm_debuginfod_find_main(int argc, char **argv,
const llvm::ToolContext &) {
// InitLLVM X(argc, argv);
HTTPClient::initialize();
parseArgs(argc, argv);
if (FetchExecutable + FetchDebuginfo + (FetchSource != "") != 1)
helpExit();
std::string IDString;
if (!tryGetFromHex(InputBuildID, IDString)) {
errs() << "Build ID " << InputBuildID << " is not a hex string.\n";
exit(1);
}
object::BuildID ID(IDString.begin(), IDString.end());
std::string Path;
if (FetchSource != "")
Path =
ExitOnDebuginfodFindError(getCachedOrDownloadSource(ID, FetchSource));
else if (FetchExecutable)
Path = ExitOnDebuginfodFindError(getCachedOrDownloadExecutable(ID));
else if (FetchDebuginfo)
Path = fetchDebugInfo(ID);
else
llvm_unreachable("We have already checked that exactly one of the above "
"conditions is true.");
if (DumpToStdout) {
// Print the contents of the artifact.
ErrorOr<std::unique_ptr<MemoryBuffer>> Buf = MemoryBuffer::getFile(
Path, /*IsText=*/false, /*RequiresNullTerminator=*/false);
ExitOnDebuginfodFindError(errorCodeToError(Buf.getError()));
outs() << Buf.get()->getBuffer();
} else
// Print the path to the cached artifact file.
outs() << Path << "\n";
return 0;
}
// Find a debug file in local build ID directories and via debuginfod.
std::string fetchDebugInfo(object::BuildIDRef BuildID) {
if (std::optional<std::string> Path =
DebuginfodFetcher(DebugFileDirectory).fetch(BuildID))
return *Path;
errs() << "Build ID " << llvm::toHex(BuildID, /*Lowercase=*/true)
<< " could not be found.\n";
exit(1);
}
|
