forked from couchbase/kv_engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
breakpad.cc
218 lines (188 loc) · 6.95 KB
/
breakpad.cc
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
213
214
215
216
217
218
/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* Copyright 2018 Couchbase, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "breakpad.h"
#include "terminate_handler.h"
#include <logger/logger.h>
#include <platform/backtrace.h>
#include <platform/dirutils.h>
#if defined(WIN32) && defined(HAVE_BREAKPAD)
/*
* For some unknown reason, Folly has decided to undefine some Windows types
* that are required by "dbghelp.h", which is included in Breakpad's Windows
* "exception_handler.h". Nobody bothered to document why exactly they were
* undefined, and it looks as though they are not, and never were, used within
* the Folly codebase. So, if we have already pulled in Folly's "Windows.h" at
* this point, then we need to re-define OUT and IN. To avoid any potential
* issues with Folly, we'll undefine them after we've included Breakpad's
* "exception_handler.h". If we haven't pulled in Folly's "Windows.h", then
* Breakpad will pull in it's own, but it won't undefine OUT and IN so there
* won't be an issue.
*/
#ifdef _WINDOWS_
#ifndef OUT
#define UNDEFOUT 1
#define OUT
#endif
#ifndef IN
#define UNDEFIN 1
#define IN
#endif
#endif
#include "client/windows/handler/exception_handler.h"
#ifdef UNDEFOUT
#undef OUT
#endif
#ifdef UNDEFIN
#undef IN
#endif
#elif defined(linux) && defined(HAVE_BREAKPAD)
#include "client/linux/handler/exception_handler.h"
#else
namespace google_breakpad {
class ExceptionHandler {
public:
};
} // namespace google_breakpad
#endif
using namespace google_breakpad;
// Unique_ptr which holds the pointer to the installed
// breakpad handler
static std::unique_ptr<ExceptionHandler> handler;
#if (defined(WIN32) || defined(linux)) && defined(HAVE_BREAKPAD)
// These methods is called from breakpad when creating
// the dump. They're inside the #ifdef block to avoid
// compilers to complain about static functions never
// being used.
static void write_to_logger(void* ctx, const char* frame) {
LOG_CRITICAL(" {}", frame);
}
static void dump_stack() {
LOG_CRITICAL("Stack backtrace of crashed thread:");
print_backtrace(write_to_logger, nullptr);
cb::logger::flush();
}
#endif
// Unfortunately Breakpad use a different API on each platform,
// so we need a bit of #ifdef's..
#if defined(WIN32) && defined(HAVE_BREAKPAD)
static bool dumpCallback(const wchar_t* dump_path,
const wchar_t* minidump_id,
void* context,
EXCEPTION_POINTERS* exinfo,
MDRawAssertionInfo* assertion,
bool succeeded) {
// Unfortnately the filenames is in wchar's and I got compiler errors
// from fmt when trying to print them by using {}. Let's just format
// it into a string first.
char file[512];
sprintf(file, "%S\\%S.dmp", dump_path, minidump_id);
LOG_CRITICAL(
"Breakpad caught a crash (Couchbase version {}). Writing crash "
"dump to {} before terminating.",
PRODUCT_VERSION,
file);
dump_stack();
cb::logger::shutdown();
return succeeded;
}
#elif defined(linux) && defined(HAVE_BREAKPAD)
static bool dumpCallback(const MinidumpDescriptor& descriptor,
void* context,
bool succeeded) {
LOG_CRITICAL(
"Breakpad caught a crash (Couchbase version {}). Writing crash "
"dump to {} before terminating.",
PRODUCT_VERSION,
descriptor.path());
dump_stack();
cb::logger::shutdown();
return succeeded;
}
#endif
void create_handler(const std::string& minidump_dir) {
#if defined(WIN32) && defined(HAVE_BREAKPAD)
// Takes a wchar_t* on Windows. Isn't the Breakpad API nice and
// consistent? ;)
size_t len = minidump_dir.length() + 1;
std::wstring wc_minidump_dir(len, '\0');
size_t wlen = 0;
mbstowcs_s(
&wlen, &wc_minidump_dir[0], len, minidump_dir.c_str(), _TRUNCATE);
handler.reset(new ExceptionHandler(&wc_minidump_dir[0],
/*filter*/ NULL,
dumpCallback,
/*callback-context*/ NULL,
ExceptionHandler::HANDLER_ALL,
MiniDumpNormal,
/*pipe*/ (wchar_t*)NULL,
/*custom_info*/ NULL));
#elif defined(linux) && defined(HAVE_BREAKPAD)
MinidumpDescriptor descriptor(minidump_dir.c_str());
handler.reset(new ExceptionHandler(descriptor,
/*filter*/ nullptr,
dumpCallback,
/*callback-context*/ nullptr,
/*install_handler*/ true,
/*server_fd*/ -1));
#else
// Not supported on this plaform
#endif
}
void cb::breakpad::initialize(const cb::breakpad::Settings& settings) {
// We cannot actually change any of breakpad's settings once created, only
// remove it and re-create with new settings.
destroy();
if (settings.enabled) {
create_handler(settings.minidump_dir);
}
if (handler) {
// Turn off the terminate handler's backtrace - otherwise we
// just print it twice.
set_terminate_handler_print_backtrace(false);
LOG_INFO("Breakpad enabled. Minidumps will be written to '{}'",
settings.minidump_dir);
} else {
// If breakpad is off, then at least print the backtrace via
// terminate_handler.
set_terminate_handler_print_backtrace(true);
LOG_INFO("Breakpad disabled");
}
}
void cb::breakpad::initialize(const std::string& directory) {
// We cannot actually change any of breakpad's settings once created, only
// remove it and re-create with new settings.
destroy();
if (directory.empty()) {
// No directory provided
LOG_INFO("Breakpad disabled");
return;
}
create_handler(directory);
if (handler) {
// Turn off the terminate handler's backtrace - otherwise we
// just print it twice.
set_terminate_handler_print_backtrace(false);
} else {
// do we want to notify the user that we don't have access?
}
}
void cb::breakpad::destroy() {
if (handler) {
set_terminate_handler_print_backtrace(true);
}
handler.reset();
}