xref: /titanic_44/usr/src/uts/common/sys/random.h (revision 9d12795f87b63c2e39e87bff369182edd34677d3)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 /*
26  * Copyright 2010 Nexenta Systems, Inc.  All rights reserved.
27  * Copyright (c) 2015, Joyent, Inc.
28  */
29 
30 #ifndef	_SYS_RANDOM_H
31 #define	_SYS_RANDOM_H
32 
33 #include <sys/types.h>
34 #include <sys/atomic.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 /* stats for the random number devices, /dev/random and /dev/urandom. */
41 typedef struct rnd_stats {
42 	uint64_t	rs_rndOut;	/* Bytes generated for /dev/random */
43 	uint64_t	rs_rndcOut;	/* Bytes read from /dev/random cache */
44 	uint64_t	rs_urndOut;	/* Bytes generated for /dev/urandom */
45 } rnd_stats_t;
46 
47 /* stats for the kernel random number provider, swrand. */
48 typedef struct swrand_stats {
49 	uint32_t	ss_entEst;	/* Entropy estimate in bits */
50 	uint64_t	ss_entIn;	/* Entropy bits added to pool */
51 	uint64_t	ss_entOut;	/* Entropy bits extracted from pool */
52 	uint64_t	ss_bytesIn;	/* Total data bytes added to pool */
53 	uint64_t	ss_bytesOut;	/* Total data bytes extracted from */
54 					/* the pool */
55 } swrand_stats_t;
56 
57 #ifdef	_KERNEL
58 
59 #define	BUMP_CPU_RND_STATS(rm, x, v)    (((rm)->rm_mag.rm_stats).x += (v))
60 #define	BUMP_RND_STATS(x, v)	atomic_add_64(&(rnd_stats).x, (v))
61 #define	BUMP_SWRAND_STATS(x, v)	atomic_add_64(&(swrand_stats).x, (v))
62 
63 extern int random_add_entropy(uint8_t *, size_t, uint_t);
64 extern int random_get_bytes(uint8_t *, size_t);
65 extern int random_get_blocking_bytes(uint8_t *, size_t);
66 extern int random_get_pseudo_bytes(uint8_t *, size_t);
67 
68 #endif /* _KERNEL */
69 
70 /*
71  * Flags for the getrandom system call. Note, we may want to move these
72  * definitions if we expose getrandom(2) into a public system call.
73  */
74 #define	GRND_NONBLOCK	0x0001		/* O_NONBLOCK equiv */
75 #define	GRND_RANDOM	0x0002		/* Use /dev/random, not /dev/urandom */
76 extern int getrandom(void *, size_t, int);
77 
78 #ifdef	__cplusplus
79 }
80 #endif
81 
82 #endif /* _SYS_RANDOM_H */
83