doc/man3/OPENSSL_LH_stats.pod

   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_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);
  16
  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);
  20
  21 =head1 DESCRIPTION
  22
  23 The B<LHASH> structure records statistics about most aspects of
  24 accessing the hash table.
  25
  26 OPENSSL_LH_stats() prints out statistics on the size of the hash table and how
  27 many entries are in it. For historical reasons, this function also outputs a
  28 number of additional statistics, but the tracking of these statistics is no
  29 longer supported and these statistics are always reported as zero.
  30
  31 OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
  32 hash table.
  33
  34 OPENSSL_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 OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_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 NOTE
  51
  52 These calls should be made under a read lock. Refer to
  53 L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required
  54 when using the LHASH data structure.
  55
  56 =head1 SEE ALSO
  57
  58 L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)>
  59
  60 =head1 COPYRIGHT
  61
  62 Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
  63
  64 Licensed under the Apache License 2.0 (the "License").  You may not use
  65 this file except in compliance with the License.  You can obtain a copy
  66 in the file LICENSE in the source distribution or at
  67 L<https://www.openssl.org/source/license.html>.
  68
  69 =cut