https://bugs.webkit.org/show_bug.cgi?id=73503
[WebKit-https.git] / Source / JavaScriptCore / wtf / ArrayBuffer.h
1 /*
2  * Copyright (C) 2009 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ArrayBuffer_h
27 #define ArrayBuffer_h
28
29 #include <wtf/HashSet.h>
30 #include <wtf/PassRefPtr.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Vector.h>
33
34 namespace WTF {
35
36 class ArrayBuffer;
37 class ArrayBufferView;
38
39 class ArrayBufferContents {
40     WTF_MAKE_NONCOPYABLE(ArrayBufferContents);
41 public:
42     ArrayBufferContents() 
43         : m_data(0)
44         , m_sizeInBytes(0)
45     { }
46
47     inline ~ArrayBufferContents();
48
49     void* data() { return m_data; }
50     unsigned sizeInBytes() { return m_sizeInBytes; }
51
52 private:
53     ArrayBufferContents(void* data, unsigned sizeInBytes) 
54         : m_data(data)
55         , m_sizeInBytes(sizeInBytes)
56     { }
57
58     friend class ArrayBuffer;
59
60     static inline void tryAllocate(unsigned numElements, unsigned elementByteSize, ArrayBufferContents&);
61     void transfer(ArrayBufferContents& other)
62     {
63         ASSERT(!other.m_data);
64         other.m_data = m_data;
65         other.m_sizeInBytes = m_sizeInBytes;
66         m_data = 0;
67         m_sizeInBytes = 0;
68     }
69
70     void* m_data;
71     unsigned m_sizeInBytes;
72 };
73
74 class ArrayBuffer : public RefCounted<ArrayBuffer> {
75 public:
76     static inline PassRefPtr<ArrayBuffer> create(unsigned numElements, unsigned elementByteSize);
77     static inline PassRefPtr<ArrayBuffer> create(ArrayBuffer*);
78     static inline PassRefPtr<ArrayBuffer> create(const void* source, unsigned byteLength);
79     static inline PassRefPtr<ArrayBuffer> create(ArrayBufferContents&);
80
81     inline void* data();
82     inline const void* data() const;
83     inline unsigned byteLength() const;
84
85     inline PassRefPtr<ArrayBuffer> slice(int begin, int end) const;
86     inline PassRefPtr<ArrayBuffer> slice(int begin) const;
87
88     void addView(ArrayBufferView*);
89     void removeView(ArrayBufferView*);
90
91     bool transfer(ArrayBufferContents&, Vector<RefPtr<ArrayBufferView> >& neuteredViews);
92     bool isNeutered() { return !m_contents.m_data; }
93
94     ~ArrayBuffer() { }
95
96 private:
97     inline ArrayBuffer(ArrayBufferContents&);
98     inline PassRefPtr<ArrayBuffer> sliceImpl(unsigned begin, unsigned end) const;
99     inline unsigned clampIndex(int index) const;
100     static inline int clampValue(int x, int left, int right);
101
102     ArrayBufferContents m_contents;
103     ArrayBufferView* m_firstView;
104 };
105
106 int ArrayBuffer::clampValue(int x, int left, int right)
107 {
108     ASSERT(left <= right);
109     if (x < left)
110         x = left;
111     if (right < x)
112         x = right;
113     return x;
114 }
115
116 PassRefPtr<ArrayBuffer> ArrayBuffer::create(unsigned numElements, unsigned elementByteSize)
117 {
118     ArrayBufferContents contents;
119     ArrayBufferContents::tryAllocate(numElements, elementByteSize, contents);
120     if (!contents.m_data)
121         return 0;
122     return adoptRef(new ArrayBuffer(contents));
123 }
124
125 PassRefPtr<ArrayBuffer> ArrayBuffer::create(ArrayBuffer* other)
126 {
127     return ArrayBuffer::create(other->data(), other->byteLength());
128 }
129
130 PassRefPtr<ArrayBuffer> ArrayBuffer::create(const void* source, unsigned byteLength)
131 {
132     ArrayBufferContents contents;
133     ArrayBufferContents::tryAllocate(byteLength, 1, contents);
134     if (!contents.m_data)
135         return 0;
136     RefPtr<ArrayBuffer> buffer = adoptRef(new ArrayBuffer(contents));
137     memcpy(buffer->data(), source, byteLength);
138     return buffer.release();
139 }
140
141 PassRefPtr<ArrayBuffer> ArrayBuffer::create(ArrayBufferContents& contents)
142 {
143     return adoptRef(new ArrayBuffer(contents));
144 }
145
146 ArrayBuffer::ArrayBuffer(ArrayBufferContents& contents)
147     : m_firstView(0)
148 {
149     contents.transfer(m_contents);
150 }
151
152 void* ArrayBuffer::data()
153 {
154     return m_contents.m_data;
155 }
156
157 const void* ArrayBuffer::data() const
158 {
159     return m_contents.m_data;
160 }
161
162 unsigned ArrayBuffer::byteLength() const
163 {
164     return m_contents.m_sizeInBytes;
165 }
166
167 PassRefPtr<ArrayBuffer> ArrayBuffer::slice(int begin, int end) const
168 {
169     return sliceImpl(clampIndex(begin), clampIndex(end));
170 }
171
172 PassRefPtr<ArrayBuffer> ArrayBuffer::slice(int begin) const
173 {
174     return sliceImpl(clampIndex(begin), byteLength());
175 }
176
177 PassRefPtr<ArrayBuffer> ArrayBuffer::sliceImpl(unsigned begin, unsigned end) const
178 {
179     unsigned size = begin <= end ? end - begin : 0;
180     return ArrayBuffer::create(static_cast<const char*>(data()) + begin, size);
181 }
182
183 unsigned ArrayBuffer::clampIndex(int index) const
184 {
185     unsigned currentLength = byteLength();
186     if (index < 0)
187         index = currentLength + index;
188     return clampValue(index, 0, currentLength);
189 }
190
191 void ArrayBufferContents::tryAllocate(unsigned numElements, unsigned elementByteSize, ArrayBufferContents& result)
192 {
193     // Do not allow 32-bit overflow of the total size.
194     // FIXME: Why not? The tryFastCalloc function already checks its arguments,
195     // and will fail if there is any overflow, so why should we include a
196     // redudant unnecessarily restrictive check here?
197     if (numElements) {
198         unsigned totalSize = numElements * elementByteSize;
199         if (totalSize / numElements != elementByteSize) {
200             result.m_data = 0;
201             return;
202         }
203     }
204     if (WTF::tryFastCalloc(numElements, elementByteSize).getValue(result.m_data)) {
205         result.m_sizeInBytes = numElements * elementByteSize;
206         return;
207     }
208     result.m_data = 0;
209 }
210
211 ArrayBufferContents::~ArrayBufferContents()
212 {
213     WTF::fastFree(m_data);
214 }
215
216 } // namespace WTF
217
218 using WTF::ArrayBuffer;
219
220 #endif // ArrayBuffer_h