]>
Commit | Line | Data |
---|---|---|
74235cc9 UM |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
739a1eb1 RS |
5 | OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats, |
6 | OPENSSL_LH_stats_bio, | |
7 | OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics | |
74235cc9 UM |
8 | |
9 | =head1 SYNOPSIS | |
10 | ||
11 | #include <openssl/lhash.h> | |
12 | ||
739a1eb1 RS |
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); | |
74235cc9 | 16 | |
739a1eb1 RS |
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); | |
74235cc9 UM |
20 | |
21 | =head1 DESCRIPTION | |
22 | ||
23 | The B<LHASH> structure records statistics about most aspects of | |
a95d7574 | 24 | accessing the hash table. |
74235cc9 | 25 | |
739a1eb1 | 26 | OPENSSL_LH_stats() prints out statistics on the size of the hash table, how |
74235cc9 UM |
27 | many entries are in it, and the number and result of calls to the |
28 | routines in this library. | |
29 | ||
739a1eb1 | 30 | OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the |
74235cc9 UM |
31 | hash table. |
32 | ||
739a1eb1 | 33 | OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the |
74235cc9 UM |
34 | hash table. It prints the 'load' and the 'actual load'. The load is |
35 | the 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 | |
37 | for buckets which contain entries. So the 'actual load' is the | |
38 | average number of searches that will need to find an item in the hash | |
39 | table, while the 'load' is the average number that will be done to | |
40 | record a miss. | |
41 | ||
739a1eb1 | 42 | OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio() |
74235cc9 UM |
43 | are the same as the above, except that the output goes to a B<BIO>. |
44 | ||
45 | =head1 RETURN VALUES | |
46 | ||
47 | These functions do not return values. | |
48 | ||
2e8b5d75 P |
49 | =head1 NOTE |
50 | ||
51 | These calls should be made under a read lock. Refer to | |
52 | L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required | |
53 | when using the LHASH data structure. | |
54 | ||
74235cc9 UM |
55 | =head1 SEE ALSO |
56 | ||
2e8b5d75 | 57 | L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)> |
74235cc9 | 58 | |
e2f92610 RS |
59 | =head1 COPYRIGHT |
60 | ||
2e8b5d75 | 61 | Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 RS |
62 | |
63 | Licensed under the OpenSSL license (the "License"). You may not use | |
64 | this file except in compliance with the License. You can obtain a copy | |
65 | in the file LICENSE in the source distribution or at | |
66 | L<https://www.openssl.org/source/license.html>. | |
67 | ||
68 | =cut |