xref: /freebsd/sys/sys/random.h (revision 38d120bc13ac1de5b739b67b87016b9122149374)
1 /*-
2  * Copyright (c) 2000-2013 Mark R. V. Murray
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef	_SYS_RANDOM_H_
30 #define	_SYS_RANDOM_H_
31 
32 #ifdef _KERNEL
33 
34 int read_random(void *, int);
35 
36 /*
37  * Note: if you add or remove members of random_entropy_source, remember to also update the
38  * KASSERT regarding what valid members are in random_harvest_internal(), and remember the
39  * strings in the static array random_source_descr[] in random_harvestq.c.
40  *
41  * NOTE: complain loudly to markm@ or on the lists if this enum gets more than 32
42  * distinct values (0-31)! ENTROPYSOURCE may be == 32, but not > 32.
43  */
44 enum random_entropy_source {
45 	RANDOM_START = 0,
46 	RANDOM_CACHED = 0,
47 	/* Environmental sources */
48 	RANDOM_ATTACH,
49 	RANDOM_KEYBOARD,
50 	RANDOM_MOUSE,
51 	RANDOM_NET_TUN,
52 	RANDOM_NET_ETHER,
53 	RANDOM_NET_NG,
54 	RANDOM_INTERRUPT,
55 	RANDOM_SWI,
56 	RANDOM_UMA_ALLOC,
57 	RANDOM_ENVIRONMENTAL_END, /* This one is wasted */
58 	/* High-quality HW RNGs from here on. */
59 	RANDOM_PURE_OCTEON,
60 	RANDOM_PURE_SAFE,
61 	RANDOM_PURE_GLXSB,
62 	RANDOM_PURE_UBSEC,
63 	RANDOM_PURE_HIFN,
64 	RANDOM_PURE_RDRAND,
65 	RANDOM_PURE_NEHEMIAH,
66 	RANDOM_PURE_RNDTEST,
67 	RANDOM_PURE_VIRTIO,
68 	ENTROPYSOURCE
69 };
70 void random_harvest(const void *, u_int, u_int, enum random_entropy_source);
71 
72 #endif /* _KERNEL */
73 
74 #endif /* _SYS_RANDOM_H_ */
75