Files

229 lines
6.6 KiB
C++

// Boost random_generator.hpp header file ----------------------------------------------//
// Copyright 2010 Andy Tompkins.
// Copyright 2017 James E. King III
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// https://www.boost.org/LICENSE_1_0.txt)
#ifndef ACTIV_BOOST_UUID_RANDOM_GENERATOR_HPP
#define ACTIV_BOOST_UUID_RANDOM_GENERATOR_HPP
#include <ActivBoost/config.hpp>
#include <ActivBoost/assert.hpp>
#include <ActivBoost/move/core.hpp>
#include <ActivBoost/move/utility_core.hpp>
#include <ActivBoost/core/enable_if.hpp>
#include <ActivBoost/random/mersenne_twister.hpp>
#include <ActivBoost/random/uniform_int.hpp>
#include <ActivBoost/random/variate_generator.hpp>
#include <ActivBoost/tti/has_member_function.hpp>
#include <ActivBoost/uuid/detail/random_provider.hpp>
#include <ActivBoost/uuid/uuid.hpp>
#include <limits>
namespace Boost {
namespace uuids {
namespace detail {
template<class U>
U& set_uuid_random_vv(U& u)
{
// set variant
// must be 0b10xxxxxx
*(u.begin() + 8) &= 0xBF;
*(u.begin() + 8) |= 0x80;
// set version
// must be 0b0100xxxx
*(u.begin() + 6) &= 0x4F; //0b01001111
*(u.begin() + 6) |= 0x40; //0b01000000
return u;
}
ACTIV_BOOST_TTI_HAS_MEMBER_FUNCTION(seed)
}
//! generate a random-based uuid
//! \param[in] UniformRandomNumberGenerator see Boost.Random documentation
template <typename UniformRandomNumberGenerator>
class basic_random_generator
{
ACTIV_BOOST_MOVABLE_BUT_NOT_COPYABLE(basic_random_generator)
private:
typedef uniform_int<unsigned long> distribution_type;
typedef variate_generator<UniformRandomNumberGenerator*, distribution_type> generator_type;
struct impl
{
generator_type generator;
explicit impl(UniformRandomNumberGenerator* purng_arg) :
generator(purng_arg, distribution_type((std::numeric_limits<unsigned long>::min)(), (std::numeric_limits<unsigned long>::max)()))
{
}
virtual ~impl() {}
ACTIV_BOOST_DELETED_FUNCTION(impl(impl const&))
ACTIV_BOOST_DELETED_FUNCTION(impl& operator= (impl const&))
};
struct urng_holder
{
UniformRandomNumberGenerator urng;
};
#if defined(ACTIV_BOOST_MSVC)
#pragma warning(push)
// 'this' : used in base member initializer list
#pragma warning(disable: 4355)
#endif
struct self_contained_impl :
public urng_holder,
public impl
{
self_contained_impl() : impl(&this->urng_holder::urng)
{
}
};
#if defined(ACTIV_BOOST_MSVC)
#pragma warning(pop)
#endif
public:
typedef uuid result_type;
// default constructor creates the random number generator and
// if the UniformRandomNumberGenerator is a PseudoRandomNumberGenerator
// then it gets seeded by a random_provider.
basic_random_generator() : m_impl(new self_contained_impl())
{
// seed the random number generator if it is capable
seed(static_cast< self_contained_impl* >(m_impl)->urng);
}
// keep a reference to a random number generator
// don't seed a given random number generator
explicit basic_random_generator(UniformRandomNumberGenerator& gen) : m_impl(new impl(&gen))
{
}
// keep a pointer to a random number generator
// don't seed a given random number generator
explicit basic_random_generator(UniformRandomNumberGenerator* gen) : m_impl(new impl(gen))
{
ACTIV_BOOST_ASSERT(!!gen);
}
basic_random_generator(ACTIV_BOOST_RV_REF(basic_random_generator) that) ACTIV_BOOST_NOEXCEPT : m_impl(that.m_impl)
{
that.m_impl = 0;
}
basic_random_generator& operator= (ACTIV_BOOST_RV_REF(basic_random_generator) that) ACTIV_BOOST_NOEXCEPT
{
delete m_impl;
m_impl = that.m_impl;
that.m_impl = 0;
return *this;
}
~basic_random_generator()
{
delete m_impl;
}
result_type operator()()
{
result_type u;
int i=0;
unsigned long random_value = m_impl->generator();
for (uuid::iterator it = u.begin(), end = u.end(); it != end; ++it, ++i) {
if (i==sizeof(unsigned long)) {
random_value = m_impl->generator();
i = 0;
}
// static_cast gets rid of warnings of converting unsigned long to Boost::uint8_t
*it = static_cast<uuid::value_type>((random_value >> (i*8)) & 0xFF);
}
return detail::set_uuid_random_vv(u);
}
private:
// Detect whether UniformRandomNumberGenerator has a seed() method which indicates that
// it is a PseudoRandomNumberGenerator and needs a seed to initialize it. This allows
// basic_random_generator to take any type of UniformRandomNumberGenerator and still
// meet the post-conditions for the default constructor.
template<class MaybePseudoRandomNumberGenerator>
typename Boost::enable_if<detail::has_member_function_seed<MaybePseudoRandomNumberGenerator, void> >::type
seed(MaybePseudoRandomNumberGenerator& rng)
{
detail::random_provider seeder;
rng.seed(seeder);
}
template<class MaybePseudoRandomNumberGenerator>
typename Boost::disable_if<detail::has_member_function_seed<MaybePseudoRandomNumberGenerator, void> >::type
seed(MaybePseudoRandomNumberGenerator&)
{
}
impl* m_impl;
};
//! \brief a far less complex random generator that uses
//! operating system provided entropy which will
//! satisfy the majority of use cases
class random_generator_pure
{
ACTIV_BOOST_MOVABLE_BUT_NOT_COPYABLE(random_generator_pure)
public:
typedef uuid result_type;
ACTIV_BOOST_DEFAULTED_FUNCTION(random_generator_pure(), {})
random_generator_pure(ACTIV_BOOST_RV_REF(random_generator_pure) that) ACTIV_BOOST_NOEXCEPT :
prov_(Boost::move(that.prov_))
{
}
random_generator_pure& operator= (ACTIV_BOOST_RV_REF(random_generator_pure) that) ACTIV_BOOST_NOEXCEPT
{
prov_ = Boost::move(that.prov_);
return *this;
}
//! \returns a random, valid uuid
//! \throws entropy_error
result_type operator()()
{
result_type result;
prov_.get_random_bytes(&result, sizeof(result_type));
return detail::set_uuid_random_vv(result);
}
private:
detail::random_provider prov_;
};
#if defined(ACTIV_BOOST_UUID_RANDOM_GENERATOR_COMPAT)
typedef basic_random_generator<mt19937> random_generator;
#else
typedef random_generator_pure random_generator;
typedef basic_random_generator<mt19937> random_generator_mt19937;
#endif
}} // namespace Boost::uuids
#endif // ACTIV_BOOST_UUID_RANDOM_GENERATOR_HPP