fune/gfx/thebes/gfxPlatform.cpp
Cosmin Sabou 36dc5703c6 Backed out 3 changesets (bug 1859625) for causing reftest assertion failures on gfxFeature.cpp. CLOSED TREE
Backed out changeset ea804fe0a160 (bug 1859625)
Backed out changeset 7ba7a8156187 (bug 1859625)
Backed out changeset ab1801c9add6 (bug 1859625)
2023-11-21 19:38:28 +02:00

3997 lines
137 KiB
C++

/* -*- Mode: C++; tab-width: 20; 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/. */
#include "mozilla/FontPropertyTypes.h"
#include "mozilla/RDDProcessManager.h"
#include "mozilla/image/ImageMemoryReporter.h"
#include "mozilla/layers/CompositorManagerChild.h"
#include "mozilla/layers/CompositorThread.h"
#include "mozilla/layers/ImageBridgeChild.h"
#include "mozilla/layers/ISurfaceAllocator.h" // for GfxMemoryImageReporter
#include "mozilla/layers/CompositorBridgeChild.h"
#include "mozilla/layers/RemoteTextureMap.h"
#include "mozilla/layers/VideoBridgeParent.h"
#include "mozilla/webrender/RenderThread.h"
#include "mozilla/webrender/WebRenderAPI.h"
#include "mozilla/webrender/webrender_ffi.h"
#include "mozilla/gfx/BuildConstants.h"
#include "mozilla/gfx/gfxConfigManager.h"
#include "mozilla/gfx/gfxVars.h"
#include "mozilla/gfx/GPUProcessManager.h"
#include "mozilla/gfx/GraphicsMessages.h"
#include "mozilla/gfx/CanvasManagerChild.h"
#include "mozilla/gfx/CanvasRenderThread.h"
#include "mozilla/ClearOnShutdown.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/EnumTypeTraits.h"
#include "mozilla/StaticPrefs_accessibility.h"
#include "mozilla/StaticPrefs_apz.h"
#include "mozilla/StaticPrefs_bidi.h"
#include "mozilla/StaticPrefs_gfx.h"
#include "mozilla/StaticPrefs_layout.h"
#include "mozilla/StaticPrefs_layers.h"
#include "mozilla/StaticPrefs_media.h"
#include "mozilla/StaticPrefs_privacy.h"
#include "mozilla/StaticPrefs_webgl.h"
#include "mozilla/StaticPrefs_widget.h"
#include "mozilla/Telemetry.h"
#include "mozilla/TimeStamp.h"
#include "mozilla/Unused.h"
#include "mozilla/IntegerPrintfMacros.h"
#include "mozilla/Base64.h"
#include "mozilla/VsyncDispatcher.h"
#include "mozilla/Logging.h"
#include "mozilla/Components.h"
#include "nsAppRunner.h"
#include "nsAppDirectoryServiceDefs.h"
#include "nsCSSProps.h"
#include "nsContentUtils.h"
#include "gfxCrashReporterUtils.h"
#include "gfxPlatform.h"
#include "gfxPlatformWorker.h"
#include "gfxBlur.h"
#include "gfxEnv.h"
#include "gfxTextRun.h"
#include "gfxUserFontSet.h"
#include "gfxConfig.h"
#include "GfxDriverInfo.h"
#include "VRProcessManager.h"
#include "VRThread.h"
#ifdef XP_WIN
# include <process.h>
# define getpid _getpid
#else
# include <unistd.h>
#endif
#include "nsXULAppAPI.h"
#include "nsIXULAppInfo.h"
#include "nsDirectoryServiceUtils.h"
#include "nsDirectoryServiceDefs.h"
#if defined(XP_WIN)
# include "gfxWindowsPlatform.h"
# include "mozilla/widget/WinWindowOcclusionTracker.h"
#elif defined(XP_MACOSX)
# include "gfxPlatformMac.h"
# include "gfxQuartzSurface.h"
#elif defined(MOZ_WIDGET_GTK)
# include "gfxPlatformGtk.h"
#elif defined(ANDROID)
# include "gfxAndroidPlatform.h"
#endif
#if defined(MOZ_WIDGET_ANDROID)
# include "mozilla/jni/Utils.h" // for IsFennec
#endif
#ifdef XP_WIN
# include "mozilla/WindowsVersion.h"
# include "WinUtils.h"
#endif
#include "nsGkAtoms.h"
#include "gfxPlatformFontList.h"
#include "gfxContext.h"
#include "gfxImageSurface.h"
#include "nsUnicodeProperties.h"
#include "harfbuzz/hb.h"
#include "gfxGraphiteShaper.h"
#include "gfx2DGlue.h"
#include "gfxGradientCache.h"
#include "gfxUtils.h" // for NextPowerOfTwo
#include "gfxFontMissingGlyphs.h"
#include "nsExceptionHandler.h"
#include "nsServiceManagerUtils.h"
#include "nsTArray.h"
#include "nsIObserverService.h"
#include "mozilla/widget/Screen.h"
#include "mozilla/widget/ScreenManager.h"
#include "MainThreadUtils.h"
#include "nsWeakReference.h"
#include "cairo.h"
#include "qcms.h"
#include "imgITools.h"
#include "nsCRT.h"
#include "GLContext.h"
#include "GLContextProvider.h"
#include "mozilla/gfx/Logging.h"
#ifdef __GNUC__
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wshadow"
#endif
#include "skia/include/core/SkGraphics.h"
#ifdef MOZ_ENABLE_FREETYPE
# include "skia/include/ports/SkTypeface_cairo.h"
#endif
#include "mozilla/gfx/SkMemoryReporter.h"
#ifdef __GNUC__
# pragma GCC diagnostic pop // -Wshadow
#endif
static const uint32_t kDefaultGlyphCacheSize = -1;
#include "mozilla/Preferences.h"
#include "mozilla/Assertions.h"
#include "mozilla/Atomics.h"
#include "mozilla/Attributes.h"
#include "mozilla/Mutex.h"
#include "nsAlgorithm.h"
#include "nsIGfxInfo.h"
#include "nsIXULRuntime.h"
#include "VsyncSource.h"
#include "SoftwareVsyncSource.h"
#include "nscore.h" // for NS_FREE_PERMANENT_DATA
#include "mozilla/dom/ContentChild.h"
#include "mozilla/dom/ContentParent.h"
#include "mozilla/dom/TouchEvent.h"
#include "gfxVR.h"
#include "VRManager.h"
#include "VRManagerChild.h"
#include "mozilla/gfx/GPUParent.h"
#include "prsystem.h"
#include "mozilla/gfx/2D.h"
#include "mozilla/gfx/SourceSurfaceCairo.h"
using namespace mozilla;
using namespace mozilla::layers;
using namespace mozilla::gl;
using namespace mozilla::gfx;
gfxPlatform* gPlatform = nullptr;
static bool gEverInitialized = false;
const ContentDeviceData* gContentDeviceInitData = nullptr;
Atomic<bool, MemoryOrdering::ReleaseAcquire> gfxPlatform::gCMSInitialized;
CMSMode gfxPlatform::gCMSMode = CMSMode::Off;
// These two may point to the same profile
qcms_profile* gfxPlatform::gCMSOutputProfile = nullptr;
qcms_profile* gfxPlatform::gCMSsRGBProfile = nullptr;
qcms_transform* gfxPlatform::gCMSRGBTransform = nullptr;
qcms_transform* gfxPlatform::gCMSInverseRGBTransform = nullptr;
qcms_transform* gfxPlatform::gCMSRGBATransform = nullptr;
qcms_transform* gfxPlatform::gCMSBGRATransform = nullptr;
/// This override of the LogForwarder, initially used for the critical graphics
/// errors, is sending the log to the crash annotations as well, but only
/// if the capacity set with the method below is >= 2. We always retain the
/// very first critical message, and the latest capacity-1 messages are
/// rotated through. Note that we don't expect the total number of times
/// this gets called to be large - it is meant for critical errors only.
class CrashStatsLogForwarder : public mozilla::gfx::LogForwarder {
public:
explicit CrashStatsLogForwarder(CrashReporter::Annotation aKey);
void Log(const std::string& aString) override;
void CrashAction(LogReason aReason) override;
bool UpdateStringsVector(const std::string& aString) override;
LoggingRecord LoggingRecordCopy() override;
void SetCircularBufferSize(uint32_t aCapacity);
private:
// Helper for the Log()
void UpdateCrashReport();
private:
LoggingRecord mBuffer;
CrashReporter::Annotation mCrashCriticalKey;
uint32_t mMaxCapacity;
int32_t mIndex;
Mutex mMutex MOZ_UNANNOTATED;
};
CrashStatsLogForwarder::CrashStatsLogForwarder(CrashReporter::Annotation aKey)
: mCrashCriticalKey(aKey),
mMaxCapacity(0),
mIndex(-1),
mMutex("CrashStatsLogForwarder") {}
void CrashStatsLogForwarder::SetCircularBufferSize(uint32_t aCapacity) {
MutexAutoLock lock(mMutex);
mMaxCapacity = aCapacity;
mBuffer.reserve(static_cast<size_t>(aCapacity));
}
LoggingRecord CrashStatsLogForwarder::LoggingRecordCopy() {
MutexAutoLock lock(mMutex);
return mBuffer;
}
bool CrashStatsLogForwarder::UpdateStringsVector(const std::string& aString) {
// We want at least the first one and the last one. Otherwise, no point.
if (mMaxCapacity < 2) {
return false;
}
mIndex += 1;
MOZ_ASSERT(mIndex >= 0);
// index will count 0, 1, 2, ..., max-1, 1, 2, ..., max-1, 1, 2, ...
int32_t index = mIndex ? (mIndex - 1) % (mMaxCapacity - 1) + 1 : 0;
MOZ_ASSERT(index >= 0 && index < (int32_t)mMaxCapacity);
MOZ_ASSERT(index <= mIndex && index <= (int32_t)mBuffer.size());
double tStamp = (TimeStamp::NowLoRes() - TimeStamp::ProcessCreation())
.ToSecondsSigDigits();
// Checking for index >= mBuffer.size(), rather than index == mBuffer.size()
// just out of paranoia, but we know index <= mBuffer.size().
LoggingRecordEntry newEntry(mIndex, aString, tStamp);
if (index >= static_cast<int32_t>(mBuffer.size())) {
mBuffer.push_back(newEntry);
} else {
mBuffer[index] = newEntry;
}
return true;
}
void CrashStatsLogForwarder::UpdateCrashReport() {
std::stringstream message;
std::string logAnnotation;
switch (XRE_GetProcessType()) {
case GeckoProcessType_Default:
logAnnotation = "|[";
break;
case GeckoProcessType_Content:
logAnnotation = "|[C";
break;
case GeckoProcessType_GPU:
logAnnotation = "|[G";
break;
default:
logAnnotation = "|[X";
break;
}
for (auto& it : mBuffer) {
message << logAnnotation << std::get<0>(it) << "]" << std::get<1>(it)
<< " (t=" << std::get<2>(it) << ") ";
}
nsCString reportString(message.str().c_str());
nsresult annotated =
CrashReporter::AnnotateCrashReport(mCrashCriticalKey, reportString);
if (annotated != NS_OK) {
printf("Crash Annotation %s: %s",
CrashReporter::AnnotationToString(mCrashCriticalKey),
message.str().c_str());
}
}
class LogForwarderEvent : public Runnable {
virtual ~LogForwarderEvent() = default;
public:
NS_INLINE_DECL_REFCOUNTING_INHERITED(LogForwarderEvent, Runnable)
explicit LogForwarderEvent(const nsCString& aMessage)
: mozilla::Runnable("LogForwarderEvent"), mMessage(aMessage) {}
NS_IMETHOD Run() override {
MOZ_ASSERT(NS_IsMainThread() &&
(XRE_IsContentProcess() || XRE_IsGPUProcess()));
if (XRE_IsContentProcess()) {
dom::ContentChild* cc = dom::ContentChild::GetSingleton();
Unused << cc->SendGraphicsError(mMessage);
} else if (XRE_IsGPUProcess()) {
GPUParent* gp = GPUParent::GetSingleton();
Unused << gp->SendGraphicsError(mMessage);
}
return NS_OK;
}
protected:
nsCString mMessage;
};
void CrashStatsLogForwarder::Log(const std::string& aString) {
MutexAutoLock lock(mMutex);
if (UpdateStringsVector(aString)) {
UpdateCrashReport();
}
// Add it to the parent strings
if (!XRE_IsParentProcess()) {
nsCString stringToSend(aString.c_str());
if (NS_IsMainThread()) {
if (XRE_IsContentProcess()) {
dom::ContentChild* cc = dom::ContentChild::GetSingleton();
Unused << cc->SendGraphicsError(stringToSend);
} else if (XRE_IsGPUProcess()) {
GPUParent* gp = GPUParent::GetSingleton();
Unused << gp->SendGraphicsError(stringToSend);
}
} else {
nsCOMPtr<nsIRunnable> r1 = new LogForwarderEvent(stringToSend);
NS_DispatchToMainThread(r1);
}
}
}
class CrashTelemetryEvent : public Runnable {
virtual ~CrashTelemetryEvent() = default;
public:
NS_INLINE_DECL_REFCOUNTING_INHERITED(CrashTelemetryEvent, Runnable)
explicit CrashTelemetryEvent(uint32_t aReason)
: mozilla::Runnable("CrashTelemetryEvent"), mReason(aReason) {}
NS_IMETHOD Run() override {
MOZ_ASSERT(NS_IsMainThread());
Telemetry::Accumulate(Telemetry::GFX_CRASH, mReason);
return NS_OK;
}
protected:
uint32_t mReason;
};
void CrashStatsLogForwarder::CrashAction(LogReason aReason) {
#ifndef RELEASE_OR_BETA
// Non-release builds crash by default, but will use telemetry
// if this environment variable is present.
static bool useTelemetry = gfxEnv::MOZ_GFX_CRASH_TELEMETRY();
#else
// Release builds use telemetry by default, but will crash instead
// if this environment variable is present.
static bool useTelemetry = !gfxEnv::MOZ_GFX_CRASH_MOZ_CRASH();
#endif
if (useTelemetry) {
// The callers need to assure that aReason is in the range
// that the telemetry call below supports.
if (NS_IsMainThread()) {
Telemetry::Accumulate(Telemetry::GFX_CRASH, (uint32_t)aReason);
} else {
nsCOMPtr<nsIRunnable> r1 = new CrashTelemetryEvent((uint32_t)aReason);
NS_DispatchToMainThread(r1);
}
} else {
// ignoring aReason, we can get the information we need from the stack
MOZ_CRASH("GFX_CRASH");
}
}
#define GFX_DOWNLOADABLE_FONTS_ENABLED "gfx.downloadable_fonts.enabled"
#define GFX_PREF_FALLBACK_USE_CMAPS \
"gfx.font_rendering.fallback.always_use_cmaps"
#define GFX_PREF_OPENTYPE_SVG "gfx.font_rendering.opentype_svg.enabled"
#define GFX_PREF_WORD_CACHE_CHARLIMIT "gfx.font_rendering.wordcache.charlimit"
#define GFX_PREF_WORD_CACHE_MAXENTRIES "gfx.font_rendering.wordcache.maxentries"
#define GFX_PREF_GRAPHITE_SHAPING "gfx.font_rendering.graphite.enabled"
#if defined(XP_MACOSX)
# define GFX_PREF_CORETEXT_SHAPING "gfx.font_rendering.coretext.enabled"
#endif
#define FONT_VARIATIONS_PREF "layout.css.font-variations.enabled"
static const char* kObservedPrefs[] = {"gfx.downloadable_fonts.",
"gfx.font_rendering.", nullptr};
static void FontPrefChanged(const char* aPref, void* aData) {
MOZ_ASSERT(aPref);
NS_ASSERTION(gfxPlatform::GetPlatform(), "the singleton instance has gone");
gfxPlatform::GetPlatform()->FontsPrefsChanged(aPref);
}
void gfxPlatform::OnMemoryPressure(layers::MemoryPressureReason aWhy) {
Factory::PurgeAllCaches();
gfxGradientCache::PurgeAllCaches();
gfxFontMissingGlyphs::Purge();
PurgeSkiaFontCache();
if (XRE_IsParentProcess()) {
layers::CompositorManagerChild* manager =
CompositorManagerChild::GetInstance();
if (manager) {
manager->SendNotifyMemoryPressure();
}
}
}
gfxPlatform::gfxPlatform()
: mAzureCanvasBackendCollector(this, &gfxPlatform::GetAzureBackendInfo),
mApzSupportCollector(this, &gfxPlatform::GetApzSupportInfo),
mFrameStatsCollector(this, &gfxPlatform::GetFrameStats),
mCMSInfoCollector(this, &gfxPlatform::GetCMSSupportInfo),
mDisplayInfoCollector(this, &gfxPlatform::GetDisplayInfo),
mOverlayInfoCollector(this, &gfxPlatform::GetOverlayInfo),
mSwapChainInfoCollector(this, &gfxPlatform::GetSwapChainInfo),
mCompositorBackend(layers::LayersBackend::LAYERS_NONE),
mScreenDepth(0) {
mAllowDownloadableFonts = UNINITIALIZED_VALUE;
InitBackendPrefs(GetBackendPrefs());
VRManager::ManagerInit();
}
gfxPlatform* gfxPlatform::GetPlatform() {
if (!gPlatform) {
MOZ_RELEASE_ASSERT(!XRE_IsContentProcess(),
"Content Process should have called InitChild() before "
"first GetPlatform()");
Init();
}
return gPlatform;
}
bool gfxPlatform::Initialized() { return !!gPlatform; }
/* static */
void gfxPlatform::InitChild(const ContentDeviceData& aData) {
MOZ_ASSERT(XRE_IsContentProcess());
MOZ_RELEASE_ASSERT(!gPlatform,
"InitChild() should be called before first GetPlatform()");
// Make the provided initial ContentDeviceData available to the init
// routines, so they don't have to do a sync request from the parent.
gContentDeviceInitData = &aData;
Init();
gContentDeviceInitData = nullptr;
}
#define WR_DEBUG_PREF "gfx.webrender.debug"
static void SwapIntervalPrefChangeCallback(const char* aPrefName, void*) {
bool egl = Preferences::GetBool("gfx.swap-interval.egl", false);
bool glx = Preferences::GetBool("gfx.swap-interval.glx", false);
gfxVars::SetSwapIntervalEGL(egl);
gfxVars::SetSwapIntervalGLX(glx);
}
static void WebRendeProfilerUIPrefChangeCallback(const char* aPrefName, void*) {
nsCString uiString;
if (NS_SUCCEEDED(Preferences::GetCString("gfx.webrender.debug.profiler-ui",
uiString))) {
gfxVars::SetWebRenderProfilerUI(uiString);
}
}
// List of boolean dynamic parameter for WebRender.
//
// The parameters in this list are:
// - The pref name.
// - The BoolParameter enum variant (see webrender_api/src/lib.rs)
// - A default value.
#define WR_BOOL_PARAMETER_LIST(_) \
_("gfx.webrender.batched-texture-uploads", \
wr::BoolParameter::BatchedUploads, true) \
_("gfx.webrender.draw-calls-for-texture-copy", \
wr::BoolParameter::DrawCallsForTextureCopy, true) \
_("gfx.webrender.pbo-uploads", wr::BoolParameter::PboUploads, true) \
_("gfx.webrender.multithreading", wr::BoolParameter::Multithreading, true)
static void WebRenderBoolParameterChangeCallback(const char*, void*) {
uint32_t bits = 0;
#define WR_BOOL_PARAMETER(name, key, default_val) \
if (Preferences::GetBool(name, default_val)) { \
bits |= 1 << (uint32_t)key; \
}
WR_BOOL_PARAMETER_LIST(WR_BOOL_PARAMETER)
#undef WR_BOOL_PARAMETER
gfx::gfxVars::SetWebRenderBoolParameters(bits);
}
static void RegisterWebRenderBoolParamCallback() {
#define WR_BOOL_PARAMETER(name, _key, _default_val) \
Preferences::RegisterCallback(WebRenderBoolParameterChangeCallback, name);
WR_BOOL_PARAMETER_LIST(WR_BOOL_PARAMETER)
#undef WR_BOOL_PARAMETER
WebRenderBoolParameterChangeCallback(nullptr, nullptr);
}
static void WebRenderDebugPrefChangeCallback(const char* aPrefName, void*) {
wr::DebugFlags flags{0};
#define GFX_WEBRENDER_DEBUG(suffix, bit) \
if (Preferences::GetBool(WR_DEBUG_PREF suffix, false)) { \
flags |= (bit); \
}
GFX_WEBRENDER_DEBUG(".profiler", wr::DebugFlags::PROFILER_DBG)
GFX_WEBRENDER_DEBUG(".render-targets", wr::DebugFlags::RENDER_TARGET_DBG)
GFX_WEBRENDER_DEBUG(".texture-cache", wr::DebugFlags::TEXTURE_CACHE_DBG)
GFX_WEBRENDER_DEBUG(".gpu-time-queries", wr::DebugFlags::GPU_TIME_QUERIES)
GFX_WEBRENDER_DEBUG(".gpu-sample-queries", wr::DebugFlags::GPU_SAMPLE_QUERIES)
GFX_WEBRENDER_DEBUG(".disable-batching", wr::DebugFlags::DISABLE_BATCHING)
GFX_WEBRENDER_DEBUG(".epochs", wr::DebugFlags::EPOCHS)
GFX_WEBRENDER_DEBUG(".smart-profiler", wr::DebugFlags::SMART_PROFILER)
GFX_WEBRENDER_DEBUG(".echo-driver-messages",
wr::DebugFlags::ECHO_DRIVER_MESSAGES)
GFX_WEBRENDER_DEBUG(".show-overdraw", wr::DebugFlags::SHOW_OVERDRAW)
GFX_WEBRENDER_DEBUG(".gpu-cache", wr::DebugFlags::GPU_CACHE_DBG)
GFX_WEBRENDER_DEBUG(".texture-cache.clear-evicted",
wr::DebugFlags::TEXTURE_CACHE_DBG_CLEAR_EVICTED)
GFX_WEBRENDER_DEBUG(".picture-caching", wr::DebugFlags::PICTURE_CACHING_DBG)
GFX_WEBRENDER_DEBUG(".force-picture-invalidation",
wr::DebugFlags::FORCE_PICTURE_INVALIDATION)
GFX_WEBRENDER_DEBUG(".primitives", wr::DebugFlags::PRIMITIVE_DBG)
// Bit 18 is for the zoom display, which requires the mouse position and thus
// currently only works in wrench.
GFX_WEBRENDER_DEBUG(".small-screen", wr::DebugFlags::SMALL_SCREEN)
GFX_WEBRENDER_DEBUG(".disable-opaque-pass",
wr::DebugFlags::DISABLE_OPAQUE_PASS)
GFX_WEBRENDER_DEBUG(".disable-alpha-pass", wr::DebugFlags::DISABLE_ALPHA_PASS)
GFX_WEBRENDER_DEBUG(".disable-clip-masks", wr::DebugFlags::DISABLE_CLIP_MASKS)
GFX_WEBRENDER_DEBUG(".disable-text-prims", wr::DebugFlags::DISABLE_TEXT_PRIMS)
GFX_WEBRENDER_DEBUG(".disable-gradient-prims",
wr::DebugFlags::DISABLE_GRADIENT_PRIMS)
GFX_WEBRENDER_DEBUG(".obscure-images", wr::DebugFlags::OBSCURE_IMAGES)
GFX_WEBRENDER_DEBUG(".glyph-flashing", wr::DebugFlags::GLYPH_FLASHING)
GFX_WEBRENDER_DEBUG(".capture-profiler", wr::DebugFlags::PROFILER_CAPTURE)
GFX_WEBRENDER_DEBUG(".window-visibility",
wr::DebugFlags::WINDOW_VISIBILITY_DBG)
GFX_WEBRENDER_DEBUG(".restrict-blob-size", wr::DebugFlags::RESTRICT_BLOB_SIZE)
#undef GFX_WEBRENDER_DEBUG
gfx::gfxVars::SetWebRenderDebugFlags(flags._0);
}
static void WebRenderQualityPrefChangeCallback(const char* aPref, void*) {
gfxPlatform::GetPlatform()->UpdateForceSubpixelAAWherePossible();
}
static void WebRenderBatchingPrefChangeCallback(const char* aPrefName, void*) {
uint32_t count = Preferences::GetUint(
StaticPrefs::GetPrefName_gfx_webrender_batching_lookback(), 10);
gfx::gfxVars::SetWebRenderBatchingLookback(count);
}
static void WebRenderBlobTileSizePrefChangeCallback(const char* aPrefName,
void*) {
uint32_t tileSize = Preferences::GetUint(
StaticPrefs::GetPrefName_gfx_webrender_blob_tile_size(), 256);
gfx::gfxVars::SetWebRenderBlobTileSize(tileSize);
}
static void WebRenderUploadThresholdPrefChangeCallback(const char* aPrefName,
void*) {
int value = Preferences::GetInt(
StaticPrefs::GetPrefName_gfx_webrender_batched_upload_threshold(),
512 * 512);
gfxVars::SetWebRenderBatchedUploadThreshold(value);
}
static uint32_t GetSkiaGlyphCacheSize() {
// Only increase font cache size on non-android to save memory.
#if !defined(MOZ_WIDGET_ANDROID)
// 10mb as the default pref cache size on desktop due to talos perf tweaking.
// Chromium uses 20mb and skia default uses 2mb.
// We don't need to change the font cache count since we usually
// cache thrash due to asian character sets in talos.
// Only increase memory on the content process
uint32_t cacheSize =
StaticPrefs::gfx_content_skia_font_cache_size_AtStartup() * 1024 * 1024;
if (mozilla::BrowserTabsRemoteAutostart()) {
return XRE_IsContentProcess() ? cacheSize : kDefaultGlyphCacheSize;
}
return cacheSize;
#else
return kDefaultGlyphCacheSize;
#endif // MOZ_WIDGET_ANDROID
}
class WebRenderMemoryReporter final : public nsIMemoryReporter {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIMEMORYREPORTER
private:
~WebRenderMemoryReporter() = default;
};
// Memory reporter for WebRender.
//
// The reporting within WebRender is manual and incomplete. We could do a much
// more thorough job by depending on the malloc_size_of crate, but integrating
// that into WebRender is tricky [1].
//
// So the idea is to start with manual reporting for the large allocations
// detected by DMD, and see how much that can cover in practice (which may
// require a few rounds of iteration). If that approach turns out to be
// fundamentally insufficient, we can either duplicate more of the
// malloc_size_of functionality in WebRender, or deal with the complexity of a
// gecko-only crate dependency.
//
// [1] See https://bugzilla.mozilla.org/show_bug.cgi?id=1480293#c1
struct WebRenderMemoryReporterHelper {
WebRenderMemoryReporterHelper(nsIHandleReportCallback* aCallback,
nsISupports* aData)
: mCallback(aCallback), mData(aData) {}
nsCOMPtr<nsIHandleReportCallback> mCallback;
nsCOMPtr<nsISupports> mData;
void Report(size_t aBytes, const char* aName) const {
nsPrintfCString path("explicit/gfx/webrender/%s", aName);
nsCString desc("CPU heap memory used by WebRender"_ns);
ReportInternal(aBytes, path, desc, nsIMemoryReporter::KIND_HEAP);
}
void ReportTexture(size_t aBytes, const char* aName) const {
nsPrintfCString path("gfx/webrender/textures/%s", aName);
nsCString desc("GPU texture memory used by WebRender"_ns);
ReportInternal(aBytes, path, desc, nsIMemoryReporter::KIND_OTHER);
}
void ReportTotalGPUBytes(size_t aBytes) const {
nsCString path("gfx/webrender/total-gpu-bytes"_ns);
nsCString desc(nsLiteralCString(
"Total GPU bytes used by WebRender (should match textures/ sum)"));
ReportInternal(aBytes, path, desc, nsIMemoryReporter::KIND_OTHER);
}
void ReportInternal(size_t aBytes, nsACString& aPath, nsACString& aDesc,
int32_t aKind) const {
// Generally, memory reporters pass the empty string as the process name to
// indicate "current process". However, if we're using a GPU process, the
// measurements will actually take place in that process, and it's easier to
// just note that here rather than trying to invoke the memory reporter in
// the GPU process.
nsAutoCString processName;
if (gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
GPUParent::GetGPUProcessName(processName);
}
mCallback->Callback(processName, aPath, aKind,
nsIMemoryReporter::UNITS_BYTES, aBytes, aDesc, mData);
}
};
static void FinishAsyncMemoryReport() {
nsCOMPtr<nsIMemoryReporterManager> imgr =
do_GetService("@mozilla.org/memory-reporter-manager;1");
if (imgr) {
imgr->EndReport();
}
}
// clang-format off
// (For some reason, clang-format gets the second macro right, but totally mangles the first).
#define REPORT_INTERNER(id) \
helper.Report(aReport.interning.interners.id, \
"interning/" #id "/interners");
// clang-format on
#define REPORT_DATA_STORE(id) \
helper.Report(aReport.interning.data_stores.id, \
"interning/" #id "/data-stores");
NS_IMPL_ISUPPORTS(WebRenderMemoryReporter, nsIMemoryReporter)
NS_IMETHODIMP
WebRenderMemoryReporter::CollectReports(nsIHandleReportCallback* aHandleReport,
nsISupports* aData, bool aAnonymize) {
MOZ_ASSERT(XRE_IsParentProcess());
MOZ_ASSERT(NS_IsMainThread());
layers::CompositorManagerChild* manager =
CompositorManagerChild::GetInstance();
if (!manager) {
FinishAsyncMemoryReport();
return NS_OK;
}
WebRenderMemoryReporterHelper helper(aHandleReport, aData);
manager->SendReportMemory(
[=](wr::MemoryReport aReport) {
// CPU Memory.
helper.Report(aReport.clip_stores, "clip-stores");
helper.Report(aReport.gpu_cache_metadata, "gpu-cache/metadata");
helper.Report(aReport.gpu_cache_cpu_mirror, "gpu-cache/cpu-mirror");
helper.Report(aReport.render_tasks, "render-tasks");
helper.Report(aReport.hit_testers, "hit-testers");
helper.Report(aReport.fonts, "resource-cache/fonts");
helper.Report(aReport.weak_fonts, "resource-cache/weak-fonts");
helper.Report(aReport.images, "resource-cache/images");
helper.Report(aReport.rasterized_blobs,
"resource-cache/rasterized-blobs");
helper.Report(aReport.texture_cache_structures,
"texture-cache/structures");
helper.Report(aReport.shader_cache, "shader-cache");
helper.Report(aReport.display_list, "display-list");
helper.Report(aReport.swgl, "swgl");
helper.Report(aReport.upload_staging_memory, "upload-stagin-memory");
WEBRENDER_FOR_EACH_INTERNER(REPORT_INTERNER);
WEBRENDER_FOR_EACH_INTERNER(REPORT_DATA_STORE);
// GPU Memory.
helper.ReportTexture(aReport.gpu_cache_textures, "gpu-cache");
helper.ReportTexture(aReport.vertex_data_textures, "vertex-data");
helper.ReportTexture(aReport.render_target_textures, "render-targets");
helper.ReportTexture(aReport.depth_target_textures, "depth-targets");
helper.ReportTexture(aReport.picture_tile_textures, "picture-tiles");
helper.ReportTexture(aReport.atlas_textures, "texture-cache/atlas");
helper.ReportTexture(aReport.standalone_textures,
"texture-cache/standalone");
helper.ReportTexture(aReport.texture_upload_pbos,
"texture-upload-pbos");
helper.ReportTexture(aReport.swap_chain, "swap-chains");
helper.ReportTexture(aReport.render_texture_hosts,
"render-texture-hosts");
helper.ReportTexture(aReport.upload_staging_textures,
"upload-staging-textures");
FinishAsyncMemoryReport();
},
[](mozilla::ipc::ResponseRejectReason&& aReason) {
FinishAsyncMemoryReport();
});
return NS_OK;
}
#undef REPORT_INTERNER
#undef REPORT_DATA_STORE
std::atomic<int8_t> gfxPlatform::sHasVariationFontSupport = -1;
bool gfxPlatform::HasVariationFontSupport() {
// We record the status here: 0 for not supported, 1 for supported.
if (sHasVariationFontSupport < 0) {
// It doesn't actually matter if we race with another thread setting this,
// as any thread will set it to the same value.
#if defined(XP_WIN)
sHasVariationFontSupport = gfxWindowsPlatform::CheckVariationFontSupport();
#elif defined(XP_MACOSX)
sHasVariationFontSupport = gfxPlatformMac::CheckVariationFontSupport();
#elif defined(MOZ_WIDGET_GTK)
sHasVariationFontSupport = gfxPlatformGtk::CheckVariationFontSupport();
#elif defined(ANDROID)
sHasVariationFontSupport = gfxAndroidPlatform::CheckVariationFontSupport();
#else
# error "No gfxPlatform implementation available"
#endif
}
return sHasVariationFontSupport > 0;
}
void gfxPlatform::Init() {
MOZ_RELEASE_ASSERT(!XRE_IsGPUProcess(), "GFX: Not allowed in GPU process.");
MOZ_RELEASE_ASSERT(!XRE_IsRDDProcess(), "GFX: Not allowed in RDD process.");
MOZ_RELEASE_ASSERT(NS_IsMainThread(), "GFX: Not in main thread.");
if (gEverInitialized) {
MOZ_CRASH("Already started???");
}
gEverInitialized = true;
gfxVars::Initialize();
gfxConfig::Init();
if (XRE_IsParentProcess()) {
GPUProcessManager::Initialize();
RDDProcessManager::Initialize();
nsCOMPtr<nsIFile> file;
nsresult rv = NS_GetSpecialDirectory(NS_GRE_DIR, getter_AddRefs(file));
if (NS_FAILED(rv)) {
gfxVars::SetGREDirectory(nsString());
} else {
nsAutoString path;
file->GetPath(path);
gfxVars::SetGREDirectory(nsString(path));
}
}
if (XRE_IsParentProcess()) {
nsCOMPtr<nsIFile> profDir;
nsresult rv = NS_GetSpecialDirectory(NS_APP_PROFILE_DIR_STARTUP,
getter_AddRefs(profDir));
if (NS_FAILED(rv)) {
gfxVars::SetProfDirectory(nsString());
} else {
nsAutoString path;
profDir->GetPath(path);
gfxVars::SetProfDirectory(nsString(path));
}
nsAutoCString path;
Preferences::GetCString("layers.windowrecording.path", path);
gfxVars::SetLayersWindowRecordingPath(path);
if (gFxREmbedded) {
gfxVars::SetFxREmbedded(true);
}
}
// Drop a note in the crash report if we end up forcing an option that could
// destabilize things. New items should be appended at the end (of an
// existing or in a new section), so that we don't have to know the version to
// interpret these cryptic strings.
{
nsAutoCString forcedPrefs;
// D2D prefs
forcedPrefs.AppendPrintf(
"FP(D%d%d", StaticPrefs::gfx_direct2d_disabled_AtStartup(),
StaticPrefs::gfx_direct2d_force_enabled_AtStartup());
// Layers prefs
forcedPrefs.AppendPrintf(
"-L%d%d%d%d",
StaticPrefs::layers_amd_switchable_gfx_enabled_AtStartup(),
StaticPrefs::layers_acceleration_disabled_AtStartup_DoNotUseDirectly(),
StaticPrefs::
layers_acceleration_force_enabled_AtStartup_DoNotUseDirectly(),
StaticPrefs::layers_d3d11_force_warp_AtStartup());
// WebGL prefs
forcedPrefs.AppendPrintf(
"-W%d%d%d%d%d%d%d", StaticPrefs::webgl_angle_force_d3d11(),
StaticPrefs::webgl_angle_force_warp(), StaticPrefs::webgl_disabled(),
StaticPrefs::webgl_disable_angle(), StaticPrefs::webgl_dxgl_enabled(),
StaticPrefs::webgl_force_enabled(), StaticPrefs::webgl_msaa_force());
// Prefs that don't fit into any of the other sections
forcedPrefs.AppendPrintf("-T%d%d%d) ",
StaticPrefs::gfx_android_rgb16_force_AtStartup(),
StaticPrefs::gfx_canvas_accelerated(),
StaticPrefs::layers_force_shmem_tiles_AtStartup());
ScopedGfxFeatureReporter::AppNote(forcedPrefs);
}
InitMoz2DLogging();
/* Initialize the GfxInfo service.
* Note: we can't call functions on GfxInfo that depend
* on gPlatform until after it has been initialized
* below. GfxInfo initialization annotates our
* crash reports so we want to do it before
* we try to load any drivers and do device detection
* incase that code crashes. See bug #591561. */
nsCOMPtr<nsIGfxInfo> gfxInfo;
/* this currently will only succeed on Windows */
gfxInfo = components::GfxInfo::Service();
if (XRE_IsParentProcess()) {
// Some gfxVars must be initialized prior gPlatform for coherent results.
gfxVars::SetDXInterop2Blocked(IsDXInterop2Blocked());
gfxVars::SetDXNV12Blocked(IsDXNV12Blocked());
gfxVars::SetDXP010Blocked(IsDXP010Blocked());
gfxVars::SetDXP016Blocked(IsDXP016Blocked());
}
#if defined(XP_WIN)
gPlatform = new gfxWindowsPlatform;
#elif defined(XP_MACOSX)
gPlatform = new gfxPlatformMac;
#elif defined(MOZ_WIDGET_GTK)
gPlatform = new gfxPlatformGtk;
#elif defined(ANDROID)
gPlatform = new gfxAndroidPlatform;
#else
# error "No gfxPlatform implementation available"
#endif
gPlatform->PopulateScreenInfo();
gPlatform->InitAcceleration();
gPlatform->InitWebRenderConfig();
gPlatform->InitHardwareVideoConfig();
gPlatform->InitWebGLConfig();
gPlatform->InitWebGPUConfig();
gPlatform->InitWindowOcclusionConfig();
gPlatform->InitBackdropFilterConfig();
gPlatform->InitAcceleratedCanvas2DConfig();
#if defined(XP_WIN)
// When using WebRender, we defer initialization of the D3D11 devices until
// the (rare) cases where they're used. Note that the GPU process where
// WebRender runs doesn't initialize gfxPlatform and performs explicit
// initialization of the bits it needs.
if (XRE_IsParentProcess() && !gfxConfig::IsEnabled(Feature::GPU_PROCESS) &&
StaticPrefs::
gfx_webrender_enabled_no_gpu_process_with_angle_win_AtStartup()) {
gPlatform->EnsureDevicesInitialized();
}
#endif
if (gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
GPUProcessManager* gpu = GPUProcessManager::Get();
Unused << gpu->LaunchGPUProcess();
}
if (XRE_IsParentProcess()) {
// Create the global vsync source and dispatcher.
RefPtr<VsyncSource> vsyncSource =
gfxPlatform::ForceSoftwareVsync()
? gPlatform->GetSoftwareVsyncSource()
: gPlatform->GetGlobalHardwareVsyncSource();
gPlatform->mVsyncDispatcher = new VsyncDispatcher(vsyncSource);
// Listen for layout.frame_rate pref changes.
Preferences::RegisterCallback(
gfxPlatform::ReInitFrameRate,
nsDependentCString(StaticPrefs::GetPrefName_layout_frame_rate()));
Preferences::RegisterCallback(
gfxPlatform::ReInitFrameRate,
nsDependentCString(
StaticPrefs::GetPrefName_privacy_resistFingerprinting()));
}
// Create the sRGB to output display profile transforms. They can be accessed
// off the main thread so we want to avoid a race condition.
InitializeCMS();
SkGraphics::Init();
#ifdef MOZ_ENABLE_FREETYPE
SkInitCairoFT(gPlatform->FontHintingEnabled());
#endif
gfxGradientCache::Init();
InitLayersIPC();
// This *create* the platform font list instance, but may not *initialize* it
// yet if the gfx.font-list.lazy-init.enabled pref is set. The first *use*
// of the list will ensure it is initialized.
if (!gPlatform->CreatePlatformFontList()) {
MOZ_CRASH("Could not initialize gfxPlatformFontList");
}
gPlatform->mScreenReferenceDrawTarget =
gPlatform->CreateOffscreenContentDrawTarget(IntSize(1, 1),
SurfaceFormat::B8G8R8A8);
if (!gPlatform->mScreenReferenceDrawTarget ||
!gPlatform->mScreenReferenceDrawTarget->IsValid()) {
// If TDR is detected, create a draw target with software backend
// and it should be replaced later when the process gets the device
// reset notification.
if (!gPlatform->DidRenderingDeviceReset()) {
gfxCriticalError() << "Could not initialize mScreenReferenceDrawTarget";
}
}
if (NS_FAILED(gfxFontCache::Init())) {
MOZ_CRASH("Could not initialize gfxFontCache");
}
Preferences::RegisterPrefixCallbacks(FontPrefChanged, kObservedPrefs);
GLContext::PlatformStartup();
// Listen to memory pressure event so we can purge DrawTarget caches
gPlatform->mMemoryPressureObserver =
layers::MemoryPressureObserver::Create(gPlatform);
// Request the imgITools service, implicitly initializing ImageLib.
nsCOMPtr<imgITools> imgTools = do_GetService("@mozilla.org/image/tools;1");
if (!imgTools) {
MOZ_CRASH("Could not initialize ImageLib");
}
RegisterStrongMemoryReporter(new GfxMemoryImageReporter());
if (XRE_IsParentProcess()) {
RegisterStrongAsyncMemoryReporter(new WebRenderMemoryReporter());
}
RegisterStrongMemoryReporter(new SkMemoryReporter());
uint32_t skiaCacheSize = GetSkiaGlyphCacheSize();
if (skiaCacheSize != kDefaultGlyphCacheSize) {
SkGraphics::SetFontCacheLimit(skiaCacheSize);
}
InitNullMetadata();
InitOpenGLConfig();
if (XRE_IsParentProcess()) {
Preferences::Unlock(FONT_VARIATIONS_PREF);
if (!gfxPlatform::HasVariationFontSupport()) {
// Ensure variation fonts are disabled and the pref is locked.
Preferences::SetBool(FONT_VARIATIONS_PREF, false, PrefValueKind::Default);
Preferences::SetBool(FONT_VARIATIONS_PREF, false);
Preferences::Lock(FONT_VARIATIONS_PREF);
}
}
if (XRE_IsParentProcess()) {
ReportTelemetry();
}
nsCOMPtr<nsIObserverService> obs = services::GetObserverService();
if (obs) {
obs->NotifyObservers(nullptr, "gfx-features-ready", nullptr);
}
}
void gfxPlatform::ReportTelemetry() {
MOZ_RELEASE_ASSERT(XRE_IsParentProcess(),
"GFX: Only allowed to be called from parent process.");
nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
{
auto& screenManager = widget::ScreenManager::GetSingleton();
const uint32_t screenCount = screenManager.CurrentScreenList().Length();
RefPtr<widget::Screen> primaryScreen = screenManager.GetPrimaryScreen();
const LayoutDeviceIntRect rect = primaryScreen->GetRect();
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_DISPLAY_COUNT, screenCount);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_DISPLAY_PRIMARY_HEIGHT,
uint32_t(rect.Height()));
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_DISPLAY_PRIMARY_WIDTH,
uint32_t(rect.Width()));
mozilla::glean::fog_validation::gvsv_primary_height.Set(rect.Height());
mozilla::glean::fog_validation::gvsv_primary_width.Set(rect.Width());
}
nsString adapterDesc;
gfxInfo->GetAdapterDescription(adapterDesc);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_DESCRIPTION,
adapterDesc);
nsString adapterVendorId;
gfxInfo->GetAdapterVendorID(adapterVendorId);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_VENDOR_ID,
adapterVendorId);
nsString adapterDeviceId;
gfxInfo->GetAdapterDeviceID(adapterDeviceId);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_DEVICE_ID,
adapterDeviceId);
nsString adapterSubsystemId;
gfxInfo->GetAdapterSubsysID(adapterSubsystemId);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_SUBSYSTEM_ID,
adapterSubsystemId);
uint32_t adapterRam = 0;
gfxInfo->GetAdapterRAM(&adapterRam);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_RAM, adapterRam);
nsString adapterDriver;
gfxInfo->GetAdapterDriver(adapterDriver);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_DRIVER_FILES,
adapterDriver);
nsString adapterDriverVendor;
gfxInfo->GetAdapterDriverVendor(adapterDriverVendor);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_DRIVER_VENDOR,
adapterDriverVendor);
nsString adapterDriverVersion;
gfxInfo->GetAdapterDriverVersion(adapterDriverVersion);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_DRIVER_VERSION,
adapterDriverVersion);
nsString adapterDriverDate;
gfxInfo->GetAdapterDriverDate(adapterDriverDate);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_ADAPTER_DRIVER_DATE,
adapterDriverDate);
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_HEADLESS, IsHeadless());
MOZ_ASSERT(gPlatform, "Need gPlatform to generate some telemetry.");
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_SUPPORTS_HDR,
gPlatform->SupportsHDR());
}
static bool IsFeatureSupported(long aFeature, bool aDefault) {
nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
nsCString blockId;
int32_t status;
if (!NS_SUCCEEDED(gfxInfo->GetFeatureStatus(aFeature, blockId, &status))) {
return aDefault;
}
return status == nsIGfxInfo::FEATURE_STATUS_OK;
}
/* static*/
bool gfxPlatform::IsDXInterop2Blocked() {
return !IsFeatureSupported(nsIGfxInfo::FEATURE_DX_INTEROP2, false);
}
/* static*/
bool gfxPlatform::IsDXNV12Blocked() {
return !IsFeatureSupported(nsIGfxInfo::FEATURE_DX_NV12, false);
}
/* static*/
bool gfxPlatform::IsDXP010Blocked() {
return !IsFeatureSupported(nsIGfxInfo::FEATURE_DX_P010, false);
}
/* static*/
bool gfxPlatform::IsDXP016Blocked() {
return !IsFeatureSupported(nsIGfxInfo::FEATURE_DX_P016, false);
}
/* static */
int32_t gfxPlatform::MaxTextureSize() {
// Make sure we don't completely break rendering because of a typo in the
// pref or whatnot.
const int32_t kMinSizePref = 2048;
return std::max(
kMinSizePref,
StaticPrefs::gfx_max_texture_size_AtStartup_DoNotUseDirectly());
}
/* static */
int32_t gfxPlatform::MaxAllocSize() {
// Make sure we don't completely break rendering because of a typo in the
// pref or whatnot.
const int32_t kMinAllocPref = 10000000;
return std::max(kMinAllocPref,
StaticPrefs::gfx_max_alloc_size_AtStartup_DoNotUseDirectly());
}
/* static */
void gfxPlatform::InitMoz2DLogging() {
auto fwd = new CrashStatsLogForwarder(
CrashReporter::Annotation::GraphicsCriticalError);
fwd->SetCircularBufferSize(StaticPrefs::gfx_logging_crash_length_AtStartup());
mozilla::gfx::Config cfg;
cfg.mLogForwarder = fwd;
cfg.mMaxTextureSize = gfxPlatform::MaxTextureSize();
cfg.mMaxAllocSize = gfxPlatform::MaxAllocSize();
gfx::Factory::Init(cfg);
}
/* static */
bool gfxPlatform::IsHeadless() {
static bool initialized = false;
static bool headless = false;
if (!initialized) {
initialized = true;
headless = PR_GetEnv("MOZ_HEADLESS");
}
return headless;
}
/* static */
bool gfxPlatform::UseRemoteCanvas() {
return XRE_IsContentProcess() && gfx::gfxVars::RemoteCanvasEnabled();
}
/* static */
bool gfxPlatform::IsBackendAccelerated(
const mozilla::gfx::BackendType aBackendType) {
return aBackendType == BackendType::DIRECT2D ||
aBackendType == BackendType::DIRECT2D1_1;
}
/* static */
bool gfxPlatform::CanMigrateMacGPUs() {
int32_t pMigration = StaticPrefs::gfx_compositor_gpu_migration();
bool forceDisable = pMigration == 0;
bool forceEnable = pMigration == 2;
return forceEnable || !forceDisable;
}
static bool sLayersIPCIsUp = false;
/* static */
void gfxPlatform::InitNullMetadata() {
ScrollMetadata::sNullMetadata = new ScrollMetadata();
ClearOnShutdown(&ScrollMetadata::sNullMetadata);
}
void gfxPlatform::Shutdown() {
// In some cases, gPlatform may not be created but Shutdown() called,
// e.g., during xpcshell tests.
if (!gPlatform) {
return;
}
MOZ_ASSERT(!sLayersIPCIsUp);
// These may be called before the corresponding subsystems have actually
// started up. That's OK, they can handle it.
gfxFontCache::Shutdown();
gfxGradientCache::Shutdown();
gfxAlphaBoxBlur::ShutdownBlurCache();
gfxGraphiteShaper::Shutdown();
gfxPlatformFontList::Shutdown();
gfxFontMissingGlyphs::Shutdown();
// Free the various non-null transforms and loaded profiles
ShutdownCMS();
Preferences::UnregisterPrefixCallbacks(FontPrefChanged, kObservedPrefs);
NS_ASSERTION(gPlatform->mMemoryPressureObserver,
"mMemoryPressureObserver has already gone");
if (gPlatform->mMemoryPressureObserver) {
gPlatform->mMemoryPressureObserver->Unregister();
gPlatform->mMemoryPressureObserver = nullptr;
}
if (XRE_IsParentProcess()) {
if (gPlatform->mGlobalHardwareVsyncSource) {
gPlatform->mGlobalHardwareVsyncSource->Shutdown();
}
if (gPlatform->mSoftwareVsyncSource &&
gPlatform->mSoftwareVsyncSource !=
gPlatform->mGlobalHardwareVsyncSource) {
gPlatform->mSoftwareVsyncSource->Shutdown();
}
}
gPlatform->mGlobalHardwareVsyncSource = nullptr;
gPlatform->mSoftwareVsyncSource = nullptr;
gPlatform->mVsyncDispatcher = nullptr;
// Shut down the default GL context provider.
GLContextProvider::Shutdown();
#if defined(XP_WIN)
// The above shutdown calls operate on the available context providers on
// most platforms. Windows is a "special snowflake", though, and has three
// context providers available, so we have to shut all of them down.
// We should only support the default GL provider on Windows; then, this
// could go away. Unfortunately, we currently support WGL (the default) for
// WebGL on Optimus.
GLContextProviderEGL::Shutdown();
#endif
if (XRE_IsParentProcess()) {
GPUProcessManager::Shutdown();
VRProcessManager::Shutdown();
RDDProcessManager::Shutdown();
}
gfx::Factory::ShutDown();
gfxVars::Shutdown();
gfxFont::DestroySingletons();
gfxConfig::Shutdown();
gPlatform->WillShutdown();
delete gPlatform;
gPlatform = nullptr;
}
/* static */
void gfxPlatform::InitLayersIPC() {
if (sLayersIPCIsUp) {
return;
}
sLayersIPCIsUp = true;
if (XRE_IsParentProcess()) {
#if defined(XP_WIN)
if (gfxConfig::IsEnabled(gfx::Feature::WINDOW_OCCLUSION)) {
widget::WinWindowOcclusionTracker::Ensure();
}
#endif
if (!gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
RemoteTextureMap::Init();
wr::RenderThread::Start(GPUProcessManager::Get()->AllocateNamespace());
image::ImageMemoryReporter::InitForWebRender();
}
layers::CompositorThreadHolder::Start();
if (!gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
gfx::CanvasRenderThread::Start();
}
}
}
/* static */
void gfxPlatform::ShutdownLayersIPC() {
if (!sLayersIPCIsUp) {
return;
}
sLayersIPCIsUp = false;
if (XRE_IsContentProcess()) {
gfx::VRManagerChild::ShutDown();
gfx::CanvasManagerChild::Shutdown();
// cf bug 1215265.
if (StaticPrefs::layers_child_process_shutdown()) {
layers::CompositorManagerChild::Shutdown();
layers::ImageBridgeChild::ShutDown();
}
} else if (XRE_IsParentProcess()) {
VideoBridgeParent::Shutdown();
RDDProcessManager::RDDProcessShutdown();
gfx::VRManagerChild::ShutDown();
gfx::CanvasManagerChild::Shutdown();
layers::CompositorManagerChild::Shutdown();
layers::ImageBridgeChild::ShutDown();
// This could be running on either the Compositor thread, the Renderer
// thread, or the dedicated CanvasRender thread, so we need to shutdown
// before the former two.
gfx::CanvasRenderThread::Shutdown();
// This has to happen after shutting down the child protocols.
layers::CompositorThreadHolder::Shutdown();
RemoteTextureMap::Shutdown();
image::ImageMemoryReporter::ShutdownForWebRender();
// There is a case that RenderThread exists when UseWebRender() is
// false. This could happen when WebRender was fallbacked to compositor.
if (wr::RenderThread::Get()) {
wr::RenderThread::ShutDown();
Preferences::UnregisterCallback(WebRenderDebugPrefChangeCallback,
WR_DEBUG_PREF);
Preferences::UnregisterCallback(WebRendeProfilerUIPrefChangeCallback,
"gfx.webrender.debug.profiler-ui");
Preferences::UnregisterCallback(
WebRenderBlobTileSizePrefChangeCallback,
nsDependentCString(
StaticPrefs::GetPrefName_gfx_webrender_blob_tile_size()));
}
#if defined(XP_WIN)
widget::WinWindowOcclusionTracker::ShutDown();
#endif
} else {
// TODO: There are other kind of processes and we should make sure gfx
// stuff is either not created there or shut down properly.
}
}
void gfxPlatform::WillShutdown() {
// Destoy these first in case they depend on backend-specific resources.
// Otherwise, the backend's destructor would be called before the
// base gfxPlatform destructor.
mScreenReferenceSurface = nullptr;
mScreenReferenceDrawTarget = nullptr;
// Always clear out the Skia font cache here, in case it is referencing any
// SharedFTFaces that would otherwise outlive destruction of the FT_Library
// that owns them.
SkGraphics::PurgeFontCache();
// The cairo folks think we should only clean up in debug builds,
// but we're generally in the habit of trying to shut down as
// cleanly as possible even in production code, so call this
// cairo_debug_* function unconditionally.
//
// because cairo can assert and thus crash on shutdown, don't do this in
// release builds
#ifdef NS_FREE_PERMANENT_DATA
cairo_debug_reset_static_data();
#endif
}
gfxPlatform::~gfxPlatform() = default;
/* static */
already_AddRefed<DrawTarget> gfxPlatform::CreateDrawTargetForSurface(
gfxASurface* aSurface, const IntSize& aSize) {
SurfaceFormat format = aSurface->GetSurfaceFormat();
RefPtr<DrawTarget> drawTarget = Factory::CreateDrawTargetForCairoSurface(
aSurface->CairoSurface(), aSize, &format);
if (!drawTarget) {
gfxWarning() << "gfxPlatform::CreateDrawTargetForSurface failed in "
"CreateDrawTargetForCairoSurface";
return nullptr;
}
return drawTarget.forget();
}
cairo_user_data_key_t kSourceSurface;
/**
* Record the backend that was used to construct the SourceSurface.
* When getting the cached SourceSurface for a gfxASurface/DrawTarget pair,
* we check to make sure the DrawTarget's backend matches the backend
* for the cached SourceSurface, and only use it if they match. This
* can avoid expensive and unnecessary readbacks.
*/
struct SourceSurfaceUserData {
RefPtr<SourceSurface> mSrcSurface;
BackendType mBackendType;
};
static void SourceBufferDestroy(void* srcSurfUD) {
delete static_cast<SourceSurfaceUserData*>(srcSurfUD);
}
UserDataKey kThebesSurface;
struct DependentSourceSurfaceUserData {
RefPtr<gfxASurface> mSurface;
};
static void SourceSurfaceDestroyed(void* aData) {
delete static_cast<DependentSourceSurfaceUserData*>(aData);
}
void gfxPlatform::ClearSourceSurfaceForSurface(gfxASurface* aSurface) {
aSurface->SetData(&kSourceSurface, nullptr, nullptr);
}
/* static */
already_AddRefed<SourceSurface> gfxPlatform::GetSourceSurfaceForSurface(
RefPtr<DrawTarget> aTarget, gfxASurface* aSurface, bool aIsPlugin) {
if (!aSurface->CairoSurface() || aSurface->CairoStatus()) {
return nullptr;
}
if (!aTarget) {
aTarget = gfxPlatform::GetPlatform()->ScreenReferenceDrawTarget();
}
void* userData = aSurface->GetData(&kSourceSurface);
if (userData) {
SourceSurfaceUserData* surf = static_cast<SourceSurfaceUserData*>(userData);
if (surf->mSrcSurface->IsValid() &&
surf->mBackendType == aTarget->GetBackendType()) {
RefPtr<SourceSurface> srcSurface(surf->mSrcSurface);
return srcSurface.forget();
}
// We can just continue here as when setting new user data the destroy
// function will be called for the old user data.
}
SurfaceFormat format = aSurface->GetSurfaceFormat();
if (aTarget->GetBackendType() == BackendType::CAIRO) {
// If we're going to be used with a CAIRO DrawTarget, then just create a
// SourceSurfaceCairo since we don't know the underlying type of the CAIRO
// DrawTarget and can't pick a better surface type. Doing this also avoids
// readback of aSurface's surface into memory if, for example, aSurface
// wraps an xlib cairo surface (which can be important to avoid a major
// slowdown).
//
// We return here regardless of whether CreateSourceSurfaceFromNativeSurface
// succeeds or not since we don't expect to be able to do any better below
// if it fails.
//
// Note that the returned SourceSurfaceCairo holds a strong reference to
// the cairo_surface_t* that it wraps, which essencially means it holds a
// strong reference to aSurface since aSurface shares its
// cairo_surface_t*'s reference count variable. As a result we can't cache
// srcBuffer on aSurface (see below) since aSurface would then hold a
// strong reference back to srcBuffer, creating a reference loop and a
// memory leak. Not caching is fine since wrapping is cheap enough (no
// copying) so we can just wrap again next time we're called.
return Factory::CreateSourceSurfaceForCairoSurface(
aSurface->CairoSurface(), aSurface->GetSize(), format);
}
RefPtr<SourceSurface> srcBuffer;
// Currently no other DrawTarget types implement
// CreateSourceSurfaceFromNativeSurface
if (!srcBuffer) {
// If aSurface wraps data, we can create a SourceSurfaceRawData that wraps
// the same data, then optimize it for aTarget:
RefPtr<DataSourceSurface> surf = GetWrappedDataSourceSurface(aSurface);
if (surf) {
srcBuffer = aIsPlugin
? aTarget->OptimizeSourceSurfaceForUnknownAlpha(surf)
: aTarget->OptimizeSourceSurface(surf);
if (srcBuffer == surf) {
// GetWrappedDataSourceSurface returns a SourceSurface that holds a
// strong reference to aSurface since it wraps aSurface's data and
// needs it to stay alive. As a result we can't cache srcBuffer on
// aSurface (below) since aSurface would then hold a strong reference
// back to srcBuffer, creating a reference loop and a memory leak. Not
// caching is fine since wrapping is cheap enough (no copying) so we
// can just wrap again next time we're called.
//
// Note that the check below doesn't catch this since srcBuffer will be
// a SourceSurfaceRawData object (even if aSurface is not a
// gfxImageSurface object), which is why we need this separate check.
return srcBuffer.forget();
}
}
}
if (!srcBuffer) {
MOZ_ASSERT(aTarget->GetBackendType() != BackendType::CAIRO,
"We already tried CreateSourceSurfaceFromNativeSurface with a "
"DrawTargetCairo above");
// We've run out of performant options. We now try creating a SourceSurface
// using a temporary DrawTargetCairo and then optimizing it to aTarget's
// actual type. The CreateSourceSurfaceFromNativeSurface() call will
// likely create a DataSourceSurface (possibly involving copying and/or
// readback), and the OptimizeSourceSurface may well copy again and upload
// to the GPU. So, while this code path is rarely hit, hitting it may be
// very slow.
srcBuffer = Factory::CreateSourceSurfaceForCairoSurface(
aSurface->CairoSurface(), aSurface->GetSize(), format);
if (srcBuffer) {
srcBuffer = aTarget->OptimizeSourceSurface(srcBuffer);
}
}
if (!srcBuffer) {
return nullptr;
}
if ((srcBuffer->GetType() == SurfaceType::CAIRO &&
static_cast<SourceSurfaceCairo*>(srcBuffer.get())->GetSurface() ==
aSurface->CairoSurface()) ||
(srcBuffer->GetType() == SurfaceType::CAIRO_IMAGE &&
static_cast<DataSourceSurfaceCairo*>(srcBuffer.get())->GetSurface() ==
aSurface->CairoSurface())) {
// See the "Note that the returned SourceSurfaceCairo..." comment above.
return srcBuffer.forget();
}
// Add user data to aSurface so we can cache lookups in the future.
auto* srcSurfUD = new SourceSurfaceUserData;
srcSurfUD->mBackendType = aTarget->GetBackendType();
srcSurfUD->mSrcSurface = srcBuffer;
aSurface->SetData(&kSourceSurface, srcSurfUD, SourceBufferDestroy);
return srcBuffer.forget();
}
already_AddRefed<DataSourceSurface> gfxPlatform::GetWrappedDataSourceSurface(
gfxASurface* aSurface) {
RefPtr<gfxImageSurface> image = aSurface->GetAsImageSurface();
if (!image) {
return nullptr;
}
RefPtr<DataSourceSurface> result = Factory::CreateWrappingDataSourceSurface(
image->Data(), image->Stride(), image->GetSize(),
ImageFormatToSurfaceFormat(image->Format()));
if (!result) {
return nullptr;
}
// If we wrapped the underlying data of aSurface, then we need to add user
// data to make sure aSurface stays alive until we are done with the data.
auto* srcSurfUD = new DependentSourceSurfaceUserData;
srcSurfUD->mSurface = aSurface;
result->AddUserData(&kThebesSurface, srcSurfUD, SourceSurfaceDestroyed);
return result.forget();
}
void gfxPlatform::PopulateScreenInfo() {
nsCOMPtr<nsIScreenManager> manager =
do_GetService("@mozilla.org/gfx/screenmanager;1");
MOZ_ASSERT(manager, "failed to get nsIScreenManager");
nsCOMPtr<nsIScreen> screen;
manager->GetPrimaryScreen(getter_AddRefs(screen));
if (!screen) {
// This can happen in xpcshell, for instance
return;
}
screen->GetColorDepth(&mScreenDepth);
if (XRE_IsParentProcess()) {
gfxVars::SetScreenDepth(mScreenDepth);
}
int left, top;
screen->GetRect(&left, &top, &mScreenSize.width, &mScreenSize.height);
}
bool gfxPlatform::SupportsAzureContentForDrawTarget(DrawTarget* aTarget) {
if (!aTarget || !aTarget->IsValid()) {
return false;
}
return SupportsAzureContentForType(aTarget->GetBackendType());
}
void gfxPlatform::PurgeSkiaFontCache() {
if (gfxPlatform::GetPlatform()->GetDefaultContentBackend() ==
BackendType::SKIA) {
SkGraphics::PurgeFontCache();
}
}
already_AddRefed<DrawTarget> gfxPlatform::CreateDrawTargetForBackend(
BackendType aBackend, const IntSize& aSize, SurfaceFormat aFormat) {
// There is a bunch of knowledge in the gfxPlatform heirarchy about how to
// create the best offscreen surface for the current system and situation. We
// can easily take advantage of this for the Cairo backend, so that's what we
// do.
// mozilla::gfx::Factory can get away without having all this knowledge for
// now, but this might need to change in the future (using
// CreateOffscreenSurface() and CreateDrawTargetForSurface() for all
// backends).
if (aBackend == BackendType::CAIRO) {
RefPtr<gfxASurface> surf =
CreateOffscreenSurface(aSize, SurfaceFormatToImageFormat(aFormat));
if (!surf || surf->CairoStatus()) {
return nullptr;
}
return CreateDrawTargetForSurface(surf, aSize);
}
return Factory::CreateDrawTarget(aBackend, aSize, aFormat);
}
already_AddRefed<DrawTarget> gfxPlatform::CreateOffscreenCanvasDrawTarget(
const IntSize& aSize, SurfaceFormat aFormat) {
NS_ASSERTION(mPreferredCanvasBackend != BackendType::NONE, "No backend.");
// If we are using remote canvas we don't want to use acceleration in
// canvas DrawTargets we are not remoting, so we always use the fallback
// software one.
if (!gfxPlatform::UseRemoteCanvas() ||
!gfxPlatform::IsBackendAccelerated(mPreferredCanvasBackend)) {
RefPtr<DrawTarget> target =
CreateDrawTargetForBackend(mPreferredCanvasBackend, aSize, aFormat);
if (target || mFallbackCanvasBackend == BackendType::NONE) {
return target.forget();
}
}
#ifdef XP_WIN
// On Windows, the fallback backend (Cairo) should use its image backend.
return Factory::CreateDrawTarget(mFallbackCanvasBackend, aSize, aFormat);
#else
return CreateDrawTargetForBackend(mFallbackCanvasBackend, aSize, aFormat);
#endif
}
already_AddRefed<DrawTarget> gfxPlatform::CreateOffscreenContentDrawTarget(
const IntSize& aSize, SurfaceFormat aFormat, bool aFallback) {
BackendType backend = (aFallback) ? mSoftwareBackend : mContentBackend;
NS_ASSERTION(backend != BackendType::NONE, "No backend.");
RefPtr<DrawTarget> dt = CreateDrawTargetForBackend(backend, aSize, aFormat);
if (!dt) {
return nullptr;
}
// We'd prefer this to take proper care and return a CaptureDT, but for the
// moment since we can't and this means we're going to be drawing on the main
// thread force it's initialization. See bug 1526045 and bug 1521368.
dt->ClearRect(gfx::Rect());
if (!dt->IsValid()) {
return nullptr;
}
return dt.forget();
}
already_AddRefed<DrawTarget> gfxPlatform::CreateSimilarSoftwareDrawTarget(
DrawTarget* aDT, const IntSize& aSize, SurfaceFormat aFormat) {
RefPtr<DrawTarget> dt;
if (Factory::DoesBackendSupportDataDrawtarget(aDT->GetBackendType())) {
dt = aDT->CreateSimilarDrawTarget(aSize, aFormat);
} else {
BackendType backendType = BackendType::SKIA;
dt = Factory::CreateDrawTarget(backendType, aSize, aFormat);
}
return dt.forget();
}
/* static */
already_AddRefed<DrawTarget> gfxPlatform::CreateDrawTargetForData(
unsigned char* aData, const IntSize& aSize, int32_t aStride,
SurfaceFormat aFormat, bool aUninitialized) {
BackendType backendType = gfxVars::ContentBackend();
NS_ASSERTION(backendType != BackendType::NONE, "No backend.");
if (!Factory::DoesBackendSupportDataDrawtarget(backendType)) {
backendType = BackendType::SKIA;
}
RefPtr<DrawTarget> dt = Factory::CreateDrawTargetForData(
backendType, aData, aSize, aStride, aFormat, aUninitialized);
return dt.forget();
}
/* static */
BackendType gfxPlatform::BackendTypeForName(const nsCString& aName) {
if (aName.EqualsLiteral("cairo")) return BackendType::CAIRO;
if (aName.EqualsLiteral("skia")) return BackendType::SKIA;
if (aName.EqualsLiteral("direct2d")) return BackendType::DIRECT2D;
if (aName.EqualsLiteral("direct2d1.1")) return BackendType::DIRECT2D1_1;
return BackendType::NONE;
}
nsresult gfxPlatform::GetFontList(nsAtom* aLangGroup,
const nsACString& aGenericFamily,
nsTArray<nsString>& aListOfFonts) {
gfxPlatformFontList::PlatformFontList()->GetFontList(
aLangGroup, aGenericFamily, aListOfFonts);
return NS_OK;
}
nsresult gfxPlatform::UpdateFontList(bool aFullRebuild) {
gfxPlatformFontList::PlatformFontList()->UpdateFontList(aFullRebuild);
return NS_OK;
}
void gfxPlatform::GetStandardFamilyName(const nsCString& aFontName,
nsACString& aFamilyName) {
gfxPlatformFontList::PlatformFontList()->GetStandardFamilyName(aFontName,
aFamilyName);
}
nsAutoCString gfxPlatform::GetDefaultFontName(
const nsACString& aLangGroup, const nsACString& aGenericFamily) {
// To benefit from Return Value Optimization, all paths here must return
// this one variable:
nsAutoCString result;
auto* pfl = gfxPlatformFontList::PlatformFontList();
FamilyAndGeneric fam = pfl->GetDefaultFontFamily(aLangGroup, aGenericFamily);
if (!pfl->GetLocalizedFamilyName(fam.mFamily, result)) {
NS_WARNING("missing default font-family name");
}
return result;
}
bool gfxPlatform::DownloadableFontsEnabled() {
if (mAllowDownloadableFonts == UNINITIALIZED_VALUE) {
mAllowDownloadableFonts =
Preferences::GetBool(GFX_DOWNLOADABLE_FONTS_ENABLED, false);
}
return mAllowDownloadableFonts;
}
bool gfxPlatform::UseCmapsDuringSystemFallback() {
return StaticPrefs::gfx_font_rendering_fallback_always_use_cmaps();
}
bool gfxPlatform::OpenTypeSVGEnabled() {
return StaticPrefs::gfx_font_rendering_opentype_svg_enabled();
}
uint32_t gfxPlatform::WordCacheCharLimit() {
return StaticPrefs::gfx_font_rendering_wordcache_charlimit();
}
uint32_t gfxPlatform::WordCacheMaxEntries() {
return StaticPrefs::gfx_font_rendering_wordcache_maxentries();
}
bool gfxPlatform::UseGraphiteShaping() {
return StaticPrefs::gfx_font_rendering_graphite_enabled();
}
bool gfxPlatform::IsFontFormatSupported(
StyleFontFaceSourceFormatKeyword aFormatHint,
StyleFontFaceSourceTechFlags aTechFlags) {
// By default, font resources are assumed to be supported; but if the format
// hint or technology flags explicitly indicate something we don't support,
// then return false.
switch (aFormatHint) {
case StyleFontFaceSourceFormatKeyword::None:
break;
case StyleFontFaceSourceFormatKeyword::Collection:
return false;
case StyleFontFaceSourceFormatKeyword::Opentype:
case StyleFontFaceSourceFormatKeyword::Truetype:
break;
case StyleFontFaceSourceFormatKeyword::EmbeddedOpentype:
return false;
case StyleFontFaceSourceFormatKeyword::Svg:
return false;
case StyleFontFaceSourceFormatKeyword::Woff:
break;
case StyleFontFaceSourceFormatKeyword::Woff2:
break;
case StyleFontFaceSourceFormatKeyword::Unknown:
return false;
default:
MOZ_ASSERT_UNREACHABLE("bad format hint!");
return false;
}
StyleFontFaceSourceTechFlags unsupportedTechnologies =
StyleFontFaceSourceTechFlags::INCREMENTAL |
StyleFontFaceSourceTechFlags::COLOR_SBIX;
if (!StaticPrefs::gfx_downloadable_fonts_keep_color_bitmaps()) {
unsupportedTechnologies |= StyleFontFaceSourceTechFlags::COLOR_CBDT;
}
if (!StaticPrefs::gfx_font_rendering_colr_v1_enabled()) {
unsupportedTechnologies |= StyleFontFaceSourceTechFlags::COLOR_COLRV1;
}
if (!StaticPrefs::layout_css_font_palette_enabled()) {
unsupportedTechnologies |= StyleFontFaceSourceTechFlags::PALETTES;
}
if (!StaticPrefs::layout_css_font_variations_enabled()) {
unsupportedTechnologies |= StyleFontFaceSourceTechFlags::VARIATIONS;
}
if (aTechFlags & unsupportedTechnologies) {
return false;
}
return true;
}
bool gfxPlatform::IsKnownIconFontFamily(const nsAtom* aFamilyName) const {
return gfxPlatformFontList::PlatformFontList()->IsKnownIconFontFamily(
aFamilyName);
}
gfxFontEntry* gfxPlatform::LookupLocalFont(nsPresContext* aPresContext,
const nsACString& aFontName,
WeightRange aWeightForEntry,
StretchRange aStretchForEntry,
SlantStyleRange aStyleForEntry) {
return gfxPlatformFontList::PlatformFontList()->LookupLocalFont(
aPresContext, aFontName, aWeightForEntry, aStretchForEntry,
aStyleForEntry);
}
gfxFontEntry* gfxPlatform::MakePlatformFont(const nsACString& aFontName,
WeightRange aWeightForEntry,
StretchRange aStretchForEntry,
SlantStyleRange aStyleForEntry,
const uint8_t* aFontData,
uint32_t aLength) {
return gfxPlatformFontList::PlatformFontList()->MakePlatformFont(
aFontName, aWeightForEntry, aStretchForEntry, aStyleForEntry, aFontData,
aLength);
}
BackendPrefsData gfxPlatform::GetBackendPrefs() const {
BackendPrefsData data;
data.mCanvasBitmask = BackendTypeBit(BackendType::SKIA);
data.mContentBitmask = BackendTypeBit(BackendType::SKIA);
#ifdef MOZ_WIDGET_GTK
data.mCanvasBitmask |= BackendTypeBit(BackendType::CAIRO);
data.mContentBitmask |= BackendTypeBit(BackendType::CAIRO);
#endif
data.mCanvasDefault = BackendType::SKIA;
data.mContentDefault = BackendType::SKIA;
return data;
}
void gfxPlatform::InitBackendPrefs(BackendPrefsData&& aPrefsData) {
mPreferredCanvasBackend = GetCanvasBackendPref(aPrefsData.mCanvasBitmask);
if (mPreferredCanvasBackend == BackendType::NONE) {
mPreferredCanvasBackend = aPrefsData.mCanvasDefault;
}
if (mPreferredCanvasBackend == BackendType::DIRECT2D1_1) {
// Falling back to D2D 1.0 won't help us here. When D2D 1.1 DT creation
// fails it means the surface was too big or there's something wrong with
// the device. D2D 1.0 will encounter a similar situation.
mFallbackCanvasBackend = GetCanvasBackendPref(
aPrefsData.mCanvasBitmask & ~(BackendTypeBit(mPreferredCanvasBackend) |
BackendTypeBit(BackendType::DIRECT2D)));
} else {
mFallbackCanvasBackend = GetCanvasBackendPref(
aPrefsData.mCanvasBitmask & ~BackendTypeBit(mPreferredCanvasBackend));
}
mContentBackendBitmask = aPrefsData.mContentBitmask;
mContentBackend = GetContentBackendPref(mContentBackendBitmask);
if (mContentBackend == BackendType::NONE) {
mContentBackend = aPrefsData.mContentDefault;
// mContentBackendBitmask is our canonical reference for supported
// backends so we need to add the default if we are using it and
// overriding the prefs.
mContentBackendBitmask |= BackendTypeBit(aPrefsData.mContentDefault);
}
uint32_t swBackendBits = BackendTypeBit(BackendType::SKIA);
#ifdef MOZ_WIDGET_GTK
swBackendBits |= BackendTypeBit(BackendType::CAIRO);
#endif
mSoftwareBackend = GetContentBackendPref(swBackendBits);
if (mSoftwareBackend == BackendType::NONE) {
mSoftwareBackend = BackendType::SKIA;
}
// If we don't have a fallback canvas backend then use the same software
// fallback as content.
if (mFallbackCanvasBackend == BackendType::NONE) {
mFallbackCanvasBackend = mSoftwareBackend;
}
if (XRE_IsParentProcess()) {
gfxVars::SetContentBackend(mContentBackend);
gfxVars::SetSoftwareBackend(mSoftwareBackend);
}
}
/* static */
BackendType gfxPlatform::GetCanvasBackendPref(uint32_t aBackendBitmask) {
return GetBackendPref("gfx.canvas.azure.backends", aBackendBitmask);
}
/* static */
BackendType gfxPlatform::GetContentBackendPref(uint32_t& aBackendBitmask) {
return GetBackendPref("gfx.content.azure.backends", aBackendBitmask);
}
/* static */
BackendType gfxPlatform::GetBackendPref(const char* aBackendPrefName,
uint32_t& aBackendBitmask) {
nsTArray<nsCString> backendList;
nsAutoCString prefString;
if (NS_SUCCEEDED(Preferences::GetCString(aBackendPrefName, prefString))) {
ParseString(prefString, ',', backendList);
}
uint32_t allowedBackends = 0;
BackendType result = BackendType::NONE;
for (uint32_t i = 0; i < backendList.Length(); ++i) {
BackendType type = BackendTypeForName(backendList[i]);
if (BackendTypeBit(type) & aBackendBitmask) {
allowedBackends |= BackendTypeBit(type);
if (result == BackendType::NONE) {
result = type;
}
}
}
aBackendBitmask = allowedBackends;
return result;
}
bool gfxPlatform::InSafeMode() {
static bool sSafeModeInitialized = false;
static bool sInSafeMode = false;
if (!sSafeModeInitialized) {
sSafeModeInitialized = true;
nsCOMPtr<nsIXULRuntime> xr = do_GetService("@mozilla.org/xre/runtime;1");
if (xr) {
xr->GetInSafeMode(&sInSafeMode);
}
}
return sInSafeMode;
}
bool gfxPlatform::OffMainThreadCompositingEnabled() {
return UsesOffMainThreadCompositing();
}
void gfxPlatform::SetCMSModeOverride(CMSMode aMode) {
MOZ_ASSERT(gCMSInitialized);
gCMSMode = aMode;
}
int gfxPlatform::GetRenderingIntent() {
// StaticPrefList.yaml is using 0 as the default for the rendering
// intent preference, based on that being the value for
// QCMS_INTENT_DEFAULT. Assert here to catch if that ever
// changes and we can then figure out what to do about it.
MOZ_ASSERT(QCMS_INTENT_DEFAULT == 0);
/* Try to query the pref system for a rendering intent. */
int32_t pIntent = StaticPrefs::gfx_color_management_rendering_intent();
if ((pIntent < QCMS_INTENT_MIN) || (pIntent > QCMS_INTENT_MAX)) {
/* If the pref is out of range, use embedded profile. */
pIntent = -1;
}
return pIntent;
}
DeviceColor gfxPlatform::TransformPixel(const sRGBColor& in,
qcms_transform* transform) {
if (transform) {
/* we want the bytes in RGB order */
#ifdef IS_LITTLE_ENDIAN
/* ABGR puts the bytes in |RGBA| order on little endian */
uint32_t packed = in.ToABGR();
qcms_transform_data(transform, (uint8_t*)&packed, (uint8_t*)&packed, 1);
auto out = DeviceColor::FromABGR(packed);
#else
/* ARGB puts the bytes in |ARGB| order on big endian */
uint32_t packed = in.UnusualToARGB();
/* add one to move past the alpha byte */
qcms_transform_data(transform, (uint8_t*)&packed + 1, (uint8_t*)&packed + 1,
1);
auto out = DeviceColor::UnusualFromARGB(packed);
#endif
out.a = in.a;
return out;
}
return DeviceColor(in.r, in.g, in.b, in.a);
}
nsTArray<uint8_t> gfxPlatform::GetPrefCMSOutputProfileData() {
const auto mirror = StaticPrefs::gfx_color_management_display_profile();
const auto fname = *mirror;
if (fname == "") {
return nsTArray<uint8_t>();
}
void* mem = nullptr;
size_t size = 0;
qcms_data_from_path(fname.get(), &mem, &size);
nsTArray<uint8_t> result;
if (mem) {
result.AppendElements(static_cast<uint8_t*>(mem), size);
free(mem);
}
return result;
}
const mozilla::gfx::ContentDeviceData* gfxPlatform::GetInitContentDeviceData() {
return gContentDeviceInitData;
}
CMSMode GfxColorManagementMode() {
const auto mode = StaticPrefs::gfx_color_management_mode();
if (mode >= 0 && mode < UnderlyingValue(CMSMode::AllCount)) {
return CMSMode(mode);
}
return CMSMode::Off;
}
void gfxPlatform::InitializeCMS() {
if (gCMSInitialized) {
return;
}
if (XRE_IsGPUProcess()) {
// Colors in the GPU process should already be managed, so we don't need to
// perform color management there.
gCMSInitialized = true;
return;
}
MOZ_DIAGNOSTIC_ASSERT(NS_IsMainThread(),
"CMS should be initialized on the main thread");
if (MOZ_UNLIKELY(!NS_IsMainThread())) {
return;
}
gCMSMode = GfxColorManagementMode();
gCMSsRGBProfile = qcms_profile_sRGB();
/* Determine if we're using the internal override to force sRGB as
an output profile for reftests. See Bug 452125.
Note that we don't normally (outside of tests) set a default value
of this preference, which means nsIPrefBranch::GetBoolPref will
typically throw (and leave its out-param untouched).
*/
if (StaticPrefs::gfx_color_management_force_srgb() ||
StaticPrefs::gfx_color_management_native_srgb()) {
gCMSOutputProfile = gCMSsRGBProfile;
}
if (!gCMSOutputProfile) {
nsTArray<uint8_t> outputProfileData =
gfxPlatform::GetPlatform()->GetPlatformCMSOutputProfileData();
if (!outputProfileData.IsEmpty()) {
gCMSOutputProfile = qcms_profile_from_memory_curves_only(
outputProfileData.Elements(), outputProfileData.Length());
}
}
/* Determine if the profile looks bogus. If so, close the profile
* and use sRGB instead. See bug 460629, */
if (gCMSOutputProfile && qcms_profile_is_bogus(gCMSOutputProfile)) {
NS_ASSERTION(gCMSOutputProfile != gCMSsRGBProfile,
"Builtin sRGB profile tagged as bogus!!!");
qcms_profile_release(gCMSOutputProfile);
gCMSOutputProfile = nullptr;
}
if (!gCMSOutputProfile) {
gCMSOutputProfile = gCMSsRGBProfile;
}
/* Precache the LUT16 Interpolations for the output profile. See
bug 444661 for details. */
qcms_profile_precache_output_transform(gCMSOutputProfile);
// Create the RGB transform.
gCMSRGBTransform =
qcms_transform_create(gCMSsRGBProfile, QCMS_DATA_RGB_8, gCMSOutputProfile,
QCMS_DATA_RGB_8, QCMS_INTENT_PERCEPTUAL);
// And the inverse.
gCMSInverseRGBTransform =
qcms_transform_create(gCMSOutputProfile, QCMS_DATA_RGB_8, gCMSsRGBProfile,
QCMS_DATA_RGB_8, QCMS_INTENT_PERCEPTUAL);
// The RGBA transform.
gCMSRGBATransform = qcms_transform_create(gCMSsRGBProfile, QCMS_DATA_RGBA_8,
gCMSOutputProfile, QCMS_DATA_RGBA_8,
QCMS_INTENT_PERCEPTUAL);
// And the BGRA one.
gCMSBGRATransform = qcms_transform_create(gCMSsRGBProfile, QCMS_DATA_BGRA_8,
gCMSOutputProfile, QCMS_DATA_BGRA_8,
QCMS_INTENT_PERCEPTUAL);
// FIXME: We only enable iccv4 after we create the platform profile, to
// wallpaper over bug 1697787.
//
// This should happen ideally right after setting gCMSMode.
if (StaticPrefs::gfx_color_management_enablev4()) {
qcms_enable_iccv4();
}
gCMSInitialized = true;
}
qcms_transform* gfxPlatform::GetCMSOSRGBATransform() {
switch (SurfaceFormat::OS_RGBA) {
case SurfaceFormat::B8G8R8A8:
return GetCMSBGRATransform();
case SurfaceFormat::R8G8B8A8:
return GetCMSRGBATransform();
default:
// We do not support color management with big endian.
return nullptr;
}
}
qcms_data_type gfxPlatform::GetCMSOSRGBAType() {
switch (SurfaceFormat::OS_RGBA) {
case SurfaceFormat::B8G8R8A8:
return QCMS_DATA_BGRA_8;
case SurfaceFormat::R8G8B8A8:
return QCMS_DATA_RGBA_8;
default:
// We do not support color management with big endian.
return QCMS_DATA_RGBA_8;
}
}
/* Shuts down various transforms and profiles for CMS. */
void gfxPlatform::ShutdownCMS() {
if (gCMSRGBTransform) {
qcms_transform_release(gCMSRGBTransform);
gCMSRGBTransform = nullptr;
}
if (gCMSInverseRGBTransform) {
qcms_transform_release(gCMSInverseRGBTransform);
gCMSInverseRGBTransform = nullptr;
}
if (gCMSRGBATransform) {
qcms_transform_release(gCMSRGBATransform);
gCMSRGBATransform = nullptr;
}
if (gCMSBGRATransform) {
qcms_transform_release(gCMSBGRATransform);
gCMSBGRATransform = nullptr;
}
if (gCMSOutputProfile) {
qcms_profile_release(gCMSOutputProfile);
// handle the aliased case
if (gCMSsRGBProfile == gCMSOutputProfile) {
gCMSsRGBProfile = nullptr;
}
gCMSOutputProfile = nullptr;
}
if (gCMSsRGBProfile) {
qcms_profile_release(gCMSsRGBProfile);
gCMSsRGBProfile = nullptr;
}
// Reset the state variables
gCMSMode = CMSMode::Off;
gCMSInitialized = false;
}
uint32_t gfxPlatform::GetBidiNumeralOption() {
return StaticPrefs::bidi_numeral();
}
/* static */
void gfxPlatform::FlushFontAndWordCaches() {
gfxFontCache* fontCache = gfxFontCache::GetCache();
if (fontCache) {
fontCache->Flush();
}
gfxPlatform::PurgeSkiaFontCache();
}
/* static */
void gfxPlatform::ForceGlobalReflow(NeedsReframe aNeedsReframe,
BroadcastToChildren aBroadcastToChildren) {
MOZ_ASSERT(NS_IsMainThread());
const bool reframe = aNeedsReframe == NeedsReframe::Yes;
// Send a notification that will be observed by PresShells in this process
// only.
if (nsCOMPtr<nsIObserverService> obs = services::GetObserverService()) {
char16_t needsReframe[] = {char16_t(reframe), 0};
obs->NotifyObservers(nullptr, "font-info-updated", needsReframe);
}
if (XRE_IsParentProcess() &&
aBroadcastToChildren == BroadcastToChildren::Yes) {
// Propagate the change to child processes.
for (auto* process :
dom::ContentParent::AllProcesses(dom::ContentParent::eLive)) {
Unused << process->SendForceGlobalReflow(reframe);
}
}
}
void gfxPlatform::FontsPrefsChanged(const char* aPref) {
NS_ASSERTION(aPref != nullptr, "null preference");
if (!strcmp(GFX_DOWNLOADABLE_FONTS_ENABLED, aPref)) {
mAllowDownloadableFonts = UNINITIALIZED_VALUE;
} else if (!strcmp(GFX_PREF_WORD_CACHE_CHARLIMIT, aPref) ||
!strcmp(GFX_PREF_WORD_CACHE_MAXENTRIES, aPref) ||
!strcmp(GFX_PREF_GRAPHITE_SHAPING, aPref)) {
FlushFontAndWordCaches();
} else if (
#if defined(XP_MACOSX)
!strcmp(GFX_PREF_CORETEXT_SHAPING, aPref) ||
#endif
!strcmp("gfx.font_rendering.ahem_antialias_none", aPref)) {
FlushFontAndWordCaches();
} else if (!strcmp(GFX_PREF_OPENTYPE_SVG, aPref)) {
gfxFontCache::GetCache()->Flush();
gfxFontCache::GetCache()->NotifyGlyphsChanged();
}
}
mozilla::LogModule* gfxPlatform::GetLog(eGfxLog aWhichLog) {
// logs shared across gfx
static LazyLogModule sFontlistLog("fontlist");
static LazyLogModule sFontInitLog("fontinit");
static LazyLogModule sTextrunLog("textrun");
static LazyLogModule sTextrunuiLog("textrunui");
static LazyLogModule sCmapDataLog("cmapdata");
static LazyLogModule sTextPerfLog("textperf");
switch (aWhichLog) {
case eGfxLog_fontlist:
return sFontlistLog;
case eGfxLog_fontinit:
return sFontInitLog;
case eGfxLog_textrun:
return sTextrunLog;
case eGfxLog_textrunui:
return sTextrunuiLog;
case eGfxLog_cmapdata:
return sCmapDataLog;
case eGfxLog_textperf:
return sTextPerfLog;
}
MOZ_ASSERT_UNREACHABLE("Unexpected log type");
return nullptr;
}
RefPtr<mozilla::gfx::DrawTarget> gfxPlatform::ScreenReferenceDrawTarget() {
MOZ_ASSERT_IF(XRE_IsContentProcess(), NS_IsMainThread());
return (mScreenReferenceDrawTarget)
? mScreenReferenceDrawTarget
: gPlatform->CreateOffscreenContentDrawTarget(
IntSize(1, 1), SurfaceFormat::B8G8R8A8, true);
}
/* static */ RefPtr<mozilla::gfx::DrawTarget>
gfxPlatform::ThreadLocalScreenReferenceDrawTarget() {
if (NS_IsMainThread() && gPlatform) {
return gPlatform->ScreenReferenceDrawTarget();
}
gfxPlatformWorker* platformWorker = gfxPlatformWorker::Get();
if (platformWorker) {
return platformWorker->ScreenReferenceDrawTarget();
}
return Factory::CreateDrawTarget(BackendType::SKIA, IntSize(1, 1),
SurfaceFormat::B8G8R8A8);
}
mozilla::gfx::SurfaceFormat gfxPlatform::Optimal2DFormatForContent(
gfxContentType aContent) {
switch (aContent) {
case gfxContentType::COLOR:
switch (GetOffscreenFormat()) {
case SurfaceFormat::A8R8G8B8_UINT32:
return mozilla::gfx::SurfaceFormat::B8G8R8A8;
case SurfaceFormat::X8R8G8B8_UINT32:
return mozilla::gfx::SurfaceFormat::B8G8R8X8;
case SurfaceFormat::R5G6B5_UINT16:
return mozilla::gfx::SurfaceFormat::R5G6B5_UINT16;
default:
MOZ_ASSERT_UNREACHABLE(
"unknown gfxImageFormat for "
"gfxContentType::COLOR");
return mozilla::gfx::SurfaceFormat::B8G8R8A8;
}
case gfxContentType::ALPHA:
return mozilla::gfx::SurfaceFormat::A8;
case gfxContentType::COLOR_ALPHA:
return mozilla::gfx::SurfaceFormat::B8G8R8A8;
default:
MOZ_ASSERT_UNREACHABLE("unknown gfxContentType");
return mozilla::gfx::SurfaceFormat::B8G8R8A8;
}
}
gfxImageFormat gfxPlatform::OptimalFormatForContent(gfxContentType aContent) {
switch (aContent) {
case gfxContentType::COLOR:
return GetOffscreenFormat();
case gfxContentType::ALPHA:
return SurfaceFormat::A8;
case gfxContentType::COLOR_ALPHA:
return SurfaceFormat::A8R8G8B8_UINT32;
default:
MOZ_ASSERT_UNREACHABLE("unknown gfxContentType");
return SurfaceFormat::A8R8G8B8_UINT32;
}
}
/**
* There are a number of layers acceleration (or layers in general) preferences
* that should be consistent for the lifetime of the application (bug 840967).
* As such, we will evaluate them all as soon as one of them is evaluated
* and remember the values. Changing these preferences during the run will
* not have any effect until we restart.
*/
static mozilla::Atomic<bool> sLayersSupportsHardwareVideoDecoding(false);
static bool sLayersHardwareVideoDecodingFailed = false;
static mozilla::Atomic<bool> sLayersAccelerationPrefsInitialized(false);
static void VideoDecodingFailedChangedCallback(const char* aPref, void*) {
sLayersHardwareVideoDecodingFailed = Preferences::GetBool(aPref, false);
gfxPlatform::GetPlatform()->UpdateCanUseHardwareVideoDecoding();
}
void gfxPlatform::UpdateCanUseHardwareVideoDecoding() {
if (XRE_IsParentProcess()) {
gfxVars::SetCanUseHardwareVideoDecoding(CanUseHardwareVideoDecoding());
}
}
void gfxPlatform::UpdateForceSubpixelAAWherePossible() {
bool forceSubpixelAAWherePossible =
StaticPrefs::gfx_webrender_quality_force_subpixel_aa_where_possible();
gfxVars::SetForceSubpixelAAWherePossible(forceSubpixelAAWherePossible);
}
void gfxPlatform::InitAcceleration() {
if (sLayersAccelerationPrefsInitialized) {
return;
}
InitCompositorAccelerationPrefs();
// If this is called for the first time on a non-main thread, we're screwed.
// At the moment there's no explicit guarantee that the main thread calls
// this before the compositor thread, but let's at least make the assumption
// explicit.
MOZ_ASSERT(NS_IsMainThread(), "can only initialize prefs on the main thread");
#ifndef MOZ_WIDGET_GTK
nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
nsCString discardFailureId;
int32_t status;
#endif
if (XRE_IsParentProcess()) {
gfxVars::SetBrowserTabsRemoteAutostart(BrowserTabsRemoteAutostart());
gfxVars::SetOffscreenFormat(GetOffscreenFormat());
gfxVars::SetRequiresAcceleratedGLContextForCompositorOGL(
RequiresAcceleratedGLContextForCompositorOGL());
#ifdef XP_WIN
if (NS_SUCCEEDED(
gfxInfo->GetFeatureStatus(nsIGfxInfo::FEATURE_D3D11_KEYED_MUTEX,
discardFailureId, &status))) {
gfxVars::SetAllowD3D11KeyedMutex(status == nsIGfxInfo::FEATURE_STATUS_OK);
} else {
// If we couldn't properly evaluate the status, err on the side
// of caution and give this functionality to the user.
gfxCriticalNote << "Cannot evaluate keyed mutex feature status";
gfxVars::SetAllowD3D11KeyedMutex(true);
}
if (StaticPrefs::gfx_direct3d11_use_double_buffering()) {
gfxVars::SetUseDoubleBufferingWithCompositor(true);
}
#endif
}
if (StaticPrefs::media_hardware_video_decoding_enabled_AtStartup()) {
#ifdef MOZ_WIDGET_GTK
sLayersSupportsHardwareVideoDecoding =
gfxPlatformGtk::GetPlatform()->InitVAAPIConfig(
StaticPrefs::
media_hardware_video_decoding_force_enabled_AtStartup() ||
StaticPrefs::media_ffmpeg_vaapi_enabled_AtStartup());
#else
if (
# ifdef XP_WIN
Preferences::GetBool("media.wmf.dxva.enabled", true) &&
# endif
NS_SUCCEEDED(gfxInfo->GetFeatureStatus(
nsIGfxInfo::FEATURE_HARDWARE_VIDEO_DECODING, discardFailureId,
&status))) {
if (status == nsIGfxInfo::FEATURE_STATUS_OK ||
StaticPrefs::
media_hardware_video_decoding_force_enabled_AtStartup()) {
sLayersSupportsHardwareVideoDecoding = true;
}
}
#endif
} else if (XRE_IsParentProcess()) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::HARDWARE_VIDEO_DECODING);
feature.EnableByDefault();
feature.UserDisable("User disabled via pref",
"FEATURE_HARDWARE_VIDEO_DECODING_PREF_DISABLED"_ns);
}
sLayersAccelerationPrefsInitialized = true;
if (XRE_IsParentProcess()) {
Preferences::RegisterCallbackAndCall(
VideoDecodingFailedChangedCallback,
"media.hardware-video-decoding.failed");
InitGPUProcessPrefs();
FeatureState& feature = gfxConfig::GetFeature(Feature::REMOTE_CANVAS);
feature.SetDefault(StaticPrefs::gfx_canvas_remote_AtStartup(),
FeatureStatus::Disabled, "Disabled via pref");
if (!gfxConfig::IsEnabled(Feature::GPU_PROCESS) &&
!StaticPrefs::gfx_canvas_remote_allow_in_parent_AtStartup()) {
feature.Disable(FeatureStatus::UnavailableNoGpuProcess,
"Disabled without GPU process",
"FEATURE_REMOTE_CANVAS_NO_GPU_PROCESS"_ns);
}
#ifndef XP_WIN
gfxConfig::ForceDisable(Feature::REMOTE_CANVAS, FeatureStatus::Blocked,
"Platform not supported",
"FEATURE_REMOTE_CANVAS_NOT_WINDOWS"_ns);
#endif
gfxVars::SetRemoteCanvasEnabled(feature.IsEnabled());
}
}
void gfxPlatform::InitGPUProcessPrefs() {
// We want to hide this from about:support, so only set a default if the
// pref is known to be true.
if (!StaticPrefs::layers_gpu_process_enabled_AtStartup() &&
!StaticPrefs::layers_gpu_process_force_enabled_AtStartup()) {
return;
}
FeatureState& gpuProc = gfxConfig::GetFeature(Feature::GPU_PROCESS);
// We require E10S - otherwise, there is very little benefit to the GPU
// process, since the UI process must still use acceleration for
// performance.
if (!BrowserTabsRemoteAutostart()) {
gpuProc.DisableByDefault(FeatureStatus::Unavailable,
"Multi-process mode is not enabled",
"FEATURE_FAILURE_NO_E10S"_ns);
} else {
gpuProc.SetDefaultFromPref(
StaticPrefs::GetPrefName_layers_gpu_process_enabled(), true,
StaticPrefs::GetPrefDefault_layers_gpu_process_enabled());
}
if (StaticPrefs::layers_gpu_process_force_enabled_AtStartup()) {
gpuProc.UserForceEnable("User force-enabled via pref");
}
nsCString message;
nsCString failureId;
if (!gfxPlatform::IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_GPU_PROCESS,
&message, failureId)) {
gpuProc.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
return;
}
if (IsHeadless()) {
gpuProc.ForceDisable(FeatureStatus::Blocked, "Headless mode is enabled",
"FEATURE_FAILURE_HEADLESS_MODE"_ns);
return;
}
if (InSafeMode()) {
gpuProc.ForceDisable(FeatureStatus::Blocked, "Safe-mode is enabled",
"FEATURE_FAILURE_SAFE_MODE"_ns);
return;
}
InitPlatformGPUProcessPrefs();
}
void gfxPlatform::InitCompositorAccelerationPrefs() {
const char* acceleratedEnv = PR_GetEnv("MOZ_ACCELERATED");
FeatureState& feature = gfxConfig::GetFeature(Feature::HW_COMPOSITING);
// Base value - does the platform allow acceleration?
if (feature.SetDefault(AccelerateLayersByDefault(), FeatureStatus::Blocked,
"Acceleration blocked by platform")) {
if (StaticPrefs::
layers_acceleration_disabled_AtStartup_DoNotUseDirectly()) {
feature.UserDisable("Disabled by layers.acceleration.disabled=true",
"FEATURE_FAILURE_COMP_PREF"_ns);
} else if (acceleratedEnv && *acceleratedEnv == '0') {
feature.UserDisable("Disabled by envvar", "FEATURE_FAILURE_COMP_ENV"_ns);
}
} else {
if (acceleratedEnv && *acceleratedEnv == '1') {
feature.UserEnable("Enabled by envvar");
}
}
// This has specific meaning elsewhere, so we always record it.
if (StaticPrefs::
layers_acceleration_force_enabled_AtStartup_DoNotUseDirectly()) {
feature.UserForceEnable("Force-enabled by pref");
}
// Safe, headless, and record/replay modes override everything.
if (InSafeMode()) {
feature.ForceDisable(FeatureStatus::Blocked,
"Acceleration blocked by safe-mode",
"FEATURE_FAILURE_COMP_SAFEMODE"_ns);
}
if (IsHeadless()) {
feature.ForceDisable(FeatureStatus::Blocked,
"Acceleration blocked by headless mode",
"FEATURE_FAILURE_COMP_HEADLESSMODE"_ns);
}
}
/*static*/
bool gfxPlatform::WebRenderPrefEnabled() {
return StaticPrefs::gfx_webrender_all_AtStartup();
}
/*static*/
bool gfxPlatform::WebRenderEnvvarEnabled() {
const char* env = PR_GetEnv("MOZ_WEBRENDER");
return (env && *env == '1');
}
/* static */ const char* gfxPlatform::WebRenderResourcePathOverride() {
const char* resourcePath = PR_GetEnv("WR_RESOURCE_PATH");
if (!resourcePath || resourcePath[0] == '\0') {
return nullptr;
}
return resourcePath;
}
void gfxPlatform::InitWebRenderConfig() {
bool prefEnabled = WebRenderPrefEnabled();
bool envvarEnabled = WebRenderEnvvarEnabled();
// WR? WR+ => means WR was enabled on qualified hardware
// WR! WR+ => means WR was enabled via gfx.webrender.{all,enabled} or
// envvar, possibly on unqualified hardware
// In all cases WR- means WR was not enabled, for one of many possible
// reasons. Prior to bug 1523788 landing the gfx.webrender.{all,enabled}
// prefs only worked on Nightly so keep that in mind when looking at older
// crash reports.
ScopedGfxFeatureReporter reporter("WR", prefEnabled || envvarEnabled);
if (!XRE_IsParentProcess()) {
// The parent process runs through all the real decision-making code
// later in this function. For other processes we still want to report
// the state of the feature for crash reports.
reporter.SetSuccessful();
return;
}
// Update the gfxConfig feature states.
gfxConfigManager manager;
manager.Init();
manager.ConfigureWebRender();
bool hasHardware = gfxConfig::IsEnabled(Feature::WEBRENDER);
#ifdef MOZ_WIDGET_GTK
// We require a hardware driver to back the GL context unless the user forced
// on WebRender.
if (!gfxConfig::IsForcedOnByUser(Feature::WEBRENDER) &&
StaticPrefs::gfx_webrender_reject_software_driver_AtStartup()) {
gfxVars::SetWebRenderRequiresHardwareDriver(true);
}
#endif
#ifdef XP_WIN
if (gfxConfig::IsEnabled(Feature::WEBRENDER_ANGLE)) {
gfxVars::SetUseWebRenderANGLE(true);
}
#endif
if (gfxConfig::IsEnabled(Feature::WEBRENDER_SHADER_CACHE)) {
gfxVars::SetUseWebRenderProgramBinaryDisk(true);
}
gfxVars::SetUseWebRenderOptimizedShaders(
gfxConfig::IsEnabled(Feature::WEBRENDER_OPTIMIZED_SHADERS));
gfxVars::SetUseSoftwareWebRender(!hasHardware);
Preferences::RegisterPrefixCallbackAndCall(SwapIntervalPrefChangeCallback,
"gfx.swap-interval");
reporter.SetSuccessful();
Preferences::RegisterPrefixCallbackAndCall(WebRenderDebugPrefChangeCallback,
WR_DEBUG_PREF);
RegisterWebRenderBoolParamCallback();
Preferences::RegisterPrefixCallbackAndCall(
WebRendeProfilerUIPrefChangeCallback, "gfx.webrender.debug.profiler-ui");
Preferences::RegisterCallback(
WebRenderQualityPrefChangeCallback,
nsDependentCString(
StaticPrefs::
GetPrefName_gfx_webrender_quality_force_subpixel_aa_where_possible()));
Preferences::RegisterCallback(
WebRenderBatchingPrefChangeCallback,
nsDependentCString(
StaticPrefs::GetPrefName_gfx_webrender_batching_lookback()));
Preferences::RegisterCallbackAndCall(
WebRenderBlobTileSizePrefChangeCallback,
nsDependentCString(
StaticPrefs::GetPrefName_gfx_webrender_blob_tile_size()));
Preferences::RegisterCallbackAndCall(
WebRenderUploadThresholdPrefChangeCallback,
nsDependentCString(
StaticPrefs::GetPrefName_gfx_webrender_batched_upload_threshold()));
if (WebRenderResourcePathOverride()) {
CrashReporter::AnnotateCrashReport(
CrashReporter::Annotation::IsWebRenderResourcePathOverridden, true);
}
UpdateForceSubpixelAAWherePossible();
#if defined(MOZ_WIDGET_ANDROID) || defined(MOZ_WIDGET_GTK)
if (StaticPrefs::gfx_webrender_software_opengl_AtStartup()) {
gfxVars::SetAllowSoftwareWebRenderOGL(true);
}
#endif
#ifdef XP_WIN
if (gfxConfig::IsEnabled(Feature::WEBRENDER_DCOMP_PRESENT)) {
gfxVars::SetUseWebRenderDCompWin(true);
}
if (StaticPrefs::gfx_webrender_software_d3d11_AtStartup()) {
gfxVars::SetAllowSoftwareWebRenderD3D11(true);
}
const bool overlaySupported =
IsWin10AnniversaryUpdateOrLater() &&
gfxConfig::IsEnabled(Feature::WEBRENDER_COMPOSITOR);
MOZ_ASSERT_IF(overlaySupported,
gfxConfig::IsEnabled(Feature::WEBRENDER_DCOMP_PRESENT));
bool useVideoHwOverlay = false;
if (StaticPrefs::gfx_webrender_dcomp_video_hw_overlay_win_AtStartup()) {
if (overlaySupported) {
useVideoHwOverlay = true;
}
if (useVideoHwOverlay &&
!StaticPrefs::
gfx_webrender_dcomp_video_hw_overlay_win_force_enabled_AtStartup()) {
nsCString failureId;
int32_t status;
const nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
if (NS_FAILED(gfxInfo->GetFeatureStatus(nsIGfxInfo::FEATURE_VIDEO_OVERLAY,
failureId, &status))) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_HARDWARE_OVERLAY);
feature.DisableByDefault(FeatureStatus::BlockedNoGfxInfo,
"gfxInfo is broken",
"FEATURE_FAILURE_WR_NO_GFX_INFO"_ns);
useVideoHwOverlay = false;
} else {
if (status != nsIGfxInfo::FEATURE_ALLOW_ALWAYS) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_HARDWARE_OVERLAY);
feature.DisableByDefault(FeatureStatus::Blocked,
"Blocklisted by gfxInfo", failureId);
useVideoHwOverlay = false;
}
}
}
} else if (overlaySupported) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_HARDWARE_OVERLAY);
feature.DisableByDefault(FeatureStatus::Blocked, "Disabled by pref",
"FEATURE_FAILURE_DISABLED_BY_PREF"_ns);
}
if (useVideoHwOverlay) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_HARDWARE_OVERLAY);
feature.EnableByDefault();
gfxVars::SetUseWebRenderDCompVideoHwOverlayWin(true);
}
bool useVideoSwOverlay = false;
if (overlaySupported &&
StaticPrefs::gfx_webrender_dcomp_video_sw_overlay_win_AtStartup()) {
useVideoSwOverlay = true;
if (useVideoSwOverlay &&
!StaticPrefs::
gfx_webrender_dcomp_video_sw_overlay_win_force_enabled_AtStartup()) {
nsCString failureId;
int32_t status;
const nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
if (NS_FAILED(gfxInfo->GetFeatureStatus(
nsIGfxInfo::FEATURE_VIDEO_SOFTWARE_OVERLAY, failureId,
&status))) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_SOFTWARE_OVERLAY);
feature.DisableByDefault(FeatureStatus::BlockedNoGfxInfo,
"gfxInfo is broken",
"FEATURE_FAILURE_WR_NO_GFX_INFO"_ns);
useVideoSwOverlay = false;
} else {
if (status != nsIGfxInfo::FEATURE_STATUS_OK) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_SOFTWARE_OVERLAY);
feature.DisableByDefault(FeatureStatus::Blocked,
"Blocklisted by gfxInfo", failureId);
useVideoSwOverlay = false;
}
}
}
} else if (overlaySupported) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_SOFTWARE_OVERLAY);
feature.DisableByDefault(FeatureStatus::Blocked, "Disabled by pref",
"FEATURE_FAILURE_DISABLED_BY_PREF"_ns);
}
if (useVideoSwOverlay) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::VIDEO_SOFTWARE_OVERLAY);
feature.EnableByDefault();
gfxVars::SetUseWebRenderDCompVideoSwOverlayWin(true);
}
bool useHwVideoZeroCopy = false;
if (StaticPrefs::media_wmf_zero_copy_nv12_textures_AtStartup()) {
if (hasHardware) {
useHwVideoZeroCopy = true;
}
if (useHwVideoZeroCopy &&
!StaticPrefs::
media_wmf_zero_copy_nv12_textures_force_enabled_AtStartup()) {
nsCString failureId;
int32_t status;
const nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
if (NS_FAILED(gfxInfo->GetFeatureStatus(
nsIGfxInfo::FEATURE_HW_DECODED_VIDEO_ZERO_COPY, failureId,
&status))) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::HW_DECODED_VIDEO_ZERO_COPY);
feature.DisableByDefault(FeatureStatus::BlockedNoGfxInfo,
"gfxInfo is broken",
"FEATURE_FAILURE_WR_NO_GFX_INFO"_ns);
useHwVideoZeroCopy = false;
} else {
if (status != nsIGfxInfo::FEATURE_ALLOW_ALWAYS) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::HW_DECODED_VIDEO_ZERO_COPY);
feature.DisableByDefault(FeatureStatus::Blocked,
"Blocklisted by gfxInfo", failureId);
useHwVideoZeroCopy = false;
}
}
}
}
if (useHwVideoZeroCopy) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::HW_DECODED_VIDEO_ZERO_COPY);
feature.EnableByDefault();
gfxVars::SetHwDecodedVideoZeroCopy(true);
}
bool reuseDecoderDevice = false;
if (StaticPrefs::gfx_direct3d11_reuse_decoder_device_AtStartup()) {
reuseDecoderDevice = true;
if (reuseDecoderDevice &&
!StaticPrefs::
gfx_direct3d11_reuse_decoder_device_force_enabled_AtStartup()) {
nsCString failureId;
int32_t status;
const nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
if (NS_FAILED(gfxInfo->GetFeatureStatus(
nsIGfxInfo::FEATURE_REUSE_DECODER_DEVICE, failureId, &status))) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::REUSE_DECODER_DEVICE);
feature.DisableByDefault(FeatureStatus::BlockedNoGfxInfo,
"gfxInfo is broken",
"FEATURE_FAILURE_WR_NO_GFX_INFO"_ns);
reuseDecoderDevice = false;
} else {
if (status != nsIGfxInfo::FEATURE_STATUS_OK) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::REUSE_DECODER_DEVICE);
feature.DisableByDefault(FeatureStatus::Blocked,
"Blocklisted by gfxInfo", failureId);
reuseDecoderDevice = false;
}
}
}
}
if (reuseDecoderDevice) {
FeatureState& feature =
gfxConfig::GetFeature(Feature::REUSE_DECODER_DEVICE);
feature.EnableByDefault();
gfxVars::SetReuseDecoderDevice(true);
}
if (Preferences::GetBool("gfx.webrender.flip-sequential", false)) {
if (gfxVars::UseWebRenderANGLE()) {
gfxVars::SetUseWebRenderFlipSequentialWin(true);
}
}
if (Preferences::GetBool("gfx.webrender.triple-buffering.enabled", false)) {
if (gfxVars::UseWebRenderDCompWin() ||
gfxVars::UseWebRenderFlipSequentialWin()) {
gfxVars::SetUseWebRenderTripleBufferingWin(true);
}
}
#endif
if (gfxConfig::IsEnabled(Feature::WEBRENDER_COMPOSITOR)) {
gfxVars::SetUseWebRenderCompositor(true);
}
Telemetry::ScalarSet(
Telemetry::ScalarID::GFX_OS_COMPOSITOR,
gfx::gfxConfig::IsEnabled(gfx::Feature::WEBRENDER_COMPOSITOR));
if (gfxConfig::IsEnabled(Feature::WEBRENDER_PARTIAL)) {
gfxVars::SetWebRenderMaxPartialPresentRects(
StaticPrefs::gfx_webrender_max_partial_present_rects_AtStartup());
}
// Set features that affect WR's RendererOptions
gfxVars::SetUseGLSwizzle(
IsFeatureSupported(nsIGfxInfo::FEATURE_GL_SWIZZLE, true));
gfxVars::SetUseWebRenderScissoredCacheClears(gfx::gfxConfig::IsEnabled(
gfx::Feature::WEBRENDER_SCISSORED_CACHE_CLEARS));
// The RemoveShaderCacheFromDiskIfNecessary() needs to be called after
// WebRenderConfig initialization.
gfxUtils::RemoveShaderCacheFromDiskIfNecessary();
}
void gfxPlatform::InitHardwareVideoConfig() {
if (!XRE_IsParentProcess()) {
return;
}
#ifdef MOZ_WIDGET_GTK
// We don't want to expose codec info if whole HW decoding is disabled.
if (!sLayersSupportsHardwareVideoDecoding) {
return;
}
#endif
nsCString message;
nsCString failureId;
FeatureState& featureVP8 = gfxConfig::GetFeature(Feature::VP8_HW_DECODE);
featureVP8.EnableByDefault();
if (!IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_VP8_HW_DECODE, &message,
failureId)) {
featureVP8.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
gfxVars::SetUseVP8HwDecode(featureVP8.IsEnabled());
FeatureState& featureVP9 = gfxConfig::GetFeature(Feature::VP9_HW_DECODE);
featureVP9.EnableByDefault();
if (!IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_VP9_HW_DECODE, &message,
failureId)) {
featureVP9.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
gfxVars::SetUseVP9HwDecode(featureVP9.IsEnabled());
// H264_HW_DECODE/AV1_HW_DECODE is used on Linux only right now.
#ifdef MOZ_WIDGET_GTK
FeatureState& featureH264 = gfxConfig::GetFeature(Feature::H264_HW_DECODE);
featureH264.EnableByDefault();
if (!IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_H264_HW_DECODE, &message,
failureId)) {
featureH264.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
gfxVars::SetUseH264HwDecode(featureH264.IsEnabled());
FeatureState& featureAV1 = gfxConfig::GetFeature(Feature::AV1_HW_DECODE);
featureAV1.EnableByDefault();
if (!IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_AV1_HW_DECODE, &message,
failureId)) {
featureAV1.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
gfxVars::SetUseAV1HwDecode(featureAV1.IsEnabled());
#endif
}
void gfxPlatform::InitWebGLConfig() {
if (!XRE_IsParentProcess()) return;
const nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
const auto IsFeatureOk = [&](const int32_t feature) {
nsCString discardFailureId;
int32_t status;
MOZ_RELEASE_ASSERT(NS_SUCCEEDED(
gfxInfo->GetFeatureStatus(feature, discardFailureId, &status)));
return (status == nsIGfxInfo::FEATURE_STATUS_OK);
};
gfxVars::SetAllowWebgl2(IsFeatureOk(nsIGfxInfo::FEATURE_WEBGL2));
gfxVars::SetWebglAllowWindowsNativeGl(
IsFeatureOk(nsIGfxInfo::FEATURE_WEBGL_OPENGL));
gfxVars::SetAllowWebglAccelAngle(
IsFeatureOk(nsIGfxInfo::FEATURE_WEBGL_ANGLE));
if (kIsMacOS) {
// Avoid crash for Intel HD Graphics 3000 on OSX. (Bug 1413269)
nsString vendorID, deviceID;
gfxInfo->GetAdapterVendorID(vendorID);
gfxInfo->GetAdapterDeviceID(deviceID);
if (vendorID.EqualsLiteral("0x8086") &&
(deviceID.EqualsLiteral("0x0116") ||
deviceID.EqualsLiteral("0x0126"))) {
gfxVars::SetWebglAllowCoreProfile(false);
}
}
bool allowWebGLOop =
IsFeatureOk(nsIGfxInfo::FEATURE_ALLOW_WEBGL_OUT_OF_PROCESS);
if (!kIsAndroid) {
gfxVars::SetAllowWebglOop(allowWebGLOop);
} else {
// On android, enable out-of-process WebGL only when GPU process exists.
gfxVars::SetAllowWebglOop(allowWebGLOop &&
gfxConfig::IsEnabled(Feature::GPU_PROCESS));
// Enable gl::SharedSurface of AndroidHardwareBuffer when API version is 26+
// and out-of-process WebGL is enabled.
#ifdef MOZ_WIDGET_ANDROID
if (gfxVars::AllowWebglOop() && jni::GetAPIVersion() >= 26 &&
StaticPrefs::webgl_out_of_process_enable_ahardwarebuffer_AtStartup()) {
gfxVars::SetUseAHardwareBufferSharedSurfaceWebglOop(true);
}
#endif
}
bool threadsafeGL = IsFeatureOk(nsIGfxInfo::FEATURE_THREADSAFE_GL);
threadsafeGL |= StaticPrefs::webgl_threadsafe_gl_force_enabled_AtStartup();
threadsafeGL &= !StaticPrefs::webgl_threadsafe_gl_force_disabled_AtStartup();
gfxVars::SetSupportsThreadsafeGL(threadsafeGL);
FeatureState& feature =
gfxConfig::GetFeature(Feature::CANVAS_RENDERER_THREAD);
if (!threadsafeGL) {
feature.DisableByDefault(FeatureStatus::Blocked, "Thread unsafe GL",
"FEATURE_FAILURE_THREAD_UNSAFE_GL"_ns);
} else if (!StaticPrefs::webgl_use_canvas_render_thread_AtStartup()) {
feature.DisableByDefault(FeatureStatus::Blocked, "Disabled by pref",
"FEATURE_FAILURE_DISABLED_BY_PREF"_ns);
} else {
feature.EnableByDefault();
}
gfxVars::SetUseCanvasRenderThread(feature.IsEnabled());
bool webglOopAsyncPresentForceSync =
!gfxVars::UseCanvasRenderThread() ||
StaticPrefs::webgl_out_of_process_async_present_force_sync();
gfxVars::SetWebglOopAsyncPresentForceSync(webglOopAsyncPresentForceSync);
if (kIsAndroid) {
// Don't enable robust buffer access on Adreno 620 and 630 devices.
// It causes the linking of some shaders to fail. See bug 1485441 and
// bug 1810693.
nsAutoString renderer;
gfxInfo->GetAdapterDeviceID(renderer);
if ((renderer.Find(u"Adreno (TM) 620") != -1) ||
(renderer.Find(u"Adreno (TM) 630") != -1)) {
gfxVars::SetAllowEglRbab(false);
}
}
if (kIsLinux) {
nsCString discardFailureId;
int32_t status;
FeatureState& feature =
gfxConfig::GetFeature(Feature::DMABUF_SURFACE_EXPORT);
if (NS_FAILED(
gfxInfo->GetFeatureStatus(nsIGfxInfo::FEATURE_DMABUF_SURFACE_EXPORT,
discardFailureId, &status)) ||
status != nsIGfxInfo::FEATURE_STATUS_OK) {
feature.DisableByDefault(FeatureStatus::Blocked, "Blocklisted by gfxInfo",
discardFailureId);
gfxVars::SetUseDMABufSurfaceExport(false);
} else {
feature.EnableByDefault();
}
}
}
void gfxPlatform::InitWebGPUConfig() {
if (!XRE_IsParentProcess()) {
return;
}
FeatureState& feature = gfxConfig::GetFeature(Feature::WEBGPU);
feature.EnableByDefault();
nsCString message;
nsCString failureId;
if (!IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_WEBGPU, &message, failureId)) {
if (StaticPrefs::gfx_webgpu_ignore_blocklist_AtStartup()) {
feature.UserForceEnable(
"Ignoring blocklist entry because gfx.webgpu.ignore-blocklist is "
"true.");
}
feature.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
#ifdef RELEASE_OR_BETA
feature.ForceDisable(FeatureStatus::Blocked,
"WebGPU cannot be enabled in release or beta",
"WEBGPU_DISABLE_RELEASE_OR_BETA"_ns);
#endif
gfxVars::SetAllowWebGPU(feature.IsEnabled());
}
#ifdef XP_WIN
static void WindowOcclusionPrefChangeCallback(const char* aPref, void*) {
const char* env = PR_GetEnv("MOZ_WINDOW_OCCLUSION");
if (env) {
// env has a higher priority than pref.
return;
}
FeatureState& feature = gfxConfig::GetFeature(Feature::WINDOW_OCCLUSION);
bool enabled =
StaticPrefs::widget_windows_window_occlusion_tracking_enabled();
printf_stderr("Dynamically enable window occlusion %d\n", enabled);
// Update feature before calling WinUtils::EnableWindowOcclusion()
if (enabled) {
feature.UserEnable("User enabled by pref");
} else {
feature.UserDisable("User disabled via pref",
"FEATURE_FAILURE_PREF_DISABLED"_ns);
}
widget::WinUtils::EnableWindowOcclusion(enabled);
}
#endif
void gfxPlatform::InitWindowOcclusionConfig() {
if (!XRE_IsParentProcess()) {
return;
}
#ifdef XP_WIN
FeatureState& feature = gfxConfig::GetFeature(Feature::WINDOW_OCCLUSION);
feature.SetDefaultFromPref(
StaticPrefs::
GetPrefName_widget_windows_window_occlusion_tracking_enabled(),
true,
StaticPrefs::
GetPrefDefault_widget_windows_window_occlusion_tracking_enabled());
const char* env = PR_GetEnv("MOZ_WINDOW_OCCLUSION");
if (env) {
if (*env == '1') {
feature.UserForceEnable("Force enabled by envvar");
} else {
feature.UserDisable("Force disabled by envvar",
"FEATURE_FAILURE_OCCL_ENV"_ns);
}
}
Preferences::RegisterCallback(
WindowOcclusionPrefChangeCallback,
nsDependentCString(
StaticPrefs::
GetPrefName_widget_windows_window_occlusion_tracking_enabled()));
#endif
}
static void BackdropFilterPrefChangeCallback(const char*, void*) {
FeatureState& feature = gfxConfig::GetFeature(Feature::BACKDROP_FILTER);
// We need to reset because the user status needs to be set before the
// environment status, but the environment status comes from the blocklist,
// and the user status can be updated after the fact.
feature.Reset();
feature.EnableByDefault();
if (StaticPrefs::layout_css_backdrop_filter_force_enabled()) {
feature.UserForceEnable("Force enabled by pref");
}
nsCString message;
nsCString failureId;
if (!gfxPlatform::IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_BACKDROP_FILTER,
&message, failureId)) {
feature.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
// This may still be gated by the layout.css.backdrop-filter.enabled pref but
// the test infrastructure is very sensitive to how changes to that pref
// propagate, so we don't include them in the gfxVars/gfxFeature.
gfxVars::SetAllowBackdropFilter(feature.IsEnabled());
}
void gfxPlatform::InitBackdropFilterConfig() {
// This would ideally be in the nsCSSProps code
// but nsCSSProps is initialized before gfxPlatform
// so it has to be done here.
gfxVars::AddReceiver(&nsCSSProps::GfxVarReceiver());
if (!XRE_IsParentProcess()) {
// gfxVars doesn't notify receivers when initialized on content processes
// we need to explicitly recompute backdrop-filter's enabled state here.
nsCSSProps::RecomputeEnabledState(
StaticPrefs::GetPrefName_layout_css_backdrop_filter_enabled());
return;
}
BackdropFilterPrefChangeCallback(nullptr, nullptr);
Preferences::RegisterCallback(
BackdropFilterPrefChangeCallback,
nsDependentCString(
StaticPrefs::GetPrefName_layout_css_backdrop_filter_force_enabled()));
}
static void AcceleratedCanvas2DPrefChangeCallback(const char*, void*) {
FeatureState& feature = gfxConfig::GetFeature(Feature::ACCELERATED_CANVAS2D);
// Reset to track toggling prefs and ensure force-enable does not happen
// after blocklist.
feature.Reset();
// gfx.canvas.accelerated pref controls whether platform enables the feature,
// but it still allows blocklisting to override it later.
feature.SetDefaultFromPref(
StaticPrefs::GetPrefName_gfx_canvas_accelerated(), true,
StaticPrefs::GetPrefDefault_gfx_canvas_accelerated());
// gfx.canvas.accelerated.force-enabled overrides the blocklist.
if (StaticPrefs::gfx_canvas_accelerated_force_enabled()) {
feature.UserForceEnable("Force-enabled by pref");
}
if (kIsAndroid && !gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
feature.Disable(FeatureStatus::Blocked, "Disabled by GPU Process disabled",
"FEATURE_FAILURE_DISABLED_BY_GPU_PROCESS_DISABLED"_ns);
} else if (!gfxConfig::IsEnabled(Feature::WEBRENDER)) {
// There isn't much benefit to accelerating Canvas2D if we can't accelerate
// WebRender itself.
feature.Disable(FeatureStatus::Blocked, "Disabled by Software WebRender",
"FEATURE_FAILURE_DISABLED_BY_SOFTWARE_WEBRENDER"_ns);
}
// Check if blocklisted despite the default pref.
nsCString message;
nsCString failureId;
if (!gfxPlatform::IsGfxInfoStatusOkay(
nsIGfxInfo::FEATURE_ACCELERATED_CANVAS2D, &message, failureId)) {
feature.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
gfxVars::SetUseAcceleratedCanvas2D(feature.IsEnabled());
}
void gfxPlatform::InitAcceleratedCanvas2DConfig() {
if (!XRE_IsParentProcess()) {
return;
}
// Decide during pref changes whether or not to enable acceleration. This
// allows easily toggling acceleration on and off to test performance.
AcceleratedCanvas2DPrefChangeCallback(nullptr, nullptr);
Preferences::RegisterCallback(
AcceleratedCanvas2DPrefChangeCallback,
nsDependentCString(StaticPrefs::GetPrefName_gfx_canvas_accelerated()));
Preferences::RegisterCallback(
AcceleratedCanvas2DPrefChangeCallback,
nsDependentCString(
StaticPrefs::GetPrefName_gfx_canvas_accelerated_force_enabled()));
}
bool gfxPlatform::CanUseHardwareVideoDecoding() {
// this function is called from the compositor thread, so it is not
// safe to init the prefs etc. from here.
MOZ_ASSERT(sLayersAccelerationPrefsInitialized);
return sLayersSupportsHardwareVideoDecoding &&
!sLayersHardwareVideoDecodingFailed;
}
bool gfxPlatform::AccelerateLayersByDefault() {
#if defined(MOZ_GL_PROVIDER) || defined(MOZ_WIDGET_UIKIT)
return true;
#else
return false;
#endif
}
/* static */
bool gfxPlatform::UsesOffMainThreadCompositing() {
if (XRE_GetProcessType() == GeckoProcessType_GPU) {
return true;
}
static bool firstTime = true;
static bool result = false;
if (firstTime) {
MOZ_ASSERT(sLayersAccelerationPrefsInitialized);
result = gfxVars::BrowserTabsRemoteAutostart() ||
!StaticPrefs::
layers_offmainthreadcomposition_force_disabled_AtStartup();
#if defined(MOZ_WIDGET_GTK)
// Linux users who chose OpenGL are being included in OMTC
result |= StaticPrefs::
layers_acceleration_force_enabled_AtStartup_DoNotUseDirectly();
#endif
firstTime = false;
}
return result;
}
RefPtr<mozilla::VsyncDispatcher> gfxPlatform::GetGlobalVsyncDispatcher() {
MOZ_ASSERT(mVsyncDispatcher,
"mVsyncDispatcher should have been initialized by ReInitFrameRate "
"during gfxPlatform init");
MOZ_ASSERT(XRE_IsParentProcess());
return mVsyncDispatcher;
}
already_AddRefed<mozilla::gfx::VsyncSource>
gfxPlatform::GetGlobalHardwareVsyncSource() {
if (!mGlobalHardwareVsyncSource) {
mGlobalHardwareVsyncSource = CreateGlobalHardwareVsyncSource();
}
return do_AddRef(mGlobalHardwareVsyncSource);
}
/***
* The preference "layout.frame_rate" has 3 meanings depending on the value:
*
* -1 = Auto (default), use hardware vsync or software vsync @ 60 hz if hw
* vsync fails.
* 0 = ASAP mode - used during talos testing.
* X = Software vsync at a rate of X times per second.
*/
already_AddRefed<mozilla::gfx::VsyncSource>
gfxPlatform::GetSoftwareVsyncSource() {
if (!mSoftwareVsyncSource) {
double rateInMS = 1000.0 / (double)gfxPlatform::GetSoftwareVsyncRate();
mSoftwareVsyncSource = new mozilla::gfx::SoftwareVsyncSource(
TimeDuration::FromMilliseconds(rateInMS));
}
return do_AddRef(mSoftwareVsyncSource);
}
/* static */
bool gfxPlatform::IsInLayoutAsapMode() {
// There are 2 modes of ASAP mode.
// 1 is that the refresh driver and compositor are in lock step
// the second is that the compositor goes ASAP and the refresh driver
// goes at whatever the configurated rate is. This only checks the version
// talos uses, which is the refresh driver and compositor are in lockstep.
// Ignore privacy_resistFingerprinting to preserve ASAP mode there.
return StaticPrefs::layout_frame_rate() == 0;
}
static int LayoutFrameRateFromPrefs() {
auto val = StaticPrefs::layout_frame_rate();
if (nsContentUtils::ShouldResistFingerprinting(
"The frame rate is a global property.", RFPTarget::FrameRate)) {
val = 60;
}
return val;
}
/* static */
bool gfxPlatform::ForceSoftwareVsync() {
return LayoutFrameRateFromPrefs() > 0;
}
/* static */
int gfxPlatform::GetSoftwareVsyncRate() {
int preferenceRate = LayoutFrameRateFromPrefs();
if (preferenceRate <= 0) {
return gfxPlatform::GetDefaultFrameRate();
}
return preferenceRate;
}
/* static */
int gfxPlatform::GetDefaultFrameRate() { return 60; }
/* static */
void gfxPlatform::ReInitFrameRate(const char* aPrefIgnored,
void* aDataIgnored) {
MOZ_RELEASE_ASSERT(XRE_IsParentProcess());
if (gPlatform->mSoftwareVsyncSource) {
// Update the rate of the existing software vsync source.
double rateInMS = 1000.0 / (double)gfxPlatform::GetSoftwareVsyncRate();
gPlatform->mSoftwareVsyncSource->SetVsyncRate(
TimeDuration::FromMilliseconds(rateInMS));
}
// Swap out the dispatcher's underlying source.
RefPtr<VsyncSource> vsyncSource =
gfxPlatform::ForceSoftwareVsync()
? gPlatform->GetSoftwareVsyncSource()
: gPlatform->GetGlobalHardwareVsyncSource();
gPlatform->mVsyncDispatcher->SetVsyncSource(vsyncSource);
}
const char* gfxPlatform::GetAzureCanvasBackend() const {
BackendType backend{};
if (gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
// Assume content process' backend prefs.
BackendPrefsData data = GetBackendPrefs();
backend = GetCanvasBackendPref(data.mCanvasBitmask);
if (backend == BackendType::NONE) {
backend = data.mCanvasDefault;
}
} else {
backend = mPreferredCanvasBackend;
}
return GetBackendName(backend);
}
const char* gfxPlatform::GetAzureContentBackend() const {
BackendType backend{};
if (gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
// Assume content process' backend prefs.
BackendPrefsData data = GetBackendPrefs();
backend = GetContentBackendPref(data.mContentBitmask);
if (backend == BackendType::NONE) {
backend = data.mContentDefault;
}
} else {
backend = mContentBackend;
}
return GetBackendName(backend);
}
void gfxPlatform::GetAzureBackendInfo(mozilla::widget::InfoObject& aObj) {
if (gfxConfig::IsEnabled(Feature::GPU_PROCESS)) {
aObj.DefineProperty("AzureCanvasBackend (UI Process)",
GetBackendName(mPreferredCanvasBackend));
aObj.DefineProperty("AzureFallbackCanvasBackend (UI Process)",
GetBackendName(mFallbackCanvasBackend));
aObj.DefineProperty("AzureContentBackend (UI Process)",
GetBackendName(mContentBackend));
} else {
aObj.DefineProperty("AzureFallbackCanvasBackend",
GetBackendName(mFallbackCanvasBackend));
}
aObj.DefineProperty("AzureCanvasBackend", GetAzureCanvasBackend());
aObj.DefineProperty("AzureContentBackend", GetAzureContentBackend());
}
void gfxPlatform::GetApzSupportInfo(mozilla::widget::InfoObject& aObj) {
if (!gfxPlatform::AsyncPanZoomEnabled()) {
return;
}
if (SupportsApzWheelInput()) {
aObj.DefineProperty("ApzWheelInput", 1);
}
if (SupportsApzTouchInput()) {
aObj.DefineProperty("ApzTouchInput", 1);
}
if (SupportsApzDragInput()) {
aObj.DefineProperty("ApzDragInput", 1);
}
if (SupportsApzKeyboardInput() &&
!StaticPrefs::accessibility_browsewithcaret()) {
aObj.DefineProperty("ApzKeyboardInput", 1);
}
if (SupportsApzAutoscrolling()) {
aObj.DefineProperty("ApzAutoscrollInput", 1);
}
if (SupportsApzZooming()) {
aObj.DefineProperty("ApzZoomingInput", 1);
}
}
void gfxPlatform::GetFrameStats(mozilla::widget::InfoObject& aObj) {
uint32_t i = 0;
for (FrameStats& f : mFrameStats) {
nsPrintfCString name("Slow Frame #%02u", ++i);
nsPrintfCString value(
"Frame %" PRIu64
"(%s) CONTENT_FRAME_TIME %d - Transaction start %f, main-thread time "
"%f, full paint time %f, Skipped composites %u, Composite start %f, "
"Resource upload time %f, GPU cache upload time %f, Render time %f, "
"Composite time %f",
f.id().mId, f.url().get(), f.contentFrameTime(),
(f.transactionStart() - f.refreshStart()).ToMilliseconds(),
(f.fwdTime() - f.transactionStart()).ToMilliseconds(),
f.sceneBuiltTime()
? (f.sceneBuiltTime() - f.transactionStart()).ToMilliseconds()
: 0.0,
f.skippedComposites(),
(f.compositeStart() - f.refreshStart()).ToMilliseconds(),
f.resourceUploadTime(), f.gpuCacheUploadTime(),
(f.compositeEnd() - f.renderStart()).ToMilliseconds(),
(f.compositeEnd() - f.compositeStart()).ToMilliseconds());
aObj.DefineProperty(name.get(), value.get());
}
}
void gfxPlatform::GetCMSSupportInfo(mozilla::widget::InfoObject& aObj) {
nsTArray<uint8_t> outputProfileData =
gfxPlatform::GetPlatform()->GetPlatformCMSOutputProfileData();
if (outputProfileData.IsEmpty()) {
nsPrintfCString msg("Empty profile data");
aObj.DefineProperty("CMSOutputProfile", msg.get());
return;
}
// Some profiles can be quite large. We don't want to include giant profiles
// by default in about:support. For now, we only accept less than 8kiB.
const size_t kMaxProfileSize = 8192;
if (outputProfileData.Length() >= kMaxProfileSize) {
nsPrintfCString msg("%zu bytes, too large", outputProfileData.Length());
aObj.DefineProperty("CMSOutputProfile", msg.get());
return;
}
nsString encodedProfile;
nsresult rv =
Base64Encode(reinterpret_cast<const char*>(outputProfileData.Elements()),
outputProfileData.Length(), encodedProfile);
if (!NS_SUCCEEDED(rv)) {
nsPrintfCString msg("base64 encode failed 0x%08x",
static_cast<uint32_t>(rv));
aObj.DefineProperty("CMSOutputProfile", msg.get());
return;
}
aObj.DefineProperty("CMSOutputProfile", encodedProfile);
}
void gfxPlatform::GetDisplayInfo(mozilla::widget::InfoObject& aObj) {
auto& screens = widget::ScreenManager::GetSingleton().CurrentScreenList();
aObj.DefineProperty("DisplayCount", screens.Length());
size_t i = 0;
for (auto& screen : screens) {
const LayoutDeviceIntRect rect = screen->GetRect();
nsPrintfCString value("%dx%d@%dHz scales:%f|%f", rect.width, rect.height,
screen->GetRefreshRate(),
screen->GetContentsScaleFactor(),
screen->GetDefaultCSSScaleFactor());
aObj.DefineProperty(nsPrintfCString("Display%zu", i++).get(),
NS_ConvertUTF8toUTF16(value));
}
// Platform display info is only currently used for about:support and getting
// it might fail in a child process anyway.
if (XRE_IsParentProcess()) {
GetPlatformDisplayInfo(aObj);
}
}
void gfxPlatform::GetOverlayInfo(mozilla::widget::InfoObject& aObj) {
if (mOverlayInfo.isNothing()) {
return;
}
auto toString = [](mozilla::layers::OverlaySupportType aType) -> const char* {
switch (aType) {
case mozilla::layers::OverlaySupportType::None:
return "None";
case mozilla::layers::OverlaySupportType::Software:
return "Software";
case mozilla::layers::OverlaySupportType::Direct:
return "Direct";
case mozilla::layers::OverlaySupportType::Scaling:
return "Scaling";
default:
MOZ_ASSERT_UNREACHABLE("Unexpected to be called");
}
MOZ_CRASH("Incomplete switch");
};
nsPrintfCString value("NV12=%s YUV2=%s BGRA8=%s RGB10A2=%s",
toString(mOverlayInfo.ref().mNv12Overlay),
toString(mOverlayInfo.ref().mYuy2Overlay),
toString(mOverlayInfo.ref().mBgra8Overlay),
toString(mOverlayInfo.ref().mRgb10a2Overlay));
aObj.DefineProperty("OverlaySupport", NS_ConvertUTF8toUTF16(value));
}
void gfxPlatform::GetSwapChainInfo(mozilla::widget::InfoObject& aObj) {
if (mSwapChainInfo.isNothing()) {
return;
}
auto toString = [](bool aTearingSupported) -> const char* {
if (aTearingSupported) {
return "Supported";
}
return "Not Supported";
};
nsPrintfCString value("%s", toString(mSwapChainInfo.ref().mTearingSupported));
aObj.DefineProperty("SwapChainTearingSupport", NS_ConvertUTF8toUTF16(value));
}
class FrameStatsComparator {
public:
bool Equals(const FrameStats& aA, const FrameStats& aB) const {
return aA.contentFrameTime() == aB.contentFrameTime();
}
// Reverse the condition here since we want the array sorted largest to
// smallest.
bool LessThan(const FrameStats& aA, const FrameStats& aB) const {
return aA.contentFrameTime() > aB.contentFrameTime();
}
};
void gfxPlatform::NotifyFrameStats(nsTArray<FrameStats>&& aFrameStats) {
if (!StaticPrefs::gfx_logging_slow_frames_enabled_AtStartup()) {
return;
}
FrameStatsComparator comp;
for (FrameStats& f : aFrameStats) {
mFrameStats.InsertElementSorted(f, comp);
}
if (mFrameStats.Length() > 10) {
mFrameStats.SetLength(10);
}
}
/*static*/
uint32_t gfxPlatform::TargetFrameRate() {
if (gPlatform && gPlatform->mVsyncDispatcher) {
return round(1000.0 /
gPlatform->mVsyncDispatcher->GetVsyncRate().ToMilliseconds());
}
return 0;
}
/* static */
bool gfxPlatform::UseDesktopZoomingScrollbars() {
return StaticPrefs::apz_allow_zooming() &&
!StaticPrefs::apz_force_disable_desktop_zooming_scrollbars();
}
/*static*/
bool gfxPlatform::AsyncPanZoomEnabled() {
#if !defined(MOZ_WIDGET_ANDROID) && !defined(MOZ_WIDGET_UIKIT)
// For XUL applications (everything but Firefox on Android)
// we only want to use APZ when E10S is enabled. If
// we ever get input events off the main thread we can consider relaxing
// this requirement.
if (!BrowserTabsRemoteAutostart()) {
return false;
}
#endif
#ifdef MOZ_WIDGET_ANDROID
return true;
#else
// If Fission is enabled, OOP iframes require APZ for hittest. So, we
// need to forcibly enable APZ in that case for avoiding users confused.
if (FissionAutostart()) {
return true;
}
return StaticPrefs::
layers_async_pan_zoom_enabled_AtStartup_DoNotUseDirectly();
#endif
}
/*static*/
bool gfxPlatform::PerfWarnings() {
return StaticPrefs::gfx_perf_warnings_enabled();
}
void gfxPlatform::NotifyCompositorCreated(LayersBackend aBackend) {
if (mCompositorBackend == aBackend) {
return;
}
if (mCompositorBackend != LayersBackend::LAYERS_NONE) {
gfxCriticalNote << "Compositors might be mixed (" << int(mCompositorBackend)
<< "," << int(aBackend) << ")";
}
// Set the backend before we notify so it's available immediately.
mCompositorBackend = aBackend;
if (XRE_IsParentProcess()) {
Telemetry::ScalarSet(
Telemetry::ScalarID::GFX_COMPOSITOR,
NS_ConvertUTF8toUTF16(GetLayersBackendName(mCompositorBackend)));
nsCString geckoVersion;
nsCOMPtr<nsIXULAppInfo> app = do_GetService("@mozilla.org/xre/app-info;1");
if (app) {
app->GetVersion(geckoVersion);
}
Telemetry::ScalarSet(Telemetry::ScalarID::GFX_LAST_COMPOSITOR_GECKO_VERSION,
NS_ConvertASCIItoUTF16(geckoVersion));
Telemetry::ScalarSet(
Telemetry::ScalarID::GFX_FEATURE_WEBRENDER,
NS_ConvertUTF8toUTF16(gfxConfig::GetFeature(gfx::Feature::WEBRENDER)
.GetStatusAndFailureIdString()));
}
// Notify that we created a compositor, so telemetry can update.
NS_DispatchToMainThread(
NS_NewRunnableFunction("gfxPlatform::NotifyCompositorCreated", [] {
if (nsCOMPtr<nsIObserverService> obsvc =
services::GetObserverService()) {
obsvc->NotifyObservers(nullptr, "compositor:created", nullptr);
}
}));
}
/* static */
bool gfxPlatform::FallbackFromAcceleration(FeatureStatus aStatus,
const char* aMessage,
const nsACString& aFailureId,
bool aCrashAfterFinalFallback) {
// We always want to ensure (Hardware) WebRender is disabled.
if (gfxConfig::IsEnabled(Feature::WEBRENDER)) {
gfxConfig::GetFeature(Feature::WEBRENDER)
.ForceDisable(aStatus, aMessage, aFailureId);
}
// Determine whether or not we are allowed to use Software WebRender in
// fallback without the GPU process. Either the pref is false, or the feature
// is enabled and we are currently still using it.
bool swglFallbackAllowed =
!StaticPrefs::
gfx_webrender_fallback_software_requires_gpu_process_AtStartup() ||
gfxConfig::IsEnabled(Feature::GPU_PROCESS);
#ifdef XP_WIN
// Before we disable D3D11 and HW_COMPOSITING, we should check if we can
// fallback from WebRender to Software WebRender + D3D11 compositing.
if (swglFallbackAllowed && gfxVars::AllowSoftwareWebRenderD3D11() &&
gfxConfig::IsEnabled(Feature::D3D11_COMPOSITING) &&
!gfxVars::UseSoftwareWebRender()) {
// Fallback to Software WebRender + D3D11 compositing.
gfxCriticalNote << "Fallback WR to SW-WR + D3D11";
gfxVars::SetUseSoftwareWebRender(true);
return true;
}
if (swglFallbackAllowed && gfxVars::AllowSoftwareWebRenderD3D11() &&
gfxVars::UseSoftwareWebRender()) {
// Fallback from Software WebRender + D3D11 to Software WebRender.
gfxCriticalNote << "Fallback SW-WR + D3D11 to SW-WR";
gfxVars::SetAllowSoftwareWebRenderD3D11(false);
return true;
}
// We aren't using Software WebRender + D3D11 compositing, so turn off the
// D3D11 and D2D.
if (gfxConfig::IsEnabled(Feature::DIRECT2D)) {
gfxConfig::GetFeature(Feature::DIRECT2D)
.ForceDisable(aStatus, aMessage, aFailureId);
}
if (gfxConfig::IsEnabled(Feature::D3D11_COMPOSITING)) {
gfxConfig::GetFeature(Feature::D3D11_COMPOSITING)
.ForceDisable(aStatus, aMessage, aFailureId);
}
#endif
#if defined(MOZ_WIDGET_ANDROID) || defined(MOZ_WIDGET_GTK)
// Before we disable OpenGL and HW_COMPOSITING, we should check if we can
// fallback from WebRender to Software WebRender + OpenGL compositing.
if (swglFallbackAllowed && gfxVars::AllowSoftwareWebRenderOGL() &&
gfxConfig::IsEnabled(Feature::OPENGL_COMPOSITING) &&
!gfxVars::UseSoftwareWebRender()) {
// Fallback to Software WebRender + OpenGL compositing.
gfxCriticalNote << "Fallback WR to SW-WR + OpenGL";
gfxVars::SetUseSoftwareWebRender(true);
return true;
}
#endif
// Android does not want to fallback to SW-WR.
#ifdef MOZ_WIDGET_GTK
if (swglFallbackAllowed && gfxVars::AllowSoftwareWebRenderOGL() &&
gfxVars::UseSoftwareWebRender()) {
// Fallback from Software WebRender + OpenGL to Software WebRender.
gfxCriticalNote << "Fallback SW-WR + OpenGL to SW-WR";
gfxVars::SetAllowSoftwareWebRenderOGL(false);
return true;
}
#endif
#ifndef MOZ_WIDGET_ANDROID
// Non-Android wants to fallback to Software WebRender or Basic. Android wants
// to fallback to OpenGL.
if (gfxConfig::IsEnabled(Feature::HW_COMPOSITING)) {
gfxConfig::GetFeature(Feature::HW_COMPOSITING)
.ForceDisable(aStatus, aMessage, aFailureId);
}
#endif
if (StaticPrefs::gfx_webrender_fallback_software_AtStartup() &&
swglFallbackAllowed && !gfxVars::UseSoftwareWebRender()) {
// Fallback from WebRender to Software WebRender.
gfxCriticalNote << "Fallback WR to SW-WR";
gfxVars::SetUseSoftwareWebRender(true);
return true;
}
if (!gfxVars::UseSoftwareWebRender()) {
// Software WebRender may be disabled due to a startup issue with the
// blocklist, despite it being our only fallback option based on the prefs.
// If WebRender is unable to be initialized, this means that user would
// otherwise get stuck with WebRender. As such, force a switch to Software
// WebRender in this case.
gfxCriticalNoteOnce << "Fallback WR to SW-WR, forced";
gfxVars::SetUseSoftwareWebRender(true);
return true;
}
if (aCrashAfterFinalFallback) {
MOZ_CRASH("Fallback configurations exhausted");
}
// Continue using Software WebRender (disabled fallback to Basic).
gfxCriticalNoteOnce << "Fallback remains SW-WR";
return false;
}
/* static */
void gfxPlatform::DisableGPUProcess() {
if (gfxVars::RemoteCanvasEnabled() &&
!StaticPrefs::gfx_canvas_remote_allow_in_parent_AtStartup()) {
gfxConfig::Disable(
Feature::REMOTE_CANVAS, FeatureStatus::UnavailableNoGpuProcess,
"Disabled by GPU process disabled",
"FEATURE_REMOTE_CANVAS_DISABLED_BY_GPU_PROCESS_DISABLED"_ns);
gfxVars::SetRemoteCanvasEnabled(false);
}
if (kIsAndroid) {
// On android, enable out-of-process WebGL only when GPU process exists.
gfxVars::SetAllowWebglOop(false);
// On android, enable accelerated canvas only when GPU process exists.
gfxVars::SetUseAcceleratedCanvas2D(false);
gfxConfig::Disable(Feature::ACCELERATED_CANVAS2D, FeatureStatus::Blocked,
"Disabled by GPU Process disabled",
"FEATURE_FAILURE_DISABLED_BY_GPU_PROCESS_DISABLED"_ns);
}
RemoteTextureMap::Init();
// We need to initialize the parent process to prepare for WebRender if we
// did not end up disabling it, despite losing the GPU process.
wr::RenderThread::Start(GPUProcessManager::Get()->AllocateNamespace());
gfx::CanvasRenderThread::Start();
image::ImageMemoryReporter::InitForWebRender();
}
/* static */ void gfxPlatform::DisableRemoteCanvas() {
if (!gfxVars::RemoteCanvasEnabled()) {
return;
}
gfxConfig::ForceDisable(Feature::REMOTE_CANVAS, FeatureStatus::Failed,
"Disabled by runtime error",
"FEATURE_REMOTE_CANVAS_RUNTIME_ERROR"_ns);
gfxVars::SetRemoteCanvasEnabled(false);
}
void gfxPlatform::FetchAndImportContentDeviceData() {
MOZ_ASSERT(XRE_IsContentProcess());
if (gContentDeviceInitData) {
ImportContentDeviceData(*gContentDeviceInitData);
return;
}
mozilla::dom::ContentChild* cc = mozilla::dom::ContentChild::GetSingleton();
mozilla::gfx::ContentDeviceData data;
cc->SendGetGraphicsDeviceInitData(&data);
ImportContentDeviceData(data);
}
void gfxPlatform::ImportContentDeviceData(
const mozilla::gfx::ContentDeviceData& aData) {
MOZ_ASSERT(XRE_IsContentProcess());
const DevicePrefs& prefs = aData.prefs();
gfxConfig::Inherit(Feature::HW_COMPOSITING, prefs.hwCompositing());
gfxConfig::Inherit(Feature::OPENGL_COMPOSITING, prefs.oglCompositing());
}
void gfxPlatform::BuildContentDeviceData(
mozilla::gfx::ContentDeviceData* aOut) {
MOZ_ASSERT(XRE_IsParentProcess());
// Make sure our settings are synchronized from the GPU process.
DebugOnly<nsresult> rv = GPUProcessManager::Get()->EnsureGPUReady();
MOZ_ASSERT(rv != NS_ERROR_ILLEGAL_DURING_SHUTDOWN);
aOut->prefs().hwCompositing() = gfxConfig::GetValue(Feature::HW_COMPOSITING);
aOut->prefs().oglCompositing() =
gfxConfig::GetValue(Feature::OPENGL_COMPOSITING);
}
void gfxPlatform::ImportGPUDeviceData(
const mozilla::gfx::GPUDeviceData& aData) {
MOZ_ASSERT(XRE_IsParentProcess());
gfxConfig::ImportChange(Feature::OPENGL_COMPOSITING, aData.oglCompositing());
}
bool gfxPlatform::SupportsApzTouchInput() const {
return dom::TouchEvent::PrefEnabled(nullptr);
}
bool gfxPlatform::SupportsApzDragInput() const {
return StaticPrefs::apz_drag_enabled();
}
bool gfxPlatform::SupportsApzKeyboardInput() const {
return StaticPrefs::apz_keyboard_enabled_AtStartup();
}
bool gfxPlatform::SupportsApzAutoscrolling() const {
return StaticPrefs::apz_autoscroll_enabled();
}
bool gfxPlatform::SupportsApzZooming() const {
return StaticPrefs::apz_allow_zooming();
}
void gfxPlatform::InitOpenGLConfig() {
#ifdef XP_WIN
// Don't enable by default on Windows, since it could show up in about:support
// even though it'll never get used. Only attempt if user enables the pref
if (!Preferences::GetBool("layers.prefer-opengl")) {
return;
}
#endif
FeatureState& openGLFeature =
gfxConfig::GetFeature(Feature::OPENGL_COMPOSITING);
// Check to see hw comp supported
if (!gfxConfig::IsEnabled(Feature::HW_COMPOSITING)) {
openGLFeature.DisableByDefault(FeatureStatus::Unavailable,
"Hardware compositing is disabled",
"FEATURE_FAILURE_OPENGL_NEED_HWCOMP"_ns);
return;
}
#ifdef XP_WIN
openGLFeature.SetDefaultFromPref(
StaticPrefs::GetPrefName_layers_prefer_opengl(), true,
StaticPrefs::GetPrefDefault_layers_prefer_opengl());
#else
openGLFeature.EnableByDefault();
#endif
// When layers acceleration is force-enabled, enable it even for blocklisted
// devices.
if (StaticPrefs::
layers_acceleration_force_enabled_AtStartup_DoNotUseDirectly()) {
openGLFeature.UserForceEnable("Force-enabled by pref");
return;
}
nsCString message;
nsCString failureId;
if (!IsGfxInfoStatusOkay(nsIGfxInfo::FEATURE_OPENGL_LAYERS, &message,
failureId)) {
openGLFeature.Disable(FeatureStatus::Blocklisted, message.get(), failureId);
}
}
bool gfxPlatform::IsGfxInfoStatusOkay(int32_t aFeature, nsCString* aOutMessage,
nsCString& aFailureId) {
nsCOMPtr<nsIGfxInfo> gfxInfo = components::GfxInfo::Service();
if (!gfxInfo) {
return true;
}
int32_t status;
if (NS_SUCCEEDED(gfxInfo->GetFeatureStatus(aFeature, aFailureId, &status)) &&
status != nsIGfxInfo::FEATURE_STATUS_OK) {
aOutMessage->AssignLiteral("#BLOCKLIST_");
aOutMessage->AppendASCII(aFailureId.get());
return false;
}
return true;
}