Adding flow traces for blink scheduler events

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"
@@ skipping 55 matching lines @@
         scheduler->swapQueuesRunPendingTasksAndAllowHighPriorityTaskRunnerPosting();
     }
 };
 
 
 // Can be created from any thread.
 // Note if the scheduler gets shutdown, this may be run after.
 class Scheduler::MainThreadPendingTaskRunner : public WebThread::Task {
 public:
     MainThreadPendingTaskRunner(
-        const Scheduler::Task& task, const TraceLocation& location)
-        : m_task(task, location)
+        const Scheduler::Task& task, const TraceLocation& location, const char * name, int flowTraceID)

[Sami, 2014/08/29 14:50:25]

No space before "*".

[picksi1, 2014/09/01 11:06:51]

Done.

+        : m_task(task, location, name, flowTraceID)
     {
         ASSERT(Scheduler::shared());
     }
 
     // WebThread::Task implementation.
     virtual void run() OVERRIDE
     {
         Scheduler* scheduler = Scheduler::shared();
         // FIXME: This check should't be necessary, tasks should not outlive blink.
         ASSERT(scheduler);
         if (scheduler)
             Scheduler::shared()->swapQueuesAndRunPendingTasks();
         m_task.run();
     }
 
-    Scheduler::TracedTask m_task;
+    TracedTask m_task;
 };
 
 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_sharedTimerFunction(nullptr)
     , m_mainThread(blink::Platform::current()->currentThread())
     , m_highPriorityTaskCount(0)
     , m_highPriorityTaskRunnerPosted(false)
 {
+    // Start trace ID off as 'this' to keep multiple instances of the scheduler
+    // having different(-ish) unique flow tracing IDs. Keep compiler happy
+    // by casting to a pointer and then to an integer.
+    intptr_t thisAsPointer = reinterpret_cast<intptr_t>(this);

[Sami, 2014/08/29 14:50:25]

Maybe it's just me, but I think this is a little verbose -- I'd just write the
conversion into a single line in the member initialization.

[picksi1, 2014/09/01 11:06:51]

Done.

+    int thisAsInteger = static_cast<int>(thisAsPointer);
+    m_nextFlowTraceID = thisAsInteger;
 }
 
 Scheduler::~Scheduler()
 {
     while (hasPendingHighPriorityWork()) {
         swapQueuesAndRunPendingTasks();
     }
 }
 
+int Scheduler::generateFlowTraceID()
+{
+    return atomicIncrement(&m_nextFlowTraceID);
+}
+
 void Scheduler::scheduleIdleTask(const TraceLocation& location, const IdleTask& idleTask)
 {
     // TODO: send a real allottedTime here.
     m_mainThread->postTask(new MainThreadIdleTaskAdapter(idleTask, 0, location));
 }
 
+void Scheduler::postAsHighPriorityTask(const TraceLocation& location, const Task& task, const char * traceName)

[Sami, 2014/08/29 14:50:25]

nit: postHighPriorityTask to match the wording of the other functions.

No space before "*".

[picksi1, 2014/09/01 11:06:51]

I'd named this differently on purpose as it is an internal (i.e. private)
function and has different parameters from the other PostTask functions (which
all take a location and a task).

+{
+    Locker<Mutex> lock(m_pendingTasksMutex);
+
+    TracedTask tracedTask = TracedTask(task, location, traceName, generateFlowTraceID());
+    m_pendingHighPriorityTasks.append(tracedTask);
+    atomicIncrement(&m_highPriorityTaskCount);
+    maybePostMainThreadPendingHighPriorityTaskRunner();
+}
+
 void Scheduler::postTask(const TraceLocation& location, const Task& task)
 {
-    m_mainThread->postTask(new MainThreadPendingTaskRunner(task, location));
+    m_mainThread->postTask(new MainThreadPendingTaskRunner(task, location, "Scheduler::MainThreadTask", generateFlowTraceID()));
 }
 
 void Scheduler::postInputTask(const TraceLocation& location, const Task& task)
 {
-    Locker<Mutex> lock(m_pendingTasksMutex);
-    m_pendingHighPriorityTasks.append(TracedTask(task, location));
-    atomicIncrement(&m_highPriorityTaskCount);
-    maybePostMainThreadPendingHighPriorityTaskRunner();
+    postAsHighPriorityTask(location, task, "Scheduler::InputTask");
 }
 
 void Scheduler::postCompositorTask(const TraceLocation& location, const Task& task)
 {
-    Locker<Mutex> lock(m_pendingTasksMutex);
-    m_pendingHighPriorityTasks.append(TracedTask(task, location));
-    atomicIncrement(&m_highPriorityTaskCount);
-    maybePostMainThreadPendingHighPriorityTaskRunner();
+    postAsHighPriorityTask(location, task, "Scheduler::CompositorTask");
 }
 
 void Scheduler::maybePostMainThreadPendingHighPriorityTaskRunner()
 {
     ASSERT(m_pendingTasksMutex.locked());
     if (m_highPriorityTaskRunnerPosted)
         return;
     m_mainThread->postTask(new MainThreadPendingHighPriorityTaskRunner());
     m_highPriorityTaskRunnerPosted = true;
 }
@@ skipping 85 matching lines @@
 bool Scheduler::hasPendingHighPriorityWork() const
 {
     // This method is expected to be run on the main thread, but the high priority tasks will be posted by
     // other threads. We could use locks here, but this function is (sometimes) called a lot by
     // ThreadTimers::sharedTimerFiredInternal so we decided to use atomics + barrier loads here which
     // should be cheaper.
     // NOTE it's possible the barrier read is overkill here, since delayed yielding isn't a big deal.
     return acquireLoad(&m_highPriorityTaskCount) != 0;
 }
 
-void Scheduler::TracedTask::run()
-{
-    TRACE_EVENT2("blink", "TracedTask::run",
-        "src_file", m_location.fileName(),
-        "src_func", m_location.functionName());
-    m_task();
-}
-
 } // namespace blink