lib/random.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "random.h"
  19
  20 #include <errno.h>
  21 #include <stdlib.h>
  22 #include <sys/time.h>
  23
  24 #include "entropy.h"
  25 #include "timeval.h"
  26 #include "util.h"
  27
  28 /* This is the 32-bit PRNG recommended in G. Marsaglia, "Xorshift RNGs",
  29  * _Journal of Statistical Software_ 8:14 (July 2003).  According to the paper,
  30  * it has a period of 2**32 - 1 and passes almost all tests of randomness.
  31  *
  32  * We use this PRNG instead of libc's rand() because rand() varies in quality
  33  * and because its maximum value also varies between 32767 and INT_MAX, whereas
  34  * we often want random numbers in the full range of uint32_t.
  35  *
  36  * This random number generator is intended for purposes that do not require
  37  * cryptographic-quality randomness. */
  38
  39 /* Current random state. */
  40 static uint32_t seed;
  41
  42 static uint32_t random_next(void);
  43
  44 void
  45 random_init(void)
  46 {
  47     while (!seed) {
  48         struct timeval tv;
  49         uint32_t entropy;
  50
  51         xgettimeofday(&tv);
  52         get_entropy_or_die(&entropy, 4);
  53
  54         seed = tv.tv_sec ^ tv.tv_usec ^ entropy;
  55     }
  56 }
  57
  58 void
  59 random_set_seed(uint32_t seed_)
  60 {
  61     ovs_assert(seed_);
  62     seed = seed_;
  63 }
  64
  65 void
  66 random_bytes(void *p_, size_t n)
  67 {
  68     uint8_t *p = p_;
  69
  70     random_init();
  71
  72     for (; n > 4; p += 4, n -= 4) {
  73         uint32_t x = random_next();
  74         memcpy(p, &x, 4);
  75     }
  76
  77     if (n) {
  78         uint32_t x = random_next();
  79         memcpy(p, &x, n);
  80     }
  81 }
  82
  83 uint8_t
  84 random_uint8(void)
  85 {
  86     return random_uint32();
  87 }
  88
  89 uint16_t
  90 random_uint16(void)
  91 {
  92     return random_uint32();
  93 }
  94
  95 uint32_t
  96 random_uint32(void)
  97 {
  98     random_init();
  99     return random_next();
 100 }
 101
 102 uint64_t
 103 random_uint64(void)
 104 {
 105     uint64_t x;
 106
 107     random_init();
 108
 109     x = random_next();
 110     x |= (uint64_t) random_next() << 32;
 111     return x;
 112 }
 113
 114 int
 115 random_range(int max)
 116 {
 117     return random_uint32() % max;
 118 }
 119
 120 static uint32_t
 121 random_next(void)
 122 {
 123     seed ^= seed << 13;
 124     seed ^= seed >> 17;
 125     seed ^= seed << 5;
 126
 127     return seed;
 128 }