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