7eb1eb6f7a38fdf64ad10256f1cd06dc1ff955ad
[WebKit-https.git] / Source / JavaScriptCore / bytecode / UnlinkedFunctionExecutable.cpp
1 /*
2  * Copyright (C) 2012-2013, 2015-2016 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 #include "UnlinkedFunctionExecutable.h"
28
29 #include "BytecodeGenerator.h"
30 #include "ClassInfo.h"
31 #include "CodeCache.h"
32 #include "Executable.h"
33 #include "ExecutableInfo.h"
34 #include "FunctionOverrides.h"
35 #include "JSCInlines.h"
36 #include "JSString.h"
37 #include "Parser.h"
38 #include "SourceProvider.h"
39 #include "Structure.h"
40 #include "SymbolTable.h"
41 #include "UnlinkedInstructionStream.h"
42 #include <wtf/DataLog.h>
43
44 namespace JSC {
45
46 static_assert(sizeof(UnlinkedFunctionExecutable) <= 256, "UnlinkedFunctionExecutable should fit in a 256-byte cell.");
47
48 const ClassInfo UnlinkedFunctionExecutable::s_info = { "UnlinkedFunctionExecutable", 0, 0, CREATE_METHOD_TABLE(UnlinkedFunctionExecutable) };
49
50 static UnlinkedFunctionCodeBlock* generateUnlinkedFunctionCodeBlock(
51     VM& vm, UnlinkedFunctionExecutable* executable, const SourceCode& source,
52     CodeSpecializationKind kind, DebuggerMode debuggerMode, ProfilerMode profilerMode,
53     UnlinkedFunctionKind functionKind, ParserError& error, SourceParseMode parseMode)
54 {
55     JSParserBuiltinMode builtinMode = executable->isBuiltinFunction() ? JSParserBuiltinMode::Builtin : JSParserBuiltinMode::NotBuiltin;
56     JSParserStrictMode strictMode = executable->isInStrictContext() ? JSParserStrictMode::Strict : JSParserStrictMode::NotStrict;
57     ASSERT(isFunctionParseMode(executable->parseMode()));
58     std::unique_ptr<FunctionNode> function = parse<FunctionNode>(
59         &vm, source, executable->name(), builtinMode, strictMode, executable->parseMode(), executable->superBinding(), error, nullptr);
60
61     if (!function) {
62         ASSERT(error.isValid());
63         return nullptr;
64     }
65
66     function->finishParsing(executable->name(), executable->functionMode());
67     executable->recordParse(function->features(), function->hasCapturedVariables());
68
69     bool isClassContext = executable->superBinding() == SuperBinding::Needed;
70
71     UnlinkedFunctionCodeBlock* result = UnlinkedFunctionCodeBlock::create(&vm, FunctionCode, ExecutableInfo(function->usesEval(), function->isStrictMode(), kind == CodeForConstruct, functionKind == UnlinkedBuiltinFunction, executable->constructorKind(), executable->superBinding(), parseMode, executable->derivedContextType(), false, isClassContext, EvalContextType::FunctionEvalContext), debuggerMode);
72
73     error = BytecodeGenerator::generate(vm, function.get(), result, debuggerMode, profilerMode, executable->parentScopeTDZVariables());
74
75     if (error.isValid())
76         return nullptr;
77     return result;
78 }
79
80 UnlinkedFunctionExecutable::UnlinkedFunctionExecutable(VM* vm, Structure* structure, const SourceCode& source, RefPtr<SourceProvider>&& sourceOverride, FunctionMetadataNode* node, UnlinkedFunctionKind kind, ConstructAbility constructAbility, VariableEnvironment& parentScopeTDZVariables, DerivedContextType derivedContextType)
81     : Base(*vm, structure)
82     , m_firstLineOffset(node->firstLine() - source.firstLine())
83     , m_lineCount(node->lastLine() - node->firstLine())
84     , m_unlinkedFunctionNameStart(node->functionNameStart() - source.startOffset())
85     , m_unlinkedBodyStartColumn(node->startColumn())
86     , m_unlinkedBodyEndColumn(m_lineCount ? node->endColumn() : node->endColumn() - node->startColumn())
87     , m_startOffset(node->source().startOffset() - source.startOffset())
88     , m_sourceLength(node->source().length())
89     , m_parametersStartOffset(node->parametersStart())
90     , m_typeProfilingStartOffset(node->functionKeywordStart())
91     , m_typeProfilingEndOffset(node->startStartOffset() + node->source().length() - 1)
92     , m_parameterCount(node->parameterCount())
93     , m_features(0)
94     , m_isInStrictContext(node->isInStrictContext())
95     , m_hasCapturedVariables(false)
96     , m_isBuiltinFunction(kind == UnlinkedBuiltinFunction)
97     , m_constructAbility(static_cast<unsigned>(constructAbility))
98     , m_constructorKind(static_cast<unsigned>(node->constructorKind()))
99     , m_functionMode(static_cast<unsigned>(node->functionMode()))
100     , m_superBinding(static_cast<unsigned>(node->superBinding()))
101     , m_derivedContextType(static_cast<unsigned>(derivedContextType))
102     , m_sourceParseMode(static_cast<unsigned>(node->parseMode()))
103     , m_name(node->ident())
104     , m_ecmaName(node->ecmaName())
105     , m_inferredName(node->inferredName())
106     , m_sourceOverride(WTFMove(sourceOverride))
107     , m_classSource(node->classSource())
108 {
109     // Make sure these bitfields are adequately wide.
110     ASSERT(m_constructAbility == static_cast<unsigned>(constructAbility));
111     ASSERT(m_constructorKind == static_cast<unsigned>(node->constructorKind()));
112     ASSERT(m_functionMode == static_cast<unsigned>(node->functionMode()));
113     ASSERT(m_superBinding == static_cast<unsigned>(node->superBinding()));
114     ASSERT(m_derivedContextType == static_cast<unsigned>(derivedContextType));
115     ASSERT(m_sourceParseMode == static_cast<unsigned>(node->parseMode()));
116
117     m_parentScopeTDZVariables.swap(parentScopeTDZVariables);
118 }
119
120 void UnlinkedFunctionExecutable::visitChildren(JSCell* cell, SlotVisitor& visitor)
121 {
122     UnlinkedFunctionExecutable* thisObject = jsCast<UnlinkedFunctionExecutable*>(cell);
123     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
124     Base::visitChildren(thisObject, visitor);
125     visitor.append(&thisObject->m_unlinkedCodeBlockForCall);
126     visitor.append(&thisObject->m_unlinkedCodeBlockForConstruct);
127 }
128
129 FunctionExecutable* UnlinkedFunctionExecutable::link(VM& vm, const SourceCode& ownerSource, Optional<int> overrideLineNumber, Intrinsic intrinsic)
130 {
131     SourceCode source = m_sourceOverride ? SourceCode(m_sourceOverride) : ownerSource;
132     unsigned firstLine = source.firstLine() + m_firstLineOffset;
133     unsigned startOffset = source.startOffset() + m_startOffset;
134     unsigned lineCount = m_lineCount;
135
136     // Adjust to one-based indexing.
137     bool startColumnIsOnFirstSourceLine = !m_firstLineOffset;
138     unsigned startColumn = m_unlinkedBodyStartColumn + (startColumnIsOnFirstSourceLine ? source.startColumn() : 1);
139     bool endColumnIsOnStartLine = !lineCount;
140     unsigned endColumn = m_unlinkedBodyEndColumn + (endColumnIsOnStartLine ? startColumn : 1);
141
142     SourceCode code(source.provider(), startOffset, startOffset + m_sourceLength, firstLine, startColumn);
143     FunctionOverrides::OverrideInfo overrideInfo;
144     bool hasFunctionOverride = false;
145
146     if (UNLIKELY(Options::functionOverrides())) {
147         hasFunctionOverride = FunctionOverrides::initializeOverrideFor(code, overrideInfo);
148         if (hasFunctionOverride) {
149             firstLine = overrideInfo.firstLine;
150             lineCount = overrideInfo.lineCount;
151             startColumn = overrideInfo.startColumn;
152             endColumn = overrideInfo.endColumn;
153             code = overrideInfo.sourceCode;
154         }
155     }
156
157     FunctionExecutable* result = FunctionExecutable::create(vm, code, this, firstLine, firstLine + lineCount, startColumn, endColumn, intrinsic);
158     if (overrideLineNumber)
159         result->setOverrideLineNumber(*overrideLineNumber);
160
161     if (UNLIKELY(hasFunctionOverride)) {
162         result->overrideParameterAndTypeProfilingStartEndOffsets(
163             overrideInfo.parametersStartOffset,
164             overrideInfo.typeProfilingStartOffset,
165             overrideInfo.typeProfilingEndOffset);
166     }
167
168     return result;
169 }
170
171 UnlinkedFunctionExecutable* UnlinkedFunctionExecutable::fromGlobalCode(
172     const Identifier& name, ExecState& exec, const SourceCode& source, 
173     JSObject*& exception, int overrideLineNumber)
174 {
175     ParserError error;
176     VM& vm = exec.vm();
177     CodeCache* codeCache = vm.codeCache();
178     UnlinkedFunctionExecutable* executable = codeCache->getFunctionExecutableFromGlobalCode(vm, name, source, error);
179
180     auto& globalObject = *exec.lexicalGlobalObject();
181     if (globalObject.hasDebugger())
182         globalObject.debugger()->sourceParsed(&exec, source.provider(), error.line(), error.message());
183
184     if (error.isValid()) {
185         exception = error.toErrorObject(&globalObject, source, overrideLineNumber);
186         return nullptr;
187     }
188
189     return executable;
190 }
191
192 UnlinkedFunctionCodeBlock* UnlinkedFunctionExecutable::unlinkedCodeBlockFor(
193     VM& vm, const SourceCode& source, CodeSpecializationKind specializationKind, 
194     DebuggerMode debuggerMode, ProfilerMode profilerMode, ParserError& error, SourceParseMode parseMode)
195 {
196     switch (specializationKind) {
197     case CodeForCall:
198         if (UnlinkedFunctionCodeBlock* codeBlock = m_unlinkedCodeBlockForCall.get())
199             return codeBlock;
200         break;
201     case CodeForConstruct:
202         if (UnlinkedFunctionCodeBlock* codeBlock = m_unlinkedCodeBlockForConstruct.get())
203             return codeBlock;
204         break;
205     }
206
207     UnlinkedFunctionCodeBlock* result = generateUnlinkedFunctionCodeBlock(
208         vm, this, source, specializationKind, debuggerMode, profilerMode, 
209         isBuiltinFunction() ? UnlinkedBuiltinFunction : UnlinkedNormalFunction, 
210         error, parseMode);
211     
212     if (error.isValid())
213         return nullptr;
214
215     switch (specializationKind) {
216     case CodeForCall:
217         m_unlinkedCodeBlockForCall.set(vm, this, result);
218         break;
219     case CodeForConstruct:
220         m_unlinkedCodeBlockForConstruct.set(vm, this, result);
221         break;
222     }
223     return result;
224 }
225
226 void UnlinkedFunctionExecutable::setInvalidTypeProfilingOffsets()
227 {
228     m_typeProfilingStartOffset = std::numeric_limits<unsigned>::max();
229     m_typeProfilingEndOffset = std::numeric_limits<unsigned>::max();
230 }
231
232 } // namespace JSC