isolate.h 75.3 KB
Newer Older
1
// Copyright 2012 the V8 project authors. All rights reserved.
2 3
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
4

5 6
#ifndef V8_EXECUTION_ISOLATE_H_
#define V8_EXECUTION_ISOLATE_H_
7

8
#include <cstddef>
9
#include <functional>
10
#include <memory>
11
#include <queue>
12
#include <unordered_map>
13
#include <vector>
14

15
#include "include/v8-inspector.h"
16
#include "include/v8-internal.h"
17 18
#include "include/v8.h"
#include "src/base/macros.h"
19
#include "src/builtins/builtins.h"
20
#include "src/common/globals.h"
21
#include "src/debug/interface-types.h"
22 23 24 25
#include "src/execution/execution.h"
#include "src/execution/futex-emulation.h"
#include "src/execution/isolate-data.h"
#include "src/execution/messages.h"
26
#include "src/execution/stack-guard.h"
27
#include "src/handles/handles.h"
28
#include "src/heap/factory.h"
29
#include "src/heap/heap.h"
30
#include "src/heap/read-only-heap.h"
31
#include "src/init/isolate-allocator.h"
32
#include "src/objects/code.h"
33
#include "src/objects/contexts.h"
34
#include "src/objects/debug-objects.h"
35
#include "src/runtime/runtime.h"
36
#include "src/strings/unicode.h"
37
#include "src/utils/allocation.h"
38

39 40 41
#ifdef V8_INTL_SUPPORT
#include "unicode/uversion.h"  // Define U_ICU_NAMESPACE.
namespace U_ICU_NAMESPACE {
42
class UMemory;
43 44 45
}  // namespace U_ICU_NAMESPACE
#endif  // V8_INTL_SUPPORT

46
namespace v8 {
47 48 49 50 51

namespace base {
class RandomNumberGenerator;
}

52 53
namespace debug {
class ConsoleDelegate;
54
class AsyncEventDelegate;
55
}  // namespace debug
56

57 58
namespace internal {

59 60 61 62
namespace heap {
class HeapTester;
}  // namespace heap

63
class AddressToIndexHashMap;
64
class AstStringConstants;
65
class Bootstrapper;
66
class BuiltinsConstantsTableBuilder;
67
class CancelableTaskManager;
68
class CodeEventDispatcher;
69
class CodeTracer;
70
class CompilationCache;
71
class CompilationStatistics;
72
class CompilerDispatcher;
73
class Counters;
74
class Debug;
75
class DeoptimizerData;
76
class DescriptorLookupCache;
77
class EmbeddedFileWriterInterface;
78
class EternalHandles;
79
class HandleScopeImplementer;
80
class HeapObjectToIndexHashMap;
81
class HeapProfiler;
82
class InnerPointerToCodeCache;
83
class Logger;
jarin@chromium.org's avatar
jarin@chromium.org committed
84
class MaterializedObjectStore;
85
class Microtask;
86
class MicrotaskQueue;
87
class OptimizingCompileDispatcher;
88
class ReadOnlyDeserializer;
89
class RegExpStack;
90
class RootVisitor;
91
class RuntimeProfiler;
92
class SetupIsolateDelegate;
93
class Simulator;
94
class StandardFrame;
95
class StartupDeserializer;
96 97 98 99
class StubCache;
class ThreadManager;
class ThreadState;
class ThreadVisitor;  // Defined in v8threads.h
100
class TracingCpuProfilerImpl;
jarin@chromium.org's avatar
jarin@chromium.org committed
101
class UnicodeCache;
102
struct ManagedPtrDestructor;
103

104 105
template <StateTag Tag>
class VMState;
106

107 108 109
namespace interpreter {
class Interpreter;
}
110

111 112 113 114
namespace compiler {
class PerIsolateCompilerCache;
}

115
namespace wasm {
116
class WasmEngine;
117 118
}

119 120 121 122
namespace win64_unwindinfo {
class BuiltinUnwindInfo;
}

123 124 125 126 127 128 129
#define RETURN_FAILURE_IF_SCHEDULED_EXCEPTION(isolate) \
  do {                                                 \
    Isolate* __isolate__ = (isolate);                  \
    DCHECK(!__isolate__->has_pending_exception());     \
    if (__isolate__->has_scheduled_exception()) {      \
      return __isolate__->PromoteScheduledException(); \
    }                                                  \
130
  } while (false)
131

132 133
// Macros for MaybeHandle.

134 135 136
#define RETURN_VALUE_IF_SCHEDULED_EXCEPTION(isolate, value) \
  do {                                                      \
    Isolate* __isolate__ = (isolate);                       \
137
    DCHECK(!__isolate__->has_pending_exception());          \
138 139 140 141
    if (__isolate__->has_scheduled_exception()) {           \
      __isolate__->PromoteScheduledException();             \
      return value;                                         \
    }                                                       \
142 143
  } while (false)

144 145 146
#define RETURN_EXCEPTION_IF_SCHEDULED_EXCEPTION(isolate, T) \
  RETURN_VALUE_IF_SCHEDULED_EXCEPTION(isolate, MaybeHandle<T>())

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
#define ASSIGN_RETURN_ON_SCHEDULED_EXCEPTION_VALUE(isolate, dst, call, value) \
  do {                                                                        \
    Isolate* __isolate__ = (isolate);                                         \
    if (!(call).ToLocal(&dst)) {                                              \
      DCHECK(__isolate__->has_scheduled_exception());                         \
      __isolate__->PromoteScheduledException();                               \
      return value;                                                           \
    }                                                                         \
  } while (false)

#define RETURN_ON_SCHEDULED_EXCEPTION_VALUE(isolate, call, value) \
  do {                                                            \
    Isolate* __isolate__ = (isolate);                             \
    if ((call).IsNothing()) {                                     \
      DCHECK(__isolate__->has_scheduled_exception());             \
      __isolate__->PromoteScheduledException();                   \
      return value;                                               \
    }                                                             \
  } while (false)

167
/**
168
 * RETURN_RESULT_OR_FAILURE is used in functions with return type Object (such
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
 * as "RUNTIME_FUNCTION(...) {...}" or "BUILTIN(...) {...}" ) to return either
 * the contents of a MaybeHandle<X>, or the "exception" sentinel value.
 * Example usage:
 *
 * RUNTIME_FUNCTION(Runtime_Func) {
 *   ...
 *   RETURN_RESULT_OR_FAILURE(
 *       isolate,
 *       FunctionWithReturnTypeMaybeHandleX(...));
 * }
 *
 * If inside a function with return type MaybeHandle<X> use RETURN_ON_EXCEPTION
 * instead.
 * If inside a function with return type Handle<X>, or Maybe<X> use
 * RETURN_ON_EXCEPTION_VALUE instead.
 */
185 186 187 188 189 190 191 192 193 194
#define RETURN_RESULT_OR_FAILURE(isolate, call)      \
  do {                                               \
    Handle<Object> __result__;                       \
    Isolate* __isolate__ = (isolate);                \
    if (!(call).ToHandle(&__result__)) {             \
      DCHECK(__isolate__->has_pending_exception());  \
      return ReadOnlyRoots(__isolate__).exception(); \
    }                                                \
    DCHECK(!__isolate__->has_pending_exception());   \
    return *__result__;                              \
195 196
  } while (false)

197 198 199 200 201 202
#define ASSIGN_RETURN_ON_EXCEPTION_VALUE(isolate, dst, call, value) \
  do {                                                              \
    if (!(call).ToHandle(&dst)) {                                   \
      DCHECK((isolate)->has_pending_exception());                   \
      return value;                                                 \
    }                                                               \
203 204
  } while (false)

205 206 207 208 209
#define ASSIGN_RETURN_FAILURE_ON_EXCEPTION(isolate, dst, call)                \
  do {                                                                        \
    Isolate* __isolate__ = (isolate);                                         \
    ASSIGN_RETURN_ON_EXCEPTION_VALUE(__isolate__, dst, call,                  \
                                     ReadOnlyRoots(__isolate__).exception()); \
210
  } while (false)
211

212
#define ASSIGN_RETURN_ON_EXCEPTION(isolate, dst, call, T) \
213 214
  ASSIGN_RETURN_ON_EXCEPTION_VALUE(isolate, dst, call, MaybeHandle<T>())

215 216 217 218
#define THROW_NEW_ERROR(isolate, call, T)                       \
  do {                                                          \
    Isolate* __isolate__ = (isolate);                           \
    return __isolate__->Throw<T>(__isolate__->factory()->call); \
219 220
  } while (false)

221 222 223 224
#define THROW_NEW_ERROR_RETURN_FAILURE(isolate, call)         \
  do {                                                        \
    Isolate* __isolate__ = (isolate);                         \
    return __isolate__->Throw(*__isolate__->factory()->call); \
225 226
  } while (false)

227 228 229 230 231 232 233
#define THROW_NEW_ERROR_RETURN_VALUE(isolate, call, value) \
  do {                                                     \
    Isolate* __isolate__ = (isolate);                      \
    __isolate__->Throw(*__isolate__->factory()->call);     \
    return value;                                          \
  } while (false)

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
/**
 * RETURN_ON_EXCEPTION_VALUE conditionally returns the given value when the
 * given MaybeHandle is empty. It is typically used in functions with return
 * type Maybe<X> or Handle<X>. Example usage:
 *
 * Handle<X> Func() {
 *   ...
 *   RETURN_ON_EXCEPTION_VALUE(
 *       isolate,
 *       FunctionWithReturnTypeMaybeHandleX(...),
 *       Handle<X>());
 *   // code to handle non exception
 *   ...
 * }
 *
 * Maybe<bool> Func() {
 *   ..
 *   RETURN_ON_EXCEPTION_VALUE(
 *       isolate,
 *       FunctionWithReturnTypeMaybeHandleX(...),
 *       Nothing<bool>);
 *   // code to handle non exception
 *   return Just(true);
 * }
 *
 * If inside a function with return type MaybeHandle<X>, use RETURN_ON_EXCEPTION
 * instead.
261
 * If inside a function with return type Object, use
262 263
 * RETURN_FAILURE_ON_EXCEPTION instead.
 */
264 265 266 267 268 269
#define RETURN_ON_EXCEPTION_VALUE(isolate, call, value) \
  do {                                                  \
    if ((call).is_null()) {                             \
      DCHECK((isolate)->has_pending_exception());       \
      return value;                                     \
    }                                                   \
270 271
  } while (false)

272 273 274
/**
 * RETURN_FAILURE_ON_EXCEPTION conditionally returns the "exception" sentinel if
 * the given MaybeHandle is empty; so it can only be used in functions with
275
 * return type Object, such as RUNTIME_FUNCTION(...) {...} or BUILTIN(...)
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
 * {...}. Example usage:
 *
 * RUNTIME_FUNCTION(Runtime_Func) {
 *   ...
 *   RETURN_FAILURE_ON_EXCEPTION(
 *       isolate,
 *       FunctionWithReturnTypeMaybeHandleX(...));
 *   // code to handle non exception
 *   ...
 * }
 *
 * If inside a function with return type MaybeHandle<X>, use RETURN_ON_EXCEPTION
 * instead.
 * If inside a function with return type Maybe<X> or Handle<X>, use
 * RETURN_ON_EXCEPTION_VALUE instead.
 */
292 293 294 295 296
#define RETURN_FAILURE_ON_EXCEPTION(isolate, call)                     \
  do {                                                                 \
    Isolate* __isolate__ = (isolate);                                  \
    RETURN_ON_EXCEPTION_VALUE(__isolate__, call,                       \
                              ReadOnlyRoots(__isolate__).exception()); \
297
  } while (false);
298

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
/**
 * RETURN_ON_EXCEPTION conditionally returns an empty MaybeHandle<T> if the
 * given MaybeHandle is empty. Use it to return immediately from a function with
 * return type MaybeHandle when an exception was thrown. Example usage:
 *
 * MaybeHandle<X> Func() {
 *   ...
 *   RETURN_ON_EXCEPTION(
 *       isolate,
 *       FunctionWithReturnTypeMaybeHandleY(...),
 *       X);
 *   // code to handle non exception
 *   ...
 * }
 *
314
 * If inside a function with return type Object, use
315 316 317 318
 * RETURN_FAILURE_ON_EXCEPTION instead.
 * If inside a function with return type
 * Maybe<X> or Handle<X>, use RETURN_ON_EXCEPTION_VALUE instead.
 */
319
#define RETURN_ON_EXCEPTION(isolate, call, T) \
320
  RETURN_ON_EXCEPTION_VALUE(isolate, call, MaybeHandle<T>())
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
#define RETURN_FAILURE(isolate, should_throw, call) \
  do {                                              \
    if ((should_throw) == kDontThrow) {             \
      return Just(false);                           \
    } else {                                        \
      isolate->Throw(*isolate->factory()->call);    \
      return Nothing<bool>();                       \
    }                                               \
  } while (false)

#define MAYBE_RETURN(call, value)         \
  do {                                    \
    if ((call).IsNothing()) return value; \
  } while (false)

#define MAYBE_RETURN_NULL(call) MAYBE_RETURN(call, MaybeHandle<Object>())

#define MAYBE_ASSIGN_RETURN_FAILURE_ON_EXCEPTION(isolate, dst, call) \
  do {                                                               \
    Isolate* __isolate__ = (isolate);                                \
    if (!(call).To(&dst)) {                                          \
      DCHECK(__isolate__->has_pending_exception());                  \
      return ReadOnlyRoots(__isolate__).exception();                 \
    }                                                                \
  } while (false)
347

348 349 350 351 352 353 354 355 356 357 358 359 360 361
#define FOR_WITH_HANDLE_SCOPE(isolate, loop_var_type, init, loop_var,      \
                              limit_check, increment, body)                \
  do {                                                                     \
    loop_var_type init;                                                    \
    loop_var_type for_with_handle_limit = loop_var;                        \
    Isolate* for_with_handle_isolate = isolate;                            \
    while (limit_check) {                                                  \
      for_with_handle_limit += 1024;                                       \
      HandleScope loop_scope(for_with_handle_isolate);                     \
      for (; limit_check && loop_var < for_with_handle_limit; increment) { \
        body                                                               \
      }                                                                    \
    }                                                                      \
  } while (false)
362

363 364
#define FIELD_ACCESSOR(type, name)                \
  inline void set_##name(type v) { name##_ = v; } \
365 366
  inline type name() const { return name##_; }

367 368 369 370 371
// Controls for manual embedded blob lifecycle management, used by tests and
// mksnapshot.
V8_EXPORT_PRIVATE void DisableEmbeddedBlobRefcounting();
V8_EXPORT_PRIVATE void FreeCurrentEmbeddedBlob();

372 373
#ifdef DEBUG

374 375 376 377
#define ISOLATE_INIT_DEBUG_ARRAY_LIST(V)               \
  V(CommentStatistic, paged_space_comments_statistics, \
    CommentStatistic::kMaxComments + 1)                \
  V(int, code_kind_statistics, AbstractCode::NUMBER_OF_KINDS)
378 379 380 381 382 383 384 385
#else

#define ISOLATE_INIT_DEBUG_ARRAY_LIST(V)

#endif

#define ISOLATE_INIT_ARRAY_LIST(V)                                             \
  /* SerializerDeserializer state. */                                          \
386
  V(int32_t, jsregexp_static_offsets_vector, kJSRegexpStaticOffsetsVectorSize) \
387 388 389 390 391
  V(int, bad_char_shift_table, kUC16AlphabetSize)                              \
  V(int, good_suffix_shift_table, (kBMMaxShift + 1))                           \
  V(int, suffix_table, (kBMMaxShift + 1))                                      \
  ISOLATE_INIT_DEBUG_ARRAY_LIST(V)

392
using DebugObjectCache = std::vector<Handle<HeapObject>>;
393

394 395 396 397 398 399
#define ISOLATE_INIT_LIST(V)                                                   \
  /* Assembler state. */                                                       \
  V(FatalErrorCallback, exception_behavior, nullptr)                           \
  V(OOMErrorCallback, oom_behavior, nullptr)                                   \
  V(LogEventCallback, event_logger, nullptr)                                   \
  V(AllowCodeGenerationFromStringsCallback, allow_code_gen_callback, nullptr)  \
400 401
  V(ModifyCodeGenerationFromStringsCallback, modify_code_gen_callback,         \
    nullptr)                                                                   \
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
  V(AllowWasmCodeGenerationCallback, allow_wasm_code_gen_callback, nullptr)    \
  V(ExtensionCallback, wasm_module_callback, &NoExtension)                     \
  V(ExtensionCallback, wasm_instance_callback, &NoExtension)                   \
  V(WasmStreamingCallback, wasm_streaming_callback, nullptr)                   \
  V(WasmThreadsEnabledCallback, wasm_threads_enabled_callback, nullptr)        \
  /* State for Relocatable. */                                                 \
  V(Relocatable*, relocatable_top, nullptr)                                    \
  V(DebugObjectCache*, string_stream_debug_object_cache, nullptr)              \
  V(Object, string_stream_current_security_token, Object())                    \
  V(const intptr_t*, api_external_references, nullptr)                         \
  V(AddressToIndexHashMap*, external_reference_map, nullptr)                   \
  V(HeapObjectToIndexHashMap*, root_index_map, nullptr)                        \
  V(MicrotaskQueue*, default_microtask_queue, nullptr)                         \
  V(CompilationStatistics*, turbo_statistics, nullptr)                         \
  V(CodeTracer*, code_tracer, nullptr)                                         \
  V(uint32_t, per_isolate_assert_data, 0xFFFFFFFFu)                            \
  V(PromiseRejectCallback, promise_reject_callback, nullptr)                   \
  V(const v8::StartupData*, snapshot_blob, nullptr)                            \
  V(int, code_and_metadata_size, 0)                                            \
  V(int, bytecode_and_metadata_size, 0)                                        \
  V(int, external_script_source_size, 0)                                       \
  /* true if being profiled. Causes collection of extra compile info. */       \
  V(bool, is_profiling, false)                                                 \
425 426
  /* Number of CPU profilers running on the isolate. */                        \
  V(size_t, num_cpu_profilers, 0)                                              \
427 428 429 430 431 432 433 434 435 436 437 438
  /* true if a trace is being formatted through Error.prepareStackTrace. */    \
  V(bool, formatting_stack_trace, false)                                       \
  /* Perform side effect checks on function call and API callbacks. */         \
  V(DebugInfo::ExecutionMode, debug_execution_mode, DebugInfo::kBreakpoints)   \
  /* Current code coverage mode */                                             \
  V(debug::CoverageMode, code_coverage_mode, debug::CoverageMode::kBestEffort) \
  V(debug::TypeProfileMode, type_profile_mode, debug::TypeProfileMode::kNone)  \
  V(int, last_stack_frame_info_id, 0)                                          \
  V(int, last_console_context_id, 0)                                           \
  V(v8_inspector::V8Inspector*, inspector, nullptr)                            \
  V(bool, next_v8_call_is_safe_for_termination, false)                         \
  V(bool, only_terminate_in_safe_scope, false)                                 \
439
  V(bool, detailed_source_positions_for_profiling, FLAG_detailed_line_info)
440

441 442 443
#define THREAD_LOCAL_TOP_ACCESSOR(type, name)                         \
  inline void set_##name(type v) { thread_local_top()->name##_ = v; } \
  inline type name() const { return thread_local_top()->name##_; }
444

445
#define THREAD_LOCAL_TOP_ADDRESS(type, name) \
446
  type* name##_address() { return &thread_local_top()->name##_; }
447

448 449 450
// HiddenFactory exists so Isolate can privately inherit from it without making
// Factory's members available to Isolate directly.
class V8_EXPORT_PRIVATE HiddenFactory : private Factory {};
451

452
class Isolate final : private HiddenFactory {
453 454 455 456
  // These forward declarations are required to make the friend declarations in
  // PerIsolateThreadData work on some older versions of gcc.
  class ThreadDataTable;
  class EntryStackItem;
457

458 459 460 461 462 463 464 465 466 467
 public:
  // A thread has a PerIsolateThreadData instance for each isolate that it has
  // entered. That instance is allocated when the isolate is initially entered
  // and reused on subsequent entries.
  class PerIsolateThreadData {
   public:
    PerIsolateThreadData(Isolate* isolate, ThreadId thread_id)
        : isolate_(isolate),
          thread_id_(thread_id),
          stack_limit_(0),
468
          thread_state_(nullptr)
469
#if USE_SIMULATOR
470 471
          ,
          simulator_(nullptr)
472
#endif
473
    {
474
    }
475
    ~PerIsolateThreadData();
476 477
    Isolate* isolate() const { return isolate_; }
    ThreadId thread_id() const { return thread_id_; }
478 479 480

    FIELD_ACCESSOR(uintptr_t, stack_limit)
    FIELD_ACCESSOR(ThreadState*, thread_state)
481

482
#if USE_SIMULATOR
483
    FIELD_ACCESSOR(Simulator*, simulator)
484 485 486
#endif

    bool Matches(Isolate* isolate, ThreadId thread_id) const {
Clemens Hammacher's avatar
Clemens Hammacher committed
487
      return isolate_ == isolate && thread_id_ == thread_id;
488 489 490 491 492 493 494 495
    }

   private:
    Isolate* isolate_;
    ThreadId thread_id_;
    uintptr_t stack_limit_;
    ThreadState* thread_state_;

496
#if USE_SIMULATOR
497 498 499 500 501 502 503 504 505 506
    Simulator* simulator_;
#endif

    friend class Isolate;
    friend class ThreadDataTable;
    friend class EntryStackItem;

    DISALLOW_COPY_AND_ASSIGN(PerIsolateThreadData);
  };

507 508
  static void InitializeOncePerProcess();

509 510
  // Creates Isolate object. Must be used instead of constructing Isolate with
  // new operator.
511 512
  static V8_EXPORT_PRIVATE Isolate* New(
      IsolateAllocationMode mode = IsolateAllocationMode::kDefault);
513 514 515 516 517 518 519

  // Deletes Isolate object. Must be used instead of delete operator.
  // Destroys the non-default isolates.
  // Sets default isolate into "has_been_disposed" state rather then destroying,
  // for legacy API reasons.
  static void Delete(Isolate* isolate);

520 521
  void SetUpFromReadOnlyHeap(ReadOnlyHeap* ro_heap);

522 523 524
  // Returns allocation mode of this isolate.
  V8_INLINE IsolateAllocationMode isolate_allocation_mode();

525 526 527
  // Page allocator that must be used for allocating V8 heap pages.
  v8::PageAllocator* page_allocator();

528 529
  // Returns the PerIsolateThreadData for the current thread (or nullptr if one
  // is not currently set).
530 531
  static PerIsolateThreadData* CurrentPerIsolateThreadData() {
    return reinterpret_cast<PerIsolateThreadData*>(
532
        base::Thread::GetThreadLocal(per_isolate_thread_data_key_));
533 534
  }

535 536
  // Returns the isolate inside which the current thread is running or nullptr.
  V8_INLINE static Isolate* TryGetCurrent() {
537
    DCHECK_EQ(true, isolate_key_created_.load(std::memory_order_relaxed));
538
    return reinterpret_cast<Isolate*>(
539
        base::Thread::GetExistingThreadLocal(isolate_key_));
540 541 542 543 544
  }

  // Returns the isolate inside which the current thread is running.
  V8_INLINE static Isolate* Current() {
    Isolate* isolate = TryGetCurrent();
545
    DCHECK_NOT_NULL(isolate);
546 547 548
    return isolate;
  }

549 550 551 552 553 554
  // Usually called by Init(), but can be called early e.g. to allow
  // testing components that require logging but not the whole
  // isolate.
  //
  // Safe to call more than once.
  void InitializeLoggingAndCounters();
555
  bool InitializeCounters();  // Returns false if already initialized.
556

557 558 559
  bool InitWithoutSnapshot();
  bool InitWithSnapshot(ReadOnlyDeserializer* read_only_deserializer,
                        StartupDeserializer* startup_deserializer);
560 561

  // True if at least one thread Enter'ed this isolate.
562
  bool IsInUse() { return entry_stack_ != nullptr; }
563

564
  void ReleaseSharedPtrs();
565

566 567
  void ClearSerializerData();

568 569
  bool LogObjectRelocation();

570 571 572 573 574 575 576 577 578 579 580
  // Initializes the current thread to run this Isolate.
  // Not thread-safe. Multiple threads should not Enter/Exit the same isolate
  // at the same time, this should be prevented using external locking.
  void Enter();

  // Exits the current thread. The previosuly entered Isolate is restored
  // for the thread.
  // Not thread-safe. Multiple threads should not Enter/Exit the same isolate
  // at the same time, this should be prevented using external locking.
  void Exit();

581 582 583 584
  // Find the PerThread for this particular (isolate, thread) combination.
  // If one does not yet exist, allocate a new one.
  PerIsolateThreadData* FindOrAllocatePerThreadDataForThisThread();

585 586 587 588
  // Find the PerThread for this particular (isolate, thread) combination
  // If one does not yet exist, return null.
  PerIsolateThreadData* FindPerThreadDataForThisThread();

589 590 591 592
  // Find the PerThread for given (isolate, thread) combination
  // If one does not yet exist, return null.
  PerIsolateThreadData* FindPerThreadDataForThread(ThreadId thread_id);

593 594 595 596
  // Discard the PerThread for this particular (isolate, thread) combination
  // If one does not yet exist, no-op.
  void DiscardPerThreadDataForThisThread();

597
  // Mutex for serializing access to break control structures.
598
  base::RecursiveMutex* break_access() { return &break_access_; }
599

600
  Address get_address_from_id(IsolateAddressId id);
601 602

  // Access to top context (where the current function object was created).
603
  Context context() { return thread_local_top()->context_; }
604
  inline void set_context(Context context);
605
  Context* context_address() { return &thread_local_top()->context_; }
606 607

  // Access to current thread id.
608
  THREAD_LOCAL_TOP_ACCESSOR(ThreadId, thread_id)
609 610

  // Interface to pending exception.
611 612
  inline Object pending_exception();
  inline void set_pending_exception(Object exception_obj);
613
  inline void clear_pending_exception();
614

615
  V8_EXPORT_PRIVATE bool AreWasmThreadsEnabled(Handle<Context> context);
616

617
  THREAD_LOCAL_TOP_ADDRESS(Object, pending_exception)
618

619
  inline bool has_pending_exception();
620

621
  THREAD_LOCAL_TOP_ADDRESS(Context, pending_handler_context)
622
  THREAD_LOCAL_TOP_ADDRESS(Address, pending_handler_entrypoint)
623
  THREAD_LOCAL_TOP_ADDRESS(Address, pending_handler_constant_pool)
624 625 626
  THREAD_LOCAL_TOP_ADDRESS(Address, pending_handler_fp)
  THREAD_LOCAL_TOP_ADDRESS(Address, pending_handler_sp)

627 628
  THREAD_LOCAL_TOP_ACCESSOR(bool, external_caught_exception)

629
  v8::TryCatch* try_catch_handler() {
630
    return thread_local_top()->try_catch_handler_;
631 632
  }
  bool* external_caught_exception_address() {
633
    return &thread_local_top()->external_caught_exception_;
634
  }
635

636
  THREAD_LOCAL_TOP_ADDRESS(Object, scheduled_exception)
637

638
  inline void clear_pending_message();
639
  Address pending_message_obj_address() {
640
    return reinterpret_cast<Address>(&thread_local_top()->pending_message_obj_);
641 642
  }

643
  inline Object scheduled_exception();
644 645
  inline bool has_scheduled_exception();
  inline void clear_scheduled_exception();
646

647 648
  bool IsJavaScriptHandlerOnTop(Object exception);
  bool IsExternalHandlerOnTop(Object exception);
649

650
  inline bool is_catchable_by_javascript(Object exception);
651 652 653 654 655 656

  // JS execution stack (see frames.h).
  static Address c_entry_fp(ThreadLocalTop* thread) {
    return thread->c_entry_fp_;
  }
  static Address handler(ThreadLocalTop* thread) { return thread->handler_; }
657
  Address c_function() { return thread_local_top()->c_function_; }
658 659

  inline Address* c_entry_fp_address() {
660
    return &thread_local_top()->c_entry_fp_;
661
  }
662 663 664 665 666
  static uint32_t c_entry_fp_offset() {
    return static_cast<uint32_t>(
        OFFSET_OF(Isolate, thread_local_top()->c_entry_fp_) -
        isolate_root_bias());
  }
667
  inline Address* handler_address() { return &thread_local_top()->handler_; }
668
  inline Address* c_function_address() {
669
    return &thread_local_top()->c_function_;
670
  }
671

672
  // Bottom JS entry.
673
  Address js_entry_sp() { return thread_local_top()->js_entry_sp_; }
674
  inline Address* js_entry_sp_address() {
675
    return &thread_local_top()->js_entry_sp_;
676 677 678
  }

  // Returns the global object of the current context. It could be
679
  // a builtin object, or a JS global object.
680
  inline Handle<JSGlobalObject> global_object();
681 682

  // Returns the global proxy object of the current context.
683
  inline Handle<JSGlobalProxy> global_proxy();
684 685

  static int ArchiveSpacePerThread() { return sizeof(ThreadLocalTop); }
686
  void FreeThreadResources() { thread_local_top()->Free(); }
687 688 689 690 691

  // This method is called by the api after operations that may throw
  // exceptions.  If an exception was thrown and not handled by an external
  // handler the exception is scheduled to be rethrown when we return to running
  // JavaScript code.  If an exception is scheduled true is returned.
692
  V8_EXPORT_PRIVATE bool OptionalRescheduleException(bool clear_exception);
693

694
  // Push and pop a promise and the current try-catch handler.
695
  void PushPromise(Handle<JSObject> promise);
696
  void PopPromise();
697 698 699

  // Return the relevant Promise that a throw/rejection pertains to, based
  // on the contents of the Promise stack
700 701
  Handle<Object> GetPromiseOnStackOnThrow();

702 703 704
  // Heuristically guess whether a Promise is handled by user catch handler
  bool PromiseHasUserDefinedRejectHandler(Handle<Object> promise);

705 706
  class ExceptionScope {
   public:
707 708
    // Scope currently can only be used for regular exceptions,
    // not termination exception.
709 710
    inline explicit ExceptionScope(Isolate* isolate);
    inline ~ExceptionScope();
711 712 713 714 715 716

   private:
    Isolate* isolate_;
    Handle<Object> pending_exception_;
  };

717 718
  V8_EXPORT_PRIVATE void SetCaptureStackTraceForUncaughtExceptions(
      bool capture, int frame_limit, StackTrace::StackTraceOptions options);
719

720 721 722
  void SetAbortOnUncaughtExceptionCallback(
      v8::Isolate::AbortOnUncaughtExceptionCallback callback);

723
  enum PrintStackMode { kPrintStackConcise, kPrintStackVerbose };
724
  void PrintCurrentStackTrace(FILE* out);
725 726
  void PrintStack(StringStream* accumulator,
                  PrintStackMode mode = kPrintStackVerbose);
727 728
  V8_EXPORT_PRIVATE void PrintStack(FILE* out,
                                    PrintStackMode mode = kPrintStackVerbose);
729
  Handle<String> StackTraceString();
730 731
  // Stores a stack trace in a stack-allocated temporary buffer which will
  // end up in the minidump for debugging purposes.
732 733 734 735
  V8_NOINLINE void PushStackTraceAndDie(void* ptr1 = nullptr,
                                        void* ptr2 = nullptr,
                                        void* ptr3 = nullptr,
                                        void* ptr4 = nullptr);
736 737
  Handle<FixedArray> CaptureCurrentStackTrace(
      int frame_limit, StackTrace::StackTraceOptions options);
738
  Handle<Object> CaptureSimpleStackTrace(Handle<JSReceiver> error_object,
739
                                         FrameSkipMode mode,
740
                                         Handle<Object> caller);
741 742 743
  MaybeHandle<JSReceiver> CaptureAndSetDetailedStackTrace(
      Handle<JSReceiver> error_object);
  MaybeHandle<JSReceiver> CaptureAndSetSimpleStackTrace(
744 745
      Handle<JSReceiver> error_object, FrameSkipMode mode,
      Handle<Object> caller);
746
  Handle<FixedArray> GetDetailedStackTrace(Handle<JSObject> error_object);
747

748 749
  Address GetAbstractPC(int* line, int* column);

750
  // Returns if the given context may access the given global object. If
751 752
  // the result is false, the pending exception is guaranteed to be
  // set.
753
  bool MayAccess(Handle<Context> accessing_context, Handle<JSObject> receiver);
754

755
  void SetFailedAccessCheckCallback(v8::FailedAccessCheckCallback callback);
756
  void ReportFailedAccessCheck(Handle<JSObject> receiver);
757 758

  // Exception throwing support. The caller should use the result
jwolfe's avatar
jwolfe committed
759
  // of Throw() as its return value.
760 761
  Object Throw(Object exception, MessageLocation* location = nullptr);
  Object ThrowIllegalOperation();
762 763

  template <typename T>
764 765
  V8_WARN_UNUSED_RESULT MaybeHandle<T> Throw(
      Handle<Object> exception, MessageLocation* location = nullptr) {
766 767 768 769
    Throw(*exception, location);
    return MaybeHandle<T>();
  }

770 771 772 773 774
  void set_console_delegate(debug::ConsoleDelegate* delegate) {
    console_delegate_ = delegate;
  }
  debug::ConsoleDelegate* console_delegate() { return console_delegate_; }

775 776 777 778 779 780 781
  void set_async_event_delegate(debug::AsyncEventDelegate* delegate) {
    async_event_delegate_ = delegate;
    PromiseHookStateUpdated();
  }
  void OnAsyncFunctionStateChanged(Handle<JSPromise> promise,
                                   debug::DebugAsyncActionType);

782 783
  // Re-throw an exception.  This involves no error reporting since error
  // reporting was handled when the exception was thrown originally.
784
  Object ReThrow(Object exception);
785 786 787

  // Find the correct handler for the current pending exception. This also
  // clears and returns the current pending exception.
788
  Object UnwindAndFindHandler();
789

790
  // Tries to predict whether an exception will be caught. Note that this can
791
  // only produce an estimate, because it is undecidable whether a finally
792
  // clause will consume or re-throw an exception.
793 794 795 796
  enum CatchType {
    NOT_CAUGHT,
    CAUGHT_BY_JAVASCRIPT,
    CAUGHT_BY_EXTERNAL,
797 798 799
    CAUGHT_BY_DESUGARING,
    CAUGHT_BY_PROMISE,
    CAUGHT_BY_ASYNC_AWAIT
800
  };
801
  CatchType PredictExceptionCatcher();
802

803
  V8_EXPORT_PRIVATE void ScheduleThrow(Object exception);
804 805 806
  // Re-set pending message, script and positions reported to the TryCatch
  // back to the TLS for re-use when rethrowing.
  void RestorePendingMessageFromTryCatch(v8::TryCatch* handler);
807 808
  // Un-schedule an exception that was caught by a TryCatch handler.
  void CancelScheduledExceptionFromTryCatch(v8::TryCatch* handler);
809
  void ReportPendingMessages();
810 811 812 813 814
  void ReportPendingMessagesFromJavaScript();

  // Implements code shared between the two above methods
  void ReportPendingMessagesImpl(bool report_externally);

815
  // Promote a scheduled exception to pending. Asserts has_scheduled_exception.
816
  Object PromoteScheduledException();
817 818

  // Attempts to compute the current source location, storing the
819 820 821
  // result in the target out parameter. The source location is attached to a
  // Message object as the location which should be shown to the user. It's
  // typically the top-most meaningful location on the stack.
822
  bool ComputeLocation(MessageLocation* target);
823 824
  bool ComputeLocationFromException(MessageLocation* target,
                                    Handle<Object> exception);
825 826
  V8_EXPORT_PRIVATE bool ComputeLocationFromStackTrace(
      MessageLocation* target, Handle<Object> exception);
827

828 829
  V8_EXPORT_PRIVATE Handle<JSMessageObject> CreateMessage(
      Handle<Object> exception, MessageLocation* location);
830 831

  // Out of resource exception helpers.
832 833
  Object StackOverflow();
  Object TerminateExecution();
834
  void CancelTerminateExecution();
835

836 837
  V8_EXPORT_PRIVATE void RequestInterrupt(InterruptCallback callback,
                                          void* data);
838
  void InvokeApiInterruptCallbacks();
839

840
  // Administration
841 842 843
  void Iterate(RootVisitor* v);
  void Iterate(RootVisitor* v, ThreadLocalTop* t);
  char* Iterate(RootVisitor* v, char* t);
844 845
  void IterateThread(ThreadVisitor* v, char* t);

846
  // Returns the current native context.
847
  inline Handle<NativeContext> native_context();
848
  inline NativeContext raw_native_context();
849

850 851
  Handle<Context> GetIncumbentContext();

852 853 854 855 856 857 858 859 860 861
  void RegisterTryCatchHandler(v8::TryCatch* that);
  void UnregisterTryCatchHandler(v8::TryCatch* that);

  char* ArchiveThread(char* to);
  char* RestoreThread(char* from);

  static const int kUC16AlphabetSize = 256;  // See StringSearchBase.
  static const int kBMMaxShift = 250;        // See StringSearchBase.

  // Accessors.
862 863 864 865 866 867 868 869
#define GLOBAL_ACCESSOR(type, name, initialvalue)                \
  inline type name() const {                                     \
    DCHECK(OFFSET_OF(Isolate, name##_) == name##_debug_offset_); \
    return name##_;                                              \
  }                                                              \
  inline void set_##name(type value) {                           \
    DCHECK(OFFSET_OF(Isolate, name##_) == name##_debug_offset_); \
    name##_ = value;                                             \
870 871 872 873
  }
  ISOLATE_INIT_LIST(GLOBAL_ACCESSOR)
#undef GLOBAL_ACCESSOR

874 875 876 877
#define GLOBAL_ARRAY_ACCESSOR(type, name, length)                \
  inline type* name() {                                          \
    DCHECK(OFFSET_OF(Isolate, name##_) == name##_debug_offset_); \
    return &(name##_)[0];                                        \
878 879 880 881
  }
  ISOLATE_INIT_ARRAY_LIST(GLOBAL_ARRAY_ACCESSOR)
#undef GLOBAL_ARRAY_ACCESSOR

882 883
#define NATIVE_CONTEXT_FIELD_ACCESSOR(index, type, name) \
  inline Handle<type> name();                            \
884
  inline bool is_##name(type value);
885 886
  NATIVE_CONTEXT_FIELDS(NATIVE_CONTEXT_FIELD_ACCESSOR)
#undef NATIVE_CONTEXT_FIELD_ACCESSOR
887 888

  Bootstrapper* bootstrapper() { return bootstrapper_; }
889 890 891 892 893 894 895
  // Use for updating counters on a foreground thread.
  Counters* counters() { return async_counters().get(); }
  // Use for updating counters on a background thread.
  const std::shared_ptr<Counters>& async_counters() {
    // Make sure InitializeCounters() has been called.
    DCHECK_NOT_NULL(async_counters_.get());
    return async_counters_;
896
  }
897 898
  RuntimeProfiler* runtime_profiler() { return runtime_profiler_; }
  CompilationCache* compilation_cache() { return compilation_cache_; }
899 900 901
  Logger* logger() {
    // Call InitializeLoggingAndCounters() if logging is needed before
    // the isolate is fully initialized.
902
    DCHECK_NOT_NULL(logger_);
903 904
    return logger_;
  }
905
  StackGuard* stack_guard() { return isolate_data()->stack_guard(); }
906
  Heap* heap() { return &heap_; }
907
  ReadOnlyHeap* read_only_heap() const { return read_only_heap_; }
908 909 910 911
  static Isolate* FromHeap(Heap* heap) {
    return reinterpret_cast<Isolate*>(reinterpret_cast<Address>(heap) -
                                      OFFSET_OF(Isolate, heap_));
  }
912

913 914
  const IsolateData* isolate_data() const { return &isolate_data_; }
  IsolateData* isolate_data() { return &isolate_data_; }
915

916 917 918 919
  // Generated code can embed this address to get access to the isolate-specific
  // data (for example, roots, external references, builtins, etc.).
  // The kRootRegister is set to this value.
  Address isolate_root() const { return isolate_data()->isolate_root(); }
920 921 922
  static size_t isolate_root_bias() {
    return OFFSET_OF(Isolate, isolate_data_) + IsolateData::kIsolateRootBias;
  }
923 924 925
  static Isolate* FromRoot(Address isolate_root) {
    return reinterpret_cast<Isolate*>(isolate_root - isolate_root_bias());
  }
926

927
  RootsTable& roots_table() { return isolate_data()->roots(); }
928

929 930 931 932 933 934 935 936 937 938 939
  // A sub-region of the Isolate object that has "predictable" layout which
  // depends only on the pointer size and therefore it's guaranteed that there
  // will be no compatibility issues because of different compilers used for
  // snapshot generator and actual V8 code.
  // Thus, kRootRegister may be used to address any location that falls into
  // this region.
  // See IsolateData::AssertPredictableLayout() for details.
  base::AddressRegion root_register_addressable_region() const {
    return base::AddressRegion(reinterpret_cast<Address>(&isolate_data_),
                               sizeof(IsolateData));
  }
940

941
  Object root(RootIndex index) { return Object(roots_table()[index]); }
942 943 944 945 946

  Handle<Object> root_handle(RootIndex index) {
    return Handle<Object>(&roots_table()[index]);
  }

947 948 949 950 951
  ExternalReferenceTable* external_reference_table() {
    DCHECK(isolate_data()->external_reference_table()->is_initialized());
    return isolate_data()->external_reference_table();
  }

952
  Address* builtin_entry_table() { return isolate_data_.builtin_entry_table(); }
953
  V8_INLINE Address* builtins_table() { return isolate_data_.builtins(); }
954

955 956
  StubCache* load_stub_cache() { return load_stub_cache_; }
  StubCache* store_stub_cache() { return store_stub_cache_; }
957
  DeoptimizerData* deoptimizer_data() { return deoptimizer_data_; }
958 959 960 961
  bool deoptimizer_lazy_throw() const { return deoptimizer_lazy_throw_; }
  void set_deoptimizer_lazy_throw(bool value) {
    deoptimizer_lazy_throw_ = value;
  }
962 963 964 965 966 967
  ThreadLocalTop* thread_local_top() {
    return &isolate_data_.thread_local_top_;
  }
  ThreadLocalTop const* thread_local_top() const {
    return &isolate_data_.thread_local_top_;
  }
968 969 970 971 972 973 974 975

  static uint32_t thread_in_wasm_flag_address_offset() {
    // For WebAssembly trap handlers there is a flag in thread-local storage
    // which indicates that the executing thread executes WebAssembly code. To
    // access this flag directly from generated code, we store a pointer to the
    // flag in ThreadLocalTop in thread_in_wasm_flag_address_. This function
    // here returns the offset of that member from {isolate_root()}.
    return static_cast<uint32_t>(
976
        OFFSET_OF(Isolate, thread_local_top()->thread_in_wasm_flag_address_) -
977 978 979
        isolate_root_bias());
  }

jarin@chromium.org's avatar
jarin@chromium.org committed
980 981 982
  MaterializedObjectStore* materialized_object_store() {
    return materialized_object_store_;
  }
983 984 985 986 987

  DescriptorLookupCache* descriptor_lookup_cache() {
    return descriptor_lookup_cache_;
  }

988 989
  HandleScopeData* handle_scope_data() { return &handle_scope_data_; }

990
  HandleScopeImplementer* handle_scope_implementer() {
991
    DCHECK(handle_scope_implementer_);
992 993 994
    return handle_scope_implementer_;
  }

995
  UnicodeCache* unicode_cache() { return unicode_cache_; }
996

997 998 999
  InnerPointerToCodeCache* inner_pointer_to_code_cache() {
    return inner_pointer_to_code_cache_;
  }
1000 1001 1002

  GlobalHandles* global_handles() { return global_handles_; }

1003 1004
  EternalHandles* eternal_handles() { return eternal_handles_; }

1005 1006
  ThreadManager* thread_manager() { return thread_manager_; }

1007
#ifndef V8_INTL_SUPPORT
1008 1009 1010 1011 1012 1013 1014 1015 1016
  unibrow::Mapping<unibrow::Ecma262UnCanonicalize>* jsregexp_uncanonicalize() {
    return &jsregexp_uncanonicalize_;
  }

  unibrow::Mapping<unibrow::CanonicalizationRange>* jsregexp_canonrange() {
    return &jsregexp_canonrange_;
  }

  unibrow::Mapping<unibrow::Ecma262Canonicalize>*
1017
  regexp_macro_assembler_canonicalize() {
1018 1019
    return &regexp_macro_assembler_canonicalize_;
  }
1020 1021 1022 1023 1024
#endif  // !V8_INTL_SUPPORT

  RuntimeState* runtime_state() { return &runtime_state_; }

  Builtins* builtins() { return &builtins_; }
1025 1026 1027

  RegExpStack* regexp_stack() { return regexp_stack_; }

1028 1029 1030 1031 1032
  size_t total_regexp_code_generated() { return total_regexp_code_generated_; }
  void IncreaseTotalRegexpCodeGenerated(int size) {
    total_regexp_code_generated_ += size;
  }

1033
  std::vector<int>* regexp_indices() { return &regexp_indices_; }
1034

1035
  Debug* debug() { return debug_; }
1036

1037
  bool* is_profiling_address() { return &is_profiling_; }
1038 1039 1040
  CodeEventDispatcher* code_event_dispatcher() const {
    return code_event_dispatcher_.get();
  }
1041
  HeapProfiler* heap_profiler() const { return heap_profiler_; }
1042

1043
#ifdef DEBUG
1044
  static size_t non_disposed_isolates() { return non_disposed_isolates_; }
1045 1046
#endif

1047 1048 1049
  v8::internal::Factory* factory() {
    // Upcast to the privately inherited base-class using c-style casts to avoid
    // undefined behavior (as static_cast cannot cast across private bases).
1050
    // NOLINTNEXTLINE (google-readability-casting)
1051 1052
    return (v8::internal::Factory*)this;  // NOLINT(readability/casting)
  }
1053

1054
  static const int kJSRegexpStaticOffsetsVectorSize = 128;
1055

1056
  THREAD_LOCAL_TOP_ACCESSOR(ExternalCallbackScope*, external_callback_scope)
1057

1058
  THREAD_LOCAL_TOP_ACCESSOR(StateTag, current_vm_state)
1059

1060
  void SetData(uint32_t slot, void* data) {
1061
    DCHECK_LT(slot, Internals::kNumIsolateDataSlots);
1062
    isolate_data_.embedder_data_[slot] = data;
1063 1064
  }
  void* GetData(uint32_t slot) {
1065
    DCHECK_LT(slot, Internals::kNumIsolateDataSlots);
1066
    return isolate_data_.embedder_data_[slot];
1067
  }
1068

1069
  bool serializer_enabled() const { return serializer_enabled_; }
1070 1071 1072

  void enable_serializer() { serializer_enabled_ = true; }

1073
  bool snapshot_available() const {
1074
    return snapshot_blob_ != nullptr && snapshot_blob_->raw_size != 0;
1075
  }
1076

1077 1078 1079
  bool IsDead() { return has_fatal_error_; }
  void SignalFatalError() { has_fatal_error_ = true; }

1080
  V8_EXPORT_PRIVATE bool use_optimizer();
1081

1082 1083
  bool initialized_from_snapshot() { return initialized_from_snapshot_; }

1084 1085
  bool NeedsSourcePositionsForProfiling() const;

1086
  V8_EXPORT_PRIVATE bool NeedsDetailedOptimizedCodeLineInfo() const;
1087

1088
  bool is_best_effort_code_coverage() const {
1089
    return code_coverage_mode() == debug::CoverageMode::kBestEffort;
1090 1091 1092
  }

  bool is_precise_count_code_coverage() const {
1093
    return code_coverage_mode() == debug::CoverageMode::kPreciseCount;
1094 1095
  }

1096
  bool is_precise_binary_code_coverage() const {
1097
    return code_coverage_mode() == debug::CoverageMode::kPreciseBinary;
1098 1099
  }

1100
  bool is_block_count_code_coverage() const {
1101
    return code_coverage_mode() == debug::CoverageMode::kBlockCount;
1102 1103
  }

1104
  bool is_block_binary_code_coverage() const {
1105
    return code_coverage_mode() == debug::CoverageMode::kBlockBinary;
1106 1107 1108 1109 1110 1111
  }

  bool is_block_code_coverage() const {
    return is_block_count_code_coverage() || is_block_binary_code_coverage();
  }

1112 1113 1114 1115 1116 1117 1118 1119
  bool is_binary_code_coverage() const {
    return is_precise_binary_code_coverage() || is_block_binary_code_coverage();
  }

  bool is_count_code_coverage() const {
    return is_precise_count_code_coverage() || is_block_count_code_coverage();
  }

1120
  bool is_collecting_type_profile() const {
1121
    return type_profile_mode() == debug::TypeProfileMode::kCollect;
1122 1123
  }

1124 1125 1126 1127 1128
  // Collect feedback vectors with data for code coverage or type profile.
  // Reset the list, when both code coverage and type profile are not
  // needed anymore. This keeps many feedback vectors alive, but code
  // coverage or type profile are used for debugging only and increase in
  // memory usage is expected.
1129
  void SetFeedbackVectorsForProfilingTools(Object value);
1130

1131
  void MaybeInitializeVectorListFromHeap();
1132

1133
  double time_millis_since_init() {
1134
    return heap_.MonotonicallyIncreasingTimeInMs() - time_millis_at_init_;
1135 1136
  }

1137
  DateCache* date_cache() { return date_cache_; }
1138

1139
  V8_EXPORT_PRIVATE void set_date_cache(DateCache* date_cache);
1140

1141 1142
#ifdef V8_INTL_SUPPORT

1143 1144
  const std::string& default_locale() { return default_locale_; }

1145 1146
  void ResetDefaultLocale() { default_locale_.clear(); }

1147 1148 1149 1150 1151
  void set_default_locale(const std::string& locale) {
    DCHECK_EQ(default_locale_.length(), 0);
    default_locale_ = locale;
  }

1152 1153 1154 1155 1156
  // enum to access the icu object cache.
  enum class ICUObjectCacheType{
      kDefaultCollator, kDefaultNumberFormat, kDefaultSimpleDateFormat,
      kDefaultSimpleDateFormatForTime, kDefaultSimpleDateFormatForDate};

1157
  icu::UMemory* get_cached_icu_object(ICUObjectCacheType cache_type);
1158
  void set_icu_object_in_cache(ICUObjectCacheType cache_type,
1159
                               std::shared_ptr<icu::UMemory> obj);
1160 1161
  void clear_cached_icu_object(ICUObjectCacheType cache_type);

1162 1163
#endif  // V8_INTL_SUPPORT

1164 1165
  static const int kProtectorValid = 1;
  static const int kProtectorInvalid = 0;
1166

1167
  inline bool IsArrayConstructorIntact();
1168 1169 1170 1171

  // The version with an explicit context parameter can be used when
  // Isolate::context is not set up, e.g. when calling directly into C++ from
  // CSA.
1172
  bool IsNoElementsProtectorIntact(Context context);
1173
  V8_EXPORT_PRIVATE bool IsNoElementsProtectorIntact();
1174

1175
  bool IsArrayOrObjectOrStringPrototype(Object object);
1176

1177 1178
  inline bool IsArraySpeciesLookupChainIntact();
  inline bool IsTypedArraySpeciesLookupChainIntact();
1179 1180
  inline bool IsRegExpSpeciesLookupChainIntact(
      Handle<NativeContext> native_context);
1181 1182 1183 1184 1185

  // Check that the @@species protector is intact, which guards the lookup of
  // "constructor" on JSPromise instances, whose [[Prototype]] is the initial
  // %PromisePrototype%, and the Symbol.species lookup on the
  // %PromisePrototype%.
1186
  inline bool IsPromiseSpeciesLookupChainIntact();
1187

1188
  bool IsIsConcatSpreadableLookupChainIntact();
1189
  bool IsIsConcatSpreadableLookupChainIntact(JSReceiver receiver);
1190
  inline bool IsStringLengthOverflowIntact();
1191
  inline bool IsArrayIteratorLookupChainIntact();
1192

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
  // The MapIterator protector protects the original iteration behaviors of
  // Map.prototype.keys(), Map.prototype.values(), and Set.prototype.entries().
  // It does not protect the original iteration behavior of
  // Map.prototype[Symbol.iterator](). The protector is invalidated when:
  // * The 'next' property is set on an object where the property holder is the
  //   %MapIteratorPrototype% (e.g. because the object is that very prototype).
  // * The 'Symbol.iterator' property is set on an object where the property
  //   holder is the %IteratorPrototype%. Note that this also invalidates the
  //   SetIterator protector (see below).
  inline bool IsMapIteratorLookupChainIntact();

  // The SetIterator protector protects the original iteration behavior of
  // Set.prototype.keys(), Set.prototype.values(), Set.prototype.entries(),
  // and Set.prototype[Symbol.iterator](). The protector is invalidated when:
  // * The 'next' property is set on an object where the property holder is the
  //   %SetIteratorPrototype% (e.g. because the object is that very prototype).
  // * The 'Symbol.iterator' property is set on an object where the property
  //   holder is the %SetPrototype% OR %IteratorPrototype%. This means that
  //   setting Symbol.iterator on a MapIterator object can also invalidate the
  //   SetIterator protector, and vice versa, setting Symbol.iterator on a
  //   SetIterator object can also invalidate the MapIterator. This is an over-
  //   approximation for the sake of simplicity.
  inline bool IsSetIteratorLookupChainIntact();

  // The StringIteratorProtector protects the original string iteration behavior
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
  // for primitive strings. As long as the StringIteratorProtector is valid,
  // iterating over a primitive string is guaranteed to be unobservable from
  // user code and can thus be cut short. More specifically, the protector gets
  // invalidated as soon as either String.prototype[Symbol.iterator] or
  // String.prototype[Symbol.iterator]().next is modified. This guarantee does
  // not apply to string objects (as opposed to primitives), since they could
  // define their own Symbol.iterator.
  // String.prototype itself does not need to be protected, since it is
  // non-configurable and non-writable.
  inline bool IsStringIteratorLookupChainIntact();

1229 1230
  // Make sure we do check for detached array buffers.
  inline bool IsArrayBufferDetachingIntact();
1231

1232
  // Disable promise optimizations if promise (debug) hooks have ever been
1233
  // active, because those can observe promises.
1234 1235
  bool IsPromiseHookProtectorIntact();

1236 1237 1238 1239
  // Make sure a lookup of "resolve" on the %Promise% intrinsic object
  // yeidls the initial Promise.resolve method.
  bool IsPromiseResolveLookupChainIntact();

1240
  // Make sure a lookup of "then" on any JSPromise whose [[Prototype]] is the
1241 1242 1243 1244
  // initial %PromisePrototype% yields the initial method. In addition this
  // protector also guards the negative lookup of "then" on the intrinsic
  // %ObjectPrototype%, meaning that such lookups are guaranteed to yield
  // undefined without triggering any side-effects.
1245
  bool IsPromiseThenLookupChainIntact();
1246
  bool IsPromiseThenLookupChainIntact(Handle<JSReceiver> receiver);
1247

1248 1249 1250 1251
  // On intent to set an element in object, make sure that appropriate
  // notifications occur if the set is on the elements of the array or
  // object prototype. Also ensure that changes to prototype chain between
  // Array and Object fire notifications.
1252 1253 1254
  void UpdateNoElementsProtectorOnSetElement(Handle<JSObject> object);
  void UpdateNoElementsProtectorOnSetLength(Handle<JSObject> object) {
    UpdateNoElementsProtectorOnSetElement(object);
1255
  }
1256 1257
  void UpdateNoElementsProtectorOnSetPrototype(Handle<JSObject> object) {
    UpdateNoElementsProtectorOnSetElement(object);
1258
  }
1259 1260
  void UpdateNoElementsProtectorOnNormalizeElements(Handle<JSObject> object) {
    UpdateNoElementsProtectorOnSetElement(object);
1261
  }
1262 1263 1264 1265

  // The `protector_name` C string must be statically allocated.
  void TraceProtectorInvalidation(const char* protector_name);

1266
  void InvalidateArrayConstructorProtector();
1267 1268
  void InvalidateArraySpeciesProtector();
  void InvalidateTypedArraySpeciesProtector();
1269
  void InvalidateRegExpSpeciesProtector(Handle<NativeContext> native_context);
1270
  void InvalidatePromiseSpeciesProtector();
1271
  void InvalidateIsConcatSpreadableProtector();
1272
  void InvalidateStringLengthOverflowProtector();
1273
  void InvalidateArrayIteratorProtector();
1274 1275
  void InvalidateMapIteratorProtector();
  void InvalidateSetIteratorProtector();
1276
  void InvalidateStringIteratorProtector();
1277
  void InvalidateArrayBufferDetachingProtector();
1278
  V8_EXPORT_PRIVATE void InvalidatePromiseHookProtector();
1279
  void InvalidatePromiseResolveProtector();
1280
  void InvalidatePromiseThenProtector();
1281 1282 1283 1284

  // Returns true if array is the initial array prototype in any native context.
  bool IsAnyInitialArrayPrototype(Handle<JSArray> array);

1285
  void IterateDeferredHandles(RootVisitor* visitor);
1286 1287 1288
  void LinkDeferredHandles(DeferredHandles* deferred_handles);
  void UnlinkDeferredHandles(DeferredHandles* deferred_handles);

1289
#ifdef DEBUG
1290
  bool IsDeferredHandle(Address* location);
1291 1292
#endif  // DEBUG

1293 1294
  bool concurrent_recompilation_enabled() {
    // Thread is only available with flag enabled.
1295
    DCHECK(optimizing_compile_dispatcher_ == nullptr ||
1296
           FLAG_concurrent_recompilation);
1297
    return optimizing_compile_dispatcher_ != nullptr;
1298 1299
  }

1300 1301
  OptimizingCompileDispatcher* optimizing_compile_dispatcher() {
    return optimizing_compile_dispatcher_;
1302
  }
1303 1304 1305
  // Flushes all pending concurrent optimzation jobs from the optimizing
  // compile dispatcher's queue.
  void AbortConcurrentOptimization(BlockingBehavior blocking_behavior);
1306

1307
  int id() const { return id_; }
1308

1309
  CompilationStatistics* GetTurboStatistics();
1310
  V8_EXPORT_PRIVATE CodeTracer* GetCodeTracer();
1311

1312
  void DumpAndResetStats();
1313

1314 1315
  void* stress_deopt_count_address() { return &stress_deopt_count_; }

1316 1317
  void set_force_slow_path(bool v) { force_slow_path_ = v; }
  bool force_slow_path() const { return force_slow_path_; }
1318 1319
  bool* force_slow_path_address() { return &force_slow_path_; }

1320 1321 1322 1323
  DebugInfo::ExecutionMode* debug_execution_mode_address() {
    return &debug_execution_mode_;
  }

1324
  V8_EXPORT_PRIVATE base::RandomNumberGenerator* random_number_generator();
1325

1326 1327
  V8_EXPORT_PRIVATE base::RandomNumberGenerator* fuzzer_rng();

1328 1329 1330 1331
  // Generates a random number that is non-zero when masked
  // with the provided mask.
  int GenerateIdentityHash(uint32_t mask);

1332
  // Given an address occupied by a live code object, return that object.
1333
  V8_EXPORT_PRIVATE Code FindCodeObject(Address a);
1334

1335 1336 1337 1338 1339 1340 1341 1342
  int NextOptimizationId() {
    int id = next_optimization_id_++;
    if (!Smi::IsValid(next_optimization_id_)) {
      next_optimization_id_ = 0;
    }
    return id;
  }

1343 1344 1345
  void AddNearHeapLimitCallback(v8::NearHeapLimitCallback, void* data);
  void RemoveNearHeapLimitCallback(v8::NearHeapLimitCallback callback,
                                   size_t heap_limit);
1346 1347
  void AddCallCompletedCallback(CallCompletedCallback callback);
  void RemoveCallCompletedCallback(CallCompletedCallback callback);
1348
  void FireCallCompletedCallback(MicrotaskQueue* microtask_queue);
1349

1350 1351
  void AddBeforeCallEnteredCallback(BeforeCallEnteredCallback callback);
  void RemoveBeforeCallEnteredCallback(BeforeCallEnteredCallback callback);
1352
  inline void FireBeforeCallEnteredCallback();
1353

1354
  void SetPromiseRejectCallback(PromiseRejectCallback callback);
1355
  void ReportPromiseReject(Handle<JSPromise> promise, Handle<Object> value,
1356 1357
                           v8::PromiseRejectEvent event);

1358
  void SetTerminationOnExternalTryCatch();
1359

1360 1361
  Handle<Symbol> SymbolFor(RootIndex dictionary_index, Handle<String> name,
                           bool private_symbol);
1362

1363 1364
  V8_EXPORT_PRIVATE void SetUseCounterCallback(
      v8::Isolate::UseCounterCallback callback);
1365 1366
  void CountUsage(v8::Isolate::UseCounterFeature feature);

1367
  static std::string GetTurboCfgFileName(Isolate* isolate);
1368

1369
#if V8_SFI_HAS_UNIQUE_ID
1370 1371 1372
  int GetNextUniqueSharedFunctionInfoId() { return next_unique_sfi_id_++; }
#endif

1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
  Address promise_hook_address() {
    return reinterpret_cast<Address>(&promise_hook_);
  }

  Address async_event_delegate_address() {
    return reinterpret_cast<Address>(&async_event_delegate_);
  }

  Address promise_hook_or_async_event_delegate_address() {
    return reinterpret_cast<Address>(&promise_hook_or_async_event_delegate_);
1383
  }
1384

1385 1386 1387 1388 1389
  Address promise_hook_or_debug_is_active_or_async_event_delegate_address() {
    return reinterpret_cast<Address>(
        &promise_hook_or_debug_is_active_or_async_event_delegate_);
  }

1390 1391 1392 1393
  Address handle_scope_implementer_address() {
    return reinterpret_cast<Address>(&handle_scope_implementer_);
  }

1394 1395 1396 1397
  void SetAtomicsWaitCallback(v8::Isolate::AtomicsWaitCallback callback,
                              void* data);
  void RunAtomicsWaitCallback(v8::Isolate::AtomicsWaitEvent event,
                              Handle<JSArrayBuffer> array_buffer,
1398
                              size_t offset_in_bytes, int64_t value,
1399 1400 1401
                              double timeout_in_ms,
                              AtomicsWaitWakeHandle* stop_handle);

1402 1403 1404 1405
  V8_EXPORT_PRIVATE void SetPromiseHook(PromiseHook hook);
  V8_EXPORT_PRIVATE void RunPromiseHook(PromiseHookType type,
                                        Handle<JSPromise> promise,
                                        Handle<Object> parent);
1406
  void PromiseHookStateUpdated();
1407

1408 1409 1410
  void AddDetachedContext(Handle<Context> context);
  void CheckDetachedContextsAfterGC();

1411
  std::vector<Object>* partial_snapshot_cache() {
1412 1413
    return &partial_snapshot_cache_;
  }
1414

1415 1416
  // Off-heap builtins cannot embed constants within the code object itself,
  // and thus need to load them from the root list.
1417
  bool IsGeneratingEmbeddedBuiltins() const {
1418 1419
    return FLAG_embedded_builtins &&
           builtins_constants_table_builder() != nullptr;
1420 1421
  }

1422 1423 1424
  BuiltinsConstantsTableBuilder* builtins_constants_table_builder() const {
    return builtins_constants_table_builder_;
  }
1425

1426 1427 1428 1429 1430
  // Hashes bits of the Isolate that are relevant for embedded builtins. In
  // particular, the embedded blob requires builtin Code object layout and the
  // builtins constants table to remain unchanged from build-time.
  size_t HashIsolateForEmbeddedBlob();

1431 1432
  V8_EXPORT_PRIVATE static const uint8_t* CurrentEmbeddedBlob();
  V8_EXPORT_PRIVATE static uint32_t CurrentEmbeddedBlobSize();
1433
  static bool CurrentEmbeddedBlobIsBinaryEmbedded();
1434

1435 1436
  // These always return the same result as static methods above, but don't
  // access the global atomic variable (and thus *might be* slightly faster).
1437 1438
  const uint8_t* embedded_blob() const;
  uint32_t embedded_blob_size() const;
1439

1440 1441 1442 1443 1444 1445 1446
  void set_array_buffer_allocator(v8::ArrayBuffer::Allocator* allocator) {
    array_buffer_allocator_ = allocator;
  }
  v8::ArrayBuffer::Allocator* array_buffer_allocator() const {
    return array_buffer_allocator_;
  }

binji's avatar
binji committed
1447 1448
  FutexWaitListNode* futex_wait_list_node() { return &futex_wait_list_node_; }

1449 1450 1451
  CancelableTaskManager* cancelable_task_manager() {
    return cancelable_task_manager_;
  }
1452

1453
  const AstStringConstants* ast_string_constants() const {
1454 1455 1456
    return ast_string_constants_;
  }

1457 1458
  interpreter::Interpreter* interpreter() const { return interpreter_; }

1459 1460 1461 1462 1463 1464 1465 1466 1467
  compiler::PerIsolateCompilerCache* compiler_cache() const {
    return compiler_cache_;
  }
  void set_compiler_utils(compiler::PerIsolateCompilerCache* cache,
                          Zone* zone) {
    compiler_cache_ = cache;
    compiler_zone_ = zone;
  }

1468
  AccountingAllocator* allocator() { return allocator_; }
1469

1470 1471
  CompilerDispatcher* compiler_dispatcher() const {
    return compiler_dispatcher_;
1472 1473
  }

1474
  bool IsInAnyContext(Object object, uint32_t index);
1475

1476 1477 1478 1479 1480
  void ClearKeptObjects();
  void SetHostCleanupFinalizationGroupCallback(
      HostCleanupFinalizationGroupCallback callback);
  void RunHostCleanupFinalizationGroupCallback(Handle<JSFinalizationGroup> fg);

1481 1482
  void SetHostImportModuleDynamicallyCallback(
      HostImportModuleDynamicallyCallback callback);
1483 1484 1485
  V8_EXPORT_PRIVATE MaybeHandle<JSPromise>
  RunHostImportModuleDynamicallyCallback(Handle<Script> referrer,
                                         Handle<Object> specifier);
1486

1487 1488
  void SetHostInitializeImportMetaObjectCallback(
      HostInitializeImportMetaObjectCallback callback);
1489
  V8_EXPORT_PRIVATE Handle<JSObject> RunHostInitializeImportMetaObjectCallback(
1490
      Handle<SourceTextModule> module);
1491

1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
  void RegisterEmbeddedFileWriter(EmbeddedFileWriterInterface* writer) {
    embedded_file_writer_ = writer;
  }

  int LookupOrAddExternallyCompiledFilename(const char* filename);
  const char* GetExternallyCompiledFilename(int index) const;
  int GetExternallyCompiledFilenameCount() const;
  // PrepareBuiltinSourcePositionMap is necessary in order to preserve the
  // builtin source positions before the corresponding code objects are
  // replaced with trampolines. Those source positions are used to
  // annotate the builtin blob with debugging information.
  void PrepareBuiltinSourcePositionMap();

1505
#if defined(V8_OS_WIN64)
1506 1507 1508
  void SetBuiltinUnwindData(
      int builtin_index,
      const win64_unwindinfo::BuiltinUnwindInfo& unwinding_info);
1509
#endif  // V8_OS_WIN64
1510

1511 1512
  void SetPrepareStackTraceCallback(PrepareStackTraceCallback callback);
  MaybeHandle<Object> RunPrepareStackTraceCallback(Handle<Context>,
1513 1514
                                                   Handle<JSObject> Error,
                                                   Handle<JSArray> sites);
1515 1516
  bool HasPrepareStackTraceCallback() const;

hpayer's avatar
hpayer committed
1517 1518
  void SetRAILMode(RAILMode rail_mode);

1519
  RAILMode rail_mode() { return rail_mode_.load(); }
1520 1521 1522

  double LoadStartTimeMs();

1523 1524 1525 1526 1527 1528
  void IsolateInForegroundNotification();

  void IsolateInBackgroundNotification();

  bool IsIsolateInBackground() { return is_isolate_in_background_; }

1529 1530 1531 1532 1533 1534
  void EnableMemorySavingsMode() { memory_savings_mode_active_ = true; }

  void DisableMemorySavingsMode() { memory_savings_mode_active_ = false; }

  bool IsMemorySavingsModeActive() { return memory_savings_mode_active_; }

1535
  PRINTF_FORMAT(2, 3) void PrintWithTimestamp(const char* format, ...);
1536

1537 1538 1539
  void set_allow_atomics_wait(bool set) { allow_atomics_wait_ = set; }
  bool allow_atomics_wait() { return allow_atomics_wait_; }

1540
  // Register a finalizer to be called at isolate teardown.
1541 1542
  V8_EXPORT_PRIVATE void RegisterManagedPtrDestructor(
      ManagedPtrDestructor* finalizer);
1543

1544 1545
  // Removes a previously-registered shared object finalizer.
  void UnregisterManagedPtrDestructor(ManagedPtrDestructor* finalizer);
1546

1547 1548 1549 1550 1551
  size_t elements_deletion_counter() { return elements_deletion_counter_; }
  void set_elements_deletion_counter(size_t value) {
    elements_deletion_counter_ = value;
  }

1552
  wasm::WasmEngine* wasm_engine() const { return wasm_engine_.get(); }
1553 1554
  V8_EXPORT_PRIVATE void SetWasmEngine(
      std::shared_ptr<wasm::WasmEngine> engine);
1555

1556 1557 1558 1559 1560 1561 1562 1563
  const v8::Context::BackupIncumbentScope* top_backup_incumbent_scope() const {
    return top_backup_incumbent_scope_;
  }
  void set_top_backup_incumbent_scope(
      const v8::Context::BackupIncumbentScope* top_backup_incumbent_scope) {
    top_backup_incumbent_scope_ = top_backup_incumbent_scope;
  }

1564
  V8_EXPORT_PRIVATE void SetIdle(bool is_idle);
1565

1566
 private:
1567
  explicit Isolate(std::unique_ptr<IsolateAllocator> isolate_allocator);
1568
  ~Isolate();
1569

1570 1571
  V8_EXPORT_PRIVATE bool Init(ReadOnlyDeserializer* read_only_deserializer,
                              StartupDeserializer* startup_deserializer);
1572

1573
  void CheckIsolateLayout();
1574

1575 1576
  class ThreadDataTable {
   public:
1577
    ThreadDataTable() = default;
1578

1579
    PerIsolateThreadData* Lookup(ThreadId thread_id);
1580 1581
    void Insert(PerIsolateThreadData* data);
    void Remove(PerIsolateThreadData* data);
1582
    void RemoveAllThreads();
1583 1584

   private:
1585 1586 1587 1588 1589 1590 1591
    struct Hasher {
      std::size_t operator()(const ThreadId& t) const {
        return std::hash<int>()(t.ToInteger());
      }
    };

    std::unordered_map<ThreadId, PerIsolateThreadData*, Hasher> table_;
1592 1593 1594 1595 1596 1597
  };

  // These items form a stack synchronously with threads Enter'ing and Exit'ing
  // the Isolate. The top of the stack points to a thread which is currently
  // running the Isolate. When the stack is empty, the Isolate is considered
  // not entered by any thread and can be Disposed.
thakis's avatar
thakis committed
1598
  // If the same thread enters the Isolate more than once, the entry_count_
1599 1600 1601 1602
  // is incremented rather then a new item pushed to the stack.
  class EntryStackItem {
   public:
    EntryStackItem(PerIsolateThreadData* previous_thread_data,
1603
                   Isolate* previous_isolate, EntryStackItem* previous_item)
1604 1605 1606
        : entry_count(1),
          previous_thread_data(previous_thread_data),
          previous_isolate(previous_isolate),
1607
          previous_item(previous_item) {}
1608 1609 1610 1611 1612 1613

    int entry_count;
    PerIsolateThreadData* previous_thread_data;
    Isolate* previous_isolate;
    EntryStackItem* previous_item;

1614
   private:
1615 1616 1617
    DISALLOW_COPY_AND_ASSIGN(EntryStackItem);
  };

1618 1619
  static base::Thread::LocalStorageKey per_isolate_thread_data_key_;
  static base::Thread::LocalStorageKey isolate_key_;
1620

1621 1622
#ifdef DEBUG
  static std::atomic<bool> isolate_key_created_;
1623 1624
#endif

1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638
  void Deinit();

  static void SetIsolateThreadLocals(Isolate* isolate,
                                     PerIsolateThreadData* data);

  void InitializeThreadLocal();

  void MarkCompactPrologue(bool is_compacting,
                           ThreadLocalTop* archived_thread_data);
  void MarkCompactEpilogue(bool is_compacting,
                           ThreadLocalTop* archived_thread_data);

  void FillCache();

1639 1640 1641 1642 1643
  // Propagate pending exception message to the v8::TryCatch.
  // If there is no external try-catch or message was successfully propagated,
  // then return true.
  bool PropagatePendingExceptionToExternalTryCatch();

1644 1645 1646
  void RunPromiseHookForAsyncEventDelegate(PromiseHookType type,
                                           Handle<JSPromise> promise);

hpayer's avatar
hpayer committed
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
  const char* RAILModeName(RAILMode rail_mode) const {
    switch (rail_mode) {
      case PERFORMANCE_RESPONSE:
        return "RESPONSE";
      case PERFORMANCE_ANIMATION:
        return "ANIMATION";
      case PERFORMANCE_IDLE:
        return "IDLE";
      case PERFORMANCE_LOAD:
        return "LOAD";
    }
    return "";
  }

1661 1662 1663 1664 1665
  // This class contains a collection of data accessible from both C++ runtime
  // and compiled code (including assembly stubs, builtins, interpreter bytecode
  // handlers and optimized code).
  IsolateData isolate_data_;

1666
  std::unique_ptr<IsolateAllocator> isolate_allocator_;
1667
  Heap heap_;
1668
  ReadOnlyHeap* read_only_heap_ = nullptr;
1669

1670
  const int id_;
1671 1672 1673 1674 1675 1676 1677
  EntryStackItem* entry_stack_ = nullptr;
  int stack_trace_nesting_level_ = 0;
  StringStream* incomplete_message_ = nullptr;
  Address isolate_addresses_[kIsolateAddressCount + 1] = {};
  Bootstrapper* bootstrapper_ = nullptr;
  RuntimeProfiler* runtime_profiler_ = nullptr;
  CompilationCache* compilation_cache_ = nullptr;
1678
  std::shared_ptr<Counters> async_counters_;
1679
  base::RecursiveMutex break_access_;
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
  Logger* logger_ = nullptr;
  StubCache* load_stub_cache_ = nullptr;
  StubCache* store_stub_cache_ = nullptr;
  DeoptimizerData* deoptimizer_data_ = nullptr;
  bool deoptimizer_lazy_throw_ = false;
  MaterializedObjectStore* materialized_object_store_ = nullptr;
  bool capture_stack_trace_for_uncaught_exceptions_ = false;
  int stack_trace_for_uncaught_exceptions_frame_limit_ = 0;
  StackTrace::StackTraceOptions stack_trace_for_uncaught_exceptions_options_ =
      StackTrace::kOverview;
  DescriptorLookupCache* descriptor_lookup_cache_ = nullptr;
1691
  HandleScopeData handle_scope_data_;
1692 1693 1694 1695 1696 1697 1698
  HandleScopeImplementer* handle_scope_implementer_ = nullptr;
  UnicodeCache* unicode_cache_ = nullptr;
  AccountingAllocator* allocator_ = nullptr;
  InnerPointerToCodeCache* inner_pointer_to_code_cache_ = nullptr;
  GlobalHandles* global_handles_ = nullptr;
  EternalHandles* eternal_handles_ = nullptr;
  ThreadManager* thread_manager_ = nullptr;
1699 1700
  RuntimeState runtime_state_;
  Builtins builtins_;
1701
  SetupIsolateDelegate* setup_delegate_ = nullptr;
1702
#ifndef V8_INTL_SUPPORT
1703 1704 1705 1706
  unibrow::Mapping<unibrow::Ecma262UnCanonicalize> jsregexp_uncanonicalize_;
  unibrow::Mapping<unibrow::CanonicalizationRange> jsregexp_canonrange_;
  unibrow::Mapping<unibrow::Ecma262Canonicalize>
      regexp_macro_assembler_canonicalize_;
1707
#endif  // !V8_INTL_SUPPORT
1708
  RegExpStack* regexp_stack_ = nullptr;
1709
  std::vector<int> regexp_indices_;
1710 1711 1712
  DateCache* date_cache_ = nullptr;
  base::RandomNumberGenerator* random_number_generator_ = nullptr;
  base::RandomNumberGenerator* fuzzer_rng_ = nullptr;
1713
  std::atomic<RAILMode> rail_mode_;
1714 1715 1716
  v8::Isolate::AtomicsWaitCallback atomics_wait_callback_ = nullptr;
  void* atomics_wait_callback_data_ = nullptr;
  PromiseHook promise_hook_ = nullptr;
1717 1718
  HostCleanupFinalizationGroupCallback
      host_cleanup_finalization_group_callback_ = nullptr;
1719 1720
  HostImportModuleDynamicallyCallback host_import_module_dynamically_callback_ =
      nullptr;
1721
  HostInitializeImportMetaObjectCallback
1722
      host_initialize_import_meta_object_callback_ = nullptr;
1723
  base::Mutex rail_mutex_;
1724
  double load_start_time_ms_ = 0;
1725

1726
#ifdef V8_INTL_SUPPORT
1727
  std::string default_locale_;
1728 1729 1730 1731 1732 1733

  struct ICUObjectCacheTypeHash {
    std::size_t operator()(ICUObjectCacheType a) const {
      return static_cast<std::size_t>(a);
    }
  };
1734
  std::unordered_map<ICUObjectCacheType, std::shared_ptr<icu::UMemory>,
1735 1736 1737
                     ICUObjectCacheTypeHash>
      icu_object_cache_;

1738 1739
#endif  // V8_INTL_SUPPORT

1740
  // Whether the isolate has been created for snapshotting.
1741
  bool serializer_enabled_ = false;
1742

1743
  // True if fatal error has been signaled for this isolate.
1744
  bool has_fatal_error_ = false;
1745

1746
  // True if this isolate was initialized from a snapshot.
1747
  bool initialized_from_snapshot_ = false;
1748

1749
  // TODO(ishell): remove
1750
  // True if ES2015 tail call elimination feature is enabled.
1751
  bool is_tail_call_elimination_enabled_ = true;
1752

1753 1754
  // True if the isolate is in background. This flag is used
  // to prioritize between memory usage and latency.
1755
  bool is_isolate_in_background_ = false;
1756

1757 1758
  // True if the isolate is in memory savings mode. This flag is used to
  // favor memory over runtime performance.
1759
  bool memory_savings_mode_active_ = false;
1760

1761
  // Time stamp at initialization.
1762
  double time_millis_at_init_ = 0;
1763

1764
#ifdef DEBUG
1765
  V8_EXPORT_PRIVATE static std::atomic<size_t> non_disposed_isolates_;
1766

1767 1768 1769
  JSObject::SpillInformation js_spill_information_;
#endif

1770 1771
  Debug* debug_ = nullptr;
  HeapProfiler* heap_profiler_ = nullptr;
1772
  std::unique_ptr<CodeEventDispatcher> code_event_dispatcher_;
1773

1774
  const AstStringConstants* ast_string_constants_ = nullptr;
1775

1776
  interpreter::Interpreter* interpreter_ = nullptr;
1777

1778 1779 1780
  compiler::PerIsolateCompilerCache* compiler_cache_ = nullptr;
  Zone* compiler_zone_ = nullptr;

1781
  CompilerDispatcher* compiler_dispatcher_ = nullptr;
1782

1783
  using InterruptEntry = std::pair<InterruptCallback, void*>;
1784 1785
  std::queue<InterruptEntry> api_interrupts_queue_;

1786
#define GLOBAL_BACKING_STORE(type, name, initialvalue) type name##_;
1787 1788 1789
  ISOLATE_INIT_LIST(GLOBAL_BACKING_STORE)
#undef GLOBAL_BACKING_STORE

1790
#define GLOBAL_ARRAY_BACKING_STORE(type, name, length) type name##_[length];
1791 1792 1793 1794 1795 1796 1797
  ISOLATE_INIT_ARRAY_LIST(GLOBAL_ARRAY_BACKING_STORE)
#undef GLOBAL_ARRAY_BACKING_STORE

#ifdef DEBUG
  // This class is huge and has a number of fields controlled by
  // preprocessor defines. Make sure the offsets of these fields agree
  // between compilation units.
1798
#define ISOLATE_FIELD_OFFSET(type, name, ignored) \
1799
  V8_EXPORT_PRIVATE static const intptr_t name##_debug_offset_;
1800 1801 1802 1803 1804
  ISOLATE_INIT_LIST(ISOLATE_FIELD_OFFSET)
  ISOLATE_INIT_ARRAY_LIST(ISOLATE_FIELD_OFFSET)
#undef ISOLATE_FIELD_OFFSET
#endif

1805 1806
  DeferredHandles* deferred_handles_head_ = nullptr;
  OptimizingCompileDispatcher* optimizing_compile_dispatcher_ = nullptr;
1807

1808
  // Counts deopt points if deopt_every_n_times is enabled.
1809
  unsigned int stress_deopt_count_ = 0;
1810

1811
  bool force_slow_path_ = false;
1812

1813
  int next_optimization_id_ = 0;
1814

1815
#if V8_SFI_HAS_UNIQUE_ID
1816
  int next_unique_sfi_id_ = 0;
1817 1818
#endif

1819 1820
  // Vector of callbacks before a Call starts execution.
  std::vector<BeforeCallEnteredCallback> before_call_entered_callbacks_;
1821

1822 1823
  // Vector of callbacks when a Call completes.
  std::vector<CallCompletedCallback> call_completed_callbacks_;
1824

1825
  v8::Isolate::UseCounterCallback use_counter_callback_ = nullptr;
1826

1827
  std::vector<Object> partial_snapshot_cache_;
1828

1829 1830 1831
  // Used during builtins compilation to build the builtins constants table,
  // which is stored on the root list prior to serialization.
  BuiltinsConstantsTableBuilder* builtins_constants_table_builder_ = nullptr;
1832

1833 1834 1835 1836
  void InitializeDefaultEmbeddedBlob();
  void CreateAndSetEmbeddedBlob();
  void TearDownEmbeddedBlob();

1837
  void SetEmbeddedBlob(const uint8_t* blob, uint32_t blob_size);
1838
  void ClearEmbeddedBlob();
1839

1840 1841
  const uint8_t* embedded_blob_ = nullptr;
  uint32_t embedded_blob_size_ = 0;
1842

1843
  v8::ArrayBuffer::Allocator* array_buffer_allocator_ = nullptr;
1844

binji's avatar
binji committed
1845 1846
  FutexWaitListNode futex_wait_list_node_;

1847
  CancelableTaskManager* cancelable_task_manager_ = nullptr;
1848

1849 1850
  debug::ConsoleDelegate* console_delegate_ = nullptr;

1851 1852
  debug::AsyncEventDelegate* async_event_delegate_ = nullptr;
  bool promise_hook_or_async_event_delegate_ = false;
1853
  bool promise_hook_or_debug_is_active_or_async_event_delegate_ = false;
1854 1855
  int async_task_count_ = 0;

1856
  v8::Isolate::AbortOnUncaughtExceptionCallback
1857
      abort_on_uncaught_exception_callback_ = nullptr;
1858

1859
  bool allow_atomics_wait_ = true;
1860

1861
  base::Mutex managed_ptr_destructors_mutex_;
1862
  ManagedPtrDestructor* managed_ptr_destructors_head_ = nullptr;
1863

1864
  size_t total_regexp_code_generated_ = 0;
1865

1866 1867
  size_t elements_deletion_counter_ = 0;

1868
  std::shared_ptr<wasm::WasmEngine> wasm_engine_;
1869

1870 1871
  std::unique_ptr<TracingCpuProfilerImpl> tracing_cpu_profiler_;

1872 1873
  EmbeddedFileWriterInterface* embedded_file_writer_ = nullptr;

1874 1875 1876 1877
  // The top entry of the v8::Context::BackupIncumbentScope stack.
  const v8::Context::BackupIncumbentScope* top_backup_incumbent_scope_ =
      nullptr;

1878 1879
  PrepareStackTraceCallback prepare_stack_trace_callback_ = nullptr;

1880 1881 1882 1883 1884 1885
  // TODO(kenton@cloudflare.com): This mutex can be removed if
  // thread_data_table_ is always accessed under the isolate lock. I do not
  // know if this is the case, so I'm preserving it for now.
  base::Mutex thread_data_table_mutex_;
  ThreadDataTable thread_data_table_;

1886 1887 1888 1889 1890 1891
  // Delete new/delete operators to ensure that Isolate::New() and
  // Isolate::Delete() are used for Isolate creation and deletion.
  void* operator new(size_t, void* ptr) { return ptr; }
  void* operator new(size_t) = delete;
  void operator delete(void*) = delete;

1892
  friend class heap::HeapTester;
1893
  friend class TestSerializer;
1894 1895 1896 1897

  DISALLOW_COPY_AND_ASSIGN(Isolate);
};

1898 1899 1900
#undef FIELD_ACCESSOR
#undef THREAD_LOCAL_TOP_ACCESSOR

1901 1902
class PromiseOnStack {
 public:
1903 1904
  PromiseOnStack(Handle<JSObject> promise, PromiseOnStack* prev)
      : promise_(promise), prev_(prev) {}
1905 1906 1907 1908 1909 1910 1911 1912
  Handle<JSObject> promise() { return promise_; }
  PromiseOnStack* prev() { return prev_; }

 private:
  Handle<JSObject> promise_;
  PromiseOnStack* prev_;
};

1913 1914
// SaveContext scopes save the current context on the Isolate on creation, and
// restore it on destruction.
1915
class V8_EXPORT_PRIVATE SaveContext {
1916
 public:
1917
  explicit SaveContext(Isolate* isolate);
1918

1919
  ~SaveContext();
1920 1921 1922 1923

  Handle<Context> context() { return context_; }

  // Returns true if this save context is below a given JavaScript frame.
1924
  bool IsBelowFrame(StandardFrame* frame);
1925 1926

 private:
1927
  Isolate* const isolate_;
1928
  Handle<Context> context_;
1929
  Address c_entry_fp_;
1930 1931
};

1932 1933 1934 1935 1936 1937 1938
// Like SaveContext, but also switches the Context to a new one in the
// constructor.
class V8_EXPORT_PRIVATE SaveAndSwitchContext : public SaveContext {
 public:
  SaveAndSwitchContext(Isolate* isolate, Context new_context);
};

1939
class AssertNoContextChange {
1940 1941
#ifdef DEBUG
 public:
1942
  explicit AssertNoContextChange(Isolate* isolate);
1943
  ~AssertNoContextChange() { DCHECK(isolate_->context() == *context_); }
1944 1945

 private:
1946
  Isolate* isolate_;
1947 1948 1949
  Handle<Context> context_;
#else
 public:
1950
  explicit AssertNoContextChange(Isolate* isolate) {}
1951 1952 1953
#endif
};

1954
class ExecutionAccess {
1955 1956 1957 1958 1959 1960
 public:
  explicit ExecutionAccess(Isolate* isolate) : isolate_(isolate) {
    Lock(isolate);
  }
  ~ExecutionAccess() { Unlock(isolate_); }

1961 1962
  static void Lock(Isolate* isolate) { isolate->break_access()->Lock(); }
  static void Unlock(Isolate* isolate) { isolate->break_access()->Unlock(); }
1963 1964

  static bool TryLock(Isolate* isolate) {
1965
    return isolate->break_access()->TryLock();
1966 1967 1968 1969 1970 1971
  }

 private:
  Isolate* isolate_;
};

1972
// Support for checking for stack-overflows.
1973
class StackLimitCheck {
1974
 public:
1975
  explicit StackLimitCheck(Isolate* isolate) : isolate_(isolate) {}
1976

1977
  // Use this to check for stack-overflows in C++ code.
1978
  bool HasOverflowed() const {
1979
    StackGuard* stack_guard = isolate_->stack_guard();
1980
    return GetCurrentStackPosition() < stack_guard->real_climit();
1981
  }
1982

1983 1984 1985 1986 1987 1988
  // Use this to check for interrupt request in C++ code.
  bool InterruptRequested() {
    StackGuard* stack_guard = isolate_->stack_guard();
    return GetCurrentStackPosition() < stack_guard->climit();
  }

1989
  // Use this to check for stack-overflow when entering runtime from JS code.
1990
  bool JsHasOverflowed(uintptr_t gap = 0) const;
1991

1992 1993 1994 1995
 private:
  Isolate* isolate_;
};

1996 1997 1998 1999 2000 2001 2002
#define STACK_CHECK(isolate, result_value) \
  do {                                     \
    StackLimitCheck stack_check(isolate);  \
    if (stack_check.HasOverflowed()) {     \
      isolate->StackOverflow();            \
      return result_value;                 \
    }                                      \
2003
  } while (false)
2004

2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
class StackTraceFailureMessage {
 public:
  explicit StackTraceFailureMessage(Isolate* isolate, void* ptr1 = nullptr,
                                    void* ptr2 = nullptr, void* ptr3 = nullptr,
                                    void* ptr4 = nullptr);

  V8_NOINLINE void Print() volatile;

  static const uintptr_t kStartMarker = 0xdecade30;
  static const uintptr_t kEndMarker = 0xdecade31;
  static const int kStacktraceBufferSize = 32 * KB;

  uintptr_t start_marker_ = kStartMarker;
  void* isolate_;
  void* ptr1_;
  void* ptr2_;
  void* ptr3_;
  void* ptr4_;
  void* code_objects_[4];
  char js_stack_trace_[kStacktraceBufferSize];
  uintptr_t end_marker_ = kEndMarker;
};

2028 2029
}  // namespace internal
}  // namespace v8
2030

2031
#endif  // V8_EXECUTION_ISOLATE_H_