| // Copyright 2018 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. |
| |
| #ifndef V8_COMPILER_JS_HEAP_BROKER_H_ |
| #define V8_COMPILER_JS_HEAP_BROKER_H_ |
| |
| #include "src/base/compiler-specific.h" |
| #include "src/base/optional.h" |
| #include "src/globals.h" |
| #include "src/objects.h" |
| #include "src/zone/zone-containers.h" |
| |
| namespace v8 { |
| namespace internal { |
| namespace compiler { |
| |
| enum class OddballType : uint8_t { |
| kNone, // Not an Oddball. |
| kBoolean, // True or False. |
| kUndefined, |
| kNull, |
| kHole, |
| kUninitialized, |
| kOther // Oddball, but none of the above. |
| }; |
| |
| // TODO(neis): Get rid of the HeapObjectType class. |
| class HeapObjectType { |
| public: |
| enum Flag : uint8_t { kUndetectable = 1 << 0, kCallable = 1 << 1 }; |
| |
| typedef base::Flags<Flag> Flags; |
| |
| HeapObjectType(InstanceType instance_type, Flags flags, |
| OddballType oddball_type) |
| : instance_type_(instance_type), |
| oddball_type_(oddball_type), |
| flags_(flags) { |
| DCHECK_EQ(instance_type == ODDBALL_TYPE, |
| oddball_type != OddballType::kNone); |
| } |
| |
| OddballType oddball_type() const { return oddball_type_; } |
| InstanceType instance_type() const { return instance_type_; } |
| Flags flags() const { return flags_; } |
| |
| bool is_callable() const { return flags_ & kCallable; } |
| bool is_undetectable() const { return flags_ & kUndetectable; } |
| |
| private: |
| InstanceType const instance_type_; |
| OddballType const oddball_type_; |
| Flags const flags_; |
| }; |
| |
| // This list is sorted such that subtypes appear before their supertypes. |
| // DO NOT VIOLATE THIS PROPERTY! |
| #define HEAP_BROKER_OBJECT_LIST(V) \ |
| /* Subtypes of JSObject */ \ |
| V(JSArray) \ |
| V(JSFunction) \ |
| V(JSGlobalProxy) \ |
| V(JSRegExp) \ |
| /* Subtypes of Context */ \ |
| V(NativeContext) \ |
| /* Subtypes of FixedArrayBase */ \ |
| V(BytecodeArray) \ |
| V(FixedArray) \ |
| V(FixedDoubleArray) \ |
| /* Subtypes of Name */ \ |
| V(InternalizedString) \ |
| V(String) \ |
| /* Subtypes of HeapObject */ \ |
| V(AllocationSite) \ |
| V(Cell) \ |
| V(Code) \ |
| V(FeedbackVector) \ |
| V(Map) \ |
| V(Module) \ |
| V(ScopeInfo) \ |
| V(ScriptContextTable) \ |
| V(SharedFunctionInfo) \ |
| V(Context) \ |
| V(FixedArrayBase) \ |
| V(HeapNumber) \ |
| V(JSObject) \ |
| V(MutableHeapNumber) \ |
| V(Name) \ |
| V(PropertyCell) \ |
| /* Subtypes of Object */ \ |
| V(HeapObject) |
| |
| class CompilationDependencies; |
| class JSHeapBroker; |
| class ObjectData; |
| #define FORWARD_DECL(Name) class Name##Ref; |
| HEAP_BROKER_OBJECT_LIST(FORWARD_DECL) |
| #undef FORWARD_DECL |
| |
| class ObjectRef { |
| public: |
| ObjectRef(JSHeapBroker* broker, Handle<Object> object); |
| explicit ObjectRef(ObjectData* data) : data_(data) { CHECK_NOT_NULL(data_); } |
| |
| bool equals(const ObjectRef& other) const; |
| |
| Handle<Object> object() const; |
| // TODO(neis): Remove eventually. |
| template <typename T> |
| Handle<T> object() const { |
| AllowHandleDereference handle_dereference; |
| return Handle<T>::cast(object()); |
| } |
| |
| OddballType oddball_type() const; |
| |
| bool IsSmi() const; |
| int AsSmi() const; |
| |
| #define HEAP_IS_METHOD_DECL(Name) bool Is##Name() const; |
| HEAP_BROKER_OBJECT_LIST(HEAP_IS_METHOD_DECL) |
| #undef HEAP_IS_METHOD_DECL |
| |
| #define HEAP_AS_METHOD_DECL(Name) Name##Ref As##Name() const; |
| HEAP_BROKER_OBJECT_LIST(HEAP_AS_METHOD_DECL) |
| #undef HEAP_AS_METHOD_DECL |
| |
| StringRef TypeOf() const; |
| bool BooleanValue(); |
| double OddballToNumber() const; |
| |
| Isolate* isolate() const; |
| |
| protected: |
| JSHeapBroker* broker() const; |
| ObjectData* data() const; |
| |
| private: |
| ObjectData* data_; |
| }; |
| |
| class HeapObjectRef : public ObjectRef { |
| public: |
| using ObjectRef::ObjectRef; |
| |
| HeapObjectType type() const; |
| MapRef map() const; |
| base::Optional<MapRef> TryGetObjectCreateMap() const; |
| bool IsSeqString() const; |
| bool IsExternalString() const; |
| }; |
| |
| class PropertyCellRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| ObjectRef value() const; |
| PropertyDetails property_details() const; |
| }; |
| |
| class JSObjectRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| bool IsUnboxedDoubleField(FieldIndex index) const; |
| double RawFastDoublePropertyAt(FieldIndex index) const; |
| ObjectRef RawFastPropertyAt(FieldIndex index) const; |
| |
| FixedArrayBaseRef elements() const; |
| void EnsureElementsTenured(); |
| ElementsKind GetElementsKind() const; |
| }; |
| |
| class JSFunctionRef : public JSObjectRef { |
| public: |
| using JSObjectRef::JSObjectRef; |
| |
| bool IsConstructor() const; |
| bool has_initial_map() const; |
| MapRef initial_map() const; |
| bool has_prototype() const; |
| ObjectRef prototype() const; |
| bool PrototypeRequiresRuntimeLookup() const; |
| JSGlobalProxyRef global_proxy() const; |
| int InitialMapInstanceSizeWithMinSlack() const; |
| SharedFunctionInfoRef shared() const; |
| }; |
| |
| class JSRegExpRef : public JSObjectRef { |
| public: |
| using JSObjectRef::JSObjectRef; |
| |
| ObjectRef raw_properties_or_hash() const; |
| ObjectRef data() const; |
| ObjectRef source() const; |
| ObjectRef flags() const; |
| ObjectRef last_index() const; |
| }; |
| |
| class HeapNumberRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| double value() const; |
| }; |
| |
| class MutableHeapNumberRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| double value() const; |
| }; |
| |
| class ContextRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| base::Optional<ContextRef> previous() const; |
| ObjectRef get(int index) const; |
| }; |
| |
| #define BROKER_NATIVE_CONTEXT_FIELDS(V) \ |
| V(JSFunction, array_function) \ |
| V(JSFunction, object_function) \ |
| V(JSFunction, promise_function) \ |
| V(Map, fast_aliased_arguments_map) \ |
| V(Map, initial_array_iterator_map) \ |
| V(Map, iterator_result_map) \ |
| V(Map, js_array_holey_double_elements_map) \ |
| V(Map, js_array_holey_elements_map) \ |
| V(Map, js_array_holey_smi_elements_map) \ |
| V(Map, js_array_packed_double_elements_map) \ |
| V(Map, js_array_packed_elements_map) \ |
| V(Map, js_array_packed_smi_elements_map) \ |
| V(Map, map_key_iterator_map) \ |
| V(Map, map_key_value_iterator_map) \ |
| V(Map, map_value_iterator_map) \ |
| V(Map, set_key_value_iterator_map) \ |
| V(Map, set_value_iterator_map) \ |
| V(Map, sloppy_arguments_map) \ |
| V(Map, strict_arguments_map) \ |
| V(Map, string_iterator_map) \ |
| V(ScriptContextTable, script_context_table) |
| |
| class NativeContextRef : public ContextRef { |
| public: |
| using ContextRef::ContextRef; |
| |
| #define DECL_ACCESSOR(type, name) type##Ref name() const; |
| BROKER_NATIVE_CONTEXT_FIELDS(DECL_ACCESSOR) |
| #undef DECL_ACCESSOR |
| |
| MapRef GetFunctionMapFromIndex(int index) const; |
| MapRef GetInitialJSArrayMap(ElementsKind kind) const; |
| }; |
| |
| class NameRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| }; |
| |
| class ScriptContextTableRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| struct LookupResult { |
| ContextRef context; |
| bool immutable; |
| int index; |
| }; |
| |
| base::Optional<LookupResult> lookup(const NameRef& name) const; |
| }; |
| |
| class FeedbackVectorRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| ObjectRef get(FeedbackSlot slot) const; |
| }; |
| |
| class AllocationSiteRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| bool PointsToLiteral() const; |
| PretenureFlag GetPretenureMode() const; |
| ObjectRef nested_site() const; |
| |
| // {IsFastLiteral} determines whether the given array or object literal |
| // boilerplate satisfies all limits to be considered for fast deep-copying |
| // and computes the total size of all objects that are part of the graph. |
| // |
| // If PointsToLiteral() is false, then IsFastLiteral() is also false. |
| bool IsFastLiteral() const; |
| // We only serialize boilerplate if IsFastLiteral is true. |
| base::Optional<JSObjectRef> boilerplate() const; |
| |
| ElementsKind GetElementsKind() const; |
| bool CanInlineCall() const; |
| }; |
| |
| class MapRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| int instance_size() const; |
| InstanceType instance_type() const; |
| int GetInObjectProperties() const; |
| int GetInObjectPropertiesStartInWords() const; |
| int NumberOfOwnDescriptors() const; |
| int GetInObjectPropertyOffset(int index) const; |
| ElementsKind elements_kind() const; |
| bool is_stable() const; |
| bool has_prototype_slot() const; |
| bool is_deprecated() const; |
| bool CanBeDeprecated() const; |
| bool CanTransition() const; |
| bool IsInobjectSlackTrackingInProgress() const; |
| bool is_dictionary_map() const; |
| bool IsJSArrayMap() const; |
| bool IsFixedCowArrayMap() const; |
| |
| ObjectRef constructor_or_backpointer() const; |
| |
| base::Optional<MapRef> AsElementsKind(ElementsKind kind) const; |
| |
| // Concerning the underlying instance_descriptors: |
| MapRef FindFieldOwner(int descriptor) const; |
| PropertyDetails GetPropertyDetails(int i) const; |
| NameRef GetPropertyKey(int i) const; |
| FieldIndex GetFieldIndexFor(int i) const; |
| ObjectRef GetFieldType(int descriptor) const; |
| }; |
| |
| class FixedArrayBaseRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| int length() const; |
| }; |
| |
| class FixedArrayRef : public FixedArrayBaseRef { |
| public: |
| using FixedArrayBaseRef::FixedArrayBaseRef; |
| |
| ObjectRef get(int i) const; |
| bool is_the_hole(int i) const; |
| }; |
| |
| class FixedDoubleArrayRef : public FixedArrayBaseRef { |
| public: |
| using FixedArrayBaseRef::FixedArrayBaseRef; |
| |
| double get_scalar(int i) const; |
| bool is_the_hole(int i) const; |
| }; |
| |
| class BytecodeArrayRef : public FixedArrayBaseRef { |
| public: |
| using FixedArrayBaseRef::FixedArrayBaseRef; |
| |
| int register_count() const; |
| }; |
| |
| class JSArrayRef : public JSObjectRef { |
| public: |
| using JSObjectRef::JSObjectRef; |
| |
| ObjectRef length() const; |
| }; |
| |
| class ScopeInfoRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| int ContextLength() const; |
| }; |
| |
| #define BROKER_SFI_FIELDS(V) \ |
| V(int, internal_formal_parameter_count) \ |
| V(bool, has_duplicate_parameters) \ |
| V(int, function_map_index) \ |
| V(FunctionKind, kind) \ |
| V(LanguageMode, language_mode) \ |
| V(bool, native) \ |
| V(bool, HasBreakInfo) \ |
| V(bool, HasBuiltinFunctionId) \ |
| V(bool, HasBuiltinId) \ |
| V(BuiltinFunctionId, builtin_function_id) \ |
| V(bool, construct_as_builtin) \ |
| V(bool, HasBytecodeArray) |
| |
| class SharedFunctionInfoRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| int builtin_id() const; |
| BytecodeArrayRef GetBytecodeArray() const; |
| #define DECL_ACCESSOR(type, name) type name() const; |
| BROKER_SFI_FIELDS(DECL_ACCESSOR) |
| #undef DECL_ACCSESOR |
| }; |
| |
| class StringRef : public NameRef { |
| public: |
| using NameRef::NameRef; |
| |
| int length() const; |
| uint16_t GetFirstChar(); |
| base::Optional<double> ToNumber(); |
| }; |
| |
| class ModuleRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| |
| CellRef GetCell(int cell_index); |
| }; |
| |
| class CellRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| }; |
| |
| class JSGlobalProxyRef : public JSObjectRef { |
| public: |
| using JSObjectRef::JSObjectRef; |
| }; |
| |
| class CodeRef : public HeapObjectRef { |
| public: |
| using HeapObjectRef::HeapObjectRef; |
| }; |
| |
| class InternalizedStringRef : public StringRef { |
| public: |
| using StringRef::StringRef; |
| }; |
| |
| class V8_EXPORT_PRIVATE JSHeapBroker : public NON_EXPORTED_BASE(ZoneObject) { |
| public: |
| JSHeapBroker(Isolate* isolate, Zone* zone); |
| void SerializeStandardObjects(); |
| |
| HeapObjectType HeapObjectTypeFromMap(Handle<Map> map) const { |
| AllowHandleDereference handle_dereference; |
| return HeapObjectTypeFromMap(*map); |
| } |
| |
| Isolate* isolate() const { return isolate_; } |
| Zone* zone() const { return zone_; } |
| |
| enum BrokerMode { kDisabled, kSerializing, kSerialized }; |
| BrokerMode mode() const { return mode_; } |
| void StopSerializing() { |
| CHECK_EQ(mode_, kSerializing); |
| mode_ = kSerialized; |
| } |
| bool SerializingAllowed() const; |
| |
| // Returns nullptr iff handle unknown. |
| ObjectData* GetData(Handle<Object>) const; |
| // Never returns nullptr. |
| ObjectData* GetOrCreateData(Handle<Object>); |
| |
| void Trace(const char* format, ...) const; |
| |
| private: |
| friend class HeapObjectRef; |
| friend class ObjectRef; |
| friend class ObjectData; |
| |
| // TODO(neis): Remove eventually. |
| HeapObjectType HeapObjectTypeFromMap(Map* map) const; |
| |
| void AddData(Handle<Object> object, ObjectData* data); |
| |
| Isolate* const isolate_; |
| Zone* const zone_; |
| ZoneUnorderedMap<Address, ObjectData*> refs_; |
| BrokerMode mode_; |
| }; |
| |
| #define ASSIGN_RETURN_NO_CHANGE_IF_DATA_MISSING(something_var, \ |
| optionally_something) \ |
| auto optionally_something_ = optionally_something; \ |
| if (!optionally_something_) \ |
| return NoChangeBecauseOfMissingData(js_heap_broker(), __FUNCTION__, \ |
| __LINE__); \ |
| something_var = *optionally_something_; |
| |
| class Reduction; |
| Reduction NoChangeBecauseOfMissingData(JSHeapBroker* broker, |
| const char* function, int line); |
| |
| } // namespace compiler |
| } // namespace internal |
| } // namespace v8 |
| |
| #endif // V8_COMPILER_JS_HEAP_BROKER_H_ |