Repository navigation
Expand file tree
/
Copy pathBytecodeRewriter.h
More file actions
265 lines (230 loc) · 9.54 KB
/
Copy pathBytecodeRewriter.h
File metadata and controls
265 lines (230 loc) · 9.54 KB
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/*
* Copyright (C) 2016 Yusuke Suzuki <utatane.tea@gmail.com>
* Copyright (C) 2016-2024 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 "BytecodeGenerator.h"
#include "BytecodeGraph.h"
#include "BytecodeStructs.h"
#include "Bytecodes.h"
#include "Opcode.h"
#include "UnlinkedCodeBlock.h"
#include <wtf/Insertion.h>
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
namespace JSC {
// BytecodeRewriter offers the ability to insert and remove the bytecodes including jump operations.
//
// We use the original bytecode offsets as labels. When you emit some jumps, you can specify the jump target by
// using the original bytecode offsets. These bytecode offsets are later converted appropriate values by the
// rewriter. And we also use the labels to represents the position the new bytecodes inserted.
//
// | [bytecode] | [bytecode] |
// offsets A B C
//
// We can use the above "A", "B", and "C" offsets as labels. And the rewriter has the ability to insert bytecode fragments
// before and after the label. For example, if you insert the fragment after "B", the layout becomes like this.
//
// | [bytecode] | [fragment] [bytecode] |
// offsets A B C
//
// And even if you remove some original bytecodes, the offset remains as labels. For example, when you remove the A's bytecode,
// the layout becomes like this.
//
// | | [bytecode] |
// offsets A B C
//
// And still you can insert fragments before and after "A".
//
// | [fragment] | [bytecode] |
// offsets A B C
//
// We can insert bytecode fragments "Before" and "After" the labels. This inserted position, either "Before" and "After",
// has effect when the label is involved with jumps. For example, when you have jump to the position "B",
//
// | [bytecode] | [bytecode] |
// offsets A B C
// ^
// jump to here.
//
// and you insert the bytecode before/after "B",
//
// | [bytecode] [before] | [after] [bytecode] |
// offsets A B C
// ^
// jump to here.
//
// as you can see, the execution jumping into "B" does not execute [before] code.
class BytecodeRewriter {
WTF_MAKE_NONCOPYABLE(BytecodeRewriter);
public:
enum class Position : int8_t {
Entrypoint = -2,
Before = -1,
LabelPoint = 0,
After = 1,
OriginalBytecodePoint = 2,
};
enum class IncludeBranch : uint8_t {
No = 0,
Yes = 1,
};
struct InsertionPoint {
int32_t bytecodeOffset;
Position position;
InsertionPoint(JSInstructionStream::Offset offset, Position pos)
: bytecodeOffset(offset)
, position(pos)
{
}
bool operator<(const InsertionPoint& other) const
{
if (bytecodeOffset == other.bytecodeOffset)
return position < other.position;
return bytecodeOffset < other.bytecodeOffset;
}
friend bool operator==(const InsertionPoint&, const InsertionPoint&) = default;
};
private:
struct Insertion {
enum class Type : uint8_t { Insert = 0, Remove = 1, };
size_t length() const
{
if (type == Type::Remove)
return removeLength;
return instructions.size();
}
InsertionPoint index;
Type type;
IncludeBranch includeBranch;
size_t removeLength;
JSInstructionStreamWriter instructions;
};
public:
class Fragment {
WTF_MAKE_NONCOPYABLE(Fragment);
public:
Fragment(BytecodeGenerator& bytecodeGenerator, JSInstructionStreamWriter& writer, IncludeBranch& includeBranch)
: m_bytecodeGenerator(bytecodeGenerator)
, m_writer(writer)
, m_includeBranch(includeBranch)
{
}
template<class Op, class... Args>
void appendInstruction(Args... args)
{
if (isBranch(Op::opcodeID))
m_includeBranch = IncludeBranch::Yes;
m_bytecodeGenerator.withWriter(m_writer, [&] {
Op::emit(&m_bytecodeGenerator, std::forward<Args>(args)...);
});
}
private:
BytecodeGenerator& m_bytecodeGenerator;
JSInstructionStreamWriter& m_writer;
IncludeBranch& m_includeBranch;
};
BytecodeRewriter(BytecodeGenerator& bytecodeGenerator, BytecodeGraph& graph, UnlinkedCodeBlockGenerator* codeBlock, JSInstructionStreamWriter& writer)
: m_bytecodeGenerator(bytecodeGenerator)
, m_graph(graph)
, m_codeBlock(codeBlock)
, m_writer(writer)
{
}
template<class Function>
void insertFragmentBefore(const JSInstructionStream::Ref& instruction, Function function)
{
IncludeBranch includeBranch = IncludeBranch::No;
JSInstructionStreamWriter writer;
Fragment fragment(m_bytecodeGenerator, writer, includeBranch);
function(fragment);
insertImpl(InsertionPoint(instruction.offset(), Position::Before), includeBranch, WTF::move(writer));
}
template<class Function>
void insertFragmentAfter(const JSInstructionStream::Ref& instruction, Function function)
{
IncludeBranch includeBranch = IncludeBranch::No;
JSInstructionStreamWriter writer;
Fragment fragment(m_bytecodeGenerator, writer, includeBranch);
function(fragment);
insertImpl(InsertionPoint(instruction.offset(), Position::After), includeBranch, WTF::move(writer));
}
template<class Function>
void replaceBytecodeWithFragment(const JSInstructionStream::Ref& instruction, Function function)
{
m_insertions.append(Insertion { InsertionPoint(instruction.offset(), Position::OriginalBytecodePoint), Insertion::Type::Remove, IncludeBranch::No, instruction->size(), { } });
insertFragmentAfter(instruction, function);
}
void execute();
BytecodeGraph& graph() { return m_graph; }
int32_t adjustAbsoluteOffset(JSInstructionStream::Offset absoluteOffset)
{
return adjustJumpTarget(InsertionPoint(0, Position::Entrypoint), InsertionPoint(absoluteOffset, Position::LabelPoint));
}
int32_t adjustJumpTarget(JSInstructionStream::Offset originalBytecodeOffset, int32_t originalJumpTarget)
{
return adjustJumpTarget(InsertionPoint(originalBytecodeOffset, Position::LabelPoint), InsertionPoint(originalJumpTarget, Position::LabelPoint));
}
void adjustJumpTargets();
template<typename Func>
void forEachLabelPoint(Func);
private:
void insertImpl(InsertionPoint, IncludeBranch, JSInstructionStreamWriter&& fragment);
friend class UnlinkedCodeBlockGenerator;
void applyModification();
void adjustJumpTargetsInFragment(unsigned finalOffset, Insertion&);
int adjustJumpTarget(InsertionPoint startPoint, InsertionPoint jumpTargetPoint);
template<typename Iterator> int calculateDifference(Iterator begin, Iterator end);
BytecodeGenerator& m_bytecodeGenerator;
BytecodeGraph& m_graph;
UnlinkedCodeBlockGenerator* m_codeBlock;
JSInstructionStreamWriter& m_writer;
Vector<Insertion, 8> m_insertions;
};
template<typename Iterator>
inline int BytecodeRewriter::calculateDifference(Iterator begin, Iterator end)
{
int result = 0;
for (; begin != end; ++begin) {
if (begin->type == Insertion::Type::Remove)
result -= begin->length();
else
result += begin->length();
}
return result;
}
template<typename Func>
void BytecodeRewriter::forEachLabelPoint(Func func)
{
int32_t previousBytecodeOffset = -1;
for (size_t i = 0; i < m_insertions.size(); ++i) {
Insertion& insertion = m_insertions[i];
int32_t bytecodeOffset = insertion.index.bytecodeOffset;
if (bytecodeOffset == previousBytecodeOffset)
continue;
previousBytecodeOffset = bytecodeOffset;
func(bytecodeOffset);
}
}
} // namespace JSC
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END