Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Maintain client in crashpad state #910

Merged
merged 4 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# Changelog

## Unreleased

**Fixes**:

- Maintain crashpad client instance during Native SDK lifecycle. ([#910](https://github.com/getsentry/sentry-native/pull/910))

## 0.6.7

**Fixes**:

- Disable sigaltstack on Android ([#901](https://github.com/getsentry/sentry-native/pull/901))
- Prevent stuck crashpad-client on Windows ([#902](https://github.com/getsentry/sentry-native/pull/902), [crashpad#89](https://github.com/getsentry/crashpad/pull/89))
- Disable sigaltstack on Android. ([#901](https://github.com/getsentry/sentry-native/pull/901))
- Prevent stuck crashpad-client on Windows. ([#902](https://github.com/getsentry/sentry-native/pull/902), [crashpad#89](https://github.com/getsentry/crashpad/pull/89))

## 0.6.6

Expand Down
40 changes: 27 additions & 13 deletions src/backends/sentry_backend_crashpad.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ extern "C" {
# pragma warning(pop)
#endif

template <typename T>
static void
safe_delete(T *&ptr)
{
delete ptr;
ptr = nullptr;
}

extern "C" {

#ifdef SENTRY_PLATFORM_LINUX
Expand Down Expand Up @@ -74,13 +82,24 @@ constexpr int g_CrashSignals[] = {

typedef struct {
crashpad::CrashReportDatabase *db;
crashpad::CrashpadClient *client;
sentry_path_t *event_path;
sentry_path_t *breadcrumb1_path;
sentry_path_t *breadcrumb2_path;
size_t num_breadcrumbs;
sentry_value_t crash_event;
} crashpad_state_t;

/**
* Correctly destruct C++ members of the crashpad state.
*/
static void
crashpad_state_dtor(crashpad_state_t *state)
{
safe_delete(state->client);
safe_delete(state->db);
}

static void
crashpad_backend_user_consent_changed(sentry_backend_t *backend)
{
Expand Down Expand Up @@ -325,24 +344,22 @@ crashpad_backend_startup(
// Initialize database first, flushing the consent later on as part of
// `sentry_init` will persist the upload flag.
data->db = crashpad::CrashReportDatabase::Initialize(database).release();

data->client = new crashpad::CrashpadClient;
bool success;
crashpad::CrashpadClient client;
char *minidump_url
= sentry__dsn_get_minidump_url(options->dsn, options->user_agent);
if (minidump_url) {
SENTRY_TRACEF("using minidump URL \"%s\"", minidump_url);
success = client.StartHandler(handler, database, database, minidump_url,
options->http_proxy ? options->http_proxy : "", annotations,
arguments,
success = data->client->StartHandler(handler, database, database,
minidump_url, options->http_proxy ? options->http_proxy : "",
annotations, arguments,
/* restartable */ true,
/* asynchronous_start */ false, attachments);
sentry_free(minidump_url);
} else {
SENTRY_WARN(
"failed to construct minidump URL (check DSN or user-agent)");
delete data->db;
data->db = nullptr;
crashpad_state_dtor(data);
return 1;
}

Expand All @@ -369,7 +386,7 @@ crashpad_backend_startup(
SENTRY_WARN("registering crashpad WER handler in registry failed");
} else {
std::wstring wer_path_string(wer_path->path);
if (!client.RegisterWerModule(wer_path_string)) {
if (!data->client->RegisterWerModule(wer_path_string)) {
SENTRY_WARN("registering crashpad WER handler module failed");
}
}
Expand All @@ -387,8 +404,7 @@ crashpad_backend_startup(
} else {
SENTRY_WARN("failed to start crashpad client handler");
// not calling `shutdown`
delete data->db;
data->db = nullptr;
crashpad_state_dtor(data);
return 1;
}

Expand Down Expand Up @@ -432,9 +448,7 @@ crashpad_backend_shutdown(sentry_backend_t *backend)
}
#endif

auto *data = static_cast<crashpad_state_t *>(backend->data);
delete data->db;
data->db = nullptr;
crashpad_state_dtor(static_cast<crashpad_state_t *>(backend->data));

#ifdef SENTRY_PLATFORM_LINUX
g_signal_stack.ss_flags = SS_DISABLE;
Expand Down