1OPENSSL_LH_STATS(3ossl)             OpenSSL            OPENSSL_LH_STATS(3ossl)
2
3
4

NAME

6       OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
7       OPENSSL_LH_stats_bio, OPENSSL_LH_node_stats_bio,
8       OPENSSL_LH_node_usage_stats_bio - LHASH statistics
9

SYNOPSIS

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
20       be hidden entirely by defining OPENSSL_API_COMPAT with a suitable
21       version value, see 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

DESCRIPTION

27       The LHASH structure records statistics about most aspects of accessing
28       the hash table.
29
30       OPENSSL_LH_stats() prints out statistics on the size of the hash table
31       and how many entries are in it. For historical reasons, this function
32       also outputs a number of additional statistics, but the tracking of
33       these statistics is no longer supported and these statistics are always
34       reported as zero.
35
36       OPENSSL_LH_node_stats() prints the number of entries for each 'bucket'
37       in the hash table.
38
39       OPENSSL_LH_node_usage_stats() prints out a short summary of the state
40       of the hash table.  It prints the 'load' and the 'actual load'.  The
41       load is the average number of data items per 'bucket' in the hash
42       table.  The 'actual load' is the average number of items per 'bucket',
43       but only for buckets which contain entries.  So the 'actual load' is
44       the average number of searches that will need to find an item in the
45       hash 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
49       OPENSSL_LH_node_usage_stats_bio() are the same as the above, except
50       that the output goes to a BIO.
51
52       OPENSSH_LH_stats() and OPENSSH_LH_stats_bio() are deprecated and should
53       no longer be used.
54

RETURN VALUES

56       These functions do not return values.
57

NOTE

59       These calls should be made under a read lock. Refer to "NOTE" in
60       OPENSSL_LH_COMPFUNC(3) for more details about the locks required when
61       using the LHASH data structure.
62
63       The functions OPENSSH_LH_stats() and OPENSSH_LH_stats_bio() were
64       deprecated in version 3.1.
65

SEE ALSO

67       bio(7), OPENSSL_LH_COMPFUNC(3)
68

70       Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
71
72       Licensed under the Apache License 2.0 (the "License").  You may not use
73       this file except in compliance with the License.  You can obtain a copy
74       in the file LICENSE in the source distribution or at
75       <https://www.openssl.org/source/license.html>.
76
77
78
793.1.1                             2023-08-31           OPENSSL_LH_STATS(3ossl)
Impressum