blob: e47e533742b5e35fe5ec21263ae966f64ff1ff4a [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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070021extern void add_input_randomness(unsigned int type, unsigned int code,
22 unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -040023extern void add_interrupt_randomness(int irq, int irq_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25extern void get_random_bytes(void *buf, int nbytes);
Herbert Xu205a5252015-06-09 18:19:39 +080026extern int add_random_ready_callback(struct random_ready_callback *rdy);
27extern void del_random_ready_callback(struct random_ready_callback *rdy);
Theodore Ts'oc2557a32012-07-05 10:35:23 -040028extern void get_random_bytes_arch(void *buf, int nbytes);
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);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -080036unsigned long get_random_long(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037unsigned long randomize_range(unsigned long start, unsigned long end, unsigned long len);
38
Akinobu Mita496f2f92012-12-17 16:04:23 -080039u32 prandom_u32(void);
Daniel Borkmanna98406e2014-08-23 17:03:28 +020040void prandom_bytes(void *buf, size_t nbytes);
Akinobu Mita496f2f92012-12-17 16:04:23 -080041void prandom_seed(u32 seed);
Hannes Frederic Sowa4af712e2013-11-11 12:20:34 +010042void prandom_reseed_late(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -070043
Daniel Borkmann38e9efc2013-11-11 12:20:35 +010044struct rnd_state {
Daniel Borkmanna98814c2013-11-11 12:20:36 +010045 __u32 s1, s2, s3, s4;
Daniel Borkmann38e9efc2013-11-11 12:20:35 +010046};
47
Daniel Borkmanna98814c2013-11-11 12:20:36 +010048u32 prandom_u32_state(struct rnd_state *state);
Daniel Borkmanna98406e2014-08-23 17:03:28 +020049void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes);
Daniel Borkmann897ece52015-10-08 01:20:38 +020050void prandom_seed_full_state(struct rnd_state __percpu *pcpu_state);
51
52#define prandom_init_once(pcpu_state) \
53 DO_ONCE(prandom_seed_full_state, (pcpu_state))
Joe Eykholt59601642010-05-26 14:44:13 -070054
Daniel Borkmannf337db62014-01-22 02:29:39 +010055/**
56 * prandom_u32_max - returns a pseudo-random number in interval [0, ep_ro)
57 * @ep_ro: right open interval endpoint
58 *
59 * Returns a pseudo-random number that is in interval [0, ep_ro). Note
60 * that the result depends on PRNG being well distributed in [0, ~0U]
61 * u32 space. Here we use maximally equidistributed combined Tausworthe
62 * generator, that is, prandom_u32(). This is useful when requesting a
63 * random index of an array containing ep_ro elements, for example.
64 *
65 * Returns: pseudo-random number in interval [0, ep_ro)
66 */
67static inline u32 prandom_u32_max(u32 ep_ro)
68{
69 return (u32)(((u64) prandom_u32() * ep_ro) >> 32);
70}
71
Joe Eykholt59601642010-05-26 14:44:13 -070072/*
73 * Handle minimum values for seeds
74 */
75static inline u32 __seed(u32 x, u32 m)
76{
77 return (x < m) ? x + m : x;
78}
79
80/**
Akinobu Mita496f2f92012-12-17 16:04:23 -080081 * prandom_seed_state - set seed for prandom_u32_state().
Joe Eykholt59601642010-05-26 14:44:13 -070082 * @state: pointer to state structure to receive the seed.
83 * @seed: arbitrary 64-bit value to use as a seed.
84 */
Akinobu Mita496f2f92012-12-17 16:04:23 -080085static inline void prandom_seed_state(struct rnd_state *state, u64 seed)
Joe Eykholt59601642010-05-26 14:44:13 -070086{
87 u32 i = (seed >> 32) ^ (seed << 10) ^ seed;
88
Daniel Borkmanna98814c2013-11-11 12:20:36 +010089 state->s1 = __seed(i, 2U);
90 state->s2 = __seed(i, 8U);
91 state->s3 = __seed(i, 16U);
92 state->s4 = __seed(i, 128U);
Joe Eykholt59601642010-05-26 14:44:13 -070093}
94
H. Peter Anvin63d77172011-07-31 13:54:50 -070095#ifdef CONFIG_ARCH_RANDOM
96# include <asm/archrandom.h>
97#else
98static inline int arch_get_random_long(unsigned long *v)
99{
100 return 0;
101}
102static inline int arch_get_random_int(unsigned int *v)
103{
104 return 0;
105}
H. Peter Anvin7b878d42014-03-17 16:36:30 -0700106static inline int arch_has_random(void)
107{
108 return 0;
109}
H. Peter Anvind20f78d2014-03-17 16:36:27 -0700110static inline int arch_get_random_seed_long(unsigned long *v)
111{
112 return 0;
113}
114static inline int arch_get_random_seed_int(unsigned int *v)
115{
116 return 0;
117}
H. Peter Anvin7b878d42014-03-17 16:36:30 -0700118static inline int arch_has_random_seed(void)
119{
120 return 0;
121}
H. Peter Anvin63d77172011-07-31 13:54:50 -0700122#endif
123
Tom Herbert055dc212013-01-22 09:49:50 +0000124/* Pseudo random number generator from numerical recipes. */
125static inline u32 next_pseudo_random32(u32 seed)
126{
127 return seed * 1664525 + 1013904223;
128}
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#endif /* _LINUX_RANDOM_H */