Speedup quo round up, start CL speedup integration

CHANGELOG.md

@@ -46,7 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### State Compatible
 
-* [#8006](https://github.com/osmosis-labs/osmosis/pull/8006) Speedup many BigDec operations
+* [#8006](https://github.com/osmosis-labs/osmosis/pull/8006), [#8014](https://github.com/osmosis-labs/osmosis/pull/8014) Speedup many BigDec operations
 
 ## v24.0.1
 

go.mod

@@ -30,10 +30,10 @@ require (
 	github.com/mattn/go-sqlite3 v1.14.17
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/osmosis-labs/go-mutesting v0.0.0-20221208041716-b43bcd97b3b3
-	github.com/osmosis-labs/osmosis/osmomath v0.0.12-0.20240410095049-0ddea0b91fb3
-	github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240410095049-0ddea0b91fb3
-	github.com/osmosis-labs/osmosis/x/epochs v0.0.8-0.20240410095049-0ddea0b91fb3
-	github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.14-0.20240410095049-0ddea0b91fb3
+	github.com/osmosis-labs/osmosis/osmomath v0.0.12-0.20240411084426-590a939240de
+	github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240411084426-590a939240de
+	github.com/osmosis-labs/osmosis/x/epochs v0.0.8-0.20240411084426-590a939240de
+	github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.14-0.20240411084426-590a939240de
 	github.com/osmosis-labs/sqs/sqsdomain v0.0.0-20240404053421-41aab009fb04
 	github.com/pkg/errors v0.9.1
 	github.com/rakyll/statik v0.1.7

go.sum

@@ -1517,14 +1517,14 @@ github.com/osmosis-labs/cosmos-sdk v0.47.5-v24-osmo-5 h1:fnt89Cw+55vbnIEGkpCmj0c
 github.com/osmosis-labs/cosmos-sdk v0.47.5-v24-osmo-5/go.mod h1:eSRUVYwL3eG1jnh01CnBbHiqOM3xJO49p5rTOrSFX1k=
 github.com/osmosis-labs/go-mutesting v0.0.0-20221208041716-b43bcd97b3b3 h1:YlmchqTmlwdWSmrRmXKR+PcU96ntOd8u10vTaTZdcNY=
 github.com/osmosis-labs/go-mutesting v0.0.0-20221208041716-b43bcd97b3b3/go.mod h1:lV6KnqXYD/ayTe7310MHtM3I2q8Z6bBfMAi+bhwPYtI=
-github.com/osmosis-labs/osmosis/osmomath v0.0.12-0.20240410095049-0ddea0b91fb3 h1:2FRCIC8gXSACn9SMmZivBXYdND/O/xrYK9rRzdY/fSY=
-github.com/osmosis-labs/osmosis/osmomath v0.0.12-0.20240410095049-0ddea0b91fb3/go.mod h1:I1Nw0VK1JOaZH5f0AFl4iFB2Qp2ckbH9a3Z4UZLpDbs=
-github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240410095049-0ddea0b91fb3 h1:dJFXQbBbMZ9UDtIMseoGlBg4fe5rSui7x3x9baAGw9w=
-github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240410095049-0ddea0b91fb3/go.mod h1:fo3rKZIybC/tRMX09a0W/1UBl9meK1+T4PmWs1wErHI=
-github.com/osmosis-labs/osmosis/x/epochs v0.0.8-0.20240410095049-0ddea0b91fb3 h1:UGxPvBFipIM8q3SJUYRjSP0+D/3Y8BkZGLvO+ov/fYs=
-github.com/osmosis-labs/osmosis/x/epochs v0.0.8-0.20240410095049-0ddea0b91fb3/go.mod h1:N2+CB3wWEN/HmtWNK9DjAN1WGLgqeRiGjs+ZhK3RXdQ=
-github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.14-0.20240410095049-0ddea0b91fb3 h1:QHtWt4M49bYH64Vy0DetURTtLGUIGWTpLOBIH9q/bhQ=
-github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.14-0.20240410095049-0ddea0b91fb3/go.mod h1:C4/AaeluMrYxFehK61WGXVG7DvofFUyit7Xb0QKyQPA=
+github.com/osmosis-labs/osmosis/osmomath v0.0.12-0.20240411084426-590a939240de h1:BmR5g0KhFaIW2XheFb2sjWdklPlxi2Z+CRSjf/VDxmM=
+github.com/osmosis-labs/osmosis/osmomath v0.0.12-0.20240411084426-590a939240de/go.mod h1:EH4baEX2mKDDDgcXQEk5gLQ+ECdDIr89Gtib5a+b3B4=
+github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240411084426-590a939240de h1:SPkrgdKuSqcgLb69n/nB9ET1HBkJKryezfBCCs2y55U=
+github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240411084426-590a939240de/go.mod h1:n4M42bFg0gv2DYTTkQKkMbK1yoQgf4b2tXKbDQaYgDA=
+github.com/osmosis-labs/osmosis/x/epochs v0.0.8-0.20240411084426-590a939240de h1:17qcDGmHmZppIq6Eg6UVapGhEciJIFYnqanYjy6es4w=
+github.com/osmosis-labs/osmosis/x/epochs v0.0.8-0.20240411084426-590a939240de/go.mod h1:87lVvPi4rmay0Dg5sOy/zVpCFqVfWXA9imScZxpqLYk=
+github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.14-0.20240411084426-590a939240de h1:y6NbCB3jQH4EOHOmmYUmFBm36u25l9bckDKT6C3qhdw=
+github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.14-0.20240411084426-590a939240de/go.mod h1:DjJDDKxBPqLWPKKecDXBnM1kN4hi5XiLB7yAQqRpSRQ=
 github.com/osmosis-labs/sqs/sqsdomain v0.0.0-20240404053421-41aab009fb04 h1:mvkk1A/jIe+lsFFpRNfyd9UfvhagATdpnjy8K7kANeo=
 github.com/osmosis-labs/sqs/sqsdomain v0.0.0-20240404053421-41aab009fb04/go.mod h1:mYYf7pYb7sGJ9zYIOw2aYlIl5cgKT0K93rZx4LvDAuA=
 github.com/osmosis-labs/wasmd v0.45.0-osmo h1:NIp7pvJV5HuBN1HwPgEmXKQM2TjVIVdJErIHnB9IMO8=

osmomath/decimal.go

@@ -44,12 +44,14 @@ var (
 	squaredPrecisionReuse        = new(big.Int).Mul(defaultBigDecPrecisionReuse, defaultBigDecPrecisionReuse)
 	bigDecDecPrecisionFactorDiff = new(big.Int).Exp(big.NewInt(10), big.NewInt(BigDecPrecision-DecPrecision), nil)
 
+	tenTimesPrecision   = new(big.Int).Exp(big.NewInt(10), big.NewInt(BigDecPrecision+1), nil)
 	fivePrecision       = new(big.Int).Quo(defaultBigDecPrecisionReuse, big.NewInt(2))
 	fivePrecisionSDKDec = new(big.Int).Quo(precisionReuseSDKDec, big.NewInt(2))
 
 	precisionMultipliers []*big.Int
 	zeroInt              = big.NewInt(0)
 	oneInt               = big.NewInt(1)
+	fiveInt              = big.NewInt(5)
 	tenInt               = big.NewInt(10)
 
 	// log_2(e)
@@ -172,6 +174,11 @@ func NewBigDecFromIntWithPrec(i BigInt, prec int64) BigDec {
 	}
 }
 
+func NewBigDecFromDecMulDec(a, b Dec) BigDec {
+	newBi := new(big.Int).Mul(a.BigIntMut(), b.BigIntMut())
+	return BigDec{newBi}
+}
+
 // create a decimal from an input decimal string.
 // valid must come in the form:
 //
@@ -294,9 +301,7 @@ func (d BigDec) Add(d2 BigDec) BigDec {
 func (d BigDec) AddMut(d2 BigDec) BigDec {
 	d.i.Add(d.i, d2.i)
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(d.i)
 
 	return d
 }
@@ -310,10 +315,7 @@ func (d BigDec) Sub(d2 BigDec) BigDec {
 
 func (d BigDec) SubMut(d2 BigDec) BigDec {
 	res := d.i.Sub(d.i, d2.i)
-
-	if res.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(res)
 	return BigDec{res}
 }
 
@@ -344,9 +346,7 @@ func (d BigDec) MulMut(d2 BigDec) BigDec {
 	d.i.Mul(d.i, d2.i)
 	d.i = chopPrecisionAndRound(d.i)
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(d.i)
 	return BigDec{d.i}
 }
 
@@ -360,62 +360,45 @@ func (d BigDec) MulDecMut(d2 Dec) BigDec {
 	d.i.Mul(d.i, d2.BigIntMut())
 	d.i = chopPrecisionAndRoundSdkDec(d.i)
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(d.i)
 	return BigDec{d.i}
 }
 
 // multiplication truncate
 func (d BigDec) MulTruncate(d2 BigDec) BigDec {
 	mul := new(big.Int).Mul(d.i, d2.i)
 	chopped := chopPrecisionAndTruncateMut(mul, defaultBigDecPrecisionReuse)
-
-	if chopped.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(chopped)
 	return BigDec{chopped}
 }
 
 func (d BigDec) MulTruncateDec(d2 Dec) BigDec {
 	mul := new(big.Int).Mul(d.i, d2.BigIntMut())
 	chopped := chopPrecisionAndTruncateMut(mul, precisionReuseSDKDec)
-
-	if chopped.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(chopped)
 	return BigDec{chopped}
 }
 
 // multiplication round up
 func (d BigDec) MulRoundUp(d2 BigDec) BigDec {
 	mul := new(big.Int).Mul(d.i, d2.i)
 	chopped := chopPrecisionAndRoundUpMut(mul, defaultBigDecPrecisionReuse)
-
-	if chopped.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(chopped)
 	return BigDec{chopped}
 }
 
 // multiplication
 func (d BigDec) MulInt(i BigInt) BigDec {
 	mul := new(big.Int).Mul(d.i, i.i)
-
-	if mul.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(mul)
 	return BigDec{mul}
 }
 
 // MulInt64 - multiplication with int64
 func (d BigDec) MulInt64(i int64) BigDec {
 	bi := big.NewInt(i)
 	mul := bi.Mul(d.i, bi)
-
-	if mul.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(mul)
 	return BigDec{mul}
 }
 
@@ -429,38 +412,31 @@ func (d BigDec) Quo(d2 BigDec) BigDec {
 // mutative quotient
 func (d BigDec) QuoMut(d2 BigDec) BigDec {
 	// multiply precision twice
+	// TODO: Use lower overhead thing here
 	d.i.Mul(d.i, squaredPrecisionReuse)
 
 	d.i.Quo(d.i, d2.i)
 	chopPrecisionAndRound(d.i)
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(d.i)
 	return d
 }
 func (d BigDec) QuoRaw(d2 int64) BigDec {
 	// multiply precision, so we can chop it later
+	// TODO: There is certainly more efficient ways to do this, come back later
 	mul := new(big.Int).Mul(d.i, defaultBigDecPrecisionReuse)
 
 	quo := mul.Quo(mul, big.NewInt(d2))
 	chopped := chopPrecisionAndRound(quo)
-
-	if chopped.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(chopped)
 	return BigDec{chopped}
 }
 
 // quotient truncate
 func (d BigDec) QuoTruncate(d2 BigDec) BigDec {
-	// multiply precision twice
 	mul := new(big.Int).Mul(d.i, defaultBigDecPrecisionReuse)
 	quo := mul.Quo(mul, d2.i)
-
-	if quo.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(quo)
 	return BigDec{quo}
 }
 
@@ -470,9 +446,7 @@ func (d BigDec) QuoTruncateMut(d2 BigDec) BigDec {
 	d.i.Mul(d.i, defaultBigDecPrecisionReuse)
 	d.i.Quo(d.i, d2.i)
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(d.i)
 	return d
 }
 
@@ -481,10 +455,7 @@ func (d BigDec) QuoTruncateDec(d2 Dec) BigDec {
 	// multiply Dec Precision
 	mul := new(big.Int).Mul(d.i, precisionReuseSDKDec)
 	quo := mul.Quo(mul, d2.BigIntMut())
-
-	if quo.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(quo)
 	return BigDec{quo}
 }
 
@@ -494,37 +465,30 @@ func (d BigDec) QuoTruncateDecMut(d2 Dec) BigDec {
 	d.i.Mul(d.i, precisionReuseSDKDec)
 	d.i.Quo(d.i, d2.BigIntMut())
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	assertMaxBitLen(d.i)
 	return d
 }
 
 // quotient, round up
 func (d BigDec) QuoRoundUp(d2 BigDec) BigDec {
-	// multiply precision twice
-	mul := new(big.Int).Mul(d.i, squaredPrecisionReuse)
-
-	quo := mul.Quo(mul, d2.i)
-	chopped := chopPrecisionAndRoundUpMut(quo, defaultBigDecPrecisionReuse)
+	mul := new(big.Int).Mul(d.i, defaultBigDecPrecisionReuse)
 
-	if chopped.BitLen() > maxDecBitLen {
-		panic("Int overflow")
+	chopped, rem := mul.QuoRem(mul, d2.i, new(big.Int))
+	if rem.Sign() > 0 {
+		chopped.Add(chopped, oneInt)
 	}
+
+	assertMaxBitLen(chopped)
 	return BigDec{chopped}
 }
 
 // quotient, round up (mutative)
 func (d BigDec) QuoRoundUpMut(d2 BigDec) BigDec {
-	// multiply precision twice
-	d.i.Mul(d.i, squaredPrecisionReuse)
-	d.i.Quo(d.i, d2.i)
-
-	chopPrecisionAndRoundUpMut(d.i, defaultBigDecPrecisionReuse)
+	d.i.Mul(d.i, defaultBigDecPrecisionReuse)
+	_, rem := d.i.QuoRem(d.i, d2.i, new(big.Int))
 
-	if d.i.BitLen() > maxDecBitLen {
-		panic("Int overflow")
-	}
+	d.i = incBasedOnRem(rem, d.i)
+	assertMaxBitLen(d.i)
 	return BigDec{d.i}
 }
 
@@ -588,6 +552,12 @@ func (d BigDec) ApproxRoot(root uint64) (guess BigDec, err error) {
 	return guess, nil
 }
 
+func assertMaxBitLen(i *big.Int) {
+	if i.BitLen() > maxDecBitLen {
+		panic("Int overflow")
+	}
+}
+
 // ApproxSqrt is a wrapper around ApproxRoot for the common special case
 // of finding the square root of a number. It returns -(sqrt(abs(d)) if input is negative.
 // TODO: Optimize this to be faster just using native big int sqrt.
@@ -863,6 +833,13 @@ func chopPrecisionAndRoundUpDec(d *big.Int) *big.Int {
 	return chopPrecisionAndRoundUpMut(copy, precisionReuseSDKDec)
 }
 
+func incBasedOnRem(rem *big.Int, d *big.Int) *big.Int {
+	if rem.Sign() == 0 {
+		return d
+	}
+	return d.Add(d, oneInt)
+}
+
 // chopPrecisionAndRoundUp removes a Precision amount of rightmost digits and rounds up.
 // Mutates input d.
 // Mutations occur:
@@ -881,12 +858,7 @@ func chopPrecisionAndRoundUpMut(d *big.Int, precisionReuse *big.Int) *big.Int {
 
 	// get the truncated quotient and remainder
 	_, rem := d.QuoRem(d, precisionReuse, big.NewInt(0))
-
-	if rem.Sign() == 0 { // remainder is zero
-		return d
-	}
-
-	return d.Add(d, oneInt)
+	return incBasedOnRem(rem, d)
 }
 
 func chopPrecisionAndRoundNonMutative(d *big.Int) *big.Int {

osmomath/decimal_test.go

@@ -178,6 +178,53 @@ func (s *decimalTestSuite) TestNewDecFromStr() {
 	}
 }
 
+var interestingDecNumbers = []string{
+	"123456789012345678901234567890123456.123456789012345678",
+	"111111111111111111111111111111111111.111111111111111111",
+	"999999999999999999999999999999999999.999999999999999999",
+	"314159265358979323846264338327950288.419716939937510582", // Approximation of Pi
+	"161803398874989484820458683436563811.772030917980576286", // Approximation of Phi
+	"271828182845904523536028747135266249.775724709369995957", // Approximation of e
+	"101010101010101010101010101010101010.101010101010101010", // Binary pattern
+	"123456789987654321123456789987654321.123456789987654321", // Ascending and descending pattern
+	"112358132134558914423337761098715972.584418167651094617", // Inspired by Fibonacci sequence
+	"142857142857142857142857142857142857.142857142857142857", // Repeating decimal for 1/7
+}
+
+var interestingDecNumbersDec = []osmomath.Dec{}
+
+func init() {
+	for _, str := range interestingDecNumbers {
+		d, err := osmomath.NewDecFromStr(str)
+		if err != nil {
+			panic(fmt.Sprintf("error parsing decimal string %v: %v", str, err))
+		}
+		interestingDecNumbersDec = append(interestingDecNumbersDec, d)
+	}
+}
+
+func (s *decimalTestSuite) TestNewBigDecFromDecMulDec() {
+	type testcase struct {
+		s1, s2 osmomath.Dec
+	}
+	tests := []testcase{}
+	for _, d1 := range interestingDecNumbersDec {
+		for _, d2 := range interestingDecNumbersDec {
+			tests = append(tests, testcase{d1, d2})
+		}
+	}
+	for _, tc := range tests {
+		s.Run(fmt.Sprintf("d1=%v, d2=%v", tc.s1, tc.s2), func() {
+			s1D := osmomath.BigDecFromDec(tc.s1)
+			s2D := osmomath.BigDecFromDec(tc.s2)
+			expected := s1D.MulMut(s2D)
+			actual := osmomath.NewBigDecFromDecMulDec(tc.s1, tc.s2)
+			s.Require().True(expected.Equal(actual), "expected %v, got %v", expected, actual)
+		})
+	}
+	s.Require().True(len(tests) > 20)
+}
+
 func (s *decimalTestSuite) TestDecString() {
 	tests := []struct {
 		d    osmomath.BigDec

osmomath/go.mod

@@ -5,7 +5,7 @@ go 1.21
 require (
 	cosmossdk.io/math v1.3.0
 	github.com/cosmos/cosmos-sdk v0.47.8
-	github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240410095049-0ddea0b91fb3
+	github.com/osmosis-labs/osmosis/osmoutils v0.0.12-0.20240411084426-590a939240de
 	github.com/stretchr/testify v1.9.0
 	gopkg.in/yaml.v2 v2.4.0