blob: ed5c3838780de5ba9509071bef56e8d521dc5782 [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>
Daniel Borkmann897ece52015-10-08 01:20:38 +020010#include <linux/once.h>
11
David Howells607ca462012-10-13 10:46:48 +010012#include <uapi/linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
Herbert Xu205a5252015-06-09 18:19:39 +080014struct random_ready_callback {
15 struct list_head list;
16 void (*func)(struct random_ready_callback *rdy);
17 struct module *owner;
18};
19
Linus Torvaldsa2080a62012-07-04 11:16:01 -040020extern void add_device_randomness(const void *, unsigned int);
Emese Revfy38addce2016-06-20 20:41:19 +020021
22#if defined(CONFIG_GCC_PLUGIN_LATENT_ENTROPY) && !defined(__CHECKER__)
23static inline void add_latent_entropy(void)
24{
25 add_device_randomness((const void *)&latent_entropy,
26 sizeof(latent_entropy));
27}
28#else
29static inline void add_latent_entropy(void) {}
30#endif
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032extern void add_input_randomness(unsigned int type, unsigned int code,
Emese Revfy0766f782016-06-20 20:42:34 +020033 unsigned int value) __latent_entropy;
34extern void add_interrupt_randomness(int irq, int irq_flags) __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36extern void get_random_bytes(void *buf, int nbytes);
Herbert Xu205a5252015-06-09 18:19:39 +080037extern int add_random_ready_callback(struct random_ready_callback *rdy);
38extern void del_random_ready_callback(struct random_ready_callback *rdy);
Theodore Ts'oc2557a32012-07-05 10:35:23 -040039extern void get_random_bytes_arch(void *buf, int nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#ifndef MODULE
Arjan van de Ven54047322007-02-12 00:55:28 -080042extern const struct file_operations random_fops, urandom_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#endif
44
Jason A. Donenfeldc4404082017-01-22 16:34:08 +010045u32 get_random_u32(void);
46u64 get_random_u64(void);
47static inline unsigned int get_random_int(void)
48{
49 return get_random_u32();
50}
51static inline unsigned long get_random_long(void)
52{
53#if BITS_PER_LONG == 64
54 return get_random_u64();
55#else
56 return get_random_u32();
57#endif
58}
59
Jason Cooper99fdafd2016-10-11 13:53:52 -070060unsigned long randomize_page(unsigned long start, unsigned long range);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Akinobu Mita496f2f92012-12-17 16:04:23 -080062u32 prandom_u32(void);
Daniel Borkmanna98406e2014-08-23 17:03:28 +020063void prandom_bytes(void *buf, size_t nbytes);
Akinobu Mita496f2f92012-12-17 16:04:23 -080064void prandom_seed(u32 seed);
Hannes Frederic Sowa4af712e2013-11-11 12:20:34 +010065void prandom_reseed_late(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -070066
Daniel Borkmann38e9efc2013-11-11 12:20:35 +010067struct rnd_state {
Daniel Borkmanna98814c2013-11-11 12:20:36 +010068 __u32 s1, s2, s3, s4;
Daniel Borkmann38e9efc2013-11-11 12:20:35 +010069};
70
Daniel Borkmanna98814c2013-11-11 12:20:36 +010071u32 prandom_u32_state(struct rnd_state *state);
Daniel Borkmanna98406e2014-08-23 17:03:28 +020072void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes);
Daniel Borkmann897ece52015-10-08 01:20:38 +020073void prandom_seed_full_state(struct rnd_state __percpu *pcpu_state);
74
75#define prandom_init_once(pcpu_state) \
76 DO_ONCE(prandom_seed_full_state, (pcpu_state))
Joe Eykholt59601642010-05-26 14:44:13 -070077
Daniel Borkmannf337db62014-01-22 02:29:39 +010078/**
79 * prandom_u32_max - returns a pseudo-random number in interval [0, ep_ro)
80 * @ep_ro: right open interval endpoint
81 *
82 * Returns a pseudo-random number that is in interval [0, ep_ro). Note
83 * that the result depends on PRNG being well distributed in [0, ~0U]
84 * u32 space. Here we use maximally equidistributed combined Tausworthe
85 * generator, that is, prandom_u32(). This is useful when requesting a
86 * random index of an array containing ep_ro elements, for example.
87 *
88 * Returns: pseudo-random number in interval [0, ep_ro)
89 */
90static inline u32 prandom_u32_max(u32 ep_ro)
91{
92 return (u32)(((u64) prandom_u32() * ep_ro) >> 32);
93}
94
Joe Eykholt59601642010-05-26 14:44:13 -070095/*
96 * Handle minimum values for seeds
97 */
98static inline u32 __seed(u32 x, u32 m)
99{
100 return (x < m) ? x + m : x;
101}
102
103/**
Akinobu Mita496f2f92012-12-17 16:04:23 -0800104 * prandom_seed_state - set seed for prandom_u32_state().
Joe Eykholt59601642010-05-26 14:44:13 -0700105 * @state: pointer to state structure to receive the seed.
106 * @seed: arbitrary 64-bit value to use as a seed.
107 */
Akinobu Mita496f2f92012-12-17 16:04:23 -0800108static inline void prandom_seed_state(struct rnd_state *state, u64 seed)
Joe Eykholt59601642010-05-26 14:44:13 -0700109{
110 u32 i = (seed >> 32) ^ (seed << 10) ^ seed;
111
Daniel Borkmanna98814c2013-11-11 12:20:36 +0100112 state->s1 = __seed(i, 2U);
113 state->s2 = __seed(i, 8U);
114 state->s3 = __seed(i, 16U);
115 state->s4 = __seed(i, 128U);
Joe Eykholt59601642010-05-26 14:44:13 -0700116}
117
H. Peter Anvin63d77172011-07-31 13:54:50 -0700118#ifdef CONFIG_ARCH_RANDOM
119# include <asm/archrandom.h>
120#else
H. Peter Anvin117780e2016-06-08 12:38:38 -0700121static inline bool arch_get_random_long(unsigned long *v)
H. Peter Anvin63d77172011-07-31 13:54:50 -0700122{
123 return 0;
124}
H. Peter Anvin117780e2016-06-08 12:38:38 -0700125static inline bool arch_get_random_int(unsigned int *v)
H. Peter Anvin63d77172011-07-31 13:54:50 -0700126{
127 return 0;
128}
H. Peter Anvin117780e2016-06-08 12:38:38 -0700129static inline bool arch_has_random(void)
H. Peter Anvin7b878d42014-03-17 16:36:30 -0700130{
131 return 0;
132}
H. Peter Anvin117780e2016-06-08 12:38:38 -0700133static inline bool arch_get_random_seed_long(unsigned long *v)
H. Peter Anvind20f78d2014-03-17 16:36:27 -0700134{
135 return 0;
136}
H. Peter Anvin117780e2016-06-08 12:38:38 -0700137static inline bool arch_get_random_seed_int(unsigned int *v)
H. Peter Anvind20f78d2014-03-17 16:36:27 -0700138{
139 return 0;
140}
H. Peter Anvin117780e2016-06-08 12:38:38 -0700141static inline bool arch_has_random_seed(void)
H. Peter Anvin7b878d42014-03-17 16:36:30 -0700142{
143 return 0;
144}
H. Peter Anvin63d77172011-07-31 13:54:50 -0700145#endif
146
Tom Herbert055dc212013-01-22 09:49:50 +0000147/* Pseudo random number generator from numerical recipes. */
148static inline u32 next_pseudo_random32(u32 seed)
149{
150 return seed * 1664525 + 1013904223;
151}
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#endif /* _LINUX_RANDOM_H */