ladybird/Libraries/LibJS/Script.cpp

/*
 * Copyright (c) 2021, Andreas Kling <andreas@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <LibJS/Bytecode/Executable.h>
#include <LibJS/Runtime/ECMAScriptFunctionObject.h>
#include <LibJS/Runtime/ExternalMemory.h>
#include <LibJS/Runtime/GlobalEnvironment.h>
#include <LibJS/Runtime/SharedFunctionInstanceData.h>
#include <LibJS/Runtime/VM.h>
#include <LibJS/RustIntegration.h>
#include <LibJS/Script.h>
#include <LibJS/SourceCode.h>

namespace JS {

bool g_dump_ast = false;
bool g_dump_ast_use_color = false;

GC_DEFINE_ALLOCATOR(Script);

// 16.1.5 ParseScript ( sourceText, realm, hostDefined ), https://tc39.es/ecma262/#sec-parse-script
Result<GC::Ref<Script>, Vector<ParserError>> Script::parse(StringView source_text, Realm& realm, StringView filename, HostDefined* host_defined, size_t line_number_offset)
{
    auto rust_compilation = RustIntegration::compile_script(source_text, realm, filename, line_number_offset);
    if (!rust_compilation.has_value())
        return Vector<ParserError> {};
    if (rust_compilation->is_error())
        return rust_compilation->release_error();
    return realm.heap().allocate<Script>(realm, filename, move(rust_compilation->value()), ExecutableBacking::source(), host_defined);
}

Result<GC::Ref<Script>, Vector<ParserError>> Script::create_from_parsed(FFI::ParsedProgram* parsed, NonnullRefPtr<SourceCode const> source_code, Realm& realm, HostDefined* host_defined)
{
    auto filename = source_code->filename();
    auto rust_compilation = RustIntegration::compile_parsed_script(parsed, move(source_code), realm);
    if (!rust_compilation.has_value())
        return Vector<ParserError> {};
    if (rust_compilation->is_error())
        return rust_compilation->release_error();
    return realm.heap().allocate<Script>(realm, filename, move(rust_compilation->value()), ExecutableBacking::source(), host_defined);
}

Result<GC::Ref<Script>, Vector<ParserError>> Script::create_from_compiled(FFI::CompiledProgram* compiled, NonnullRefPtr<SourceCode const> source_code, Realm& realm, HostDefined* host_defined)
{
    auto filename = source_code->filename();
    auto rust_compilation = RustIntegration::materialize_compiled_script(compiled, move(source_code), realm);
    if (!rust_compilation.has_value())
        return Vector<ParserError> {};
    if (rust_compilation->is_error())
        return rust_compilation->release_error();
    return realm.heap().allocate<Script>(realm, filename, move(rust_compilation->value()), ExecutableBacking::heap_bytecode(), host_defined);
}

Result<GC::Ref<Script>, Vector<ParserError>> Script::create_from_bytecode_cache(FFI::DecodedBytecodeCacheBlob* bytecode_cache, NonnullRefPtr<SourceCode const> source_code, Realm& realm, HostDefined* host_defined)
{
    auto filename = source_code->filename();
    auto rust_compilation = RustIntegration::materialize_bytecode_cache_script(bytecode_cache, move(source_code), realm);
    if (!rust_compilation.has_value())
        return Vector<ParserError> {};
    if (rust_compilation->is_error())
        return rust_compilation->release_error();
    return realm.heap().allocate<Script>(realm, filename, move(rust_compilation->value()), ExecutableBacking::mapped_bytecode_cache(), host_defined);
}

bool Script::try_install_bytecode_cache(FFI::DecodedBytecodeCacheBlob* bytecode_cache, NonnullRefPtr<SourceCode const> source_code)
{
    if (m_executable_backing.is_mapped_bytecode_cache()) {
        RustIntegration::free_decoded_bytecode_cache_blob(bytecode_cache);
        return false;
    }

    if (!m_executable) {
        RustIntegration::free_decoded_bytecode_cache_blob(bytecode_cache);
        return false;
    }

    auto shared_function_data = collect_shared_function_data();
    auto executable = RustIntegration::try_install_bytecode_cache_script(bytecode_cache, move(source_code), realm(), *m_executable, shared_function_data);
    if (!executable)
        return false;

    complete_bytecode_cache_install(*executable);
    return true;
}

void Script::install_generated_bytecode_cache(FFI::DecodedBytecodeCacheBlob* bytecode_cache, NonnullRefPtr<SourceCode const> source_code)
{
    VERIFY(can_install_generated_bytecode_cache());
    VERIFY(m_executable);

    auto shared_function_data = collect_shared_function_data();
    auto executable = RustIntegration::install_generated_bytecode_cache_script(bytecode_cache, move(source_code), realm(), *m_executable, shared_function_data);
    complete_bytecode_cache_install(executable);
}

bool Script::can_generate_bytecode_cache() const
{
    return m_executable && m_executable_backing.can_generate_bytecode_cache();
}

bool Script::can_install_generated_bytecode_cache() const
{
    return m_executable && m_executable_backing.can_install_generated_bytecode_cache();
}

void Script::begin_bytecode_cache_generation()
{
    VERIFY(can_generate_bytecode_cache());
    m_executable_backing.begin_bytecode_cache_generation();
    verify_executable_backing_invariants();
}

void Script::finish_bytecode_cache_generation_without_install()
{
    m_executable_backing.finish_bytecode_cache_generation_without_install();
    verify_executable_backing_invariants();
}

Vector<SharedFunctionInstanceData*> Script::collect_shared_function_data()
{
    Vector<SharedFunctionInstanceData*> shared_function_data;
    shared_function_data.ensure_capacity(m_shared_function_data.size_slow());
    m_shared_function_data.for_each([&](auto& shared_data) {
        shared_function_data.unchecked_append(&shared_data);
    });
    return shared_function_data;
}

void Script::complete_bytecode_cache_install(GC::Ref<Bytecode::Executable> executable)
{
    m_executable = executable;
    m_shared_function_data.clear_non_bytecode_cache_compile_inputs();
    m_executable_backing.finish_bytecode_cache_install();
    verify_executable_backing_invariants();
}

Script::Script(Realm& realm, StringView filename, RustIntegration::ScriptResult&& result, ExecutableBacking executable_backing, HostDefined* host_defined)
    : m_realm(realm)
    , m_executable(result.executable)
    , m_executable_backing(executable_backing)
    , m_lexical_names(move(result.lexical_names))
    , m_var_names(move(result.var_names))
    , m_declared_function_names(move(result.declared_function_names))
    , m_var_scoped_names(move(result.var_scoped_names))
    , m_annex_b_candidate_names(move(result.annex_b_candidate_names))
    , m_lexical_bindings(move(result.lexical_bindings))
    , m_is_strict_mode(result.is_strict_mode)
    , m_filename(filename)
    , m_host_defined(host_defined)
{
    for (auto& shared_data : result.shared_function_data)
        m_shared_function_data.append(*shared_data);

    m_functions_to_initialize.ensure_capacity(result.functions_to_initialize.size());
    for (auto& f : result.functions_to_initialize)
        m_functions_to_initialize.append({ *f.shared_data, move(f.name) });

    verify_executable_backing_invariants();
}

void Script::verify_executable_backing_invariants()
{
    VERIFY(m_executable);

    if (!m_executable_backing.requires_non_bytecode_cache_compile_inputs_to_be_cleared())
        return;

    VERIFY(!m_shared_function_data.contains_rust_function_ast());
    VERIFY(!m_shared_function_data.contains_precompiled_bytecode());
}

// 16.1.7 GlobalDeclarationInstantiation ( script, env ), https://tc39.es/ecma262/#sec-globaldeclarationinstantiation
ThrowCompletionOr<void> Script::global_declaration_instantiation(VM& vm, GlobalEnvironment& global_environment)
{
    auto& realm = *vm.current_realm();

    // 1. Let lexNames be the LexicallyDeclaredNames of script.
    // 2. Let varNames be the VarDeclaredNames of script.
    // 3. For each element name of lexNames, do
    for (auto const& name : m_lexical_names) {
        // a. If env.HasLexicalDeclaration(name) is true, throw a SyntaxError exception.
        if (global_environment.has_lexical_declaration(name))
            return vm.throw_completion<SyntaxError>(ErrorType::TopLevelVariableAlreadyDeclared, name);

        // b. Let hasRestrictedGlobal be ? HasRestrictedGlobalProperty(env, name).
        auto has_restricted_global = TRY(global_environment.has_restricted_global_property(name));

        // d. If hasRestrictedGlobal is true, throw a SyntaxError exception.
        if (has_restricted_global)
            return vm.throw_completion<SyntaxError>(ErrorType::RestrictedGlobalProperty, name);
    }

    // 4. For each element name of varNames, do
    for (auto const& name : m_var_names) {
        // a. If env.HasLexicalDeclaration(name) is true, throw a SyntaxError exception.
        if (global_environment.has_lexical_declaration(name))
            return vm.throw_completion<SyntaxError>(ErrorType::TopLevelVariableAlreadyDeclared, name);
    }

    // 5. Let varDeclarations be the VarScopedDeclarations of script.
    // 6. Let functionsToInitialize be a new empty List.
    // 7. Let declaredFunctionNames be a new empty List.
    // 8. For each element d of varDeclarations, in reverse List order, do
    for (auto const& function : m_functions_to_initialize) {
        // 1. Let fnDefinable be ? env.CanDeclareGlobalFunction(fn).
        auto function_definable = TRY(global_environment.can_declare_global_function(function.name));

        // 2. If fnDefinable is false, throw a TypeError exception.
        if (!function_definable)
            return vm.throw_completion<TypeError>(ErrorType::CannotDeclareGlobalFunction, function.name);
    }

    // 9. Let declaredVarNames be a new empty List.
    HashTable<Utf16FlyString> declared_var_names;

    // 10. For each element d of varDeclarations, do
    for (auto const& name : m_var_scoped_names) {
        // 1. If vn is not an element of declaredFunctionNames, then
        if (m_declared_function_names.contains(name))
            continue;

        // a. Let vnDefinable be ? env.CanDeclareGlobalVar(vn).
        auto var_definable = TRY(global_environment.can_declare_global_var(name));

        // b. If vnDefinable is false, throw a TypeError exception.
        if (!var_definable)
            return vm.throw_completion<TypeError>(ErrorType::CannotDeclareGlobalVariable, name);

        // c. If vn is not an element of declaredVarNames, then
        // i. Append vn to declaredVarNames.
        declared_var_names.set(name);
    }

    // 12. NOTE: Annex B.3.2.2 adds additional steps at this point.
    // 12. Let strict be IsStrict of script.
    // 13. If strict is false, then
    if (!m_is_strict_mode) {
        // a. Let declaredFunctionOrVarNames be the list-concatenation of declaredFunctionNames and declaredVarNames.
        // b. For each FunctionDeclaration f that is directly contained in the StatementList of a Block, CaseClause, or DefaultClause Contained within script, do
        for (size_t i = 0; i < m_annex_b_candidate_names.size(); ++i) {
            // i. Let F be StringValue of the BindingIdentifier of f.
            auto& function_name = m_annex_b_candidate_names[i];

            // 1. If env.HasLexicalDeclaration(F) is false, then
            if (global_environment.has_lexical_declaration(function_name))
                continue;

            // a. Let fnDefinable be ? env.CanDeclareGlobalVar(F).
            auto function_definable = TRY(global_environment.can_declare_global_function(function_name));
            // b. If fnDefinable is true, then
            if (!function_definable)
                continue;

            // ii. If declaredFunctionOrVarNames does not contain F, then
            if (!m_declared_function_names.contains(function_name) && !declared_var_names.contains(function_name)) {
                // i. Perform ? env.CreateGlobalVarBinding(F, false).
                TRY(global_environment.create_global_var_binding(function_name, false));
            }
        }
    }

    // 14. Let privateEnv be null.
    PrivateEnvironment* private_environment = nullptr;

    // 15. For each element d of lexDeclarations, do
    for (auto const& binding : m_lexical_bindings) {
        // i. If IsConstantDeclaration of d is true, then
        if (binding.is_constant) {
            // 1. Perform ? env.CreateImmutableBinding(dn, true).
            TRY(global_environment.create_immutable_binding(vm, binding.name, true));
        }
        // ii. Else,
        else {
            // 1. Perform ? env.CreateMutableBinding(dn, false).
            TRY(global_environment.create_mutable_binding(vm, binding.name, false));
        }
    }

    // 16. For each Parse Node f of functionsToInitialize, do
    for (auto const& function_to_initialize : m_functions_to_initialize) {
        // a. Let fn be the sole element of the BoundNames of f.
        // b. Let fo be InstantiateFunctionObject of f with arguments env and privateEnv.
        auto function = ECMAScriptFunctionObject::create_from_function_data(
            realm,
            function_to_initialize.shared_data,
            &global_environment,
            private_environment);

        // c. Perform ? env.CreateGlobalFunctionBinding(fn, fo, false).
        TRY(global_environment.create_global_function_binding(function->name(), function, false));
    }

    // 17. For each String vn of declaredVarNames, do
    for (auto& var_name : declared_var_names) {
        // a. Perform ? env.CreateGlobalVarBinding(vn, false).
        TRY(global_environment.create_global_var_binding(var_name, false));
    }

    // 18. Return unused.
    return {};
}

Script::~Script()
{
}

void Script::visit_edges(Cell::Visitor& visitor)
{
    Base::visit_edges(visitor);
    visitor.visit(m_realm);
    visitor.visit(m_executable);
    m_shared_function_data.visit_edges(visitor);
    for (auto const& function : m_functions_to_initialize)
        visitor.visit(function.shared_data);
    if (m_host_defined)
        m_host_defined->visit_host_defined_self(visitor);
    for (auto const& loaded_module : m_loaded_modules)
        visitor.visit(loaded_module.module);
}

size_t Script::external_memory_size() const
{
    size_t size = vector_external_memory_size(m_loaded_modules);
    size = saturating_add_external_memory_size(size, vector_external_memory_size(m_lexical_names));
    size = saturating_add_external_memory_size(size, vector_external_memory_size(m_var_names));
    size = saturating_add_external_memory_size(size, vector_external_memory_size(m_functions_to_initialize));
    size = saturating_add_external_memory_size(size, m_declared_function_names.capacity() * sizeof(Utf16FlyString));
    size = saturating_add_external_memory_size(size, vector_external_memory_size(m_var_scoped_names));
    size = saturating_add_external_memory_size(size, vector_external_memory_size(m_annex_b_candidate_names));
    size = saturating_add_external_memory_size(size, vector_external_memory_size(m_lexical_bindings));
    return size;
}

}