4196aa86f4529e5f21c4c90f3b809d458dcac446
[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<ArrayBufferView*>& neuteredViews);
92
93     ~ArrayBuffer() { }
94
95 private:
96     inline ArrayBuffer(ArrayBufferContents&);
97     inline PassRefPtr<ArrayBuffer> sliceImpl(unsigned begin, unsigned end) const;
98     inline unsigned clampIndex(int index) const;
99     static inline int clampValue(int x, int left, int right);
100
101     ArrayBufferContents m_contents;
102     ArrayBufferView* m_firstView;
103 };
104
105 int ArrayBuffer::clampValue(int x, int left, int right)
106 {
107     ASSERT(left <= right);
108     if (x < left)
109         x = left;
110     if (right < x)
111         x = right;
112     return x;
113 }
114
115 PassRefPtr<ArrayBuffer> ArrayBuffer::create(unsigned numElements, unsigned elementByteSize)
116 {
117     ArrayBufferContents contents;
118     ArrayBufferContents::tryAllocate(numElements, elementByteSize, contents);
119     if (!contents.m_data)
120         return 0;
121     return adoptRef(new ArrayBuffer(contents));
122 }
123
124 PassRefPtr<ArrayBuffer> ArrayBuffer::create(ArrayBuffer* other)
125 {
126     return ArrayBuffer::create(other->data(), other->byteLength());
127 }
128
129 PassRefPtr<ArrayBuffer> ArrayBuffer::create(const void* source, unsigned byteLength)
130 {
131     ArrayBufferContents contents;
132     ArrayBufferContents::tryAllocate(byteLength, 1, contents);
133     if (!contents.m_data)
134         return 0;
135     RefPtr<ArrayBuffer> buffer = adoptRef(new ArrayBuffer(contents));
136     memcpy(buffer->data(), source, byteLength);
137     return buffer.release();
138 }
139
140 PassRefPtr<ArrayBuffer> ArrayBuffer::create(ArrayBufferContents& contents)
141 {
142     return adoptRef(new ArrayBuffer(contents));
143 }
144
145 ArrayBuffer::ArrayBuffer(ArrayBufferContents& contents)
146     : m_firstView(0)
147 {
148     contents.transfer(m_contents);
149 }
150
151 void* ArrayBuffer::data()
152 {
153     return m_contents.m_data;
154 }
155
156 const void* ArrayBuffer::data() const
157 {
158     return m_contents.m_data;
159 }
160
161 unsigned ArrayBuffer::byteLength() const
162 {
163     return m_contents.m_sizeInBytes;
164 }
165
166 PassRefPtr<ArrayBuffer> ArrayBuffer::slice(int begin, int end) const
167 {
168     return sliceImpl(clampIndex(begin), clampIndex(end));
169 }
170
171 PassRefPtr<ArrayBuffer> ArrayBuffer::slice(int begin) const
172 {
173     return sliceImpl(clampIndex(begin), byteLength());
174 }
175
176 PassRefPtr<ArrayBuffer> ArrayBuffer::sliceImpl(unsigned begin, unsigned end) const
177 {
178     unsigned size = begin <= end ? end - begin : 0;
179     return ArrayBuffer::create(static_cast<const char*>(data()) + begin, size);
180 }
181
182 unsigned ArrayBuffer::clampIndex(int index) const
183 {
184     unsigned currentLength = byteLength();
185     if (index < 0)
186         index = currentLength + index;
187     return clampValue(index, 0, currentLength);
188 }
189
190 void ArrayBufferContents::tryAllocate(unsigned numElements, unsigned elementByteSize, ArrayBufferContents& result)
191 {
192     // Do not allow 32-bit overflow of the total size.
193     // FIXME: Why not? The tryFastCalloc function already checks its arguments,
194     // and will fail if there is any overflow, so why should we include a
195     // redudant unnecessarily restrictive check here?
196     if (numElements) {
197         unsigned totalSize = numElements * elementByteSize;
198         if (totalSize / numElements != elementByteSize) {
199             result.m_data = 0;
200             return;
201         }
202     }
203     if (WTF::tryFastCalloc(numElements, elementByteSize).getValue(result.m_data)) {
204         result.m_sizeInBytes = numElements * elementByteSize;
205         return;
206     }
207     result.m_data = 0;
208 }
209
210 ArrayBufferContents::~ArrayBufferContents()
211 {
212     WTF::fastFree(m_data);
213 }
214
215 } // namespace WTF
216
217 using WTF::ArrayBuffer;
218
219 #endif // ArrayBuffer_h