Getting rid of CompositorFrameMetadata::satisfies_sequences

cc/layers/surface_layer.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 "cc/layers/surface_layer.h"
 
 #include <stdint.h>
 
 #include "base/macros.h"
+#include "base/threading/thread_task_runner_handle.h"
 #include "base/trace_event/trace_event.h"
 #include "cc/layers/surface_layer_impl.h"
 #include "cc/output/swap_promise.h"
 #include "cc/surfaces/surface_sequence_generator.h"
 #include "cc/trees/layer_tree_host.h"
 #include "cc/trees/swap_promise_manager.h"
 
 namespace cc {
 
+namespace {
+
+// Some thread checkers fail if satisfy callback is not run on the main thread.
+void PostSatisfyCallbackToMainThread(
+    scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
+    SurfaceLayer::SatisfyCallback satisfy_callback,
+    SurfaceSequence sequence) {
+  main_task_runner->PostTask(FROM_HERE, base::Bind(satisfy_callback, sequence));
+}
+
+}  // namespace
+
 class SatisfySwapPromise : public SwapPromise {
  public:
-  SatisfySwapPromise(SurfaceSequence sequence,
-                     const SurfaceLayer::SatisfyCallback& satisfy_callback)
-      : sequence_(sequence), satisfy_callback_(satisfy_callback) {}
+  SatisfySwapPromise(
+      const SurfaceSequence& sequence,
+      const SurfaceLayer::SatisfyCallback& satisfy_callback,
+      scoped_refptr<base::SingleThreadTaskRunner> main_task_runner)
+      : sequence_(sequence),
+        satisfy_callback_(satisfy_callback),
+        main_task_runner_(std::move(main_task_runner)) {}
 
   ~SatisfySwapPromise() override {}
 
  private:
   void DidActivate() override {}
   void DidSwap(CompositorFrameMetadata* metadata) override {
-    metadata->satisfies_sequences.push_back(sequence_.sequence);
+    // This method is called before the swap is actually performed in order to
+    // potentially add some stuff to compositor frame's metadata.
+    // By posting a task, we ensure that satisfy callback is not called until
+    // the swap is over.
+    base::ThreadTaskRunnerHandle::Get()->PostTask(

[Fady Samuel, 2016/12/14 05:03:06]

Not a huge fan of this, but if jbauman@ is OK with it then so am I.

[danakj, 2016/12/14 16:17:20]

Hm.. this will ofc wait for a fresh callstack, but it is pretty fragile as it
depends on behaviour of unrelated implementation details. It should have a test
that verifies that doing a post will run the task after the swap is done on that
thread.

Another option would be DidSwap => WillSwap (and DidNotSwap => WillNotSwap) and
then add a new DidSwap that is actually after. Then its less magical and spelled
out with APIs.

+        FROM_HERE, base::Bind(PostSatisfyCallbackToMainThread,
+                              main_task_runner_, satisfy_callback_, sequence_));
   }
 
   DidNotSwapAction DidNotSwap(DidNotSwapReason reason) override {
-    satisfy_callback_.Run(sequence_);
+    main_task_runner_->PostTask(FROM_HERE,
+                                base::Bind(satisfy_callback_, sequence_));
     return DidNotSwapAction::BREAK_PROMISE;
   }
   int64_t TraceId() const override { return 0; }
 
   SurfaceSequence sequence_;
   SurfaceLayer::SatisfyCallback satisfy_callback_;
+  scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
 
   DISALLOW_COPY_AND_ASSIGN(SatisfySwapPromise);
 };
 
 scoped_refptr<SurfaceLayer> SurfaceLayer::Create(
     const SatisfyCallback& satisfy_callback,
     const RequireCallback& require_callback) {
   return make_scoped_refptr(
       new SurfaceLayer(satisfy_callback, require_callback));
 }
@@ skipping 59 matching lines @@
                             ->GetSurfaceSequenceGenerator()
                             ->CreateSurfaceSequence();
     require_callback_.Run(surface_id_, destroy_sequence_);
   }
 }
 
 void SurfaceLayer::SatisfyDestroySequence() {
   if (!layer_tree_host())
     return;
   DCHECK(destroy_sequence_.is_valid());
-  std::unique_ptr<SatisfySwapPromise> satisfy(
-      new SatisfySwapPromise(destroy_sequence_, satisfy_callback_));
+  auto satisfy =
+      base::MakeUnique<SatisfySwapPromise>(destroy_sequence_, satisfy_callback_,
+                                           base::ThreadTaskRunnerHandle::Get());
   layer_tree_host()->GetSwapPromiseManager()->QueueSwapPromise(
       std::move(satisfy));
   destroy_sequence_ = SurfaceSequence();
 }
 
 }  // namespace cc