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