| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OPENSSL_INSTRUMENT_BUS 3SSL" |
| 58 |
.TH OPENSSL_INSTRUMENT_BUS 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
OPENSSL_instrument_bus, OPENSSL_instrument_bus2 \- instrument references to memory bus |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
The following functions have been deprecated since OpenSSL 3.6, and will |
| 68 |
be removed in a future release. They should no longer be used. |
| 69 |
.PP |
| 70 |
.Vb 4 |
| 71 |
\& #ifdef OPENSSL_CPUID_OBJ |
| 72 |
\& size_t OPENSSL_instrument_bus(unsigned int *vector, size_t num); |
| 73 |
\& size_t OPENSSL_instrument_bus2(unsigned int *vector, size_t num, size_t max); |
| 74 |
\& #endif |
| 75 |
.Ve |
| 76 |
.SH DESCRIPTION |
| 77 |
.IX Header "DESCRIPTION" |
| 78 |
It was empirically found that timings of references to primary memory |
| 79 |
are subject to irregular, apparently non-deterministic variations. The |
| 80 |
subroutines in question instrument these references for purposes of |
| 81 |
gathering randomness for random number generator. In order to make it |
| 82 |
bus-bound a 'flush cache line' instruction is used between probes. In |
| 83 |
addition probes are added to \fBvector\fR elements in atomic or |
| 84 |
interlocked manner, which should contribute additional noise on |
| 85 |
multi-processor systems. This also means that \fBvector[num]\fR should be |
| 86 |
zeroed upon invocation (if you want to retrieve actual probe values). |
| 87 |
.PP |
| 88 |
\&\fBOPENSSL_instrument_bus()\fR performs \fBnum\fR probes and records the number of |
| 89 |
oscillator cycles every probe took. |
| 90 |
.PP |
| 91 |
\&\fBOPENSSL_instrument_bus2()\fR on the other hand \fBaccumulates\fR consecutive |
| 92 |
probes with the same value, i.e. in a way it records duration of |
| 93 |
periods when probe values appeared deterministic. The subroutine |
| 94 |
performs at most \fBmax\fR probes in attempt to fill the \fBvector[num]\fR, |
| 95 |
with \fBmax\fR value of 0 meaning "as many as it takes." |
| 96 |
.SH "RETURN VALUES" |
| 97 |
.IX Header "RETURN VALUES" |
| 98 |
Return value of 0 indicates that CPU is not capable of performing the |
| 99 |
benchmark, either because oscillator counter or 'flush cache line' is |
| 100 |
not available on current platform. For reference, on x86 'flush cache |
| 101 |
line' was introduced with the SSE2 extensions. |
| 102 |
.PP |
| 103 |
Otherwise number of recorded values is returned. |
| 104 |
.SH COPYRIGHT |
| 105 |
.IX Header "COPYRIGHT" |
| 106 |
Copyright 2011\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 107 |
.PP |
| 108 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 109 |
this file except in compliance with the License. You can obtain a copy |
| 110 |
in the file LICENSE in the source distribution or at |
| 111 |
<https://www.openssl.org/source/license.html>. |