-
Notifications
You must be signed in to change notification settings - Fork 4
β‘ Bolt: Cache color map to avoid per-plugin allocations #90
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ## 2024-05-07 - Avoid Per-Execution Map Allocations | ||
| **Learning:** Repeatedly creating map structures (like `colors.ColorMap()`) during per-plugin execution within a parallel loop causes excessive memory allocation and performance overhead. | ||
| **Action:** Cache static map data at the instance level (e.g., `StatusLine` struct) during initialization using `sync.Once` to ensure thread-safety, minimize allocations, and maintain backward compatibility. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sharing the same map instance across multiple concurrent plugin executions introduces a potential data race. In Go, maps are reference types, and since
renderLineexecutes plugins in parallel goroutines, any native plugin that modifies theColorsmap will cause a race condition and affect other plugins running concurrently.While this optimization reduces allocations, it sacrifices the isolation provided by the previous implementation (which created a fresh map per plugin). To maintain safety, ensure that all native plugins treat the
Colorsmap as read-only. Alternatively, if you want to avoid allocations entirely and ensure safety, consider changing theColorsfield inplugin.Inputto a struct, which would be passed by value and thus be inherently thread-safe.