1/*
2 * Copyright (C) 2015 Yusuke Suzuki <utatane.tea@gmail.com>.
3 * Copyright (C) 2018 Apple Inc. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24 * THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include "JSFunction.h"
30
31namespace JSC {
32
33class JSGlobalObject;
34class LLIntOffsetsExtractor;
35
36class JSGeneratorFunction final : public JSFunction {
37 friend class JIT;
38#if ENABLE(DFG_JIT)
39 friend class DFG::SpeculativeJIT;
40 friend class DFG::JITCompiler;
41#endif
42 friend class VM;
43public:
44 typedef JSFunction Base;
45
46 enum class GeneratorResumeMode : int32_t {
47 NormalMode = 0,
48 ReturnMode = 1,
49 ThrowMode = 2
50 };
51
52 enum class GeneratorState : int32_t {
53 Completed = -1,
54 Executing = -2,
55 };
56
57 // [this], @generator, @generatorState, @generatorValue, @generatorResumeMode, @generatorFrame.
58 enum class GeneratorArgument : int32_t {
59 ThisValue = 0,
60 Generator = 1,
61 State = 2,
62 Value = 3,
63 ResumeMode = 4,
64 Frame = 5,
65 };
66
67 const static unsigned StructureFlags = Base::StructureFlags;
68
69 template<typename CellType, SubspaceAccess>
70 static IsoSubspace* subspaceFor(VM& vm)
71 {
72 return &vm.functionSpace;
73 }
74
75 DECLARE_EXPORT_INFO;
76
77 static JSGeneratorFunction* create(VM&, FunctionExecutable*, JSScope*);
78 static JSGeneratorFunction* create(VM&, FunctionExecutable*, JSScope*, Structure*);
79 static JSGeneratorFunction* createWithInvalidatedReallocationWatchpoint(VM&, FunctionExecutable*, JSScope*);
80
81 static size_t allocationSize(Checked<size_t> inlineCapacity)
82 {
83 ASSERT_UNUSED(inlineCapacity, !inlineCapacity);
84 return sizeof(JSGeneratorFunction);
85 }
86
87 static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
88 {
89 ASSERT(globalObject);
90 return Structure::create(vm, globalObject, prototype, TypeInfo(JSFunctionType, StructureFlags), info());
91 }
92
93private:
94 JSGeneratorFunction(VM&, FunctionExecutable*, JSScope*, Structure*);
95
96 static JSGeneratorFunction* createImpl(VM&, FunctionExecutable*, JSScope*, Structure*);
97
98 friend class LLIntOffsetsExtractor;
99};
100static_assert(sizeof(JSGeneratorFunction) == sizeof(JSFunction), "Some subclasses of JSFunction should be the same size to share IsoSubspace");
101
102} // namespace JSC
103