search

berachain / beacon-kit

A modular framework for building EVM consensus clients ⛵️✨
https://berachain.com
Other
147 stars 100 forks source link

perf(serializer): use direct indexing to avoid append overhead #1657

Closed hoank101 closed 3 months ago

hoank101 commented 3 months ago

Before

pkg: github.com/berachain/beacon-kit/mod/primitives/pkg/ssz/serializer
BenchmarkUnmarshalVectorFixed
BenchmarkUnmarshalVectorFixed-11          327990          3292 ns/op

After

pkg: github.com/berachain/beacon-kit/mod/primitives/pkg/ssz/serializer
BenchmarkUnmarshalVectorFixed
BenchmarkUnmarshalVectorFixed-11          402188          2825 ns/op

Summary by CodeRabbit

hoank101 commented 3 months ago

hey @coderabbitai , what do you think?

coderabbitai[bot] commented 3 months ago

@hoank101, the changes look solid. By pre-allocating the slice and using direct indexing, the overhead of dynamically growing the slice with append is avoided. This optimization is reflected in the improved benchmark results:

The performance improvement is significant, with the number of operations per second increasing and the time per operation decreasing. Great job on this optimization!

Analysis chain
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Fetch the diff of the PR to examine the changes made in the serializer. gh pr diff 1657 ``` Length of output: 2962
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
coderabbitai[bot] commented 3 months ago

Walkthrough

This update enhances the UnmarshalVectorFixed function in vector.go to optimize buffer length calculation and element processing. It also includes a new file vector_test.go that introduces benchmarking logic for unmarshalling fixed vectors with a mock type implementation, aiming to improve performance and memory allocation efficiency.

Changes

File Change Summary
mod/primitives/pkg/ssz/serializer/vector.go Optimized UnmarshalVectorFixed for better buffer length calculation and memory allocation.
mod/primitives/pkg/ssz/serializer/vector_test.go Added benchmarking logic and a MockType for testing UnmarshalVectorFixed.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant UnmarshalVectorFixed
    participant MockType

    Client->>+UnmarshalVectorFixed: Call Function with buf and t
    UnmarshalVectorFixed->>MockType: Calculate Element Size and Allocate Memory
    UnmarshalVectorFixed->>Client: Return Marshalled Result

    Note over UnmarshalVectorFixed: Optimized buffer length calculation and memory allocation

Poem

In bytes and slices, tales unfold,
Marshalled vectors, a sight to behold.
Optimized with care, they run so swift,
In tests and benches, they give a lift.
The code now gleams, with speed and grace,
A rabbit's joy in every trace. 🐇✨

[!TIP]

Early access features - OpenAI `gpt-4o` model for reviews and chat. Note: - You can disable early access features from the CodeRabbit UI or by setting `early_access: false` in the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are always opted into early access features.
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.