// Copyright Joyent, Inc. and other Node contributors.

//

// Permission is hereby granted, free of charge, to any person obtaining a

// copy of this software and associated documentation files (the

// "Software"), to deal in the Software without restriction, including

// without limitation the rights to use, copy, modify, merge, publish,

// distribute, sublicense, and/or sell copies of the Software, and to permit

// persons to whom the Software is furnished to do so, subject to the

// following conditions:

//

// The above copyright notice and this permission notice shall be included

// in all copies or substantial portions of the Software.

//

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN

// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE

// USE OR OTHER DEALINGS IN THE SOFTWARE.

#ifndef SRC_ENV_H_

#define SRC_ENV_H_

#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#include "aliased_buffer.h"

#if HAVE_INSPECTOR

#include "inspector_agent.h"

#include "inspector_profiler.h"

#endif

#include "callback_queue.h"

#include "debug_utils.h"

#include "handle_wrap.h"

#include "node.h"

#include "node_binding.h"

#include "node_builtins.h"

#include "node_main_instance.h"

#include "node_options.h"

#include "node_perf_common.h"

#include "node_snapshotable.h"

#include "req_wrap.h"

#include "util.h"

#include "uv.h"

#include "v8.h"

#include <array>

#include <atomic>

#include <cstdint>

#include <functional>

#include <list>

#include <memory>

#include <ostream>

#include <set>

#include <string>

#include <unordered_map>

#include <unordered_set>

#include <vector>

namespace node {

namespace contextify {

class ContextifyScript;

class CompiledFnEntry;

}

namespace performance {

class PerformanceState;

}

namespace tracing {

class AgentWriterHandle;

}

#if HAVE_INSPECTOR

namespace profiler {

class V8CoverageConnection;

class V8CpuProfilerConnection;

class V8HeapProfilerConnection;

}  // namespace profiler

namespace inspector {

class ParentInspectorHandle;

}

#endif  // HAVE_INSPECTOR

namespace worker {

class Worker;

}

namespace loader {

class ModuleWrap;

struct PackageConfig {

  enum class Exists { Yes, No };

  enum class IsValid { Yes, No };

  enum class HasMain { Yes, No };

  enum class HasName { Yes, No };

  enum PackageType : uint32_t { None = 0, CommonJS, Module };

  const Exists exists;

  const IsValid is_valid;

  const HasMain has_main;

  const std::string main;

  const HasName has_name;

  const std::string name;

  const PackageType type;

  v8::Global<v8::Value> exports;

};

}  // namespace loader

enum class FsStatsOffset {

  kDev = 0,

  kMode,

  kNlink,

  kUid,

  kGid,

  kRdev,

  kBlkSize,

  kIno,

  kSize,

  kBlocks,

  kATimeSec,

  kATimeNsec,

  kMTimeSec,

  kMTimeNsec,

  kCTimeSec,

  kCTimeNsec,

  kBirthTimeSec,

  kBirthTimeNsec,

  kFsStatsFieldsNumber

};

// Stat fields buffers contain twice the number of entries in an uv_stat_t

// because `fs.StatWatcher` needs room to store 2 `fs.Stats` instances.

constexpr size_t kFsStatsBufferLength =

    static_cast<size_t>(FsStatsOffset::kFsStatsFieldsNumber) * 2;

// Disables zero-filling for ArrayBuffer allocations in this scope. This is

// similar to how we implement Buffer.allocUnsafe() in JS land.

class NoArrayBufferZeroFillScope {

 public:

  inline explicit NoArrayBufferZeroFillScope(IsolateData* isolate_data);

  inline ~NoArrayBufferZeroFillScope();

 private:

  NodeArrayBufferAllocator* node_allocator_;

  friend class Environment;

};

// PER_ISOLATE_* macros: We have a lot of per-isolate properties

// and adding and maintaining their getters and setters by hand would be

// difficult so let's make the preprocessor generate them for us.

//

// In each macro, `V` is expected to be the name of a macro or function which

// accepts the number of arguments provided in each tuple in the macro body,

// typically two. The named function will be invoked against each tuple.

//

// Make sure that any macro V defined for use with the PER_ISOLATE_* macros is

// undefined again after use.

// Private symbols are per-isolate primitives but Environment proxies them

// for the sake of convenience.  Strings should be ASCII-only and have a

// "node:" prefix to avoid name clashes with third-party code.

#define PER_ISOLATE_PRIVATE_SYMBOL_PROPERTIES(V)                               \

  V(alpn_buffer_private_symbol, "node:alpnBuffer")                             \

  V(arrow_message_private_symbol, "node:arrowMessage")                         \

  V(contextify_context_private_symbol, "node:contextify:context")              \

  V(contextify_global_private_symbol, "node:contextify:global")                \

  V(decorated_private_symbol, "node:decorated")                                \

  V(napi_type_tag, "node:napi:type_tag")                                       \

  V(napi_wrapper, "node:napi:wrapper")                                         \

  V(untransferable_object_private_symbol, "node:untransferableObject")         \

  V(exiting_aliased_Uint32Array, "node:exiting_aliased_Uint32Array")

// Symbols are per-isolate primitives but Environment proxies them

// for the sake of convenience.

#define PER_ISOLATE_SYMBOL_PROPERTIES(V)                                       \

  V(async_id_symbol, "async_id_symbol")                                        \

  V(handle_onclose_symbol, "handle_onclose")                                   \

  V(no_message_symbol, "no_message_symbol")                                    \

  V(messaging_deserialize_symbol, "messaging_deserialize_symbol")              \

  V(messaging_transfer_symbol, "messaging_transfer_symbol")                    \

  V(messaging_clone_symbol, "messaging_clone_symbol")                          \

  V(messaging_transfer_list_symbol, "messaging_transfer_list_symbol")          \

  V(oninit_symbol, "oninit")                                                   \

  V(owner_symbol, "owner_symbol")                                              \

  V(onpskexchange_symbol, "onpskexchange")                                     \

  V(resource_symbol, "resource_symbol")                                        \

  V(trigger_async_id_symbol, "trigger_async_id_symbol")                        \

// Strings are per-isolate primitives but Environment proxies them

// for the sake of convenience.  Strings should be ASCII-only.

#define PER_ISOLATE_STRING_PROPERTIES(V)                                       \

  V(ack_string, "ack")                                                         \

  V(address_string, "address")                                                 \

  V(aliases_string, "aliases")                                                 \

  V(args_string, "args")                                                       \

  V(asn1curve_string, "asn1Curve")                                             \

  V(async_ids_stack_string, "async_ids_stack")                                 \

  V(bits_string, "bits")                                                       \

  V(block_list_string, "blockList")                                            \

  V(buffer_string, "buffer")                                                   \

  V(bytes_parsed_string, "bytesParsed")                                        \

  V(bytes_read_string, "bytesRead")                                            \

  V(bytes_written_string, "bytesWritten")                                      \

  V(cached_data_produced_string, "cachedDataProduced")                         \

  V(cached_data_rejected_string, "cachedDataRejected")                         \

  V(cached_data_string, "cachedData")                                          \

  V(cache_key_string, "cacheKey")                                              \

  V(change_string, "change")                                                   \

  V(channel_string, "channel")                                                 \

  V(chunks_sent_since_last_write_string, "chunksSentSinceLastWrite")           \

  V(clone_unsupported_type_str, "Cannot transfer object of unsupported type.") \

  V(code_string, "code")                                                       \

  V(commonjs_string, "commonjs")                                               \

  V(config_string, "config")                                                   \

  V(constants_string, "constants")                                             \

  V(crypto_dh_string, "dh")                                                    \

  V(crypto_dsa_string, "dsa")                                                  \

  V(crypto_ec_string, "ec")                                                    \

  V(crypto_ed25519_string, "ed25519")                                          \

  V(crypto_ed448_string, "ed448")                                              \

  V(crypto_x25519_string, "x25519")                                            \

  V(crypto_x448_string, "x448")                                                \

  V(crypto_rsa_string, "rsa")                                                  \

  V(crypto_rsa_pss_string, "rsa-pss")                                          \

  V(cwd_string, "cwd")                                                         \

  V(data_string, "data")                                                       \

  V(default_is_true_string, "defaultIsTrue")                                   \

  V(deserialize_info_string, "deserializeInfo")                                \

  V(dest_string, "dest")                                                       \

  V(destroyed_string, "destroyed")                                             \

  V(detached_string, "detached")                                               \

  V(dh_string, "DH")                                                           \

  V(divisor_length_string, "divisorLength")                                    \

  V(dns_a_string, "A")                                                         \

  V(dns_aaaa_string, "AAAA")                                                   \

  V(dns_caa_string, "CAA")                                                     \

  V(dns_critical_string, "critical")                                           \

  V(dns_cname_string, "CNAME")                                                 \

  V(dns_mx_string, "MX")                                                       \

  V(dns_naptr_string, "NAPTR")                                                 \

  V(dns_ns_string, "NS")                                                       \

  V(dns_ptr_string, "PTR")                                                     \

  V(dns_soa_string, "SOA")                                                     \

  V(dns_srv_string, "SRV")                                                     \

  V(dns_txt_string, "TXT")                                                     \

  V(done_string, "done")                                                       \

  V(duration_string, "duration")                                               \

  V(ecdh_string, "ECDH")                                                       \

  V(emit_string, "emit")                                                       \

  V(emit_warning_string, "emitWarning")                                        \

  V(empty_object_string, "{}")                                                 \

  V(encoding_string, "encoding")                                               \

  V(entries_string, "entries")                                                 \

  V(entry_type_string, "entryType")                                            \

  V(env_pairs_string, "envPairs")                                              \

  V(env_var_settings_string, "envVarSettings")                                 \

  V(errno_string, "errno")                                                     \

  V(error_string, "error")                                                     \

  V(exchange_string, "exchange")                                               \

  V(exit_code_string, "exitCode")                                              \

  V(expire_string, "expire")                                                   \

  V(exponent_string, "exponent")                                               \

  V(exports_string, "exports")                                                 \

  V(ext_key_usage_string, "ext_key_usage")                                     \

  V(external_stream_string, "_externalStream")                                 \

  V(family_string, "family")                                                   \

  V(fatal_exception_string, "_fatalException")                                 \

  V(fd_string, "fd")                                                           \

  V(fields_string, "fields")                                                   \

  V(file_string, "file")                                                       \

  V(filename_string, "filename")                                               \

  V(fingerprint256_string, "fingerprint256")                                   \

  V(fingerprint512_string, "fingerprint512")                                   \

  V(fingerprint_string, "fingerprint")                                         \

  V(flags_string, "flags")                                                     \

  V(flowlabel_string, "flowlabel")                                             \

  V(fragment_string, "fragment")                                               \

  V(frames_received_string, "framesReceived")                                  \

  V(frames_sent_string, "framesSent")                                          \

  V(function_string, "function")                                               \

  V(get_data_clone_error_string, "_getDataCloneError")                         \

  V(get_shared_array_buffer_id_string, "_getSharedArrayBufferId")              \

  V(gid_string, "gid")                                                         \

  V(h2_string, "h2")                                                           \

  V(handle_string, "handle")                                                   \

  V(hash_algorithm_string, "hashAlgorithm")                                    \

  V(help_text_string, "helpText")                                              \

  V(homedir_string, "homedir")                                                 \

  V(host_string, "host")                                                       \

  V(hostmaster_string, "hostmaster")                                           \

  V(http_1_1_string, "http/1.1")                                               \

  V(id_string, "id")                                                           \

  V(identity_string, "identity")                                               \

  V(ignore_string, "ignore")                                                   \

  V(infoaccess_string, "infoAccess")                                           \

  V(inherit_string, "inherit")                                                 \

  V(input_string, "input")                                                     \

  V(internal_binding_string, "internalBinding")                                \

  V(internal_string, "internal")                                               \

  V(ipv4_string, "IPv4")                                                       \

  V(ipv6_string, "IPv6")                                                       \

  V(isclosing_string, "isClosing")                                             \

  V(issuer_string, "issuer")                                                   \

  V(issuercert_string, "issuerCertificate")                                    \

  V(jwk_crv_string, "crv")                                                     \

  V(jwk_d_string, "d")                                                         \

  V(jwk_dp_string, "dp")                                                       \

  V(jwk_dq_string, "dq")                                                       \

  V(jwk_dsa_string, "DSA")                                                     \

  V(jwk_e_string, "e")                                                         \

  V(jwk_ec_string, "EC")                                                       \

  V(jwk_g_string, "g")                                                         \

  V(jwk_k_string, "k")                                                         \

  V(jwk_p_string, "p")                                                         \

  V(jwk_q_string, "q")                                                         \

  V(jwk_qi_string, "qi")                                                       \

  V(jwk_kty_string, "kty")                                                     \

  V(jwk_n_string, "n")                                                         \

  V(jwk_oct_string, "oct")                                                     \

  V(jwk_okp_string, "OKP")                                                     \

  V(jwk_rsa_string, "RSA")                                                     \

  V(jwk_x_string, "x")                                                         \

  V(jwk_y_string, "y")                                                         \

  V(kill_signal_string, "killSignal")                                          \

  V(kind_string, "kind")                                                       \

  V(length_string, "length")                                                   \

  V(library_string, "library")                                                 \

  V(mac_string, "mac")                                                         \

  V(max_buffer_string, "maxBuffer")                                            \

  V(max_concurrent_streams_string, "maxConcurrentStreams")                     \

  V(message_port_constructor_string, "MessagePort")                            \

  V(message_port_string, "messagePort")                                        \

  V(message_string, "message")                                                 \

  V(messageerror_string, "messageerror")                                       \

  V(mgf1_hash_algorithm_string, "mgf1HashAlgorithm")                           \

  V(minttl_string, "minttl")                                                   \

  V(module_string, "module")                                                   \

  V(modulus_string, "modulus")                                                 \

  V(modulus_length_string, "modulusLength")                                    \

  V(name_string, "name")                                                       \

  V(named_curve_string, "namedCurve")                                          \

  V(netmask_string, "netmask")                                                 \

  V(next_string, "next")                                                       \

  V(nistcurve_string, "nistCurve")                                             \

  V(node_string, "node")                                                       \

  V(nsname_string, "nsname")                                                   \

  V(object_string, "Object")                                                   \

  V(ocsp_request_string, "OCSPRequest")                                        \

  V(oncertcb_string, "oncertcb")                                               \

  V(onchange_string, "onchange")                                               \

  V(onclienthello_string, "onclienthello")                                     \

  V(oncomplete_string, "oncomplete")                                           \

  V(onconnection_string, "onconnection")                                       \

  V(ondone_string, "ondone")                                                   \

  V(onerror_string, "onerror")                                                 \

  V(onexit_string, "onexit")                                                   \

  V(onhandshakedone_string, "onhandshakedone")                                 \

  V(onhandshakestart_string, "onhandshakestart")                               \

  V(onkeylog_string, "onkeylog")                                               \

  V(onmessage_string, "onmessage")                                             \

  V(onnewsession_string, "onnewsession")                                       \

  V(onocspresponse_string, "onocspresponse")                                   \

  V(onreadstart_string, "onreadstart")                                         \

  V(onreadstop_string, "onreadstop")                                           \

  V(onshutdown_string, "onshutdown")                                           \

  V(onsignal_string, "onsignal")                                               \

  V(onunpipe_string, "onunpipe")                                               \

  V(onwrite_string, "onwrite")                                                 \

  V(openssl_error_stack, "opensslErrorStack")                                  \

  V(options_string, "options")                                                 \

  V(order_string, "order")                                                     \

  V(output_string, "output")                                                   \

  V(overlapped_string, "overlapped")                                           \

  V(parse_error_string, "Parse Error")                                         \

  V(password_string, "password")                                               \

  V(path_string, "path")                                                       \

  V(pending_handle_string, "pendingHandle")                                    \

  V(pid_string, "pid")                                                         \

  V(ping_rtt_string, "pingRTT")                                                \

  V(pipe_source_string, "pipeSource")                                          \

  V(pipe_string, "pipe")                                                       \

  V(pipe_target_string, "pipeTarget")                                          \

  V(port1_string, "port1")                                                     \

  V(port2_string, "port2")                                                     \

  V(port_string, "port")                                                       \

  V(preference_string, "preference")                                           \

  V(primordials_string, "primordials")                                         \

  V(priority_string, "priority")                                               \

  V(process_string, "process")                                                 \

  V(promise_string, "promise")                                                 \

  V(psk_string, "psk")                                                         \

  V(pubkey_string, "pubkey")                                                   \

  V(public_exponent_string, "publicExponent")                                  \

  V(query_string, "query")                                                     \

  V(rate_string, "rate")                                                       \

  V(raw_string, "raw")                                                         \

  V(read_host_object_string, "_readHostObject")                                \

  V(readable_string, "readable")                                               \

  V(reason_string, "reason")                                                   \

  V(refresh_string, "refresh")                                                 \

  V(regexp_string, "regexp")                                                   \

  V(rename_string, "rename")                                                   \

  V(replacement_string, "replacement")                                         \

  V(require_string, "require")                                                 \

  V(retry_string, "retry")                                                     \

  V(salt_length_string, "saltLength")                                          \

  V(scheme_string, "scheme")                                                   \

  V(scopeid_string, "scopeid")                                                 \

  V(serial_number_string, "serialNumber")                                      \

  V(serial_string, "serial")                                                   \

  V(servername_string, "servername")                                           \

  V(service_string, "service")                                                 \

  V(session_id_string, "sessionId")                                            \

  V(shell_string, "shell")                                                     \

  V(signal_string, "signal")                                                   \

  V(sink_string, "sink")                                                       \

  V(size_string, "size")                                                       \

  V(sni_context_err_string, "Invalid SNI context")                             \

  V(sni_context_string, "sni_context")                                         \

  V(source_string, "source")                                                   \

  V(stack_string, "stack")                                                     \

  V(standard_name_string, "standardName")                                      \

  V(start_time_string, "startTime")                                            \

  V(state_string, "state")                                                     \

  V(stats_string, "stats")                                                     \

  V(status_string, "status")                                                   \

  V(stdio_string, "stdio")                                                     \

  V(stream_average_duration_string, "streamAverageDuration")                   \

  V(stream_count_string, "streamCount")                                        \

  V(subject_string, "subject")                                                 \

  V(subjectaltname_string, "subjectaltname")                                   \

  V(syscall_string, "syscall")                                                 \

  V(target_string, "target")                                                   \

  V(thread_id_string, "threadId")                                              \

  V(ticketkeycallback_string, "onticketkeycallback")                           \

  V(timeout_string, "timeout")                                                 \

  V(time_to_first_byte_string, "timeToFirstByte")                              \

  V(time_to_first_byte_sent_string, "timeToFirstByteSent")                     \

  V(time_to_first_header_string, "timeToFirstHeader")                          \

  V(tls_ticket_string, "tlsTicket")                                            \

  V(transfer_string, "transfer")                                               \

  V(ttl_string, "ttl")                                                         \

  V(type_string, "type")                                                       \

  V(uid_string, "uid")                                                         \

  V(unknown_string, "<unknown>")                                               \

  V(url_special_ftp_string, "ftp:")                                            \

  V(url_special_file_string, "file:")                                          \

  V(url_special_http_string, "http:")                                          \

  V(url_special_https_string, "https:")                                        \

  V(url_special_ws_string, "ws:")                                              \

  V(url_special_wss_string, "wss:")                                            \

  V(url_string, "url")                                                         \

  V(username_string, "username")                                               \

  V(valid_from_string, "valid_from")                                           \

  V(valid_to_string, "valid_to")                                               \

  V(value_string, "value")                                                     \

  V(verify_error_string, "verifyError")                                        \

  V(version_string, "version")                                                 \

  V(weight_string, "weight")                                                   \

  V(windows_hide_string, "windowsHide")                                        \

  V(windows_verbatim_arguments_string, "windowsVerbatimArguments")             \

  V(wrap_string, "wrap")                                                       \

  V(writable_string, "writable")                                               \

  V(write_host_object_string, "_writeHostObject")                              \

  V(write_queue_size_string, "writeQueueSize")                                 \

  V(x_forwarded_string, "x-forwarded-for")                                     \

  V(zero_return_string, "ZERO_RETURN")

#define PER_ISOLATE_TEMPLATE_PROPERTIES(V)                                     \

  V(async_wrap_ctor_template, v8::FunctionTemplate)                            \

  V(async_wrap_object_ctor_template, v8::FunctionTemplate)                     \

  V(base_object_ctor_template, v8::FunctionTemplate)                           \

  V(binding_data_ctor_template, v8::FunctionTemplate)                          \

  V(blob_constructor_template, v8::FunctionTemplate)                           \

  V(blocklist_constructor_template, v8::FunctionTemplate)                      \

  V(contextify_global_template, v8::ObjectTemplate)                            \

  V(compiled_fn_entry_template, v8::ObjectTemplate)                            \

  V(dir_instance_template, v8::ObjectTemplate)                                 \

  V(fd_constructor_template, v8::ObjectTemplate)                               \

  V(fdclose_constructor_template, v8::ObjectTemplate)                          \

  V(filehandlereadwrap_template, v8::ObjectTemplate)                           \

  V(fsreqpromise_constructor_template, v8::ObjectTemplate)                     \

  V(handle_wrap_ctor_template, v8::FunctionTemplate)                           \

  V(histogram_ctor_template, v8::FunctionTemplate)                             \

  V(http2settings_constructor_template, v8::ObjectTemplate)                    \

  V(http2stream_constructor_template, v8::ObjectTemplate)                      \

  V(http2ping_constructor_template, v8::ObjectTemplate)                        \

  V(i18n_converter_template, v8::ObjectTemplate)                               \

  V(intervalhistogram_constructor_template, v8::FunctionTemplate)              \

  V(libuv_stream_wrap_ctor_template, v8::FunctionTemplate)                     \

  V(message_port_constructor_template, v8::FunctionTemplate)                   \

  V(microtask_queue_ctor_template, v8::FunctionTemplate)                       \

  V(pipe_constructor_template, v8::FunctionTemplate)                           \

  V(promise_wrap_template, v8::ObjectTemplate)                                 \

  V(sab_lifetimepartner_constructor_template, v8::FunctionTemplate)            \

  V(script_context_constructor_template, v8::FunctionTemplate)                 \

  V(secure_context_constructor_template, v8::FunctionTemplate)                 \

  V(shutdown_wrap_template, v8::ObjectTemplate)                                \

  V(socketaddress_constructor_template, v8::FunctionTemplate)                  \

  V(streambaseoutputstream_constructor_template, v8::ObjectTemplate)           \

  V(qlogoutputstream_constructor_template, v8::ObjectTemplate)                 \

  V(tcp_constructor_template, v8::FunctionTemplate)                            \

  V(tty_constructor_template, v8::FunctionTemplate)                            \

  V(write_wrap_template, v8::ObjectTemplate)                                   \

  V(worker_heap_snapshot_taker_template, v8::ObjectTemplate)                   \

  V(x509_constructor_template, v8::FunctionTemplate)

#define ENVIRONMENT_STRONG_PERSISTENT_VALUES(V)                                \

  V(async_hooks_after_function, v8::Function)                                  \

  V(async_hooks_before_function, v8::Function)                                 \

  V(async_hooks_callback_trampoline, v8::Function)                             \

  V(async_hooks_binding, v8::Object)                                           \

  V(async_hooks_destroy_function, v8::Function)                                \

  V(async_hooks_init_function, v8::Function)                                   \

  V(async_hooks_promise_resolve_function, v8::Function)                        \

  V(buffer_prototype_object, v8::Object)                                       \

  V(crypto_key_object_constructor, v8::Function)                               \

  V(crypto_key_object_handle_constructor, v8::Function)                        \

  V(crypto_key_object_private_constructor, v8::Function)                       \

  V(crypto_key_object_public_constructor, v8::Function)                        \

  V(crypto_key_object_secret_constructor, v8::Function)                        \

  V(domexception_function, v8::Function)                                       \

  V(enhance_fatal_stack_after_inspector, v8::Function)                         \

  V(enhance_fatal_stack_before_inspector, v8::Function)                        \

  V(fs_use_promises_symbol, v8::Symbol)                                        \

  V(get_source_map_error_source, v8::Function)                                 \

  V(host_import_module_dynamically_callback, v8::Function)                     \

  V(host_initialize_import_meta_object_callback, v8::Function)                 \

  V(http2session_on_altsvc_function, v8::Function)                             \

  V(http2session_on_error_function, v8::Function)                              \

  V(http2session_on_frame_error_function, v8::Function)                        \

  V(http2session_on_goaway_data_function, v8::Function)                        \

  V(http2session_on_headers_function, v8::Function)                            \

  V(http2session_on_origin_function, v8::Function)                             \

  V(http2session_on_ping_function, v8::Function)                               \

  V(http2session_on_priority_function, v8::Function)                           \

  V(http2session_on_settings_function, v8::Function)                           \

  V(http2session_on_stream_close_function, v8::Function)                       \

  V(http2session_on_stream_trailers_function, v8::Function)                    \

  V(internal_binding_loader, v8::Function)                                     \

  V(immediate_callback_function, v8::Function)                                 \

  V(inspector_console_extension_installer, v8::Function)                       \

  V(inspector_disable_async_hooks, v8::Function)                               \

  V(inspector_enable_async_hooks, v8::Function)                                \

  V(maybe_cache_generated_source_map, v8::Function)                            \

  V(messaging_deserialize_create_object, v8::Function)                         \

  V(message_port, v8::Object)                                                  \

  V(builtin_module_require, v8::Function)                                      \

  V(performance_entry_callback, v8::Function)                                  \

  V(performance_entry_template, v8::Function)                                  \

  V(prepare_stack_trace_callback, v8::Function)                                \

  V(process_object, v8::Object)                                                \

  V(primordials, v8::Object)                                                   \

  V(primordials_safe_map_prototype_object, v8::Object)                         \

  V(primordials_safe_set_prototype_object, v8::Object)                         \

  V(primordials_safe_weak_map_prototype_object, v8::Object)                    \

  V(primordials_safe_weak_set_prototype_object, v8::Object)                    \

  V(promise_hook_handler, v8::Function)                                        \

  V(promise_reject_callback, v8::Function)                                     \

  V(snapshot_serialize_callback, v8::Function)                                 \

  V(snapshot_deserialize_callback, v8::Function)                               \

  V(snapshot_deserialize_main, v8::Function)                                   \

  V(source_map_cache_getter, v8::Function)                                     \

  V(tick_callback_function, v8::Function)                                      \

  V(timers_callback_function, v8::Function)                                    \

  V(tls_wrap_constructor_function, v8::Function)                               \

  V(trace_category_state_function, v8::Function)                               \

  V(udp_constructor_function, v8::Function)                                    \

  V(url_constructor_function, v8::Function)                                    \

  V(wasm_streaming_compilation_impl, v8::Function)                             \

  V(wasm_streaming_object_constructor, v8::Function)

class Environment;

typedef size_t SnapshotIndex;

struct PropInfo {

  std::string name;     // name for debugging

  uint32_t id;          // In the list - in case there are any empty entries

  SnapshotIndex index;  // In the snapshot

};

struct IsolateDataSerializeInfo {

  std::vector<SnapshotIndex> primitive_values;

  std::vector<PropInfo> template_values;

  friend std::ostream& operator<<(std::ostream& o,

                                  const IsolateDataSerializeInfo& i);

};

class NODE_EXTERN_PRIVATE IsolateData : public MemoryRetainer {

 public:

  IsolateData(v8::Isolate* isolate,

              uv_loop_t* event_loop,

              MultiIsolatePlatform* platform = nullptr,

              ArrayBufferAllocator* node_allocator = nullptr,

              const IsolateDataSerializeInfo* isolate_data_info = nullptr);

  void MemoryInfo(MemoryTracker* tracker) const override;

  IsolateDataSerializeInfo Serialize(v8::SnapshotCreator* creator);

  inline uv_loop_t* event_loop() const;

  inline MultiIsolatePlatform* platform() const;

  inline std::shared_ptr<PerIsolateOptions> options();

  inline void set_options(std::shared_ptr<PerIsolateOptions> options);

  inline NodeArrayBufferAllocator* node_allocator() const;

  inline worker::Worker* worker_context() const;

  inline void set_worker_context(worker::Worker* context);

#define VP(PropertyName, StringValue) V(v8::Private, PropertyName)

#define VY(PropertyName, StringValue) V(v8::Symbol, PropertyName)

#define VS(PropertyName, StringValue) V(v8::String, PropertyName)

#define V(TypeName, PropertyName)                                             \

  inline v8::Local<TypeName> PropertyName() const;

  PER_ISOLATE_PRIVATE_SYMBOL_PROPERTIES(VP)

  PER_ISOLATE_SYMBOL_PROPERTIES(VY)

  PER_ISOLATE_STRING_PROPERTIES(VS)

#undef V

#undef VY

#undef VS

#undef VP

#define V(PropertyName, TypeName)                                              \

  inline v8::Local<TypeName> PropertyName() const;                             \

  inline void set_##PropertyName(v8::Local<TypeName> value);

  PER_ISOLATE_TEMPLATE_PROPERTIES(V)

#undef V

  inline v8::Local<v8::String> async_wrap_provider(int index) const;

  size_t max_young_gen_size = 1;

  std::unordered_map<const char*, v8::Eternal<v8::String>> static_str_map;

  inline v8::Isolate* isolate() const;

  IsolateData(const IsolateData&) = delete;

  IsolateData& operator=(const IsolateData&) = delete;

  IsolateData(IsolateData&&) = delete;

  IsolateData& operator=(IsolateData&&) = delete;

 private:

  void DeserializeProperties(const IsolateDataSerializeInfo* isolate_data_info);

  void CreateProperties();

#define VP(PropertyName, StringValue) V(v8::Private, PropertyName)

#define VY(PropertyName, StringValue) V(v8::Symbol, PropertyName)

#define VS(PropertyName, StringValue) V(v8::String, PropertyName)

#define VT(PropertyName, TypeName) V(TypeName, PropertyName)

#define V(TypeName, PropertyName)                                             \

  v8::Eternal<TypeName> PropertyName ## _;

  PER_ISOLATE_PRIVATE_SYMBOL_PROPERTIES(VP)

  PER_ISOLATE_SYMBOL_PROPERTIES(VY)

  PER_ISOLATE_STRING_PROPERTIES(VS)

  PER_ISOLATE_TEMPLATE_PROPERTIES(VT)

#undef V

#undef V

#undef VT

#undef VS

#undef VY

#undef VP

  // Keep a list of all Persistent strings used for AsyncWrap Provider types.

  std::array<v8::Eternal<v8::String>, AsyncWrap::PROVIDERS_LENGTH>

      async_wrap_providers_;

  v8::Isolate* const isolate_;

  uv_loop_t* const event_loop_;

  NodeArrayBufferAllocator* const node_allocator_;

  MultiIsolatePlatform* platform_;

  std::shared_ptr<PerIsolateOptions> options_;

  worker::Worker* worker_context_ = nullptr;

};

struct ContextInfo {

  const std::string name;

  std::string origin;

  bool is_default = false;

};

class EnabledDebugList;

namespace per_process {

extern std::shared_ptr<KVStore> system_environment;

}

struct EnvSerializeInfo;

class AsyncHooks : public MemoryRetainer {

 public:

  void MemoryInfo(MemoryTracker* tracker) const override;

  // Reason for both UidFields and Fields are that one is stored as a double*

  // and the other as a uint32_t*.

  enum Fields {

    kInit,

    kBefore,

    kAfter,

    kDestroy,

    kPromiseResolve,

    kTotals,

    kCheck,

    kStackLength,

    kUsesExecutionAsyncResource,

    kFieldsCount,

  };

  enum UidFields {

    kExecutionAsyncId,

    kTriggerAsyncId,

    kAsyncIdCounter,

    kDefaultTriggerAsyncId,

    kUidFieldsCount,

  };

  inline AliasedUint32Array& fields();

  inline AliasedFloat64Array& async_id_fields();

  inline AliasedFloat64Array& async_ids_stack();

  inline v8::Local<v8::Array> js_execution_async_resources();

  // Returns the native executionAsyncResource value at stack index `index`.

  // Resources provided on the JS side are not stored on the native stack,

  // in which case an empty `Local<>` is returned.

  // The `js_execution_async_resources` array contains the value in that case.

  inline v8::Local<v8::Object> native_execution_async_resource(size_t index);

  void SetJSPromiseHooks(v8::Local<v8::Function> init,

                         v8::Local<v8::Function> before,

                         v8::Local<v8::Function> after,

                         v8::Local<v8::Function> resolve);

  inline v8::Local<v8::String> provider_string(int idx);

  inline void no_force_checks();

  inline Environment* env();

  // NB: This call does not take (co-)ownership of `execution_async_resource`.

  // The lifetime of the `v8::Local<>` pointee must last until

  // `pop_async_context()` or `clear_async_id_stack()` are called.

  void push_async_context(double async_id,

                          double trigger_async_id,

                          v8::Local<v8::Object> execution_async_resource);

  bool pop_async_context(double async_id);

  void clear_async_id_stack();  // Used in fatal exceptions.

  void AddContext(v8::Local<v8::Context> ctx);

  void RemoveContext(v8::Local<v8::Context> ctx);

  AsyncHooks(const AsyncHooks&) = delete;

  AsyncHooks& operator=(const AsyncHooks&) = delete;

  AsyncHooks(AsyncHooks&&) = delete;

  AsyncHooks& operator=(AsyncHooks&&) = delete;

  // Used to set the kDefaultTriggerAsyncId in a scope. This is instead of

  // passing the trigger_async_id along with other constructor arguments.

  class DefaultTriggerAsyncIdScope {

   public:

    DefaultTriggerAsyncIdScope() = delete;

    explicit DefaultTriggerAsyncIdScope(Environment* env,

                                        double init_trigger_async_id);

    explicit DefaultTriggerAsyncIdScope(AsyncWrap* async_wrap);

    ~DefaultTriggerAsyncIdScope();

    DefaultTriggerAsyncIdScope(const DefaultTriggerAsyncIdScope&) = delete;

    DefaultTriggerAsyncIdScope& operator=(const DefaultTriggerAsyncIdScope&) =

        delete;

    DefaultTriggerAsyncIdScope(DefaultTriggerAsyncIdScope&&) = delete;

    DefaultTriggerAsyncIdScope& operator=(DefaultTriggerAsyncIdScope&&) =

        delete;

   private:

    AsyncHooks* async_hooks_;

    double old_default_trigger_async_id_;

  };

  struct SerializeInfo {

    AliasedBufferIndex async_ids_stack;

    AliasedBufferIndex fields;

    AliasedBufferIndex async_id_fields;

    SnapshotIndex js_execution_async_resources;

    std::vector<SnapshotIndex> native_execution_async_resources;

  };

  SerializeInfo Serialize(v8::Local<v8::Context> context,

                          v8::SnapshotCreator* creator);

  void Deserialize(v8::Local<v8::Context> context);

 private:

  friend class Environment;  // So we can call the constructor.

  explicit AsyncHooks(v8::Isolate* isolate, const SerializeInfo* info);

  [[noreturn]] void FailWithCorruptedAsyncStack(double expected_async_id);

  // Stores the ids of the current execution context stack.

  AliasedFloat64Array async_ids_stack_;

  // Attached to a Uint32Array that tracks the number of active hooks for

  // each type.

  AliasedUint32Array fields_;

  // Attached to a Float64Array that tracks the state of async resources.

  AliasedFloat64Array async_id_fields_;

  void grow_async_ids_stack();

  v8::Global<v8::Array> js_execution_async_resources_;

  std::vector<v8::Local<v8::Object>> native_execution_async_resources_;

  // Non-empty during deserialization

  const SerializeInfo* info_ = nullptr;

  std::vector<v8::Global<v8::Context>> contexts_;

  std::array<v8::Global<v8::Function>, 4> js_promise_hooks_;

};

class ImmediateInfo : public MemoryRetainer {

 public:

  inline AliasedUint32Array& fields();

  inline uint32_t count() const;

  inline uint32_t ref_count() const;

  inline bool has_outstanding() const;

  inline void ref_count_inc(uint32_t increment);

  inline void ref_count_dec(uint32_t decrement);

  ImmediateInfo(const ImmediateInfo&) = delete;

  ImmediateInfo& operator=(const ImmediateInfo&) = delete;

  ImmediateInfo(ImmediateInfo&&) = delete;

  ImmediateInfo& operator=(ImmediateInfo&&) = delete;

  void MemoryInfo(MemoryTracker* tracker) const override;

  struct SerializeInfo {

    AliasedBufferIndex fields;

  };

  SerializeInfo Serialize(v8::Local<v8::Context> context,

                          v8::SnapshotCreator* creator);

  void Deserialize(v8::Local<v8::Context> context);

 private:

  friend class Environment;  // So we can call the constructor.

  explicit ImmediateInfo(v8::Isolate* isolate, const SerializeInfo* info);

  enum Fields { kCount, kRefCount, kHasOutstanding, kFieldsCount };

  AliasedUint32Array fields_;

};

class TickInfo : public MemoryRetainer {

 public:

  inline AliasedUint8Array& fields();

  inline bool has_tick_scheduled() const;

  inline bool has_rejection_to_warn() const;

  void MemoryInfo(MemoryTracker* tracker) const override;

  TickInfo(const TickInfo&) = delete;

  TickInfo& operator=(const TickInfo&) = delete;

  TickInfo(TickInfo&&) = delete;

  TickInfo& operator=(TickInfo&&) = delete;

  struct SerializeInfo {

    AliasedBufferIndex fields;

  };

  SerializeInfo Serialize(v8::Local<v8::Context> context,

                          v8::SnapshotCreator* creator);

  void Deserialize(v8::Local<v8::Context> context);

 private:

  friend class Environment;  // So we can call the constructor.

  explicit TickInfo(v8::Isolate* isolate, const SerializeInfo* info);

  enum Fields { kHasTickScheduled = 0, kHasRejectionToWarn, kFieldsCount };

  AliasedUint8Array fields_;

};

class TrackingTraceStateObserver :

    public v8::TracingController::TraceStateObserver {

 public:

 private:

  void UpdateTraceCategoryState();

  Environment* env_;

};

class ShouldNotAbortOnUncaughtScope {

 public:

  explicit inline ShouldNotAbortOnUncaughtScope(Environment* env);

  inline void Close();

  inline ~ShouldNotAbortOnUncaughtScope();

  ShouldNotAbortOnUncaughtScope(const ShouldNotAbortOnUncaughtScope&) = delete;

  ShouldNotAbortOnUncaughtScope& operator=(

      const ShouldNotAbortOnUncaughtScope&) = delete;

  ShouldNotAbortOnUncaughtScope(ShouldNotAbortOnUncaughtScope&&) = delete;

  ShouldNotAbortOnUncaughtScope& operator=(ShouldNotAbortOnUncaughtScope&&) =

      delete;

 private:

  Environment* env_;

};

class CleanupHookCallback {

 public:

  typedef void (*Callback)(void*);

                      void* arg,

                      uint64_t insertion_order_counter)

  // Only hashes `arg_`, since that is usually enough to identify the hook.

  struct Hash {

    inline size_t operator()(const CleanupHookCallback& cb) const;

  };

  // Compares by `fn_` and `arg_` being equal.

  struct Equal {

    inline bool operator()(const CleanupHookCallback& a,

                           const CleanupHookCallback& b) const;

  };

  inline BaseObject* GetBaseObject() const;

 private:

  friend class Environment;

  Callback fn_;

  void* arg_;

  // We keep track of the insertion order for these objects, so that we can

  // call the callbacks in reverse order when we are cleaning up.

  uint64_t insertion_order_counter_;

};

typedef void (*DeserializeRequestCallback)(v8::Local<v8::Context> context,

                                           v8::Local<v8::Object> holder,

                                           int index,

                                           InternalFieldInfoBase* info);

struct DeserializeRequest {

  DeserializeRequestCallback cb;

  v8::Global<v8::Object> holder;

  int index;

  InternalFieldInfoBase* info = nullptr;  // Owned by the request

  // Move constructor

};

struct EnvSerializeInfo {

  std::vector<PropInfo> native_objects;

  std::vector<std::string> builtins;

  AsyncHooks::SerializeInfo async_hooks;

  TickInfo::SerializeInfo tick_info;

  ImmediateInfo::SerializeInfo immediate_info;

  performance::PerformanceState::SerializeInfo performance_state;

  AliasedBufferIndex exiting;

  AliasedBufferIndex stream_base_state;

  AliasedBufferIndex should_abort_on_uncaught_toggle;

  std::vector<PropInfo> persistent_values;

  SnapshotIndex context;

  friend std::ostream& operator<<(std::ostream& o, const EnvSerializeInfo& i);

};

struct SnapshotMetadata {

  // For now kFullyCustomized is only built with the --build-snapshot CLI flag.

  // We might want to add more types of snapshots in the future.

  enum class Type : uint8_t { kDefault, kFullyCustomized };

  Type type;

  std::string node_version;