ArrayBufferView.h 6.6 KB
Newer Older
1
/*
2
 * Copyright (C) 2009, 2013 Apple Inc. All rights reserved.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */

26 27
#ifndef ArrayBufferView_h
#define ArrayBufferView_h
28

29
#include "ArrayBuffer.h"
30
#include "TypedArrayType.h"
31
#include <algorithm>
32
#include <limits.h>
33 34 35 36
#include <wtf/PassRefPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>

37
namespace JSC {
38

39 40 41 42
class JSArrayBufferView;
class JSGlobalObject;
class ExecState;

akling@apple.com's avatar
akling@apple.com committed
43
class ArrayBufferView : public RefCounted<ArrayBufferView> {
44
public:
45
    virtual TypedArrayType getType() const = 0;
46

47 48 49 50 51
    bool isNeutered() const
    {
        return !m_buffer || m_buffer->isNeutered();
    }
    
52
    PassRefPtr<ArrayBuffer> buffer() const
53
    {
54 55
        if (isNeutered())
            return 0;
56 57 58
        return m_buffer;
    }

59 60
    void* baseAddress() const
    {
61 62
        if (isNeutered())
            return 0;
63 64 65
        return m_baseAddress;
    }

66 67
    unsigned byteOffset() const
    {
68 69
        if (isNeutered())
            return 0;
70 71 72 73 74
        return m_byteOffset;
    }

    virtual unsigned byteLength() const = 0;

75
    JS_EXPORT_PRIVATE void setNeuterable(bool flag);
76 77
    bool isNeuterable() const { return m_isNeuterable; }

78
    JS_EXPORT_PRIVATE virtual ~ArrayBufferView();
79

80 81
    // Helper to verify that a given sub-range of an ArrayBuffer is
    // within range.
82 83
    // FIXME: This should distinguish between alignment errors and bounds errors.
    // https://bugs.webkit.org/show_bug.cgi?id=125391
84
    template <typename T>
85 86 87 88
    static bool verifySubRange(
        PassRefPtr<ArrayBuffer> buffer,
        unsigned byteOffset,
        unsigned numElements)
89
    {
90
        unsigned byteLength = buffer->byteLength();
91 92
        if (sizeof(T) > 1 && byteOffset % sizeof(T))
            return false;
93
        if (byteOffset > byteLength)
94
            return false;
95
        unsigned remainingElements = (byteLength - byteOffset) / sizeof(T);
96 97 98 99
        if (numElements > remainingElements)
            return false;
        return true;
    }
100 101 102 103
    
    virtual JSArrayBufferView* wrap(ExecState*, JSGlobalObject*) = 0;
    
protected:
104
    JS_EXPORT_PRIVATE ArrayBufferView(PassRefPtr<ArrayBuffer>, unsigned byteOffset);
105 106 107 108 109 110 111 112 113 114

    inline bool setImpl(ArrayBufferView*, unsigned byteOffset);

    inline bool setRangeImpl(const char* data, size_t dataByteLength, unsigned byteOffset);

    inline bool zeroRangeImpl(unsigned byteOffset, size_t rangeByteLength);

    static inline void calculateOffsetAndLength(
        int start, int end, unsigned arraySize,
        unsigned* offset, unsigned* length);
115

116 117
    // Input offset is in number of elements from this array's view;
    // output offset is in number of bytes from the underlying buffer's view.
118
    template <typename T>
119 120 121 122 123
    static void clampOffsetAndNumElements(
        PassRefPtr<ArrayBuffer> buffer,
        unsigned arrayByteOffset,
        unsigned *offset,
        unsigned *numElements)
124
    {
125 126 127 128 129 130 131 132 133
        unsigned maxOffset = (UINT_MAX - arrayByteOffset) / sizeof(T);
        if (*offset > maxOffset) {
            *offset = buffer->byteLength();
            *numElements = 0;
            return;
        }
        *offset = arrayByteOffset + *offset * sizeof(T);
        *offset = std::min(buffer->byteLength(), *offset);
        unsigned remainingElements = (buffer->byteLength() - *offset) / sizeof(T);
134 135 136
        *numElements = std::min(remainingElements, *numElements);
    }

137
    // This is the address of the ArrayBuffer's storage, plus the byte offset.
138 139
    void* m_baseAddress;

140 141
    unsigned m_byteOffset : 31;
    bool m_isNeuterable : 1;
142

143
private:
144
    friend class ArrayBuffer;
145
    RefPtr<ArrayBuffer> m_buffer;
146 147
};

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
bool ArrayBufferView::setImpl(ArrayBufferView* array, unsigned byteOffset)
{
    if (byteOffset > byteLength()
        || byteOffset + array->byteLength() > byteLength()
        || byteOffset + array->byteLength() < byteOffset) {
        // Out of range offset or overflow
        return false;
    }
    
    char* base = static_cast<char*>(baseAddress());
    memmove(base + byteOffset, array->baseAddress(), array->byteLength());
    return true;
}

bool ArrayBufferView::setRangeImpl(const char* data, size_t dataByteLength, unsigned byteOffset)
{
    if (byteOffset > byteLength()
        || byteOffset + dataByteLength > byteLength()
        || byteOffset + dataByteLength < byteOffset) {
        // Out of range offset or overflow
        return false;
    }
    
    char* base = static_cast<char*>(baseAddress());
    memmove(base + byteOffset, data, dataByteLength);
    return true;
}

bool ArrayBufferView::zeroRangeImpl(unsigned byteOffset, size_t rangeByteLength)
{
    if (byteOffset > byteLength()
        || byteOffset + rangeByteLength > byteLength()
        || byteOffset + rangeByteLength < byteOffset) {
        // Out of range offset or overflow
        return false;
    }
    
    char* base = static_cast<char*>(baseAddress());
    memset(base + byteOffset, 0, rangeByteLength);
    return true;
}

190 191
void ArrayBufferView::calculateOffsetAndLength(
    int start, int end, unsigned arraySize, unsigned* offset, unsigned* length)
192 193 194 195 196 197 198 199 200
{
    if (start < 0)
        start += arraySize;
    if (start < 0)
        start = 0;
    if (end < 0)
        end += arraySize;
    if (end < 0)
        end = 0;
201 202
    if (static_cast<unsigned>(end) > arraySize)
        end = arraySize;
203 204 205 206 207 208
    if (end < start)
        end = start;
    *offset = static_cast<unsigned>(start);
    *length = static_cast<unsigned>(end - start);
}

209
} // namespace JSC
210

211
using JSC::ArrayBufferView;
212

213
#endif // ArrayBufferView_h