5b281ba489ca18f0380d7efc7a5108b606cce449vboxsync * IPRT - Random Numbers and Byte Streams.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2012 Oracle Corporation
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * available from http://www.virtualbox.org. This file is free software;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * The contents of this file may alternatively be used under the terms
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * of the Common Development and Distribution License Version 1.0
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution, in which case the provisions of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * CDDL are applicable instead of those of the GPL.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * You may elect to license modified versions of this file under the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * terms and conditions of either the GPL or the CDDL or both.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/** @defgroup grp_rt_rand RTRand - Random Numbers and Byte Streams
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @ingroup grp_rt
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Fills a buffer with random bytes.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param pv Where to store the random bytes.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param cb Number of bytes to generate.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsyncRTDECL(void) RTRandBytes(void *pv, size_t cb) RT_NO_THROW;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit signed random number in the set [i32First..i32Last].
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param i32First First number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param i32Last Last number in the set.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsyncRTDECL(int32_t) RTRandS32Ex(int32_t i32First, int32_t i32Last) RT_NO_THROW;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit signed random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit unsigned random number in the set [u32First..u32Last].
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u32First First number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u32Last Last number in the set.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsyncRTDECL(uint32_t) RTRandU32Ex(uint32_t u32First, uint32_t u32Last) RT_NO_THROW;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit unsigned random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * Generate a 64-bit signed random number in the set [i64First..i64Last].
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @param i64First First number in the set.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @param i64Last Last number in the set.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsyncRTDECL(int64_t) RTRandS64Ex(int64_t i64First, int64_t i64Last) RT_NO_THROW;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 64-bit signed random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 64-bit unsigned random number in the set [u64First..u64Last].
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u64First First number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u64Last Last number in the set.
40af749e457b7d704c869ea986a042f0d4b6e09avboxsyncRTDECL(uint64_t) RTRandU64Ex(uint64_t u64First, uint64_t u64Last) RT_NO_THROW;
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 64-bit unsigned random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Create an instance of the default random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync * @param phRand Where to return the handle to the new random number
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync * generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int) RTRandAdvCreate(PRTRAND phRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Create an instance of the default pseudo random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param phRand Where to store the handle to the generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int) RTRandAdvCreatePseudo(PRTRAND phRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Create an instance of the Park-Miller pseudo random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param phRand Where to store the handle to the generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int) RTRandAdvCreateParkMiller(PRTRAND phRand) RT_NO_THROW;
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * Create an instance of the faster random number generator for the OS.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @returns IPRT status code.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * @retval VERR_NOT_SUPPORTED on platforms which doesn't have this feature.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * @retval VERR_FILE_NOT_FOUND on system where the random generator hasn't
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * been installed or configured correctly.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * @retval VERR_PATH_NOT_FOUND for the same reasons as VERR_FILE_NOT_FOUND.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param phRand Where to store the handle to the generator.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @remarks Think /dev/urandom.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsyncRTDECL(int) RTRandAdvCreateSystemFaster(PRTRAND phRand) RT_NO_THROW;
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * Create an instance of the truer random number generator for the OS.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * Don't use this unless you seriously need good random numbers because most
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * systems will have will have problems producing sufficient entropy for this
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * and you'll end up blocking while it accumulates.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @returns IPRT status code.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * @retval VERR_NOT_SUPPORTED on platforms which doesn't have this feature.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * @retval VERR_FILE_NOT_FOUND on system where the random generator hasn't
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * been installed or configured correctly.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsync * @retval VERR_PATH_NOT_FOUND for the same reasons as VERR_FILE_NOT_FOUND.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param phRand Where to store the handle to the generator.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @remarks Think /dev/random.
6cb96ab7d4ba4dab39ef47e8d7c3dcfbf7582959vboxsyncRTDECL(int) RTRandAdvCreateSystemTruer(PRTRAND phRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Destroys a random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int) RTRandAdvDestroy(RTRAND hRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generic method for seeding of a random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * The different generators may have specialized methods for
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * seeding, use one of those if you desire better control
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * over the result.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VERR_NOT_SUPPORTED if it isn't a pseudo generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64Seed Seed.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int) RTRandAdvSeed(RTRAND hRand, uint64_t u64Seed) RT_NO_THROW;
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * Save the current state of a pseudo generator.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * This can be use to save the state so it can later be resumed at the same
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * position.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @returns IPRT status code.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VINF_SUCCESS on success. *pcbState contains the length of the
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * returned string and pszState contains the state string.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VERR_BUFFER_OVERFLOW if the supplied buffer is too small. *pcbState
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * will contain the necessary buffer size.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VERR_NOT_SUPPORTED by non-psuedo generators.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param hRand Handle to the random number generator.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param pszState Where to store the state. The returned string will be
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * null terminated and printable.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param pcbState The size of the buffer pszState points to on input, the
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * size required / used on return (including the
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * terminator, thus the 'cb' instead of 'cch').
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsyncRTDECL(int) RTRandAdvSaveState(RTRAND hRand, char *pszState, size_t *pcbState) RT_NO_THROW;
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * Restores the state of a pseudo generator.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * The state must have been obtained using RTRandAdvGetState.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @returns IPRT status code.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VERR_PARSE_ERROR if the state string is malformed.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VERR_NOT_SUPPORTED by non-psuedo generators.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param hRand Handle to the random number generator.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param pszState The state to load.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsyncRTDECL(int) RTRandAdvRestoreState(RTRAND hRand, char const *pszState) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Fills a buffer with random bytes.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pv Where to store the random bytes.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param cb Number of bytes to generate.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(void) RTRandAdvBytes(RTRAND hRand, void *pv, size_t cb) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 32-bit signed random number in the set [i32First..i32Last].
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param i32First First number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param i32Last Last number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int32_t) RTRandAdvS32Ex(RTRAND hRand, int32_t i32First, int32_t i32Last) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 32-bit signed random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int32_t) RTRandAdvS32(RTRAND hRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 32-bit unsigned random number in the set [u32First..u32Last].
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u32First First number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u32Last Last number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(uint32_t) RTRandAdvU32Ex(RTRAND hRand, uint32_t u32First, uint32_t u32Last) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 32-bit unsigned random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(uint32_t) RTRandAdvU32(RTRAND hRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 64-bit signed random number in the set [i64First..i64Last].
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param i64First First number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param i64Last Last number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int64_t) RTRandAdvS64Ex(RTRAND hRand, int64_t i64First, int64_t i64Last) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 64-bit signed random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(int64_t) RTRandAdvS64(RTRAND hRand) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 64-bit unsigned random number in the set [u64First..u64Last].
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64First First number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64Last Last number in the set.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncRTDECL(uint64_t) RTRandAdvU64Ex(RTRAND hRand, uint64_t u64First, uint64_t u64Last) RT_NO_THROW;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generate a 64-bit unsigned random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param hRand Handle to the random number generator.