83703cfa922cc6271285f5938e2a820f8bedb070
[WebKit-https.git] / Source / JavaScriptCore / bytecode / EvalCodeCache.h
1 /*
2  * Copyright (C) 2008, 2009 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 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 EvalCodeCache_h
30 #define EvalCodeCache_h
31
32 #include "Executable.h"
33 #include "JSGlobalObject.h"
34 #include "JSScope.h"
35 #include "Options.h"
36 #include "SourceCode.h"
37 #include "SourceCodeKey.h"
38 #include <wtf/HashMap.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/text/StringHash.h>
41
42 namespace JSC {
43
44     class SlotVisitor;
45
46     class EvalCodeCache {
47     public:
48         EvalExecutable* tryGet(bool inStrictContext, const SourceCode& evalSource, ThisTDZMode thisTDZMode, JSScope* scope)
49         {
50             if (isCacheable(inStrictContext, evalSource, scope)) {
51                 ASSERT(!inStrictContext);
52                 SourceCodeKey sourceCodeKey(evalSource, String(), SourceCodeKey::EvalType, JSParserBuiltinMode::NotBuiltin, JSParserStrictMode::NotStrict, thisTDZMode);
53                 return m_cacheMap.get(sourceCodeKey).get();
54             }
55             return nullptr;
56         }
57         
58         EvalExecutable* getSlow(ExecState* exec, JSCell* owner, bool inStrictContext, ThisTDZMode thisTDZMode, const SourceCode& evalSource, JSScope* scope)
59         {
60             VariableEnvironment variablesUnderTDZ;
61             JSScope::collectVariablesUnderTDZ(scope, variablesUnderTDZ);
62             EvalExecutable* evalExecutable = EvalExecutable::create(exec, evalSource, inStrictContext, thisTDZMode, &variablesUnderTDZ);
63             if (!evalExecutable)
64                 return nullptr;
65
66             if (isCacheable(inStrictContext, evalSource, scope) && m_cacheMap.size() < maxCacheEntries) {
67                 ASSERT(!inStrictContext);
68                 SourceCodeKey sourceCodeKey(evalSource, String(), SourceCodeKey::EvalType, JSParserBuiltinMode::NotBuiltin, JSParserStrictMode::NotStrict, thisTDZMode);
69                 m_cacheMap.set(sourceCodeKey, WriteBarrier<EvalExecutable>(exec->vm(), owner, evalExecutable));
70             }
71             
72             return evalExecutable;
73         }
74
75         bool isEmpty() const { return m_cacheMap.isEmpty(); }
76
77         void visitAggregate(SlotVisitor&);
78
79         void clear()
80         {
81             m_cacheMap.clear();
82         }
83
84     private:
85         ALWAYS_INLINE bool isCacheableScope(JSScope* scope)
86         {
87             return scope->isGlobalLexicalEnvironment() || scope->isFunctionNameScopeObject() || scope->isVarScope();
88         }
89
90         ALWAYS_INLINE bool isCacheable(bool inStrictContext, const SourceCode& evalSource, JSScope* scope)
91         {
92             // If eval() is called and it has access to a lexical scope, we can't soundly cache it.
93             // If the eval() only has access to the "var" scope, then we can cache it.
94             return !inStrictContext 
95                 && static_cast<size_t>(evalSource.length()) < Options::maximumEvalCacheableSourceLength()
96                 && isCacheableScope(scope);
97         }
98         static const int maxCacheEntries = 64;
99
100         typedef HashMap<SourceCodeKey, WriteBarrier<EvalExecutable>, SourceCodeKeyHash, SourceCodeKeyHashTraits> EvalCacheMap;
101         EvalCacheMap m_cacheMap;
102     };
103
104 } // namespace JSC
105
106 #endif // EvalCodeCache_h