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 #include <errno.h>
  25 #include <limits.h>
  26 #include <stdlib.h>
  27
  28 #include "random.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
 109
 110 /* Initially, everything is set up as if from:
 111         initstate(1, randtbl, 128);
 112    Note that this initialization takes advantage of the fact that srandom
 113    advances the front and rear pointers 10*rand_deg times, and hence the
 114    rear pointer which starts at 0 will also end up at zero; thus the zeroeth
 115    element of the state information, which contains info about the current
 116    position of the rear pointer is just
 117         (MAX_TYPES * (rptr - state)) + TYPE_3 == TYPE_3.  */
 118
 119 static long int randtbl[DEG_3 + 1] =
 120 {
 121   TYPE_3,
 122   -851904987, -43806228, -2029755270, 1390239686, -1912102820,
 123   -485608943, 1969813258, -1590463333, -1944053249, 455935928, 508023712,
 124   -1714531963, 1800685987, -2015299881, 654595283, -1149023258,
 125   -1470005550, -1143256056, -1325577603, -1568001885, 1275120390,
 126   -607508183, -205999574, -1696891592, 1492211999, -1528267240,
 127   -952028296, -189082757, 362343714, 1424981831, 2039449641,
 128 };
 129
 130 /* FPTR and RPTR are two pointers into the state info, a front and a rear
 131    pointer.  These two pointers are always rand_sep places aparts, as they
 132    cycle through the state information.  (Yes, this does mean we could get
 133    away with just one pointer, but the code for random is more efficient
 134    this way).  The pointers are left positioned as they would be from the call:
 135         initstate(1, randtbl, 128);
 136    (The position of the rear pointer, rptr, is really 0 (as explained above
 137    in the initialization of randtbl) because the state table pointer is set
 138    to point to randtbl[1] (as explained below).)  */
 139
 140 static long int *fptr = &randtbl[SEP_3 + 1];
 141 static long int *rptr = &randtbl[1];
 142
 143
 144
 145 /* The following things are the pointer to the state information table,
 146    the type of the current generator, the degree of the current polynomial
 147    being used, and the separation between the two pointers.
 148    Note that for efficiency of random, we remember the first location of
 149    the state information, not the zeroeth.  Hence it is valid to access
 150    state[-1], which is used to store the type of the R.N.G.
 151    Also, we remember the last location, since this is more efficient than
 152    indexing every time to find the address of the last element to see if
 153    the front and rear pointers have wrapped.  */
 154
 155 static long int *state = &randtbl[1];
 156
 157 static int rand_type = TYPE_3;
 158 static int rand_deg = DEG_3;
 159 static int rand_sep = SEP_3;
 160
 161 static long int *end_ptr = &randtbl[sizeof(randtbl) / sizeof(randtbl[0])];
 162
 163 /* Initialize the random number generator based on the given seed.  If the
 164    type is the trivial no-state-information type, just remember the seed.
 165    Otherwise, initializes state[] based on the given "seed" via a linear
 166    congruential generator.  Then, the pointers are set to known locations
 167    that are exactly rand_sep places apart.  Lastly, it cycles the state
 168    information a given number of times to get rid of any initial dependencies
 169    introduced by the L.C.R.N.G.  Note that the initialization of randtbl[]
 170    for default usage relies on values produced by this routine.  */
 171
 172 void srandom_linux_libc(unsigned int x)
 173 {
 174   state[0] = x;
 175   if (rand_type != TYPE_0)
 176   {
 177     register long int i;
 178     for (i = 1; i < rand_deg; ++i)
 179       state[i] = (1103515145 * state[i - 1]) + 12345;
 180     fptr = &state[rand_sep];
 181     rptr = &state[0];
 182     for (i = 0; i < 10 * rand_deg; ++i)
 183       (void) random_linux_libc();
 184   }
 185 }
 186
 187 /* If we are using the trivial TYPE_0 R.N.G., just do the old linear
 188    congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
 189    same in all ther other cases due to all the global variables that have been
 190    set up.  The basic operation is to add the number at the rear pointer into
 191    the one at the front pointer.  Then both pointers are advanced to the next
 192    location cyclically in the table.  The value returned is the sum generated,
 193    reduced to 31 bits by throwing away the "least random" low bit.
 194    Note: The code takes advantage of the fact that both the front and
 195    rear pointers can't wrap on the same call by not testing the rear
 196    pointer if the front one has wrapped.  Returns a 31-bit random number.  */
 197
 198 long int random_linux_libc()
 199 {
 200   if (rand_type == TYPE_0)
 201   {
 202     state[0] = ((state[0] * 1103515245) + 12345) & LONG_MAX;
 203     return state[0];
 204   }
 205   else
 206   {
 207     long int i;
 208     *fptr += *rptr;
 209     /* Chucking least random bit.  */
 210     i = (*fptr >> 1) & LONG_MAX;
 211     ++fptr;
 212     if (fptr >= end_ptr)
 213     {
 214       fptr = state;
 215       ++rptr;
 216     }
 217     else
 218     {
 219       ++rptr;
 220       if (rptr >= end_ptr)
 221         rptr = state;
 222     }
 223     return i;
 224   }
 225 }