c8bba0ac32be437ffb5df3e3f9e05b0478a5361b
[WebKit-https.git] / Source / JavaScriptCore / bytecode / UnlinkedFunctionExecutable.h
1 /*
2  * Copyright (C) 2012-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 #ifndef UnlinkedFunctionExecutable_h
27 #define UnlinkedFunctionExecutable_h
28
29 #include "BytecodeConventions.h"
30 #include "CodeSpecializationKind.h"
31 #include "CodeType.h"
32 #include "ConstructAbility.h"
33 #include "ExpressionRangeInfo.h"
34 #include "GeneratorThisMode.h"
35 #include "HandlerInfo.h"
36 #include "Identifier.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 #include <wtf/RefCountedArray.h>
45 #include <wtf/Vector.h>
46
47 namespace JSC {
48
49 class FunctionMetadataNode;
50 class FunctionExecutable;
51 class ParserError;
52 class SourceCode;
53 class SourceProvider;
54 class UnlinkedFunctionCodeBlock;
55
56 enum UnlinkedFunctionKind {
57     UnlinkedNormalFunction,
58     UnlinkedBuiltinFunction,
59 };
60
61 class UnlinkedFunctionExecutable final : public JSCell {
62 public:
63     friend class CodeCache;
64     friend class VM;
65
66     typedef JSCell Base;
67     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
68
69     static UnlinkedFunctionExecutable* create(VM* vm, const SourceCode& source, FunctionMetadataNode* node, UnlinkedFunctionKind unlinkedFunctionKind, ConstructAbility constructAbility, GeneratorThisMode generatorThisMode, VariableEnvironment& parentScopeTDZVariables, RefPtr<SourceProvider>&& sourceOverride = nullptr)
70     {
71         UnlinkedFunctionExecutable* instance = new (NotNull, allocateCell<UnlinkedFunctionExecutable>(vm->heap))
72             UnlinkedFunctionExecutable(vm, vm->unlinkedFunctionExecutableStructure.get(), source, WTF::move(sourceOverride), node, unlinkedFunctionKind, constructAbility, generatorThisMode, parentScopeTDZVariables);
73         instance->finishCreation(*vm);
74         return instance;
75     }
76
77     const Identifier& name() const { return m_name; }
78     const Identifier& inferredName() const { return m_inferredName; }
79     JSString* nameValue() const { return m_nameValue.get(); }
80     void setNameValue(VM& vm, JSString* nameValue) { m_nameValue.set(vm, this, nameValue); }
81     unsigned parameterCount() const { return m_parameterCount; };
82     SourceParseMode parseMode() const { return m_parseMode; };
83     bool isInStrictContext() const { return m_isInStrictContext; }
84     FunctionMode functionMode() const { return static_cast<FunctionMode>(m_functionMode); }
85     ConstructorKind constructorKind() const { return static_cast<ConstructorKind>(m_constructorKind); }
86     GeneratorThisMode generatorThisMode() const { return static_cast<GeneratorThisMode>(m_generatorThisMode); }
87     SuperBinding superBinding() const { return static_cast<SuperBinding>(m_superBinding); }
88
89     unsigned unlinkedFunctionNameStart() const { return m_unlinkedFunctionNameStart; }
90     unsigned unlinkedBodyStartColumn() const { return m_unlinkedBodyStartColumn; }
91     unsigned unlinkedBodyEndColumn() const { return m_unlinkedBodyEndColumn; }
92     unsigned startOffset() const { return m_startOffset; }
93     unsigned sourceLength() { return m_sourceLength; }
94     unsigned parametersStartOffset() const { return m_parametersStartOffset; }
95     unsigned typeProfilingStartOffset() const { return m_typeProfilingStartOffset; }
96     unsigned typeProfilingEndOffset() const { return m_typeProfilingEndOffset; }
97     void setInvalidTypeProfilingOffsets();
98
99     UnlinkedFunctionCodeBlock* unlinkedCodeBlockFor(
100         VM&, const SourceCode&, CodeSpecializationKind, DebuggerMode, ProfilerMode, 
101         ParserError&, SourceParseMode);
102
103     static UnlinkedFunctionExecutable* fromGlobalCode(
104         const Identifier&, ExecState&, const SourceCode&, JSObject*& exception, 
105         int overrideLineNumber);
106
107     JS_EXPORT_PRIVATE FunctionExecutable* link(VM&, const SourceCode&, int overrideLineNumber = -1);
108
109     void clearCode()
110     {
111         m_unlinkedCodeBlockForCall.clear();
112         m_unlinkedCodeBlockForConstruct.clear();
113     }
114
115     void recordParse(CodeFeatures features, bool hasCapturedVariables)
116     {
117         m_features = features;
118         m_hasCapturedVariables = hasCapturedVariables;
119     }
120
121     CodeFeatures features() const { return m_features; }
122     bool hasCapturedVariables() const { return m_hasCapturedVariables; }
123
124     static const bool needsDestruction = true;
125     static void destroy(JSCell*);
126
127     bool isBuiltinFunction() const { return m_isBuiltinFunction; }
128     ConstructAbility constructAbility() const { return static_cast<ConstructAbility>(m_constructAbility); }
129     bool isClassConstructorFunction() const { return constructorKind() != ConstructorKind::None; }
130     const VariableEnvironment* parentScopeTDZVariables() const { return &m_parentScopeTDZVariables; }
131
132 private:
133     UnlinkedFunctionExecutable(VM*, Structure*, const SourceCode&, RefPtr<SourceProvider>&& sourceOverride, FunctionMetadataNode*, UnlinkedFunctionKind, ConstructAbility, GeneratorThisMode, VariableEnvironment&);
134     WriteBarrier<UnlinkedFunctionCodeBlock> m_unlinkedCodeBlockForCall;
135     WriteBarrier<UnlinkedFunctionCodeBlock> m_unlinkedCodeBlockForConstruct;
136
137     Identifier m_name;
138     Identifier m_inferredName;
139     WriteBarrier<JSString> m_nameValue;
140     RefPtr<SourceProvider> m_sourceOverride;
141     VariableEnvironment m_parentScopeTDZVariables;
142     unsigned m_firstLineOffset;
143     unsigned m_lineCount;
144     unsigned m_unlinkedFunctionNameStart;
145     unsigned m_unlinkedBodyStartColumn;
146     unsigned m_unlinkedBodyEndColumn;
147     unsigned m_startOffset;
148     unsigned m_sourceLength;
149     unsigned m_parametersStartOffset;
150     unsigned m_typeProfilingStartOffset;
151     unsigned m_typeProfilingEndOffset;
152     unsigned m_parameterCount;
153     SourceParseMode m_parseMode;
154
155     CodeFeatures m_features;
156
157     unsigned m_isInStrictContext : 1;
158     unsigned m_hasCapturedVariables : 1;
159     unsigned m_isBuiltinFunction : 1;
160     unsigned m_constructAbility: 1;
161     unsigned m_constructorKind : 2;
162     unsigned m_functionMode : 1; // FunctionMode
163     unsigned m_generatorThisMode : 1;
164     unsigned m_superBinding : 1;
165
166 protected:
167     void finishCreation(VM& vm)
168     {
169         Base::finishCreation(vm);
170         m_nameValue.set(vm, this, jsString(&vm, name().string()));
171     }
172
173     static void visitChildren(JSCell*, SlotVisitor&);
174
175 public:
176     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue proto)
177     {
178         return Structure::create(vm, globalObject, proto, TypeInfo(UnlinkedFunctionExecutableType, StructureFlags), info());
179     }
180
181     DECLARE_EXPORT_INFO;
182 };
183
184 } // namespace JSC
185
186 #endif // UnlinkedFunctionExecutable_h