Cheaper expWad and lnWad via symmetric rationals

Author: ddallaire

src/utils/FixedPointMathLib.sol

@@ -206,67 +206,53 @@ library FixedPointMathLib {
     /// Note: This function is an approximation. Monotonically increasing.
     function expWad(int256 x) internal pure returns (int256 r) {
         unchecked {
-            // When the result is less than 0.5 we return zero.
-            // This happens when `x <= (log(1e-18) * 1e18) ~ -4.15e19`.
-            if (x <= -41446531673892822313) return r;
+            // Accept `-41446531673892822313 < x < 135305999368893231589` with a
+            // single unsigned comparison; sort out the two edges on the cold path.
+            if (uint256(x) + 41446531673892822312 >= 176752531042786053901) {
+                // When the true result is less than 1 wei we return zero.
+                // This happens when `x <= (log(1e-18) * 1e18) ~ -4.15e19`.
+                if (x <= -41446531673892822313) return r;
 
-            /// @solidity memory-safe-assembly
-            assembly {
-                // When the result is greater than `(2**255 - 1) / 1e18` we can not represent it as
-                // an int. This happens when `x >= floor(log((2**255 - 1) / 1e18) * 1e18) ≈ 135`.
-                if iszero(slt(x, 135305999368893231589)) {
+                /// @solidity memory-safe-assembly
+                assembly {
+                    // When the result is greater than `(2**255 - 1) / 1e18` we can not
+                    // represent it as an int. This happens when
+                    // `x >= floor(log((2**255 - 1) / 1e18) * 1e18) ≈ 135`.
                     mstore(0x00, 0xa37bfec9) // `ExpOverflow()`.
                     revert(0x1c, 0x04)
                 }
             }
 
-            // `x` is now in the range `(-42, 136) * 1e18`. Convert to `(-42, 136) * 2**96`
-            // for more intermediate precision and a binary basis. This base conversion
-            // is a multiplication by 1e18 / 2**96 = 5**18 / 2**78.
+            // Convert `x` from `10**18` fixed point to `2**96` fixed point.
             x = (x << 78) / 5 ** 18;
 
-            // Reduce range of x to (-½ ln 2, ½ ln 2) * 2**96 by factoring out powers
-            // of two such that exp(x) = exp(x') * 2**k, where k is an integer.
-            // Solving this gives k = round(x / log(2)) and x' = x - k * log(2).
-            int256 k = ((x << 96) / 54916777467707473351141471128 + 2 ** 95) >> 96;
+            // Reduce to `x' in (-½ ln 2, ½ ln 2) * 2**96` with `exp(x) = 2**k * exp(x')`.
+            // `6196328019 = round(2**128 / (ln 2 * 2**96))`; `k` is in the range `[-60, 195]`.
+            int256 k = (x * 6196328019 + 2 ** 127) >> 128;
             x = x - k * 54916777467707473351141471128;
 
-            // `k` is in the range `[-61, 195]`.
-
-            // Evaluate using a (6, 7)-term rational approximation.
-            // `p` is made monic, we'll multiply by a scale factor later.
-            int256 y = x + 1346386616545796478920950773328;
-            y = ((y * x) >> 96) + 57155421227552351082224309758442;
-            int256 p = y + x - 94201549194550492254356042504812;
-            p = ((p * y) >> 96) + 28719021644029726153956944680412240;
-            p = p * x + (4385272521454847904659076985693276 << 96);
-
-            // We leave `p` in `2**192` basis so we don't need to scale it back up for the division.
-            int256 q = x - 2855989394907223263936484059900;
-            q = ((q * x) >> 96) + 50020603652535783019961831881945;
-            q = ((q * x) >> 96) - 533845033583426703283633433725380;
-            q = ((q * x) >> 96) + 3604857256930695427073651918091429;
-            q = ((q * x) >> 96) - 14423608567350463180887372962807573;
-            q = ((q * x) >> 96) + 26449188498355588339934803723976023;
+            // `exp(x') = (E + x' * O) / (E - x' * O)`, a (5, 5)-term symmetric
+            // rational with `E`, `O` polynomials in `x'^2`. `E` is monic, so its
+            // single Horner stage needs no `>> 96`: with the constant term
+            // pre-shifted, `e` and `t` are in `2**192` basis.
+            int256 u = (x * x) >> 96;
+            int256 e = (u + 8876005618932925505308977557156) * u
+                + (79886213883764523772906264239809 << 96);
+            int256 o = ((2639738311906822815584886674 * u) >> 96) + 1109410564309688178690540877381;
+            o = ((o * u) >> 96) + 39943106941882261691307222498689;
+            int256 t = x * o;
 
             /// @solidity memory-safe-assembly
             assembly {
                 // Div in assembly because solidity adds a zero check despite the unchecked.
-                // The q polynomial won't have zeros in the domain as all its roots are complex.
-                // No scaling is necessary because p is already `2**96` too large.
-                r := sdiv(p, q)
+                // The denominator is positive on the whole reduced domain.
+                r := sdiv(add(e, t), sar(96, sub(e, t)))
             }
 
-            // r should be in the range `(0.09, 0.25) * 2**96`.
-
-            // We now need to multiply r by:
-            // - The scale factor `s ≈ 6.031367120`.
-            // - The `2**k` factor from the range reduction.
-            // - The `1e18 / 2**96` factor for base conversion.
-            // We do this all at once, with an intermediate result in `2**213`
-            // basis, so the final right shift is always by a positive amount.
+            // Multiply by `2**k * 1e18 / 2**96`. `r < 1.5 * 2**96`, so the
+            // product cannot overflow, and the shift amount is never negative.
             r = int256(
-                (uint256(r) * 3822833074963236453042738258902158003155416615667) >> uint256(195 - k)
+                (uint256(r) * 633825300114114700748351602688000000000000000000) >> uint256(195 - k)
             );
         }
     }
@@ -277,11 +263,6 @@ library FixedPointMathLib {
     function lnWad(int256 x) internal pure returns (int256 r) {
         /// @solidity memory-safe-assembly
         assembly {
-            // We want to convert `x` from `10**18` fixed point to `2**96` fixed point.
-            // We do this by multiplying by `2**96 / 10**18`. But since
-            // `ln(x * C) = ln(x) + ln(C)`, we can simply do nothing here
-            // and add `ln(2**96 / 10**18)` at the end.
-
             // Compute `k = log2(x) - 96`, `r = 159 - k = 255 - log2(x) = 255 ^ log2(x)`.
             r := shl(7, lt(0xffffffffffffffffffffffffffffffff, x))
             r := or(r, shl(6, lt(0xffffffffffffffff, shr(r, x))))
@@ -301,47 +282,44 @@ library FixedPointMathLib {
             // ln(2^k * x) = k * ln(2) + ln(x)
             x := shr(159, shl(r, x))
 
-            // Evaluate using a (8, 8)-term rational approximation.
-            // `p` is made monic, we will multiply by a scale factor later.
-            // forgefmt: disable-next-item
-            let p := sub( // This heavily nested expression is to avoid stack-too-deep for via-ir.
-                sar(96, mul(add(43456485725739037958740375743393,
-                sar(96, mul(add(24828157081833163892658089445524,
-                sar(96, mul(add(3273285459638523848632254066296,
-                    x), x))), x))), x)), 11111509109440967052023855526967)
-            p := sub(sar(96, mul(p, x)), 45023709667254063763336534515857)
-            p := sub(sar(96, mul(p, x)), 14706773417378608786704636184526)
-            p := sub(mul(p, x), shl(96, 795164235651350426258249787498))
-            // We leave `p` in `2**192` basis so we don't need to scale it back up for the division.
-
-            // `q` is monic by convention.
-            let q := add(5573035233440673466300451813936, x)
-            q := add(71694874799317883764090561454958, sar(96, mul(x, q)))
-            q := add(283447036172924575727196451306956, sar(96, mul(x, q)))
-            q := add(401686690394027663651624208769553, sar(96, mul(x, q)))
-            q := add(204048457590392012362485061816622, sar(96, mul(x, q)))
-            q := add(31853899698501571402653359427138, sar(96, mul(x, q)))
-            q := add(909429971244387300277376558375, sar(96, mul(x, q)))
-
-            // `p / q` is in the range `(0, 0.125) * 2**96`.
-
-            // Finalization, we need to:
-            // - Multiply by the scale factor `s = 5.549…`.
-            // - Add `ln(2**96 / 10**18)`.
-            // - Add `k * ln(2)`.
-            // - Multiply by `10**18 / 2**96 = 5**18 >> 78`.
-
-            // The q polynomial is known not to have zeros in the domain.
-            // No scaling required because p is already `2**96` too large.
-            p := sdiv(p, q)
-            // Multiply by the scaling factor: `s * 5**18 * 2**96`, base is now `5**18 * 2**192`.
-            p := mul(1677202110996718588342820967067443963516166, p)
-            // Add `ln(2) * k * 5**18 * 2**192`.
-            // forgefmt: disable-next-item
-            p := add(mul(16597577552685614221487285958193947469193820559219878177908093499208371, sub(159, r)), p)
-            // Add `ln(2**96 / 10**18) * 5**18 * 2**192`.
-            p := add(600920179829731861736702779321621459595472258049074101567377883020018308, p)
-            // Base conversion: mul `2**18 / 2**192`.
+            // `s = (x - sqrt(2)) * 2**96 / (x + sqrt(2))`, so that
+            // `ln(x) = ln(2)/2 + 2 * atanh(s)`.
+            let s :=
+                sdiv(
+                    shl(96, sub(x, 112045541949572279837463876455)),
+                    add(x, 112045541949572279837463876455)
+                )
+
+            // `2 * atanh(s) = s * A(w) / B(w)`, a (3, 3)-term odd rational in `w = s^2`.
+            let w := sar(96, mul(s, s))
+            let a :=
+                add(
+                    sar(96, mul(sub(w, 1813347344949966953757847210329), w)),
+                    5824670411451500986303020460168
+                )
+            a := sub(sar(96, mul(a, w)), 4518264490991587979207438354337)
+            let b :=
+                sub(
+                    sar(96, mul(188151507788160136135094921663, w)),
+                    1676640319226537252003611223372
+                )
+            b := add(sar(96, mul(b, w)), 3665379287557676720634158507137)
+            b := sub(sar(96, mul(b, w)), 2259132245495793985525851698055)
+
+            // `B` is bounded away from zero on the whole domain.
+            let p := sdiv(mul(s, a), b)
+
+            // Add `(2k + 1) * ln(2)/2` and `ln(2**96 / 10**18)`, then convert to `WAD`,
+            // all in `5**18 * 2**192` basis.
+            p := mul(302231454903657293676544000000000000000000, p)
+            p := add(
+                mul(
+                    8298788776342807110743642979096973734596910279609939088954046749604186,
+                    sub(319, shl(1, r))
+                ),
+                p
+            )
+            p := add(600920179829731861736750627322249724520361163382248881493645412721105578, p)
             r := sar(174, p)
         }
     }
@@ -428,12 +406,35 @@ library FixedPointMathLib {
             int256 t = w | 1;
             /// @solidity memory-safe-assembly
             assembly {
-                x := sdiv(mul(x, wad), t)
-            }
-            x = (t * (wad + lnWad(x)));
-            /// @solidity memory-safe-assembly
-            assembly {
-                w := sdiv(x, add(wad, t))
+                x := sdiv(add(mul(x, wad), shr(1, t)), t)
+                // Inline the `lnWad` core at `2**96` precision, so that the final
+                // step rounds to nearest regardless of `lnWad`'s wad rounding.
+                let v := shl(7, lt(0xffffffffffffffffffffffffffffffff, x))
+                v := or(v, shl(6, lt(0xffffffffffffffff, shr(v, x))))
+                v := or(v, shl(5, lt(0xffffffff, shr(v, x))))
+                v := or(v, shl(4, lt(0xffff, shr(v, x))))
+                v := or(v, shl(3, lt(0xff, shr(v, x))))
+                // forgefmt: disable-next-item
+                v := xor(v, byte(and(0x1f, shr(shr(v, x), 0x8421084210842108cc6318c6db6d54be)),
+                    0xf8f9f9faf9fdfafbf9fdfcfdfafbfcfef9fafdfafcfcfbfefafafcfbffffffff))
+                x := shr(159, shl(v, x))
+                let s := sdiv(shl(96, sub(x, 112045541949572279837463876455)),
+                    add(x, 112045541949572279837463876455))
+                let z := sar(96, mul(s, s))
+                let a := add(sar(96, mul(sub(z, 1813347344949966953757847210329), z)),
+                    5824670411451500986303020460168)
+                a := sub(sar(96, mul(a, z)), 4518264490991587979207438354337)
+                let b := sub(sar(96, mul(188151507788160136135094921663, z)),
+                    1676640319226537252003611223372)
+                b := add(sar(96, mul(b, z)), 3665379287557676720634158507137)
+                b := sub(sar(96, mul(b, z)), 2259132245495793985525851698055)
+                // `l = ln(x' / 1e18) * 2**96`.
+                let l := add(sdiv(mul(s, a), b),
+                    add(mul(27458388733853736675570735564, sub(319, shl(1, v))),
+                        1988278089788132588087242333381))
+                // `w = t * (2**96 + l) * 1e18 / (2**96 * (1e18 + t))`, rounded to nearest.
+                let d := mul(shl(96, 1), add(wad, t))
+                w := sdiv(add(mul(mul(t, add(shl(96, 1), l)), wad), shr(1, d)), d)
             }
         }
     }