Repository navigation
Expand file tree
/
Copy pathCallFrame.cpp
More file actions
447 lines (389 loc) · 14 KB
/
Copy pathCallFrame.cpp
File metadata and controls
447 lines (389 loc) · 14 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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
/*
* Copyright (C) 2008-2025 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. ``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
* 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 "CallFrame.h"
#include "CodeBlock.h"
#include "DebuggerCallFrame.h"
#include "ExecutableAllocator.h"
#include "InlineCallFrame.h"
#include "JSCInlines.h"
#include "JSWebAssemblyInstance.h"
#include "JSWebAssemblyModule.h"
#include "LLIntPCRanges.h"
#include "NativeCallee.h"
#include "VMEntryRecord.h"
#include "VMEntryScopeInlines.h"
#include "WasmContext.h"
#include <wtf/StringPrintStream.h>
#include <wtf/URL.h>
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
namespace JSC {
bool CallFrame::callSiteBitsAreBytecodeOffset() const
{
ASSERT(codeBlock());
switch (codeBlock()->jitType()) {
case JITType::InterpreterThunk:
case JITType::BaselineJIT:
return true;
case JITType::None:
case JITType::HostCallThunk:
RELEASE_ASSERT_NOT_REACHED();
return false;
default:
return false;
}
RELEASE_ASSERT_NOT_REACHED();
return false;
}
bool CallFrame::callSiteBitsAreCodeOriginIndex() const
{
ASSERT(codeBlock());
switch (codeBlock()->jitType()) {
case JITType::DFGJIT:
case JITType::FTLJIT:
return true;
case JITType::None:
case JITType::HostCallThunk:
RELEASE_ASSERT_NOT_REACHED();
return false;
default:
return false;
}
RELEASE_ASSERT_NOT_REACHED();
return false;
}
unsigned CallFrame::callSiteAsRawBits() const
{
return this[static_cast<int>(CallFrameSlot::argumentCountIncludingThis)].highWord();
}
SUPPRESS_ASAN unsigned CallFrame::unsafeCallSiteAsRawBits() const
{
return this[static_cast<int>(CallFrameSlot::argumentCountIncludingThis)].unsafeHighWord();
}
CallSiteIndex CallFrame::callSiteIndex() const
{
return CallSiteIndex::fromBits(callSiteAsRawBits());
}
SUPPRESS_ASAN CallSiteIndex CallFrame::unsafeCallSiteIndex() const
{
return CallSiteIndex::fromBits(unsafeCallSiteAsRawBits());
}
const JSInstruction* CallFrame::currentVPC() const
{
ASSERT(callSiteBitsAreBytecodeOffset());
return codeBlock()->instructions().at(callSiteBitsAsBytecodeOffset()).ptr();
}
void CallFrame::setCurrentVPC(const JSInstruction* vpc)
{
CallSiteIndex callSite(codeBlock()->bytecodeIndex(vpc));
this[static_cast<int>(CallFrameSlot::argumentCountIncludingThis)].highWord() = callSite.bits();
ASSERT(currentVPC() == vpc);
}
unsigned CallFrame::callSiteBitsAsBytecodeOffset() const
{
ASSERT(codeBlock());
ASSERT(callSiteBitsAreBytecodeOffset());
return callSiteIndex().bits();
}
BytecodeIndex CallFrame::bytecodeIndex() const
{
if (callee().isNativeCallee())
return callSiteIndex().bytecodeIndex();
if (!codeBlock())
return BytecodeIndex(0);
#if ENABLE(DFG_JIT)
if (callSiteBitsAreCodeOriginIndex()) {
ASSERT(codeBlock());
CodeOrigin codeOrigin = this->codeOrigin();
for (InlineCallFrame* inlineCallFrame = codeOrigin.inlineCallFrame(); inlineCallFrame;) {
codeOrigin = inlineCallFrame->directCaller;
inlineCallFrame = codeOrigin.inlineCallFrame();
}
return codeOrigin.bytecodeIndex();
}
#endif
ASSERT(callSiteBitsAreBytecodeOffset());
return callSiteIndex().bytecodeIndex();
}
CodeOrigin CallFrame::codeOrigin() const
{
if (!codeBlock())
return CodeOrigin(BytecodeIndex(0));
#if ENABLE(DFG_JIT)
if (callSiteBitsAreCodeOriginIndex()) {
CallSiteIndex index = callSiteIndex();
ASSERT(codeBlock()->canGetCodeOrigin(index));
return codeBlock()->codeOrigin(index);
}
#endif
return CodeOrigin(callSiteIndex().bytecodeIndex());
}
Register* CallFrame::topOfFrameInternal()
{
CodeBlock* codeBlock = this->codeBlock();
ASSERT(codeBlock);
return registers() + codeBlock->stackPointerOffset();
}
CallFrame* CallFrame::callerFrame(EntryFrame*& currEntryFrame) const
{
if (callerFrameOrEntryFrame() == currEntryFrame) {
VMEntryRecord* currVMEntryRecord = vmEntryRecord(currEntryFrame);
currEntryFrame = currVMEntryRecord->prevTopEntryFrame();
return currVMEntryRecord->prevTopCallFrame();
}
return static_cast<CallFrame*>(callerFrameOrEntryFrame());
}
SUPPRESS_ASAN CallFrame* CallFrame::unsafeCallerFrame(EntryFrame*& currEntryFrame) const
{
if (unsafeCallerFrameOrEntryFrame() == currEntryFrame) {
VMEntryRecord* currVMEntryRecord = vmEntryRecord(currEntryFrame);
currEntryFrame = currVMEntryRecord->unsafePrevTopEntryFrame();
return currVMEntryRecord->unsafePrevTopCallFrame();
}
return static_cast<CallFrame*>(unsafeCallerFrameOrEntryFrame());
}
SourceOrigin CallFrame::callerSourceOrigin(VM& vm)
{
RELEASE_ASSERT(callee().isCell());
SourceOrigin sourceOrigin;
bool haveSkippedFirstFrame = false;
StackVisitor::visit(this, vm, [&](StackVisitor& visitor) {
if (!std::exchange(haveSkippedFirstFrame, true))
return IterationStatus::Continue;
switch (visitor->codeType()) {
case StackVisitor::Frame::CodeType::Function:
// Skip the builtin functions since they should not pass the source origin to the dynamic code generation calls.
// Consider the following code.
//
// [ "42 + 44" ].forEach(eval);
//
// In the above case, the eval function will be interpreted as the indirect call to eval inside forEach function.
// At that time, the generated eval code should have the source origin to the original caller of the forEach function
// instead of the source origin of the forEach function.
if (static_cast<FunctionExecutable*>(visitor->codeBlock()->ownerExecutable())->isBuiltinFunction())
return IterationStatus::Continue;
[[fallthrough]];
case StackVisitor::Frame::CodeType::Eval:
case StackVisitor::Frame::CodeType::Module:
case StackVisitor::Frame::CodeType::Global:
sourceOrigin = visitor->codeBlock()->ownerExecutable()->sourceOrigin();
return IterationStatus::Done;
case StackVisitor::Frame::CodeType::Native:
return IterationStatus::Continue;
case StackVisitor::Frame::CodeType::Wasm:
// FIXME: Should return the source origin for WASM.
return IterationStatus::Done;
}
RELEASE_ASSERT_NOT_REACHED();
return IterationStatus::Done;
});
return sourceOrigin;
}
JSGlobalObject* CallFrame::globalObjectOfClosestCodeBlock(VM& vm, CallFrame* callFrame)
{
// FIXME: We need to handle JSONP interpretation case in ProgramExecutable since it does not have vm.topCallFrame.
// rdar://83691438
JSGlobalObject* globalObject = nullptr;
StackVisitor::visit(callFrame, vm, [&](StackVisitor& visitor) {
// Note that this is OK for InlineCache Callee.
if (visitor->isNativeCalleeFrame()) {
globalObject = visitor->callFrame()->lexicalGlobalObject(vm);
return IterationStatus::Done;
}
if (auto* codeBlock = visitor->codeBlock()) {
if (codeBlock->codeType() == CodeType::FunctionCode && static_cast<FunctionExecutable*>(codeBlock->ownerExecutable())->isBuiltinFunction())
return IterationStatus::Continue;
globalObject = codeBlock->globalObject();
return IterationStatus::Done;
}
ASSERT(visitor->codeType() == StackVisitor::Frame::CodeType::Native);
return IterationStatus::Continue;
});
if (globalObject)
return globalObject;
if (vm.entryScope)
return vm.entryScope->globalObject();
return nullptr;
}
String CallFrame::friendlyFunctionName()
{
if (this->isNativeCalleeFrame())
return emptyString();
CodeBlock* codeBlock = this->codeBlock();
if (!codeBlock)
return emptyString();
switch (codeBlock->codeType()) {
case EvalCode:
return "eval code"_s;
case ModuleCode:
return "module code"_s;
case GlobalCode:
return "global code"_s;
case FunctionCode:
if (jsCallee())
return getCalculatedDisplayName(codeBlock->vm(), jsCallee());
return emptyString();
}
ASSERT_NOT_REACHED();
return emptyString();
}
void CallFrame::dump(PrintStream& out) const
{
if (this->isNativeCalleeFrame()) {
auto* nativeCallee = callee().asNativeCallee();
switch (nativeCallee->category()) {
case NativeCallee::Category::Wasm: {
#if ENABLE(WEBASSEMBLY)
auto* wasmCallee = uncheckedDowncast<Wasm::Callee>(nativeCallee);
out.print(Wasm::makeString(wasmCallee->indexOrName()), " [", wasmCallee->compilationMode(), " ", RawPointer(callee().rawPtr()), "]");
out.print("(JSWebAssemblyInstance: ", RawPointer(wasmInstance()), ")");
#else
out.print(RawPointer(returnPCForInspection()));
#endif
break;
}
case NativeCallee::Category::InlineCache:
out.print(RawPointer(returnPCForInspection()));
break;
}
return;
}
if (CodeBlock* codeBlock = this->codeBlock()) {
out.print(codeBlock->inferredNameWithHash(), " [", codeBlock->jitType(), " ", bytecodeIndex(), "]");
out.print("(");
thisValue().dumpForBacktrace(out);
for (size_t i = 0; i < argumentCount(); ++i) {
out.print(", ");
JSValue value = argument(i);
value.dumpForBacktrace(out);
}
out.print(")");
String source = codeBlock->ownerExecutable()->sourceURL();
if (!source.isEmpty()) {
out.print(" at ");
URL url = URL(source);
if (url.hasPath())
out.print(url.lastPathComponent());
else
out.print(source);
VM& vm = deprecatedVM();
if (RefPtr<DebuggerCallFrame> currentDebuggerCallFrame = DebuggerCallFrame::create(vm, const_cast<CallFrame*>(this))) {
int lineNumber = currentDebuggerCallFrame->line() + 1;
int columnNumber = currentDebuggerCallFrame->column() + 1;
out.print(":", lineNumber, ":", columnNumber);
}
}
return;
}
out.print(RawPointer(returnPCForInspection()));
}
const char* CallFrame::describeFrame()
{
constexpr size_t bufferSize = 200;
static char* buffer = nullptr;
static std::once_flag onceKey;
std::call_once(onceKey, [&] {
buffer = static_cast<char*>(fastZeroedMalloc(bufferSize + 1));
});
WTF::StringPrintStream stringStream;
dump(stringStream);
strncpy(buffer, stringStream.toUTF8CString().legacyCStringPointer(), bufferSize);
buffer[bufferSize] = '\0';
return buffer;
}
void CallFrame::convertToZombieFrame(VM& vm, CodeBlock* codeBlockToKeepAliveUntilFrameIsUnwound)
{
ASSERT(!isEmptyTopLevelCallFrameForDebugger());
ASSERT(codeBlockToKeepAliveUntilFrameIsUnwound->inherits<CodeBlock>());
EntryFrame* entryFrame = vm.topEntryFrame;
CallFrame* throwOriginFrame = this;
do {
throwOriginFrame = throwOriginFrame->callerFrame(entryFrame);
} while (throwOriginFrame && throwOriginFrame->callee().isNativeCallee());
JSGlobalObject* globalObject = nullptr;
if (throwOriginFrame)
globalObject = throwOriginFrame->jsCallee()->realm();
else
globalObject = vm.entryScope->globalObject();
JSObject* zombieFrameCallee = globalObject->zombieFrameCallee();
setCodeBlock(codeBlockToKeepAliveUntilFrameIsUnwound);
setCallee(zombieFrameCallee);
setArgumentCountIncludingThis(0);
}
JSGlobalObject* CallFrame::lexicalGlobalObjectFromNativeCallee(VM& vm) const
{
auto* nativeCallee = callee().asNativeCallee();
switch (nativeCallee->category()) {
case NativeCallee::Category::Wasm: {
#if ENABLE(WEBASSEMBLY)
return wasmInstance()->realm();
#else
return nullptr;
#endif
}
case NativeCallee::Category::InlineCache: {
return callerFrame()->lexicalGlobalObject(vm);
}
}
return nullptr;
}
JSCell* CallFrame::codeOwnerCellSlow() const
{
auto* nativeCallee = callee().asNativeCallee();
switch (nativeCallee->category()) {
case NativeCallee::Category::Wasm: {
#if ENABLE(WEBASSEMBLY)
return wasmInstance()->jsModule();
#else
return nullptr;
#endif
}
case NativeCallee::Category::InlineCache:
return callerFrame()->codeOwnerCell();
}
return nullptr;
}
bool isFromJSCode(void* returnAddress)
{
UNUSED_PARAM(returnAddress);
#if ENABLE(JIT)
if (isJITPC(returnAddress))
return true;
#endif
#if ENABLE(C_LOOP)
return true;
#else
return LLInt::isLLIntPC(returnAddress);
#endif
}
#if ENABLE(WEBASSEMBLY)
JSWebAssemblyInstance* CallFrame::wasmInstance() const
{
ASSERT(callee().isNativeCallee());
return uncheckedDowncast<JSWebAssemblyInstance>(this[static_cast<int>(CallFrameSlot::codeBlock)].jsValue());
}
#endif
} // namespace JSC
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END