Source/WebKit2/Platform/IPC/Connection.cpp

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include "config.h"
  27 #include "Connection.h"
  28
  29 #include <memory>
  30 #include <wtf/CurrentTime.h>
  31 #include <wtf/HashSet.h>
  32 #include <wtf/NeverDestroyed.h>
  33 #include <wtf/RunLoop.h>
  34 #include <wtf/text/WTFString.h>
  35 #include <wtf/threads/BinarySemaphore.h>
  36
  37 namespace IPC {
  38
  39 struct WaitForMessageState {
  40     WaitForMessageState(StringReference messageReceiverName, StringReference messageName, uint64_t destinationID, unsigned waitForMessageFlags)
  41         : messageReceiverName(messageReceiverName)
  42         , messageName(messageName)
  43         , destinationID(destinationID)
  44         , waitForMessageFlags(waitForMessageFlags)
  45     {
  46     }
  47
  48     StringReference messageReceiverName;
  49     StringReference messageName;
  50     uint64_t destinationID;
  51
  52     unsigned waitForMessageFlags;
  53     bool messageWaitingInterrupted = false;
  54
  55     std::unique_ptr<MessageDecoder> decoder;
  56 };
  57
  58 class Connection::SyncMessageState : public ThreadSafeRefCounted<Connection::SyncMessageState> {
  59 public:
  60     static Ref<SyncMessageState> getOrCreate(RunLoop&);
  61     ~SyncMessageState();
  62
  63     void wakeUpClientRunLoop()
  64     {
  65         m_waitForSyncReplySemaphore.signal();
  66     }
  67
  68     bool wait(double absoluteTime)
  69     {
  70         return m_waitForSyncReplySemaphore.wait(absoluteTime);
  71     }
  72
  73     // Returns true if this message will be handled on a client thread that is currently
  74     // waiting for a reply to a synchronous message.
  75     bool processIncomingMessage(Connection&, std::unique_ptr<MessageDecoder>&);
  76
  77     // Dispatch pending sync messages. if allowedConnection is not null, will only dispatch messages
  78     // from that connection and put the other messages back in the queue.
  79     void dispatchMessages(Connection* allowedConnection);
  80
  81 private:
  82     explicit SyncMessageState(RunLoop&);
  83
  84     typedef HashMap<RunLoop*, SyncMessageState*> SyncMessageStateMap;
  85     static SyncMessageStateMap& syncMessageStateMap()
  86     {
  87         static NeverDestroyed<SyncMessageStateMap> syncMessageStateMap;
  88         return syncMessageStateMap;
  89     }
  90
  91     static std::mutex& syncMessageStateMapMutex()
  92     {
  93         static LazyNeverDestroyed<std::mutex> syncMessageStateMapMutex;
  94         static std::once_flag onceFlag;
  95         std::call_once(onceFlag, [] {
  96             syncMessageStateMapMutex.construct();
  97         });
  98
  99         return syncMessageStateMapMutex;
 100     }
 101
 102     void dispatchMessageAndResetDidScheduleDispatchMessagesForConnection(Connection&);
 103
 104     RunLoop& m_runLoop;
 105     BinarySemaphore m_waitForSyncReplySemaphore;
 106
 107     // Protects m_didScheduleDispatchMessagesWorkSet and m_messagesToDispatchWhileWaitingForSyncReply.
 108     std::mutex m_mutex;
 109
 110     // The set of connections for which we've scheduled a call to dispatchMessageAndResetDidScheduleDispatchMessagesForConnection.
 111     HashSet<RefPtr<Connection>> m_didScheduleDispatchMessagesWorkSet;
 112
 113     struct ConnectionAndIncomingMessage {
 114         Ref<Connection> connection;
 115         std::unique_ptr<MessageDecoder> message;
 116     };
 117     Vector<ConnectionAndIncomingMessage> m_messagesToDispatchWhileWaitingForSyncReply;
 118 };
 119
 120 class Connection::SecondaryThreadPendingSyncReply {
 121 public:
 122     // The reply decoder, will be null if there was an error processing the sync message on the other side.
 123     std::unique_ptr<MessageDecoder> replyDecoder;
 124
 125     BinarySemaphore semaphore;
 126 };
 127
 128
 129 Ref<Connection::SyncMessageState> Connection::SyncMessageState::getOrCreate(RunLoop& runLoop)
 130 {
 131     std::lock_guard<std::mutex> lock(syncMessageStateMapMutex());
 132
 133     auto& slot = syncMessageStateMap().add(&runLoop, nullptr).iterator->value;
 134     if (slot)
 135         return *slot;
 136
 137     Ref<SyncMessageState> syncMessageState = adoptRef(*new SyncMessageState(runLoop));
 138     slot = syncMessageState.ptr();
 139
 140     return syncMessageState;
 141 }
 142
 143 Connection::SyncMessageState::SyncMessageState(RunLoop& runLoop)
 144     : m_runLoop(runLoop)
 145 {
 146 }
 147
 148 Connection::SyncMessageState::~SyncMessageState()
 149 {
 150     std::lock_guard<std::mutex> lock(syncMessageStateMapMutex());
 151
 152     ASSERT(syncMessageStateMap().contains(&m_runLoop));
 153     syncMessageStateMap().remove(&m_runLoop);
 154
 155     ASSERT(m_messagesToDispatchWhileWaitingForSyncReply.isEmpty());
 156 }
 157
 158 bool Connection::SyncMessageState::processIncomingMessage(Connection& connection, std::unique_ptr<MessageDecoder>& message)
 159 {
 160     if (!message->shouldDispatchMessageWhenWaitingForSyncReply())
 161         return false;
 162
 163     ConnectionAndIncomingMessage connectionAndIncomingMessage { connection, WTF::move(message) };
 164
 165     {
 166         std::lock_guard<std::mutex> lock(m_mutex);
 167
 168         if (m_didScheduleDispatchMessagesWorkSet.add(&connection).isNewEntry) {
 169             RefPtr<Connection> protectedConnection(&connection);
 170             m_runLoop.dispatch([this, protectedConnection] {
 171                 dispatchMessageAndResetDidScheduleDispatchMessagesForConnection(*protectedConnection);
 172             });
 173         }
 174
 175         m_messagesToDispatchWhileWaitingForSyncReply.append(WTF::move(connectionAndIncomingMessage));
 176     }
 177
 178     wakeUpClientRunLoop();
 179
 180     return true;
 181 }
 182
 183 void Connection::SyncMessageState::dispatchMessages(Connection* allowedConnection)
 184 {
 185     ASSERT(&m_runLoop == &RunLoop::current());
 186
 187     Vector<ConnectionAndIncomingMessage> messagesToDispatchWhileWaitingForSyncReply;
 188
 189     {
 190         std::lock_guard<std::mutex> lock(m_mutex);
 191         m_messagesToDispatchWhileWaitingForSyncReply.swap(messagesToDispatchWhileWaitingForSyncReply);
 192     }
 193
 194     Vector<ConnectionAndIncomingMessage> messagesToPutBack;
 195
 196     for (size_t i = 0; i < messagesToDispatchWhileWaitingForSyncReply.size(); ++i) {
 197         ConnectionAndIncomingMessage& connectionAndIncomingMessage = messagesToDispatchWhileWaitingForSyncReply[i];
 198
 199         if (allowedConnection && allowedConnection != connectionAndIncomingMessage.connection.ptr()) {
 200             // This incoming message belongs to another connection and we don't want to dispatch it now
 201             // so mark it to be put back in the message queue.
 202             messagesToPutBack.append(WTF::move(connectionAndIncomingMessage));
 203             continue;
 204         }
 205
 206         connectionAndIncomingMessage.connection->dispatchMessage(WTF::move(connectionAndIncomingMessage.message));
 207     }
 208
 209     if (!messagesToPutBack.isEmpty()) {
 210         std::lock_guard<std::mutex> lock(m_mutex);
 211
 212         for (auto& message : messagesToPutBack)
 213             m_messagesToDispatchWhileWaitingForSyncReply.append(WTF::move(message));
 214     }
 215 }
 216
 217 void Connection::SyncMessageState::dispatchMessageAndResetDidScheduleDispatchMessagesForConnection(Connection& connection)
 218 {
 219     {
 220         std::lock_guard<std::mutex> lock(m_mutex);
 221         ASSERT(m_didScheduleDispatchMessagesWorkSet.contains(&connection));
 222         m_didScheduleDispatchMessagesWorkSet.remove(&connection);
 223     }
 224
 225     dispatchMessages(&connection);
 226 }
 227
 228 Ref<Connection> Connection::createServerConnection(Identifier identifier, Client& client, RunLoop& clientRunLoop)
 229 {
 230     return adoptRef(*new Connection(identifier, true, client, clientRunLoop));
 231 }
 232
 233 Ref<Connection> Connection::createClientConnection(Identifier identifier, Client& client, RunLoop& clientRunLoop)
 234 {
 235     return adoptRef(*new Connection(identifier, false, client, clientRunLoop));
 236 }
 237
 238 Connection::Connection(Identifier identifier, bool isServer, Client& client, RunLoop& clientRunLoop)
 239     : m_client(&client)
 240     , m_isServer(isServer)
 241     , m_syncRequestID(0)
 242     , m_onlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage(false)
 243     , m_shouldExitOnSyncMessageSendFailure(false)
 244     , m_didCloseOnConnectionWorkQueueCallback(0)
 245     , m_isConnected(false)
 246     , m_connectionQueue(WorkQueue::create("com.apple.IPC.ReceiveQueue"))
 247     , m_clientRunLoop(clientRunLoop)
 248     , m_inSendSyncCount(0)
 249     , m_inDispatchMessageCount(0)
 250     , m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount(0)
 251     , m_didReceiveInvalidMessage(false)
 252     , m_waitingForMessage(nullptr)
 253     , m_syncMessageState(SyncMessageState::getOrCreate(clientRunLoop))
 254     , m_shouldWaitForSyncReplies(true)
 255 {
 256     ASSERT(m_client);
 257
 258     platformInitialize(identifier);
 259 }
 260
 261 Connection::~Connection()
 262 {
 263     ASSERT(!isValid());
 264 }
 265
 266 void Connection::setOnlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage(bool flag)
 267 {
 268     ASSERT(!m_isConnected);
 269
 270     m_onlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage = flag;
 271 }
 272
 273 void Connection::setShouldExitOnSyncMessageSendFailure(bool shouldExitOnSyncMessageSendFailure)
 274 {
 275     ASSERT(!m_isConnected);
 276
 277     m_shouldExitOnSyncMessageSendFailure = shouldExitOnSyncMessageSendFailure;
 278 }
 279
 280 void Connection::addWorkQueueMessageReceiver(StringReference messageReceiverName, WorkQueue* workQueue, WorkQueueMessageReceiver* workQueueMessageReceiver)
 281 {
 282     ASSERT(&RunLoop::current() == &m_clientRunLoop);
 283
 284     RefPtr<Connection> connection(this);
 285     m_connectionQueue->dispatch([connection, messageReceiverName, workQueue, workQueueMessageReceiver] {
 286         ASSERT(!connection->m_workQueueMessageReceivers.contains(messageReceiverName));
 287
 288         connection->m_workQueueMessageReceivers.add(messageReceiverName, std::make_pair(workQueue, workQueueMessageReceiver));
 289     });
 290 }
 291
 292 void Connection::removeWorkQueueMessageReceiver(StringReference messageReceiverName)
 293 {
 294     ASSERT(&RunLoop::current() == &m_clientRunLoop);
 295
 296     RefPtr<Connection> connection(this);
 297     m_connectionQueue->dispatch([connection, messageReceiverName] {
 298         ASSERT(connection->m_workQueueMessageReceivers.contains(messageReceiverName));
 299         connection->m_workQueueMessageReceivers.remove(messageReceiverName);
 300     });
 301 }
 302
 303 void Connection::dispatchWorkQueueMessageReceiverMessage(WorkQueueMessageReceiver* workQueueMessageReceiver, MessageDecoder* incomingMessageDecoder)
 304 {
 305     std::unique_ptr<MessageDecoder> decoder(incomingMessageDecoder);
 306
 307     if (!decoder->isSyncMessage()) {
 308         workQueueMessageReceiver->didReceiveMessage(*this, *decoder);
 309         return;
 310     }
 311
 312     uint64_t syncRequestID = 0;
 313     if (!decoder->decode(syncRequestID) || !syncRequestID) {
 314         // We received an invalid sync message.
 315         // FIXME: Handle this.
 316         decoder->markInvalid();
 317         return;
 318     }
 319
 320 #if HAVE(DTRACE)
 321     auto replyEncoder = std::make_unique<MessageEncoder>("IPC", "SyncMessageReply", syncRequestID, incomingMessageDecoder->UUID());
 322 #else
 323     auto replyEncoder = std::make_unique<MessageEncoder>("IPC", "SyncMessageReply", syncRequestID);
 324 #endif
 325
 326     // Hand off both the decoder and encoder to the work queue message receiver.
 327     workQueueMessageReceiver->didReceiveSyncMessage(*this, *decoder, replyEncoder);
 328
 329     // FIXME: If the message was invalid, we should send back a SyncMessageError.
 330     ASSERT(!decoder->isInvalid());
 331
 332     if (replyEncoder)
 333         sendSyncReply(WTF::move(replyEncoder));
 334 }
 335
 336 void Connection::setDidCloseOnConnectionWorkQueueCallback(DidCloseOnConnectionWorkQueueCallback callback)
 337 {
 338     ASSERT(!m_isConnected);
 339
 340     m_didCloseOnConnectionWorkQueueCallback = callback;
 341 }
 342
 343 void Connection::invalidate()
 344 {
 345     if (!isValid()) {
 346         // Someone already called invalidate().
 347         return;
 348     }
 349
 350     // Reset the client.
 351     m_client = 0;
 352
 353     m_connectionQueue->dispatch(WTF::bind(&Connection::platformInvalidate, this));
 354 }
 355
 356 void Connection::markCurrentlyDispatchedMessageAsInvalid()
 357 {
 358     // This should only be called while processing a message.
 359     ASSERT(m_inDispatchMessageCount > 0);
 360
 361     m_didReceiveInvalidMessage = true;
 362 }
 363
 364 std::unique_ptr<MessageEncoder> Connection::createSyncMessageEncoder(StringReference messageReceiverName, StringReference messageName, uint64_t destinationID, uint64_t& syncRequestID)
 365 {
 366     auto encoder = std::make_unique<MessageEncoder>(messageReceiverName, messageName, destinationID);
 367     encoder->setIsSyncMessage(true);
 368
 369     // Encode the sync request ID.
 370     syncRequestID = ++m_syncRequestID;
 371     *encoder << syncRequestID;
 372
 373     return encoder;
 374 }
 375
 376 bool Connection::sendMessage(std::unique_ptr<MessageEncoder> encoder, unsigned messageSendFlags, bool alreadyRecordedMessage)
 377 {
 378     if (!isValid())
 379         return false;
 380
 381     if (messageSendFlags & DispatchMessageEvenWhenWaitingForSyncReply
 382         && (!m_onlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage
 383             || m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount))
 384         encoder->setShouldDispatchMessageWhenWaitingForSyncReply(true);
 385
 386 #if HAVE(DTRACE)
 387     std::unique_ptr<MessageRecorder::MessageProcessingToken> token;
 388     if (!alreadyRecordedMessage)
 389         token = MessageRecorder::recordOutgoingMessage(*this, *encoder);
 390 #else
 391     UNUSED_PARAM(alreadyRecordedMessage);
 392 #endif
 393
 394     {
 395         std::lock_guard<std::mutex> lock(m_outgoingMessagesMutex);
 396         m_outgoingMessages.append(WTF::move(encoder));
 397     }
 398
 399     // FIXME: We should add a boolean flag so we don't call this when work has already been scheduled.
 400     m_connectionQueue->dispatch(WTF::bind(&Connection::sendOutgoingMessages, this));
 401     return true;
 402 }
 403
 404 bool Connection::sendSyncReply(std::unique_ptr<MessageEncoder> encoder)
 405 {
 406     return sendMessage(WTF::move(encoder));
 407 }
 408
 409 std::unique_ptr<MessageDecoder> Connection::waitForMessage(StringReference messageReceiverName, StringReference messageName, uint64_t destinationID, std::chrono::milliseconds timeout, unsigned waitForMessageFlags)
 410 {
 411     ASSERT(&m_clientRunLoop == &RunLoop::current());
 412
 413     // First, check if this message is already in the incoming messages queue.
 414     {
 415         std::lock_guard<std::mutex> lock(m_incomingMessagesMutex);
 416
 417         for (auto it = m_incomingMessages.begin(), end = m_incomingMessages.end(); it != end; ++it) {
 418             std::unique_ptr<MessageDecoder>& message = *it;
 419
 420             if (message->messageReceiverName() == messageReceiverName && message->messageName() == messageName && message->destinationID() == destinationID) {
 421                 std::unique_ptr<MessageDecoder> returnedMessage = WTF::move(message);
 422
 423                 m_incomingMessages.remove(it);
 424                 return returnedMessage;
 425             }
 426         }
 427     }
 428
 429     WaitForMessageState waitingForMessage(messageReceiverName, messageName, destinationID, waitForMessageFlags);
 430
 431     {
 432         std::lock_guard<std::mutex> lock(m_waitForMessageMutex);
 433
 434         // We don't support having multiple clients waiting for messages.
 435         ASSERT(!m_waitingForMessage);
 436
 437         m_waitingForMessage = &waitingForMessage;
 438     }
 439
 440     // Now wait for it to be set.
 441     while (true) {
 442         std::unique_lock<std::mutex> lock(m_waitForMessageMutex);
 443
 444         if (m_waitingForMessage->decoder) {
 445             auto decoder = WTF::move(m_waitingForMessage->decoder);
 446             m_waitingForMessage = nullptr;
 447             return decoder;
 448         }
 449
 450         // Now we wait.
 451         std::cv_status status = m_waitForMessageCondition.wait_for(lock, timeout);
 452         // We timed out, lost our connection, or a sync message came in with InterruptWaitingIfSyncMessageArrives, so stop waiting.
 453         if (status == std::cv_status::timeout || m_waitingForMessage->messageWaitingInterrupted)
 454             break;
 455     }
 456
 457     m_waitingForMessage = nullptr;
 458
 459     return nullptr;
 460 }
 461
 462 std::unique_ptr<MessageDecoder> Connection::sendSyncMessage(uint64_t syncRequestID, std::unique_ptr<MessageEncoder> encoder, std::chrono::milliseconds timeout, unsigned syncSendFlags)
 463 {
 464     if (&RunLoop::current() != &m_clientRunLoop) {
 465         // No flags are supported for synchronous messages sent from secondary threads.
 466         ASSERT(!syncSendFlags);
 467         return sendSyncMessageFromSecondaryThread(syncRequestID, WTF::move(encoder), timeout);
 468     }
 469
 470     if (!isValid()) {
 471         didFailToSendSyncMessage();
 472         return nullptr;
 473     }
 474
 475     // Push the pending sync reply information on our stack.
 476     {
 477         MutexLocker locker(m_syncReplyStateMutex);
 478         if (!m_shouldWaitForSyncReplies) {
 479             didFailToSendSyncMessage();
 480             return nullptr;
 481         }
 482
 483         m_pendingSyncReplies.append(PendingSyncReply(syncRequestID));
 484     }
 485
 486     ++m_inSendSyncCount;
 487
 488 #if HAVE(DTRACE)
 489     auto token = MessageRecorder::recordOutgoingMessage(*this, *encoder);
 490 #endif
 491
 492     // First send the message.
 493     sendMessage(WTF::move(encoder), DispatchMessageEvenWhenWaitingForSyncReply, true);
 494
 495     // Then wait for a reply. Waiting for a reply could involve dispatching incoming sync messages, so
 496     // keep an extra reference to the connection here in case it's invalidated.
 497     Ref<Connection> protect(*this);
 498     std::unique_ptr<MessageDecoder> reply = waitForSyncReply(syncRequestID, timeout, syncSendFlags);
 499
 500     --m_inSendSyncCount;
 501
 502     // Finally, pop the pending sync reply information.
 503     {
 504         MutexLocker locker(m_syncReplyStateMutex);
 505         ASSERT(m_pendingSyncReplies.last().syncRequestID == syncRequestID);
 506         m_pendingSyncReplies.removeLast();
 507     }
 508
 509     if (!reply)
 510         didFailToSendSyncMessage();
 511
 512     return reply;
 513 }
 514
 515 std::unique_ptr<MessageDecoder> Connection::sendSyncMessageFromSecondaryThread(uint64_t syncRequestID, std::unique_ptr<MessageEncoder> encoder, std::chrono::milliseconds timeout)
 516 {
 517     ASSERT(&RunLoop::current() != &m_clientRunLoop);
 518
 519     if (!isValid())
 520         return nullptr;
 521
 522     SecondaryThreadPendingSyncReply pendingReply;
 523
 524     // Push the pending sync reply information on our stack.
 525     {
 526         MutexLocker locker(m_syncReplyStateMutex);
 527         if (!m_shouldWaitForSyncReplies)
 528             return nullptr;
 529
 530         ASSERT(!m_secondaryThreadPendingSyncReplyMap.contains(syncRequestID));
 531         m_secondaryThreadPendingSyncReplyMap.add(syncRequestID, &pendingReply);
 532     }
 533
 534 #if HAVE(DTRACE)
 535     auto token = MessageRecorder::recordOutgoingMessage(*this, *encoder);
 536 #endif
 537
 538     sendMessage(WTF::move(encoder), 0, true);
 539
 540     pendingReply.semaphore.wait(currentTime() + (timeout.count() / 1000.0));
 541
 542     // Finally, pop the pending sync reply information.
 543     {
 544         MutexLocker locker(m_syncReplyStateMutex);
 545         ASSERT(m_secondaryThreadPendingSyncReplyMap.contains(syncRequestID));
 546         m_secondaryThreadPendingSyncReplyMap.remove(syncRequestID);
 547     }
 548
 549     return WTF::move(pendingReply.replyDecoder);
 550 }
 551
 552 std::unique_ptr<MessageDecoder> Connection::waitForSyncReply(uint64_t syncRequestID, std::chrono::milliseconds timeout, unsigned syncSendFlags)
 553 {
 554     double absoluteTime = currentTime() + (timeout.count() / 1000.0);
 555
 556     willSendSyncMessage(syncSendFlags);
 557
 558     bool timedOut = false;
 559     while (!timedOut) {
 560         // First, check if we have any messages that we need to process.
 561         m_syncMessageState->dispatchMessages(nullptr);
 562
 563         {
 564             MutexLocker locker(m_syncReplyStateMutex);
 565
 566             // Second, check if there is a sync reply at the top of the stack.
 567             ASSERT(!m_pendingSyncReplies.isEmpty());
 568
 569             PendingSyncReply& pendingSyncReply = m_pendingSyncReplies.last();
 570             ASSERT_UNUSED(syncRequestID, pendingSyncReply.syncRequestID == syncRequestID);
 571
 572             // We found the sync reply, or the connection was closed.
 573             if (pendingSyncReply.didReceiveReply || !m_shouldWaitForSyncReplies) {
 574                 didReceiveSyncReply(syncSendFlags);
 575                 return WTF::move(pendingSyncReply.replyDecoder);
 576             }
 577         }
 578
 579         // Processing a sync message could cause the connection to be invalidated.
 580         // (If the handler ends up calling Connection::invalidate).
 581         // If that happens, we need to stop waiting, or we'll hang since we won't get
 582         // any more incoming messages.
 583         if (!isValid()) {
 584             didReceiveSyncReply(syncSendFlags);
 585             return nullptr;
 586         }
 587
 588         // We didn't find a sync reply yet, keep waiting.
 589         // This allows the WebProcess to still serve clients while waiting for the message to return.
 590         // Notably, it can continue to process accessibility requests, which are on the main thread.
 591         if (syncSendFlags & SpinRunLoopWhileWaitingForReply) {
 592 #if PLATFORM(COCOA)
 593             // FIXME: Although we run forever, any events incoming will cause us to drop out and exit out. This however doesn't
 594             // account for a timeout value passed in. Timeout is always NoTimeout in these cases, but that could change.
 595             RunLoop::current().runForDuration(1e10);
 596             timedOut = currentTime() >= absoluteTime;
 597 #endif
 598         } else
 599             timedOut = !m_syncMessageState->wait(absoluteTime);
 600
 601     }
 602
 603     didReceiveSyncReply(syncSendFlags);
 604
 605     return nullptr;
 606 }
 607
 608 void Connection::processIncomingSyncReply(std::unique_ptr<MessageDecoder> decoder)
 609 {
 610     MutexLocker locker(m_syncReplyStateMutex);
 611
 612     // Go through the stack of sync requests that have pending replies and see which one
 613     // this reply is for.
 614     for (size_t i = m_pendingSyncReplies.size(); i > 0; --i) {
 615         PendingSyncReply& pendingSyncReply = m_pendingSyncReplies[i - 1];
 616
 617         if (pendingSyncReply.syncRequestID != decoder->destinationID())
 618             continue;
 619
 620         ASSERT(!pendingSyncReply.replyDecoder);
 621
 622         pendingSyncReply.replyDecoder = WTF::move(decoder);
 623         pendingSyncReply.didReceiveReply = true;
 624
 625         // We got a reply to the last send message, wake up the client run loop so it can be processed.
 626         if (i == m_pendingSyncReplies.size())
 627             m_syncMessageState->wakeUpClientRunLoop();
 628
 629         return;
 630     }
 631
 632     // If it's not a reply to any primary thread message, check if it is a reply to a secondary thread one.
 633     SecondaryThreadPendingSyncReplyMap::iterator secondaryThreadReplyMapItem = m_secondaryThreadPendingSyncReplyMap.find(decoder->destinationID());
 634     if (secondaryThreadReplyMapItem != m_secondaryThreadPendingSyncReplyMap.end()) {
 635         SecondaryThreadPendingSyncReply* reply = secondaryThreadReplyMapItem->value;
 636         ASSERT(!reply->replyDecoder);
 637         reply->replyDecoder = WTF::move(decoder);
 638         reply->semaphore.signal();
 639     }
 640
 641     // If we get here, it means we got a reply for a message that wasn't in the sync request stack or map.
 642     // This can happen if the send timed out, so it's fine to ignore.
 643 }
 644
 645 void Connection::processIncomingMessage(std::unique_ptr<MessageDecoder> message)
 646 {
 647     ASSERT(!message->messageReceiverName().isEmpty());
 648     ASSERT(!message->messageName().isEmpty());
 649
 650     if (message->messageReceiverName() == "IPC" && message->messageName() == "SyncMessageReply") {
 651         processIncomingSyncReply(WTF::move(message));
 652         return;
 653     }
 654
 655     if (!m_workQueueMessageReceivers.isValidKey(message->messageReceiverName())) {
 656         if (message->messageReceiverName().isEmpty() && message->messageName().isEmpty()) {
 657             // Something went wrong when decoding the message. Encode the message length so we can figure out if this
 658             // happens for certain message lengths.
 659             CString messageReceiverName = "<unknown message>";
 660             CString messageName = String::format("<message length: %zu bytes>", message->length()).utf8();
 661
 662             m_clientRunLoop.dispatch(bind(&Connection::dispatchDidReceiveInvalidMessage, this, messageReceiverName, messageName));
 663             return;
 664         }
 665
 666         m_clientRunLoop.dispatch(bind(&Connection::dispatchDidReceiveInvalidMessage, this, message->messageReceiverName().toString(), message->messageName().toString()));
 667         return;
 668     }
 669
 670     auto it = m_workQueueMessageReceivers.find(message->messageReceiverName());
 671     if (it != m_workQueueMessageReceivers.end()) {
 672         it->value.first->dispatch(bind(&Connection::dispatchWorkQueueMessageReceiverMessage, this, it->value.second, message.release()));
 673         return;
 674     }
 675
 676     // Check if this is a sync message or if it's a message that should be dispatched even when waiting for
 677     // a sync reply. If it is, and we're waiting for a sync reply this message needs to be dispatched.
 678     // If we don't we'll end up with a deadlock where both sync message senders are stuck waiting for a reply.
 679     if (m_syncMessageState->processIncomingMessage(*this, message))
 680         return;
 681
 682     // Check if we're waiting for this message.
 683     {
 684         std::lock_guard<std::mutex> lock(m_waitForMessageMutex);
 685
 686         if (m_waitingForMessage && m_waitingForMessage->messageReceiverName == message->messageReceiverName() && m_waitingForMessage->messageName == message->messageName() && m_waitingForMessage->destinationID == message->destinationID()) {
 687             m_waitingForMessage->decoder = WTF::move(message);
 688             ASSERT(m_waitingForMessage->decoder);
 689             m_waitForMessageCondition.notify_one();
 690             return;
 691         }
 692
 693         if (m_waitingForMessage && (m_waitingForMessage->waitForMessageFlags & InterruptWaitingIfSyncMessageArrives) && message->isSyncMessage()) {
 694             m_waitingForMessage->messageWaitingInterrupted = true;
 695             m_waitForMessageCondition.notify_one();
 696         }
 697     }
 698
 699     enqueueIncomingMessage(WTF::move(message));
 700 }
 701
 702 void Connection::postConnectionDidCloseOnConnectionWorkQueue()
 703 {
 704     RefPtr<Connection> connection(this);
 705     m_connectionQueue->dispatch([connection] {
 706         connection->connectionDidClose();
 707     });
 708 }
 709
 710 void Connection::connectionDidClose()
 711 {
 712     // The connection is now invalid.
 713     platformInvalidate();
 714
 715     {
 716         MutexLocker locker(m_syncReplyStateMutex);
 717
 718         ASSERT(m_shouldWaitForSyncReplies);
 719         m_shouldWaitForSyncReplies = false;
 720
 721         if (!m_pendingSyncReplies.isEmpty())
 722             m_syncMessageState->wakeUpClientRunLoop();
 723
 724         for (SecondaryThreadPendingSyncReplyMap::iterator iter = m_secondaryThreadPendingSyncReplyMap.begin(); iter != m_secondaryThreadPendingSyncReplyMap.end(); ++iter)
 725             iter->value->semaphore.signal();
 726     }
 727
 728     {
 729         std::lock_guard<std::mutex> lock(m_waitForMessageMutex);
 730         if (m_waitingForMessage)
 731             m_waitingForMessage->messageWaitingInterrupted = true;
 732     }
 733     m_waitForMessageCondition.notify_all();
 734
 735     if (m_didCloseOnConnectionWorkQueueCallback)
 736         m_didCloseOnConnectionWorkQueueCallback(this);
 737
 738     RefPtr<Connection> connection(this);
 739     m_clientRunLoop.dispatch([connection] {
 740         // If the connection has been explicitly invalidated before dispatchConnectionDidClose was called,
 741         // then the client will be null here.
 742         if (!connection->m_client)
 743             return;
 744
 745         // Because we define a connection as being "valid" based on wheter it has a null client, we null out
 746         // the client before calling didClose here. Otherwise, sendSync will try to send a message to the connection and
 747         // will then wait indefinitely for a reply.
 748         Client* client = connection->m_client;
 749         connection->m_client = nullptr;
 750
 751         client->didClose(*connection);
 752     });
 753 }
 754
 755 bool Connection::canSendOutgoingMessages() const
 756 {
 757     return m_isConnected && platformCanSendOutgoingMessages();
 758 }
 759
 760 void Connection::sendOutgoingMessages()
 761 {
 762     if (!canSendOutgoingMessages())
 763         return;
 764
 765     while (true) {
 766         std::unique_ptr<MessageEncoder> message;
 767
 768         {
 769             std::lock_guard<std::mutex> lock(m_outgoingMessagesMutex);
 770             if (m_outgoingMessages.isEmpty())
 771                 break;
 772             message = m_outgoingMessages.takeFirst();
 773         }
 774
 775         if (!sendOutgoingMessage(WTF::move(message)))
 776             break;
 777     }
 778 }
 779
 780 void Connection::dispatchSyncMessage(MessageDecoder& decoder)
 781 {
 782     ASSERT(decoder.isSyncMessage());
 783
 784     uint64_t syncRequestID = 0;
 785     if (!decoder.decode(syncRequestID) || !syncRequestID) {
 786         // We received an invalid sync message.
 787         decoder.markInvalid();
 788         return;
 789     }
 790
 791 #if HAVE(DTRACE)
 792     auto replyEncoder = std::make_unique<MessageEncoder>("IPC", "SyncMessageReply", syncRequestID, decoder.UUID());
 793 #else
 794     auto replyEncoder = std::make_unique<MessageEncoder>("IPC", "SyncMessageReply", syncRequestID);
 795 #endif
 796
 797     // Hand off both the decoder and encoder to the client.
 798     m_client->didReceiveSyncMessage(*this, decoder, replyEncoder);
 799
 800     // FIXME: If the message was invalid, we should send back a SyncMessageError.
 801     ASSERT(!decoder.isInvalid());
 802
 803     if (replyEncoder)
 804         sendSyncReply(WTF::move(replyEncoder));
 805 }
 806
 807 void Connection::dispatchDidReceiveInvalidMessage(const CString& messageReceiverNameString, const CString& messageNameString)
 808 {
 809     ASSERT(&RunLoop::current() == &m_clientRunLoop);
 810
 811     if (!m_client)
 812         return;
 813
 814     m_client->didReceiveInvalidMessage(*this, StringReference(messageReceiverNameString.data(), messageReceiverNameString.length()), StringReference(messageNameString.data(), messageNameString.length()));
 815 }
 816
 817 void Connection::didFailToSendSyncMessage()
 818 {
 819     if (!m_shouldExitOnSyncMessageSendFailure)
 820         return;
 821
 822     exit(0);
 823 }
 824
 825 void Connection::enqueueIncomingMessage(std::unique_ptr<MessageDecoder> incomingMessage)
 826 {
 827     {
 828         std::lock_guard<std::mutex> lock(m_incomingMessagesMutex);
 829         m_incomingMessages.append(WTF::move(incomingMessage));
 830     }
 831
 832     m_clientRunLoop.dispatch(WTF::bind(&Connection::dispatchOneMessage, this));
 833 }
 834
 835 void Connection::dispatchMessage(MessageDecoder& decoder)
 836 {
 837     m_client->didReceiveMessage(*this, decoder);
 838 }
 839
 840 void Connection::dispatchMessage(std::unique_ptr<MessageDecoder> message)
 841 {
 842 #if HAVE(DTRACE)
 843     MessageRecorder::recordIncomingMessage(*this, *message);
 844 #endif
 845
 846     if (!m_client)
 847         return;
 848
 849     m_inDispatchMessageCount++;
 850
 851     if (message->shouldDispatchMessageWhenWaitingForSyncReply())
 852         m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount++;
 853
 854     bool oldDidReceiveInvalidMessage = m_didReceiveInvalidMessage;
 855     m_didReceiveInvalidMessage = false;
 856
 857     if (message->isSyncMessage())
 858         dispatchSyncMessage(*message);
 859     else
 860         dispatchMessage(*message);
 861
 862     m_didReceiveInvalidMessage |= message->isInvalid();
 863     m_inDispatchMessageCount--;
 864
 865     // FIXME: For Delayed synchronous messages, we should not decrement the counter until we send a response.
 866     // Otherwise, we would deadlock if processing the message results in a sync message back after we exit this function.
 867     if (message->shouldDispatchMessageWhenWaitingForSyncReply())
 868         m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount--;
 869
 870     if (m_didReceiveInvalidMessage && m_client)
 871         m_client->didReceiveInvalidMessage(*this, message->messageReceiverName(), message->messageName());
 872
 873     m_didReceiveInvalidMessage = oldDidReceiveInvalidMessage;
 874 }
 875
 876 void Connection::dispatchOneMessage()
 877 {
 878     std::unique_ptr<MessageDecoder> message;
 879
 880     {
 881         std::lock_guard<std::mutex> lock(m_incomingMessagesMutex);
 882         if (m_incomingMessages.isEmpty())
 883             return;
 884
 885         message = m_incomingMessages.takeFirst();
 886     }
 887
 888     dispatchMessage(WTF::move(message));
 889 }
 890
 891 void Connection::wakeUpRunLoop()
 892 {
 893     m_clientRunLoop.wakeUp();
 894 }
 895
 896 } // namespace IPC