subsys/random: Add Xoroshiro128+ PRNG

This adds an implementation of Xoroshiro128+ PRNG, based on the
original implementation at [1].  This pseudorandom number generator
will use the entropy driver to obtain the seed.

While it uses only 128 bits of state, it's pretty robust for non-crypto
safe applications.

[1] http://vigna.di.unimi.it/xorshift/xoroshiro128plus.c

Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
This commit is contained in:
Leandro Pereira 2017-10-13 17:07:53 -07:00 committed by Anas Nashif
commit 5a272b027a
3 changed files with 123 additions and 0 deletions

View file

@ -17,6 +17,10 @@ config TEST_RANDOM_GENERATOR
number generator is not available. The non-random number generator number generator is not available. The non-random number generator
should not be used in a production environment. should not be used in a production environment.
choice
prompt "Random generator"
default ENTROPY_DEVICE_RANDOM_GENERATOR
config X86_TSC_RANDOM_GENERATOR config X86_TSC_RANDOM_GENERATOR
bool bool
prompt "x86 timestamp counter based number generator" prompt "x86 timestamp counter based number generator"
@ -42,3 +46,16 @@ config ENTROPY_DEVICE_RANDOM_GENERATOR
Enables a random number generator that uses the enabled Enables a random number generator that uses the enabled
hardware entropy gathering driver to generate random hardware entropy gathering driver to generate random
numbers. numbers.
config XOROSHIRO_RANDOM_GENERATOR
bool
prompt "Use Xoroshiro128+ as PRNG"
depends on ENTROPY_HAS_DRIVER
help
Enables the Xoroshiro128+ pseudo-random number generator, that
uses the entropy driver as a seed source. This is not a
cryptographically secure random number generator.
It is so named because it uses 128 bits of state.
endchoice

View file

@ -1,3 +1,4 @@
obj-$(CONFIG_TIMER_RANDOM_GENERATOR) = rand32_timer.o obj-$(CONFIG_TIMER_RANDOM_GENERATOR) = rand32_timer.o
obj-$(CONFIG_X86_TSC_RANDOM_GENERATOR) += rand32_timestamp.o obj-$(CONFIG_X86_TSC_RANDOM_GENERATOR) += rand32_timestamp.o
obj-$(CONFIG_ENTROPY_DEVICE_RANDOM_GENERATOR) += rand32_entropy_device.o obj-$(CONFIG_ENTROPY_DEVICE_RANDOM_GENERATOR) += rand32_entropy_device.o
obj-$(CONFIG_XOROSHIRO_RANDOM_GENERATOR) += rand32_xoroshiro128.o

View file

@ -0,0 +1,105 @@
/*
* Copyright (c) 2017 Intel Corporation
*
* SPDX-License-Identifier: CC0-1.0
*
* Based on code written in 2016 by David Blackman and Sebastiano Vigna
* (vigna@acm.org)
*
* To the extent possible under law, the author has dedicated all copyright
* and related and neighboring rights to this software to the public domain
* worldwide. This software is distributed without any warranty.
*
* See <http://creativecommons.org/publicdomain/zero/1.0/>.
*/
/* This is the successor to xorshift128+. It is the fastest full-period
* generator passing BigCrush without systematic failures, but due to the
* relatively short period it is acceptable only for applications with a
* mild amount of parallelism; otherwise, use a xorshift1024* generator.
*
* Beside passing BigCrush, this generator passes the PractRand test suite
* up to (and included) 16TB, with the exception of binary rank tests, as
* the lowest bit of this generator is an LSFR. The next bit is not an
* LFSR, but in the long run it will fail binary rank tests, too. The
* other bits have no LFSR artifacts.
*
* We suggest to use a sign test to extract a random Boolean value, and
* right shifts to extract subsets of bits.
*
* Note that the generator uses a simulated rotate operation, which most C
* compilers will turn into a single instruction. In Java, you can use
* Long.rotateLeft(). In languages that do not make low-level rotation
* instructions accessible xorshift128+ could be faster.
*
* The state must be seeded so that it is not everywhere zero. If you have
* a 64-bit seed, we suggest to seed a splitmix64 generator and use its
* output to fill s.
*/
#include <entropy.h>
#include <kernel.h>
static u64_t state[2];
static bool initialized;
K_SEM_DEFINE(state_sem, 0, 1);
static inline u64_t rotl(const u64_t x, int k)
{
return (x << k) | (x >> (64 - k));
}
static bool xoroshiro128_initialize(void)
{
struct device *dev = device_get_binding(CONFIG_ENTROPY_NAME);
if (!dev) {
return false;
}
if (entropy_get_entropy(dev, (uint8_t *)&state, sizeof(state)) < 0) {
return false;
}
initialized = true;
return true;
}
static u32_t xoroshiro128_next(void)
{
const u64_t s0 = state[0];
u64_t s1 = state[1];
const u64_t result = s0 + s1;
s1 ^= s0;
state[0] = rotl(s0, 55) ^ s1 ^ (s1 << 14);
state[1] = rotl(s1, 36);
return (u32_t)result;
}
u32_t sys_rand32_get(void)
{
u32_t ret;
k_sem_take(&state_sem, K_FOREVER);
if (unlikely(!initialized)) {
if (!xoroshiro128_initialize()) {
/* This should not happen, but beats returning 0
* when the PRNG couldn't be initialized.
*/
ret = k_cycle_get_32();
goto out;
}
}
ret = xoroshiro128_next();
out:
k_sem_give(&state_sem);
return ret;
}