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