xref: /arkcompiler/ets_runtime/ecmascript/builtins/builtins_arraybuffer.h (revision 4514f5e3)

/*
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ECMASCRIPT_BUILTINS_BUILTINS_ARRAYBUFFER_H
#define ECMASCRIPT_BUILTINS_BUILTINS_ARRAYBUFFER_H

#include "ecmascript/base/builtins_base.h"
#include "ecmascript/base/number_helper.h"
#include "ecmascript/js_dataview.h"
#include "ecmascript/js_typed_array.h"

// List of functions in ArrayBuffer, excluding the '@@' properties.
// V(name, func, length, stubIndex)
// where BuiltinsArrayBuffer::func refers to the native implementation of ArrayBuffer[name].
//       kungfu::BuiltinsStubCSigns::stubIndex refers to the builtin stub index, or INVALID if no stub available.
#define BUILTIN_ARRAY_BUFFER_FUNCTIONS(V)                                           \
    /* ArrayBuffer.isView ( arg ) */                                                \
    V("isView", IsView, 1, ArrayBufferIsView)

namespace panda::ecmascript::builtins {
static constexpr double NUMBER_HALF = 0.5;
static constexpr uint32_t BITS_MASK_FF = 0xFF;
static constexpr uint32_t BITS_EIGHT = 8;
static constexpr uint32_t BITS_TWENTY_FOUR = 24;
static constexpr uint32_t BITS_FORTY = 40;
static constexpr uint32_t BITS_FIFTY_SIX = 56;
static constexpr uint32_t BITS_THIRTY_ONE = 31;
using DataViewType = ecmascript::DataViewType;
union UnionType32 {
    uint32_t uValue;
    float value;
};
union UnionType64 {
    uint64_t uValue;
    double value;
};
class BuiltinsArrayBuffer : public base::BuiltinsBase {
public:
    enum NumberSize : uint8_t {
        UINT16 = 2, INT16 = 2, UINT32 = 4, INT32 = 4, FLOAT32 = 4, FLOAT64 = 8, BIGINT64 = 8, BIGUINT64 = 8
    };

    // 24.1.2.1 ArrayBuffer(length)
    static JSTaggedValue ArrayBufferConstructor(EcmaRuntimeCallInfo *argv);
    // 24.1.3.1 ArrayBuffer.isView(arg)
    static JSTaggedValue IsView(EcmaRuntimeCallInfo *argv);
    // 24.1.3.3 get ArrayBuffer[@@species]
    static JSTaggedValue Species(EcmaRuntimeCallInfo *argv);
    // 24.1.4.1 get ArrayBuffer.prototype.byteLength
    static JSTaggedValue GetByteLength(EcmaRuntimeCallInfo *argv);
    // 24.1.4.3 ArrayBuffer.prototype.slice()
    static JSTaggedValue Slice(EcmaRuntimeCallInfo *argv);
    // 24.1.1.2 IsDetachedBuffer(arrayBuffer)
    static void IsDetachedBuffer(JSThread *thread, const JSHandle<JSTypedArray> &arrayBuffer);
    static bool IsDetachedBuffer(JSTaggedValue arrayBuffer);
    // 24.1.1.5 GetValueFromBuffer ( arrayBuffer, byteIndex, type, isLittleEndian )
    static JSTaggedValue GetValueFromBuffer(JSThread *thread, JSTaggedValue arrBuf, uint32_t byteIndex,
                                            DataViewType type, bool littleEndian);
    // 24.1.1.6 SetValueInBuffer ( arrayBuffer, byteIndex, type, value, isLittleEndian )
    static JSTaggedValue SetValueInBuffer(JSThread *thread, JSTaggedValue arrBuf, uint32_t byteIndex,
                                          DataViewType type, const JSHandle<JSTaggedValue> &value, bool littleEndian);
    // 24.1.1.4 CloneArrayBuffer( srcBuffer, srcByteOffset [, cloneConstructor] )
    static JSTaggedValue CloneArrayBuffer(JSThread *thread, const JSHandle<JSTaggedValue> &srcBuffer,
                                          uint32_t srcByteOffset, JSHandle<JSTaggedValue> constructor);
    // 24.1.1.1 AllocateArrayBuffer(constructor, byteLength)
    static JSTaggedValue AllocateArrayBuffer(JSThread *thread, const JSHandle<JSTaggedValue> &newTarget,
                                             uint64_t byteLength);
    // es12 25.1.2.6 IsUnclampedIntegerElementType ( type )
    static bool IsUnclampedIntegerElementType(DataViewType type);
    // es12 25.1.2.7 IsBigIntElementType ( type )
    static bool IsBigIntElementType(DataViewType type);

    // Excluding the '@@' internal properties
    static Span<const base::BuiltinFunctionEntry> GetArrayBufferFunctions()
    {
        return Span<const base::BuiltinFunctionEntry>(ARRAY_BUFFER_FUNCTIONS);
    }

    static JSTaggedValue FastSetValueInBuffer(JSThread* thread, JSTaggedValue arrBuf, uint32_t byteIndex,
                                              DataViewType type, double val, bool littleEndian);
    static JSTaggedValue TryFastSetValueInBuffer(JSThread *thread, JSTaggedValue arrBuf, uint32_t byteBeginOffset,
                                                 uint32_t byteEndOffset, DataViewType type,
                                                 double val, bool littleEndian);
    template<typename T>
    static void FastSetValueInBufferForByte(uint8_t *byteBeginOffset, uint8_t *byteEndOffset,
                                            double val);
    static void FastSetValueInBufferForUint8Clamped(uint8_t *byteBeginOffset, uint8_t *byteEndOffset,
                                                    double val);
    template<typename T>
    static void FastSetValueInBufferForInteger(uint8_t *byteBeginOffset, uint8_t *byteEndOffset,
                                               double val, bool littleEndian);
    template<typename T>
    static void FastSetValueInBufferForFloat(uint8_t *byteBeginOffset, uint8_t *byteEndOffset,
                                             double val, bool littleEndian);
    template<typename T>
    static void FastSetValueInBufferForBigInt(JSThread *thread, uint8_t *byteBeginOffset, uint8_t *byteEndOffset,
                                              double val, bool littleEndian);
    static JSTaggedValue SetValueInBuffer(JSThread *thread, uint32_t byteIndex, uint8_t *block,
                                          DataViewType type, double val, bool littleEndian);
    static JSTaggedValue GetValueFromBuffer(JSThread *thread, uint32_t byteIndex, uint8_t *block,
                                            DataViewType type, bool littleEndian);
    static void *GetDataPointFromBuffer(JSTaggedValue arrBuf, uint32_t byteOffset = 0);

protected:
    static constexpr uint64_t MAX_NATIVE_SIZE_LIMIT = 4_GB;
    static constexpr char const *NATIVE_SIZE_OUT_OF_LIMIT_MESSAGE = "total array buffer size out of limit(4_GB)";

private:
#define BUILTIN_ARRAY_BUFFER_ENTRY(name, func, length, id)                                                             \
    base::BuiltinFunctionEntry::Create((name), (BuiltinsArrayBuffer::func), (length), (kungfu::BuiltinsStubCSigns::id)),

    static constexpr std::array ARRAY_BUFFER_FUNCTIONS = {BUILTIN_ARRAY_BUFFER_FUNCTIONS(BUILTIN_ARRAY_BUFFER_ENTRY)};
#undef BUILTIN_ARRAY_BUFFER_ENTRY

    template <typename T>
    static T LittleEndianToBigEndian(T liValue);
    template<typename T>
    static T LittleEndianToBigEndian64Bit(T liValue);

    template<typename T>
    static void SetTypeData(uint8_t *block, T value, uint32_t index);

    template<typename T>
    static void FastSetTypeData(uint8_t *byteBeginOffset, uint8_t *byteEndOffset, T value);

    template<typename T, NumberSize size>
    static JSTaggedValue GetValueFromBufferForInteger(uint8_t *block, uint32_t byteIndex, bool littleEndian);

    template<typename T, typename UnionType, NumberSize size>
    static JSTaggedValue GetValueFromBufferForFloat(uint8_t *block, uint32_t byteIndex, bool littleEndian);
    template<typename T1, typename T2>
    static JSTaggedValue CommonConvert(T1 &value, T2 &res, bool littleEndian);
    template<typename T, NumberSize size>
    static JSTaggedValue GetValueFromBufferForBigInt(JSThread *thread, uint8_t *block,
                                                     uint32_t byteIndex, bool littleEndian);

    template<typename T>
    static void SetValueInBufferForByte(double val, uint8_t *block, uint32_t byteIndex);

    static void SetValueInBufferForUint8Clamped(double val, uint8_t *block, uint32_t byteIndex);

    template<typename T>
    static void SetValueInBufferForInteger(double val, uint8_t *block, uint32_t byteIndex, bool littleEndian);

    template<typename T>
    static void SetValueInBufferForFloat(double val, uint8_t *block, uint32_t byteIndex, bool littleEndian);

    template<typename T>
    static void SetValueInBufferForBigInt(JSThread *thread, const JSHandle<JSTaggedValue> &val,
                                          JSHandle<JSTaggedValue> &arrBuf, uint32_t byteIndex, bool littleEndian);

    template<typename T>
    static void SetValueInBufferForBigInt(JSThread *thread, double val,
                                          uint8_t *block, uint32_t byteIndex, bool littleEndian);

    static JSTaggedValue TypedArrayToList(JSThread *thread, JSHandle<JSTypedArray>& items);

    friend class BuiltinsArray;
    friend class BuiltinsSharedArray;
};
}  // namespace panda::ecmascript::builtins

#endif  // ECMASCRIPT_BUILTINS_BUILTINS_ARRAYBUFFER_H