summaryrefslogtreecommitdiffstats
path: root/src/VBox/Runtime/include/internal/rand.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-11 08:17:27 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-11 08:17:27 +0000
commitf215e02bf85f68d3a6106c2a1f4f7f063f819064 (patch)
tree6bb5b92c046312c4e95ac2620b10ddf482d3fa8b /src/VBox/Runtime/include/internal/rand.h
parentInitial commit. (diff)
downloadvirtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.tar.xz
virtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.zip
Adding upstream version 7.0.14-dfsg.upstream/7.0.14-dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/VBox/Runtime/include/internal/rand.h')
-rw-r--r--src/VBox/Runtime/include/internal/rand.h188
1 files changed, 188 insertions, 0 deletions
diff --git a/src/VBox/Runtime/include/internal/rand.h b/src/VBox/Runtime/include/internal/rand.h
new file mode 100644
index 00000000..b5becdaf
--- /dev/null
+++ b/src/VBox/Runtime/include/internal/rand.h
@@ -0,0 +1,188 @@
+/* $Id: rand.h $ */
+/** @file
+ * IPRT - Internal RTRand header
+ */
+
+/*
+ * Copyright (C) 2006-2023 Oracle and/or its affiliates.
+ *
+ * This file is part of VirtualBox base platform packages, as
+ * available from https://www.virtualbox.org.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, in version 3 of the
+ * License.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses>.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
+ * in the VirtualBox distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
+ */
+
+#ifndef IPRT_INCLUDED_INTERNAL_rand_h
+#define IPRT_INCLUDED_INTERNAL_rand_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <iprt/types.h>
+#include <iprt/critsect.h>
+
+/** Pointer to a random number generator instance. */
+typedef struct RTRANDINT *PRTRANDINT;
+
+/**
+ * Random number generator instance.
+ *
+ * @remarks Not sure if it makes sense to have three random getters...
+ */
+typedef struct RTRANDINT
+{
+ /** Magic value (RTRANDINT_MAGIC). */
+ uint32_t u32Magic;
+#if 0 /** @todo later. */
+ /** Fast mutex semaphore that serializes the access, this is optional. */
+ PRTCRITSECT pCritSect;
+#endif
+
+ /**
+ * Generates random bytes.
+ *
+ * @param pThis Pointer to the instance data.
+ * @param pb Where to store the bytes.
+ * @param cb The number of bytes to produce.
+ */
+ DECLCALLBACKMEMBER(void , pfnGetBytes,(PRTRANDINT pThis, uint8_t *pb, size_t cb));
+
+ /**
+ * Generates a unsigned 32-bit random number.
+ *
+ * @returns The random number.
+ * @param pThis Pointer to the instance data.
+ * @param u32First The first number in the range.
+ * @param u32Last The last number in the range (i.e. inclusive).
+ */
+ DECLCALLBACKMEMBER(uint32_t, pfnGetU32,(PRTRANDINT pThis, uint32_t u32First, uint32_t u32Last));
+
+ /**
+ * Generates a unsigned 64-bit random number.
+ *
+ * @returns The random number.
+ * @param pThis Pointer to the instance data.
+ * @param u64First The first number in the range.
+ * @param u64Last The last number in the range (i.e. inclusive).
+ */
+ DECLCALLBACKMEMBER(uint64_t, pfnGetU64,(PRTRANDINT pThis, uint64_t u64First, uint64_t u64Last));
+
+ /**
+ * Generic seeding.
+ *
+ * @returns IPRT status code.
+ * @retval VERR_NOT_SUPPORTED if it isn't a pseudo generator.
+ *
+ * @param pThis Pointer to the instance data.
+ * @param u64Seed The seed.
+ */
+ DECLCALLBACKMEMBER(int, pfnSeed,(PRTRANDINT pThis, uint64_t u64Seed));
+
+ /**
+ * Save the current state of a pseudo generator.
+ *
+ * This can be use to save the state so it can later be resumed at the same
+ * position.
+ *
+ * @returns IPRT status code.
+ * @retval VINF_SUCCESS on success. *pcbState contains the length of the
+ * returned string and pszState contains the state string.
+ * @retval VERR_BUFFER_OVERFLOW if the supplied buffer is too small. *pcbState
+ * will contain the necessary buffer size.
+ * @retval VERR_NOT_SUPPORTED by non-psuedo generators.
+ *
+ * @param pThis Pointer to the instance data.
+ * @param pszState Where to store the state. The returned string will be
+ * null terminated and printable.
+ * @param pcbState The size of the buffer pszState points to on input, the
+ * size required / used on return (including the
+ * terminator, thus the 'cb' instead of 'cch').
+ */
+ DECLCALLBACKMEMBER(int, pfnSaveState,(PRTRANDINT pThis, char *pszState, size_t *pcbState));
+
+ /**
+ * Restores the state of a pseudo generator.
+ *
+ * The state must have been obtained using pfnGetState.
+ *
+ * @returns IPRT status code.
+ * @retval VERR_PARSE_ERROR if the state string is malformed.
+ * @retval VERR_NOT_SUPPORTED by non-psuedo generators.
+ *
+ * @param pThis Pointer to the instance data.
+ * @param pszState The state to load.
+ */
+ DECLCALLBACKMEMBER(int, pfnRestoreState,(PRTRANDINT pThis, char const *pszState));
+
+ /**
+ * Destroys the instance.
+ *
+ * The callee is responsible for freeing all resources, including
+ * the instance data.
+ *
+ * @returns IPRT status code. State undefined on failure.
+ * @param pThis Pointer to the instance data.
+ */
+ DECLCALLBACKMEMBER(int, pfnDestroy,(PRTRANDINT pThis));
+
+ /** Union containing the specific state info for each generator. */
+ union
+ {
+ struct RTRandParkMiller
+ {
+ /** The context. */
+ uint32_t u32Ctx;
+ /** The number of single bits used to fill in the 31st bit. */
+ uint32_t u32Bits;
+ /** The number bits in u32Bits. */
+ uint32_t cBits;
+ } ParkMiller;
+
+ struct RTRandFile
+ {
+ /** The file handle (native). */
+ intptr_t hFile;
+ } File;
+ } u;
+} RTRANDINT;
+
+
+RT_C_DECLS_BEGIN
+
+DECL_HIDDEN_CALLBACK(void) rtRandAdvSynthesizeBytesFromU32(PRTRANDINT pThis, uint8_t *pb, size_t cb);
+DECL_HIDDEN_CALLBACK(void) rtRandAdvSynthesizeBytesFromU64(PRTRANDINT pThis, uint8_t *pb, size_t cb);
+DECL_HIDDEN_CALLBACK(uint32_t) rtRandAdvSynthesizeU32FromBytes(PRTRANDINT pThis, uint32_t u32First, uint32_t u32Last);
+DECL_HIDDEN_CALLBACK(uint32_t) rtRandAdvSynthesizeU32FromU64(PRTRANDINT pThis, uint32_t u32First, uint32_t u32Last);
+DECL_HIDDEN_CALLBACK(uint64_t) rtRandAdvSynthesizeU64FromBytes(PRTRANDINT pThis, uint64_t u64First, uint64_t u64Last);
+DECL_HIDDEN_CALLBACK(uint64_t) rtRandAdvSynthesizeU64FromU32(PRTRANDINT pThis, uint64_t u64First, uint64_t u64Last);
+DECL_HIDDEN_CALLBACK(int) rtRandAdvStubSeed(PRTRANDINT pThis, uint64_t u64Seed);
+DECL_HIDDEN_CALLBACK(int) rtRandAdvStubSaveState(PRTRANDINT pThis, char *pszState, size_t *pcbState);
+DECL_HIDDEN_CALLBACK(int) rtRandAdvStubRestoreState(PRTRANDINT pThis, char const *pszState);
+DECL_HIDDEN_CALLBACK(int) rtRandAdvDefaultDestroy(PRTRANDINT pThis);
+
+RT_C_DECLS_END
+
+#endif /* !IPRT_INCLUDED_INTERNAL_rand_h */
+