Objective-C API: Rename JSValue.h/APIJSValue.h to JSCJSValue.h/JSValue.h
[WebKit-https.git] / Source / JavaScriptCore / runtime / Structure.h
1 /*
2  * Copyright (C) 2008, 2009, 2012 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 Structure_h
27 #define Structure_h
28
29 #include "ClassInfo.h"
30 #include "IndexingType.h"
31 #include "JSCJSValue.h"
32 #include "JSCell.h"
33 #include "JSType.h"
34 #include "PropertyMapHashTable.h"
35 #include "PropertyName.h"
36 #include "PropertyNameArray.h"
37 #include "Protect.h"
38 #include "StructureTransitionTable.h"
39 #include "JSTypeInfo.h"
40 #include "Watchpoint.h"
41 #include "Weak.h"
42 #include <wtf/PassOwnPtr.h>
43 #include <wtf/PassRefPtr.h>
44 #include <wtf/RefCounted.h>
45 #include <wtf/text/StringImpl.h>
46
47
48 namespace JSC {
49
50     class LLIntOffsetsExtractor;
51     class PropertyNameArray;
52     class PropertyNameArrayData;
53     class StructureChain;
54     class SlotVisitor;
55     class JSString;
56
57     // The out-of-line property storage capacity to use when first allocating out-of-line
58     // storage. Note that all objects start out without having any out-of-line storage;
59     // this comes into play only on the first property store that exhausts inline storage.
60     static const unsigned initialOutOfLineCapacity = 4;
61
62     // The factor by which to grow out-of-line storage when it is exhausted, after the
63     // initial allocation.
64     static const unsigned outOfLineGrowthFactor = 2;
65
66     class Structure : public JSCell {
67     public:
68         friend class StructureTransitionTable;
69
70         typedef JSCell Base;
71
72         static Structure* create(JSGlobalData&, JSGlobalObject*, JSValue prototype, const TypeInfo&, const ClassInfo*, IndexingType = NonArray, PropertyOffset inlineCapacity = 0);
73
74     protected:
75         void finishCreation(JSGlobalData& globalData)
76         {
77             Base::finishCreation(globalData);
78             ASSERT(m_prototype);
79             ASSERT(m_prototype.isObject() || m_prototype.isNull());
80         }
81
82         void finishCreation(JSGlobalData& globalData, CreatingEarlyCellTag)
83         {
84             Base::finishCreation(globalData, this, CreatingEarlyCell);
85             ASSERT(m_prototype);
86             ASSERT(m_prototype.isNull());
87             ASSERT(!globalData.structureStructure);
88         }
89
90     public:
91         static void dumpStatistics();
92
93         JS_EXPORT_PRIVATE static Structure* addPropertyTransition(JSGlobalData&, Structure*, PropertyName, unsigned attributes, JSCell* specificValue, PropertyOffset&);
94         JS_EXPORT_PRIVATE static Structure* addPropertyTransitionToExistingStructure(Structure*, PropertyName, unsigned attributes, JSCell* specificValue, PropertyOffset&);
95         static Structure* removePropertyTransition(JSGlobalData&, Structure*, PropertyName, PropertyOffset&);
96         JS_EXPORT_PRIVATE static Structure* changePrototypeTransition(JSGlobalData&, Structure*, JSValue prototype);
97         JS_EXPORT_PRIVATE static Structure* despecifyFunctionTransition(JSGlobalData&, Structure*, PropertyName);
98         static Structure* attributeChangeTransition(JSGlobalData&, Structure*, PropertyName, unsigned attributes);
99         static Structure* toCacheableDictionaryTransition(JSGlobalData&, Structure*);
100         static Structure* toUncacheableDictionaryTransition(JSGlobalData&, Structure*);
101         static Structure* sealTransition(JSGlobalData&, Structure*);
102         static Structure* freezeTransition(JSGlobalData&, Structure*);
103         static Structure* preventExtensionsTransition(JSGlobalData&, Structure*);
104         static Structure* nonPropertyTransition(JSGlobalData&, Structure*, NonPropertyTransition);
105
106         bool isSealed(JSGlobalData&);
107         bool isFrozen(JSGlobalData&);
108         bool isExtensible() const { return !m_preventExtensions; }
109         bool didTransition() const { return m_didTransition; }
110         bool putWillGrowOutOfLineStorage()
111         {
112             ASSERT(outOfLineCapacity() >= outOfLineSize());
113             
114             if (!m_propertyTable) {
115                 unsigned currentSize = numberOfOutOfLineSlotsForLastOffset(m_offset);
116                 ASSERT(outOfLineCapacity() >= currentSize);
117                 return currentSize == outOfLineCapacity();
118             }
119             
120             ASSERT(totalStorageCapacity() >= m_propertyTable->propertyStorageSize());
121             if (m_propertyTable->hasDeletedOffset())
122                 return false;
123             
124             ASSERT(totalStorageCapacity() >= m_propertyTable->size());
125             return m_propertyTable->size() == totalStorageCapacity();
126         }
127         JS_EXPORT_PRIVATE size_t suggestedNewOutOfLineStorageCapacity(); 
128
129         Structure* flattenDictionaryStructure(JSGlobalData&, JSObject*);
130
131         static const bool needsDestruction = true;
132         static const bool hasImmortalStructure = true;
133         static void destroy(JSCell*);
134
135         // These should be used with caution.  
136         JS_EXPORT_PRIVATE PropertyOffset addPropertyWithoutTransition(JSGlobalData&, PropertyName, unsigned attributes, JSCell* specificValue);
137         PropertyOffset removePropertyWithoutTransition(JSGlobalData&, PropertyName);
138         void setPrototypeWithoutTransition(JSGlobalData& globalData, JSValue prototype) { m_prototype.set(globalData, this, prototype); }
139         
140         bool isDictionary() const { return m_dictionaryKind != NoneDictionaryKind; }
141         bool isUncacheableDictionary() const { return m_dictionaryKind == UncachedDictionaryKind; }
142
143         bool propertyAccessesAreCacheable() { return m_dictionaryKind != UncachedDictionaryKind && !typeInfo().prohibitsPropertyCaching(); }
144
145         // Type accessors.
146         const TypeInfo& typeInfo() const { ASSERT(structure()->classInfo() == &s_info); return m_typeInfo; }
147         bool isObject() const { return typeInfo().isObject(); }
148
149         IndexingType indexingType() const { return m_indexingType & AllArrayTypes; }
150         IndexingType indexingTypeIncludingHistory() const { return m_indexingType; }
151         
152         bool mayInterceptIndexedAccesses() const
153         {
154             return !!(indexingTypeIncludingHistory() & MayHaveIndexedAccessors);
155         }
156         
157         bool anyObjectInChainMayInterceptIndexedAccesses() const;
158         
159         bool needsSlowPutIndexing() const;
160         NonPropertyTransition suggestedArrayStorageTransition() const;
161         
162         JSGlobalObject* globalObject() const { return m_globalObject.get(); }
163         void setGlobalObject(JSGlobalData& globalData, JSGlobalObject* globalObject) { m_globalObject.set(globalData, this, globalObject); }
164         
165         JSValue storedPrototype() const { return m_prototype.get(); }
166         JSValue prototypeForLookup(ExecState*) const;
167         JSValue prototypeForLookup(JSGlobalObject*) const;
168         JSValue prototypeForLookup(CodeBlock*) const;
169         StructureChain* prototypeChain(JSGlobalData&, JSGlobalObject*) const;
170         StructureChain* prototypeChain(ExecState*) const;
171         static void visitChildren(JSCell*, SlotVisitor&);
172         
173         // Will just the prototype chain intercept this property access?
174         bool prototypeChainMayInterceptStoreTo(JSGlobalData&, PropertyName);
175         
176         bool transitionDidInvolveSpecificValue() const { return !!m_specificValueInPrevious; }
177         
178         Structure* previousID() const
179         {
180             ASSERT(structure()->classInfo() == &s_info);
181             return m_previous.get();
182         }
183         bool transitivelyTransitionedFrom(Structure* structureToFind);
184
185         void growOutOfLineCapacity();
186         unsigned outOfLineCapacity() const
187         {
188             ASSERT(structure()->classInfo() == &s_info);
189             return m_outOfLineCapacity;
190         }
191         unsigned outOfLineSize() const
192         {
193             ASSERT(structure()->classInfo() == &s_info);
194             if (m_propertyTable) {
195                 unsigned totalSize = m_propertyTable->propertyStorageSize();
196                 unsigned inlineCapacity = this->inlineCapacity();
197                 if (totalSize < inlineCapacity)
198                     return 0;
199                 return totalSize - inlineCapacity;
200             }
201             return numberOfOutOfLineSlotsForLastOffset(m_offset);
202         }
203         bool hasInlineStorage() const
204         {
205             return !!m_inlineCapacity;
206         }
207         unsigned inlineCapacity() const
208         {
209             return m_inlineCapacity;
210         }
211         unsigned inlineSize() const
212         {
213             unsigned result;
214             if (m_propertyTable)
215                 result = m_propertyTable->propertyStorageSize();
216             else
217                 result = m_offset + 1;
218             return std::min<unsigned>(result, m_inlineCapacity);
219         }
220         unsigned totalStorageSize() const
221         {
222             if (m_propertyTable)
223                 return m_propertyTable->propertyStorageSize();
224             return numberOfSlotsForLastOffset(m_offset, m_typeInfo.type());
225         }
226         unsigned totalStorageCapacity() const
227         {
228             ASSERT(structure()->classInfo() == &s_info);
229             return m_outOfLineCapacity + inlineCapacity();
230         }
231
232         PropertyOffset firstValidOffset() const
233         {
234             if (hasInlineStorage())
235                 return 0;
236             return firstOutOfLineOffset;
237         }
238         PropertyOffset lastValidOffset() const
239         {
240             if (m_propertyTable)
241                 return offsetForPropertyNumber(m_propertyTable->propertyStorageSize() - 1, m_inlineCapacity);
242             return m_offset;
243         }
244         bool isValidOffset(PropertyOffset offset) const
245         {
246             return offset >= firstValidOffset()
247                 && offset <= lastValidOffset();
248         }
249
250         bool masqueradesAsUndefined(JSGlobalObject* lexicalGlobalObject);
251
252         PropertyOffset get(JSGlobalData&, PropertyName);
253         PropertyOffset get(JSGlobalData&, const WTF::String& name);
254         JS_EXPORT_PRIVATE PropertyOffset get(JSGlobalData&, PropertyName, unsigned& attributes, JSCell*& specificValue);
255
256         bool hasGetterSetterProperties() const { return m_hasGetterSetterProperties; }
257         bool hasReadOnlyOrGetterSetterPropertiesExcludingProto() const { return m_hasReadOnlyOrGetterSetterPropertiesExcludingProto; }
258         void setHasGetterSetterProperties(bool is__proto__)
259         {
260             m_hasGetterSetterProperties = true;
261             if (!is__proto__)
262                 m_hasReadOnlyOrGetterSetterPropertiesExcludingProto = true;
263         }
264         void setContainsReadOnlyProperties()
265         {
266             m_hasReadOnlyOrGetterSetterPropertiesExcludingProto = true;
267         }
268
269         bool hasNonEnumerableProperties() const { return m_hasNonEnumerableProperties; }
270         
271         bool isEmpty() const
272         {
273             if (m_propertyTable)
274                 return m_propertyTable->isEmpty();
275             return !JSC::isValidOffset(m_offset);
276         }
277
278         JS_EXPORT_PRIVATE void despecifyDictionaryFunction(JSGlobalData&, PropertyName);
279         void disableSpecificFunctionTracking() { m_specificFunctionThrashCount = maxSpecificFunctionThrashCount; }
280
281         void setEnumerationCache(JSGlobalData&, JSPropertyNameIterator* enumerationCache); // Defined in JSPropertyNameIterator.h.
282         JSPropertyNameIterator* enumerationCache(); // Defined in JSPropertyNameIterator.h.
283         void getPropertyNamesFromStructure(JSGlobalData&, PropertyNameArray&, EnumerationMode);
284
285         JSString* objectToStringValue() { return m_objectToStringValue.get(); }
286
287         void setObjectToStringValue(JSGlobalData& globalData, const JSCell* owner, JSString* value)
288         {
289             m_objectToStringValue.set(globalData, owner, value);
290         }
291
292         bool staticFunctionsReified()
293         {
294             return m_staticFunctionReified;
295         }
296
297         void setStaticFunctionsReified()
298         {
299             m_staticFunctionReified = true;
300         }
301
302         const ClassInfo* classInfo() const { return m_classInfo; }
303
304         static ptrdiff_t prototypeOffset()
305         {
306             return OBJECT_OFFSETOF(Structure, m_prototype);
307         }
308
309         static ptrdiff_t globalObjectOffset()
310         {
311             return OBJECT_OFFSETOF(Structure, m_globalObject);
312         }
313
314         static ptrdiff_t typeInfoFlagsOffset()
315         {
316             return OBJECT_OFFSETOF(Structure, m_typeInfo) + TypeInfo::flagsOffset();
317         }
318
319         static ptrdiff_t typeInfoTypeOffset()
320         {
321             return OBJECT_OFFSETOF(Structure, m_typeInfo) + TypeInfo::typeOffset();
322         }
323         
324         static ptrdiff_t classInfoOffset()
325         {
326             return OBJECT_OFFSETOF(Structure, m_classInfo);
327         }
328         
329         static ptrdiff_t indexingTypeOffset()
330         {
331             return OBJECT_OFFSETOF(Structure, m_indexingType);
332         }
333
334         static Structure* createStructure(JSGlobalData&);
335         
336         bool transitionWatchpointSetHasBeenInvalidated() const
337         {
338             return m_transitionWatchpointSet.hasBeenInvalidated();
339         }
340         
341         bool transitionWatchpointSetIsStillValid() const
342         {
343             return m_transitionWatchpointSet.isStillValid();
344         }
345         
346         void addTransitionWatchpoint(Watchpoint* watchpoint) const
347         {
348             ASSERT(transitionWatchpointSetIsStillValid());
349             m_transitionWatchpointSet.add(watchpoint);
350         }
351         
352         void notifyTransitionFromThisStructure() const
353         {
354             m_transitionWatchpointSet.notifyWrite();
355         }
356         
357         static JS_EXPORTDATA const ClassInfo s_info;
358
359     private:
360         friend class LLIntOffsetsExtractor;
361
362         JS_EXPORT_PRIVATE Structure(JSGlobalData&, JSGlobalObject*, JSValue prototype, const TypeInfo&, const ClassInfo*, IndexingType, PropertyOffset inlineCapacity);
363         Structure(JSGlobalData&);
364         Structure(JSGlobalData&, const Structure*);
365
366         static Structure* create(JSGlobalData&, const Structure*);
367         
368         typedef enum { 
369             NoneDictionaryKind = 0,
370             CachedDictionaryKind = 1,
371             UncachedDictionaryKind = 2
372         } DictionaryKind;
373         static Structure* toDictionaryTransition(JSGlobalData&, Structure*, DictionaryKind);
374
375         PropertyOffset putSpecificValue(JSGlobalData&, PropertyName, unsigned attributes, JSCell* specificValue);
376         PropertyOffset remove(PropertyName);
377
378         void createPropertyMap(unsigned keyCount = 0);
379         void checkConsistency();
380
381         bool despecifyFunction(JSGlobalData&, PropertyName);
382         void despecifyAllFunctions(JSGlobalData&);
383
384         PassOwnPtr<PropertyTable> copyPropertyTable(JSGlobalData&, Structure* owner);
385         PassOwnPtr<PropertyTable> copyPropertyTableForPinning(JSGlobalData&, Structure* owner);
386         JS_EXPORT_PRIVATE void materializePropertyMap(JSGlobalData&);
387         void materializePropertyMapIfNecessary(JSGlobalData& globalData)
388         {
389             ASSERT(structure()->classInfo() == &s_info);
390             if (!m_propertyTable && m_previous)
391                 materializePropertyMap(globalData);
392         }
393         void materializePropertyMapIfNecessaryForPinning(JSGlobalData& globalData)
394         {
395             ASSERT(structure()->classInfo() == &s_info);
396             if (!m_propertyTable)
397                 materializePropertyMap(globalData);
398         }
399
400         int transitionCount() const
401         {
402             // Since the number of transitions is always the same as m_offset, we keep the size of Structure down by not storing both.
403             return numberOfSlotsForLastOffset(m_offset, m_typeInfo.type());
404         }
405
406         bool isValid(JSGlobalObject*, StructureChain* cachedPrototypeChain) const;
407         bool isValid(ExecState*, StructureChain* cachedPrototypeChain) const;
408         
409         void pin();
410
411         static const int s_maxTransitionLength = 64;
412
413         static const unsigned maxSpecificFunctionThrashCount = 3;
414
415         TypeInfo m_typeInfo;
416         IndexingType m_indexingType;
417         
418         WriteBarrier<JSGlobalObject> m_globalObject;
419         WriteBarrier<Unknown> m_prototype;
420         mutable WriteBarrier<StructureChain> m_cachedPrototypeChain;
421
422         WriteBarrier<Structure> m_previous;
423         RefPtr<StringImpl> m_nameInPrevious;
424         WriteBarrier<JSCell> m_specificValueInPrevious;
425
426         const ClassInfo* m_classInfo;
427
428         StructureTransitionTable m_transitionTable;
429
430         WriteBarrier<JSPropertyNameIterator> m_enumerationCache;
431
432         OwnPtr<PropertyTable> m_propertyTable;
433
434         WriteBarrier<JSString> m_objectToStringValue;
435         
436         mutable InlineWatchpointSet m_transitionWatchpointSet;
437
438         uint32_t m_outOfLineCapacity;
439         uint8_t m_inlineCapacity;
440         COMPILE_ASSERT(firstOutOfLineOffset < 256, firstOutOfLineOffset_fits);
441
442         // m_offset does not account for anonymous slots
443         PropertyOffset m_offset;
444
445         unsigned m_dictionaryKind : 2;
446         bool m_isPinnedPropertyTable : 1;
447         bool m_hasGetterSetterProperties : 1;
448         bool m_hasReadOnlyOrGetterSetterPropertiesExcludingProto : 1;
449         bool m_hasNonEnumerableProperties : 1;
450         unsigned m_attributesInPrevious : 22;
451         unsigned m_specificFunctionThrashCount : 2;
452         unsigned m_preventExtensions : 1;
453         unsigned m_didTransition : 1;
454         unsigned m_staticFunctionReified;
455     };
456
457     inline Structure* Structure::create(JSGlobalData& globalData, JSGlobalObject* globalObject, JSValue prototype, const TypeInfo& typeInfo, const ClassInfo* classInfo, IndexingType indexingType, PropertyOffset inlineCapacity)
458     {
459         ASSERT(globalData.structureStructure);
460         ASSERT(classInfo);
461         Structure* structure = new (NotNull, allocateCell<Structure>(globalData.heap)) Structure(globalData, globalObject, prototype, typeInfo, classInfo, indexingType, inlineCapacity);
462         structure->finishCreation(globalData);
463         return structure;
464     }
465         
466     inline Structure* Structure::createStructure(JSGlobalData& globalData)
467     {
468         ASSERT(!globalData.structureStructure);
469         Structure* structure = new (NotNull, allocateCell<Structure>(globalData.heap)) Structure(globalData);
470         structure->finishCreation(globalData, CreatingEarlyCell);
471         return structure;
472     }
473
474     inline Structure* Structure::create(JSGlobalData& globalData, const Structure* structure)
475     {
476         ASSERT(globalData.structureStructure);
477         Structure* newStructure = new (NotNull, allocateCell<Structure>(globalData.heap)) Structure(globalData, structure);
478         newStructure->finishCreation(globalData);
479         return newStructure;
480     }
481         
482     inline PropertyOffset Structure::get(JSGlobalData& globalData, PropertyName propertyName)
483     {
484         ASSERT(structure()->classInfo() == &s_info);
485         materializePropertyMapIfNecessary(globalData);
486         if (!m_propertyTable)
487             return invalidOffset;
488
489         PropertyMapEntry* entry = m_propertyTable->find(propertyName.uid()).first;
490         return entry ? entry->offset : invalidOffset;
491     }
492
493     inline PropertyOffset Structure::get(JSGlobalData& globalData, const WTF::String& name)
494     {
495         ASSERT(structure()->classInfo() == &s_info);
496         materializePropertyMapIfNecessary(globalData);
497         if (!m_propertyTable)
498             return invalidOffset;
499
500         PropertyMapEntry* entry = m_propertyTable->findWithString(name.impl()).first;
501         return entry ? entry->offset : invalidOffset;
502     }
503     
504     inline bool Structure::masqueradesAsUndefined(JSGlobalObject* lexicalGlobalObject)
505     {
506         return typeInfo().masqueradesAsUndefined() && globalObject() == lexicalGlobalObject;
507     }
508
509     ALWAYS_INLINE void SlotVisitor::internalAppend(JSCell* cell)
510     {
511         ASSERT(!m_isCheckingForDefaultMarkViolation);
512         if (!cell)
513             return;
514 #if ENABLE(GC_VALIDATION)
515         validate(cell);
516 #endif
517         if (Heap::testAndSetMarked(cell) || !cell->structure())
518             return;
519
520         m_visitCount++;
521         
522         MARK_LOG_CHILD(*this, cell);
523
524         // Should never attempt to mark something that is zapped.
525         ASSERT(!cell->isZapped());
526         
527         m_stack.append(cell);
528     }
529
530     inline bool Structure::transitivelyTransitionedFrom(Structure* structureToFind)
531     {
532         for (Structure* current = this; current; current = current->previousID()) {
533             if (current == structureToFind)
534                 return true;
535         }
536         return false;
537     }
538
539 } // namespace JSC
540
541 #endif // Structure_h