xref: /freebsd/sys/dev/random/other_algorithm.h (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1 /*-
2  * Copyright (c) 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  * This is a skeleton for folks who wish to build a loadable module
31  * containing an alternative entropy-processing algorithm for random(4).
32  *
33  * The functions below should be completed with the appropriate code,
34  * and the nearby fortuna.c may be consulted for examples of working code.
35  *
36  * The author is willing to provide reasonable help to those wishing to
37  * write such a module for themselves. Please use the markm@ FreeBSD
38  * email address, and ensure that you are developing this on a suitably
39  * supported branch (This is currently 12-CURRENT, and may be no
40  * older than 12-STABLE in the future).
41  */
42 
43 #ifndef SYS_DEV_RANDOM_OTHER_H_INCLUDED
44 #define	SYS_DEV_RANDOM_OTHER_H_INCLUDED
45 
46 #ifdef _KERNEL
47 typedef struct mtx mtx_t;
48 #define	RANDOM_RESEED_INIT_LOCK(x)		mtx_init(&other_mtx, "reseed mutex", NULL, MTX_DEF)
49 #define	RANDOM_RESEED_DEINIT_LOCK(x)		mtx_destroy(&other_mtx)
50 #define	RANDOM_RESEED_LOCK(x)			mtx_lock(&other_mtx)
51 #define	RANDOM_RESEED_UNLOCK(x)			mtx_unlock(&other_mtx)
52 #define	RANDOM_RESEED_ASSERT_LOCK_OWNED(x)	mtx_assert(&other_mtx, MA_OWNED)
53 #else
54 #define	RANDOM_RESEED_INIT_LOCK(x)		mtx_init(&other_mtx, mtx_plain)
55 #define	RANDOM_RESEED_DEINIT_LOCK(x)		mtx_destroy(&other_mtx)
56 #define	RANDOM_RESEED_LOCK(x)			mtx_lock(&other_mtx)
57 #define	RANDOM_RESEED_UNLOCK(x)			mtx_unlock(&other_mtx)
58 #define	RANDOM_RESEED_ASSERT_LOCK_OWNED(x)
59 #endif
60 
61 #endif /* SYS_DEV_RANDOM_OTHER_H_INCLUDED */
62