Worker: Attempt to gracefully terminate WorkerThread as much as possible

third_party/WebKit/Source/core/workers/WorkerThread.h

 /*
  * 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 44 matching lines @@
 
 // WorkerThread is a kind of WorkerBackingThread client. Each worker mechanism
 // can access the lower thread infrastructure via an implementation of this
 // abstract class. Multiple WorkerThreads can share one WorkerBackingThread.
 // See WorkerBackingThread.h for more details.
 //
 // WorkerThread start and termination must be initiated on the main thread and
 // an actual task is executed on the worker thread.
 class CORE_EXPORT WorkerThread {
 public:
+    // Represents how this thread is terminated.
+    enum class ExitCode {
+        NotTerminated,
+        TerminatedBeforeStarting,
+        GracefullyTerminated,
+        SyncForciblyTerminated,
+        AsyncForciblyTerminated,
+    };
+
     virtual ~WorkerThread();
 
     // Called on the main thread.
     void start(PassOwnPtr<WorkerThreadStartupData>);
     void terminate();
 
-    // Called in shutdown sequence on the main thread. Internally calls
-    // terminate() and wait (by *blocking* the calling thread) until the
-    // worker(s) is/are shut down.
+    // Called on the main thread. Internally calls terminateInternal() and wait
+    // (by *blocking* the calling thread) until the worker(s) is/are shut down.
     void terminateAndWait();
     static void terminateAndWaitForAllWorkers();
 
     virtual WorkerBackingThread& workerBackingThread() = 0;
     virtual bool shouldAttachThreadDebugger() const { return true; }
     v8::Isolate* isolate();
 
     // Can be used to wait for this worker thread to terminate.
     // (This is signaled on the main thread, so it's assumed to be waited on
     // the worker context thread)
@@ skipping 23 matching lines @@
     WorkerGlobalScope* workerGlobalScope();
 
     // Returns true once one of the terminate* methods is called.
     bool terminated();
 
     // Number of active worker threads.
     static unsigned workerThreadCount();
 
     PlatformThreadId platformThreadId();
 
+    ExitCode exitCode();

[kinuko, 2016/05/31 10:13:26]

nit: getExitCode()

c.f. "Please use names that differ by more than case"
(https://groups.google.com/a/chromium.org/forum/#!searchin/blink-dev/%22Please...
)

[nhiroki, 2016/06/01 04:16:36]

Thank you for sharing the pointer. I missed the discussion. Done.

+
 protected:
     WorkerThread(PassRefPtr<WorkerLoaderProxy>, WorkerReportingProxy&);
 
     // Factory method for creating a new worker context for the thread.
     // Called on the worker thread.
     virtual WorkerGlobalScope* createWorkerGlobalScope(PassOwnPtr<WorkerThreadStartupData>) = 0;
 
     // Called on the worker thread.
     virtual void postInitialize() { }
 
 private:
+    friend class WorkerThreadTest;
+
+    class ForceTerminationTask;
     class WorkerMicrotaskRunner;
 
+    enum class TerminationMode {
+        // Synchronously terminate the isolate. Please be careful to use this

[kinuko, 2016/05/31 10:13:26]

nit: "terminate the isolate" -> "terminate the v8 isolate" or maybe just
"terminate the worker execution" (here and below)

[nhiroki, 2016/06/01 04:16:36]

Replaced all.

+        // mode, because after the synchronous termination any V8 APIs may
+        // suddenly start to return empty handles and it may cause crashes.
+        Forcible,
+
+        // Don't synchronously terminate the isolate. Instead, schedule a task
+        // to terminate the isolate in case that the shutdown sequence does not
+        // start on the worker thread in a certain time period.
+        Graceful,
+    };
+
     std::unique_ptr<CrossThreadClosure> createWorkerThreadTask(std::unique_ptr<ExecutionContextTask>, bool isInstrumented);
 
     void initializeOnWorkerThread(PassOwnPtr<WorkerThreadStartupData>);
+    void terminateInternal(TerminationMode);
+    void forciblyTerminateIsolate();

[kinuko, 2016/05/31 10:13:26]

nit: why are having these methods between initializeOnWorkerThread() and
prepareForShutdownOnWorkerThread()?  It feels a bit misplaced?

[kinuko, 2016/05/31 10:13:26]

nit: forciblyTerminateV8Isolate or forciblyTerminateExecution

[nhiroki, 2016/06/01 04:16:36]

Done.

[nhiroki, 2016/06/01 04:16:36]

In common cases, these are called after initializeOnWorkerThread and before
prepareForShutdownOnWorkerThread. That's the reason why I placed them here.
However, as you commented, these can be called on the main thread and placing
them among *OnWorkerThread functions looks a bit strange, so I moved them to
before this *OnWorkerThread block.

     void prepareForShutdownOnWorkerThread();
     void performShutdownOnWorkerThread();
     void performTaskOnWorkerThread(std::unique_ptr<ExecutionContextTask>, bool isInstrumented);
     void runDebuggerTaskOnWorkerThread(std::unique_ptr<CrossThreadClosure>);
     void runDebuggerTaskDontWaitOnWorkerThread();
 
+    void setForceTerminationDelayInMsForTesting(long long forceTerminationDelayInMs) { m_forceTerminationDelayInMs = forceTerminationDelayInMs; }
+
     bool m_started = false;
     bool m_terminated = false;
     bool m_readyToShutdown = false;
     bool m_pausedInDebugger = false;
     bool m_runningDebuggerTask = false;
+    ExitCode m_exitCode = ExitCode::NotTerminated;
+
+    long long m_forceTerminationDelayInMs;
 
     OwnPtr<InspectorTaskRunner> m_inspectorTaskRunner;
     OwnPtr<WorkerMicrotaskRunner> m_microtaskRunner;
 
     RefPtr<WorkerLoaderProxy> m_workerLoaderProxy;
     WorkerReportingProxy& m_workerReportingProxy;
 
     // This lock protects |m_workerGlobalScope|, |m_terminated|,
-    // |m_readyToShutdown|, |m_runningDebuggerTask| and |m_microtaskRunner|.
+    // |m_readyToShutdown|, |m_runningDebuggerTask|, |m_exitCode| and
+    // |m_microtaskRunner|.
     Mutex m_threadStateMutex;
 
     Persistent<WorkerGlobalScope> m_workerGlobalScope;
 
     // Signaled when the thread starts termination on the main thread.
     OwnPtr<WaitableEvent> m_terminationEvent;
 
     // Signaled when the thread completes termination on the worker thread.
     OwnPtr<WaitableEvent> m_shutdownEvent;
+
+    // Scheduled when termination starts with TerminationMode::Force, and
+    // cancelled when the worker thread is gracefully shut down.
+    OwnPtr<ForceTerminationTask> m_scheduledForceTerminationTask;
 };
 
 } // namespace blink
 
 #endif // WorkerThread_h