645c258e557be9e47a427afc3a7fac4497e686ab
[WebKit-https.git] / Source / JavaScriptCore / bytecode / ArithProfile.h
1 /*
2  * Copyright (C) 2016 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 "GPRInfo.h"
29 #include "JSCJSValue.h"
30 #include "ResultType.h"
31 #include "TagRegistersMode.h"
32
33 namespace JSC {
34
35 class CCallHelpers;
36
37 struct ObservedType {
38     constexpr ObservedType(uint8_t bits = TypeEmpty)
39         : m_bits(bits)
40     { }
41
42     constexpr bool sawInt32() const { return m_bits & TypeInt32; }
43     constexpr bool isOnlyInt32() const { return m_bits == TypeInt32; }
44     constexpr bool sawNumber() const { return m_bits & TypeNumber; }
45     constexpr bool isOnlyNumber() const { return m_bits == TypeNumber; }
46     constexpr bool sawNonNumber() const { return m_bits & TypeNonNumber; }
47     constexpr bool isOnlyNonNumber() const { return m_bits == TypeNonNumber; }
48     constexpr bool isEmpty() const { return !m_bits; }
49     constexpr uint8_t bits() const { return m_bits; }
50
51     constexpr ObservedType withInt32() const { return ObservedType(m_bits | TypeInt32); }
52     constexpr ObservedType withNumber() const { return ObservedType(m_bits | TypeNumber); }
53     constexpr ObservedType withNonNumber() const { return ObservedType(m_bits | TypeNonNumber); }
54     constexpr ObservedType withoutNonNumber() const { return ObservedType(m_bits & ~TypeNonNumber); }
55
56     constexpr bool operator==(const ObservedType& other) const { return m_bits == other.m_bits; }
57
58     static constexpr uint8_t TypeEmpty = 0x0;
59     static constexpr uint8_t TypeInt32 = 0x1;
60     static constexpr uint8_t TypeNumber = 0x02;
61     static constexpr uint8_t TypeNonNumber = 0x04;
62
63     static constexpr uint32_t numBitsNeeded = 3;
64
65 private:
66     uint8_t m_bits { 0 };
67 };
68
69 struct ArithProfile {
70 private:
71     static constexpr uint32_t numberOfFlagBits = 5;
72     static constexpr uint32_t rhsResultTypeShift = numberOfFlagBits;
73     static constexpr uint32_t lhsResultTypeShift = rhsResultTypeShift + ResultType::numBitsNeeded;
74     static constexpr uint32_t rhsObservedTypeShift = lhsResultTypeShift + ResultType::numBitsNeeded;
75     static constexpr uint32_t lhsObservedTypeShift = rhsObservedTypeShift + ObservedType::numBitsNeeded;
76
77     static_assert(ObservedType::numBitsNeeded == 3, "We make a hard assumption about that here.");
78     static constexpr uint32_t clearRhsObservedTypeBitMask = static_cast<uint32_t>(~((1 << rhsObservedTypeShift) | (1 << (rhsObservedTypeShift + 1)) | (1 << (rhsObservedTypeShift + 2))));
79     static constexpr uint32_t clearLhsObservedTypeBitMask = static_cast<uint32_t>(~((1 << lhsObservedTypeShift) | (1 << (lhsObservedTypeShift + 1)) | (1 << (lhsObservedTypeShift + 2))));
80
81     static constexpr uint32_t resultTypeMask = (1 << ResultType::numBitsNeeded) - 1;
82     static constexpr uint32_t observedTypeMask = (1 << ObservedType::numBitsNeeded) - 1;
83
84     enum class ConstantTag { Constant };
85
86 public:
87     static constexpr uint32_t specialFastPathBit = 1 << (lhsObservedTypeShift + ObservedType::numBitsNeeded);
88     static_assert((lhsObservedTypeShift + ObservedType::numBitsNeeded) <= (sizeof(uint32_t) * 8) - 1, "Should fit in a uint32_t.");
89     static_assert(!(specialFastPathBit & ~clearLhsObservedTypeBitMask), "These bits should not intersect.");
90     static_assert(specialFastPathBit & clearLhsObservedTypeBitMask, "These bits should intersect.");
91     static_assert(specialFastPathBit > ~clearLhsObservedTypeBitMask, "These bits should not intersect and specialFastPathBit should be a higher bit.");
92
93     ArithProfile(ResultType arg)
94         : ArithProfile(ConstantTag::Constant, arg)
95     {
96         ASSERT(lhsResultType().bits() == arg.bits());
97         ASSERT(lhsObservedType().isEmpty());
98         ASSERT(rhsObservedType().isEmpty());
99     }
100
101     ArithProfile(ResultType lhs, ResultType rhs)
102         : ArithProfile(ConstantTag::Constant, lhs, rhs)
103     {
104         ASSERT(lhsResultType().bits() == lhs.bits() && rhsResultType().bits() == rhs.bits());
105         ASSERT(lhsObservedType().isEmpty());
106         ASSERT(rhsObservedType().isEmpty());
107     }
108
109     ArithProfile(OperandTypes types)
110         : ArithProfile(types.first(), types.second())
111     { }
112
113     ArithProfile() = default;
114
115     static constexpr ArithProfile fromInt(uint32_t bits)
116     {
117         return ArithProfile { ConstantTag::Constant, bits };
118     }
119
120     static constexpr ArithProfile observedUnaryInt()
121     {
122         constexpr ObservedType observedInt32 { ObservedType().withInt32() };
123         constexpr uint32_t bits = observedInt32.bits() << lhsObservedTypeShift;
124         static_assert(bits == 0x400000, "");
125         return fromInt(bits);
126     }
127     static constexpr ArithProfile observedUnaryNumber()
128     {
129         constexpr ObservedType observedNumber { ObservedType().withNumber() };
130         constexpr uint32_t bits = observedNumber.bits() << lhsObservedTypeShift;
131         static_assert(bits == 0x800000, "");
132         return fromInt(bits);
133     }
134     static constexpr ArithProfile observedBinaryIntInt()
135     {
136         constexpr ObservedType observedInt32 { ObservedType().withInt32() };
137         constexpr uint32_t bits = (observedInt32.bits() << lhsObservedTypeShift) | (observedInt32.bits() << rhsObservedTypeShift);
138         static_assert(bits == 0x480000, "");
139         return fromInt(bits);
140     }
141     static constexpr ArithProfile observedBinaryNumberInt()
142     {
143         constexpr ObservedType observedNumber { ObservedType().withNumber() };
144         constexpr ObservedType observedInt32 { ObservedType().withInt32() };
145         constexpr uint32_t bits = (observedNumber.bits() << lhsObservedTypeShift) | (observedInt32.bits() << rhsObservedTypeShift);
146         static_assert(bits == 0x880000, "");
147         return fromInt(bits);
148     }
149     static constexpr ArithProfile observedBinaryIntNumber()
150     {
151         constexpr ObservedType observedNumber { ObservedType().withNumber() };
152         constexpr ObservedType observedInt32 { ObservedType().withInt32() };
153         constexpr uint32_t bits = (observedInt32.bits() << lhsObservedTypeShift) | (observedNumber.bits() << rhsObservedTypeShift);
154         static_assert(bits == 0x500000, "");
155         return fromInt(bits);
156     }
157     static constexpr ArithProfile observedBinaryNumberNumber()
158     {
159         constexpr ObservedType observedNumber { ObservedType().withNumber() };
160         constexpr uint32_t bits = (observedNumber.bits() << lhsObservedTypeShift) | (observedNumber.bits() << rhsObservedTypeShift);
161         static_assert(bits == 0x900000, "");
162         return fromInt(bits);
163     }
164
165     enum ObservedResults {
166         NonNegZeroDouble = 1 << 0,
167         NegZeroDouble    = 1 << 1,
168         NonNumber        = 1 << 2,
169         Int32Overflow    = 1 << 3,
170         Int52Overflow    = 1 << 4,
171     };
172
173     ResultType lhsResultType() const { return ResultType((m_bits >> lhsResultTypeShift) & resultTypeMask); }
174     ResultType rhsResultType() const { return ResultType((m_bits >> rhsResultTypeShift) & resultTypeMask); }
175
176     constexpr ObservedType lhsObservedType() const { return ObservedType((m_bits >> lhsObservedTypeShift) & observedTypeMask); }
177     constexpr ObservedType rhsObservedType() const { return ObservedType((m_bits >> rhsObservedTypeShift) & observedTypeMask); }
178     void setLhsObservedType(ObservedType type)
179     {
180         uint32_t bits = m_bits;
181         bits &= clearLhsObservedTypeBitMask;
182         bits |= type.bits() << lhsObservedTypeShift;
183         m_bits = bits;
184         ASSERT(lhsObservedType() == type);
185     }
186
187     void setRhsObservedType(ObservedType type)
188     { 
189         uint32_t bits = m_bits;
190         bits &= clearRhsObservedTypeBitMask;
191         bits |= type.bits() << rhsObservedTypeShift;
192         m_bits = bits;
193         ASSERT(rhsObservedType() == type);
194     }
195
196     bool tookSpecialFastPath() const { return m_bits & specialFastPathBit; }
197
198     bool didObserveNonInt32() const { return hasBits(NonNegZeroDouble | NegZeroDouble | NonNumber); }
199     bool didObserveDouble() const { return hasBits(NonNegZeroDouble | NegZeroDouble); }
200     bool didObserveNonNegZeroDouble() const { return hasBits(NonNegZeroDouble); }
201     bool didObserveNegZeroDouble() const { return hasBits(NegZeroDouble); }
202     bool didObserveNonNumber() const { return hasBits(NonNumber); }
203     bool didObserveInt32Overflow() const { return hasBits(Int32Overflow); }
204     bool didObserveInt52Overflow() const { return hasBits(Int52Overflow); }
205
206     void setObservedNonNegZeroDouble() { setBit(NonNegZeroDouble); }
207     void setObservedNegZeroDouble() { setBit(NegZeroDouble); }
208     void setObservedNonNumber() { setBit(NonNumber); }
209     void setObservedInt32Overflow() { setBit(Int32Overflow); }
210     void setObservedInt52Overflow() { setBit(Int52Overflow); }
211
212     const void* addressOfBits() const { return &m_bits; }
213
214     void observeResult(JSValue value)
215     {
216         if (value.isInt32())
217             return;
218         if (value.isNumber()) {
219             m_bits |= Int32Overflow | Int52Overflow | NonNegZeroDouble | NegZeroDouble;
220             return;
221         }
222         m_bits |= NonNumber;
223     }
224
225     void lhsSawInt32() { setLhsObservedType(lhsObservedType().withInt32()); }
226     void lhsSawNumber() { setLhsObservedType(lhsObservedType().withNumber()); }
227     void lhsSawNonNumber() { setLhsObservedType(lhsObservedType().withNonNumber()); }
228     void rhsSawInt32() { setRhsObservedType(rhsObservedType().withInt32()); }
229     void rhsSawNumber() { setRhsObservedType(rhsObservedType().withNumber()); }
230     void rhsSawNonNumber() { setRhsObservedType(rhsObservedType().withNonNumber()); }
231
232     void observeLHS(JSValue lhs)
233     {
234         ArithProfile newProfile = *this;
235         if (lhs.isNumber()) {
236             if (lhs.isInt32())
237                 newProfile.lhsSawInt32();
238             else
239                 newProfile.lhsSawNumber();
240         } else
241             newProfile.lhsSawNonNumber();
242
243         m_bits = newProfile.bits();
244     }
245
246     void observeLHSAndRHS(JSValue lhs, JSValue rhs)
247     {
248         observeLHS(lhs);
249
250         ArithProfile newProfile = *this;
251         if (rhs.isNumber()) {
252             if (rhs.isInt32())
253                 newProfile.rhsSawInt32();
254             else
255                 newProfile.rhsSawNumber();
256         } else
257             newProfile.rhsSawNonNumber();
258
259         m_bits = newProfile.bits();
260     }
261
262 #if ENABLE(JIT)    
263     // Sets (Int32Overflow | Int52Overflow | NonNegZeroDouble | NegZeroDouble) if it sees a
264     // double. Sets NonNumber if it sees a non-number.
265     void emitObserveResult(CCallHelpers&, JSValueRegs, TagRegistersMode = HaveTagRegisters);
266     
267     // Sets (Int32Overflow | Int52Overflow | NonNegZeroDouble | NegZeroDouble).
268     bool shouldEmitSetDouble() const;
269     void emitSetDouble(CCallHelpers&) const;
270     
271     // Sets NonNumber.
272     void emitSetNonNumber(CCallHelpers&) const;
273     bool shouldEmitSetNonNumber() const;
274 #endif // ENABLE(JIT)
275
276     constexpr uint32_t bits() const { return m_bits; }
277
278 private:
279     constexpr explicit ArithProfile(ConstantTag, uint32_t bits)
280         : m_bits(bits)
281     {
282     }
283
284     constexpr ArithProfile(ConstantTag, ResultType arg)
285         : m_bits(arg.bits() << lhsResultTypeShift)
286     {
287     }
288
289     constexpr ArithProfile(ConstantTag, ResultType lhs, ResultType rhs)
290         : m_bits((lhs.bits() << lhsResultTypeShift) | (rhs.bits() << rhsResultTypeShift))
291     {
292     }
293
294     bool hasBits(int mask) const { return m_bits & mask; }
295     void setBit(int mask) { m_bits |= mask; }
296
297     uint32_t m_bits { 0 }; // We take care to update m_bits only in a single operation. We don't ever store an inconsistent bit representation to it.
298 };
299
300 } // namespace JSC
301
302 namespace WTF {
303
304 void printInternal(PrintStream&, const JSC::ArithProfile&);
305 void printInternal(PrintStream&, const JSC::ObservedType&);
306
307 } // namespace WTF