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