// 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_API_CALLBACKS_H_
#define V8_OBJECTS_API_CALLBACKS_H_
#include "src/base/bit-field.h"
#include "src/objects/struct.h"
#include "src/sandbox/external-pointer.h"
// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"
namespace v8 {
namespace internal {
class Undefined;
class StructBodyDescriptor;
// An accessor must have a getter, but can have no setter.
//
// When setting a property, V8 searches accessors in prototypes.
// If an accessor was found and it does not have a setter,
// the request is ignored.
//
// If the accessor in the prototype has the READ_ONLY property attribute, then
// a new value is added to the derived object when the property is set.
// This shadows the accessor in the prototype.
V8_OBJECT class AccessorInfo : public HeapObject {
public:
inline Tagged<Object> data() const;
inline void set_data(Tagged<Object> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline Tagged<Name> name() const;
inline void set_name(Tagged<Name> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline uint32_t flags() const;
inline void set_flags(uint32_t value);
// C function pointer that can be called from native code.
DECL_REDIRECTED_CALLBACK_ACCESSORS_MAYBE_READ_ONLY_HOST(getter, Address)
inline bool has_getter(Isolate* isolate);
// The field contains the address of the C function.
DECL_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(setter, Address)
inline bool has_setter(Isolate* isolate);
DECL_BOOLEAN_ACCESSORS(replace_on_access)
DECL_BOOLEAN_ACCESSORS(is_sloppy)
inline SideEffectType getter_side_effect_type() const;
inline void set_getter_side_effect_type(SideEffectType type);
inline SideEffectType setter_side_effect_type() const;
inline void set_setter_side_effect_type(SideEffectType type);
// The property attributes used when an API object template is instantiated
// for the first time. Changing of this value afterwards does not affect
// the actual attributes of a property.
inline PropertyAttributes initial_property_attributes() const;
inline void set_initial_property_attributes(PropertyAttributes attributes);
// Checks whether the given receiver is compatible with this accessor.
static bool IsCompatibleReceiverMap(Handle<AccessorInfo> info,
Handle<Map> map);
inline bool IsCompatibleReceiver(Tagged<Object> receiver);
// Append all descriptors to the array that are not already there.
// Return number added.
static int AppendUnique(Isolate* isolate, DirectHandle<Object> descriptors,
DirectHandle<FixedArray> array,
int valid_descriptors);
DECL_PRINTER(AccessorInfo)
DECL_VERIFIER(AccessorInfo)
inline void RemoveCallbackRedirectionForSerialization(
IsolateForSandbox isolate);
inline void RestoreCallbackRedirectionAfterDeserialization(
IsolateForSandbox isolate);
inline void clear_padding();
class BodyDescriptor;
static const int kOptionalPaddingOffset;
static const int kOptionalPaddingOffsetEnd;
static const int kEndOfStrongFieldsOffset;
static const int kSize;
private:
// Bit positions in |flags|.
using IsSloppyBit = base::BitField<bool, 0, 1, uint32_t>;
using ReplaceOnAccessBit = IsSloppyBit::Next<bool, 1>;
using GetterSideEffectTypeBits = ReplaceOnAccessBit::Next<SideEffectType, 2>;
using SetterSideEffectTypeBits =
GetterSideEffectTypeBits::Next<SideEffectType, 2>;
using InitialAttributesBits =
SetterSideEffectTypeBits::Next<PropertyAttributes, 3>;
friend class TorqueGeneratedAccessorInfoAsserts;
friend class TorqueGeneratedBitFieldAsserts;
public:
TaggedMember<Object> data_;
TaggedMember<Name> name_;
ExternalPointerMember<kAccessorInfoGetterTag> getter_;
ExternalPointerMember<kAccessorInfoSetterTag> setter_;
uint32_t flags_;
#if TAGGED_SIZE_8_BYTES
uint32_t optional_padding_;
#endif // TAGGED_SIZE_8_BYTES
} V8_OBJECT_END;
inline constexpr int AccessorInfo::kOptionalPaddingOffset =
offsetof(AccessorInfo, flags_) + sizeof(uint32_t);
inline constexpr int AccessorInfo::kOptionalPaddingOffsetEnd =
TAGGED_SIZE_8_BYTES
? AccessorInfo::kOptionalPaddingOffset + sizeof(uint32_t) - 1
: AccessorInfo::kOptionalPaddingOffset - 1;
inline constexpr int AccessorInfo::kEndOfStrongFieldsOffset =
offsetof(AccessorInfo, getter_);
inline constexpr int AccessorInfo::kSize = sizeof(AccessorInfo);
V8_OBJECT class AccessCheckInfo : public Struct {
public:
static Tagged<AccessCheckInfo> Get(Isolate* isolate,
DirectHandle<JSObject> receiver);
inline Tagged<UnionOf<Foreign, Smi, Undefined>> callback() const;
inline void set_callback(Tagged<UnionOf<Foreign, Smi, Undefined>> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline Tagged<UnionOf<InterceptorInfo, Smi, Undefined>> named_interceptor()
const;
inline void set_named_interceptor(
Tagged<UnionOf<InterceptorInfo, Smi, Undefined>> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline Tagged<UnionOf<InterceptorInfo, Smi, Undefined>> indexed_interceptor()
const;
inline void set_indexed_interceptor(
Tagged<UnionOf<InterceptorInfo, Smi, Undefined>> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline Tagged<Object> data() const;
inline void set_data(Tagged<Object> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
DECL_PRINTER(AccessCheckInfo)
DECL_VERIFIER(AccessCheckInfo)
using BodyDescriptor = StructBodyDescriptor;
private:
friend class TorqueGeneratedAccessCheckInfoAsserts;
TaggedMember<UnionOf<Foreign, Smi, Undefined>> callback_;
TaggedMember<UnionOf<InterceptorInfo, Smi, Undefined>> named_interceptor_;
TaggedMember<UnionOf<InterceptorInfo, Smi, Undefined>> indexed_interceptor_;
TaggedMember<Object> data_;
} V8_OBJECT_END;
// Interceptor callbacks that exist in both named and indexed interceptors.
#define COMMON_INTERCEPTOR_INFO_CALLBACK_LIST(V) \
V(Getter, getter) \
V(Setter, setter) \
V(Query, query) \
V(Descriptor, descriptor) \
V(Deleter, deleter) \
V(Enumerator, enumerator) \
V(Definer, definer)
#define NAMED_INTERCEPTOR_INFO_CALLBACK_LIST(V) \
COMMON_INTERCEPTOR_INFO_CALLBACK_LIST(V)
#define INDEXED_INTERCEPTOR_INFO_CALLBACK_LIST(V) \
COMMON_INTERCEPTOR_INFO_CALLBACK_LIST(V) \
V(IndexOf, index_of) \
V(IterableToList, iterable_to_list)
V8_OBJECT class InterceptorInfo : public HeapObject {
public:
inline Tagged<Object> data() const;
inline void set_data(Tagged<Object> value,
WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
inline uint32_t flags() const;
inline void set_flags(uint32_t value);
// Convenient predicates without named/indexed prefix.
inline bool has_getter() const;
inline bool has_setter() const;
inline bool has_query() const;
inline bool has_descriptor() const;
inline bool has_deleter() const;
inline bool has_enumerator() const;
inline bool has_definer() const;
inline bool has_index_of() const;
inline bool has_iterable_to_list() const;
// Accessor callbacks for named interceptors.
DECL_LAZY_REDIRECTED_CALLBACK_ACCESSORS_MAYBE_READ_ONLY_HOST(named_getter,
Address)
DECL_LAZY_REDIRECTED_CALLBACK_ACCESSORS_MAYBE_READ_ONLY_HOST(named_setter,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(named_query,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(named_descriptor,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(named_deleter,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(named_enumerator,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(named_definer,
Address)
// Accessor callbacks for indexed interceptors.
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_getter,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_setter,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_query,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_descriptor,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_deleter,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_enumerator,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_definer,
Address)
// Indexed interceptor-only callbacks.
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(indexed_index_of,
Address)
DECL_LAZY_EXTERNAL_POINTER_ACCESSORS_MAYBE_READ_ONLY_HOST(
indexed_iterable_to_list, Address)
DECL_BOOLEAN_ACCESSORS(can_intercept_symbols)
DECL_BOOLEAN_ACCESSORS(non_masking)
inline bool is_named() const;
DECL_BOOLEAN_ACCESSORS(has_no_side_effect)
// TODO(ishell): remove support for old signatures once they go through
// Api deprecation process.
DECL_BOOLEAN_ACCESSORS(has_new_callbacks_signature)
DECL_BOOLEAN_ACCESSORS(has_dont_delete_property)
using CanInterceptSymbolsBit = base::BitField<bool, 0, 1, uint32_t>;
using NonMaskingBit = CanInterceptSymbolsBit::Next<bool, 1>;
using NamedBit = NonMaskingBit::Next<bool, 1>;
using HasNoSideEffectBit = NamedBit::Next<bool, 1>;
using HasNewCallbacksSignatureBit = HasNoSideEffectBit::Next<bool, 1>;
using HasDontDeletePropertyBit = HasNewCallbacksSignatureBit::Next<bool, 1>;
enum Flag : uint32_t {
kNone = 0,
kCanInterceptSymbols = CanInterceptSymbolsBit::kMask,
kNonMasking = NonMaskingBit::kMask,
kNamed = NamedBit::kMask,
kHasNoSideEffect = HasNoSideEffectBit::kMask,
kHasNewCallbacksSignature = HasNewCallbacksSignatureBit::kMask,
kHasDontDeleteProperty = HasDontDeletePropertyBit::kMask,
};
using Flags = base::Flags<Flag>;
static constexpr int kFlagCount = 6;
DECL_PRINTER(InterceptorInfo)
DECL_VERIFIER(InterceptorInfo)
inline void RemoveCallbackRedirectionForSerialization(
IsolateForSandbox isolate);
inline void RestoreCallbackRedirectionAfterDeserialization(
IsolateForSandbox isolate);
inline void clear_padding();
class BodyDescriptor;
static const int kOptionalPaddingOffset;
static const int kOptionalPaddingOffsetEnd;
static const int kEndOfStrongFieldsOffset;
static const int kIndexOfOffsetEnd;
static const int kIterableToListOffsetEnd;
static const int kSize;
private:
friend class Factory;
friend class TorqueGeneratedInterceptorInfoAsserts;
inline void AllocateExternalPointerEntries(Isolate* isolate);
public:
TaggedMember<Object> data_;
uint32_t flags_;
#if TAGGED_SIZE_8_BYTES
uint32_t optional_padding_;
#endif // TAGGED_SIZE_8_BYTES
ExternalPointerMember<kApiNamedPropertyGetterCallbackTag> getter_;
ExternalPointerMember<kApiNamedPropertySetterCallbackTag> setter_;
ExternalPointerMember<kApiNamedPropertyQueryCallbackTag> query_;
ExternalPointerMember<kApiNamedPropertyDescriptorCallbackTag> descriptor_;
ExternalPointerMember<kApiNamedPropertyDeleterCallbackTag> deleter_;
ExternalPointerMember<kApiNamedPropertyEnumeratorCallbackTag> enumerator_;
ExternalPointerMember<kApiNamedPropertyDefinerCallbackTag> definer_;
ExternalPointerMember<kApiIndexedPropertyIndexOfCallbackTag> index_of_;
ExternalPointerMember<kApiIndexedPropertyIterableToListCallbackTag>
iterable_to_list_;
} V8_OBJECT_END;
inline constexpr int InterceptorInfo::kOptionalPaddingOffset =
offsetof(InterceptorInfo, flags_) + sizeof(uint32_t);
inline constexpr int InterceptorInfo::kOptionalPaddingOffsetEnd =
TAGGED_SIZE_8_BYTES
? InterceptorInfo::kOptionalPaddingOffset + sizeof(uint32_t) - 1
: InterceptorInfo::kOptionalPaddingOffset - 1;
inline constexpr int InterceptorInfo::kEndOfStrongFieldsOffset =
offsetof(InterceptorInfo, flags_);
inline constexpr int InterceptorInfo::kIndexOfOffsetEnd =
offsetof(InterceptorInfo, index_of_) +
sizeof(ExternalPointerMember<kApiIndexedPropertyIndexOfCallbackTag>) - 1;
inline constexpr int InterceptorInfo::kIterableToListOffsetEnd =
offsetof(InterceptorInfo, iterable_to_list_) +
sizeof(
ExternalPointerMember<kApiIndexedPropertyIterableToListCallbackTag>) -
1;
inline constexpr int InterceptorInfo::kSize = sizeof(InterceptorInfo);
} // namespace internal
} // namespace v8
#include "src/objects/object-macros-undef.h"
#endif // V8_OBJECTS_API_CALLBACKS_H_