CodeBlocks should be in IsoSubspaces
[WebKit-https.git] / Source / JavaScriptCore / runtime / FunctionExecutable.h
1 /*
2  * Copyright (C) 2009-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 "ExecutableToCodeBlockEdge.h"
29 #include "ScriptExecutable.h"
30 #include "SourceCode.h"
31 #include <wtf/Box.h>
32
33 namespace JSC {
34
35 class FunctionExecutable final : public ScriptExecutable {
36     friend class JIT;
37     friend class LLIntOffsetsExtractor;
38 public:
39     typedef ScriptExecutable Base;
40     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
41
42     template<typename CellType>
43     static IsoSubspace* subspaceFor(VM& vm)
44     {
45         return &vm.functionExecutableSpace;
46     }
47
48     static FunctionExecutable* create(
49         VM& vm, const SourceCode& source, UnlinkedFunctionExecutable* unlinkedExecutable, 
50         unsigned lastLine, unsigned endColumn, Intrinsic intrinsic)
51     {
52         FunctionExecutable* executable = new (NotNull, allocateCell<FunctionExecutable>(vm.heap)) FunctionExecutable(vm, source, unlinkedExecutable, lastLine, endColumn, intrinsic);
53         executable->finishCreation(vm);
54         return executable;
55     }
56     static FunctionExecutable* fromGlobalCode(
57         const Identifier& name, ExecState&, const SourceCode&, 
58         JSObject*& exception, int overrideLineNumber);
59
60     static void destroy(JSCell*);
61         
62     UnlinkedFunctionExecutable* unlinkedExecutable() const
63     {
64         return m_unlinkedExecutable.get();
65     }
66
67     // Returns either call or construct bytecode. This can be appropriate
68     // for answering questions that that don't vary between call and construct --
69     // for example, argumentsRegister().
70     FunctionCodeBlock* eitherCodeBlock()
71     {
72         ExecutableToCodeBlockEdge* edge;
73         if (m_codeBlockForCall)
74             edge = m_codeBlockForCall.get();
75         else
76             edge = m_codeBlockForConstruct.get();
77         return bitwise_cast<FunctionCodeBlock*>(ExecutableToCodeBlockEdge::unwrap(edge));
78     }
79         
80     bool isGeneratedForCall() const
81     {
82         return !!m_codeBlockForCall;
83     }
84
85     FunctionCodeBlock* codeBlockForCall()
86     {
87         return bitwise_cast<FunctionCodeBlock*>(ExecutableToCodeBlockEdge::unwrap(m_codeBlockForCall.get()));
88     }
89
90     bool isGeneratedForConstruct() const
91     {
92         return !!m_codeBlockForConstruct;
93     }
94
95     FunctionCodeBlock* codeBlockForConstruct()
96     {
97         return bitwise_cast<FunctionCodeBlock*>(ExecutableToCodeBlockEdge::unwrap(m_codeBlockForConstruct.get()));
98     }
99         
100     bool isGeneratedFor(CodeSpecializationKind kind)
101     {
102         if (kind == CodeForCall)
103             return isGeneratedForCall();
104         ASSERT(kind == CodeForConstruct);
105         return isGeneratedForConstruct();
106     }
107         
108     FunctionCodeBlock* codeBlockFor(CodeSpecializationKind kind)
109     {
110         if (kind == CodeForCall)
111             return codeBlockForCall();
112         ASSERT(kind == CodeForConstruct);
113         return codeBlockForConstruct();
114     }
115
116     FunctionCodeBlock* baselineCodeBlockFor(CodeSpecializationKind);
117         
118     FunctionCodeBlock* profiledCodeBlockFor(CodeSpecializationKind kind)
119     {
120         return baselineCodeBlockFor(kind);
121     }
122
123     RefPtr<TypeSet> returnStatementTypeSet() 
124     {
125         if (!m_returnStatementTypeSet)
126             m_returnStatementTypeSet = TypeSet::create();
127
128         return m_returnStatementTypeSet;
129     }
130         
131     FunctionMode functionMode() { return m_unlinkedExecutable->functionMode(); }
132     bool isBuiltinFunction() const { return m_unlinkedExecutable->isBuiltinFunction(); }
133     ConstructAbility constructAbility() const { return m_unlinkedExecutable->constructAbility(); }
134     bool isClass() const { return !classSource().isNull(); }
135     bool isArrowFunction() const { return parseMode() == SourceParseMode::ArrowFunctionMode; }
136     bool isGetter() const { return parseMode() == SourceParseMode::GetterMode; }
137     bool isSetter() const { return parseMode() == SourceParseMode::SetterMode; }
138     bool isGenerator() const { return isGeneratorParseMode(parseMode()); }
139     bool isAsyncGenerator() const { return SourceParseModeSet(SourceParseMode::AsyncGeneratorWrapperFunctionMode, SourceParseMode::AsyncGeneratorBodyMode).contains(parseMode()); }
140     bool isMethod() const { return parseMode() == SourceParseMode::MethodMode; }
141     bool hasCallerAndArgumentsProperties() const
142     {
143         // Per https://tc39.github.io/ecma262/#sec-forbidden-extensions, only sloppy-mode non-builtin functions in old-style (pre-ES6) syntactic forms can contain
144         // "caller" and "arguments".
145         return !isStrictMode() && parseMode() == SourceParseMode::NormalFunctionMode && !isClassConstructorFunction();
146     }
147     bool hasPrototypeProperty() const
148     {
149         return SourceParseModeSet(
150             SourceParseMode::NormalFunctionMode,
151             SourceParseMode::GeneratorBodyMode,
152             SourceParseMode::GeneratorWrapperFunctionMode,
153             SourceParseMode::GeneratorWrapperMethodMode,
154             SourceParseMode::AsyncGeneratorWrapperFunctionMode,
155             SourceParseMode::AsyncGeneratorBodyMode
156         ).contains(parseMode()) || isClass();
157     }
158     DerivedContextType derivedContextType() const { return m_unlinkedExecutable->derivedContextType(); }
159     bool isClassConstructorFunction() const { return m_unlinkedExecutable->isClassConstructorFunction(); }
160     const Identifier& name() { return m_unlinkedExecutable->name(); }
161     const Identifier& ecmaName() { return m_unlinkedExecutable->ecmaName(); }
162     const Identifier& inferredName() { return m_unlinkedExecutable->inferredName(); }
163     unsigned parameterCount() const { return m_unlinkedExecutable->parameterCount(); } // Excluding 'this'!
164     SourceParseMode parseMode() const { return m_unlinkedExecutable->parseMode(); }
165     JSParserScriptMode scriptMode() const { return m_unlinkedExecutable->scriptMode(); }
166     const SourceCode& classSource() const { return m_unlinkedExecutable->classSource(); }
167
168     static void visitChildren(JSCell*, SlotVisitor&);
169     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue proto)
170     {
171         return Structure::create(vm, globalObject, proto, TypeInfo(FunctionExecutableType, StructureFlags), info());
172     }
173
174     unsigned parametersStartOffset() const { return m_parametersStartOffset; }
175
176     void overrideParameterAndTypeProfilingStartEndOffsets(unsigned parametersStartOffset, unsigned typeProfilingStartOffset, unsigned typeProfilingEndOffset)
177     {
178         m_parametersStartOffset = parametersStartOffset;
179         m_typeProfilingStartOffset = typeProfilingStartOffset;
180         m_typeProfilingEndOffset = typeProfilingEndOffset;
181     }
182
183     DECLARE_INFO;
184
185     InferredValue* singletonFunction() { return m_singletonFunction.get(); }
186     // Cached poly proto structure for the result of constructing this executable.
187     Structure* cachedPolyProtoStructure() { return m_cachedPolyProtoStructure.get(); }
188     void setCachedPolyProtoStructure(VM& vm, Structure* structure) { m_cachedPolyProtoStructure.set(vm, this, structure); }
189
190     InlineWatchpointSet& ensurePolyProtoWatchpoint()
191     {
192         if (!m_polyProtoWatchpoint)
193             m_polyProtoWatchpoint = Box<InlineWatchpointSet>::create(IsWatched);
194         return *m_polyProtoWatchpoint;
195     }
196
197     Box<InlineWatchpointSet> sharedPolyProtoWatchpoint() const { return m_polyProtoWatchpoint; }
198
199 private:
200     friend class ExecutableBase;
201     FunctionExecutable(
202         VM&, const SourceCode&, UnlinkedFunctionExecutable*,
203         unsigned lastLine, unsigned endColumn, Intrinsic);
204     
205     void finishCreation(VM&);
206
207     friend class ScriptExecutable;
208     
209     unsigned m_parametersStartOffset;
210     WriteBarrier<UnlinkedFunctionExecutable> m_unlinkedExecutable;
211     WriteBarrier<ExecutableToCodeBlockEdge> m_codeBlockForCall;
212     WriteBarrier<ExecutableToCodeBlockEdge> m_codeBlockForConstruct;
213     RefPtr<TypeSet> m_returnStatementTypeSet;
214     WriteBarrier<InferredValue> m_singletonFunction;
215     WriteBarrier<Structure> m_cachedPolyProtoStructure;
216     Box<InlineWatchpointSet> m_polyProtoWatchpoint;
217 };
218
219 } // namespace JSC