Worker: Initiate worker thread shutdown always on the main thread

third_party/WebKit/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 53 matching lines @@
         DCHECK(!m_workerThread->workerGlobalScope() || !m_workerThread->workerGlobalScope()->isClosing());
     }
 
     void didProcessTask() override
     {
         Microtask::performCheckpoint(m_workerThread->isolate());
         if (WorkerGlobalScope* globalScope = m_workerThread->workerGlobalScope()) {
             if (WorkerOrWorkletScriptController* scriptController = globalScope->scriptController())
                 scriptController->getRejectedPromises()->processQueue();
             if (globalScope->isClosing()) {
+                // |m_workerThread| will eventually be requested to terminate.
                 m_workerThread->workerReportingProxy().workerGlobalScopeClosed();
-                m_workerThread->terminateFromWorkerThread();
+
+                // Dispose WorkerGlobalScope to avoid processing the next task.

[kinuko, 2016/05/24 09:07:48]

Could we make this comment a bit clearer, e.g. "to stop associated
ActiveDOMObjects and close the event queue" or sth like that

[nhiroki, 2016/05/24 13:36:06]

Done.

+                m_workerThread->prepareForShutdown();
             }
         }
     }
 
 private:
     // Thread owns the microtask runner; reference remains
     // valid for the lifetime of this object.
     WorkerThread* m_workerThread;
 };
 
@@ skipping 20 matching lines @@
     DCHECK(isCurrentThread());
     WorkerGlobalScope* globalScope = workerGlobalScope();
     // If the thread is terminated before it had a chance initialize (see
     // WorkerThread::Initialize()), we mustn't run any of the posted tasks.
     if (!globalScope) {
         DCHECK(terminated());
         return;
     }
 
     InspectorInstrumentation::AsyncTask asyncTask(globalScope, task.get(), isInstrumented);
     task->performTask(globalScope);

[kinuko, 2016/05/24 09:07:48]

Going back to this method... how do we prevent tasks that are already posted
from running here?

[nhiroki, 2016/05/24 13:36:06]

We could just return if |m_readyToShutdown| is set. Done.

 }
 
 std::unique_ptr<CrossThreadClosure> WorkerThread::createWorkerThreadTask(std::unique_ptr<ExecutionContextTask> task, bool isInstrumented)
 {
     if (isInstrumented)
         isInstrumented = !task->taskNameForInstrumentation().isEmpty();
     if (isInstrumented) {
         DCHECK(isCurrentThread());
         InspectorInstrumentation::asyncTaskScheduled(workerGlobalScope(), "Worker task", task.get());
     }
     return threadSafeBind(&WorkerThread::performTask, AllowCrossThreadAccess(this), passed(std::move(task)), isInstrumented);
 }
 
 WorkerThread::WorkerThread(PassRefPtr<WorkerLoaderProxy> workerLoaderProxy, WorkerReportingProxy& workerReportingProxy)
-    : m_started(false)
-    , m_terminated(false)
-    , m_shutdown(false)
-    , m_pausedInDebugger(false)
-    , m_runningDebuggerTask(false)
-    , m_shouldTerminateV8Execution(false)
-    , m_inspectorTaskRunner(adoptPtr(new InspectorTaskRunner()))
+    : m_inspectorTaskRunner(adoptPtr(new InspectorTaskRunner()))
     , m_workerLoaderProxy(workerLoaderProxy)
     , m_workerReportingProxy(workerReportingProxy)
     , m_terminationEvent(adoptPtr(new WaitableEvent(
         WaitableEvent::ResetPolicy::Manual,
         WaitableEvent::InitialState::NonSignaled)))
     , m_shutdownEvent(adoptPtr(new WaitableEvent(
         WaitableEvent::ResetPolicy::Manual,
         WaitableEvent::InitialState::NonSignaled)))
 {
     MutexLocker lock(threadSetMutex());
@@ skipping 79 matching lines @@
     }
 
     CachedMetadataHandler* handler = workerGlobalScope()->createWorkerScriptCachedMetadataHandler(scriptURL, cachedMetaData.get());
     bool success = m_workerGlobalScope->scriptController()->evaluate(ScriptSourceCode(sourceCode, scriptURL), nullptr, handler, v8CacheOptions);
     m_workerGlobalScope->didEvaluateWorkerScript();
     m_workerReportingProxy.didEvaluateWorkerScript(success);
 
     postInitialize();
 }
 
-void WorkerThread::shutdown()
-{
-    DCHECK(isCurrentThread());
-    {
-        MutexLocker lock(m_threadStateMutex);
-        if (m_shutdown)
-            return;
-        m_shutdown = true;
-    }
-
-    // This should be called before we start the shutdown procedure.
-    workerReportingProxy().willDestroyWorkerGlobalScope();
-
-    InspectorInstrumentation::allAsyncTasksCanceled(workerGlobalScope());
-    workerGlobalScope()->dispose();
-
-    workerBackingThread().backingThread().removeTaskObserver(m_microtaskRunner.get());
-    postTask(BLINK_FROM_HERE, createSameThreadTask(&WorkerThread::performShutdownTask, this));
-}
-
 void WorkerThread::performShutdownTask()

[kinuko, 2016/05/24 09:07:48]

nit: maybe we could rename this to performShutdown() (method renaming /
reordering could be done in a follow-up cleanup CL too)

[nhiroki, 2016/05/24 13:36:06]

I'll make a separate CL.

[nhiroki, 2016/05/25 01:58:33]

Uploaded a CL: https://codereview.chromium.org/2015453002/

 {
     DCHECK(isCurrentThread());
+#if DCHECK_IS_ON
+    {
+        MutexLocker lock(m_threadStateMutex);
+        DCHECK(m_terminated);
+        DCHECK(m_readyToShutdown);
+    }
+#endif
 
     // 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.
     m_workerGlobalScope->notifyContextDestroyed();
     m_workerGlobalScope = nullptr;
 
     workerBackingThread().detach();
@@ skipping 21 matching lines @@
 
     // If terminate 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_terminationEvent)
         m_terminationEvent->signal();
 
-    // If the thread has already initiated shutdown, just return.
-    if (m_shutdown)
-        return;
-
     // If the worker thread was never initialized, don't start another
     // shutdown, but still wait for the thread to signal when shutdown has
     // completed on initialize().
     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.
-    m_workerGlobalScope->scriptController()->willScheduleExecutionTermination();
+    // If |m_readyToShutdown| is set, scriptController() is already disposed.
+    if (!m_readyToShutdown) {
+        DCHECK(m_workerGlobalScope->scriptController());
+
+        // 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.
+        m_workerGlobalScope->scriptController()->willScheduleExecutionTermination();
+    }
 
     if (workerBackingThread().workerScriptCount() == 1) {

[kinuko, 2016/05/24 09:07:49]

Actually if we've passed m_readyToShutdown we won't need to go through this
block either?

[nhiroki, 2016/05/24 13:36:06]

Right. We can assume that the execution context is not running in the case.
Moved this block into the block conditioned with !m_readyToShutdown and added
comments.

         // This condition is not entirely correct because other scripts
         // can be being initialized or terminated simuletaneously. Though this
         // function itself is protected by a mutex, it is possible that
         // |workerScriptCount()| here is not consistent with that in
         // |initialize| and |shutdown|.
         // TODO(yhirano): TerminateExecution should be called more carefully.
         // https://crbug.com/413518
         if (m_runningDebuggerTask) {
             // Terminating during debugger task may lead to crash due to heavy
             // use of v8 api in debugger. Any debugger task is guaranteed to
             // finish, so we can postpone termination after task has finished.
             // Note: m_runningDebuggerTask and m_shouldTerminateV8Execution
             // access must be guarded by the lock.
             m_shouldTerminateV8Execution = true;
         } else {
             isolate()->TerminateExecution();
         }
     }
 
     m_inspectorTaskRunner->kill();
-    workerBackingThread().backingThread().postTask(BLINK_FROM_HERE, threadSafeBind(&WorkerThread::shutdown, AllowCrossThreadAccess(this)));
+    workerBackingThread().backingThread().postTask(BLINK_FROM_HERE, threadSafeBind(&WorkerThread::prepareForShutdown, AllowCrossThreadAccess(this)));
+    workerBackingThread().backingThread().postTask(BLINK_FROM_HERE, threadSafeBind(&WorkerThread::performShutdownTask, AllowCrossThreadAccess(this)));
 }
 
 void WorkerThread::terminateAndWait()
 {
     DCHECK(isMainThread());
     terminate();
     m_shutdownEvent->wait();
 }
 
 void WorkerThread::terminateAndWaitForAllWorkers()
 {
     DCHECK(isMainThread());
 
     // Keep this lock to prevent WorkerThread instances from being destroyed.
     MutexLocker lock(threadSetMutex());
     HashSet<WorkerThread*> threads = workerThreads();
     for (WorkerThread* thread : threads)
         thread->terminate();
 
     for (WorkerThread* thread : threads)
         thread->m_shutdownEvent->wait();
 }
 
-void WorkerThread::terminateFromWorkerThread()
+void WorkerThread::prepareForShutdown()
 {
     DCHECK(isCurrentThread());
-    shutdown();
+    {
+        MutexLocker lock(m_threadStateMutex);
+        if (m_readyToShutdown)
+            return;
+        m_readyToShutdown = true;
+    }
+
+    workerReportingProxy().willDestroyWorkerGlobalScope();
+    InspectorInstrumentation::allAsyncTasksCanceled(workerGlobalScope());
+    workerGlobalScope()->dispose();
+    workerBackingThread().backingThread().removeTaskObserver(m_microtaskRunner.get());
 }
 
 WorkerGlobalScope* WorkerThread::workerGlobalScope()
 {
     DCHECK(isCurrentThread());
     return m_workerGlobalScope.get();
 }
 
 bool WorkerThread::terminated()
 {
@@ skipping 21 matching lines @@
     DCHECK(isCurrentThread());
     std::unique_ptr<CrossThreadClosure> task = m_inspectorTaskRunner->takeNextTask(InspectorTaskRunner::DontWaitForTask);
     if (task)
         (*task)();
 }
 
 void WorkerThread::appendDebuggerTask(std::unique_ptr<CrossThreadClosure> task)
 {
     {
         MutexLocker lock(m_threadStateMutex);
-        if (m_shutdown)
+        if (m_readyToShutdown)
             return;
     }
     m_inspectorTaskRunner->appendTask(threadSafeBind(&WorkerThread::runDebuggerTask, AllowCrossThreadAccess(this), passed(std::move(task))));
     {
         MutexLocker lock(m_threadStateMutex);
         if (isolate())
             m_inspectorTaskRunner->interruptAndRunAllTasksDontWait(isolate());
     }
     workerBackingThread().backingThread().postTask(BLINK_FROM_HERE, threadSafeBind(&WorkerThread::runDebuggerTaskDontWait, AllowCrossThreadAccess(this)));
 }
@@ skipping 35 matching lines @@
     } while (task && m_pausedInDebugger);
     ThreadDebugger::idleFinished(isolate());
 }
 
 void WorkerThread::stopRunningDebuggerTasksOnPause()
 {
     m_pausedInDebugger = false;
 }
 
 } // namespace blink