mseaborn@chromium.org | 056521b | 2012-05-30 23:26:13 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef BASE_RAND_UTIL_H_ |
| 6 | #define BASE_RAND_UTIL_H_ |
| 7 | |
abarth@chromium.org | c19cb31 | 2011-04-30 06:03:54 +0900 | [diff] [blame] | 8 | #include <string> |
| 9 | |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 10 | #include "base/base_export.h" |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 11 | #include "base/basictypes.h" |
| 12 | |
| 13 | namespace base { |
| 14 | |
| 15 | // Returns a random number in range [0, kuint64max]. Thread-safe. |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 16 | BASE_EXPORT uint64 RandUint64(); |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 17 | |
| 18 | // Returns a random number between min and max (inclusive). Thread-safe. |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 19 | BASE_EXPORT int RandInt(int min, int max); |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 20 | |
dilmah@chromium.org | bd36573 | 2011-08-25 04:58:36 +0900 | [diff] [blame] | 21 | // Returns a random number in range [0, range). Thread-safe. |
isherman@chromium.org | 01eaa0b | 2010-08-31 06:07:05 +0900 | [diff] [blame] | 22 | // |
| 23 | // Note that this can be used as an adapter for std::random_shuffle(): |
| 24 | // Given a pre-populated |std::vector<int> myvector|, shuffle it as |
| 25 | // std::random_shuffle(myvector.begin(), myvector.end(), base::RandGenerator); |
dilmah@chromium.org | bd36573 | 2011-08-25 04:58:36 +0900 | [diff] [blame] | 26 | BASE_EXPORT uint64 RandGenerator(uint64 range); |
isherman@chromium.org | 01eaa0b | 2010-08-31 06:07:05 +0900 | [diff] [blame] | 27 | |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 28 | // Returns a random double in range [0, 1). Thread-safe. |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 29 | BASE_EXPORT double RandDouble(); |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 30 | |
joi@chromium.org | df3561d | 2011-05-11 02:18:53 +0900 | [diff] [blame] | 31 | // Given input |bits|, convert with maximum precision to a double in |
| 32 | // the range [0, 1). Thread-safe. |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 33 | BASE_EXPORT double BitsToOpenEndedUnitInterval(uint64 bits); |
joi@chromium.org | df3561d | 2011-05-11 02:18:53 +0900 | [diff] [blame] | 34 | |
mniknami@chromium.org | f4331ae | 2012-08-03 05:22:25 +0900 | [diff] [blame] | 35 | // Fills |output_length| bytes of |output| with random data. |
| 36 | // |
| 37 | // WARNING: |
| 38 | // Do not use for security-sensitive purposes. |
| 39 | // See crypto/ for cryptographically secure random number generation APIs. |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 40 | BASE_EXPORT void RandBytes(void* output, size_t output_length); |
qsr@google.com | fbda4d5 | 2011-05-05 17:46:11 +0900 | [diff] [blame] | 41 | |
thestig@chromium.org | ce9eaed | 2014-05-13 14:56:19 +0900 | [diff] [blame] | 42 | // Fills a string of length |length| with random data and returns it. |
mniknami@chromium.org | f4331ae | 2012-08-03 05:22:25 +0900 | [diff] [blame] | 43 | // |length| should be nonzero. |
qsr@google.com | fbda4d5 | 2011-05-05 17:46:11 +0900 | [diff] [blame] | 44 | // |
pkasting@chromium.org | d347937 | 2011-11-30 05:06:18 +0900 | [diff] [blame] | 45 | // Note that this is a variation of |RandBytes| with a different return type. |
thestig@chromium.org | ce9eaed | 2014-05-13 14:56:19 +0900 | [diff] [blame] | 46 | // The returned string is likely not ASCII/UTF-8. Use with care. |
mniknami@chromium.org | f4331ae | 2012-08-03 05:22:25 +0900 | [diff] [blame] | 47 | // |
| 48 | // WARNING: |
| 49 | // Do not use for security-sensitive purposes. |
| 50 | // See crypto/ for cryptographically secure random number generation APIs. |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 51 | BASE_EXPORT std::string RandBytesAsString(size_t length); |
abarth@chromium.org | c19cb31 | 2011-04-30 06:03:54 +0900 | [diff] [blame] | 52 | |
dbeam@chromium.org | e888849 | 2013-03-24 04:10:54 +0900 | [diff] [blame] | 53 | #if defined(OS_POSIX) |
mseaborn@chromium.org | 056521b | 2012-05-30 23:26:13 +0900 | [diff] [blame] | 54 | BASE_EXPORT int GetUrandomFD(); |
| 55 | #endif |
| 56 | |
mark@chromium.org | b93c054 | 2008-09-30 07:18:01 +0900 | [diff] [blame] | 57 | } // namespace base |
| 58 | |
erg@google.com | bf6ce9f | 2010-01-27 08:08:02 +0900 | [diff] [blame] | 59 | #endif // BASE_RAND_UTIL_H_ |