Debian Codegraph @

upstream/debian-unstable/man3/OPENSSL_LH_stats.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_LH_STATS 3SSL"
58 .TH OPENSSL_LH_STATS 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_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
65 OPENSSL_LH_stats_bio,
66 OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio \- LHASH statistics
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/lhash.h>
71 .Ve
72 .PP
73 The following functions have been deprecated since OpenSSL 3.1, and can be
74 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
75 see \fBopenssl_user_macros\fR\|(7):
76 .PP
77 .Vb 2
78 \& void OPENSSL_LH_node_stats(LHASH *table, FILE *out);
79 \& void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *out);
80 \&
81 \& void OPENSSL_LH_node_stats_bio(LHASH *table, BIO *out);
82 \& void OPENSSL_LH_node_usage_stats_bio(LHASH *table, BIO *out);
83 \&
84 \& void OPENSSL_LH_stats(LHASH *table, FILE *out);
85 \& void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
86 .Ve
87 .SH DESCRIPTION
88 .IX Header "DESCRIPTION"
89 The \fBLHASH\fR structure records statistics about most aspects of
90 accessing the hash table.
91 .PP
92 \&\fBOPENSSL_LH_stats()\fR prints out statistics on the size of the hash table and how
93 many entries are in it. For historical reasons, this function also outputs a
94 number of additional statistics, but the tracking of these statistics is no
95 longer supported and these statistics are always reported as zero.
96 .PP
97 \&\fBOPENSSL_LH_node_stats()\fR prints the number of entries for each 'bucket' in the
98 hash table.
99 .PP
100 \&\fBOPENSSL_LH_node_usage_stats()\fR prints out a short summary of the state of the
101 hash table. It prints the 'load' and the 'actual load'. The load is
102 the average number of data items per 'bucket' in the hash table. The
103 \&'actual load' is the average number of items per 'bucket', but only
104 for buckets which contain entries. So the 'actual load' is the
105 average number of searches that will need to find an item in the hash
106 table, while the 'load' is the average number that will be done to
107 record a miss.
108 .PP
109 \&\fBOPENSSL_LH_stats_bio()\fR, \fBOPENSSL_LH_node_stats_bio()\fR and \fBOPENSSL_LH_node_usage_stats_bio()\fR
110 are the same as the above, except that the output goes to a \fBBIO\fR.
111 .PP
112 These functions are deprecated and should no longer be used.
113 .SH "RETURN VALUES"
114 .IX Header "RETURN VALUES"
115 These functions do not return values.
116 .SH NOTE
117 .IX Header "NOTE"
118 These calls should be made under a read lock. Refer to
119 "NOTE" in \fBOPENSSL_LH_COMPFUNC\fR\|(3) for more details about the locks required
120 when using the LHASH data structure.
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 \&\fBbio\fR\|(7), \fBOPENSSL_LH_COMPFUNC\fR\|(3)
124 .SH HISTORY
125 .IX Header "HISTORY"
126 These functions were deprecated in version 3.1.
127 .SH COPYRIGHT
128 .IX Header "COPYRIGHT"
129 Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved.
130 .PP
131 Licensed under the Apache License 2.0 (the "License"). You may not use
132 this file except in compliance with the License. You can obtain a copy
133 in the file LICENSE in the source distribution or at
134 <https://www.openssl.org/source/license.html>.