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
|
/*
* 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 "IPCSemaphore.h"
#include "MessageNames.h"
#include "StreamConnectionBuffer.h"
#include "StreamConnectionEncoder.h"
#include "StreamMessageReceiver.h"
#include <wtf/Deque.h>
#include <wtf/Lock.h>
#include <wtf/Threading.h>
namespace IPC {
class StreamConnectionWorkQueue;
// 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 {
WTF_MAKE_NONCOPYABLE(StreamServerConnection);
public:
// Creates StreamClientConnection where the out of stream messages and server replies are
// received through the passed IPC::Connection. The messages from the server are sent to
// the passed IPC::Connection.
// Note: This function should be used only in cases where the
// stream server starts listening to messages with new identifiers on the same thread as
// in which the server IPC::Connection dispatch messages. At the time of writing,
// IPC::Connection dispatches messages only in main thread.
static Ref<StreamServerConnection> create(Connection&, StreamConnectionBuffer&&, StreamConnectionWorkQueue&);
// Creates StreamServerConnection where the out of stream messages and server replies are
// received through a dedidcated, new IPC::Connection. The messages from the server are sent to
// the dedicated conneciton.
static Ref<StreamServerConnection> createWithDedicatedConnection(Attachment&& connectionIdentifier, StreamConnectionBuffer&&, StreamConnectionWorkQueue&);
~StreamServerConnection() final;
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; }
enum DispatchResult : bool {
HasNoMessages,
HasMoreMessages
};
DispatchResult dispatchStreamMessages(size_t messageLimit);
void open();
void invalidate();
template<typename T, typename... Arguments>
void sendSyncReply(Connection::SyncRequestID, Arguments&&...);
Semaphore& clientWaitSemaphore() { return m_clientWaitSemaphore; }
private:
enum class HasDedicatedConnection : bool { No, Yes };
StreamServerConnection(Ref<Connection>&&, StreamConnectionBuffer&&, StreamConnectionWorkQueue&, HasDedicatedConnection);
// MessageReceiveQueue
void enqueueMessage(Connection&, std::unique_ptr<Decoder>&&) final;
struct Span {
uint8_t* data;
size_t size;
};
std::optional<Span> tryAcquire();
Span acquireAll();
void release(size_t readSize);
void releaseAll();
static constexpr size_t minimumMessageSize = StreamConnectionEncoder::minimumMessageSize;
static constexpr size_t messageAlignment = StreamConnectionEncoder::messageAlignment;
Span alignedSpan(size_t offset, size_t limit);
size_t size(size_t offset, size_t limit);
size_t wrapOffset(size_t offset) const { return m_buffer.wrapOffset(offset); }
size_t alignOffset(size_t offset) const { return m_buffer.alignOffset<messageAlignment>(offset, minimumMessageSize); }
using ServerLimit = StreamConnectionBuffer::ClientOffset;
Atomic<ServerLimit>& sharedServerLimit() { return m_buffer.clientOffset(); }
using ServerOffset = StreamConnectionBuffer::ServerOffset;
Atomic<ServerOffset>& sharedServerOffset() { return m_buffer.serverOffset(); }
size_t clampedLimit(ServerLimit) const;
uint8_t* data() const { return m_buffer.data(); }
size_t dataSize() const { return m_buffer.dataSize(); }
bool processSetStreamDestinationID(Decoder&&, RefPtr<StreamMessageReceiver>& currentReceiver);
bool dispatchStreamMessage(Decoder&&, StreamMessageReceiver&);
bool dispatchOutOfStreamMessage(Decoder&&);
Ref<IPC::Connection> m_connection;
Semaphore m_clientWaitSemaphore;
StreamConnectionWorkQueue& m_workQueue;
size_t m_serverOffset { 0 };
StreamConnectionBuffer m_buffer;
Lock m_outOfStreamMessagesLock;
Deque<std::unique_ptr<Decoder>> m_outOfStreamMessages WTF_GUARDED_BY_LOCK(m_outOfStreamMessagesLock);
bool m_isDispatchingStreamMessage { false };
const bool m_hasDedicatedConnection;
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 };
friend class StreamConnectionWorkQueue;
};
template<typename T, typename... Arguments>
void StreamServerConnection::sendSyncReply(Connection::SyncRequestID syncRequestID, Arguments&&... arguments)
{
if constexpr(T::isReplyStreamEncodable) {
if (m_isDispatchingStreamMessage) {
auto span = acquireAll();
{
StreamConnectionEncoder messageEncoder { MessageName::SyncMessageReply, span.data, span.size };
if ((messageEncoder << ... << arguments))
return;
}
StreamConnectionEncoder outOfStreamEncoder { MessageName::ProcessOutOfStreamMessage, span.data, span.size };
}
}
auto encoder = makeUniqueRef<Encoder>(MessageName::SyncMessageReply, syncRequestID.toUInt64());
(encoder.get() << ... << std::forward<Arguments>(arguments));
m_connection->sendSyncReply(WTFMove(encoder));
}
}
|
