v8 12.4.254 (node 22.4.1)
V8 is Google's open source JavaScript engine
Loading...
Searching...
No Matches
v8-callbacks.h
Go to the documentation of this file.
1// Copyright 2021 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef INCLUDE_V8_ISOLATE_CALLBACKS_H_
6#define INCLUDE_V8_ISOLATE_CALLBACKS_H_
7
8#include <stddef.h>
9
10#include <functional>
11#include <string>
12
13#include "cppgc/common.h"
14#include "v8-data.h" // NOLINT(build/include_directory)
15#include "v8-local-handle.h" // NOLINT(build/include_directory)
16#include "v8-promise.h" // NOLINT(build/include_directory)
17#include "v8config.h" // NOLINT(build/include_directory)
18
19#if defined(V8_OS_WIN)
20struct _EXCEPTION_POINTERS;
21#endif
22
23namespace v8 {
24
25template <typename T>
26class FunctionCallbackInfo;
27class Isolate;
28class Message;
29class Module;
30class Object;
31class Promise;
32class ScriptOrModule;
33class String;
34class UnboundScript;
35class Value;
36
43 enum EventType {
50 };
51 // Definition of the code position type. The "POSITION" type means the place
52 // in the source code which are of interest when making stack traces to
53 // pin-point the source location of a stack frame as close as possible.
54 // The "STATEMENT_POSITION" means the place at the beginning of each
55 // statement, and is used to indicate possible break locations.
57
58 // There are three different kinds of CodeType, one for JIT code generated
59 // by the optimizing compiler, one for byte code generated for the
60 // interpreter, and one for code generated from Wasm. For JIT_CODE and
61 // WASM_CODE, |code_start| points to the beginning of jitted assembly code,
62 // while for BYTE_CODE events, |code_start| points to the first bytecode of
63 // the interpreted function.
65
66 // Type of event.
69 // Start of the instructions.
71 // Size of the instructions.
72 size_t code_len;
73 // Script info for CODE_ADDED event.
75 // User-defined data for *_LINE_INFO_* event. It's used to hold the source
76 // code line information which is returned from the
77 // CODE_START_LINE_INFO_RECORDING event. And it's passed to subsequent
78 // CODE_ADD_LINE_POS_INFO and CODE_END_LINE_INFO_RECORDING events.
79 void* user_data;
80
81 struct name_t {
82 // Name of the object associated with the code, note that the string is not
83 // zero-terminated.
84 const char* str;
85 // Number of chars in str.
86 size_t len;
87 };
88
89 struct line_info_t {
90 // PC offset
91 size_t offset;
92 // Code position
93 size_t pos;
94 // The position type.
96 };
97
99 // Source file name.
100 const char* filename;
101 // Length of filename.
103 // Line number table, which maps offsets of JITted code to line numbers of
104 // source file.
106 // Number of entries in the line number table.
108 };
109
111
112 union {
113 // Only valid for CODE_ADDED.
114 struct name_t name;
115
116 // Only valid for CODE_ADD_LINE_POS_INFO
118
119 // New location of instructions. Only valid for CODE_MOVED.
121 };
122
124};
125
131 // Generate callbacks for already existent code.
134
140using JitCodeEventHandler = void (*)(const JitCodeEvent* event);
141
142// --- Garbage Collection Callbacks ---
143
152enum GCType {
155 kGCTypeMinorMarkCompact V8_DEPRECATE_SOON(
156 "Use kGCTypeMinorMarkSweep instead of kGCTypeMinorMarkCompact.") =
165
188};
189
190using GCCallback = void (*)(GCType type, GCCallbackFlags flags);
191
192using InterruptCallback = void (*)(Isolate* isolate, void* data);
193
201using NearHeapLimitCallback = size_t (*)(void* data, size_t current_heap_limit,
202 size_t initial_heap_limit);
203
207#if defined(V8_OS_WIN)
208using UnhandledExceptionCallback =
209 int (*)(_EXCEPTION_POINTERS* exception_pointers);
210#endif
211
212// --- Counters Callbacks ---
213
214using CounterLookupCallback = int* (*)(const char* name);
215
216using CreateHistogramCallback = void* (*)(const char* name, int min, int max,
217 size_t buckets);
218
219using AddHistogramSampleCallback = void (*)(void* histogram, int sample);
220
221// --- Exceptions ---
222
223using FatalErrorCallback = void (*)(const char* location, const char* message);
224
226 bool is_heap_oom = false;
227 const char* detail = nullptr;
228};
229
230using OOMErrorCallback = void (*)(const char* location,
231 const OOMDetails& details);
232
233using MessageCallback = void (*)(Local<Message> message, Local<Value> data);
234
235// --- Tracing ---
236
237enum LogEventStatus : int { kStart = 0, kEnd = 1, kStamp = 2 };
238using LogEventCallback = void (*)(const char* name,
239 int /* LogEventStatus */ status);
240
241// --- Crashkeys Callback ---
242enum class CrashKeyId {
245 kMapSpaceFirstPageAddress V8_ENUM_DEPRECATE_SOON("Map space got removed"),
249 kDumpType,
252};
253
254using AddCrashKeyCallback = void (*)(CrashKeyId id, const std::string& value);
255
256// --- Enter/Leave Script Callback ---
259
260// --- AllowCodeGenerationFromStrings callbacks ---
261
267 Local<String> source);
268
270 // If true, proceed with the codegen algorithm. Otherwise, block it.
271 bool codegen_allowed = false;
272 // Overwrite the original source with this string, if present.
273 // Use the original source if empty.
274 // This field is considered only if codegen_allowed is true.
276};
277
288
289// --- Failed Access Check Callback ---
290
292 AccessType type, Local<Value> data);
293
300 Local<Value> source);
303 Local<Value> source,
304 bool is_code_like);
305
306// --- WebAssembly compilation callbacks ---
308
310 Local<String> source);
311
312// --- Callback for APIs defined on v8-supported objects, but implemented
313// by the embedder. Example: WebAssembly.{compile|instantiate}Streaming ---
315
316// --- Callback for WebAssembly.compileStreaming ---
318
320
321// --- Callback called when async WebAssembly operations finish ---
323 Isolate* isolate, Local<Context> context, Local<Promise::Resolver> resolver,
324 Local<Value> result, WasmAsyncSuccess success);
325
326// --- Callback for loading source map file for Wasm profiling support
328 const char* name);
329
330// --- Callback for checking if WebAssembly imported strings are enabled ---
332
333// --- Callback for checking if the SharedArrayBuffer constructor is enabled ---
335 bool (*)(Local<Context> context);
336
337// --- Callback for checking if the compile hints magic comments are enabled ---
339 bool (*)(Local<Context> context);
340
341// --- Callback for checking if WebAssembly JSPI is enabled ---
342using WasmJSPIEnabledCallback = bool (*)(Local<Context> context);
343
371 Local<Context> context, Local<Data> host_defined_options,
372 Local<Value> resource_name, Local<String> specifier,
373 Local<FixedArray> import_attributes);
374
380using CompileHintCallback = bool (*)(int, void*);
381
393 Local<Module> module,
394 Local<Object> meta);
395
408 MaybeLocal<Context> (*)(Local<Context> initiator_context);
409
418 Local<Value> error,
419 Local<Array> sites);
420
421#if defined(V8_OS_WIN)
456using FilterETWSessionByURLCallback =
457 bool (*)(Local<Context> context, const std::string& etw_filter_payload);
458#endif // V8_OS_WIN
459
460} // namespace v8
461
462#endif // INCLUDE_V8_ISOLATE_CALLBACKS_H_
bool(*)(Local< Context > context) WasmJSPIEnabledCallback
void(*)(const char *name, int status) LogEventCallback
bool(*)(const FunctionCallbackInfo< Value > &) ExtensionCallback
void(*)(Local< Message > message, Local< Value > data) MessageCallback
WasmAsyncSuccess
void(*)(CrashKeyId id, const std::string &value) AddCrashKeyCallback
bool(*)(Local< Context > context, Local< String > source) AllowWasmCodeGenerationCallback
bool(*)(Local< Context > context) JavaScriptCompileHintsMagicEnabledCallback
ModifyCodeGenerationFromStringsResult(*)(Local< Context > context, Local< Value > source, bool is_code_like) ModifyCodeGenerationFromStringsCallback2
GCCallbackFlags
@ kNoGCCallbackFlags
@ kGCCallbackFlagSynchronousPhantomCallbackProcessing
@ kGCCallbackFlagForced
@ kGCCallbackFlagConstructRetainedObjectInfos
@ kGCCallbackFlagCollectAllExternalMemory
@ kGCCallbackFlagCollectAllAvailableGarbage
@ kGCCallbackScheduleIdleGarbageCollection
void(*)(Isolate *) CallCompletedCallback
void(*)(GCType type, GCCallbackFlags flags) GCCallback
bool(*)(Local< Context > context) WasmImportedStringsEnabledCallback
size_t(*)(void *data, size_t current_heap_limit, size_t initial_heap_limit) NearHeapLimitCallback
@ kGCTypeProcessWeakCallbacks
@ kGCTypeIncrementalMarking
@ kGCTypeMarkSweepCompact
@ kGCTypeScavenge
@ V8_DEPRECATE_SOON
@ kGCTypeAll
@ kGCTypeMinorMarkSweep
JitCodeEventOptions
@ kJitCodeEventEnumExisting
@ kJitCodeEventDefault
void(*)(Local< Object > target, AccessType type, Local< Value > data) FailedAccessCheckCallback
void(*)(Isolate *isolate, void *data) InterruptCallback
bool(*)(Local< Context > context) SharedArrayBufferConstructorEnabledCallback
void(*)(const FunctionCallbackInfo< Value > &) ApiImplementationCallback
void(*)(const FunctionCallbackInfo< Value > &) WasmStreamingCallback
void(*)(const char *location, const char *message) FatalErrorCallback
void(*)(const char *location, const OOMDetails &details) OOMErrorCallback
bool(*)(Local< Context > context, Local< String > source) AllowCodeGenerationFromStringsCallback
ModifyCodeGenerationFromStringsResult(*)(Local< Context > context, Local< Value > source) ModifyCodeGenerationFromStringsCallback
void(*)(Isolate *isolate, Local< Context > context, Local< Promise::Resolver > resolver, Local< Value > result, WasmAsyncSuccess success) WasmAsyncResolvePromiseCallback
void(*)(Isolate *) BeforeCallEnteredCallback
void(*)(void *histogram, int sample) AddHistogramSampleCallback
bool(*)(int, void *) CompileHintCallback
@ ACCESS_KEYS
@ ACCESS_HAS
@ ACCESS_DELETE
@ ACCESS_GET
@ ACCESS_SET
int *(*)(const char *name) CounterLookupCallback
LogEventStatus
@ kStamp
@ kStart
@ kSnapshotChecksumCalculated
@ kCodeSpaceFirstPageAddress
@ kReadonlySpaceFirstPageAddress
void(*)(Local< Context > context, Local< Module > module, Local< Object > meta) HostInitializeImportMetaObjectCallback
void *(*)(const char *name, int min, int max, size_t buckets) CreateHistogramCallback
void(*)(const JitCodeEvent *event) JitCodeEventHandler
Local< UnboundScript > script
struct line_info_t line_info
wasm_source_info_t * wasm_source_info
struct name_t name
const char * detail