494520dbdf428c8640db5e223f00e21f2fecffe9
[WebKit-https.git] / Source / JavaScriptCore / runtime / CodeCache.cpp
1 /*
2  * Copyright (C) 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  * 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 #include "config.h"
27
28 #include "CodeCache.h"
29
30 #include "BytecodeGenerator.h"
31 #include "CodeSpecializationKind.h"
32 #include "JSCInlines.h"
33 #include "Parser.h"
34 #include "StrongInlines.h"
35 #include "UnlinkedCodeBlock.h"
36
37 namespace JSC {
38
39 const double CodeCacheMap::workingSetTime = 10.0;
40
41 void CodeCacheMap::pruneSlowCase()
42 {
43     m_minCapacity = std::max(m_size - m_sizeAtLastPrune, static_cast<int64_t>(0));
44     m_sizeAtLastPrune = m_size;
45     m_timeAtLastPrune = monotonicallyIncreasingTime();
46
47     if (m_capacity < m_minCapacity)
48         m_capacity = m_minCapacity;
49
50     while (m_size > m_capacity || !canPruneQuickly()) {
51         MapType::iterator it = m_map.begin();
52         m_size -= it->key.length();
53         m_map.remove(it);
54     }
55 }
56
57 CodeCache::CodeCache()
58 {
59 }
60
61 CodeCache::~CodeCache()
62 {
63 }
64
65 template <typename T> struct CacheTypes { };
66
67 template <> struct CacheTypes<UnlinkedProgramCodeBlock> {
68     typedef JSC::ProgramNode RootNode;
69     static const SourceCodeKey::CodeType codeType = SourceCodeKey::ProgramType;
70     static const SourceParseMode parseMode = SourceParseMode::ProgramMode;
71 };
72
73 template <> struct CacheTypes<UnlinkedEvalCodeBlock> {
74     typedef JSC::EvalNode RootNode;
75     static const SourceCodeKey::CodeType codeType = SourceCodeKey::EvalType;
76     static const SourceParseMode parseMode = SourceParseMode::ProgramMode;
77 };
78
79 template <> struct CacheTypes<UnlinkedModuleProgramCodeBlock> {
80     typedef JSC::ModuleProgramNode RootNode;
81     static const SourceCodeKey::CodeType codeType = SourceCodeKey::ModuleType;
82     static const SourceParseMode parseMode = SourceParseMode::ModuleEvaluateMode;
83 };
84
85 template <class UnlinkedCodeBlockType, class ExecutableType>
86 UnlinkedCodeBlockType* CodeCache::getGlobalCodeBlock(VM& vm, ExecutableType* executable, const SourceCode& source, JSParserBuiltinMode builtinMode,
87     JSParserStrictMode strictMode, ThisTDZMode thisTDZMode, DebuggerMode debuggerMode, ProfilerMode profilerMode, ParserError& error, const VariableEnvironment* variablesUnderTDZ)
88 {
89     SourceCodeKey key = SourceCodeKey(source, String(), CacheTypes<UnlinkedCodeBlockType>::codeType, builtinMode, strictMode, thisTDZMode);
90     SourceCodeValue* cache = m_sourceCode.findCacheAndUpdateAge(key);
91     bool canCache = debuggerMode == DebuggerOff && profilerMode == ProfilerOff && !vm.typeProfiler() && !vm.controlFlowProfiler();
92     if (cache && canCache) {
93         UnlinkedCodeBlockType* unlinkedCodeBlock = jsCast<UnlinkedCodeBlockType*>(cache->cell.get());
94         unsigned firstLine = source.firstLine() + unlinkedCodeBlock->firstLine();
95         unsigned lineCount = unlinkedCodeBlock->lineCount();
96         unsigned startColumn = unlinkedCodeBlock->startColumn() + source.startColumn();
97         bool endColumnIsOnStartLine = !lineCount;
98         unsigned endColumn = unlinkedCodeBlock->endColumn() + (endColumnIsOnStartLine ? startColumn : 1);
99         executable->recordParse(unlinkedCodeBlock->codeFeatures(), unlinkedCodeBlock->hasCapturedVariables(), firstLine, firstLine + lineCount, startColumn, endColumn);
100         return unlinkedCodeBlock;
101     }
102
103     typedef typename CacheTypes<UnlinkedCodeBlockType>::RootNode RootNode;
104     std::unique_ptr<RootNode> rootNode = parse<RootNode>(
105         &vm, source, Identifier(), builtinMode, strictMode,
106         CacheTypes<UnlinkedCodeBlockType>::parseMode, SuperBinding::NotNeeded, error, nullptr, ConstructorKind::None, thisTDZMode);
107     if (!rootNode)
108         return nullptr;
109
110     unsigned lineCount = rootNode->lastLine() - rootNode->firstLine();
111     unsigned startColumn = rootNode->startColumn() + 1;
112     bool endColumnIsOnStartLine = !lineCount;
113     unsigned unlinkedEndColumn = rootNode->endColumn();
114     unsigned endColumn = unlinkedEndColumn + (endColumnIsOnStartLine ? startColumn : 1);
115     executable->recordParse(rootNode->features(), rootNode->hasCapturedVariables(), rootNode->firstLine(), rootNode->lastLine(), startColumn, endColumn);
116
117     UnlinkedCodeBlockType* unlinkedCodeBlock = UnlinkedCodeBlockType::create(&vm, executable->executableInfo());
118     unlinkedCodeBlock->recordParse(rootNode->features(), rootNode->hasCapturedVariables(), rootNode->firstLine() - source.firstLine(), lineCount, unlinkedEndColumn);
119
120     auto generator = std::make_unique<BytecodeGenerator>(vm, rootNode.get(), unlinkedCodeBlock, debuggerMode, profilerMode, variablesUnderTDZ);
121     error = generator->generate();
122     if (error.isValid())
123         return nullptr;
124
125     if (!canCache)
126         return unlinkedCodeBlock;
127
128     m_sourceCode.addCache(key, SourceCodeValue(vm, unlinkedCodeBlock, m_sourceCode.age()));
129     return unlinkedCodeBlock;
130 }
131
132 UnlinkedProgramCodeBlock* CodeCache::getProgramCodeBlock(VM& vm, ProgramExecutable* executable, const SourceCode& source, JSParserBuiltinMode builtinMode, JSParserStrictMode strictMode, DebuggerMode debuggerMode, ProfilerMode profilerMode, ParserError& error)
133 {
134     VariableEnvironment emptyParentTDZVariables;
135     return getGlobalCodeBlock<UnlinkedProgramCodeBlock>(vm, executable, source, builtinMode, strictMode, ThisTDZMode::CheckIfNeeded, debuggerMode, profilerMode, error, &emptyParentTDZVariables);
136 }
137
138 UnlinkedEvalCodeBlock* CodeCache::getEvalCodeBlock(VM& vm, EvalExecutable* executable, const SourceCode& source, JSParserBuiltinMode builtinMode, JSParserStrictMode strictMode, ThisTDZMode thisTDZMode, DebuggerMode debuggerMode, ProfilerMode profilerMode, ParserError& error, const VariableEnvironment* variablesUnderTDZ)
139 {
140     return getGlobalCodeBlock<UnlinkedEvalCodeBlock>(vm, executable, source, builtinMode, strictMode, thisTDZMode, debuggerMode, profilerMode, error, variablesUnderTDZ);
141 }
142
143 UnlinkedModuleProgramCodeBlock* CodeCache::getModuleProgramCodeBlock(VM& vm, ModuleProgramExecutable* executable, const SourceCode& source, JSParserBuiltinMode builtinMode, DebuggerMode debuggerMode, ProfilerMode profilerMode, ParserError& error)
144 {
145     VariableEnvironment emptyParentTDZVariables;
146     return getGlobalCodeBlock<UnlinkedModuleProgramCodeBlock>(vm, executable, source, builtinMode, JSParserStrictMode::Strict, ThisTDZMode::CheckIfNeeded, debuggerMode, profilerMode, error, &emptyParentTDZVariables);
147 }
148
149 // FIXME: There's no need to add the function's name to the key here. It's already in the source code.
150 UnlinkedFunctionExecutable* CodeCache::getFunctionExecutableFromGlobalCode(VM& vm, const Identifier& name, const SourceCode& source, ParserError& error)
151 {
152     SourceCodeKey key = SourceCodeKey(
153         source, name.string(), SourceCodeKey::FunctionType, 
154         JSParserBuiltinMode::NotBuiltin, 
155         JSParserStrictMode::NotStrict);
156     SourceCodeValue* cache = m_sourceCode.findCacheAndUpdateAge(key);
157     if (cache)
158         return jsCast<UnlinkedFunctionExecutable*>(cache->cell.get());
159
160     JSTextPosition positionBeforeLastNewline;
161     std::unique_ptr<ProgramNode> program = parse<ProgramNode>(
162         &vm, source, Identifier(), JSParserBuiltinMode::NotBuiltin,
163         JSParserStrictMode::NotStrict, SourceParseMode::ProgramMode, SuperBinding::NotNeeded,
164         error, &positionBeforeLastNewline);
165     if (!program) {
166         RELEASE_ASSERT(error.isValid());
167         return nullptr;
168     }
169
170     // This function assumes an input string that would result in a single function declaration.
171     StatementNode* statement = program->singleStatement();
172     ASSERT(statement);
173     ASSERT(statement->isBlock());
174     if (!statement || !statement->isBlock())
175         return nullptr;
176
177     StatementNode* funcDecl = static_cast<BlockNode*>(statement)->singleStatement();
178     ASSERT(funcDecl);
179     ASSERT(funcDecl->isFuncDeclNode());
180     if (!funcDecl || !funcDecl->isFuncDeclNode())
181         return nullptr;
182
183     FunctionMetadataNode* metadata = static_cast<FuncDeclNode*>(funcDecl)->metadata();
184     ASSERT(metadata);
185     if (!metadata)
186         return nullptr;
187     
188     metadata->setEndPosition(positionBeforeLastNewline);
189     // The Function constructor only has access to global variables, so no variables will be under TDZ.
190     VariableEnvironment emptyTDZVariables;
191     UnlinkedFunctionExecutable* functionExecutable = UnlinkedFunctionExecutable::create(&vm, source, metadata, UnlinkedNormalFunction, ConstructAbility::CanConstruct, GeneratorThisMode::NonEmpty, emptyTDZVariables);
192     functionExecutable->m_nameValue.set(vm, functionExecutable, jsString(&vm, name.string()));
193
194     m_sourceCode.addCache(key, SourceCodeValue(vm, functionExecutable, m_sourceCode.age()));
195     return functionExecutable;
196 }
197
198 }