Destroy GLX windows when they are backgrounded

ui/gl/gl_surface_glx.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 extern "C" {
 #include <X11/Xlib.h>
 }
 
 #include "ui/gl/gl_surface_glx.h"
 
 #include "base/basictypes.h"
 #include "base/debug/trace_event.h"
+#include "base/lazy_instance.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/synchronization/cancellation_flag.h"
 #include "base/synchronization/lock.h"
 #include "base/threading/non_thread_safe.h"
 #include "base/threading/thread.h"
 #include "base/time/time.h"
 #include "third_party/mesa/src/include/GL/osmesa.h"
 #include "ui/base/x/x11_util.h"
 #include "ui/gl/gl_bindings.h"
 #include "ui/gl/gl_implementation.h"
 #include "ui/gl/vsync_provider.h"
 
 namespace gfx {
 
 namespace {
 
 // scoped_ptr functor for XFree(). Use as follows:
 //   scoped_ptr_malloc<XVisualInfo, ScopedPtrXFree> foo(...);
 // where "XVisualInfo" is any X type that is freed with XFree.
 class ScopedPtrXFree {
  public:
   void operator()(void* x) const {
     ::XFree(x);
   }
 };
 
-Display* g_display;
+Display* g_display = NULL;
 const char* g_glx_extensions = NULL;
 bool g_glx_context_create = false;
 bool g_glx_create_context_robustness_supported = false;
 bool g_glx_texture_from_pixmap_supported = false;
 bool g_glx_oml_sync_control_supported = false;
 
 // Track support of glXGetMscRateOML separately from GLX_OML_sync_control as a
 // whole since on some platforms (e.g. crosbug.com/34585), glXGetMscRateOML
 // always fails even though GLX_OML_sync_control is reported as being supported.
 bool g_glx_get_msc_rate_oml_supported = false;
@@ skipping 255 matching lines @@
   if (initialized)
     return true;
 
   // http://crbug.com/245466
   setenv("force_s3tc_enable", "true", 1);
 
   // SGIVideoSyncProviderShim (if instantiated) will issue X commands on
   // it's own thread.
   XInitThreads();
 
+#if defined(TOOLKIT_GTK)
+  // Be sure to use the X display handle and not the GTK display handle if this
+  // is the GPU process.
+  if (base::MessageLoop::current()->type() == base::MessageLoop::TYPE_GPU)
+    g_display = base::MessagePumpX11::GetDefaultXDisplay();
+  else
+    g_display = base::MessagePumpForUI::GetDefaultXDisplay();
+#else
   g_display = base::MessagePumpForUI::GetDefaultXDisplay();
+#endif
+
   if (!g_display) {
     LOG(ERROR) << "XOpenDisplay failed.";
     return false;
   }
 
   int major, minor;
   if (!glXQueryVersion(g_display, &major, &minor)) {
     LOG(ERROR) << "glxQueryVersion failed";
     return false;
   }
@@ skipping 52 matching lines @@
 bool GLSurfaceGLX::IsOMLSyncControlSupported() {
   return g_glx_oml_sync_control_supported;
 }
 
 void* GLSurfaceGLX::GetDisplay() {
   return g_display;
 }
 
 GLSurfaceGLX::~GLSurfaceGLX() {}
 
+#if defined(TOOLKIT_GTK)
+// A mechanism for forwarding XExpose events from one window to another.
+// Because in the workaround for http://crbug.com/145600 the child window
+// is placed on top of the parent window, only the child window will receive
+// all expose events. These need to be forwared to the parent window to inform
+// it that it should paint.
+class XExposeEventForwarder : public base::MessagePumpObserver {

[piman, 2013/09/11 23:05:09]

nit: move this to an anonoymous namespace.

[ccameron, 2013/09/12 01:37:13]

Done.

+ public:
+  XExposeEventForwarder() {
+    base::MessagePumpX11::Current()->AddObserver(this);
+  }
+  ~XExposeEventForwarder() {
+    base::MessagePumpX11::Current()->RemoveObserver(this);

[piman, 2013/09/11 23:05:09]

If this is a lazy instance, the destructor will run during AtExit, at which
point I think base::MessagePumpX11::Current() will be NULL (or worse).
You can make it Leaky, but maybe we could do something along the lines of adding
to the pump when we add the first window pair, and remove it when we remove the
last pair, wdyt?

[ccameron, 2013/09/12 01:37:13]

Good catch, thanks. Moved to the Add/RemoveParentChildPair functions.

+  }
+
+  void AddParentChildPair(gfx::AcceleratedWidget parent_window,
+                          gfx::AcceleratedWidget child_window) {
+    DCHECK(child_to_parent_map_.find(child_window) ==
+           child_to_parent_map_.end());
+    child_to_parent_map_.insert(std::make_pair(
+        child_window, parent_window));
+  }
+  void RemoveParentChildPair(gfx::AcceleratedWidget parent_window,
+                             gfx::AcceleratedWidget child_window) {
+    DCHECK(child_to_parent_map_.find(child_window) !=
+           child_to_parent_map_.end());
+    child_to_parent_map_.erase(child_window);
+  }
+
+ private:
+  virtual base::EventStatus WillProcessEvent(
+      const base::NativeEvent& xevent) OVERRIDE {
+    if (xevent->type != Expose)
+      return base::EVENT_CONTINUE;
+
+    WindowMap::const_iterator found = child_to_parent_map_.find(
+        xevent->xexpose.window);
+    if (found == child_to_parent_map_.end())
+      return base::EVENT_CONTINUE;
+
+    gfx::AcceleratedWidget target_window = found->second;
+    XEvent forwarded_event = *xevent;
+    forwarded_event.xexpose.window = target_window;
+    XSendEvent(g_display, target_window, False, ExposureMask,
+               &forwarded_event);
+    return base::EVENT_CONTINUE;
+  }
+  virtual void DidProcessEvent(const base::NativeEvent& xevent) {
+  }
+
+  typedef std::map<gfx::AcceleratedWidget, gfx::AcceleratedWidget> WindowMap;
+  WindowMap child_to_parent_map_;
+};
+
+static base::LazyInstance<XExposeEventForwarder> g_xexpose_event_forwarder =
+    LAZY_INSTANCE_INITIALIZER;
+
+bool NativeViewGLSurfaceGLX::SetBackbufferAllocation(bool allocated) {
+  if (allocated)
+    return CreateChildWindow();
+  else
+    DestroyChildWindow();
+  return true;
+}
+
+bool NativeViewGLSurfaceGLX::CreateChildWindow() {
+  if (child_window_)
+    return true;
+
+  XWindowAttributes attributes;
+  if (!XGetWindowAttributes(g_display, parent_window_, &attributes)) {

[piman, 2013/09/11 23:05:09]

Could we cache this? It requires a round trip to X.

[ccameron, 2013/09/12 01:37:13]

Actually, we can just use CopyFromParent and avoid caching and querying
altogether.

+    LOG(ERROR) << "XGetWindowAttributes failed for window " << parent_window_
+        << ".";
+    return false;
+  }
+
+  XSetWindowAttributes set_window_attributes;
+  set_window_attributes.event_mask = ExposureMask;
+  child_window_ = XCreateWindow(
+      g_display, parent_window_, 0, 0, attributes.width, attributes.height, 0,
+      attributes.depth, InputOutput, attributes.visual, CWEventMask,
+      &set_window_attributes);
+  g_xexpose_event_forwarder.Pointer()->AddParentChildPair(
+      parent_window_, child_window_);
+
+  XMapWindow(g_display, child_window_);
+  XFlush(g_display);
+
+  // If the dummy window was current, make the child window current now.
+  if (dummy_window_ == glXGetCurrentDrawable())
+    glXMakeCurrent(g_display, child_window_, glXGetCurrentContext());
+
+  return true;
+}
+
+void NativeViewGLSurfaceGLX::DestroyChildWindow() {
+  if (!child_window_)
+    return;
+

[piman, 2013/09/11 23:05:09]

Do we need to glXMakeCurrent the dummy_window_ here?

[ccameron, 2013/09/12 01:37:13]

Doesn't look like it. And I may make dummy_window_ shared in a future patch,
which would make this not even possible.

+  g_xexpose_event_forwarder.Pointer()->RemoveParentChildPair(
+      parent_window_, child_window_);
+  XDestroyWindow(g_display, child_window_);
+  XFlush(g_display);
+  child_window_ = 0;
+}
+#endif
+
 NativeViewGLSurfaceGLX::NativeViewGLSurfaceGLX(gfx::AcceleratedWidget window)
-  : window_(window),
+  : parent_window_(window),
+#if defined(TOOLKIT_GTK)
+    child_window_(0),
+    dummy_window_(0),
+#endif
     config_(NULL) {
 }
 
+gfx::AcceleratedWidget NativeViewGLSurfaceGLX::GetDrawableHandle() const {
+#if defined(TOOLKIT_GTK)
+  if (child_window_)
+    return child_window_;
+  return dummy_window_;
+#else
+  return parent_window_;
+#endif
+}
+
 bool NativeViewGLSurfaceGLX::Initialize() {
   XWindowAttributes attributes;
-  if (!XGetWindowAttributes(g_display, window_, &attributes)) {
-    LOG(ERROR) << "XGetWindowAttributes failed for window " << window_ << ".";
+  if (!XGetWindowAttributes(g_display, parent_window_, &attributes)) {
+    LOG(ERROR) << "XGetWindowAttributes failed for window " << parent_window_
+        << ".";
     return false;
   }
   size_ = gfx::Size(attributes.width, attributes.height);
 
+  gfx::AcceleratedWidget window_for_vsync = parent_window_;
+
+#if defined(TOOLKIT_GTK)
+  CreateChildWindow();
+  dummy_window_ = XCreateWindow(
+      g_display, parent_window_, 0, 0, 1, 1, 0, attributes.depth, InputOutput,
+      attributes.visual, 0, NULL);
+  window_for_vsync = dummy_window_;
+#endif
+
   if (g_glx_oml_sync_control_supported)
-    vsync_provider_.reset(new OMLSyncControlVSyncProvider(window_));
+    vsync_provider_.reset(new OMLSyncControlVSyncProvider(window_for_vsync));
   else if (g_glx_sgi_video_sync_supported)
-    vsync_provider_.reset(new SGIVideoSyncVSyncProvider(window_));
+    vsync_provider_.reset(new SGIVideoSyncVSyncProvider(window_for_vsync));
 
   return true;
 }
 
 void NativeViewGLSurfaceGLX::Destroy() {
+#if defined(TOOLKIT_GTK)
+  if (dummy_window_)
+    XDestroyWindow(g_display, dummy_window_);
+  dummy_window_ = 0;
+
+  DestroyChildWindow();
+#endif
 }
 
 bool NativeViewGLSurfaceGLX::Resize(const gfx::Size& size) {
+#if defined(TOOLKIT_GTK)
+  if (child_window_) {
+    XResizeWindow(g_display, child_window_, size.width(), size.height());
+    XFlush(g_display);
+  }
+#endif
   size_ = size;
   return true;
 }
 
 bool NativeViewGLSurfaceGLX::IsOffscreen() {
   return false;
 }
 
 bool NativeViewGLSurfaceGLX::SwapBuffers() {
-  glXSwapBuffers(g_display, window_);
+  glXSwapBuffers(g_display, GetDrawableHandle());
   return true;
 }
 
 gfx::Size NativeViewGLSurfaceGLX::GetSize() {
   return size_;
 }
 
 void* NativeViewGLSurfaceGLX::GetHandle() {
-  return reinterpret_cast<void*>(window_);
+  return reinterpret_cast<void*>(GetDrawableHandle());
 }
 
 std::string NativeViewGLSurfaceGLX::GetExtensions() {
   std::string extensions = GLSurface::GetExtensions();
   if (gfx::g_driver_glx.ext.b_GLX_MESA_copy_sub_buffer) {
     extensions += extensions.empty() ? "" : " ";
     extensions += "GL_CHROMIUM_post_sub_buffer";
   }
   return extensions;
 }
 
 void* NativeViewGLSurfaceGLX::GetConfig() {
   if (!config_) {
     // This code path is expensive, but we only take it when
     // attempting to use GLX_ARB_create_context_robustness, in which
     // case we need a GLXFBConfig for the window in order to create a
     // context for it.
     //
     // TODO(kbr): this is not a reliable code path. On platforms which
     // support it, we should use glXChooseFBConfig in the browser
     // process to choose the FBConfig and from there the X Visual to
     // use when creating the window in the first place. Then we can
     // pass that FBConfig down rather than attempting to reconstitute
     // it.
 
     XWindowAttributes attributes;
     if (!XGetWindowAttributes(
         g_display,
-        window_,
+        parent_window_,
         &attributes)) {
       LOG(ERROR) << "XGetWindowAttributes failed for window " <<
-          window_ << ".";
+          parent_window_ << ".";
       return NULL;
     }
 
     int visual_id = XVisualIDFromVisual(attributes.visual);
 
     int num_elements = 0;
     scoped_ptr_malloc<GLXFBConfig, ScopedPtrXFree> configs(
         glXGetFBConfigs(g_display,
                         DefaultScreen(g_display),
                         &num_elements));
@@ skipping 23 matching lines @@
       config_ = configs.get()[i];
     }
   }
 
   return config_;
 }
 
 bool NativeViewGLSurfaceGLX::PostSubBuffer(
     int x, int y, int width, int height) {
   DCHECK(gfx::g_driver_glx.ext.b_GLX_MESA_copy_sub_buffer);
-  glXCopySubBufferMESA(g_display, window_, x, y, width, height);
+  glXCopySubBufferMESA(g_display, GetDrawableHandle(), x, y, width, height);
   return true;
 }
 
 VSyncProvider* NativeViewGLSurfaceGLX::GetVSyncProvider() {
   return vsync_provider_.get();
 }
 
 NativeViewGLSurfaceGLX::NativeViewGLSurfaceGLX()
-  : window_(0),
+  : parent_window_(0),
+#if defined(TOOLKIT_GTK)
+    child_window_(0),
+    dummy_window_(0),
+#endif
     config_(NULL) {
 }
 
 NativeViewGLSurfaceGLX::~NativeViewGLSurfaceGLX() {
   Destroy();
 }
 
 PbufferGLSurfaceGLX::PbufferGLSurfaceGLX(const gfx::Size& size)
   : size_(size),
     config_(NULL),
@@ skipping 77 matching lines @@
 
 void* PbufferGLSurfaceGLX::GetConfig() {
   return config_;
 }
 
 PbufferGLSurfaceGLX::~PbufferGLSurfaceGLX() {
   Destroy();
 }
 
 }  // namespace gfx