blob: 10f1026b30795c845aaccbab0a242bdff8633b0b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) 2015-2018 Linaro Limited
*/
/**
* @file
*
* ODP random number API
*/
#ifndef ODP_API_SPEC_RANDOM_H_
#define ODP_API_SPEC_RANDOM_H_
#include <odp/visibility_begin.h>
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/api/random_types.h>
#include <odp/api/std_types.h>
/** @addtogroup odp_random
* Random number generation.
* @{
*/
/**
* Query random max kind
*
* Implementations support the returned max kind and all kinds weaker than it.
*
* @return kind The maximum odp_random_kind_t supported by this implementation
*/
odp_random_kind_t odp_random_max_kind(void);
/**
* Generate random byte data
*
* The intent in supporting different kinds of random data is to allow
* tradeoffs between performance and the quality of random data needed. The
* assumption is that basic random is cheap while true random is relatively
* expensive in terms of time to generate, with cryptographic random being
* something in between. Implementations that support highly efficient true
* random are free to use this for all requested kinds. So it is always
* permissible to "upgrade" a random data request, but never to "downgrade"
* such requests.
*
* @param[out] buf Output buffer
* @param len Length of output buffer in bytes
* @param kind Specifies the type of random data required. Request
* is expected to fail if the implementation is unable to
* provide the requested type.
*
* @return Number of bytes written (0...len).
* @retval <0 on failure
*/
int32_t odp_random_data(uint8_t *buf, uint32_t len, odp_random_kind_t kind);
/**
* Generate repeatable random data for testing purposes
*
* For testing purposes it is often useful to generate "random" sequences that
* are repeatable. This is accomplished by supplying a seed value that is used
* for pseudo-random data generation. The caller-provided seed value is
* updated for each call to continue the sequence. Restarting the same series of
* calls with the same initial seed value will generate the same sequence of
* random test data.
*
* This function returns data of ODP_RANDOM_BASIC quality and should be used
* only for testing purposes. Use odp_random_data() for production.
*
* @param[out] buf Output buffer
* @param len Length of output buffer in bytes
* @param[in,out] seed Seed value to use. This must be a thread-local
* variable. Results are undefined if multiple threads
* call this routine with the same seed variable.
*
* @return Number of bytes written (always len)
* @retval <0 on failure
*/
int32_t odp_random_test_data(uint8_t *buf, uint32_t len, uint64_t *seed);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <odp/visibility_end.h>
#endif
|
