Script streaming: Add an option to make the main thread block (wait for parsing)

Source/bindings/core/v8/ScriptStreamer.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 "bindings/core/v8/ScriptStreamer.h"
 
 #include "bindings/core/v8/ScriptStreamerThread.h"
 #include "bindings/core/v8/V8ScriptRunner.h"
 #include "core/dom/Document.h"
@@ skipping 206 matching lines @@
 void ScriptStreamer::startStreaming(PendingScript& script, Settings* settings, ScriptState* scriptState, PendingScript::Type scriptType)
 {
     // We don't yet know whether the script will really be streamed. E.g.,
     // suppressing streaming for short scripts is done later. Record only the
     // sure negative cases here.
     bool startedStreaming = startStreamingInternal(script, settings, scriptState, scriptType);
     if (!startedStreaming)
         blink::Platform::current()->histogramEnumeration(startedStreamingHistogramName(scriptType), 0, 2);
 }
 
-void ScriptStreamer::streamingComplete()
+void ScriptStreamer::streamingCompleteOnBackgroundThread()
 {
-    ASSERT(isMainThread());
-    // It's possible that the corresponding Resource was deleted before V8
-    // finished streaming. In that case, the data or the notification is not
-    // needed. In addition, if the streaming is suppressed, the non-streaming
-    // code path will resume after the resource has loaded, before the
-    // background task finishes.
-    if (m_detached || m_streamingSuppressed) {
-        deref();
-        return;
+    ASSERT(!isMainThread());
+    MutexLocker locker(m_mutex);
+    m_parsingFinished = true;
+    if (m_blockMainThreadAfterLoading) {
+        // Normally, the main thread is waiting at this point, but it can also
+        // happen that the load is not yet finished (e.g., a parse error). In
+        // that case, notifyFinished will be called eventually and it will not
+        // wait on m_parsingFinishedCondition.
+        m_parsingFinishedCondition.signal();
+    } else {
+        callOnMainThread(WTF::bind(&ScriptStreamer::streamingComplete, this));
     }
-
-    // We have now streamed the whole script to V8 and it has parsed the
-    // script. We're ready for the next step: compiling and executing the
-    // script.
-    m_parsingFinished = true;
-
-    notifyFinishedToClient();
-
-    // The background thread no longer holds an implicit reference.
-    deref();
 }
 
 void ScriptStreamer::cancel()
 {
     ASSERT(isMainThread());
     // The upper layer doesn't need the script any more, but streaming might
     // still be ongoing. Tell SourceStream to try to cancel it whenever it gets
     // the control the next time. It can also be that V8 has already completed
     // its operations and streamingComplete will be called soon.
     m_detached = true;
     m_resource = 0;
     m_stream->cancel();
 }
 
 void ScriptStreamer::suppressStreaming()
 {
+    MutexLocker locker(m_mutex);
     ASSERT(!m_parsingFinished);
     ASSERT(!m_loadingFinished);
     m_streamingSuppressed = true;
 }
 
 void ScriptStreamer::notifyAppendData(ScriptResource* resource)
 {
     ASSERT(isMainThread());
     ASSERT(m_resource == resource);
     if (m_streamingSuppressed)
@@ skipping 16 matching lines @@
             // network. At the moment we are only streaming parser blocking
             // scripts, but this code can still be hit when multiple frames are
             // loading simultaneously.
             suppressStreaming();
             blink::Platform::current()->histogramEnumeration(histogramName, 0, 2);
             return;
         }
         ASSERT(m_task);
         // ScriptStreamer needs to stay alive as long as the background task is
         // running. This is taken care of with a manual ref() & deref() pair;
-        // the corresponding deref() is in streamingComplete.
+        // the corresponding deref() is in streamingComplete or in
+        // notifyFinished.
         ref();
         ScriptStreamingTask* task = new ScriptStreamingTask(m_task.release(), this);
         ScriptStreamerThread::shared()->postTask(task);
         blink::Platform::current()->histogramEnumeration(histogramName, 1, 2);
     }
     m_stream->didReceiveData();
 }
 
 void ScriptStreamer::notifyFinished(Resource* resource)
 {
     ASSERT(isMainThread());
     ASSERT(m_resource == resource);
     // A special case: empty scripts. We didn't receive any data before this
     // notification. In that case, there won't be a "parsing complete"
     // notification either, and we should not wait for it.
     if (!m_firstDataChunkReceived)
         suppressStreaming();
     m_stream->didFinishLoading();
     m_loadingFinished = true;
+
+    if (m_blockMainThreadAfterLoading) {
+        // Make the main thead wait until the streaming is complete, to make
+        // sure that the script gets the main thread's attention as early as
+        // possible (for possible compiling, if the client wants to do it
+        // right away). Note that blocking here is not any worse than the
+        // non-streaming code path where the main thread eventually blocks
+        // to parse the script.
+        MutexLocker locker(m_mutex);
+        if (!isFinished()) {

[Sami, 2014/10/15 13:11:51]

Should this be a while loop to guard against spurious wakeups?

[marja, 2014/10/24 13:04:40]

Hmm, dunno, it's a bit of overly defensive programming; m_loadingFinished is set
to true here, and m_parsingFinished is set to true before the cond var is
signaled, so, there shouldn't be other wakeups.

[Sami, 2014/10/24 13:15:35]

I think we're using pthread_cond_wait under the hood, which can sometimes return
without being signaled because of the way it's implemented. I'd suggest making
this loop to be safe.

See here:
https://code.google.com/p/chromium/codesearch#chromium/src/base/synchronizati...

[marja, 2014/10/24 13:19:29]

Oh wow. I wasn't aware of that. TIL. Fixed in the new version.

+            m_parsingFinishedCondition.wait(m_mutex);
+        }
+        ASSERT(isFinished());
+    }
+
     notifyFinishedToClient();
+
+    if (m_blockMainThreadAfterLoading && m_parsingFinished) {
+        // streamingComplete won't be called, so do the ramp-down work
+        // here. Since m_parsingFinished is true, we know that there was a
+        // background task and we need to deref().
+        deref();
+    }
 }
 
-ScriptStreamer::ScriptStreamer(ScriptResource* resource, v8::ScriptCompiler::StreamedSource::Encoding encoding, PendingScript::Type scriptType)
+ScriptStreamer::ScriptStreamer(ScriptResource* resource, v8::ScriptCompiler::StreamedSource::Encoding encoding, PendingScript::Type scriptType, bool blockMainThreadAfterLoading)
     : m_resource(resource)
     , m_detached(false)
     , m_stream(new SourceStream(this))
     , m_source(m_stream, encoding) // m_source takes ownership of m_stream.
     , m_client(0)
     , m_loadingFinished(false)
     , m_parsingFinished(false)
     , m_firstDataChunkReceived(false)
     , m_streamingSuppressed(false)
     , m_scriptType(scriptType)
+    , m_blockMainThreadAfterLoading(blockMainThreadAfterLoading)
 {
 }
 
+void ScriptStreamer::streamingComplete()
+{
+    // The background task is completed; do the necessary ramp-down in the main
+    // thread.
+    ASSERT(isMainThread());
+    // In the blocking mode, the ramp-down is done in notifyFinished.
+    ASSERT(!m_blockMainThreadAfterLoading);
+
+    // It's possible that the corresponding Resource was deleted before V8
+    // finished streaming. In that case, the data or the notification is not
+    // needed. In addition, if the streaming is suppressed, the non-streaming
+    // code path will resume after the resource has loaded, before the
+    // background task finishes.
+    if (m_detached || m_streamingSuppressed) {
+        deref();
+        return;
+    }
+
+    // We have now streamed the whole script to V8 and it has parsed the
+    // script. We're ready for the next step: compiling and executing the
+    // script.
+    notifyFinishedToClient();
+
+    // The background thread no longer holds an implicit reference.
+    deref();
+}
+
 void ScriptStreamer::notifyFinishedToClient()
 {
     ASSERT(isMainThread());
     // Usually, the loading will be finished first, and V8 will still need some
     // time to catch up. But the other way is possible too: if V8 detects a
     // parse error, the V8 side can complete before loading has finished. Send
     // the notification after both loading and V8 side operations have
     // completed. Here we also check that we have a client: it can happen that a
     // function calling notifyFinishedToClient was already scheduled in the task
     // queue and the upper layer decided that it's not interested in the script
     // and called removeClient.
+    MutexLocker locker(m_mutex);
     if (isFinished() && m_client)
         m_client->notifyFinished(m_resource);
 }
 
 const char* ScriptStreamer::startedStreamingHistogramName(PendingScript::Type scriptType)
 {
     switch (scriptType) {
     case PendingScript::ParsingBlocking:
         return "WebCore.Scripts.ParsingBlocking.StartedStreaming";
         break;
@@ skipping 49 matching lines @@
         return false;
     }
 
     if (!scriptState->contextIsValid())
         return false;
     ScriptState::Scope scope(scriptState);
 
     // The Resource might go out of scope if the script is no longer needed. We
     // will soon call PendingScript::setStreamer, which makes the PendingScript
     // notify the ScriptStreamer when it is destroyed.
-    RefPtr<ScriptStreamer> streamer = adoptRef(new ScriptStreamer(resource, encoding, scriptType));
+    RefPtr<ScriptStreamer> streamer = adoptRef(new ScriptStreamer(resource, encoding, scriptType, settings->v8ScriptStreamingBlocking()));
 
     // Decide what kind of cached data we should produce while streaming. By
     // default, we generate the parser cache for streamed scripts, to emulate
     // the non-streaming behavior (see V8ScriptRunner::compileScript).
     v8::ScriptCompiler::CompileOptions compileOption = v8::ScriptCompiler::kProduceParserCache;
     if (settings->v8CacheOptions() == V8CacheOptionsCode)
         compileOption = v8::ScriptCompiler::kProduceCodeCache;
     v8::ScriptCompiler::ScriptStreamingTask* scriptStreamingTask = v8::ScriptCompiler::StartStreamingScript(scriptState->isolate(), &(streamer->m_source), compileOption);
     if (scriptStreamingTask) {
         streamer->m_task = adoptPtr(scriptStreamingTask);
         script.setStreamer(streamer.release());
         return true;
     }
     // Otherwise, V8 cannot stream the script.
     return false;
 }
 
 } // namespace blink