entered into RCS
[kopensolaris-gnu/glibc.git] / stdlib / random.c
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 are permitted
6  * provided that the above copyright notice and this paragraph are
7  * duplicated in all such forms and that any documentation,
8  * advertising materials, and other materials related to such
9  * distribution and use acknowledge that the software was developed
10  * by the University of California, Berkeley.  The name of the
11  * University may not be used to endorse or promote products derived
12  * from this software without specific prior written permission.
13  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
15  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
16  */
17
18 /*
19  * This is derived from the Berkeley source:
20  *      @(#)random.c    5.5 (Berkeley) 7/6/88
21  * It was reworked for the GNU C Library by Roland McGrath.
22  */
23
24 #include <ansidecl.h>
25 #include <errno.h>
26 #include <limits.h>
27 #include <stddef.h>
28 #include <stdlib.h>
29
30
31 /* An improved random number generation package.  In addition to the standard
32    rand()/srand() like interface, this package also has a special state info
33    interface.  The initstate() routine is called with a seed, an array of
34    bytes, and a count of how many bytes are being passed in; this array is
35    then initialized to contain information for random number generation with
36    that much state information.  Good sizes for the amount of state
37    information are 32, 64, 128, and 256 bytes.  The state can be switched by
38    calling the setstate() function with the same array as was initiallized
39    with initstate().  By default, the package runs with 128 bytes of state
40    information and generates far better random numbers than a linear
41    congruential generator.  If the amount of state information is less than
42    32 bytes, a simple linear congruential R.N.G. is used.  Internally, the
43    state information is treated as an array of longs; the zeroeth element of
44    the array is the type of R.N.G. being used (small integer); the remainder
45    of the array is the state information for the R.N.G.  Thus, 32 bytes of
46    state information will give 7 longs worth of state information, which will
47    allow a degree seven polynomial.  (Note: The zeroeth word of state
48    information also has some other information stored in it; see setstate
49    for details).  The random number generation technique is a linear feedback
50    shift register approach, employing trinomials (since there are fewer terms
51    to sum up that way).  In this approach, the least significant bit of all
52    the numbers in the state table will act as a linear feedback shift register,
53    and will have period 2^deg - 1 (where deg is the degree of the polynomial
54    being used, assuming that the polynomial is irreducible and primitive).
55    The higher order bits will have longer periods, since their values are
56    also influenced by pseudo-random carries out of the lower bits.  The
57    total period of the generator is approximately deg*(2**deg - 1); thus
58    doubling the amount of state information has a vast influence on the
59    period of the generator.  Note: The deg*(2**deg - 1) is an approximation
60    only good for large deg, when the period of the shift register is the
61    dominant factor.  With deg equal to seven, the period is actually much
62    longer than the 7*(2**7 - 1) predicted by this formula.  */
63
64
65
66 /* For each of the currently supported random number generators, we have a
67    break value on the amount of state information (you need at least thi
68    bytes of state info to support this random number generator), a degree for
69    the polynomial (actually a trinomial) that the R.N.G. is based on, and
70    separation between the two lower order coefficients of the trinomial.  */
71
72 /* Linear congruential.  */
73 #define TYPE_0          0
74 #define BREAK_0         8
75 #define DEG_0           0
76 #define SEP_0           0
77
78 /* x**7 + x**3 + 1.  */
79 #define TYPE_1          1
80 #define BREAK_1         32
81 #define DEG_1           7
82 #define SEP_1           3
83
84 /* x**15 + x + 1.  */
85 #define TYPE_2          2
86 #define BREAK_2         64
87 #define DEG_2           15
88 #define SEP_2           1
89
90 /* x**31 + x**3 + 1.  */
91 #define TYPE_3          3
92 #define BREAK_3         128
93 #define DEG_3           31
94 #define SEP_3           3
95
96 /* x**63 + x + 1.  */
97 #define TYPE_4          4
98 #define BREAK_4         256
99 #define DEG_4           63
100 #define SEP_4           1
101
102
103 /* Array versions of the above information to make code run faster.
104    Relies on fact that TYPE_i == i.  */
105
106 #define MAX_TYPES       5       /* Max number of types above.  */
107
108 static int degrees[MAX_TYPES] = { DEG_0, DEG_1, DEG_2, DEG_3, DEG_4 };
109 static int seps[MAX_TYPES] = { SEP_0, SEP_1, SEP_2, SEP_3, SEP_4 };
110
111
112
113 /* Initially, everything is set up as if from:
114         initstate(1, randtbl, 128);
115    Note that this initialization takes advantage of the fact that srandom
116    advances the front and rear pointers 10*rand_deg times, and hence the
117    rear pointer which starts at 0 will also end up at zero; thus the zeroeth
118    element of the state information, which contains info about the current
119    position of the rear pointer is just
120         (MAX_TYPES * (rptr - state)) + TYPE_3 == TYPE_3.  */
121
122 static long int randtbl[DEG_3 + 1] =
123   {
124     TYPE_3,
125     -851904987, -43806228, -2029755270, 1390239686, -1912102820,
126     -485608943, 1969813258, -1590463333, -1944053249, 455935928, 508023712,
127     -1714531963, 1800685987, -2015299881, 654595283, -1149023258,
128     -1470005550, -1143256056, -1325577603, -1568001885, 1275120390,
129     -607508183, -205999574, -1696891592, 1492211999, -1528267240,
130     -952028296, -189082757, 362343714, 1424981831, 2039449641,
131   };
132
133 /* FPTR and RPTR are two pointers into the state info, a front and a rear
134    pointer.  These two pointers are always rand_sep places aparts, as they
135    cycle through the state information.  (Yes, this does mean we could get
136    away with just one pointer, but the code for random is more efficient
137    this way).  The pointers are left positioned as they would be from the call:
138         initstate(1, randtbl, 128);
139    (The position of the rear pointer, rptr, is really 0 (as explained above
140    in the initialization of randtbl) because the state table pointer is set
141    to point to randtbl[1] (as explained below).)  */
142
143 static long int *fptr = &randtbl[SEP_3 + 1];
144 static long int *rptr = &randtbl[1];
145
146
147
148 /* The following things are the pointer to the state information table,
149    the type of the current generator, the degree of the current polynomial
150    being used, and the separation between the two pointers.
151    Note that for efficiency of random, we remember the first location of
152    the state information, not the zeroeth.  Hence it is valid to access
153    state[-1], which is used to store the type of the R.N.G.
154    Also, we remember the last location, since this is more efficient than
155    indexing every time to find the address of the last element to see if
156    the front and rear pointers have wrapped.  */
157
158 static long int *state = &randtbl[1];
159
160 static int rand_type = TYPE_3;
161 static int rand_deg = DEG_3;
162 static int rand_sep = SEP_3;
163
164 static long int *end_ptr = &randtbl[sizeof(randtbl) / sizeof(randtbl[0])];
165 \f
166 /* Initialize the random number generator based on the given seed.  If the
167    type is the trivial no-state-information type, just remember the seed.
168    Otherwise, initializes state[] based on the given "seed" via a linear
169    congruential generator.  Then, the pointers are set to known locations
170    that are exactly rand_sep places apart.  Lastly, it cycles the state
171    information a given number of times to get rid of any initial dependencies
172    introduced by the L.C.R.N.G.  Note that the initialization of randtbl[]
173    for default usage relies on values produced by this routine.  */
174 void
175 DEFUN(__srandom, (x), unsigned int x)
176 {
177   state[0] = x;
178   if (rand_type != TYPE_0)
179     {
180       register long int i;
181       for (i = 1; i < rand_deg; ++i)
182         state[i] = (1103515145 * state[i - 1]) + 12345;
183       fptr = &state[rand_sep];
184       rptr = &state[0];
185       for (i = 0; i < 10 * rand_deg; ++i)
186         (void) __random();
187     }
188 }
189 \f
190 /* Initialize the state information in the given array of N bytes for
191    future random number generation.  Based on the number of bytes we
192    are given, and the break values for the different R.N.G.'s, we choose
193    the best (largest) one we can and set things up for it.  srandom is
194    then called to initialize the state information.  Note that on return
195    from srandom, we set state[-1] to be the type multiplexed with the current
196    value of the rear pointer; this is so successive calls to initstate won't
197    lose this information and will be able to restart with setstate.
198    Note: The first thing we do is save the current state, if any, just like
199    setstate so that it doesn't matter when initstate is called.
200    Returns a pointer to the old state.  */
201 PTR
202 DEFUN(__initstate, (seed, arg_state, n),
203       unsigned int seed AND PTR arg_state AND size_t n)
204 {
205   PTR ostate = (PTR) &state[-1];
206
207   if (rand_type == TYPE_0)
208     state[-1] = rand_type;
209   else
210     state[-1] = (MAX_TYPES * (rptr - state)) + rand_type;
211   if (n < BREAK_1)
212     {
213       if (n < BREAK_0)
214         {
215           errno = EINVAL;
216           return NULL;
217         }
218       rand_type = TYPE_0;
219       rand_deg = DEG_0;
220       rand_sep = SEP_0;
221     }
222   else if (n < BREAK_2)
223     {
224       rand_type = TYPE_1;
225       rand_deg = DEG_1;
226       rand_sep = SEP_1;
227     }
228   else if (n < BREAK_3)
229     {
230       rand_type = TYPE_2;
231       rand_deg = DEG_2;
232       rand_sep = SEP_2;
233     }
234   else if (n < BREAK_4)
235     {
236       rand_type = TYPE_3;
237       rand_deg = DEG_3;
238       rand_sep = SEP_3;
239     }
240   else
241     {
242       rand_type = TYPE_4;
243       rand_deg = DEG_4;
244       rand_sep = SEP_4;
245     }
246
247   state = &((long int *) arg_state)[1]; /* First location.  */
248   /* Must set END_PTR before srandom.  */
249   end_ptr = &state[rand_deg];
250   __srandom(seed);
251   if (rand_type == TYPE_0)
252     state[-1] = rand_type;
253   else
254     state[-1] = (MAX_TYPES * (rptr - state)) + rand_type;
255
256   return ostate;
257 }
258 \f
259 /* Restore the state from the given state array.
260    Note: It is important that we also remember the locations of the pointers
261    in the current state information, and restore the locations of the pointers
262    from the old state information.  This is done by multiplexing the pointer
263    location into the zeroeth word of the state information. Note that due
264    to the order in which things are done, it is OK to call setstate with the
265    same state as the current state
266    Returns a pointer to the old state information.  */
267 PTR
268 DEFUN(__setstate, (arg_state), PTR arg_state)
269 {
270   register long int *new_state = (long int *) arg_state;
271   register int type = new_state[0] % MAX_TYPES;
272   register int rear = new_state[0] / MAX_TYPES;
273   PTR ostate = (PTR) &state[-1];
274
275   if (rand_type == TYPE_0)
276     state[-1] = rand_type;
277   else
278     state[-1] = (MAX_TYPES * (rptr - state)) + rand_type;
279
280   switch (type)
281     {
282     case TYPE_0:
283     case TYPE_1:
284     case TYPE_2:
285     case TYPE_3:
286     case TYPE_4:
287       rand_type = type;
288       rand_deg = degrees[type];
289       rand_sep = seps[type];
290       break;
291     default:
292       /* State info munged.  */
293       errno = EINVAL;
294       return NULL;
295     }
296
297   state = &new_state[1];
298   if (rand_type != TYPE_0)
299     {
300       rptr = &state[rear];
301       fptr = &state[(rear + rand_sep) % rand_deg];
302     }
303   /* Set end_ptr too.  */
304   end_ptr = &state[rand_deg];
305
306   return ostate;
307 }
308 \f
309 /* If we are using the trivial TYPE_0 R.N.G., just do the old linear
310    congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
311    same in all ther other cases due to all the global variables that have been
312    set up.  The basic operation is to add the number at the rear pointer into
313    the one at the front pointer.  Then both pointers are advanced to the next
314    location cyclically in the table.  The value returned is the sum generated,
315    reduced to 31 bits by throwing away the "least random" low bit.
316    Note: The code takes advantage of the fact that both the front and
317    rear pointers can't wrap on the same call by not testing the rear
318    pointer if the front one has wrapped.  Returns a 31-bit random number.  */
319
320 long int
321 DEFUN_VOID(__random)
322 {
323   if (rand_type == TYPE_0)
324     {
325       state[0] = ((state[0] * 1103515245) + 12345) & LONG_MAX;
326       return state[0];
327     }
328   else
329     {
330       long int i;
331       *fptr += *rptr;
332       /* Chucking least random bit.  */
333       i = (*fptr >> 1) & LONG_MAX;
334       ++fptr;
335       if (fptr >= end_ptr)
336         {
337           fptr = state;
338           ++rptr;
339         }
340       else
341         {
342           ++rptr;
343           if (rptr >= end_ptr)
344             rptr = state;
345         }
346       return i;
347     }
348 }