Copyright 2008 Michael Kerrisk <email@example.com> %%%LICENSE_START(VERBATIM) Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Sin...
NAMErandom_r, srandom_r, initstate_r, setstate_r - reentrant random number generator
#include <stdlib.h> int random_r(struct random_data *buf, int32_t *result); int srandom_r(unsigned int seed, struct random_data *buf); int initstate_r(unsigned int seed, char *statebuf, size_t statelen, struct random_data *buf);
int setstate_r(char *statebuf, struct random_data *buf);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
random_r(), srandom_r(), initstate_r(), setstate_r():
- _SVID_SOURCE || _BSD_SOURCE
DESCRIPTIONThese functions are the reentrant equivalents of the functions described in random(3). They are suitable for use in multithreaded programs where each thread needs to obtain an independent, reproducible sequence of random numbers.
The random_r() function is like random(3), except that instead of using state information maintained in a global variable, it uses the state information in the argument pointed to by buf, which must have been previously initialized by initstate_r(). The generated random number is returned in the argument result.
The srandom_r() function is like srandom(3), except that it initializes the seed for the random number generator whose state is maintained in the object pointed to by buf, which must have been previously initialized by initstate_r(), instead of the seed associated with the global state variable.
The initstate_r() function is like initstate(3) except that it initializes the state in the object pointed to by buf, rather than initializing the global state variable.
The setstate_r() function is like setstate(3) except that it modifies the state in the object pointer to by buf, rather than modifying the global state variable.
RETURN VALUEAll of these functions return 0 on success. On error, -1 is returned, with errno set to indicate the cause of the error.
- A state array of less than 8 bytes was specified to initstate_r().
- The statebuf or buf argument to setstate_r() was NULL.
- The buf or result argument to random_r() was NULL.
ATTRIBUTESFor an explanation of the terms used in this section, see attributes(7).
|Thread safety||MT-Safe race:buf|