mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-09 11:25:00 +00:00
76021a664b
This patch includes multiple changes cleaning up various aspects of the crash reporter client and exception handler: * Some Unix-specific code was moved out from the base crashreporter client code and into the appropriate platform implementation * Functions used to open files in the crashreporter client now accept C++ `std::ios` flags instead of unreadable booleans * Useless character conversion routines were removed from the minidump-analyzer * Crash annotations are not serialized into a huge string anymore every time they change. They are all written out individually during an exception. * `WriteEscapedMozCrashReason()` uses the exception-safe `my_strlen()` instead of plain `strlen()` * The Windows-specific DLL-blocklist shutdown was removed from the Linux & macOS Breakpad callbacks * The `CrashReporterHost`, `CrashReporterClient` and `CrashReporterMetadataShmem` classes now take `nsACString` references instead of `nsCString` ones since they never modify their contents Differential Revision: https://phabricator.services.mozilla.com/D33267 --HG-- extra : moz-landing-system : lando
84 lines
2.6 KiB
C++
84 lines
2.6 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_ipc_CrashReporterClient_h
|
|
#define mozilla_ipc_CrashReporterClient_h
|
|
|
|
#include "mozilla/StaticMutex.h"
|
|
#include "mozilla/StaticPtr.h"
|
|
#include "mozilla/Unused.h"
|
|
#include "mozilla/ipc/Shmem.h"
|
|
|
|
namespace mozilla {
|
|
namespace ipc {
|
|
|
|
class CrashReporterMetadataShmem;
|
|
|
|
class CrashReporterClient {
|
|
public:
|
|
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(CrashReporterClient);
|
|
|
|
// |aTopLevelProtocol| must be a top-level protocol instance, as sub-actors
|
|
// do not have AllocUnsafeShmem. It must also have a child-to-parent message:
|
|
//
|
|
// async SetCrashReporterClient(Shmem shmem);
|
|
//
|
|
// The parent-side receive function of this message should save the shmem
|
|
// somewhere, and when the top-level actor's ActorDestroy runs (or when the
|
|
// crash reporter needs metadata), the shmem should be parsed.
|
|
template <typename T>
|
|
static bool InitSingleton(T* aToplevelProtocol) {
|
|
// The crash reporter is not enabled in recording/replaying processes.
|
|
if (recordreplay::IsRecordingOrReplaying()) {
|
|
return true;
|
|
}
|
|
|
|
Shmem shmem;
|
|
if (!AllocShmem(aToplevelProtocol, &shmem)) {
|
|
return false;
|
|
}
|
|
|
|
InitSingletonWithShmem(shmem);
|
|
Unused << aToplevelProtocol->SendInitCrashReporter(
|
|
std::move(shmem), CrashReporter::CurrentThreadId());
|
|
return true;
|
|
}
|
|
|
|
template <typename T>
|
|
static bool AllocShmem(T* aToplevelProtocol, Shmem* aOutShmem) {
|
|
// 16KB should be enough for most metadata - see bug 1278717 comment #11.
|
|
static const size_t kShmemSize = 16 * 1024;
|
|
|
|
return aToplevelProtocol->AllocUnsafeShmem(
|
|
kShmemSize, SharedMemory::TYPE_BASIC, aOutShmem);
|
|
}
|
|
|
|
static void InitSingletonWithShmem(const Shmem& aShmem);
|
|
|
|
static void DestroySingleton();
|
|
static RefPtr<CrashReporterClient> GetSingleton();
|
|
|
|
void AnnotateCrashReport(CrashReporter::Annotation aKey,
|
|
const nsACString& aData);
|
|
void AppendAppNotes(const nsACString& aData);
|
|
|
|
private:
|
|
explicit CrashReporterClient(const Shmem& aShmem);
|
|
~CrashReporterClient();
|
|
|
|
private:
|
|
static StaticMutex sLock;
|
|
static StaticRefPtr<CrashReporterClient> sClientSingleton;
|
|
|
|
private:
|
|
UniquePtr<CrashReporterMetadataShmem> mMetadata;
|
|
};
|
|
|
|
} // namespace ipc
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_ipc_CrashReporterClient_h
|