node/src/node_snapshot_builder.h
Joyee Cheung fea74b0f7b
src: support configurable snapshot
- Add support for --build-snapshot-config which allows passing
  snapshot configurations via a JSON configuration file.
- Add support for node::SnapshotConfig in the embedder API

The initial configurable options are:

- "builder" (SnapshotConfig::builder_script_path): path to the
  builder script.
- "withoutCodeCache" (SnapshotFlags::kWithoutCodeCache): disable
  code cache generation.

PR-URL: https://github.com/nodejs/node/pull/50453
Refs: https://github.com/nodejs/node/issues/42566
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2023-12-15 15:13:46 +01:00

58 lines
1.9 KiB
C++

#ifndef SRC_NODE_SNAPSHOT_BUILDER_H_
#define SRC_NODE_SNAPSHOT_BUILDER_H_
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#include <cstdint>
#include <optional>
#include <string_view>
#include "node_exit_code.h"
#include "node_mutex.h"
#include "v8.h"
namespace node {
class ExternalReferenceRegistry;
struct SnapshotData;
std::optional<SnapshotConfig> ReadSnapshotConfig(const char* path);
class NODE_EXTERN_PRIVATE SnapshotBuilder {
public:
static ExitCode GenerateAsSource(const char* out_path,
const std::vector<std::string>& args,
const std::vector<std::string>& exec_args,
const SnapshotConfig& config,
bool use_array_literals = false);
// Generate the snapshot into out. builder_script_content should match
// config.builder_script_path. This is passed separately
// in case the script is already read for other purposes.
static ExitCode Generate(
SnapshotData* out,
const std::vector<std::string>& args,
const std::vector<std::string>& exec_args,
std::optional<std::string_view> builder_script_content,
const SnapshotConfig& config);
// 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);
static const std::vector<intptr_t>& CollectExternalReferences();
static ExitCode CreateSnapshot(SnapshotData* out,
CommonEnvironmentSetup* setup);
private:
static std::unique_ptr<ExternalReferenceRegistry> registry_;
};
} // namespace node
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#endif // SRC_NODE_SNAPSHOT_BUILDER_H_