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