xref: /openssl/doc/man3/OPENSSL_LH_stats.pod (revision 6a92159d)
1=pod
2
3=head1 NAME
4
5OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
6OPENSSL_LH_stats_bio,
7OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
8
9=head1 SYNOPSIS
10
11 #include <openssl/lhash.h>
12
13The following functions have been deprecated since OpenSSL 3.1, and can be
14hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
15see L<openssl_user_macros(7)>:
16
17 void OPENSSL_LH_node_stats(LHASH *table, FILE *out);
18 void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *out);
19
20 void OPENSSL_LH_node_stats_bio(LHASH *table, BIO *out);
21 void OPENSSL_LH_node_usage_stats_bio(LHASH *table, BIO *out);
22
23 void OPENSSL_LH_stats(LHASH *table, FILE *out);
24 void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
25
26=head1 DESCRIPTION
27
28The B<LHASH> structure records statistics about most aspects of
29accessing the hash table.
30
31OPENSSL_LH_stats() prints out statistics on the size of the hash table and how
32many entries are in it. For historical reasons, this function also outputs a
33number of additional statistics, but the tracking of these statistics is no
34longer supported and these statistics are always reported as zero.
35
36OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
37hash table.
38
39OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
40hash table.  It prints the 'load' and the 'actual load'.  The load is
41the average number of data items per 'bucket' in the hash table.  The
42'actual load' is the average number of items per 'bucket', but only
43for buckets which contain entries.  So the 'actual load' is the
44average number of searches that will need to find an item in the hash
45table, while the 'load' is the average number that will be done to
46record a miss.
47
48OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
49are the same as the above, except that the output goes to a B<BIO>.
50
51These functions are deprecated and should no longer be used.
52
53=head1 RETURN VALUES
54
55These functions do not return values.
56
57=head1 NOTE
58
59These calls should be made under a read lock. Refer to
60L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required
61when using the LHASH data structure.
62
63=head1 SEE ALSO
64
65L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)>
66
67=head1 HISTORY
68
69These functions were deprecated in version 3.1.
70
71=head1 COPYRIGHT
72
73Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
74
75Licensed under the Apache License 2.0 (the "License").  You may not use
76this file except in compliance with the License.  You can obtain a copy
77in the file LICENSE in the source distribution or at
78L<https://www.openssl.org/source/license.html>.
79
80=cut
81