Changeset be30e74 in mainline for uspace/app/hbench/hbench.h

Timestamp:

2019-01-21T13:49:08Z (5 years ago)

Author:

Vojtech Horky <vojtech.horky@…>

Branches:

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

Children:

9736c00

Parents:

94d52d5

Message:

hbench: comments

File:

• uspace/app/hbench/hbench.h (modified) (3 diffs)

uspace/app/hbench/hbench.h

@@ -66 +66 @@
 } bench_env_t;
 
+/** Actual benchmark runner.
+ *
+ * The first argument describes the environment, second is used to store
+ * information about the run (performance data or error message) and
+ * third describes workload size (number of iterations).
+ */
 typedef bool (*benchmark_entry_t)(bench_env_t *, bench_run_t *, uint64_t);
+
+/** Setup and teardown callback type.
+ *
+ * Unlike in benchmark_entry_t, we do not need to pass in number of
+ * iterations to execute (note that we use bench_run_t only to simplify
+ * creation of error messages).
+ */
 typedef bool (*benchmark_helper_t)(bench_env_t *, bench_run_t *);
 
@@ -90 +103 @@
 }
 
-extern benchmark_t *benchmarks[];
-extern size_t benchmark_count;
-
 extern errno_t csv_report_open(const char *);
 extern void csv_report_add_entry(bench_run_t *, int, benchmark_t *, uint64_t);
@@ -101 +111 @@
 extern const char *bench_env_param_get(bench_env_t *, const char *, const char *);
 extern void bench_env_cleanup(bench_env_t *);
+
+extern benchmark_t *benchmarks[];
+extern size_t benchmark_count;
 
 /* Put your benchmark descriptors here (and also to benchlist.c). */