Debian Codegraph @

upstream/debian-trixie/man3/OPENSSL_instrument_bus.3ssl

raw
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.5.6 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 .Vb 4
68 \& #ifdef OPENSSL_CPUID_OBJ
69 \& size_t OPENSSL_instrument_bus(unsigned int *vector, size_t num);
70 \& size_t OPENSSL_instrument_bus2(unsigned int *vector, size_t num, size_t max);
71 \& #endif
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 It was empirically found that timings of references to primary memory
76 are subject to irregular, apparently non-deterministic variations. The
77 subroutines in question instrument these references for purposes of
78 gathering randomness for random number generator. In order to make it
79 bus-bound a 'flush cache line' instruction is used between probes. In
80 addition probes are added to \fBvector\fR elements in atomic or
81 interlocked manner, which should contribute additional noise on
82 multi-processor systems. This also means that \fBvector[num]\fR should be
83 zeroed upon invocation (if you want to retrieve actual probe values).
84 .PP
85 \&\fBOPENSSL_instrument_bus()\fR performs \fBnum\fR probes and records the number of
86 oscillator cycles every probe took.
87 .PP
88 \&\fBOPENSSL_instrument_bus2()\fR on the other hand \fBaccumulates\fR consecutive
89 probes with the same value, i.e. in a way it records duration of
90 periods when probe values appeared deterministic. The subroutine
91 performs at most \fBmax\fR probes in attempt to fill the \fBvector[num]\fR,
92 with \fBmax\fR value of 0 meaning "as many as it takes."
93 .SH "RETURN VALUES"
94 .IX Header "RETURN VALUES"
95 Return value of 0 indicates that CPU is not capable of performing the
96 benchmark, either because oscillator counter or 'flush cache line' is
97 not available on current platform. For reference, on x86 'flush cache
98 line' was introduced with the SSE2 extensions.
99 .PP
100 Otherwise number of recorded values is returned.
101 .SH COPYRIGHT
102 .IX Header "COPYRIGHT"
103 Copyright 2011\-2018 The OpenSSL Project Authors. All Rights Reserved.
104 .PP
105 Licensed under the Apache License 2.0 (the "License"). You may not use
106 this file except in compliance with the License. You can obtain a copy
107 in the file LICENSE in the source distribution or at
108 <https://www.openssl.org/source/license.html>.