exo: Add explicit synchronization support to motion event client.

components/exo/wayland/clients/motion_events.cc

 // Copyright 2016 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.
 
 // Implementation of a client that produces output in the form of RGBA
 // buffers when receiving pointer/touch events. RGB contains the lower
 // 24 bits of the event timestamp and A is 0xff.
 
 #include <fcntl.h>
 #include <linux-dmabuf-unstable-v1-client-protocol.h>
+#include <linux-explicit-synchronization-unstable-v1-client-protocol.h>
 #include <wayland-client-core.h>
 #include <wayland-client-protocol.h>
 
 #include <deque>
 #include <iostream>
 #include <string>
 #include <vector>
 
 #include "base/at_exit.h"
 #include "base/command_line.h"
@@ skipping 40 matching lines @@
 DEFAULT_DELETER(wl_shm_pool, wl_shm_pool_destroy)
 DEFAULT_DELETER(wl_buffer, wl_buffer_destroy)
 DEFAULT_DELETER(wl_surface, wl_surface_destroy)
 DEFAULT_DELETER(wl_region, wl_region_destroy)
 DEFAULT_DELETER(wl_shell, wl_shell_destroy)
 DEFAULT_DELETER(wl_shell_surface, wl_shell_surface_destroy)
 DEFAULT_DELETER(wl_seat, wl_seat_destroy)
 DEFAULT_DELETER(wl_pointer, wl_pointer_destroy)
 DEFAULT_DELETER(wl_touch, wl_touch_destroy)
 DEFAULT_DELETER(wl_callback, wl_callback_destroy)
+DEFAULT_DELETER(zcr_linux_explicit_synchronization_v1,
+                zcr_linux_explicit_synchronization_v1_destroy)
+DEFAULT_DELETER(zcr_synchronization_v1, zcr_synchronization_v1_destroy)
 DEFAULT_DELETER(zwp_linux_buffer_params_v1, zwp_linux_buffer_params_v1_destroy)
 DEFAULT_DELETER(zwp_linux_dmabuf_v1, zwp_linux_dmabuf_v1_destroy)
 
 #if defined(OZONE_PLATFORM_GBM)
 DEFAULT_DELETER(gbm_device, gbm_device_destroy)
 DEFAULT_DELETER(gbm_bo, gbm_bo_destroy)
 #endif
 
 namespace exo {
 namespace wayland {
@@ skipping 22 matching lines @@
 
 // Rotation speed (degrees/second).
 const double kRotationSpeed = 360.0;
 
 // Benchmark interval in seconds.
 const int kBenchmarkInterval = 5;
 
 struct Globals {
   std::unique_ptr<wl_compositor> compositor;
   std::unique_ptr<wl_shm> shm;
+  std::unique_ptr<zcr_linux_explicit_synchronization_v1>
+      linux_explicit_synchronization;
   std::unique_ptr<zwp_linux_dmabuf_v1> linux_dmabuf;
   std::unique_ptr<wl_shell> shell;
   std::unique_ptr<wl_seat> seat;
 };
 
 void RegistryHandler(void* data,
                      wl_registry* registry,
                      uint32_t id,
                      const char* interface,
                      uint32_t version) {
   Globals* globals = static_cast<Globals*>(data);
 
   if (strcmp(interface, "wl_compositor") == 0) {
     globals->compositor.reset(static_cast<wl_compositor*>(
         wl_registry_bind(registry, id, &wl_compositor_interface, 3)));
   } else if (strcmp(interface, "wl_shm") == 0) {
     globals->shm.reset(static_cast<wl_shm*>(
         wl_registry_bind(registry, id, &wl_shm_interface, 1)));
   } else if (strcmp(interface, "wl_shell") == 0) {
     globals->shell.reset(static_cast<wl_shell*>(
         wl_registry_bind(registry, id, &wl_shell_interface, 1)));
   } else if (strcmp(interface, "wl_seat") == 0) {
     globals->seat.reset(static_cast<wl_seat*>(
         wl_registry_bind(registry, id, &wl_seat_interface, 5)));
+  } else if (strcmp(interface, "zcr_linux_explicit_synchronization_v1") == 0) {
+    globals->linux_explicit_synchronization.reset(
+        static_cast<zcr_linux_explicit_synchronization_v1*>(wl_registry_bind(
+            registry, id, &zcr_linux_explicit_synchronization_v1_interface,
+            1)));
   } else if (strcmp(interface, "zwp_linux_dmabuf_v1") == 0) {
     globals->linux_dmabuf.reset(static_cast<zwp_linux_dmabuf_v1*>(
         wl_registry_bind(registry, id, &zwp_linux_dmabuf_v1_interface, 1)));
   }
 }
 
 void RegistryRemover(void* data, wl_registry* registry, uint32_t id) {
   LOG(WARNING) << "Got a registry losing event for " << id;
 }
 
 #if defined(OZONE_PLATFORM_GBM)
 struct DeleteTextureTraits {
   static GLuint InvalidValue() { return 0; }
   static void Free(GLuint texture) { glDeleteTextures(1, &texture); }
 };
 using ScopedTexture = base::ScopedGeneric<GLuint, DeleteTextureTraits>;
 
 struct DeleteEglImageTraits {
   static EGLImageKHR InvalidValue() { return 0; }
   static void Free(EGLImageKHR image) {
     eglDestroyImageKHR(eglGetCurrentDisplay(), image);
   }
 };
 using ScopedEglImage = base::ScopedGeneric<EGLImageKHR, DeleteEglImageTraits>;
+
+struct DeleteEglSyncTraits {
+  static EGLSyncKHR InvalidValue() { return 0; }
+  static void Free(EGLSyncKHR sync) {
+    eglDestroySyncKHR(eglGetCurrentDisplay(), sync);
+  }
+};
+using ScopedEglSync = base::ScopedGeneric<EGLSyncKHR, DeleteEglSyncTraits>;
 #endif
 
 struct Buffer {
   std::unique_ptr<wl_buffer> buffer;
   bool busy = false;
 #if defined(OZONE_PLATFORM_GBM)
   std::unique_ptr<gbm_bo> bo;
   std::unique_ptr<ScopedEglImage> egl_image;
+  std::unique_ptr<ScopedEglSync> egl_sync;
   std::unique_ptr<ScopedTexture> texture;
 #endif
   std::unique_ptr<zwp_linux_buffer_params_v1> params;
   base::SharedMemory shared_memory;
   std::unique_ptr<wl_shm_pool> shm_pool;
   sk_sp<SkSurface> sk_surface;
 };
 
 void BufferRelease(void* data, wl_buffer* /* buffer */) {
   Buffer* buffer = static_cast<Buffer*>(data);
@@ skipping 117 matching lines @@
 }  // namespace
 
 class MotionEvents {
  public:
   MotionEvents(size_t width,
                size_t height,
                int scale,
                size_t num_rects,
                size_t max_frames_pending,
                bool fullscreen,
+               bool use_explicit_synchronization,
                const std::string* use_drm)
       : width_(width),
         height_(height),
         scale_(scale),
         num_rects_(num_rects),
         max_frames_pending_(max_frames_pending),
         fullscreen_(fullscreen),
+        use_explicit_synchronization_(use_explicit_synchronization),
         use_drm_(use_drm) {}
 
   // Initialize and run client main loop.
   int Run();
 
  private:
   bool CreateBuffer(Buffer* buffer);
 
   const size_t width_;
   const size_t height_;
   const int scale_;
   const size_t num_rects_;
   const size_t max_frames_pending_;
   const bool fullscreen_;
+  const bool use_explicit_synchronization_;
   const std::string* use_drm_;
 
   Globals globals_;
   std::unique_ptr<wl_display> display_;
 
 #if defined(OZONE_PLATFORM_GBM)
   base::ScopedFD drm_fd_;
   std::unique_ptr<gbm_device> device_;
 #endif
 
@@ skipping 32 matching lines @@
   wl_display_roundtrip(display_.get());
 
   if (!globals_.compositor) {
     LOG(ERROR) << "Can't find compositor interface";
     return 1;
   }
   if (!globals_.shm) {
     LOG(ERROR) << "Can't find shm interface";
     return 1;
   }
+  if (use_explicit_synchronization_ &&
+      !globals_.linux_explicit_synchronization) {
+    LOG(ERROR) << "Can't find linux_explicit_synchronization interface";
+    return 1;
+  }
   if (use_drm_ && !globals_.linux_dmabuf) {
     LOG(ERROR) << "Can't find linux_dmabuf interface";
     return 1;
   }
   if (!globals_.shell) {
     LOG(ERROR) << "Can't find shell interface";
     return 1;
   }
   if (!globals_.seat) {
     LOG(ERROR) << "Can't find seat interface";
     return 1;
   }
 
+#if defined(OZONE_PLATFORM_GBM)
   EGLenum egl_sync_type = 0;
-#if defined(OZONE_PLATFORM_GBM)
   if (use_drm_) {
     // Number of files to look for when discovering DRM devices.
     const uint32_t kDrmMaxMinor = 15;
     const uint32_t kRenderNodeStart = 128;
     const uint32_t kRenderNodeEnd = kRenderNodeStart + kDrmMaxMinor;
 
     for (uint32_t i = kRenderNodeStart; i < kRenderNodeEnd; i++) {
       std::string dri_render_node(
           base::StringPrintf(kDriRenderNodeTemplate, i));
       base::ScopedFD drm_fd(open(dri_render_node.c_str(), O_RDWR));
@@ skipping 15 matching lines @@
       LOG_IF(ERROR, use_drm_) << "Can't find drm device: '" << *use_drm_ << "'";
       LOG_IF(ERROR, !use_drm_) << "Can't find drm device";
       return 1;
     }
 
     device_.reset(gbm_create_device(drm_fd_.get()));
     if (!device_) {
       LOG(ERROR) << "Can't create gbm device";
       return 1;
     }
+
+    if (gl::GLSurfaceEGL::HasEGLExtension("EGL_EXT_image_flush_external") ||
+        gl::GLSurfaceEGL::HasEGLExtension("EGL_ARM_implicit_external_sync")) {
+      egl_sync_type = EGL_SYNC_FENCE_KHR;
+    }
+    if (gl::GLSurfaceEGL::HasEGLExtension("EGL_ANDROID_native_fence_sync")) {
+      egl_sync_type = EGL_SYNC_NATIVE_FENCE_ANDROID;
+    }
   }
 
   sk_sp<const GrGLInterface> native_interface(GrGLCreateNativeInterface());
   DCHECK(native_interface);
   gr_context_ = sk_sp<GrContext>(GrContext::Create(
       kOpenGL_GrBackend,
       reinterpret_cast<GrBackendContext>(native_interface.get())));
   DCHECK(gr_context_);
-
-  if (gl::GLSurfaceEGL::HasEGLExtension("EGL_EXT_image_flush_external") ||
-      gl::GLSurfaceEGL::HasEGLExtension("EGL_ARM_implicit_external_sync")) {
-    egl_sync_type = EGL_SYNC_FENCE_KHR;
-  }
-  if (gl::GLSurfaceEGL::HasEGLExtension("EGL_ANDROID_native_fence_sync")) {
-    egl_sync_type = EGL_SYNC_NATIVE_FENCE_ANDROID;
-  }
 #endif
 
   wl_buffer_listener buffer_listener = {BufferRelease};
 
   for (size_t i = 0; i < kBuffers; ++i) {
     if (!CreateBuffer(&buffers_[i]))
       return 1;
   }
   wl_display_roundtrip(display_.get());
   for (size_t i = 0; i < kBuffers; ++i) {
@@ skipping 14 matching lines @@
   std::unique_ptr<wl_region> opaque_region(static_cast<wl_region*>(
       wl_compositor_create_region(globals_.compositor.get())));
   if (!opaque_region) {
     LOG(ERROR) << "Can't create region";
     return 1;
   }
 
   wl_region_add(opaque_region.get(), 0, 0, width_, height_);
   wl_surface_set_opaque_region(surface.get(), opaque_region.get());
 
+  std::unique_ptr<zcr_synchronization_v1> synchronization;
+  if (use_explicit_synchronization_) {
+    synchronization.reset(static_cast<zcr_synchronization_v1*>(
+        zcr_linux_explicit_synchronization_v1_get_synchronization(
+            globals_.linux_explicit_synchronization.get(), surface.get())));
+    if (!synchronization) {
+      LOG(ERROR) << "Can't get synchronization";
+      return 1;
+    }
+  }
+
   std::unique_ptr<wl_shell_surface> shell_surface(
       static_cast<wl_shell_surface*>(
           wl_shell_get_shell_surface(globals_.shell.get(), surface.get())));
   if (!shell_surface) {
     LOG(ERROR) << "Can't get shell surface";
     return 1;
   }
 
   wl_shell_surface_set_title(shell_surface.get(), kClientTitle);
 
@@ skipping 27 matching lines @@
     return 1;
   }
 
   wl_touch_listener touch_listener = {TouchDown, TouchUp, TouchMotion,
                                       TouchFrame, TouchCancel};
   wl_touch_add_listener(touch.get(), &touch_listener, &event_times);
 
   Frame frame;
   std::unique_ptr<wl_callback> frame_callback;
   wl_callback_listener frame_listener = {FrameCallback};
-  std::deque<wl_buffer*> pending_frames;
+  std::deque<Buffer*> pending_frames;
 
   uint32_t frames = 0;
   base::TimeTicks benchmark_time = base::TimeTicks::Now();
   base::TimeDelta benchmark_interval =
       base::TimeDelta::FromSeconds(kBenchmarkInterval);
   base::TimeDelta benchmark_wall_time;
   base::TimeDelta benchmark_cpu_time;
 
   int dispatch_status = 0;
   do {
@@ skipping 66 matching lines @@
                                    SK_ColorRED,  SK_ColorYELLOW,
                                    SK_ColorCYAN, SK_ColorMAGENTA};
         paint.setColor(SkColorSetA(kColors[i % arraysize(kColors)], 0xA0));
         canvas->rotate(rotation / num_rects_);
         canvas->drawIRect(rect, paint);
       }
 
       canvas->restore();
       if (gr_context_) {
         gr_context_->flush();
+
+#if defined(OZONE_PLATFORM_GBM)
+        if (egl_sync_type) {
+          buffer->egl_sync.reset(new ScopedEglSync(eglCreateSyncKHR(
+              eglGetCurrentDisplay(), egl_sync_type, nullptr)));
+          DCHECK(buffer->egl_sync->is_valid());
+        }
+#endif
+
         glFlush();
-
-        if (egl_sync_type) {
-          EGLSyncKHR sync =
-              eglCreateSyncKHR(eglGetCurrentDisplay(), egl_sync_type, nullptr);
-          DCHECK(sync != EGL_NO_SYNC_KHR);
-          eglClientWaitSyncKHR(eglGetCurrentDisplay(), sync,
-                               EGL_SYNC_FLUSH_COMMANDS_BIT_KHR,
-                               EGL_FOREVER_KHR);
-          eglDestroySyncKHR(eglGetCurrentDisplay(), sync);
-        }
       }
 
       buffer->busy = true;
-      pending_frames.push_back(buffer->buffer.get());
+      pending_frames.push_back(buffer);
 
       ++frames;
       benchmark_wall_time += base::TimeTicks::Now() - wall_time_start;
       benchmark_cpu_time += base::ThreadTicks::Now() - cpu_time_start;
       continue;
     }
 
     if (!frame.callback_pending) {
       DCHECK_GT(pending_frames.size(), 0u);
+      Buffer* buffer = pending_frames.front();
+      pending_frames.pop_front();
+
       wl_surface_set_buffer_scale(surface.get(), scale_);
-      wl_surface_attach(surface.get(), pending_frames.front(), 0, 0);
-      pending_frames.pop_front();
+      wl_surface_attach(surface.get(), buffer->buffer.get(), 0, 0);
+
+#if defined(OZONE_PLATFORM_GBM)
+      if (buffer->egl_sync->is_valid()) {
+        if (use_explicit_synchronization_) {
+          DCHECK_EQ(egl_sync_type,
+                    static_cast<EGLenum>(EGL_SYNC_NATIVE_FENCE_ANDROID));
+          base::ScopedFD fence_fd(eglDupNativeFenceFDANDROID(
+              eglGetCurrentDisplay(), buffer->egl_sync->get()));
+          DCHECK(fence_fd.is_valid());
+          DCHECK(synchronization);
+          zcr_synchronization_v1_set_acquire_fence(synchronization.get(),
+                                                   fence_fd.get());
+        } else {
+          eglClientWaitSyncKHR(eglGetCurrentDisplay(), buffer->egl_sync->get(),
+                               EGL_SYNC_FLUSH_COMMANDS_BIT_KHR,
+                               EGL_FOREVER_KHR);
+        }
+      }
+#endif
 
       frame_callback.reset(wl_surface_frame(surface.get()));
       wl_callback_add_listener(frame_callback.get(), &frame_listener, &frame);
       frame.callback_pending = true;
       wl_surface_commit(surface.get());
       wl_display_flush(display_.get());
       continue;
     }
 
     dispatch_status = wl_display_dispatch(display_.get());
@@ skipping 103 matching lines @@
 
 // Specifies the number of rotating rects to draw.
 const char kNumRects[] = "num-rects";
 
 // Specifies the maximum number of pending frames.
 const char kMaxFramesPending[] = "max-frames-pending";
 
 // Specifies if client should be fullscreen.
 const char kFullscreen[] = "fullscreen";
 
+// Specifies if client should be using explicit synchronization.
+const char kUseExplicitSynchronization[] = "use-explicit-synchronization";
+
 // Use drm buffer instead of shared memory.
 const char kUseDrm[] = "use-drm";
 
 }  // namespace switches
 
 int main(int argc, char* argv[]) {
   base::AtExitManager exit_manager;
   base::CommandLine::Init(argc, argv);
   base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
 
@@ skipping 33 matching lines @@
   }
 
   std::unique_ptr<std::string> use_drm;
   if (command_line->HasSwitch(switches::kUseDrm)) {
     use_drm.reset(
         new std::string(command_line->GetSwitchValueASCII(switches::kUseDrm)));
   }
 
   exo::wayland::clients::MotionEvents client(
       width, height, scale, num_rects, max_frames_pending,
-      command_line->HasSwitch(switches::kFullscreen), use_drm.get());
+      command_line->HasSwitch(switches::kFullscreen),
+      command_line->HasSwitch(switches::kUseExplicitSynchronization),
+      use_drm.get());
   return client.Run();
 }