DFG should have adaptive structure watchpoints
[WebKit-https.git] / Source / JavaScriptCore / bytecode / ObjectPropertyConditionSet.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 #ifndef ObjectPropertyConditionSet_h
27 #define ObjectPropertyConditionSet_h
28
29 #include "ObjectPropertyCondition.h"
30 #include <wtf/FastMalloc.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Vector.h>
33
34 namespace JSC {
35
36 // An object property condition set is used to represent the set of additional conditions
37 // that need to be met for some heap access to be valid. The set can have the following
38 // interesting states:
39 //
40 // Empty: There are no special conditions that need to be met.
41 // Invalid: The heap access is never valid.
42 // Non-empty: The heap access is valid if all the ObjectPropertyConditions in the set are valid.
43
44 class ObjectPropertyConditionSet {
45 public:
46     ObjectPropertyConditionSet() { }
47     
48     static ObjectPropertyConditionSet invalid()
49     {
50         ObjectPropertyConditionSet result;
51         result.m_data = adoptRef(new Data());
52         return result;
53     }
54     
55     static ObjectPropertyConditionSet create(const Vector<ObjectPropertyCondition>& vector)
56     {
57         if (vector.isEmpty())
58             return ObjectPropertyConditionSet();
59         
60         ObjectPropertyConditionSet result;
61         result.m_data = adoptRef(new Data());
62         result.m_data->vector = vector;
63         return result;
64     }
65     
66     bool isValid() const
67     {
68         return !m_data || !m_data->vector.isEmpty();
69     }
70     
71     bool isEmpty() const
72     {
73         return !m_data;
74     }
75     
76     typedef const ObjectPropertyCondition* iterator;
77     
78     iterator begin() const
79     {
80         if (!m_data)
81             return nullptr;
82         return m_data->vector.begin();
83     }
84     iterator end() const
85     {
86         if (!m_data)
87             return nullptr;
88         return m_data->vector.end();
89     }
90     
91     ObjectPropertyCondition forObject(JSObject*) const;
92     ObjectPropertyCondition forConditionKind(PropertyCondition::Kind) const;
93
94     unsigned numberOfConditionsWithKind(PropertyCondition::Kind) const;
95
96     bool hasOneSlotBaseCondition() const;
97     
98     // If this is a condition set for a prototype hit, then this is guaranteed to return the
99     // condition on the prototype itself. This allows you to get the object, offset, and
100     // attributes for the prototype. This will RELEASE_ASSERT that there is exactly one Presence
101     // in the set, and it will return that presence.
102     ObjectPropertyCondition slotBaseCondition() const;
103     
104     // Attempt to create a new condition set by merging this one with the other one. This will
105     // fail if any of the conditions are incompatible with each other. When if fails, it returns
106     // invalid().
107     ObjectPropertyConditionSet mergedWith(const ObjectPropertyConditionSet& other) const;
108     
109     bool structuresEnsureValidity() const;
110     bool structuresEnsureValidityAssumingImpurePropertyWatchpoint() const;
111     
112     bool needImpurePropertyWatchpoint() const;
113     bool areStillLive() const;
114     
115     void dumpInContext(PrintStream&, DumpContext*) const;
116     void dump(PrintStream&) const;
117     
118     // Helpers for using this in a union.
119     void* releaseRawPointer()
120     {
121         return static_cast<void*>(m_data.leakRef());
122     }
123     static ObjectPropertyConditionSet adoptRawPointer(void* rawPointer)
124     {
125         ObjectPropertyConditionSet result;
126         result.m_data = adoptRef(static_cast<Data*>(rawPointer));
127         return result;
128     }
129     static ObjectPropertyConditionSet fromRawPointer(void* rawPointer)
130     {
131         ObjectPropertyConditionSet result;
132         result.m_data = static_cast<Data*>(rawPointer);
133         return result;
134     }
135     
136 private:
137     // Internally, this represents Invalid using a pointer to a Data that has an empty vector.
138     
139     // FIXME: This could be made more compact by having it internally use a vector that just has
140     // the non-uid portion of ObjectPropertyCondition, and then requiring that the callers of all
141     // of the APIs supply the uid.
142     
143     class Data : public ThreadSafeRefCounted<Data> {
144         WTF_MAKE_NONCOPYABLE(Data);
145         WTF_MAKE_FAST_ALLOCATED;
146         
147     public:
148         Data() { }
149         
150         Vector<ObjectPropertyCondition> vector;
151     };
152     
153     RefPtr<Data> m_data;
154 };
155
156 ObjectPropertyConditionSet generateConditionsForPropertyMiss(
157     VM&, JSCell* owner, ExecState*, Structure* headStructure, UniquedStringImpl* uid);
158 ObjectPropertyConditionSet generateConditionsForPropertySetterMiss(
159     VM&, JSCell* owner, ExecState*, Structure* headStructure, UniquedStringImpl* uid);
160 ObjectPropertyConditionSet generateConditionsForPrototypePropertyHit(
161     VM&, JSCell* owner, ExecState*, Structure* headStructure, JSObject* prototype,
162     UniquedStringImpl* uid);
163 ObjectPropertyConditionSet generateConditionsForPrototypePropertyHitCustom(
164     VM&, JSCell* owner, ExecState*, Structure* headStructure, JSObject* prototype,
165     UniquedStringImpl* uid);
166
167 ObjectPropertyConditionSet generateConditionsForPropertySetterMissConcurrently(
168     VM&, JSGlobalObject*, Structure* headStructure, UniquedStringImpl* uid);
169
170 } // namespace JSC
171
172 #endif // ObjectPropertyConditionSet_h
173