309 lines
9.4 KiB
C++
309 lines
9.4 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_dom_CrashReporterParent_h
|
|
#define mozilla_dom_CrashReporterParent_h
|
|
|
|
#include "mozilla/dom/PCrashReporterParent.h"
|
|
#include "mozilla/dom/TabMessageUtils.h"
|
|
#include "nsIFile.h"
|
|
#ifdef MOZ_CRASHREPORTER
|
|
#include "nsExceptionHandler.h"
|
|
#include "nsDataHashtable.h"
|
|
#endif
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
class CrashReporterParent :
|
|
public PCrashReporterParent
|
|
{
|
|
#ifdef MOZ_CRASHREPORTER
|
|
typedef CrashReporter::AnnotationTable AnnotationTable;
|
|
#endif
|
|
public:
|
|
CrashReporterParent();
|
|
virtual ~CrashReporterParent();
|
|
|
|
#ifdef MOZ_CRASHREPORTER
|
|
|
|
/*
|
|
* Attempt to create a bare-bones crash report, along with extra process-
|
|
* specific annotations present in the given AnnotationTable. Calls
|
|
* GenerateChildData and FinalizeChildData.
|
|
*
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
template<class Toplevel>
|
|
bool
|
|
GenerateCrashReport(Toplevel* t, const AnnotationTable* processNotes);
|
|
|
|
/*
|
|
* Attempt to generate a parent/child pair of minidumps from the given
|
|
* toplevel actor. This calls CrashReporter::CreateMinidumpsAndPair to
|
|
* generate the minidumps. Crash reporter annotations set prior to this
|
|
* call will be saved via PairedDumpCallbackExtra into an .extra file
|
|
* under the proper crash id. AnnotateCrashReport annotations are not
|
|
* set in this call and the report is not finalized.
|
|
*
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
template<class Toplevel>
|
|
bool
|
|
GeneratePairedMinidump(Toplevel* t);
|
|
|
|
/*
|
|
* Attempts to take a minidump of the current process and pair that with
|
|
* a named minidump handed in by the caller.
|
|
*
|
|
* @param aTopLevel - top level actor this reporter is associated with.
|
|
* @param aMinidump - the minidump to associate with.
|
|
* @param aPairName - the name of the additional minidump.
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
template<class Toplevel>
|
|
bool
|
|
GenerateMinidumpAndPair(Toplevel* aTopLevel, nsIFile* aMinidump,
|
|
const nsACString& aPairName);
|
|
|
|
/**
|
|
* Apply child process annotations to an existing paired mindump generated
|
|
* with GeneratePairedMinidump.
|
|
*
|
|
* Be careful about calling generate apis immediately after this call,
|
|
* see FinalizeChildData.
|
|
*
|
|
* @param processNotes (optional) - Additional notes to append. Annotations
|
|
* stored in mNotes will also be applied. processNotes can be null.
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
bool
|
|
GenerateChildData(const AnnotationTable* processNotes);
|
|
|
|
/**
|
|
* Handles main thread finalization tasks after a report has been
|
|
* generated. Does the following:
|
|
* - register the finished report with the crash service manager
|
|
* - records telemetry related data about crashes
|
|
*
|
|
* Be careful about calling generate apis immediately after this call,
|
|
* if this api is called on a non-main thread it will fire off a runnable
|
|
* to complete its work async.
|
|
*/
|
|
void
|
|
FinalizeChildData();
|
|
|
|
/*
|
|
* Attempt to generate a full paired dump complete with any child
|
|
* annoations, and finalizes the report. Note this call is only valid
|
|
* on the main thread. Calling on a background thread will fail.
|
|
*
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
template<class Toplevel>
|
|
bool
|
|
GenerateCompleteMinidump(Toplevel* t);
|
|
|
|
/**
|
|
* Submits a raw minidump handed in, calls GenerateChildData and
|
|
* FinalizeChildData. Used by content plugins and gmp.
|
|
*
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
bool
|
|
GenerateCrashReportForMinidump(nsIFile* minidump,
|
|
const AnnotationTable* processNotes);
|
|
|
|
/*
|
|
* Instantiate a new crash reporter actor from a given parent that manages
|
|
* the protocol.
|
|
*
|
|
* @returns true if successful, false otherwise.
|
|
*/
|
|
template<class Toplevel>
|
|
static bool CreateCrashReporter(Toplevel* actor);
|
|
#endif // MOZ_CRASHREPORTER
|
|
|
|
/*
|
|
* Initialize this reporter with data from the child process.
|
|
*/
|
|
void
|
|
SetChildData(const NativeThreadId& id, const uint32_t& processType);
|
|
|
|
/*
|
|
* Returns the ID of the child minidump.
|
|
* GeneratePairedMinidump or GenerateCrashReport must be called first.
|
|
*/
|
|
const nsString& ChildDumpID() {
|
|
return mChildDumpID;
|
|
}
|
|
|
|
/*
|
|
* Add an annotation to our internally tracked list of annotations.
|
|
* Callers must apply these notes using GenerateChildData otherwise
|
|
* the notes will get dropped.
|
|
*/
|
|
void
|
|
AnnotateCrashReport(const nsCString& key, const nsCString& data);
|
|
|
|
protected:
|
|
virtual void ActorDestroy(ActorDestroyReason aWhy) override;
|
|
|
|
virtual bool
|
|
RecvAnnotateCrashReport(const nsCString& key, const nsCString& data) override {
|
|
AnnotateCrashReport(key, data);
|
|
return true;
|
|
}
|
|
virtual bool
|
|
RecvAppendAppNotes(const nsCString& data) override;
|
|
virtual mozilla::ipc::IProtocol*
|
|
CloneProtocol(Channel* aChannel,
|
|
mozilla::ipc::ProtocolCloneContext *aCtx) override;
|
|
|
|
#ifdef MOZ_CRASHREPORTER
|
|
void
|
|
NotifyCrashService();
|
|
#endif
|
|
|
|
#ifdef MOZ_CRASHREPORTER
|
|
AnnotationTable mNotes;
|
|
#endif
|
|
nsCString mAppNotes;
|
|
nsString mChildDumpID;
|
|
// stores the child main thread id
|
|
NativeThreadId mMainThread;
|
|
time_t mStartTime;
|
|
// stores the child process type
|
|
uint32_t mProcessType;
|
|
bool mInitialized;
|
|
};
|
|
|
|
#ifdef MOZ_CRASHREPORTER
|
|
template<class Toplevel>
|
|
inline bool
|
|
CrashReporterParent::GeneratePairedMinidump(Toplevel* t)
|
|
{
|
|
mozilla::ipc::ScopedProcessHandle child;
|
|
#ifdef XP_MACOSX
|
|
child = t->Process()->GetChildTask();
|
|
#else
|
|
if (!base::OpenPrivilegedProcessHandle(t->OtherPid(), &child.rwget())) {
|
|
NS_WARNING("Failed to open child process handle.");
|
|
return false;
|
|
}
|
|
#endif
|
|
nsCOMPtr<nsIFile> childDump;
|
|
if (CrashReporter::CreateMinidumpsAndPair(child,
|
|
mMainThread,
|
|
NS_LITERAL_CSTRING("browser"),
|
|
nullptr, // pair with a dump of this process and thread
|
|
getter_AddRefs(childDump)) &&
|
|
CrashReporter::GetIDFromMinidump(childDump, mChildDumpID)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
template<class Toplevel>
|
|
inline bool
|
|
CrashReporterParent::GenerateMinidumpAndPair(Toplevel* aTopLevel,
|
|
nsIFile* aMinidumpToPair,
|
|
const nsACString& aPairName)
|
|
{
|
|
mozilla::ipc::ScopedProcessHandle childHandle;
|
|
#ifdef XP_MACOSX
|
|
childHandle = aTopLevel->Process()->GetChildTask();
|
|
#else
|
|
if (!base::OpenPrivilegedProcessHandle(aTopLevel->OtherPid(), &childHandle.rwget())) {
|
|
NS_WARNING("Failed to open child process handle.");
|
|
return false;
|
|
}
|
|
#endif
|
|
nsCOMPtr<nsIFile> targetDump;
|
|
if (CrashReporter::CreateMinidumpsAndPair(childHandle,
|
|
mMainThread, // child thread id
|
|
aPairName,
|
|
aMinidumpToPair,
|
|
getter_AddRefs(targetDump)) &&
|
|
CrashReporter::GetIDFromMinidump(targetDump, mChildDumpID)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
template<class Toplevel>
|
|
inline bool
|
|
CrashReporterParent::GenerateCrashReport(Toplevel* t,
|
|
const AnnotationTable* processNotes)
|
|
{
|
|
nsCOMPtr<nsIFile> crashDump;
|
|
if (t->TakeMinidump(getter_AddRefs(crashDump), nullptr) &&
|
|
CrashReporter::GetIDFromMinidump(crashDump, mChildDumpID)) {
|
|
bool result = GenerateChildData(processNotes);
|
|
FinalizeChildData();
|
|
return result;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
template<class Toplevel>
|
|
inline bool
|
|
CrashReporterParent::GenerateCompleteMinidump(Toplevel* t)
|
|
{
|
|
mozilla::ipc::ScopedProcessHandle child;
|
|
if (!NS_IsMainThread()) {
|
|
NS_WARNING("GenerateCompleteMinidump can't be called on non-main thread.");
|
|
return false;
|
|
}
|
|
|
|
#ifdef XP_MACOSX
|
|
child = t->Process()->GetChildTask();
|
|
#else
|
|
if (!base::OpenPrivilegedProcessHandle(t->OtherPid(), &child.rwget())) {
|
|
NS_WARNING("Failed to open child process handle.");
|
|
return false;
|
|
}
|
|
#endif
|
|
nsCOMPtr<nsIFile> childDump;
|
|
if (CrashReporter::CreateMinidumpsAndPair(child,
|
|
mMainThread,
|
|
NS_LITERAL_CSTRING("browser"),
|
|
nullptr, // pair with a dump of this process and thread
|
|
getter_AddRefs(childDump)) &&
|
|
CrashReporter::GetIDFromMinidump(childDump, mChildDumpID)) {
|
|
bool result = GenerateChildData(nullptr);
|
|
FinalizeChildData();
|
|
return result;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
template<class Toplevel>
|
|
/* static */ bool
|
|
CrashReporterParent::CreateCrashReporter(Toplevel* actor)
|
|
{
|
|
#ifdef MOZ_CRASHREPORTER
|
|
NativeThreadId id;
|
|
uint32_t processType;
|
|
PCrashReporterParent* p =
|
|
actor->CallPCrashReporterConstructor(&id, &processType);
|
|
if (p) {
|
|
static_cast<CrashReporterParent*>(p)->SetChildData(id, processType);
|
|
} else {
|
|
NS_ERROR("Error creating crash reporter actor");
|
|
}
|
|
return !!p;
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
#endif
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_CrashReporterParent_h
|