xref: /onnv-gate/usr/src/common/openssl/doc/crypto/lh_stats.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948lh_stats, lh_node_stats, lh_node_usage_stats, lh_stats_bio,
6*2175Sjp161948lh_node_stats_bio, lh_node_usage_stats_bio - LHASH statistics
7*2175Sjp161948
8*2175Sjp161948=head1 SYNOPSIS
9*2175Sjp161948
10*2175Sjp161948 #include <openssl/lhash.h>
11*2175Sjp161948
12*2175Sjp161948 void lh_stats(LHASH *table, FILE *out);
13*2175Sjp161948 void lh_node_stats(LHASH *table, FILE *out);
14*2175Sjp161948 void lh_node_usage_stats(LHASH *table, FILE *out);
15*2175Sjp161948
16*2175Sjp161948 void lh_stats_bio(LHASH *table, BIO *out);
17*2175Sjp161948 void lh_node_stats_bio(LHASH *table, BIO *out);
18*2175Sjp161948 void lh_node_usage_stats_bio(LHASH *table, BIO *out);
19*2175Sjp161948
20*2175Sjp161948=head1 DESCRIPTION
21*2175Sjp161948
22*2175Sjp161948The B<LHASH> structure records statistics about most aspects of
23*2175Sjp161948accessing the hash table.  This is mostly a legacy of Eric Young
24*2175Sjp161948writing this library for the reasons of implementing what looked like
25*2175Sjp161948a nice algorithm rather than for a particular software product.
26*2175Sjp161948
27*2175Sjp161948lh_stats() prints out statistics on the size of the hash table, how
28*2175Sjp161948many entries are in it, and the number and result of calls to the
29*2175Sjp161948routines in this library.
30*2175Sjp161948
31*2175Sjp161948lh_node_stats() prints the number of entries for each 'bucket' in the
32*2175Sjp161948hash table.
33*2175Sjp161948
34*2175Sjp161948lh_node_usage_stats() prints out a short summary of the state of the
35*2175Sjp161948hash table.  It prints the 'load' and the 'actual load'.  The load is
36*2175Sjp161948the average number of data items per 'bucket' in the hash table.  The
37*2175Sjp161948'actual load' is the average number of items per 'bucket', but only
38*2175Sjp161948for buckets which contain entries.  So the 'actual load' is the
39*2175Sjp161948average number of searches that will need to find an item in the hash
40*2175Sjp161948table, while the 'load' is the average number that will be done to
41*2175Sjp161948record a miss.
42*2175Sjp161948
43*2175Sjp161948lh_stats_bio(), lh_node_stats_bio() and lh_node_usage_stats_bio()
44*2175Sjp161948are the same as the above, except that the output goes to a B<BIO>.
45*2175Sjp161948
46*2175Sjp161948=head1 RETURN VALUES
47*2175Sjp161948
48*2175Sjp161948These functions do not return values.
49*2175Sjp161948
50*2175Sjp161948=head1 SEE ALSO
51*2175Sjp161948
52*2175Sjp161948L<bio(3)|bio(3)>, L<lhash(3)|lhash(3)>
53*2175Sjp161948
54*2175Sjp161948=head1 HISTORY
55*2175Sjp161948
56*2175Sjp161948These functions are available in all versions of SSLeay and OpenSSL.
57*2175Sjp161948
58*2175Sjp161948This manpage is derived from the SSLeay documentation.
59*2175Sjp161948
60*2175Sjp161948=cut
61