diff options
Diffstat (limited to 'src/lib/libcrypto/man/lh_stats.3')
-rw-r--r-- | src/lib/libcrypto/man/lh_stats.3 | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/lh_stats.3 b/src/lib/libcrypto/man/lh_stats.3 new file mode 100644 index 0000000000..b56bb81979 --- /dev/null +++ b/src/lib/libcrypto/man/lh_stats.3 | |||
@@ -0,0 +1,83 @@ | |||
1 | .Dd $Mdocdate: November 5 2016 $ | ||
2 | .Dt LH_STATS 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm lh_stats , | ||
6 | .Nm lh_node_stats , | ||
7 | .Nm lh_node_usage_stats , | ||
8 | .Nm lh_stats_bio , | ||
9 | .Nm lh_node_stats_bio , | ||
10 | .Nm lh_node_usage_stats_bio | ||
11 | .Nd LHASH statistics | ||
12 | .Sh SYNOPSIS | ||
13 | .In openssl/lhash.h | ||
14 | .Ft void | ||
15 | .Fo lh_stats | ||
16 | .Fa "LHASH *table" | ||
17 | .Fa "FILE *out" | ||
18 | .Fc | ||
19 | .Ft void | ||
20 | .Fo lh_node_stats | ||
21 | .Fa "LHASH *table" | ||
22 | .Fa "FILE *out" | ||
23 | .Fc | ||
24 | .Ft void | ||
25 | .Fo lh_node_usage_stats | ||
26 | .Fa "LHASH *table" | ||
27 | .Fa "FILE *out" | ||
28 | .Fc | ||
29 | .Ft void | ||
30 | .Fo lh_stats_bio | ||
31 | .Fa "LHASH *table" | ||
32 | .Fa "BIO *out" | ||
33 | .Fc | ||
34 | .Ft void | ||
35 | .Fo lh_node_stats_bio | ||
36 | .Fa "LHASH *table" | ||
37 | .Fa "BIO *out" | ||
38 | .Fc | ||
39 | .Ft void | ||
40 | .Fo lh_node_usage_stats_bio | ||
41 | .Fa "LHASH *table" | ||
42 | .Fa "BIO *out" | ||
43 | .Fc | ||
44 | .Sh DESCRIPTION | ||
45 | The | ||
46 | .Vt LHASH | ||
47 | structure records statistics about most aspects of accessing the hash | ||
48 | table. | ||
49 | .Pp | ||
50 | .Fn lh_stats | ||
51 | prints out statistics on the size of the hash table, how many entries | ||
52 | are in it, and the number and result of calls to the routines in this | ||
53 | library. | ||
54 | .Pp | ||
55 | .Fn lh_node_stats | ||
56 | prints the number of entries for each 'bucket' in the hash table. | ||
57 | .Pp | ||
58 | .Fn lh_node_usage_stats | ||
59 | prints out a short summary of the state of the hash table. | ||
60 | It prints the 'load' and the 'actual load'. | ||
61 | The load is the average number of data items per 'bucket' in the hash | ||
62 | table. | ||
63 | The 'actual load' is the average number of items per 'bucket', but only | ||
64 | for buckets which contain entries. | ||
65 | So the 'actual load' is the average number of searches that will need to | ||
66 | find an item in the hash table, while the 'load' is the average number | ||
67 | that will be done to record a miss. | ||
68 | .Pp | ||
69 | .Fn lh_stats_bio , | ||
70 | .Fn lh_node_stats_bio , | ||
71 | and | ||
72 | .Fn lh_node_usage_stats_bio | ||
73 | are the same as the above, except that the output goes to a | ||
74 | .Vt BIO . | ||
75 | .Sh RETURN VALUES | ||
76 | These functions do not return values. | ||
77 | .Sh SEE ALSO | ||
78 | .Xr bio 3 , | ||
79 | .Xr lh_new 3 | ||
80 | .Sh HISTORY | ||
81 | These functions are available in all versions of SSLeay and OpenSSL. | ||
82 | .Sh AUTHORS | ||
83 | .An Eric Young | ||