snapshot_builder.cc

#include "snapshot_builder.h"
#include <iostream>
#include <sstream>
#include "debug_utils-inl.h"
#include "env-inl.h"
#include "node_external_reference.h"
#include "node_internals.h"
#include "node_main_instance.h"
#include "node_v8_platform-inl.h"

namespace node {

using v8::Context;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::SnapshotCreator;
using v8::StartupData;

template <typename T>
void WriteVector(std::stringstream* ss, const T* vec, size_t size) {
  for (size_t i = 0; i < size; i++) {
    *ss << std::to_string(vec[i]) << (i == size - 1 ? '\n' : ',');
  }
}

std::string FormatBlob(v8::StartupData* blob,
                       const std::vector<size_t>& isolate_data_indexes,
                       const EnvSerializeInfo& env_info) {
  std::stringstream ss;

  // TODO(joyeechenug): aliased_buffer.h implicitly depends on util-inl.h,
  // fix it.
  ss << R"(#include <cstddef>
#include "env.h"
#include "node_main_instance.h"
#include "util-inl.h"
#include "v8.h"

// This file is generated by tools/snapshot. Do not edit.

namespace node {

static const char blob_data[] = {
)";
  WriteVector(&ss, blob->data, blob->raw_size);
  ss << R"(};

static const int blob_size = )"
     << blob->raw_size << R"(;
static v8::StartupData blob = { blob_data, blob_size };
)";

  ss << R"(v8::StartupData* NodeMainInstance::GetEmbeddedSnapshotBlob() {
  return &blob;
}

static const std::vector<size_t> isolate_data_indexes {
)";
  WriteVector(&ss, isolate_data_indexes.data(), isolate_data_indexes.size());
  ss << R"(};

const std::vector<size_t>* NodeMainInstance::GetIsolateDataIndexes() {
  return &isolate_data_indexes;
}

static const EnvSerializeInfo env_info )"
     << env_info << R"(;

const EnvSerializeInfo* NodeMainInstance::GetEnvSerializeInfo() {
  return &env_info;
}

}  // namespace node
)";

  return ss.str();
}

static v8::StartupData SerializeNodeContextInternalFields(Local<Object> holder,
                                                          int index,
                                                          void* env) {
  void* ptr = holder->GetAlignedPointerFromInternalField(index);
  if (ptr == nullptr) {
    return StartupData{reinterpret_cast<const char*>(0), 0};
  }
  // TODO(joyee): add more types for other objects with embedder fields.
  if (index == BaseObject::kSlot) {
    BaseObject* obj = static_cast<BaseObject*>(ptr);
    switch (obj->type()) {
      case InternalFieldType::kNoBindingData: {
        per_process::Debug(DebugCategory::MKSNAPSHOT,
                           "Serializing NoBindingData with index %d at %p\n",
                           index,
                           ptr);
        InternalFieldInfo* info = new InternalFieldInfo{obj->type(), 0};
        return StartupData{reinterpret_cast<const char*>(info), sizeof(*info)};
      }
      case InternalFieldType::kDefault: {
        per_process::Debug(DebugCategory::MKSNAPSHOT,
                           "Serializing default with index %d at %p\n",
                           index,
                           ptr);
        InternalFieldInfo* info = new InternalFieldInfo{obj->type(), 0};
        return StartupData{reinterpret_cast<const char*>(info), sizeof(*info)};
      };
      default: { UNREACHABLE(); }
    }
  }
  // TODO(joyee): add more types for other objects with embedder fields.
  InternalFieldInfo* info =
      new InternalFieldInfo{InternalFieldType::kDefault, 0};
  return StartupData{reinterpret_cast<const char*>(info), sizeof(*info)};
}

std::string SnapshotBuilder::Generate(
    const std::vector<std::string> args,
    const std::vector<std::string> exec_args) {
  Isolate* isolate = Isolate::Allocate();
  per_process::v8_platform.Platform()->RegisterIsolate(isolate,
                                                       uv_default_loop());
  std::unique_ptr<NodeMainInstance> main_instance;
  std::string result;

  {
    std::vector<size_t> isolate_data_indexes;
    EnvSerializeInfo env_info;

    const std::vector<intptr_t>& external_references =
        NodeMainInstance::CollectExternalReferences();
    SnapshotCreator creator(isolate, external_references.data());
    Environment* env;
    {
      main_instance =
          NodeMainInstance::Create(isolate,
                                   uv_default_loop(),
                                   per_process::v8_platform.Platform(),
                                   args,
                                   exec_args);

      HandleScope scope(isolate);
      creator.SetDefaultContext(Context::New(isolate));
      isolate_data_indexes = main_instance->isolate_data()->Serialize(&creator);

      Local<Context> context = NewContext(isolate);
      Context::Scope context_scope(context);

      env = new Environment(main_instance->isolate_data(),
                            context,
                            args,
                            exec_args,
                            nullptr,
                            node::EnvironmentFlags::kDefaultFlags,
                            {});
      if (per_process::enabled_debug_list.enabled(DebugCategory::MKSNAPSHOT)) {
        env->PrintAllBaseObjects();
        printf("Environment = %p\n", env);
      }
      env->RunBootstrapping().ToLocalChecked();
      env_info = env->Serialize(&creator);
      size_t index = creator.AddContext(
          context, {SerializeNodeContextInternalFields, env});
      CHECK_EQ(index, NodeMainInstance::kNodeContextIndex);
      // env->RunCleanup();  // will be necessary when we initiliaze libuv
    }

    env->ReleaseContext();
    // Must be out of HandleScope
    StartupData blob =
        creator.CreateBlob(SnapshotCreator::FunctionCodeHandling::kClear);
    CHECK(blob.CanBeRehashed());
    // Must be done while the snapshot creator isolate is entered i.e. the
    // creator is still alive.
    env->set_stopping(true);
    delete env;
    main_instance->Dispose();
    result = FormatBlob(&blob, isolate_data_indexes, env_info);
    delete[] blob.data;
  }

  per_process::v8_platform.Platform()->UnregisterIsolate(isolate);
  return result;
}
}  // namespace node