sys/sys/random.h

   1 /*-
   2  * Copyright (c) 2000-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 #ifndef _SYS_RANDOM_H_
  30 #define _SYS_RANDOM_H_
  31
  32 #ifdef _KERNEL
  33
  34 #include <sys/types.h>
  35
  36 #if !defined(KLD_MODULE)
  37 #if defined(RANDOM_LOADABLE) && defined(RANDOM_YARROW)
  38 #error "Cannot define both RANDOM_LOADABLE and RANDOM_YARROW"
  39 #endif
  40 #endif
  41
  42 struct uio;
  43
  44 #if defined(DEV_RANDOM)
  45 u_int read_random(void *, u_int);
  46 int read_random_uio(struct uio *, bool);
  47 #else
  48 static __inline int
  49 read_random_uio(void *a __unused, u_int b __unused)
  50 {
  51         return (0);
  52 }
  53 static __inline u_int
  54 read_random(void *a __unused, u_int b __unused)
  55 {
  56         return (0);
  57 }
  58 #endif
  59
  60 /*
  61  * Note: if you add or remove members of random_entropy_source, remember to also update the
  62  * KASSERT regarding what valid members are in random_harvest_internal(), and remember the
  63  * strings in the static array random_source_descr[] in random_harvestq.c.
  64  *
  65  * NOTE: complain loudly to markm@ or on the lists if this enum gets more than 32
  66  * distinct values (0-31)! ENTROPYSOURCE may be == 32, but not > 32.
  67  */
  68 enum random_entropy_source {
  69         RANDOM_START = 0,
  70         RANDOM_CACHED = 0,
  71         /* Environmental sources */
  72         RANDOM_ATTACH,
  73         RANDOM_KEYBOARD,
  74         RANDOM_MOUSE,
  75         RANDOM_NET_TUN,
  76         RANDOM_NET_ETHER,
  77         RANDOM_NET_NG,
  78         RANDOM_INTERRUPT,
  79         RANDOM_SWI,
  80         RANDOM_FS_ATIME,
  81         RANDOM_UMA,     /* Special!! UMA/SLAB Allocator */
  82         RANDOM_ENVIRONMENTAL_END = RANDOM_UMA,
  83         /* Fast hardware random-number sources from here on. */
  84         RANDOM_PURE_OCTEON,
  85         RANDOM_PURE_SAFE,
  86         RANDOM_PURE_GLXSB,
  87         RANDOM_PURE_UBSEC,
  88         RANDOM_PURE_HIFN,
  89         RANDOM_PURE_RDRAND,
  90         RANDOM_PURE_NEHEMIAH,
  91         RANDOM_PURE_RNDTEST,
  92         RANDOM_PURE_VIRTIO,
  93         ENTROPYSOURCE
  94 };
  95
  96 #define RANDOM_HARVEST_EVERYTHING_MASK ((1 << (RANDOM_ENVIRONMENTAL_END + 1)) - 1)
  97
  98 #if defined(DEV_RANDOM)
  99 void random_harvest_queue(const void *, u_int, u_int, enum random_entropy_source);
 100 void random_harvest_fast(const void *, u_int, u_int, enum random_entropy_source);
 101 void random_harvest_direct(const void *, u_int, u_int, enum random_entropy_source);
 102 #else
 103 #define random_harvest_queue(a, b, c, d) do {} while (0)
 104 #define random_harvest_fast(a, b, c, d) do {} while (0)
 105 #define random_harvest_direct(a, b, c, d) do {} while (0)
 106 #endif
 107
 108 #if defined(RANDOM_ENABLE_UMA)
 109 #define random_harvest_fast_uma(a, b, c, d)     random_harvest_fast(a, b, c, d)
 110 #else /* !defined(RANDOM_ENABLE_UMA) */
 111 #define random_harvest_fast_uma(a, b, c, d)     do {} while (0)
 112 #endif /* defined(RANDOM_ENABLE_UMA) */
 113
 114 #endif /* _KERNEL */
 115
 116 #endif /* _SYS_RANDOM_H_ */