node/src/compile_cache.h at force-push-validate-commit-message · aduh95/node · GitHub

History

134 lines (110 loc) · 4.28 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

#ifndef SRC_COMPILE_CACHE_H_

#define SRC_COMPILE_CACHE_H_

#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#include <cinttypes>

#include <memory>

#include <string>

#include <string_view>

#include <unordered_map>

#include "v8.h"

namespace node {

class Environment;

#define CACHED_CODE_TYPES(V) \

V(kCommonJS, 0) \

V(kESM, 1) \

V(kStrippedTypeScript, 2)

enum class CachedCodeType : uint8_t {

#define V(type, value) type = value,

CACHED_CODE_TYPES(V)

#undef V

};

struct CompileCacheEntry {

std::unique_ptr<v8::ScriptCompiler::CachedData> cache{nullptr};

uint32_t cache_key;

uint32_t code_hash;

uint32_t code_size;

std::string cache_filename;

std::string source_filename;

CachedCodeType type;

bool refreshed = false;

bool persisted = false;

// Copy the cache into a new store for V8 to consume. Caller takes

// ownership.

v8::ScriptCompiler::CachedData* CopyCache() const;

const char* type_name() const;

};

#define COMPILE_CACHE_STATUS(V) \

V(FAILED) /* Failed to enable the cache */ \

V(ENABLED) /* Was not enabled before, and now enabled. */ \

V(ALREADY_ENABLED) /* Was already enabled. */ \

V(DISABLED) /* Has been disabled by NODE_DISABLE_COMPILE_CACHE. */

enum class CompileCacheEnableStatus : uint8_t {

#define V(status) status,

COMPILE_CACHE_STATUS(V)

#undef V

};

struct CompileCacheEnableResult {

CompileCacheEnableStatus status;

std::string cache_directory;

std::string message; // Set in case of failure.

};

enum class EnableOption : uint8_t {

DEFAULT = 0,

PORTABLE = 1 << 0,

// Only read existing cache entries: nothing is compiled into the in-memory

// store for persisting, nothing is written to disk, and the cache directory

// is not created if it does not exist.

READ_ONLY = 1 << 1,

};

inline constexpr EnableOption operator|(EnableOption a, EnableOption b) {

return static_cast<EnableOption>(static_cast<uint8_t>(a) |

static_cast<uint8_t>(b));

}

inline constexpr bool HasOption(EnableOption value, EnableOption flag) {

return (static_cast<uint8_t>(value) & static_cast<uint8_t>(flag)) != 0;

}

class CompileCacheHandler {

public:

explicit CompileCacheHandler(Environment* env);

CompileCacheEnableResult Enable(Environment* env,

const std::string& dir,

EnableOption option = EnableOption::DEFAULT);

void Persist();

CompileCacheEntry* GetOrInsert(v8::Local<v8::String> code,

v8::Local<v8::String> filename,

CachedCodeType type);

void MaybeSave(CompileCacheEntry* entry,

v8::Local<v8::Function> func,

bool rejected);

void MaybeSave(CompileCacheEntry* entry,

v8::Local<v8::Module> mod,

bool rejected);

void MaybeSave(CompileCacheEntry* entry, std::string_view transpiled);

std::string_view cache_dir() { return compile_cache_dir_; }

bool read_only() const { return read_only_; }

private:

void ReadCacheFile(CompileCacheEntry* entry);

template <typename T>

void MaybeSaveImpl(CompileCacheEntry* entry,

v8::Local<T> func_or_mod,

bool rejected);

template <typename... Args>

inline void Debug(const char* format, Args&&... args) const;

static constexpr size_t kMagicNumberOffset = 0;

static constexpr size_t kCodeSizeOffset = 1;

static constexpr size_t kCacheSizeOffset = 2;

static constexpr size_t kCodeHashOffset = 3;

static constexpr size_t kCacheHashOffset = 4;

static constexpr size_t kHeaderCount = 5;

v8::Isolate* isolate_ = nullptr;

bool is_debug_ = false;

std::string compile_cache_dir_;

std::string normalized_compile_cache_dir_;

EnableOption portable_ = EnableOption::DEFAULT;

bool read_only_ = false;

std::unordered_map<uint32_t, std::unique_ptr<CompileCacheEntry>>

compiler_cache_store_;

};

} // namespace node

#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS

#endif // SRC_COMPILE_CACHE_H_

node/src/compile_cache.h at force-push-validate-commit-message · aduh95/node · GitHub

Expand file tree

Breadcrumbs

compile_cache.h

Latest commit

History

Breadcrumbs

compile_cache.h

File metadata and controls