Blame stdlib/random_r.c

Packit Service 82fcde
/*
Packit Service 82fcde
   Copyright (C) 1995-2018 Free Software Foundation, Inc.
Packit Service 82fcde
Packit Service 82fcde
   The GNU C Library is free software; you can redistribute it and/or
Packit Service 82fcde
   modify it under the terms of the GNU Lesser General Public
Packit Service 82fcde
   License as published by the Free Software Foundation; either
Packit Service 82fcde
   version 2.1 of the License, or (at your option) any later version.
Packit Service 82fcde
Packit Service 82fcde
   The GNU C Library is distributed in the hope that it will be useful,
Packit Service 82fcde
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 82fcde
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service 82fcde
   Lesser General Public License for more details.
Packit Service 82fcde
Packit Service 82fcde
   You should have received a copy of the GNU Lesser General Public
Packit Service 82fcde
   License along with the GNU C Library; if not, see
Packit Service 82fcde
   <http://www.gnu.org/licenses/>.  */
Packit Service 82fcde
Packit Service 82fcde
/*
Packit Service 82fcde
   Copyright (C) 1983 Regents of the University of California.
Packit Service 82fcde
   All rights reserved.
Packit Service 82fcde
Packit Service 82fcde
   Redistribution and use in source and binary forms, with or without
Packit Service 82fcde
   modification, are permitted provided that the following conditions
Packit Service 82fcde
   are met:
Packit Service 82fcde
Packit Service 82fcde
   1. Redistributions of source code must retain the above copyright
Packit Service 82fcde
      notice, this list of conditions and the following disclaimer.
Packit Service 82fcde
   2. Redistributions in binary form must reproduce the above copyright
Packit Service 82fcde
      notice, this list of conditions and the following disclaimer in the
Packit Service 82fcde
      documentation and/or other materials provided with the distribution.
Packit Service 82fcde
   4. Neither the name of the University nor the names of its contributors
Packit Service 82fcde
      may be used to endorse or promote products derived from this software
Packit Service 82fcde
      without specific prior written permission.
Packit Service 82fcde
Packit Service 82fcde
   THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
Packit Service 82fcde
   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Packit Service 82fcde
   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit Service 82fcde
   ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
Packit Service 82fcde
   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Packit Service 82fcde
   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
Packit Service 82fcde
   OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
Packit Service 82fcde
   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
Packit Service 82fcde
   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
Packit Service 82fcde
   OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
Packit Service 82fcde
   SUCH DAMAGE.*/
Packit Service 82fcde
Packit Service 82fcde
/*
Packit Service 82fcde
 * This is derived from the Berkeley source:
Packit Service 82fcde
 *	@(#)random.c	5.5 (Berkeley) 7/6/88
Packit Service 82fcde
 * It was reworked for the GNU C Library by Roland McGrath.
Packit Service 82fcde
 * Rewritten to be reentrant by Ulrich Drepper, 1995
Packit Service 82fcde
 */
Packit Service 82fcde
Packit Service 82fcde
#include <errno.h>
Packit Service 82fcde
#include <limits.h>
Packit Service 82fcde
#include <stddef.h>
Packit Service 82fcde
#include <stdlib.h>
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* An improved random number generation package.  In addition to the standard
Packit Service 82fcde
   rand()/srand() like interface, this package also has a special state info
Packit Service 82fcde
   interface.  The initstate() routine is called with a seed, an array of
Packit Service 82fcde
   bytes, and a count of how many bytes are being passed in; this array is
Packit Service 82fcde
   then initialized to contain information for random number generation with
Packit Service 82fcde
   that much state information.  Good sizes for the amount of state
Packit Service 82fcde
   information are 32, 64, 128, and 256 bytes.  The state can be switched by
Packit Service 82fcde
   calling the setstate() function with the same array as was initialized
Packit Service 82fcde
   with initstate().  By default, the package runs with 128 bytes of state
Packit Service 82fcde
   information and generates far better random numbers than a linear
Packit Service 82fcde
   congruential generator.  If the amount of state information is less than
Packit Service 82fcde
   32 bytes, a simple linear congruential R.N.G. is used.  Internally, the
Packit Service 82fcde
   state information is treated as an array of longs; the zeroth element of
Packit Service 82fcde
   the array is the type of R.N.G. being used (small integer); the remainder
Packit Service 82fcde
   of the array is the state information for the R.N.G.  Thus, 32 bytes of
Packit Service 82fcde
   state information will give 7 longs worth of state information, which will
Packit Service 82fcde
   allow a degree seven polynomial.  (Note: The zeroth word of state
Packit Service 82fcde
   information also has some other information stored in it; see setstate
Packit Service 82fcde
   for details).  The random number generation technique is a linear feedback
Packit Service 82fcde
   shift register approach, employing trinomials (since there are fewer terms
Packit Service 82fcde
   to sum up that way).  In this approach, the least significant bit of all
Packit Service 82fcde
   the numbers in the state table will act as a linear feedback shift register,
Packit Service 82fcde
   and will have period 2^deg - 1 (where deg is the degree of the polynomial
Packit Service 82fcde
   being used, assuming that the polynomial is irreducible and primitive).
Packit Service 82fcde
   The higher order bits will have longer periods, since their values are
Packit Service 82fcde
   also influenced by pseudo-random carries out of the lower bits.  The
Packit Service 82fcde
   total period of the generator is approximately deg*(2**deg - 1); thus
Packit Service 82fcde
   doubling the amount of state information has a vast influence on the
Packit Service 82fcde
   period of the generator.  Note: The deg*(2**deg - 1) is an approximation
Packit Service 82fcde
   only good for large deg, when the period of the shift register is the
Packit Service 82fcde
   dominant factor.  With deg equal to seven, the period is actually much
Packit Service 82fcde
   longer than the 7*(2**7 - 1) predicted by this formula.  */
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* For each of the currently supported random number generators, we have a
Packit Service 82fcde
   break value on the amount of state information (you need at least this many
Packit Service 82fcde
   bytes of state info to support this random number generator), a degree for
Packit Service 82fcde
   the polynomial (actually a trinomial) that the R.N.G. is based on, and
Packit Service 82fcde
   separation between the two lower order coefficients of the trinomial.  */
Packit Service 82fcde
Packit Service 82fcde
/* Linear congruential.  */
Packit Service 82fcde
#define	TYPE_0		0
Packit Service 82fcde
#define	BREAK_0		8
Packit Service 82fcde
#define	DEG_0		0
Packit Service 82fcde
#define	SEP_0		0
Packit Service 82fcde
Packit Service 82fcde
/* x**7 + x**3 + 1.  */
Packit Service 82fcde
#define	TYPE_1		1
Packit Service 82fcde
#define	BREAK_1		32
Packit Service 82fcde
#define	DEG_1		7
Packit Service 82fcde
#define	SEP_1		3
Packit Service 82fcde
Packit Service 82fcde
/* x**15 + x + 1.  */
Packit Service 82fcde
#define	TYPE_2		2
Packit Service 82fcde
#define	BREAK_2		64
Packit Service 82fcde
#define	DEG_2		15
Packit Service 82fcde
#define	SEP_2		1
Packit Service 82fcde
Packit Service 82fcde
/* x**31 + x**3 + 1.  */
Packit Service 82fcde
#define	TYPE_3		3
Packit Service 82fcde
#define	BREAK_3		128
Packit Service 82fcde
#define	DEG_3		31
Packit Service 82fcde
#define	SEP_3		3
Packit Service 82fcde
Packit Service 82fcde
/* x**63 + x + 1.  */
Packit Service 82fcde
#define	TYPE_4		4
Packit Service 82fcde
#define	BREAK_4		256
Packit Service 82fcde
#define	DEG_4		63
Packit Service 82fcde
#define	SEP_4		1
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* Array versions of the above information to make code run faster.
Packit Service 82fcde
   Relies on fact that TYPE_i == i.  */
Packit Service 82fcde
Packit Service 82fcde
#define	MAX_TYPES	5	/* Max number of types above.  */
Packit Service 82fcde
Packit Service 82fcde
struct random_poly_info
Packit Service 82fcde
{
Packit Service 82fcde
  int seps[MAX_TYPES];
Packit Service 82fcde
  int degrees[MAX_TYPES];
Packit Service 82fcde
};
Packit Service 82fcde
Packit Service 82fcde
static const struct random_poly_info random_poly_info =
Packit Service 82fcde
{
Packit Service 82fcde
  { SEP_0, SEP_1, SEP_2, SEP_3, SEP_4 },
Packit Service 82fcde
  { DEG_0, DEG_1, DEG_2, DEG_3, DEG_4 }
Packit Service 82fcde
};
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde

Packit Service 82fcde
/* Initialize the random number generator based on the given seed.  If the
Packit Service 82fcde
   type is the trivial no-state-information type, just remember the seed.
Packit Service 82fcde
   Otherwise, initializes state[] based on the given "seed" via a linear
Packit Service 82fcde
   congruential generator.  Then, the pointers are set to known locations
Packit Service 82fcde
   that are exactly rand_sep places apart.  Lastly, it cycles the state
Packit Service 82fcde
   information a given number of times to get rid of any initial dependencies
Packit Service 82fcde
   introduced by the L.C.R.N.G.  Note that the initialization of randtbl[]
Packit Service 82fcde
   for default usage relies on values produced by this routine.  */
Packit Service 82fcde
int
Packit Service 82fcde
__srandom_r (unsigned int seed, struct random_data *buf)
Packit Service 82fcde
{
Packit Service 82fcde
  int type;
Packit Service 82fcde
  int32_t *state;
Packit Service 82fcde
  long int i;
Packit Service 82fcde
  int32_t word;
Packit Service 82fcde
  int32_t *dst;
Packit Service 82fcde
  int kc;
Packit Service 82fcde
Packit Service 82fcde
  if (buf == NULL)
Packit Service 82fcde
    goto fail;
Packit Service 82fcde
  type = buf->rand_type;
Packit Service 82fcde
  if ((unsigned int) type >= MAX_TYPES)
Packit Service 82fcde
    goto fail;
Packit Service 82fcde
Packit Service 82fcde
  state = buf->state;
Packit Service 82fcde
  /* We must make sure the seed is not 0.  Take arbitrarily 1 in this case.  */
Packit Service 82fcde
  if (seed == 0)
Packit Service 82fcde
    seed = 1;
Packit Service 82fcde
  state[0] = seed;
Packit Service 82fcde
  if (type == TYPE_0)
Packit Service 82fcde
    goto done;
Packit Service 82fcde
Packit Service 82fcde
  dst = state;
Packit Service 82fcde
  word = seed;
Packit Service 82fcde
  kc = buf->rand_deg;
Packit Service 82fcde
  for (i = 1; i < kc; ++i)
Packit Service 82fcde
    {
Packit Service 82fcde
      /* This does:
Packit Service 82fcde
	   state[i] = (16807 * state[i - 1]) % 2147483647;
Packit Service 82fcde
	 but avoids overflowing 31 bits.  */
Packit Service 82fcde
      long int hi = word / 127773;
Packit Service 82fcde
      long int lo = word % 127773;
Packit Service 82fcde
      word = 16807 * lo - 2836 * hi;
Packit Service 82fcde
      if (word < 0)
Packit Service 82fcde
	word += 2147483647;
Packit Service 82fcde
      *++dst = word;
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
  buf->fptr = &state[buf->rand_sep];
Packit Service 82fcde
  buf->rptr = &state[0];
Packit Service 82fcde
  kc *= 10;
Packit Service 82fcde
  while (--kc >= 0)
Packit Service 82fcde
    {
Packit Service 82fcde
      int32_t discard;
Packit Service 82fcde
      (void) __random_r (buf, &discard);
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
 done:
Packit Service 82fcde
  return 0;
Packit Service 82fcde
Packit Service 82fcde
 fail:
Packit Service 82fcde
  return -1;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
weak_alias (__srandom_r, srandom_r)
Packit Service 82fcde

Packit Service 82fcde
/* Initialize the state information in the given array of N bytes for
Packit Service 82fcde
   future random number generation.  Based on the number of bytes we
Packit Service 82fcde
   are given, and the break values for the different R.N.G.'s, we choose
Packit Service 82fcde
   the best (largest) one we can and set things up for it.  srandom is
Packit Service 82fcde
   then called to initialize the state information.  Note that on return
Packit Service 82fcde
   from srandom, we set state[-1] to be the type multiplexed with the current
Packit Service 82fcde
   value of the rear pointer; this is so successive calls to initstate won't
Packit Service 82fcde
   lose this information and will be able to restart with setstate.
Packit Service 82fcde
   Note: The first thing we do is save the current state, if any, just like
Packit Service 82fcde
   setstate so that it doesn't matter when initstate is called.
Packit Service 82fcde
   Returns 0 on success, non-zero on failure.  */
Packit Service 82fcde
int
Packit Service 82fcde
__initstate_r (unsigned int seed, char *arg_state, size_t n,
Packit Service 82fcde
	       struct random_data *buf)
Packit Service 82fcde
{
Packit Service 82fcde
  if (buf == NULL)
Packit Service 82fcde
    goto fail;
Packit Service 82fcde
Packit Service 82fcde
  int32_t *old_state = buf->state;
Packit Service 82fcde
  if (old_state != NULL)
Packit Service 82fcde
    {
Packit Service 82fcde
      int old_type = buf->rand_type;
Packit Service 82fcde
      if (old_type == TYPE_0)
Packit Service 82fcde
	old_state[-1] = TYPE_0;
Packit Service 82fcde
      else
Packit Service 82fcde
	old_state[-1] = (MAX_TYPES * (buf->rptr - old_state)) + old_type;
Packit Service 82fcde
    }
Packit Service 82fcde
Packit Service 82fcde
  int type;
Packit Service 82fcde
  if (n >= BREAK_3)
Packit Service 82fcde
    type = n < BREAK_4 ? TYPE_3 : TYPE_4;
Packit Service 82fcde
  else if (n < BREAK_1)
Packit Service 82fcde
    {
Packit Service 82fcde
      if (n < BREAK_0)
Packit Service 82fcde
	goto fail;
Packit Service 82fcde
Packit Service 82fcde
      type = TYPE_0;
Packit Service 82fcde
    }
Packit Service 82fcde
  else
Packit Service 82fcde
    type = n < BREAK_2 ? TYPE_1 : TYPE_2;
Packit Service 82fcde
Packit Service 82fcde
  int degree = random_poly_info.degrees[type];
Packit Service 82fcde
  int separation = random_poly_info.seps[type];
Packit Service 82fcde
Packit Service 82fcde
  buf->rand_type = type;
Packit Service 82fcde
  buf->rand_sep = separation;
Packit Service 82fcde
  buf->rand_deg = degree;
Packit Service 82fcde
  int32_t *state = &((int32_t *) arg_state)[1];	/* First location.  */
Packit Service 82fcde
  /* Must set END_PTR before srandom.  */
Packit Service 82fcde
  buf->end_ptr = &state[degree];
Packit Service 82fcde
Packit Service 82fcde
  buf->state = state;
Packit Service 82fcde
Packit Service 82fcde
  __srandom_r (seed, buf);
Packit Service 82fcde
Packit Service 82fcde
  state[-1] = TYPE_0;
Packit Service 82fcde
  if (type != TYPE_0)
Packit Service 82fcde
    state[-1] = (buf->rptr - state) * MAX_TYPES + type;
Packit Service 82fcde
Packit Service 82fcde
  return 0;
Packit Service 82fcde
Packit Service 82fcde
 fail:
Packit Service 82fcde
  __set_errno (EINVAL);
Packit Service 82fcde
  return -1;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
weak_alias (__initstate_r, initstate_r)
Packit Service 82fcde

Packit Service 82fcde
/* Restore the state from the given state array.
Packit Service 82fcde
   Note: It is important that we also remember the locations of the pointers
Packit Service 82fcde
   in the current state information, and restore the locations of the pointers
Packit Service 82fcde
   from the old state information.  This is done by multiplexing the pointer
Packit Service 82fcde
   location into the zeroth word of the state information. Note that due
Packit Service 82fcde
   to the order in which things are done, it is OK to call setstate with the
Packit Service 82fcde
   same state as the current state
Packit Service 82fcde
   Returns 0 on success, non-zero on failure.  */
Packit Service 82fcde
int
Packit Service 82fcde
__setstate_r (char *arg_state, struct random_data *buf)
Packit Service 82fcde
{
Packit Service 82fcde
  int32_t *new_state = 1 + (int32_t *) arg_state;
Packit Service 82fcde
  int type;
Packit Service 82fcde
  int old_type;
Packit Service 82fcde
  int32_t *old_state;
Packit Service 82fcde
  int degree;
Packit Service 82fcde
  int separation;
Packit Service 82fcde
Packit Service 82fcde
  if (arg_state == NULL || buf == NULL)
Packit Service 82fcde
    goto fail;
Packit Service 82fcde
Packit Service 82fcde
  old_type = buf->rand_type;
Packit Service 82fcde
  old_state = buf->state;
Packit Service 82fcde
  if (old_type == TYPE_0)
Packit Service 82fcde
    old_state[-1] = TYPE_0;
Packit Service 82fcde
  else
Packit Service 82fcde
    old_state[-1] = (MAX_TYPES * (buf->rptr - old_state)) + old_type;
Packit Service 82fcde
Packit Service 82fcde
  type = new_state[-1] % MAX_TYPES;
Packit Service 82fcde
  if (type < TYPE_0 || type > TYPE_4)
Packit Service 82fcde
    goto fail;
Packit Service 82fcde
Packit Service 82fcde
  buf->rand_deg = degree = random_poly_info.degrees[type];
Packit Service 82fcde
  buf->rand_sep = separation = random_poly_info.seps[type];
Packit Service 82fcde
  buf->rand_type = type;
Packit Service 82fcde
Packit Service 82fcde
  if (type != TYPE_0)
Packit Service 82fcde
    {
Packit Service 82fcde
      int rear = new_state[-1] / MAX_TYPES;
Packit Service 82fcde
      buf->rptr = &new_state[rear];
Packit Service 82fcde
      buf->fptr = &new_state[(rear + separation) % degree];
Packit Service 82fcde
    }
Packit Service 82fcde
  buf->state = new_state;
Packit Service 82fcde
  /* Set end_ptr too.  */
Packit Service 82fcde
  buf->end_ptr = &new_state[degree];
Packit Service 82fcde
Packit Service 82fcde
  return 0;
Packit Service 82fcde
Packit Service 82fcde
 fail:
Packit Service 82fcde
  __set_errno (EINVAL);
Packit Service 82fcde
  return -1;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
weak_alias (__setstate_r, setstate_r)
Packit Service 82fcde

Packit Service 82fcde
/* If we are using the trivial TYPE_0 R.N.G., just do the old linear
Packit Service 82fcde
   congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
Packit Service 82fcde
   same in all the other cases due to all the global variables that have been
Packit Service 82fcde
   set up.  The basic operation is to add the number at the rear pointer into
Packit Service 82fcde
   the one at the front pointer.  Then both pointers are advanced to the next
Packit Service 82fcde
   location cyclically in the table.  The value returned is the sum generated,
Packit Service 82fcde
   reduced to 31 bits by throwing away the "least random" low bit.
Packit Service 82fcde
   Note: The code takes advantage of the fact that both the front and
Packit Service 82fcde
   rear pointers can't wrap on the same call by not testing the rear
Packit Service 82fcde
   pointer if the front one has wrapped.  Returns a 31-bit random number.  */
Packit Service 82fcde
Packit Service 82fcde
int
Packit Service 82fcde
__random_r (struct random_data *buf, int32_t *result)
Packit Service 82fcde
{
Packit Service 82fcde
  int32_t *state;
Packit Service 82fcde
Packit Service 82fcde
  if (buf == NULL || result == NULL)
Packit Service 82fcde
    goto fail;
Packit Service 82fcde
Packit Service 82fcde
  state = buf->state;
Packit Service 82fcde
Packit Service 82fcde
  if (buf->rand_type == TYPE_0)
Packit Service 82fcde
    {
Packit Service 82fcde
      int32_t val = ((state[0] * 1103515245U) + 12345U) & 0x7fffffff;
Packit Service 82fcde
      state[0] = val;
Packit Service 82fcde
      *result = val;
Packit Service 82fcde
    }
Packit Service 82fcde
  else
Packit Service 82fcde
    {
Packit Service 82fcde
      int32_t *fptr = buf->fptr;
Packit Service 82fcde
      int32_t *rptr = buf->rptr;
Packit Service 82fcde
      int32_t *end_ptr = buf->end_ptr;
Packit Service 82fcde
      uint32_t val;
Packit Service 82fcde
Packit Service 82fcde
      val = *fptr += (uint32_t) *rptr;
Packit Service 82fcde
      /* Chucking least random bit.  */
Packit Service 82fcde
      *result = val >> 1;
Packit Service 82fcde
      ++fptr;
Packit Service 82fcde
      if (fptr >= end_ptr)
Packit Service 82fcde
	{
Packit Service 82fcde
	  fptr = state;
Packit Service 82fcde
	  ++rptr;
Packit Service 82fcde
	}
Packit Service 82fcde
      else
Packit Service 82fcde
	{
Packit Service 82fcde
	  ++rptr;
Packit Service 82fcde
	  if (rptr >= end_ptr)
Packit Service 82fcde
	    rptr = state;
Packit Service 82fcde
	}
Packit Service 82fcde
      buf->fptr = fptr;
Packit Service 82fcde
      buf->rptr = rptr;
Packit Service 82fcde
    }
Packit Service 82fcde
  return 0;
Packit Service 82fcde
Packit Service 82fcde
 fail:
Packit Service 82fcde
  __set_errno (EINVAL);
Packit Service 82fcde
  return -1;
Packit Service 82fcde
}
Packit Service 82fcde
Packit Service 82fcde
weak_alias (__random_r, random_r)