Bitcoin Core
25.99.0
P2P Digital Currency

#include <crypto/chacha20.h>
#include <crypto/common.h>
#include <span.h>
#include <uint256.h>
#include <cassert>
#include <chrono>
#include <cstdint>
#include <limits>
#include <vector>
Go to the source code of this file.
Classes  
class  FastRandomContext 
Fast randomness source. More...  
Functions  
void  GetRandBytes (Span< unsigned char > bytes) noexcept 
Overall design of the RNG and entropy sources. More...  
uint64_t  GetRandInternal (uint64_t nMax) noexcept 
Generate a uniform random integer in the range [0..range). More...  
template<typename T >  
T  GetRand (T nMax=std::numeric_limits< T >::max()) noexcept 
Generate a uniform random integer of type T in the range [0..nMax) nMax defaults to std::numeric_limits<T>::max() Precondition: nMax > 0, T is an integral type, no larger than uint64_t. More...  
template<typename D >  
D  GetRandomDuration (typename std::common_type< D >::type max) noexcept 
Generate a uniform random duration in the range [0..max). More...  
std::chrono::microseconds  GetExponentialRand (std::chrono::microseconds now, std::chrono::seconds average_interval) 
Return a timestamp in the future sampled from an exponential distribution (https://en.wikipedia.org/wiki/Exponential_distribution). More...  
uint256  GetRandHash () noexcept 
void  GetStrongRandBytes (Span< unsigned char > bytes) noexcept 
Gather entropy from various sources, feed it into the internal PRNG, and generate random data using it. More...  
void  RandAddPeriodic () noexcept 
Gather entropy from various expensive sources, and feed them to the PRNG state. More...  
void  RandAddEvent (const uint32_t event_info) noexcept 
Gathers entropy from the low bits of the time at which events occur. More...  
template<typename I , typename R >  
void  Shuffle (I first, I last, R &&rng) 
More efficient than using std::shuffle on a FastRandomContext. More...  
void  GetOSRand (unsigned char *ent32) 
Get 32 bytes of system entropy. More...  
bool  Random_SanityCheck () 
Check that OS randomness is available and returning the requested number of bytes. More...  
void  RandomInit () 
Initialize global RNG state and log any CPU features that are used. More...  
Variables  
constexpr auto  GetRandMicros = GetRandomDuration<std::chrono::microseconds> 
constexpr auto  GetRandMillis = GetRandomDuration<std::chrono::milliseconds> 
static const int  NUM_OS_RANDOM_BYTES = 32 
std::chrono::microseconds GetExponentialRand  (  std::chrono::microseconds  now, 
std::chrono::seconds  average_interval  
) 
Return a timestamp in the future sampled from an exponential distribution (https://en.wikipedia.org/wiki/Exponential_distribution).
This distribution is memoryless and should be used for repeated network events (e.g. sending a certain type of message) to minimize leaking information to observers.
The probability of an event occurring before time x is 1  e^(x/a) where a is the average interval between events.
Definition at line 687 of file random.cpp.
void GetOSRand  (  unsigned char *  ent32  ) 
Get 32 bytes of system entropy.
Do not use this in application code: use GetStrongRandBytes instead.
Definition at line 274 of file random.cpp.

noexcept 
Generate a uniform random integer of type T in the range [0..nMax) nMax defaults to std::numeric_limits<T>::max() Precondition: nMax > 0, T is an integral type, no larger than uint64_t.
Definition at line 80 of file random.h.

noexcept 
Overall design of the RNG and entropy sources.
We maintain a single global 256bit RNG state for all highquality randomness. The following (classes of) functions interact with that state by mixing in new entropy, and optionally extracting random output from it:
On first use of the RNG (regardless of what function is called first), all entropy sources used in the 'slow' seeder are included, but also:
When mixing in new entropy, H = SHA512(entropy  old_rng_state) is computed, and (up to) the first 32 bytes of H are produced as output, while the last 32 bytes become the new RNG state. Generate random data via the internal PRNG.
These functions are designed to be fast (sub microsecond), but do not necessarily meaningfully add entropy to the PRNG state.
Threadsafe.
Definition at line 561 of file random.cpp.

noexcept 
Definition at line 573 of file random.cpp.

noexcept 
Generate a uniform random integer in the range [0..range).
Precondition: range > 0
Definition at line 568 of file random.cpp.

noexcept 

noexcept 
Gather entropy from various sources, feed it into the internal PRNG, and generate random data using it.
This function will cause failure whenever the OS RNG fails.
Threadsafe.
Definition at line 562 of file random.cpp.

noexcept 
Gathers entropy from the low bits of the time at which events occur.
Should be called with a uint32_t describing the event at the time an event occurs.
Threadsafe.
Definition at line 564 of file random.cpp.

noexcept 
Gather entropy from various expensive sources, and feed them to the PRNG state.
Threadsafe.
Definition at line 563 of file random.cpp.
bool Random_SanityCheck  (  ) 
Check that OS randomness is available and returning the requested number of bytes.
Definition at line 613 of file random.cpp.
void RandomInit  (  ) 
Initialize global RNG state and log any CPU features that are used.
Calling this function is optional. RNG state will be initialized when first needed if it is not called.
Definition at line 679 of file random.cpp.
void Shuffle  (  I  first, 
I  last,  
R &&  rng  
) 
More efficient than using std::shuffle on a FastRandomContext.
This is more efficient as std::shuffle will consume entropy in groups of 64 bits at the time and throw away most.
This also works around a bug in libstdc++ std::shuffle that may cause type::operator=(type&&) to be invoked on itself, which the library's debug mode detects and panics on. This is a known issue, see https://stackoverflow.com/questions/22915325/avoidingselfassignmentinstdshuffle
Definition at line 264 of file random.h.

constexpr 

constexpr 