lib/libc/stdlib/rand.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rand.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd May 25, 1999
  36 .Dt RAND 3
  37 .Os
  38 .Sh NAME
  39 .Nm rand ,
  40 .Nm srand ,
  41 .Nm sranddev ,
  42 .Nm rand_r
  43 .Nd bad random number generator
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In stdlib.h
  48 .Ft void
  49 .Fn srand "unsigned seed"
  50 .Ft void
  51 .Fn sranddev void
  52 .Ft int
  53 .Fn rand void
  54 .Ft int
  55 .Fn rand_r "unsigned *ctx"
  56 .Sh DESCRIPTION
  57 .Bf -symbolic
  58 These interfaces are obsoleted by
  59 .Xr random 3 .
  60 .Ef
  61 .Pp
  62 The
  63 .Fn rand
  64 function computes a sequence of pseudo-random integers in the range
  65 of 0 to
  66 .Dv RAND_MAX
  67 (as defined by the header file
  68 .In stdlib.h ) .
  69 .Pp
  70 The
  71 .Fn srand
  72 function sets its argument
  73 .Fa seed
  74 as the seed for a new sequence of
  75 pseudo-random numbers to be returned by
  76 .Fn rand .
  77 These sequences are repeatable by calling
  78 .Fn srand
  79 with the same seed value.
  80 .Pp
  81 If no
  82 .Fa seed
  83 value is provided, the functions are automatically
  84 seeded with a value of 1.
  85 .Pp
  86 The
  87 .Fn sranddev
  88 function initializes a seed using the
  89 .Xr random 4
  90 random number device which returns good random numbers.
  91 However, the
  92 .Fn rand
  93 function still remains unsuitable for cryptographic use.
  94 .Pp
  95 The
  96 .Fn rand_r
  97 function
  98 provides the same functionality as
  99 .Fn rand .
 100 A pointer to the context value
 101 .Fa ctx
 102 must be supplied by the caller.
 103 .Sh SEE ALSO
 104 .Xr random 3 ,
 105 .Xr random 4
 106 .Sh STANDARDS
 107 The
 108 .Fn rand
 109 and
 110 .Fn srand
 111 functions
 112 conform to
 113 .St -isoC .
 114 .Pp
 115 The
 116 .Fn rand_r
 117 function is as proposed in the POSIX.4a Draft #6 document.