OPENSSL_LH_stats.pod 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. =pod
  2. =head1 NAME
  3. OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
  4. OPENSSL_LH_stats_bio,
  5. OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
  6. =head1 SYNOPSIS
  7. #include <openssl/lhash.h>
  8. void OPENSSL_LH_stats(LHASH *table, FILE *out);
  9. void OPENSSL_LH_node_stats(LHASH *table, FILE *out);
  10. void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *out);
  11. void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
  12. void OPENSSL_LH_node_stats_bio(LHASH *table, BIO *out);
  13. void OPENSSL_LH_node_usage_stats_bio(LHASH *table, BIO *out);
  14. =head1 DESCRIPTION
  15. The B<LHASH> structure records statistics about most aspects of
  16. accessing the hash table.
  17. OPENSSL_LH_stats() prints out statistics on the size of the hash table, how
  18. many entries are in it, and the number and result of calls to the
  19. routines in this library.
  20. OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
  21. hash table.
  22. OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
  23. hash table. It prints the 'load' and the 'actual load'. The load is
  24. the average number of data items per 'bucket' in the hash table. The
  25. 'actual load' is the average number of items per 'bucket', but only
  26. for buckets which contain entries. So the 'actual load' is the
  27. average number of searches that will need to find an item in the hash
  28. table, while the 'load' is the average number that will be done to
  29. record a miss.
  30. OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
  31. are the same as the above, except that the output goes to a B<BIO>.
  32. =head1 RETURN VALUES
  33. These functions do not return values.
  34. =head1 NOTE
  35. These calls should be made under a read lock. Refer to
  36. L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required
  37. when using the LHASH data structure.
  38. =head1 SEE ALSO
  39. L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)>
  40. =head1 COPYRIGHT
  41. Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  42. Licensed under the Apache License 2.0 (the "License"). You may not use
  43. this file except in compliance with the License. You can obtain a copy
  44. in the file LICENSE in the source distribution or at
  45. L<https://www.openssl.org/source/license.html>.
  46. =cut