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

Fix: transition to math/rand/v2 for Improved Performance and Code Clarity #15438

Merged
merged 1 commit into from
Mar 12, 2024

Conversation

Aoang
Copy link
Contributor

@Aoang Aoang commented Mar 11, 2024

Description

This Pull Request removes a reference to runtime.fastrand in go/hack/runtime.go and replaces a call to hack.FastRand() with math/rand/v2.Uint32N in go/pools/smartconnpool/pool.go. These change aim to enhance code readability, performance, and reduce dependency on specific runtime implementations.

math/rand/v2 employs Lemire's algorithm in functions such as N, IntN, UintN, and others. Preliminary benchmark tests show a 40% improvement compared to Int31n in v1 and a 75% improvement compared to Int63n in v1.

Furthermore, math/rand/v2 default utilizes ChaCha8 for the global random number generator in each OS thread.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@Aoang Aoang requested a review from deepthi as a code owner March 11, 2024 12:56
Copy link
Contributor

vitess-bot bot commented Mar 11, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Mar 11, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 11, 2024
@mattlord mattlord requested a review from vmg March 11, 2024 13:02
@mattlord mattlord added Type: Internal Cleanup Type: Performance and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 11, 2024
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.65%. Comparing base (fbaed97) to head (1e0aa22).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15438      +/-   ##
==========================================
+ Coverage   65.63%   65.65%   +0.01%     
==========================================
  Files        1562     1563       +1     
  Lines      194249   194379     +130     
==========================================
+ Hits       127502   127618     +116     
- Misses      66747    66761      +14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dbussink
Copy link
Contributor

I don't think we should keep using this hack, but switch to https://pkg.go.dev/math/rand/v2#Uint32N from the only place where we use this, namely in go/pools/smartconnpool/pool.go.

@Aoang Aoang requested a review from harshit-gangal as a code owner March 11, 2024 14:08
@Aoang
Copy link
Contributor Author

Aoang commented Mar 11, 2024

I don't think we should keep using this hack, but switch to https://pkg.go.dev/math/rand/v2#Uint32N from the only place where we use this, namely in go/pools/smartconnpool/pool.go.

Should go/hack be cleaned up?

@dbussink
Copy link
Contributor

Should go/hack be cleaned up?

Yes, we can then clean up runtime.fastrand.

@dbussink
Copy link
Contributor

You'll also need to fix the DCO check.

@dbussink
Copy link
Contributor

@Aoang Can you update the PR description as well with how the new approach works?

@Aoang Aoang changed the title Fix: update calls to runtime.fastrand to use cheaprand for compatibility with Go 1.22 Fix: transition to math/rand/v2 for Improved Performance and Code Clarity Mar 12, 2024
@dbussink dbussink removed the NeedsIssue A linked issue is missing for this Pull Request label Mar 12, 2024
Copy link
Contributor

@dbussink dbussink left a comment

Choose a reason for hiding this comment

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

@vmg Wanna also take a look here?

@vmg vmg merged commit 85aeb34 into vitessio:main Mar 12, 2024
103 of 104 checks passed
@Aoang Aoang deleted the fix/fastrand-go-122 branch March 12, 2024 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants