rand_util.h 2.26 KB
Newer Older
gejun's avatar
gejun committed
1 2 3 4
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
#ifndef BUTIL_RAND_UTIL_H_
#define BUTIL_RAND_UTIL_H_
gejun's avatar
gejun committed
7 8 9

#include <string>

10 11
#include "butil/base_export.h"
#include "butil/basictypes.h"
gejun's avatar
gejun committed
12

13
namespace butil {
gejun's avatar
gejun committed
14 15 16 17 18 19 20 21

// --------------------------------------------------------------------------
// NOTE(gejun): Functions in this header read from /dev/urandom in posix
// systems and are not proper for performance critical situations.
// For fast random numbers, check fast_rand.h
// --------------------------------------------------------------------------

// Returns a random number in range [0, kuint64max]. Thread-safe.
22
BUTIL_EXPORT uint64_t RandUint64();
gejun's avatar
gejun committed
23 24

// Returns a random number between min and max (inclusive). Thread-safe.
25
BUTIL_EXPORT int RandInt(int min, int max);
gejun's avatar
gejun committed
26 27 28 29 30

// Returns a random number in range [0, range).  Thread-safe.
//
// Note that this can be used as an adapter for std::random_shuffle():
// Given a pre-populated |std::vector<int> myvector|, shuffle it as
31
//   std::random_shuffle(myvector.begin(), myvector.end(), butil::RandGenerator);
32
BUTIL_EXPORT uint64_t RandGenerator(uint64_t range);
gejun's avatar
gejun committed
33 34

// Returns a random double in range [0, 1). Thread-safe.
35
BUTIL_EXPORT double RandDouble();
gejun's avatar
gejun committed
36 37 38

// Given input |bits|, convert with maximum precision to a double in
// the range [0, 1). Thread-safe.
39
BUTIL_EXPORT double BitsToOpenEndedUnitInterval(uint64_t bits);
gejun's avatar
gejun committed
40 41 42 43 44 45

// Fills |output_length| bytes of |output| with random data.
//
// WARNING:
// Do not use for security-sensitive purposes.
// See crypto/ for cryptographically secure random number generation APIs.
46
BUTIL_EXPORT void RandBytes(void* output, size_t output_length);
gejun's avatar
gejun committed
47 48 49 50 51 52 53 54 55 56

// Fills a string of length |length| with random data and returns it.
// |length| should be nonzero.
//
// Note that this is a variation of |RandBytes| with a different return type.
// The returned string is likely not ASCII/UTF-8. Use with care.
//
// WARNING:
// Do not use for security-sensitive purposes.
// See crypto/ for cryptographically secure random number generation APIs.
57
BUTIL_EXPORT std::string RandBytesAsString(size_t length);
gejun's avatar
gejun committed
58 59

#if defined(OS_POSIX)
60
BUTIL_EXPORT int GetUrandomFD();
gejun's avatar
gejun committed
61 62
#endif

63
}  // namespace butil
gejun's avatar
gejun committed
64

65
#endif  // BUTIL_RAND_UTIL_H_