Convert {mini|micro}dump_stackwalk argument parsing to getopt.

Bug: google-breakpad:748
Change-Id: I70b16ba6456df0be038d6c7170eb22b093fdc65d
Reviewed-on: https://chromium-review.googlesource.com/718756
Reviewed-by: Mike Frysinger <vapier@chromium.org>
This commit is contained in:
Tobias Sargeant 2017-10-13 17:55:46 +01:00 committed by Tobias Sargeant
parent bc8fb88648
commit 623c4a0f42
2 changed files with 147 additions and 121 deletions

View file

@ -32,6 +32,7 @@
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <fstream>
#include <string>
@ -50,6 +51,13 @@
namespace {
struct Options {
bool machine_readable;
string microdump_file;
std::vector<string> symbol_paths;
};
using google_breakpad::BasicSourceLineResolver;
using google_breakpad::MicrodumpProcessor;
using google_breakpad::ProcessResult;
@ -58,19 +66,18 @@ using google_breakpad::scoped_ptr;
using google_breakpad::SimpleSymbolSupplier;
using google_breakpad::StackFrameSymbolizer;
// Processes |microdump_file| using MicrodumpProcessor. |symbol_path|, if
// non-empty, is the base directory of a symbol storage area, laid out in
// the format required by SimpleSymbolSupplier. If such a storage area
// is specified, it is made available for use by the MicrodumpProcessor.
// Processes |options.microdump_file| using
// MicrodumpProcessor. |options.symbol_path|, if non-empty, is the
// base directory of a symbol storage area, laid out in the format
// required by SimpleSymbolSupplier. If such a storage area is
// specified, it is made available for use by the MicrodumpProcessor.
//
// Returns the value of MicrodumpProcessor::Process. If processing succeeds,
// prints identifying OS and CPU information from the microdump, crash
// information and call stacks for the crashing thread.
// All information is printed to stdout.
int PrintMicrodumpProcess(const char* microdump_file,
const std::vector<string>& symbol_paths,
bool machine_readable) {
std::ifstream file_stream(microdump_file);
int PrintMicrodumpProcess(const Options& options) {
std::ifstream file_stream(options.microdump_file);
std::vector<char> bytes;
file_stream.seekg(0, std::ios_base::end);
bytes.resize(file_stream.tellg());
@ -79,8 +86,8 @@ int PrintMicrodumpProcess(const char* microdump_file,
string microdump_content(&bytes[0], bytes.size());
scoped_ptr<SimpleSymbolSupplier> symbol_supplier;
if (!symbol_paths.empty()) {
symbol_supplier.reset(new SimpleSymbolSupplier(symbol_paths));
if (!options.symbol_paths.empty()) {
symbol_supplier.reset(new SimpleSymbolSupplier(options.symbol_paths));
}
BasicSourceLineResolver resolver;
@ -91,7 +98,7 @@ int PrintMicrodumpProcess(const char* microdump_file,
&process_state);
if (res == google_breakpad::PROCESS_OK) {
if (machine_readable) {
if (options.machine_readable) {
PrintProcessStateMachineReadable(process_state);
} else {
PrintProcessState(process_state, false, &resolver);
@ -103,49 +110,58 @@ int PrintMicrodumpProcess(const char* microdump_file,
return 1;
}
void usage(const char *program_name) {
fprintf(stderr, "usage: %s [-m] <microdump-file> [symbol-path ...]\n"
" -m : Output in machine-readable format\n",
program_name);
}
} // namespace
int main(int argc, char** argv) {
BPLOG_INIT(&argc, &argv);
if (argc < 2) {
usage(argv[0]);
return 1;
}
const char* microdump_file;
bool machine_readable;
int symbol_path_arg;
if (strcmp(argv[1], "-m") == 0) {
if (argc < 3) {
usage(argv[0]);
return 1;
}
machine_readable = true;
microdump_file = argv[2];
symbol_path_arg = 3;
} else {
machine_readable = false;
microdump_file = argv[1];
symbol_path_arg = 2;
}
// extra arguments are symbol paths
std::vector<string> symbol_paths;
if (argc > symbol_path_arg) {
for (int argi = symbol_path_arg; argi < argc; ++argi)
symbol_paths.push_back(argv[argi]);
}
return PrintMicrodumpProcess(microdump_file,
symbol_paths,
machine_readable);
static void Usage(int argc, const char *argv[], bool error) {
fprintf(error ? stderr : stdout,
"Usage: %s [options] <microdump-file> [symbol-path ...]\n"
"\n"
"Output a stack trace for the provided microdump\n"
"\n"
"Options:\n"
"\n"
" -m Output in machine-readable format\n",
basename(argv[0]));
}
static void SetupOptions(int argc, const char *argv[], Options* options) {
int ch;
options->machine_readable = false;
while ((ch = getopt(argc, (char * const *)argv, "hm")) != -1) {
switch (ch) {
case 'h':
Usage(argc, argv, false);
exit(0);
break;
case 'm':
options->machine_readable = true;
break;
case '?':
Usage(argc, argv, true);
exit(1);
break;
}
}
if ((argc - optind) == 0) {
fprintf(stderr, "%s: Missing microdump file\n", argv[0]);
Usage(argc, argv, true);
exit(1);
}
options->microdump_file = argv[optind];
for (int argi = optind + 1; argi < argc; ++argi)
options->symbol_paths.push_back(argv[argi]);
}
int main(int argc, const char* argv[]) {
Options options;
SetupOptions(argc, argv, &options);
return PrintMicrodumpProcess(options);
}

View file

@ -34,6 +34,7 @@
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <limits>
#include <string>
@ -52,6 +53,14 @@
namespace {
struct Options {
bool machine_readable;
bool output_stack_contents;
string minidump_file;
std::vector<string> symbol_paths;
};
using google_breakpad::BasicSourceLineResolver;
using google_breakpad::Minidump;
using google_breakpad::MinidumpMemoryList;
@ -61,24 +70,22 @@ using google_breakpad::ProcessState;
using google_breakpad::SimpleSymbolSupplier;
using google_breakpad::scoped_ptr;
// Processes |minidump_file| using MinidumpProcessor. |symbol_path|, if
// non-empty, is the base directory of a symbol storage area, laid out in
// the format required by SimpleSymbolSupplier. If such a storage area
// is specified, it is made available for use by the MinidumpProcessor.
// Processes |options.minidump_file| using MinidumpProcessor.
// |options.symbol_path|, if non-empty, is the base directory of a
// symbol storage area, laid out in the format required by
// SimpleSymbolSupplier. If such a storage area is specified, it is
// made available for use by the MinidumpProcessor.
//
// Returns the value of MinidumpProcessor::Process. If processing succeeds,
// prints identifying OS and CPU information from the minidump, crash
// information if the minidump was produced as a result of a crash, and
// call stacks for each thread contained in the minidump. All information
// is printed to stdout.
bool PrintMinidumpProcess(const string &minidump_file,
const std::vector<string> &symbol_paths,
bool machine_readable,
bool output_stack_contents) {
bool PrintMinidumpProcess(const Options& options) {
scoped_ptr<SimpleSymbolSupplier> symbol_supplier;
if (!symbol_paths.empty()) {
if (!options.symbol_paths.empty()) {
// TODO(mmentovai): check existence of symbol_path if specified?
symbol_supplier.reset(new SimpleSymbolSupplier(symbol_paths));
symbol_supplier.reset(new SimpleSymbolSupplier(options.symbol_paths));
}
BasicSourceLineResolver resolver;
@ -88,7 +95,7 @@ bool PrintMinidumpProcess(const string &minidump_file,
MinidumpThreadList::set_max_threads(std::numeric_limits<uint32_t>::max());
MinidumpMemoryList::set_max_regions(std::numeric_limits<uint32_t>::max());
// Process the minidump.
Minidump dump(minidump_file);
Minidump dump(options.minidump_file);
if (!dump.Read()) {
BPLOG(ERROR) << "Minidump " << dump.path() << " could not be read";
return false;
@ -100,69 +107,72 @@ bool PrintMinidumpProcess(const string &minidump_file,
return false;
}
if (machine_readable) {
if (options.machine_readable) {
PrintProcessStateMachineReadable(process_state);
} else {
PrintProcessState(process_state, output_stack_contents, &resolver);
PrintProcessState(process_state, options.output_stack_contents, &resolver);
}
return true;
}
void usage(const char *program_name) {
fprintf(stderr, "usage: %s [-m|-s] <minidump-file> [symbol-path ...]\n"
" -m : Output in machine-readable format\n"
" -s : Output stack contents\n",
program_name);
}
} // namespace
int main(int argc, char **argv) {
BPLOG_INIT(&argc, &argv);
if (argc < 2) {
usage(argv[0]);
return 1;
}
const char *minidump_file;
bool machine_readable = false;
bool output_stack_contents = false;
int symbol_path_arg;
if (strcmp(argv[1], "-m") == 0) {
if (argc < 3) {
usage(argv[0]);
return 1;
}
machine_readable = true;
minidump_file = argv[2];
symbol_path_arg = 3;
} else if (strcmp(argv[1], "-s") == 0) {
if (argc < 3) {
usage(argv[0]);
return 1;
}
output_stack_contents = true;
minidump_file = argv[2];
symbol_path_arg = 3;
} else {
minidump_file = argv[1];
symbol_path_arg = 2;
}
// extra arguments are symbol paths
std::vector<string> symbol_paths;
if (argc > symbol_path_arg) {
for (int argi = symbol_path_arg; argi < argc; ++argi)
symbol_paths.push_back(argv[argi]);
}
return PrintMinidumpProcess(minidump_file,
symbol_paths,
machine_readable,
output_stack_contents) ? 0 : 1;
static void Usage(int argc, const char *argv[], bool error) {
fprintf(error ? stderr : stdout,
"Usage: %s [options] <minidump-file> [symbol-path ...]\n"
"\n"
"Output a stack trace for the provided minidump\n"
"\n"
"Options:\n"
"\n"
" -m Output in machine-readable format\n"
" -s Output stack contents\n",
basename(argv[0]));
}
static void SetupOptions(int argc, const char *argv[], Options* options) {
int ch;
options->machine_readable = false;
options->output_stack_contents = false;
while ((ch = getopt(argc, (char * const *)argv, "hms")) != -1) {
switch (ch) {
case 'h':
Usage(argc, argv, false);
exit(0);
break;
case 'm':
options->machine_readable = true;
break;
case 's':
options->output_stack_contents = true;
break;
case '?':
Usage(argc, argv, true);
exit(1);
break;
}
}
if ((argc - optind) == 0) {
fprintf(stderr, "%s: Missing minidump file\n", argv[0]);
Usage(argc, argv, true);
exit(1);
}
options->minidump_file = argv[optind];
for (int argi = optind + 1; argi < argc; ++argi)
options->symbol_paths.push_back(argv[argi]);
}
int main(int argc, const char* argv[]) {
Options options;
SetupOptions(argc, argv, &options);
return PrintMinidumpProcess(options) ? 0 : 1;
}