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