We should support CreateThis in the FTL
[WebKit-https.git] / Source / JavaScriptCore / bytecode / PutByIdVariant.h
1 /*
2  * Copyright (C) 2014-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 "ObjectPropertyConditionSet.h"
29 #include "PropertyOffset.h"
30 #include "StructureSet.h"
31
32 namespace JSC {
33
34 class CallLinkStatus;
35
36 class PutByIdVariant {
37 public:
38     enum Kind {
39         NotSet,
40         Replace,
41         Transition,
42         Setter
43     };
44     
45     PutByIdVariant()
46         : m_kind(NotSet)
47         , m_newStructure(nullptr)
48         , m_offset(invalidOffset)
49     {
50     }
51     
52     PutByIdVariant(const PutByIdVariant&);
53     PutByIdVariant& operator=(const PutByIdVariant&);
54
55     static PutByIdVariant replace(const StructureSet&, PropertyOffset, const InferredType::Descriptor&);
56     
57     static PutByIdVariant transition(
58         const StructureSet& oldStructure, Structure* newStructure,
59         const ObjectPropertyConditionSet&, PropertyOffset, const InferredType::Descriptor&);
60     
61     static PutByIdVariant setter(
62         const StructureSet&, PropertyOffset, const ObjectPropertyConditionSet&,
63         std::unique_ptr<CallLinkStatus>);
64     
65     Kind kind() const { return m_kind; }
66     
67     bool isSet() const { return kind() != NotSet; }
68     bool operator!() const { return !isSet(); }
69     
70     const StructureSet& structure() const
71     {
72         ASSERT(kind() == Replace || kind() == Setter);
73         return m_oldStructure;
74     }
75     
76     const StructureSet& oldStructure() const
77     {
78         ASSERT(kind() == Transition || kind() == Replace || kind() == Setter);
79         return m_oldStructure;
80     }
81     
82     const StructureSet& structureSet() const
83     {
84         return oldStructure();
85     }
86     
87     StructureSet& oldStructure()
88     {
89         ASSERT(kind() == Transition || kind() == Replace || kind() == Setter);
90         return m_oldStructure;
91     }
92     
93     StructureSet& structureSet()
94     {
95         return oldStructure();
96     }
97     
98     Structure* oldStructureForTransition() const;
99     
100     Structure* newStructure() const
101     {
102         ASSERT(kind() == Transition);
103         return m_newStructure;
104     }
105     
106     void fixTransitionToReplaceIfNecessary();
107
108     InferredType::Descriptor requiredType() const
109     {
110         return m_requiredType;
111     }
112
113     bool writesStructures() const;
114     bool reallocatesStorage() const;
115     bool makesCalls() const;
116     
117     const ObjectPropertyConditionSet& conditionSet() const { return m_conditionSet; }
118     
119     // We don't support intrinsics for Setters (it would be sweet if we did) but we need this for templated helpers.
120     Intrinsic intrinsic() const { return NoIntrinsic; }
121
122     // This is needed for templated helpers.
123     bool isPropertyUnset() const { return false; }
124
125     PropertyOffset offset() const
126     {
127         ASSERT(isSet());
128         return m_offset;
129     }
130     
131     CallLinkStatus* callLinkStatus() const
132     {
133         ASSERT(kind() == Setter);
134         return m_callLinkStatus.get();
135     }
136
137     bool attemptToMerge(const PutByIdVariant& other);
138     
139     void markIfCheap(SlotVisitor&);
140     bool finalize();
141     
142     void dump(PrintStream&) const;
143     void dumpInContext(PrintStream&, DumpContext*) const;
144
145 private:
146     bool attemptToMergeTransitionWithReplace(const PutByIdVariant& replace);
147     
148     Kind m_kind;
149     StructureSet m_oldStructure;
150     Structure* m_newStructure { nullptr };
151     ObjectPropertyConditionSet m_conditionSet;
152     PropertyOffset m_offset;
153     InferredType::Descriptor m_requiredType;
154     std::unique_ptr<CallLinkStatus> m_callLinkStatus;
155 };
156
157 } // namespace JSC