Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / runtime / InferredTypeTable.h
1 /*
2  * Copyright (C) 2015 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 "Identifier.h"
29 #include "InferredType.h"
30 #include "JSCell.h"
31
32 namespace JSC {
33
34 // A table of inferred types for some structure. This is a JSCell because that simplifies the Structure
35 // destructor and makes lifetime easier to manage. For example, since it's a cell, we know that this thing
36 // cannot be deleted while the DFG is running. This is separate from PropertyTable because most properties
37 // will not have an InferredType, since most properties are in dictionaries (if you think of "a property"
38 // as being "a property in some Structure"). Also, this will happily conflate the types of properties from
39 // different structures even if the structures represent disjoint sets of objects.
40
41 class InferredTypeTable final : public JSCell {
42 public:
43     typedef JSCell Base;
44
45     static InferredTypeTable* create(VM&);
46
47     static const bool needsDestruction = true;
48     static void destroy(JSCell*);
49
50     static const unsigned StructureFlags = StructureIsImmortal | Base::StructureFlags;
51     
52     static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
53
54     static void visitChildren(JSCell*, SlotVisitor&);
55
56     DECLARE_INFO;
57
58     ConcurrentJSLock& lock() { return m_lock; }
59
60     bool isEmpty() const { return m_table.isEmpty(); }
61
62     // Get the current inferred type. Returns nullptr for both Top and Bottom. Null means Bottom if the
63     // owning Structure doesn't know about the property.
64     InferredType* get(const ConcurrentJSLocker&, UniquedStringImpl*);
65     InferredType* get(UniquedStringImpl*);
66     InferredType* get(PropertyName);
67
68     enum StoredPropertyAge {
69         NewProperty,
70         OldProperty
71     };
72     
73     // Returns true if the InferredType for this property is still relevant after the store. It's not
74     // relevant if it's Top. Note that this table will internally prune Top entries.
75     bool willStoreValue(VM&, PropertyName, JSValue, StoredPropertyAge);
76
77     // Invalidates the type for the property. Useful if we detect a store in a reflective context.
78     void makeTop(VM&, PropertyName, StoredPropertyAge);
79
80 private:
81     InferredTypeTable(VM&);
82     ~InferredTypeTable();
83
84     // Bottom: absence from table.
85     // Top: null value in table, !value->isRelevant(), or absence from table.
86     //
87     // We know how to determine if absence from the table is bottom or top depending on whether the
88     // property is present in the owning structure. Hence, depending on the structure, absence may have
89     // different meanings. The way that this class determines if the owning structure knows of the property
90     // is that we differentiate between actions: replace or transition. If we're adding a new property
91     // (transition), then absence means bottom. If we're storing to an existing property (replace), then
92     // absence means top. To make this work, we have to watch out for the case where two structures, S1 and
93     // S2, share the same InferredTypeTable and neither of them initially know about property P. S1 may
94     // want to add P without a type, while S2 may want to add P with a type. If S1 added P and used absence
95     // to indicate Top, then S2 would use that absence to mean Bottom and would end up creating a non-Top
96     // entry in the table. Then S1 would forget that it wanted Top, and would use S2's type. Clearly,
97     // that's bad. We avoid such confusion by ensuring that a transition always adds an entry. Hence,
98     // absence-means-bottom only comes into play for properties added before the InferredTypeTable was
99     // created.
100     typedef HashMap<RefPtr<UniquedStringImpl>, WriteBarrier<InferredType>, IdentifierRepHash> TableType;
101     
102     TableType m_table;
103
104     // We only grab this lock when we're doing modifications on the main thread, or reads on the compiler
105     // thread. The compiler thread is not allowed to do modifications.
106     ConcurrentJSLock m_lock;
107 };
108
109 } // namespace JSC