man3/rand.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\"
  30 .\" Modified 1993-03-29, David Metcalfe
  31 .\" Modified 1993-04-28, Lars Wirzenius
  32 .\" Modified 1993-07-24, Rik Faith (faith@cs.unc.edu)
  33 .\" Modified 1995-05-18, Rik Faith (faith@cs.unc.edu) to add
  34 .\"          better discussion of problems with rand on other systems.
  35 .\"          (Thanks to Esa Hyyti{ (ehyytia@snakemail.hut.fi).)
  36 .\" Modified 1998-04-10, Nicolás Lichtmaier <nick@debian.org>
  37 .\"          with contribution from Francesco Potorti <F.Potorti@cnuce.cnr.it>
  38 .\" Modified 2003-11-15, aeb, added rand_r
  39 .\" 2010-09-13, mtk, added example program
  40 .\"
  41 .TH RAND 3 2021-03-22 "" "Linux Programmer's Manual"
  42 .SH NAME
  43 rand, rand_r, srand \- pseudo-random number generator
  44 .SH SYNOPSIS
  45 .nf
  46 .B #include <stdlib.h>
  47 .PP
  48 .B int rand(void);
  49 .BI "int rand_r(unsigned int *" seedp );
  50 .BI "void srand(unsigned int " seed );
  51 .fi
  52 .PP
  53 .RS -4
  54 Feature Test Macro Requirements for glibc (see
  55 .BR feature_test_macros (7)):
  56 .RE
  57 .PP
  58 .BR rand_r ():
  59 .nf
  60     Since glibc 2.24:
  61         _POSIX_C_SOURCE >= 199506L
  62     Glibc 2.23 and earlier
  63         _POSIX_C_SOURCE
  64 .fi
  65 .SH DESCRIPTION
  66 The
  67 .BR rand ()
  68 function returns a pseudo-random integer in the range 0 to
  69 .BR RAND_MAX
  70 inclusive (i.e., the mathematical range [0,\ \fBRAND_MAX\fR]).
  71 .PP
  72 The
  73 .BR srand ()
  74 function sets its argument as the seed for a new
  75 sequence of pseudo-random integers to be returned by
  76 .BR rand ().
  77 These sequences are repeatable by calling
  78 .BR srand ()
  79 with the same seed value.
  80 .PP
  81 If no seed value is provided, the
  82 .BR rand ()
  83 function is automatically seeded with a value of 1.
  84 .PP
  85 The function
  86 .BR rand ()
  87 is not reentrant, since it
  88 uses hidden state that is modified on each call.
  89 This might just be the seed value to be used by the next call,
  90 or it might be something more elaborate.
  91 In order to get reproducible behavior in a threaded
  92 application, this state must be made explicit;
  93 this can be done using the reentrant function
  94 .BR rand_r ().
  95 .PP
  96 Like
  97 .BR rand (),
  98 .BR rand_r ()
  99 returns a pseudo-random integer in the range [0,\ \fBRAND_MAX\fR].
 100 The
 101 .I seedp
 102 argument is a pointer to an
 103 .IR "unsigned int"
 104 that is used to store state between calls.
 105 If
 106 .BR rand_r ()
 107 is called with the same initial value for the integer pointed to by
 108 .IR seedp ,
 109 and that value is not modified between calls,
 110 then the same pseudo-random sequence will result.
 111 .PP
 112 The value pointed to by the
 113 .I seedp
 114 argument of
 115 .BR rand_r ()
 116 provides only a very small amount of state,
 117 so this function will be a weak pseudo-random generator.
 118 Try
 119 .BR drand48_r (3)
 120 instead.
 121 .SH RETURN VALUE
 122 The
 123 .BR rand ()
 124 and
 125 .BR rand_r ()
 126 functions return a value between 0 and
 127 .BR RAND_MAX
 128 (inclusive).
 129 The
 130 .BR srand ()
 131 function returns no value.
 132 .SH ATTRIBUTES
 133 For an explanation of the terms used in this section, see
 134 .BR attributes (7).
 135 .ad l
 136 .nh
 137 .TS
 138 allbox;
 139 lbx lb lb
 140 l l l.
 141 Interface       Attribute       Value
 142 T{
 143 .BR rand (),
 144 .BR rand_r (),
 145 .BR srand ()
 146 T}      Thread safety   MT-Safe
 147 .TE
 148 .hy
 149 .ad
 150 .sp 1
 151 .SH CONFORMING TO
 152 The functions
 153 .BR rand ()
 154 and
 155 .BR srand ()
 156 conform to SVr4, 4.3BSD, C89, C99, POSIX.1-2001.
 157 The function
 158 .BR rand_r ()
 159 is from POSIX.1-2001.
 160 POSIX.1-2008 marks
 161 .BR rand_r ()
 162 as obsolete.
 163 .SH NOTES
 164 The versions of
 165 .BR rand ()
 166 and
 167 .BR srand ()
 168 in the Linux C Library use the same random number generator as
 169 .BR random (3)
 170 and
 171 .BR srandom (3),
 172 so the lower-order bits should be as random as the higher-order bits.
 173 However, on older
 174 .BR rand ()
 175 implementations, and on current implementations on different systems,
 176 the lower-order bits are much less random than the higher-order bits.
 177 Do not use this function in applications intended to be portable
 178 when good randomness is needed.
 179 (Use
 180 .BR random (3)
 181 instead.)
 182 .SH EXAMPLES
 183 POSIX.1-2001 gives the following example of an implementation of
 184 .BR rand ()
 185 and
 186 .BR srand (),
 187 possibly useful when one needs the same sequence on two different machines.
 188 .PP
 189 .in +4n
 190 .EX
 191 static unsigned long next = 1;
 192
 193 /* RAND_MAX assumed to be 32767 */
 194 int myrand(void) {
 195     next = next * 1103515245 + 12345;
 196     return((unsigned)(next/65536) % 32768);
 197 }
 198
 199 void mysrand(unsigned int seed) {
 200     next = seed;
 201 }
 202 .EE
 203 .in
 204 .PP
 205 The following program can be used to display the
 206 pseudo-random sequence produced by
 207 .BR rand ()
 208 when given a particular seed.
 209 .PP
 210 .in +4n
 211 .EX
 212 #include <stdlib.h>
 213 #include <stdio.h>
 214
 215 int
 216 main(int argc, char *argv[])
 217 {
 218     int r, nloops;
 219     unsigned int seed;
 220
 221     if (argc != 3) {
 222         fprintf(stderr, "Usage: %s <seed> <nloops>\en", argv[0]);
 223         exit(EXIT_FAILURE);
 224     }
 225
 226     seed = atoi(argv[1]);
 227     nloops = atoi(argv[2]);
 228
 229     srand(seed);
 230     for (int j = 0; j < nloops; j++) {
 231         r =  rand();
 232         printf("%d\en", r);
 233     }
 234
 235     exit(EXIT_SUCCESS);
 236 }
 237 .EE
 238 .in
 239 .SH SEE ALSO
 240 .BR drand48 (3),
 241 .BR random (3)