random.h 3.78 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8
/*
 * include/linux/random.h
 *
 * Include file for the random number generator.
 */
#ifndef _LINUX_RANDOM_H
#define _LINUX_RANDOM_H

9
#include <linux/list.h>
10 11
#include <linux/once.h>

12
#include <uapi/linux/random.h>
Linus Torvalds's avatar
Linus Torvalds committed
13

14 15 16 17 18 19
struct random_ready_callback {
	struct list_head list;
	void (*func)(struct random_ready_callback *rdy);
	struct module *owner;
};

20
extern void add_device_randomness(const void *, unsigned int);
21 22 23 24 25 26 27 28 29 30 31

#if defined(CONFIG_GCC_PLUGIN_LATENT_ENTROPY) && !defined(__CHECKER__)
static inline void add_latent_entropy(void)
{
	add_device_randomness((const void *)&latent_entropy,
			      sizeof(latent_entropy));
}
#else
static inline void add_latent_entropy(void) {}
#endif

Linus Torvalds's avatar
Linus Torvalds committed
32
extern void add_input_randomness(unsigned int type, unsigned int code,
33 34
				 unsigned int value) __latent_entropy;
extern void add_interrupt_randomness(int irq, int irq_flags) __latent_entropy;
Linus Torvalds's avatar
Linus Torvalds committed
35 36

extern void get_random_bytes(void *buf, int nbytes);
37 38
extern int add_random_ready_callback(struct random_ready_callback *rdy);
extern void del_random_ready_callback(struct random_ready_callback *rdy);
39
extern void get_random_bytes_arch(void *buf, int nbytes);
Linus Torvalds's avatar
Linus Torvalds committed
40 41

#ifndef MODULE
42
extern const struct file_operations random_fops, urandom_fops;
Linus Torvalds's avatar
Linus Torvalds committed
43 44
#endif

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
u32 get_random_u32(void);
u64 get_random_u64(void);
static inline unsigned int get_random_int(void)
{
	return get_random_u32();
}
static inline unsigned long get_random_long(void)
{
#if BITS_PER_LONG == 64
	return get_random_u64();
#else
	return get_random_u32();
#endif
}

60
unsigned long randomize_page(unsigned long start, unsigned long range);
Linus Torvalds's avatar
Linus Torvalds committed
61

62
u32 prandom_u32(void);
63
void prandom_bytes(void *buf, size_t nbytes);
64
void prandom_seed(u32 seed);
65
void prandom_reseed_late(void);
66

67
struct rnd_state {
68
	__u32 s1, s2, s3, s4;
69 70
};

71
u32 prandom_u32_state(struct rnd_state *state);
72
void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes);
73 74 75 76
void prandom_seed_full_state(struct rnd_state __percpu *pcpu_state);

#define prandom_init_once(pcpu_state)			\
	DO_ONCE(prandom_seed_full_state, (pcpu_state))
77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
/**
 * prandom_u32_max - returns a pseudo-random number in interval [0, ep_ro)
 * @ep_ro: right open interval endpoint
 *
 * Returns a pseudo-random number that is in interval [0, ep_ro). Note
 * that the result depends on PRNG being well distributed in [0, ~0U]
 * u32 space. Here we use maximally equidistributed combined Tausworthe
 * generator, that is, prandom_u32(). This is useful when requesting a
 * random index of an array containing ep_ro elements, for example.
 *
 * Returns: pseudo-random number in interval [0, ep_ro)
 */
static inline u32 prandom_u32_max(u32 ep_ro)
{
	return (u32)(((u64) prandom_u32() * ep_ro) >> 32);
}

95 96 97 98 99 100 101 102 103
/*
 * Handle minimum values for seeds
 */
static inline u32 __seed(u32 x, u32 m)
{
	return (x < m) ? x + m : x;
}

/**
104
 * prandom_seed_state - set seed for prandom_u32_state().
105 106 107
 * @state: pointer to state structure to receive the seed.
 * @seed: arbitrary 64-bit value to use as a seed.
 */
108
static inline void prandom_seed_state(struct rnd_state *state, u64 seed)
109 110 111
{
	u32 i = (seed >> 32) ^ (seed << 10) ^ seed;

112 113 114 115
	state->s1 = __seed(i,   2U);
	state->s2 = __seed(i,   8U);
	state->s3 = __seed(i,  16U);
	state->s4 = __seed(i, 128U);
116 117
}

118 119 120
#ifdef CONFIG_ARCH_RANDOM
# include <asm/archrandom.h>
#else
121
static inline bool arch_get_random_long(unsigned long *v)
122 123 124
{
	return 0;
}
125
static inline bool arch_get_random_int(unsigned int *v)
126 127 128
{
	return 0;
}
129
static inline bool arch_has_random(void)
130 131 132
{
	return 0;
}
133
static inline bool arch_get_random_seed_long(unsigned long *v)
134 135 136
{
	return 0;
}
137
static inline bool arch_get_random_seed_int(unsigned int *v)
138 139 140
{
	return 0;
}
141
static inline bool arch_has_random_seed(void)
142 143 144
{
	return 0;
}
145 146
#endif

147 148 149 150 151 152
/* Pseudo random number generator from numerical recipes. */
static inline u32 next_pseudo_random32(u32 seed)
{
	return seed * 1664525 + 1013904223;
}

Linus Torvalds's avatar
Linus Torvalds committed
153
#endif /* _LINUX_RANDOM_H */