blob: 42416dffa9cd0402a456b4142bd843bb3389961b [file] [log] [blame]
// Copyright 2020 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "src/objects/shared-function-info.h"
#include "src/ast/ast.h"
#include "src/ast/scopes.h"
#include "src/codegen/compilation-cache.h"
#include "src/codegen/compiler.h"
#include "src/codegen/optimized-compilation-info.h"
#include "src/common/globals.h"
#include "src/debug/debug.h"
#include "src/diagnostics/code-tracer.h"
#include "src/execution/isolate-utils.h"
#include "src/heap/combined-heap.h"
#include "src/objects/shared-function-info-inl.h"
#include "src/strings/string-builder-inl.h"
namespace v8 {
namespace internal {
V8_EXPORT_PRIVATE constexpr Tagged<Smi>
SharedFunctionInfo::kNoSharedNameSentinel;
uint32_t SharedFunctionInfo::Hash() {
// Hash SharedFunctionInfo based on its start position and script id. Note: we
// don't use the function's literal id since getting that is slow for compiled
// functions.
int start_pos = StartPosition();
int script_id = IsScript(script()) ? Script::cast(script())->id() : 0;
return static_cast<uint32_t>(base::hash_combine(start_pos, script_id));
}
void SharedFunctionInfo::Init(ReadOnlyRoots ro_roots, int unique_id) {
DisallowGarbageCollection no_gc;
// Set the function data to the "illegal" builtin. Ideally we'd use some sort
// of "uninitialized" marker here, but it's cheaper to use a valid buitin and
// avoid having to do uninitialized checks elsewhere.
set_builtin_id(Builtin::kIllegal);
// Set the name to the no-name sentinel, this can be updated later.
set_name_or_scope_info(SharedFunctionInfo::kNoSharedNameSentinel,
kReleaseStore, SKIP_WRITE_BARRIER);
// Generally functions won't have feedback, unless they have been created
// from a FunctionLiteral. Those can just reset this field to keep the
// SharedFunctionInfo in a consistent state.
set_raw_outer_scope_info_or_feedback_metadata(ro_roots.the_hole_value(),
SKIP_WRITE_BARRIER);
set_script(ro_roots.undefined_value(), kReleaseStore, SKIP_WRITE_BARRIER);
set_function_literal_id(kFunctionLiteralIdInvalid);
set_unique_id(unique_id);
// Set integer fields (smi or int, depending on the architecture).
set_length(0);
set_internal_formal_parameter_count(JSParameterCount(0));
set_expected_nof_properties(0);
set_raw_function_token_offset(0);
// All flags default to false or 0, except ConstructAsBuiltinBit just because
// we're using the kIllegal builtin.
set_flags(ConstructAsBuiltinBit::encode(true), kRelaxedStore);
set_flags2(0);
UpdateFunctionMapIndex();
set_age(0);
clear_padding();
}
Tagged<Code> SharedFunctionInfo::GetCode(Isolate* isolate) const {
// ======
// NOTE: This chain of checks MUST be kept in sync with the equivalent CSA
// GetSharedFunctionInfoCode method in code-stub-assembler.cc.
// ======
Tagged<Object> data = GetData(isolate);
if (IsSmi(data)) {
// Holding a Smi means we are a builtin.
DCHECK(HasBuiltinId());
return isolate->builtins()->code(builtin_id());
}
if (IsBytecodeArray(data)) {
// Having a bytecode array means we are a compiled, interpreted function.
DCHECK(HasBytecodeArray());
return isolate->builtins()->code(Builtin::kInterpreterEntryTrampoline);
}
if (IsCode(data)) {
// Having baseline Code means we are a compiled, baseline function.
DCHECK(HasBaselineCode());
return Code::cast(data);
}
#if V8_ENABLE_WEBASSEMBLY
if (IsAsmWasmData(data)) {
// Having AsmWasmData means we are an asm.js/wasm function.
DCHECK(HasAsmWasmData());
return isolate->builtins()->code(Builtin::kInstantiateAsmJs);
}
if (IsWasmExportedFunctionData(data)) {
// Having a WasmExportedFunctionData means the code is in there.
DCHECK(HasWasmExportedFunctionData());
return wasm_exported_function_data()->wrapper_code(isolate);
}
if (IsWasmJSFunctionData(data)) {
return wasm_js_function_data()->wrapper_code(isolate);
}
if (IsWasmCapiFunctionData(data)) {
return wasm_capi_function_data()->wrapper_code(isolate);
}
if (IsWasmResumeData(data)) {
if (static_cast<wasm::OnResume>(wasm_resume_data()->on_resume()) ==
wasm::OnResume::kContinue) {
return isolate->builtins()->code(Builtin::kWasmResume);
} else {
return isolate->builtins()->code(Builtin::kWasmReject);
}
}
#endif // V8_ENABLE_WEBASSEMBLY
if (IsUncompiledData(data)) {
// Having uncompiled data (with or without scope) means we need to compile.
DCHECK(HasUncompiledData());
return isolate->builtins()->code(Builtin::kCompileLazy);
}
if (IsFunctionTemplateInfo(data)) {
// Having a function template info means we are an API function.
DCHECK(IsApiFunction());
return isolate->builtins()->code(Builtin::kHandleApiCallOrConstruct);
}
if (IsInterpreterData(data)) {
Tagged<Code> code = InterpreterTrampoline(isolate);
DCHECK(IsCode(code));
DCHECK(code->is_interpreter_trampoline_builtin());
return code;
}
UNREACHABLE();
}
SharedFunctionInfo::ScriptIterator::ScriptIterator(Isolate* isolate,
Tagged<Script> script)
: ScriptIterator(handle(script->shared_function_infos(), isolate)) {}
SharedFunctionInfo::ScriptIterator::ScriptIterator(
Handle<WeakFixedArray> shared_function_infos)
: shared_function_infos_(shared_function_infos), index_(0) {}
Tagged<SharedFunctionInfo> SharedFunctionInfo::ScriptIterator::Next() {
while (index_ < shared_function_infos_->length()) {
Tagged<MaybeObject> raw = shared_function_infos_->get(index_++);
Tagged<HeapObject> heap_object;
if (!raw.GetHeapObject(&heap_object) || IsUndefined(heap_object)) {
continue;
}
return SharedFunctionInfo::cast(heap_object);
}
return SharedFunctionInfo();
}
void SharedFunctionInfo::ScriptIterator::Reset(Isolate* isolate,
Tagged<Script> script) {
shared_function_infos_ = handle(script->shared_function_infos(), isolate);
index_ = 0;
}
void SharedFunctionInfo::SetScript(ReadOnlyRoots roots,
Tagged<HeapObject> script_object,
int function_literal_id,
bool reset_preparsed_scope_data) {
DisallowGarbageCollection no_gc;
if (script() == script_object) return;
if (reset_preparsed_scope_data && HasUncompiledDataWithPreparseData()) {
ClearPreparseData();
}
// Add shared function info to new script's list. If a collection occurs,
// the shared function info may be temporarily in two lists.
// This is okay because the gc-time processing of these lists can tolerate
// duplicates.
if (IsScript(script_object)) {
DCHECK(!IsScript(script()));
Tagged<Script> script = Script::cast(script_object);
Tagged<WeakFixedArray> list = script->shared_function_infos();
#ifdef DEBUG
DCHECK_LT(function_literal_id, list->length());
Tagged<MaybeObject> maybe_object = list->get(function_literal_id);
Tagged<HeapObject> heap_object;
if (maybe_object.GetHeapObjectIfWeak(&heap_object)) {
DCHECK_EQ(heap_object, *this);
}
#endif
list->set(function_literal_id, MakeWeak(Tagged(*this)));
} else {
DCHECK(IsScript(script()));
// Remove shared function info from old script's list.
Tagged<Script> old_script = Script::cast(script());
// Due to liveedit, it might happen that the old_script doesn't know
// about the SharedFunctionInfo, so we have to guard against that.
Tagged<WeakFixedArray> infos = old_script->shared_function_infos();
if (function_literal_id < infos->length()) {
Tagged<MaybeObject> raw =
old_script->shared_function_infos()->get(function_literal_id);
Tagged<HeapObject> heap_object;
if (raw.GetHeapObjectIfWeak(&heap_object) && heap_object == *this) {
old_script->shared_function_infos()->set(function_literal_id,
roots.undefined_value());
}
}
}
// Finally set new script.
set_script(script_object, kReleaseStore);
}
void SharedFunctionInfo::CopyFrom(Tagged<SharedFunctionInfo> other,
IsolateForSandbox isolate) {
PtrComprCageBase cage_base = GetPtrComprCageBase(*this);
#ifdef V8_ENABLE_SANDBOX
if (other->has_trusted_function_data()) {
set_trusted_function_data(
other->trusted_function_data(isolate, kAcquireLoad), kReleaseStore);
} else {
clear_trusted_function_data(kReleaseStore);
}
#endif
set_function_data(other->function_data(cage_base, kAcquireLoad),
kReleaseStore);
set_name_or_scope_info(other->name_or_scope_info(cage_base, kAcquireLoad),
kReleaseStore);
set_outer_scope_info_or_feedback_metadata(
other->outer_scope_info_or_feedback_metadata(cage_base));
set_script(other->script(cage_base, kAcquireLoad), kReleaseStore);
set_length(other->length());
set_formal_parameter_count(other->formal_parameter_count());
set_function_token_offset(other->function_token_offset());
set_expected_nof_properties(other->expected_nof_properties());
set_flags2(other->flags2());
set_flags(other->flags(kRelaxedLoad), kRelaxedStore);
set_function_literal_id(other->function_literal_id());
set_unique_id(other->unique_id());
set_age(0);
#if DEBUG
// This should now be byte-for-byte identical to the input except for the age
// field (could be reset concurrently). Compare content before age field now:
DCHECK_EQ(memcmp(reinterpret_cast<void*>(address()),
reinterpret_cast<void*>(other.address()),
SharedFunctionInfo::kAgeOffset),
0);
// Compare content after age field.
constexpr Address kPastAgeOffset =
SharedFunctionInfo::kAgeOffset + SharedFunctionInfo::kAgeSize;
DCHECK_EQ(memcmp(reinterpret_cast<void*>(address() + kPastAgeOffset),
reinterpret_cast<void*>(other.address() + kPastAgeOffset),
SharedFunctionInfo::kSize - kPastAgeOffset),
0);
#endif
}
bool SharedFunctionInfo::HasDebugInfo(Isolate* isolate) const {
return isolate->debug()->HasDebugInfo(*this);
}
Tagged<DebugInfo> SharedFunctionInfo::GetDebugInfo(Isolate* isolate) const {
return isolate->debug()->TryGetDebugInfo(*this).value();
}
base::Optional<Tagged<DebugInfo>> SharedFunctionInfo::TryGetDebugInfo(
Isolate* isolate) const {
return isolate->debug()->TryGetDebugInfo(*this);
}
bool SharedFunctionInfo::HasBreakInfo(Isolate* isolate) const {
return isolate->debug()->HasBreakInfo(*this);
}
bool SharedFunctionInfo::BreakAtEntry(Isolate* isolate) const {
return isolate->debug()->BreakAtEntry(*this);
}
bool SharedFunctionInfo::HasCoverageInfo(Isolate* isolate) const {
return isolate->debug()->HasCoverageInfo(*this);
}
Tagged<CoverageInfo> SharedFunctionInfo::GetCoverageInfo(
Isolate* isolate) const {
DCHECK(HasCoverageInfo(isolate));
return CoverageInfo::cast(GetDebugInfo(isolate)->coverage_info());
}
std::unique_ptr<char[]> SharedFunctionInfo::DebugNameCStr() const {
#if V8_ENABLE_WEBASSEMBLY
if (HasWasmExportedFunctionData()) {
return WasmExportedFunction::GetDebugName(
wasm_exported_function_data()->sig());
}
#endif // V8_ENABLE_WEBASSEMBLY
DisallowGarbageCollection no_gc;
Tagged<String> function_name = Name();
if (function_name->length() == 0) function_name = inferred_name();
return function_name->ToCString();
}
// static
Handle<String> SharedFunctionInfo::DebugName(
Isolate* isolate, Handle<SharedFunctionInfo> shared) {
#if V8_ENABLE_WEBASSEMBLY
if (shared->HasWasmExportedFunctionData()) {
return isolate->factory()
->NewStringFromUtf8(base::CStrVector(shared->DebugNameCStr().get()))
.ToHandleChecked();
}
#endif // V8_ENABLE_WEBASSEMBLY
FunctionKind function_kind = shared->kind();
if (IsClassMembersInitializerFunction(function_kind)) {
return function_kind == FunctionKind::kClassMembersInitializerFunction
? isolate->factory()->instance_members_initializer_string()
: isolate->factory()->static_initializer_string();
}
DisallowHeapAllocation no_gc;
Tagged<String> function_name = shared->Name();
if (function_name->length() == 0) function_name = shared->inferred_name();
return handle(function_name, isolate);
}
bool SharedFunctionInfo::PassesFilter(const char* raw_filter) {
// Filters are almost always "*", so check for that and exit quickly.
if (V8_LIKELY(raw_filter[0] == '*' && raw_filter[1] == '\0')) {
return true;
}
base::Vector<const char> filter = base::CStrVector(raw_filter);
return v8::internal::PassesFilter(base::CStrVector(DebugNameCStr().get()),
filter);
}
bool SharedFunctionInfo::HasSourceCode() const {
ReadOnlyRoots roots = GetReadOnlyRoots();
return !IsUndefined(script(), roots) &&
!IsUndefined(Script::cast(script())->source(), roots) &&
String::cast(Script::cast(script())->source())->length() > 0;
}
void SharedFunctionInfo::DiscardCompiledMetadata(
Isolate* isolate,
std::function<void(Tagged<HeapObject> object, ObjectSlot slot,
Tagged<HeapObject> target)>
gc_notify_updated_slot) {
DisallowGarbageCollection no_gc;
if (HasFeedbackMetadata()) {
if (v8_flags.trace_flush_code) {
CodeTracer::Scope scope(isolate->GetCodeTracer());
PrintF(scope.file(), "[discarding compiled metadata for ");
ShortPrint(*this, scope.file());
PrintF(scope.file(), "]\n");
}
Tagged<HeapObject> outer_scope_info;
if (scope_info()->HasOuterScopeInfo()) {
outer_scope_info = scope_info()->OuterScopeInfo();
} else {
outer_scope_info = ReadOnlyRoots(isolate).the_hole_value();
}
// Raw setter to avoid validity checks, since we're performing the unusual
// task of decompiling.
set_raw_outer_scope_info_or_feedback_metadata(outer_scope_info);
gc_notify_updated_slot(
*this,
RawField(SharedFunctionInfo::kOuterScopeInfoOrFeedbackMetadataOffset),
outer_scope_info);
} else {
DCHECK(IsScopeInfo(outer_scope_info()) || IsTheHole(outer_scope_info()));
}
// TODO(rmcilroy): Possibly discard ScopeInfo here as well.
}
// static
void SharedFunctionInfo::DiscardCompiled(
Isolate* isolate, Handle<SharedFunctionInfo> shared_info) {
DCHECK(shared_info->CanDiscardCompiled());
Handle<String> inferred_name_val =
handle(shared_info->inferred_name(), isolate);
int start_position = shared_info->StartPosition();
int end_position = shared_info->EndPosition();
MaybeHandle<UncompiledData> data;
if (!shared_info->HasUncompiledDataWithPreparseData()) {
// Create a new UncompiledData, without pre-parsed scope.
data = isolate->factory()->NewUncompiledDataWithoutPreparseData(
inferred_name_val, start_position, end_position);
}
// If the GC runs after changing one but not both fields below, it could see
// the SharedFunctionInfo in an unexpected state.
DisallowGarbageCollection no_gc;
shared_info->DiscardCompiledMetadata(isolate);
// Replace compiled data with a new UncompiledData object.
if (shared_info->HasUncompiledDataWithPreparseData()) {
// If this is uncompiled data with a pre-parsed scope data, we can just
// clear out the scope data and keep the uncompiled data.
shared_info->ClearPreparseData();
DCHECK(data.is_null());
} else {
// Update the function data to point to the UncompiledData without preparse
// data created above. Use the raw function data setter to avoid validity
// checks, since we're performing the unusual task of decompiling.
shared_info->SetData(*data.ToHandleChecked(), kReleaseStore);
}
}
// static
Handle<Object> SharedFunctionInfo::GetSourceCode(
Isolate* isolate, Handle<SharedFunctionInfo> shared) {
if (!shared->HasSourceCode()) return isolate->factory()->undefined_value();
Handle<String> source(String::cast(Script::cast(shared->script())->source()),
isolate);
return isolate->factory()->NewSubString(source, shared->StartPosition(),
shared->EndPosition());
}
// static
Handle<Object> SharedFunctionInfo::GetSourceCodeHarmony(
Isolate* isolate, Handle<SharedFunctionInfo> shared) {
if (!shared->HasSourceCode()) return isolate->factory()->undefined_value();
Handle<String> script_source(
String::cast(Script::cast(shared->script())->source()), isolate);
int start_pos = shared->function_token_position();
DCHECK_NE(start_pos, kNoSourcePosition);
Handle<String> source = isolate->factory()->NewSubString(
script_source, start_pos, shared->EndPosition());
if (!shared->is_wrapped()) return source;
DCHECK(!shared->name_should_print_as_anonymous());
IncrementalStringBuilder builder(isolate);
builder.AppendCStringLiteral("function ");
builder.AppendString(Handle<String>(shared->Name(), isolate));
builder.AppendCharacter('(');
Handle<FixedArray> args(Script::cast(shared->script())->wrapped_arguments(),
isolate);
int argc = args->length();
for (int i = 0; i < argc; i++) {
if (i > 0) builder.AppendCStringLiteral(", ");
builder.AppendString(Handle<String>(String::cast(args->get(i)), isolate));
}
builder.AppendCStringLiteral(") {\n");
builder.AppendString(source);
builder.AppendCStringLiteral("\n}");
return indirect_handle(builder.Finish().ToHandleChecked(), isolate);
}
int SharedFunctionInfo::SourceSize() { return EndPosition() - StartPosition(); }
// Output the source code without any allocation in the heap.
std::ostream& operator<<(std::ostream& os, const SourceCodeOf& v) {
const Tagged<SharedFunctionInfo> s = v.value;
// For some native functions there is no source.
if (!s->HasSourceCode()) return os << "<No Source>";
// Get the source for the script which this function came from.
// Don't use String::cast because we don't want more assertion errors while
// we are already creating a stack dump.
Tagged<String> script_source =
String::unchecked_cast(Script::cast(s->script())->source());
if (!script_source->LooksValid()) return os << "<Invalid Source>";
if (!s->is_toplevel()) {
os << "function ";
Tagged<String> name = s->Name();
if (name->length() > 0) {
name->PrintUC16(os);
}
}
int len = s->EndPosition() - s->StartPosition();
if (len <= v.max_length || v.max_length < 0) {
script_source->PrintUC16(os, s->StartPosition(), s->EndPosition());
return os;
} else {
script_source->PrintUC16(os, s->StartPosition(),
s->StartPosition() + v.max_length);
return os << "...\n";
}
}
void SharedFunctionInfo::DisableOptimization(Isolate* isolate,
BailoutReason reason) {
DCHECK_NE(reason, BailoutReason::kNoReason);
set_flags(DisabledOptimizationReasonBits::update(flags(kRelaxedLoad), reason),
kRelaxedStore);
// Code should be the lazy compilation stub or else interpreted.
if constexpr (DEBUG_BOOL) {
CodeKind kind = abstract_code(isolate)->kind(isolate);
CHECK(kind == CodeKind::INTERPRETED_FUNCTION || kind == CodeKind::BUILTIN);
}
PROFILE(isolate, CodeDisableOptEvent(handle(abstract_code(isolate), isolate),
handle(*this, isolate)));
if (v8_flags.trace_opt) {
CodeTracer::Scope scope(isolate->GetCodeTracer());
PrintF(scope.file(), "[disabled optimization for ");
ShortPrint(*this, scope.file());
PrintF(scope.file(), ", reason: %s]\n", GetBailoutReason(reason));
}
}
// static
template <typename IsolateT>
void SharedFunctionInfo::InitFromFunctionLiteral(
IsolateT* isolate, Handle<SharedFunctionInfo> shared_info,
FunctionLiteral* lit, bool is_toplevel) {
DCHECK(!IsScopeInfo(shared_info->name_or_scope_info(kAcquireLoad)));
{
DisallowGarbageCollection no_gc;
Tagged<SharedFunctionInfo> raw_sfi = *shared_info;
// When adding fields here, make sure DeclarationScope::AnalyzePartially is
// updated accordingly.
raw_sfi->set_internal_formal_parameter_count(
JSParameterCount(lit->parameter_count()));
raw_sfi->SetFunctionTokenPosition(lit->function_token_position(),
lit->start_position());
raw_sfi->set_syntax_kind(lit->syntax_kind());
raw_sfi->set_allows_lazy_compilation(lit->AllowsLazyCompilation());
raw_sfi->set_language_mode(lit->language_mode());
raw_sfi->set_function_literal_id(lit->function_literal_id());
// FunctionKind must have already been set.
DCHECK(lit->kind() == raw_sfi->kind());
DCHECK_IMPLIES(lit->requires_instance_members_initializer(),
IsClassConstructor(lit->kind()));
raw_sfi->set_requires_instance_members_initializer(
lit->requires_instance_members_initializer());
DCHECK_IMPLIES(lit->class_scope_has_private_brand(),
IsClassConstructor(lit->kind()));
raw_sfi->set_class_scope_has_private_brand(
lit->class_scope_has_private_brand());
DCHECK_IMPLIES(lit->has_static_private_methods_or_accessors(),
IsClassConstructor(lit->kind()));
raw_sfi->set_has_static_private_methods_or_accessors(
lit->has_static_private_methods_or_accessors());
raw_sfi->set_is_toplevel(is_toplevel);
DCHECK(IsTheHole(raw_sfi->outer_scope_info()));
if (!is_toplevel) {
Scope* outer_scope = lit->scope()->GetOuterScopeWithContext();
if (outer_scope) {
raw_sfi->set_outer_scope_info(*outer_scope->scope_info());
raw_sfi->set_private_name_lookup_skips_outer_class(
lit->scope()->private_name_lookup_skips_outer_class());
}
}
raw_sfi->set_length(lit->function_length());
// For lazy parsed functions, the following flags will be inaccurate since
// we don't have the information yet. They're set later in
// UpdateSharedFunctionFlagsAfterCompilation (compiler.cc), when the
// function is really parsed and compiled.
if (lit->ShouldEagerCompile()) {
raw_sfi->set_has_duplicate_parameters(lit->has_duplicate_parameters());
raw_sfi->UpdateAndFinalizeExpectedNofPropertiesFromEstimate(lit);
DCHECK_NULL(lit->produced_preparse_data());
// If we're about to eager compile, we'll have the function literal
// available, so there's no need to wastefully allocate an uncompiled
// data.
return;
}
raw_sfi->UpdateExpectedNofPropertiesFromEstimate(lit);
}
CreateAndSetUncompiledData(isolate, shared_info, lit);
}
template <typename IsolateT>
void SharedFunctionInfo::CreateAndSetUncompiledData(
IsolateT* isolate, Handle<SharedFunctionInfo> shared_info,
FunctionLiteral* lit) {
DCHECK(!shared_info->HasUncompiledData());
Handle<UncompiledData> data;
ProducedPreparseData* scope_data = lit->produced_preparse_data();
if (scope_data != nullptr) {
Handle<PreparseData> preparse_data = scope_data->Serialize(isolate);
if (lit->should_parallel_compile()) {
data = isolate->factory()->NewUncompiledDataWithPreparseDataAndJob(
lit->GetInferredName(isolate), lit->start_position(),
lit->end_position(), preparse_data);
} else {
data = isolate->factory()->NewUncompiledDataWithPreparseData(
lit->GetInferredName(isolate), lit->start_position(),
lit->end_position(), preparse_data);
}
} else {
if (lit->should_parallel_compile()) {
data = isolate->factory()->NewUncompiledDataWithoutPreparseDataWithJob(
lit->GetInferredName(isolate), lit->start_position(),
lit->end_position());
} else {
data = isolate->factory()->NewUncompiledDataWithoutPreparseData(
lit->GetInferredName(isolate), lit->start_position(),
lit->end_position());
}
}
shared_info->set_uncompiled_data(*data);
}
template EXPORT_TEMPLATE_DEFINE(V8_EXPORT_PRIVATE) void SharedFunctionInfo::
InitFromFunctionLiteral<Isolate>(Isolate* isolate,
Handle<SharedFunctionInfo> shared_info,
FunctionLiteral* lit, bool is_toplevel);
template EXPORT_TEMPLATE_DEFINE(V8_EXPORT_PRIVATE) void SharedFunctionInfo::
InitFromFunctionLiteral<LocalIsolate>(
LocalIsolate* isolate, Handle<SharedFunctionInfo> shared_info,
FunctionLiteral* lit, bool is_toplevel);
template EXPORT_TEMPLATE_DEFINE(V8_EXPORT_PRIVATE) void SharedFunctionInfo::
CreateAndSetUncompiledData<Isolate>(Isolate* isolate,
Handle<SharedFunctionInfo> shared_info,
FunctionLiteral* lit);
template EXPORT_TEMPLATE_DEFINE(V8_EXPORT_PRIVATE) void SharedFunctionInfo::
CreateAndSetUncompiledData<LocalIsolate>(
LocalIsolate* isolate, Handle<SharedFunctionInfo> shared_info,
FunctionLiteral* lit);
uint16_t SharedFunctionInfo::get_property_estimate_from_literal(
FunctionLiteral* literal) {
int estimate = literal->expected_property_count();
// If this is a class constructor, we may have already parsed fields.
if (is_class_constructor()) {
estimate += expected_nof_properties();
}
return estimate;
}
void SharedFunctionInfo::UpdateExpectedNofPropertiesFromEstimate(
FunctionLiteral* literal) {
// Limit actual estimate to fit in a 8 bit field, we will never allocate
// more than this in any case.
static_assert(JSObject::kMaxInObjectProperties <= kMaxUInt8);
int estimate = get_property_estimate_from_literal(literal);
set_expected_nof_properties(std::min(estimate, kMaxUInt8));
}
void SharedFunctionInfo::UpdateAndFinalizeExpectedNofPropertiesFromEstimate(
FunctionLiteral* literal) {
DCHECK(literal->ShouldEagerCompile());
if (are_properties_final()) {
return;
}
int estimate = get_property_estimate_from_literal(literal);
// If no properties are added in the constructor, they are more likely
// to be added later.
if (estimate == 0) estimate = 2;
// Limit actual estimate to fit in a 8 bit field, we will never allocate
// more than this in any case.
static_assert(JSObject::kMaxInObjectProperties <= kMaxUInt8);
estimate = std::min(estimate, kMaxUInt8);
set_expected_nof_properties(estimate);
set_are_properties_final(true);
}
void SharedFunctionInfo::SetFunctionTokenPosition(int function_token_position,
int start_position) {
int offset;
if (function_token_position == kNoSourcePosition) {
offset = 0;
} else {
offset = start_position - function_token_position;
}
if (offset > kMaximumFunctionTokenOffset) {
offset = kFunctionTokenOutOfRange;
}
set_raw_function_token_offset(offset);
}
int SharedFunctionInfo::StartPosition() const {
Tagged<Object> maybe_scope_info = name_or_scope_info(kAcquireLoad);
if (IsScopeInfo(maybe_scope_info)) {
Tagged<ScopeInfo> info = ScopeInfo::cast(maybe_scope_info);
if (info->HasPositionInfo()) {
return info->StartPosition();
}
}
if (HasUncompiledData()) {
// Works with or without scope.
return uncompiled_data()->start_position();
}
if (IsApiFunction() || HasBuiltinId()) {
DCHECK_IMPLIES(HasBuiltinId(), builtin_id() != Builtin::kCompileLazy);
return 0;
}
#if V8_ENABLE_WEBASSEMBLY
if (HasWasmExportedFunctionData()) {
Tagged<WasmInstanceObject> instance =
wasm_exported_function_data()->instance();
int func_index = wasm_exported_function_data()->function_index();
auto& function = instance->module()->functions[func_index];
return static_cast<int>(function.code.offset());
}
#endif // V8_ENABLE_WEBASSEMBLY
return kNoSourcePosition;
}
int SharedFunctionInfo::EndPosition() const {
Tagged<Object> maybe_scope_info = name_or_scope_info(kAcquireLoad);
if (IsScopeInfo(maybe_scope_info)) {
Tagged<ScopeInfo> info = ScopeInfo::cast(maybe_scope_info);
if (info->HasPositionInfo()) {
return info->EndPosition();
}
}
if (HasUncompiledData()) {
// Works with or without scope.
return uncompiled_data()->end_position();
}
if (IsApiFunction() || HasBuiltinId()) {
DCHECK_IMPLIES(HasBuiltinId(), builtin_id() != Builtin::kCompileLazy);
return 0;
}
#if V8_ENABLE_WEBASSEMBLY
if (HasWasmExportedFunctionData()) {
Tagged<WasmInstanceObject> instance =
wasm_exported_function_data()->instance();
int func_index = wasm_exported_function_data()->function_index();
auto& function = instance->module()->functions[func_index];
return static_cast<int>(function.code.end_offset());
}
#endif // V8_ENABLE_WEBASSEMBLY
return kNoSourcePosition;
}
void SharedFunctionInfo::UpdateFromFunctionLiteralForLiveEdit(
FunctionLiteral* lit) {
Tagged<Object> maybe_scope_info = name_or_scope_info(kAcquireLoad);
if (IsScopeInfo(maybe_scope_info)) {
// Updating the ScopeInfo is safe since they are identical modulo
// source positions.
Tagged<ScopeInfo> new_scope_info = *lit->scope()->scope_info();
DCHECK(new_scope_info->Equals(ScopeInfo::cast(maybe_scope_info), true));
SetScopeInfo(new_scope_info);
} else if (!is_compiled()) {
CHECK(HasUncompiledData());
if (HasUncompiledDataWithPreparseData()) {
ClearPreparseData();
}
uncompiled_data()->set_start_position(lit->start_position());
uncompiled_data()->set_end_position(lit->end_position());
if (!is_toplevel()) {
Scope* outer_scope = lit->scope()->GetOuterScopeWithContext();
if (outer_scope) {
// Use the raw accessor since we have to replace the existing outer
// scope.
set_raw_outer_scope_info_or_feedback_metadata(
*outer_scope->scope_info());
}
}
}
SetFunctionTokenPosition(lit->function_token_position(),
lit->start_position());
}
CachedTieringDecision SharedFunctionInfo::cached_tiering_decision() {
return CachedTieringDecisionBits::decode(flags2());
}
void SharedFunctionInfo::set_cached_tiering_decision(
CachedTieringDecision decision) {
set_flags2(CachedTieringDecisionBits::update(flags2(), decision));
}
// static
void SharedFunctionInfo::EnsureBytecodeArrayAvailable(
Isolate* isolate, Handle<SharedFunctionInfo> shared_info,
IsCompiledScope* is_compiled_scope, CreateSourcePositions flag) {
if (!shared_info->HasBytecodeArray()) {
if (!Compiler::Compile(isolate, shared_info, Compiler::CLEAR_EXCEPTION,
is_compiled_scope, flag)) {
FATAL("Failed to compile shared info that was already compiled before");
}
DCHECK(shared_info->GetBytecodeArray(isolate)->HasSourcePositionTable());
} else {
*is_compiled_scope = shared_info->is_compiled_scope(isolate);
}
}
// static
void SharedFunctionInfo::EnsureSourcePositionsAvailable(
Isolate* isolate, Handle<SharedFunctionInfo> shared_info) {
if (shared_info->CanCollectSourcePosition(isolate)) {
base::Optional<Isolate::ExceptionScope> exception_scope;
if (isolate->has_exception()) {
exception_scope.emplace(isolate);
}
Compiler::CollectSourcePositions(isolate, shared_info);
}
}
// static
void SharedFunctionInfo::InstallDebugBytecode(Handle<SharedFunctionInfo> shared,
Isolate* isolate) {
DCHECK(shared->HasBytecodeArray());
Handle<BytecodeArray> original_bytecode_array(
shared->GetBytecodeArray(isolate), isolate);
Handle<BytecodeArray> debug_bytecode_array =
isolate->factory()->CopyBytecodeArray(original_bytecode_array);
{
DisallowGarbageCollection no_gc;
base::SharedMutexGuard<base::kExclusive> mutex_guard(
isolate->shared_function_info_access());
Tagged<DebugInfo> debug_info = shared->GetDebugInfo(isolate);
debug_info->set_original_bytecode_array(*original_bytecode_array,
kReleaseStore);
debug_info->set_debug_bytecode_array(*debug_bytecode_array, kReleaseStore);
shared->SetActiveBytecodeArray(*debug_bytecode_array, isolate);
}
}
// static
void SharedFunctionInfo::UninstallDebugBytecode(
Tagged<SharedFunctionInfo> shared, Isolate* isolate) {
DisallowGarbageCollection no_gc;
base::SharedMutexGuard<base::kExclusive> mutex_guard(
isolate->shared_function_info_access());
Tagged<DebugInfo> debug_info = shared->GetDebugInfo(isolate);
Tagged<BytecodeArray> original_bytecode_array =
debug_info->OriginalBytecodeArray(isolate);
DCHECK(!shared->HasBaselineCode());
shared->SetActiveBytecodeArray(original_bytecode_array, isolate);
debug_info->clear_original_bytecode_array();
debug_info->clear_debug_bytecode_array();
}
// static
void SharedFunctionInfo::EnsureOldForTesting(Tagged<SharedFunctionInfo> sfi) {
if (v8_flags.flush_code_based_on_time ||
v8_flags.flush_code_based_on_tab_visibility) {
sfi->set_age(kMaxAge);
} else {
sfi->set_age(v8_flags.bytecode_old_age);
}
}
#ifdef DEBUG
// static
bool SharedFunctionInfo::UniqueIdsAreUnique(Isolate* isolate) {
std::unordered_set<uint32_t> ids({isolate->next_unique_sfi_id()});
CombinedHeapObjectIterator it(isolate->heap());
for (Tagged<HeapObject> o = it.Next(); !o.is_null(); o = it.Next()) {
if (!IsSharedFunctionInfo(o)) continue;
auto result = ids.emplace(SharedFunctionInfo::cast(o)->unique_id());
// If previously inserted...
if (!result.second) return false;
}
return true;
}
#endif // DEBUG
} // namespace internal
} // namespace v8