cosmos / iavl

Merkleized IAVL+ Tree implementation in Go
Apache License 2.0
409 stars 256 forks source link

perf: Remove unneeded GetKey calls to the LRU cache #890

Closed ValarDragon closed 4 months ago

ValarDragon commented 4 months ago

Remove some extra GetKey calls within the LRU cache code. GetKey calls took 1.5s on an Osmosis 2000 block long block sync. This PR should shave off .45s of that.

Though ideally we get the LRU code rethought / adapted more, to make it generally lower overhead. (Its currently 13.5 s on a 2000 block sync!)

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent modifications enhance the efficiency and readability of the caching mechanism within the cache.go file. By introducing local variables to store string representations of keys before operations, the Add and Remove methods now offer clearer and potentially more performant key handling. Furthermore, the addition of a removeWithKey method simplifies the removal process by allowing direct key-based cache element deletion, streamlining cache management.

Changes

File Path Change Summary
cache/cache.go - Add method stores key's string representation in a local variable before checking existence.
- Remove method uses a local variable for key's string representation before operations.
- Added removeWithKey method for direct key-based removal.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: > Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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 tests 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 tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
tac0turtle commented 4 months ago

@mergifyio backport release/v1.x.x

mergify[bot] commented 4 months ago

backport release/v1.x.x

✅ Backports have been created

* [#899 perf: Remove unneeded GetKey calls to the LRU cache (backport #890)](https://github.com/cosmos/iavl/pull/899) has been created for branch `release/v1.x.x`
odeke-em commented 4 months ago

@ValarDragon this isn't fully the correct optimization despite eliminating the extra call to node.Key() while then also keep the original intended optimization or zero byteslice->string conversion in the case of already existing keys when looking im the map. In short it now it incurs the byteslice->string conversion in all cases, but could have been faster if it had been:

key := node.GetKey()
if value, ok := c.dict[string(key)]; ok {
   ...
}

c.dict[string(key)] = value