[Blink-Worker] WorkerThread fires idleHandler only at the end of processing all tasks.

Source/core/workers/WorkerThread.cpp

 /*
  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 162 matching lines @@
             m_sharedTimerFunction();
     }
 
     WorkerThread* m_workerThread;
     SharedTimerFunction m_sharedTimerFunction;
     double m_nextFireTime;
     bool m_running;
     WorkerThreadCancelableTask* m_lastQueuedTask;
 };
 
-class WorkerThreadTask : public blink::WebThread::Task {
-    WTF_MAKE_NONCOPYABLE(WorkerThreadTask); WTF_MAKE_FAST_ALLOCATED;
-public:
-    static PassOwnPtr<WorkerThreadTask> create(WorkerThread& workerThread, PassOwnPtr<ExecutionContextTask> task, bool isInstrumented)
-    {
-        return adoptPtr(new WorkerThreadTask(workerThread, task, isInstrumented));
+// WorkerThreadTask made private to WorkerThread
+PassOwnPtr<WorkerThread::WorkerThreadTask> WorkerThread::WorkerThreadTask::create(WorkerThread& workerThread
+    , PassOwnPtr<ExecutionContextTask> task, bool isInstrumented)
+{
+    return adoptPtr(new WorkerThreadTask(workerThread, task, isInstrumented));
+}
+
+void WorkerThread::WorkerThreadTask::run()
+{
+    WorkerGlobalScope* workerGlobalScope = m_workerThread.workerGlobalScope();
+    // Tasks could be put on the message loop after the cleanup task,
+    // ensure none of those are ran.
+    if (!workerGlobalScope || m_isTaskCanceled)
+        return;
+
+    if (m_isInstrumented)
+        InspectorInstrumentation::willPerformExecutionContextTask(workerGlobalScope, m_task.get());
+    if ((!workerGlobalScope->isClosing() && !m_workerThread.terminated()) || m_task->isCleanupTask()) {
+        if (!m_isIdleHandlerTask || (m_isIdleHandlerTask && !m_workerThread.taskCount()))
+            m_task->performTask(workerGlobalScope);
     }
+    if (m_isInstrumented)
+        InspectorInstrumentation::didPerformExecutionContextTask(workerGlobalScope);
 
-    virtual ~WorkerThreadTask() { }
+    // If no more tasks are queued up after this, then queue up the idleHandler
+    // to trigger GC.
+    if (!m_isIdleHandlerTask && !m_workerThread.decrementAndReturnTaskCount() && !m_workerThread.m_lastQueuedIdleHandlerTask)
+        m_workerThread.queueUpIdleHandlerNow(kLongIdleHandlerDelayMs);
+}
 
-    virtual void run() override
-    {
-        WorkerGlobalScope* workerGlobalScope = m_workerThread.workerGlobalScope();
-        // Tasks could be put on the message loop after the cleanup task,
-        // ensure none of those are ran.
-        if (!workerGlobalScope)
-            return;
-
-        if (m_isInstrumented)
-            InspectorInstrumentation::willPerformExecutionContextTask(workerGlobalScope, m_task.get());
-        if ((!workerGlobalScope->isClosing() && !m_workerThread.terminated()) || m_task->isCleanupTask())
-            m_task->performTask(workerGlobalScope);
-        if (m_isInstrumented)
-            InspectorInstrumentation::didPerformExecutionContextTask(workerGlobalScope);
-    }
-
-private:
-    WorkerThreadTask(WorkerThread& workerThread, PassOwnPtr<ExecutionContextTask> task, bool isInstrumented)
-        : m_workerThread(workerThread)
-        , m_task(task)
-        , m_isInstrumented(isInstrumented)
-    {
-        if (m_isInstrumented)
-            m_isInstrumented = !m_task->taskNameForInstrumentation().isEmpty();
-        if (m_isInstrumented)
-            InspectorInstrumentation::didPostExecutionContextTask(m_workerThread.workerGlobalScope(), m_task.get());
-    }
-
-    WorkerThread& m_workerThread;
-    OwnPtr<ExecutionContextTask> m_task;
-    bool m_isInstrumented;
-};
+WorkerThread::WorkerThreadTask::WorkerThreadTask(WorkerThread& workerThread
+    , PassOwnPtr<ExecutionContextTask> task, bool isInstrumented)
+    : m_workerThread(workerThread)
+    , m_task(task)
+    , m_isInstrumented(isInstrumented)
+    , m_isIdleHandlerTask(false)
+    , m_isTaskCanceled(false)
+    , m_timeStamp(currentTime())
+{
+    if (m_isInstrumented)
+        m_isInstrumented = !m_task->taskNameForInstrumentation().isEmpty();
+    if (m_isInstrumented)
+        InspectorInstrumentation::didPostExecutionContextTask(m_workerThread.workerGlobalScope(), m_task.get());
+}
 
 class RunDebuggerQueueTask final : public ExecutionContextTask {
 public:
     static PassOwnPtr<RunDebuggerQueueTask> create(WorkerThread* thread)
     {
         return adoptPtr(new RunDebuggerQueueTask(thread));
     }
     virtual void performTask(ExecutionContext* context) override
     {
         ASSERT(context->isWorkerGlobalScope());
         m_thread->runDebuggerTask(WorkerThread::DontWaitForMessage);
     }
 
 private:
     explicit RunDebuggerQueueTask(WorkerThread* thread) : m_thread(thread) { }
 
     WorkerThread* m_thread;
 };
 
 WorkerThread::WorkerThread(WorkerLoaderProxy& workerLoaderProxy, WorkerReportingProxy& workerReportingProxy, PassOwnPtrWillBeRawPtr<WorkerThreadStartupData> startupData)
     : m_terminated(false)
     , m_workerLoaderProxy(workerLoaderProxy)
     , m_workerReportingProxy(workerReportingProxy)
     , m_startupData(startupData)
     , m_shutdownEvent(adoptPtr(blink::Platform::current()->createWaitableEvent()))
     , m_terminationEvent(adoptPtr(blink::Platform::current()->createWaitableEvent()))
+    , m_lastQueuedIdleHandlerTask(nullptr)
+    , m_tasksCount(0)
 {
     MutexLocker lock(threadSetMutex());
     workerThreads().add(this);
 }
 
 WorkerThread::~WorkerThread()
 {
     MutexLocker lock(threadSetMutex());
     ASSERT(workerThreads().contains(this));
     workerThreads().remove(this);
@@ skipping 62 matching lines @@
     script->evaluate(ScriptSourceCode(sourceCode, scriptURL));
     m_workerGlobalScope->didEvaluateWorkerScript();
 
     postInitialize();
 
     postDelayedTask(createSameThreadTask(&WorkerThread::idleHandler, this), kShortIdleHandlerDelayMs);
 }
 
 void WorkerThread::cleanup()
 {
-
     // This should be called before we start the shutdown procedure.
     workerReportingProxy().willDestroyWorkerGlobalScope();
 
     // The below assignment will destroy the context, which will in turn notify messaging proxy.
     // We cannot let any objects survive past thread exit, because no other thread will run GC or otherwise destroy them.
     // If Oilpan is enabled, we detach of the context/global scope, with the final heap cleanup below sweeping it out.
 #if !ENABLE(OILPAN)
     ASSERT(m_workerGlobalScope->hasOneRef());
 #endif
     m_workerGlobalScope->dispose();
@@ skipping 111 matching lines @@
 
     for (WorkerThread* thread : threads)
         thread->terminationEvent()->wait();
 }
 
 bool WorkerThread::isCurrentThread() const
 {
     return m_thread && m_thread->isCurrentThread();
 }
 
+void WorkerThread::queueUpIdleHandlerNow(long long delayMs)
+{
+    OwnPtr<WorkerThreadTask> idleHandlerTask = WorkerThreadTask::create(*this, createSameThreadTask(&WorkerThread::idleHandler, this), true);
+
+    idleHandlerTask->setIsIdleHandlerTask(true);
+
+    if (clearIdleHandlerTaskIfSet()) {
+        WorkerThreadTask* tmp = idleHandlerTask.get();
+        m_thread->postDelayedTask(idleHandlerTask.leakPtr(), delayMs);
+        m_lastQueuedIdleHandlerTask = tmp;
+    }
+}
+
 void WorkerThread::idleHandler()
 {
     ASSERT(m_workerGlobalScope.get());
     int64_t delay = kLongIdleHandlerDelayMs;
+    m_lastQueuedIdleHandlerTask = nullptr;
+
+    // Some tasks may have been started in the mean time, so lets return back
+    // and wait for the next idleHandler to be fired.
+    if (m_tasksCount)
+        return;
 
     // Do a script engine idle notification if the next event is distant enough.
     const double kMinIdleTimespan = 0.3;
+    // This is set to true when idleNotification returns false.
+    // idleNotification returns false only when more GC is required. It returns
+    // true if no more GC is required and that is when callGCAgain will be set to false.
+    bool callGCAgain = false;
     if (m_sharedTimer->nextFireTime() == 0.0 || m_sharedTimer->nextFireTime() > currentTime() + kMinIdleTimespan) {
-        bool hasMoreWork = !m_workerGlobalScope->idleNotification();
-        if (hasMoreWork)
+        callGCAgain = !m_workerGlobalScope->idleNotification();
+        if (callGCAgain)
             delay = kShortIdleHandlerDelayMs;
     }
 
-    postDelayedTask(createSameThreadTask(&WorkerThread::idleHandler, this), delay);
+    if (callGCAgain)
+        queueUpIdleHandlerNow(delay);
+}
+
+int WorkerThread::decrementAndReturnTaskCount()
+{
+    atomicDecrement(&m_tasksCount);
+    return m_tasksCount;
+}
+
+bool WorkerThread::clearIdleHandlerTaskIfSet()
+{
+    // If the event was created more than 3 seconds ago, so its too close to the task completion
+    // hence cancel it and create a new one.
+    const double kIdleHandlerAgeThreshold = 3.0;
+    if (!m_lastQueuedIdleHandlerTask)
+        return true;
+    double idleTaskHandlerAge = currentTime() - m_lastQueuedIdleHandlerTask->creationTimeStamp();
+    if (idleTaskHandlerAge < kIdleHandlerAgeThreshold)
+        return false;
+
+    m_lastQueuedIdleHandlerTask->cancelTask();
+    m_lastQueuedIdleHandlerTask = nullptr;
+
+    return true;
 }
 
 void WorkerThread::postTask(PassOwnPtr<ExecutionContextTask> task)
 {
+    atomicIncrement(&m_tasksCount);
+    clearIdleHandlerTaskIfSet();
     m_thread->postTask(WorkerThreadTask::create(*this, task, true).leakPtr());
 }
 
 void WorkerThread::postDelayedTask(PassOwnPtr<ExecutionContextTask> task, long long delayMs)
 {
+    atomicIncrement(&m_tasksCount);
+    clearIdleHandlerTaskIfSet();
     m_thread->postDelayedTask(WorkerThreadTask::create(*this, task, true).leakPtr(), delayMs);
 }
 
 void WorkerThread::postDebuggerTask(PassOwnPtr<ExecutionContextTask> task)
 {
     m_debuggerMessageQueue.append(WorkerThreadTask::create(*this, task, false));
     postTask(RunDebuggerQueueTask::create(this));
 }
 
 MessageQueueWaitResult WorkerThread::runDebuggerTask(WaitMode waitMode)
@@ skipping 28 matching lines @@
     InspectorInstrumentation::didLeaveNestedRunLoop(m_workerGlobalScope.get());
 }
 
 void WorkerThread::setWorkerInspectorController(WorkerInspectorController* workerInspectorController)
 {
     MutexLocker locker(m_workerInspectorControllerMutex);
     m_workerInspectorController = workerInspectorController;
 }
 
 } // namespace blink