gfx/config/gfxConfig.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6 #include "gfxConfig.h"
   7 #include "mozilla/UniquePtr.h"
   8 #include "mozilla/Unused.h"
   9 #include "mozilla/gfx/GPUParent.h"
  10 #include "mozilla/gfx/GraphicsMessages.h"
  11 #include "plstr.h"
  12
  13 namespace mozilla {
  14 namespace gfx {
  15
  16 static UniquePtr<gfxConfig> sConfig;
  17
  18 /* static */ FeatureState& gfxConfig::GetFeature(Feature aFeature) {
  19   return sConfig->GetState(aFeature);
  20 }
  21
  22 /* static */
  23 bool gfxConfig::IsEnabled(Feature aFeature) {
  24   const FeatureState& state = sConfig->GetState(aFeature);
  25   return state.IsEnabled();
  26 }
  27
  28 /* static */
  29 bool gfxConfig::IsDisabledByDefault(Feature aFeature) {
  30   const FeatureState& state = sConfig->GetState(aFeature);
  31   return state.DisabledByDefault();
  32 }
  33
  34 /* static */
  35 bool gfxConfig::IsForcedOnByUser(Feature aFeature) {
  36   const FeatureState& state = sConfig->GetState(aFeature);
  37   return state.IsForcedOnByUser();
  38 }
  39
  40 /* static */
  41 FeatureStatus gfxConfig::GetValue(Feature aFeature) {
  42   const FeatureState& state = sConfig->GetState(aFeature);
  43   return state.GetValue();
  44 }
  45
  46 /* static */
  47 bool gfxConfig::SetDefault(Feature aFeature, bool aEnable,
  48                            FeatureStatus aDisableStatus,
  49                            const char* aDisableMessage) {
  50   FeatureState& state = sConfig->GetState(aFeature);
  51   return state.SetDefault(aEnable, aDisableStatus, aDisableMessage);
  52 }
  53
  54 /* static */
  55 void gfxConfig::DisableByDefault(Feature aFeature, FeatureStatus aDisableStatus,
  56                                  const char* aDisableMessage,
  57                                  const nsACString& aFailureId) {
  58   FeatureState& state = sConfig->GetState(aFeature);
  59   state.DisableByDefault(aDisableStatus, aDisableMessage, aFailureId);
  60 }
  61
  62 /* static */
  63 void gfxConfig::EnableByDefault(Feature aFeature) {
  64   FeatureState& state = sConfig->GetState(aFeature);
  65   state.EnableByDefault();
  66 }
  67
  68 /* static */
  69 void gfxConfig::SetDefaultFromPref(Feature aFeature, const char* aPrefName,
  70                                    bool aIsEnablePref, bool aDefaultValue) {
  71   FeatureState& state = sConfig->GetState(aFeature);
  72   return state.SetDefaultFromPref(aPrefName, aIsEnablePref, aDefaultValue);
  73 }
  74
  75 /* static */
  76 bool gfxConfig::InitOrUpdate(Feature aFeature, bool aEnable,
  77                              FeatureStatus aDisableStatus,
  78                              const char* aDisableMessage) {
  79   FeatureState& state = sConfig->GetState(aFeature);
  80   return state.InitOrUpdate(aEnable, aDisableStatus, aDisableMessage);
  81 }
  82
  83 /* static */
  84 void gfxConfig::SetFailed(Feature aFeature, FeatureStatus aStatus,
  85                           const char* aMessage, const nsACString& aFailureId) {
  86   FeatureState& state = sConfig->GetState(aFeature);
  87   state.SetFailed(aStatus, aMessage, aFailureId);
  88 }
  89
  90 /* static */
  91 void gfxConfig::Disable(Feature aFeature, FeatureStatus aStatus,
  92                         const char* aMessage, const nsACString& aFailureId) {
  93   FeatureState& state = sConfig->GetState(aFeature);
  94   state.Disable(aStatus, aMessage, aFailureId);
  95 }
  96
  97 /* static */
  98 void gfxConfig::UserEnable(Feature aFeature, const char* aMessage) {
  99   FeatureState& state = sConfig->GetState(aFeature);
 100   state.UserEnable(aMessage);
 101 }
 102
 103 /* static */
 104 void gfxConfig::UserForceEnable(Feature aFeature, const char* aMessage) {
 105   FeatureState& state = sConfig->GetState(aFeature);
 106   state.UserForceEnable(aMessage);
 107 }
 108
 109 /* static */
 110 void gfxConfig::UserDisable(Feature aFeature, const char* aMessage,
 111                             const nsACString& aFailureId) {
 112   FeatureState& state = sConfig->GetState(aFeature);
 113   state.UserDisable(aMessage, aFailureId);
 114 }
 115
 116 /* static */
 117 void gfxConfig::Reenable(Feature aFeature, Fallback aFallback) {
 118   FeatureState& state = sConfig->GetState(aFeature);
 119   MOZ_ASSERT(IsFeatureStatusFailure(state.GetValue()));
 120
 121   const char* message = state.GetRuntimeMessage();
 122   EnableFallback(aFallback, message);
 123   state.SetRuntime(FeatureStatus::Available, nullptr, nsCString());
 124 }
 125
 126 /* static */
 127 void gfxConfig::Reset(Feature aFeature) {
 128   FeatureState& state = sConfig->GetState(aFeature);
 129   state.Reset();
 130 }
 131
 132 /* static */
 133 void gfxConfig::Inherit(Feature aFeature, FeatureStatus aStatus) {
 134   FeatureState& state = sConfig->GetState(aFeature);
 135
 136   state.Reset();
 137
 138   switch (aStatus) {
 139     case FeatureStatus::Unused:
 140       break;
 141     case FeatureStatus::Available:
 142       gfxConfig::EnableByDefault(aFeature);
 143       break;
 144     case FeatureStatus::ForceEnabled:
 145       gfxConfig::EnableByDefault(aFeature);
 146       gfxConfig::UserForceEnable(aFeature, "Inherited from parent process");
 147       break;
 148     default:
 149       gfxConfig::SetDefault(aFeature, false, aStatus,
 150                             "Disabled in parent process");
 151       break;
 152   }
 153 }
 154
 155 /* static */
 156 void gfxConfig::Inherit(EnumSet<Feature> aFeatures,
 157                         const DevicePrefs& aDevicePrefs) {
 158   for (Feature feature : aFeatures) {
 159     FeatureStatus status = FeatureStatus::Unused;
 160     switch (feature) {
 161       case Feature::HW_COMPOSITING:
 162         status = aDevicePrefs.hwCompositing();
 163         break;
 164       case Feature::D3D11_COMPOSITING:
 165         status = aDevicePrefs.d3d11Compositing();
 166         break;
 167       case Feature::OPENGL_COMPOSITING:
 168         status = aDevicePrefs.oglCompositing();
 169         break;
 170       case Feature::DIRECT2D:
 171         status = aDevicePrefs.useD2D1();
 172         break;
 173       default:
 174         break;
 175     }
 176     gfxConfig::Inherit(feature, status);
 177   }
 178 }
 179
 180 /* static */
 181 bool gfxConfig::UseFallback(Fallback aFallback) {
 182   return sConfig->UseFallbackImpl(aFallback);
 183 }
 184
 185 /* static */
 186 void gfxConfig::EnableFallback(Fallback aFallback, const char* aMessage) {
 187   if (!NS_IsMainThread()) {
 188     nsCString message(aMessage);
 189     NS_DispatchToMainThread(
 190         NS_NewRunnableFunction("gfxConfig::EnableFallback", [=]() -> void {
 191           gfxConfig::EnableFallback(aFallback, message.get());
 192         }));
 193     return;
 194   }
 195
 196   if (XRE_IsGPUProcess()) {
 197     nsCString message(aMessage);
 198     Unused << GPUParent::GetSingleton()->SendUsedFallback(aFallback, message);
 199     return;
 200   }
 201
 202   sConfig->EnableFallbackImpl(aFallback, aMessage);
 203 }
 204
 205 bool gfxConfig::UseFallbackImpl(Fallback aFallback) const {
 206   return !!(mFallbackBits & (uint64_t(1) << uint64_t(aFallback)));
 207 }
 208
 209 void gfxConfig::EnableFallbackImpl(Fallback aFallback, const char* aMessage) {
 210   if (!UseFallbackImpl(aFallback)) {
 211     MOZ_ASSERT(mNumFallbackLogEntries < kNumFallbacks);
 212
 213     FallbackLogEntry& entry = mFallbackLog[mNumFallbackLogEntries];
 214     mNumFallbackLogEntries++;
 215
 216     entry.mFallback = aFallback;
 217     PL_strncpyz(entry.mMessage, aMessage, sizeof(entry.mMessage));
 218   }
 219   mFallbackBits |= (uint64_t(1) << uint64_t(aFallback));
 220 }
 221
 222 struct FeatureInfo {
 223   const char* name;
 224   const char* description;
 225 };
 226 static const FeatureInfo sFeatureInfo[] = {
 227 #define FOR_EACH_FEATURE(name, type, desc) {#name, desc},
 228     GFX_FEATURE_MAP(FOR_EACH_FEATURE)
 229 #undef FOR_EACH_FEATURE
 230         {nullptr, nullptr}};
 231
 232 /* static */
 233 void gfxConfig::ForEachFeature(const FeatureIterCallback& aCallback) {
 234   for (size_t i = 0; i < kNumFeatures; i++) {
 235     FeatureState& state = GetFeature(static_cast<Feature>(i));
 236     if (!state.IsInitialized()) {
 237       continue;
 238     }
 239
 240     aCallback(sFeatureInfo[i].name, sFeatureInfo[i].description, state);
 241   }
 242 }
 243
 244 static const char* sFallbackNames[] = {
 245 #define FOR_EACH_FALLBACK(name) #name,
 246     GFX_FALLBACK_MAP(FOR_EACH_FALLBACK)
 247 #undef FOR_EACH_FALLBACK
 248         nullptr};
 249
 250 /* static  */
 251 void gfxConfig::ForEachFallback(const FallbackIterCallback& aCallback) {
 252   sConfig->ForEachFallbackImpl(aCallback);
 253 }
 254
 255 void gfxConfig::ForEachFallbackImpl(const FallbackIterCallback& aCallback) {
 256   for (size_t i = 0; i < mNumFallbackLogEntries; i++) {
 257     const FallbackLogEntry& entry = mFallbackLog[i];
 258     aCallback(sFallbackNames[size_t(entry.mFallback)], entry.mMessage);
 259   }
 260 }
 261
 262 /* static */ const nsCString& gfxConfig::GetFailureId(Feature aFeature) {
 263   const FeatureState& state = sConfig->GetState(aFeature);
 264   return state.GetFailureId();
 265 }
 266
 267 /* static */
 268 void gfxConfig::ImportChange(Feature aFeature,
 269                              const Maybe<FeatureFailure>& aChange) {
 270   if (aChange.isNothing()) {
 271     return;
 272   }
 273
 274   const FeatureFailure& failure = aChange.ref();
 275   gfxConfig::SetFailed(aFeature, failure.status(), failure.message().get(),
 276                        failure.failureId());
 277 }
 278
 279 /* static */
 280 void gfxConfig::Init() { sConfig = mozilla::MakeUnique<gfxConfig>(); }
 281
 282 /* static */
 283 void gfxConfig::Shutdown() { sConfig = nullptr; }
 284
 285 }  // namespace gfx
 286 }  // namespace mozilla