lib/rand.c

   1 /*
   2   This is a maximally equidistributed combined Tausworthe generator
   3   based on code from GNU Scientific Library 1.5 (30 Jun 2004)
   4
   5    x_n = (s1_n ^ s2_n ^ s3_n)
   6
   7    s1_{n+1} = (((s1_n & 4294967294) <<12) ^ (((s1_n <<13) ^ s1_n) >>19))
   8    s2_{n+1} = (((s2_n & 4294967288) << 4) ^ (((s2_n << 2) ^ s2_n) >>25))
   9    s3_{n+1} = (((s3_n & 4294967280) <<17) ^ (((s3_n << 3) ^ s3_n) >>11))
  10
  11    The period of this generator is about 2^88.
  12
  13    From: P. L'Ecuyer, "Maximally Equidistributed Combined Tausworthe
  14    Generators", Mathematics of Computation, 65, 213 (1996), 203--213.
  15
  16    This is available on the net from L'Ecuyer's home page,
  17
  18    http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps
  19    ftp://ftp.iro.umontreal.ca/pub/simulation/lecuyer/papers/tausme.ps
  20
  21    There is an erratum in the paper "Tables of Maximally
  22    Equidistributed Combined LFSR Generators", Mathematics of
  23    Computation, 68, 225 (1999), 261--269:
  24    http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps
  25
  26         ... the k_j most significant bits of z_j must be non-
  27         zero, for each j. (Note: this restriction also applies to the
  28         computer code given in [4], but was mistakenly not mentioned in
  29         that paper.)
  30
  31    This affects the seeding procedure by imposing the requirement
  32    s1 > 1, s2 > 7, s3 > 15.
  33
  34 */
  35
  36 #include <string.h>
  37 #include "rand.h"
  38 #include "pattern.h"
  39 #include "../hash.h"
  40
  41 int arch_random;
  42
  43 static inline uint64_t __seed(uint64_t x, uint64_t m)
  44 {
  45         return (x < m) ? x + m : x;
  46 }
  47
  48 static void __init_rand32(struct taus88_state *state, unsigned int seed)
  49 {
  50         int cranks = 6;
  51
  52 #define LCG(x, seed)  ((x) * 69069 ^ (seed))
  53
  54         state->s1 = __seed(LCG((2^31) + (2^17) + (2^7), seed), 1);
  55         state->s2 = __seed(LCG(state->s1, seed), 7);
  56         state->s3 = __seed(LCG(state->s2, seed), 15);
  57
  58         while (cranks--)
  59                 __rand32(state);
  60 }
  61
  62 void __init_rand64(struct taus258_state *state, uint64_t seed)
  63 {
  64         int cranks = 6;
  65
  66 #define LCG64(x, seed)  ((x) * 6906969069ULL ^ (seed))
  67
  68         state->s1 = __seed(LCG64((2^31) + (2^17) + (2^7), seed), 1);
  69         state->s2 = __seed(LCG64(state->s1, seed), 7);
  70         state->s3 = __seed(LCG64(state->s2, seed), 15);
  71         state->s4 = __seed(LCG64(state->s3, seed), 33);
  72         state->s5 = __seed(LCG64(state->s4, seed), 49);
  73
  74         while (cranks--)
  75                 __rand64(state);
  76 }
  77
  78 void init_rand(struct frand_state *state, bool use64)
  79 {
  80         state->use64 = use64;
  81
  82         if (!use64)
  83                 __init_rand32(&state->state32, 1);
  84         else
  85                 __init_rand64(&state->state64, 1);
  86 }
  87
  88 void init_rand_seed(struct frand_state *state, uint64_t seed, bool use64)
  89 {
  90         state->use64 = use64;
  91
  92         if (!use64)
  93                 __init_rand32(&state->state32, (unsigned int) seed);
  94         else
  95                 __init_rand64(&state->state64, seed);
  96 }
  97
  98 void __fill_random_buf_small(void *buf, unsigned int len, uint64_t seed)
  99 {
 100         uint64_t *b = buf;
 101         uint64_t *e = b  + len / sizeof(*b);
 102         unsigned int rest = len % sizeof(*b);
 103
 104         for (; b != e; ++b) {
 105                 *b = seed;
 106                 seed = __hash_u64(seed);
 107         }
 108
 109         if (fio_unlikely(rest))
 110                 __builtin_memcpy(e, &seed, rest);
 111 }
 112
 113 void __fill_random_buf(void *buf, unsigned int len, uint64_t seed)
 114 {
 115 #define MAX_SEED_BUCKETS 16
 116         static uint64_t prime[MAX_SEED_BUCKETS] = {1,  2,  3,  5,
 117                                                    7,  11, 13, 17,
 118                                                    19, 23, 29, 31,
 119                                                    37, 41, 43, 47};
 120
 121         uint64_t *b, *e, s[CONFIG_SEED_BUCKETS];
 122         unsigned int rest;
 123         int p;
 124
 125         /*
 126          * Calculate the max index which is multiples of the seed buckets.
 127          */
 128         rest = (len / sizeof(*b) / CONFIG_SEED_BUCKETS) * CONFIG_SEED_BUCKETS;
 129
 130         b = buf;
 131         e = b + rest;
 132
 133         rest = len - (rest * sizeof(*b));
 134
 135         for (p = 0; p < CONFIG_SEED_BUCKETS; p++)
 136                 s[p] = seed * prime[p];
 137
 138         for (; b != e; b += CONFIG_SEED_BUCKETS) {
 139                 for (p = 0; p < CONFIG_SEED_BUCKETS; ++p) {
 140                         b[p] = s[p];
 141                         s[p] = __hash_u64(s[p]);
 142                 }
 143         }
 144
 145         __fill_random_buf_small(b, rest, s[0]);
 146 }
 147
 148 uint64_t fill_random_buf(struct frand_state *fs, void *buf,
 149                          unsigned int len)
 150 {
 151         uint64_t r = __get_next_seed(fs);
 152
 153         __fill_random_buf(buf, len, r);
 154         return r;
 155 }
 156
 157 void __fill_random_buf_percentage(uint64_t seed, void *buf,
 158                                   unsigned int percentage,
 159                                   unsigned int segment, unsigned int len,
 160                                   char *pattern, unsigned int pbytes)
 161 {
 162         unsigned int this_len;
 163
 164         if (percentage == 100) {
 165                 if (pbytes)
 166                         (void)cpy_pattern(pattern, pbytes, buf, len);
 167                 else
 168                         memset(buf, 0, len);
 169                 return;
 170         }
 171
 172         if (segment > len)
 173                 segment = len;
 174
 175         while (len) {
 176                 /*
 177                  * Fill random chunk
 178                  */
 179                 this_len = ((unsigned long long)segment * (100 - percentage)) / 100;
 180                 if (this_len > len)
 181                         this_len = len;
 182
 183                 __fill_random_buf(buf, this_len, seed);
 184
 185                 len -= this_len;
 186                 if (!len)
 187                         break;
 188                 buf += this_len;
 189                 this_len = segment - this_len;
 190
 191                 if (this_len > len)
 192                         this_len = len;
 193                 else if (len - this_len <= sizeof(long))
 194                         this_len = len;
 195
 196                 if (pbytes)
 197                         (void)cpy_pattern(pattern, pbytes, buf, this_len);
 198                 else
 199                         memset(buf, 0, this_len);
 200
 201                 len -= this_len;
 202                 buf += this_len;
 203         }
 204 }
 205
 206 uint64_t fill_random_buf_percentage(struct frand_state *fs, void *buf,
 207                                     unsigned int percentage,
 208                                     unsigned int segment, unsigned int len,
 209                                     char *pattern, unsigned int pbytes)
 210 {
 211         uint64_t r = __get_next_seed(fs);
 212
 213         __fill_random_buf_percentage(r, buf, percentage, segment, len,
 214                                         pattern, pbytes);
 215         return r;
 216 }