xref: /freebsd/crypto/openssl/doc/man3/OPENSSL_LH_stats.pod (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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, how
27many entries are in it, and the number and result of calls to the
28routines in this library.
29
30OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
31hash table.
32
33OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
34hash table.  It prints the 'load' and the 'actual load'.  The load is
35the average number of data items per 'bucket' in the hash table.  The
36'actual load' is the average number of items per 'bucket', but only
37for buckets which contain entries.  So the 'actual load' is the
38average number of searches that will need to find an item in the hash
39table, while the 'load' is the average number that will be done to
40record a miss.
41
42OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
43are the same as the above, except that the output goes to a B<BIO>.
44
45=head1 RETURN VALUES
46
47These functions do not return values.
48
49=head1 NOTE
50
51These calls should be made under a read lock. Refer to
52L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required
53when using the LHASH data structure.
54
55=head1 SEE ALSO
56
57L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)>
58
59=head1 COPYRIGHT
60
61Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
62
63Licensed under the OpenSSL license (the "License").  You may not use
64this file except in compliance with the License.  You can obtain a copy
65in the file LICENSE in the source distribution or at
66L<https://www.openssl.org/source/license.html>.
67
68=cut
69