BigDec operation speedups #8006

ValarDragon · 2024-04-10T06:49:02Z

Changes:

Rename precisionReuse -> defaultBigDecPrecisionReuse
Rename precisionReuseSDK -> precisionReuseSDKDec
Use squaredPrecisionReuse properly (saving many internal ops). This is clearly state compat because we are replacing double Mul's with a single one that will commute.
expose precisionReuse as an argument more consistently
Remove redundant copies in many BigDec operations
Speedup common BigDec X Dec ops
- Just needs tests
Speedup Quo w/ rounding - Update: My intuition was wrong for roundup, Now looking into RoundDown
- Truncate was significantly sped up. (Saved the chop routine, and operate on something two word sizes smaller!)

Its easiest to review this PR commit by commit

coderabbitai · 2024-04-10T06:49:10Z

Walkthrough

The update in version v24.0.1 enhances the efficiency of BigDec operations by restructuring variable naming and management in decimal arithmetic operations. These changes aim to improve precision and calculation accuracy, optimizing performance and computational integrity in mathematical functions.

Changes

File(s)	Change Summary
`osmomath/decimal.go`	Renaming and reorganization of precision-related variables; introduction of `squaredPrecisionReuse`.
`osmomath/decimal_test.go`	Update in `TestApproxRoot` function to use `AbsMut` instead of `Abs`.
`x/concentrated-liquidity/math/math.go`	Logic update in `CalcAmount1Delta` function for absolute value calculation.
`x/gamm/pool-models/stableswap/amm.go`	Mutating operations on `osmomath.BigDec` types for in-place modifications.

🐰✨
Oh hark! A change, a tweak, a twist,
In math where decimals coexist.
Precision fine like morning dew,
Code hops along, fresh and new.
Cheers to devs, with brains so bright,
Crafting code by moon's soft light. 🌙
🎉🥕

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between dfe1b43 and 47d4f52.

Files ignored due to path filters (10)

go.mod is excluded by !**/*.mod
go.sum is excluded by !**/*.sum
osmomath/go.mod is excluded by !**/*.mod
osmomath/go.sum is excluded by !**/*.sum
osmoutils/go.mod is excluded by !**/*.mod
osmoutils/go.sum is excluded by !**/*.sum
x/epochs/go.mod is excluded by !**/*.mod
x/epochs/go.sum is excluded by !**/*.sum
x/ibc-hooks/go.mod is excluded by !**/*.mod
x/ibc-hooks/go.sum is excluded by !**/*.sum

Files selected for processing (4)

osmomath/decimal.go (22 hunks)
osmomath/decimal_test.go (1 hunks)
x/concentrated-liquidity/math/math.go (1 hunks)
x/gamm/pool-models/stableswap/amm.go (2 hunks)

Files not reviewed due to errors (1)

(no review received)

Files skipped from review as they are similar to previous changes (1)

osmomath/decimal.go

Additional comments not posted (2)

x/concentrated-liquidity/math/math.go (1)

100-100: Verify the removal of the GT check in CalcAmount1Delta.

osmomath/decimal_test.go (1)

621-621: Ensure that the mutation from AbsMut() does not unintentionally affect subsequent operations where expected or res might be reused in the TestApproxRoot function.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-04-10T06:49:19Z

Important Notice

This PR modifies an in-repo Go module. It is one of:

osmomath
osmoutils
x/ibc-hooks
x/epochs

The dependent Go modules, especially the root one, will have to be
updated to reflect the changes. Failing to do so might cause e2e to fail.

Please follow the instructions below:

Open https://github.com/osmosis-labs/osmosis/actions/workflows/go-mod-auto-bump.yml
Provide the current branch name
On success, confirm if an automated commit corretly updated the go.mod and go.sum files

Please let us know if you need any help.

ValarDragon · 2024-04-10T07:00:06Z

I'll edit several CL methods in a second PR

czarcas7ic

I think the go.mod at the highest level needs to be updated to use this version of osmomath in order to ensure all tests pass, and not just the osmomath specific tests (it LGTM, but would make sense to do this prior to merge)

czarcas7ic · 2024-04-10T16:41:26Z

osmomath/decimal.go

+	if d.i.BitLen() > maxDecBitLen {
+		panic("Int overflow")
+	}


nit: this logic gets reused 5/6 times in this PR, maybe could be a single line helper.

Lets do that in a second PR, agreed tho

…ependencies locally

* Rename precisionReuse and use squaredPrecisionReuse properly * Remove redundant copies for chop operations * Speedup RoundUpMut failed, just committing benchmark * CL notes * Speedup Truncate routines by saving ~2 word sizes * Add BigDec x Dec fns * Minor approx root spedup * Driveby, better mut usage in stableswap * Add AbsMut * Auto: update go.mod after push to dev/bigdec_speedups that modified dependencies locally --------- Co-authored-by: github-actions <github-actions@github.com> (cherry picked from commit b56059e) # Conflicts: # CHANGELOG.md # go.mod # go.sum # osmomath/go.mod # osmomath/go.sum # osmoutils/go.mod # osmoutils/go.sum # x/epochs/go.mod # x/epochs/go.sum # x/ibc-hooks/go.mod # x/ibc-hooks/go.sum

* Rename precisionReuse and use squaredPrecisionReuse properly * Remove redundant copies for chop operations * Speedup RoundUpMut failed, just committing benchmark * CL notes * Speedup Truncate routines by saving ~2 word sizes * Add BigDec x Dec fns * Minor approx root spedup * Driveby, better mut usage in stableswap * Add AbsMut * Auto: update go.mod after push to dev/bigdec_speedups that modified dependencies locally --------- Co-authored-by: github-actions <github-actions@github.com> (cherry picked from commit b56059e) # Conflicts: # go.mod # go.sum # osmomath/go.mod # osmomath/go.sum # osmoutils/go.mod # osmoutils/go.sum # x/epochs/go.mod # x/epochs/go.sum # x/ibc-hooks/go.mod # x/ibc-hooks/go.sum

* BigDec operation speedups (backport #8006) * Speedup quo round up, start CL speedup integration (#8014) * Speedup quo round up * Code reuse * Missed a code re-use point * Add future notes * Comment cleanup * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Add new fn: NewBigDecFromDecMulDec * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove some extra ops from CL * Further perf notes * Make faster QuoRoundUpNextIntMut * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove another 2 BigDec ops * Add another dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Start moving some liquidity calls to Dec not BigDec * One more BigDec x Dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Another liq BigDec -> Dec * Missed one step * Move another Liquidity BigDec -> Dec * Minor spread reward update * Make CalcAmount1Dec use Dec for Liquidity * Make one more op mutative * One more speedup * Fix test * Speedup SpotPrice impl --------- Co-authored-by: github-actions <github-actions@github.com> * updates * updates --------- Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com> Co-authored-by: github-actions <github-actions@github.com>

Rename precisionReuse and use squaredPrecisionReuse properly

939fc9a

ValarDragon added A:backport/v23.x backport patches to v23.x branch A:backport/v24.x backport patches to v24.x branch labels Apr 10, 2024

Remove redundant copies for chop operations

1e44832

ValarDragon added the V:state/compatible/backport State machine compatible PR, should be backported label Apr 10, 2024

ValarDragon changed the title ~~Rename precisionReuse and use squaredPrecisionReuse properly~~ BigDec operation speedups Apr 10, 2024

ValarDragon added 3 commits April 10, 2024 17:35

Speedup RoundUpMut failed, just committing benchmark

78800bd

CL notes

5ea9e64

Speedup Truncate routines by saving ~2 word sizes

6c727bd

ValarDragon requested review from czarcas7ic, p0mvn and AlpinYukseloglu as code owners April 10, 2024 09:24

github-actions bot added the C:x/concentrated-liquidity label Apr 10, 2024

ValarDragon added 3 commits April 10, 2024 18:25

Add BigDec x Dec fns

75274eb

Minor approx root spedup

dfe1b43

Driveby, better mut usage in stableswap

717447d

ValarDragon requested a review from mattverse as a code owner April 10, 2024 09:47

github-actions bot added the C:x/gamm Changes, features and bugs related to the gamm module. label Apr 10, 2024

Add AbsMut

0ddea0b

czarcas7ic approved these changes Apr 10, 2024

View reviewed changes

Auto: update go.mod after push to dev/bigdec_speedups that modified d…

47d4f52

…ependencies locally

ValarDragon requested a review from nicolaslara as a code owner April 10, 2024 18:24

czarcas7ic closed this Apr 10, 2024

czarcas7ic reopened this Apr 10, 2024

github-actions bot added the C:x/epochs label Apr 10, 2024

ValarDragon merged commit b56059e into main Apr 11, 2024
1 check passed

ValarDragon deleted the dev/bigdec_speedups branch April 11, 2024 07:10

mergify bot mentioned this pull request Apr 11, 2024

BigDec operation speedups (backport #8006) #8010

Closed

This was referenced Apr 11, 2024

BigDec operation speedups (backport #8006) #8011

Closed

BigDec operation speedups (backport #8006) #8012

Closed

p0mvn added a commit that referenced this pull request Apr 12, 2024

BigDec operation speedups (backport #8006)

e77a4a4

p0mvn mentioned this pull request Apr 12, 2024

Roman/backport dev math speed up v24 #8037

Merged

github-actions bot mentioned this pull request Apr 15, 2024

Broken Links Detected #8046

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BigDec operation speedups #8006

BigDec operation speedups #8006

ValarDragon commented Apr 10, 2024 •

edited

Loading

coderabbitai bot commented Apr 10, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Apr 10, 2024

ValarDragon commented Apr 10, 2024

czarcas7ic left a comment

czarcas7ic Apr 10, 2024

ValarDragon Apr 11, 2024

BigDec operation speedups #8006

BigDec operation speedups #8006

Conversation

ValarDragon commented Apr 10, 2024 • edited Loading

coderabbitai bot commented Apr 10, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Apr 10, 2024

ValarDragon commented Apr 10, 2024

czarcas7ic left a comment

Choose a reason for hiding this comment

czarcas7ic Apr 10, 2024

Choose a reason for hiding this comment

ValarDragon Apr 11, 2024

Choose a reason for hiding this comment

ValarDragon commented Apr 10, 2024 •

edited

Loading

coderabbitai bot commented Apr 10, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)