Foo::s_info should be Foo::info(), so that you can change how the s_info is actually...
[WebKit-https.git] / Source / JavaScriptCore / runtime / StructureInlines.h
1 /*
2  * Copyright (C) 2013 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 StructureInlines_h
27 #define StructureInlines_h
28
29 #include "PropertyMapHashTable.h"
30 #include "Structure.h"
31
32 namespace JSC {
33
34 inline Structure* Structure::create(VM& vm, JSGlobalObject* globalObject, JSValue prototype, const TypeInfo& typeInfo, const ClassInfo* classInfo, IndexingType indexingType, unsigned inlineCapacity)
35 {
36     ASSERT(vm.structureStructure);
37     ASSERT(classInfo);
38     Structure* structure = new (NotNull, allocateCell<Structure>(vm.heap)) Structure(vm, globalObject, prototype, typeInfo, classInfo, indexingType, inlineCapacity);
39     structure->finishCreation(vm);
40     return structure;
41 }
42
43 inline Structure* Structure::createStructure(VM& vm)
44 {
45     ASSERT(!vm.structureStructure);
46     Structure* structure = new (NotNull, allocateCell<Structure>(vm.heap)) Structure(vm);
47     structure->finishCreation(vm, CreatingEarlyCell);
48     return structure;
49 }
50
51 inline Structure* Structure::create(VM& vm, const Structure* structure)
52 {
53     ASSERT(vm.structureStructure);
54     Structure* newStructure = new (NotNull, allocateCell<Structure>(vm.heap)) Structure(vm, structure);
55     newStructure->finishCreation(vm);
56     return newStructure;
57 }
58
59 inline JSObject* Structure::storedPrototypeObject() const
60 {
61     JSValue value = m_prototype.get();
62     if (value.isNull())
63         return 0;
64     return asObject(value);
65 }
66
67 inline Structure* Structure::storedPrototypeStructure() const
68 {
69     JSObject* object = storedPrototypeObject();
70     if (!object)
71         return 0;
72     return object->structure();
73 }
74
75 inline PropertyOffset Structure::get(VM& vm, PropertyName propertyName)
76 {
77     ASSERT(!isCompilationThread());
78     ASSERT(structure()->classInfo() == info());
79     materializePropertyMapIfNecessary(vm);
80     if (!propertyTable())
81         return invalidOffset;
82
83     PropertyMapEntry* entry = propertyTable()->find(propertyName.uid()).first;
84     return entry ? entry->offset : invalidOffset;
85 }
86
87 inline PropertyOffset Structure::get(VM& vm, const WTF::String& name)
88 {
89     ASSERT(!isCompilationThread());
90     ASSERT(structure()->classInfo() == info());
91     materializePropertyMapIfNecessary(vm);
92     if (!propertyTable())
93         return invalidOffset;
94
95     PropertyMapEntry* entry = propertyTable()->findWithString(name.impl()).first;
96     return entry ? entry->offset : invalidOffset;
97 }
98     
99 inline PropertyOffset Structure::getConcurrently(VM& vm, StringImpl* uid)
100 {
101     unsigned attributesIgnored;
102     JSCell* specificValueIgnored;
103     return getConcurrently(
104         vm, uid, attributesIgnored, specificValueIgnored);
105 }
106
107 inline bool Structure::masqueradesAsUndefined(JSGlobalObject* lexicalGlobalObject)
108 {
109     return typeInfo().masqueradesAsUndefined() && globalObject() == lexicalGlobalObject;
110 }
111
112 inline bool Structure::transitivelyTransitionedFrom(Structure* structureToFind)
113 {
114     for (Structure* current = this; current; current = current->previousID()) {
115         if (current == structureToFind)
116             return true;
117     }
118     return false;
119 }
120
121 inline void Structure::setEnumerationCache(VM& vm, JSPropertyNameIterator* enumerationCache)
122 {
123     ASSERT(!isDictionary());
124     if (!typeInfo().structureHasRareData())
125         allocateRareData(vm);
126     rareData()->setEnumerationCache(vm, this, enumerationCache);
127 }
128
129 inline JSPropertyNameIterator* Structure::enumerationCache()
130 {
131     if (!typeInfo().structureHasRareData())
132         return 0;
133     return rareData()->enumerationCache();
134 }
135
136 inline JSValue Structure::prototypeForLookup(JSGlobalObject* globalObject) const
137 {
138     if (isObject())
139         return m_prototype.get();
140
141     ASSERT(typeInfo().type() == StringType);
142     return globalObject->stringPrototype();
143 }
144
145 inline JSValue Structure::prototypeForLookup(ExecState* exec) const
146 {
147     return prototypeForLookup(exec->lexicalGlobalObject());
148 }
149
150 inline StructureChain* Structure::prototypeChain(VM& vm, JSGlobalObject* globalObject) const
151 {
152     // We cache our prototype chain so our clients can share it.
153     if (!isValid(globalObject, m_cachedPrototypeChain.get())) {
154         JSValue prototype = prototypeForLookup(globalObject);
155         m_cachedPrototypeChain.set(vm, this, StructureChain::create(vm, prototype.isNull() ? 0 : asObject(prototype)->structure()));
156     }
157     return m_cachedPrototypeChain.get();
158 }
159
160 inline StructureChain* Structure::prototypeChain(ExecState* exec) const
161 {
162     return prototypeChain(exec->vm(), exec->lexicalGlobalObject());
163 }
164
165 inline bool Structure::isValid(JSGlobalObject* globalObject, StructureChain* cachedPrototypeChain) const
166 {
167     if (!cachedPrototypeChain)
168         return false;
169
170     JSValue prototype = prototypeForLookup(globalObject);
171     WriteBarrier<Structure>* cachedStructure = cachedPrototypeChain->head();
172     while (*cachedStructure && !prototype.isNull()) {
173         if (asObject(prototype)->structure() != cachedStructure->get())
174             return false;
175         ++cachedStructure;
176         prototype = asObject(prototype)->prototype();
177     }
178     return prototype.isNull() && !*cachedStructure;
179 }
180
181 inline bool Structure::isValid(ExecState* exec, StructureChain* cachedPrototypeChain) const
182 {
183     return isValid(exec->lexicalGlobalObject(), cachedPrototypeChain);
184 }
185
186 inline bool Structure::putWillGrowOutOfLineStorage()
187 {
188     checkOffsetConsistency();
189
190     ASSERT(outOfLineCapacity() >= outOfLineSize());
191
192     if (!propertyTable()) {
193         unsigned currentSize = numberOfOutOfLineSlotsForLastOffset(m_offset);
194         ASSERT(outOfLineCapacity() >= currentSize);
195         return currentSize == outOfLineCapacity();
196     }
197
198     ASSERT(totalStorageCapacity() >= propertyTable()->propertyStorageSize());
199     if (propertyTable()->hasDeletedOffset())
200         return false;
201
202     ASSERT(totalStorageCapacity() >= propertyTable()->size());
203     return propertyTable()->size() == totalStorageCapacity();
204 }
205
206 ALWAYS_INLINE WriteBarrier<PropertyTable>& Structure::propertyTable()
207 {
208     ASSERT(!globalObject() || !globalObject()->vm().heap.isCollecting());
209     return m_propertyTableUnsafe;
210 }
211
212 ALWAYS_INLINE bool Structure::checkOffsetConsistency() const
213 {
214     PropertyTable* propertyTable = m_propertyTableUnsafe.get();
215
216     if (!propertyTable) {
217         ASSERT(!m_isPinnedPropertyTable);
218         return true;
219     }
220
221     RELEASE_ASSERT(numberOfSlotsForLastOffset(m_offset, m_inlineCapacity) == propertyTable->propertyStorageSize());
222     unsigned totalSize = propertyTable->propertyStorageSize();
223     RELEASE_ASSERT((totalSize < inlineCapacity() ? 0 : totalSize - inlineCapacity()) == numberOfOutOfLineSlotsForLastOffset(m_offset));
224
225     return true;
226 }
227
228 } // namespace JSC
229
230 #endif // StructureInlines_h
231