src/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 #ifndef MSDOS
  25 #include <ansidecl.h>
  26 #endif
  27 #include <errno.h>
  28 #include <limits.h>
  29 #include <stdlib.h>
  30
  31 #include "random.h"
  32
  33
  34 /* An improved random number generation package.  In addition to the standard
  35    rand()/srand() like interface, this package also has a special state info
  36    interface.  The initstate() routine is called with a seed, an array of
  37    bytes, and a count of how many bytes are being passed in; this array is
  38    then initialized to contain information for random number generation with
  39    that much state information.  Good sizes for the amount of state
  40    information are 32, 64, 128, and 256 bytes.  The state can be switched by
  41    calling the setstate() function with the same array as was initiallized
  42    with initstate().  By default, the package runs with 128 bytes of state
  43    information and generates far better random numbers than a linear
  44    congruential generator.  If the amount of state information is less than
  45    32 bytes, a simple linear congruential R.N.G. is used.  Internally, the
  46    state information is treated as an array of longs; the zeroeth element of
  47    the array is the type of R.N.G. being used (small integer); the remainder
  48    of the array is the state information for the R.N.G.  Thus, 32 bytes of
  49    state information will give 7 longs worth of state information, which will
  50    allow a degree seven polynomial.  (Note: The zeroeth word of state
  51    information also has some other information stored in it; see setstate
  52    for details).  The random number generation technique is a linear feedback
  53    shift register approach, employing trinomials (since there are fewer terms
  54    to sum up that way).  In this approach, the least significant bit of all
  55    the numbers in the state table will act as a linear feedback shift register,
  56    and will have period 2^deg - 1 (where deg is the degree of the polynomial
  57    being used, assuming that the polynomial is irreducible and primitive).
  58    The higher order bits will have longer periods, since their values are
  59    also influenced by pseudo-random carries out of the lower bits.  The
  60    total period of the generator is approximately deg*(2**deg - 1); thus
  61    doubling the amount of state information has a vast influence on the
  62    period of the generator.  Note: The deg*(2**deg - 1) is an approximation
  63    only good for large deg, when the period of the shift register is the
  64    dominant factor.  With deg equal to seven, the period is actually much
  65    longer than the 7*(2**7 - 1) predicted by this formula.  */
  66
  67
  68
  69 /* For each of the currently supported random number generators, we have a
  70    break value on the amount of state information (you need at least thi
  71    bytes of state info to support this random number generator), a degree for
  72    the polynomial (actually a trinomial) that the R.N.G. is based on, and
  73    separation between the two lower order coefficients of the trinomial.  */
  74
  75 /* Linear congruential.  */
  76 #define TYPE_0          0
  77 #define BREAK_0         8
  78 #define DEG_0           0
  79 #define SEP_0           0
  80
  81 /* x**7 + x**3 + 1.  */
  82 #define TYPE_1          1
  83 #define BREAK_1         32
  84 #define DEG_1           7
  85 #define SEP_1           3
  86
  87 /* x**15 + x + 1.  */
  88 #define TYPE_2          2
  89 #define BREAK_2         64
  90 #define DEG_2           15
  91 #define SEP_2           1
  92
  93 /* x**31 + x**3 + 1.  */
  94 #define TYPE_3          3
  95 #define BREAK_3         128
  96 #define DEG_3           31
  97 #define SEP_3           3
  98
  99 /* x**63 + x + 1.  */
 100 #define TYPE_4          4
 101 #define BREAK_4         256
 102 #define DEG_4           63
 103 #define SEP_4           1
 104
 105
 106 /* Array versions of the above information to make code run faster.
 107    Relies on fact that TYPE_i == i.  */
 108
 109 #define MAX_TYPES       5       /* Max number of types above.  */
 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
 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
 175 void srandom_linux_libc(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_linux_libc();
 187   }
 188 }
 189
 190 /* If we are using the trivial TYPE_0 R.N.G., just do the old linear
 191    congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
 192    same in all ther other cases due to all the global variables that have been
 193    set up.  The basic operation is to add the number at the rear pointer into
 194    the one at the front pointer.  Then both pointers are advanced to the next
 195    location cyclically in the table.  The value returned is the sum generated,
 196    reduced to 31 bits by throwing away the "least random" low bit.
 197    Note: The code takes advantage of the fact that both the front and
 198    rear pointers can't wrap on the same call by not testing the rear
 199    pointer if the front one has wrapped.  Returns a 31-bit random number.  */
 200
 201 long int random_linux_libc()
 202 {
 203   if (rand_type == TYPE_0)
 204   {
 205     state[0] = ((state[0] * 1103515245) + 12345) & LONG_MAX;
 206     return state[0];
 207   }
 208   else
 209   {
 210     long int i;
 211     *fptr += *rptr;
 212     /* Chucking least random bit.  */
 213     i = (*fptr >> 1) & LONG_MAX;
 214     ++fptr;
 215     if (fptr >= end_ptr)
 216     {
 217       fptr = state;
 218       ++rptr;
 219     }
 220     else
 221     {
 222       ++rptr;
 223       if (rptr >= end_ptr)
 224         rptr = state;
 225     }
 226     return i;
 227   }
 228 }