lib/Support/RandomNumberGenerator.cpp

   1 //===-- RandomNumberGenerator.cpp - Implement RNG class -------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements deterministic random number generation (RNG).
  11 // The current implementation is NOT cryptographically secure as it uses
  12 // the C++11 <random> facilities.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "rng"
  17 #include "llvm/Support/CommandLine.h"
  18 #include "llvm/Support/Debug.h"
  19 #include "llvm/Support/RandomNumberGenerator.h"
  20
  21 using namespace llvm;
  22
  23 // Tracking BUG: 19665
  24 // http://llvm.org/bugs/show_bug.cgi?id=19665
  25 //
  26 // Do not change to cl::opt<uint64_t> since this silently breaks argument parsing.
  27 static cl::opt<unsigned long long>
  28 Seed("rng-seed", cl::value_desc("seed"),
  29      cl::desc("Seed for the random number generator"), cl::init(0));
  30
  31 RandomNumberGenerator::RandomNumberGenerator(StringRef Salt) {
  32   DEBUG(
  33     if (Seed == 0)
  34       dbgs() << "Warning! Using unseeded random number generator.\n"
  35   );
  36
  37   // Combine seed and salts using std::seed_seq.
  38   // Data: Seed-low, Seed-high, Salt
  39   // Note: std::seed_seq can only store 32-bit values, even though we
  40   // are using a 64-bit RNG. This isn't a problem since the Mersenne
  41   // twister constructor copies these correctly into its initial state.
  42   std::vector<uint32_t> Data;
  43   Data.reserve(2 + Salt.size());
  44   Data.push_back(Seed);
  45   Data.push_back(Seed >> 32);
  46
  47   std::copy(Salt.begin(), Salt.end(), Data.end());
  48
  49   std::seed_seq SeedSeq(Data.begin(), Data.end());
  50   Generator.seed(SeedSeq);
  51 }
  52
  53 uint_fast64_t RandomNumberGenerator::operator()() {
  54   return Generator();
  55 }