2016-10-12 00:25:17 +03:00
|
|
|
/* -*- 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_CrashReporterHost_h
|
|
|
|
#define mozilla_ipc_CrashReporterHost_h
|
|
|
|
|
2017-06-22 13:52:58 +03:00
|
|
|
#include <functional>
|
|
|
|
|
2016-10-12 00:25:17 +03:00
|
|
|
#include "mozilla/UniquePtr.h"
|
|
|
|
#include "mozilla/ipc/Shmem.h"
|
|
|
|
#include "base/process.h"
|
|
|
|
#include "nsExceptionHandler.h"
|
2017-08-17 04:12:37 +03:00
|
|
|
#include "nsThreadUtils.h"
|
2016-10-12 00:25:17 +03:00
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace ipc {
|
|
|
|
|
|
|
|
// This is the newer replacement for CrashReporterParent. It is created in
|
|
|
|
// response to a InitCrashReporter message on a top-level actor, and simply
|
|
|
|
// holds the metadata shmem alive until the process ends. When the process
|
|
|
|
// terminates abnormally, the top-level should call GenerateCrashReport to
|
|
|
|
// automatically integrate metadata.
|
|
|
|
class CrashReporterHost
|
|
|
|
{
|
|
|
|
typedef mozilla::ipc::Shmem Shmem;
|
|
|
|
typedef CrashReporter::AnnotationTable AnnotationTable;
|
|
|
|
|
|
|
|
public:
|
2017-06-22 13:52:58 +03:00
|
|
|
|
2017-02-16 01:44:29 +03:00
|
|
|
CrashReporterHost(GeckoProcessType aProcessType,
|
|
|
|
const Shmem& aShmem,
|
2018-09-17 23:51:45 +03:00
|
|
|
CrashReporter::ThreadId aThreadId);
|
2016-10-12 00:25:17 +03:00
|
|
|
|
2017-02-16 01:44:30 +03:00
|
|
|
// Helper function for generating a crash report for a process that probably
|
|
|
|
// crashed (i.e., had an AbnormalShutdown in ActorDestroy). Returns true if
|
|
|
|
// the process has a minidump attached and we were able to generate a report.
|
|
|
|
bool GenerateCrashReport(base::ProcessId aPid);
|
|
|
|
|
2017-02-16 01:44:30 +03:00
|
|
|
// Given an existing minidump for a crashed child process, take ownership of
|
|
|
|
// it from IPDL. After this, FinalizeCrashReport may be called.
|
|
|
|
RefPtr<nsIFile> TakeCrashedChildMinidump(base::ProcessId aPid, uint32_t* aOutSequence);
|
|
|
|
|
|
|
|
// Replace the stored minidump with a new one. After this,
|
|
|
|
// FinalizeCrashReport may be called.
|
|
|
|
bool AdoptMinidump(nsIFile* aFile);
|
|
|
|
|
2017-02-16 01:44:30 +03:00
|
|
|
// If a minidump was already captured (e.g. via the hang reporter), this
|
|
|
|
// finalizes the existing report by attaching metadata and notifying the
|
|
|
|
// crash service.
|
|
|
|
bool FinalizeCrashReport();
|
2016-10-12 00:25:17 +03:00
|
|
|
|
2017-02-16 01:44:30 +03:00
|
|
|
// Generate a paired minidump. This does not take the crash report, as
|
|
|
|
// GenerateCrashReport does. After this, FinalizeCrashReport may be called.
|
2018-09-17 23:51:45 +03:00
|
|
|
//
|
|
|
|
// This calls TakeCrashedChildMinidump and FinalizeCrashReport.
|
|
|
|
template <typename Toplevel>
|
|
|
|
bool GenerateMinidumpAndPair(Toplevel* aToplevelProtocol,
|
|
|
|
nsIFile* aMinidumpToPair,
|
|
|
|
const nsACString& aPairName)
|
|
|
|
{
|
|
|
|
ScopedProcessHandle childHandle;
|
|
|
|
#ifdef XP_MACOSX
|
|
|
|
childHandle = aToplevelProtocol->Process()->GetChildTask();
|
|
|
|
#else
|
|
|
|
if (!base::OpenPrivilegedProcessHandle(aToplevelProtocol->OtherPid(),
|
|
|
|
&childHandle.rwget()))
|
|
|
|
{
|
|
|
|
NS_WARNING("Failed to open child process handle.");
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
nsCOMPtr<nsIFile> targetDump;
|
|
|
|
if (!CrashReporter::CreateMinidumpsAndPair(childHandle,
|
|
|
|
mThreadId,
|
|
|
|
aPairName,
|
|
|
|
aMinidumpToPair,
|
|
|
|
getter_AddRefs(targetDump)))
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return CrashReporter::GetIDFromMinidump(targetDump, mDumpID);
|
|
|
|
}
|
2017-02-16 01:44:30 +03:00
|
|
|
|
Bug 1348273 - Convert crash annotations into a machine-readable list of constants; r=ted.mielczarek,njn,dholbert,mak,cpearce,mcmanus,froydnj,Dexter,jrmuizel,jchen,jimm,bz,surkov
This introduces the machinery needed to generate crash annotations from a YAML
file. The relevant C++ functions are updated to take a typed enum. JavaScript
calls are unaffected but they will throw if the string argument does not
correspond to one of the known entries in the C++ enum. The existing whitelists
and blacklists of annotations are also generated from the YAML file and all
duplicate code related to them has been consolidated. Once written out to the
.extra file the annotations are converted in string form and are no different
than the existing ones.
All existing annotations have been included in the list (and some obsolete ones
have been removed) and all call sites have been updated including tests where
appropriate.
--HG--
extra : source : 4f6c43f2830701ec5552e08e3f1b06fe6d045860
2018-07-05 16:42:11 +03:00
|
|
|
void AddAnnotation(CrashReporter::Annotation aKey, bool aValue);
|
|
|
|
void AddAnnotation(CrashReporter::Annotation aKey, int aValue);
|
|
|
|
void AddAnnotation(CrashReporter::Annotation aKey, unsigned int aValue);
|
|
|
|
void AddAnnotation(CrashReporter::Annotation aKey, const nsCString& aValue);
|
2017-02-16 01:44:30 +03:00
|
|
|
|
|
|
|
bool HasMinidump() const {
|
|
|
|
return !mDumpID.IsEmpty();
|
|
|
|
}
|
|
|
|
const nsString& MinidumpID() const {
|
|
|
|
MOZ_ASSERT(HasMinidump());
|
|
|
|
return mDumpID;
|
|
|
|
}
|
2016-10-12 00:25:17 +03:00
|
|
|
|
|
|
|
private:
|
2016-10-19 13:51:29 +03:00
|
|
|
static void AsyncAddCrash(int32_t aProcessType, int32_t aCrashType,
|
|
|
|
const nsString& aChildDumpID);
|
2016-10-12 00:25:17 +03:00
|
|
|
|
2018-08-14 03:50:11 +03:00
|
|
|
// Get the nsICrashService crash type to use for an impending crash.
|
|
|
|
int32_t GetCrashType(const CrashReporter::AnnotationTable& aAnnotations);
|
|
|
|
|
|
|
|
// This is a static helper function to notify the crash service that a
|
|
|
|
// crash has occurred. This can be called from any thread, and if not
|
|
|
|
// called from the main thread, will post a synchronous message to the
|
|
|
|
// main thread.
|
|
|
|
static void NotifyCrashService(
|
|
|
|
GeckoProcessType aProcessType,
|
|
|
|
int32_t aCrashType,
|
|
|
|
const nsString& aChildDumpID);
|
|
|
|
|
2016-10-12 00:25:17 +03:00
|
|
|
private:
|
|
|
|
GeckoProcessType mProcessType;
|
|
|
|
Shmem mShmem;
|
2018-09-17 23:51:45 +03:00
|
|
|
CrashReporter::ThreadId mThreadId;
|
2016-10-12 00:25:17 +03:00
|
|
|
time_t mStartTime;
|
Bug 1348273 - Convert crash annotations into a machine-readable list of constants; r=ted.mielczarek,njn,dholbert,mak,cpearce,mcmanus,froydnj,Dexter,jrmuizel,jchen,jimm,bz,surkov
This introduces the machinery needed to generate crash annotations from a YAML
file. The relevant C++ functions are updated to take a typed enum. JavaScript
calls are unaffected but they will throw if the string argument does not
correspond to one of the known entries in the C++ enum. The existing whitelists
and blacklists of annotations are also generated from the YAML file and all
duplicate code related to them has been consolidated. Once written out to the
.extra file the annotations are converted in string form and are no different
than the existing ones.
All existing annotations have been included in the list (and some obsolete ones
have been removed) and all call sites have been updated including tests where
appropriate.
--HG--
extra : source : 4f6c43f2830701ec5552e08e3f1b06fe6d045860
2018-07-05 16:42:11 +03:00
|
|
|
AnnotationTable mExtraAnnotations;
|
2017-02-16 01:44:30 +03:00
|
|
|
nsString mDumpID;
|
|
|
|
bool mFinalized;
|
2016-10-12 00:25:17 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace ipc
|
|
|
|
} // namespace mozilla
|
|
|
|
|
|
|
|
#endif // mozilla_ipc_CrashReporterHost_h
|