[Ozone-DRI] Listen for swap events

ui/ozone/platform/dri/hardware_display_controller.cc

 // Copyright 2014 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.
 
 #include "ui/ozone/platform/dri/hardware_display_controller.h"
 
 #include <drm.h>
 #include <errno.h>
 #include <string.h>
 #include <xf86drm.h>
 
 #include "base/basictypes.h"
 #include "base/debug/trace_event.h"
 #include "base/logging.h"
 #include "third_party/skia/include/core/SkCanvas.h"
 #include "ui/gfx/geometry/point.h"
 #include "ui/gfx/geometry/size.h"
 #include "ui/ozone/platform/dri/crtc_controller.h"
 #include "ui/ozone/platform/dri/dri_buffer.h"
 #include "ui/ozone/platform/dri/dri_wrapper.h"
 #include "ui/ozone/public/native_pixmap.h"
 
 namespace ui {
 
-namespace {
-
-// DRM callback on page flip events. This callback is triggered after the
-// page flip has happened and the backbuffer is now the new frontbuffer
-// The old frontbuffer is no longer used by the hardware and can be used for
-// future draw operations.
-//
-// |device| will contain a reference to the |ScanoutSurface| object which
-// the event belongs to.
-//
-// TODO(dnicoara) When we have a FD handler for the DRM calls in the message
-// loop, we can move this function in the handler.
-void HandlePageFlipEvent(int fd,
-                         unsigned int frame,
-                         unsigned int seconds,
-                         unsigned int useconds,
-                         void* controller) {
-  static_cast<CrtcController*>(controller)
-      ->OnPageFlipEvent(frame, seconds, useconds);
+HardwareDisplayController::PageFlipRequest::PageFlipRequest(
+    const OverlayPlaneList& planes,
+    const base::Closure& callback)
+    : planes(planes), callback(callback) {
 }
 
-}  // namespace
+HardwareDisplayController::PageFlipRequest::~PageFlipRequest() {
+}
 
 HardwareDisplayController::HardwareDisplayController(
     scoped_ptr<CrtcController> controller)
     : is_disabled_(true) {
   memset(&mode_, 0, sizeof(mode_));
   AddCrtc(controller.Pass());
 }
 
 HardwareDisplayController::~HardwareDisplayController() {
   // Reset the cursor.
   UnsetCursor();
+  ClearPendingRequests();
 }
 
 bool HardwareDisplayController::Modeset(const OverlayPlane& primary,
                                         drmModeModeInfo mode) {
   TRACE_EVENT0("dri", "HDC::Modeset");
   DCHECK(primary.buffer.get());
   bool status = true;
   for (size_t i = 0; i < crtc_controllers_.size(); ++i)
     status &= crtc_controllers_[i]->Modeset(primary, mode);
 
+  is_disabled_ = false;
+  mode_ = mode;
+
   current_planes_ = std::vector<OverlayPlane>(1, primary);
   pending_planes_.clear();
-  is_disabled_ = false;
-  mode_ = mode;
+  ClearPendingRequests();
+
+  // Because a page flip is pending we need to leave some state for the
+  // callback. We use the modeset state since it is the only valid state.
+  if (HasPendingPageFlips())
+    requests_.push_back(
+        PageFlipRequest(current_planes_, base::Bind(&base::DoNothing)));
+
   return status;
 }
 
 bool HardwareDisplayController::Enable() {
   TRACE_EVENT0("dri", "HDC::Enable");
   DCHECK(!current_planes_.empty());
   const OverlayPlane* primary = OverlayPlane::GetPrimaryPlane(current_planes_);
 
   return Modeset(*primary, mode_);
 }
 
 void HardwareDisplayController::Disable() {
   TRACE_EVENT0("dri", "HDC::Disable");
   for (size_t i = 0; i < crtc_controllers_.size(); ++i)
     crtc_controllers_[i]->Disable();
 
   is_disabled_ = true;
 }
 
 void HardwareDisplayController::QueueOverlayPlane(const OverlayPlane& plane) {
   pending_planes_.push_back(plane);
 }
 
-bool HardwareDisplayController::SchedulePageFlip() {
-  DCHECK(!pending_planes_.empty());
+bool HardwareDisplayController::SchedulePageFlip(
+    const base::Closure& callback) {
+  TRACE_EVENT0("dri", "HDC::SchedulePageFlip");
 
-  if (is_disabled_)
+  // Ignore requests with no planes to schedule.
+  if (pending_planes_.empty()) {
+    callback.Run();
+    return true;
+  }
+
+  requests_.push_back(PageFlipRequest(pending_planes_, callback));
+  pending_planes_.clear();
+
+  // A request is being serviced right now.
+  if (HasPendingPageFlips())
     return true;
 
-  std::sort(pending_planes_.begin(), pending_planes_.end(),
-            [](const OverlayPlane& l, const OverlayPlane& r) {
-    return l.z_order < r.z_order;
-  });
+  bool status = ActualSchedulePageFlip();
 
-  bool status = true;
-  for (size_t i = 0; i < crtc_controllers_.size(); ++i) {
-    status &= crtc_controllers_[i]->SchedulePageFlip(
-        owned_hardware_planes_.get(crtc_controllers_[i]->drm()),
-        pending_planes_);
-  }
-
-  for (const auto& planes : owned_hardware_planes_) {
-    if (!planes.first->plane_manager()->Commit(planes.second)) {
-      status = false;
-    }
-  }
+  // No page flip event on failure so discard failed request.
+  if (!status)
+    requests_.pop_front();
 
   return status;
 }
 
-void HardwareDisplayController::WaitForPageFlipEvent() {
-  TRACE_EVENT0("dri", "HDC::WaitForPageFlipEvent");
-
-  drmEventContext drm_event;
-  drm_event.version = DRM_EVENT_CONTEXT_VERSION;
-  drm_event.page_flip_handler = HandlePageFlipEvent;
-  drm_event.vblank_handler = NULL;
-
-  bool has_pending_page_flips = false;
-  // Wait for the page-flips to complete.
-  for (size_t i = 0; i < crtc_controllers_.size(); ++i) {
-    // In mirror mode the page flip callbacks can happen in different order than
-    // scheduled, so we need to make sure that the event for the current CRTC is
-    // processed before moving to the next CRTC.
-    while (crtc_controllers_[i]->page_flip_pending()) {
-      has_pending_page_flips = true;
-      crtc_controllers_[i]->drm()->HandleEvent(drm_event);
-    }
-  }
-
-  // In case there are no pending pageflips do not replace the current planes
-  // since they are still being used.
-  if (has_pending_page_flips)
-    current_planes_.swap(pending_planes_);
-
-  pending_planes_.clear();
-}
-
 bool HardwareDisplayController::SetCursor(
     const scoped_refptr<ScanoutBuffer>& buffer) {
   bool status = true;
 
   if (is_disabled_)
     return true;
 
   for (size_t i = 0; i < crtc_controllers_.size(); ++i)
     status &= crtc_controllers_[i]->SetCursor(buffer);
 
@@ skipping 16 matching lines @@
   for (size_t i = 0; i < crtc_controllers_.size(); ++i)
     status &= crtc_controllers_[i]->MoveCursor(location);
 
   return status;
 }
 
 void HardwareDisplayController::AddCrtc(scoped_ptr<CrtcController> controller) {
   owned_hardware_planes_.add(
       controller->drm(),
       scoped_ptr<HardwareDisplayPlaneList>(new HardwareDisplayPlaneList()));
+  controller->AddObserver(this);
   crtc_controllers_.push_back(controller.release());
 }
 
 scoped_ptr<CrtcController> HardwareDisplayController::RemoveCrtc(
     uint32_t crtc) {
   for (ScopedVector<CrtcController>::iterator it = crtc_controllers_.begin();
        it != crtc_controllers_.end(); ++it) {
     if ((*it)->crtc() == crtc) {
       scoped_ptr<CrtcController> controller(*it);
       crtc_controllers_.weak_erase(it);
-      // Release any planes this crtc might own.
-      HardwareDisplayPlaneManager::ResetPlanes(
-          owned_hardware_planes_.find(controller->drm())->second, crtc);
       // Remove entry from |owned_hardware_planes_| iff no other crtcs share it.
       bool found = false;
       for (ScopedVector<CrtcController>::iterator it =
                crtc_controllers_.begin();
            it != crtc_controllers_.end(); ++it) {
         if ((*it)->drm() == controller->drm()) {
           found = true;
           break;
         }
       }
       if (!found)
         owned_hardware_planes_.erase(controller->drm());
+
+      controller->RemoveObserver(this);
+      // If a display configuration happens mid page flip we want to make sure
+      // the HDC won't wait for an event from a CRTC that is no longer
+      // associated with it.
+      if (controller->page_flip_pending())
+        OnPageFlipEvent();
+
       return controller.Pass();
     }
   }
 
   return scoped_ptr<CrtcController>();
 }
 
 bool HardwareDisplayController::HasCrtc(uint32_t crtc) const {
   for (size_t i = 0; i < crtc_controllers_.size(); ++i)
     if (crtc_controllers_[i]->crtc() == crtc)
@@ skipping 16 matching lines @@
 
 uint64_t HardwareDisplayController::GetTimeOfLastFlip() const {
   uint64_t time = 0;
   for (size_t i = 0; i < crtc_controllers_.size(); ++i)
     if (time < crtc_controllers_[i]->time_of_last_flip())
       time = crtc_controllers_[i]->time_of_last_flip();
 
   return time;
 }
 
+void HardwareDisplayController::OnPageFlipEvent() {
+  TRACE_EVENT0("dri", "HDC::OnPageFlipEvent");
+  if (HasPendingPageFlips())
+    return;
+
+  // If a CRTC was moved between HDCs while page-flipping, it will report a page
+  // flip without any scheduled requests.
+  if (!requests_.empty())
+    ProcessPageFlipRequest();
+
+  if (requests_.empty())
+    return;
+
+  bool status = ActualSchedulePageFlip();
+  if (!status) {
+    PageFlipRequest request = requests_.front();
+    requests_.pop_front();
+
+    // Normally the caller would handle the error call, but because we're in a
+    // delayed schedule the initial SchedulePageFlip() already returned true,
+    // this we need to run the callback.
+    request.callback.Run();
+  }
+}
+
+bool HardwareDisplayController::HasPendingPageFlips() const {
+  for (size_t i = 0; i < crtc_controllers_.size(); ++i)
+    if (crtc_controllers_[i]->page_flip_pending())
+      return true;
+
+  return false;
+}
+
+bool HardwareDisplayController::ActualSchedulePageFlip() {
+  TRACE_EVENT0("dri", "HDC::ActualSchedulePageFlip");
+  DCHECK(!requests_.empty());
+
+  if (is_disabled_) {
+    ProcessPageFlipRequest();
+    return true;
+  }
+
+  OverlayPlaneList pending_planes = requests_.front().planes;
+  std::sort(pending_planes.begin(), pending_planes.end(),
+            [](const OverlayPlane& l, const OverlayPlane& r) {
+    return l.z_order < r.z_order;
+  });
+
+  bool status = true;
+  for (size_t i = 0; i < crtc_controllers_.size(); ++i) {
+    status &= crtc_controllers_[i]->SchedulePageFlip(
+        owned_hardware_planes_.get(crtc_controllers_[i]->drm()),
+        pending_planes);
+  }
+
+  for (const auto& planes : owned_hardware_planes_) {
+    if (!planes.first->plane_manager()->Commit(planes.second)) {
+      status = false;
+    }
+  }
+
+  return status;
+}
+
+void HardwareDisplayController::ProcessPageFlipRequest() {
+  DCHECK(!requests_.empty());
+  PageFlipRequest request = requests_.front();

[alexst (slow to review), 2015/01/09 16:06:58]

nit: PageFlipRequest& request = requests_.front(); here and in
ClearPendingRequests because deque returns a ref, no need to copy the data here.

[dnicoara, 2015/01/09 16:08:40]

We do need to copy it since we're popping the element right after.

[alexst (slow to review), 2015/01/09 16:10:52]

Acknowledged.

+  requests_.pop_front();
+
+  current_planes_.swap(request.planes);
+  request.callback.Run();
+}
+
+void HardwareDisplayController::ClearPendingRequests() {
+  while (!requests_.empty()) {
+    PageFlipRequest request = requests_.front();
+    requests_.pop_front();
+    request.callback.Run();
+  }
+}
+
 }  // namespace ui