Prioritizing input and compositor tasks in the blink scheduler.

Source/platform/scheduler/Scheduler.cpp

 // 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 "config.h"
 #include "platform/scheduler/Scheduler.h"
 
+#include "platform/PlatformThreadData.h"
 #include "platform/Task.h"
+#include "platform/ThreadTimers.h"
 #include "platform/TraceEvent.h"
-#include "platform/TraceLocation.h"
 #include "public/platform/Platform.h"
-#include "public/platform/WebThread.h"
+#include "wtf/WeakPtr.h"
 
 namespace blink {
 
 namespace {
 
-class MainThreadTaskAdapter : public blink::WebThread::Task {
-public:
-    explicit MainThreadTaskAdapter(const TraceLocation& location, const Scheduler::Task& task)
-        : m_location(location)
-        , m_task(task)
-    {
-    }
-
-    // WebThread::Task implementation.
-    virtual void run() OVERRIDE
-    {
-        TRACE_EVENT2("blink", "MainThreadTaskAdapter::run",
-            "src_file", m_location.fileName(),
-            "src_func", m_location.functionName());
-        m_task();
-    }
-
-private:
-    const TraceLocation m_location;
-    Scheduler::Task m_task;
-};
-
 class MainThreadIdleTaskAdapter : public blink::WebThread::Task {
 public:
     MainThreadIdleTaskAdapter(const Scheduler::IdleTask& idleTask, double allottedTimeMs)
         : m_idleTask(idleTask)
         , m_allottedTimeMs(allottedTimeMs)
     {
     }
 
     // WebThread::Task implementation.
     virtual void run() OVERRIDE
     {
         TRACE_EVENT1("blink", "MainThreadIdleTaskAdapter::run", "allottedTime", m_allottedTimeMs);
         m_idleTask(m_allottedTimeMs);
     }
 
 private:
     Scheduler::IdleTask m_idleTask;
     double m_allottedTimeMs;
 };
 
+class MainThreadPendingTaskRunner : public blink::WebThread::Task {
+public:
+    MainThreadPendingTaskRunner()
+        : m_weakPtrFactory(this)
+    {
+        s_taskInFlight = m_weakPtrFactory.createWeakPtr();
+    }
+
+    // WebThread::Task implementation.
+    virtual void run() OVERRIDE
+    {
+        Scheduler::shared()->runPendingTasks();
+    }
+
+    static bool isTaskInFlight()
+    {
+        return s_taskInFlight;
+    }
+
+private:
+    WeakPtrFactory<MainThreadPendingTaskRunner> m_weakPtrFactory;
+
+    static WeakPtr<MainThreadPendingTaskRunner> s_taskInFlight;
+};
+
+WeakPtr<MainThreadPendingTaskRunner> MainThreadPendingTaskRunner::s_taskInFlight;

[Sami, 2014/08/07 14:24:45]

I think we need to avoid non-POD static initializers. There's a DEFINE_GLOBAL
macro if we really need this, but is there a way we could avoid it by maybe
keeping track of whether the task is pending with a normal (atomic) bool?

[alexclarke, 2014/08/07 15:15:29]

Done.

 }
 
 Scheduler* Scheduler::s_sharedScheduler = nullptr;
 
 void Scheduler::initializeOnMainThread()
 {
     s_sharedScheduler = new Scheduler();
 }
 
 void Scheduler::shutdown()
 {
     delete s_sharedScheduler;
     s_sharedScheduler = nullptr;
 }
 
 Scheduler* Scheduler::shared()
 {
     return s_sharedScheduler;
 }
 
 Scheduler::Scheduler()
     : m_mainThread(blink::Platform::current()->currentThread())
     , m_sharedTimerFunction(nullptr)
 {
 }
 
 Scheduler::~Scheduler()
 {
-}
-
-void Scheduler::scheduleTask(const TraceLocation& location, const Task& task)
-{
-    m_mainThread->postTask(new MainThreadTaskAdapter(location, task));
+    runPendingTasks();
 }
 
 void Scheduler::scheduleIdleTask(const IdleTask& idleTask)
 {
     // TODO: send a real allottedTime here.
     m_mainThread->postTask(new MainThreadIdleTaskAdapter(idleTask, 0));
 }
 
 void Scheduler::postTask(const TraceLocation& location, const Task& task)
 {
-    scheduleTask(location, task);
+    m_pendingLowPriorityTasks.append(TracedTask(task, location));
+    maybePostTaskLoopOnMainThread();
 }
 
 void Scheduler::postInputTask(const TraceLocation& location, const Task& task)
 {
-    scheduleTask(location, task);
+    m_pendingInputTasks.append(TracedTask(task, location));
+    maybePostTaskLoopOnMainThread();
 }
 
 void Scheduler::postCompositorTask(const TraceLocation& location, const Task& task)
 {
-    scheduleTask(location, task);
+    m_pendingCompositorTasks.append(TracedTask(task, location));
+    maybePostTaskLoopOnMainThread();
 }
 
 void Scheduler::postIdleTask(const IdleTask& idleTask)
 {
     scheduleIdleTask(idleTask);
 }
 
 void Scheduler::tickSharedTimer()
 {
     TRACE_EVENT0("blink", "Scheduler::tickSharedTimer");
+
+    runHighPriorityTasks();
     m_sharedTimerFunction();
+    runHighPriorityTasks();
+}
+
+void Scheduler::runPendingTasks()
+{
+    TRACE_EVENT0("blink", "Scheduler::runPendingTasks");
+
+    // Execute tasks from the queues in order of priority.
+    for (;;) {
+        runHighPriorityTasks();
+
+        if (m_pendingLowPriorityTasks.isEmpty())
+            break;
+        m_pendingLowPriorityTasks.takeFirst().run();
+    }
+}
+
+void Scheduler::runHighPriorityTasks()
+{
+    TRACE_EVENT0("blink", "Scheduler::runHighPriorityTasks");
+
+    for (;;) {
+        if (!m_pendingInputTasks.isEmpty()) {
+            m_pendingInputTasks.takeFirst().run();
+            continue;
+        }
+
+        if (m_pendingCompositorTasks.isEmpty())
+            break;
+        m_pendingCompositorTasks.takeFirst().run();
+    }
+}
+
+void Scheduler::maybePostTaskLoopOnMainThread()
+{
+    if (MainThreadPendingTaskRunner::isTaskInFlight())
+        return;
+
+    m_mainThread->postTask(new MainThreadPendingTaskRunner());
 }
 
 void Scheduler::sharedTimerAdapter()
 {
     shared()->tickSharedTimer();
 }
 
 void Scheduler::setSharedTimerFiredFunction(void (*function)())
 {
     m_sharedTimerFunction = function;
     blink::Platform::current()->setSharedTimerFiredFunction(function ? &Scheduler::sharedTimerAdapter : nullptr);
 }
 
 void Scheduler::setSharedTimerFireInterval(double interval)
 {
     blink::Platform::current()->setSharedTimerFireInterval(interval);
 }
 
 void Scheduler::stopSharedTimer()
 {
     blink::Platform::current()->stopSharedTimer();
 }
 
 bool Scheduler::shouldYieldForHighPriorityWork()
 {
-    return false;
+    return !m_pendingInputTasks.isEmpty() || !m_pendingCompositorTasks.isEmpty();
+}
+
+void Scheduler::TracedTask::run()
+{
+    TRACE_EVENT2("blink", "TracedTask::run",
+        "src_file", m_location.fileName(),
+        "src_func", m_location.functionName());
+    m_task();
 }
 
 } // namespace blink