diff options
Diffstat (limited to 'random.c')
| -rw-r--r-- | random.c | 1254 |
1 files changed, 787 insertions, 467 deletions
@@ -42,27 +42,38 @@ # include <winsock2.h> # include <windows.h> # include <wincrypt.h> +# include <bcrypt.h> #endif -#ifdef __OpenBSD__ -/* to define OpenBSD for version check */ +#if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__NetBSD__) +/* to define OpenBSD and FreeBSD for version check */ # include <sys/param.h> #endif -#if defined HAVE_GETRANDOM -# include <sys/random.h> +#if defined HAVE_GETRANDOM || defined HAVE_GETENTROPY +# if defined(HAVE_SYS_RANDOM_H) +# include <sys/random.h> +# endif #elif defined __linux__ && defined __NR_getrandom # include <linux/random.h> #endif +#if defined __APPLE__ +# include <AvailabilityMacros.h> +#endif + #include "internal.h" +#include "internal/array.h" #include "internal/compilers.h" #include "internal/numeric.h" #include "internal/random.h" #include "internal/sanitizers.h" +#include "internal/variable.h" #include "ruby_atomic.h" +#include "ruby/random.h" +#include "ruby/ractor.h" -typedef int int_must_be_32bit_at_least[sizeof(int) * CHAR_BIT < 32 ? -1 : 1]; +STATIC_ASSERT(int_must_be_32bit_at_least, sizeof(int) * CHAR_BIT >= 32); #include "missing/mt19937.c" @@ -112,44 +123,98 @@ genrand_real2(struct MT *mt) #undef M typedef struct { - VALUE seed; + rb_random_t base; struct MT mt; -} rb_random_t; +} rb_random_mt_t; #define DEFAULT_SEED_CNT 4 -static rb_random_t default_rand; - -static VALUE rand_init(struct MT *mt, VALUE vseed); +static VALUE rand_init(const rb_random_interface_t *, rb_random_t *, VALUE); static VALUE random_seed(VALUE); +static void fill_random_seed(uint32_t *seed, size_t cnt, bool try_bytes); +static VALUE make_seed_value(uint32_t *ptr, size_t len); +#define fill_random_bytes ruby_fill_random_bytes -static rb_random_t * -rand_start(rb_random_t *r) +RB_RANDOM_INTERFACE_DECLARE(rand_mt); +static const rb_random_interface_t random_mt_if = { + DEFAULT_SEED_CNT * 32, + RB_RANDOM_INTERFACE_DEFINE(rand_mt) +}; + +static rb_random_mt_t * +rand_mt_start(rb_random_mt_t *r, VALUE obj) { - struct MT *mt = &r->mt; - if (!genrand_initialized(mt)) { - r->seed = rand_init(mt, random_seed(Qundef)); + if (!genrand_initialized(&r->mt)) { + r->base.seed = rand_init(&random_mt_if, &r->base, random_seed(Qundef)); + if (obj) { + RB_OBJ_WRITTEN(obj, Qundef, r->base.seed); + } } return r; } -static struct MT * +static rb_random_t * +rand_start(rb_random_mt_t *r, VALUE obj) +{ + return &rand_mt_start(r, obj)->base; +} + +static rb_ractor_local_key_t default_rand_key; + +void +rb_free_default_rand_key(void) +{ + xfree(default_rand_key); +} + +static void +default_rand_mark(void *ptr) +{ + rb_random_mt_t *rnd = (rb_random_mt_t *)ptr; + rb_gc_mark(rnd->base.seed); +} + +static const struct rb_ractor_local_storage_type default_rand_key_storage_type = { + default_rand_mark, + ruby_xfree, +}; + +static rb_random_mt_t * +default_rand(void) +{ + rb_random_mt_t *rnd; + + if ((rnd = rb_ractor_local_storage_ptr(default_rand_key)) == NULL) { + rnd = ZALLOC(rb_random_mt_t); + rb_ractor_local_storage_ptr_set(default_rand_key, rnd); + } + + return rnd; +} + +static rb_random_mt_t * default_mt(void) { - return &rand_start(&default_rand)->mt; + return rand_mt_start(default_rand(), Qfalse); +} + +static rb_random_t * +default_rand_start(void) +{ + return &default_mt()->base; } unsigned int rb_genrand_int32(void) { - struct MT *mt = default_mt(); + struct MT *mt = &default_mt()->mt; return genrand_int32(mt); } double rb_genrand_real(void) { - struct MT *mt = default_mt(); + struct MT *mt = &default_mt()->mt; return genrand_real(mt); } @@ -165,9 +230,9 @@ int_pair_to_real_inclusive(uint32_t a, uint32_t b) const uint128_t m = ((uint128_t)1 << dig) | 1; uint128_t x = ((uint128_t)a << 32) | b; r = (double)(uint64_t)((x * m) >> 64); -#elif defined HAVE_UINT64_T && !MSC_VERSION_BEFORE(1300) +#elif defined HAVE_UINT64_T uint64_t x = ((uint64_t)a << dig_u) + - (((uint64_t)b + (a >> dig_u)) >> dig_r64); + (((uint64_t)b + (a >> dig_u)) >> dig_r64); r = (double)x; #else /* shift then add to get rid of overflow */ @@ -184,18 +249,15 @@ static ID id_rand, id_bytes; NORETURN(static void domain_error(void)); /* :nodoc: */ -static void +#define random_mark rb_random_mark + +void random_mark(void *ptr) { rb_gc_mark(((rb_random_t *)ptr)->seed); } -static void -random_free(void *ptr) -{ - if (ptr != &default_rand) - xfree(ptr); -} +#define random_free RUBY_TYPED_DEFAULT_FREE static size_t random_memsize(const void *ptr) @@ -203,72 +265,139 @@ random_memsize(const void *ptr) return sizeof(rb_random_t); } +const rb_data_type_t rb_random_data_type = { + "random", + { + random_mark, + random_free, + random_memsize, + }, + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED +}; + +#define random_mt_mark rb_random_mark +#define random_mt_free RUBY_TYPED_DEFAULT_FREE + +static size_t +random_mt_memsize(const void *ptr) +{ + return sizeof(rb_random_mt_t); +} + static const rb_data_type_t random_mt_type = { "random/MT", { - random_mark, - random_free, - random_memsize, + random_mt_mark, + random_mt_free, + random_mt_memsize, }, - 0, 0, RUBY_TYPED_FREE_IMMEDIATELY + &rb_random_data_type, + (void *)&random_mt_if, + RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED }; static rb_random_t * get_rnd(VALUE obj) { rb_random_t *ptr; - TypedData_Get_Struct(obj, rb_random_t, &random_mt_type, ptr); - return rand_start(ptr); + TypedData_Get_Struct(obj, rb_random_t, &rb_random_data_type, ptr); + if (RTYPEDDATA_TYPE(obj) == &random_mt_type) + return rand_start((rb_random_mt_t *)ptr, obj); + return ptr; +} + +static rb_random_mt_t * +get_rnd_mt(VALUE obj) +{ + rb_random_mt_t *ptr; + TypedData_Get_Struct(obj, rb_random_mt_t, &random_mt_type, ptr); + return ptr; } static rb_random_t * -try_get_rnd(VALUE obj) +try_get_rnd(VALUE obj, const rb_random_interface_t **rng_p) { if (obj == rb_cRandom) { - return rand_start(&default_rand); + *rng_p = &random_mt_if; + return default_rand_start(); } - if (!rb_typeddata_is_kind_of(obj, &random_mt_type)) return NULL; - return rand_start(DATA_PTR(obj)); + if (!rb_typeddata_is_kind_of(obj, &rb_random_data_type)) return NULL; + const struct rb_data_type_struct *type = RTYPEDDATA_TYPE(obj); + *rng_p = type->data; + void *rnd = DATA_PTR(obj); + if (!rnd) { + rb_raise(rb_eArgError, "uninitialized random: %s", + RTYPEDDATA_TYPE(obj)->wrap_struct_name); + } + if (type == &random_mt_type) rnd = rand_start(rnd, obj); + return rnd; +} + +/* :nodoc: */ +void +rb_random_base_init(rb_random_t *rnd) +{ + rnd->seed = INT2FIX(0); } /* :nodoc: */ static VALUE random_alloc(VALUE klass) { - rb_random_t *rnd; - VALUE obj = TypedData_Make_Struct(klass, rb_random_t, &random_mt_type, rnd); - rnd->seed = INT2FIX(0); + rb_random_mt_t *rnd; + VALUE obj = TypedData_Make_Struct(klass, rb_random_mt_t, &random_mt_type, rnd); + rb_random_base_init(&rnd->base); return obj; } static VALUE -rand_init(struct MT *mt, VALUE seed) +rand_init_default(const rb_random_interface_t *rng, rb_random_t *rnd) { - uint32_t buf0[SIZEOF_LONG / SIZEOF_INT32 * 4], *buf = buf0; + VALUE seed; + size_t len = roomof(rng->default_seed_bits, 32); + + if (LIKELY(len)) { + VALUE buf0 = 0; + uint32_t *buf = ALLOCV_N(uint32_t, buf0, len); + fill_random_seed(buf, len, true); + rng->init(rnd, buf, len); + seed = make_seed_value(buf, len); + explicit_bzero(buf, len * sizeof(*buf)); + ALLOCV_END(buf0); + } + else { + uint32_t minimul[1] = {0}; + rng->init(rnd, minimul, 0); + seed = INT2FIX(0); + } + return seed; +} + +static VALUE +rand_init(const rb_random_interface_t *rng, rb_random_t *rnd, VALUE seed) +{ + uint32_t *buf; + VALUE buf0 = 0; size_t len; int sign; len = rb_absint_numwords(seed, 32, NULL); - if (len > numberof(buf0)) - buf = ALLOC_N(uint32_t, len); + if (len == 0) len = 1; + buf = ALLOCV_N(uint32_t, buf0, len); sign = rb_integer_pack(seed, buf, len, sizeof(uint32_t), 0, INTEGER_PACK_LSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER); if (sign < 0) sign = -sign; - if (len == 0) { - buf[0] = 0; - len = 1; - } - if (len <= 1) { - init_genrand(mt, buf[0]); + if (len == 1) { + rng->init_int32(rnd, buf[0]); } else { if (sign != 2 && buf[len-1] == 1) /* remove leading-zero-guard */ len--; - init_by_array(mt, buf, (int)len); + rng->init(rnd, buf, len); } explicit_bzero(buf, len * sizeof(*buf)); - if (buf != buf0) xfree(buf); + ALLOCV_END(buf0); return seed; } @@ -284,19 +413,30 @@ rand_init(struct MT *mt, VALUE seed) static VALUE random_init(int argc, VALUE *argv, VALUE obj) { - VALUE vseed; - rb_random_t *rnd = get_rnd(obj); + const rb_random_interface_t *rng = NULL; + rb_random_t *rnd = try_get_rnd(obj, &rng); - if (rb_check_arity(argc, 0, 1) == 0) { - rb_check_frozen(obj); - vseed = random_seed(obj); + if (!rng) { + rb_raise(rb_eTypeError, "undefined random interface: %s", + RTYPEDDATA_TYPE(obj)->wrap_struct_name); + } + + unsigned int major = rng->version.major; + unsigned int minor = rng->version.minor; + if (major != RUBY_RANDOM_INTERFACE_VERSION_MAJOR) { + rb_raise(rb_eTypeError, "Random interface version " + STRINGIZE(RUBY_RANDOM_INTERFACE_VERSION_MAJOR) "." + STRINGIZE(RUBY_RANDOM_INTERFACE_VERSION_MINOR) " " + "expected: %d.%d", major, minor); + } + argc = rb_check_arity(argc, 0, 1); + rb_check_frozen(obj); + if (argc == 0) { + RB_OBJ_WRITE(obj, &rnd->seed, rand_init_default(rng, rnd)); } else { - vseed = argv[0]; - rb_check_copyable(obj, vseed); - vseed = rb_to_int(vseed); + RB_OBJ_WRITE(obj, &rnd->seed, rand_init(rng, rnd, rb_to_int(argv[0]))); } - rnd->seed = rand_init(&rnd->mt, vseed); return obj; } @@ -308,6 +448,16 @@ random_init(int argc, VALUE *argv, VALUE obj) # define USE_DEV_URANDOM 0 #endif +#if ! defined HAVE_GETRANDOM && defined __linux__ && defined __NR_getrandom +# ifndef GRND_NONBLOCK +# define GRND_NONBLOCK 0x0001 /* not defined in musl libc */ +# endif +# define getrandom(ptr, size, flags) \ + (ssize_t)syscall(__NR_getrandom, (ptr), (size), (flags)) +# define HAVE_GETRANDOM 1 +#endif + +/* fill random bytes by reading random device directly */ #if USE_DEV_URANDOM static int fill_random_bytes_urandom(void *seed, size_t size) @@ -319,12 +469,12 @@ fill_random_bytes_urandom(void *seed, size_t size) */ int fd = rb_cloexec_open("/dev/urandom", # ifdef O_NONBLOCK - O_NONBLOCK| + O_NONBLOCK| # endif # ifdef O_NOCTTY - O_NOCTTY| + O_NOCTTY| # endif - O_RDONLY, 0); + O_RDONLY, 0); struct stat statbuf; ssize_t ret = 0; size_t offset = 0; @@ -332,14 +482,14 @@ fill_random_bytes_urandom(void *seed, size_t size) if (fd < 0) return -1; rb_update_max_fd(fd); if (fstat(fd, &statbuf) == 0 && S_ISCHR(statbuf.st_mode)) { - do { - ret = read(fd, ((char*)seed) + offset, size - offset); - if (ret < 0) { - close(fd); - return -1; - } - offset += (size_t)ret; - } while (offset < size); + do { + ret = read(fd, ((char*)seed) + offset, size - offset); + if (ret < 0) { + close(fd); + return -1; + } + offset += (size_t)ret; + } while (offset < size); } close(fd); return 0; @@ -348,110 +498,192 @@ fill_random_bytes_urandom(void *seed, size_t size) # define fill_random_bytes_urandom(seed, size) -1 #endif -#if ! defined HAVE_GETRANDOM && defined __linux__ && defined __NR_getrandom -# ifndef GRND_NONBLOCK -# define GRND_NONBLOCK 0x0001 /* not defined in musl libc */ -# endif -# define getrandom(ptr, size, flags) \ - (ssize_t)syscall(__NR_getrandom, (ptr), (size), (flags)) -# define HAVE_GETRANDOM 1 -#endif - +/* fill random bytes by library */ #if 0 #elif defined MAC_OS_X_VERSION_10_7 && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_7 -#include <Security/Security.h> + +# if defined(USE_COMMON_RANDOM) +# elif defined MAC_OS_X_VERSION_10_10 && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_10 +# define USE_COMMON_RANDOM 1 +# else +# define USE_COMMON_RANDOM 0 +# endif +# if USE_COMMON_RANDOM +# include <CommonCrypto/CommonCryptoError.h> /* for old Xcode */ +# include <CommonCrypto/CommonRandom.h> +# else +# include <Security/SecRandom.h> +# endif static int -fill_random_bytes_syscall(void *seed, size_t size, int unused) +fill_random_bytes_lib(void *seed, size_t size) { +#if USE_COMMON_RANDOM + CCRNGStatus status = CCRandomGenerateBytes(seed, size); + int failed = status != kCCSuccess; +#else int status = SecRandomCopyBytes(kSecRandomDefault, size, seed); + int failed = status != errSecSuccess; +#endif - if (status != errSecSuccess) { + if (failed) { # if 0 +# if USE_COMMON_RANDOM + /* How to get the error message? */ + fprintf(stderr, "CCRandomGenerateBytes failed: %d\n", status); +# else CFStringRef s = SecCopyErrorMessageString(status, NULL); const char *m = s ? CFStringGetCStringPtr(s, kCFStringEncodingUTF8) : NULL; fprintf(stderr, "SecRandomCopyBytes failed: %d: %s\n", status, m ? m : "unknown"); if (s) CFRelease(s); # endif +# endif return -1; } return 0; } -#elif defined(HAVE_ARC4RANDOM_BUF) +#elif defined(HAVE_ARC4RANDOM_BUF) && \ + ((defined(__OpenBSD__) && OpenBSD >= 201411) || \ + (defined(__NetBSD__) && __NetBSD_Version__ >= 700000000) || \ + (defined(__FreeBSD__) && __FreeBSD_version >= 1200079)) +// [Bug #15039] arc4random_buf(3) should used only if we know it is fork-safe static int -fill_random_bytes_syscall(void *buf, size_t size, int unused) +fill_random_bytes_lib(void *buf, size_t size) { -#if (defined(__OpenBSD__) && OpenBSD >= 201411) || \ - (defined(__NetBSD__) && __NetBSD_Version__ >= 700000000) || \ - (defined(__FreeBSD__) && __FreeBSD_version >= 1200079) arc4random_buf(buf, size); return 0; -#else - return -1; -#endif } #elif defined(_WIN32) + +#ifndef DWORD_MAX +# define DWORD_MAX (~(DWORD)0UL) +#endif + +# if defined(CRYPT_VERIFYCONTEXT) +/* Although HCRYPTPROV is not a HANDLE, it looks like + * INVALID_HANDLE_VALUE is not a valid value */ +static const HCRYPTPROV INVALID_HCRYPTPROV = (HCRYPTPROV)INVALID_HANDLE_VALUE; + static void -release_crypt(void *p) +release_crypt(VALUE arg) { - HCRYPTPROV prov = (HCRYPTPROV)ATOMIC_PTR_EXCHANGE(*(HCRYPTPROV *)p, INVALID_HANDLE_VALUE); - if (prov && prov != (HCRYPTPROV)INVALID_HANDLE_VALUE) { - CryptReleaseContext(prov, 0); + HCRYPTPROV *ptr = (void *)arg; + HCRYPTPROV prov = (HCRYPTPROV)ATOMIC_PTR_EXCHANGE(*ptr, INVALID_HCRYPTPROV); + if (prov && prov != INVALID_HCRYPTPROV) { + CryptReleaseContext(prov, 0); } } static int -fill_random_bytes_syscall(void *seed, size_t size, int unused) +fill_random_bytes_crypt(void *seed, size_t size) { static HCRYPTPROV perm_prov; HCRYPTPROV prov = perm_prov, old_prov; if (!prov) { - if (!CryptAcquireContext(&prov, NULL, NULL, PROV_RSA_FULL, CRYPT_VERIFYCONTEXT)) { - prov = (HCRYPTPROV)INVALID_HANDLE_VALUE; - } - old_prov = (HCRYPTPROV)ATOMIC_PTR_CAS(perm_prov, 0, prov); - if (LIKELY(!old_prov)) { /* no other threads acquired */ - if (prov != (HCRYPTPROV)INVALID_HANDLE_VALUE) { -#undef RUBY_UNTYPED_DATA_WARNING -#define RUBY_UNTYPED_DATA_WARNING 0 - rb_gc_register_mark_object(Data_Wrap_Struct(0, 0, release_crypt, &perm_prov)); - } - } - else { /* another thread acquired */ - if (prov != (HCRYPTPROV)INVALID_HANDLE_VALUE) { - CryptReleaseContext(prov, 0); - } - prov = old_prov; - } + if (!CryptAcquireContext(&prov, NULL, NULL, PROV_RSA_FULL, CRYPT_VERIFYCONTEXT)) { + prov = INVALID_HCRYPTPROV; + } + old_prov = (HCRYPTPROV)ATOMIC_PTR_CAS(perm_prov, 0, prov); + if (LIKELY(!old_prov)) { /* no other threads acquired */ + if (prov != INVALID_HCRYPTPROV) { + /* register only once; perm_prov == 0 at the first call only */ + rb_set_end_proc(release_crypt, (VALUE)&perm_prov); + } + } + else { /* another thread acquired */ + if (prov != INVALID_HCRYPTPROV) { + CryptReleaseContext(prov, 0); + } + prov = old_prov; + } + } + if (prov == INVALID_HCRYPTPROV) return -1; + while (size > 0) { + DWORD n = (size > (size_t)DWORD_MAX) ? DWORD_MAX/2+1 : (DWORD)size; + if (!CryptGenRandom(prov, n, seed)) return -1; + seed = (char *)seed + n; + size -= n; + } + return 0; +} +# else +# define fill_random_bytes_crypt(seed, size) -1 +# endif + +static int +fill_random_bytes_bcrypt(void *seed, size_t size) +{ + while (size > 0) { + ULONG n = (size > (size_t)ULONG_MAX) ? ULONG_MAX/2+1 : (ULONG)size; + if (BCryptGenRandom(NULL, seed, n, BCRYPT_USE_SYSTEM_PREFERRED_RNG)) + return -1; + seed = (char *)seed + n; + size -= n; } - if (prov == (HCRYPTPROV)INVALID_HANDLE_VALUE) return -1; - CryptGenRandom(prov, size, seed); return 0; } + +static int +fill_random_bytes_lib(void *seed, size_t size) +{ + if (fill_random_bytes_bcrypt(seed, size) == 0) return 0; + return fill_random_bytes_crypt(seed, size); +} +#else +# define fill_random_bytes_lib(seed, size) -1 +#endif + +/* fill random bytes by dedicated syscall */ +#if 0 #elif defined HAVE_GETRANDOM static int fill_random_bytes_syscall(void *seed, size_t size, int need_secure) { static rb_atomic_t try_syscall = 1; if (try_syscall) { - size_t offset = 0; - int flags = 0; - if (!need_secure) - flags = GRND_NONBLOCK; - do { - errno = 0; + size_t offset = 0; + int flags = 0; + if (!need_secure) + flags = GRND_NONBLOCK; + do { + errno = 0; ssize_t ret = getrandom(((char*)seed) + offset, size - offset, flags); - if (ret == -1) { - ATOMIC_SET(try_syscall, 0); - return -1; - } - offset += (size_t)ret; - } while (offset < size); - return 0; + if (ret == -1) { + ATOMIC_SET(try_syscall, 0); + return -1; + } + offset += (size_t)ret; + } while (offset < size); + return 0; } return -1; } +#elif defined(HAVE_GETENTROPY) +/* + * The Open Group Base Specifications Issue 8 - IEEE Std 1003.1-2024 + * https://pubs.opengroup.org/onlinepubs/9799919799/functions/getentropy.html + * + * NOTE: `getentropy`(3) on Linux is implemented using `getrandom`(2), + * prefer the latter over this if both are defined. + */ +#ifndef GETENTROPY_MAX +# define GETENTROPY_MAX 256 +#endif +static int +fill_random_bytes_syscall(void *seed, size_t size, int need_secure) +{ + unsigned char *p = (unsigned char *)seed; + while (size) { + size_t len = size < GETENTROPY_MAX ? size : GETENTROPY_MAX; + if (getentropy(p, len) != 0) { + return -1; + } + p += len; + size -= len; + } + return 0; +} #else # define fill_random_bytes_syscall(seed, size, need_secure) -1 #endif @@ -461,16 +693,15 @@ ruby_fill_random_bytes(void *seed, size_t size, int need_secure) { int ret = fill_random_bytes_syscall(seed, size, need_secure); if (ret == 0) return ret; + if (fill_random_bytes_lib(seed, size) == 0) return 0; return fill_random_bytes_urandom(seed, size); } -#define fill_random_bytes ruby_fill_random_bytes - /* cnt must be 4 or more */ static void -fill_random_seed(uint32_t *seed, size_t cnt) +fill_random_seed(uint32_t *seed, size_t cnt, bool try_bytes) { - static int n = 0; + static rb_atomic_t n = 0; #if defined HAVE_CLOCK_GETTIME struct timespec tv; #elif defined HAVE_GETTIMEOFDAY @@ -478,10 +709,12 @@ fill_random_seed(uint32_t *seed, size_t cnt) #endif size_t len = cnt * sizeof(*seed); - memset(seed, 0, len); - - fill_random_bytes(seed, len, FALSE); + if (try_bytes) { + fill_random_bytes(seed, len, FALSE); + return; + } + memset(seed, 0, len); #if defined HAVE_CLOCK_GETTIME clock_gettime(CLOCK_REALTIME, &tv); seed[0] ^= tv.tv_nsec; @@ -493,7 +726,7 @@ fill_random_seed(uint32_t *seed, size_t cnt) #if SIZEOF_TIME_T > SIZEOF_INT seed[0] ^= (uint32_t)((time_t)tv.tv_sec >> SIZEOF_INT * CHAR_BIT); #endif - seed[2] ^= getpid() ^ (n++ << 16); + seed[2] ^= getpid() ^ (ATOMIC_FETCH_ADD(n, 1) << 16); seed[3] ^= (uint32_t)(VALUE)&seed; #if SIZEOF_VOIDP > SIZEOF_INT seed[2] ^= (uint32_t)((VALUE)&seed >> SIZEOF_INT * CHAR_BIT); @@ -516,8 +749,8 @@ make_seed_value(uint32_t *ptr, size_t len) return seed; } -#define with_random_seed(size, add) \ - for (uint32_t seedbuf[(size)+(add)], loop = (fill_random_seed(seedbuf, (size)), 1); \ +#define with_random_seed(size, add, try_bytes) \ + for (uint32_t seedbuf[(size)+(add)], loop = (fill_random_seed(seedbuf, (size), try_bytes), 1); \ loop; explicit_bzero(seedbuf, (size)*sizeof(seedbuf[0])), loop = 0) /* @@ -532,7 +765,7 @@ static VALUE random_seed(VALUE _) { VALUE v; - with_random_seed(DEFAULT_SEED_CNT, 1) { + with_random_seed(DEFAULT_SEED_CNT, 1, true) { v = make_seed_value(seedbuf, DEFAULT_SEED_CNT); } return v; @@ -561,7 +794,7 @@ random_raw_seed(VALUE self, VALUE size) VALUE buf = rb_str_new(0, n); if (n == 0) return buf; if (fill_random_bytes(RSTRING_PTR(buf), n, TRUE)) - rb_raise(rb_eRuntimeError, "failed to get urandom"); + rb_raise(rb_eRuntimeError, "failed to get urandom"); return buf; } @@ -587,18 +820,19 @@ random_get_seed(VALUE obj) /* :nodoc: */ static VALUE -random_copy(VALUE obj, VALUE orig) +rand_mt_copy(VALUE obj, VALUE orig) { - rb_random_t *rnd1, *rnd2; + rb_random_mt_t *rnd1, *rnd2; struct MT *mt; if (!OBJ_INIT_COPY(obj, orig)) return obj; - rnd1 = get_rnd(obj); - rnd2 = get_rnd(orig); + rnd1 = get_rnd_mt(obj); + rnd2 = get_rnd_mt(orig); mt = &rnd1->mt; *rnd1 = *rnd2; + RB_OBJ_WRITTEN(obj, Qundef, rnd1->base.seed); mt->next = mt->state + numberof(mt->state) - mt->left + 1; return obj; } @@ -613,9 +847,9 @@ mt_state(const struct MT *mt) /* :nodoc: */ static VALUE -random_state(VALUE obj) +rand_mt_state(VALUE obj) { - rb_random_t *rnd = get_rnd(obj); + rb_random_mt_t *rnd = get_rnd_mt(obj); return mt_state(&rnd->mt); } @@ -623,14 +857,14 @@ random_state(VALUE obj) static VALUE random_s_state(VALUE klass) { - return mt_state(&default_rand.mt); + return mt_state(&default_rand()->mt); } /* :nodoc: */ static VALUE -random_left(VALUE obj) +rand_mt_left(VALUE obj) { - rb_random_t *rnd = get_rnd(obj); + rb_random_mt_t *rnd = get_rnd_mt(obj); return INT2FIX(rnd->mt.left); } @@ -638,28 +872,28 @@ random_left(VALUE obj) static VALUE random_s_left(VALUE klass) { - return INT2FIX(default_rand.mt.left); + return INT2FIX(default_rand()->mt.left); } /* :nodoc: */ static VALUE -random_dump(VALUE obj) +rand_mt_dump(VALUE obj) { - rb_random_t *rnd = get_rnd(obj); + rb_random_mt_t *rnd = rb_check_typeddata(obj, &random_mt_type); VALUE dump = rb_ary_new2(3); rb_ary_push(dump, mt_state(&rnd->mt)); rb_ary_push(dump, INT2FIX(rnd->mt.left)); - rb_ary_push(dump, rnd->seed); + rb_ary_push(dump, rnd->base.seed); return dump; } /* :nodoc: */ static VALUE -random_load(VALUE obj, VALUE dump) +rand_mt_load(VALUE obj, VALUE dump) { - rb_random_t *rnd = get_rnd(obj); + rb_random_mt_t *rnd = rb_check_typeddata(obj, &random_mt_type); struct MT *mt = &rnd->mt; VALUE state, left = INT2FIX(1), seed = INT2FIX(0); unsigned long x; @@ -673,30 +907,57 @@ random_load(VALUE obj, VALUE dump) left = RARRAY_AREF(dump, 1); case 1: state = RARRAY_AREF(dump, 0); - break; + break; default: - rb_raise(rb_eArgError, "wrong dump data"); + rb_raise(rb_eArgError, "wrong dump data"); } rb_integer_pack(state, mt->state, numberof(mt->state), sizeof(*mt->state), 0, INTEGER_PACK_LSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER); x = NUM2ULONG(left); - if (x > numberof(mt->state)) { - rb_raise(rb_eArgError, "wrong value"); + if (x > numberof(mt->state) || x == 0) { + rb_raise(rb_eArgError, "wrong value"); } mt->left = (unsigned int)x; mt->next = mt->state + numberof(mt->state) - x + 1; - rnd->seed = rb_to_int(seed); + RB_OBJ_WRITE(obj, &rnd->base.seed, rb_to_int(seed)); return obj; } +static void +rand_mt_init_int32(rb_random_t *rnd, uint32_t data) +{ + struct MT *mt = &((rb_random_mt_t *)rnd)->mt; + init_genrand(mt, data); +} + +static void +rand_mt_init(rb_random_t *rnd, const uint32_t *buf, size_t len) +{ + struct MT *mt = &((rb_random_mt_t *)rnd)->mt; + init_by_array(mt, buf, (int)len); +} + +static unsigned int +rand_mt_get_int32(rb_random_t *rnd) +{ + struct MT *mt = &((rb_random_mt_t *)rnd)->mt; + return genrand_int32(mt); +} + +static void +rand_mt_get_bytes(rb_random_t *rnd, void *ptr, size_t n) +{ + rb_rand_bytes_int32(rand_mt_get_int32, rnd, ptr, n); +} + /* * call-seq: * srand(number = Random.new_seed) -> old_seed * - * Seeds the system pseudo-random number generator, Random::DEFAULT, with - * +number+. The previous seed value is returned. + * Seeds the system pseudo-random number generator, with +number+. + * The previous seed value is returned. * * If +number+ is omitted, seeds the generator using a source of entropy * provided by the operating system, if available (/dev/urandom on Unix systems @@ -718,16 +979,17 @@ static VALUE rb_f_srand(int argc, VALUE *argv, VALUE obj) { VALUE seed, old; - rb_random_t *r = &default_rand; + rb_random_mt_t *r = default_mt(); if (rb_check_arity(argc, 0, 1) == 0) { seed = random_seed(obj); } else { - seed = rb_to_int(argv[0]); + seed = rb_to_int(argv[0]); } - old = r->seed; - r->seed = rand_init(&r->mt, seed); + old = r->base.seed; + rand_init(&random_mt_if, &r->base, seed); + r->base.seed = seed; return old; } @@ -747,7 +1009,7 @@ make_mask(unsigned long x) } static unsigned long -limited_rand(struct MT *mt, unsigned long limit) +limited_rand(const rb_random_interface_t *rng, rb_random_t *rnd, unsigned long limit) { /* mt must be initialized */ unsigned long val, mask; @@ -762,7 +1024,7 @@ limited_rand(struct MT *mt, unsigned long limit) val = 0; for (i = SIZEOF_LONG/SIZEOF_INT32-1; 0 <= i; i--) { if ((mask >> (i * 32)) & 0xffffffff) { - val |= (unsigned long)genrand_int32(mt) << (i * 32); + val |= (unsigned long)rng->get_int32(rnd) << (i * 32); val &= mask; if (limit < val) goto retry; @@ -773,13 +1035,13 @@ limited_rand(struct MT *mt, unsigned long limit) #endif do { - val = genrand_int32(mt) & mask; + val = rng->get_int32(rnd) & mask; } while (limit < val); return val; } static VALUE -limited_big_rand(struct MT *mt, VALUE limit) +limited_big_rand(const rb_random_interface_t *rng, rb_random_t *rnd, VALUE limit) { /* mt must be initialized */ @@ -803,22 +1065,19 @@ limited_big_rand(struct MT *mt, VALUE limit) mask = 0; boundary = 1; for (i = len-1; 0 <= i; i--) { - uint32_t rnd; + uint32_t r = 0; uint32_t lim = lim_array[i]; mask = mask ? 0xffffffff : (uint32_t)make_mask(lim); if (mask) { - rnd = genrand_int32(mt) & mask; + r = rng->get_int32(rnd) & mask; if (boundary) { - if (lim < rnd) + if (lim < r) goto retry; - if (rnd < lim) + if (r < lim) boundary = 0; } } - else { - rnd = 0; - } - rnd_array[i] = rnd; + rnd_array[i] = r; } val = rb_integer_unpack(rnd_array, len, sizeof(uint32_t), 0, INTEGER_PACK_LSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER); @@ -836,7 +1095,8 @@ limited_big_rand(struct MT *mt, VALUE limit) unsigned long rb_genrand_ulong_limited(unsigned long limit) { - return limited_rand(default_mt(), limit); + rb_random_mt_t *mt = default_mt(); + return limited_rand(&random_mt_if, &mt->base, limit); } static VALUE @@ -848,70 +1108,79 @@ obj_random_bytes(VALUE obj, void *p, long n) Check_Type(v, T_STRING); l = RSTRING_LEN(v); if (l < n) - rb_raise(rb_eRangeError, "random data too short %ld", l); + rb_raise(rb_eRangeError, "random data too short %ld", l); else if (l > n) - rb_raise(rb_eRangeError, "random data too long %ld", l); + rb_raise(rb_eRangeError, "random data too long %ld", l); if (p) memcpy(p, RSTRING_PTR(v), n); return v; } static unsigned int -random_int32(rb_random_t *rnd) +random_int32(const rb_random_interface_t *rng, rb_random_t *rnd) { - return genrand_int32(&rnd->mt); + return rng->get_int32(rnd); } unsigned int rb_random_int32(VALUE obj) { - rb_random_t *rnd = try_get_rnd(obj); + const rb_random_interface_t *rng; + rb_random_t *rnd = try_get_rnd(obj, &rng); if (!rnd) { - uint32_t x; - obj_random_bytes(obj, &x, sizeof(x)); - return (unsigned int)x; + uint32_t x; + obj_random_bytes(obj, &x, sizeof(x)); + return (unsigned int)x; } - return random_int32(rnd); + return random_int32(rng, rnd); } static double -random_real(VALUE obj, rb_random_t *rnd, int excl) +random_real(VALUE obj, const rb_random_interface_t *rng, rb_random_t *rnd, int excl) { uint32_t a, b; if (!rnd) { - uint32_t x[2] = {0, 0}; - obj_random_bytes(obj, x, sizeof(x)); - a = x[0]; - b = x[1]; + uint32_t x[2] = {0, 0}; + obj_random_bytes(obj, x, sizeof(x)); + a = x[0]; + b = x[1]; } else { - a = random_int32(rnd); - b = random_int32(rnd); + if (rng->get_real) return rng->get_real(rnd, excl); + a = random_int32(rng, rnd); + b = random_int32(rng, rnd); } + return rb_int_pair_to_real(a, b, excl); +} + +double +rb_int_pair_to_real(uint32_t a, uint32_t b, int excl) +{ if (excl) { - return int_pair_to_real_exclusive(a, b); + return int_pair_to_real_exclusive(a, b); } else { - return int_pair_to_real_inclusive(a, b); + return int_pair_to_real_inclusive(a, b); } } double rb_random_real(VALUE obj) { - rb_random_t *rnd = try_get_rnd(obj); + const rb_random_interface_t *rng; + rb_random_t *rnd = try_get_rnd(obj, &rng); if (!rnd) { - VALUE v = rb_funcallv(obj, id_rand, 0, 0); - double d = NUM2DBL(v); - if (d < 0.0) { - rb_raise(rb_eRangeError, "random number too small %g", d); - } - else if (d >= 1.0) { - rb_raise(rb_eRangeError, "random number too big %g", d); - } - return d; + VALUE v = rb_funcallv(obj, id_rand, 0, 0); + double d = NUM2DBL(v); + if (d < 0.0) { + rb_raise(rb_eRangeError, "random number too small %g", d); + } + else if (d >= 1.0) { + rb_raise(rb_eRangeError, "random number too big %g", d); + } + return d; } - return genrand_real(&rnd->mt); + return random_real(obj, rng, rnd, TRUE); } static inline VALUE @@ -921,90 +1190,101 @@ ulong_to_num_plus_1(unsigned long n) return ULL2NUM((LONG_LONG)n+1); #else if (n >= ULONG_MAX) { - return rb_big_plus(ULONG2NUM(n), INT2FIX(1)); + return rb_big_plus(ULONG2NUM(n), INT2FIX(1)); } return ULONG2NUM(n+1); #endif } static unsigned long -random_ulong_limited(VALUE obj, rb_random_t *rnd, unsigned long limit) +random_ulong_limited(VALUE obj, const rb_random_interface_t *rng, rb_random_t *rnd, unsigned long limit) { if (!limit) return 0; if (!rnd) { - const int w = sizeof(limit) * CHAR_BIT - nlz_long(limit); - const int n = w > 32 ? sizeof(unsigned long) : sizeof(uint32_t); - const unsigned long mask = ~(~0UL << w); - const unsigned long full = - (size_t)n >= sizeof(unsigned long) ? ~0UL : - ~(~0UL << n * CHAR_BIT); - unsigned long val, bits = 0, rest = 0; - do { - if (mask & ~rest) { - union {uint32_t u32; unsigned long ul;} buf; - obj_random_bytes(obj, &buf, n); - rest = full; - bits = (n == sizeof(uint32_t)) ? buf.u32 : buf.ul; - } - val = bits; - bits >>= w; - rest >>= w; - val &= mask; - } while (limit < val); - return val; + const int w = sizeof(limit) * CHAR_BIT - nlz_long(limit); + const int n = w > 32 ? sizeof(unsigned long) : sizeof(uint32_t); + const unsigned long mask = ~(~0UL << w); + const unsigned long full = + (size_t)n >= sizeof(unsigned long) ? ~0UL : + ~(~0UL << n * CHAR_BIT); + unsigned long val, bits = 0, rest = 0; + do { + if (mask & ~rest) { + union {uint32_t u32; unsigned long ul;} buf; + obj_random_bytes(obj, &buf, n); + rest = full; + bits = (n == sizeof(uint32_t)) ? buf.u32 : buf.ul; + } + val = bits; + bits >>= w; + rest >>= w; + val &= mask; + } while (limit < val); + return val; } - return limited_rand(&rnd->mt, limit); + return limited_rand(rng, rnd, limit); } unsigned long rb_random_ulong_limited(VALUE obj, unsigned long limit) { - rb_random_t *rnd = try_get_rnd(obj); + const rb_random_interface_t *rng; + rb_random_t *rnd = try_get_rnd(obj, &rng); if (!rnd) { - VALUE lim = ulong_to_num_plus_1(limit); - VALUE v = rb_to_int(rb_funcallv_public(obj, id_rand, 1, &lim)); - unsigned long r = NUM2ULONG(v); - if (rb_num_negative_p(v)) { - rb_raise(rb_eRangeError, "random number too small %ld", r); - } - if (r > limit) { - rb_raise(rb_eRangeError, "random number too big %ld", r); - } - return r; + VALUE lim = ulong_to_num_plus_1(limit); + VALUE v = rb_to_int(rb_funcallv_public(obj, id_rand, 1, &lim)); + unsigned long r = NUM2ULONG(v); + if (rb_num_negative_p(v)) { + rb_raise(rb_eRangeError, "random number too small %ld", r); + } + if (r > limit) { + rb_raise(rb_eRangeError, "random number too big %ld", r); + } + return r; } - return limited_rand(&rnd->mt, limit); + return limited_rand(rng, rnd, limit); } static VALUE -random_ulong_limited_big(VALUE obj, rb_random_t *rnd, VALUE vmax) +random_ulong_limited_big(VALUE obj, const rb_random_interface_t *rng, rb_random_t *rnd, VALUE vmax) { if (!rnd) { - VALUE v, vtmp; - size_t i, nlz, len = rb_absint_numwords(vmax, 32, &nlz); - uint32_t *tmp = ALLOCV_N(uint32_t, vtmp, len * 2); - uint32_t mask = (uint32_t)~0 >> nlz; - uint32_t *lim_array = tmp; - uint32_t *rnd_array = tmp + len; - int flag = INTEGER_PACK_MSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER; - rb_integer_pack(vmax, lim_array, len, sizeof(uint32_t), 0, flag); + VALUE v, vtmp; + size_t i, nlz, len = rb_absint_numwords(vmax, 32, &nlz); + uint32_t *tmp = ALLOCV_N(uint32_t, vtmp, len * 2); + uint32_t mask = (uint32_t)~0 >> nlz; + uint32_t *lim_array = tmp; + uint32_t *rnd_array = tmp + len; + int flag = INTEGER_PACK_MSWORD_FIRST|INTEGER_PACK_NATIVE_BYTE_ORDER; + rb_integer_pack(vmax, lim_array, len, sizeof(uint32_t), 0, flag); retry: - obj_random_bytes(obj, rnd_array, len * sizeof(uint32_t)); - rnd_array[0] &= mask; - for (i = 0; i < len; ++i) { - if (lim_array[i] < rnd_array[i]) - goto retry; - if (rnd_array[i] < lim_array[i]) - break; - } - v = rb_integer_unpack(rnd_array, len, sizeof(uint32_t), 0, flag); - ALLOCV_END(vtmp); - return v; + obj_random_bytes(obj, rnd_array, len * sizeof(uint32_t)); + rnd_array[0] &= mask; + for (i = 0; i < len; ++i) { + if (lim_array[i] < rnd_array[i]) + goto retry; + if (rnd_array[i] < lim_array[i]) + break; + } + v = rb_integer_unpack(rnd_array, len, sizeof(uint32_t), 0, flag); + ALLOCV_END(vtmp); + return v; } - return limited_big_rand(&rnd->mt, vmax); + return limited_big_rand(rng, rnd, vmax); } -static VALUE genrand_bytes(rb_random_t *rnd, long n); +static VALUE +rand_bytes(const rb_random_interface_t *rng, rb_random_t *rnd, long n) +{ + VALUE bytes; + char *ptr; + + bytes = rb_str_new(0, n); + ptr = RSTRING_PTR(bytes); + rng->get_bytes(rnd, ptr, n); + return bytes; +} /* * call-seq: prng.bytes(size) -> string @@ -1017,44 +1297,43 @@ static VALUE genrand_bytes(rb_random_t *rnd, long n); static VALUE random_bytes(VALUE obj, VALUE len) { - return genrand_bytes(get_rnd(obj), NUM2LONG(rb_to_int(len))); + const rb_random_interface_t *rng = NULL; + rb_random_t *rnd = try_get_rnd(obj, &rng); + return rand_bytes(rng, rnd, NUM2LONG(rb_to_int(len))); } -static VALUE -genrand_bytes(rb_random_t *rnd, long n) +void +rb_rand_bytes_int32(rb_random_get_int32_func *get_int32, + rb_random_t *rnd, void *p, size_t n) { - VALUE bytes; - char *ptr; + char *ptr = p; unsigned int r, i; - - bytes = rb_str_new(0, n); - ptr = RSTRING_PTR(bytes); for (; n >= SIZEOF_INT32; n -= SIZEOF_INT32) { - r = genrand_int32(&rnd->mt); - i = SIZEOF_INT32; - do { - *ptr++ = (char)r; - r >>= CHAR_BIT; + r = get_int32(rnd); + i = SIZEOF_INT32; + do { + *ptr++ = (char)r; + r >>= CHAR_BIT; } while (--i); } if (n > 0) { - r = genrand_int32(&rnd->mt); - do { - *ptr++ = (char)r; - r >>= CHAR_BIT; - } while (--n); + r = get_int32(rnd); + do { + *ptr++ = (char)r; + r >>= CHAR_BIT; + } while (--n); } - return bytes; } VALUE rb_random_bytes(VALUE obj, long n) { - rb_random_t *rnd = try_get_rnd(obj); + const rb_random_interface_t *rng; + rb_random_t *rnd = try_get_rnd(obj, &rng); if (!rnd) { - return obj_random_bytes(obj, NULL, n); + return obj_random_bytes(obj, NULL, n); } - return genrand_bytes(rnd, n); + return rand_bytes(rng, rnd, n); } /* @@ -1066,8 +1345,30 @@ rb_random_bytes(VALUE obj, long n) static VALUE random_s_bytes(VALUE obj, VALUE len) { - rb_random_t *rnd = rand_start(&default_rand); - return genrand_bytes(rnd, NUM2LONG(rb_to_int(len))); + rb_random_t *rnd = default_rand_start(); + return rand_bytes(&random_mt_if, rnd, NUM2LONG(rb_to_int(len))); +} + +/* + * call-seq: Random.seed -> integer + * + * Returns the seed value used to initialize the Ruby system PRNG. + * This may be used to initialize another generator with the same + * state at a later time, causing it to produce the same sequence of + * numbers. + * + * Random.seed #=> 1234 + * prng1 = Random.new(Random.seed) + * prng1.seed #=> 1234 + * prng1.rand(100) #=> 47 + * Random.seed #=> 1234 + * Random.rand(100) #=> 47 + */ +static VALUE +random_s_seed(VALUE obj) +{ + rb_random_mt_t *rnd = default_mt(); + return rnd->base.seed; } static VALUE @@ -1084,38 +1385,38 @@ range_values(VALUE vmax, VALUE *begp, VALUE *endp, int *exclp) } static VALUE -rand_int(VALUE obj, rb_random_t *rnd, VALUE vmax, int restrictive) +rand_int(VALUE obj, const rb_random_interface_t *rng, rb_random_t *rnd, VALUE vmax, int restrictive) { /* mt must be initialized */ unsigned long r; if (FIXNUM_P(vmax)) { - long max = FIX2LONG(vmax); - if (!max) return Qnil; - if (max < 0) { - if (restrictive) return Qnil; - max = -max; - } - r = random_ulong_limited(obj, rnd, (unsigned long)max - 1); - return ULONG2NUM(r); + long max = FIX2LONG(vmax); + if (!max) return Qnil; + if (max < 0) { + if (restrictive) return Qnil; + max = -max; + } + r = random_ulong_limited(obj, rng, rnd, (unsigned long)max - 1); + return ULONG2NUM(r); } else { - VALUE ret; - if (rb_bigzero_p(vmax)) return Qnil; - if (!BIGNUM_SIGN(vmax)) { - if (restrictive) return Qnil; + VALUE ret; + if (rb_bigzero_p(vmax)) return Qnil; + if (!BIGNUM_SIGN(vmax)) { + if (restrictive) return Qnil; vmax = rb_big_uminus(vmax); - } - vmax = rb_big_minus(vmax, INT2FIX(1)); - if (FIXNUM_P(vmax)) { - long max = FIX2LONG(vmax); - if (max == -1) return Qnil; - r = random_ulong_limited(obj, rnd, max); - return LONG2NUM(r); - } - ret = random_ulong_limited_big(obj, rnd, vmax); - RB_GC_GUARD(vmax); - return ret; + } + vmax = rb_big_minus(vmax, INT2FIX(1)); + if (FIXNUM_P(vmax)) { + long max = FIX2LONG(vmax); + if (max == -1) return Qnil; + r = random_ulong_limited(obj, rng, rnd, max); + return LONG2NUM(r); + } + ret = random_ulong_limited_big(obj, rng, rnd, vmax); + RB_GC_GUARD(vmax); + return ret; } } @@ -1138,10 +1439,10 @@ check_random_number(VALUE v, const VALUE *argv) { switch (v) { case Qfalse: - (void)NUM2LONG(argv[0]); - break; + (void)NUM2LONG(argv[0]); + break; case Qnil: - invalid_argument(argv[0]); + invalid_argument(argv[0]); } return v; } @@ -1150,95 +1451,96 @@ static inline double float_value(VALUE v) { double x = RFLOAT_VALUE(v); - if (isinf(x) || isnan(x)) { - domain_error(); + if (!isfinite(x)) { + domain_error(); } return x; } static inline VALUE -rand_range(VALUE obj, rb_random_t* rnd, VALUE range) +rand_range(VALUE obj, const rb_random_interface_t *rng, rb_random_t* rnd, VALUE range) { VALUE beg = Qundef, end = Qundef, vmax, v; int excl = 0; if ((v = vmax = range_values(range, &beg, &end, &excl)) == Qfalse) - return Qfalse; + return Qfalse; if (NIL_P(v)) domain_error(); - if (!RB_TYPE_P(vmax, T_FLOAT) && (v = rb_check_to_int(vmax), !NIL_P(v))) { - long max; - vmax = v; - v = Qnil; + if (!RB_FLOAT_TYPE_P(vmax) && (v = rb_check_to_int(vmax), !NIL_P(v))) { + long max; + vmax = v; + v = Qnil; fixnum: - if (FIXNUM_P(vmax)) { - if ((max = FIX2LONG(vmax) - excl) >= 0) { - unsigned long r = random_ulong_limited(obj, rnd, (unsigned long)max); - v = ULONG2NUM(r); - } - } - else if (BUILTIN_TYPE(vmax) == T_BIGNUM && BIGNUM_SIGN(vmax) && !rb_bigzero_p(vmax)) { - vmax = excl ? rb_big_minus(vmax, INT2FIX(1)) : rb_big_norm(vmax); - if (FIXNUM_P(vmax)) { - excl = 0; - goto fixnum; - } - v = random_ulong_limited_big(obj, rnd, vmax); - } + if (FIXNUM_P(vmax)) { + if ((max = FIX2LONG(vmax) - excl) >= 0) { + unsigned long r = random_ulong_limited(obj, rng, rnd, (unsigned long)max); + v = ULONG2NUM(r); + } + } + else if (BUILTIN_TYPE(vmax) == T_BIGNUM && BIGNUM_SIGN(vmax) && !rb_bigzero_p(vmax)) { + vmax = excl ? rb_big_minus(vmax, INT2FIX(1)) : rb_big_norm(vmax); + if (FIXNUM_P(vmax)) { + excl = 0; + goto fixnum; + } + v = random_ulong_limited_big(obj, rng, rnd, vmax); + } } else if (v = rb_check_to_float(vmax), !NIL_P(v)) { - int scale = 1; - double max = RFLOAT_VALUE(v), mid = 0.5, r; - if (isinf(max)) { - double min = float_value(rb_to_float(beg)) / 2.0; - max = float_value(rb_to_float(end)) / 2.0; - scale = 2; - mid = max + min; - max -= min; - } - else if (isnan(max)) { - domain_error(); - } - v = Qnil; - if (max > 0.0) { - r = random_real(obj, rnd, excl); - if (scale > 1) { - return rb_float_new(+(+(+(r - 0.5) * max) * scale) + mid); - } - v = rb_float_new(r * max); - } - else if (max == 0.0 && !excl) { - v = rb_float_new(0.0); - } + int scale = 1; + double max = RFLOAT_VALUE(v), mid = 0.5, r; + if (isinf(max)) { + double min = float_value(rb_to_float(beg)) / 2.0; + max = float_value(rb_to_float(end)) / 2.0; + scale = 2; + mid = max + min; + max -= min; + } + else if (isnan(max)) { + domain_error(); + } + v = Qnil; + if (max > 0.0) { + r = random_real(obj, rng, rnd, excl); + if (scale > 1) { + return rb_float_new(+(+(+(r - 0.5) * max) * scale) + mid); + } + v = rb_float_new(r * max); + } + else if (max == 0.0 && !excl) { + v = rb_float_new(0.0); + } } if (FIXNUM_P(beg) && FIXNUM_P(v)) { - long x = FIX2LONG(beg) + FIX2LONG(v); - return LONG2NUM(x); + long x = FIX2LONG(beg) + FIX2LONG(v); + return LONG2NUM(x); } switch (TYPE(v)) { case T_NIL: - break; + break; case T_BIGNUM: - return rb_big_plus(v, beg); + return rb_big_plus(v, beg); case T_FLOAT: { - VALUE f = rb_check_to_float(beg); - if (!NIL_P(f)) { - return DBL2NUM(RFLOAT_VALUE(v) + RFLOAT_VALUE(f)); - } + VALUE f = rb_check_to_float(beg); + if (!NIL_P(f)) { + return DBL2NUM(RFLOAT_VALUE(v) + RFLOAT_VALUE(f)); + } } default: - return rb_funcallv(beg, id_plus, 1, &v); + return rb_funcallv(beg, id_plus, 1, &v); } return v; } -static VALUE rand_random(int argc, VALUE *argv, VALUE obj, rb_random_t *rnd); +static VALUE rand_random(int argc, VALUE *argv, VALUE obj, const rb_random_interface_t *rng, rb_random_t *rnd); /* * call-seq: * prng.rand -> float * prng.rand(max) -> number + * prng.rand(range) -> number * * When +max+ is an Integer, +rand+ returns a random integer greater than * or equal to zero and less than +max+. Unlike Kernel.rand, when +max+ @@ -1248,12 +1550,14 @@ static VALUE rand_random(int argc, VALUE *argv, VALUE obj, rb_random_t *rnd); * prng.rand(100) # => 42 * * When +max+ is a Float, +rand+ returns a random floating point number - * between 0.0 and +max+, including 0.0 and excluding +max+. + * between 0.0 and +max+, including 0.0 and excluding +max+. Note that it + * behaves differently from Kernel.rand. * - * prng.rand(1.5) # => 1.4600282860034115 + * prng.rand(1.5) # => 1.4600282860034115 + * rand(1.5) # => 0 * - * When +max+ is a Range, +rand+ returns a random number where - * range.member?(number) == true. + * When +range+ is a Range, +rand+ returns a random number where + * <code>range.member?(number) == true</code>. * * prng.rand(5..9) # => one of [5, 6, 7, 8, 9] * prng.rand(5...9) # => one of [5, 6, 7, 8] @@ -1267,46 +1571,50 @@ static VALUE rand_random(int argc, VALUE *argv, VALUE obj, rb_random_t *rnd); static VALUE random_rand(int argc, VALUE *argv, VALUE obj) { - VALUE v = rand_random(argc, argv, obj, get_rnd(obj)); + const rb_random_interface_t *rng = NULL; + rb_random_t *rnd = try_get_rnd(obj, &rng); + VALUE v = rand_random(argc, argv, obj, rng, rnd); check_random_number(v, argv); return v; } static VALUE -rand_random(int argc, VALUE *argv, VALUE obj, rb_random_t *rnd) +rand_random(int argc, VALUE *argv, VALUE obj, const rb_random_interface_t *rng, rb_random_t *rnd) { VALUE vmax, v; if (rb_check_arity(argc, 0, 1) == 0) { - return rb_float_new(random_real(obj, rnd, TRUE)); + return rb_float_new(random_real(obj, rng, rnd, TRUE)); } vmax = argv[0]; if (NIL_P(vmax)) return Qnil; - if (!RB_TYPE_P(vmax, T_FLOAT)) { - v = rb_check_to_int(vmax); - if (!NIL_P(v)) return rand_int(obj, rnd, v, 1); + if (!RB_FLOAT_TYPE_P(vmax)) { + v = rb_check_to_int(vmax); + if (!NIL_P(v)) return rand_int(obj, rng, rnd, v, 1); } v = rb_check_to_float(vmax); if (!NIL_P(v)) { - const double max = float_value(v); - if (max < 0.0) { - return Qnil; - } - else { - double r = random_real(obj, rnd, TRUE); - if (max > 0.0) r *= max; - return rb_float_new(r); - } + const double max = float_value(v); + if (max < 0.0) { + return Qnil; + } + else { + double r = random_real(obj, rng, rnd, TRUE); + if (max > 0.0) r *= max; + return rb_float_new(r); + } } - return rand_range(obj, rnd, vmax); + return rand_range(obj, rng, rnd, vmax); } /* * call-seq: - * prng.random_number -> float - * prng.random_number(max) -> number - * prng.rand -> float - * prng.rand(max) -> number + * prng.random_number -> float + * prng.random_number(max) -> number + * prng.random_number(range) -> number + * prng.rand -> float + * prng.rand(max) -> number + * prng.rand(range) -> number * * Generates formatted random number from raw random bytes. * See Random#rand. @@ -1314,9 +1622,10 @@ rand_random(int argc, VALUE *argv, VALUE obj, rb_random_t *rnd) static VALUE rand_random_number(int argc, VALUE *argv, VALUE obj) { - rb_random_t *rnd = try_get_rnd(obj); - VALUE v = rand_random(argc, argv, obj, rnd); - if (NIL_P(v)) v = rand_random(0, 0, obj, rnd); + const rb_random_interface_t *rng = NULL; + rb_random_t *rnd = try_get_rnd(obj, &rng); + VALUE v = rand_random(argc, argv, obj, rng, rnd); + if (NIL_P(v)) v = rand_random(0, 0, obj, rng, rnd); else if (!v) invalid_argument(argv[0]); return v; } @@ -1346,16 +1655,16 @@ rand_random_number(int argc, VALUE *argv, VALUE obj) * prng1 == prng2 # => true */ static VALUE -random_equal(VALUE self, VALUE other) +rand_mt_equal(VALUE self, VALUE other) { - rb_random_t *r1, *r2; + rb_random_mt_t *r1, *r2; if (rb_obj_class(self) != rb_obj_class(other)) return Qfalse; - r1 = get_rnd(self); - r2 = get_rnd(other); + r1 = get_rnd_mt(self); + r2 = get_rnd_mt(other); if (memcmp(r1->mt.state, r2->mt.state, sizeof(r1->mt.state))) return Qfalse; if ((r1->mt.next - r1->mt.state) != (r2->mt.next - r2->mt.state)) return Qfalse; if (r1->mt.left != r2->mt.left) return Qfalse; - return rb_equal(r1->seed, r2->seed); + return rb_equal(r1->base.seed, r2->base.seed); } /* @@ -1374,7 +1683,7 @@ random_equal(VALUE self, VALUE other) * rand(100) #=> 12 * * When +max+ is a Range, +rand+ returns a random number where - * range.member?(number) == true. + * <code>range.member?(number) == true</code>. * * Negative or floating point values for +max+ are allowed, but may give * surprising results. @@ -1386,39 +1695,44 @@ random_equal(VALUE self, VALUE other) * Kernel.srand may be used to ensure that sequences of random numbers are * reproducible between different runs of a program. * - * See also Random.rand. + * Related: Random.rand. + * rand(100.0) # => 64 (Integer because max.to_i is 100) + * Random.rand(100.0) # => 30.315320967824523 */ static VALUE rb_f_rand(int argc, VALUE *argv, VALUE obj) { VALUE vmax; - rb_random_t *rnd = rand_start(&default_rand); + const rb_random_interface_t *rng = &random_mt_if; + rb_random_t *rnd = default_rand_start(); if (rb_check_arity(argc, 0, 1) && !NIL_P(vmax = argv[0])) { - VALUE v = rand_range(Qnil, rnd, vmax); - if (v != Qfalse) return v; - vmax = rb_to_int(vmax); - if (vmax != INT2FIX(0)) { - v = rand_int(Qnil, rnd, vmax, 0); - if (!NIL_P(v)) return v; - } + VALUE v = rand_range(obj, rng, rnd, vmax); + if (v != Qfalse) return v; + vmax = rb_to_int(vmax); + if (vmax != INT2FIX(0)) { + v = rand_int(obj, rng, rnd, vmax, 0); + if (!NIL_P(v)) return v; + } } - return DBL2NUM(genrand_real(&rnd->mt)); + return DBL2NUM(random_real(obj, rng, rnd, TRUE)); } /* * call-seq: * Random.rand -> float * Random.rand(max) -> number + * Random.rand(range) -> number + * + * Returns a random number using the Ruby system PRNG. * - * Alias of Random::DEFAULT.rand. + * See also Random#rand. */ - static VALUE random_s_rand(int argc, VALUE *argv, VALUE obj) { - VALUE v = rand_random(argc, argv, Qnil, rand_start(&default_rand)); + VALUE v = rand_random(argc, argv, Qnil, &random_mt_if, default_rand_start()); check_random_number(v, argv); return v; } @@ -1456,7 +1770,7 @@ init_hash_salt(struct MT *mt) int i; for (i = 0; i < numberof(hash_salt.u32); ++i) - hash_salt.u32[i] = genrand_int32(mt); + hash_salt.u32[i] = genrand_int32(mt); } NO_SANITIZE("unsigned-integer-overflow", extern st_index_t rb_hash_start(st_index_t h)); @@ -1470,8 +1784,10 @@ st_index_t rb_memhash(const void *ptr, long len) { sip_uint64_t h = sip_hash13(hash_salt.key.sip, ptr, len); -#ifdef HAVE_UINT64_T +#if SIZEOF_ST_INDEX_T >= 8 return (st_index_t)h; +#elif defined HAVE_UINT64_T + return (st_index_t)((h >> 32) ^ h); #else return (st_index_t)(h.u32[0] ^ h.u32[1]); #endif @@ -1488,12 +1804,12 @@ Init_RandomSeedCore(void) If failed to fill siphash's salt with random data, expand less random data with MT. - Don't reuse this MT for Random::DEFAULT. Random::DEFAULT::seed shouldn't + Don't reuse this MT for default_rand(). default_rand()::seed shouldn't provide a hint that an attacker guess siphash's seed. */ struct MT mt; - with_random_seed(DEFAULT_SEED_CNT, 0) { + with_random_seed(DEFAULT_SEED_CNT, 0, false) { init_by_array(&mt, seedbuf, DEFAULT_SEED_CNT); } @@ -1501,29 +1817,12 @@ Init_RandomSeedCore(void) explicit_bzero(&mt, sizeof(mt)); } -/* construct Random::DEFAULT bits */ -static VALUE -Init_Random_default(VALUE klass) -{ - rb_random_t *r = &default_rand; - struct MT *mt = &r->mt; - VALUE v = TypedData_Wrap_Struct(klass, &random_mt_type, r); - - rb_gc_register_mark_object(v); - with_random_seed(DEFAULT_SEED_CNT, 1) { - init_by_array(mt, seedbuf, DEFAULT_SEED_CNT); - r->seed = make_seed_value(seedbuf, DEFAULT_SEED_CNT); - } - - return v; -} - void rb_reset_random_seed(void) { - rb_random_t *r = &default_rand; + rb_random_mt_t *r = default_rand(); uninit_genrand(&r->mt); - r->seed = INT2FIX(0); + r->base.seed = INT2FIX(0); } /* @@ -1539,60 +1838,81 @@ rb_reset_random_seed(void) * * The class method Random.rand provides the base functionality of Kernel.rand * along with better handling of floating point values. These are both - * interfaces to Random::DEFAULT, the Ruby system PRNG. + * interfaces to the Ruby system PRNG. * - * Random.new will create a new PRNG with a state independent of - * Random::DEFAULT, allowing multiple generators with different seed values or + * Random.new will create a new PRNG with a state independent of the Ruby + * system PRNG, allowing multiple generators with different seed values or * sequence positions to exist simultaneously. Random objects can be * marshaled, allowing sequences to be saved and resumed. * * PRNGs are currently implemented as a modified Mersenne Twister with a period - * of 2**19937-1. + * of 2**19937-1. As this algorithm is _not_ for cryptographical use, you must + * use SecureRandom for security purpose, instead of this PRNG. + * + * See also Random::Formatter module that adds convenience methods to generate + * various forms of random data. */ void InitVM_Random(void) { + VALUE base; + ID id_base = rb_intern_const("Base"); + rb_define_global_function("srand", rb_f_srand, -1); rb_define_global_function("rand", rb_f_rand, -1); - rb_cRandom = rb_define_class("Random", rb_cObject); + base = rb_define_class_id(id_base, rb_cObject); + rb_undef_alloc_func(base); + rb_cRandom = rb_define_class("Random", base); + rb_const_set(rb_cRandom, id_base, base); rb_define_alloc_func(rb_cRandom, random_alloc); + rb_define_method(base, "initialize", random_init, -1); + rb_define_method(base, "rand", random_rand, -1); + rb_define_method(base, "bytes", random_bytes, 1); + rb_define_method(base, "seed", random_get_seed, 0); + rb_define_method(rb_cRandom, "initialize_copy", rand_mt_copy, 1); + rb_define_private_method(rb_cRandom, "marshal_dump", rand_mt_dump, 0); + rb_define_private_method(rb_cRandom, "marshal_load", rand_mt_load, 1); + rb_define_private_method(rb_cRandom, "state", rand_mt_state, 0); + rb_define_private_method(rb_cRandom, "left", rand_mt_left, 0); + rb_define_method(rb_cRandom, "==", rand_mt_equal, 1); + +#if 0 /* for RDoc: it can't handle unnamed base class */ rb_define_method(rb_cRandom, "initialize", random_init, -1); rb_define_method(rb_cRandom, "rand", random_rand, -1); rb_define_method(rb_cRandom, "bytes", random_bytes, 1); rb_define_method(rb_cRandom, "seed", random_get_seed, 0); - rb_define_method(rb_cRandom, "initialize_copy", random_copy, 1); - rb_define_private_method(rb_cRandom, "marshal_dump", random_dump, 0); - rb_define_private_method(rb_cRandom, "marshal_load", random_load, 1); - rb_define_private_method(rb_cRandom, "state", random_state, 0); - rb_define_private_method(rb_cRandom, "left", random_left, 0); - rb_define_method(rb_cRandom, "==", random_equal, 1); - - { - /* Direct access to Ruby's Pseudorandom number generator (PRNG). */ - VALUE rand_default = Init_Random_default(rb_cRandom); - /* The default Pseudorandom number generator. Used by class - * methods of Random. */ - rb_define_const(rb_cRandom, "DEFAULT", rand_default); - } +#endif rb_define_singleton_method(rb_cRandom, "srand", rb_f_srand, -1); rb_define_singleton_method(rb_cRandom, "rand", random_s_rand, -1); rb_define_singleton_method(rb_cRandom, "bytes", random_s_bytes, 1); + rb_define_singleton_method(rb_cRandom, "seed", random_s_seed, 0); rb_define_singleton_method(rb_cRandom, "new_seed", random_seed, 0); rb_define_singleton_method(rb_cRandom, "urandom", random_raw_seed, 1); rb_define_private_method(CLASS_OF(rb_cRandom), "state", random_s_state, 0); rb_define_private_method(CLASS_OF(rb_cRandom), "left", random_s_left, 0); { - /* Format raw random number as Random does */ - VALUE m = rb_define_module_under(rb_cRandom, "Formatter"); - rb_include_module(rb_cRandom, m); - rb_extend_object(rb_cRandom, m); - rb_define_method(m, "random_number", rand_random_number, -1); - rb_define_method(m, "rand", rand_random_number, -1); + /* + * Generate a random number in the given range as Random does + * + * prng.random_number #=> 0.5816771641321361 + * prng.random_number(1000) #=> 485 + * prng.random_number(1..6) #=> 3 + * prng.rand #=> 0.5816771641321361 + * prng.rand(1000) #=> 485 + * prng.rand(1..6) #=> 3 + */ + VALUE m = rb_define_module_under(rb_cRandom, "Formatter"); + rb_include_module(base, m); + rb_extend_object(base, m); + rb_define_method(m, "random_number", rand_random_number, -1); + rb_define_method(m, "rand", rand_random_number, -1); } + + default_rand_key = rb_ractor_local_storage_ptr_newkey(&default_rand_key_storage_type); } #undef rb_intern |