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 .\" 3. 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: src/lib/libc/stdlib/rand.3,v 1.16 2007/01/09 00:28:10 imp Exp $
  34 .\" $DragonFly: src/lib/libc/stdlib/rand.3,v 1.6 2007/06/29 19:34:41 swildner Exp $
  35 .\"
  36 .Dd May 25, 1999
  37 .Dt RAND 3
  38 .Os
  39 .Sh NAME
  40 .Nm rand ,
  41 .Nm srand ,
  42 .Nm sranddev ,
  43 .Nm rand_r
  44 .Nd bad random number generator
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In stdlib.h
  49 .Ft void
  50 .Fn srand "unsigned seed"
  51 .Ft void
  52 .Fn sranddev void
  53 .Ft int
  54 .Fn rand void
  55 .Ft int
  56 .Fn rand_r "unsigned *ctx"
  57 .Sh DESCRIPTION
  58 .Bf -symbolic
  59 These interfaces are obsoleted by
  60 .Xr random 3 .
  61 .Ef
  62 .Pp
  63 The
  64 .Fn rand
  65 function computes a sequence of pseudo-random integers in the range
  66 of 0 to
  67 .Dv RAND_MAX
  68 (as defined by the header file
  69 .In stdlib.h ) .
  70 .Pp
  71 The
  72 .Fn srand
  73 function sets its argument
  74 .Fa seed
  75 as the seed for a new sequence of
  76 pseudo-random numbers to be returned by
  77 .Fn rand .
  78 These sequences are repeatable by calling
  79 .Fn srand
  80 with the same seed value.
  81 .Pp
  82 If no
  83 .Fa seed
  84 value is provided, the functions are automatically
  85 seeded with a value of 1.
  86 .Pp
  87 The
  88 .Fn sranddev
  89 function initializes a seed using the
  90 .Xr random 4
  91 random number device which returns good random numbers.
  92 However, the
  93 .Fn rand
  94 function still remains unsuitable for cryptographic use.
  95 .Pp
  96 The
  97 .Fn rand_r
  98 function
  99 provides the same functionality as
 100 .Fn rand .
 101 A pointer to the context value
 102 .Fa ctx
 103 must be supplied by the caller.
 104 .Sh SEE ALSO
 105 .Xr arc4random 3 ,
 106 .Xr random 3 ,
 107 .Xr random 4
 108 .Sh STANDARDS
 109 The
 110 .Fn rand
 111 and
 112 .Fn srand
 113 functions
 114 conform to
 115 .St -isoC .
 116 .Pp
 117 The
 118 .Fn rand_r
 119 function is as proposed in the POSIX.4a Draft #6 document.