rand.h revision cb13ee8e628d04a773894bf4f9e8047d74f2ee21
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/** @file
c97989161fbe75bc14cea477a5443bbf474dd3advboxsync * innotek Portable Runtime - Random Numbers and Byte Streams.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/*
c97989161fbe75bc14cea477a5443bbf474dd3advboxsync * Copyright (C) 2006-2007 innotek GmbH
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync *
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 *
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 *
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 */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
154e1d5579ca6c8bee571a8d1ced5d76a0234030vboxsync#ifndef ___iprt_rand_h
154e1d5579ca6c8bee571a8d1ced5d76a0234030vboxsync#define ___iprt_rand_h
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync#include <iprt/cdefs.h>
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync#include <iprt/types.h>
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync__BEGIN_DECLS
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/** @defgroup grp_rt_rand RTRand - Random Numbers and Byte Streams
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @ingroup grp_rt
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @{
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Fills a buffer with random bytes.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param pv Where to store the random bytes.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param cb Number of bytes to generate.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(void) RTRandBytes(void *pv, size_t cb);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit signed random number in the set [i32First..i32Last].
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param i32First First number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param i32Last Last number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(int32_t) RTRandS32Ex(int32_t i32First, int32_t i32Last);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit signed random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(int32_t) RTRandS32(void);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit unsigned random number in the set [u32First..u32Last].
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u32First First number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u32Last Last number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(uint32_t) RTRandU32Ex(uint32_t u32First, uint32_t u32Last);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 32-bit unsigned random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(uint32_t) RTRandU32(void);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * Generate a 64-bit signed random number in the set [i64First..i64Last].
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @param i64First First number in the set.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @param i64Last Last number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(int64_t) RTRandS64Ex(int64_t i64First, int64_t i64Last);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 64-bit signed random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(int64_t) RTRandS64(void);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 64-bit unsigned random number in the set [u64First..u64Last].
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u64First First number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @param u64Last Last number in the set.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(uint64_t) RTRandU64Ex(uint64_t u64First, uint64_t u64Last);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/**
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * Generate a 64-bit unsigned random number.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync *
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync * @returns The random number.
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsyncRTDECL(uint64_t) RTRandU64(void);
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync/** @} */
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync__END_DECLS
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync#endif
07db1daf0ffed7a0fe1224c296fc1e7ac40d7681vboxsync