lib/libc/stdlib/random.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd February 1, 2020
  29 .Dt RANDOM 3
  30 .Os
  31 .Sh NAME
  32 .Nm random ,
  33 .Nm srandom ,
  34 .Nm srandomdev ,
  35 .Nm initstate ,
  36 .Nm setstate
  37 .Nd non-cryptographic pseudorandom number generator; routines for changing generators
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In stdlib.h
  42 .Ft long
  43 .Fn random void
  44 .Ft void
  45 .Fn srandom "unsigned int seed"
  46 .Ft void
  47 .Fn srandomdev void
  48 .Ft char *
  49 .Fn initstate "unsigned int seed" "char *state" "size_t n"
  50 .Ft char *
  51 .Fn setstate "char *state"
  52 .Sh DESCRIPTION
  53 .Bf -symbolic
  54 The functions described in this manual page are not secure.
  55 Applications which require unpredictable random numbers should use
  56 .Xr arc4random 3
  57 instead.
  58 .Ef
  59 .Pp
  60 Unless initialized with less than 32 bytes of state, the
  61 .Fn random
  62 function
  63 uses a non-linear additive feedback random number generator employing a
  64 default table of size 31 long integers to return successive pseudo-random
  65 numbers in the range from 0 to
  66 .if t 2\u\s731\s10\d\(mi1.
  67 .if n (2**31)\(mi1.
  68 The period of this random number generator is very large, approximately
  69 .if t 16\(mu(2\u\s731\s10\d\(mi1).
  70 .if n 16*((2**31)\(mi1).
  71 .Pp
  72 If initialized with less than 32 bytes of state,
  73 .Fn random
  74 uses the poor-quality 32-bit Park-Miller LCG.
  75 .Pp
  76 The
  77 .Fn random
  78 and
  79 .Fn srandom
  80 functions are analagous to
  81 .Xr rand 3
  82 and
  83 .Xr srand 3 .
  84 .Pp
  85 Like
  86 .Xr rand 3 ,
  87 .Fn random
  88 is implicitly initialized as if
  89 .Fn srandom "1"
  90 had been invoked explicitly.
  91 .Pp
  92 The
  93 .Fn srandomdev
  94 routine initializes the state array using random numbers obtained from the
  95 kernel.
  96 This can generate states which are impossible to reproduce by calling
  97 .Fn srandom ,
  98 because the succeeding terms in the state buffer are no longer derived from the
  99 Park-Miller LCG algorithm applied to a fixed seed.
 100 .Pp
 101 The
 102 .Fn initstate
 103 routine initializes the provided state array of
 104 .Vt uint32_t
 105 values and uses it in future
 106 .Fn random
 107 invocations.
 108 (Despite the
 109 .Vt char *
 110 type of
 111 .Fa state ,
 112 the underlying object must be a naturally aligned array of 32-bit values.)
 113 The size of the state array (in bytes) is used by
 114 .Fn initstate
 115 to decide how sophisticated a random number generator it should use \(em the
 116 more state, the better the random numbers will be.
 117 (Current "optimal" values for the amount of state information are
 118 8, 32, 64, 128, and 256 bytes; other amounts will be rounded down to
 119 the nearest known amount.
 120 Using less than 8 bytes will cause an error.)
 121 The
 122 .Fa seed
 123 is used as in
 124 .Fn srandom .
 125 The
 126 .Fn initstate
 127 function
 128 returns a pointer to the previous state information array.
 129 .Pp
 130 The
 131 .Fn setstate
 132 routine switches
 133 .Fn random
 134 to using the provided state.
 135 It returns a pointer to the previous state.
 136 .Pp
 137 Once a state array has been initialized, it may be restarted at a
 138 different point either by calling
 139 .Fn initstate
 140 (with the desired seed, the state array, and its size) or by calling
 141 both
 142 .Fn setstate
 143 (with the state array) and
 144 .Fn srandom
 145 (with the desired seed).
 146 The advantage of calling both
 147 .Fn setstate
 148 and
 149 .Fn srandom
 150 is that the size of the state array does not have to be remembered after
 151 it is initialized.
 152 .Pp
 153 With 256 bytes of state information, the period of the random number
 154 generator is greater than
 155 .if t 2\u\s769\s10\d,
 156 .if n 2**69
 157 which should be sufficient for most purposes.
 158 .Sh DIAGNOSTICS
 159 If
 160 .Fn initstate
 161 is called with less than 8 bytes of state information, or if
 162 .Fn setstate
 163 detects that the state information has been garbled,
 164 NULL is returned.
 165 .Sh SEE ALSO
 166 .Xr arc4random 3 ,
 167 .Xr lrand48 3 ,
 168 .Xr rand 3 ,
 169 .Xr random 4
 170 .Sh HISTORY
 171 These
 172 functions appeared in
 173 .Bx 4.2 .
 174 .Sh AUTHORS
 175 .An Earl T. Cohen