reporting.3 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .\"
  2. .\" @(#)lmbench.man 2.0 98/04/24
  3. .\"
  4. .\" lmbench - benchmarking toolbox
  5. .\"
  6. .\" Copyright (C) 1998 Carl Staelin and Larry McVoy
  7. .\" E-mail: staelin@hpl.hp.com
  8. .\"
  9. .TH "lmbench reporting" 3 "$Date" "(c)1998 Larry McVoy" "LMBENCH"
  10. .SH "NAME"
  11. milli, micro, nano, mb, kb \- the lmbench reporting subsystem
  12. .SH "SYNOPSIS"
  13. .ft C
  14. #include "lmbench.h"
  15. .br
  16. void milli(char *s, uint64 n);
  17. .br
  18. void micro(char *s, uint64 n);
  19. .br
  20. void nano(char *s, uint64 n);
  21. .br
  22. void mb(uint64 bytes);
  23. .br
  24. void kb(uint64 bytes);
  25. .ft R
  26. .SH "DESCRIPTION"
  27. Creating benchmarks using the
  28. .I lmbench
  29. timing harness is easy.
  30. Since it is so easy to measure performance using
  31. .IR lmbench ,
  32. it is possible to quickly answer questions that arise during system
  33. design, development, or tuning. For example, image processing
  34. .P
  35. There are two attributes that are critical for performance, latency
  36. and bandwidth, and
  37. .IR lmbench 's
  38. timing harness makes it easy to measure and report results for both.
  39. The measurement interface,
  40. .B BENCH
  41. and
  42. .BR BENCH1 ,
  43. are identical, but the reporting functions are different.
  44. Latency is usually important for frequently executed operations, and
  45. bandwidth is usually important when moving large chunks of data.
  46. .TP
  47. .B "void milli(char *s, uint64 n)"
  48. print out the time per operation in milli-seconds.
  49. .I n
  50. is the number of operations during the timing interval, which is passed
  51. as a parameter because each
  52. .I loop_body
  53. can contain several operations.
  54. .TP
  55. .B "void micro(char *s, uint64 n)"
  56. print the time per opertaion in micro-seconds.
  57. .TP
  58. .B "void nano(char *s, uint64 n)"
  59. print the time per operation in nano-seconds.
  60. .TP
  61. .B "void mb(uint64 bytes)"
  62. print the bandwidth in megabytes per second.
  63. .TP
  64. .B "void kb(uint64 bytes)"
  65. print the bandwidth in kilobytes per second.
  66. .SH "FUTURES"
  67. Development of
  68. .I lmbench
  69. is continuing.
  70. .SH "SEE ALSO"
  71. lmbench(3), timing(3), results(3).
  72. .SH "AUTHOR"
  73. Carl Staelin and Larry McVoy
  74. .PP
  75. Comments, suggestions, and bug reports are always welcome.