222a2acd740dd1cf9cedf6f437f69e7840ec8259
[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, unsigned 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(unsigned 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, unsigned 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 JSBigInt* JSBigInt::multiply(ExecState* state, JSBigInt* x, JSBigInt* y)
254 {
255     VM& vm = state->vm();
256
257     if (x->isZero())
258         return x;
259     if (y->isZero())
260         return y;
261
262     unsigned resultLength = x->length() + y->length();
263     JSBigInt* result = JSBigInt::createWithLength(vm, resultLength);
264     result->initialize(InitializationType::WithZero);
265
266     for (unsigned i = 0; i < x->length(); i++)
267         multiplyAccumulate(y, x->digit(i), result, i);
268
269     result->setSign(x->sign() != y->sign());
270     return result->rightTrim(vm);
271 }
272
273 JSBigInt* JSBigInt::divide(ExecState* state, JSBigInt* x, JSBigInt* y)
274 {
275     // 1. If y is 0n, throw a RangeError exception.
276     VM& vm = state->vm();
277     auto scope = DECLARE_THROW_SCOPE(vm);
278
279     if (y->isZero()) {
280         throwRangeError(state, scope, ASCIILiteral("0 is an invalid divisor value."));
281         return nullptr;
282     }
283
284     // 2. Let quotient be the mathematical value of x divided by y.
285     // 3. Return a BigInt representing quotient rounded towards 0 to the next
286     //    integral value.
287     if (absoluteCompare(x, y) == ComparisonResult::LessThan)
288         return createZero(vm);
289
290     JSBigInt* quotient = nullptr;
291     bool resultSign = x->sign() != y->sign();
292     if (y->length() == 1) {
293         Digit divisor = y->digit(0);
294         if (divisor == 1)
295             return resultSign == x->sign() ? x : unaryMinus(vm, x);
296
297         Digit remainder;
298         absoluteDivWithDigitDivisor(vm, x, divisor, &quotient, remainder);
299     } else
300         absoluteDivWithBigIntDivisor(vm, x, y, &quotient, nullptr);
301
302     quotient->setSign(resultSign);
303     return quotient->rightTrim(vm);
304 }
305
306 JSBigInt* JSBigInt::copy(VM& vm, JSBigInt* x)
307 {
308     ASSERT(!x->isZero());
309
310     JSBigInt* result = JSBigInt::createWithLength(vm, x->length());
311     std::copy(x->dataStorage(), x->dataStorage() + x->length(), result->dataStorage());
312     result->setSign(x->sign());
313     return result;
314 }
315
316 JSBigInt* JSBigInt::unaryMinus(VM& vm, JSBigInt* x)
317 {
318     if (x->isZero())
319         return x;
320
321     JSBigInt* result = copy(vm, x);
322     result->setSign(!x->sign());
323     return result;
324 }
325
326 #if USE(JSVALUE32_64)
327 #define HAVE_TWO_DIGIT 1
328 typedef uint64_t TwoDigit;
329 #elif HAVE(INT128_T)
330 #define HAVE_TWO_DIGIT 1
331 typedef __uint128_t TwoDigit;
332 #else
333 #define HAVE_TWO_DIGIT 0
334 #endif
335
336 // {carry} must point to an initialized Digit and will either be incremented
337 // by one or left alone.
338 inline JSBigInt::Digit JSBigInt::digitAdd(Digit a, Digit b, Digit& carry)
339 {
340     Digit result = a + b;
341     carry += static_cast<bool>(result < a);
342     return result;
343 }
344
345 // {borrow} must point to an initialized Digit and will either be incremented
346 // by one or left alone.
347 inline JSBigInt::Digit JSBigInt::digitSub(Digit a, Digit b, Digit& borrow)
348 {
349     Digit result = a - b;
350     borrow += static_cast<bool>(result > a);
351     return result;
352 }
353
354 // Returns the low half of the result. High half is in {high}.
355 inline JSBigInt::Digit JSBigInt::digitMul(Digit a, Digit b, Digit& high)
356 {
357 #if HAVE_TWO_DIGIT
358     TwoDigit result = static_cast<TwoDigit>(a) * static_cast<TwoDigit>(b);
359     high = result >> digitBits;
360
361     return static_cast<Digit>(result);
362 #else
363     // Multiply in half-pointer-sized chunks.
364     // For inputs [AH AL]*[BH BL], the result is:
365     //
366     //            [AL*BL]  // rLow
367     //    +    [AL*BH]     // rMid1
368     //    +    [AH*BL]     // rMid2
369     //    + [AH*BH]        // rHigh
370     //    = [R4 R3 R2 R1]  // high = [R4 R3], low = [R2 R1]
371     //
372     // Where of course we must be careful with carries between the columns.
373     Digit aLow = a & halfDigitMask;
374     Digit aHigh = a >> halfDigitBits;
375     Digit bLow = b & halfDigitMask;
376     Digit bHigh = b >> halfDigitBits;
377     
378     Digit rLow = aLow * bLow;
379     Digit rMid1 = aLow * bHigh;
380     Digit rMid2 = aHigh * bLow;
381     Digit rHigh = aHigh * bHigh;
382     
383     Digit carry = 0;
384     Digit low = digitAdd(rLow, rMid1 << halfDigitBits, carry);
385     low = digitAdd(low, rMid2 << halfDigitBits, carry);
386
387     high = (rMid1 >> halfDigitBits) + (rMid2 >> halfDigitBits) + rHigh + carry;
388
389     return low;
390 #endif
391 }
392
393 // Raises {base} to the power of {exponent}. Does not check for overflow.
394 inline JSBigInt::Digit JSBigInt::digitPow(Digit base, Digit exponent)
395 {
396     Digit result = 1ull;
397     while (exponent > 0) {
398         if (exponent & 1)
399             result *= base;
400
401         exponent >>= 1;
402         base *= base;
403     }
404
405     return result;
406 }
407
408 // Returns the quotient.
409 // quotient = (high << digitBits + low - remainder) / divisor
410 inline JSBigInt::Digit JSBigInt::digitDiv(Digit high, Digit low, Digit divisor, Digit& remainder)
411 {
412     ASSERT(high < divisor);
413 #if CPU(X86_64) && COMPILER(GCC_OR_CLANG)
414     Digit quotient;
415     Digit rem;
416     __asm__("divq  %[divisor]"
417         // Outputs: {quotient} will be in rax, {rem} in rdx.
418         : "=a"(quotient), "=d"(rem)
419         // Inputs: put {high} into rdx, {low} into rax, and {divisor} into
420         // any register or stack slot.
421         : "d"(high), "a"(low), [divisor] "rm"(divisor));
422     remainder = rem;
423     return quotient;
424 #elif CPU(X86) && COMPILER(GCC_OR_CLANG)
425     Digit quotient;
426     Digit rem;
427     __asm__("divl  %[divisor]"
428         // Outputs: {quotient} will be in eax, {rem} in edx.
429         : "=a"(quotient), "=d"(rem)
430         // Inputs: put {high} into edx, {low} into eax, and {divisor} into
431         // any register or stack slot.
432         : "d"(high), "a"(low), [divisor] "rm"(divisor));
433     remainder = rem;
434     return quotient;
435 #else
436     static const Digit kHalfDigitBase = 1ull << halfDigitBits;
437     // Adapted from Warren, Hacker's Delight, p. 152.
438 #if USE(JSVALUE64)
439     unsigned s = clz64(divisor);
440 #else
441     unsigned s = clz32(divisor);
442 #endif
443     divisor <<= s;
444     
445     Digit vn1 = divisor >> halfDigitBits;
446     Digit vn0 = divisor & halfDigitMask;
447
448     // {s} can be 0. "low >> digitBits == low" on x86, so we "&" it with
449     // {s_zero_mask} which is 0 if s == 0 and all 1-bits otherwise.
450     STATIC_ASSERT(sizeof(intptr_t) == sizeof(Digit));
451     Digit sZeroMask = static_cast<Digit>(static_cast<intptr_t>(-s) >> (digitBits - 1));
452     Digit un32 = (high << s) | ((low >> (digitBits - s)) & sZeroMask);
453     Digit un10 = low << s;
454     Digit un1 = un10 >> halfDigitBits;
455     Digit un0 = un10 & halfDigitMask;
456     Digit q1 = un32 / vn1;
457     Digit rhat = un32 - q1 * vn1;
458
459     while (q1 >= kHalfDigitBase || q1 * vn0 > rhat * kHalfDigitBase + un1) {
460         q1--;
461         rhat += vn1;
462         if (rhat >= kHalfDigitBase)
463             break;
464     }
465
466     Digit un21 = un32 * kHalfDigitBase + un1 - q1 * divisor;
467     Digit q0 = un21 / vn1;
468     rhat = un21 - q0 * vn1;
469
470     while (q0 >= kHalfDigitBase || q0 * vn0 > rhat * kHalfDigitBase + un0) {
471         q0--;
472         rhat += vn1;
473         if (rhat >= kHalfDigitBase)
474             break;
475     }
476
477     remainder = (un21 * kHalfDigitBase + un0 - q0 * divisor) >> s;
478     return q1 * kHalfDigitBase + q0;
479 #endif
480 }
481
482 // Multiplies {source} with {factor} and adds {summand} to the result.
483 // {result} and {source} may be the same BigInt for inplace modification.
484 void JSBigInt::internalMultiplyAdd(JSBigInt* source, Digit factor, Digit summand, unsigned n, JSBigInt* result)
485 {
486     ASSERT(source->length() >= n);
487     ASSERT(result->length() >= n);
488
489     Digit carry = summand;
490     Digit high = 0;
491     for (unsigned i = 0; i < n; i++) {
492         Digit current = source->digit(i);
493         Digit newCarry = 0;
494
495         // Compute this round's multiplication.
496         Digit newHigh = 0;
497         current = digitMul(current, factor, newHigh);
498
499         // Add last round's carryovers.
500         current = digitAdd(current, high, newCarry);
501         current = digitAdd(current, carry, newCarry);
502
503         // Store result and prepare for next round.
504         result->setDigit(i, current);
505         carry = newCarry;
506         high = newHigh;
507     }
508
509     if (result->length() > n) {
510         result->setDigit(n++, carry + high);
511
512         // Current callers don't pass in such large results, but let's be robust.
513         while (n < result->length())
514             result->setDigit(n++, 0);
515     } else
516         ASSERT(!(carry + high));
517 }
518
519 // Multiplies {multiplicand} with {multiplier} and adds the result to
520 // {accumulator}, starting at {accumulatorIndex} for the least-significant
521 // digit.
522 // Callers must ensure that {accumulator} is big enough to hold the result.
523 void JSBigInt::multiplyAccumulate(JSBigInt* multiplicand, Digit multiplier, JSBigInt* accumulator, unsigned accumulatorIndex)
524 {
525     ASSERT(accumulator->length() > multiplicand->length() + accumulatorIndex);
526     if (!multiplier)
527         return;
528     
529     Digit carry = 0;
530     Digit high = 0;
531     for (unsigned i = 0; i < multiplicand->length(); i++, accumulatorIndex++) {
532         Digit acc = accumulator->digit(accumulatorIndex);
533         Digit newCarry = 0;
534         
535         // Add last round's carryovers.
536         acc = digitAdd(acc, high, newCarry);
537         acc = digitAdd(acc, carry, newCarry);
538         
539         // Compute this round's multiplication.
540         Digit multiplicandDigit = multiplicand->digit(i);
541         Digit low = digitMul(multiplier, multiplicandDigit, high);
542         acc = digitAdd(acc, low, newCarry);
543         
544         // Store result and prepare for next round.
545         accumulator->setDigit(accumulatorIndex, acc);
546         carry = newCarry;
547     }
548     
549     while (carry || high) {
550         ASSERT(accumulatorIndex < accumulator->length());
551         Digit acc = accumulator->digit(accumulatorIndex);
552         Digit newCarry = 0;
553         acc = digitAdd(acc, high, newCarry);
554         high = 0;
555         acc = digitAdd(acc, carry, newCarry);
556         accumulator->setDigit(accumulatorIndex, acc);
557         carry = newCarry;
558         accumulatorIndex++;
559     }
560 }
561
562 bool JSBigInt::equals(JSBigInt* x, JSBigInt* y)
563 {
564     if (x->sign() != y->sign())
565         return false;
566
567     if (x->length() != y->length())
568         return false;
569
570     for (unsigned i = 0; i < x->length(); i++) {
571         if (x->digit(i) != y->digit(i))
572             return false;
573     }
574
575     return true;
576 }
577
578 inline JSBigInt::ComparisonResult JSBigInt::absoluteCompare(JSBigInt* x, JSBigInt* y)
579 {
580     ASSERT(!x->length() || x->digit(0));
581     ASSERT(!y->length() || y->digit(0));
582
583     int diff = x->length() - y->length();
584     if (diff)
585         return diff < 0 ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
586
587     int i = x->length() - 1;
588     while (i >= 0 && x->digit(i) == y->digit(i))
589         i--;
590
591     if (i < 0)
592         return ComparisonResult::Equal;
593
594     return x->digit(i) > y->digit(i) ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
595 }
596
597 // Divides {x} by {divisor}, returning the result in {quotient} and {remainder}.
598 // Mathematically, the contract is:
599 // quotient = (x - remainder) / divisor, with 0 <= remainder < divisor.
600 // If {quotient} is an empty handle, an appropriately sized BigInt will be
601 // allocated for it; otherwise the caller must ensure that it is big enough.
602 // {quotient} can be the same as {x} for an in-place division. {quotient} can
603 // also be nullptr if the caller is only interested in the remainder.
604 void JSBigInt::absoluteDivWithDigitDivisor(VM& vm, JSBigInt* x, Digit divisor, JSBigInt** quotient, Digit& remainder)
605 {
606     ASSERT(divisor);
607
608     ASSERT(!x->isZero());
609     remainder = 0;
610     if (divisor == 1) {
611         if (quotient != nullptr)
612             *quotient = x;
613         return;
614     }
615
616     unsigned length = x->length();
617     if (quotient != nullptr) {
618         if (*quotient == nullptr)
619             *quotient = JSBigInt::createWithLength(vm, length);
620
621         for (int i = length - 1; i >= 0; i--) {
622             Digit q = digitDiv(remainder, x->digit(i), divisor, remainder);
623             (*quotient)->setDigit(i, q);
624         }
625     } else {
626         for (int i = length - 1; i >= 0; i--)
627             digitDiv(remainder, x->digit(i), divisor, remainder);
628     }
629 }
630
631 // Divides {dividend} by {divisor}, returning the result in {quotient} and
632 // {remainder}. Mathematically, the contract is:
633 // quotient = (dividend - remainder) / divisor, with 0 <= remainder < divisor.
634 // Both {quotient} and {remainder} are optional, for callers that are only
635 // interested in one of them.
636 // See Knuth, Volume 2, section 4.3.1, Algorithm D.
637 void JSBigInt::absoluteDivWithBigIntDivisor(VM& vm, JSBigInt* dividend, JSBigInt* divisor, JSBigInt** quotient, JSBigInt** remainder)
638 {
639     ASSERT(divisor->length() >= 2);
640     ASSERT(dividend->length() >= divisor->length());
641
642     // The unusual variable names inside this function are consistent with
643     // Knuth's book, as well as with Go's implementation of this algorithm.
644     // Maintaining this consistency is probably more useful than trying to
645     // come up with more descriptive names for them.
646     unsigned n = divisor->length();
647     unsigned m = dividend->length() - n;
648     
649     // The quotient to be computed.
650     JSBigInt* q = nullptr;
651     if (quotient != nullptr)
652         q = createWithLength(vm, m + 1);
653     
654     // In each iteration, {qhatv} holds {divisor} * {current quotient digit}.
655     // "v" is the book's name for {divisor}, "qhat" the current quotient digit.
656     JSBigInt* qhatv = createWithLength(vm, m + 1);
657     
658     // D1.
659     // Left-shift inputs so that the divisor's MSB is set. This is necessary
660     // to prevent the digit-wise divisions (see digit_div call below) from
661     // overflowing (they take a two digits wide input, and return a one digit
662     // result).
663     Digit lastDigit = divisor->digit(n - 1);
664     unsigned shift = sizeof(lastDigit) == 8 ? clz64(lastDigit) : clz32(lastDigit);
665
666     if (shift > 0)
667         divisor = absoluteLeftShiftAlwaysCopy(vm, divisor, shift, LeftShiftMode::SameSizeResult);
668
669     // Holds the (continuously updated) remaining part of the dividend, which
670     // eventually becomes the remainder.
671     JSBigInt* u = absoluteLeftShiftAlwaysCopy(vm, dividend, shift, LeftShiftMode::AlwaysAddOneDigit);
672
673     // D2.
674     // Iterate over the dividend's digit (like the "grad school" algorithm).
675     // {vn1} is the divisor's most significant digit.
676     Digit vn1 = divisor->digit(n - 1);
677     for (int j = m; j >= 0; j--) {
678         // D3.
679         // Estimate the current iteration's quotient digit (see Knuth for details).
680         // {qhat} is the current quotient digit.
681         Digit qhat = std::numeric_limits<Digit>::max();
682
683         // {ujn} is the dividend's most significant remaining digit.
684         Digit ujn = u->digit(j + n);
685         if (ujn != vn1) {
686             // {rhat} is the current iteration's remainder.
687             Digit rhat = 0;
688             // Estimate the current quotient digit by dividing the most significant
689             // digits of dividend and divisor. The result will not be too small,
690             // but could be a bit too large.
691             qhat = digitDiv(ujn, u->digit(j + n - 1), vn1, rhat);
692             
693             // Decrement the quotient estimate as needed by looking at the next
694             // digit, i.e. by testing whether
695             // qhat * v_{n-2} > (rhat << digitBits) + u_{j+n-2}.
696             Digit vn2 = divisor->digit(n - 2);
697             Digit ujn2 = u->digit(j + n - 2);
698             while (productGreaterThan(qhat, vn2, rhat, ujn2)) {
699                 qhat--;
700                 Digit prevRhat = rhat;
701                 rhat += vn1;
702                 // v[n-1] >= 0, so this tests for overflow.
703                 if (rhat < prevRhat)
704                     break;
705             }
706         }
707
708         // D4.
709         // Multiply the divisor with the current quotient digit, and subtract
710         // it from the dividend. If there was "borrow", then the quotient digit
711         // was one too high, so we must correct it and undo one subtraction of
712         // the (shifted) divisor.
713         internalMultiplyAdd(divisor, qhat, 0, n, qhatv);
714         Digit c = u->absoluteInplaceSub(qhatv, j);
715         if (c) {
716             c = u->absoluteInplaceAdd(divisor, j);
717             u->setDigit(j + n, u->digit(j + n) + c);
718             qhat--;
719         }
720         
721         if (quotient != nullptr)
722             q->setDigit(j, qhat);
723     }
724
725     if (quotient != nullptr) {
726         // Caller will right-trim.
727         *quotient = q;
728     }
729
730     if (remainder != nullptr) {
731         u->inplaceRightShift(shift);
732         *remainder = u;
733     }
734 }
735
736 // Returns whether (factor1 * factor2) > (high << kDigitBits) + low.
737 inline bool JSBigInt::productGreaterThan(Digit factor1, Digit factor2, Digit high, Digit low)
738 {
739     Digit resultHigh;
740     Digit resultLow = digitMul(factor1, factor2, resultHigh);
741     return resultHigh > high || (resultHigh == high && resultLow > low);
742 }
743
744 // Adds {summand} onto {this}, starting with {summand}'s 0th digit
745 // at {this}'s {startIndex}'th digit. Returns the "carry" (0 or 1).
746 JSBigInt::Digit JSBigInt::absoluteInplaceAdd(JSBigInt* summand, unsigned startIndex)
747 {
748     Digit carry = 0;
749     unsigned n = summand->length();
750     ASSERT(length() >= startIndex + n);
751     for (unsigned i = 0; i < n; i++) {
752         Digit newCarry = 0;
753         Digit sum = digitAdd(digit(startIndex + i), summand->digit(i), newCarry);
754         sum = digitAdd(sum, carry, newCarry);
755         setDigit(startIndex + i, sum);
756         carry = newCarry;
757     }
758
759     return carry;
760 }
761
762 // Subtracts {subtrahend} from {this}, starting with {subtrahend}'s 0th digit
763 // at {this}'s {startIndex}-th digit. Returns the "borrow" (0 or 1).
764 JSBigInt::Digit JSBigInt::absoluteInplaceSub(JSBigInt* subtrahend, unsigned startIndex)
765 {
766     Digit borrow = 0;
767     unsigned n = subtrahend->length();
768     ASSERT(length() >= startIndex + n);
769     for (unsigned i = 0; i < n; i++) {
770         Digit newBorrow = 0;
771         Digit difference = digitSub(digit(startIndex + i), subtrahend->digit(i), newBorrow);
772         difference = digitSub(difference, borrow, newBorrow);
773         setDigit(startIndex + i, difference);
774         borrow = newBorrow;
775     }
776
777     return borrow;
778 }
779
780 void JSBigInt::inplaceRightShift(unsigned shift)
781 {
782     ASSERT(shift < digitBits);
783     ASSERT(!(digit(0) & ((static_cast<Digit>(1) << shift) - 1)));
784
785     if (!shift)
786         return;
787
788     Digit carry = digit(0) >> shift;
789     unsigned last = length() - 1;
790     for (unsigned i = 0; i < last; i++) {
791         Digit d = digit(i + 1);
792         setDigit(i, (d << (digitBits - shift)) | carry);
793         carry = d >> shift;
794     }
795     setDigit(last, carry);
796 }
797
798 // Always copies the input, even when {shift} == 0.
799 JSBigInt* JSBigInt::absoluteLeftShiftAlwaysCopy(VM& vm, JSBigInt* x, unsigned shift, LeftShiftMode mode)
800 {
801     ASSERT(shift < digitBits);
802     ASSERT(!x->isZero());
803
804     unsigned n = x->length();
805     unsigned resultLength = mode == LeftShiftMode::AlwaysAddOneDigit ? n + 1 : n;
806     JSBigInt* result = createWithLength(vm, resultLength);
807
808     if (!shift) {
809         for (unsigned i = 0; i < n; i++)
810             result->setDigit(i, x->digit(i));
811         if (mode == LeftShiftMode::AlwaysAddOneDigit)
812             result->setDigit(n, 0);
813
814         return result;
815     }
816
817     Digit carry = 0;
818     for (unsigned i = 0; i < n; i++) {
819         Digit d = x->digit(i);
820         result->setDigit(i, (d << shift) | carry);
821         carry = d >> (digitBits - shift);
822     }
823
824     if (mode == LeftShiftMode::AlwaysAddOneDigit)
825         result->setDigit(n, carry);
826     else {
827         ASSERT(mode == LeftShiftMode::SameSizeResult);
828         ASSERT(!carry);
829     }
830
831     return result;
832 }
833
834 // Lookup table for the maximum number of bits required per character of a
835 // base-N string representation of a number. To increase accuracy, the array
836 // value is the actual value multiplied by 32. To generate this table:
837 // for (var i = 0; i <= 36; i++) { print(Math.ceil(Math.log2(i) * 32) + ","); }
838 constexpr uint8_t maxBitsPerCharTable[] = {
839     0,   0,   32,  51,  64,  75,  83,  90,  96, // 0..8
840     102, 107, 111, 115, 119, 122, 126, 128,     // 9..16
841     131, 134, 136, 139, 141, 143, 145, 147,     // 17..24
842     149, 151, 153, 154, 156, 158, 159, 160,     // 25..32
843     162, 163, 165, 166,                         // 33..36
844 };
845
846 static const unsigned bitsPerCharTableShift = 5;
847 static const size_t bitsPerCharTableMultiplier = 1u << bitsPerCharTableShift;
848
849 // Compute (an overapproximation of) the length of the resulting string:
850 // Divide bit length of the BigInt by bits representable per character.
851 uint64_t JSBigInt::calculateMaximumCharactersRequired(unsigned length, unsigned radix, Digit lastDigit, bool sign)
852 {
853     unsigned leadingZeros;
854     if (sizeof(lastDigit) == 8)
855         leadingZeros = clz64(lastDigit);
856     else
857         leadingZeros = clz32(lastDigit);
858
859     size_t bitLength = length * digitBits - leadingZeros;
860
861     // Maximum number of bits we can represent with one character. We'll use this
862     // to find an appropriate chunk size below.
863     uint8_t maxBitsPerChar = maxBitsPerCharTable[radix];
864
865     // For estimating result length, we have to be pessimistic and work with
866     // the minimum number of bits one character can represent.
867     uint8_t minBitsPerChar = maxBitsPerChar - 1;
868
869     // Perform the following computation with uint64_t to avoid overflows.
870     uint64_t maximumCharactersRequired = bitLength;
871     maximumCharactersRequired *= bitsPerCharTableMultiplier;
872
873     // Round up.
874     maximumCharactersRequired += minBitsPerChar - 1;
875     maximumCharactersRequired /= minBitsPerChar;
876     maximumCharactersRequired += sign;
877     
878     return maximumCharactersRequired;
879 }
880
881 String JSBigInt::toStringGeneric(ExecState* state, JSBigInt* x, unsigned radix)
882 {
883     // FIXME: [JSC] Revisit usage of Vector into JSBigInt::toString
884     // https://bugs.webkit.org/show_bug.cgi?id=18067
885     Vector<LChar> resultString;
886
887     VM& vm = state->vm();
888
889     ASSERT(radix >= 2 && radix <= 36);
890     ASSERT(!x->isZero());
891
892     unsigned length = x->length();
893     bool sign = x->sign();
894
895     uint8_t maxBitsPerChar = maxBitsPerCharTable[radix];
896     uint64_t maximumCharactersRequired = calculateMaximumCharactersRequired(length, radix, x->digit(length - 1), sign);
897
898     if (maximumCharactersRequired > JSString::MaxLength) {
899         auto scope = DECLARE_THROW_SCOPE(vm);
900         throwOutOfMemoryError(state, scope);
901         return String();
902     }
903
904     Digit lastDigit;
905     if (length == 1)
906         lastDigit = x->digit(0);
907     else {
908         unsigned chunkChars = digitBits * bitsPerCharTableMultiplier / maxBitsPerChar;
909         Digit chunkDivisor = digitPow(radix, chunkChars);
910
911         // By construction of chunkChars, there can't have been overflow.
912         ASSERT(chunkDivisor);
913         unsigned nonZeroDigit = length - 1;
914         ASSERT(x->digit(nonZeroDigit));
915
916         // {rest} holds the part of the BigInt that we haven't looked at yet.
917         // Not to be confused with "remainder"!
918         JSBigInt* rest = nullptr;
919
920         // In the first round, divide the input, allocating a new BigInt for
921         // the result == rest; from then on divide the rest in-place.
922         JSBigInt** dividend = &x;
923         do {
924             Digit chunk;
925             absoluteDivWithDigitDivisor(vm, *dividend, chunkDivisor, &rest, chunk);
926             ASSERT(rest);
927
928             dividend = &rest;
929             for (unsigned i = 0; i < chunkChars; i++) {
930                 resultString.append(radixDigits[chunk % radix]);
931                 chunk /= radix;
932             }
933             ASSERT(!chunk);
934
935             if (!rest->digit(nonZeroDigit))
936                 nonZeroDigit--;
937
938             // We can never clear more than one digit per iteration, because
939             // chunkDivisor is smaller than max digit value.
940             ASSERT(rest->digit(nonZeroDigit));
941         } while (nonZeroDigit > 0);
942
943         lastDigit = rest->digit(0);
944     }
945
946     do {
947         resultString.append(radixDigits[lastDigit % radix]);
948         lastDigit /= radix;
949     } while (lastDigit > 0);
950     ASSERT(resultString.size());
951     ASSERT(resultString.size() <= static_cast<size_t>(maximumCharactersRequired));
952
953     // Remove leading zeroes.
954     unsigned newSizeNoLeadingZeroes = resultString.size();
955     while (newSizeNoLeadingZeroes  > 1 && resultString[newSizeNoLeadingZeroes - 1] == '0')
956         newSizeNoLeadingZeroes--;
957
958     resultString.shrink(newSizeNoLeadingZeroes);
959
960     if (sign)
961         resultString.append('-');
962
963     std::reverse(resultString.begin(), resultString.end());
964
965     return StringImpl::adopt(WTFMove(resultString));
966 }
967
968 JSBigInt* JSBigInt::rightTrim(VM& vm)
969 {
970     if (isZero())
971         return this;
972
973     unsigned nonZeroIndex = m_length - 1;
974     while (!digit(nonZeroIndex))
975         nonZeroIndex--;
976
977     if (nonZeroIndex == m_length - 1)
978         return this;
979
980     unsigned newLength = nonZeroIndex + 1;
981     JSBigInt* trimmedBigInt = createWithLength(vm, newLength);
982     RELEASE_ASSERT(trimmedBigInt);
983     std::copy(dataStorage(), dataStorage() + newLength, trimmedBigInt->dataStorage()); 
984
985     trimmedBigInt->setSign(this->sign());
986
987     return trimmedBigInt;
988 }
989
990 JSBigInt* JSBigInt::allocateFor(ExecState* state, VM& vm, unsigned radix, unsigned charcount)
991 {
992     ASSERT(2 <= radix && radix <= 36);
993     ASSERT(charcount >= 0);
994
995     size_t bitsPerChar = maxBitsPerCharTable[radix];
996     size_t chars = charcount;
997     const unsigned roundup = bitsPerCharTableMultiplier - 1;
998     if (chars <= (std::numeric_limits<size_t>::max() - roundup) / bitsPerChar) {
999         size_t bitsMin = bitsPerChar * chars;
1000
1001         // Divide by 32 (see table), rounding up.
1002         bitsMin = (bitsMin + roundup) >> bitsPerCharTableShift;
1003         if (bitsMin <= static_cast<size_t>(maxInt)) {
1004             // Divide by kDigitsBits, rounding up.
1005             unsigned length = (bitsMin + digitBits - 1) / digitBits;
1006             if (length <= maxLength) {
1007                 JSBigInt* result = JSBigInt::createWithLength(vm, length);
1008                 return result;
1009             }
1010         }
1011     }
1012
1013     if (state) {
1014         auto scope = DECLARE_THROW_SCOPE(vm);
1015         throwOutOfMemoryError(state, scope);
1016     }
1017     return nullptr;
1018 }
1019
1020 size_t JSBigInt::estimatedSize(JSCell* cell)
1021 {
1022     return Base::estimatedSize(cell) + jsCast<JSBigInt*>(cell)->m_length * sizeof(Digit);
1023 }
1024
1025 double JSBigInt::toNumber(ExecState* state) const
1026 {
1027     VM& vm = state->vm();
1028     auto scope = DECLARE_THROW_SCOPE(vm);
1029     throwTypeError(state, scope, ASCIILiteral("Convertion from 'BigInt' to 'number' is not allowed."));
1030     return 0.0;
1031 }
1032
1033 bool JSBigInt::getPrimitiveNumber(ExecState* state, double& number, JSValue& result) const
1034 {
1035     result = this;
1036     number = toNumber(state);
1037     return true;
1038 }
1039
1040 inline size_t JSBigInt::offsetOfData()
1041 {
1042     return WTF::roundUpToMultipleOf<sizeof(Digit)>(sizeof(JSBigInt));
1043 }
1044
1045 template <typename CharType>
1046 JSBigInt* JSBigInt::parseInt(ExecState* state, CharType*  data, unsigned length, ErrorParseMode errorParseMode)
1047 {
1048     VM& vm = state->vm();
1049
1050     unsigned p = 0;
1051     while (p < length && isStrWhiteSpace(data[p]))
1052         ++p;
1053
1054     // Check Radix from frist characters
1055     if (static_cast<unsigned>(p) + 1 < static_cast<unsigned>(length) && data[p] == '0') {
1056         if (isASCIIAlphaCaselessEqual(data[p + 1], 'b'))
1057             return parseInt(state, vm, data, length, p + 2, 2, errorParseMode, false);
1058         
1059         if (isASCIIAlphaCaselessEqual(data[p + 1], 'x'))
1060             return parseInt(state, vm, data, length, p + 2, 16, errorParseMode, false);
1061         
1062         if (isASCIIAlphaCaselessEqual(data[p + 1], 'o'))
1063             return parseInt(state, vm, data, length, p + 2, 8, errorParseMode, false);
1064     }
1065
1066     bool sign = false;
1067     if (p < length) {
1068         if (data[p] == '+')
1069             ++p;
1070         else if (data[p] == '-') {
1071             sign = true;
1072             ++p;
1073         }
1074     }
1075
1076     JSBigInt* result = parseInt(state, vm, data, length, p, 10, errorParseMode);
1077
1078     if (result && !result->isZero())
1079         result->setSign(sign);
1080
1081     return result;
1082 }
1083
1084 template <typename CharType>
1085 JSBigInt* JSBigInt::parseInt(ExecState* state, VM& vm, CharType* data, unsigned length, unsigned startIndex, unsigned radix, ErrorParseMode errorParseMode, bool allowEmptyString)
1086 {
1087     ASSERT(length >= 0);
1088     unsigned p = startIndex;
1089
1090     auto scope = DECLARE_THROW_SCOPE(vm);
1091
1092     if (!allowEmptyString && startIndex == length) {
1093         ASSERT(state);
1094         if (errorParseMode == ErrorParseMode::ThrowExceptions)
1095             throwVMError(state, scope, createSyntaxError(state, "Failed to parse String to BigInt"));
1096         return nullptr;
1097     }
1098
1099     // Skipping leading zeros
1100     while (p < length && data[p] == '0')
1101         ++p;
1102
1103     int endIndex = length - 1;
1104     // Removing trailing spaces
1105     while (endIndex >= static_cast<int>(p) && isStrWhiteSpace(data[endIndex]))
1106         --endIndex;
1107
1108     length = endIndex + 1;
1109
1110     if (p == length)
1111         return createZero(vm);
1112
1113     unsigned limit0 = '0' + (radix < 10 ? radix : 10);
1114     unsigned limita = 'a' + (radix - 10);
1115     unsigned limitA = 'A' + (radix - 10);
1116
1117     JSBigInt* result = allocateFor(state, vm, radix, length - p);
1118     RETURN_IF_EXCEPTION(scope, nullptr);
1119
1120     result->initialize(InitializationType::WithZero);
1121
1122     for (unsigned i = p; i < length; i++, p++) {
1123         uint32_t digit;
1124         if (data[i] >= '0' && data[i] < limit0)
1125             digit = data[i] - '0';
1126         else if (data[i] >= 'a' && data[i] < limita)
1127             digit = data[i] - 'a' + 10;
1128         else if (data[i] >= 'A' && data[i] < limitA)
1129             digit = data[i] - 'A' + 10;
1130         else
1131             break;
1132
1133         result->inplaceMultiplyAdd(static_cast<Digit>(radix), static_cast<Digit>(digit));
1134     }
1135
1136     if (p == length)
1137         return result->rightTrim(vm);
1138
1139     ASSERT(state);
1140     if (errorParseMode == ErrorParseMode::ThrowExceptions)
1141         throwVMError(state, scope, createSyntaxError(state, "Failed to parse String to BigInt"));
1142
1143     return nullptr;
1144 }
1145
1146 inline JSBigInt::Digit* JSBigInt::dataStorage()
1147 {
1148     return reinterpret_cast<Digit*>(reinterpret_cast<char*>(this) + offsetOfData());
1149 }
1150
1151 inline JSBigInt::Digit JSBigInt::digit(unsigned n)
1152 {
1153     ASSERT(n < length());
1154     return dataStorage()[n];
1155 }
1156
1157 inline void JSBigInt::setDigit(unsigned n, Digit value)
1158 {
1159     ASSERT(n < length());
1160     dataStorage()[n] = value;
1161 }
1162 JSObject* JSBigInt::toObject(ExecState* exec, JSGlobalObject* globalObject) const
1163 {
1164     return BigIntObject::create(exec->vm(), globalObject, const_cast<JSBigInt*>(this));
1165 }
1166
1167 bool JSBigInt::equalsToNumber(JSValue numValue)
1168 {
1169     ASSERT(numValue.isNumber());
1170     
1171     if (numValue.isInt32()) {
1172         int value = numValue.asInt32();
1173         if (!value)
1174             return this->isZero();
1175
1176         return (this->length() == 1) && (this->sign() == (value < 0)) && (this->digit(0) == static_cast<Digit>(std::abs(static_cast<int64_t>(value))));
1177     }
1178     
1179     double value = numValue.asDouble();
1180     return compareToDouble(this, value) == ComparisonResult::Equal;
1181 }
1182
1183 JSBigInt::ComparisonResult JSBigInt::compareToDouble(JSBigInt* x, double y)
1184 {
1185     // This algorithm expect that the double format is IEEE 754
1186
1187     uint64_t doubleBits = bitwise_cast<uint64_t>(y);
1188     int rawExponent = static_cast<int>(doubleBits >> 52) & 0x7FF;
1189
1190     if (rawExponent == 0x7FF) {
1191         if (std::isnan(y))
1192             return ComparisonResult::Undefined;
1193
1194         return (y == std::numeric_limits<double>::infinity()) ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
1195     }
1196
1197     bool xSign = x->sign();
1198     
1199     // Note that this is different from the double's sign bit for -0. That's
1200     // intentional because -0 must be treated like 0.
1201     bool ySign = y < 0;
1202     if (xSign != ySign)
1203         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
1204
1205     if (!y) {
1206         ASSERT(!xSign);
1207         return x->isZero() ? ComparisonResult::Equal : ComparisonResult::GreaterThan;
1208     }
1209
1210     if (x->isZero())
1211         return ComparisonResult::LessThan;
1212
1213     uint64_t mantissa = doubleBits & 0x000FFFFFFFFFFFFF;
1214
1215     // Non-finite doubles are handled above.
1216     ASSERT(rawExponent != 0x7FF);
1217     int exponent = rawExponent - 0x3FF;
1218     if (exponent < 0) {
1219         // The absolute value of the double is less than 1. Only 0n has an
1220         // absolute value smaller than that, but we've already covered that case.
1221         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
1222     }
1223
1224     int xLength = x->length();
1225     Digit xMSD = x->digit(xLength - 1);
1226     int msdLeadingZeros = sizeof(xMSD) == 8  ? clz64(xMSD) : clz32(xMSD);
1227
1228     int xBitLength = xLength * digitBits - msdLeadingZeros;
1229     int yBitLength = exponent + 1;
1230     if (xBitLength < yBitLength)
1231         return xSign? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
1232
1233     if (xBitLength > yBitLength)
1234         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
1235     
1236     // At this point, we know that signs and bit lengths (i.e. position of
1237     // the most significant bit in exponent-free representation) are identical.
1238     // {x} is not zero, {y} is finite and not denormal.
1239     // Now we virtually convert the double to an integer by shifting its
1240     // mantissa according to its exponent, so it will align with the BigInt {x},
1241     // and then we compare them bit for bit until we find a difference or the
1242     // least significant bit.
1243     //                    <----- 52 ------> <-- virtual trailing zeroes -->
1244     // y / mantissa:     1yyyyyyyyyyyyyyyyy 0000000000000000000000000000000
1245     // x / digits:    0001xxxx xxxxxxxx xxxxxxxx ...
1246     //                    <-->          <------>
1247     //              msdTopBit         digitBits
1248     //
1249     mantissa |= 0x0010000000000000;
1250     const int mantissaTopBit = 52; // 0-indexed.
1251
1252     // 0-indexed position of {x}'s most significant bit within the {msd}.
1253     int msdTopBit = digitBits - 1 - msdLeadingZeros;
1254     ASSERT(msdTopBit == (xBitLength - 1) % digitBits);
1255     
1256     // Shifted chunk of {mantissa} for comparing with {digit}.
1257     Digit compareMantissa;
1258
1259     // Number of unprocessed bits in {mantissa}. We'll keep them shifted to
1260     // the left (i.e. most significant part) of the underlying uint64_t.
1261     int remainingMantissaBits = 0;
1262     
1263     // First, compare the most significant digit against the beginning of
1264     // the mantissa and then we align them.
1265     if (msdTopBit < mantissaTopBit) {
1266         remainingMantissaBits = (mantissaTopBit - msdTopBit);
1267         compareMantissa = static_cast<Digit>(mantissa >> remainingMantissaBits);
1268         mantissa = mantissa << (64 - remainingMantissaBits);
1269     } else {
1270         compareMantissa = static_cast<Digit>(mantissa << (msdTopBit - mantissaTopBit));
1271         mantissa = 0;
1272     }
1273
1274     if (xMSD > compareMantissa)
1275         return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
1276
1277     if (xMSD < compareMantissa)
1278         return xSign ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
1279     
1280     // Then, compare additional digits against any remaining mantissa bits.
1281     for (int digitIndex = xLength - 2; digitIndex >= 0; digitIndex--) {
1282         if (remainingMantissaBits > 0) {
1283             remainingMantissaBits -= digitBits;
1284             if (sizeof(mantissa) != sizeof(xMSD)) {
1285                 compareMantissa = static_cast<Digit>(mantissa >> (64 - digitBits));
1286                 // "& 63" to appease compilers. digitBits is 32 here anyway.
1287                 mantissa = mantissa << (digitBits & 63);
1288             } else {
1289                 compareMantissa = static_cast<Digit>(mantissa);
1290                 mantissa = 0;
1291             }
1292         } else
1293             compareMantissa = 0;
1294
1295         Digit digit = x->digit(digitIndex);
1296         if (digit > compareMantissa)
1297             return xSign ? ComparisonResult::LessThan : ComparisonResult::GreaterThan;
1298         if (digit < compareMantissa)
1299             return xSign ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
1300     }
1301
1302     // Integer parts are equal; check whether {y} has a fractional part.
1303     if (mantissa) {
1304         ASSERT(remainingMantissaBits > 0);
1305         return xSign ? ComparisonResult::GreaterThan : ComparisonResult::LessThan;
1306     }
1307
1308     return ComparisonResult::Equal;
1309 }
1310
1311 } // namespace JSC