]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - include/linux/random.h
random: Add callback API for random pool readiness
[karo-tx-linux.git] / include / linux / random.h
1 /*
2  * include/linux/random.h
3  *
4  * Include file for the random number generator.
5  */
6 #ifndef _LINUX_RANDOM_H
7 #define _LINUX_RANDOM_H
8
9 #include <linux/list.h>
10 #include <uapi/linux/random.h>
11
12 struct random_ready_callback {
13         struct list_head list;
14         void (*func)(struct random_ready_callback *rdy);
15         struct module *owner;
16 };
17
18 extern void add_device_randomness(const void *, unsigned int);
19 extern void add_input_randomness(unsigned int type, unsigned int code,
20                                  unsigned int value);
21 extern void add_interrupt_randomness(int irq, int irq_flags);
22
23 extern void get_random_bytes(void *buf, int nbytes);
24 extern void get_blocking_random_bytes(void *buf, int nbytes);
25 extern int add_random_ready_callback(struct random_ready_callback *rdy);
26 extern void del_random_ready_callback(struct random_ready_callback *rdy);
27 extern void get_random_bytes_arch(void *buf, int nbytes);
28 void generate_random_uuid(unsigned char uuid_out[16]);
29 extern int random_int_secret_init(void);
30
31 #ifndef MODULE
32 extern const struct file_operations random_fops, urandom_fops;
33 #endif
34
35 unsigned int get_random_int(void);
36 unsigned long randomize_range(unsigned long start, unsigned long end, unsigned long len);
37
38 u32 prandom_u32(void);
39 void prandom_bytes(void *buf, size_t nbytes);
40 void prandom_seed(u32 seed);
41 void prandom_reseed_late(void);
42
43 struct rnd_state {
44         __u32 s1, s2, s3, s4;
45 };
46
47 u32 prandom_u32_state(struct rnd_state *state);
48 void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes);
49
50 /**
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  */
62 static inline u32 prandom_u32_max(u32 ep_ro)
63 {
64         return (u32)(((u64) prandom_u32() * ep_ro) >> 32);
65 }
66
67 /*
68  * Handle minimum values for seeds
69  */
70 static inline u32 __seed(u32 x, u32 m)
71 {
72         return (x < m) ? x + m : x;
73 }
74
75 /**
76  * prandom_seed_state - set seed for prandom_u32_state().
77  * @state: pointer to state structure to receive the seed.
78  * @seed: arbitrary 64-bit value to use as a seed.
79  */
80 static inline void prandom_seed_state(struct rnd_state *state, u64 seed)
81 {
82         u32 i = (seed >> 32) ^ (seed << 10) ^ seed;
83
84         state->s1 = __seed(i,   2U);
85         state->s2 = __seed(i,   8U);
86         state->s3 = __seed(i,  16U);
87         state->s4 = __seed(i, 128U);
88 }
89
90 #ifdef CONFIG_ARCH_RANDOM
91 # include <asm/archrandom.h>
92 #else
93 static inline int arch_get_random_long(unsigned long *v)
94 {
95         return 0;
96 }
97 static inline int arch_get_random_int(unsigned int *v)
98 {
99         return 0;
100 }
101 static inline int arch_has_random(void)
102 {
103         return 0;
104 }
105 static inline int arch_get_random_seed_long(unsigned long *v)
106 {
107         return 0;
108 }
109 static inline int arch_get_random_seed_int(unsigned int *v)
110 {
111         return 0;
112 }
113 static inline int arch_has_random_seed(void)
114 {
115         return 0;
116 }
117 #endif
118
119 /* Pseudo random number generator from numerical recipes. */
120 static inline u32 next_pseudo_random32(u32 seed)
121 {
122         return seed * 1664525 + 1013904223;
123 }
124
125 #endif /* _LINUX_RANDOM_H */