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
195
196
197
198
199
200
201
|
/*
* Copyright (C) 2010-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 "Encoder.h"
#include "ArgumentCoders.h"
#include "MessageFlags.h"
#include <algorithm>
#include <wtf/OptionSet.h>
#include <wtf/StdLibExtras.h>
#include <wtf/TZoneMallocInlines.h>
#include <wtf/UniqueRef.h>
#if OS(DARWIN)
#include <wtf/Mmap.h>
#endif
namespace IPC {
static constexpr uint8_t defaultMessageFlags = 0;
#if OS(DARWIN)
static inline MallocSpan<uint8_t, Mmap> allocateBuffer(size_t size)
{
auto buffer = MallocSpan<uint8_t, Mmap>::mmap(size, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE, -1);
RELEASE_ASSERT(!!buffer);
return buffer;
}
#else
static inline MallocSpan<uint8_t> allocateBuffer(size_t size)
{
return MallocSpan<uint8_t>::malloc(size);
}
#endif
WTF_MAKE_TZONE_ALLOCATED_IMPL(Encoder);
Encoder::Encoder(MessageName messageName, uint64_t destinationID)
: m_messageName(messageName)
, m_destinationID(destinationID)
{
encodeHeader();
}
// FIXME: We need to dispose of the attachments in cases of failure.
Encoder::~Encoder() = default;
void Encoder::setShouldDispatchMessageWhenWaitingForSyncReply(ShouldDispatchWhenWaitingForSyncReply shouldDispatchWhenWaitingForSyncReply)
{
switch (shouldDispatchWhenWaitingForSyncReply) {
case ShouldDispatchWhenWaitingForSyncReply::No:
messageFlags().remove(MessageFlags::DispatchMessageWhenWaitingForSyncReply);
messageFlags().remove(MessageFlags::DispatchMessageWhenWaitingForUnboundedSyncReply);
break;
case ShouldDispatchWhenWaitingForSyncReply::Yes:
messageFlags().add(MessageFlags::DispatchMessageWhenWaitingForSyncReply);
messageFlags().remove(MessageFlags::DispatchMessageWhenWaitingForUnboundedSyncReply);
break;
case ShouldDispatchWhenWaitingForSyncReply::YesDuringUnboundedIPC:
messageFlags().remove(MessageFlags::DispatchMessageWhenWaitingForSyncReply);
messageFlags().add(MessageFlags::DispatchMessageWhenWaitingForUnboundedSyncReply);
break;
}
}
bool Encoder::isFullySynchronousModeForTesting() const
{
return messageFlags().contains(MessageFlags::UseFullySynchronousModeForTesting);
}
void Encoder::setFullySynchronousModeForTesting()
{
messageFlags().add(MessageFlags::UseFullySynchronousModeForTesting);
}
void Encoder::setShouldMaintainOrderingWithAsyncMessages()
{
messageFlags().add(MessageFlags::MaintainOrderingWithAsyncMessages);
}
void Encoder::wrapForTesting(UniqueRef<Encoder>&& original)
{
ASSERT(isSyncMessage());
ASSERT(!original->isSyncMessage());
original->setShouldDispatchMessageWhenWaitingForSyncReply(ShouldDispatchWhenWaitingForSyncReply::Yes);
*this << original->span();
auto attachments = original->releaseAttachments();
reserve(attachments.size());
for (auto&& attachment : WTFMove(attachments))
addAttachment(WTFMove(attachment));
}
static inline size_t roundUpToAlignment(size_t value, size_t alignment)
{
return ((value + alignment - 1) / alignment) * alignment;
}
void Encoder::reserve(size_t size)
{
auto oldCapacityBufferSize = capacityBuffer().size();
if (size <= oldCapacityBufferSize)
return;
size_t newCapacity = roundUpToAlignment(oldCapacityBufferSize * 2, 4096);
while (newCapacity < size)
newCapacity *= 2;
auto newBuffer = allocateBuffer(newCapacity);
memcpySpan(newBuffer.mutableSpan(), span());
m_outOfLineBuffer = WTFMove(newBuffer);
}
void Encoder::encodeHeader()
{
*this << defaultMessageFlags;
*this << m_messageName;
*this << m_destinationID;
}
OptionSet<MessageFlags>& Encoder::messageFlags()
{
// FIXME: We should probably pass an OptionSet<MessageFlags> into the Encoder constructor instead of encoding defaultMessageFlags then using this to change it later.
static_assert(sizeof(OptionSet<MessageFlags>::StorageType) == 1, "Encoder uses the first byte of the buffer for message flags.");
return reinterpretCastSpanStartTo<OptionSet<MessageFlags>>(capacityBuffer());
}
const OptionSet<MessageFlags>& Encoder::messageFlags() const
{
return reinterpretCastSpanStartTo<OptionSet<MessageFlags>>(capacityBuffer());
}
std::span<uint8_t> Encoder::grow(size_t alignment, size_t size)
{
size_t alignedSize = roundUpToAlignment(m_bufferSize, alignment);
reserve(alignedSize + size);
auto capacityBuffer = this->capacityBuffer();
zeroSpan(capacityBuffer.subspan(m_bufferSize, alignedSize - m_bufferSize));
m_bufferSize = alignedSize + size;
return capacityBuffer.subspan(alignedSize);
}
std::span<uint8_t> Encoder::capacityBuffer()
{
if (m_outOfLineBuffer)
return m_outOfLineBuffer.mutableSpan();
return m_inlineBuffer;
}
std::span<const uint8_t> Encoder::capacityBuffer() const
{
if (m_outOfLineBuffer)
return m_outOfLineBuffer.span();
return m_inlineBuffer;
}
void Encoder::addAttachment(Attachment&& attachment)
{
m_attachments.append(WTFMove(attachment));
}
Vector<Attachment> Encoder::releaseAttachments()
{
return std::exchange(m_attachments, { });
}
bool Encoder::hasAttachments() const
{
return !m_attachments.isEmpty();
}
} // namespace IPC
|
