summaryrefslogtreecommitdiffstats
path: root/tools/crashreporter/minidump_stackwalk/minidump_stackwalk.cc
blob: f43cf14a0178d7567f0be99770c07f108aff6f19 (plain)
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// Copyright (c) 2010 Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// minidump_stackwalk.cc: Process a minidump with MinidumpProcessor, printing
// the results, including stack traces.
//
// Author: Mark Mentovai
//
// Lightly modified to use HTTPSymbolSupplier instead of SimpleSymbolSupplier

#include <stdio.h>
#include <string.h>

#include <limits>
#include <string>
#include <vector>

#include "common/scoped_ptr.h"
#include "common/using_std_string.h"
#include "google_breakpad/processor/basic_source_line_resolver.h"
#include "google_breakpad/processor/minidump.h"
#include "google_breakpad/processor/minidump_processor.h"
#include "google_breakpad/processor/process_state.h"
#include "processor/logging.h"
#include "processor/simple_symbol_supplier.h"
#include "processor/stackwalk_common.h"

#include "http_symbol_supplier.h"

#ifdef ERROR
#  undef ERROR
#endif

#ifdef SEVERITY_ERROR
#  undef SEVERITY_ERROR
#endif

namespace {

using breakpad_extra::HTTPSymbolSupplier;
using google_breakpad::BasicSourceLineResolver;
using google_breakpad::Minidump;
using google_breakpad::MinidumpMemoryList;
using google_breakpad::MinidumpProcessor;
using google_breakpad::MinidumpThreadList;
using google_breakpad::ProcessState;
using google_breakpad::scoped_ptr;
using google_breakpad::SimpleSymbolSupplier;

// 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.
//
// 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_args,
                          bool machine_readable, bool output_stack_contents) {
  std::vector<string> server_paths;
  std::vector<string> symbol_paths;
  for (std::vector<string>::const_iterator arg = symbol_args.begin();
       arg < symbol_args.end(); ++arg) {
    if (arg->substr(0, 4) == "http") {
      server_paths.push_back(*arg);
    } else {
      symbol_paths.push_back(*arg);
    }
  }

  string temp_path;
#ifdef _WIN32
  temp_path.resize(MAX_PATH + 1);
  DWORD length = GetTempPath(temp_path.length(), &temp_path[0]);
  temp_path.resize(length + 1);
#else
  temp_path = "/tmp";
#endif

  if (server_paths.empty()) {
    server_paths.push_back(
        "http://s3-us-west-2.amazonaws.com/"
        "org.mozilla.crash-stats.symbols-public/v1/");
  }

  scoped_ptr<HTTPSymbolSupplier> symbol_supplier;
  string symbols_cache = temp_path;
  if (!symbol_paths.empty()) {
    symbols_cache = symbol_paths[0];
    symbol_paths.erase(symbol_paths.begin());
  }

  // TODO(mmentovai): check existence of symbol_path if specified?
  symbol_supplier.reset(new HTTPSymbolSupplier(server_paths, symbols_cache,
                                               symbol_paths, temp_path));

  BasicSourceLineResolver resolver;
  MinidumpProcessor minidump_processor(symbol_supplier.get(), &resolver);

  // Increase the maximum number of threads and regions.
  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);
  if (!dump.Read()) {
    BPLOG(ERROR) << "Minidump " << dump.path() << " could not be read";
    return false;
  }
  ProcessState process_state;
  if (minidump_processor.Process(&dump, &process_state) !=
      google_breakpad::PROCESS_OK) {
    BPLOG(ERROR) << "MinidumpProcessor::Process failed";
    return false;
  }

  if (machine_readable) {
    PrintProcessStateMachineReadable(process_state);
  } else {
    PrintProcessState(process_state, output_stack_contents, &resolver);
  }

  return true;
}

void usage(const char* program_name) {
  fprintf(stderr,
          "usage: %s [-m|-s] <minidump-file> [<symbol server URL> | "
          "<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;
}