[WebSocket] Create Peer on the worker thread.

Source/modules/websockets/WorkerThreadableWebSocketChannel.cpp

 /*
  * Copyright (C) 2011, 2012 Google 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 79 matching lines @@
     {
         return m_sendRequestResult;
     }
 
     // This should be called after all setters are called and before any
     // getters are called.
     void signalWorkerThread()
     {
         m_event->signal();
     }
-
-    blink::WebWaitableEvent* event() const
+    void wait()
     {
-        return m_event.get();
+        m_event->wait();
     }
 
     void trace(Visitor* visitor) { }
 
 private:
     explicit ThreadableWebSocketChannelSyncHelper(PassOwnPtr<blink::WebWaitableEvent> event)
         : m_event(event)
         , m_connectRequestResult(false)
         , m_sendRequestResult(WebSocketChannel::SendFail)
     {
@@ skipping 80 matching lines @@
     m_bridge.clear();
 }
 
 void WorkerThreadableWebSocketChannel::trace(Visitor* visitor)
 {
     visitor->trace(m_bridge);
     visitor->trace(m_workerClientWrapper);
     WebSocketChannel::trace(visitor);
 }
 
-#if ENABLE(OILPAN)
-Peer::Peer(RawPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, ExecutionContext* context, const String& sourceURL, unsigned lineNumber, RawPtr<ThreadableWebSocketChannelSyncHelper> syncHelper)
-#else
-Peer::Peer(PassRefPtr<WeakReference<Peer> > reference, PassRefPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, ExecutionContext* context, const String& sourceURL, unsigned lineNumber, PassRefPtr<ThreadableWebSocketChannelSyncHelper> syncHelper)
-#endif
+Peer::Peer(PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelSyncHelper> syncHelper)
     : m_workerClientWrapper(clientWrapper)
     , m_loaderProxy(loaderProxy)
     , m_mainWebSocketChannel(nullptr)
     , m_syncHelper(syncHelper)
-#if ENABLE(OILPAN)
-    , m_keepAlive(this)
-#else
-    , m_weakFactory(reference, this)
-#endif
+{
+    ASSERT(!isMainThread());
+}
+
+Peer::~Peer()
+{
+    ASSERT(!isMainThread());
+}
+
+PassOwnPtrWillBeRawPtr<Peer> Peer::create(PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelSyncHelper> syncHelper)
+{
+    return adoptPtrWillBeNoop(new Peer(clientWrapper, loaderProxy, syncHelper));
+}
+
+void Peer::initializeInternal(ExecutionContext* context, const String& sourceURL, unsigned lineNumber)
 {
     ASSERT(isMainThread());
-    ASSERT(m_workerClientWrapper.get());
-
     Document* document = toDocument(context);
     if (RuntimeEnabledFeatures::experimentalWebSocketEnabled()) {
         m_mainWebSocketChannel = NewWebSocketChannelImpl::create(document, this, sourceURL, lineNumber);
     } else {
         m_mainWebSocketChannel = MainThreadWebSocketChannel::create(document, this, sourceURL, lineNumber);
     }
-}
-
-Peer::~Peer()
-{
-    ASSERT(isMainThread());
-}
-
-#if ENABLE(OILPAN)
-void Peer::initialize(ExecutionContext* context, WeakMember<Peer>* reference, WorkerLoaderProxy* loaderProxy, RawPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, const String& sourceURLAtConnection, unsigned lineNumberAtConnection, RawPtr<ThreadableWebSocketChannelSyncHelper> syncHelper)
-{
-    // The caller must call destroy() to free the peer.
-    *reference = new Peer(clientWrapper, *loaderProxy, context, sourceURLAtConnection, lineNumberAtConnection, syncHelper);
-    syncHelper->signalWorkerThread();
-}
-#else
-void Peer::initialize(ExecutionContext* context, PassRefPtr<WeakReference<Peer> > reference, WorkerLoaderProxy* loaderProxy, PassRefPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, const String& sourceURLAtConnection, unsigned lineNumberAtConnection, PassRefPtr<ThreadableWebSocketChannelSyncHelper> prpSyncHelper)
-{
-    RefPtr<ThreadableWebSocketChannelSyncHelper> syncHelper = prpSyncHelper;
-    // The caller must call destroy() to free the peer.
-    new Peer(reference, clientWrapper, *loaderProxy, context, sourceURLAtConnection, lineNumberAtConnection, syncHelper);
-    syncHelper->signalWorkerThread();
-}
-#endif
-
-void Peer::destroy()
-{
-    ASSERT(isMainThread());
-    disconnect();
-
-#if ENABLE(OILPAN)
-    m_keepAlive = nullptr;
     m_syncHelper->signalWorkerThread();
-    m_syncHelper = nullptr;
-#else
-    delete this;
-#endif
 }
 
 void Peer::connect(const KURL& url, const String& protocol)
 {
     ASSERT(isMainThread());
     ASSERT(m_syncHelper);
     if (!m_mainWebSocketChannel) {
         m_syncHelper->setConnectRequestResult(false);
     } else {
         bool connectRequestResult = m_mainWebSocketChannel->connect(url, protocol);
@@ skipping 56 matching lines @@
     ASSERT(m_syncHelper);
     if (!m_mainWebSocketChannel)
         return;
     m_mainWebSocketChannel->fail(reason, level, sourceURL, lineNumber);
 }
 
 void Peer::disconnect()
 {
     ASSERT(isMainThread());
     ASSERT(m_syncHelper);
-    if (!m_mainWebSocketChannel)
-        return;
-    m_mainWebSocketChannel->disconnect();
-    m_mainWebSocketChannel = nullptr;
+    if (m_mainWebSocketChannel) {
+        m_mainWebSocketChannel->disconnect();
+        m_mainWebSocketChannel = nullptr;
+    }
+    m_syncHelper->signalWorkerThread();
 }
 
 static void workerGlobalScopeDidConnect(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, const String& subprotocol, const String& extensions)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didConnect(subprotocol, extensions);
 }
 
 void Peer::didConnect(const String& subprotocol, const String& extensions)
 {
     ASSERT(isMainThread());
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidConnect, m_workerClientWrapper.get(), subprotocol, extensions);
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidConnect, m_workerClientWrapper, subprotocol, extensions);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 static void workerGlobalScopeDidReceiveMessage(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, const String& message)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didReceiveMessage(message);
 }
 
 void Peer::didReceiveMessage(const String& message)
 {
     ASSERT(isMainThread());
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidReceiveMessage, m_workerClientWrapper.get(), message);
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidReceiveMessage, m_workerClientWrapper, message);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 static void workerGlobalScopeDidReceiveBinaryData(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, PassOwnPtr<Vector<char> > binaryData)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didReceiveBinaryData(binaryData);
 }
 
 void Peer::didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData)
 {
     ASSERT(isMainThread());
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidReceiveBinaryData, m_workerClientWrapper.get(), binaryData);
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidReceiveBinaryData, m_workerClientWrapper, binaryData);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 static void workerGlobalScopeDidConsumeBufferedAmount(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, unsigned long consumed)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didConsumeBufferedAmount(consumed);
 }
 
 void Peer::didConsumeBufferedAmount(unsigned long consumed)
 {
     ASSERT(isMainThread());
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidConsumeBufferedAmount, m_workerClientWrapper.get(), consumed);
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidConsumeBufferedAmount, m_workerClientWrapper, consumed);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 static void workerGlobalScopeDidStartClosingHandshake(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didStartClosingHandshake();
 }
 
 void Peer::didStartClosingHandshake()
 {
     ASSERT(isMainThread());
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidStartClosingHandshake, m_workerClientWrapper.get());
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidStartClosingHandshake, m_workerClientWrapper);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 static void workerGlobalScopeDidClose(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, WebSocketChannelClient::ClosingHandshakeCompletionStatus closingHandshakeCompletion, unsigned short code, const String& reason)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didClose(closingHandshakeCompletion, code, reason);
 }
 
 void Peer::didClose(ClosingHandshakeCompletionStatus closingHandshakeCompletion, unsigned short code, const String& reason)
 {
     ASSERT(isMainThread());
-    m_mainWebSocketChannel = nullptr;
+    if (m_mainWebSocketChannel) {
+        m_mainWebSocketChannel->disconnect();
+        m_mainWebSocketChannel = nullptr;
+    }
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidClose, m_workerClientWrapper.get(), closingHandshakeCompletion, code, reason);
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidClose, m_workerClientWrapper, closingHandshakeCompletion, code, reason);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 static void workerGlobalScopeDidReceiveMessageError(ExecutionContext* context, PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper)
 {
     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
     workerClientWrapper->didReceiveMessageError();
 }
 
 void Peer::didReceiveMessageError()
 {
     ASSERT(isMainThread());
     // It is important to seprate task creation from posting
     // the task. See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidReceiveMessageError, m_workerClientWrapper.get());
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&workerGlobalScopeDidReceiveMessageError, m_workerClientWrapper);
     m_loaderProxy.postTaskToWorkerGlobalScope(task.release());
 }
 
 void Peer::trace(Visitor* visitor)
 {
     visitor->trace(m_workerClientWrapper);
     visitor->trace(m_mainWebSocketChannel);
     visitor->trace(m_syncHelper);
     WebSocketChannelClient::trace(visitor);
 }
 
 Bridge::Bridge(PassRefPtrWillBeRawPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, WorkerGlobalScope& workerGlobalScope)
     : m_workerClientWrapper(workerClientWrapper)
     , m_workerGlobalScope(workerGlobalScope)
     , m_loaderProxy(m_workerGlobalScope->thread()->workerLoaderProxy())
-    , m_syncHelper(nullptr)
-    , m_peer(nullptr)
+    , m_syncHelper(ThreadableWebSocketChannelSyncHelper::create(adoptPtr(blink::Platform::current()->createWaitableEvent())))
+    , m_peer(Peer::create(m_workerClientWrapper, m_loaderProxy, m_syncHelper))
 {
     ASSERT(m_workerClientWrapper.get());
 }
 
 Bridge::~Bridge()
 {
-    ASSERT(hasTerminatedPeer());
+    ASSERT(!m_peer);
 }
 
 void Bridge::initialize(const String& sourceURL, unsigned lineNumber)
 {
-#if !ENABLE(OILPAN)
-    RefPtr<WeakReference<Peer> > reference = WeakReference<Peer>::createUnbound();
-    m_peer = WeakPtr<Peer>(reference);
-#endif
-
-    RefPtrWillBeRawPtr<ThreadableWebSocketChannelSyncHelper> syncHelper = ThreadableWebSocketChannelSyncHelper::create(adoptPtr(blink::Platform::current()->createWaitableEvent()));
-    // This pointer is guaranteed to be valid until we call terminatePeer.
-    m_syncHelper = syncHelper.get();
-
     RefPtrWillBeRawPtr<Bridge> protect(this);
-#if ENABLE(OILPAN)
     // In order to assure all temporary objects to be destroyed before
     // posting the task, we separate task creation and posting.
     // In other words, it is dangerous to have a complicated expression
     // as a waitForMethodCompletion argument.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&Peer::initialize, &m_peer, AllowCrossThreadAccess(&m_loaderProxy), m_workerClientWrapper.get(), sourceURL, lineNumber, syncHelper.get());
-#else
-    // See the above comment.
-    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&Peer::initialize, reference, AllowCrossThreadAccess(&m_loaderProxy), m_workerClientWrapper.get(), sourceURL, lineNumber, syncHelper.get());
-#endif
+    OwnPtr<ExecutionContextTask> task = createCrossThreadTask(&Peer::initialize, AllowCrossThreadAccess(m_peer.get()), sourceURL, lineNumber);
     if (!waitForMethodCompletion(task.release())) {
         // The worker thread has been signalled to shutdown before method completion.
         disconnect();
     }
 }
 
 bool Bridge::connect(const KURL& url, const String& protocol)
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return false;
 
     RefPtrWillBeRawPtr<Bridge> protect(this);
-    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::connect, m_peer, url, protocol)))
+    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::connect, m_peer.get(), url, protocol)))
         return false;
 
     return m_syncHelper->connectRequestResult();
 }
 
 WebSocketChannel::SendResult Bridge::send(const String& message)
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return WebSocketChannel::SendFail;
 
     RefPtrWillBeRawPtr<Bridge> protect(this);
-    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::send, m_peer, message)))
+    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::send, m_peer.get(), message)))
         return WebSocketChannel::SendFail;
 
     return m_syncHelper->sendRequestResult();
 }
 
 WebSocketChannel::SendResult Bridge::send(const ArrayBuffer& binaryData, unsigned byteOffset, unsigned byteLength)
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return WebSocketChannel::SendFail;
 
     // ArrayBuffer isn't thread-safe, hence the content of ArrayBuffer is copied into Vector<char>.
     OwnPtr<Vector<char> > data = adoptPtr(new Vector<char>(byteLength));
     if (binaryData.byteLength())
         memcpy(data->data(), static_cast<const char*>(binaryData.data()) + byteOffset, byteLength);
 
     RefPtrWillBeRawPtr<Bridge> protect(this);
-    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::sendArrayBuffer, m_peer, data.release())))
+    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::sendArrayBuffer, m_peer.get(), data.release())))
         return WebSocketChannel::SendFail;
 
     return m_syncHelper->sendRequestResult();
 }
 
 WebSocketChannel::SendResult Bridge::send(PassRefPtr<BlobDataHandle> data)
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return WebSocketChannel::SendFail;
 
     RefPtrWillBeRawPtr<Bridge> protect(this);
-    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::sendBlob, m_peer, data)))
+    if (!waitForMethodCompletion(createCrossThreadTask(&Peer::sendBlob, m_peer.get(), data)))
         return WebSocketChannel::SendFail;
 
     return m_syncHelper->sendRequestResult();
 }
 
 void Bridge::close(int code, const String& reason)
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return;
 
-    m_loaderProxy.postTaskToLoader(createCrossThreadTask(&Peer::close, m_peer, code, reason));
+    m_loaderProxy.postTaskToLoader(createCrossThreadTask(&Peer::close, m_peer.get(), code, reason));
 }
 
 void Bridge::fail(const String& reason, MessageLevel level, const String& sourceURL, unsigned lineNumber)
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return;
 
-    m_loaderProxy.postTaskToLoader(createCrossThreadTask(&Peer::fail, m_peer, reason, level, sourceURL, lineNumber));
+    m_loaderProxy.postTaskToLoader(createCrossThreadTask(&Peer::fail, m_peer.get(), reason, level, sourceURL, lineNumber));
 }
 
 void Bridge::disconnect()
 {
-    if (hasTerminatedPeer())
+    if (!m_peer)
         return;
 
-    clearClientWrapper();
-    terminatePeer();
-}
+    m_workerClientWrapper->clearClient();
+    waitForMethodCompletion(createCrossThreadTask(&Peer::disconnect, m_peer.get()));
+    // Here |m_peer| is detached from the main thread and we can delete it.
 
-void Bridge::clearClientWrapper()
-{
-    m_workerClientWrapper->clearClient();
+    m_peer = nullptr;
+    m_syncHelper = nullptr;
+    // We won't use this any more.
+    m_workerGlobalScope.clear();
 }
 
 // Caller of this function should hold a reference to the bridge, because this function may call WebSocket::didClose() in the end,
 // which causes the bridge to get disconnected from the WebSocket and deleted if there is no other reference.
 bool Bridge::waitForMethodCompletion(PassOwnPtr<ExecutionContextTask> task)
 {
     ASSERT(m_workerGlobalScope);
     ASSERT(m_syncHelper);
 
     m_loaderProxy.postTaskToLoader(task);
 
     // We wait for the syncHelper event even if a shutdown event is fired.
     // See https://codereview.chromium.org/267323004/#msg43 for why we need to wait this.
-    Vector<blink::WebWaitableEvent*> events;
-    events.append(m_syncHelper->event());
     ThreadState::SafePointScope scope(ThreadState::HeapPointersOnStack);
-    blink::Platform::current()->waitMultipleEvents(events);
+    m_syncHelper->wait();
     // This is checking whether a shutdown event is fired or not.
     return !m_workerGlobalScope->thread()->terminated();
 }
 
-void Bridge::terminatePeer()
-{
-    ASSERT(!hasTerminatedPeer());
-
-#if ENABLE(OILPAN)
-    // The worker thread has to wait for the main thread to complete Peer::destroy,
-    // because the worker thread has to make sure that the main thread does not have any
-    // references to on-heap objects allocated in the thread heap of the worker thread
-    // before the worker thread shuts down.
-    waitForMethodCompletion(createCrossThreadTask(&Peer::destroy, m_peer));
-#else
-    m_loaderProxy.postTaskToLoader(createCrossThreadTask(&Peer::destroy, m_peer));
-#endif
-
-    // Peer::destroy() deletes m_peer and then m_syncHelper will be released.
-    // We must not touch m_syncHelper any more.
-    m_syncHelper = nullptr;
-
-    // We won't use this any more.
-    m_workerGlobalScope = nullptr;
-}
-
 void Bridge::trace(Visitor* visitor)
 {
     visitor->trace(m_workerClientWrapper);
     visitor->trace(m_workerGlobalScope);
     visitor->trace(m_syncHelper);
     visitor->trace(m_peer);
 }
 
 } // namespace blink