blob: f0c9a00878ad5690ba7f8bc6a59a036440217feb [file] [log] [blame]
// 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_OBJECTS_JS_OBJECTS_H_
#define V8_OBJECTS_JS_OBJECTS_H_
#include "src/base/optional.h"
#include "src/common/globals.h"
#include "src/handles/handles.h"
#include "src/objects/embedder-data-slot.h"
// TODO(jkummerow): Consider forward-declaring instead.
#include "src/objects/internal-index.h"
#include "src/objects/objects.h"
#include "src/objects/property-array.h"
// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"
namespace v8 {
namespace internal {
// Enum for functions that offer a second mode that does not cause allocations.
// Used in conjunction with LookupIterator and unboxed double fields.
enum class AllocationPolicy { kAllocationAllowed, kAllocationDisallowed };
enum InstanceType : uint16_t;
class JSGlobalObject;
class JSGlobalProxy;
class LookupIterator;
class PropertyDescriptor;
class PropertyKey;
class NativeContext;
class IsCompiledScope;
class SwissNameDictionary;
class ElementsAccessor;
#include "torque-generated/src/objects/js-objects-tq.inc"
// JSReceiver includes types on which properties can be defined, i.e.,
// JSObject and JSProxy.
class JSReceiver : public TorqueGeneratedJSReceiver<JSReceiver, HeapObject> {
public:
NEVER_READ_ONLY_SPACE
// Returns true if there is no slow (ie, dictionary) backing store.
DECL_GETTER(HasFastProperties, bool)
// Returns the properties array backing store if it
// exists. Otherwise, returns an empty_property_array when there's a
// Smi (hash code) or an empty_fixed_array for a fast properties
// map.
DECL_GETTER(property_array, Tagged<PropertyArray>)
// Gets slow properties for non-global objects (if
// v8_enable_swiss_name_dictionary is not set).
DECL_GETTER(property_dictionary, Tagged<NameDictionary>)
// Gets slow properties for non-global objects (if
// v8_enable_swiss_name_dictionary is set).
DECL_GETTER(property_dictionary_swiss, Tagged<SwissNameDictionary>)
// Sets the properties backing store and makes sure any existing hash is moved
// to the new properties store. To clear out the properties store, pass in the
// empty_fixed_array(), the hash will be maintained in this case as well.
void SetProperties(Tagged<HeapObject> properties);
// There are five possible values for the properties offset.
// 1) EmptyFixedArray/EmptyPropertyDictionary - This is the standard
// placeholder.
//
// 2) Smi - This is the hash code of the object.
//
// 3) PropertyArray - This is similar to a FixedArray but stores
// the hash code of the object in its length field. This is a fast
// backing store.
//
// 4) NameDictionary - This is the dictionary-mode backing store.
//
// 4) GlobalDictionary - This is the backing store for the
// GlobalObject.
//
// This is used only in the deoptimizer and heap. Please use the
// above typed getters and setters to access the properties.
DECL_ACCESSORS(raw_properties_or_hash, Tagged<Object>)
DECL_RELAXED_ACCESSORS(raw_properties_or_hash, Tagged<Object>)
inline void initialize_properties(Isolate* isolate);
// Deletes an existing named property in a normalized object.
static void DeleteNormalizedProperty(Handle<JSReceiver> object,
InternalIndex entry);
// ES6 section 7.1.1 ToPrimitive
V8_WARN_UNUSED_RESULT static MaybeHandle<Object> ToPrimitive(
Isolate* isolate, Handle<JSReceiver> receiver,
ToPrimitiveHint hint = ToPrimitiveHint::kDefault);
// ES6 section 7.1.1.1 OrdinaryToPrimitive
V8_WARN_UNUSED_RESULT static MaybeHandle<Object> OrdinaryToPrimitive(
Isolate* isolate, Handle<JSReceiver> receiver,
OrdinaryToPrimitiveHint hint);
// Unwraps the chain of potential function wrappers or JSProxy objects and
// return the leaf function's creation context.
// Throws TypeError in case there's a revoked JSProxy on the way.
// https://tc39.es/ecma262/#sec-getfunctionrealm
static MaybeHandle<NativeContext> GetFunctionRealm(
Handle<JSReceiver> receiver);
V8_EXPORT_PRIVATE static MaybeHandle<NativeContext> GetContextForMicrotask(
Handle<JSReceiver> receiver);
// Get the first non-hidden prototype.
static inline MaybeHandle<HeapObject> GetPrototype(
Isolate* isolate, Handle<JSReceiver> receiver);
V8_WARN_UNUSED_RESULT static Maybe<bool> HasInPrototypeChain(
Isolate* isolate, Handle<JSReceiver> object, Handle<Object> proto);
// Reads all enumerable own properties of source and adds them to
// target, using either Set or CreateDataProperty depending on the
// use_set argument. This only copies values not present in the
// maybe_excluded_properties list.
V8_WARN_UNUSED_RESULT static Maybe<bool> SetOrCopyDataProperties(
Isolate* isolate, Handle<JSReceiver> target, Handle<Object> source,
PropertiesEnumerationMode mode,
const base::ScopedVector<Handle<Object>>* excluded_properties = nullptr,
bool use_set = true);
// Implementation of [[HasProperty]], ECMA-262 5th edition, section 8.12.6.
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static Maybe<bool> HasProperty(
LookupIterator* it);
V8_WARN_UNUSED_RESULT static inline Maybe<bool> HasProperty(
Isolate* isolate, Handle<JSReceiver> object, Handle<Name> name);
V8_WARN_UNUSED_RESULT static inline Maybe<bool> HasElement(
Isolate* isolate, Handle<JSReceiver> object, uint32_t index);
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static Maybe<bool> HasOwnProperty(
Isolate* isolate, Handle<JSReceiver> object, Handle<Name> name);
V8_WARN_UNUSED_RESULT static inline Maybe<bool> HasOwnProperty(
Isolate* isolate, Handle<JSReceiver> object, uint32_t index);
V8_WARN_UNUSED_RESULT static inline MaybeHandle<Object> GetProperty(
Isolate* isolate, Handle<JSReceiver> receiver, const char* key);
V8_WARN_UNUSED_RESULT static inline MaybeHandle<Object> GetProperty(
Isolate* isolate, Handle<JSReceiver> receiver, Handle<Name> name);
V8_WARN_UNUSED_RESULT static inline MaybeHandle<Object> GetElement(
Isolate* isolate, Handle<JSReceiver> receiver, uint32_t index);
// Implementation of ES6 [[Delete]]
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static Maybe<bool>
DeletePropertyOrElement(Handle<JSReceiver> object, Handle<Name> name,
LanguageMode language_mode = LanguageMode::kSloppy);
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static Maybe<bool> DeleteProperty(
Handle<JSReceiver> object, Handle<Name> name,
LanguageMode language_mode = LanguageMode::kSloppy);
V8_WARN_UNUSED_RESULT static Maybe<bool> DeleteProperty(
LookupIterator* it, LanguageMode language_mode);
V8_WARN_UNUSED_RESULT static Maybe<bool> DeleteElement(
Handle<JSReceiver> object, uint32_t index,
LanguageMode language_mode = LanguageMode::kSloppy);
V8_WARN_UNUSED_RESULT static Tagged<Object> DefineProperty(
Isolate* isolate, Handle<Object> object, Handle<Object> name,
Handle<Object> attributes);
V8_WARN_UNUSED_RESULT static MaybeHandle<Object> DefineProperties(
Isolate* isolate, Handle<Object> object, Handle<Object> properties);
// "virtual" dispatcher to the correct [[DefineOwnProperty]] implementation.
V8_WARN_UNUSED_RESULT static Maybe<bool> DefineOwnProperty(
Isolate* isolate, Handle<JSReceiver> object, Handle<Object> key,
PropertyDescriptor* desc, Maybe<ShouldThrow> should_throw);
// Check if private name property can be store on the object. It will return
// false with an error when it cannot but didn't throw, or a Nothing if
// it throws.
V8_WARN_UNUSED_RESULT static Maybe<bool> CheckPrivateNameStore(
LookupIterator* it, bool is_define);
// ES6 7.3.4 (when passed kDontThrow)
V8_WARN_UNUSED_RESULT static Maybe<bool> CreateDataProperty(
Isolate* isolate, Handle<JSReceiver> object, Handle<Name> key,
Handle<Object> value, Maybe<ShouldThrow> should_throw);
V8_WARN_UNUSED_RESULT static Maybe<bool> CreateDataProperty(
Isolate* isolate, Handle<Object> object, PropertyKey key,
Handle<Object> value, Maybe<ShouldThrow> should_throw);
V8_WARN_UNUSED_RESULT static Maybe<bool> CreateDataProperty(
Isolate* isolate, Handle<JSReceiver> object, PropertyKey key,
Handle<Object> value, Maybe<ShouldThrow> should_throw);
// Add private fields to the receiver, ignoring extensibility and the
// traps. The caller should check that the private field does not already
// exist on the receiver before calling this method.
V8_WARN_UNUSED_RESULT static Maybe<bool> AddPrivateField(
LookupIterator* it, Handle<Object> value,
Maybe<ShouldThrow> should_throw);
// ES6 9.1.6.1
V8_WARN_UNUSED_RESULT static Maybe<bool> OrdinaryDefineOwnProperty(
Isolate* isolate, Handle<JSObject> object, Handle<Object> key,
PropertyDescriptor* desc, Maybe<ShouldThrow> should_throw);
V8_WARN_UNUSED_RESULT static Maybe<bool> OrdinaryDefineOwnProperty(
Isolate* isolate, Handle<JSObject> object, const PropertyKey& key,
PropertyDescriptor* desc, Maybe<ShouldThrow> should_throw);
V8_WARN_UNUSED_RESULT static Maybe<bool> OrdinaryDefineOwnProperty(
LookupIterator* it, PropertyDescriptor* desc,
Maybe<ShouldThrow> should_throw);
// ES6 9.1.6.2
V8_WARN_UNUSED_RESULT static Maybe<bool> IsCompatiblePropertyDescriptor(
Isolate* isolate, bool extensible, PropertyDescriptor* desc,
PropertyDescriptor* current, Handle<Name> property_name,
Maybe<ShouldThrow> should_throw);
// ES6 9.1.6.3
// |it| can be NULL in cases where the ES spec passes |undefined| as the
// receiver. Exactly one of |it| and |property_name| must be provided.
V8_WARN_UNUSED_RESULT static Maybe<bool> ValidateAndApplyPropertyDescriptor(
Isolate* isolate, LookupIterator* it, bool extensible,
PropertyDescriptor* desc, PropertyDescriptor* current,
Maybe<ShouldThrow> should_throw, Handle<Name> property_name);
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static Maybe<bool>
GetOwnPropertyDescriptor(Isolate* isolate, Handle<JSReceiver> object,
Handle<Object> key, PropertyDescriptor* desc);
V8_WARN_UNUSED_RESULT static Maybe<bool> GetOwnPropertyDescriptor(
LookupIterator* it, PropertyDescriptor* desc);
using IntegrityLevel = PropertyAttributes;
// ES6 7.3.14 (when passed kDontThrow)
// 'level' must be SEALED or FROZEN.
V8_WARN_UNUSED_RESULT static Maybe<bool> SetIntegrityLevel(
Isolate* isolate, Handle<JSReceiver> object, IntegrityLevel lvl,
ShouldThrow should_throw);
// ES6 7.3.15
// 'level' must be SEALED or FROZEN.
V8_WARN_UNUSED_RESULT static Maybe<bool> TestIntegrityLevel(
Isolate* isolate, Handle<JSReceiver> object, IntegrityLevel lvl);
// ES6 [[PreventExtensions]] (when passed kDontThrow)
V8_WARN_UNUSED_RESULT static Maybe<bool> PreventExtensions(
Isolate* isolate, Handle<JSReceiver> object, ShouldThrow should_throw);
V8_WARN_UNUSED_RESULT static Maybe<bool> IsExtensible(
Isolate* isolate, Handle<JSReceiver> object);
// Returns the class name.
V8_EXPORT_PRIVATE Tagged<String> class_name();
// Returns the constructor (the function that was used to instantiate the
// object).
static MaybeHandle<JSFunction> GetConstructor(Isolate* isolate,
Handle<JSReceiver> receiver);
// Returns the constructor name (the (possibly inferred) name of the function
// that was used to instantiate the object), if any. If a FunctionTemplate is
// used to instantiate the object, the class_name of the FunctionTemplate is
// returned instead.
static Handle<String> GetConstructorName(Isolate* isolate,
Handle<JSReceiver> receiver);
V8_EXPORT_PRIVATE inline base::Optional<Tagged<NativeContext>>
GetCreationContext();
V8_EXPORT_PRIVATE inline MaybeHandle<NativeContext> GetCreationContext(
Isolate* isolate);
V8_WARN_UNUSED_RESULT static inline Maybe<PropertyAttributes>
GetPropertyAttributes(Handle<JSReceiver> object, Handle<Name> name);
V8_WARN_UNUSED_RESULT static inline Maybe<PropertyAttributes>
GetOwnPropertyAttributes(Handle<JSReceiver> object, Handle<Name> name);
V8_WARN_UNUSED_RESULT static inline Maybe<PropertyAttributes>
GetOwnPropertyAttributes(Handle<JSReceiver> object, uint32_t index);
V8_WARN_UNUSED_RESULT static inline Maybe<PropertyAttributes>
GetElementAttributes(Handle<JSReceiver> object, uint32_t index);
V8_WARN_UNUSED_RESULT static inline Maybe<PropertyAttributes>
GetOwnElementAttributes(Handle<JSReceiver> object, uint32_t index);
V8_WARN_UNUSED_RESULT static Maybe<PropertyAttributes> GetPropertyAttributes(
LookupIterator* it);
// Set the object's prototype (only JSReceiver and null are allowed values).
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static Maybe<bool> SetPrototype(
Isolate* isolate, Handle<JSReceiver> object, Handle<Object> value,
bool from_javascript, ShouldThrow should_throw);
inline static Handle<Object> GetDataProperty(Isolate* isolate,
Handle<JSReceiver> object,
Handle<Name> name);
V8_EXPORT_PRIVATE static Handle<Object> GetDataProperty(
LookupIterator* it, AllocationPolicy allocation_policy =
AllocationPolicy::kAllocationAllowed);
// Retrieves a permanent object identity hash code. The undefined value might
// be returned in case no hash was created yet.
V8_EXPORT_PRIVATE Tagged<Object> GetIdentityHash();
// Retrieves a permanent object identity hash code. May create and store a
// hash code if needed and none exists.
static Tagged<Smi> CreateIdentityHash(Isolate* isolate,
Tagged<JSReceiver> key);
V8_EXPORT_PRIVATE Tagged<Smi> GetOrCreateIdentityHash(Isolate* isolate);
// Stores the hash code. The hash passed in must be masked with
// JSReceiver::kHashMask.
V8_EXPORT_PRIVATE void SetIdentityHash(int masked_hash);
// ES6 [[OwnPropertyKeys]] (modulo return type)
V8_WARN_UNUSED_RESULT static inline MaybeHandle<FixedArray> OwnPropertyKeys(
Isolate* isolate, Handle<JSReceiver> object);
V8_WARN_UNUSED_RESULT static MaybeHandle<FixedArray> GetOwnValues(
Isolate* isolate, Handle<JSReceiver> object, PropertyFilter filter,
bool try_fast_path = true);
V8_WARN_UNUSED_RESULT static MaybeHandle<FixedArray> GetOwnEntries(
Isolate* isolate, Handle<JSReceiver> object, PropertyFilter filter,
bool try_fast_path = true);
static const int kHashMask = PropertyArray::HashField::kMask;
bool HasProxyInPrototype(Isolate* isolate);
// TC39 "Dynamic Code Brand Checks"
bool IsCodeLike(Isolate* isolate) const;
private:
// Hide generated accessors; custom accessors are called
// "raw_properties_or_hash".
DECL_ACCESSORS(properties_or_hash, Tagged<Object>)
TQ_OBJECT_CONSTRUCTORS(JSReceiver)
};
// The JSObject describes real heap allocated JavaScript objects with
// properties.
// Note that the map of JSObject changes during execution to enable inline
// caching.
class JSObject : public TorqueGeneratedJSObject<JSObject, JSReceiver> {
public:
static bool IsUnmodifiedApiObject(FullObjectSlot o);
V8_EXPORT_PRIVATE static V8_WARN_UNUSED_RESULT MaybeHandle<JSObject> New(
Handle<JSFunction> constructor, Handle<JSReceiver> new_target,
Handle<AllocationSite> site,
NewJSObjectType = NewJSObjectType::kNoAPIWrapper);
static MaybeHandle<JSObject> NewWithMap(
Isolate* isolate, Handle<Map> initial_map, Handle<AllocationSite> site,
NewJSObjectType = NewJSObjectType::kNoAPIWrapper);
// 9.1.12 ObjectCreate ( proto [ , internalSlotsList ] )
// Notice: This is NOT 19.1.2.2 Object.create ( O, Properties )
static V8_WARN_UNUSED_RESULT MaybeHandle<JSObject> ObjectCreate(
Isolate* isolate, Handle<Object> prototype);
DECL_ACCESSORS(elements, Tagged<FixedArrayBase>)
DECL_RELAXED_GETTER(elements, Tagged<FixedArrayBase>)
// Acquire/release semantics on this field are explicitly forbidden to avoid
// confusion, since the default setter uses relaxed semantics. If
// acquire/release semantics ever become necessary, the default setter should
// be reverted to non-atomic behavior, and setters with explicit tags
// introduced and used when required.
Tagged<FixedArrayBase> elements(PtrComprCageBase cage_base,
AcquireLoadTag tag) const = delete;
void set_elements(Tagged<FixedArrayBase> value, ReleaseStoreTag tag,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER) = delete;
inline void initialize_elements();
static inline void SetMapAndElements(Handle<JSObject> object, Handle<Map> map,
Handle<FixedArrayBase> elements);
DECL_GETTER(GetElementsKind, ElementsKind)
DECL_GETTER(GetElementsAccessor, ElementsAccessor*)
// Returns true if an object has elements of PACKED_SMI_ELEMENTS or
// HOLEY_SMI_ELEMENTS ElementsKind.
DECL_GETTER(HasSmiElements, bool)
// Returns true if an object has elements of PACKED_ELEMENTS or
// HOLEY_ELEMENTS ElementsKind.
DECL_GETTER(HasObjectElements, bool)
// Returns true if an object has elements of PACKED_SMI_ELEMENTS,
// HOLEY_SMI_ELEMENTS, PACKED_ELEMENTS, or HOLEY_ELEMENTS.
DECL_GETTER(HasSmiOrObjectElements, bool)
// Returns true if an object has any of the "fast" elements kinds.
DECL_GETTER(HasFastElements, bool)
// Returns true if an object has any of the PACKED elements kinds.
DECL_GETTER(HasFastPackedElements, bool)
// Returns true if an object has elements of PACKED_DOUBLE_ELEMENTS or
// HOLEY_DOUBLE_ELEMENTS ElementsKind.
DECL_GETTER(HasDoubleElements, bool)
// Returns true if an object has elements of HOLEY_SMI_ELEMENTS,
// HOLEY_DOUBLE_ELEMENTS, or HOLEY_ELEMENTS ElementsKind.
DECL_GETTER(HasHoleyElements, bool)
DECL_GETTER(HasSloppyArgumentsElements, bool)
DECL_GETTER(HasStringWrapperElements, bool)
DECL_GETTER(HasDictionaryElements, bool)
// Returns true if an object has elements of PACKED_ELEMENTS
DECL_GETTER(HasPackedElements, bool)
DECL_GETTER(HasAnyNonextensibleElements, bool)
DECL_GETTER(HasSealedElements, bool)
DECL_GETTER(HasSharedArrayElements, bool)
DECL_GETTER(HasNonextensibleElements, bool)
DECL_GETTER(HasTypedArrayOrRabGsabTypedArrayElements, bool)
DECL_GETTER(HasFixedUint8ClampedElements, bool)
DECL_GETTER(HasFixedArrayElements, bool)
DECL_GETTER(HasFixedInt8Elements, bool)
DECL_GETTER(HasFixedUint8Elements, bool)
DECL_GETTER(HasFixedInt16Elements, bool)
DECL_GETTER(HasFixedUint16Elements, bool)
DECL_GETTER(HasFixedInt32Elements, bool)
DECL_GETTER(HasFixedUint32Elements, bool)
DECL_GETTER(HasFixedFloat16Elements, bool)
DECL_GETTER(HasFixedFloat32Elements, bool)
DECL_GETTER(HasFixedFloat64Elements, bool)
DECL_GETTER(HasFixedBigInt64Elements, bool)
DECL_GETTER(HasFixedBigUint64Elements, bool)
DECL_GETTER(HasFastArgumentsElements, bool)
DECL_GETTER(HasSlowArgumentsElements, bool)
DECL_GETTER(HasFastStringWrapperElements, bool)
DECL_GETTER(HasSlowStringWrapperElements, bool)
bool HasEnumerableElements();
// Gets slow elements.
DECL_GETTER(element_dictionary, Tagged<NumberDictionary>)
// Requires: HasFastElements().
static void EnsureWritableFastElements(Handle<JSObject> object);
V8_WARN_UNUSED_RESULT static Maybe<bool> SetPropertyWithInterceptor(
LookupIterator* it, Maybe<ShouldThrow> should_throw,
Handle<Object> value);
// The API currently still wants DefineOwnPropertyIgnoreAttributes to convert
// AccessorInfo objects to data fields. We allow FORCE_FIELD as an exception
// to the default behavior that calls the setter.
enum AccessorInfoHandling { FORCE_FIELD, DONT_FORCE_FIELD };
V8_WARN_UNUSED_RESULT static MaybeHandle<Object>
DefineOwnPropertyIgnoreAttributes(
LookupIterator* it, Handle<Object> value, PropertyAttributes attributes,
AccessorInfoHandling handling = DONT_FORCE_FIELD,
EnforceDefineSemantics semantics = EnforceDefineSemantics::kSet);
V8_WARN_UNUSED_RESULT static Maybe<bool> DefineOwnPropertyIgnoreAttributes(
LookupIterator* it, Handle<Object> value, PropertyAttributes attributes,
Maybe<ShouldThrow> should_throw,
AccessorInfoHandling handling = DONT_FORCE_FIELD,
EnforceDefineSemantics semantics = EnforceDefineSemantics::kSet,
StoreOrigin store_origin = StoreOrigin::kNamed);
V8_WARN_UNUSED_RESULT static MaybeHandle<Object> V8_EXPORT_PRIVATE
SetOwnPropertyIgnoreAttributes(Handle<JSObject> object, Handle<Name> name,
Handle<Object> value,
PropertyAttributes attributes);
V8_WARN_UNUSED_RESULT static MaybeHandle<Object>
SetOwnElementIgnoreAttributes(Handle<JSObject> object, size_t index,
Handle<Object> value,
PropertyAttributes attributes);
// Equivalent to one of the above depending on whether |name| can be converted
// to an array index.
V8_EXPORT_PRIVATE V8_WARN_UNUSED_RESULT static MaybeHandle<Object>
DefinePropertyOrElementIgnoreAttributes(Handle<JSObject> object,
Handle<Name> name,
Handle<Object> value,
PropertyAttributes attributes = NONE);
// Adds or reconfigures a property to attributes NONE. It will fail when it
// cannot.
V8_WARN_UNUSED_RESULT static Maybe<bool> CreateDataProperty(
Isolate* isolate, Handle<JSObject> object, PropertyKey key,
Handle<Object> value, Maybe<ShouldThrow> should_throw = Just(kDontThrow));
V8_EXPORT_PRIVATE static void AddProperty(Isolate* isolate,
Handle<JSObject> object,
Handle<Name> name,
Handle<Object> value,
PropertyAttributes attributes);
// {name} must be a UTF-8 encoded, null-terminated string.
static void AddProperty(Isolate* isolate, Handle<JSObject> object,
const char* name, Handle<Object> value,
PropertyAttributes attributes);
V8_EXPORT_PRIVATE static Maybe<bool> AddDataElement(
Handle<JSObject> receiver, uint32_t index, Handle<Object> value,
PropertyAttributes attributes);
// Extend the receiver with a single fast property appeared first in the
// passed map. This also extends the property backing store if necessary.
static void AllocateStorageForMap(Handle<JSObject> object, Handle<Map> map);
// Migrates the given object to a map whose field representations are the
// lowest upper bound of all known representations for that field.
static void MigrateInstance(Isolate* isolate, Handle<JSObject> instance);
// Migrates the given object only if the target map is already available,
// or returns false if such a map is not yet available.
static bool TryMigrateInstance(Isolate* isolate, Handle<JSObject> instance);
// Sets the property value in a normalized object given (key, value, details).
// Handles the special representation of JS global objects.
static void SetNormalizedProperty(Handle<JSObject> object, Handle<Name> name,
Handle<Object> value,
PropertyDetails details);
static void SetNormalizedElement(Handle<JSObject> object, uint32_t index,
Handle<Object> value,
PropertyDetails details);
static void OptimizeAsPrototype(Handle<JSObject> object,
bool enable_setup_mode = true);
static void ReoptimizeIfPrototype(Handle<JSObject> object);
static void MakePrototypesFast(Handle<Object> receiver,
WhereToStart where_to_start, Isolate* isolate);
static void LazyRegisterPrototypeUser(Handle<Map> user, Isolate* isolate);
static void UpdatePrototypeUserRegistration(Handle<Map> old_map,
Handle<Map> new_map,
Isolate* isolate);
static bool UnregisterPrototypeUser(Handle<Map> user, Isolate* isolate);
static Tagged<Map> InvalidatePrototypeChains(Tagged<Map> map);
static void InvalidatePrototypeValidityCell(Tagged<JSGlobalObject> global);
// Updates prototype chain tracking information when an object changes its
// map from |old_map| to |new_map|.
static void NotifyMapChange(Handle<Map> old_map, Handle<Map> new_map,
Isolate* isolate);
// Utility used by many Array builtins and runtime functions
static inline bool PrototypeHasNoElements(Isolate* isolate,
Tagged<JSObject> object);
// To be passed to PrototypeUsers::Compact.
static void PrototypeRegistryCompactionCallback(Tagged<HeapObject> value,
int old_index, int new_index);
// Retrieve interceptors.
DECL_GETTER(GetNamedInterceptor, Tagged<InterceptorInfo>)
DECL_GETTER(GetIndexedInterceptor, Tagged<InterceptorInfo>)
// Used from JSReceiver.
V8_WARN_UNUSED_RESULT static Maybe<PropertyAttributes>
GetPropertyAttributesWithInterceptor(LookupIterator* it);
V8_WARN_UNUSED_RESULT static Maybe<PropertyAttributes>
GetPropertyAttributesWithFailedAccessCheck(LookupIterator* it);
// Defines an AccessorPair property on the given object.
V8_EXPORT_PRIVATE static MaybeHandle<Object>
DefineOwnAccessorIgnoreAttributes(Handle<JSObject> object, Handle<Name> name,
Handle<Object> getter,
Handle<Object> setter,
PropertyAttributes attributes);
static MaybeHandle<Object> DefineOwnAccessorIgnoreAttributes(
LookupIterator* it, Handle<Object> getter, Handle<Object> setter,
PropertyAttributes attributes);
// Defines an AccessorInfo property on the given object.
V8_WARN_UNUSED_RESULT static MaybeHandle<Object> SetAccessor(
Handle<JSObject> object, Handle<Name> name, Handle<AccessorInfo> info,
PropertyAttributes attributes);
// Check if a data property can be created on the object. It will fail with
// an error when it cannot.
V8_WARN_UNUSED_RESULT static Maybe<bool> CheckIfCanDefineAsConfigurable(
Isolate* isolate, LookupIterator* it, Handle<Object> value,
Maybe<ShouldThrow> should_throw);
// The result must be checked first for exceptions. If there's no exception,
// the output parameter |done| indicates whether the interceptor has a result
// or not.
V8_WARN_UNUSED_RESULT static MaybeHandle<Object> GetPropertyWithInterceptor(
LookupIterator* it, bool* done);
static void ValidateElements(Tagged<JSObject> object);
// Makes sure that this object can contain HeapObject as elements.
static inline void EnsureCanContainHeapObjectElements(Handle<JSObject> obj);
// Makes sure that this object can contain the specified elements.
// TSlot here is either ObjectSlot or FullObjectSlot.
template <typename TSlot>
static inline void EnsureCanContainElements(Handle<JSObject> object,
TSlot elements, uint32_t count,
EnsureElementsMode mode);
static inline void EnsureCanContainElements(Handle<JSObject> object,
Handle<FixedArrayBase> elements,
uint32_t length,
EnsureElementsMode mode);
static void EnsureCanContainElements(Handle<JSObject> object,
JavaScriptArguments* arguments,
uint32_t arg_count,
EnsureElementsMode mode);
// Would we convert a fast elements array to dictionary mode given
// an access at key?
bool WouldConvertToSlowElements(uint32_t index);
static const uint32_t kMinAddedElementsCapacity = 16;
// Computes the new capacity when expanding the elements of a JSObject.
static uint32_t NewElementsCapacity(uint32_t old_capacity) {
// (old_capacity + 50%) + kMinAddedElementsCapacity
return old_capacity + (old_capacity >> 1) + kMinAddedElementsCapacity;
}
// These methods do not perform access checks!
template <AllocationSiteUpdateMode update_or_check =
AllocationSiteUpdateMode::kUpdate>
static bool UpdateAllocationSite(Handle<JSObject> object,
ElementsKind to_kind);
// Lookup interceptors are used for handling properties controlled by host
// objects.
DECL_GETTER(HasNamedInterceptor, bool)
DECL_GETTER(HasIndexedInterceptor, bool)
// Support functions for v8 api (needed for correct interceptor behavior).
V8_WARN_UNUSED_RESULT static Maybe<bool> HasRealNamedProperty(
Isolate* isolate, Handle<JSObject> object, Handle<Name> name);
V8_WARN_UNUSED_RESULT static Maybe<bool> HasRealElementProperty(
Isolate* isolate, Handle<JSObject> object, uint32_t index);
V8_WARN_UNUSED_RESULT static Maybe<bool> HasRealNamedCallbackProperty(
Isolate* isolate, Handle<JSObject> object, Handle<Name> name);
// Get the header size for a JSObject. Used to compute the index of
// embedder fields as well as the number of embedder fields.
// The |function_has_prototype_slot| parameter is needed only for
// JSFunction objects.
static V8_EXPORT_PRIVATE int GetHeaderSize(
InstanceType instance_type, bool function_has_prototype_slot = false);
static inline int GetHeaderSize(Tagged<Map> map);
static inline bool MayHaveEmbedderFields(Tagged<Map> map);
inline bool MayHaveEmbedderFields() const;
static inline int GetEmbedderFieldsStartOffset(Tagged<Map> map);
inline int GetEmbedderFieldsStartOffset();
static inline int GetEmbedderFieldCount(Tagged<Map> map);
inline int GetEmbedderFieldCount() const;
inline int GetEmbedderFieldOffset(int index);
inline Tagged<Object> GetEmbedderField(int index);
inline void SetEmbedderField(int index, Tagged<Object> value);
inline void SetEmbedderField(int index, Tagged<Smi> value);
// Returns true if this object is an Api object which can, if unmodified, be
// dropped during minor GC because the embedder can recreate it again later.
static inline bool IsDroppableApiObject(Tagged<Map>);
inline bool IsDroppableApiObject() const;
// Returns a new map with all transitions dropped from the object's current
// map and the ElementsKind set.
static Handle<Map> GetElementsTransitionMap(Handle<JSObject> object,
ElementsKind to_kind);
V8_EXPORT_PRIVATE static void TransitionElementsKind(Handle<JSObject> object,
ElementsKind to_kind);
// Always use this to migrate an object to a new map.
// |expected_additional_properties| is only used for fast-to-slow transitions
// and ignored otherwise.
V8_EXPORT_PRIVATE static void MigrateToMap(
Isolate* isolate, Handle<JSObject> object, Handle<Map> new_map,
int expected_additional_properties = 0);
// Forces a prototype without any of the checks that the regular SetPrototype
// would do.
static void ForceSetPrototype(Isolate* isolate, Handle<JSObject> object,
Handle<HeapObject> proto);
// Convert the object to use the canonical dictionary
// representation. If the object is expected to have additional properties
// added this number can be indicated to have the backing store allocated to
// an initial capacity for holding these properties.
V8_EXPORT_PRIVATE static void NormalizeProperties(
Isolate* isolate, Handle<JSObject> object, PropertyNormalizationMode mode,
int expected_additional_properties, bool use_cache, const char* reason);
V8_EXPORT_PRIVATE static void NormalizeProperties(
Isolate* isolate, Handle<JSObject> object, PropertyNormalizationMode mode,
int expected_additional_properties, const char* reason) {
const bool kUseCache = true;
NormalizeProperties(isolate, object, mode, expected_additional_properties,
kUseCache, reason);
}
// Convert and update the elements backing store to be a
// NumberDictionary dictionary. Returns the backing after conversion.
V8_EXPORT_PRIVATE static Handle<NumberDictionary> NormalizeElements(
Handle<JSObject> object);
void RequireSlowElements(Tagged<NumberDictionary> dictionary);
// Transform slow named properties to fast variants.
V8_EXPORT_PRIVATE static void MigrateSlowToFast(Handle<JSObject> object,
int unused_property_fields,
const char* reason);
// Access property in dictionary mode object at the given dictionary index.
static Handle<Object> DictionaryPropertyAt(Isolate* isolate,
Handle<JSObject> object,
InternalIndex dict_index);
// Same as above, but it will return {} if we would be reading out of the
// bounds of the object or if the dictionary is pending allocation. Use this
// version for concurrent access.
static base::Optional<Tagged<Object>> DictionaryPropertyAt(
Handle<JSObject> object, InternalIndex dict_index, Heap* heap);
// Access fast-case object properties at index.
static Handle<Object> FastPropertyAt(Isolate* isolate,
Handle<JSObject> object,
Representation representation,
FieldIndex index);
static Handle<Object> FastPropertyAt(Isolate* isolate,
Handle<JSObject> object,
Representation representation,
FieldIndex index, SeqCstAccessTag tag);
inline Tagged<Object> RawFastPropertyAt(FieldIndex index) const;
inline Tagged<Object> RawFastPropertyAt(PtrComprCageBase cage_base,
FieldIndex index) const;
inline Tagged<Object> RawFastPropertyAt(FieldIndex index,
SeqCstAccessTag tag) const;
inline Tagged<Object> RawFastPropertyAt(PtrComprCageBase cage_base,
FieldIndex index,
SeqCstAccessTag tag) const;
// See comment in the body of the method to understand the conditions
// in which this method is meant to be used, and what guarantees it
// provides against invalid reads from another thread during object
// mutation.
inline base::Optional<Tagged<Object>> RawInobjectPropertyAt(
PtrComprCageBase cage_base, Tagged<Map> original_map,
FieldIndex index) const;
inline void FastPropertyAtPut(FieldIndex index, Tagged<Object> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline void FastPropertyAtPut(FieldIndex index, Tagged<Object> value,
SeqCstAccessTag tag);
inline void RawFastInobjectPropertyAtPut(
FieldIndex index, Tagged<Object> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline void RawFastInobjectPropertyAtPut(FieldIndex index,
Tagged<Object> value,
SeqCstAccessTag tag);
inline void WriteToField(InternalIndex descriptor, PropertyDetails details,
Tagged<Object> value);
inline Tagged<Object> RawFastInobjectPropertyAtSwap(FieldIndex index,
Tagged<Object> value,
SeqCstAccessTag tag);
inline Tagged<Object> RawFastPropertyAtSwap(FieldIndex index,
Tagged<Object> value,
SeqCstAccessTag tag);
Tagged<Object> RawFastPropertyAtCompareAndSwap(FieldIndex index,
Tagged<Object> expected,
Tagged<Object> value,
SeqCstAccessTag tag);
inline Tagged<Object> RawFastInobjectPropertyAtCompareAndSwap(
FieldIndex index, Tagged<Object> expected, Tagged<Object> value,
SeqCstAccessTag tag);
// Access to in object properties.
inline int GetInObjectPropertyOffset(int index);
inline Tagged<Object> InObjectPropertyAt(int index);
inline Tagged<Object> InObjectPropertyAtPut(
int index, Tagged<Object> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
// Set the object's prototype (only JSReceiver and null are allowed values).
V8_WARN_UNUSED_RESULT static Maybe<bool> SetPrototype(
Isolate* isolate, Handle<JSObject> object, Handle<Object> value,
bool from_javascript, ShouldThrow should_throw);
// Makes the object prototype immutable
// Never called from JavaScript
static void SetImmutableProto(Handle<JSObject> object);
// Initializes the body starting at |start_offset|. It is responsibility of
// the caller to initialize object header. Fill the pre-allocated fields with
// undefined_value and the rest with filler_map.
// Note: this call does not update write barrier, the caller is responsible
// to ensure that |filler_map| can be collected without WB here.
inline void InitializeBody(Tagged<Map> map, int start_offset,
bool is_slack_tracking_in_progress,
MapWord filler_map,
Tagged<Object> undefined_value);
// Check whether this object references another object
bool ReferencesObject(Tagged<Object> obj);
V8_WARN_UNUSED_RESULT static Maybe<bool> TestIntegrityLevel(
Isolate* isolate, Handle<JSObject> object, IntegrityLevel lvl);
V8_WARN_UNUSED_RESULT static Maybe<bool> PreventExtensions(
Isolate* isolate, Handle<JSObject> object, ShouldThrow should_throw);
static bool IsExtensible(Isolate* isolate, Handle<JSObject> object);
static MaybeHandle<Object> ReadFromOptionsBag(Handle<Object> options,
Handle<String> option_name,
Isolate* isolate);
// Dispatched behavior.
void JSObjectShortPrint(StringStream* accumulator);
DECL_PRINTER(JSObject)
DECL_VERIFIER(JSObject)
#ifdef OBJECT_PRINT
bool PrintProperties(std::ostream& os);
void PrintElements(std::ostream& os);
#endif
#if defined(DEBUG) || defined(OBJECT_PRINT)
void PrintTransitions(std::ostream& os);
#endif
static void PrintElementsTransition(FILE* file, Handle<JSObject> object,
ElementsKind from_kind,
Handle<FixedArrayBase> from_elements,
ElementsKind to_kind,
Handle<FixedArrayBase> to_elements);
void PrintInstanceMigration(FILE* file, Tagged<Map> original_map,
Tagged<Map> new_map);
#ifdef DEBUG
// Structure for collecting spill information about JSObjects.
class SpillInformation {
public:
void Clear();
void Print();
int number_of_objects_;
int number_of_objects_with_fast_properties_;
int number_of_objects_with_fast_elements_;
int number_of_fast_used_fields_;
int number_of_fast_unused_fields_;
int number_of_slow_used_properties_;
int number_of_slow_unused_properties_;
int number_of_fast_used_elements_;
int number_of_fast_unused_elements_;
int number_of_slow_used_elements_;
int number_of_slow_unused_elements_;
};
void IncrementSpillStatistics(Isolate* isolate, SpillInformation* info);
#endif
#ifdef VERIFY_HEAP
// If a GC was caused while constructing this object, the elements pointer
// may point to a one pointer filler map. The object won't be rooted, but
// our heap verification code could stumble across it.
V8_EXPORT_PRIVATE bool ElementsAreSafeToExamine(
PtrComprCageBase cage_base) const;
#endif
Tagged<Object> SlowReverseLookup(Tagged<Object> value);
// Maximal number of elements (numbered 0 .. kMaxElementCount - 1).
// Also maximal value of JSArray's length property.
static constexpr uint32_t kMaxElementCount = kMaxUInt32;
static constexpr uint32_t kMaxElementIndex = kMaxElementCount - 1;
// Constants for heuristics controlling conversion of fast elements
// to slow elements.
// Maximal gap that can be introduced by adding an element beyond
// the current elements length.
static const uint32_t kMaxGap = 1024;
// Maximal length of fast elements array that won't be checked for
// being dense enough on expansion.
static const int kMaxUncheckedFastElementsLength = 5000;
// Same as above but for old arrays. This limit is more strict. We
// don't want to be wasteful with long lived objects.
static const int kMaxUncheckedOldFastElementsLength = 500;
// This constant applies only to the initial map of "global.Object" and
// not to arbitrary other JSObject maps.
static const int kInitialGlobalObjectUnusedPropertiesCount = 4;
static const int kMaxInstanceSize = 255 * kTaggedSize;
// kMaxInstanceSize in words must fit in one byte.
static_assert((kMaxInstanceSize >> kTaggedSizeLog2) <= kMaxUInt8);
static const int kMapCacheSize = 128;
// When extending the backing storage for property values, we increase
// its size by more than the 1 entry necessary, so sequentially adding fields
// to the same object requires fewer allocations and copies.
static const int kFieldsAdded = 3;
static_assert(kMaxNumberOfDescriptors + kFieldsAdded <=
PropertyArray::kMaxLength);
static_assert(kHeaderSize == Internals::kJSObjectHeaderSize);
static const int kMaxInObjectProperties =
(kMaxInstanceSize - kHeaderSize) >> kTaggedSizeLog2;
static_assert(kMaxInObjectProperties <= kMaxNumberOfDescriptors);
static const int kMaxFirstInobjectPropertyOffset =
(1 << kFirstInobjectPropertyOffsetBitCount) - 1;
static const int kMaxEmbedderFields =
(kMaxFirstInobjectPropertyOffset - kHeaderSize) / kEmbedderDataSlotSize;
static_assert(kHeaderSize +
kMaxEmbedderFields * kEmbedderDataSlotSizeInTaggedSlots <=
kMaxInstanceSize);
static constexpr int kMaxJSApiObjectInObjectProperties =
(kMaxInstanceSize - kHeaderSize - kCppHeapPointerSlotSize) >>
kTaggedSizeLog2;
static constexpr int kMaxJSApiObjectEmbedderFields =
(kMaxFirstInobjectPropertyOffset - kHeaderSize -
kCppHeapPointerSlotSize) /
kEmbedderDataSlotSize;
class BodyDescriptor;
class FastBodyDescriptor;
// Gets the number of currently used elements.
int GetFastElementsUsage();
template <typename Dictionary>
static void ApplyAttributesToDictionary(Isolate* isolate, ReadOnlyRoots roots,
Handle<Dictionary> dictionary,
const PropertyAttributes attributes);
private:
friend class JSReceiver;
friend class Object;
// Used from Object::GetProperty().
V8_WARN_UNUSED_RESULT static MaybeHandle<Object>
GetPropertyWithFailedAccessCheck(LookupIterator* it);
V8_WARN_UNUSED_RESULT static Maybe<bool> SetPropertyWithFailedAccessCheck(
LookupIterator* it, Handle<Object> value,
Maybe<ShouldThrow> should_throw);
V8_WARN_UNUSED_RESULT static Maybe<bool> DeletePropertyWithInterceptor(
LookupIterator* it, ShouldThrow should_throw);
bool ReferencesObjectFromElements(Tagged<FixedArray> elements,
ElementsKind kind, Tagged<Object> object);
// Helper for fast versions of preventExtensions, seal, and freeze.
// attrs is one of NONE, SEALED, or FROZEN (depending on the operation).
template <PropertyAttributes attrs>
V8_WARN_UNUSED_RESULT static Maybe<bool> PreventExtensionsWithTransition(
Isolate* isolate, Handle<JSObject> object, ShouldThrow should_throw);
inline Tagged<Object> RawFastPropertyAtCompareAndSwapInternal(
FieldIndex index, Tagged<Object> expected, Tagged<Object> value,
SeqCstAccessTag tag);
TQ_OBJECT_CONSTRUCTORS(JSObject)
};
// A JSObject created through the public api which wraps an external pointer.
// See v8::External.
class JSExternalObject
: public TorqueGeneratedJSExternalObject<JSExternalObject, JSObject> {
public:
// [value]: field containing the pointer value.
DECL_EXTERNAL_POINTER_ACCESSORS(value, void*)
static constexpr int kEndOfTaggedFieldsOffset = JSObject::kHeaderSize;
DECL_PRINTER(JSExternalObject)
class BodyDescriptor;
private:
TQ_OBJECT_CONSTRUCTORS(JSExternalObject)
};
// An abstract superclass for JSObjects that may contain EmbedderDataSlots.
class JSObjectWithEmbedderSlots
: public TorqueGeneratedJSObjectWithEmbedderSlots<JSObjectWithEmbedderSlots,
JSObject> {
public:
static_assert(kHeaderSize == JSObject::kHeaderSize);
TQ_OBJECT_CONSTRUCTORS(JSObjectWithEmbedderSlots)
};
// An abstract superclass for JSObjects that may contain EmbedderDataSlots and
// are used as API wrapper objects.
class JSAPIObjectWithEmbedderSlots
: public TorqueGeneratedJSAPIObjectWithEmbedderSlots<
JSAPIObjectWithEmbedderSlots, JSObject> {
public:
class BodyDescriptor;
TQ_OBJECT_CONSTRUCTORS(JSAPIObjectWithEmbedderSlots)
};
// An abstract superclass for JSObjects that may have elements while having an
// empty fixed array as elements backing store. It doesn't carry any
// functionality but allows function classes to be identified in the type
// system.
class JSCustomElementsObject
: public TorqueGeneratedJSCustomElementsObject<JSCustomElementsObject,
JSObject> {
public:
static_assert(kHeaderSize == JSObject::kHeaderSize);
TQ_OBJECT_CONSTRUCTORS(JSCustomElementsObject)
};
// An abstract superclass for JSObjects that require non-standard element
// access. It doesn't carry any functionality but allows function classes to be
// identified in the type system.
// These may also contain EmbedderDataSlots, but can't currently inherit from
// JSAPIObjectWithEmbedderSlots due to instance_type constraints.
class JSSpecialObject
: public TorqueGeneratedJSSpecialObject<JSSpecialObject,
JSCustomElementsObject> {
public:
TQ_OBJECT_CONSTRUCTORS(JSSpecialObject)
};
// Helper union that doesn't actually exist as type. Use by value.
class JSApiWrapper {
public:
V8_INLINE explicit JSApiWrapper(Tagged<JSObject> object);
template <ExternalPointerTag tag>
V8_INLINE void SetCppHeapWrappable(IsolateForPointerCompression isolate,
void*);
V8_INLINE void SetCppHeapWrappable(IsolateForPointerCompression isolate,
void*, ExternalPointerTag tag);
template <ExternalPointerTag tag>
V8_INLINE void* GetCppHeapWrappable(
IsolateForPointerCompression isolate) const;
V8_INLINE void* GetCppHeapWrappable(IsolateForPointerCompression isolate,
ExternalPointerTag tag) const;
private:
static_assert(JSAPIObjectWithEmbedderSlots::kCppHeapWrappableOffset ==
JSSpecialObject::kCppHeapWrappableOffset);
static constexpr int kCppHeapWrappableOffset =
JSAPIObjectWithEmbedderSlots::kCppHeapWrappableOffset;
Tagged<JSObject> object_;
};
// JSAccessorPropertyDescriptor is just a JSObject with a specific initial
// map. This initial map adds in-object properties for "get", "set",
// "enumerable" and "configurable" properties, as assigned by the
// FromPropertyDescriptor function for regular accessor properties.
class JSAccessorPropertyDescriptor : public JSObject {
public:
// Layout description.
#define JS_ACCESSOR_PROPERTY_DESCRIPTOR_FIELDS(V) \
V(kGetOffset, kTaggedSize) \
V(kSetOffset, kTaggedSize) \
V(kEnumerableOffset, kTaggedSize) \
V(kConfigurableOffset, kTaggedSize) \
/* Total size. */ \
V(kSize, 0)
DEFINE_FIELD_OFFSET_CONSTANTS(JSObject::kHeaderSize,
JS_ACCESSOR_PROPERTY_DESCRIPTOR_FIELDS)
#undef JS_ACCESSOR_PROPERTY_DESCRIPTOR_FIELDS
// Indices of in-object properties.
static const int kGetIndex = 0;
static const int kSetIndex = 1;
static const int kEnumerableIndex = 2;
static const int kConfigurableIndex = 3;
private:
DISALLOW_IMPLICIT_CONSTRUCTORS(JSAccessorPropertyDescriptor);
};
// JSDataPropertyDescriptor is just a JSObject with a specific initial map.
// This initial map adds in-object properties for "value", "writable",
// "enumerable" and "configurable" properties, as assigned by the
// FromPropertyDescriptor function for regular data properties.
class JSDataPropertyDescriptor : public JSObject {
public:
// Layout description.
#define JS_DATA_PROPERTY_DESCRIPTOR_FIELDS(V) \
V(kValueOffset, kTaggedSize) \
V(kWritableOffset, kTaggedSize) \
V(kEnumerableOffset, kTaggedSize) \
V(kConfigurableOffset, kTaggedSize) \
/* Total size. */ \
V(kSize, 0)
DEFINE_FIELD_OFFSET_CONSTANTS(JSObject::kHeaderSize,
JS_DATA_PROPERTY_DESCRIPTOR_FIELDS)
#undef JS_DATA_PROPERTY_DESCRIPTOR_FIELDS
// Indices of in-object properties.
static const int kValueIndex = 0;
static const int kWritableIndex = 1;
static const int kEnumerableIndex = 2;
static const int kConfigurableIndex = 3;
private:
DISALLOW_IMPLICIT_CONSTRUCTORS(JSDataPropertyDescriptor);
};
// JSIteratorResult is just a JSObject with a specific initial map.
// This initial map adds in-object properties for "done" and "value",
// as specified by ES6 section 25.1.1.3 The IteratorResult Interface.
class JSIteratorResult : public JSObject {
public:
DECL_ACCESSORS(value, Tagged<Object>)
DECL_ACCESSORS(done, Tagged<Object>)
// Layout description.
#define JS_ITERATOR_RESULT_FIELDS(V) \
V(kValueOffset, kTaggedSize) \
V(kDoneOffset, kTaggedSize) \
/* Total size. */ \
V(kSize, 0)
DEFINE_FIELD_OFFSET_CONSTANTS(JSObject::kHeaderSize,
JS_ITERATOR_RESULT_FIELDS)
#undef JS_ITERATOR_RESULT_FIELDS
// Indices of in-object properties.
static const int kValueIndex = 0;
static const int kDoneIndex = 1;
DECL_CAST(JSIteratorResult)
OBJECT_CONSTRUCTORS(JSIteratorResult, JSObject);
};
// JSGlobalProxy's prototype must be a JSGlobalObject or null,
// and the prototype is hidden. JSGlobalProxy always delegates
// property accesses to its prototype if the prototype is not null.
//
// A JSGlobalProxy can be reinitialized which will preserve its identity.
//
// Accessing a JSGlobalProxy requires security check.
class JSGlobalProxy
: public TorqueGeneratedJSGlobalProxy<JSGlobalProxy, JSSpecialObject> {
public:
inline bool IsDetachedFrom(Tagged<JSGlobalObject> global) const;
V8_EXPORT_PRIVATE bool IsDetached();
static int SizeWithEmbedderFields(int embedder_field_count);
// Dispatched behavior.
DECL_PRINTER(JSGlobalProxy)
DECL_VERIFIER(JSGlobalProxy)
TQ_OBJECT_CONSTRUCTORS(JSGlobalProxy)
};
// JavaScript global object.
class JSGlobalObject
: public TorqueGeneratedJSGlobalObject<JSGlobalObject, JSSpecialObject> {
public:
DECL_RELEASE_ACQUIRE_ACCESSORS(global_dictionary, Tagged<GlobalDictionary>)
static void InvalidatePropertyCell(Handle<JSGlobalObject> object,
Handle<Name> name);
inline bool IsDetached();
inline Tagged<NativeContext> native_context();
// Dispatched behavior.
DECL_PRINTER(JSGlobalObject)
DECL_VERIFIER(JSGlobalObject)
TQ_OBJECT_CONSTRUCTORS(JSGlobalObject)
};
// Representation for JS Wrapper objects, String, Number, Boolean, etc.
class JSPrimitiveWrapper
: public TorqueGeneratedJSPrimitiveWrapper<JSPrimitiveWrapper,
JSCustomElementsObject> {
public:
// Dispatched behavior.
DECL_PRINTER(JSPrimitiveWrapper)
TQ_OBJECT_CONSTRUCTORS(JSPrimitiveWrapper)
};
class DateCache;
// Representation for JS date objects.
class JSDate : public TorqueGeneratedJSDate<JSDate, JSObject> {
public:
static V8_WARN_UNUSED_RESULT MaybeHandle<JSDate> New(
Handle<JSFunction> constructor, Handle<JSReceiver> new_target, double tv);
// Returns the time value (UTC) identifying the current time in milliseconds.
static int64_t CurrentTimeValue(Isolate* isolate);
// Returns the date field with the specified index.
// See FieldIndex for the list of date fields.
// Arguments and result are raw Address values because this is called
// via ExternalReference.
// {raw_date} is a tagged Object pointer.
// {smi_index} is a tagged Smi.
// The return value is a tagged Object pointer.
static Address GetField(Isolate* isolate, Address raw_date,
Address smi_index);
static Handle<Object> SetValue(Handle<JSDate> date, double v);
void SetValue(Tagged<Object> value, bool is_value_nan);
// Dispatched behavior.
DECL_PRINTER(JSDate)
DECL_VERIFIER(JSDate)
// The order is important. It must be kept in sync with date macros
// in macros.py.
enum FieldIndex {
kDateValue,
kYear,
kMonth,
kDay,
kWeekday,
kHour,
kMinute,
kSecond,
kFirstUncachedField,
kMillisecond = kFirstUncachedField,
kDays,
kTimeInDay,
kFirstUTCField,
kYearUTC = kFirstUTCField,
kMonthUTC,
kDayUTC,
kWeekdayUTC,
kHourUTC,
kMinuteUTC,
kSecondUTC,
kMillisecondUTC,
kDaysUTC,
kTimeInDayUTC,
kTimezoneOffset
};
private:
Tagged<Object> DoGetField(Isolate* isolate, FieldIndex index);
Tagged<Object> GetUTCField(FieldIndex index, double value,
DateCache* date_cache);
// Computes and caches the cacheable fields of the date.
inline void SetCachedFields(int64_t local_time_ms, DateCache* date_cache);
TQ_OBJECT_CONSTRUCTORS(JSDate)
};
// Representation of message objects used for error reporting through
// the API. The messages are formatted in JavaScript so this object is
// a real JavaScript object. The information used for formatting the
// error messages are not directly accessible from JavaScript to
// prevent leaking information to user code called during error
// formatting.
class JSMessageObject
: public TorqueGeneratedJSMessageObject<JSMessageObject, JSObject> {
public:
// [type]: the type of error message.
inline MessageTemplate type() const;
inline void set_type(MessageTemplate value);
// Initializes the source positions in the object if possible. Does nothing if
// called more than once. If called when stack space is exhausted, then the
// source positions will be not be set and calling it again when there is more
// stack space will not have any effect.
static inline void EnsureSourcePositionsAvailable(
Isolate* isolate, Handle<JSMessageObject> message);
// Gets the start and end positions for the message.
// EnsureSourcePositionsAvailable must have been called before calling these.
inline int GetStartPosition() const;
inline int GetEndPosition() const;
// Returns the line number for the error message (1-based), or
// Message::kNoLineNumberInfo if the line cannot be determined.
// EnsureSourcePositionsAvailable must have been called before calling this.
V8_EXPORT_PRIVATE int GetLineNumber() const;
// Returns the offset of the given position within the containing line.
// EnsureSourcePositionsAvailable must have been called before calling this.
V8_EXPORT_PRIVATE int GetColumnNumber() const;
// Returns the source code
V8_EXPORT_PRIVATE Tagged<String> GetSource() const;
// Returns the source code line containing the given source
// position, or the empty string if the position is invalid.
// EnsureSourcePositionsAvailable must have been called before calling this.
Handle<String> GetSourceLine() const;
DECL_INT_ACCESSORS(error_level)
// Dispatched behavior.
DECL_PRINTER(JSMessageObject)
// TODO(v8:8989): [torque] Support marker constants.
static const int kPointerFieldsEndOffset = kStartPositionOffset;
using BodyDescriptor =
FixedBodyDescriptor<HeapObject::kMapOffset, kPointerFieldsEndOffset,
kHeaderSize>;
private:
friend class Factory;
inline bool DidEnsureSourcePositionsAvailable() const;
static void V8_PRESERVE_MOST V8_EXPORT_PRIVATE
InitializeSourcePositions(Isolate* isolate, Handle<JSMessageObject> message);
// [shared]: optional SharedFunctionInfo that can be used to reconstruct the
// source position if not available when the message was generated.
DECL_ACCESSORS(shared_info, Tagged<Object>)
// [bytecode_offset]: optional offset using along with |shared| to generation
// source positions.
DECL_ACCESSORS(bytecode_offset, Tagged<Smi>)
// [start_position]: the start position in the script for the error message.
DECL_INT_ACCESSORS(start_position)
// [end_position]: the end position in the script for the error message.
DECL_INT_ACCESSORS(end_position)
DECL_INT_ACCESSORS(raw_type)
// Hide generated accessors; custom accessors are named "raw_type".
DECL_INT_ACCESSORS(message_type)
TQ_OBJECT_CONSTRUCTORS(JSMessageObject)
};
// The [Async-from-Sync Iterator] object
// (proposal-async-iteration/#sec-async-from-sync-iterator-objects)
// An object which wraps an ordinary Iterator and converts it to behave
// according to the Async Iterator protocol.
// (See https://tc39.github.io/proposal-async-iteration/#sec-iteration)
class JSAsyncFromSyncIterator
: public TorqueGeneratedJSAsyncFromSyncIterator<JSAsyncFromSyncIterator,
JSObject> {
public:
DECL_PRINTER(JSAsyncFromSyncIterator)
// Async-from-Sync Iterator instances are ordinary objects that inherit
// properties from the %AsyncFromSyncIteratorPrototype% intrinsic object.
// Async-from-Sync Iterator instances are initially created with the internal
// slots listed in Table 4.
// (proposal-async-iteration/#table-async-from-sync-iterator-internal-slots)
TQ_OBJECT_CONSTRUCTORS(JSAsyncFromSyncIterator)
};
class JSStringIterator
: public TorqueGeneratedJSStringIterator<JSStringIterator, JSObject> {
public:
// Dispatched behavior.
DECL_PRINTER(JSStringIterator)
DECL_VERIFIER(JSStringIterator)
TQ_OBJECT_CONSTRUCTORS(JSStringIterator)
};
// The valid iterator wrapper is the wrapper object created by
// Iterator.from(obj), which attempts to wrap iterator-like objects into an
// actual iterator with %Iterator.prototype%.
class JSValidIteratorWrapper
: public TorqueGeneratedJSValidIteratorWrapper<JSValidIteratorWrapper,
JSObject> {
public:
DECL_PRINTER(JSValidIteratorWrapper)
TQ_OBJECT_CONSTRUCTORS(JSValidIteratorWrapper)
};
// JSPromiseWithResolversResult is just a JSObject with a specific initial map.
// This initial map adds in-object properties for "promise", "resolve", and
// "reject", in that order.
class JSPromiseWithResolversResult : public JSObject {
public:
DECL_ACCESSORS(promise, Tagged<Object>)
DECL_ACCESSORS(resolve, Tagged<Object>)
DECL_ACCESSORS(reject, Tagged<Object>)
// Layout description.
#define JS_PROMISE_WITHRESOLVERS_RESULT_FIELDS(V) \
V(kPromiseOffset, kTaggedSize) \
V(kResolveOffset, kTaggedSize) \
V(kRejectOffset, kTaggedSize) \
/* Total size. */ \
V(kSize, 0)
DEFINE_FIELD_OFFSET_CONSTANTS(JSObject::kHeaderSize,
JS_PROMISE_WITHRESOLVERS_RESULT_FIELDS)
#undef JS_PROMISE_WITHRESOLVERS_RESULT_FIELDS
// Indices of in-object properties.
static const int kPromiseIndex = 0;
static const int kResolveIndex = 1;
static const int kRejectIndex = 2;
DECL_CAST(JSPromiseWithResolversResult)
OBJECT_CONSTRUCTORS(JSPromiseWithResolversResult, JSObject);
};
} // namespace internal
} // namespace v8
#include "src/objects/object-macros-undef.h"
#endif // V8_OBJECTS_JS_OBJECTS_H_