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