#include "config.h"
#include "Connection.h"
#include "Logging.h"
#include <memory>
#include <wtf/HashSet.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/RunLoop.h>
#include <wtf/text/WTFString.h>
#include <wtf/threads/BinarySemaphore.h>
#if PLATFORM(COCOA)
#include "MachMessage.h"
#endif
#if USE(UNIX_DOMAIN_SOCKETS)
#include "UnixMessage.h"
#endif
namespace IPC {
#if PLATFORM(COCOA)
const size_t maxPendingIncomingMessagesKillingThreshold { 50000 };
#endif
struct Connection::ReplyHandler {
RefPtr<FunctionDispatcher> dispatcher;
Function<void (std::unique_ptr<Decoder>)> handler;
};
struct Connection::WaitForMessageState {
WaitForMessageState(StringReference messageReceiverName, StringReference messageName, uint64_t destinationID, OptionSet<WaitForOption> waitForOptions)
: messageReceiverName(messageReceiverName)
, messageName(messageName)
, destinationID(destinationID)
, waitForOptions(waitForOptions)
{
}
StringReference messageReceiverName;
StringReference messageName;
uint64_t destinationID;
OptionSet<WaitForOption> waitForOptions;
bool messageWaitingInterrupted = false;
std::unique_ptr<Decoder> decoder;
};
class Connection::SyncMessageState {
public:
static SyncMessageState& singleton();
SyncMessageState();
~SyncMessageState() = delete;
void wakeUpClientRunLoop()
{
m_waitForSyncReplySemaphore.signal();
}
bool wait(TimeWithDynamicClockType absoluteTime)
{
return m_waitForSyncReplySemaphore.waitUntil(absoluteTime);
}
bool processIncomingMessage(Connection&, std::unique_ptr<Decoder>&);
void dispatchMessages(Connection* allowedConnection);
private:
void dispatchMessageAndResetDidScheduleDispatchMessagesForConnection(Connection&);
BinarySemaphore m_waitForSyncReplySemaphore;
Lock m_mutex;
HashSet<RefPtr<Connection>> m_didScheduleDispatchMessagesWorkSet;
struct ConnectionAndIncomingMessage {
Ref<Connection> connection;
std::unique_ptr<Decoder> message;
};
Vector<ConnectionAndIncomingMessage> m_messagesToDispatchWhileWaitingForSyncReply;
};
Connection::SyncMessageState& Connection::SyncMessageState::singleton()
{
static std::once_flag onceFlag;
static LazyNeverDestroyed<SyncMessageState> syncMessageState;
std::call_once(onceFlag, [] {
syncMessageState.construct();
});
return syncMessageState;
}
Connection::SyncMessageState::SyncMessageState()
{
}
bool Connection::SyncMessageState::processIncomingMessage(Connection& connection, std::unique_ptr<Decoder>& message)
{
if (!message->shouldDispatchMessageWhenWaitingForSyncReply())
return false;
ConnectionAndIncomingMessage connectionAndIncomingMessage { connection, WTFMove(message) };
{
std::lock_guard<Lock> lock(m_mutex);
if (m_didScheduleDispatchMessagesWorkSet.add(&connection).isNewEntry) {
RunLoop::main().dispatch([this, protectedConnection = Ref<Connection>(connection)]() mutable {
dispatchMessageAndResetDidScheduleDispatchMessagesForConnection(protectedConnection);
});
}
m_messagesToDispatchWhileWaitingForSyncReply.append(WTFMove(connectionAndIncomingMessage));
}
wakeUpClientRunLoop();
return true;
}
void Connection::SyncMessageState::dispatchMessages(Connection* allowedConnection)
{
ASSERT(RunLoop::isMain());
Vector<ConnectionAndIncomingMessage> messagesToDispatchWhileWaitingForSyncReply;
{
std::lock_guard<Lock> lock(m_mutex);
m_messagesToDispatchWhileWaitingForSyncReply.swap(messagesToDispatchWhileWaitingForSyncReply);
}
Vector<ConnectionAndIncomingMessage> messagesToPutBack;
for (size_t i = 0; i < messagesToDispatchWhileWaitingForSyncReply.size(); ++i) {
ConnectionAndIncomingMessage& connectionAndIncomingMessage = messagesToDispatchWhileWaitingForSyncReply[i];
if (allowedConnection && allowedConnection != connectionAndIncomingMessage.connection.ptr()) {
messagesToPutBack.append(WTFMove(connectionAndIncomingMessage));
continue;
}
connectionAndIncomingMessage.connection->dispatchMessage(WTFMove(connectionAndIncomingMessage.message));
}
if (!messagesToPutBack.isEmpty()) {
std::lock_guard<Lock> lock(m_mutex);
for (auto& message : messagesToPutBack)
m_messagesToDispatchWhileWaitingForSyncReply.append(WTFMove(message));
}
}
void Connection::SyncMessageState::dispatchMessageAndResetDidScheduleDispatchMessagesForConnection(Connection& connection)
{
{
std::lock_guard<Lock> lock(m_mutex);
ASSERT(m_didScheduleDispatchMessagesWorkSet.contains(&connection));
m_didScheduleDispatchMessagesWorkSet.remove(&connection);
}
dispatchMessages(&connection);
}
struct Connection::PendingSyncReply {
uint64_t syncRequestID { 0 };
std::unique_ptr<Decoder> replyDecoder;
bool didReceiveReply { false };
PendingSyncReply() = default;
explicit PendingSyncReply(uint64_t syncRequestID)
: syncRequestID(syncRequestID)
{
}
};
Ref<Connection> Connection::createServerConnection(Identifier identifier, Client& client)
{
return adoptRef(*new Connection(identifier, true, client));
}
Ref<Connection> Connection::createClientConnection(Identifier identifier, Client& client)
{
return adoptRef(*new Connection(identifier, false, client));
}
static HashMap<IPC::Connection::UniqueID, Connection*>& allConnections()
{
static NeverDestroyed<HashMap<IPC::Connection::UniqueID, Connection*>> map;
return map;
}
static HashMap<uintptr_t, HashMap<uint64_t, CompletionHandler<void(Decoder*)>>>& asyncReplyHandlerMap()
{
static NeverDestroyed<HashMap<uintptr_t, HashMap<uint64_t, CompletionHandler<void(Decoder*)>>>> map;
return map.get();
}
Connection::Connection(Identifier identifier, bool isServer, Client& client)
: m_client(client)
, m_uniqueID(generateObjectIdentifier<UniqueIDType>())
, m_isServer(isServer)
, m_syncRequestID(0)
, m_onlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage(false)
, m_shouldExitOnSyncMessageSendFailure(false)
, m_didCloseOnConnectionWorkQueueCallback(0)
, m_isConnected(false)
, m_connectionQueue(WorkQueue::create("com.apple.IPC.ReceiveQueue"))
, m_inSendSyncCount(0)
, m_inDispatchMessageCount(0)
, m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount(0)
, m_didReceiveInvalidMessage(false)
, m_waitingForMessage(nullptr)
, m_shouldWaitForSyncReplies(true)
{
ASSERT(RunLoop::isMain());
allConnections().add(m_uniqueID, this);
platformInitialize(identifier);
#if HAVE(QOS_CLASSES)
ASSERT(pthread_main_np());
m_mainThread = pthread_self();
#endif
}
Connection::~Connection()
{
ASSERT(RunLoop::isMain());
ASSERT(!isValid());
allConnections().remove(m_uniqueID);
auto map = asyncReplyHandlerMap().take(reinterpret_cast<uintptr_t>(this));
for (auto& handler : map.values()) {
if (handler)
handler(nullptr);
}
}
Connection* Connection::connection(UniqueID uniqueID)
{
ASSERT(RunLoop::isMain());
return allConnections().get(uniqueID);
}
void Connection::setOnlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage(bool flag)
{
ASSERT(!m_isConnected);
m_onlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage = flag;
}
void Connection::setShouldExitOnSyncMessageSendFailure(bool shouldExitOnSyncMessageSendFailure)
{
ASSERT(!m_isConnected);
m_shouldExitOnSyncMessageSendFailure = shouldExitOnSyncMessageSendFailure;
}
void Connection::addWorkQueueMessageReceiver(StringReference messageReceiverName, WorkQueue& workQueue, WorkQueueMessageReceiver* workQueueMessageReceiver)
{
ASSERT(RunLoop::isMain());
m_connectionQueue->dispatch([protectedThis = makeRef(*this), messageReceiverName = WTFMove(messageReceiverName), workQueue = &workQueue, workQueueMessageReceiver]() mutable {
ASSERT(!protectedThis->m_workQueueMessageReceivers.contains(messageReceiverName));
protectedThis->m_workQueueMessageReceivers.add(messageReceiverName, std::make_pair(workQueue, workQueueMessageReceiver));
});
}
void Connection::removeWorkQueueMessageReceiver(StringReference messageReceiverName)
{
ASSERT(RunLoop::isMain());
m_connectionQueue->dispatch([protectedThis = makeRef(*this), messageReceiverName = WTFMove(messageReceiverName)]() mutable {
ASSERT(protectedThis->m_workQueueMessageReceivers.contains(messageReceiverName));
protectedThis->m_workQueueMessageReceivers.remove(messageReceiverName);
});
}
void Connection::dispatchWorkQueueMessageReceiverMessage(WorkQueueMessageReceiver& workQueueMessageReceiver, Decoder& decoder)
{
if (!decoder.isSyncMessage()) {
workQueueMessageReceiver.didReceiveMessage(*this, decoder);
return;
}
uint64_t syncRequestID = 0;
if (!decoder.decode(syncRequestID) || !syncRequestID) {
decoder.markInvalid();
return;
}
auto replyEncoder = std::make_unique<Encoder>("IPC", "SyncMessageReply", syncRequestID);
workQueueMessageReceiver.didReceiveSyncMessage(*this, decoder, replyEncoder);
ASSERT(!decoder.isInvalid());
if (replyEncoder)
sendSyncReply(WTFMove(replyEncoder));
}
void Connection::setDidCloseOnConnectionWorkQueueCallback(DidCloseOnConnectionWorkQueueCallback callback)
{
ASSERT(!m_isConnected);
m_didCloseOnConnectionWorkQueueCallback = callback;
}
void Connection::invalidate()
{
ASSERT(RunLoop::isMain());
if (!isValid()) {
return;
}
m_isValid = false;
{
std::lock_guard<Lock> lock(m_replyHandlersLock);
for (auto& replyHandler : m_replyHandlers.values()) {
replyHandler.dispatcher->dispatch([handler = WTFMove(replyHandler.handler)] {
handler(nullptr);
});
}
m_replyHandlers.clear();
}
m_connectionQueue->dispatch([protectedThis = makeRef(*this)]() mutable {
protectedThis->platformInvalidate();
});
}
void Connection::markCurrentlyDispatchedMessageAsInvalid()
{
ASSERT(m_inDispatchMessageCount > 0);
m_didReceiveInvalidMessage = true;
}
std::unique_ptr<Encoder> Connection::createSyncMessageEncoder(StringReference messageReceiverName, StringReference messageName, uint64_t destinationID, uint64_t& syncRequestID)
{
auto encoder = std::make_unique<Encoder>(messageReceiverName, messageName, destinationID);
encoder->setIsSyncMessage(true);
syncRequestID = ++m_syncRequestID;
*encoder << syncRequestID;
return encoder;
}
bool Connection::sendMessage(std::unique_ptr<Encoder> encoder, OptionSet<SendOption> sendOptions)
{
if (!isValid())
return false;
if (isMainThread() && m_inDispatchMessageMarkedToUseFullySynchronousModeForTesting && !encoder->isSyncMessage() && !(encoder->messageReceiverName() == "IPC") && !sendOptions.contains(SendOption::IgnoreFullySynchronousMode)) {
uint64_t syncRequestID;
auto wrappedMessage = createSyncMessageEncoder("IPC", "WrappedAsyncMessageForTesting", encoder->destinationID(), syncRequestID);
wrappedMessage->setFullySynchronousModeForTesting();
wrappedMessage->wrapForTesting(WTFMove(encoder));
return static_cast<bool>(sendSyncMessage(syncRequestID, WTFMove(wrappedMessage), Seconds::infinity(), { }));
}
if (sendOptions.contains(SendOption::DispatchMessageEvenWhenWaitingForSyncReply)
&& (!m_onlySendMessagesAsDispatchWhenWaitingForSyncReplyWhenProcessingSuchAMessage
|| m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount))
encoder->setShouldDispatchMessageWhenWaitingForSyncReply(true);
{
std::lock_guard<Lock> lock(m_outgoingMessagesMutex);
m_outgoingMessages.append(WTFMove(encoder));
}
m_connectionQueue->dispatch([protectedThis = makeRef(*this)]() mutable {
protectedThis->sendOutgoingMessages();
});
return true;
}
void Connection::sendMessageWithReply(uint64_t requestID, std::unique_ptr<Encoder> encoder, FunctionDispatcher& replyDispatcher, Function<void (std::unique_ptr<Decoder>)>&& replyHandler)
{
{
std::lock_guard<Lock> lock(m_replyHandlersLock);
if (!isValid()) {
replyDispatcher.dispatch([replyHandler = WTFMove(replyHandler)] {
replyHandler(nullptr);
});
return;
}
ASSERT(!m_replyHandlers.contains(requestID));
m_replyHandlers.set(requestID, ReplyHandler { &replyDispatcher, WTFMove(replyHandler) });
}
sendMessage(WTFMove(encoder), { });
}
bool Connection::sendSyncReply(std::unique_ptr<Encoder> encoder)
{
return sendMessage(WTFMove(encoder), { });
}
Seconds Connection::timeoutRespectingIgnoreTimeoutsForTesting(Seconds timeout) const
{
return m_ignoreTimeoutsForTesting ? Seconds::infinity() : timeout;
}
std::unique_ptr<Decoder> Connection::waitForMessage(StringReference messageReceiverName, StringReference messageName, uint64_t destinationID, Seconds timeout, OptionSet<WaitForOption> waitForOptions)
{
ASSERT(RunLoop::isMain());
timeout = timeoutRespectingIgnoreTimeoutsForTesting(timeout);
bool hasIncomingSynchronousMessage = false;
{
std::lock_guard<Lock> lock(m_incomingMessagesMutex);
for (auto it = m_incomingMessages.begin(), end = m_incomingMessages.end(); it != end; ++it) {
std::unique_ptr<Decoder>& message = *it;
if (message->messageReceiverName() == messageReceiverName && message->messageName() == messageName && message->destinationID() == destinationID) {
std::unique_ptr<Decoder> returnedMessage = WTFMove(message);
m_incomingMessages.remove(it);
return returnedMessage;
}
if (message->isSyncMessage())
hasIncomingSynchronousMessage = true;
}
}
if (hasIncomingSynchronousMessage && waitForOptions.contains(WaitForOption::InterruptWaitingIfSyncMessageArrives)) {
m_waitingForMessage = nullptr;
return nullptr;
}
WaitForMessageState waitingForMessage(messageReceiverName, messageName, destinationID, waitForOptions);
{
std::lock_guard<Lock> lock(m_waitForMessageMutex);
ASSERT(!m_waitingForMessage);
m_waitingForMessage = &waitingForMessage;
}
MonotonicTime absoluteTimeout = MonotonicTime::now() + timeout;
while (true) {
std::unique_lock<Lock> lock(m_waitForMessageMutex);
if (m_waitingForMessage->decoder) {
auto decoder = WTFMove(m_waitingForMessage->decoder);
m_waitingForMessage = nullptr;
return decoder;
}
bool didTimeout = !m_waitForMessageCondition.waitUntil(lock, absoluteTimeout);
if (didTimeout || m_waitingForMessage->messageWaitingInterrupted) {
m_waitingForMessage = nullptr;
break;
}
}
return nullptr;
}
std::unique_ptr<Decoder> Connection::sendSyncMessage(uint64_t syncRequestID, std::unique_ptr<Encoder> encoder, Seconds timeout, OptionSet<SendSyncOption> sendSyncOptions)
{
ASSERT(RunLoop::isMain());
if (!isValid()) {
didFailToSendSyncMessage();
return nullptr;
}
{
LockHolder locker(m_syncReplyStateMutex);
if (!m_shouldWaitForSyncReplies) {
didFailToSendSyncMessage();
return nullptr;
}
m_pendingSyncReplies.append(PendingSyncReply(syncRequestID));
}
++m_inSendSyncCount;
sendMessage(WTFMove(encoder), IPC::SendOption::DispatchMessageEvenWhenWaitingForSyncReply);
Ref<Connection> protect(*this);
std::unique_ptr<Decoder> reply = waitForSyncReply(syncRequestID, timeout, sendSyncOptions);
--m_inSendSyncCount;
{
LockHolder locker(m_syncReplyStateMutex);
ASSERT(m_pendingSyncReplies.last().syncRequestID == syncRequestID);
m_pendingSyncReplies.removeLast();
}
if (!reply)
didFailToSendSyncMessage();
return reply;
}
std::unique_ptr<Decoder> Connection::waitForSyncReply(uint64_t syncRequestID, Seconds timeout, OptionSet<SendSyncOption> sendSyncOptions)
{
timeout = timeoutRespectingIgnoreTimeoutsForTesting(timeout);
WallTime absoluteTime = WallTime::now() + timeout;
willSendSyncMessage(sendSyncOptions);
bool timedOut = false;
while (!timedOut) {
SyncMessageState::singleton().dispatchMessages(nullptr);
{
LockHolder locker(m_syncReplyStateMutex);
ASSERT(!m_pendingSyncReplies.isEmpty());
PendingSyncReply& pendingSyncReply = m_pendingSyncReplies.last();
ASSERT_UNUSED(syncRequestID, pendingSyncReply.syncRequestID == syncRequestID);
if (pendingSyncReply.didReceiveReply || !m_shouldWaitForSyncReplies) {
didReceiveSyncReply(sendSyncOptions);
return WTFMove(pendingSyncReply.replyDecoder);
}
}
if (!isValid()) {
RELEASE_LOG_ERROR(IPC, "Connection::waitForSyncReply: Connection no longer valid, id = %" PRIu64, syncRequestID);
didReceiveSyncReply(sendSyncOptions);
return nullptr;
}
timedOut = !SyncMessageState::singleton().wait(absoluteTime);
}
RELEASE_LOG_ERROR(IPC, "Connection::waitForSyncReply: Timed-out while waiting for reply, id = %" PRIu64, syncRequestID);
didReceiveSyncReply(sendSyncOptions);
return nullptr;
}
void Connection::processIncomingSyncReply(std::unique_ptr<Decoder> decoder)
{
{
LockHolder locker(m_syncReplyStateMutex);
for (size_t i = m_pendingSyncReplies.size(); i > 0; --i) {
PendingSyncReply& pendingSyncReply = m_pendingSyncReplies[i - 1];
if (pendingSyncReply.syncRequestID != decoder->destinationID())
continue;
ASSERT(!pendingSyncReply.replyDecoder);
pendingSyncReply.replyDecoder = WTFMove(decoder);
pendingSyncReply.didReceiveReply = true;
if (i == m_pendingSyncReplies.size())
SyncMessageState::singleton().wakeUpClientRunLoop();
return;
}
}
{
LockHolder locker(m_replyHandlersLock);
auto replyHandler = m_replyHandlers.take(decoder->destinationID());
if (replyHandler.dispatcher) {
replyHandler.dispatcher->dispatch([protectedThis = makeRef(*this), handler = WTFMove(replyHandler.handler), decoder = WTFMove(decoder)] () mutable {
if (!protectedThis->isValid()) {
handler(nullptr);
return;
}
handler(WTFMove(decoder));
});
}
}
}
void Connection::processIncomingMessage(std::unique_ptr<Decoder> message)
{
ASSERT(!message->messageReceiverName().isEmpty());
ASSERT(!message->messageName().isEmpty());
if (message->messageReceiverName() == "IPC" && message->messageName() == "SyncMessageReply") {
processIncomingSyncReply(WTFMove(message));
return;
}
if (!m_workQueueMessageReceivers.isValidKey(message->messageReceiverName())) {
RefPtr<Connection> protectedThis(this);
StringReference messageReceiverNameReference = message->messageReceiverName();
String messageReceiverName(messageReceiverNameReference.isEmpty() ? "<unknown message receiver>" : String(messageReceiverNameReference.data(), messageReceiverNameReference.size()));
StringReference messageNameReference = message->messageName();
String messageName(messageNameReference.isEmpty() ? "<unknown message>" : String(messageNameReference.data(), messageNameReference.size()));
RunLoop::main().dispatch([protectedThis = makeRef(*this), messageReceiverName = WTFMove(messageReceiverName), messageName = WTFMove(messageName)]() mutable {
protectedThis->dispatchDidReceiveInvalidMessage(messageReceiverName.utf8(), messageName.utf8());
});
return;
}
auto it = m_workQueueMessageReceivers.find(message->messageReceiverName());
if (it != m_workQueueMessageReceivers.end()) {
it->value.first->dispatch([protectedThis = makeRef(*this), workQueueMessageReceiver = it->value.second, decoder = WTFMove(message)]() mutable {
protectedThis->dispatchWorkQueueMessageReceiverMessage(*workQueueMessageReceiver, *decoder);
});
return;
}
#if HAVE(QOS_CLASSES)
if (message->isSyncMessage() && m_shouldBoostMainThreadOnSyncMessage) {
pthread_override_t override = pthread_override_qos_class_start_np(m_mainThread, Thread::adjustedQOSClass(QOS_CLASS_USER_INTERACTIVE), 0);
message->setQOSClassOverride(override);
}
#endif
if (message->isSyncMessage()) {
std::lock_guard<Lock> lock(m_incomingSyncMessageCallbackMutex);
for (auto& callback : m_incomingSyncMessageCallbacks.values())
m_incomingSyncMessageCallbackQueue->dispatch(WTFMove(callback));
m_incomingSyncMessageCallbacks.clear();
}
if (SyncMessageState::singleton().processIncomingMessage(*this, message))
return;
{
std::lock_guard<Lock> lock(m_waitForMessageMutex);
if (m_waitingForMessage && !m_waitingForMessage->decoder) {
if (m_waitingForMessage->messageReceiverName == message->messageReceiverName() && m_waitingForMessage->messageName == message->messageName() && m_waitingForMessage->destinationID == message->destinationID()) {
m_waitingForMessage->decoder = WTFMove(message);
ASSERT(m_waitingForMessage->decoder);
m_waitForMessageCondition.notifyOne();
return;
}
if (m_waitingForMessage->waitForOptions.contains(WaitForOption::InterruptWaitingIfSyncMessageArrives) && message->isSyncMessage()) {
m_waitingForMessage->messageWaitingInterrupted = true;
m_waitForMessageCondition.notifyOne();
}
}
}
enqueueIncomingMessage(WTFMove(message));
}
uint64_t Connection::installIncomingSyncMessageCallback(WTF::Function<void ()>&& callback)
{
std::lock_guard<Lock> lock(m_incomingSyncMessageCallbackMutex);
m_nextIncomingSyncMessageCallbackID++;
if (!m_incomingSyncMessageCallbackQueue)
m_incomingSyncMessageCallbackQueue = WorkQueue::create("com.apple.WebKit.IPC.IncomingSyncMessageCallbackQueue");
m_incomingSyncMessageCallbacks.add(m_nextIncomingSyncMessageCallbackID, WTFMove(callback));
return m_nextIncomingSyncMessageCallbackID;
}
void Connection::uninstallIncomingSyncMessageCallback(uint64_t callbackID)
{
std::lock_guard<Lock> lock(m_incomingSyncMessageCallbackMutex);
m_incomingSyncMessageCallbacks.remove(callbackID);
}
bool Connection::hasIncomingSyncMessage()
{
std::lock_guard<Lock> lock(m_incomingMessagesMutex);
for (auto& message : m_incomingMessages) {
if (message->isSyncMessage())
return true;
}
return false;
}
void Connection::enableIncomingMessagesThrottling()
{
if (m_incomingMessagesThrottler)
return;
m_incomingMessagesThrottler = std::make_unique<MessagesThrottler>(*this, &Connection::dispatchIncomingMessages);
}
void Connection::postConnectionDidCloseOnConnectionWorkQueue()
{
m_connectionQueue->dispatch([protectedThis = makeRef(*this)]() mutable {
protectedThis->connectionDidClose();
});
}
void Connection::connectionDidClose()
{
platformInvalidate();
{
LockHolder locker(m_replyHandlersLock);
for (auto& replyHandler : m_replyHandlers.values()) {
replyHandler.dispatcher->dispatch([handler = WTFMove(replyHandler.handler)] {
handler(nullptr);
});
}
m_replyHandlers.clear();
}
{
LockHolder locker(m_syncReplyStateMutex);
ASSERT(m_shouldWaitForSyncReplies);
m_shouldWaitForSyncReplies = false;
if (!m_pendingSyncReplies.isEmpty())
SyncMessageState::singleton().wakeUpClientRunLoop();
}
{
std::lock_guard<Lock> lock(m_waitForMessageMutex);
if (m_waitingForMessage)
m_waitingForMessage->messageWaitingInterrupted = true;
}
m_waitForMessageCondition.notifyAll();
if (m_didCloseOnConnectionWorkQueueCallback)
m_didCloseOnConnectionWorkQueueCallback(this);
RunLoop::main().dispatch([protectedThis = makeRef(*this)]() mutable {
if (!protectedThis->isValid())
return;
protectedThis->m_isValid = false;
protectedThis->m_client.didClose(protectedThis.get());
});
}
bool Connection::canSendOutgoingMessages() const
{
return m_isConnected && platformCanSendOutgoingMessages();
}
void Connection::sendOutgoingMessages()
{
if (!canSendOutgoingMessages())
return;
while (true) {
std::unique_ptr<Encoder> message;
{
std::lock_guard<Lock> lock(m_outgoingMessagesMutex);
if (m_outgoingMessages.isEmpty())
break;
message = m_outgoingMessages.takeFirst();
}
if (!sendOutgoingMessage(WTFMove(message)))
break;
}
}
void Connection::dispatchSyncMessage(Decoder& decoder)
{
ASSERT(decoder.isSyncMessage());
uint64_t syncRequestID = 0;
if (!decoder.decode(syncRequestID) || !syncRequestID) {
decoder.markInvalid();
return;
}
auto replyEncoder = std::make_unique<Encoder>("IPC", "SyncMessageReply", syncRequestID);
if (decoder.messageReceiverName() == "IPC" && decoder.messageName() == "WrappedAsyncMessageForTesting") {
if (!m_fullySynchronousModeIsAllowedForTesting) {
decoder.markInvalid();
return;
}
std::unique_ptr<Decoder> unwrappedDecoder = Decoder::unwrapForTesting(decoder);
RELEASE_ASSERT(unwrappedDecoder);
processIncomingMessage(WTFMove(unwrappedDecoder));
SyncMessageState::singleton().dispatchMessages(nullptr);
} else {
m_client.didReceiveSyncMessage(*this, decoder, replyEncoder);
}
ASSERT(!decoder.isInvalid());
if (replyEncoder)
sendSyncReply(WTFMove(replyEncoder));
}
void Connection::dispatchDidReceiveInvalidMessage(const CString& messageReceiverNameString, const CString& messageNameString)
{
ASSERT(RunLoop::isMain());
if (!isValid())
return;
m_client.didReceiveInvalidMessage(*this, StringReference(messageReceiverNameString.data(), messageReceiverNameString.length()), StringReference(messageNameString.data(), messageNameString.length()));
}
void Connection::didFailToSendSyncMessage()
{
if (!m_shouldExitOnSyncMessageSendFailure)
return;
exit(0);
}
void Connection::enqueueIncomingMessage(std::unique_ptr<Decoder> incomingMessage)
{
{
std::lock_guard<Lock> lock(m_incomingMessagesMutex);
#if PLATFORM(COCOA)
if (m_wasKilled)
return;
if (m_incomingMessages.size() >= maxPendingIncomingMessagesKillingThreshold) {
if (kill()) {
RELEASE_LOG_ERROR(IPC, "%p - Connection::enqueueIncomingMessage: Over %zu incoming messages have been queued without the main thread processing them, killing the connection as the remote process seems to be misbehaving", this, maxPendingIncomingMessagesKillingThreshold);
m_incomingMessages.clear();
}
return;
}
#endif
m_incomingMessages.append(WTFMove(incomingMessage));
if (m_incomingMessagesThrottler && m_incomingMessages.size() != 1)
return;
}
RunLoop::main().dispatch([protectedThis = makeRef(*this)]() mutable {
if (protectedThis->m_incomingMessagesThrottler)
protectedThis->dispatchIncomingMessages();
else
protectedThis->dispatchOneIncomingMessage();
});
}
void Connection::dispatchMessage(Decoder& decoder)
{
RELEASE_ASSERT(isValid());
if (decoder.messageReceiverName() == "AsyncReply") {
Optional<uint64_t> listenerID;
decoder >> listenerID;
if (!listenerID) {
ASSERT_NOT_REACHED();
return;
}
auto handler = takeAsyncReplyHandler(*this, *listenerID);
if (!handler) {
ASSERT_NOT_REACHED();
return;
}
handler(&decoder);
return;
}
m_client.didReceiveMessage(*this, decoder);
}
void Connection::dispatchMessage(std::unique_ptr<Decoder> message)
{
if (!isValid())
return;
if (message->shouldUseFullySynchronousModeForTesting()) {
if (!m_fullySynchronousModeIsAllowedForTesting) {
m_client.didReceiveInvalidMessage(*this, message->messageReceiverName(), message->messageName());
return;
}
m_inDispatchMessageMarkedToUseFullySynchronousModeForTesting++;
}
m_inDispatchMessageCount++;
if (message->shouldDispatchMessageWhenWaitingForSyncReply())
m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount++;
bool oldDidReceiveInvalidMessage = m_didReceiveInvalidMessage;
m_didReceiveInvalidMessage = false;
if (message->isSyncMessage())
dispatchSyncMessage(*message);
else
dispatchMessage(*message);
m_didReceiveInvalidMessage |= message->isInvalid();
m_inDispatchMessageCount--;
if (message->shouldDispatchMessageWhenWaitingForSyncReply())
m_inDispatchMessageMarkedDispatchWhenWaitingForSyncReplyCount--;
if (message->shouldUseFullySynchronousModeForTesting())
m_inDispatchMessageMarkedToUseFullySynchronousModeForTesting--;
if (m_didReceiveInvalidMessage && isValid())
m_client.didReceiveInvalidMessage(*this, message->messageReceiverName(), message->messageName());
m_didReceiveInvalidMessage = oldDidReceiveInvalidMessage;
}
Connection::MessagesThrottler::MessagesThrottler(Connection& connection, DispatchMessagesFunction dispatchMessages)
: m_dispatchMessagesTimer(RunLoop::main(), &connection, dispatchMessages)
, m_connection(connection)
, m_dispatchMessages(dispatchMessages)
{
ASSERT(RunLoop::isMain());
}
void Connection::MessagesThrottler::scheduleMessagesDispatch()
{
ASSERT(RunLoop::isMain());
if (m_throttlingLevel) {
m_dispatchMessagesTimer.startOneShot(0_s);
return;
}
RunLoop::main().dispatch([this, protectedConnection = makeRefPtr(&m_connection)]() mutable {
(protectedConnection.get()->*m_dispatchMessages)();
});
}
size_t Connection::MessagesThrottler::numberOfMessagesToProcess(size_t totalMessages)
{
ASSERT(RunLoop::isMain());
static const size_t maxIncomingMessagesDispatchingBatchSize { 600 };
static const unsigned maxThrottlingLevel = 9;
size_t batchSize = maxIncomingMessagesDispatchingBatchSize / (m_throttlingLevel + 1);
if (totalMessages > maxIncomingMessagesDispatchingBatchSize)
m_throttlingLevel = std::min(m_throttlingLevel + 1, maxThrottlingLevel);
else if (m_throttlingLevel)
--m_throttlingLevel;
return std::min(totalMessages, batchSize);
}
void Connection::dispatchOneIncomingMessage()
{
std::unique_ptr<Decoder> message;
{
std::lock_guard<Lock> lock(m_incomingMessagesMutex);
if (m_incomingMessages.isEmpty())
return;
message = m_incomingMessages.takeFirst();
}
dispatchMessage(WTFMove(message));
}
void Connection::dispatchIncomingMessages()
{
ASSERT(RunLoop::isMain());
std::unique_ptr<Decoder> message;
size_t messagesToProcess = 0;
{
std::lock_guard<Lock> lock(m_incomingMessagesMutex);
if (m_incomingMessages.isEmpty())
return;
message = m_incomingMessages.takeFirst();
messagesToProcess = m_incomingMessagesThrottler->numberOfMessagesToProcess(m_incomingMessages.size());
if (messagesToProcess < m_incomingMessages.size()) {
RELEASE_LOG_ERROR(IPC, "%p - Connection::dispatchIncomingMessages: IPC throttling was triggered (has %zu pending incoming messages, will only process %zu before yielding)", this, m_incomingMessages.size(), messagesToProcess);
#if PLATFORM(COCOA)
RELEASE_LOG_ERROR(IPC, "%p - Connection::dispatchIncomingMessages: first IPC message in queue is %{public}s::%{public}s", this, message->messageReceiverName().toString().data(), message->messageName().toString().data());
#endif
}
if (!m_incomingMessages.isEmpty())
m_incomingMessagesThrottler->scheduleMessagesDispatch();
}
dispatchMessage(WTFMove(message));
for (size_t i = 1; i < messagesToProcess; ++i) {
{
std::lock_guard<Lock> lock(m_incomingMessagesMutex);
if (m_incomingMessages.isEmpty())
return;
message = m_incomingMessages.takeFirst();
}
dispatchMessage(WTFMove(message));
}
}
uint64_t nextAsyncReplyHandlerID()
{
static uint64_t identifier { 0 };
return ++identifier;
}
void addAsyncReplyHandler(Connection& connection, uint64_t identifier, CompletionHandler<void(Decoder*)>&& completionHandler)
{
auto result = asyncReplyHandlerMap().ensure(reinterpret_cast<uintptr_t>(&connection), [] {
return HashMap<uint64_t, CompletionHandler<void(Decoder*)>>();
}).iterator->value.add(identifier, WTFMove(completionHandler));
ASSERT_UNUSED(result, result.isNewEntry);
}
CompletionHandler<void(Decoder*)> takeAsyncReplyHandler(Connection& connection, uint64_t identifier)
{
auto iterator = asyncReplyHandlerMap().find(reinterpret_cast<uintptr_t>(&connection));
if (iterator != asyncReplyHandlerMap().end()) {
if (!iterator->value.isValidKey(identifier)) {
ASSERT_NOT_REACHED();
connection.markCurrentlyDispatchedMessageAsInvalid();
return nullptr;
}
ASSERT(iterator->value.contains(identifier));
return iterator->value.take(identifier);
}
ASSERT_NOT_REACHED();
return nullptr;
}
void Connection::wakeUpRunLoop()
{
RunLoop::main().wakeUp();
}
}