gfx/gl/GLContextProviderEGL.cpp

   1 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #if defined(MOZ_WIDGET_GTK)
   7 #  define GET_NATIVE_WINDOW_FROM_REAL_WIDGET(aWidget) \
   8     ((EGLNativeWindowType)aWidget->GetNativeData(NS_NATIVE_EGL_WINDOW))
   9 #  define GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aWidget) \
  10     (aWidget->AsGTK()->GetEGLNativeWindow())
  11 #elif defined(MOZ_WIDGET_ANDROID)
  12 #  define GET_NATIVE_WINDOW_FROM_REAL_WIDGET(aWidget) \
  13     ((EGLNativeWindowType)aWidget->GetNativeData(NS_JAVA_SURFACE))
  14 #  define GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aWidget) \
  15     (aWidget->AsAndroid()->GetEGLNativeWindow())
  16 #elif defined(XP_WIN)
  17 #  define GET_NATIVE_WINDOW_FROM_REAL_WIDGET(aWidget) \
  18     ((EGLNativeWindowType)aWidget->GetNativeData(NS_NATIVE_WINDOW))
  19 #  define GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aWidget) \
  20     ((EGLNativeWindowType)aWidget->AsWindows()->GetHwnd())
  21 #else
  22 #  define GET_NATIVE_WINDOW_FROM_REAL_WIDGET(aWidget) \
  23     ((EGLNativeWindowType)aWidget->GetNativeData(NS_NATIVE_WINDOW))
  24 #  define GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aWidget)     \
  25     ((EGLNativeWindowType)aWidget->RealWidget()->GetNativeData( \
  26         NS_NATIVE_WINDOW))
  27 #endif
  28
  29 #if defined(XP_UNIX)
  30 #  ifdef MOZ_WIDGET_ANDROID
  31 #    include <android/native_window.h>
  32 #    include <android/native_window_jni.h>
  33 #    include "mozilla/widget/AndroidCompositorWidget.h"
  34 #  endif
  35
  36 #  define GLES2_LIB "libGLESv2.so"
  37 #  define GLES2_LIB2 "libGLESv2.so.2"
  38
  39 #elif defined(XP_WIN)
  40 #  include "mozilla/widget/WinCompositorWidget.h"
  41 #  include "nsIFile.h"
  42
  43 #  define GLES2_LIB "libGLESv2.dll"
  44
  45 #  ifndef WIN32_LEAN_AND_MEAN
  46 #    define WIN32_LEAN_AND_MEAN 1
  47 #  endif
  48
  49 #  include <windows.h>
  50 #else
  51 #  error "Platform not recognized"
  52 #endif
  53
  54 #include "gfxCrashReporterUtils.h"
  55 #include "gfxFailure.h"
  56 #include "gfxPlatform.h"
  57 #include "gfxUtils.h"
  58 #include "GLBlitHelper.h"
  59 #include "GLContextEGL.h"
  60 #include "GLContextProvider.h"
  61 #include "GLLibraryEGL.h"
  62 #include "GLLibraryLoader.h"
  63 #include "mozilla/ArrayUtils.h"
  64 #include "mozilla/Preferences.h"
  65 #include "mozilla/Services.h"
  66 #include "mozilla/StaticPrefs_gfx.h"
  67 #include "mozilla/gfx/gfxVars.h"
  68 #include "mozilla/gfx/BuildConstants.h"
  69 #include "mozilla/gfx/Logging.h"
  70 #include "mozilla/layers/CompositorOptions.h"
  71 #include "mozilla/widget/CompositorWidget.h"
  72 #include "nsDebug.h"
  73 #include "nsIWidget.h"
  74 #include "nsThreadUtils.h"
  75 #include "ScopedGLHelpers.h"
  76
  77 #if defined(MOZ_WIDGET_GTK)
  78 #  include "mozilla/widget/GtkCompositorWidget.h"
  79 #  if defined(MOZ_WAYLAND)
  80 #    include <gdk/gdkwayland.h>
  81 #    include <wayland-egl.h>
  82 #    include "mozilla/WidgetUtilsGtk.h"
  83 #    include "mozilla/widget/nsWaylandDisplay.h"
  84 #  endif
  85 #endif
  86
  87 struct wl_egl_window;
  88
  89 using namespace mozilla::gfx;
  90
  91 namespace mozilla {
  92 namespace gl {
  93
  94 using namespace mozilla::widget;
  95
  96 #if defined(MOZ_WAYLAND)
  97 class WaylandOffscreenGLSurface {
  98  public:
  99   WaylandOffscreenGLSurface(struct wl_surface* aWaylandSurface,
 100                             struct wl_egl_window* aEGLWindow);
 101   ~WaylandOffscreenGLSurface();
 102
 103  private:
 104   struct wl_surface* mWaylandSurface = nullptr;
 105   struct wl_egl_window* mEGLWindow = nullptr;
 106 };
 107
 108 static nsTHashMap<nsPtrHashKey<void>, WaylandOffscreenGLSurface*>
 109     sWaylandOffscreenGLSurfaces;
 110
 111 void DeleteWaylandOffscreenGLSurface(EGLSurface surface) {
 112   auto entry = sWaylandOffscreenGLSurfaces.Lookup(surface);
 113   if (entry) {
 114     delete entry.Data();
 115     entry.Remove();
 116   }
 117 }
 118 #endif
 119
 120 static bool CreateConfigScreen(EglDisplay&, EGLConfig* const aConfig,
 121                                const bool aEnableDepthBuffer,
 122                                const bool aUseGles);
 123
 124 // append three zeros at the end of attribs list to work around
 125 // EGL implementation bugs that iterate until they find 0, instead of
 126 // EGL_NONE. See bug 948406.
 127 #define EGL_ATTRIBS_LIST_SAFE_TERMINATION_WORKING_AROUND_BUGS \
 128   LOCAL_EGL_NONE, 0, 0, 0
 129
 130 static EGLint kTerminationAttribs[] = {
 131     EGL_ATTRIBS_LIST_SAFE_TERMINATION_WORKING_AROUND_BUGS};
 132
 133 static int next_power_of_two(int v) {
 134   v--;
 135   v |= v >> 1;
 136   v |= v >> 2;
 137   v |= v >> 4;
 138   v |= v >> 8;
 139   v |= v >> 16;
 140   v++;
 141
 142   return v;
 143 }
 144
 145 static bool is_power_of_two(int v) {
 146   NS_ASSERTION(v >= 0, "bad value");
 147
 148   if (v == 0) return true;
 149
 150   return (v & (v - 1)) == 0;
 151 }
 152
 153 static EGLSurface CreateFallbackSurface(EglDisplay& egl,
 154                                         const EGLConfig& config) {
 155   if (egl.IsExtensionSupported(EGLExtension::KHR_surfaceless_context)) {
 156     // We don't need a PBuffer surface in this case
 157     return EGL_NO_SURFACE;
 158   }
 159
 160   std::vector<EGLint> pbattrs;
 161   pbattrs.push_back(LOCAL_EGL_WIDTH);
 162   pbattrs.push_back(1);
 163   pbattrs.push_back(LOCAL_EGL_HEIGHT);
 164   pbattrs.push_back(1);
 165
 166   for (const auto& cur : kTerminationAttribs) {
 167     pbattrs.push_back(cur);
 168   }
 169
 170   EGLSurface surface = egl.fCreatePbufferSurface(config, pbattrs.data());
 171   if (!surface) {
 172     MOZ_CRASH("Failed to create fallback EGLSurface");
 173   }
 174
 175   return surface;
 176 }
 177
 178 static EGLSurface CreateSurfaceFromNativeWindow(
 179     EglDisplay& egl, const EGLNativeWindowType window, const EGLConfig config) {
 180   MOZ_ASSERT(window);
 181   EGLSurface newSurface = EGL_NO_SURFACE;
 182
 183 #ifdef MOZ_WIDGET_ANDROID
 184   JNIEnv* const env = jni::GetEnvForThread();
 185   ANativeWindow* const nativeWindow =
 186       ANativeWindow_fromSurface(env, reinterpret_cast<jobject>(window));
 187   if (!nativeWindow) {
 188     gfxCriticalNote << "Failed to obtain native window from Surface";
 189     return EGL_NO_SURFACE;
 190   }
 191   const auto& display = egl.mLib->fGetDisplay(EGL_DEFAULT_DISPLAY);
 192   newSurface = egl.mLib->fCreateWindowSurface(display, config, nativeWindow, 0);
 193   ANativeWindow_release(nativeWindow);
 194 #else
 195   newSurface = egl.fCreateWindowSurface(config, window, 0);
 196 #endif
 197   if (!newSurface) {
 198     const auto err = egl.mLib->fGetError();
 199     gfxCriticalNote << "Failed to create EGLSurface!: " << gfx::hexa(err);
 200   }
 201   return newSurface;
 202 }
 203
 204 /* GLContextEGLFactory class was added as a friend of GLContextEGL
 205  * so that it could access  GLContextEGL::CreateGLContext. This was
 206  * done so that a new function would not need to be added to the shared
 207  * GLContextProvider interface.
 208  */
 209 class GLContextEGLFactory {
 210  public:
 211   static already_AddRefed<GLContext> Create(EGLNativeWindowType aWindow,
 212                                             bool aHardwareWebRender);
 213   static already_AddRefed<GLContext> CreateImpl(EGLNativeWindowType aWindow,
 214                                                 bool aHardwareWebRender,
 215                                                 bool aUseGles);
 216
 217  private:
 218   GLContextEGLFactory() = default;
 219   ~GLContextEGLFactory() = default;
 220 };
 221
 222 already_AddRefed<GLContext> GLContextEGLFactory::CreateImpl(
 223     EGLNativeWindowType aWindow, bool aHardwareWebRender, bool aUseGles) {
 224   nsCString failureId;
 225   const auto lib = GLLibraryEGL::Get(&failureId);
 226   if (!lib) {
 227     gfxCriticalNote << "Failed[3] to load EGL library: " << failureId.get();
 228     return nullptr;
 229   }
 230   const auto egl = lib->CreateDisplay(true, &failureId);
 231   if (!egl) {
 232     gfxCriticalNote << "Failed[3] to create EGL library  display: "
 233                     << failureId.get();
 234     return nullptr;
 235   }
 236
 237   bool doubleBuffered = true;
 238
 239   EGLConfig config;
 240   if (aHardwareWebRender && egl->mLib->IsANGLE()) {
 241     // Force enable alpha channel to make sure ANGLE use correct framebuffer
 242     // formart
 243     const int bpp = 32;
 244     if (!CreateConfig(*egl, &config, bpp, false, aUseGles)) {
 245       gfxCriticalNote << "Failed to create EGLConfig for WebRender ANGLE!";
 246       return nullptr;
 247     }
 248   } else if (kIsLinux) {
 249     const int bpp = 32;
 250     if (!CreateConfig(*egl, &config, bpp, false, aUseGles)) {
 251       gfxCriticalNote << "Failed to create EGLConfig for WebRender!";
 252       return nullptr;
 253     }
 254   } else {
 255     if (!CreateConfigScreen(*egl, &config,
 256                             /* aEnableDepthBuffer */ false, aUseGles)) {
 257       gfxCriticalNote << "Failed to create EGLConfig!";
 258       return nullptr;
 259     }
 260   }
 261
 262   EGLSurface surface = EGL_NO_SURFACE;
 263   if (aWindow) {
 264     surface = mozilla::gl::CreateSurfaceFromNativeWindow(*egl, aWindow, config);
 265     if (!surface) {
 266       return nullptr;
 267     }
 268   }
 269
 270   CreateContextFlags flags = CreateContextFlags::NONE;
 271   if (aHardwareWebRender &&
 272       StaticPrefs::gfx_webrender_prefer_robustness_AtStartup()) {
 273     flags |= CreateContextFlags::PREFER_ROBUSTNESS;
 274   }
 275   if (aHardwareWebRender && aUseGles) {
 276     flags |= CreateContextFlags::PREFER_ES3;
 277   }
 278   if (!aHardwareWebRender) {
 279     flags |= CreateContextFlags::REQUIRE_COMPAT_PROFILE;
 280   }
 281
 282   const auto desc = GLContextDesc{{flags}, false};
 283   RefPtr<GLContextEGL> gl = GLContextEGL::CreateGLContext(
 284       egl, desc, config, surface, aUseGles, config, &failureId);
 285   if (!gl) {
 286     const auto err = egl->mLib->fGetError();
 287     gfxCriticalNote << "Failed to create EGLContext!: " << gfx::hexa(err);
 288     GLContextEGL::DestroySurface(*egl, surface);
 289     return nullptr;
 290   }
 291
 292   gl->MakeCurrent();
 293   gl->SetIsDoubleBuffered(doubleBuffered);
 294
 295 #ifdef MOZ_WIDGET_GTK
 296   if (surface) {
 297     const int interval = gfxVars::SwapIntervalEGL() ? 1 : 0;
 298     egl->fSwapInterval(interval);
 299   }
 300 #endif
 301   if (aHardwareWebRender && egl->mLib->IsANGLE()) {
 302     MOZ_ASSERT(doubleBuffered);
 303     const int interval = gfxVars::SwapIntervalEGL() ? 1 : 0;
 304     egl->fSwapInterval(interval);
 305   }
 306   return gl.forget();
 307 }
 308
 309 already_AddRefed<GLContext> GLContextEGLFactory::Create(
 310     EGLNativeWindowType aWindow, bool aHardwareWebRender) {
 311   bool preferGles;
 312 #if defined(MOZ_WIDGET_ANDROID)
 313   preferGles = true;
 314 #else
 315   preferGles = StaticPrefs::gfx_egl_prefer_gles_enabled_AtStartup();
 316 #endif  // defined(MOZ_WIDGET_ANDROID)
 317
 318   RefPtr<GLContext> glContext =
 319       CreateImpl(aWindow, aHardwareWebRender, preferGles);
 320 #if !defined(MOZ_WIDGET_ANDROID)
 321   if (!glContext) {
 322     glContext = CreateImpl(aWindow, aHardwareWebRender, !preferGles);
 323   }
 324 #endif  // !defined(MOZ_WIDGET_ANDROID)
 325   return glContext.forget();
 326 }
 327
 328 /* static */
 329 EGLSurface GLContextEGL::CreateEGLSurfaceForCompositorWidget(
 330     widget::CompositorWidget* aCompositorWidget, const EGLConfig aConfig) {
 331   nsCString discardFailureId;
 332   const auto egl = DefaultEglDisplay(&discardFailureId);
 333   if (!egl) {
 334     gfxCriticalNote << "Failed to load EGL library 6!";
 335     return EGL_NO_SURFACE;
 336   }
 337
 338   MOZ_ASSERT(aCompositorWidget);
 339   EGLNativeWindowType window =
 340       GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aCompositorWidget);
 341   if (!window) {
 342 #ifdef MOZ_WIDGET_GTK
 343     // RenderCompositorEGL does not like EGL_NO_SURFACE as it fallbacks
 344     // to SW rendering or claims itself as paused.
 345     // In case we're missing valid native window because aCompositorWidget
 346     // hidden, just create a fallback EGLSurface. Actual EGLSurface will be
 347     // created by widget code later when aCompositorWidget becomes visible.
 348     mozilla::gfx::IntSize pbSize(16, 16);
 349 #  ifdef MOZ_WAYLAND
 350     if (GdkIsWaylandDisplay()) {
 351       return CreateWaylandOffscreenSurface(*egl, aConfig, pbSize);
 352     } else
 353 #  endif
 354     {
 355       return CreatePBufferSurfaceTryingPowerOfTwo(*egl, aConfig, LOCAL_EGL_NONE,
 356                                                   pbSize);
 357     }
 358 #else
 359     gfxCriticalNote << "window is null";
 360     return EGL_NO_SURFACE;
 361 #endif
 362   }
 363
 364   return mozilla::gl::CreateSurfaceFromNativeWindow(*egl, window, aConfig);
 365 }
 366
 367 GLContextEGL::GLContextEGL(const std::shared_ptr<EglDisplay> egl,
 368                            const GLContextDesc& desc, EGLConfig surfaceConfig,
 369                            EGLSurface surface, EGLContext context)
 370     : GLContext(desc, nullptr, false),
 371       mEgl(egl),
 372       mSurfaceConfig(surfaceConfig),
 373       mContext(context),
 374       mSurface(surface),
 375       mFallbackSurface(CreateFallbackSurface(*mEgl, mSurfaceConfig)) {
 376 #ifdef DEBUG
 377   printf_stderr("Initializing context %p surface %p on display %p\n", mContext,
 378                 mSurface, mEgl->mDisplay);
 379 #endif
 380 }
 381
 382 void GLContextEGL::OnMarkDestroyed() {
 383   if (mSurfaceOverride != EGL_NO_SURFACE) {
 384     SetEGLSurfaceOverride(EGL_NO_SURFACE);
 385   }
 386 }
 387
 388 GLContextEGL::~GLContextEGL() {
 389   MarkDestroyed();
 390
 391   // Wrapped context should not destroy eglContext/Surface
 392   if (!mOwnsContext) {
 393     return;
 394   }
 395
 396 #ifdef DEBUG
 397   printf_stderr("Destroying context %p surface %p on display %p\n", mContext,
 398                 mSurface, mEgl->mDisplay);
 399 #endif
 400
 401   mEgl->fDestroyContext(mContext);
 402
 403   DestroySurface(*mEgl, mSurface);
 404   DestroySurface(*mEgl, mFallbackSurface);
 405 }
 406
 407 bool GLContextEGL::Init() {
 408   if (!GLContext::Init()) return false;
 409
 410   bool current = MakeCurrent();
 411   if (!current) {
 412     gfx::LogFailure("Couldn't get device attachments for device."_ns);
 413     return false;
 414   }
 415
 416   mShareWithEGLImage =
 417       mEgl->HasKHRImageBase() &&
 418       mEgl->IsExtensionSupported(EGLExtension::KHR_gl_texture_2D_image) &&
 419       IsExtensionSupported(OES_EGL_image);
 420
 421   return true;
 422 }
 423
 424 bool GLContextEGL::BindTexImage() {
 425   if (!mSurface) return false;
 426
 427   if (mBound && !ReleaseTexImage()) return false;
 428
 429   EGLBoolean success =
 430       mEgl->fBindTexImage((EGLSurface)mSurface, LOCAL_EGL_BACK_BUFFER);
 431   if (success == LOCAL_EGL_FALSE) return false;
 432
 433   mBound = true;
 434   return true;
 435 }
 436
 437 bool GLContextEGL::ReleaseTexImage() {
 438   if (!mBound) return true;
 439
 440   if (!mSurface) return false;
 441
 442   EGLBoolean success;
 443   success = mEgl->fReleaseTexImage((EGLSurface)mSurface, LOCAL_EGL_BACK_BUFFER);
 444   if (success == LOCAL_EGL_FALSE) return false;
 445
 446   mBound = false;
 447   return true;
 448 }
 449
 450 void GLContextEGL::SetEGLSurfaceOverride(EGLSurface surf) {
 451   mSurfaceOverride = surf;
 452   DebugOnly<bool> ok = MakeCurrent(true);
 453   MOZ_ASSERT(ok);
 454 }
 455
 456 bool GLContextEGL::MakeCurrentImpl() const {
 457   EGLSurface surface =
 458       (mSurfaceOverride != EGL_NO_SURFACE) ? mSurfaceOverride : mSurface;
 459   if (!surface) {
 460     surface = mFallbackSurface;
 461   }
 462
 463   const bool succeeded = mEgl->fMakeCurrent(surface, surface, mContext);
 464   if (!succeeded) {
 465     const auto eglError = mEgl->mLib->fGetError();
 466     if (eglError == LOCAL_EGL_CONTEXT_LOST) {
 467       OnContextLostError();
 468     } else {
 469       NS_WARNING("Failed to make GL context current!");
 470 #ifdef DEBUG
 471       printf_stderr("EGL Error: 0x%04x\n", eglError);
 472 #endif
 473     }
 474   }
 475
 476   return succeeded;
 477 }
 478
 479 bool GLContextEGL::IsCurrentImpl() const {
 480   return mEgl->mLib->fGetCurrentContext() == mContext;
 481 }
 482
 483 bool GLContextEGL::RenewSurface(CompositorWidget* aWidget) {
 484   if (!mOwnsContext) {
 485     return false;
 486   }
 487   // unconditionally release the surface and create a new one. Don't try to
 488   // optimize this away. If we get here, then by definition we know that we want
 489   // to get a new surface.
 490   ReleaseSurface();
 491   MOZ_ASSERT(aWidget);
 492
 493   EGLNativeWindowType nativeWindow =
 494       GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aWidget);
 495   if (nativeWindow) {
 496     mSurface = mozilla::gl::CreateSurfaceFromNativeWindow(*mEgl, nativeWindow,
 497                                                           mSurfaceConfig);
 498     if (!mSurface) {
 499       NS_WARNING("Failed to create EGLSurface from native window");
 500       return false;
 501     }
 502   }
 503   const bool ok = MakeCurrent(true);
 504   MOZ_ASSERT(ok);
 505 #ifdef MOZ_WIDGET_GTK
 506   if (mSurface) {
 507     const int interval = gfxVars::SwapIntervalEGL() ? 1 : 0;
 508     mEgl->fSwapInterval(interval);
 509   }
 510 #endif
 511   return ok;
 512 }
 513
 514 void GLContextEGL::ReleaseSurface() {
 515   if (mOwnsContext) {
 516     DestroySurface(*mEgl, mSurface);
 517   }
 518   if (mSurface == mSurfaceOverride) {
 519     mSurfaceOverride = EGL_NO_SURFACE;
 520   }
 521   mSurface = EGL_NO_SURFACE;
 522 }
 523
 524 Maybe<SymbolLoader> GLContextEGL::GetSymbolLoader() const {
 525   return mEgl->mLib->GetSymbolLoader();
 526 }
 527
 528 bool GLContextEGL::SwapBuffers() {
 529   EGLSurface surface =
 530       mSurfaceOverride != EGL_NO_SURFACE ? mSurfaceOverride : mSurface;
 531   if (surface) {
 532     if ((mEgl->IsExtensionSupported(
 533              EGLExtension::EXT_swap_buffers_with_damage) ||
 534          mEgl->IsExtensionSupported(
 535              EGLExtension::KHR_swap_buffers_with_damage))) {
 536       std::vector<EGLint> rects;
 537       for (auto iter = mDamageRegion.RectIter(); !iter.Done(); iter.Next()) {
 538         const IntRect& r = iter.Get();
 539         rects.push_back(r.X());
 540         rects.push_back(r.Y());
 541         rects.push_back(r.Width());
 542         rects.push_back(r.Height());
 543       }
 544       mDamageRegion.SetEmpty();
 545       return mEgl->fSwapBuffersWithDamage(surface, rects.data(),
 546                                           rects.size() / 4);
 547     }
 548     return mEgl->fSwapBuffers(surface);
 549   } else {
 550     return false;
 551   }
 552 }
 553
 554 void GLContextEGL::SetDamage(const nsIntRegion& aDamageRegion) {
 555   mDamageRegion = aDamageRegion;
 556 }
 557
 558 void GLContextEGL::GetWSIInfo(nsCString* const out) const {
 559   out->AppendLiteral("EGL_VENDOR: ");
 560   out->Append(
 561       (const char*)mEgl->mLib->fQueryString(mEgl->mDisplay, LOCAL_EGL_VENDOR));
 562
 563   out->AppendLiteral("\nEGL_VERSION: ");
 564   out->Append(
 565       (const char*)mEgl->mLib->fQueryString(mEgl->mDisplay, LOCAL_EGL_VERSION));
 566
 567   out->AppendLiteral("\nEGL_EXTENSIONS: ");
 568   out->Append((const char*)mEgl->mLib->fQueryString(mEgl->mDisplay,
 569                                                     LOCAL_EGL_EXTENSIONS));
 570
 571 #ifndef ANDROID  // This query will crash some old android.
 572   out->AppendLiteral("\nEGL_EXTENSIONS(nullptr): ");
 573   out->Append(
 574       (const char*)mEgl->mLib->fQueryString(nullptr, LOCAL_EGL_EXTENSIONS));
 575 #endif
 576 }
 577
 578 bool GLContextEGL::HasExtBufferAge() const {
 579   return mEgl->IsExtensionSupported(EGLExtension::EXT_buffer_age);
 580 }
 581
 582 bool GLContextEGL::HasKhrPartialUpdate() const {
 583   return mEgl->IsExtensionSupported(EGLExtension::KHR_partial_update);
 584 }
 585
 586 GLint GLContextEGL::GetBufferAge() const {
 587   EGLSurface surface =
 588       mSurfaceOverride != EGL_NO_SURFACE ? mSurfaceOverride : mSurface;
 589
 590   if (surface && (HasExtBufferAge() || HasKhrPartialUpdate())) {
 591     EGLint result;
 592     mEgl->fQuerySurface(surface, LOCAL_EGL_BUFFER_AGE_EXT, &result);
 593     return result;
 594   }
 595
 596   return 0;
 597 }
 598
 599 #define LOCAL_EGL_CONTEXT_PROVOKING_VERTEX_DONT_CARE_MOZ 0x6000
 600
 601 RefPtr<GLContextEGL> GLContextEGL::CreateGLContext(
 602     const std::shared_ptr<EglDisplay> egl, const GLContextDesc& desc,
 603     EGLConfig surfaceConfig, EGLSurface surface, const bool useGles,
 604     EGLConfig contextConfig, nsACString* const out_failureId) {
 605   const auto& flags = desc.flags;
 606
 607   std::vector<EGLint> required_attribs;
 608
 609   if (useGles) {
 610     // TODO: This fBindAPI could be more thread-safe
 611     if (egl->mLib->fBindAPI(LOCAL_EGL_OPENGL_ES_API) == LOCAL_EGL_FALSE) {
 612       *out_failureId = "FEATURE_FAILURE_EGL_ES"_ns;
 613       NS_WARNING("Failed to bind API to GLES!");
 614       return nullptr;
 615     }
 616     required_attribs.push_back(LOCAL_EGL_CONTEXT_MAJOR_VERSION);
 617     if (flags & CreateContextFlags::PREFER_ES3) {
 618       required_attribs.push_back(3);
 619     } else {
 620       required_attribs.push_back(2);
 621     }
 622   } else {
 623     if (egl->mLib->fBindAPI(LOCAL_EGL_OPENGL_API) == LOCAL_EGL_FALSE) {
 624       *out_failureId = "FEATURE_FAILURE_EGL"_ns;
 625       NS_WARNING("Failed to bind API to GL!");
 626       return nullptr;
 627     }
 628     if (flags & CreateContextFlags::REQUIRE_COMPAT_PROFILE) {
 629       required_attribs.push_back(LOCAL_EGL_CONTEXT_OPENGL_PROFILE_MASK);
 630       required_attribs.push_back(
 631           LOCAL_EGL_CONTEXT_OPENGL_COMPATIBILITY_PROFILE_BIT);
 632       required_attribs.push_back(LOCAL_EGL_CONTEXT_MAJOR_VERSION);
 633       required_attribs.push_back(2);
 634     } else {
 635       // !REQUIRE_COMPAT_PROFILE means core profle.
 636       required_attribs.push_back(LOCAL_EGL_CONTEXT_OPENGL_PROFILE_MASK);
 637       required_attribs.push_back(LOCAL_EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT);
 638       required_attribs.push_back(LOCAL_EGL_CONTEXT_MAJOR_VERSION);
 639       required_attribs.push_back(3);
 640       required_attribs.push_back(LOCAL_EGL_CONTEXT_MINOR_VERSION);
 641       required_attribs.push_back(2);
 642     }
 643   }
 644
 645   if ((flags & CreateContextFlags::PREFER_EXACT_VERSION) &&
 646       egl->mLib->IsANGLE()) {
 647     required_attribs.push_back(
 648         LOCAL_EGL_CONTEXT_OPENGL_BACKWARDS_COMPATIBLE_ANGLE);
 649     required_attribs.push_back(LOCAL_EGL_FALSE);
 650   }
 651
 652   const auto debugFlags = GLContext::ChooseDebugFlags(flags);
 653   if (!debugFlags && flags & CreateContextFlags::NO_VALIDATION &&
 654       egl->IsExtensionSupported(EGLExtension::KHR_create_context_no_error)) {
 655     required_attribs.push_back(LOCAL_EGL_CONTEXT_OPENGL_NO_ERROR_KHR);
 656     required_attribs.push_back(LOCAL_EGL_TRUE);
 657   }
 658
 659   if (flags & CreateContextFlags::PROVOKING_VERTEX_DONT_CARE &&
 660       egl->IsExtensionSupported(
 661           EGLExtension::MOZ_create_context_provoking_vertex_dont_care)) {
 662     required_attribs.push_back(
 663         LOCAL_EGL_CONTEXT_PROVOKING_VERTEX_DONT_CARE_MOZ);
 664     required_attribs.push_back(LOCAL_EGL_TRUE);
 665   }
 666
 667   std::vector<EGLint> ext_robustness_attribs;
 668   std::vector<EGLint> ext_rbab_attribs;  // RBAB: Robust Buffer Access Behavior
 669   std::vector<EGLint> khr_robustness_attribs;
 670   std::vector<EGLint> khr_rbab_attribs;  // RBAB: Robust Buffer Access Behavior
 671   if (flags & CreateContextFlags::PREFER_ROBUSTNESS) {
 672     std::vector<EGLint> base_robustness_attribs = required_attribs;
 673     if (egl->IsExtensionSupported(
 674             EGLExtension::NV_robustness_video_memory_purge)) {
 675       base_robustness_attribs.push_back(
 676           LOCAL_EGL_GENERATE_RESET_ON_VIDEO_MEMORY_PURGE_NV);
 677       base_robustness_attribs.push_back(LOCAL_EGL_TRUE);
 678     }
 679
 680     if (egl->IsExtensionSupported(
 681             EGLExtension::EXT_create_context_robustness)) {
 682       ext_robustness_attribs = base_robustness_attribs;
 683       ext_robustness_attribs.push_back(
 684           LOCAL_EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY_EXT);
 685       ext_robustness_attribs.push_back(LOCAL_EGL_LOSE_CONTEXT_ON_RESET_EXT);
 686
 687       if (gfxVars::AllowEglRbab()) {
 688         ext_rbab_attribs = ext_robustness_attribs;
 689         ext_rbab_attribs.push_back(LOCAL_EGL_CONTEXT_OPENGL_ROBUST_ACCESS_EXT);
 690         ext_rbab_attribs.push_back(LOCAL_EGL_TRUE);
 691       }
 692     }
 693
 694     if (egl->IsExtensionSupported(EGLExtension::KHR_create_context)) {
 695       khr_robustness_attribs = base_robustness_attribs;
 696       khr_robustness_attribs.push_back(
 697           LOCAL_EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY_KHR);
 698       khr_robustness_attribs.push_back(LOCAL_EGL_LOSE_CONTEXT_ON_RESET_KHR);
 699
 700       khr_rbab_attribs = khr_robustness_attribs;
 701       khr_rbab_attribs.push_back(LOCAL_EGL_CONTEXT_FLAGS_KHR);
 702       khr_rbab_attribs.push_back(
 703           LOCAL_EGL_CONTEXT_OPENGL_ROBUST_ACCESS_BIT_KHR);
 704     }
 705   }
 706
 707   const auto fnCreate = [&](const std::vector<EGLint>& attribs) {
 708     auto terminated_attribs = attribs;
 709
 710     for (const auto& cur : kTerminationAttribs) {
 711       terminated_attribs.push_back(cur);
 712     }
 713
 714     return egl->fCreateContext(contextConfig, EGL_NO_CONTEXT,
 715                                terminated_attribs.data());
 716   };
 717
 718   EGLContext context;
 719   do {
 720     if (!khr_rbab_attribs.empty()) {
 721       context = fnCreate(khr_rbab_attribs);
 722       if (context) break;
 723       NS_WARNING("Failed to create EGLContext with khr_rbab_attribs");
 724     }
 725
 726     if (!ext_rbab_attribs.empty()) {
 727       context = fnCreate(ext_rbab_attribs);
 728       if (context) break;
 729       NS_WARNING("Failed to create EGLContext with ext_rbab_attribs");
 730     }
 731
 732     if (!khr_robustness_attribs.empty()) {
 733       context = fnCreate(khr_robustness_attribs);
 734       if (context) break;
 735       NS_WARNING("Failed to create EGLContext with khr_robustness_attribs");
 736     }
 737
 738     if (!ext_robustness_attribs.empty()) {
 739       context = fnCreate(ext_robustness_attribs);
 740       if (context) break;
 741       NS_WARNING("Failed to create EGLContext with ext_robustness_attribs");
 742     }
 743
 744     context = fnCreate(required_attribs);
 745     if (context) break;
 746     NS_WARNING("Failed to create EGLContext with required_attribs");
 747
 748     *out_failureId = "FEATURE_FAILURE_EGL_CREATE"_ns;
 749     return nullptr;
 750   } while (false);
 751   MOZ_ASSERT(context);
 752
 753   RefPtr<GLContextEGL> glContext =
 754       new GLContextEGL(egl, desc, surfaceConfig, surface, context);
 755   if (!glContext->Init()) {
 756     *out_failureId = "FEATURE_FAILURE_EGL_INIT"_ns;
 757     return nullptr;
 758   }
 759
 760   if (GLContext::ShouldSpew()) {
 761     printf_stderr("new GLContextEGL %p on EGLDisplay %p\n", glContext.get(),
 762                   egl->mDisplay);
 763   }
 764
 765   return glContext;
 766 }
 767
 768 // static
 769 EGLSurface GLContextEGL::CreatePBufferSurfaceTryingPowerOfTwo(
 770     EglDisplay& egl, EGLConfig config, EGLenum bindToTextureFormat,
 771     mozilla::gfx::IntSize& pbsize) {
 772   nsTArray<EGLint> pbattrs(16);
 773   EGLSurface surface = nullptr;
 774
 775 TRY_AGAIN_POWER_OF_TWO:
 776   pbattrs.Clear();
 777   pbattrs.AppendElement(LOCAL_EGL_WIDTH);
 778   pbattrs.AppendElement(pbsize.width);
 779   pbattrs.AppendElement(LOCAL_EGL_HEIGHT);
 780   pbattrs.AppendElement(pbsize.height);
 781
 782   if (bindToTextureFormat != LOCAL_EGL_NONE) {
 783     pbattrs.AppendElement(LOCAL_EGL_TEXTURE_TARGET);
 784     pbattrs.AppendElement(LOCAL_EGL_TEXTURE_2D);
 785
 786     pbattrs.AppendElement(LOCAL_EGL_TEXTURE_FORMAT);
 787     pbattrs.AppendElement(bindToTextureFormat);
 788   }
 789
 790   for (const auto& cur : kTerminationAttribs) {
 791     pbattrs.AppendElement(cur);
 792   }
 793
 794   surface = egl.fCreatePbufferSurface(config, &pbattrs[0]);
 795   if (!surface) {
 796     if (!is_power_of_two(pbsize.width) || !is_power_of_two(pbsize.height)) {
 797       if (!is_power_of_two(pbsize.width))
 798         pbsize.width = next_power_of_two(pbsize.width);
 799       if (!is_power_of_two(pbsize.height))
 800         pbsize.height = next_power_of_two(pbsize.height);
 801
 802       NS_WARNING("Failed to create pbuffer, trying power of two dims");
 803       goto TRY_AGAIN_POWER_OF_TWO;
 804     }
 805
 806     NS_WARNING("Failed to create pbuffer surface");
 807     return nullptr;
 808   }
 809
 810   return surface;
 811 }
 812
 813 #if defined(MOZ_WAYLAND)
 814 WaylandOffscreenGLSurface::WaylandOffscreenGLSurface(
 815     struct wl_surface* aWaylandSurface, struct wl_egl_window* aEGLWindow)
 816     : mWaylandSurface(aWaylandSurface), mEGLWindow(aEGLWindow) {}
 817
 818 WaylandOffscreenGLSurface::~WaylandOffscreenGLSurface() {
 819   if (mEGLWindow) {
 820     wl_egl_window_destroy(mEGLWindow);
 821   }
 822   if (mWaylandSurface) {
 823     wl_surface_destroy(mWaylandSurface);
 824   }
 825 }
 826
 827 // static
 828 EGLSurface GLContextEGL::CreateWaylandOffscreenSurface(
 829     EglDisplay& egl, EGLConfig config, mozilla::gfx::IntSize& pbsize) {
 830   wl_egl_window* eglwindow = nullptr;
 831
 832   struct wl_compositor* compositor =
 833       gdk_wayland_display_get_wl_compositor(gdk_display_get_default());
 834   struct wl_surface* wlsurface = wl_compositor_create_surface(compositor);
 835   eglwindow = wl_egl_window_create(wlsurface, pbsize.width, pbsize.height);
 836   if (!eglwindow) return nullptr;
 837
 838   const auto surface = egl.fCreateWindowSurface(
 839       config, reinterpret_cast<EGLNativeWindowType>(eglwindow), 0);
 840   if (surface) {
 841     MOZ_DIAGNOSTIC_ASSERT(!sWaylandOffscreenGLSurfaces.Contains(surface));
 842     sWaylandOffscreenGLSurfaces.LookupOrInsert(
 843         surface, new WaylandOffscreenGLSurface(wlsurface, eglwindow));
 844   }
 845   return surface;
 846 }
 847 #endif
 848
 849 static const EGLint kEGLConfigAttribsRGB16[] = {
 850     LOCAL_EGL_SURFACE_TYPE, LOCAL_EGL_WINDOW_BIT,
 851     LOCAL_EGL_RED_SIZE,     5,
 852     LOCAL_EGL_GREEN_SIZE,   6,
 853     LOCAL_EGL_BLUE_SIZE,    5,
 854     LOCAL_EGL_ALPHA_SIZE,   0};
 855
 856 static const EGLint kEGLConfigAttribsRGB24[] = {
 857     LOCAL_EGL_SURFACE_TYPE, LOCAL_EGL_WINDOW_BIT,
 858     LOCAL_EGL_RED_SIZE,     8,
 859     LOCAL_EGL_GREEN_SIZE,   8,
 860     LOCAL_EGL_BLUE_SIZE,    8,
 861     LOCAL_EGL_ALPHA_SIZE,   0};
 862
 863 static const EGLint kEGLConfigAttribsRGBA32[] = {
 864     LOCAL_EGL_SURFACE_TYPE, LOCAL_EGL_WINDOW_BIT,
 865     LOCAL_EGL_RED_SIZE,     8,
 866     LOCAL_EGL_GREEN_SIZE,   8,
 867     LOCAL_EGL_BLUE_SIZE,    8,
 868     LOCAL_EGL_ALPHA_SIZE,   8};
 869
 870 bool CreateConfig(EglDisplay& aEgl, EGLConfig* aConfig, int32_t aDepth,
 871                   bool aEnableDepthBuffer, bool aUseGles, bool aAllowFallback) {
 872   EGLConfig configs[64];
 873   std::vector<EGLint> attribs;
 874   EGLint ncfg = ArrayLength(configs);
 875
 876   switch (aDepth) {
 877     case 16:
 878       for (const auto& cur : kEGLConfigAttribsRGB16) {
 879         attribs.push_back(cur);
 880       }
 881       break;
 882     case 24:
 883       for (const auto& cur : kEGLConfigAttribsRGB24) {
 884         attribs.push_back(cur);
 885       }
 886       break;
 887     case 32:
 888       for (const auto& cur : kEGLConfigAttribsRGBA32) {
 889         attribs.push_back(cur);
 890       }
 891       break;
 892     default:
 893       NS_ERROR("Unknown pixel depth");
 894       return false;
 895   }
 896
 897   if (aUseGles) {
 898     attribs.push_back(LOCAL_EGL_RENDERABLE_TYPE);
 899     attribs.push_back(LOCAL_EGL_OPENGL_ES2_BIT);
 900   }
 901   for (const auto& cur : kTerminationAttribs) {
 902     attribs.push_back(cur);
 903   }
 904
 905   if (!aEgl.fChooseConfig(attribs.data(), configs, ncfg, &ncfg) || ncfg < 1) {
 906     return false;
 907   }
 908
 909   Maybe<EGLConfig> fallbackConfig;
 910
 911   for (int j = 0; j < ncfg; ++j) {
 912     EGLConfig config = configs[j];
 913     EGLint r, g, b, a;
 914     if (aEgl.fGetConfigAttrib(config, LOCAL_EGL_RED_SIZE, &r) &&
 915         aEgl.fGetConfigAttrib(config, LOCAL_EGL_GREEN_SIZE, &g) &&
 916         aEgl.fGetConfigAttrib(config, LOCAL_EGL_BLUE_SIZE, &b) &&
 917         aEgl.fGetConfigAttrib(config, LOCAL_EGL_ALPHA_SIZE, &a) &&
 918         ((aDepth == 16 && r == 5 && g == 6 && b == 5) ||
 919          (aDepth == 24 && r == 8 && g == 8 && b == 8) ||
 920          (aDepth == 32 && r == 8 && g == 8 && b == 8 && a == 8))) {
 921       EGLint z;
 922       if (aEnableDepthBuffer) {
 923         if (!aEgl.fGetConfigAttrib(config, LOCAL_EGL_DEPTH_SIZE, &z) ||
 924             z != 24) {
 925           continue;
 926         }
 927       }
 928 #ifdef MOZ_X11
 929       if (GdkIsX11Display()) {
 930         int configVisualID;
 931         if (!aEgl.fGetConfigAttrib(config, LOCAL_EGL_NATIVE_VISUAL_ID,
 932                                    &configVisualID)) {
 933           continue;
 934         }
 935
 936         XVisualInfo visual_info_template, *visual_info;
 937         int num_visuals;
 938
 939         visual_info_template.visualid = configVisualID;
 940         visual_info =
 941             XGetVisualInfo(GDK_DISPLAY_XDISPLAY(gdk_display_get_default()),
 942                            VisualIDMask, &visual_info_template, &num_visuals);
 943
 944         if (!visual_info || visual_info->depth != aDepth) {
 945           if (aAllowFallback && !fallbackConfig) {
 946             fallbackConfig = Some(config);
 947           }
 948           continue;
 949         }
 950       }
 951 #endif
 952       *aConfig = config;
 953       return true;
 954     }
 955   }
 956
 957   if (kIsLinux && fallbackConfig) {
 958     *aConfig = fallbackConfig.value();
 959     return true;
 960   }
 961
 962   return false;
 963 }
 964
 965 // Return true if a suitable EGLConfig was found and pass it out
 966 // through aConfig.  Return false otherwise.
 967 //
 968 // NB: It's entirely legal for the returned EGLConfig to be valid yet
 969 // have the value null.
 970 static bool CreateConfigScreen(EglDisplay& egl, EGLConfig* const aConfig,
 971                                const bool aEnableDepthBuffer,
 972                                const bool aUseGles) {
 973   int32_t depth = gfxVars::PrimaryScreenDepth();
 974   if (CreateConfig(egl, aConfig, depth, aEnableDepthBuffer, aUseGles)) {
 975     return true;
 976   }
 977 #ifdef MOZ_WIDGET_ANDROID
 978   // Bug 736005
 979   // Android doesn't always support 16 bit so also try 24 bit
 980   if (depth == 16) {
 981     return CreateConfig(egl, aConfig, 24, aEnableDepthBuffer, aUseGles);
 982   }
 983   // Bug 970096
 984   // Some devices that have 24 bit screens only support 16 bit OpenGL?
 985   if (depth == 24) {
 986     return CreateConfig(egl, aConfig, 16, aEnableDepthBuffer, aUseGles);
 987   }
 988 #endif
 989   return false;
 990 }
 991
 992 already_AddRefed<GLContext> GLContextProviderEGL::CreateForCompositorWidget(
 993     CompositorWidget* aCompositorWidget, bool aHardwareWebRender,
 994     bool /*aForceAccelerated*/) {
 995   EGLNativeWindowType window = nullptr;
 996   if (aCompositorWidget) {
 997     window = GET_NATIVE_WINDOW_FROM_COMPOSITOR_WIDGET(aCompositorWidget);
 998   }
 999   return GLContextEGLFactory::Create(window, aHardwareWebRender);
1000 }
1001
1002 EGLSurface GLContextEGL::CreateCompatibleSurface(void* aWindow) const {
1003   MOZ_ASSERT(aWindow);
1004   MOZ_RELEASE_ASSERT(mSurfaceConfig != EGL_NO_CONFIG);
1005
1006   // NOTE: aWindow is an ANativeWindow
1007   EGLSurface surface = mEgl->fCreateWindowSurface(
1008       mSurfaceConfig, reinterpret_cast<EGLNativeWindowType>(aWindow), nullptr);
1009   if (!surface) {
1010     gfxCriticalError() << "CreateCompatibleSurface failed: "
1011                        << hexa(GetError());
1012   }
1013   return surface;
1014 }
1015
1016 static void FillContextAttribs(bool es3, bool useGles, nsTArray<EGLint>* out) {
1017   out->AppendElement(LOCAL_EGL_SURFACE_TYPE);
1018 #ifdef MOZ_WAYLAND
1019   if (GdkIsWaylandDisplay()) {
1020     // Wayland on desktop does not support PBuffer or FBO.
1021     // We create a dummy wl_egl_window instead.
1022     out->AppendElement(LOCAL_EGL_WINDOW_BIT);
1023   } else
1024 #endif
1025   {
1026     out->AppendElement(LOCAL_EGL_PBUFFER_BIT);
1027   }
1028
1029   if (useGles) {
1030     out->AppendElement(LOCAL_EGL_RENDERABLE_TYPE);
1031     if (es3) {
1032       out->AppendElement(LOCAL_EGL_OPENGL_ES3_BIT_KHR);
1033     } else {
1034       out->AppendElement(LOCAL_EGL_OPENGL_ES2_BIT);
1035     }
1036   }
1037
1038   out->AppendElement(LOCAL_EGL_RED_SIZE);
1039   out->AppendElement(8);
1040
1041   out->AppendElement(LOCAL_EGL_GREEN_SIZE);
1042   out->AppendElement(8);
1043
1044   out->AppendElement(LOCAL_EGL_BLUE_SIZE);
1045   out->AppendElement(8);
1046
1047   out->AppendElement(LOCAL_EGL_ALPHA_SIZE);
1048   out->AppendElement(8);
1049
1050   out->AppendElement(LOCAL_EGL_DEPTH_SIZE);
1051   out->AppendElement(0);
1052
1053   out->AppendElement(LOCAL_EGL_STENCIL_SIZE);
1054   out->AppendElement(0);
1055
1056   // EGL_ATTRIBS_LIST_SAFE_TERMINATION_WORKING_AROUND_BUGS
1057   out->AppendElement(LOCAL_EGL_NONE);
1058   out->AppendElement(0);
1059
1060   out->AppendElement(0);
1061   out->AppendElement(0);
1062 }
1063
1064 /*
1065 /// Useful for debugging, but normally unused.
1066 static GLint GetAttrib(GLLibraryEGL* egl, EGLConfig config, EGLint attrib) {
1067   EGLint bits = 0;
1068   egl->fGetConfigAttrib(config, attrib, &bits);
1069   MOZ_ASSERT(egl->fGetError() == LOCAL_EGL_SUCCESS);
1070
1071   return bits;
1072 }
1073 */
1074
1075 static EGLConfig ChooseConfig(EglDisplay& egl, const GLContextCreateDesc& desc,
1076                               const bool useGles) {
1077   nsTArray<EGLint> configAttribList;
1078   FillContextAttribs(bool(desc.flags & CreateContextFlags::PREFER_ES3), useGles,
1079                      &configAttribList);
1080
1081   const EGLint* configAttribs = configAttribList.Elements();
1082
1083   // The sorting dictated by the spec for eglChooseConfig reasonably assures
1084   // that a reasonable 'best' config is on top.
1085   const EGLint kMaxConfigs = 1;
1086   EGLConfig configs[kMaxConfigs];
1087   EGLint foundConfigs = 0;
1088   if (!egl.fChooseConfig(configAttribs, configs, kMaxConfigs, &foundConfigs) ||
1089       foundConfigs == 0) {
1090     return EGL_NO_CONFIG;
1091   }
1092
1093   EGLConfig config = configs[0];
1094   return config;
1095 }
1096
1097 #ifdef MOZ_X11
1098 /* static */
1099 bool GLContextEGL::FindVisual(int* const out_visualId) {
1100   nsCString discardFailureId;
1101   const auto egl = DefaultEglDisplay(&discardFailureId);
1102   if (!egl) {
1103     gfxCriticalNote
1104         << "GLContextEGL::FindVisual(): Failed to load EGL library!";
1105     return false;
1106   }
1107
1108   EGLConfig config;
1109   const int bpp = 32;
1110   if (!CreateConfig(*egl, &config, bpp, /* aEnableDepthBuffer */ false,
1111                     /* aUseGles */ false, /* aAllowFallback */ false)) {
1112     // We are on a buggy driver. Do not return a visual so a fallback path can
1113     // be used. See https://gitlab.freedesktop.org/mesa/mesa/-/issues/149
1114     return false;
1115   }
1116   if (egl->fGetConfigAttrib(config, LOCAL_EGL_NATIVE_VISUAL_ID, out_visualId)) {
1117     return true;
1118   }
1119   return false;
1120 }
1121 #endif
1122
1123 /*static*/
1124 RefPtr<GLContextEGL> GLContextEGL::CreateWithoutSurface(
1125     const std::shared_ptr<EglDisplay> egl, const GLContextCreateDesc& desc,
1126     nsACString* const out_failureId) {
1127   const auto WithUseGles = [&](const bool useGles) -> RefPtr<GLContextEGL> {
1128 #ifdef MOZ_WIDGET_GTK
1129     // First try creating a context with no config and no surface, this is what
1130     // we really want, and seems to be the only way to make selecting software
1131     // Mesa init properly when it's not the first device.
1132     if (egl->IsExtensionSupported(EGLExtension::KHR_no_config_context) &&
1133         egl->IsExtensionSupported(EGLExtension::KHR_surfaceless_context)) {
1134       // These extensions have been supported by mesa and nvidia drivers
1135       // since 2014 or earlier, this is the preferred code path
1136       auto fullDesc = GLContextDesc{desc};
1137       fullDesc.isOffscreen = true;
1138       RefPtr<GLContextEGL> gl = GLContextEGL::CreateGLContext(
1139           egl, fullDesc, EGL_NO_CONFIG, EGL_NO_SURFACE, useGles, EGL_NO_CONFIG,
1140           out_failureId);
1141       if (gl) {
1142         return gl;
1143       }
1144       NS_WARNING(
1145           "Failed to create GLContext with no config and no surface, will try "
1146           "ChooseConfig");
1147     }
1148 #endif
1149
1150     const EGLConfig surfaceConfig = ChooseConfig(*egl, desc, useGles);
1151     if (surfaceConfig == EGL_NO_CONFIG) {
1152       *out_failureId = "FEATURE_FAILURE_EGL_NO_CONFIG"_ns;
1153       NS_WARNING("Failed to find a compatible config.");
1154       return nullptr;
1155     }
1156
1157     if (GLContext::ShouldSpew()) {
1158       egl->DumpEGLConfig(surfaceConfig);
1159     }
1160     const EGLConfig contextConfig =
1161         egl->IsExtensionSupported(EGLExtension::KHR_no_config_context)
1162             ? nullptr
1163             : surfaceConfig;
1164
1165     auto dummySize = mozilla::gfx::IntSize{16, 16};
1166     EGLSurface surface = nullptr;
1167 #ifdef MOZ_WAYLAND
1168     if (GdkIsWaylandDisplay()) {
1169       surface = GLContextEGL::CreateWaylandOffscreenSurface(*egl, surfaceConfig,
1170                                                             dummySize);
1171     } else
1172 #endif
1173     {
1174       surface = GLContextEGL::CreatePBufferSurfaceTryingPowerOfTwo(
1175           *egl, surfaceConfig, LOCAL_EGL_NONE, dummySize);
1176     }
1177     if (!surface) {
1178       *out_failureId = "FEATURE_FAILURE_EGL_POT"_ns;
1179       NS_WARNING("Failed to create PBuffer for context!");
1180       return nullptr;
1181     }
1182
1183     auto fullDesc = GLContextDesc{desc};
1184     fullDesc.isOffscreen = true;
1185     RefPtr<GLContextEGL> gl =
1186         GLContextEGL::CreateGLContext(egl, fullDesc, surfaceConfig, surface,
1187                                       useGles, contextConfig, out_failureId);
1188     if (!gl) {
1189       NS_WARNING("Failed to create GLContext from PBuffer");
1190       egl->fDestroySurface(surface);
1191 #if defined(MOZ_WAYLAND)
1192       DeleteWaylandOffscreenGLSurface(surface);
1193 #endif
1194       return nullptr;
1195     }
1196
1197     return gl;
1198   };
1199
1200   bool preferGles;
1201 #if defined(MOZ_WIDGET_ANDROID)
1202   preferGles = true;
1203 #else
1204   preferGles = StaticPrefs::gfx_egl_prefer_gles_enabled_AtStartup();
1205 #endif  // defined(MOZ_WIDGET_ANDROID)
1206   RefPtr<GLContextEGL> gl = WithUseGles(preferGles);
1207 #if !defined(MOZ_WIDGET_ANDROID)
1208   if (!gl) {
1209     gl = WithUseGles(!preferGles);
1210   }
1211 #endif  // !defined(MOZ_WIDGET_ANDROID)
1212   return gl;
1213 }
1214
1215 /*static*/
1216 void GLContextEGL::DestroySurface(EglDisplay& aEgl, const EGLSurface aSurface) {
1217   if (aSurface != EGL_NO_SURFACE) {
1218     if (!aEgl.fMakeCurrent(EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT)) {
1219       const EGLint err = aEgl.mLib->fGetError();
1220       gfxCriticalNote << "Error in eglMakeCurrent: " << gfx::hexa(err);
1221     }
1222     if (!aEgl.fDestroySurface(aSurface)) {
1223       const EGLint err = aEgl.mLib->fGetError();
1224       gfxCriticalNote << "Error in eglDestroySurface: " << gfx::hexa(err);
1225     }
1226 #if defined(MOZ_WAYLAND)
1227     DeleteWaylandOffscreenGLSurface(aSurface);
1228 #endif
1229   }
1230 }
1231
1232 /*static*/
1233 already_AddRefed<GLContext> GLContextProviderEGL::CreateHeadless(
1234     const GLContextCreateDesc& desc, nsACString* const out_failureId) {
1235   const auto display = DefaultEglDisplay(out_failureId);
1236   if (!display) {
1237     return nullptr;
1238   }
1239   auto ret = GLContextEGL::CreateWithoutSurface(display, desc, out_failureId);
1240   return ret.forget();
1241 }
1242
1243 // Don't want a global context on Android as 1) share groups across 2 threads
1244 // fail on many Tegra drivers (bug 759225) and 2) some mobile devices have a
1245 // very strict limit on global number of GL contexts (bug 754257) and 3) each
1246 // EGL context eats 750k on B2G (bug 813783)
1247 /*static*/
1248 GLContext* GLContextProviderEGL::GetGlobalContext() { return nullptr; }
1249
1250 // -
1251
1252 /*static*/ void GLContextProviderEGL::Shutdown() { GLLibraryEGL::Shutdown(); }
1253
1254 } /* namespace gl */
1255 } /* namespace mozilla */
1256
1257 #undef EGL_ATTRIBS_LIST_SAFE_TERMINATION_WORKING_AROUND_BUGS