blob: 30e2aca0b16af61e836de501b564bed2917be270 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * include/linux/random.h
3 *
4 * Include file for the random number generator.
5 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#ifndef _LINUX_RANDOM_H
7#define _LINUX_RANDOM_H
8
Herbert Xu205a5252015-06-09 18:19:39 +08009#include <linux/list.h>
David Howells607ca462012-10-13 10:46:48 +010010#include <uapi/linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Herbert Xu205a5252015-06-09 18:19:39 +080012struct random_ready_callback {
13 struct list_head list;
14 void (*func)(struct random_ready_callback *rdy);
15 struct module *owner;
16};
17
Linus Torvaldsa2080a62012-07-04 11:16:01 -040018extern void add_device_randomness(const void *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070019extern void add_input_randomness(unsigned int type, unsigned int code,
20 unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -040021extern void add_interrupt_randomness(int irq, int irq_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23extern void get_random_bytes(void *buf, int nbytes);
Stephan Mueller16b369a2015-05-25 15:08:47 +020024extern void get_blocking_random_bytes(void *buf, int nbytes);
Herbert Xu205a5252015-06-09 18:19:39 +080025extern int add_random_ready_callback(struct random_ready_callback *rdy);
26extern void del_random_ready_callback(struct random_ready_callback *rdy);
Theodore Ts'oc2557a32012-07-05 10:35:23 -040027extern void get_random_bytes_arch(void *buf, int nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -070028void generate_random_uuid(unsigned char uuid_out[16]);
Theodore Ts'o47d06e52013-09-10 10:52:35 -040029extern int random_int_secret_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#ifndef MODULE
Arjan van de Ven54047322007-02-12 00:55:28 -080032extern const struct file_operations random_fops, urandom_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#endif
34
35unsigned int get_random_int(void);
36unsigned long randomize_range(unsigned long start, unsigned long end, unsigned long len);
37
Akinobu Mita496f2f92012-12-17 16:04:23 -080038u32 prandom_u32(void);
Daniel Borkmanna98406e2014-08-23 17:03:28 +020039void prandom_bytes(void *buf, size_t nbytes);
Akinobu Mita496f2f92012-12-17 16:04:23 -080040void prandom_seed(u32 seed);
Hannes Frederic Sowa4af712e2013-11-11 12:20:34 +010041void prandom_reseed_late(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -070042
Daniel Borkmann38e9efc2013-11-11 12:20:35 +010043struct rnd_state {
Daniel Borkmanna98814c2013-11-11 12:20:36 +010044 __u32 s1, s2, s3, s4;
Daniel Borkmann38e9efc2013-11-11 12:20:35 +010045};
46
Daniel Borkmanna98814c2013-11-11 12:20:36 +010047u32 prandom_u32_state(struct rnd_state *state);
Daniel Borkmanna98406e2014-08-23 17:03:28 +020048void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes);
Joe Eykholt59601642010-05-26 14:44:13 -070049
Daniel Borkmannf337db62014-01-22 02:29:39 +010050/**
51 * prandom_u32_max - returns a pseudo-random number in interval [0, ep_ro)
52 * @ep_ro: right open interval endpoint
53 *
54 * Returns a pseudo-random number that is in interval [0, ep_ro). Note
55 * that the result depends on PRNG being well distributed in [0, ~0U]
56 * u32 space. Here we use maximally equidistributed combined Tausworthe
57 * generator, that is, prandom_u32(). This is useful when requesting a
58 * random index of an array containing ep_ro elements, for example.
59 *
60 * Returns: pseudo-random number in interval [0, ep_ro)
61 */
62static inline u32 prandom_u32_max(u32 ep_ro)
63{
64 return (u32)(((u64) prandom_u32() * ep_ro) >> 32);
65}
66
Joe Eykholt59601642010-05-26 14:44:13 -070067/*
68 * Handle minimum values for seeds
69 */
70static inline u32 __seed(u32 x, u32 m)
71{
72 return (x < m) ? x + m : x;
73}
74
75/**
Akinobu Mita496f2f92012-12-17 16:04:23 -080076 * prandom_seed_state - set seed for prandom_u32_state().
Joe Eykholt59601642010-05-26 14:44:13 -070077 * @state: pointer to state structure to receive the seed.
78 * @seed: arbitrary 64-bit value to use as a seed.
79 */
Akinobu Mita496f2f92012-12-17 16:04:23 -080080static inline void prandom_seed_state(struct rnd_state *state, u64 seed)
Joe Eykholt59601642010-05-26 14:44:13 -070081{
82 u32 i = (seed >> 32) ^ (seed << 10) ^ seed;
83
Daniel Borkmanna98814c2013-11-11 12:20:36 +010084 state->s1 = __seed(i, 2U);
85 state->s2 = __seed(i, 8U);
86 state->s3 = __seed(i, 16U);
87 state->s4 = __seed(i, 128U);
Joe Eykholt59601642010-05-26 14:44:13 -070088}
89
H. Peter Anvin63d77172011-07-31 13:54:50 -070090#ifdef CONFIG_ARCH_RANDOM
91# include <asm/archrandom.h>
92#else
93static inline int arch_get_random_long(unsigned long *v)
94{
95 return 0;
96}
97static inline int arch_get_random_int(unsigned int *v)
98{
99 return 0;
100}
H. Peter Anvin7b878d42014-03-17 16:36:30 -0700101static inline int arch_has_random(void)
102{
103 return 0;
104}
H. Peter Anvind20f78d2014-03-17 16:36:27 -0700105static inline int arch_get_random_seed_long(unsigned long *v)
106{
107 return 0;
108}
109static inline int arch_get_random_seed_int(unsigned int *v)
110{
111 return 0;
112}
H. Peter Anvin7b878d42014-03-17 16:36:30 -0700113static inline int arch_has_random_seed(void)
114{
115 return 0;
116}
H. Peter Anvin63d77172011-07-31 13:54:50 -0700117#endif
118
Tom Herbert055dc212013-01-22 09:49:50 +0000119/* Pseudo random number generator from numerical recipes. */
120static inline u32 next_pseudo_random32(u32 seed)
121{
122 return seed * 1664525 + 1013904223;
123}
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#endif /* _LINUX_RANDOM_H */