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>
38 #if !defined(KLD_MODULE)
39 #if defined(RANDOM_LOADABLE) && defined(RANDOM_YARROW)
40 #error "Cannot define both RANDOM_LOADABLE and RANDOM_YARROW"
46 #if defined(DEV_RANDOM)
47 u_int read_random(void *, u_int);
48 int read_random_uio(struct uio *, bool);
51 read_random_uio(void *a __unused, u_int b __unused)
56 read_random(void *a __unused, u_int b __unused)
63 * Note: if you add or remove members of random_entropy_source, remember to
64 * also update the strings in the static array random_source_descr[] in
67 * NOTE: complain loudly to markm@ or on the lists if this enum gets more than 32
68 * distinct values (0-31)! ENTROPYSOURCE may be == 32, but not > 32.
70 enum random_entropy_source {
73 /* Environmental sources */
83 RANDOM_UMA, /* Special!! UMA/SLAB Allocator */
84 RANDOM_ENVIRONMENTAL_END = RANDOM_UMA,
85 /* Fast hardware random-number sources from here on. */
87 RANDOM_PURE_OCTEON = RANDOM_PURE_START,
101 #define RANDOM_HARVEST_EVERYTHING_MASK ((1 << (RANDOM_ENVIRONMENTAL_END + 1)) - 1)
102 #define RANDOM_HARVEST_PURE_MASK (((1 << ENTROPYSOURCE) - 1) & (-1UL << RANDOM_PURE_START))
104 #define RANDOM_LEGACY_BOOT_ENTROPY_MODULE "/boot/entropy"
105 #define RANDOM_CACHED_BOOT_ENTROPY_MODULE "boot_entropy_cache"
106 #define RANDOM_CACHED_SKIP_START 256
108 #if defined(DEV_RANDOM)
109 extern u_int hc_source_mask;
110 void random_harvest_queue_(const void *, u_int, u_int, enum random_entropy_source);
111 void random_harvest_fast_(const void *, u_int, u_int);
112 void random_harvest_direct_(const void *, u_int, u_int, enum random_entropy_source);
115 random_harvest_queue(const void *entropy, u_int size, u_int bits,
116 enum random_entropy_source origin)
119 if (hc_source_mask & (1 << origin))
120 random_harvest_queue_(entropy, size, bits, origin);
124 random_harvest_fast(const void *entropy, u_int size, u_int bits,
125 enum random_entropy_source origin)
128 if (hc_source_mask & (1 << origin))
129 random_harvest_fast_(entropy, size, bits);
133 random_harvest_direct(const void *entropy, u_int size, u_int bits,
134 enum random_entropy_source origin)
137 if (hc_source_mask & (1 << origin))
138 random_harvest_direct_(entropy, size, bits, origin);
141 void random_harvest_register_source(enum random_entropy_source);
142 void random_harvest_deregister_source(enum random_entropy_source);
144 #define random_harvest_queue(a, b, c, d) do {} while (0)
145 #define random_harvest_fast(a, b, c, d) do {} while (0)
146 #define random_harvest_direct(a, b, c, d) do {} while (0)
147 #define random_harvest_register_source(a) do {} while (0)
148 #define random_harvest_deregister_source(a) do {} while (0)
151 #if defined(RANDOM_ENABLE_UMA)
152 #define random_harvest_fast_uma(a, b, c, d) random_harvest_fast(a, b, c, d)
153 #else /* !defined(RANDOM_ENABLE_UMA) */
154 #define random_harvest_fast_uma(a, b, c, d) do {} while (0)
155 #endif /* defined(RANDOM_ENABLE_UMA) */
157 #if defined(RANDOM_ENABLE_ETHER)
158 #define random_harvest_queue_ether(a, b, c) random_harvest_queue(a, b, c, RANDOM_NET_ETHER)
159 #else /* !defined(RANDOM_ENABLE_ETHER) */
160 #define random_harvest_queue_ether(a, b, c) do {} while (0)
161 #endif /* defined(RANDOM_ENABLE_ETHER) */
166 #define GRND_NONBLOCK 0x1
167 #define GRND_RANDOM 0x2
168 ssize_t getrandom(void *buf, size_t buflen, unsigned int flags);
170 #endif /* _SYS_RANDOM_H_ */