Refactor TimeBase to post tasks. Workers to use real Idle 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 20 matching lines @@
 #include "bindings/core/v8/ScriptSourceCode.h"
 #include "bindings/core/v8/V8GCController.h"
 #include "bindings/core/v8/V8Initializer.h"
 #include "core/dom/Microtask.h"
 #include "core/inspector/InspectorInstrumentation.h"
 #include "core/inspector/WorkerInspectorController.h"
 #include "core/workers/DedicatedWorkerGlobalScope.h"
 #include "core/workers/WorkerClients.h"
 #include "core/workers/WorkerReportingProxy.h"
 #include "core/workers/WorkerThreadStartupData.h"
-#include "platform/PlatformThreadData.h"
 #include "platform/Task.h"
 #include "platform/ThreadSafeFunctional.h"
-#include "platform/ThreadTimers.h"
 #include "platform/heap/SafePoint.h"
 #include "platform/heap/ThreadState.h"
 #include "platform/weborigin/KURL.h"
 #include "public/platform/Platform.h"
+#include "public/platform/WebScheduler.h"
 #include "public/platform/WebThread.h"
 #include "public/platform/WebWaitableEvent.h"
 #include "wtf/Noncopyable.h"
 #include "wtf/WeakPtr.h"
 #include "wtf/text/WTFString.h"
 
 namespace blink {
 
 namespace {
-const int64_t kShortIdleHandlerDelayMs = 1000;
-const int64_t kLongIdleHandlerDelayMs = 10*1000;
+const double kLongIdleHandlerDelaySecs = 1.0;
 
 class MicrotaskRunner : public WebThread::TaskObserver {
 public:
     explicit MicrotaskRunner(WorkerThread* workerThread)
         : m_workerThread(workerThread)
     {
     }
 
     virtual void willProcessTask() override { }
     virtual void didProcessTask() override
@@ skipping 24 matching lines @@
     DEFINE_STATIC_LOCAL(HashSet<WorkerThread*>, threads, ());
     return threads;
 }
 
 unsigned WorkerThread::workerThreadCount()
 {
     MutexLocker lock(threadSetMutex());
     return workerThreads().size();
 }
 
-class WorkerThreadCancelableTask final : public ExecutionContextTask {
-    WTF_MAKE_NONCOPYABLE(WorkerThreadCancelableTask); WTF_MAKE_FAST_ALLOCATED(WorkerThreadCancelableTask);
-public:
-    static PassOwnPtr<WorkerThreadCancelableTask> create(PassOwnPtr<Closure> closure)
-    {
-        return adoptPtr(new WorkerThreadCancelableTask(closure));
-    }
-
-    virtual ~WorkerThreadCancelableTask() { }
-
-    virtual void performTask(ExecutionContext*) override
-    {
-        if (!m_taskCanceled)
-            (*m_closure)();
-    }
-
-    WeakPtr<WorkerThreadCancelableTask> createWeakPtr() { return m_weakFactory.createWeakPtr(); }
-    void cancelTask() { m_taskCanceled = true; }
-
-private:
-    explicit WorkerThreadCancelableTask(PassOwnPtr<Closure> closure)
-        : m_closure(closure)
-        , m_weakFactory(this)
-        , m_taskCanceled(false)
-    { }
-
-    OwnPtr<Closure> m_closure;
-    WeakPtrFactory<WorkerThreadCancelableTask> m_weakFactory;
-    bool m_taskCanceled;
-};
-
-class WorkerSharedTimer : public SharedTimer {
-public:
-    explicit WorkerSharedTimer(WorkerThread* workerThread)
-        : m_workerThread(workerThread)
-        , m_running(false)
-    { }
-
-    typedef void (*SharedTimerFunction)();
-    virtual void setFiredFunction(SharedTimerFunction func)
-    {
-        m_sharedTimerFunction = func;
-    }
-
-    virtual void setFireInterval(double interval)
-    {
-        ASSERT(m_sharedTimerFunction);
-
-        // See BlinkPlatformImpl::setSharedTimerFireInterval for explanation of
-        // why ceil is used in the interval calculation.
-        int64_t delay = static_cast<int64_t>(ceil(interval * 1000));
-
-        if (delay < 0) {
-            delay = 0;
-        }
-
-        m_running = true;
-
-        if (m_lastQueuedTask.get())
-            m_lastQueuedTask->cancelTask();
-
-        // Now queue the task as a cancellable one.
-        OwnPtr<WorkerThreadCancelableTask> task = WorkerThreadCancelableTask::create(bind(&WorkerSharedTimer::OnTimeout, this));
-        m_lastQueuedTask = task->createWeakPtr();
-        m_workerThread->postDelayedTask(FROM_HERE, task.release(), delay);
-    }
-
-    virtual void stop()
-    {
-        m_running = false;
-        m_lastQueuedTask = nullptr;
-    }
-
-private:
-    void OnTimeout()
-    {
-        ASSERT(m_workerThread->workerGlobalScope());
-
-        m_lastQueuedTask = nullptr;
-
-        if (m_sharedTimerFunction && m_running && !m_workerThread->workerGlobalScope()->isClosing())
-            m_sharedTimerFunction();
-    }
-
-    WorkerThread* m_workerThread;
-    SharedTimerFunction m_sharedTimerFunction;
-    bool m_running;
-
-    // The task to run OnTimeout, if any. While OnTimeout resets
-    // m_lastQueuedTask, this must be a weak pointer because the
-    // worker runloop may delete the task as it is shutting down.
-    WeakPtr<WorkerThreadCancelableTask> m_lastQueuedTask;
-};
-
 class WorkerThreadTask : public blink::WebThread::Task {
     WTF_MAKE_NONCOPYABLE(WorkerThreadTask); WTF_MAKE_FAST_ALLOCATED(WorkerThreadTask);
 public:
     static PassOwnPtr<WorkerThreadTask> create(WorkerThread& workerThread, PassOwnPtr<ExecutionContextTask> task, bool isInstrumented)
     {
         return adoptPtr(new WorkerThreadTask(workerThread, task, isInstrumented));
     }
 
     virtual ~WorkerThreadTask() { }
 
@@ skipping 50 matching lines @@
 
 WorkerThread::WorkerThread(const char* threadName, PassRefPtr<WorkerLoaderProxy> workerLoaderProxy, WorkerReportingProxy& workerReportingProxy, PassOwnPtr<WorkerThreadStartupData> startupData)
     : m_threadName(threadName)
     , m_terminated(false)
     , m_workerLoaderProxy(workerLoaderProxy)
     , m_workerReportingProxy(workerReportingProxy)
     , m_startupData(startupData)
     , m_isolate(nullptr)
     , m_shutdownEvent(adoptPtr(blink::Platform::current()->createWaitableEvent()))
     , m_terminationEvent(adoptPtr(blink::Platform::current()->createWaitableEvent()))
+    , m_webScheduler(nullptr)
+    , m_preShutdown(false)
 {
     MutexLocker lock(threadSetMutex());
     workerThreads().add(this);
 }
 
 WorkerThread::~WorkerThread()
 {
     MutexLocker lock(threadSetMutex());
     ASSERT(workerThreads().contains(this));
     workerThreads().remove(this);
 }
 
 void WorkerThread::start()
 {
     if (m_thread)
         return;
 
     m_thread = createWebThreadSupportingGC();
+    m_webScheduler = m_thread->platformThread().scheduler();
     m_thread->postTask(FROM_HERE, new Task(threadSafeBind(&WorkerThread::initialize, AllowCrossThreadAccess(this))));
 }
 
 void WorkerThread::interruptAndDispatchInspectorCommands()
 {
     MutexLocker locker(m_workerInspectorControllerMutex);
     if (m_workerInspectorController)
         m_workerInspectorController->interruptAndDispatchInspectorCommands();
 }
 
 PlatformThreadId WorkerThread::platformThreadId() const
 {
     if (!m_thread)
         return 0;
     return m_thread->platformThread().threadId();
 }
 
+// TODO(alexclarke): Use base::Bind instead of this class when the repo's merge. Unfortunately we
+// can't use WTF::bind because the type-erasure for member function pointers with parameters is broken.
+class WorkerThreadIdleTask : public WebThread::IdleTask {
+public:
+    explicit WorkerThreadIdleTask(WorkerThread* thread)
+        : m_thread(thread) { }
+
+    ~WorkerThreadIdleTask() override { }
+
+    void run(double deadlineSeconds) override
+    {
+        m_thread->idleTask(deadlineSeconds);
+    }
+
+private:
+    RawPtr<WorkerThread> m_thread; // NOT OWNED
+};
+
 void WorkerThread::initialize()
 {
     KURL scriptURL = m_startupData->m_scriptURL;
     String sourceCode = m_startupData->m_sourceCode;
     WorkerThreadStartMode startMode = m_startupData->m_startMode;
     OwnPtr<Vector<char>> cachedMetaData = m_startupData->m_cachedMetaData.release();
     V8CacheOptions v8CacheOptions = m_startupData->m_v8CacheOptions;
 
     {
         MutexLocker lock(m_threadCreationMutex);
 
         // The worker was terminated before the thread had a chance to run.
         if (m_terminated) {
             // Notify the proxy that the WorkerGlobalScope has been disposed of.
             // This can free this thread object, hence it must not be touched afterwards.
             m_workerReportingProxy.workerThreadTerminated();
             return;
         }
 
         m_microtaskRunner = adoptPtr(new MicrotaskRunner(this));
         m_thread->addTaskObserver(m_microtaskRunner.get());
         m_thread->attachGC();
 
         m_isolate = initializeIsolate();
         m_workerGlobalScope = createWorkerGlobalScope(m_startupData.release());
         m_workerGlobalScope->scriptLoaded(sourceCode.length(), cachedMetaData.get() ? cachedMetaData->size() : 0);
-
-        PlatformThreadData::current().threadTimers().setSharedTimer(adoptPtr(new WorkerSharedTimer(this)));
     }
 
     // The corresponding call to stopRunLoop() is in ~WorkerScriptController().
     didStartRunLoop();
 
     // Notify proxy that a new WorkerGlobalScope has been created and started.
     m_workerReportingProxy.workerGlobalScopeStarted(m_workerGlobalScope.get());
 
     WorkerScriptController* script = m_workerGlobalScope->script();
     if (!script->isExecutionForbidden())
         script->initializeContextIfNeeded();
     if (startMode == PauseWorkerGlobalScopeOnStart)
         m_workerGlobalScope->workerInspectorController()->pauseOnStart();
 
     OwnPtr<CachedMetadataHandler> handler(workerGlobalScope()->createWorkerScriptCachedMetadataHandler(scriptURL, cachedMetaData.get()));
     bool success = script->evaluate(ScriptSourceCode(sourceCode, scriptURL), nullptr, handler.get(), v8CacheOptions);
     m_workerGlobalScope->didEvaluateWorkerScript();
     m_workerReportingProxy.didEvaluateWorkerScript(success);
 
     postInitialize();
 
-    postDelayedTask(FROM_HERE, createSameThreadTask(&WorkerThread::idleHandler, this), kShortIdleHandlerDelayMs);
+    m_webScheduler->postIdleTaskAfterWakeup(FROM_HERE, new WorkerThreadIdleTask(this));
 }
 
 PassOwnPtr<WebThreadSupportingGC> WorkerThread::createWebThreadSupportingGC()
 {
     return WebThreadSupportingGC::create(m_threadName);
 }
 
 void WorkerThread::cleanup()
 {
     // This should be called before we start the shutdown procedure.
@@ skipping 12 matching lines @@
     destroyIsolate();
 
     m_thread->removeTaskObserver(m_microtaskRunner.get());
     m_microtaskRunner = nullptr;
 
     // Notify the proxy that the WorkerGlobalScope has been disposed of.
     // This can free this thread object, hence it must not be touched afterwards.
     workerReportingProxy().workerThreadTerminated();
 
     m_terminationEvent->signal();
-
-    // Clean up PlatformThreadData before WTF::WTFThreadData goes away!
-    PlatformThreadData::current().destroy();
 }
 
 class WorkerThreadShutdownFinishTask : public ExecutionContextTask {
 public:
     static PassOwnPtr<WorkerThreadShutdownFinishTask> create()
     {
         return adoptPtr(new WorkerThreadShutdownFinishTask());
     }
 
     virtual void performTask(ExecutionContext *context)
     {
         WorkerGlobalScope* workerGlobalScope = toWorkerGlobalScope(context);
         workerGlobalScope->dispose();
 
         WorkerThread* workerThread = workerGlobalScope->thread();
         workerThread->willDestroyIsolate();
-        workerThread->m_thread->postTask(FROM_HERE, new Task(WTF::bind(&WorkerThread::cleanup, workerThread)));
+        workerThread->m_webScheduler->postShutdownTask(FROM_HERE, new Task(WTF::bind(&WorkerThread::cleanup, workerThread)), 0);
     }
 
     virtual bool isCleanupTask() const { return true; }
 };
 
 class WorkerThreadShutdownStartTask : public ExecutionContextTask {
 public:
     static PassOwnPtr<WorkerThreadShutdownStartTask> create()
     {
         return adoptPtr(new WorkerThreadShutdownStartTask());
     }
 
     virtual void performTask(ExecutionContext *context)
     {
         WorkerGlobalScope* workerGlobalScope = toWorkerGlobalScope(context);
         workerGlobalScope->stopActiveDOMObjects();
-        PlatformThreadData::current().threadTimers().setSharedTimer(nullptr);
 
         // Event listeners would keep DOMWrapperWorld objects alive for too long. Also, they have references to JS objects,
         // which become dangling once Heap is destroyed.
         workerGlobalScope->removeAllEventListeners();
 
         // Stick a shutdown command at the end of the queue, so that we deal
         // with all the cleanup tasks the databases post first.
         workerGlobalScope->postTask(FROM_HERE, WorkerThreadShutdownFinishTask::create());
     }
 
     virtual bool isCleanupTask() const { return true; }
 };
 
+class PreShutDownTask : public WebThread::Task {
+public:
+    PreShutDownTask(WebWaitableEvent* completion, WebScheduler* webScheduler)
+        : m_completion(completion)
+        , m_webScheduler(webScheduler) { }
+
+    ~PreShutDownTask() override { }
+
+    void run()
+    {
+        m_webScheduler->preShutdown();
+        m_completion->signal();
+    }
+
+private:
+    RawPtr<WebWaitableEvent> m_completion; // NOT OWNED.
+    RawPtr<WebScheduler> m_webScheduler; // NOT OWNED.
+};
+
+void WorkerThread::preShutdown()
+{
+    MutexLocker lock(m_preShutdownMutex);
+    if (m_preShutdown || !m_webScheduler)
+        return;
+    m_preShutdown = true;
+
+    if (m_thread->isCurrentThread()) {
+        m_webScheduler->preShutdown();
+    } else {
+        OwnPtr<WebWaitableEvent> completion(adoptPtr(blink::Platform::current()->createWaitableEvent()));
+        m_thread->postTask(FROM_HERE, new PreShutDownTask(completion.get(), m_webScheduler.get()));
+        completion->wait();
+    }
+}
+
 void WorkerThread::stop()
 {
     // Prevent the deadlock between GC and an attempt to stop a thread.
     SafePointScope safePointScope(ThreadState::HeapPointersOnStack);
     stopInternal();
 }
 
 void WorkerThread::stopInShutdownSequence()
 {
     stopInternal();
 }
 
 void WorkerThread::terminateAndWait()
 {
     stop();
     m_terminationEvent->wait();
 }
 
 bool WorkerThread::terminated()
 {
     MutexLocker lock(m_threadCreationMutex);
     return m_terminated;
 }
 
 void WorkerThread::stopInternal()
 {
     // Protect against this method and initialize() racing each other.
-    MutexLocker lock(m_threadCreationMutex);
+    {
+        MutexLocker lock(m_threadCreationMutex);
 
-    // If stop has already been called, just return.
-    if (m_terminated)
-        return;
-    m_terminated = true;
+        // If stop has already been called, just return.
+        if (m_terminated)
+            return;
+        m_terminated = true;
 
-    // Signal the thread to notify that the thread's stopping.
-    if (m_shutdownEvent)
-        m_shutdownEvent->signal();
+        // Signal the thread to notify that the thread's stopping.
+        if (m_shutdownEvent)
+            m_shutdownEvent->signal();
 
-    if (!m_workerGlobalScope)
-        return;
+        if (!m_workerGlobalScope)
+            return;
 
-    // Ensure that tasks are being handled by thread event loop. If script execution weren't forbidden, a while(1) loop in JS could keep the thread alive forever.
-    terminateV8Execution();
+        // Ensure that tasks are being handled by thread event loop. If script execution weren't forbidden, a while(1) loop in JS could keep the thread alive forever.
+        terminateV8Execution();
 
-    InspectorInstrumentation::didKillAllExecutionContextTasks(m_workerGlobalScope.get());
-    m_debuggerMessageQueue.kill();
-    postTask(FROM_HERE, WorkerThreadShutdownStartTask::create());
+        InspectorInstrumentation::didKillAllExecutionContextTasks(m_workerGlobalScope.get());
+        m_debuggerMessageQueue.kill();
+        postTask(FROM_HERE, WorkerThreadShutdownStartTask::create());
+    }
+    // Prevent further execution of non-shutdown tasks on the thread.  Must happen after any v8 task has been terminated.
+    preShutdown();
 }
 
 void WorkerThread::didStartRunLoop()
 {
     ASSERT(isCurrentThread());
     blink::Platform::current()->didStartWorkerRunLoop();
 }
 
 void WorkerThread::didStopRunLoop()
 {
@@ skipping 11 matching lines @@
 
     for (WorkerThread* thread : threads)
         thread->terminationEvent()->wait();
 }
 
 bool WorkerThread::isCurrentThread() const
 {
     return m_thread && m_thread->isCurrentThread();
 }
 
-void WorkerThread::idleHandler()
+void WorkerThread::idleTask(double deadlineSeconds)
 {
-    ASSERT(m_workerGlobalScope.get());
-    int64_t delay = kLongIdleHandlerDelayMs;
+    if (terminated())
+        return;
 
-    // Do a script engine idle notification if the next event is distant enough.
-    const double kMinIdleTimespan = 0.3;
-    const double nextFireTime = PlatformThreadData::current().threadTimers().nextFireTime();
-    if (nextFireTime == 0.0 || nextFireTime > currentTime() + kMinIdleTimespan) {
-        bool hasMoreWork = !isolate()->IdleNotificationDeadline(Platform::current()->monotonicallyIncreasingTime() + 1.0);
-        if (hasMoreWork)
-            delay = kShortIdleHandlerDelayMs;
-    }
+    double gcDeadlineSeconds = deadlineSeconds;
 
-    postDelayedTask(FROM_HERE, createSameThreadTask(&WorkerThread::idleHandler, this), delay);
+    // The V8 GC does some GC steps (e.g. compaction) only when the idle notification is ~1s.
+    // TODO(rmcilroy): Refactor so extending the deadline like this this isn't needed.
+    if (m_webScheduler->canExceedIdleDeadlineIfRequired())
+        gcDeadlineSeconds = Platform::current()->monotonicallyIncreasingTime() + kLongIdleHandlerDelaySecs;
+
+    if (doIdleGc(gcDeadlineSeconds))
+        m_webScheduler->postIdleTaskAfterWakeup(FROM_HERE, new WorkerThreadIdleTask(this));
+    else
+        m_webScheduler->postIdleTask(FROM_HERE, new WorkerThreadIdleTask(this));
+}
+
+bool WorkerThread::doIdleGc(double deadlineSeconds)
+{
+    bool gcFinished = false;
+    if (deadlineSeconds > Platform::current()->monotonicallyIncreasingTime())
+        gcFinished = isolate()->IdleNotificationDeadline(deadlineSeconds);
+    return gcFinished;
 }
 
 void WorkerThread::postTask(const WebTraceLocation& location, PassOwnPtr<ExecutionContextTask> task)
 {
-    m_thread->postTask(location, WorkerThreadTask::create(*this, task, true).leakPtr());
+    if (task->isCleanupTask())
+        m_webScheduler->postShutdownTask(location, WorkerThreadTask::create(*this, task, true).leakPtr(), 0);
+    else
+        m_thread->postTask(location, WorkerThreadTask::create(*this, task, true).leakPtr());
 }
 
 void WorkerThread::postDelayedTask(const WebTraceLocation& location, PassOwnPtr<ExecutionContextTask> task, long long delayMs)
 {
-    m_thread->postDelayedTask(location, WorkerThreadTask::create(*this, task, true).leakPtr(), delayMs);
+    if (task->isCleanupTask())
+        m_webScheduler->postShutdownTask(location, WorkerThreadTask::create(*this, task, true).leakPtr(), delayMs);
+    else
+        m_thread->postDelayedTask(location, WorkerThreadTask::create(*this, task, true).leakPtr(), delayMs);
 }
 
 v8::Isolate* WorkerThread::initializeIsolate()
 {
     ASSERT(isCurrentThread());
     ASSERT(!m_isolate);
     v8::Isolate* isolate = V8PerIsolateData::initialize();
     V8Initializer::initializeWorker(isolate);
 
     m_interruptor = adoptPtr(new V8IsolateInterruptor(isolate));
@@ skipping 63 matching lines @@
     InspectorInstrumentation::didLeaveNestedRunLoop(m_workerGlobalScope.get());
 }
 
 void WorkerThread::setWorkerInspectorController(WorkerInspectorController* workerInspectorController)
 {
     MutexLocker locker(m_workerInspectorControllerMutex);
     m_workerInspectorController = workerInspectorController;
 }
 
 } // namespace blink