Changeset ebb0835 in mainline for uspace/app/hbench/doc/doxygroups.h

Timestamp:

2019-01-07T12:56:22Z (6 years ago)

Author:

Vojtech Horky <vojtech.horky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

c2db02a

Parents:

a787081

Message:

hbench: add tiny wrapper around stopwatch_t

This prepares the harness for future extensions when more than wallclock
time would be prepared. The data would be stored inside the new
structure and the actual benchmarks would not need to be modified at all
(they really should not care which metrics are collected).

File:

• uspace/app/hbench/doc/doxygroups.h (modified) (2 diffs)

uspace/app/hbench/doc/doxygroups.h

@@ -19 +19 @@
  * benchmark function to the benchmark_t.
  *
- * The benchmarking function has to accept for arguments:
- *  @li stopwatch_t: store the measured data there
+ * The benchmarking function has to accept four arguments:
+ *  @li benchmeter_t: call benchmeter_start and benchmeter_stop around the
+ *      actual benchmarking code
  *  @li uint64_t: size of the workload - typically number of inner loops in
  *      your benchmark (used to self-calibrate benchmark size)
@@ -28 +29 @@
  * Typically, the structure of the function is following:
  * @code{c}
- * static bool runner(stopwatch_t *stopwatch, uint64_t size,
+ * static bool runner(benchmeter_t *meter, uint64_t size,
  *     char *error, size_t error_size)
  * {
- *      stopwatch_start(stopwatch);
+ *      benchmeter_start(meter);
  *      for (uint64_t i = 0; i < size; i++) {
  *              // measured action
  *      }
- *      stopwatch_stop(stopwatch);
+ *      benchmeter_stop(meter);
  *
  *      return true;