DFG should be able to set watchpoints on global variables
[WebKit-https.git] / Source / JavaScriptCore / runtime / SymbolTable.h
1 /*
2  * Copyright (C) 2007, 2008, 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef SymbolTable_h
30 #define SymbolTable_h
31
32 #include "JSObject.h"
33 #include "UString.h"
34 #include "Watchpoint.h"
35 #include <wtf/AlwaysInline.h>
36 #include <wtf/HashTraits.h>
37
38 namespace JSC {
39
40     class Watchpoint;
41     class WatchpointSet;
42
43     static ALWAYS_INLINE int missingSymbolMarker() { return std::numeric_limits<int>::max(); }
44
45     // The bit twiddling in this class assumes that every register index is a
46     // reasonably small positive or negative number, and therefore has its high
47     // four bits all set or all unset.
48
49     // In addition to implementing semantics-mandated variable attributes and
50     // implementation-mandated variable indexing, this class also implements
51     // watchpoints to be used for JIT optimizations. Because watchpoints are
52     // meant to be relatively rare, this class optimizes heavily for the case
53     // that they are not being used. To that end, this class uses the thin-fat
54     // idiom: either it is thin, in which case it contains an in-place encoded
55     // word that consists of attributes, the index, and a bit saying that it is
56     // thin; or it is fat, in which case it contains a pointer to a malloc'd
57     // data structure and a bit saying that it is fat. The malloc'd data
58     // structure will be malloced a second time upon copy, to preserve the
59     // property that in-place edits to SymbolTableEntry do not manifest in any
60     // copies. However, the malloc'd FatEntry data structure contains a ref-
61     // counted pointer to a shared WatchpointSet. Thus, in-place edits of the
62     // WatchpointSet will manifest in all copies. Here's a picture:
63     //
64     // SymbolTableEntry --> FatEntry --> WatchpointSet
65     //
66     // If you make a copy of a SymbolTableEntry, you will have:
67     //
68     // original: SymbolTableEntry --> FatEntry --> WatchpointSet
69     // copy:     SymbolTableEntry --> FatEntry -----^
70
71     struct SymbolTableEntry {
72         // Use the SymbolTableEntry::Fast class, either via implicit cast or by calling
73         // getFast(), when you (1) only care about isNull(), getIndex(), and isReadOnly(),
74         // and (2) you are in a hot path where you need to minimize the number of times
75         // that you branch on isFat() when getting the bits().
76         class Fast {
77         public:
78             Fast()
79                 : m_bits(0)
80             {
81             }
82             
83             ALWAYS_INLINE Fast(const SymbolTableEntry& entry)
84                 : m_bits(entry.bits())
85             {
86             }
87         
88             bool isNull() const
89             {
90                 return !m_bits;
91             }
92
93             int getIndex() const
94             {
95                 return static_cast<int>(m_bits >> FlagBits);
96             }
97         
98             bool isReadOnly() const
99             {
100                 return m_bits & ReadOnlyFlag;
101             }
102             
103             unsigned getAttributes() const
104             {
105                 unsigned attributes = 0;
106                 if (m_bits & ReadOnlyFlag)
107                     attributes |= ReadOnly;
108                 if (m_bits & DontEnumFlag)
109                     attributes |= DontEnum;
110                 return attributes;
111             }
112
113             bool isFat() const
114             {
115                 return m_bits & FatFlag;
116             }
117             
118         private:
119             friend struct SymbolTableEntry;
120             intptr_t m_bits;
121         };
122
123         SymbolTableEntry()
124             : m_bits(0)
125         {
126         }
127
128         SymbolTableEntry(int index)
129             : m_bits(0)
130         {
131             ASSERT(isValidIndex(index));
132             pack(index, false, false);
133         }
134
135         SymbolTableEntry(int index, unsigned attributes)
136             : m_bits(0)
137         {
138             ASSERT(isValidIndex(index));
139             pack(index, attributes & ReadOnly, attributes & DontEnum);
140         }
141         
142         ~SymbolTableEntry()
143         {
144             freeFatEntry();
145         }
146         
147         SymbolTableEntry(const SymbolTableEntry& other)
148             : m_bits(0)
149         {
150             *this = other;
151         }
152         
153         SymbolTableEntry& operator=(const SymbolTableEntry& other)
154         {
155             if (UNLIKELY(other.isFat()))
156                 return copySlow(other);
157             freeFatEntry();
158             m_bits = other.m_bits;
159             return *this;
160         }
161         
162         bool isNull() const
163         {
164             return !bits();
165         }
166
167         int getIndex() const
168         {
169             return static_cast<int>(bits() >> FlagBits);
170         }
171         
172         ALWAYS_INLINE Fast getFast() const
173         {
174             return Fast(*this);
175         }
176         
177         ALWAYS_INLINE Fast getFast(bool& wasFat) const
178         {
179             Fast result;
180             wasFat = isFat();
181             if (wasFat)
182                 result.m_bits = fatEntry()->m_bits;
183             else
184                 result.m_bits = m_bits;
185             return result;
186         }
187         
188         unsigned getAttributes() const
189         {
190             return getFast().getAttributes();
191         }
192
193         void setAttributes(unsigned attributes)
194         {
195             pack(getIndex(), attributes & ReadOnly, attributes & DontEnum);
196         }
197
198         bool isReadOnly() const
199         {
200             return bits() & ReadOnlyFlag;
201         }
202         
203         bool couldBeWatched();
204         
205         // Notify an opportunity to create a watchpoint for a variable. This is
206         // idempotent and fail-silent. It is idempotent in the sense that if
207         // a watchpoint set had already been created, then another one will not
208         // be created. Hence two calls to this method have the same effect as
209         // one call. It is also fail-silent, in the sense that if a watchpoint
210         // set had been created and had already been invalidated, then this will
211         // just return. This means that couldBeWatched() may return false even
212         // immediately after a call to attemptToWatch().
213         void attemptToWatch();
214         
215         bool* addressOfIsWatched();
216         
217         void addWatchpoint(Watchpoint*);
218         
219         WatchpointSet* watchpointSet()
220         {
221             return fatEntry()->m_watchpoints.get();
222         }
223         
224         ALWAYS_INLINE void notifyWrite()
225         {
226             if (LIKELY(!isFat()))
227                 return;
228             notifyWriteSlow();
229         }
230         
231     private:
232         static const intptr_t FatFlag = 0x1;
233         static const intptr_t ReadOnlyFlag = 0x2;
234         static const intptr_t DontEnumFlag = 0x4;
235         static const intptr_t NotNullFlag = 0x8;
236         static const intptr_t FlagBits = 4;
237         
238         class FatEntry {
239             WTF_MAKE_FAST_ALLOCATED;
240         public:
241             FatEntry(intptr_t bits)
242                 : m_bits(bits | FatFlag)
243             {
244             }
245             
246             intptr_t m_bits; // always has FatFlag set and exactly matches what the bits would have been if this wasn't fat.
247             
248             RefPtr<WatchpointSet> m_watchpoints;
249         };
250         
251         SymbolTableEntry& copySlow(const SymbolTableEntry&);
252         JS_EXPORT_PRIVATE void notifyWriteSlow();
253         
254         bool isFat() const
255         {
256             return m_bits & FatFlag;
257         }
258         
259         const FatEntry* fatEntry() const
260         {
261             ASSERT(isFat());
262             return bitwise_cast<const FatEntry*>(m_bits & ~FatFlag);
263         }
264         
265         FatEntry* fatEntry()
266         {
267             ASSERT(isFat());
268             return bitwise_cast<FatEntry*>(m_bits & ~FatFlag);
269         }
270         
271         FatEntry* inflate()
272         {
273             if (LIKELY(isFat()))
274                 return fatEntry();
275             return inflateSlow();
276         }
277         
278         FatEntry* inflateSlow();
279         
280         ALWAYS_INLINE intptr_t bits() const
281         {
282             if (isFat())
283                 return fatEntry()->m_bits;
284             return m_bits;
285         }
286         
287         ALWAYS_INLINE intptr_t& bits()
288         {
289             if (isFat())
290                 return fatEntry()->m_bits;
291             return m_bits;
292         }
293         
294         void freeFatEntry()
295         {
296             if (LIKELY(!isFat()))
297                 return;
298             freeFatEntrySlow();
299         }
300         
301         void freeFatEntrySlow();
302
303         void pack(int index, bool readOnly, bool dontEnum)
304         {
305             intptr_t& bitsRef = bits();
306             bitsRef = (static_cast<intptr_t>(index) << FlagBits) | NotNullFlag;
307             if (readOnly)
308                 bitsRef |= ReadOnlyFlag;
309             if (dontEnum)
310                 bitsRef |= DontEnumFlag;
311         }
312         
313         bool isValidIndex(int index)
314         {
315             return ((static_cast<intptr_t>(index) << FlagBits) >> FlagBits) == static_cast<intptr_t>(index);
316         }
317
318         intptr_t m_bits;
319     };
320
321     struct SymbolTableIndexHashTraits : HashTraits<SymbolTableEntry> {
322         static const bool emptyValueIsZero = true;
323         static const bool needsDestruction = false;
324     };
325
326     typedef HashMap<RefPtr<StringImpl>, SymbolTableEntry, IdentifierRepHash, HashTraits<RefPtr<StringImpl> >, SymbolTableIndexHashTraits> SymbolTable;
327
328     class SharedSymbolTable : public SymbolTable, public RefCounted<SharedSymbolTable> {
329         WTF_MAKE_FAST_ALLOCATED;
330     public:
331         static PassRefPtr<SharedSymbolTable> create() { return adoptRef(new SharedSymbolTable); }
332     private:
333         SharedSymbolTable() { turnOffVerifier(); }
334     };
335     
336 } // namespace JSC
337
338 #endif // SymbolTable_h