Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * include/linux/random.h |
| 3 | * |
| 4 | * Include file for the random number generator. |
| 5 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | #ifndef _LINUX_RANDOM_H |
| 7 | #define _LINUX_RANDOM_H |
| 8 | |
Herbert Xu | 205a525 | 2015-06-09 18:19:39 +0800 | [diff] [blame] | 9 | #include <linux/list.h> |
Daniel Borkmann | 897ece5 | 2015-10-08 01:20:38 +0200 | [diff] [blame] | 10 | #include <linux/once.h> |
| 11 | |
David Howells | 607ca46 | 2012-10-13 10:46:48 +0100 | [diff] [blame] | 12 | #include <uapi/linux/random.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | |
Herbert Xu | 205a525 | 2015-06-09 18:19:39 +0800 | [diff] [blame] | 14 | struct random_ready_callback { |
| 15 | struct list_head list; |
| 16 | void (*func)(struct random_ready_callback *rdy); |
| 17 | struct module *owner; |
| 18 | }; |
| 19 | |
Linus Torvalds | a2080a6 | 2012-07-04 11:16:01 -0400 | [diff] [blame] | 20 | extern void add_device_randomness(const void *, unsigned int); |
Emese Revfy | 38addce | 2016-06-20 20:41:19 +0200 | [diff] [blame] | 21 | |
| 22 | #if defined(CONFIG_GCC_PLUGIN_LATENT_ENTROPY) && !defined(__CHECKER__) |
| 23 | static inline void add_latent_entropy(void) |
| 24 | { |
| 25 | add_device_randomness((const void *)&latent_entropy, |
| 26 | sizeof(latent_entropy)); |
| 27 | } |
| 28 | #else |
| 29 | static inline void add_latent_entropy(void) {} |
| 30 | #endif |
| 31 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | extern void add_input_randomness(unsigned int type, unsigned int code, |
Emese Revfy | 0766f78 | 2016-06-20 20:42:34 +0200 | [diff] [blame] | 33 | unsigned int value) __latent_entropy; |
| 34 | extern void add_interrupt_randomness(int irq, int irq_flags) __latent_entropy; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | |
| 36 | extern void get_random_bytes(void *buf, int nbytes); |
Herbert Xu | 205a525 | 2015-06-09 18:19:39 +0800 | [diff] [blame] | 37 | extern int add_random_ready_callback(struct random_ready_callback *rdy); |
| 38 | extern void del_random_ready_callback(struct random_ready_callback *rdy); |
Theodore Ts'o | c2557a3 | 2012-07-05 10:35:23 -0400 | [diff] [blame] | 39 | extern void get_random_bytes_arch(void *buf, int nbytes); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | #ifndef MODULE |
Arjan van de Ven | 5404732 | 2007-02-12 00:55:28 -0800 | [diff] [blame] | 42 | extern const struct file_operations random_fops, urandom_fops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | #endif |
| 44 | |
Jason A. Donenfeld | c440408 | 2017-01-22 16:34:08 +0100 | [diff] [blame] | 45 | u32 get_random_u32(void); |
| 46 | u64 get_random_u64(void); |
| 47 | static inline unsigned int get_random_int(void) |
| 48 | { |
| 49 | return get_random_u32(); |
| 50 | } |
| 51 | static 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 Cooper | 99fdafd | 2016-10-11 13:53:52 -0700 | [diff] [blame] | 60 | unsigned long randomize_page(unsigned long start, unsigned long range); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | |
Akinobu Mita | 496f2f9 | 2012-12-17 16:04:23 -0800 | [diff] [blame] | 62 | u32 prandom_u32(void); |
Daniel Borkmann | a98406e | 2014-08-23 17:03:28 +0200 | [diff] [blame] | 63 | void prandom_bytes(void *buf, size_t nbytes); |
Akinobu Mita | 496f2f9 | 2012-12-17 16:04:23 -0800 | [diff] [blame] | 64 | void prandom_seed(u32 seed); |
Hannes Frederic Sowa | 4af712e | 2013-11-11 12:20:34 +0100 | [diff] [blame] | 65 | void prandom_reseed_late(void); |
Stephen Hemminger | aaa248f | 2006-10-17 00:09:42 -0700 | [diff] [blame] | 66 | |
Daniel Borkmann | 38e9efc | 2013-11-11 12:20:35 +0100 | [diff] [blame] | 67 | struct rnd_state { |
Daniel Borkmann | a98814c | 2013-11-11 12:20:36 +0100 | [diff] [blame] | 68 | __u32 s1, s2, s3, s4; |
Daniel Borkmann | 38e9efc | 2013-11-11 12:20:35 +0100 | [diff] [blame] | 69 | }; |
| 70 | |
Daniel Borkmann | a98814c | 2013-11-11 12:20:36 +0100 | [diff] [blame] | 71 | u32 prandom_u32_state(struct rnd_state *state); |
Daniel Borkmann | a98406e | 2014-08-23 17:03:28 +0200 | [diff] [blame] | 72 | void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes); |
Daniel Borkmann | 897ece5 | 2015-10-08 01:20:38 +0200 | [diff] [blame] | 73 | void 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 Eykholt | 5960164 | 2010-05-26 14:44:13 -0700 | [diff] [blame] | 77 | |
Daniel Borkmann | f337db6 | 2014-01-22 02:29:39 +0100 | [diff] [blame] | 78 | /** |
| 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 | */ |
| 90 | static inline u32 prandom_u32_max(u32 ep_ro) |
| 91 | { |
| 92 | return (u32)(((u64) prandom_u32() * ep_ro) >> 32); |
| 93 | } |
| 94 | |
Joe Eykholt | 5960164 | 2010-05-26 14:44:13 -0700 | [diff] [blame] | 95 | /* |
| 96 | * Handle minimum values for seeds |
| 97 | */ |
| 98 | static inline u32 __seed(u32 x, u32 m) |
| 99 | { |
| 100 | return (x < m) ? x + m : x; |
| 101 | } |
| 102 | |
| 103 | /** |
Akinobu Mita | 496f2f9 | 2012-12-17 16:04:23 -0800 | [diff] [blame] | 104 | * prandom_seed_state - set seed for prandom_u32_state(). |
Joe Eykholt | 5960164 | 2010-05-26 14:44:13 -0700 | [diff] [blame] | 105 | * @state: pointer to state structure to receive the seed. |
| 106 | * @seed: arbitrary 64-bit value to use as a seed. |
| 107 | */ |
Akinobu Mita | 496f2f9 | 2012-12-17 16:04:23 -0800 | [diff] [blame] | 108 | static inline void prandom_seed_state(struct rnd_state *state, u64 seed) |
Joe Eykholt | 5960164 | 2010-05-26 14:44:13 -0700 | [diff] [blame] | 109 | { |
| 110 | u32 i = (seed >> 32) ^ (seed << 10) ^ seed; |
| 111 | |
Daniel Borkmann | a98814c | 2013-11-11 12:20:36 +0100 | [diff] [blame] | 112 | state->s1 = __seed(i, 2U); |
| 113 | state->s2 = __seed(i, 8U); |
| 114 | state->s3 = __seed(i, 16U); |
| 115 | state->s4 = __seed(i, 128U); |
Joe Eykholt | 5960164 | 2010-05-26 14:44:13 -0700 | [diff] [blame] | 116 | } |
| 117 | |
H. Peter Anvin | 63d7717 | 2011-07-31 13:54:50 -0700 | [diff] [blame] | 118 | #ifdef CONFIG_ARCH_RANDOM |
| 119 | # include <asm/archrandom.h> |
| 120 | #else |
H. Peter Anvin | 117780e | 2016-06-08 12:38:38 -0700 | [diff] [blame] | 121 | static inline bool arch_get_random_long(unsigned long *v) |
H. Peter Anvin | 63d7717 | 2011-07-31 13:54:50 -0700 | [diff] [blame] | 122 | { |
| 123 | return 0; |
| 124 | } |
H. Peter Anvin | 117780e | 2016-06-08 12:38:38 -0700 | [diff] [blame] | 125 | static inline bool arch_get_random_int(unsigned int *v) |
H. Peter Anvin | 63d7717 | 2011-07-31 13:54:50 -0700 | [diff] [blame] | 126 | { |
| 127 | return 0; |
| 128 | } |
H. Peter Anvin | 117780e | 2016-06-08 12:38:38 -0700 | [diff] [blame] | 129 | static inline bool arch_has_random(void) |
H. Peter Anvin | 7b878d4 | 2014-03-17 16:36:30 -0700 | [diff] [blame] | 130 | { |
| 131 | return 0; |
| 132 | } |
H. Peter Anvin | 117780e | 2016-06-08 12:38:38 -0700 | [diff] [blame] | 133 | static inline bool arch_get_random_seed_long(unsigned long *v) |
H. Peter Anvin | d20f78d | 2014-03-17 16:36:27 -0700 | [diff] [blame] | 134 | { |
| 135 | return 0; |
| 136 | } |
H. Peter Anvin | 117780e | 2016-06-08 12:38:38 -0700 | [diff] [blame] | 137 | static inline bool arch_get_random_seed_int(unsigned int *v) |
H. Peter Anvin | d20f78d | 2014-03-17 16:36:27 -0700 | [diff] [blame] | 138 | { |
| 139 | return 0; |
| 140 | } |
H. Peter Anvin | 117780e | 2016-06-08 12:38:38 -0700 | [diff] [blame] | 141 | static inline bool arch_has_random_seed(void) |
H. Peter Anvin | 7b878d4 | 2014-03-17 16:36:30 -0700 | [diff] [blame] | 142 | { |
| 143 | return 0; |
| 144 | } |
H. Peter Anvin | 63d7717 | 2011-07-31 13:54:50 -0700 | [diff] [blame] | 145 | #endif |
| 146 | |
Tom Herbert | 055dc21 | 2013-01-22 09:49:50 +0000 | [diff] [blame] | 147 | /* Pseudo random number generator from numerical recipes. */ |
| 148 | static inline u32 next_pseudo_random32(u32 seed) |
| 149 | { |
| 150 | return seed * 1664525 + 1013904223; |
| 151 | } |
| 152 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | #endif /* _LINUX_RANDOM_H */ |