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 <linux/once.h>
  11
  12 #include <uapi/linux/random.h>
  13
  14 struct random_ready_callback {
  15         struct list_head list;
  16         void (*func)(struct random_ready_callback *rdy);
  17         struct module *owner;
  18 };
  19
  20 extern void add_device_randomness(const void *, unsigned int);
  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
  32 extern void add_input_randomness(unsigned int type, unsigned int code,
  33                                  unsigned int value) __latent_entropy;
  34 extern void add_interrupt_randomness(int irq, int irq_flags) __latent_entropy;
  35
  36 extern void get_random_bytes(void *buf, int nbytes);
  37 extern int wait_for_random_bytes(void);
  38 extern int add_random_ready_callback(struct random_ready_callback *rdy);
  39 extern void del_random_ready_callback(struct random_ready_callback *rdy);
  40 extern void get_random_bytes_arch(void *buf, int nbytes);
  41
  42 #ifndef MODULE
  43 extern const struct file_operations random_fops, urandom_fops;
  44 #endif
  45
  46 u32 get_random_u32(void);
  47 u64 get_random_u64(void);
  48 static inline unsigned int get_random_int(void)
  49 {
  50         return get_random_u32();
  51 }
  52 static inline unsigned long get_random_long(void)
  53 {
  54 #if BITS_PER_LONG == 64
  55         return get_random_u64();
  56 #else
  57         return get_random_u32();
  58 #endif
  59 }
  60
  61 /* Calls wait_for_random_bytes() and then calls get_random_bytes(buf, nbytes).
  62  * Returns the result of the call to wait_for_random_bytes. */
  63 static inline int get_random_bytes_wait(void *buf, int nbytes)
  64 {
  65         int ret = wait_for_random_bytes();
  66         if (unlikely(ret))
  67                 return ret;
  68         get_random_bytes(buf, nbytes);
  69         return 0;
  70 }
  71
  72 #define declare_get_random_var_wait(var) \
  73         static inline int get_random_ ## var ## _wait(var *out) { \
  74                 int ret = wait_for_random_bytes(); \
  75                 if (unlikely(ret)) \
  76                         return ret; \
  77                 *out = get_random_ ## var(); \
  78                 return 0; \
  79         }
  80 declare_get_random_var_wait(u32)
  81 declare_get_random_var_wait(u64)
  82 declare_get_random_var_wait(int)
  83 declare_get_random_var_wait(long)
  84 #undef declare_get_random_var
  85
  86 unsigned long randomize_page(unsigned long start, unsigned long range);
  87
  88 u32 prandom_u32(void);
  89 void prandom_bytes(void *buf, size_t nbytes);
  90 void prandom_seed(u32 seed);
  91 void prandom_reseed_late(void);
  92
  93 struct rnd_state {
  94         __u32 s1, s2, s3, s4;
  95 };
  96
  97 u32 prandom_u32_state(struct rnd_state *state);
  98 void prandom_bytes_state(struct rnd_state *state, void *buf, size_t nbytes);
  99 void prandom_seed_full_state(struct rnd_state __percpu *pcpu_state);
 100
 101 #define prandom_init_once(pcpu_state)                   \
 102         DO_ONCE(prandom_seed_full_state, (pcpu_state))
 103
 104 /**
 105  * prandom_u32_max - returns a pseudo-random number in interval [0, ep_ro)
 106  * @ep_ro: right open interval endpoint
 107  *
 108  * Returns a pseudo-random number that is in interval [0, ep_ro). Note
 109  * that the result depends on PRNG being well distributed in [0, ~0U]
 110  * u32 space. Here we use maximally equidistributed combined Tausworthe
 111  * generator, that is, prandom_u32(). This is useful when requesting a
 112  * random index of an array containing ep_ro elements, for example.
 113  *
 114  * Returns: pseudo-random number in interval [0, ep_ro)
 115  */
 116 static inline u32 prandom_u32_max(u32 ep_ro)
 117 {
 118         return (u32)(((u64) prandom_u32() * ep_ro) >> 32);
 119 }
 120
 121 /*
 122  * Handle minimum values for seeds
 123  */
 124 static inline u32 __seed(u32 x, u32 m)
 125 {
 126         return (x < m) ? x + m : x;
 127 }
 128
 129 /**
 130  * prandom_seed_state - set seed for prandom_u32_state().
 131  * @state: pointer to state structure to receive the seed.
 132  * @seed: arbitrary 64-bit value to use as a seed.
 133  */
 134 static inline void prandom_seed_state(struct rnd_state *state, u64 seed)
 135 {
 136         u32 i = (seed >> 32) ^ (seed << 10) ^ seed;
 137
 138         state->s1 = __seed(i,   2U);
 139         state->s2 = __seed(i,   8U);
 140         state->s3 = __seed(i,  16U);
 141         state->s4 = __seed(i, 128U);
 142 }
 143
 144 #ifdef CONFIG_ARCH_RANDOM
 145 # include <asm/archrandom.h>
 146 #else
 147 static inline bool arch_get_random_long(unsigned long *v)
 148 {
 149         return 0;
 150 }
 151 static inline bool arch_get_random_int(unsigned int *v)
 152 {
 153         return 0;
 154 }
 155 static inline bool arch_has_random(void)
 156 {
 157         return 0;
 158 }
 159 static inline bool arch_get_random_seed_long(unsigned long *v)
 160 {
 161         return 0;
 162 }
 163 static inline bool arch_get_random_seed_int(unsigned int *v)
 164 {
 165         return 0;
 166 }
 167 static inline bool arch_has_random_seed(void)
 168 {
 169         return 0;
 170 }
 171 #endif
 172
 173 /* Pseudo random number generator from numerical recipes. */
 174 static inline u32 next_pseudo_random32(u32 seed)
 175 {
 176         return seed * 1664525 + 1013904223;
 177 }
 178
 179 #endif /* _LINUX_RANDOM_H */