Replace pkg/rand by standard library math/rand/v2 #32542
Merged
Conversation
This file contains 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
tklauser
added
kind/cleanup
|
/test |
bimmlerd
approved these changes
May 15, 2024
giorio94
reviewed
May 15, 2024
giorio94
approved these changes
May 15, 2024
Good suggestion! I'll do that in an additional set of commits on this PR given the list of |
Since Go 1.22 the Go standard library provides the math/rand/v2 package[^1]. Its global generator accessed by top-level functions is unconditionally seeded using a true random value. Moreover, the new package provides a way to construct PRNG sources which can be accessed concurrently. This allows to drop SafeRand and use the global source again where applicable. SafeRand was originally introduced in commit fac5dde ("rand: add and use concurrency-safe PRNG source") to fix #10988 by providing a concurrency-safe PRNG source other than the global math/rand source which could be used at the time because it can't be interfered with from unrelated packages by means of calling rand.Seed, see #10575. In some cases the global math/rand/v2 source cannot be used because unit tests rely on seeding the PRNG source to a fixed value for deterministic test runs. In these cases a math/rand/v2 source using fixed values is used, like with SafeRand before. [^1]: https://go.dev/doc/go1.22#math_rand_v2 Signed-off-by: Tobias Klauser <tobias@cilium.io>
The previous commit changed all users of pkg/rand to use math/rand/v2 from the Go standard library. As a result this package is no longer needed, should not be used going forward and can thus be removed. Signed-off-by: Tobias Klauser <tobias@cilium.io>
pkg/rand was removed in the previous commit and we'll rely on math/rand/v2 from the Go standard library going forward. The script checking for pkg/rand usage is thus no longer needed. Signed-off-by: Tobias Klauser <tobias@cilium.io>
doniacld
approved these changes
May 15, 2024
Replace use of the standard library math/rand package by math/rand/v2 which provides top-level functions backed by a global generator unconditionally seeded using a true random value. This avoids having to create generators manually. Suggested-by: Marco Iorio <marco.iorio@isovalent.com> Signed-off-by: Tobias Klauser <tobias@cilium.io>
Use crypto/rand.Read instead as suggested in https://pkg.go.dev/math/rand#Read Signed-off-by: Tobias Klauser <tobias@cilium.io>
Use the depguard linter to disallow using the standard library math/rand package and use v2 of the package instead. Suggested-by: Marco Iorio <marco.iorio@isovalent.com> Signed-off-by: Tobias Klauser <tobias@cilium.io>
tklauser
force-pushed
the
pr/tklauser/switch-to-math-rand-v2
branch
from
5ba4edd
to
35587ff
Compare
|
/test |
dylandreimerink
approved these changes
May 15, 2024
pippolo84
approved these changes
May 15, 2024
rolinh
approved these changes
May 16, 2024
maintainer-s-little-helper
bot
added
the
ready-to-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since Go 1.22 the Go standard library provides the
math/rand/v2package1. Its global generator accessed by top-level functions is unconditionally seeded using a true random value. Moreover, the new package provides a way to construct PRNG sources which can be accessed concurrently.This allows to drop
SafeRandand use the global source again where applicable.SafeRandwas originally introduced in commit fac5dde ("rand: add and use concurrency-safe PRNG source") to fix #10988 by providing a concurrency-safe PRNG source other than the globalmath/randsource which could be used at the time because it can't be interfered with from unrelated packages by means of calling rand.Seed, see #10575.In some cases the global
math/rand/v2source cannot be used because unit tests rely on seeding the PRNG source to a fixed value for deterministic test runs. In these cases amath/rand/v2source using fixed values is used, like withSafeRandbefore.See commits for details.
Supersedes #29731
Footnotes
https://go.dev/doc/go1.22#math_rand_v2 ↩