BytecodeGenerator needs to be re-entrant to support miranda functions
[WebKit-https.git] / Source / JavaScriptCore / runtime / CodeCache.h
1 /*
2  * Copyright (C) 2012, 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 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 CodeCache_h
27 #define CodeCache_h
28
29 #include "CodeSpecializationKind.h"
30 #include "ParserModes.h"
31 #include "SourceCode.h"
32 #include "Strong.h"
33 #include "WeakRandom.h"
34 #include <wtf/CurrentTime.h>
35 #include <wtf/Forward.h>
36 #include <wtf/RandomNumber.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace JSC {
40
41 class EvalExecutable;
42 class FunctionBodyNode;
43 class Identifier;
44 class JSScope;
45 class ParserError;
46 class ProgramExecutable;
47 class UnlinkedCodeBlock;
48 class UnlinkedEvalCodeBlock;
49 class UnlinkedFunctionCodeBlock;
50 class UnlinkedFunctionExecutable;
51 class UnlinkedProgramCodeBlock;
52 class VM;
53 class SourceCode;
54 class SourceProvider;
55
56 class SourceCodeKey {
57 public:
58     enum CodeType { EvalType, ProgramType, FunctionType };
59
60     SourceCodeKey()
61     {
62     }
63
64     SourceCodeKey(const SourceCode& sourceCode, const String& name, CodeType codeType, JSParserStrictness jsParserStrictness)
65         : m_sourceCode(sourceCode)
66         , m_name(name)
67         , m_flags((codeType << 2) | jsParserStrictness)
68         , m_hash(string().impl()->hash())
69     {
70     }
71
72     SourceCodeKey(WTF::HashTableDeletedValueType)
73         : m_sourceCode(WTF::HashTableDeletedValue)
74     {
75     }
76
77     bool isHashTableDeletedValue() const { return m_sourceCode.isHashTableDeletedValue(); }
78
79     unsigned hash() const { return m_hash; }
80
81     size_t length() const { return m_sourceCode.length(); }
82
83     bool isNull() const { return m_sourceCode.isNull(); }
84
85     // To save memory, we compute our string on demand. It's expected that source
86     // providers cache their strings to make this efficient.
87     String string() const { return m_sourceCode.toString(); }
88
89     bool operator==(const SourceCodeKey& other) const
90     {
91         return m_hash == other.m_hash
92             && length() == other.length()
93             && m_flags == other.m_flags
94             && m_name == other.m_name
95             && string() == other.string();
96     }
97
98 private:
99     SourceCode m_sourceCode;
100     String m_name;
101     unsigned m_flags;
102     unsigned m_hash;
103 };
104
105 struct SourceCodeKeyHash {
106     static unsigned hash(const SourceCodeKey& key) { return key.hash(); }
107     static bool equal(const SourceCodeKey& a, const SourceCodeKey& b) { return a == b; }
108     static const bool safeToCompareToEmptyOrDeleted = false;
109 };
110
111 struct SourceCodeKeyHashTraits : SimpleClassHashTraits<SourceCodeKey> {
112     static const bool hasIsEmptyValueFunction = true;
113     static bool isEmptyValue(const SourceCodeKey& sourceCodeKey) { return sourceCodeKey.isNull(); }
114 };
115
116 struct SourceCodeValue {
117     SourceCodeValue()
118     {
119     }
120
121     SourceCodeValue(VM& vm, JSCell* cell, int64_t age)
122         : cell(vm, cell)
123         , age(age)
124     {
125     }
126
127     Strong<JSCell> cell;
128     int64_t age;
129 };
130
131 class CodeCacheMap {
132 public:
133     typedef HashMap<SourceCodeKey, SourceCodeValue, SourceCodeKeyHash, SourceCodeKeyHashTraits> MapType;
134     typedef MapType::iterator iterator;
135     typedef MapType::AddResult AddResult;
136
137     CodeCacheMap()
138         : m_size(0)
139         , m_sizeAtLastPrune(0)
140         , m_timeAtLastPrune(monotonicallyIncreasingTime())
141         , m_minCapacity(0)
142         , m_capacity(0)
143         , m_age(0)
144     {
145     }
146
147     SourceCodeValue* findCacheAndUpdateAge(const SourceCodeKey& key)
148     {
149         prune();
150
151         iterator findResult = m_map.find(key);
152         if (findResult == m_map.end())
153             return nullptr;
154
155         int64_t age = m_age - findResult->value.age;
156         if (age > m_capacity) {
157             // A requested object is older than the cache's capacity. We can
158             // infer that requested objects are subject to high eviction probability,
159             // so we grow the cache to improve our hit rate.
160             m_capacity += recencyBias * oldObjectSamplingMultiplier * key.length();
161         } else if (age < m_capacity / 2) {
162             // A requested object is much younger than the cache's capacity. We can
163             // infer that requested objects are subject to low eviction probability,
164             // so we shrink the cache to save memory.
165             m_capacity -= recencyBias * key.length();
166             if (m_capacity < m_minCapacity)
167                 m_capacity = m_minCapacity;
168         }
169
170         findResult->value.age = m_age;
171         m_age += key.length();
172
173         return &findResult->value;
174     }
175
176     AddResult addCache(const SourceCodeKey& key, const SourceCodeValue& value)
177     {
178         prune();
179
180         AddResult addResult = m_map.add(key, value);
181         ASSERT(addResult.isNewEntry);
182
183         m_size += key.length();
184         m_age += key.length();
185         return addResult;
186     }
187
188     void remove(iterator it)
189     {
190         m_size -= it->key.length();
191         m_map.remove(it);
192     }
193
194     void clear()
195     {
196         m_size = 0;
197         m_age = 0;
198         m_map.clear();
199     }
200
201     int64_t age() { return m_age; }
202
203 private:
204     // This constant factor biases cache capacity toward allowing a minimum
205     // working set to enter the cache before it starts evicting.
206     static const double workingSetTime;
207     static const int64_t workingSetMaxBytes = 16000000;
208     static const size_t workingSetMaxEntries = 2000;
209
210     // This constant factor biases cache capacity toward recent activity. We
211     // want to adapt to changing workloads.
212     static const int64_t recencyBias = 4;
213
214     // This constant factor treats a sampled event for one old object as if it
215     // happened for many old objects. Most old objects are evicted before we can
216     // sample them, so we need to extrapolate from the ones we do sample.
217     static const int64_t oldObjectSamplingMultiplier = 32;
218
219     size_t numberOfEntries() const { return static_cast<size_t>(m_map.size()); }
220     bool canPruneQuickly() const { return numberOfEntries() < workingSetMaxEntries; }
221
222     void pruneSlowCase();
223     void prune()
224     {
225         if (m_size <= m_capacity && canPruneQuickly())
226             return;
227
228         if (monotonicallyIncreasingTime() - m_timeAtLastPrune < workingSetTime
229             && m_size - m_sizeAtLastPrune < workingSetMaxBytes
230             && canPruneQuickly())
231                 return;
232
233         pruneSlowCase();
234     }
235
236     MapType m_map;
237     int64_t m_size;
238     int64_t m_sizeAtLastPrune;
239     double m_timeAtLastPrune;
240     int64_t m_minCapacity;
241     int64_t m_capacity;
242     int64_t m_age;
243 };
244
245 // Caches top-level code such as <script>, eval(), new Function, and JSEvaluateScript().
246 class CodeCache {
247     WTF_MAKE_FAST_ALLOCATED;
248 public:
249     CodeCache();
250     ~CodeCache();
251
252     UnlinkedProgramCodeBlock* getProgramCodeBlock(VM&, ProgramExecutable*, const SourceCode&, JSParserStrictness, DebuggerMode, ProfilerMode, ParserError&);
253     UnlinkedEvalCodeBlock* getEvalCodeBlock(VM&, EvalExecutable*, const SourceCode&, JSParserStrictness, DebuggerMode, ProfilerMode, ParserError&);
254     UnlinkedFunctionExecutable* getFunctionExecutableFromGlobalCode(VM&, const Identifier&, const SourceCode&, ParserError&);
255
256     void clear()
257     {
258         m_sourceCode.clear();
259     }
260
261 private:
262     template <class UnlinkedCodeBlockType, class ExecutableType> 
263     UnlinkedCodeBlockType* getGlobalCodeBlock(VM&, ExecutableType*, const SourceCode&, JSParserStrictness, DebuggerMode, ProfilerMode, ParserError&);
264
265     CodeCacheMap m_sourceCode;
266 };
267
268 }
269
270 #endif // CodeCache_h