mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
Shelley Vohr
65f518c72a
A compile cache generated ahead of time and shipped inside an application package should only ever be read: the package may be immutable or covered by an integrity check, and a cache directory that appears at run time would be a surprise. Add readOnly to module.enableCompileCache() and NODE_COMPILE_CACHE_READONLY=1: existing entries are loaded as before, nothing is serialized or persisted, flushCompileCache() is a no-op, and the cache directory is used as found rather than created, so enabling against a missing directory fails instead of making one. Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com> PR-URL: https://github.com/nodejs/node/pull/65302 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
135 lines
4.3 KiB
C++
135 lines
4.3 KiB
C++
#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_
|