sys/sys/random.h

   1 /*-
   2  * Copyright (c) 2000-2013 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 struct uio;
  37
  38 u_int read_random(void *, u_int);
  39 int read_random_uio(struct uio *, bool);
  40
  41 /*
  42  * Note: if you add or remove members of random_entropy_source, remember to also update the
  43  * KASSERT regarding what valid members are in random_harvest_internal(), and remember the
  44  * strings in the static array random_source_descr[] in random_harvestq.c.
  45  *
  46  * NOTE: complain loudly to markm@ or on the lists if this enum gets more than 32
  47  * distinct values (0-31)! ENTROPYSOURCE may be == 32, but not > 32.
  48  */
  49 enum random_entropy_source {
  50         RANDOM_START = 0,
  51         RANDOM_CACHED = 0,
  52         /* Environmental sources */
  53         RANDOM_ATTACH,
  54         RANDOM_KEYBOARD,
  55         RANDOM_MOUSE,
  56         RANDOM_NET_TUN,
  57         RANDOM_NET_ETHER,
  58         RANDOM_NET_NG,
  59         RANDOM_INTERRUPT,
  60         RANDOM_SWI,
  61         RANDOM_FS_ATIME,
  62         RANDOM_FAST,    /* Special!! Miscellaneous high performance stuff, like UMA/SLAB Allocator */
  63         RANDOM_ENVIRONMENTAL_END = RANDOM_FAST,
  64         /* Fast hardware random-number sources from here on. */
  65         RANDOM_PURE_OCTEON,
  66         RANDOM_PURE_SAFE,
  67         RANDOM_PURE_GLXSB,
  68         RANDOM_PURE_UBSEC,
  69         RANDOM_PURE_HIFN,
  70         RANDOM_PURE_RDRAND,
  71         RANDOM_PURE_NEHEMIAH,
  72         RANDOM_PURE_RNDTEST,
  73         RANDOM_PURE_VIRTIO,
  74         ENTROPYSOURCE
  75 };
  76
  77 #define RANDOM_HARVEST_EVERYTHING_MASK ((1 << (RANDOM_ENVIRONMENTAL_END + 1)) - 1)
  78
  79 #if defined(RANDOM_DUMMY)
  80 #define random_harvest_queue(a, b, c, d) do {} while (0)
  81 #define random_harvest_fast(a, b, c, d) do {} while (0)
  82 #define random_harvest_direct(a, b, c, d) do {} while (0)
  83 #else /* !defined(RANDOM_DUMMY) */
  84 void random_harvest_queue(const void *, u_int, u_int, enum random_entropy_source);
  85 void random_harvest_fast(const void *, u_int, u_int, enum random_entropy_source);
  86 void random_harvest_direct(const void *, u_int, u_int, enum random_entropy_source);
  87 #endif /* defined(RANDOM_DUMMY) */
  88
  89 #endif /* _KERNEL */
  90
  91 #endif /* _SYS_RANDOM_H_ */