6a7f6873ebaf65ca705af1cd88a476997ceaf93e
[WebKit.git] / Source / JavaScriptCore / runtime / IndexingHeader.h
1 /*
2  * Copyright (C) 2012, 2014 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 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 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 #pragma once
27
28 #include "PropertyStorage.h"
29
30 namespace JSC {
31
32 class ArrayBuffer;
33 class Butterfly;
34 class LLIntOffsetsExtractor;
35 class Structure;
36 struct ArrayStorage;
37
38 class IndexingHeader {
39 public:
40     // Define the maximum storage vector length to be 2^32 / sizeof(JSValue) / 2 to ensure that
41     // there is no risk of overflow.
42     enum { maximumLength = 0x10000000 };
43     
44     static ptrdiff_t offsetOfIndexingHeader() { return -static_cast<ptrdiff_t>(sizeof(IndexingHeader)); }
45     
46     static ptrdiff_t offsetOfArrayBuffer() { return OBJECT_OFFSETOF(IndexingHeader, u.typedArray.buffer); }
47     static ptrdiff_t offsetOfPublicLength() { return OBJECT_OFFSETOF(IndexingHeader, u.lengths.publicLength); }
48     static ptrdiff_t offsetOfVectorLength() { return OBJECT_OFFSETOF(IndexingHeader, u.lengths.vectorLength); }
49     
50     IndexingHeader()
51     {
52         u.lengths.publicLength = 0;
53         u.lengths.vectorLength = 0;
54     }
55     
56     uint32_t vectorLength() const { return u.lengths.vectorLength; }
57     
58     void setVectorLength(uint32_t length)
59     {
60         RELEASE_ASSERT(length <= maximumLength);
61         u.lengths.vectorLength = length;
62     }
63     
64     uint32_t publicLength() const { return u.lengths.publicLength; }
65     void setPublicLength(uint32_t auxWord) { u.lengths.publicLength = auxWord; }
66     
67     ArrayBuffer* arrayBuffer() { return u.typedArray.buffer; }
68     void setArrayBuffer(ArrayBuffer* buffer) { u.typedArray.buffer = buffer; }
69     
70     static IndexingHeader* from(Butterfly* butterfly)
71     {
72         return reinterpret_cast<IndexingHeader*>(butterfly) - 1;
73     }
74     
75     static const IndexingHeader* from(const Butterfly* butterfly)
76     {
77         return reinterpret_cast<const IndexingHeader*>(butterfly) - 1;
78     }
79     
80     static IndexingHeader* from(ArrayStorage* arrayStorage)
81     {
82         return const_cast<IndexingHeader*>(from(const_cast<const ArrayStorage*>(arrayStorage)));
83     }
84     
85     static const IndexingHeader* from(const ArrayStorage* arrayStorage)
86     {
87         return reinterpret_cast<const IndexingHeader*>(arrayStorage) - 1;
88     }
89     
90     static IndexingHeader* fromEndOf(PropertyStorage propertyStorage)
91     {
92         return reinterpret_cast<IndexingHeader*>(propertyStorage);
93     }
94     
95     PropertyStorage propertyStorage()
96     {
97         return reinterpret_cast_ptr<PropertyStorage>(this);
98     }
99     
100     ConstPropertyStorage propertyStorage() const
101     {
102         return reinterpret_cast_ptr<ConstPropertyStorage>(this);
103     }
104     
105     ArrayStorage* arrayStorage()
106     {
107         return reinterpret_cast<ArrayStorage*>(this + 1);
108     }
109     
110     Butterfly* butterfly()
111     {
112         return reinterpret_cast<Butterfly*>(this + 1);
113     }
114     
115     // These methods are not standalone in the sense that they cannot be
116     // used on a copy of the IndexingHeader.
117     size_t preCapacity(Structure*);
118     size_t indexingPayloadSizeInBytes(Structure*);
119     
120 private:
121     friend class LLIntOffsetsExtractor;
122
123     union {
124         struct {
125             uint32_t publicLength; // The meaning of this field depends on the array type, but for all JSArrays we rely on this being the publicly visible length (array.length).
126             uint32_t vectorLength; // The length of the indexed property storage. The actual size of the storage depends on this, and the type.
127         } lengths;
128         
129         struct {
130             ArrayBuffer* buffer;
131         } typedArray;
132     } u;
133 };
134
135 } // namespace JSC