niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

move MT19937 random generator to ddsrt

Browse source 
Signed-off-by: Erik Boasson <eb@ilities.com>
This commit is contained in:
Erik Boasson 2019-04-03 17:03:17 +02:00 • committed by eboasson
parent 83f3a51a47
commit 9bfac607a4
13 changed files with 345 additions and 264 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/ddsrt/CMakeLists.txt
View file

@ -165,7 +165,7 @@ find_package(Threads REQUIRED)
target_link_libraries(ddsrt INTERFACE Threads::Threads)
if(WIN32)
target_link_libraries(ddsrt INTERFACE wsock32 ws2_32 iphlpapi)
target_link_libraries(ddsrt INTERFACE wsock32 ws2_32 iphlpapi bcrypt)
elseif(UNIX)
check_library_exists(c clock_gettime "" HAVE_CLOCK_GETTIME)
if(NOT HAVE_CLOCK_GETTIME)

23
src/ddsrt/include/dds/ddsrt/random.h
View file

@ -12,13 +12,34 @@
#ifndef DDSRT_RANDOM_H
#define DDSRT_RANDOM_H
#include <stdint.h>
#include <stdbool.h>
#include "dds/export.h"
#if defined (__cplusplus)
extern "C" {
#endif
DDS_EXPORT long ddsrt_random(void);
#define DDSRT_MT19937_N 624
typedef struct ddsrt_prng_seed {
uint32_t key[8];
} ddsrt_prng_seed_t;
typedef struct ddsrt_prng {
uint32_t mt[DDSRT_MT19937_N];
uint32_t mti;
} ddsrt_prng_t;
DDS_EXPORT void ddsrt_random_init (void);
DDS_EXPORT void ddsrt_random_fini (void);
DDS_EXPORT void ddsrt_prng_init_simple (ddsrt_prng_t *prng, uint32_t seed);
DDS_EXPORT bool ddsrt_prng_makeseed (struct ddsrt_prng_seed *seed);
DDS_EXPORT void ddsrt_prng_init (ddsrt_prng_t *prng, const struct ddsrt_prng_seed *seed);
DDS_EXPORT uint32_t ddsrt_prng_random (ddsrt_prng_t *prng);
DDS_EXPORT uint32_t ddsrt_random (void);
#if defined (__cplusplus)
}

3
src/ddsrt/src/cdtors.c
View file

@ -13,6 +13,7 @@
#include "dds/ddsrt/cdtors.h"
#include "dds/ddsrt/sync.h"
#include "dds/ddsrt/time.h"
#include "dds/ddsrt/random.h"
#if _WIN32
/* Sockets API initialization is only necessary on Microsoft Windows. The
@ -41,6 +42,7 @@ retry:
ddsrt_winsock_init();
ddsrt_time_init();
#endif
ddsrt_random_init();
ddsrt_atomic_or32(&init_status, INIT_STATUS_OK);
} else {
while (v > 1 && !(v & INIT_STATUS_OK)) {
@ -65,6 +67,7 @@ void ddsrt_fini (void)
if (nv == 1)
{
ddsrt_mutex_destroy(&init_mutex);
ddsrt_random_fini();
#if _WIN32
ddsrt_winsock_fini();
ddsrt_time_fini();

205
src/ddsrt/src/random.c
View file

@ -9,36 +9,197 @@
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
/*
A C-program for MT19937, with initialization improved 2002/1/26.
Coded by Takuji Nishimura and Makoto Matsumoto.
Before using, initialize the state by using init_genrand(seed)
or init_by_array(init_key, key_length).
Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The names of its contributors may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Any feedback is very welcome.
http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
*/
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include "dds/ddsrt/random.h"
#include "dds/ddsrt/sync.h"
#include "dds/ddsrt/time.h"
#include "dds/ddsrt/process.h"
#if _WIN32
#define _CRT_RAND_S
#include <errno.h>
#define N DDSRT_MT19937_N
#define M 397
#define MATRIX_A 0x9908b0dfU /* constant vector a */
#define UPPER_MASK 0x80000000U /* most significant w-r bits */
#define LOWER_MASK 0x7fffffffU /* least significant r bits */
long random (void)
static ddsrt_prng_t default_prng;
static ddsrt_mutex_t default_prng_lock;
/* initializes mt[N] with a seed */
static void init_genrand (ddsrt_prng_t *prng, uint32_t s)
{
/* rand() is a really terribly bad PRNG */
/* FIXME: Indeed (especially if not seeded), use rand_s instead. */
union { long x; unsigned char c[4]; } t;
int i;
for (i = 0; i < 4; i++)
t.c[i] = (unsigned char) ((rand () >> 4) & 0xff);
#if RAND_MAX == INT32_MAX || RAND_MAX == 0x7fff
t.x &= RAND_MAX;
#elif RAND_MAX <= 0x7ffffffe
t.x %= (RAND_MAX+1);
#else
#error "RAND_MAX out of range"
#endif
return t.x;
prng->mt[0] = s;
for (prng->mti = 1; prng->mti < N; prng->mti++)
{
prng->mt[prng->mti] = (1812433253U * (prng->mt[prng->mti-1] ^ (prng->mt[prng->mti-1] >> 30)) + prng->mti);
/* See Knuth TAOCP Vol2. 3rd Ed. P.106 for multiplier. */
/* In the previous versions, MSBs of the seed affect */
/* only MSBs of the array mt[]. */
/* 2002/01/09 modified by Makoto Matsumoto */
}
}
#endif
long ddsrt_random(void)
/* initialize by an array with array-length */
/* init_key is the array for initializing keys */
/* key_length is its length */
/* slight change for C++, 2004/2/26 */
static void init_by_array (ddsrt_prng_t *prng, const uint32_t init_key[], size_t key_length)
{
/* FIXME: Not MT-safe, should use random_r (or a real PRNG) instead. */
return random();
uint32_t i, j, k;
init_genrand (prng, 19650218U);
i = 1; j = 0;
k = (N > key_length ? N : (uint32_t) key_length);
for (; k; k--)
{
prng->mt[i] = (prng->mt[i] ^ ((prng->mt[i-1] ^ (prng->mt[i-1] >> 30)) * 1664525U)) + init_key[j] + j; /* non linear */
i++; j++;
if (i >= N)
{
prng->mt[0] = prng->mt[N-1];
i=1;
}
if (j >= key_length)
{
j = 0;
}
}
for (k = N-1; k; k--)
{
prng->mt[i] = (prng->mt[i] ^ ((prng->mt[i-1] ^ (prng->mt[i-1] >> 30)) * 1566083941U)) - i; /* non linear */
i++;
if (i >= N)
{
prng->mt[0] = prng->mt[N-1];
i = 1;
}
}
prng->mt[0] = 0x80000000U; /* MSB is 1; assuring non-zero initial array */
}
void ddsrt_prng_init_simple (ddsrt_prng_t *prng, uint32_t seed)
{
init_genrand (prng, seed);
}
void ddsrt_prng_init (ddsrt_prng_t *prng, const struct ddsrt_prng_seed *seed)
{
init_by_array (prng, seed->key, sizeof (seed->key) / sizeof (seed->key[0]));
}
/* generates a random number on [0,0xffffffff]-interval */
uint32_t ddsrt_prng_random (ddsrt_prng_t *prng)
{
/* mag01[x] = x * MATRIX_A for x=0,1 */
static const uint32_t mag01[2] = { 0x0U, MATRIX_A };
uint32_t y;
if (prng->mti >= N)
{
/* generate N words at one time */
int kk;
for (kk=0; kk < N-M; kk++)
{
y = (prng->mt[kk] & UPPER_MASK) | (prng->mt[kk+1] & LOWER_MASK);
prng->mt[kk] = prng->mt[kk+M] ^ (y >> 1) ^ mag01[y & 0x1U];
}
for (; kk < N-1; kk++)
{
y = (prng->mt[kk] & UPPER_MASK) | (prng->mt[kk+1] & LOWER_MASK);
prng->mt[kk] = prng->mt[kk+(M-N)] ^ (y >> 1) ^ mag01[y & 0x1U];
}
y = (prng->mt[N-1] & UPPER_MASK) | (prng->mt[0] & LOWER_MASK);
prng->mt[N-1] = prng->mt[M-1] ^ (y >> 1) ^ mag01[y & 0x1U];
prng->mti = 0;
}
y = prng->mt[prng->mti++];
/* Tempering */
y ^= (y >> 11);
y ^= (y << 7) & 0x9d2c5680U;
y ^= (y << 15) & 0xefc60000U;
y ^= (y >> 18);
return y;
}
uint32_t ddsrt_random (void)
{
uint32_t x;
ddsrt_mutex_lock (&default_prng_lock);
x = ddsrt_prng_random (&default_prng);
ddsrt_mutex_unlock (&default_prng_lock);
return x;
}
void ddsrt_random_init (void)
{
ddsrt_prng_seed_t seed;
if (!ddsrt_prng_makeseed (&seed))
{
/* Poor man's initialisation */
struct lengthof_seed_large_enough {
char ok[sizeof (seed.key) / sizeof (seed.key[0]) >= 3 ? 1 : -1];
};
memset (&seed, 0, sizeof (seed));
dds_time_t now = dds_time ();
seed.key[0] = (uint32_t) ddsrt_getpid ();
seed.key[1] = (uint32_t) ((uint64_t) now >> 32);
seed.key[2] = (uint32_t) now;
}
ddsrt_prng_init (&default_prng, &seed);
ddsrt_mutex_init (&default_prng_lock);
}
void ddsrt_random_fini (void)
{
ddsrt_mutex_destroy (&default_prng_lock);
}

17
src/ddsrt/src/random/posix/random.c Normal file
View file

@ -0,0 +1,17 @@
#include <stdio.h>
#include <string.h>
#include "dds/ddsrt/random.h"
bool ddsrt_prng_makeseed (struct ddsrt_prng_seed *seed)
{
FILE *rndfile;
memset (seed->key, 0, sizeof (seed->key));
if ((rndfile = fopen ("/dev/urandom", "rb")) == NULL)
return false;
else
{
size_t n = fread (seed->key, sizeof (seed->key), 1, rndfile);
fclose (rndfile);
return (n == 1);
}
}

14
src/ddsrt/src/random/windows/random.c Normal file
View file

@ -0,0 +1,14 @@
#include <ntstatus.h>
#define WIN32_NO_STATUS
#include <windows.h>
#include "bcrypt.h"
#include <string.h>
#include "dds/ddsrt/random.h"
bool ddsrt_prng_makeseed (struct ddsrt_prng_seed *seed)
{
NTSTATUS res;
memset (seed->key, 0, sizeof (seed->key));
res = BCryptGenRandom (NULL, (PUCHAR) seed->key, (ULONG) sizeof (seed->key), BCRYPT_USE_SYSTEM_PREFERRED_RNG);
return (res >= 0);
}

1
src/ddsrt/tests/CMakeLists.txt
View file

@ -22,6 +22,7 @@ set(sources
"thread_cleanup.c"
"string.c"
"log.c"
"random.c"
"strlcpy.c"
"socket.c"
"select.c")

92
src/ddsrt/tests/random.c Normal file
View file

@ -0,0 +1,92 @@
/*
* Copyright(c) 2006 to 2018 ADLINK Technology Limited and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
* v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
#include <assert.h>
#include <errno.h>
#include <stdio.h>
#include <string.h>
#include "CUnit/Test.h"
#include "dds/ddsrt/random.h"
#define N_PRNG 4
#define N_DATA 10
CU_Test(ddsrt_random, mt19937)
{
static const uint32_t refdata[N_DATA] = {
3499211612u, 581869302u, 3890346734u, 3586334585u, 545404204u,
4161255391u, 3922919429u, 949333985u, 2715962298u, 1323567403u
};
ddsrt_prng_t prng;
ddsrt_prng_init_simple (&prng, 5489U);
for (size_t i = 0; i < N_DATA; i++)
{
uint32_t x = ddsrt_prng_random (&prng);
CU_ASSERT_EQUAL_FATAL(x, refdata[i]);
}
}
CU_Test(ddsrt_random, makeseed)
{
ddsrt_prng_seed_t seeds[N_PRNG];
/* Until proven otherwise, assume all platforms have a good way of getting multiple seeds */
memset (seeds, 0, sizeof (seeds));
for (size_t i = 0; i < N_PRNG; i++)
{
bool ok = ddsrt_prng_makeseed (&seeds[i]);
CU_ASSERT_FATAL(ok);
}
/* Any pair the same is possible, but the likelihood should be so small that it is worth accepting
an intermittently failing test */
for (size_t i = 0; i < N_PRNG; i++)
{
for (size_t j = i + 1; j < N_PRNG; j++)
CU_ASSERT_FATAL (memcmp (&seeds[i], &seeds[j], sizeof (seeds[i])) != 0);
}
/* A short random sequence generated from each of the different seeds should be unique -- again,
there is no guarantee but only an overwhelming likelihood */
ddsrt_prng_t prngs[N_PRNG];
uint32_t data[N_PRNG][N_DATA];
memset (data, 0, sizeof (data));
for (size_t i = 0; i < N_PRNG; i++)
{
ddsrt_prng_init (&prngs[i], &seeds[i]);
for (size_t j = 0; j < N_DATA; j++)
data[i][j] = ddsrt_prng_random (&prngs[i]);
}
for (size_t i = 0; i < N_PRNG; i++)
{
for (size_t j = i + 1; j < N_PRNG; j++)
CU_ASSERT_FATAL (memcmp (&data[i], &data[j], sizeof (data[i])) != 0);
}
}
CU_Test(ddsrt_random, default_random)
{
#define N_BINS 128
#define N_PER_BIN 100
uint32_t bins[N_BINS];
memset (bins, 0, sizeof (bins));
for (size_t i = 0; i < N_PER_BIN * N_BINS; i++)
{
uint32_t x = ddsrt_random ();
bins[x % N_BINS]++;
}
double chisq = 0.0;
for (size_t i = 0; i < N_BINS; i++)
chisq += ((bins[i] - N_PER_BIN) * (bins[i] - N_PER_BIN)) / (double) N_PER_BIN;
/* Solve[CDF[ChiSquareDistribution[127], x] == 999/1000] */
CU_ASSERT (chisq < 181.993);
}