526898c951d82175979881102f9dc7d615b01522
[WebKit-https.git] / Source / JavaScriptCore / bytecode / UnlinkedFunctionExecutable.h
1 /*
2  * Copyright (C) 2012-2018 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 #pragma once
27
28 #include "CodeSpecializationKind.h"
29 #include "ConstructAbility.h"
30 #include "ExecutableInfo.h"
31 #include "ExpressionRangeInfo.h"
32 #include "Identifier.h"
33 #include "Intrinsic.h"
34 #include "JSCast.h"
35 #include "ParserModes.h"
36 #include "RegExp.h"
37 #include "SourceCode.h"
38 #include "VariableEnvironment.h"
39
40 namespace JSC {
41
42 class FunctionMetadataNode;
43 class FunctionExecutable;
44 class ParserError;
45 class SourceProvider;
46 class UnlinkedFunctionCodeBlock;
47
48 enum UnlinkedFunctionKind {
49     UnlinkedNormalFunction,
50     UnlinkedBuiltinFunction,
51 };
52
53 class UnlinkedFunctionExecutable final : public JSCell {
54 public:
55     friend class CodeCache;
56     friend class VM;
57
58     typedef JSCell Base;
59     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
60
61     template<typename CellType>
62     static IsoSubspace* subspaceFor(VM& vm)
63     {
64         return &vm.unlinkedFunctionExecutableSpace.space;
65     }
66
67     static UnlinkedFunctionExecutable* create(VM* vm, const SourceCode& source, FunctionMetadataNode* node, UnlinkedFunctionKind unlinkedFunctionKind, ConstructAbility constructAbility, JSParserScriptMode scriptMode, VariableEnvironment& parentScopeTDZVariables, DerivedContextType derivedContextType, bool isBuiltinDefaultClassConstructor = false)
68     {
69         UnlinkedFunctionExecutable* instance = new (NotNull, allocateCell<UnlinkedFunctionExecutable>(vm->heap))
70             UnlinkedFunctionExecutable(vm, vm->unlinkedFunctionExecutableStructure.get(), source, node, unlinkedFunctionKind, constructAbility, scriptMode, parentScopeTDZVariables, derivedContextType, isBuiltinDefaultClassConstructor);
71         instance->finishCreation(*vm);
72         return instance;
73     }
74
75     const Identifier& name() const { return m_name; }
76     const Identifier& ecmaName() const { return m_ecmaName; }
77     void setEcmaName(const Identifier& name) { m_ecmaName = name; }
78     const Identifier& inferredName() const { return m_inferredName; }
79     unsigned parameterCount() const { return m_parameterCount; }; // Excluding 'this'!
80     SourceParseMode parseMode() const { return static_cast<SourceParseMode>(m_sourceParseMode); };
81
82     const SourceCode& classSource() const { return m_classSource; };
83     void setClassSource(const SourceCode& source) { m_classSource = source; };
84
85     bool isInStrictContext() const { return m_isInStrictContext; }
86     FunctionMode functionMode() const { return static_cast<FunctionMode>(m_functionMode); }
87     ConstructorKind constructorKind() const { return static_cast<ConstructorKind>(m_constructorKind); }
88     SuperBinding superBinding() const { return static_cast<SuperBinding>(m_superBinding); }
89
90     unsigned lineCount() const { return m_lineCount; }
91     unsigned linkedStartColumn(unsigned parentStartColumn) const { return m_unlinkedBodyStartColumn + (!m_firstLineOffset ? parentStartColumn : 1); }
92     unsigned linkedEndColumn(unsigned startColumn) const { return m_unlinkedBodyEndColumn + (!m_lineCount ? startColumn : 1); }
93
94     unsigned unlinkedFunctionNameStart() const { return m_unlinkedFunctionNameStart; }
95     unsigned unlinkedBodyStartColumn() const { return m_unlinkedBodyStartColumn; }
96     unsigned unlinkedBodyEndColumn() const { return m_unlinkedBodyEndColumn; }
97     unsigned startOffset() const { return m_startOffset; }
98     unsigned sourceLength() { return m_sourceLength; }
99     unsigned parametersStartOffset() const { return m_parametersStartOffset; }
100     unsigned typeProfilingStartOffset() const { return m_typeProfilingStartOffset; }
101     unsigned typeProfilingEndOffset() const { return m_typeProfilingEndOffset; }
102     void setInvalidTypeProfilingOffsets();
103
104     UnlinkedFunctionCodeBlock* unlinkedCodeBlockFor(
105         VM&, const SourceCode&, CodeSpecializationKind, DebuggerMode,
106         ParserError&, SourceParseMode);
107
108     static UnlinkedFunctionExecutable* fromGlobalCode(
109         const Identifier&, ExecState&, const SourceCode&, JSObject*& exception, 
110         int overrideLineNumber, Optional<int> functionConstructorParametersEndPosition);
111
112     JS_EXPORT_PRIVATE FunctionExecutable* link(VM&, const SourceCode& parentSource, Optional<int> overrideLineNumber = WTF::nullopt, Intrinsic = NoIntrinsic);
113
114     void clearCode(VM& vm)
115     {
116         m_unlinkedCodeBlockForCall.clear();
117         m_unlinkedCodeBlockForConstruct.clear();
118         vm.unlinkedFunctionExecutableSpace.clearableCodeSet.remove(this);
119     }
120
121     void recordParse(CodeFeatures features, bool hasCapturedVariables)
122     {
123         m_features = features;
124         m_hasCapturedVariables = hasCapturedVariables;
125     }
126
127     CodeFeatures features() const { return m_features; }
128     bool hasCapturedVariables() const { return m_hasCapturedVariables; }
129
130     static const bool needsDestruction = true;
131     static void destroy(JSCell*);
132
133     bool isBuiltinFunction() const { return m_isBuiltinFunction; }
134     ConstructAbility constructAbility() const { return static_cast<ConstructAbility>(m_constructAbility); }
135     JSParserScriptMode scriptMode() const { return static_cast<JSParserScriptMode>(m_scriptMode); }
136     bool isClassConstructorFunction() const { return constructorKind() != ConstructorKind::None; }
137     VariableEnvironment parentScopeTDZVariables() const { return m_parentScopeTDZVariables.environment().toVariableEnvironment(); }
138     
139     bool isArrowFunction() const { return isArrowFunctionParseMode(parseMode()); }
140
141     JSC::DerivedContextType derivedContextType() const {return static_cast<JSC::DerivedContextType>(m_derivedContextType); }
142
143     const String& sourceURLDirective() const { return m_sourceURLDirective; }
144     const String& sourceMappingURLDirective() const { return m_sourceMappingURLDirective; }
145     void setSourceURLDirective(const String& sourceURL) { m_sourceURLDirective = sourceURL; }
146     void setSourceMappingURLDirective(const String& sourceMappingURL) { m_sourceMappingURLDirective = sourceMappingURL; }
147
148 private:
149     UnlinkedFunctionExecutable(VM*, Structure*, const SourceCode&, FunctionMetadataNode*, UnlinkedFunctionKind, ConstructAbility, JSParserScriptMode, VariableEnvironment&,  JSC::DerivedContextType, bool isBuiltinDefaultClassConstructor);
150
151     unsigned m_firstLineOffset;
152     unsigned m_lineCount;
153     unsigned m_unlinkedFunctionNameStart;
154     unsigned m_unlinkedBodyStartColumn;
155     unsigned m_unlinkedBodyEndColumn;
156     unsigned m_startOffset;
157     unsigned m_sourceLength;
158     unsigned m_parametersStartOffset;
159     unsigned m_typeProfilingStartOffset;
160     unsigned m_typeProfilingEndOffset;
161     unsigned m_parameterCount;
162     CodeFeatures m_features;
163     SourceParseMode m_sourceParseMode;
164     unsigned m_isInStrictContext : 1;
165     unsigned m_hasCapturedVariables : 1;
166     unsigned m_isBuiltinFunction : 1;
167     unsigned m_isBuiltinDefaultClassConstructor : 1;
168     unsigned m_constructAbility: 1;
169     unsigned m_constructorKind : 2;
170     unsigned m_functionMode : 2; // FunctionMode
171     unsigned m_scriptMode: 1; // JSParserScriptMode
172     unsigned m_superBinding : 1;
173     unsigned m_derivedContextType: 2;
174
175     WriteBarrier<UnlinkedFunctionCodeBlock> m_unlinkedCodeBlockForCall;
176     WriteBarrier<UnlinkedFunctionCodeBlock> m_unlinkedCodeBlockForConstruct;
177
178     Identifier m_name;
179     Identifier m_ecmaName;
180     Identifier m_inferredName;
181     SourceCode m_classSource;
182
183     String m_sourceURLDirective;
184     String m_sourceMappingURLDirective;
185
186     CompactVariableMap::Handle m_parentScopeTDZVariables;
187
188 protected:
189     static void visitChildren(JSCell*, SlotVisitor&);
190
191 public:
192     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue proto)
193     {
194         return Structure::create(vm, globalObject, proto, TypeInfo(UnlinkedFunctionExecutableType, StructureFlags), info());
195     }
196
197     DECLARE_EXPORT_INFO;
198 };
199
200 } // namespace JSC