Files
bun.sh/src/bun.js/bindings/ZigSourceProvider.cpp
2024-12-09 23:10:32 -08:00

372 lines
14 KiB
C++

#include "root.h"
#include "helpers.h"
#include "ZigSourceProvider.h"
#include <JavaScriptCore/BytecodeCacheError.h>
#include "ZigGlobalObject.h"
#include "wtf/Assertions.h"
#include <JavaScriptCore/Completion.h>
#include <wtf/Scope.h>
#include <wtf/text/StringHash.h>
#include <sys/stat.h>
#include <JavaScriptCore/SourceCodeKey.h>
#include <mimalloc.h>
#include <JavaScriptCore/CodeCache.h>
extern "C" void RefString__free(void*, void*, unsigned);
namespace Zig {
using Base = JSC::SourceProvider;
using BytecodeCacheGenerator = JSC::BytecodeCacheGenerator;
using UnlinkedFunctionExecutable = JSC::UnlinkedFunctionExecutable;
using CachedBytecode = JSC::CachedBytecode;
using UnlinkedFunctionCodeBlock = JSC::UnlinkedFunctionCodeBlock;
using SourceCode = JSC::SourceCode;
using CodeSpecializationKind = JSC::CodeSpecializationKind;
using SourceOrigin = JSC::SourceOrigin;
using String = WTF::String;
using SourceProviderSourceType = JSC::SourceProviderSourceType;
SourceOrigin toSourceOrigin(const String& sourceURL, bool isBuiltin)
{
ASSERT_WITH_MESSAGE(!sourceURL.startsWith("file://"_s), "specifier should not already be a file URL");
if (isBuiltin) {
if (sourceURL.startsWith("node:"_s)) {
return SourceOrigin(WTF::URL(makeString("builtin://node/"_s, sourceURL.substring(5))));
} else if (sourceURL.startsWith("bun:"_s)) {
return SourceOrigin(WTF::URL(makeString("builtin://bun/"_s, sourceURL.substring(4))));
} else {
return SourceOrigin(WTF::URL(makeString("builtin://"_s, sourceURL)));
}
}
return SourceOrigin(WTF::URL::fileURLWithFileSystemPath(sourceURL));
}
extern "C" int ByteRangeMapping__getSourceID(void* mappings, BunString sourceURL);
extern "C" void* ByteRangeMapping__find(BunString sourceURL);
void* sourceMappingForSourceURL(const WTF::String& sourceURL)
{
return ByteRangeMapping__find(Bun::toString(sourceURL));
}
extern "C" void ByteRangeMapping__generate(BunString sourceURL, BunString code, int sourceID);
JSC::SourceID sourceIDForSourceURL(const WTF::String& sourceURL)
{
void* mappings = ByteRangeMapping__find(Bun::toString(sourceURL));
if (!mappings) {
return 0;
}
return ByteRangeMapping__getSourceID(mappings, Bun::toString(sourceURL));
}
extern "C" bool BunTest__shouldGenerateCodeCoverage(BunString sourceURL);
extern "C" void Bun__addSourceProviderSourceMap(void* bun_vm, SourceProvider* opaque_source_provider, BunString* specifier);
extern "C" void Bun__removeSourceProviderSourceMap(void* bun_vm, SourceProvider* opaque_source_provider, BunString* specifier);
Ref<SourceProvider> SourceProvider::create(
Zig::GlobalObject* globalObject,
ResolvedSource& resolvedSource,
JSC::SourceProviderSourceType sourceType,
bool isBuiltin)
{
auto string = resolvedSource.source_code.toWTFString(BunString::ZeroCopy);
auto sourceURLString = resolvedSource.source_url.toWTFString(BunString::ZeroCopy);
bool isCodeCoverageEnabled = !!globalObject->vm().controlFlowProfiler();
bool shouldGenerateCodeCoverage = isCodeCoverageEnabled && !isBuiltin && BunTest__shouldGenerateCodeCoverage(resolvedSource.source_url);
if (resolvedSource.needsDeref && !isBuiltin) {
resolvedSource.needsDeref = false;
resolvedSource.source_code.deref();
// Do not deref either source_url or specifier
// Specifier's lifetime is the JSValue, mostly
// source_url is owned by the string above
// https://github.com/oven-sh/bun/issues/9521
}
const auto getProvider = [&]() -> Ref<SourceProvider> {
if (resolvedSource.bytecode_cache != nullptr) {
const auto destructorPtr = [](const void* ptr) {
mi_free(const_cast<void*>(ptr));
};
const auto destructorNoOp = [](const void* ptr) {
// no-op, for bun build --compile.
};
const auto destructor = resolvedSource.needsDeref ? destructorPtr : destructorNoOp;
Ref<JSC::CachedBytecode> bytecode = JSC::CachedBytecode::create(std::span<uint8_t>(resolvedSource.bytecode_cache, resolvedSource.bytecode_cache_size), destructor, {});
auto provider = adoptRef(*new SourceProvider(
globalObject->isThreadLocalDefaultGlobalObject ? globalObject : nullptr,
resolvedSource,
string.isNull() ? *StringImpl::empty() : *string.impl(),
JSC::SourceTaintedOrigin::Untainted,
toSourceOrigin(sourceURLString, isBuiltin),
sourceURLString.impl(), TextPosition(),
sourceType));
provider->m_cachedBytecode = WTFMove(bytecode);
return provider;
}
return adoptRef(*new SourceProvider(
globalObject->isThreadLocalDefaultGlobalObject ? globalObject : nullptr,
resolvedSource,
string.isNull() ? *StringImpl::empty() : *string.impl(),
JSC::SourceTaintedOrigin::Untainted,
toSourceOrigin(sourceURLString, isBuiltin),
sourceURLString.impl(), TextPosition(),
sourceType));
};
auto provider = getProvider();
if (shouldGenerateCodeCoverage) {
ByteRangeMapping__generate(Bun::toString(provider->sourceURL()), Bun::toString(provider->source().toStringWithoutCopying()), provider->asID());
}
if (resolvedSource.already_bundled) {
Bun__addSourceProviderSourceMap(globalObject->bunVM(), provider.ptr(), &resolvedSource.source_url);
}
return provider;
}
StringView SourceProvider::source() const
{
return StringView(m_source.get());
}
SourceProvider::~SourceProvider()
{
if (m_resolvedSource.already_bundled) {
BunString str = Bun::toString(sourceURL());
Bun__removeSourceProviderSourceMap(m_globalObject->bunVM(), this, &str);
}
}
extern "C" void CachedBytecode__deref(JSC::CachedBytecode* cachedBytecode)
{
cachedBytecode->deref();
}
static JSC::VM& getVMForBytecodeCache()
{
static thread_local JSC::VM* vmForBytecodeCache = nullptr;
if (!vmForBytecodeCache) {
const auto heapSize = JSC::HeapType::Small;
auto& vm = JSC::VM::create(heapSize).leakRef();
vm.ref();
vmForBytecodeCache = &vm;
vm.heap.acquireAccess();
}
return *vmForBytecodeCache;
}
extern "C" bool generateCachedModuleByteCodeFromSourceCode(BunString* sourceProviderURL, const LChar* inputSourceCode, size_t inputSourceCodeSize, const uint8_t** outputByteCode, size_t* outputByteCodeSize, JSC::CachedBytecode** cachedBytecodePtr)
{
std::span<const LChar> sourceCodeSpan(inputSourceCode, inputSourceCodeSize);
JSC::SourceCode sourceCode = JSC::makeSource(WTF::String(sourceCodeSpan), toSourceOrigin(sourceProviderURL->toWTFString(), false), JSC::SourceTaintedOrigin::Untainted);
JSC::VM& vm = getVMForBytecodeCache();
JSC::JSLockHolder locker(vm);
LexicallyScopedFeatures lexicallyScopedFeatures = StrictModeLexicallyScopedFeature;
JSParserScriptMode scriptMode = JSParserScriptMode::Module;
EvalContextType evalContextType = EvalContextType::None;
ParserError parserError;
UnlinkedModuleProgramCodeBlock* unlinkedCodeBlock = JSC::recursivelyGenerateUnlinkedCodeBlockForModuleProgram(vm, sourceCode, lexicallyScopedFeatures, scriptMode, {}, parserError, evalContextType);
if (parserError.isValid())
return false;
if (!unlinkedCodeBlock)
return false;
auto key = JSC::sourceCodeKeyForSerializedModule(vm, sourceCode);
RefPtr<JSC::CachedBytecode> cachedBytecode = JSC::encodeCodeBlock(vm, key, unlinkedCodeBlock);
if (!cachedBytecode)
return false;
cachedBytecode->ref();
*cachedBytecodePtr = cachedBytecode.get();
*outputByteCode = cachedBytecode->span().data();
*outputByteCodeSize = cachedBytecode->span().size();
return true;
}
extern "C" bool generateCachedCommonJSProgramByteCodeFromSourceCode(BunString* sourceProviderURL, const LChar* inputSourceCode, size_t inputSourceCodeSize, const uint8_t** outputByteCode, size_t* outputByteCodeSize, JSC::CachedBytecode** cachedBytecodePtr)
{
std::span<const LChar> sourceCodeSpan(inputSourceCode, inputSourceCodeSize);
JSC::SourceCode sourceCode = JSC::makeSource(WTF::String(sourceCodeSpan), toSourceOrigin(sourceProviderURL->toWTFString(), false), JSC::SourceTaintedOrigin::Untainted);
JSC::VM& vm = getVMForBytecodeCache();
JSC::JSLockHolder locker(vm);
LexicallyScopedFeatures lexicallyScopedFeatures = NoLexicallyScopedFeatures;
JSParserScriptMode scriptMode = JSParserScriptMode::Classic;
EvalContextType evalContextType = EvalContextType::None;
ParserError parserError;
UnlinkedProgramCodeBlock* unlinkedCodeBlock = JSC::recursivelyGenerateUnlinkedCodeBlockForProgram(vm, sourceCode, lexicallyScopedFeatures, scriptMode, {}, parserError, evalContextType);
if (parserError.isValid())
return false;
if (!unlinkedCodeBlock)
return false;
auto key = JSC::sourceCodeKeyForSerializedProgram(vm, sourceCode);
RefPtr<JSC::CachedBytecode> cachedBytecode = JSC::encodeCodeBlock(vm, key, unlinkedCodeBlock);
if (!cachedBytecode)
return false;
cachedBytecode->ref();
*cachedBytecodePtr = cachedBytecode.get();
*outputByteCode = cachedBytecode->span().data();
*outputByteCodeSize = cachedBytecode->span().size();
return true;
}
unsigned SourceProvider::hash() const
{
if (m_hash) {
return m_hash;
}
return m_source->hash();
}
void SourceProvider::freeSourceCode()
{
}
void SourceProvider::updateCache(const UnlinkedFunctionExecutable* executable, const SourceCode&,
CodeSpecializationKind kind,
const UnlinkedFunctionCodeBlock* codeBlock) const
{
// if (!m_resolvedSource.bytecodecache_fd || !m_cachedBytecode)
return;
JSC::BytecodeCacheError error;
RefPtr<JSC::CachedBytecode> cachedBytecode = JSC::encodeFunctionCodeBlock(executable->vm(), codeBlock, error);
if (cachedBytecode && !error.isValid())
m_cachedBytecode->addFunctionUpdate(executable, kind, *cachedBytecode);
}
void SourceProvider::cacheBytecode(const BytecodeCacheGenerator& generator) const
{
// if (!m_resolvedSource.bytecodecache_fd)
return;
if (!m_cachedBytecode)
m_cachedBytecode = JSC::CachedBytecode::create();
auto update = generator();
if (update)
m_cachedBytecode->addGlobalUpdate(*update);
}
void SourceProvider::commitCachedBytecode() const
{
// if (!m_resolvedSource.bytecodecache_fd || !m_cachedBytecode || !m_cachedBytecode->hasUpdates())
return;
// auto clearBytecode = WTF::makeScopeExit([&] { m_cachedBytecode = nullptr; });
// const auto fd = m_resolvedSource.bytecodecache_fd;
// auto fileSize = FileSystem::fileSize(fd);
// if (!fileSize)
// return;
// size_t cacheFileSize;
// if (!WTF::convertSafely(*fileSize, cacheFileSize) || cacheFileSize != m_cachedBytecode->size()) {
// // The bytecode cache has already been updated
// return;
// }
// if (!FileSystem::truncateFile(fd, m_cachedBytecode->sizeForUpdate()))
// return;
// m_cachedBytecode->commitUpdates([&](off_t offset, const void* data, size_t size) {
// long long result = FileSystem::seekFile(fd, offset, FileSystem::FileSeekOrigin::Beginning);
// ASSERT_UNUSED(result, result != -1);
// size_t bytesWritten = static_cast<size_t>(FileSystem::writeToFile(fd, data, size));
// ASSERT_UNUSED(bytesWritten, bytesWritten == size);
// });
}
bool SourceProvider::isBytecodeCacheEnabled() const
{
// return m_resolvedSource.bytecodecache_fd > 0;
return false;
}
void SourceProvider::readOrGenerateByteCodeCache(JSC::VM& vm, const JSC::SourceCode& sourceCode)
{
// auto status = this->readCache(vm, sourceCode);
// switch (status) {
// case -1: {
// m_resolvedSource.bytecodecache_fd = 0;
// break;
// }
// case 0: {
// JSC::BytecodeCacheError err;
// m_cachedBytecode = JSC::generateModuleBytecode(vm, sourceCode, m_resolvedSource.bytecodecache_fd, err);
// if (err.isValid()) {
// m_resolvedSource.bytecodecache_fd = 0;
// m_cachedBytecode = JSC::CachedBytecode::create();
// }
// }
// // TODO: read the bytecode into a JSC::SourceCode object here
// case 1: {
// }
// }
}
int SourceProvider::readCache(JSC::VM& vm, const JSC::SourceCode& sourceCode)
{
return -1;
// if (m_resolvedSource.bytecodecache_fd == 0)
// return -1;
// if (!FileSystem::isHandleValid(m_resolvedSource.bytecodecache_fd))
// return -1;
// const auto fd = m_resolvedSource.bytecodecache_fd;
// bool success;
// FileSystem::MappedFileData mappedFile(fd, FileSystem::MappedFileMode::Shared, success);
// if (!success)
// return -1;
// const uint8_t* fileData = reinterpret_cast<const uint8_t*>(mappedFile.data());
// unsigned fileTotalSize = mappedFile.size();
// if (fileTotalSize == 0)
// return 0;
// Ref<JSC::CachedBytecode> cachedBytecode = JSC::CachedBytecode::create(WTFMove(mappedFile));
// // auto key = JSC::sourceCodeKeyForSerializedModule(vm, sourceCode);
// // if (isCachedBytecodeStillValid(vm, cachedBytecode.copyRef(), key,
// // JSC::SourceCodeType::ModuleType)) {
// m_cachedBytecode = WTFMove(cachedBytecode);
// return 1;
// } else {
// FileSystem::truncateFile(fd, 0);
// return 0;
// }
}
extern "C" BunString ZigSourceProvider__getSourceSlice(SourceProvider* provider)
{
return Bun::toStringView(provider->source());
}
}; // namespace Zig