08a8136801
This implements the crash helper service used to move child process crash report generation out of the main process and into its own process. This is implemented as a separate executable that is launched on startup by the main process on the desktop platforms and as a service hosted by a separate process on Android. The crash helper process is started when the first exception handler is set on desktop platforms and before loading libxul on Android. In both cases starting this process happens asynchronously so that neither the main process nor child processes have to wait for it to come up. If a crash happens before the crash helper has started, the crashed process will wait for it to fully come up and then proceed with regular crash generation. IPC with the crash helper is implemented using Unix sockets on Linux and macOS with the former using sequential packets and the latter using stream sockets. On Windows we use named pipes. In all cases the choice of IPC was dictated both by the requirement to eventually talk directly to child processes from within the sandbox, and to external processes in case of Windows as the Windows Error Reporting exception handler must be able to reach out to the helper from within a restricted context. These particular requirements are not used yet but will be as we move more logic out of the main process logic. Differential Revision: https://phabricator.services.mozilla.com/D231083
172 lines
5.0 KiB
C++
172 lines
5.0 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* 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/. */
|
|
|
|
/**
|
|
* This file represents the only external interface exposed from libxul. It
|
|
* is used by the various stub binaries (nsBrowserApp, xpcshell,
|
|
* plugin-container) to initialize XPCOM and start their main loop.
|
|
*/
|
|
|
|
#ifndef mozilla_Bootstrap_h
|
|
#define mozilla_Bootstrap_h
|
|
|
|
#include "mozilla/Maybe.h"
|
|
#include "mozilla/ResultVariant.h"
|
|
#include "mozilla/UniquePtr.h"
|
|
#include "mozilla/UniquePtrExtensions.h"
|
|
#include "mozilla/Variant.h"
|
|
#include "nscore.h"
|
|
#include "nsXULAppAPI.h"
|
|
|
|
#ifdef MOZ_WIDGET_ANDROID
|
|
# include "jni.h"
|
|
#endif
|
|
|
|
#if defined(XP_WIN) && defined(MOZ_SANDBOX)
|
|
namespace sandbox {
|
|
class BrokerServices;
|
|
}
|
|
#endif
|
|
|
|
namespace mozilla {
|
|
|
|
struct StaticXREAppData;
|
|
|
|
struct BootstrapConfig {
|
|
#if defined(XP_WIN) && defined(MOZ_SANDBOX)
|
|
/* Chromium sandbox BrokerServices. */
|
|
sandbox::BrokerServices* sandboxBrokerServices;
|
|
#endif
|
|
/* Pointer to static XRE AppData from application.ini.h */
|
|
const StaticXREAppData* appData;
|
|
/* When the pointer above is null, points to the (string) path of an
|
|
* application.ini file to open and parse.
|
|
* When the pointer above is non-null, may indicate the directory where
|
|
* application files are, relative to the XRE. */
|
|
const char* appDataPath;
|
|
#if defined(MOZ_WIDGET_ANDROID)
|
|
/* Crash notification socket used by Breakpad. */
|
|
int crashChildNotificationSocket;
|
|
/* Crash socket used to communicate with the crash helper. */
|
|
int crashHelperSocket;
|
|
#endif
|
|
};
|
|
|
|
/**
|
|
* This class is virtual abstract so that using it does not require linking
|
|
* any symbols. The singleton instance of this class is obtained from the
|
|
* exported method XRE_GetBootstrap.
|
|
*/
|
|
class Bootstrap {
|
|
protected:
|
|
Bootstrap() {}
|
|
|
|
// Because of allocator mismatches, code outside libxul shouldn't delete a
|
|
// Bootstrap instance. Use Dispose().
|
|
virtual ~Bootstrap() {}
|
|
|
|
/**
|
|
* Destroy and deallocate this Bootstrap instance.
|
|
*/
|
|
virtual void Dispose() = 0;
|
|
|
|
/**
|
|
* Helper class to use with UniquePtr.
|
|
*/
|
|
class BootstrapDelete {
|
|
public:
|
|
constexpr BootstrapDelete() {}
|
|
void operator()(Bootstrap* aPtr) const { aPtr->Dispose(); }
|
|
};
|
|
|
|
public:
|
|
typedef mozilla::UniquePtr<Bootstrap, BootstrapDelete> UniquePtr;
|
|
|
|
virtual void NS_LogInit() = 0;
|
|
|
|
virtual void NS_LogTerm() = 0;
|
|
|
|
virtual void XRE_StartupTimelineRecord(int aEvent,
|
|
mozilla::TimeStamp aWhen) = 0;
|
|
|
|
virtual int XRE_main(int argc, char* argv[],
|
|
const BootstrapConfig& aConfig) = 0;
|
|
|
|
virtual void XRE_StopLateWriteChecks() = 0;
|
|
|
|
virtual int XRE_XPCShellMain(int argc, char** argv, char** envp,
|
|
const XREShellData* aShellData) = 0;
|
|
|
|
virtual nsresult XRE_InitChildProcess(int argc, char* argv[],
|
|
const XREChildData* aChildData) = 0;
|
|
|
|
virtual void XRE_EnableSameExecutableForContentProc() = 0;
|
|
|
|
#ifdef MOZ_WIDGET_ANDROID
|
|
virtual void XRE_SetGeckoThreadEnv(JNIEnv* aEnv) = 0;
|
|
|
|
virtual void XRE_SetAndroidChildFds(JNIEnv* aEnv, jintArray aFds) = 0;
|
|
# ifdef MOZ_PROFILE_GENERATE
|
|
virtual void XRE_WriteLLVMProfData() = 0;
|
|
# endif
|
|
#endif
|
|
|
|
#ifdef LIBFUZZER
|
|
virtual void XRE_LibFuzzerSetDriver(LibFuzzerDriver aDriver) = 0;
|
|
#endif
|
|
|
|
#ifdef MOZ_ENABLE_FORKSERVER
|
|
virtual int XRE_ForkServer(int* argc, char*** argv) = 0;
|
|
#endif
|
|
};
|
|
|
|
enum class LibLoadingStrategy {
|
|
NoReadAhead,
|
|
ReadAhead,
|
|
};
|
|
|
|
#if defined(XP_WIN)
|
|
using DLErrorType = unsigned long; // (DWORD)
|
|
#else
|
|
using DLErrorType = UniqueFreePtr<char>;
|
|
#endif
|
|
|
|
using BootstrapError = Variant<nsresult, DLErrorType>;
|
|
|
|
using BootstrapResult = ::mozilla::Result<Bootstrap::UniquePtr, BootstrapError>;
|
|
|
|
/**
|
|
* Creates and returns the singleton instance of the bootstrap object.
|
|
* @param `b` is an outparam. We use a parameter and not a return value
|
|
* because MSVC doesn't let us return a c++ class from a function with
|
|
* "C" linkage. On failure this will be null.
|
|
* @note This function may only be called once and will crash if called again.
|
|
*/
|
|
#ifdef XPCOM_GLUE
|
|
typedef void (*GetBootstrapType)(Bootstrap::UniquePtr&);
|
|
BootstrapResult GetBootstrap(
|
|
const char* aXPCOMFile = nullptr,
|
|
LibLoadingStrategy aLibLoadingStrategy = LibLoadingStrategy::NoReadAhead);
|
|
#else
|
|
extern "C" NS_EXPORT void NS_FROZENCALL
|
|
XRE_GetBootstrap(Bootstrap::UniquePtr& b);
|
|
|
|
inline BootstrapResult GetBootstrap(
|
|
const char* aXPCOMFile = nullptr,
|
|
LibLoadingStrategy aLibLoadingStrategy = LibLoadingStrategy::NoReadAhead) {
|
|
Bootstrap::UniquePtr bootstrap;
|
|
XRE_GetBootstrap(bootstrap);
|
|
return bootstrap;
|
|
}
|
|
#endif
|
|
|
|
#if defined(XP_WIN) && defined(_M_X64) && defined(MOZ_DIAGNOSTIC_ASSERT_ENABLED)
|
|
extern "C" NS_EXPORT bool XRE_CheckBlockScopeStaticVarInit(uint32_t* aTlsIndex);
|
|
#endif // XP_WIN && _M_X64 && MOZ_DIAGNOSTIC_ASSERT_ENABLED
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_Bootstrap_h
|