/* * Copyright (c) 2020-2022, Linus Groh * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include namespace JS { struct ClampedU8 { }; // 25.1.1 Notation (read-modify-write modification function), https://tc39.es/ecma262/#sec-arraybuffer-notation using ReadWriteModifyFunction = Function; class ArrayBuffer : public Object { JS_OBJECT(ArrayBuffer, Object); public: static ThrowCompletionOr create(GlobalObject&, size_t); static ArrayBuffer* create(GlobalObject&, ByteBuffer); static ArrayBuffer* create(GlobalObject&, ByteBuffer*); ArrayBuffer(ByteBuffer buffer, Object& prototype); ArrayBuffer(ByteBuffer* buffer, Object& prototype); virtual ~ArrayBuffer() override = default; size_t byte_length() const { return buffer_impl().size(); } size_t max_byte_length() const { return m_max_byte_length.value(); } // Will VERIFY() that it has value ByteBuffer& buffer() { return buffer_impl(); } ByteBuffer const& buffer() const { return buffer_impl(); } // Used by allocate_array_buffer() to attach the data block after construction void set_buffer(ByteBuffer buffer) { m_buffer = move(buffer); } void set_max_byte_length(size_t max_byte_length) { m_max_byte_length = max_byte_length; } Value detach_key() const { return m_detach_key; } void set_detach_key(Value detach_key) { m_detach_key = detach_key; } void detach_buffer() { m_buffer = Empty {}; } bool is_detached() const { return m_buffer.has(); } bool is_resizable_array_buffer() const; enum Order { SeqCst, Unordered }; template Value get_value(size_t byte_index, bool is_typed_array, Order, bool is_little_endian = true); template void set_value(size_t byte_index, Value value, bool is_typed_array, Order, bool is_little_endian = true); template Value get_modify_set_value(size_t byte_index, Value value, ReadWriteModifyFunction operation, bool is_little_endian = true); private: virtual void visit_edges(Visitor&) override; ByteBuffer& buffer_impl() { ByteBuffer* ptr { nullptr }; m_buffer.visit([&](Empty) { VERIFY_NOT_REACHED(); }, [&](auto* pointer) { ptr = pointer; }, [&](auto& value) { ptr = &value; }); return *ptr; } ByteBuffer const& buffer_impl() const { return const_cast(this)->buffer_impl(); } Variant m_buffer; // The various detach related members of ArrayBuffer are not used by any ECMA262 functionality, // but are required to be available for the use of various harnesses like the Test262 test runner. Value m_detach_key; Optional m_max_byte_length; }; ThrowCompletionOr allocate_array_buffer(GlobalObject&, FunctionObject& constructor, size_t byte_length, Optional max_byte_length = {}); ThrowCompletionOr detach_array_buffer(GlobalObject&, ArrayBuffer& array_buffer, Optional key = {}); ThrowCompletionOr clone_array_buffer(GlobalObject&, ArrayBuffer& source_buffer, size_t source_byte_offset, size_t source_length); // 25.1.2.9 RawBytesToNumeric ( type, rawBytes, isLittleEndian ), https://tc39.es/ecma262/#sec-rawbytestonumeric template static Value raw_bytes_to_numeric(GlobalObject& global_object, ByteBuffer raw_value, bool is_little_endian) { if (!is_little_endian) { VERIFY(raw_value.size() % 2 == 0); for (size_t i = 0; i < raw_value.size() / 2; ++i) swap(raw_value[i], raw_value[raw_value.size() - 1 - i]); } using UnderlyingBufferDataType = Conditional, u8, T>; if constexpr (IsSame) { float value; raw_value.span().copy_to({ &value, sizeof(float) }); if (isnan(value)) return js_nan(); return Value(value); } if constexpr (IsSame) { double value; raw_value.span().copy_to({ &value, sizeof(double) }); if (isnan(value)) return js_nan(); return Value(value); } if constexpr (!IsIntegral) VERIFY_NOT_REACHED(); UnderlyingBufferDataType int_value = 0; raw_value.span().copy_to({ &int_value, sizeof(UnderlyingBufferDataType) }); if constexpr (sizeof(UnderlyingBufferDataType) == 8) { if constexpr (IsSigned) return js_bigint(global_object.heap(), Crypto::SignedBigInteger::create_from(int_value)); else return js_bigint(global_object.heap(), Crypto::SignedBigInteger { Crypto::UnsignedBigInteger::create_from(int_value) }); } else { return Value(int_value); } } // Implementation for 25.1.2.10 GetValueFromBuffer, used in TypedArray::get_value_from_buffer(). template Value ArrayBuffer::get_value(size_t byte_index, [[maybe_unused]] bool is_typed_array, Order, bool is_little_endian) { auto element_size = sizeof(T); // FIXME: Check for shared buffer // FIXME: Propagate errors. auto raw_value = MUST(buffer_impl().slice(byte_index, element_size)); return raw_bytes_to_numeric(global_object(), move(raw_value), is_little_endian); } // 25.1.2.11 NumericToRawBytes ( type, value, isLittleEndian ), https://tc39.es/ecma262/#sec-numerictorawbytes template static ByteBuffer numeric_to_raw_bytes(GlobalObject& global_object, Value value, bool is_little_endian) { VERIFY(value.is_number() || value.is_bigint()); using UnderlyingBufferDataType = Conditional, u8, T>; ByteBuffer raw_bytes = ByteBuffer::create_uninitialized(sizeof(UnderlyingBufferDataType)).release_value_but_fixme_should_propagate_errors(); // FIXME: Handle possible OOM situation. auto flip_if_needed = [&]() { if (is_little_endian) return; VERIFY(sizeof(UnderlyingBufferDataType) % 2 == 0); for (size_t i = 0; i < sizeof(UnderlyingBufferDataType) / 2; ++i) swap(raw_bytes[i], raw_bytes[sizeof(UnderlyingBufferDataType) - 1 - i]); }; if constexpr (IsSame) { float raw_value = MUST(value.to_double(global_object)); ReadonlyBytes { &raw_value, sizeof(float) }.copy_to(raw_bytes); flip_if_needed(); return raw_bytes; } if constexpr (IsSame) { double raw_value = MUST(value.to_double(global_object)); ReadonlyBytes { &raw_value, sizeof(double) }.copy_to(raw_bytes); flip_if_needed(); return raw_bytes; } if constexpr (!IsIntegral) VERIFY_NOT_REACHED(); if constexpr (sizeof(UnderlyingBufferDataType) == 8) { UnderlyingBufferDataType int_value; if constexpr (IsSigned) int_value = MUST(value.to_bigint_int64(global_object)); else int_value = MUST(value.to_bigint_uint64(global_object)); ReadonlyBytes { &int_value, sizeof(UnderlyingBufferDataType) }.copy_to(raw_bytes); flip_if_needed(); return raw_bytes; } else { UnderlyingBufferDataType int_value; if constexpr (IsSigned) { if constexpr (sizeof(UnderlyingBufferDataType) == 4) int_value = MUST(value.to_i32(global_object)); else if constexpr (sizeof(UnderlyingBufferDataType) == 2) int_value = MUST(value.to_i16(global_object)); else int_value = MUST(value.to_i8(global_object)); } else { if constexpr (sizeof(UnderlyingBufferDataType) == 4) int_value = MUST(value.to_u32(global_object)); else if constexpr (sizeof(UnderlyingBufferDataType) == 2) int_value = MUST(value.to_u16(global_object)); else if constexpr (!IsSame) int_value = MUST(value.to_u8(global_object)); else int_value = MUST(value.to_u8_clamp(global_object)); } ReadonlyBytes { &int_value, sizeof(UnderlyingBufferDataType) }.copy_to(raw_bytes); if constexpr (sizeof(UnderlyingBufferDataType) % 2 == 0) flip_if_needed(); return raw_bytes; } } // 25.1.2.12 SetValueInBuffer ( arrayBuffer, byteIndex, type, value, isTypedArray, order [ , isLittleEndian ] ), https://tc39.es/ecma262/#sec-setvalueinbuffer template void ArrayBuffer::set_value(size_t byte_index, Value value, [[maybe_unused]] bool is_typed_array, Order, bool is_little_endian) { auto raw_bytes = numeric_to_raw_bytes(global_object(), value, is_little_endian); // FIXME: Check for shared buffer raw_bytes.span().copy_to(buffer_impl().span().slice(byte_index)); } // 25.1.2.13 GetModifySetValueInBuffer ( arrayBuffer, byteIndex, type, value, op [ , isLittleEndian ] ), https://tc39.es/ecma262/#sec-getmodifysetvalueinbuffer template Value ArrayBuffer::get_modify_set_value(size_t byte_index, Value value, ReadWriteModifyFunction operation, bool is_little_endian) { auto raw_bytes = numeric_to_raw_bytes(global_object(), value, is_little_endian); // FIXME: Check for shared buffer // FIXME: Propagate errors. auto raw_bytes_read = MUST(buffer_impl().slice(byte_index, sizeof(T))); auto raw_bytes_modified = operation(raw_bytes_read, raw_bytes); raw_bytes_modified.span().copy_to(buffer_impl().span().slice(byte_index)); return raw_bytes_to_numeric(global_object(), raw_bytes_read, is_little_endian); } }