widget/GfxInfoBase.h

   1 /* vim: se cin sw=2 ts=2 et : */
   2 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 #ifndef __mozilla_widget_GfxInfoBase_h__
   9 #define __mozilla_widget_GfxInfoBase_h__
  10
  11 #include "GfxDriverInfo.h"
  12 #include "GfxInfoCollector.h"
  13 #include "gfxFeature.h"
  14 #include "gfxTelemetry.h"
  15 #include "js/Value.h"
  16 #include "mozilla/Attributes.h"
  17 #include "mozilla/Maybe.h"
  18 #include "mozilla/Mutex.h"
  19 #include "mozilla/StaticPtr.h"
  20 #include "mozilla/gfx/GraphicsMessages.h"
  21 #include "nsCOMPtr.h"
  22 #include "nsIGfxInfo.h"
  23 #include "nsIGfxInfoDebug.h"
  24 #include "nsIObserver.h"
  25 #include "nsString.h"
  26 #include "nsTArray.h"
  27 #include "nsWeakReference.h"
  28
  29 namespace mozilla {
  30 namespace widget {
  31
  32 class GfxInfoBase : public nsIGfxInfo,
  33                     public nsIObserver,
  34                     public nsSupportsWeakReference
  35 #ifdef DEBUG
  36     ,
  37                     public nsIGfxInfoDebug
  38 #endif
  39 {
  40  public:
  41   GfxInfoBase();
  42
  43   NS_DECL_THREADSAFE_ISUPPORTS
  44   NS_DECL_NSIOBSERVER
  45
  46   // We only declare a subset of the nsIGfxInfo interface. It's up to derived
  47   // classes to implement the rest of the interface.
  48   // Derived classes need to use
  49   // using GfxInfoBase::GetFeatureStatus;
  50   // using GfxInfoBase::GetFeatureSuggestedDriverVersion;
  51   // to import the relevant methods into their namespace.
  52   NS_IMETHOD GetFeatureStatus(int32_t aFeature, nsACString& aFailureId,
  53                               int32_t* _retval) override;
  54   NS_IMETHOD GetFeatureSuggestedDriverVersion(int32_t aFeature,
  55                                               nsAString& _retval) override;
  56
  57   NS_IMETHOD GetMonitors(JSContext* cx,
  58                          JS::MutableHandle<JS::Value> _retval) override;
  59   NS_IMETHOD GetFailures(nsTArray<int32_t>& indices,
  60                          nsTArray<nsCString>& failures) override;
  61   NS_IMETHOD_(void) LogFailure(const nsACString& failure) override;
  62   NS_IMETHOD GetInfo(JSContext*, JS::MutableHandle<JS::Value>) override;
  63   NS_IMETHOD GetFeatures(JSContext*, JS::MutableHandle<JS::Value>) override;
  64   NS_IMETHOD GetFeatureLog(JSContext*, JS::MutableHandle<JS::Value>) override;
  65   NS_IMETHOD GetActiveCrashGuards(JSContext*,
  66                                   JS::MutableHandle<JS::Value>) override;
  67   NS_IMETHOD GetContentBackend(nsAString& aContentBackend) override;
  68   NS_IMETHOD GetAzureCanvasBackend(nsAString& aBackend) override;
  69   NS_IMETHOD GetAzureContentBackend(nsAString& aBackend) override;
  70   NS_IMETHOD GetUsingGPUProcess(bool* aOutValue) override;
  71   NS_IMETHOD GetIsHeadless(bool* aIsHeadless) override;
  72   NS_IMETHOD GetTargetFrameRate(uint32_t* aTargetFrameRate) override;
  73   NS_IMETHOD GetCodecSupportInfo(nsACString& aCodecSupportInfo) override;
  74
  75   // Non-XPCOM method to get IPC data:
  76   nsTArray<mozilla::gfx::GfxInfoFeatureStatus> GetAllFeatures();
  77
  78   // Initialization function. If you override this, you must call this class's
  79   // version of Init first.
  80   // We need Init to be called separately from the constructor so we can
  81   // register as an observer after all derived classes have been constructed
  82   // and we know we have a non-zero refcount.
  83   // Ideally, Init() would be void-return, but the rules of
  84   // NS_GENERIC_FACTORY_CONSTRUCTOR_INIT require it be nsresult return.
  85   virtual nsresult Init();
  86
  87   NS_IMETHOD_(void) GetData() override;
  88   NS_IMETHOD_(int32_t) GetMaxRefreshRate(bool* aMixed) override;
  89
  90   static void AddCollector(GfxInfoCollectorBase* collector);
  91   static void RemoveCollector(GfxInfoCollectorBase* collector);
  92
  93   static nsTArray<GfxDriverInfo>* sDriverInfo;
  94   static StaticAutoPtr<nsTArray<mozilla::gfx::GfxInfoFeatureStatus>>
  95       sFeatureStatus;
  96   static bool sDriverInfoObserverInitialized;
  97   static bool sShutdownOccurred;
  98
  99   virtual nsString Model() { return u""_ns; }
 100   virtual nsString Hardware() { return u""_ns; }
 101   virtual nsString Product() { return u""_ns; }
 102   virtual nsString Manufacturer() { return u""_ns; }
 103   virtual uint32_t OperatingSystemVersion() { return 0; }
 104   virtual uint32_t OperatingSystemBuild() { return 0; }
 105
 106   // Convenience to get the application version
 107   static const nsCString& GetApplicationVersion();
 108
 109   virtual nsresult FindMonitors(JSContext* cx, JS::Handle<JSObject*> array);
 110
 111   static void SetFeatureStatus(
 112       nsTArray<mozilla::gfx::GfxInfoFeatureStatus>&& aFS);
 113
 114  protected:
 115   virtual ~GfxInfoBase();
 116
 117   virtual OperatingSystem GetOperatingSystem() = 0;
 118
 119   virtual nsresult GetFeatureStatusImpl(
 120       int32_t aFeature, int32_t* aStatus, nsAString& aSuggestedDriverVersion,
 121       const nsTArray<GfxDriverInfo>& aDriverInfo, nsACString& aFailureId,
 122       OperatingSystem* aOS = nullptr);
 123
 124   // Gets the driver info table. Used by GfxInfoBase to check for general cases
 125   // (while subclasses check for more specific ones).
 126   virtual const nsTArray<GfxDriverInfo>& GetGfxDriverInfo() = 0;
 127
 128   virtual void DescribeFeatures(JSContext* aCx, JS::Handle<JSObject*> obj);
 129
 130   bool DoesDesktopEnvironmentMatch(const nsAString& aBlocklistDesktop,
 131                                    const nsAString& aDesktopEnv);
 132
 133   virtual bool DoesWindowProtocolMatch(
 134       const nsAString& aBlocklistWindowProtocol,
 135       const nsAString& aWindowProtocol);
 136
 137   bool DoesVendorMatch(const nsAString& aBlocklistVendor,
 138                        const nsAString& aAdapterVendor);
 139
 140   virtual bool DoesDriverVendorMatch(const nsAString& aBlocklistVendor,
 141                                      const nsAString& aDriverVendor);
 142
 143   bool InitFeatureObject(JSContext* aCx, JS::Handle<JSObject*> aContainer,
 144                          const char* aName,
 145                          mozilla::gfx::FeatureState& aFeatureState,
 146                          JS::MutableHandle<JSObject*> aOutObj);
 147
 148   NS_IMETHOD ControlGPUProcessForXPCShell(bool aEnable, bool* _retval) override;
 149
 150   NS_IMETHOD KillGPUProcessForTests() override;
 151   NS_IMETHOD CrashGPUProcessForTests() override;
 152
 153   // Total number of pixels for all detected screens at startup.
 154   int64_t mScreenPixels;
 155
 156  private:
 157   virtual int32_t FindBlocklistedDeviceInList(
 158       const nsTArray<GfxDriverInfo>& aDriverInfo, nsAString& aSuggestedVersion,
 159       int32_t aFeature, nsACString& aFailureId, OperatingSystem os,
 160       bool aForAllowing);
 161
 162   bool IsFeatureAllowlisted(int32_t aFeature) const;
 163
 164   void EvaluateDownloadedBlocklist(nsTArray<GfxDriverInfo>& aDriverInfo);
 165
 166   bool BuildFeatureStateLog(JSContext* aCx, const gfx::FeatureState& aFeature,
 167                             JS::MutableHandle<JS::Value> aOut);
 168
 169   Mutex mMutex MOZ_UNANNOTATED;
 170 };
 171
 172 }  // namespace widget
 173 }  // namespace mozilla
 174
 175 #endif /* __mozilla_widget_GfxInfoBase_h__ */