doc/crypto/lh_stats.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 lh_stats, lh_node_stats, lh_node_usage_stats, lh_stats_bio,
   6 lh_node_stats_bio, lh_node_usage_stats_bio - LHASH statistics
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/lhash.h>
  11
  12  void lh_stats(LHASH *table, FILE *out);
  13  void lh_node_stats(LHASH *table, FILE *out);
  14  void lh_node_usage_stats(LHASH *table, FILE *out);
  15
  16  void lh_stats_bio(LHASH *table, BIO *out);
  17  void lh_node_stats_bio(LHASH *table, BIO *out);
  18  void lh_node_usage_stats_bio(LHASH *table, BIO *out);
  19
  20 =head1 DESCRIPTION
  21
  22 The B<LHASH> structure records statistics about most aspects of
  23 accessing the hash table.  This is mostly a legacy of Eric Young
  24 writing this library for the reasons of implementing what looked like
  25 a nice algorithm rather than for a particular software product.
  26
  27 lh_stats() prints out statistics on the size of the hash table, how
  28 many entries are in it, and the number and result of calls to the
  29 routines in this library.
  30
  31 lh_node_stats() prints the number of entries for each 'bucket' in the
  32 hash table.
  33
  34 lh_node_usage_stats() prints out a short summary of the state of the
  35 hash table.  It prints the 'load' and the 'actual load'.  The load is
  36 the average number of data items per 'bucket' in the hash table.  The
  37 'actual load' is the average number of items per 'bucket', but only
  38 for buckets which contain entries.  So the 'actual load' is the
  39 average number of searches that will need to find an item in the hash
  40 table, while the 'load' is the average number that will be done to
  41 record a miss.
  42
  43 lh_stats_bio(), lh_node_stats_bio() and lh_node_usage_stats_bio()
  44 are the same as the above, except that the output goes to a B<BIO>.
  45
  46 =head1 RETURN VALUES
  47
  48 These functions do not return values.
  49
  50 =head1 SEE ALSO
  51
  52 L<bio(3)>, L<lhash(3)>
  53
  54 =cut
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  59
  60 Licensed under the OpenSSL license (the "License").  You may not use
  61 this file except in compliance with the License.  You can obtain a copy
  62 in the file LICENSE in the source distribution or at
  63 L<https://www.openssl.org/source/license.html>.
  64
  65 =cut