Debian Codegraph @

regutil/random.c

raw
1 /*
2 * Copyright (c) 1983 Regents of the University of California.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 */
33
34 #if defined(LIBC_SCCS) && !defined(lint)
35 static char sccsid[] = "@(#)random.c 5.9 (Berkeley) 2/23/91";
36 #endif /* LIBC_SCCS and not lint */
37
38 #include <stdio.h>
39 #include <stdlib.h>
40
41 /*
42 * random.c:
43 *
44 * An improved random number generation package. In addition to the standard
45 * rand()/srand() like interface, this package also has a special state info
46 * interface. The initstate() routine is called with a seed, an array of
47 * bytes, and a count of how many bytes are being passed in; this array is
48 * then initialized to contain information for random number generation with
49 * that much state information. Good sizes for the amount of state
50 * information are 32, 64, 128, and 256 bytes. The state can be switched by
51 * calling the setstate() routine with the same array as was initiallized
52 * with initstate(). By default, the package runs with 128 bytes of state
53 * information and generates far better random numbers than a linear
54 * congruential generator. If the amount of state information is less than
55 * 32 bytes, a simple linear congruential R.N.G. is used.
56 *
57 * Internally, the state information is treated as an array of longs; the
58 * zeroeth element of the array is the type of R.N.G. being used (small
59 * integer); the remainder of the array is the state information for the
60 * R.N.G. Thus, 32 bytes of state information will give 7 longs worth of
61 * state information, which will allow a degree seven polynomial. (Note:
62 * the zeroeth word of state information also has some other information
63 * stored in it -- see setstate() for details).
64 *
65 * The random number generation technique is a linear feedback shift register
66 * approach, employing trinomials (since there are fewer terms to sum up that
67 * way). In this approach, the least significant bit of all the numbers in
68 * the state table will act as a linear feedback shift register, and will
69 * have period 2^deg - 1 (where deg is the degree of the polynomial being
70 * used, assuming that the polynomial is irreducible and primitive). The
71 * higher order bits will have longer periods, since their values are also
72 * influenced by pseudo-random carries out of the lower bits. The total
73 * period of the generator is approximately deg*(2**deg - 1); thus doubling
74 * the amount of state information has a vast influence on the period of the
75 * generator. Note: the deg*(2**deg - 1) is an approximation only good for
76 * large deg, when the period of the shift register is the dominant factor.
77 * With deg equal to seven, the period is actually much longer than the
78 * 7*(2**7 - 1) predicted by this formula.
79 */
80
81 typedef unsigned int u_int;
82
83 /*
84 * For each of the currently supported random number generators, we have a
85 * break value on the amount of state information (you need at least this
86 * many bytes of state info to support this random number generator), a degree
87 * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
88 * the separation between the two lower order coefficients of the trinomial.
89 */
90 #define TYPE_0 0 /* linear congruential */
91 #define BREAK_0 8
92 #define DEG_0 0
93 #define SEP_0 0
94
95 #define TYPE_1 1 /* x**7 + x**3 + 1 */
96 #define BREAK_1 32
97 #define DEG_1 7
98 #define SEP_1 3
99
100 #define TYPE_2 2 /* x**15 + x + 1 */
101 #define BREAK_2 64
102 #define DEG_2 15
103 #define SEP_2 1
104
105 #define TYPE_3 3 /* x**31 + x**3 + 1 */
106 #define BREAK_3 128
107 #define DEG_3 31
108 #define SEP_3 3
109
110 #define TYPE_4 4 /* x**63 + x + 1 */
111 #define BREAK_4 256
112 #define DEG_4 63
113 #define SEP_4 1
114
115 /*
116 * Array versions of the above information to make code run faster --
117 * relies on fact that TYPE_i == i.
118 */
119 #define MAX_TYPES 5 /* max number of types above */
120
121 static int degrees[MAX_TYPES] = { DEG_0, DEG_1, DEG_2, DEG_3, DEG_4 };
122 static int seps [MAX_TYPES] = { SEP_0, SEP_1, SEP_2, SEP_3, SEP_4 };
123
124 /*
125 * Initially, everything is set up as if from:
126 *
127 * initstate(1, &randtbl, 128);
128 *
129 * Note that this initialization takes advantage of the fact that srandom()
130 * advances the front and rear pointers 10*rand_deg times, and hence the
131 * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
132 * element of the state information, which contains info about the current
133 * position of the rear pointer is just
134 *
135 * MAX_TYPES * (rptr - state) + TYPE_3 == TYPE_3.
136 */
137
138 static long randtbl[DEG_3 + 1] = {
139 TYPE_3,
140 0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342, 0xde3b81e0, 0xdf0a6fb5,
141 0xf103bc02, 0x48f340fb, 0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd,
142 0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86, 0xda672e2a, 0x1588ca88,
143 0xe369735d, 0x904f35f7, 0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc,
144 0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b, 0xf5ad9d0e, 0x8999220b,
145 0x27fb47b9,
146 };
147
148 /*
149 * fptr and rptr are two pointers into the state info, a front and a rear
150 * pointer. These two pointers are always rand_sep places aparts, as they
151 * cycle cyclically through the state information. (Yes, this does mean we
152 * could get away with just one pointer, but the code for random() is more
153 * efficient this way). The pointers are left positioned as they would be
154 * from the call
155 *
156 * initstate(1, randtbl, 128);
157 *
158 * (The position of the rear pointer, rptr, is really 0 (as explained above
159 * in the initialization of randtbl) because the state table pointer is set
160 * to point to randtbl[1] (as explained below).
161 */
162 static long *fptr = &randtbl[SEP_3 + 1];
163 static long *rptr = &randtbl[1];
164
165 /*
166 * The following things are the pointer to the state information table, the
167 * type of the current generator, the degree of the current polynomial being
168 * used, and the separation between the two pointers. Note that for efficiency
169 * of random(), we remember the first location of the state information, not
170 * the zeroeth. Hence it is valid to access state[-1], which is used to
171 * store the type of the R.N.G. Also, we remember the last location, since
172 * this is more efficient than indexing every time to find the address of
173 * the last element to see if the front and rear pointers have wrapped.
174 */
175 static long *state = &randtbl[1];
176 static int rand_type = TYPE_3;
177 static int rand_deg = DEG_3;
178 static int rand_sep = SEP_3;
179 static long *end_ptr = &randtbl[DEG_3 + 1];
180
181 long random(void);
182
183 /*
184 * srandom:
185 *
186 * Initialize the random number generator based on the given seed. If the
187 * type is the trivial no-state-information type, just remember the seed.
188 * Otherwise, initializes state[] based on the given "seed" via a linear
189 * congruential generator. Then, the pointers are set to known locations
190 * that are exactly rand_sep places apart. Lastly, it cycles the state
191 * information a given number of times to get rid of any initial dependencies
192 * introduced by the L.C.R.N.G. Note that the initialization of randtbl[]
193 * for default usage relies on values produced by this routine.
194 */
195 void
196 srandom(x)
197 u_int x;
198 {
199 register int i, j;
200
201 if (rand_type == TYPE_0)
202 state[0] = x;
203 else {
204 j = 1;
205 state[0] = x;
206 for (i = 1; i < rand_deg; i++)
207 state[i] = 1103515245 * state[i - 1] + 12345;
208 fptr = &state[rand_sep];
209 rptr = &state[0];
210 for (i = 0; i < 10 * rand_deg; i++)
211 (void)random();
212 }
213 }
214
215 /*
216 * initstate:
217 *
218 * Initialize the state information in the given array of n bytes for future
219 * random number generation. Based on the number of bytes we are given, and
220 * the break values for the different R.N.G.'s, we choose the best (largest)
221 * one we can and set things up for it. srandom() is then called to
222 * initialize the state information.
223 *
224 * Note that on return from srandom(), we set state[-1] to be the type
225 * multiplexed with the current value of the rear pointer; this is so
226 * successive calls to initstate() won't lose this information and will be
227 * able to restart with setstate().
228 *
229 * Note: the first thing we do is save the current state, if any, just like
230 * setstate() so that it doesn't matter when initstate is called.
231 *
232 * Returns a pointer to the old state.
233 */
234 char *
235 initstate(seed, arg_state, n)
236 u_int seed; /* seed for R.N.G. */
237 char *arg_state; /* pointer to state array */
238 int n; /* # bytes of state info */
239 {
240 register char *ostate = (char *)(&state[-1]);
241
242 if (rand_type == TYPE_0)
243 state[-1] = rand_type;
244 else
245 state[-1] = MAX_TYPES * (rptr - state) + rand_type;
246 if (n < BREAK_0) {
247 (void)fprintf(stderr,
248 "random: not enough state (%d bytes); ignored.\n", n);
249 return(0);
250 }
251 if (n < BREAK_1) {
252 rand_type = TYPE_0;
253 rand_deg = DEG_0;
254 rand_sep = SEP_0;
255 } else if (n < BREAK_2) {
256 rand_type = TYPE_1;
257 rand_deg = DEG_1;
258 rand_sep = SEP_1;
259 } else if (n < BREAK_3) {
260 rand_type = TYPE_2;
261 rand_deg = DEG_2;
262 rand_sep = SEP_2;
263 } else if (n < BREAK_4) {
264 rand_type = TYPE_3;
265 rand_deg = DEG_3;
266 rand_sep = SEP_3;
267 } else {
268 rand_type = TYPE_4;
269 rand_deg = DEG_4;
270 rand_sep = SEP_4;
271 }
272 state = &(((long *)arg_state)[1]); /* first location */
273 end_ptr = &state[rand_deg]; /* must set end_ptr before srandom */
274 srandom(seed);
275 if (rand_type == TYPE_0)
276 state[-1] = rand_type;
277 else
278 state[-1] = MAX_TYPES*(rptr - state) + rand_type;
279 return(ostate);
280 }
281
282 /*
283 * setstate:
284 *
285 * Restore the state from the given state array.
286 *
287 * Note: it is important that we also remember the locations of the pointers
288 * in the current state information, and restore the locations of the pointers
289 * from the old state information. This is done by multiplexing the pointer
290 * location into the zeroeth word of the state information.
291 *
292 * Note that due to the order in which things are done, it is OK to call
293 * setstate() with the same state as the current state.
294 *
295 * Returns a pointer to the old state information.
296 */
297 char *
298 setstate(arg_state)
299 char *arg_state;
300 {
301 register long *new_state = (long *)arg_state;
302 register int type = new_state[0] % MAX_TYPES;
303 register int rear = new_state[0] / MAX_TYPES;
304 char *ostate = (char *)(&state[-1]);
305
306 if (rand_type == TYPE_0)
307 state[-1] = rand_type;
308 else
309 state[-1] = MAX_TYPES * (rptr - state) + rand_type;
310 switch(type) {
311 case TYPE_0:
312 case TYPE_1:
313 case TYPE_2:
314 case TYPE_3:
315 case TYPE_4:
316 rand_type = type;
317 rand_deg = degrees[type];
318 rand_sep = seps[type];
319 break;
320 default:
321 (void)fprintf(stderr,
322 "random: state info corrupted; not changed.\n");
323 }
324 state = &new_state[1];
325 if (rand_type != TYPE_0) {
326 rptr = &state[rear];
327 fptr = &state[(rear + rand_sep) % rand_deg];
328 }
329 end_ptr = &state[rand_deg]; /* set end_ptr too */
330 return(ostate);
331 }
332
333 /*
334 * random:
335 *
336 * If we are using the trivial TYPE_0 R.N.G., just do the old linear
337 * congruential bit. Otherwise, we do our fancy trinomial stuff, which is
338 * the same in all the other cases due to all the global variables that have
339 * been set up. The basic operation is to add the number at the rear pointer
340 * into the one at the front pointer. Then both pointers are advanced to
341 * the next location cyclically in the table. The value returned is the sum
342 * generated, reduced to 31 bits by throwing away the "least random" low bit.
343 *
344 * Note: the code takes advantage of the fact that both the front and
345 * rear pointers can't wrap on the same call by not testing the rear
346 * pointer if the front one has wrapped.
347 *
348 * Returns a 31-bit random number.
349 */
350 long
351 random()
352 {
353 long i;
354
355 if (rand_type == TYPE_0)
356 i = state[0] = (state[0] * 1103515245 + 12345) & 0x7fffffff;
357 else {
358 *fptr += *rptr;
359 i = (*fptr >> 1) & 0x7fffffff; /* chucking least random bit */
360 if (++fptr >= end_ptr) {
361 fptr = state;
362 ++rptr;
363 } else if (++rptr >= end_ptr)
364 rptr = state;
365 }
366 return(i);
367 }