rand: add 64-bit tausworthe variant with a 2^258 cycle
[fio.git] / 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 <assert.h>
38 #include "rand.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 static 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, int 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, unsigned int seed, int use64)
89 {
90         state->use64 = use64;
91
92         if (!use64)
93                 __init_rand32(&state->state32, seed);
94         else
95                 __init_rand64(&state->state64, seed);
96 }
97
98 void __fill_random_buf(void *buf, unsigned int len, unsigned long seed)
99 {
100         void *ptr = buf;
101
102         while (len) {
103                 int this_len;
104
105                 if (len >= sizeof(int64_t)) {
106                         *((int64_t *) ptr) = seed;
107                         this_len = sizeof(int64_t);
108                 } else if (len >= sizeof(int32_t)) {
109                         *((int32_t *) ptr) = seed;
110                         this_len = sizeof(int32_t);
111                 } else if (len >= sizeof(int16_t)) {
112                         *((int16_t *) ptr) = seed;
113                         this_len = sizeof(int16_t);
114                 } else {
115                         *((int8_t *) ptr) = seed;
116                         this_len = sizeof(int8_t);
117                 }
118                 ptr += this_len;
119                 len -= this_len;
120                 seed *= GOLDEN_RATIO_PRIME;
121                 seed >>= 3;
122         }
123 }
124
125 unsigned long fill_random_buf(struct frand_state *fs, void *buf,
126                               unsigned int len)
127 {
128         unsigned long r = __rand(fs);
129
130         if (sizeof(int) != sizeof(long *))
131                 r *= (unsigned long) __rand(fs);
132
133         __fill_random_buf(buf, len, r);
134         return r;
135 }
136
137 void fill_pattern(void *p, unsigned int len, char *pattern,
138                   unsigned int pattern_bytes)
139 {
140         switch (pattern_bytes) {
141         case 0:
142                 assert(0);
143                 break;
144         case 1:
145                 memset(p, pattern[0], len);
146                 break;
147         default: {
148                 unsigned int i = 0, size = 0;
149                 unsigned char *b = p;
150
151                 while (i < len) {
152                         size = pattern_bytes;
153                         if (size > (len - i))
154                                 size = len - i;
155                         memcpy(b+i, pattern, size);
156                         i += size;
157                 }
158                 break;
159                 }
160         }
161 }
162
163 void __fill_random_buf_percentage(unsigned long seed, void *buf,
164                                   unsigned int percentage,
165                                   unsigned int segment, unsigned int len,
166                                   char *pattern, unsigned int pbytes)
167 {
168         unsigned int this_len;
169
170         if (percentage == 100) {
171                 if (pbytes)
172                         fill_pattern(buf, len, pattern, pbytes);
173                 else
174                         memset(buf, 0, len);
175                 return;
176         }
177
178         if (segment > len)
179                 segment = len;
180
181         while (len) {
182                 /*
183                  * Fill random chunk
184                  */
185                 this_len = (segment * (100 - percentage)) / 100;
186                 if (this_len > len)
187                         this_len = len;
188
189                 __fill_random_buf(buf, this_len, seed);
190
191                 len -= this_len;
192                 if (!len)
193                         break;
194                 buf += this_len;
195
196                 if (this_len > len)
197                         this_len = len;
198                 else if (len - this_len <= sizeof(long))
199                         this_len = len;
200
201                 if (pbytes)
202                         fill_pattern(buf, this_len, pattern, pbytes);
203                 else
204                         memset(buf, 0, this_len);
205
206                 len -= this_len;
207                 buf += this_len;
208         }
209 }
210
211 unsigned long fill_random_buf_percentage(struct frand_state *fs, void *buf,
212                                          unsigned int percentage,
213                                          unsigned int segment, unsigned int len,
214                                          char *pattern, unsigned int pbytes)
215 {
216         unsigned long r = __rand(fs);
217
218         if (sizeof(int) != sizeof(long *))
219                 r *= (unsigned long) __rand(fs);
220
221         __fill_random_buf_percentage(r, buf, percentage, segment, len,
222                                         pattern, pbytes);
223         return r;
224 }