Skip to content

Commit

Permalink
bootstrap: move embedded snapshot to SnapshotBuilder
Browse files Browse the repository at this point in the history
So that the embedded snapshot can be reused by the worker.

PR-URL: #42702
Refs: #35711
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
joyeecheung authored and juanarbol committed May 31, 2022
1 parent cc90d11 commit 27bed94
Show file tree
Hide file tree
Showing 10 changed files with 78 additions and 44 deletions.
1 change: 1 addition & 0 deletions node.gyp
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,7 @@
'src/node_revert.h',
'src/node_root_certs.h',
'src/node_snapshotable.h',
'src/node_snapshot_builder.h',
'src/node_sockaddr.h',
'src/node_sockaddr-inl.h',
'src/node_stat_watcher.h',
Expand Down
5 changes: 3 additions & 2 deletions src/node.cc
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

#include "debug_utils-inl.h"
#include "env-inl.h"
#include "memory_tracker-inl.h"
#include "histogram-inl.h"
#include "memory_tracker-inl.h"
#include "node_binding.h"
#include "node_errors.h"
#include "node_internals.h"
Expand All @@ -38,6 +38,7 @@
#include "node_process-inl.h"
#include "node_report.h"
#include "node_revert.h"
#include "node_snapshot_builder.h"
#include "node_v8_platform-inl.h"
#include "node_version.h"

Expand Down Expand Up @@ -1158,7 +1159,7 @@ int Start(int argc, char** argv) {
bool use_node_snapshot =
per_process::cli_options->per_isolate->node_snapshot;
const SnapshotData* snapshot_data =
use_node_snapshot ? NodeMainInstance::GetEmbeddedSnapshotData()
use_node_snapshot ? SnapshotBuilder::GetEmbeddedSnapshotData()
: nullptr;
uv_loop_configure(uv_default_loop(), UV_METRICS_IDLE_TIME);

Expand Down
8 changes: 5 additions & 3 deletions src/node_external_reference.cc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@
namespace node {

const std::vector<intptr_t>& ExternalReferenceRegistry::external_references() {
CHECK(!is_finalized_);
external_references_.push_back(reinterpret_cast<intptr_t>(nullptr));
is_finalized_ = true;
if (!is_finalized_) {
external_references_.push_back(reinterpret_cast<intptr_t>(nullptr));
is_finalized_ = true;
}

return external_references_;
}

Expand Down
19 changes: 3 additions & 16 deletions src/node_main_instance.cc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include "node_external_reference.h"
#include "node_internals.h"
#include "node_options-inl.h"
#include "node_snapshot_builder.h"
#include "node_snapshotable.h"
#include "node_v8_platform-inl.h"
#include "util-inl.h"
Expand All @@ -23,8 +24,6 @@ using v8::Isolate;
using v8::Local;
using v8::Locker;

std::unique_ptr<ExternalReferenceRegistry> NodeMainInstance::registry_ =
nullptr;
NodeMainInstance::NodeMainInstance(Isolate* isolate,
uv_loop_t* event_loop,
MultiIsolatePlatform* platform,
Expand All @@ -43,13 +42,6 @@ NodeMainInstance::NodeMainInstance(Isolate* isolate,
SetIsolateMiscHandlers(isolate_, {});
}

const std::vector<intptr_t>& NodeMainInstance::CollectExternalReferences() {
// Cannot be called more than once.
CHECK_NULL(registry_);
registry_.reset(new ExternalReferenceRegistry());
return registry_->external_references();
}

std::unique_ptr<NodeMainInstance> NodeMainInstance::Create(
Isolate* isolate,
uv_loop_t* event_loop,
Expand All @@ -75,13 +67,8 @@ NodeMainInstance::NodeMainInstance(const SnapshotData* snapshot_data,
snapshot_data_(snapshot_data) {
isolate_params_->array_buffer_allocator = array_buffer_allocator_.get();
if (snapshot_data != nullptr) {
// TODO(joyeecheung): collect external references and set it in
// params.external_references.
const std::vector<intptr_t>& external_references =
CollectExternalReferences();
isolate_params_->external_references = external_references.data();
isolate_params_->snapshot_blob =
const_cast<v8::StartupData*>(&(snapshot_data->blob));
SnapshotBuilder::InitializeIsolateParams(snapshot_data,
isolate_params_.get());
}

isolate_ = Isolate::Allocate();
Expand Down
5 changes: 0 additions & 5 deletions src/node_main_instance.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,6 @@ class NodeMainInstance {
DeleteFnPtr<Environment, FreeEnvironment> CreateMainEnvironment(
int* exit_code);

// If nullptr is returned, the binary is not built with embedded
// snapshot.
static const SnapshotData* GetEmbeddedSnapshotData();
static const std::vector<intptr_t>& CollectExternalReferences();

static const size_t kNodeContextIndex = 0;
NodeMainInstance(const NodeMainInstance&) = delete;
NodeMainInstance& operator=(const NodeMainInstance&) = delete;
Expand Down
43 changes: 43 additions & 0 deletions src/node_snapshot_builder.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

#ifndef SRC_NODE_SNAPSHOT_BUILDER_H_
#define SRC_NODE_SNAPSHOT_BUILDER_H_

#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#include <cstdint>
#include "node_mutex.h"
#include "v8.h"

namespace node {

class ExternalReferenceRegistry;
struct SnapshotData;

class SnapshotBuilder {
public:
static std::string Generate(const std::vector<std::string> args,
const std::vector<std::string> exec_args);

// Generate the snapshot into out.
static void Generate(SnapshotData* out,
const std::vector<std::string> args,
const std::vector<std::string> exec_args);

// If nullptr is returned, the binary is not built with embedded
// snapshot.
static const SnapshotData* GetEmbeddedSnapshotData();
static void InitializeIsolateParams(const SnapshotData* data,
v8::Isolate::CreateParams* params);

private:
// Used to synchronize access to the snapshot data
static Mutex snapshot_data_mutex_;
static const std::vector<intptr_t>& CollectExternalReferences();

static std::unique_ptr<ExternalReferenceRegistry> registry_;
};
} // namespace node

#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#endif // SRC_NODE_SNAPSHOT_BUILDER_H_
4 changes: 2 additions & 2 deletions src/node_snapshot_stub.cc
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
// NODE_WANT_INTERNALS, so we define it here manually.
#define NODE_WANT_INTERNALS 1

#include "node_main_instance.h"
#include "node_snapshot_builder.h"

namespace node {

const SnapshotData* NodeMainInstance::GetEmbeddedSnapshotData() {
const SnapshotData* SnapshotBuilder::GetEmbeddedSnapshotData() {
return nullptr;
}

Expand Down
23 changes: 19 additions & 4 deletions src/node_snapshotable.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include "node_internals.h"
#include "node_main_instance.h"
#include "node_process.h"
#include "node_snapshot_builder.h"
#include "node_v8.h"
#include "node_v8_platform-inl.h"

Expand Down Expand Up @@ -49,7 +50,7 @@ std::string FormatBlob(SnapshotData* data) {

ss << R"(#include <cstddef>
#include "env.h"
#include "node_main_instance.h"
#include "node_snapshot_builder.h"
#include "v8.h"
// This file is generated by tools/snapshot. Do not edit.
Expand Down Expand Up @@ -78,11 +79,12 @@ SnapshotData snapshot_data {
// -- isolate_data_indices ends --
// -- env_info begins --
)" << data->env_info
<< R"(
<< R"(
// -- env_info ends --
};
const SnapshotData* NodeMainInstance::GetEmbeddedSnapshotData() {
const SnapshotData* SnapshotBuilder::GetEmbeddedSnapshotData() {
Mutex::ScopedLock lock(snapshot_data_mutex_);
return &snapshot_data;
}
} // namespace node
Expand All @@ -91,6 +93,19 @@ const SnapshotData* NodeMainInstance::GetEmbeddedSnapshotData() {
return ss.str();
}

Mutex SnapshotBuilder::snapshot_data_mutex_;

const std::vector<intptr_t>& SnapshotBuilder::CollectExternalReferences() {
static auto registry = std::make_unique<ExternalReferenceRegistry>();
return registry->external_references();
}

void SnapshotBuilder::InitializeIsolateParams(const SnapshotData* data,
Isolate::CreateParams* params) {
params->external_references = CollectExternalReferences().data();
params->snapshot_blob = const_cast<v8::StartupData*>(&(data->blob));
}

void SnapshotBuilder::Generate(SnapshotData* out,
const std::vector<std::string> args,
const std::vector<std::string> exec_args) {
Expand All @@ -104,7 +119,7 @@ void SnapshotBuilder::Generate(SnapshotData* out,

{
const std::vector<intptr_t>& external_references =
NodeMainInstance::CollectExternalReferences();
CollectExternalReferences();
SnapshotCreator creator(isolate, external_references.data());
Environment* env;
{
Expand Down
12 changes: 1 addition & 11 deletions src/node_snapshotable.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ namespace node {
class Environment;
struct EnvSerializeInfo;
struct SnapshotData;
class ExternalReferenceRegistry;

#define SERIALIZABLE_OBJECT_TYPES(V) \
V(fs_binding_data, fs::BindingData) \
Expand Down Expand Up @@ -122,17 +123,6 @@ void SerializeBindingData(Environment* env,
EnvSerializeInfo* info);

bool IsSnapshotableType(FastStringKey key);

class SnapshotBuilder {
public:
static std::string Generate(const std::vector<std::string> args,
const std::vector<std::string> exec_args);

// Generate the snapshot into out.
static void Generate(SnapshotData* out,
const std::vector<std::string> args,
const std::vector<std::string> exec_args);
};
} // namespace node

#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
Expand Down
2 changes: 1 addition & 1 deletion tools/snapshot/node_mksnapshot.cc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#include "libplatform/libplatform.h"
#include "node_internals.h"
#include "node_snapshotable.h"
#include "node_snapshot_builder.h"
#include "util-inl.h"
#include "v8.h"

Expand Down

0 comments on commit 27bed94

Please sign in to comment.