1891cb8c5c992f43f6dc1d5de0519fd1191f7f21
[WebKit-https.git] / Source / JavaScriptCore / bytecode / UnlinkedFunctionExecutable.cpp
1 /*
2  * Copyright (C) 2012, 2013, 2015 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* generateFunctionCodeBlock(
51     VM& vm, UnlinkedFunctionExecutable* executable, const SourceCode& source,
52     CodeSpecializationKind kind, DebuggerMode debuggerMode, ProfilerMode profilerMode,
53     UnlinkedFunctionKind functionKind, ParserError& error)
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(), 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     UnlinkedFunctionCodeBlock* result = UnlinkedFunctionCodeBlock::create(&vm, FunctionCode,
70         ExecutableInfo(function->needsActivation(), function->usesEval(), function->isStrictMode(), kind == CodeForConstruct, functionKind == UnlinkedBuiltinFunction, executable->constructorKind()));
71     auto generator(std::make_unique<BytecodeGenerator>(vm, function.get(), result, debuggerMode, profilerMode, executable->parentScopeTDZVariables()));
72     error = generator->generate();
73     if (error.isValid())
74         return nullptr;
75     return result;
76 }
77
78 UnlinkedFunctionExecutable::UnlinkedFunctionExecutable(VM* vm, Structure* structure, const SourceCode& source, RefPtr<SourceProvider>&& sourceOverride, FunctionMetadataNode* node, UnlinkedFunctionKind kind, ConstructAbility constructAbility, VariableEnvironment& parentScopeTDZVariables)
79     : Base(*vm, structure)
80     , m_name(node->ident())
81     , m_inferredName(node->inferredName())
82     , m_sourceOverride(WTF::move(sourceOverride))
83     , m_firstLineOffset(node->firstLine() - source.firstLine())
84     , m_lineCount(node->lastLine() - node->firstLine())
85     , m_unlinkedFunctionNameStart(node->functionNameStart() - source.startOffset())
86     , m_unlinkedBodyStartColumn(node->startColumn())
87     , m_unlinkedBodyEndColumn(m_lineCount ? node->endColumn() : node->endColumn() - node->startColumn())
88     , m_startOffset(node->source().startOffset() - source.startOffset())
89     , m_sourceLength(node->source().length())
90     , m_parametersStartOffset(node->parametersStart())
91     , m_typeProfilingStartOffset(node->functionKeywordStart())
92     , m_typeProfilingEndOffset(node->startStartOffset() + node->source().length() - 1)
93     , m_parameterCount(node->parameterCount())
94     , m_parseMode(node->parseMode())
95     , m_features(0)
96     , m_isInStrictContext(node->isInStrictContext())
97     , m_hasCapturedVariables(false)
98     , m_isBuiltinFunction(kind == UnlinkedBuiltinFunction)
99     , m_constructAbility(static_cast<unsigned>(constructAbility))
100     , m_constructorKind(static_cast<unsigned>(node->constructorKind()))
101     , m_functionMode(node->functionMode())
102 {
103     ASSERT(m_constructorKind == static_cast<unsigned>(node->constructorKind()));
104     m_parentScopeTDZVariables.swap(parentScopeTDZVariables);
105 }
106
107 void UnlinkedFunctionExecutable::visitChildren(JSCell* cell, SlotVisitor& visitor)
108 {
109     UnlinkedFunctionExecutable* thisObject = jsCast<UnlinkedFunctionExecutable*>(cell);
110     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
111     Base::visitChildren(thisObject, visitor);
112     visitor.append(&thisObject->m_codeBlockForCall);
113     visitor.append(&thisObject->m_codeBlockForConstruct);
114     visitor.append(&thisObject->m_nameValue);
115 }
116
117 FunctionExecutable* UnlinkedFunctionExecutable::link(VM& vm, const SourceCode& ownerSource, int overrideLineNumber)
118 {
119     SourceCode source = m_sourceOverride ? SourceCode(m_sourceOverride) : ownerSource;
120     unsigned firstLine = source.firstLine() + m_firstLineOffset;
121     unsigned startOffset = source.startOffset() + m_startOffset;
122     unsigned lineCount = m_lineCount;
123
124     // Adjust to one-based indexing.
125     bool startColumnIsOnFirstSourceLine = !m_firstLineOffset;
126     unsigned startColumn = m_unlinkedBodyStartColumn + (startColumnIsOnFirstSourceLine ? source.startColumn() : 1);
127     bool endColumnIsOnStartLine = !lineCount;
128     unsigned endColumn = m_unlinkedBodyEndColumn + (endColumnIsOnStartLine ? startColumn : 1);
129
130     SourceCode code(source.provider(), startOffset, startOffset + m_sourceLength, firstLine, startColumn);
131     FunctionOverrides::OverrideInfo overrideInfo;
132     bool hasFunctionOverride = false;
133
134     if (UNLIKELY(Options::functionOverrides())) {
135         hasFunctionOverride = FunctionOverrides::initializeOverrideFor(code, overrideInfo);
136         if (hasFunctionOverride) {
137             firstLine = overrideInfo.firstLine;
138             lineCount = overrideInfo.lineCount;
139             startColumn = overrideInfo.startColumn;
140             endColumn = overrideInfo.endColumn;
141             code = overrideInfo.sourceCode;
142         }
143     }
144
145     FunctionExecutable* result = FunctionExecutable::create(vm, code, this, firstLine, firstLine + lineCount, startColumn, endColumn);
146     if (overrideLineNumber != -1)
147         result->setOverrideLineNumber(overrideLineNumber);
148
149     if (UNLIKELY(hasFunctionOverride)) {
150         result->overrideParameterAndTypeProfilingStartEndOffsets(
151             overrideInfo.parametersStartOffset,
152             overrideInfo.typeProfilingStartOffset,
153             overrideInfo.typeProfilingEndOffset);
154     }
155
156     return result;
157 }
158
159 UnlinkedFunctionExecutable* UnlinkedFunctionExecutable::fromGlobalCode(
160     const Identifier& name, ExecState& exec, const SourceCode& source, 
161     JSObject*& exception, int overrideLineNumber)
162 {
163     ParserError error;
164     VM& vm = exec.vm();
165     CodeCache* codeCache = vm.codeCache();
166     UnlinkedFunctionExecutable* executable = codeCache->getFunctionExecutableFromGlobalCode(vm, name, source, error);
167
168     auto& globalObject = *exec.lexicalGlobalObject();
169     if (globalObject.hasDebugger())
170         globalObject.debugger()->sourceParsed(&exec, source.provider(), error.line(), error.message());
171
172     if (error.isValid()) {
173         exception = error.toErrorObject(&globalObject, source, overrideLineNumber);
174         return nullptr;
175     }
176
177     return executable;
178 }
179
180 UnlinkedFunctionCodeBlock* UnlinkedFunctionExecutable::codeBlockFor(
181     VM& vm, const SourceCode& source, CodeSpecializationKind specializationKind, 
182     DebuggerMode debuggerMode, ProfilerMode profilerMode, ParserError& error)
183 {
184     switch (specializationKind) {
185     case CodeForCall:
186         if (UnlinkedFunctionCodeBlock* codeBlock = m_codeBlockForCall.get())
187             return codeBlock;
188         break;
189     case CodeForConstruct:
190         if (UnlinkedFunctionCodeBlock* codeBlock = m_codeBlockForConstruct.get())
191             return codeBlock;
192         break;
193     }
194
195     UnlinkedFunctionCodeBlock* result = generateFunctionCodeBlock(
196         vm, this, source, specializationKind, debuggerMode, profilerMode, 
197         isBuiltinFunction() ? UnlinkedBuiltinFunction : UnlinkedNormalFunction, 
198         error);
199     
200     if (error.isValid())
201         return nullptr;
202
203     switch (specializationKind) {
204     case CodeForCall:
205         m_codeBlockForCall.set(vm, this, result);
206         break;
207     case CodeForConstruct:
208         m_codeBlockForConstruct.set(vm, this, result);
209         break;
210     }
211     return result;
212 }
213
214 } // namespace JSC