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

Timestamp:

2019-01-21T13:20:31Z (5 years ago)

Author:

Vojtech Horky <vojtech.horky@…>

Branches:

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

Children:

d17cf8c

Parents:

94ebebf

Message:

hbench: less parameters to benchmark runners

Merge stopwatch as well as error message buffer into one structure to
simplify benchmark runner signature.

File:

• uspace/app/hbench/doc/doxygroups.h (modified) (1 diff)

uspace/app/hbench/doc/doxygroups.h

@@ -19 +19 @@
  * benchmark function to the benchmark_t.
  *
- * The benchmarking function has to accept four arguments:
- *  @li benchmeter_t: call benchmeter_start and benchmeter_stop around the
+ * The benchmarking function has to accept two arguments:
+ *  @li bench_run_t: call bench_run_start and bench_run_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)
- *  @li char * and size_t giving you access to buffer for storing error message
- *  if the benchmark fails (return false from the function itself then)
  *
  * Typically, the structure of the function is following:
  * @code{c}
- * static bool runner(benchmeter_t *meter, uint64_t size,
- *     char *error, size_t error_size)
+ * static bool runner(bench_run_t *run, uint64_t size)
  * {
- *      benchmeter_start(meter);
+ *      bench_run_start(run);
  *      for (uint64_t i = 0; i < size; i++) {
  *              // measured action
+ *              if (something_fails) {
+ *                  return bench_run_fail(run, "oops: %s (%d)", str_error(rc), rc);
+ *              }
  *      }
- *      benchmeter_stop(meter);
+ *      bench_run_stop(run);
  *
  *      return true;