5b281ba489ca18f0380d7efc7a5108b606cce449vboxsync * IPRT - Internal RTRand header
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2011 Oracle Corporation
65d63f09bebb772a9549e353e9bd8cb8976913a7vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
65d63f09bebb772a9549e353e9bd8cb8976913a7vboxsync * available from http://www.virtualbox.org. This file is free software;
65d63f09bebb772a9549e353e9bd8cb8976913a7vboxsync * 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.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync/** Pointer to a random number generator instance. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Random number generator instance.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @remarks Not sure if it makes sense to have three random getters...
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Magic value (RTRANDINT_MAGIC). */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync#if 0 /** @todo later. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Fast mutex semaphore that serializes the access, this is optional. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generates random bytes.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pThis Pointer to the instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pb Where to store the bytes.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param cb The number of bytes to produce.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync DECLCALLBACKMEMBER(void , pfnGetBytes)(PRTRANDINT pThis, uint8_t *pb, size_t cb);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generates a unsigned 32-bit random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pThis Pointer to the instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u32First The first number in the range.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u32Last The last number in the range (i.e. inclusive).
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync DECLCALLBACKMEMBER(uint32_t, pfnGetU32)(PRTRANDINT pThis, uint32_t u32First, uint32_t u32Last);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generates a unsigned 64-bit random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns The random number.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pThis Pointer to the instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64First The first number in the range.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64Last The last number in the range (i.e. inclusive).
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync DECLCALLBACKMEMBER(uint64_t, pfnGetU64)(PRTRANDINT pThis, uint64_t u64First, uint64_t u64Last);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Generic seeding.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @retval VERR_NOT_SUPPORTED if it isn't a pseudo generator.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pThis Pointer to the instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param u64Seed The seed.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync DECLCALLBACKMEMBER(int, pfnSeed)(PRTRANDINT pThis, uint64_t u64Seed);
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.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync * @param pThis Pointer to the instance data.
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').
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync DECLCALLBACKMEMBER(int, pfnSaveState)(PRTRANDINT pThis, char *pszState, size_t *pcbState);
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * Restores the state of a pseudo generator.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * The state must have been obtained using pfnGetState.
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.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync * @param pThis Pointer to the instance data.
062b8a43e237d9e2edde03b5837d44506e35eb47vboxsync * @param pszState The state to load.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync DECLCALLBACKMEMBER(int, pfnRestoreState)(PRTRANDINT pThis, char const *pszState);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Destroys the instance.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * The callee is responsible for freeing all resources, including
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * the instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns IPRT status code. State undefined on failure.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pThis Pointer to the instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync DECLCALLBACKMEMBER(int, pfnDestroy)(PRTRANDINT pThis);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Union containing the specific state info for each generator. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The context. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The number of single bits used to fill in the 31st bit. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The number bits in u32Bits. */
dc0a54940789f994c84390cb4a9f03da0b492285vboxsync /** The file handle (native). */
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(void)) rtRandAdvSynthesizeBytesFromU32(PRTRANDINT pThis, uint8_t *pb, size_t cb);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(void)) rtRandAdvSynthesizeBytesFromU64(PRTRANDINT pThis, uint8_t *pb, size_t cb);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(uint32_t)) rtRandAdvSynthesizeU32FromBytes(PRTRANDINT pThis, uint32_t u32First, uint32_t u32Last);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(uint32_t)) rtRandAdvSynthesizeU32FromU64(PRTRANDINT pThis, uint32_t u32First, uint32_t u32Last);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(uint64_t)) rtRandAdvSynthesizeU64FromBytes(PRTRANDINT pThis, uint64_t u64First, uint64_t u64Last);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(uint64_t)) rtRandAdvSynthesizeU64FromU32(PRTRANDINT pThis, uint64_t u64First, uint64_t u64Last);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(int)) rtRandAdvStubSeed(PRTRANDINT pThis, uint64_t u64Seed);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(int)) rtRandAdvStubSaveState(PRTRANDINT pThis, char *pszState, size_t *pcbState);
5eda82e218d35ae0691febd531e1bfc0324cc4a6vboxsyncDECLHIDDEN(DECLCALLBACK(int)) rtRandAdvStubRestoreState(PRTRANDINT pThis, char const *pszState);