random_adaptors.h revision 255362 
1/*-
2 * Copyright (c) 2013 Arthur Mesh <arthurmesh@gmail.com>
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: head/sys/dev/random/random_adaptors.h 255362 2013-09-07 14:15:13Z markm $
27 */
28
29#ifndef __RANDOM_ADAPTORS_H__
30#define __RANDOM_ADAPTORS_H__
31
32#include <sys/eventhandler.h>
33
34struct random_adaptors {
35	LIST_ENTRY(random_adaptors) entries;	/* list of providers */
36	const char		*name;		/* name of random adaptor */
37	struct random_adaptor	*rsp;
38};
39
40struct random_adaptor *random_adaptor_get(const char *);
41int random_adaptor_register(const char *, struct random_adaptor *);
42void random_adaptor_choose(struct random_adaptor **);
43
44/*
45 * random_adaptor's should be registered prior to
46 * random module (SI_SUB_DRIVERS/SI_ORDER_MIDDLE)
47 */
48#define RANDOM_ADAPTOR_MODULE(name, modevent, ver)		\
49    static moduledata_t name##_mod = {				\
50	#name,							\
51	modevent,						\
52	0							\
53    };								\
54    DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS,		\
55		   SI_ORDER_SECOND);				\
56    MODULE_VERSION(name, ver);					\
57    MODULE_DEPEND(name, random, 1, 1, 1);
58
59typedef void (*random_adaptor_attach_hook)(void *, struct random_adaptor *);
60EVENTHANDLER_DECLARE(random_adaptor_attach, random_adaptor_attach_hook);
61
62/* kern.random sysctls */
63#ifdef SYSCTL_DECL	/* from sysctl.h */
64SYSCTL_DECL(_kern_random);
65#endif /* SYSCTL_DECL */
66
67#endif /* __RANDOM_ADAPTORS_H__ */
68