[ESNext][BigInt] Implement support for "=<" and ">=" relational operation
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSBigInt.h
1 /*
2  * Copyright (C) 2017 Caio Lima <ticaiolima@gmail.com>
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 "ExceptionHelpers.h"
29 #include "JSObject.h"
30 #include "ParseInt.h"
31 #include <wtf/CagedPtr.h>
32 #include <wtf/text/StringBuilder.h>
33 #include <wtf/text/StringView.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace JSC {
37
38 class JSBigInt final : public JSCell {
39     using Base = JSCell;
40     static const unsigned StructureFlags = Base::StructureFlags | OverridesToThis;
41
42 public:
43
44     JSBigInt(VM&, Structure*, unsigned length);
45
46     enum class InitializationType { None, WithZero };
47     void initialize(InitializationType);
48
49     static void visitChildren(JSCell*, SlotVisitor&);
50
51     static size_t estimatedSize(JSCell*);
52     static size_t allocationSize(unsigned length);
53
54     static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
55     static JSBigInt* createZero(VM&);
56     static JSBigInt* createWithLength(VM&, unsigned length);
57
58     static JSBigInt* createFrom(VM&, int32_t value);
59     static JSBigInt* createFrom(VM&, uint32_t value);
60     static JSBigInt* createFrom(VM&, int64_t value);
61     static JSBigInt* createFrom(VM&, bool value);
62
63     DECLARE_EXPORT_INFO;
64
65     void finishCreation(VM&);
66
67     JSValue toPrimitive(ExecState*, PreferredPrimitiveType) const;
68
69     void setSign(bool sign) { m_sign = sign; }
70     bool sign() const { return m_sign; }
71
72     void setLength(unsigned length) { m_length = length; }
73     unsigned length() const { return m_length; }
74
75     enum class ErrorParseMode {
76         ThrowExceptions,
77         IgnoreExceptions
78     };
79
80     enum class ParseIntMode { DisallowEmptyString, AllowEmptyString };
81     enum class ParseIntSign { Unsigned, Signed };
82
83     static JSBigInt* parseInt(ExecState*, VM&, StringView, uint8_t radix, ErrorParseMode = ErrorParseMode::ThrowExceptions, ParseIntSign = ParseIntSign::Unsigned);
84     static JSBigInt* parseInt(ExecState*, StringView, ErrorParseMode = ErrorParseMode::ThrowExceptions);
85     static JSBigInt* stringToBigInt(ExecState*, StringView);
86
87     std::optional<uint8_t> singleDigitValueForString();
88     String toString(ExecState*, unsigned radix);
89     
90     enum class ComparisonMode {
91         LessThan,
92         LessThanOrEqual
93     };
94
95     enum class ComparisonResult {
96         Equal,
97         Undefined,
98         GreaterThan,
99         LessThan
100     };
101     
102     JS_EXPORT_PRIVATE static bool equals(JSBigInt*, JSBigInt*);
103     bool equalsToNumber(JSValue);
104     static ComparisonResult compare(JSBigInt* x, JSBigInt* y);
105
106     bool getPrimitiveNumber(ExecState*, double& number, JSValue& result) const;
107     double toNumber(ExecState*) const;
108
109     JSObject* toObject(ExecState*, JSGlobalObject*) const;
110
111     static JSBigInt* multiply(ExecState*, JSBigInt* x, JSBigInt* y);
112     
113     ComparisonResult static compareToDouble(JSBigInt* x, double y);
114
115     static JSBigInt* divide(ExecState*, JSBigInt* x, JSBigInt* y);
116     static JSBigInt* remainder(ExecState*, JSBigInt* x, JSBigInt* y);
117     static JSBigInt* unaryMinus(VM&, JSBigInt* x);
118     
119 private:
120
121     using Digit = uintptr_t;
122     static constexpr unsigned bitsPerByte = 8;
123     static constexpr unsigned digitBits = sizeof(Digit) * bitsPerByte;
124     static constexpr unsigned halfDigitBits = digitBits / 2;
125     static constexpr Digit halfDigitMask = (1ull << halfDigitBits) - 1;
126     static constexpr int maxInt = 0x7FFFFFFF;
127     
128     // The maximum length that the current implementation supports would be
129     // maxInt / digitBits. However, we use a lower limit for now, because
130     // raising it later is easier than lowering it.
131     // Support up to 1 million bits.
132     static constexpr unsigned maxLength = 1024 * 1024 / (sizeof(void*) * bitsPerByte);
133     
134     static uint64_t calculateMaximumCharactersRequired(unsigned length, unsigned radix, Digit lastDigit, bool sign);
135     
136     static ComparisonResult absoluteCompare(JSBigInt* x, JSBigInt* y);
137     static void absoluteDivWithDigitDivisor(VM&, JSBigInt* x, Digit divisor, JSBigInt** quotient, Digit& remainder);
138     static void internalMultiplyAdd(JSBigInt* source, Digit factor, Digit summand, unsigned, JSBigInt* result);
139     static void multiplyAccumulate(JSBigInt* multiplicand, Digit multiplier, JSBigInt* accumulator, unsigned accumulatorIndex);
140     static void absoluteDivWithBigIntDivisor(VM&, JSBigInt* dividend, JSBigInt* divisor, JSBigInt** quotient, JSBigInt** remainder);
141     
142     enum class LeftShiftMode {
143         SameSizeResult,
144         AlwaysAddOneDigit
145     };
146     
147     static JSBigInt* absoluteLeftShiftAlwaysCopy(VM&, JSBigInt* x, unsigned shift, LeftShiftMode);
148     static bool productGreaterThan(Digit factor1, Digit factor2, Digit high, Digit low);
149
150     Digit absoluteInplaceAdd(JSBigInt* summand, unsigned startIndex);
151     Digit absoluteInplaceSub(JSBigInt* subtrahend, unsigned startIndex);
152     void inplaceRightShift(unsigned shift);
153
154     // Digit arithmetic helpers.
155     static Digit digitAdd(Digit a, Digit b, Digit& carry);
156     static Digit digitSub(Digit a, Digit b, Digit& borrow);
157     static Digit digitMul(Digit a, Digit b, Digit& high);
158     static Digit digitDiv(Digit high, Digit low, Digit divisor, Digit& remainder);
159     static Digit digitPow(Digit base, Digit exponent);
160
161     static String toStringGeneric(ExecState*, JSBigInt*, unsigned radix);
162
163     bool isZero();
164
165     template <typename CharType>
166     static JSBigInt* parseInt(ExecState*, CharType*  data, unsigned length, ErrorParseMode);
167
168     template <typename CharType>
169     static JSBigInt* parseInt(ExecState*, VM&, CharType* data, unsigned length, unsigned startIndex, unsigned radix, ErrorParseMode, ParseIntSign = ParseIntSign::Signed, ParseIntMode = ParseIntMode::AllowEmptyString);
170
171     static JSBigInt* allocateFor(ExecState*, VM&, unsigned radix, unsigned charcount);
172
173     static JSBigInt* copy(VM&, JSBigInt* x);
174     JSBigInt* rightTrim(VM&);
175
176     void inplaceMultiplyAdd(Digit multiplier, Digit part);
177     
178     static size_t offsetOfData();
179     Digit* dataStorage();
180
181     Digit digit(unsigned);
182     void setDigit(unsigned, Digit);
183         
184     unsigned m_length;
185     bool m_sign;
186 };
187
188 inline JSBigInt* asBigInt(JSValue value)
189 {
190     ASSERT(value.asCell()->isBigInt());
191     return jsCast<JSBigInt*>(value.asCell());
192 }
193
194 } // namespace JSC