[ESNext][BigInt] Implement support for "==" operation
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSBigInt.cpp
1 /*
2  * Copyright (C) 2017 Caio Lima <ticaiolima@gmail.com>
3  * Copyright (C) 2017-2018 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * Parts of the implementation below:
27  *
28  * Copyright 2017 the V8 project authors. All rights reserved.
29  * Use of this source code is governed by a BSD-style license that can be
30  * found in the LICENSE file.
31  *
32  *
33  * Copyright (c) 2014 the Dart project authors.  Please see the AUTHORS file [1]
34  * for details. All rights reserved. Use of this source code is governed by a
35  * BSD-style license that can be found in the LICENSE file [2].
36  *
37  * [1] https://github.com/dart-lang/sdk/blob/master/AUTHORS
38  * [2] https://github.com/dart-lang/sdk/blob/master/LICENSE
39  *
40  * Copyright 2009 The Go Authors. All rights reserved.
41  * Use of this source code is governed by a BSD-style
42  * license that can be found in the LICENSE file [3].
43  *
44  * [3] https://golang.org/LICENSE
45  */
46
47 #include "config.h"
48 #include "JSBigInt.h"
49
50 #include "BigIntObject.h"
51 #include "CatchScope.h"
52 #include "JSCInlines.h"
53 #include "MathCommon.h"
54 #include "ParseInt.h"
55 #include <algorithm>
56
57 #define STATIC_ASSERT(cond) static_assert(cond, "JSBigInt assumes " #cond)
58
59 namespace JSC {
60
61 const ClassInfo JSBigInt::s_info =
62     { "JSBigInt", nullptr, nullptr, nullptr, CREATE_METHOD_TABLE(JSBigInt) };
63
64 void JSBigInt::visitChildren(JSCell* cell, SlotVisitor& visitor)
65 {
66     JSBigInt* thisObject = jsCast<JSBigInt*>(cell);
67     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
68     Base::visitChildren(thisObject, visitor);
69 }
70
71 JSBigInt::JSBigInt(VM& vm, Structure* structure, int length)
72     : Base(vm, structure)
73     , m_length(length)
74 { }
75
76 void JSBigInt::initialize(InitializationType initType)
77 {
78     setSign(false);
79     if (initType == InitializationType::WithZero)
80         memset(dataStorage(), 0, length() * sizeof(Digit));
81 }
82
83 Structure* JSBigInt::createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
84 {
85     return Structure::create(vm, globalObject, prototype, TypeInfo(BigIntType, StructureFlags), info());
86 }
87
88 JSBigInt* JSBigInt::createZero(VM& vm)
89 {
90     JSBigInt* zeroBigInt = createWithLength(vm, 0);
91     zeroBigInt->setSign(false);
92     return zeroBigInt;
93 }
94
95 size_t JSBigInt::allocationSize(int length)
96 {
97     size_t sizeWithPadding = WTF::roundUpToMultipleOf<sizeof(size_t)>(sizeof(JSBigInt));
98     return sizeWithPadding + length * sizeof(Digit);
99 }
100
101 JSBigInt* JSBigInt::createWithLength(VM& vm, int length)
102 {
103     JSBigInt* bigInt = new (NotNull, allocateCell<JSBigInt>(vm.heap, allocationSize(length))) JSBigInt(vm, vm.bigIntStructure.get(), length);
104     bigInt->finishCreation(vm);
105     return bigInt;
106 }
107
108 void JSBigInt::finishCreation(VM& vm)
109 {
110     Base::finishCreation(vm);
111 }
112
113
114 JSBigInt* JSBigInt::createFrom(VM& vm, int32_t value)
115 {
116     if (!value)
117         return createZero(vm);
118     
119     JSBigInt* bigInt = createWithLength(vm, 1);
120     
121     if (value < 0) {
122         bigInt->setDigit(0, static_cast<Digit>(-1 * static_cast<int64_t>(value)));
123         bigInt->setSign(true);
124     } else {
125         bigInt->setDigit(0, static_cast<Digit>(value));
126         bigInt->setSign(false);
127     }
128
129     return bigInt;
130 }
131
132 JSBigInt* JSBigInt::createFrom(VM& vm, uint32_t value)
133 {
134     if (!value)
135         return createZero(vm);
136     
137     JSBigInt* bigInt = createWithLength(vm, 1);
138     bigInt->setDigit(0, static_cast<Digit>(value));
139     bigInt->setSign(false);
140     return bigInt;
141 }
142
143 JSBigInt* JSBigInt::createFrom(VM& vm, int64_t value)
144 {
145     if (!value)
146         return createZero(vm);
147     
148     if (sizeof(Digit) == 8) {
149         JSBigInt* bigInt = createWithLength(vm, 1);
150         
151         if (value < 0) {
152             bigInt->setDigit(0, static_cast<Digit>(static_cast<uint64_t>(-(value + 1)) + 1));
153             bigInt->setSign(true);
154         } else {
155             bigInt->setDigit(0, static_cast<Digit>(value));
156             bigInt->setSign(false);
157         }
158         
159         return bigInt;
160     }
161     
162     JSBigInt* bigInt = createWithLength(vm, 2);
163     
164     uint64_t tempValue;
165     bool sign = false;
166     if (value < 0) {
167         tempValue = static_cast<uint64_t>(-(value + 1)) + 1;
168         sign = true;
169     } else
170         tempValue = value;
171     
172     Digit lowBits  = static_cast<Digit>(tempValue & 0xffffffff);
173     Digit highBits = static_cast<Digit>((tempValue >> 32) & 0xffffffff);
174     
175     bigInt->setDigit(0, lowBits);
176     bigInt->setDigit(1, highBits);
177     bigInt->setSign(sign);
178     
179     return bigInt;
180 }
181
182 JSBigInt* JSBigInt::createFrom(VM& vm, bool value)
183 {
184     if (!value)
185         return createZero(vm);
186     
187     JSBigInt* bigInt = createWithLength(vm, 1);
188     bigInt->setDigit(0, static_cast<Digit>(value));
189     bigInt->setSign(false);
190     return bigInt;
191 }
192
193 JSValue JSBigInt::toPrimitive(ExecState*, PreferredPrimitiveType) const
194 {
195     return const_cast<JSBigInt*>(this);
196 }
197
198 std::optional<uint8_t> JSBigInt::singleDigitValueForString()
199 {
200     if (isZero())
201         return 0;
202     
203     if (length() == 1 && !sign()) {
204         Digit rDigit = digit(0);
205         if (rDigit <= 9)
206             return static_cast<uint8_t>(rDigit);
207     }
208     return { };
209 }
210
211 JSBigInt* JSBigInt::parseInt(ExecState* state, StringView s, ErrorParseMode parserMode)
212 {
213     if (s.is8Bit())
214         return parseInt(state, s.characters8(), s.length(), parserMode);
215     return parseInt(state, s.characters16(), s.length(), parserMode);
216 }
217
218 JSBigInt* JSBigInt::parseInt(ExecState* state, VM& vm, StringView s, uint8_t radix, ErrorParseMode parserMode)
219 {
220     if (s.is8Bit())
221         return parseInt(state, vm, s.characters8(), s.length(), 0, radix, parserMode, false);
222     return parseInt(state, vm, s.characters16(), s.length(), 0, radix, parserMode, false);
223 }
224
225 JSBigInt* JSBigInt::stringToBigInt(ExecState* state, StringView s)
226 {
227     return parseInt(state, s, ErrorParseMode::IgnoreExceptions);
228 }
229
230 String JSBigInt::toString(ExecState& state, unsigned radix)
231 {
232     if (this->isZero())
233         return state.vm().smallStrings.singleCharacterStringRep('0');
234
235     return toStringGeneric(state, this, radix);
236 }
237
238 inline bool JSBigInt::isZero()
239 {
240     ASSERT(length() || !sign());
241     return length() == 0;
242 }
243
244 // Multiplies {this} with {factor} and adds {summand} to the result.
245 inline void JSBigInt::inplaceMultiplyAdd(uintptr_t factor, uintptr_t summand)
246 {
247     STATIC_ASSERT(sizeof(factor) == sizeof(Digit));
248     STATIC_ASSERT(sizeof(summand) == sizeof(Digit));
249
250     internalMultiplyAdd(this, factor, summand, length(), this);
251 }
252
253 #if USE(JSVALUE32_64)
254 #define HAVE_TWO_DIGIT 1
255 typedef uint64_t TwoDigit;
256 #elif HAVE(INT128_T)
257 #define HAVE_TWO_DIGIT 1
258 typedef __uint128_t TwoDigit;
259 #else
260 #define HAVE_TWO_DIGIT 0
261 #endif
262
263 // {carry} must point to an initialized Digit and will either be incremented
264 // by one or left alone.
265 inline JSBigInt::Digit JSBigInt::digitAdd(Digit a, Digit b, Digit& carry)
266 {
267     Digit result = a + b;
268     carry += static_cast<bool>(result < a);
269     return result;
270 }
271
272 // {borrow} must point to an initialized Digit and will either be incremented
273 // by one or left alone.
274 inline JSBigInt::Digit JSBigInt::digitSub(Digit a, Digit b, Digit& borrow)
275 {
276     Digit result = a - b;
277     borrow += static_cast<bool>(result > a);
278     return result;
279 }
280
281 // Returns the low half of the result. High half is in {high}.
282 inline JSBigInt::Digit JSBigInt::digitMul(Digit a, Digit b, Digit& high)
283 {
284 #if HAVE_TWO_DIGIT
285     TwoDigit result = static_cast<TwoDigit>(a) * static_cast<TwoDigit>(b);
286     high = result >> digitBits;
287
288     return static_cast<Digit>(result);
289 #else
290     // Multiply in half-pointer-sized chunks.
291     // For inputs [AH AL]*[BH BL], the result is:
292     //
293     //            [AL*BL]  // rLow
294     //    +    [AL*BH]     // rMid1
295     //    +    [AH*BL]     // rMid2
296     //    + [AH*BH]        // rHigh
297     //    = [R4 R3 R2 R1]  // high = [R4 R3], low = [R2 R1]
298     //
299     // Where of course we must be careful with carries between the columns.
300     Digit aLow = a & halfDigitMask;
301     Digit aHigh = a >> halfDigitBits;
302     Digit bLow = b & halfDigitMask;
303     Digit bHigh = b >> halfDigitBits;
304     
305     Digit rLow = aLow * bLow;
306     Digit rMid1 = aLow * bHigh;
307     Digit rMid2 = aHigh * bLow;
308     Digit rHigh = aHigh * bHigh;
309     
310     Digit carry = 0;
311     Digit low = digitAdd(rLow, rMid1 << halfDigitBits, carry);
312     low = digitAdd(low, rMid2 << halfDigitBits, carry);
313
314     high = (rMid1 >> halfDigitBits) + (rMid2 >> halfDigitBits) + rHigh + carry;
315
316     return low;
317 #endif
318 }
319
320 // Raises {base} to the power of {exponent}. Does not check for overflow.
321 inline JSBigInt::Digit JSBigInt::digitPow(Digit base, Digit exponent)
322 {
323     Digit result = 1ull;
324     while (exponent > 0) {
325         if (exponent & 1)
326             result *= base;
327
328         exponent >>= 1;
329         base *= base;
330     }
331
332     return result;
333 }
334
335 // Returns the quotient.
336 // quotient = (high << digitBits + low - remainder) / divisor
337 inline JSBigInt::Digit JSBigInt::digitDiv(Digit high, Digit low, Digit divisor, Digit& remainder)
338 {
339     ASSERT(high < divisor);
340 #if CPU(X86_64) && COMPILER(GCC_OR_CLANG)
341     Digit quotient;
342     Digit rem;
343     __asm__("divq  %[divisor]"
344         // Outputs: {quotient} will be in rax, {rem} in rdx.
345         : "=a"(quotient), "=d"(rem)
346         // Inputs: put {high} into rdx, {low} into rax, and {divisor} into
347         // any register or stack slot.
348         : "d"(high), "a"(low), [divisor] "rm"(divisor));
349     remainder = rem;
350     return quotient;
351 #elif CPU(X86) && COMPILER(GCC_OR_CLANG)
352     Digit quotient;
353     Digit rem;
354     __asm__("divl  %[divisor]"
355         // Outputs: {quotient} will be in eax, {rem} in edx.
356         : "=a"(quotient), "=d"(rem)
357         // Inputs: put {high} into edx, {low} into eax, and {divisor} into
358         // any register or stack slot.
359         : "d"(high), "a"(low), [divisor] "rm"(divisor));
360     remainder = rem;
361     return quotient;
362 #else
363     static const Digit kHalfDigitBase = 1ull << halfDigitBits;
364     // Adapted from Warren, Hacker's Delight, p. 152.
365 #if USE(JSVALUE64)
366     int s = clz64(divisor);
367 #else
368     int s = clz32(divisor);
369 #endif
370     divisor <<= s;
371     
372     Digit vn1 = divisor >> halfDigitBits;
373     Digit vn0 = divisor & halfDigitMask;
374
375     // {s} can be 0. "low >> digitBits == low" on x86, so we "&" it with
376     // {s_zero_mask} which is 0 if s == 0 and all 1-bits otherwise.
377     STATIC_ASSERT(sizeof(intptr_t) == sizeof(Digit));
378     Digit sZeroMask = static_cast<Digit>(static_cast<intptr_t>(-s) >> (digitBits - 1));
379     Digit un32 = (high << s) | ((low >> (digitBits - s)) & sZeroMask);
380     Digit un10 = low << s;
381     Digit un1 = un10 >> halfDigitBits;
382     Digit un0 = un10 & halfDigitMask;
383     Digit q1 = un32 / vn1;
384     Digit rhat = un32 - q1 * vn1;
385
386     while (q1 >= kHalfDigitBase || q1 * vn0 > rhat * kHalfDigitBase + un1) {
387         q1--;
388         rhat += vn1;
389         if (rhat >= kHalfDigitBase)
390             break;
391     }
392
393     Digit un21 = un32 * kHalfDigitBase + un1 - q1 * divisor;
394     Digit q0 = un21 / vn1;
395     rhat = un21 - q0 * vn1;
396
397     while (q0 >= kHalfDigitBase || q0 * vn0 > rhat * kHalfDigitBase + un0) {
398         q0--;
399         rhat += vn1;
400         if (rhat >= kHalfDigitBase)
401             break;
402     }
403
404     remainder = (un21 * kHalfDigitBase + un0 - q0 * divisor) >> s;
405     return q1 * kHalfDigitBase + q0;
406 #endif
407 }
408
409 // Multiplies {source} with {factor} and adds {summand} to the result.
410 // {result} and {source} may be the same BigInt for inplace modification.
411 void JSBigInt::internalMultiplyAdd(JSBigInt* source, Digit factor, Digit summand, int n, JSBigInt* result)
412 {
413     ASSERT(source->length() >= n);
414     ASSERT(result->length() >= n);
415
416     Digit carry = summand;
417     Digit high = 0;
418     for (int i = 0; i < n; i++) {
419         Digit current = source->digit(i);
420         Digit newCarry = 0;
421
422         // Compute this round's multiplication.
423         Digit newHigh = 0;
424         current = digitMul(current, factor, newHigh);
425
426         // Add last round's carryovers.
427         current = digitAdd(current, high, newCarry);
428         current = digitAdd(current, carry, newCarry);
429
430         // Store result and prepare for next round.
431         result->setDigit(i, current);
432         carry = newCarry;
433         high = newHigh;
434     }
435
436     if (result->length() > n) {
437         result->setDigit(n++, carry + high);
438
439         // Current callers don't pass in such large results, but let's be robust.
440         while (n < result->length())
441             result->setDigit(n++, 0);
442     } else
443         ASSERT(!(carry + high));
444 }
445
446 bool JSBigInt::equals(JSBigInt* x, JSBigInt* y)
447 {
448     if (x->sign() != y->sign())
449         return false;
450
451     if (x->length() != y->length())
452         return false;
453
454     for (int i = 0; i < x->length(); i++) {
455         if (x->digit(i) != y->digit(i))
456             return false;
457     }
458
459     return true;
460 }
461
462 // Divides {x} by {divisor}, returning the result in {quotient} and {remainder}.
463 // Mathematically, the contract is:
464 // quotient = (x - remainder) / divisor, with 0 <= remainder < divisor.
465 // If {quotient} is an empty handle, an appropriately sized BigInt will be
466 // allocated for it; otherwise the caller must ensure that it is big enough.
467 // {quotient} can be the same as {x} for an in-place division. {quotient} can
468 // also be nullptr if the caller is only interested in the remainder.
469 void JSBigInt::absoluteDivSmall(ExecState& state, JSBigInt* x, Digit divisor, JSBigInt** quotient, Digit& remainder)
470 {
471     ASSERT(divisor);
472
473     VM& vm = state.vm();
474     ASSERT(!x->isZero());
475     remainder = 0;
476     if (divisor == 1) {
477         if (quotient != nullptr)
478             *quotient = x;
479         return;
480     }
481
482     int length = x->length();
483     if (quotient != nullptr) {
484         if (*quotient == nullptr)
485             *quotient = JSBigInt::createWithLength(vm, length);
486
487         for (int i = length - 1; i >= 0; i--) {
488             Digit q = digitDiv(remainder, x->digit(i), divisor, remainder);
489             (*quotient)->setDigit(i, q);
490         }
491     } else {
492         for (int i = length - 1; i >= 0; i--)
493             digitDiv(remainder, x->digit(i), divisor, remainder);
494     }
495 }
496
497 // Lookup table for the maximum number of bits required per character of a
498 // base-N string representation of a number. To increase accuracy, the array
499 // value is the actual value multiplied by 32. To generate this table:
500 // for (var i = 0; i <= 36; i++) { print(Math.ceil(Math.log2(i) * 32) + ","); }
501 constexpr uint8_t maxBitsPerCharTable[] = {
502     0,   0,   32,  51,  64,  75,  83,  90,  96, // 0..8
503     102, 107, 111, 115, 119, 122, 126, 128,     // 9..16
504     131, 134, 136, 139, 141, 143, 145, 147,     // 17..24
505     149, 151, 153, 154, 156, 158, 159, 160,     // 25..32
506     162, 163, 165, 166,                         // 33..36
507 };
508
509 static const int bitsPerCharTableShift = 5;
510 static const size_t bitsPerCharTableMultiplier = 1u << bitsPerCharTableShift;
511
512 // Compute (an overapproximation of) the length of the resulting string:
513 // Divide bit length of the BigInt by bits representable per character.
514 uint64_t JSBigInt::calculateMaximumCharactersRequired(int length, int radix, Digit lastDigit, bool sign)
515 {
516     int leadingZeros;
517     if (sizeof(lastDigit) == 8)
518         leadingZeros = clz64(lastDigit);
519     else
520         leadingZeros = clz32(lastDigit);
521
522     size_t bitLength = length * digitBits - leadingZeros;
523
524     // Maximum number of bits we can represent with one character. We'll use this
525     // to find an appropriate chunk size below.
526     uint8_t maxBitsPerChar = maxBitsPerCharTable[radix];
527
528     // For estimating result length, we have to be pessimistic and work with
529     // the minimum number of bits one character can represent.
530     uint8_t minBitsPerChar = maxBitsPerChar - 1;
531
532     // Perform the following computation with uint64_t to avoid overflows.
533     uint64_t maximumCharactersRequired = bitLength;
534     maximumCharactersRequired *= bitsPerCharTableMultiplier;
535
536     // Round up.
537     maximumCharactersRequired += minBitsPerChar - 1;
538     maximumCharactersRequired /= minBitsPerChar;
539     maximumCharactersRequired += sign;
540     
541     return maximumCharactersRequired;
542 }
543
544 String JSBigInt::toStringGeneric(ExecState& state, JSBigInt* x, int radix)
545 {
546     // FIXME: [JSC] Revisit usage of Vector into JSBigInt::toString
547     // https://bugs.webkit.org/show_bug.cgi?id=18067
548     Vector<LChar> resultString;
549
550     ASSERT(radix >= 2 && radix <= 36);
551     ASSERT(!x->isZero());
552
553     int length = x->length();
554     bool sign = x->sign();
555
556     uint8_t maxBitsPerChar = maxBitsPerCharTable[radix];
557     uint64_t maximumCharactersRequired = calculateMaximumCharactersRequired(length, radix, x->digit(length - 1), sign);
558
559     if (maximumCharactersRequired > JSString::MaxLength) {
560         auto scope = DECLARE_THROW_SCOPE(state.vm());
561         throwOutOfMemoryError(&state, scope);
562         return String();
563     }
564
565     Digit lastDigit;
566     if (length == 1)
567         lastDigit = x->digit(0);
568     else {
569         int chunkChars = digitBits * bitsPerCharTableMultiplier / maxBitsPerChar;
570         Digit chunkDivisor = digitPow(radix, chunkChars);
571
572         // By construction of chunkChars, there can't have been overflow.
573         ASSERT(chunkDivisor);
574         int nonZeroDigit = length - 1;
575         ASSERT(x->digit(nonZeroDigit));
576
577         // {rest} holds the part of the BigInt that we haven't looked at yet.
578         // Not to be confused with "remainder"!
579         JSBigInt* rest = nullptr;
580
581         // In the first round, divide the input, allocating a new BigInt for
582         // the result == rest; from then on divide the rest in-place.
583         JSBigInt** dividend = &x;
584         do {
585             Digit chunk;
586             absoluteDivSmall(state, *dividend, chunkDivisor, &rest, chunk);
587             ASSERT(rest);
588
589             dividend = &rest;
590             for (int i = 0; i < chunkChars; i++) {
591                 resultString.append(radixDigits[chunk % radix]);
592                 chunk /= radix;
593             }
594             ASSERT(!chunk);
595
596             if (!rest->digit(nonZeroDigit))
597                 nonZeroDigit--;
598
599             // We can never clear more than one digit per iteration, because
600             // chunkDivisor is smaller than max digit value.
601             ASSERT(rest->digit(nonZeroDigit));
602         } while (nonZeroDigit > 0);
603
604         lastDigit = rest->digit(0);
605     }
606
607     do {
608         resultString.append(radixDigits[lastDigit % radix]);
609         lastDigit /= radix;
610     } while (lastDigit > 0);
611     ASSERT(resultString.size());
612     ASSERT(resultString.size() <= static_cast<size_t>(maximumCharactersRequired));
613
614     // Remove leading zeroes.
615     int newSizeNoLeadingZeroes = resultString.size();
616     while (newSizeNoLeadingZeroes  > 1 && resultString[newSizeNoLeadingZeroes - 1] == '0')
617         newSizeNoLeadingZeroes--;
618
619     resultString.shrink(newSizeNoLeadingZeroes);
620
621     if (sign)
622         resultString.append('-');
623
624     std::reverse(resultString.begin(), resultString.end());
625
626     return StringImpl::adopt(WTFMove(resultString));
627 }
628
629 JSBigInt* JSBigInt::rightTrim(VM& vm)
630 {
631     if (isZero())
632         return this;
633
634     int nonZeroIndex = m_length - 1;
635     while (nonZeroIndex >= 0 && !digit(nonZeroIndex))
636         nonZeroIndex--;
637
638     if (nonZeroIndex == m_length - 1)
639         return this;
640
641     int newLength = nonZeroIndex + 1;
642     JSBigInt* trimmedBigInt = createWithLength(vm, newLength);
643     RELEASE_ASSERT(trimmedBigInt);
644     std::copy(dataStorage(), dataStorage() + newLength, trimmedBigInt->dataStorage()); 
645
646     trimmedBigInt->setSign(this->sign());
647
648     return trimmedBigInt;
649 }
650
651 JSBigInt* JSBigInt::allocateFor(ExecState* state, VM& vm, int radix, int charcount)
652 {
653     ASSERT(2 <= radix && radix <= 36);
654     ASSERT(charcount >= 0);
655
656     size_t bitsPerChar = maxBitsPerCharTable[radix];
657     size_t chars = charcount;
658     const int roundup = bitsPerCharTableMultiplier - 1;
659     if (chars <= (std::numeric_limits<size_t>::max() - roundup) / bitsPerChar) {
660         size_t bitsMin = bitsPerChar * chars;
661
662         // Divide by 32 (see table), rounding up.
663         bitsMin = (bitsMin + roundup) >> bitsPerCharTableShift;
664         if (bitsMin <= static_cast<size_t>(maxInt)) {
665             // Divide by kDigitsBits, rounding up.
666             int length = (static_cast<int>(bitsMin) + digitBits - 1) / digitBits;
667             if (length <= maxLength) {
668                 JSBigInt* result = JSBigInt::createWithLength(vm, length);
669                 return result;
670             }
671         }
672     }
673
674     if (state) {
675         auto scope = DECLARE_THROW_SCOPE(vm);
676         throwOutOfMemoryError(state, scope);
677     }
678     return nullptr;
679 }
680
681 size_t JSBigInt::estimatedSize(JSCell* cell)
682 {
683     return Base::estimatedSize(cell) + jsCast<JSBigInt*>(cell)->m_length * sizeof(Digit);
684 }
685
686 double JSBigInt::toNumber(ExecState* state) const
687 {
688     VM& vm = state->vm();
689     auto scope = DECLARE_THROW_SCOPE(vm);
690     throwTypeError(state, scope, ASCIILiteral("Convertion from 'BigInt' to 'number' is not allowed."));
691     return 0.0;
692 }
693
694 bool JSBigInt::getPrimitiveNumber(ExecState* state, double& number, JSValue& result) const
695 {
696     result = this;
697     number = toNumber(state);
698     return true;
699 }
700
701 inline size_t JSBigInt::offsetOfData()
702 {
703     return WTF::roundUpToMultipleOf<sizeof(Digit)>(sizeof(JSBigInt));
704 }
705
706 template <typename CharType>
707 JSBigInt* JSBigInt::parseInt(ExecState* state, CharType*  data, unsigned length, ErrorParseMode errorParseMode)
708 {
709     VM& vm = state->vm();
710
711     unsigned p = 0;
712     while (p < length && isStrWhiteSpace(data[p]))
713         ++p;
714
715     // Check Radix from frist characters
716     if (static_cast<unsigned>(p) + 1 < static_cast<unsigned>(length) && data[p] == '0') {
717         if (isASCIIAlphaCaselessEqual(data[p + 1], 'b'))
718             return parseInt(state, vm, data, length, p + 2, 2, errorParseMode, false);
719         
720         if (isASCIIAlphaCaselessEqual(data[p + 1], 'x'))
721             return parseInt(state, vm, data, length, p + 2, 16, errorParseMode, false);
722         
723         if (isASCIIAlphaCaselessEqual(data[p + 1], 'o'))
724             return parseInt(state, vm, data, length, p + 2, 8, errorParseMode, false);
725     }
726
727     bool sign = false;
728     if (p < length) {
729         if (data[p] == '+')
730             ++p;
731         else if (data[p] == '-') {
732             sign = true;
733             ++p;
734         }
735     }
736
737     JSBigInt* result = parseInt(state, vm, data, length, p, 10, errorParseMode);
738
739     if (result && !result->isZero())
740         result->setSign(sign);
741
742     return result;
743 }
744
745 template <typename CharType>
746 JSBigInt* JSBigInt::parseInt(ExecState* state, VM& vm, CharType* data, unsigned length, unsigned startIndex, unsigned radix, ErrorParseMode errorParseMode, bool allowEmptyString)
747 {
748     ASSERT(length >= 0);
749     unsigned p = startIndex;
750
751     auto scope = DECLARE_THROW_SCOPE(vm);
752
753     if (!allowEmptyString && startIndex == length) {
754         ASSERT(state);
755         if (errorParseMode == ErrorParseMode::ThrowExceptions)
756             throwVMError(state, scope, createSyntaxError(state, "Failed to parse String to BigInt"));
757         return nullptr;
758     }
759
760     // Skipping leading zeros
761     while (p < length && data[p] == '0')
762         ++p;
763
764     int endIndex = length - 1;
765     // Removing trailing spaces
766     while (endIndex >= static_cast<int>(p) && isStrWhiteSpace(data[endIndex]))
767         --endIndex;
768
769     length = endIndex + 1;
770
771     if (p == length)
772         return createZero(vm);
773
774     int limit0 = '0' + (radix < 10 ? radix : 10);
775     int limita = 'a' + (radix - 10);
776     int limitA = 'A' + (radix - 10);
777
778     JSBigInt* result = allocateFor(state, vm, radix, length - p);
779     RETURN_IF_EXCEPTION(scope, nullptr);
780
781     result->initialize(InitializationType::WithZero);
782
783     for (unsigned i = p; i < length; i++, p++) {
784         uint32_t digit;
785         if (data[i] >= '0' && data[i] < limit0)
786             digit = data[i] - '0';
787         else if (data[i] >= 'a' && data[i] < limita)
788             digit = data[i] - 'a' + 10;
789         else if (data[i] >= 'A' && data[i] < limitA)
790             digit = data[i] - 'A' + 10;
791         else
792             break;
793
794         result->inplaceMultiplyAdd(static_cast<Digit>(radix), static_cast<Digit>(digit));
795     }
796
797     if (p == length)
798         return result->rightTrim(vm);
799
800     ASSERT(state);
801     if (errorParseMode == ErrorParseMode::ThrowExceptions)
802         throwVMError(state, scope, createSyntaxError(state, "Failed to parse String to BigInt"));
803
804     return nullptr;
805 }
806
807 inline JSBigInt::Digit* JSBigInt::dataStorage()
808 {
809     return reinterpret_cast<Digit*>(reinterpret_cast<char*>(this) + offsetOfData());
810 }
811
812 inline JSBigInt::Digit JSBigInt::digit(int n)
813 {
814     ASSERT(n >= 0 && n < length());
815     return dataStorage()[n];
816 }
817
818 inline void JSBigInt::setDigit(int n, Digit value)
819 {
820     ASSERT(n >= 0 && n < length());
821     dataStorage()[n] = value;
822 }
823 JSObject* JSBigInt::toObject(ExecState* exec, JSGlobalObject* globalObject) const
824 {
825     return BigIntObject::create(exec->vm(), globalObject, const_cast<JSBigInt*>(this));
826 }
827
828 bool JSBigInt::equalsToNumber(JSValue numValue)
829 {
830     ASSERT(numValue.isNumber());
831     
832     if (numValue.isInt32()) {
833         int value = numValue.asInt32();
834         if (!value)
835             return this->isZero();
836
837         return (this->length() == 1) && (this->sign() == (value < 0)) && (this->digit(0) == static_cast<Digit>(std::abs(static_cast<int64_t>(value))));
838     }
839     
840     double value = numValue.asDouble();
841     return compareToDouble(this, value) == ComparisonResult::Equal;
842 }
843
844 JSBigInt::ComparisonResult JSBigInt::compareToDouble(JSBigInt* x, double y)
845 {
846     // This algorithm expect that the double format is IEEE 754
847
848     uint64_t doubleBits = bitwise_cast<uint64_t>(y);
849     int rawExponent = static_cast<int>(doubleBits >> 52) & 0x7FF;
850
851     if (rawExponent == 0x7FF) {
852         if (std::isnan(y))
853             return ComparisonResult::Undefined;
854
855         return (y == std::numeric_limits<double>::infinity()) ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
856     }
857
858     bool xSign = x->sign();
859     
860     // Note that this is different from the double's sign bit for -0. That's
861     // intentional because -0 must be treated like 0.
862     bool ySign = y < 0;
863     if (xSign != ySign)
864         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
865
866     if (!y) {
867         ASSERT(!xSign);
868         return x->isZero() ? ComparisonResult::Equal : ComparisonResult::GreaterThan;
869     }
870
871     if (x->isZero())
872         return ComparisonResult::LessThan;
873
874     uint64_t mantissa = doubleBits & 0x000FFFFFFFFFFFFF;
875
876     // Non-finite doubles are handled above.
877     ASSERT(rawExponent != 0x7FF);
878     int exponent = rawExponent - 0x3FF;
879     if (exponent < 0) {
880         // The absolute value of the double is less than 1. Only 0n has an
881         // absolute value smaller than that, but we've already covered that case.
882         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
883     }
884
885     int xLength = x->length();
886     Digit xMSD = x->digit(xLength - 1);
887     int msdLeadingZeros = sizeof(xMSD) == 8  ? clz64(xMSD) : clz32(xMSD);
888
889     int xBitLength = xLength * digitBits - msdLeadingZeros;
890     int yBitLength = exponent + 1;
891     if (xBitLength < yBitLength)
892         return xSign? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
893
894     if (xBitLength > yBitLength)
895         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
896     
897     // At this point, we know that signs and bit lengths (i.e. position of
898     // the most significant bit in exponent-free representation) are identical.
899     // {x} is not zero, {y} is finite and not denormal.
900     // Now we virtually convert the double to an integer by shifting its
901     // mantissa according to its exponent, so it will align with the BigInt {x},
902     // and then we compare them bit for bit until we find a difference or the
903     // least significant bit.
904     //                    <----- 52 ------> <-- virtual trailing zeroes -->
905     // y / mantissa:     1yyyyyyyyyyyyyyyyy 0000000000000000000000000000000
906     // x / digits:    0001xxxx xxxxxxxx xxxxxxxx ...
907     //                    <-->          <------>
908     //              msdTopBit         digitBits
909     //
910     mantissa |= 0x0010000000000000;
911     const int mantissaTopBit = 52; // 0-indexed.
912
913     // 0-indexed position of {x}'s most significant bit within the {msd}.
914     int msdTopBit = digitBits - 1 - msdLeadingZeros;
915     ASSERT(msdTopBit == (xBitLength - 1) % digitBits);
916     
917     // Shifted chunk of {mantissa} for comparing with {digit}.
918     Digit compareMantissa;
919
920     // Number of unprocessed bits in {mantissa}. We'll keep them shifted to
921     // the left (i.e. most significant part) of the underlying uint64_t.
922     int remainingMantissaBits = 0;
923     
924     // First, compare the most significant digit against the beginning of
925     // the mantissa and then we align them.
926     if (msdTopBit < mantissaTopBit) {
927         remainingMantissaBits = (mantissaTopBit - msdTopBit);
928         compareMantissa = static_cast<Digit>(mantissa >> remainingMantissaBits);
929         mantissa = mantissa << (64 - remainingMantissaBits);
930     } else {
931         compareMantissa = static_cast<Digit>(mantissa << (msdTopBit - mantissaTopBit));
932         mantissa = 0;
933     }
934
935     if (xMSD > compareMantissa)
936         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
937
938     if (xMSD < compareMantissa)
939         return xSign ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
940     
941     // Then, compare additional digits against any remaining mantissa bits.
942     for (int digitIndex = xLength - 2; digitIndex >= 0; digitIndex--) {
943         if (remainingMantissaBits > 0) {
944             remainingMantissaBits -= digitBits;
945             if (sizeof(mantissa) != sizeof(xMSD)) {
946                 compareMantissa = static_cast<Digit>(mantissa >> (64 - digitBits));
947                 // "& 63" to appease compilers. digitBits is 32 here anyway.
948                 mantissa = mantissa << (digitBits & 63);
949             } else {
950                 compareMantissa = static_cast<Digit>(mantissa);
951                 mantissa = 0;
952             }
953         } else
954             compareMantissa = 0;
955
956         Digit digit = x->digit(digitIndex);
957         if (digit > compareMantissa)
958             return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
959         if (digit < compareMantissa)
960             return xSign ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
961     }
962
963     // Integer parts are equal; check whether {y} has a fractional part.
964     if (mantissa) {
965         ASSERT(remainingMantissaBits > 0);
966         return xSign ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
967     }
968
969     return ComparisonResult::Equal;
970 }
971
972 } // namespace JSC