xref: /freebsd/sys/dev/random/unit_test.h (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1 /*-
2  * Copyright (c) 2013-2015 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 
30 #ifndef UNIT_TEST_H_INCLUDED
31 #define	UNIT_TEST_H_INCLUDED
32 
33 #ifdef _KERNEL
34 #error "Random unit tests cannot be compiled into the kernel."
35 #endif
36 
37 #include <sys/types.h>
38 #include <inttypes.h>
39 #include <stdint.h>
40 
41 #if defined(clang) && __has_builtin(__builtin_readcyclecounter)
42 #define	rdtsc __builtin_readcyclecounter
43 #else /* !clang */
44 #if defined(__amd64__) || defined(__i386__)
45 static __inline uint64_t
46 rdtsc(void)
47 {
48 	uint32_t low, high;
49 
50 	__asm __volatile("rdtsc" : "=a" (low), "=d" (high));
51 	return (low | ((uint64_t)high << 32));
52 }
53 #else /* __amd64__ || __i386__ */
54 #error "No rdtsc() implementation available."
55 #endif /* __amd64__ || __i386__ */
56 #endif /* !clang */
57 
58 static __inline uint64_t
59 get_cyclecount(void)
60 {
61 
62 	return (rdtsc());
63 }
64 
65 #define	HARVESTSIZE	2
66 #define RANDOM_BLOCKSIZE	16
67 
68 enum random_entropy_source {
69 	RANDOM_START = 0,
70 	RANDOM_CACHED = 0,
71 	ENTROPYSOURCE = 32
72 };
73 
74 struct harvest_event {
75 	uintmax_t			he_somecounter;		/* fast counter for clock jitter */
76 	uint32_t			he_entropy[HARVESTSIZE];/* some harvested entropy */
77 	uint8_t				he_size;		/* harvested entropy byte count */
78 	uint8_t				he_destination;		/* destination pool of this entropy */
79 	enum random_entropy_source	he_source;		/* origin of the entropy */
80 	void *				he_next;		/* next item on the list */
81 };
82 
83 struct sysctl_ctx_list;
84 
85 #define	CTASSERT(x)	_Static_assert(x, "compile-time assertion failed")
86 #define	KASSERT(exp,msg) do {	\
87 	if (!(exp)) {		\
88 		printf msg;	\
89 		exit(0);	\
90 	}			\
91 } while (0)
92 
93 #endif /* UNIT_TEST_H_INCLUDED */
94