1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* Copyright (C) 2020 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "StreamClientConnection.h"
#include <wtf/TZoneMallocInlines.h>
namespace IPC {
WTF_MAKE_TZONE_ALLOCATED_IMPL(StreamClientConnection);
// FIXME(http://webkit.org/b/238986): Workaround for not being able to deliver messages from the dedicated connection to the work queue the client uses.
StreamClientConnection::DedicatedConnectionClient::DedicatedConnectionClient(StreamClientConnection& owner, Connection::Client& receiver)
: m_owner(owner)
, m_receiver(receiver)
{
}
void StreamClientConnection::DedicatedConnectionClient::didReceiveMessage(Connection& connection, Decoder& decoder)
{
m_receiver.didReceiveMessage(connection, decoder);
}
bool StreamClientConnection::DedicatedConnectionClient::didReceiveSyncMessage(Connection& connection, Decoder& decoder, UniqueRef<Encoder>& replyEncoder)
{
return m_receiver.didReceiveSyncMessage(connection, decoder, replyEncoder);
}
void StreamClientConnection::DedicatedConnectionClient::didClose(Connection& connection)
{
// Client is expected to listen to Connection::didClose() from the connection it sent to the dedicated connection to.
m_receiver.didClose(connection);
}
void StreamClientConnection::DedicatedConnectionClient::didReceiveInvalidMessage(Connection&, MessageName, int32_t)
{
ASSERT_NOT_REACHED(); // The sender is expected to be trusted, so all invalid messages are programming errors.
}
std::optional<StreamClientConnection::StreamConnectionPair> StreamClientConnection::create(unsigned bufferSizeLog2, Seconds defaultTimeoutDuration)
{
auto connectionIdentifiers = Connection::createConnectionIdentifierPair();
if (!connectionIdentifiers)
return std::nullopt;
auto buffer = StreamClientConnectionBuffer::create(bufferSizeLog2);
if (!buffer)
return std::nullopt;
// Create StreamClientConnection with "server" type Connection. The caller will send the "client" type connection identifier via
// IPC to the other side, where StreamServerConnection will be created with "client" type Connection.
// For Connection, "server" means the connection which was created first, the connection which is not sent through IPC to other party.
// For Connection, "client" means the connection which was established by receiving it through IPC and creating IPC::Connection out from the identifier.
// The "Client" in StreamClientConnection means the party that mostly does sending, e.g. untrusted party.
// The "Server" in StreamServerConnection means the party that mostly does receiving, e.g. the trusted party which holds the destination object to communicate with.
auto dedicatedConnection = Connection::createServerConnection(WTFMove(connectionIdentifiers->server));
auto clientConnection = adoptRef(*new StreamClientConnection(WTFMove(dedicatedConnection), WTFMove(*buffer), defaultTimeoutDuration));
StreamServerConnection::Handle serverHandle {
WTFMove(connectionIdentifiers->client),
clientConnection->m_buffer.createHandle()
};
return StreamClientConnection::StreamConnectionPair { WTFMove(clientConnection), WTFMove(serverHandle) };
}
StreamClientConnection::StreamClientConnection(Ref<Connection> connection, StreamClientConnectionBuffer&& buffer, Seconds defaultTimeoutDuration)
: m_connection(WTFMove(connection))
, m_buffer(WTFMove(buffer))
, m_defaultTimeoutDuration(defaultTimeoutDuration)
{
}
StreamClientConnection::~StreamClientConnection()
{
ASSERT(!m_connection->isValid());
}
void StreamClientConnection::setSemaphores(IPC::Semaphore&& wakeUp, IPC::Semaphore&& clientWait)
{
m_buffer.setSemaphores(WTFMove(wakeUp), WTFMove(clientWait));
}
bool StreamClientConnection::hasSemaphores() const
{
return m_buffer.hasSemaphores();
}
void StreamClientConnection::setMaxBatchSize(unsigned size)
{
m_maxBatchSize = size;
m_buffer.wakeUpServer();
}
void StreamClientConnection::open(Connection::Client& receiver, SerialFunctionDispatcher& dispatcher)
{
m_dedicatedConnectionClient.emplace(*this, receiver);
protectedConnection()->open(*m_dedicatedConnectionClient, dispatcher);
}
Error StreamClientConnection::flushSentMessages()
{
auto timeout = defaultTimeout();
wakeUpServer(WakeUpServer::Yes);
return protectedConnection()->flushSentMessages(WTFMove(timeout));
}
void StreamClientConnection::invalidate()
{
protectedConnection()->invalidate();
}
void StreamClientConnection::wakeUpServer(WakeUpServer wakeUpResult)
{
if (wakeUpResult == WakeUpServer::No && !m_batchSize)
return;
m_buffer.wakeUpServer();
m_batchSize = 0;
}
void StreamClientConnection::wakeUpServerBatched(WakeUpServer wakeUpResult)
{
if (wakeUpResult == WakeUpServer::Yes || m_batchSize) {
m_batchSize++;
if (m_batchSize >= m_maxBatchSize)
wakeUpServer(WakeUpServer::Yes);
}
}
StreamClientConnectionBuffer& StreamClientConnection::bufferForTesting()
{
return m_buffer;
}
Connection& StreamClientConnection::connectionForTesting()
{
return m_connection.get();
}
void StreamClientConnection::addWorkQueueMessageReceiver(ReceiverName name, WorkQueue& workQueue, WorkQueueMessageReceiverBase& receiver, uint64_t destinationID)
{
protectedConnection()->addWorkQueueMessageReceiver(name, workQueue, receiver, destinationID);
}
void StreamClientConnection::removeWorkQueueMessageReceiver(ReceiverName name, uint64_t destinationID)
{
protectedConnection()->removeWorkQueueMessageReceiver(name, destinationID);
}
}
|
