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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/*
* 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.
*/
#pragma once
#include "Connection.h"
#include "Decoder.h"
#include "Encoder.h"
#include "MessageNames.h"
#include "StreamMessageReceiver.h"
#include "StreamServerConnectionBuffer.h"
#include <wtf/Deque.h>
#include <wtf/Lock.h>
#include <wtf/Threading.h>
namespace IPC {
class StreamConnectionWorkQueue;
struct StreamServerConnectionHandle {
WTF_MAKE_NONCOPYABLE(StreamServerConnectionHandle);
StreamServerConnectionHandle(Connection::Handle&& connection, StreamConnectionBuffer::Handle&& bufferHandle)
: outOfStreamConnection(WTFMove(connection))
, buffer(WTFMove(bufferHandle))
{ }
StreamServerConnectionHandle(StreamServerConnectionHandle&&) = default;
StreamServerConnectionHandle& operator=(StreamServerConnectionHandle&&) = default;
Connection::Handle outOfStreamConnection;
StreamConnectionBuffer::Handle buffer;
};
struct StreamServerConnectionParameters {
#if ENABLE(IPC_TESTING_API)
bool ignoreInvalidMessageForTesting { false };
#endif
};
// StreamServerConnection represents the connection between stream client and server, as used by the server.
//
// StreamServerConnection:
// * Holds the messages towards the server.
// * Sends the replies back to the client via the stream or normal Connection fallback.
//
// Receiver template contract:
// void didReceiveStreamMessage(StreamServerConnection&, Decoder&);
//
// The StreamServerConnection does not trust the StreamClientConnection.
class StreamServerConnection final : public ThreadSafeRefCounted<StreamServerConnection>, private MessageReceiveQueue, private Connection::Client {
WTF_MAKE_NONCOPYABLE(StreamServerConnection);
WTF_MAKE_FAST_ALLOCATED;
WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(StreamServerConnection);
public:
using AsyncReplyID = Connection::AsyncReplyID;
using Handle = StreamServerConnectionHandle;
static RefPtr<StreamServerConnection> tryCreate(Handle&&, const StreamServerConnectionParameters&);
~StreamServerConnection() final;
void ref() const final { ThreadSafeRefCounted::ref(); }
void deref() const final { ThreadSafeRefCounted::deref(); }
void startReceivingMessages(StreamMessageReceiver&, ReceiverName, uint64_t destinationID);
// Stops the message receipt. Note: already received messages might still be delivered.
void stopReceivingMessages(ReceiverName, uint64_t destinationID);
Connection& connection() { return m_connection; }
Ref<Connection> protectedConnection() { return m_connection; }
enum DispatchResult : bool {
HasNoMessages,
HasMoreMessages
};
DispatchResult dispatchStreamMessages(size_t messageLimit);
void markCurrentlyDispatchedMessageAsInvalid();
void open(StreamConnectionWorkQueue&);
void invalidate();
template<typename T, typename RawValue> Error send(T&& message, const ObjectIdentifierGenericBase<RawValue>& destinationID);
template<typename T, typename... Arguments>
void sendSyncReply(Connection::SyncRequestID, Arguments&&...);
#if ENABLE(IPC_TESTING_API)
void setIgnoreInvalidMessageForTesting() { m_connection->setIgnoreInvalidMessageForTesting(); }
bool ignoreInvalidMessageForTesting() const { return m_connection->ignoreInvalidMessageForTesting(); }
#endif
template<typename T, typename... Arguments>
void sendAsyncReply(AsyncReplyID, Arguments&&...);
Semaphore& clientWaitSemaphore() { return m_clientWaitSemaphore; }
private:
StreamServerConnection(Ref<Connection>, StreamServerConnectionBuffer&&);
// MessageReceiveQueue
void enqueueMessage(Connection&, UniqueRef<Decoder>&&) final;
// Connection::Client
void didReceiveMessage(Connection&, Decoder&) final;
bool didReceiveSyncMessage(Connection&, Decoder&, UniqueRef<Encoder>&) final;
void didClose(Connection&) final;
void didReceiveInvalidMessage(Connection&, MessageName, int32_t indexOfObjectFailingDecoding) final;
bool processSetStreamDestinationID(Decoder&, RefPtr<StreamMessageReceiver>& currentReceiver);
bool processStreamMessage(Decoder&, StreamMessageReceiver&);
bool processOutOfStreamMessage(Decoder&);
bool dispatchStreamMessage(Decoder&, StreamMessageReceiver&);
RefPtr<StreamConnectionWorkQueue> protectedWorkQueue() const;
using WakeUpClient = StreamServerConnectionBuffer::WakeUpClient;
const Ref<IPC::Connection> m_connection;
RefPtr<StreamConnectionWorkQueue> m_workQueue;
StreamServerConnectionBuffer m_buffer;
Lock m_outOfStreamMessagesLock;
Deque<UniqueRef<Decoder>> m_outOfStreamMessages WTF_GUARDED_BY_LOCK(m_outOfStreamMessagesLock);
bool m_isProcessingStreamMessage { false };
std::unique_ptr<IPC::Encoder> m_syncReplyToDispatch;
Lock m_receiversLock;
using ReceiversMap = HashMap<std::pair<uint8_t, uint64_t>, Ref<StreamMessageReceiver>>;
ReceiversMap m_receivers WTF_GUARDED_BY_LOCK(m_receiversLock);
uint64_t m_currentDestinationID { 0 };
Semaphore m_clientWaitSemaphore;
bool m_didReceiveInvalidMessage { false };
friend class StreamConnectionWorkQueue;
};
template<typename T, typename RawValue>
Error StreamServerConnection::send(T&& message, const ObjectIdentifierGenericBase<RawValue>& destinationID)
{
return m_connection->send(std::forward<T>(message), destinationID);
}
template<typename T, typename... Arguments>
void StreamServerConnection::sendSyncReply(Connection::SyncRequestID syncRequestID, Arguments&&... arguments)
{
if constexpr(T::isReplyStreamEncodable) {
if (m_isProcessingStreamMessage) {
auto span = m_buffer.acquireAll();
{
StreamConnectionEncoder messageEncoder { MessageName::SyncMessageReply, span };
if ((messageEncoder << ... << arguments))
return;
}
StreamConnectionEncoder outOfStreamEncoder { MessageName::ProcessOutOfStreamMessage, span };
}
}
auto encoder = makeUniqueRef<Encoder>(MessageName::SyncMessageReply, syncRequestID.toUInt64());
(encoder.get() << ... << std::forward<Arguments>(arguments));
if (m_isProcessingStreamMessage) {
// Send sync reply only after releasing the buffer. Otherwise client might receive the message before server
// releases the buffer. Client would the send a new message, and release would happen only after.
m_syncReplyToDispatch = encoder.moveToUniquePtr();
} else {
// Asynchronously replying from the current thread is supported. Note: This is not thread safe,
// as any other thread might execute before the buffer release.
m_connection->sendSyncReply(WTFMove(encoder));
}
}
template<typename T, typename... Arguments>
void StreamServerConnection::sendAsyncReply(AsyncReplyID asyncReplyID, Arguments&&... arguments)
{
m_connection->sendAsyncReply<T>(asyncReplyID, std::forward<Arguments>(arguments)...);
}
}
|
