2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2000-2015, 2017 Mark R. V. Murray
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer
12 * in this position and unchanged.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef _SYS_RANDOM_H_
32 #define _SYS_RANDOM_H_
34 #include <sys/types.h>
40 void read_random(void *, u_int);
41 int read_random_uio(struct uio *, bool);
42 bool is_random_seeded(void);
45 * Note: if you add or remove members of random_entropy_source, remember to
46 * also update the strings in the static array random_source_descr[] in
49 enum random_entropy_source {
52 /* Environmental sources */
62 RANDOM_UMA, /* Special!! UMA/SLAB Allocator */
63 RANDOM_ENVIRONMENTAL_END = RANDOM_UMA,
64 /* Fast hardware random-number sources from here on. */
66 RANDOM_PURE_OCTEON = RANDOM_PURE_START,
81 _Static_assert(ENTROPYSOURCE <= 32,
82 "hardcoded assumption that values fit in a typical word-sized bitset");
84 #define RANDOM_LEGACY_BOOT_ENTROPY_MODULE "/boot/entropy"
85 #define RANDOM_CACHED_BOOT_ENTROPY_MODULE "boot_entropy_cache"
87 extern u_int hc_source_mask;
88 void random_harvest_queue_(const void *, u_int, enum random_entropy_source);
89 void random_harvest_fast_(const void *, u_int);
90 void random_harvest_direct_(const void *, u_int, enum random_entropy_source);
93 random_harvest_queue(const void *entropy, u_int size, enum random_entropy_source origin)
96 if (hc_source_mask & (1 << origin))
97 random_harvest_queue_(entropy, size, origin);
101 random_harvest_fast(const void *entropy, u_int size, enum random_entropy_source origin)
104 if (hc_source_mask & (1 << origin))
105 random_harvest_fast_(entropy, size);
109 random_harvest_direct(const void *entropy, u_int size, enum random_entropy_source origin)
112 if (hc_source_mask & (1 << origin))
113 random_harvest_direct_(entropy, size, origin);
116 void random_harvest_register_source(enum random_entropy_source);
117 void random_harvest_deregister_source(enum random_entropy_source);
119 #if defined(RANDOM_ENABLE_UMA)
120 #define random_harvest_fast_uma(a, b, c) random_harvest_fast(a, b, c)
121 #else /* !defined(RANDOM_ENABLE_UMA) */
122 #define random_harvest_fast_uma(a, b, c) do {} while (0)
123 #endif /* defined(RANDOM_ENABLE_UMA) */
125 #if defined(RANDOM_ENABLE_ETHER)
126 #define random_harvest_queue_ether(a, b) random_harvest_queue(a, b, RANDOM_NET_ETHER)
127 #else /* !defined(RANDOM_ENABLE_ETHER) */
128 #define random_harvest_queue_ether(a, b) do {} while (0)
129 #endif /* defined(RANDOM_ENABLE_ETHER) */
134 #define GRND_NONBLOCK 0x1
135 #define GRND_RANDOM 0x2
138 ssize_t getrandom(void *buf, size_t buflen, unsigned int flags);
141 #endif /* _SYS_RANDOM_H_ */