Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: Avoid making an extra heap copy in DecodeBytes #865

Closed

Conversation

ValarDragon
Copy link
Contributor

Deserializing bytes right now is making a new heap copy of the slice. In IAVL v1, with legacy nodes, over a 100 block period this appeared to be 0.3% of the CPU time. (Plus heap / memory pressure)

This is only needed if the input bytes are mutated, but this is not the case in any usage of this, as each read is coming from a new GetNode or cache result. GetNode returns new heap-data for the value, and the cache entries do not mutate. Hence we can save on CPU time + heap pressure with this.

@ValarDragon ValarDragon requested a review from a team as a code owner December 24, 2023 17:21
Copy link

coderabbitai bot commented Dec 24, 2023

Walkthrough

The recent changes involve optimizations in data handling, specifically concerning byte slices. Both DeserializeNode and DecodeBytes functions now operate under the assumption that the byte slices they process will not be modified after being passed in. This has led to the removal of data copying mechanisms, likely improving performance by reducing memory usage and processing time.

Changes

File(s) Change Summary
fastnode/.../fast_node.go
internal/.../encoding.go
DeserializeNode now assumes immutable []byte input.
DecodeBytes directly returns a slice of bz to avoid unnecessary copying.

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 with CodeRabbit Bot (@coderabbitai)

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
    • @coderabbitai generate unit tests for this file
    • @coderabbitai modularize this function
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions. Examples:
    • @coderabbitai gather interesting statistics about this repository and render them in a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai generate unit tests for the src/utils.ts file.

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.
  • 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 to get help, request features, and share feedback.

@ValarDragon ValarDragon changed the title Avoid making an extra heap copy in DecodeBytes perf: Avoid making an extra heap copy in DecodeBytes Dec 24, 2023
Comment on lines 55 to 57
// bz2 := make([]byte, size)
// copy(bz2, bz[n:end])
return bz[n:end], end, nil
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The removal of the byte slice copy operation is a significant change. It assumes that the input bytes are immutable post-read, which could lead to memory safety issues if this assumption is violated. It is crucial to verify that all current and future usages of this function adhere to this assumption.

@cool-develope
Copy link
Collaborator

cool-develope commented Feb 19, 2024

@ValarDragon could we close it since it is included in #877? also #864

@ValarDragon
Copy link
Contributor Author

Sure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants