[ESNext][BigInt] Implement support for "%" 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 ComparisonResult {
91         Equal,
92         Undefined,
93         GreaterThan,
94         LessThan
95     };
96     
97     JS_EXPORT_PRIVATE static bool equals(JSBigInt*, JSBigInt*);
98     bool equalsToNumber(JSValue);
99     static ComparisonResult compare(JSBigInt* x, JSBigInt* y);
100
101     bool getPrimitiveNumber(ExecState*, double& number, JSValue& result) const;
102     double toNumber(ExecState*) const;
103
104     JSObject* toObject(ExecState*, JSGlobalObject*) const;
105
106     static JSBigInt* multiply(ExecState*, JSBigInt* x, JSBigInt* y);
107     
108     ComparisonResult static compareToDouble(JSBigInt* x, double y);
109
110     static JSBigInt* divide(ExecState*, JSBigInt* x, JSBigInt* y);
111     static JSBigInt* remainder(ExecState*, JSBigInt* x, JSBigInt* y);
112     static JSBigInt* unaryMinus(VM&, JSBigInt* x);
113     
114 private:
115
116     using Digit = uintptr_t;
117     static constexpr unsigned bitsPerByte = 8;
118     static constexpr unsigned digitBits = sizeof(Digit) * bitsPerByte;
119     static constexpr unsigned halfDigitBits = digitBits / 2;
120     static constexpr Digit halfDigitMask = (1ull << halfDigitBits) - 1;
121     static constexpr int maxInt = 0x7FFFFFFF;
122     
123     // The maximum length that the current implementation supports would be
124     // maxInt / digitBits. However, we use a lower limit for now, because
125     // raising it later is easier than lowering it.
126     // Support up to 1 million bits.
127     static constexpr unsigned maxLength = 1024 * 1024 / (sizeof(void*) * bitsPerByte);
128     
129     static uint64_t calculateMaximumCharactersRequired(unsigned length, unsigned radix, Digit lastDigit, bool sign);
130     
131     static ComparisonResult absoluteCompare(JSBigInt* x, JSBigInt* y);
132     static void absoluteDivWithDigitDivisor(VM&, JSBigInt* x, Digit divisor, JSBigInt** quotient, Digit& remainder);
133     static void internalMultiplyAdd(JSBigInt* source, Digit factor, Digit summand, unsigned, JSBigInt* result);
134     static void multiplyAccumulate(JSBigInt* multiplicand, Digit multiplier, JSBigInt* accumulator, unsigned accumulatorIndex);
135     static void absoluteDivWithBigIntDivisor(VM&, JSBigInt* dividend, JSBigInt* divisor, JSBigInt** quotient, JSBigInt** remainder);
136     
137     enum class LeftShiftMode {
138         SameSizeResult,
139         AlwaysAddOneDigit
140     };
141     
142     static JSBigInt* absoluteLeftShiftAlwaysCopy(VM&, JSBigInt* x, unsigned shift, LeftShiftMode);
143     static bool productGreaterThan(Digit factor1, Digit factor2, Digit high, Digit low);
144
145     Digit absoluteInplaceAdd(JSBigInt* summand, unsigned startIndex);
146     Digit absoluteInplaceSub(JSBigInt* subtrahend, unsigned startIndex);
147     void inplaceRightShift(unsigned shift);
148
149     // Digit arithmetic helpers.
150     static Digit digitAdd(Digit a, Digit b, Digit& carry);
151     static Digit digitSub(Digit a, Digit b, Digit& borrow);
152     static Digit digitMul(Digit a, Digit b, Digit& high);
153     static Digit digitDiv(Digit high, Digit low, Digit divisor, Digit& remainder);
154     static Digit digitPow(Digit base, Digit exponent);
155
156     static String toStringGeneric(ExecState*, JSBigInt*, unsigned radix);
157
158     bool isZero();
159
160     template <typename CharType>
161     static JSBigInt* parseInt(ExecState*, CharType*  data, unsigned length, ErrorParseMode);
162
163     template <typename CharType>
164     static JSBigInt* parseInt(ExecState*, VM&, CharType* data, unsigned length, unsigned startIndex, unsigned radix, ErrorParseMode, ParseIntSign = ParseIntSign::Signed, ParseIntMode = ParseIntMode::AllowEmptyString);
165
166     static JSBigInt* allocateFor(ExecState*, VM&, unsigned radix, unsigned charcount);
167
168     static JSBigInt* copy(VM&, JSBigInt* x);
169     JSBigInt* rightTrim(VM&);
170
171     void inplaceMultiplyAdd(Digit multiplier, Digit part);
172     
173     static size_t offsetOfData();
174     Digit* dataStorage();
175
176     Digit digit(unsigned);
177     void setDigit(unsigned, Digit);
178         
179     unsigned m_length;
180     bool m_sign;
181 };
182
183 inline JSBigInt* asBigInt(JSValue value)
184 {
185     ASSERT(value.asCell()->isBigInt());
186     return jsCast<JSBigInt*>(value.asCell());
187 }
188
189 } // namespace JSC