Github/littlefs
1
Fork 0
Code Actions Activity
Files
efde754f889da02b957e31268799cc24027a4670
littlefs/runners/bench_runner.c
T
Christopher Haster 356d7065be runners: Added stack/heap measurement functions 
These have been battle-tested in external benchmarks, and have proven
useful for finding a runtime estimate on stack+heap usage.

Of course, to be realistic they need to be cross-compiled and run under
QEMU (which does work!), but even on x86_64 they provide a nice insight
into RAM usage. In practice the only real difference is pointer width
anyways.

---

Enabled by default for the bench runner, these are available if
TEST/BENCH_YES_HEAP and/or TEST/BENCH_YES_STACK are defined.

(This default is provided by the Makefile. At least heap measurements
rely on linker flags, so it probably doesn't make sense to default
enable in the bench runner itself.)

Stack vs heap rely on slightly different mechanisms:

- Stack: Uses GCC's __builtin_frame_address(0) to measure the current
  stack usage on entry to every bd operation.

- Heap: Relies on GCC's -Wl,--wrap flags to intercept every malloc/free
  call, to track the current heap usage.

These are available via bench/test macros:

- BENCH_STACK()         - Maximum stack usage of the current run
- BENCH_STACK_CURRENT() - Current stack usage
- BENCH_HEAP()          - Maximum heap usage of the current run
- BENCH_HEAP_CURRENT()  - Current heap usage

Note BENCH_STACK_CURRENT() can be useful for separating out the bench's
ctx from total stack usage, similarly to our static analysis.

---

One surprising outcome is that these heap hooks trivially implement a
memory leak detector. Maybe that could be useful in the test_runner as a
cheaper alternative to Valgrind?
2026-02-13 13:59:44 -06:00

2484 lines
73 KiB
C
Raw Blame History

/*
* Runner for littlefs benchmarks
*
* Copyright (c) 2022, The littlefs authors.
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef _POSIX_C_SOURCE
#define _POSIX_C_SOURCE 199309L
#endif
#include "runners/bench_runner.h"
#include <getopt.h>
#include <sys/types.h>
#include <errno.h>
#include <setjmp.h>
#include <fcntl.h>
#include <stdarg.h>
#include <stdio.h>
#include <unistd.h>
#include <execinfo.h>
#include <signal.h>
#include <time.h>
#include <stddef.h>
// some common types
#ifndef BENCH_KIWIBD
typedef lfs3_emubd_io_t bench_io_t;
typedef lfs3_emubd_sio_t bench_sio_t;
typedef lfs3_emubd_ns_t bench_ns_t;
typedef lfs3_emubd_sns_t bench_sns_t;
#else
typedef lfs3_kiwibd_io_t bench_io_t;
typedef lfs3_kiwibd_sio_t bench_sio_t;
typedef lfs3_kiwibd_ns_t bench_ns_t;
typedef lfs3_kiwibd_sns_t bench_sns_t;
#endif
// some helpers
// append to an array with amortized doubling
void *mappend(void **p,
size_t size,
size_t *count,
size_t *capacity) {
uint8_t *p_ = *p;
size_t count_ = *count;
size_t capacity_ = *capacity;
count_ += 1;
if (count_ > capacity_) {
capacity_ = (2*capacity_ < 4) ? 4 : 2*capacity_;
p_ = realloc(p_, capacity_*size);
if (!p_) {
return NULL;
}
}
*p = p_;
*count = count_;
*capacity = capacity_;
return &p_[(count_-1)*size];
}
// a quick self-terminating text-safe varint scheme
static void leb16_print(uintmax_t x) {
// allow 'w' to indicate negative numbers
if ((intmax_t)x < 0) {
printf("w");
x = -x;
}
while (true) {
char nibble = (x & 0xf) | ((x > 0xf) ? 0x10 : 0);
printf("%c", (nibble < 10) ? '0'+nibble : 'a'+nibble-10);
if (x <= 0xf) {
break;
}
x >>= 4;
}
}
static uintmax_t leb16_parse(const char *s, char **tail) {
bool neg = false;
uintmax_t x = 0;
if (tail) {
*tail = (char*)s;
}
if (s[0] == 'w') {
neg = true;
s = s+1;
}
size_t i = 0;
while (true) {
uintmax_t nibble = s[i];
if (nibble >= '0' && nibble <= '9') {
nibble = nibble - '0';
} else if (nibble >= 'a' && nibble <= 'v') {
nibble = nibble - 'a' + 10;
} else {
// invalid?
return 0;
}
x |= (nibble & 0xf) << (4*i);
i += 1;
if (!(nibble & 0x10)) {
s = s + i;
break;
}
}
if (tail) {
*tail = (char*)s;
}
return (neg) ? -x : x;
}
// bench_runner types
typedef struct bench_id {
const char *name;
bench_define_t *defines;
size_t define_count;
} bench_id_t;
// bench define management
// implicit defines declared here
#define BENCH_DEFINE(k, v) \
intmax_t k;
#include "bench_defines.h"
#undef BENCH_DEFINE
#define BENCH_DEFINE(k, v) \
intmax_t bench_define_##k(void *data, size_t i) { \
(void)data; \
(void)i; \
return v; \
}
#include "bench_defines.h"
#undef BENCH_DEFINE
const bench_define_t bench_implicit_defines[] = {
#define BENCH_DEFINE(k, v) \
{#k, &k, bench_define_##k, NULL, 1},
#include "bench_defines.h"
#undef BENCH_DEFINE
};
const size_t bench_implicit_define_count
= sizeof(bench_implicit_defines) / sizeof(bench_define_t);
// some helpers
intmax_t bench_define_lit(void *data, size_t i) {
(void)i;
return (intptr_t)data;
}
#define BENCH_LIT(name, v) ((bench_define_t){ \
name, NULL, bench_define_lit, (void*)(uintptr_t)(v), 1})
// define mapping
const bench_define_t **bench_defines = NULL;
size_t bench_define_count = 0;
size_t bench_define_capacity = 0;
const bench_define_t **bench_suite_defines = NULL;
size_t bench_suite_define_count = 0;
ssize_t *bench_suite_define_map = NULL;
bench_define_t *bench_override_defines = NULL;
size_t bench_override_define_count = 0;
size_t bench_define_depth = 1000;
static inline bool bench_define_isdefined(const bench_define_t *define) {
return define->cb;
}
static inline bool bench_define_ispermutation(const bench_define_t *define) {
// permutation defines are basically anything that's not implicit
return bench_define_isdefined(define)
&& !(define >= bench_implicit_defines
&& define
< bench_implicit_defines
+ bench_implicit_define_count);
}
void bench_define_suite(
const bench_id_t *id,
const struct bench_suite *suite) {
// reset our mapping
bench_define_count = 0;
bench_suite_define_count = 0;
// make sure we have space for everything, just assume the worst case
if (bench_implicit_define_count + suite->define_count
> bench_define_capacity) {
bench_define_capacity
= bench_implicit_define_count + suite->define_count;
bench_defines = realloc(
bench_defines,
bench_define_capacity*sizeof(const bench_define_t*));
bench_suite_defines = realloc(
bench_suite_defines,
bench_define_capacity*sizeof(const bench_define_t*));
bench_suite_define_map = realloc(
bench_suite_define_map,
bench_define_capacity*sizeof(ssize_t));
}
// first map our implicit defines
for (size_t i = 0; i < bench_implicit_define_count; i++) {
bench_suite_defines[i] = &bench_implicit_defines[i];
}
bench_suite_define_count = bench_implicit_define_count;
// build a mapping from suite defines to bench defines
//
// we will use this for both suite and case defines
memset(bench_suite_define_map, -1,
bench_suite_define_count*sizeof(size_t));
for (size_t i = 0; i < suite->define_count; i++) {
// assume suite defines are unique so we only need to compare
// against implicit defines, this avoids a O(n^2)
for (size_t j = 0; j < bench_implicit_define_count; j++) {
if (bench_suite_defines[j]->define == suite->defines[i].define) {
bench_suite_define_map[j] = i;
// don't override implicit defines if we're not defined
if (bench_define_isdefined(&suite->defines[i])) {
bench_suite_defines[j] = &suite->defines[i];
}
goto next_suite_define;
}
}
// map a new suite define
bench_suite_define_map[bench_suite_define_count] = i;
bench_suite_defines[bench_suite_define_count] = &suite->defines[i];
bench_suite_define_count += 1;
next_suite_define:;
}
// map any explicit defines
//
// we ignore any out-of-bounds defines here, even though it's likely
// an error
if (id && id->defines) {
for (size_t i = 0;
i < id->define_count && i < bench_suite_define_count;
i++) {
if (bench_define_isdefined(&id->defines[i])) {
// update name/addr
id->defines[i].name = bench_suite_defines[i]->name;
id->defines[i].define = bench_suite_defines[i]->define;
// map and override suite mapping
bench_suite_defines[i] = &id->defines[i];
bench_suite_define_map[i] = -1;
}
}
}
// map any override defines
//
// note it's not an error to override a define that doesn't exist
for (size_t i = 0; i < bench_override_define_count; i++) {
for (size_t j = 0; j < bench_suite_define_count; j++) {
if (strcmp(
bench_suite_defines[j]->name,
bench_override_defines[i].name) == 0) {
// update addr
bench_override_defines[i].define
= bench_suite_defines[j]->define;
// map and override suite mapping
bench_suite_defines[j] = &bench_override_defines[i];
bench_suite_define_map[j] = -1;
goto next_override_define;
}
}
next_override_define:;
}
}
void bench_define_case(
const bench_id_t *id,
const struct bench_suite *suite,
const struct bench_case *case_,
size_t perm) {
(void)id;
// copy over suite defines
for (size_t i = 0; i < bench_suite_define_count; i++) {
// map case define if case define is defined
if (case_->defines
&& bench_suite_define_map[i] != -1
&& bench_define_isdefined(&case_->defines[
perm*suite->define_count
+ bench_suite_define_map[i]])) {
bench_defines[i] = &case_->defines[
perm*suite->define_count
+ bench_suite_define_map[i]];
} else {
bench_defines[i] = bench_suite_defines[i];
}
}
bench_define_count = bench_suite_define_count;
}
void bench_define_permutation(size_t perm) {
// first zero everything, we really don't want reproducibility issues
for (size_t i = 0; i < bench_define_count; i++) {
*bench_defines[i]->define = 0;
}
// defines may be mutually recursive, which makes evaluation a bit tricky
//
// Rather than doing any clever, we just repeatedly evaluate the
// permutation until values stabilize. If things don't stabilize after
// some number of iterations, error, this likely means defines were
// stuck in a cycle
//
size_t attempt = 0;
while (true) {
const bench_define_t *changed = NULL;
// define-specific permutations are encoded in the case permutation
size_t perm_ = perm;
for (size_t i = 0; i < bench_define_count; i++) {
if (bench_defines[i]->cb) {
intmax_t v = bench_defines[i]->cb(
bench_defines[i]->data,
perm_ % bench_defines[i]->permutations);
if (v != *bench_defines[i]->define) {
*bench_defines[i]->define = v;
changed = bench_defines[i];
}
perm_ /= bench_defines[i]->permutations;
}
}
// stabilized?
if (!changed) {
break;
}
attempt += 1;
if (bench_define_depth && attempt >= bench_define_depth+1) {
fprintf(stderr, "error: could not resolve recursive defines: %s\n",
changed->name);
exit(-1);
}
}
}
void bench_define_cleanup(void) {
// bench define management can allocate a few things
free(bench_defines);
free(bench_suite_defines);
free(bench_suite_define_map);
}
size_t bench_define_permutations(void) {
size_t prod = 1;
for (size_t i = 0; i < bench_define_count; i++) {
prod *= (bench_defines[i]->permutations > 0)
? bench_defines[i]->permutations
: 1;
}
return prod;
}
// override define stuff
typedef struct bench_override_value {
intmax_t start;
intmax_t stop;
// step == 0 indicates a single value
intmax_t step;
} bench_override_value_t;
typedef struct bench_override_data {
bench_override_value_t *values;
size_t value_count;
} bench_override_data_t;
intmax_t bench_override_cb(void *data, size_t i) {
const bench_override_data_t *data_ = data;
for (size_t j = 0; j < data_->value_count; j++) {
const bench_override_value_t *v = &data_->values[j];
// range?
if (v->step) {
size_t range_count;
if (v->step > 0) {
range_count = (v->stop-1 - v->start) / v->step + 1;
} else {
range_count = (v->start-1 - v->stop) / -v->step + 1;
}
if (i < range_count) {
return i*v->step + v->start;
}
i -= range_count;
// value?
} else {
if (i == 0) {
return v->start;
}
i -= 1;
}
}
// should never get here
assert(false);
__builtin_unreachable();
}
// bench state
const bench_id_t *bench_ids = (const bench_id_t[]) {
{NULL, NULL, 0},
};
size_t bench_id_count = 1;
size_t bench_step_start = 0;
size_t bench_step_stop = -1;
size_t bench_step_step = 1;
bool bench_force = false;
const char *bench_disk_path = NULL;
const char *bench_trace_path = NULL;
bool bench_trace_backtrace = false;
uint32_t bench_trace_period = 0;
uint32_t bench_trace_freq = 0;
FILE *bench_trace_file = NULL;
uint32_t bench_trace_cycles = 0;
uint64_t bench_trace_time = 0;
uint64_t bench_trace_open_time = 0;
bench_ns_t bench_read_sleep = 0.0;
bench_ns_t bench_prog_sleep = 0.0;
bench_ns_t bench_erase_sleep = 0.0;
// this determines both the backtrace buffer and the trace printf buffer, if
// trace ends up interleaved or truncated this may need to be increased
#ifndef BENCH_TRACE_BACKTRACE_BUFFER_SIZE
#define BENCH_TRACE_BACKTRACE_BUFFER_SIZE 8192
#endif
void *bench_trace_backtrace_buffer[
BENCH_TRACE_BACKTRACE_BUFFER_SIZE / sizeof(void*)];
// trace printing
void bench_trace(const char *fmt, ...) {
if (bench_trace_path) {
// sample at a specific period?
if (bench_trace_period) {
if (bench_trace_cycles % bench_trace_period != 0) {
bench_trace_cycles += 1;
return;
}
bench_trace_cycles += 1;
}
// sample at a specific frequency?
if (bench_trace_freq) {
struct timespec t;
clock_gettime(CLOCK_MONOTONIC, &t);
uint64_t now = (uint64_t)t.tv_sec*1000*1000*1000
+ (uint64_t)t.tv_nsec;
if (now - bench_trace_time < (1000*1000*1000) / bench_trace_freq) {
return;
}
bench_trace_time = now;
}
if (!bench_trace_file) {
// Tracing output is heavy and trying to open every trace
// call is slow, so we only try to open the trace file every
// so often. Note this doesn't affect successfully opened files
struct timespec t;
clock_gettime(CLOCK_MONOTONIC, &t);
uint64_t now = (uint64_t)t.tv_sec*1000*1000*1000
+ (uint64_t)t.tv_nsec;
if (now - bench_trace_open_time < 100*1000*1000) {
return;
}
bench_trace_open_time = now;
// try to open the trace file
int fd;
if (strcmp(bench_trace_path, "-") == 0) {
fd = dup(1);
if (fd < 0) {
return;
}
} else {
fd = open(
bench_trace_path,
O_WRONLY | O_CREAT | O_APPEND | O_NONBLOCK,
0666);
if (fd < 0) {
return;
}
int err = fcntl(fd, F_SETFL, O_WRONLY | O_CREAT | O_APPEND);
assert(!err);
}
FILE *f = fdopen(fd, "a");
assert(f);
int err = setvbuf(f, NULL, _IOFBF,
BENCH_TRACE_BACKTRACE_BUFFER_SIZE);
assert(!err);
bench_trace_file = f;
}
// print trace
va_list va;
va_start(va, fmt);
int res = vfprintf(bench_trace_file, fmt, va);
va_end(va);
if (res < 0) {
fclose(bench_trace_file);
bench_trace_file = NULL;
return;
}
if (bench_trace_backtrace) {
// print backtrace
size_t count = backtrace(
bench_trace_backtrace_buffer,
BENCH_TRACE_BACKTRACE_BUFFER_SIZE);
// note we skip our own stack frame
for (size_t i = 1; i < count; i++) {
res = fprintf(bench_trace_file, "\tat %p\n",
bench_trace_backtrace_buffer[i]);
if (res < 0) {
fclose(bench_trace_file);
bench_trace_file = NULL;
return;
}
}
}
// flush immediately
fflush(bench_trace_file);
}
}
// bench prng
uint32_t bench_prng(uint32_t *state) {
// A simple xorshift32 generator, easily reproducible. Keep in mind
// determinism is much more important than actual randomness here.
uint32_t x = *state;
// must be non-zero, use uintmax here so that seed=0 is different
// from seed=1 and seed=range(0,n) makes a bit more sense
if (x == 0) {
x = -1;
}
x ^= x << 13;
x ^= x >> 17;
x ^= x << 5;
*state = x;
return x;
}
// bench factorial
size_t bench_factorial(size_t x) {
size_t y = 1;
for (size_t i = 2; i <= x; i++) {
y *= i;
}
return y;
}
// bench array permutations
void bench_permutation(size_t i, uint32_t *buffer, size_t size) {
// https://stackoverflow.com/a/7919887 and
// https://stackoverflow.com/a/24257996 helped a lot with this, but
// changed to run in O(n) with no extra memory. This has a tradeoff
// of generating the permutations in an unintuitive order.
// initialize array
for (size_t j = 0; j < size; j++) {
buffer[j] = j;
}
for (size_t j = 0; j < size; j++) {
// swap index with digit
//
// .- i%rem --.
// v .----+----.
// [p0 p1 |-> r0 r1 r2 r3]
//
size_t t = buffer[j + (i % (size-j))];
buffer[j + (i % (size-j))] = buffer[j];
buffer[j] = t;
// update i
i /= (size-j);
}
}
// stack hooks
#ifdef BENCH_YES_STACK
uint8_t *bench_stack_watermark_enter;
uint8_t *bench_stack_watermark_depth;
#endif
// call me when entering/exiting a bench!
#ifdef BENCH_YES_STACK
__attribute__((noinline))
void bench_stack_enter(void) {
bench_stack_watermark_enter = __builtin_frame_address(0);
bench_stack_watermark_depth = bench_stack_watermark_enter;
}
#endif
#ifdef BENCH_YES_STACK
void bench_stack_exit(void) {
// do nothing
}
#endif
// call me when entering/exiting a bd op!
#ifdef BENCH_YES_STACK
__attribute__((noinline))
void bench_stack_pause(void) {
uint8_t *watermark = __builtin_frame_address(0);
// keep track of the deepest stack
ssize_t depth = bench_stack_watermark_depth - bench_stack_watermark_enter;
if (depth < 0) {
depth = -depth;
}
ssize_t depth_ = watermark - bench_stack_watermark_enter;
if (depth_ < 0) {
depth_ = -depth_;
}
if (depth_ > depth) {
bench_stack_watermark_depth = watermark;
}
}
#endif
#ifdef BENCH_YES_STACK
void bench_stack_resume(void) {
// do nothing
}
#endif
// get the worst-case stack usage
#ifdef BENCH_YES_STACK
size_t bench_stack(void) {
ssize_t depth = bench_stack_watermark_depth - bench_stack_watermark_enter;
if (depth < 0) {
depth = -depth;
}
return depth;
}
#endif
// get the current stack usage, note this is included in bench_stack
//
// note note the noinline here is important for forcing a new stack frame
#ifdef BENCH_YES_STACK
__attribute__((noinline))
size_t bench_stack_current(void) {
uint8_t *watermark = __builtin_frame_address(0);
ssize_t depth = watermark - bench_stack_watermark_enter;
if (depth < 0) {
depth = -depth;
}
return depth;
}
#endif
// heap hooks
#ifdef BENCH_YES_HEAP
uint32_t bench_heap_entered = 0;
size_t bench_heap_watermark = 0;
size_t bench_heap_watermark_depth = 0;
#endif
// call me when entering/exiting a bench!
#ifdef BENCH_YES_HEAP
void bench_heap_enter(void) {
bench_heap_entered = 1;
bench_heap_watermark = 0;
bench_heap_watermark_depth = 0;
}
#endif
#ifdef BENCH_YES_HEAP
void bench_heap_exit(void) {
bench_heap_entered = 0;
if (bench_heap_watermark != 0) {
fprintf(stderr, "warning: memory leak detected (%zd > 0)\n",
bench_heap_watermark);
}
}
#endif
// call me when entering/exiting a bd op!
#ifdef BENCH_YES_HEAP
void bench_heap_pause(void) {
// haha, a little 32-bit stack
bench_heap_entered <<= 1;
}
#endif
#ifdef BENCH_YES_HEAP
void bench_heap_resume(void) {
bench_heap_entered >>= 1;
}
#endif
#ifdef BENCH_YES_HEAP
static void bench_heap_inc(size_t size) {
if (bench_heap_entered & 1) {
bench_heap_watermark += size;
// keep track of the deepest heap
if (bench_heap_watermark > bench_heap_watermark_depth) {
bench_heap_watermark_depth = bench_heap_watermark;
}
}
}
#endif
#ifdef BENCH_YES_HEAP
static void bench_heap_dec(size_t size) {
if (bench_heap_entered & 1) {
assert(bench_heap_watermark >= size);
bench_heap_watermark -= size;
}
}
#endif
// get the worst-case heap usage
#ifdef BENCH_YES_HEAP
size_t bench_heap(void) {
return bench_heap_watermark_depth;
}
#endif
// get the current heap usage
#ifdef BENCH_YES_HEAP
size_t bench_heap_current(void) {
return bench_heap_watermark;
}
#endif
// __real_malloc stubs, gcc's --wrap wraps these over the original symbols
#ifdef BENCH_YES_HEAP
extern void *__real_malloc(size_t size);
extern void __real_free(void *p);
extern void *__real_realloc(void *p, size_t size);
#endif
// the actual malloc hooks
//
// these only work if wrapped via gcc's --wrap
#ifdef BENCH_YES_HEAP
void *__wrap_malloc(size_t size) {
// prefix with allocation size, note we use uintptr_t to hopefully
// keep things aligned
uintptr_t *p_ = __real_malloc(sizeof(uintptr_t) + size);
if (!p_) {
return NULL;
}
bench_heap_inc(size);
*p_ = size;
return p_ + 1;
}
#endif
#ifdef BENCH_YES_HEAP
void __wrap_free(void *p) {
if (!p) {
return;
}
uintptr_t *p_ = ((uintptr_t*)p) - 1;
size_t size = *p_;
bench_heap_dec(size);
__real_free(p_);
}
#endif
#ifdef BENCH_YES_HEAP
void *__wrap_realloc(void *p, size_t size) {
uintptr_t *p_;
size_t old;
if (p) {
p_ = ((uintptr_t*)p) - 1;
old = *p_;
} else {
p_ = NULL;
old = 0;
}
assert(size != 0);
p_ = __real_realloc(p_, sizeof(uintptr_t) + size);
if (!p_) {
return NULL;
}
bench_heap_dec(old);
bench_heap_inc(size);
*p_ = size;
return p_ + 1;
}
#endif
// bench recording state
typedef struct bench_record {
const char *probe;
bench_io_t last_reads;
bench_io_t last_progs;
bench_io_t last_erases;
bench_io_t last_readed;
bench_io_t last_progged;
bench_io_t last_erased;
bench_ns_t last_simtime;
} bench_record_t;
static struct lfs3_cfg *bench_cfg = NULL;
static bench_record_t *bench_records;
size_t bench_record_count;
size_t bench_record_capacity;
void bench_reset(struct lfs3_cfg *cfg) {
bench_cfg = cfg;
bench_record_count = 0;
}
void bench_start(const char *probe) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
// measure current read/prog/erase
assert(bench_cfg);
#ifndef BENCH_KIWIBD
bench_sio_t reads = lfs3_emubd_reads(bench_cfg);
assert(reads >= 0);
bench_sio_t progs = lfs3_emubd_progs(bench_cfg);
assert(progs >= 0);
bench_sio_t erases = lfs3_emubd_erases(bench_cfg);
assert(erases >= 0);
bench_sio_t readed = lfs3_emubd_readed(bench_cfg);
assert(readed >= 0);
bench_sio_t progged = lfs3_emubd_progged(bench_cfg);
assert(progged >= 0);
bench_sio_t erased = lfs3_emubd_erased(bench_cfg);
assert(erased >= 0);
// note this can error if no timings provided
bench_sns_t simtime = lfs3_emubd_simtime(bench_cfg);
#else
bench_sio_t reads = lfs3_kiwibd_reads(bench_cfg);
assert(reads >= 0);
bench_sio_t progs = lfs3_kiwibd_progs(bench_cfg);
assert(progs >= 0);
bench_sio_t erases = lfs3_kiwibd_erases(bench_cfg);
assert(erases >= 0);
bench_sio_t readed = lfs3_kiwibd_readed(bench_cfg);
assert(readed >= 0);
bench_sio_t progged = lfs3_kiwibd_progged(bench_cfg);
assert(progged >= 0);
bench_sio_t erased = lfs3_kiwibd_erased(bench_cfg);
assert(erased >= 0);
// note this can error if no timings provided
bench_sns_t simtime = lfs3_kiwibd_simtime(bench_cfg);
#endif
// allocate a new record
bench_record_t *record = mappend(
(void**)&bench_records,
sizeof(bench_record_t),
&bench_record_count,
&bench_record_capacity);
record->probe = probe;
record->last_reads = reads;
record->last_progs = progs;
record->last_erases = erases;
record->last_readed = readed;
record->last_progged = progged;
record->last_erased = erased;
record->last_simtime = simtime;
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
}
void bench_stop(const char *probe, uintmax_t n) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
// measure current read/prog/erase
assert(bench_cfg);
#ifndef BENCH_KIWIBD
bench_sio_t reads = lfs3_emubd_reads(bench_cfg);
assert(reads >= 0);
bench_sio_t progs = lfs3_emubd_progs(bench_cfg);
assert(progs >= 0);
bench_sio_t erases = lfs3_emubd_erases(bench_cfg);
assert(erases >= 0);
bench_sio_t readed = lfs3_emubd_readed(bench_cfg);
assert(readed >= 0);
bench_sio_t progged = lfs3_emubd_progged(bench_cfg);
assert(progged >= 0);
bench_sio_t erased = lfs3_emubd_erased(bench_cfg);
assert(erased >= 0);
// note this can error if no timings provided
bench_sns_t simtime = lfs3_emubd_simtime(bench_cfg);
#else
bench_sio_t reads = lfs3_kiwibd_reads(bench_cfg);
assert(reads >= 0);
bench_sio_t progs = lfs3_kiwibd_progs(bench_cfg);
assert(progs >= 0);
bench_sio_t erases = lfs3_kiwibd_erases(bench_cfg);
assert(erases >= 0);
bench_sio_t readed = lfs3_kiwibd_readed(bench_cfg);
assert(readed >= 0);
bench_sio_t progged = lfs3_kiwibd_progged(bench_cfg);
assert(progged >= 0);
bench_sio_t erased = lfs3_kiwibd_erased(bench_cfg);
assert(erased >= 0);
// note this can error if no timings provided
bench_sns_t simtime = lfs3_kiwibd_simtime(bench_cfg);
#endif
// find our record
for (size_t i = 0; i < bench_record_count; i++) {
if (strcmp(bench_records[i].probe, probe) == 0) {
// print results
if (simtime >= 0) {
printf("benched %s %jd "
"%"PRIu64" %"PRIu64" %"PRIu64" "
"%"PRIu64" %"PRIu64" %"PRIu64" "
"%"PRIu64"\n",
probe,
n,
reads - bench_records[i].last_reads,
progs - bench_records[i].last_progs,
erases - bench_records[i].last_erases,
readed - bench_records[i].last_readed,
progged - bench_records[i].last_progged,
erased - bench_records[i].last_erased,
simtime - bench_records[i].last_simtime);
} else {
printf("benched %s %jd "
"%"PRIu64" %"PRIu64" %"PRIu64" "
"%"PRIu64" %"PRIu64" %"PRIu64"\n",
probe,
n,
reads - bench_records[i].last_reads,
progs - bench_records[i].last_progs,
erases - bench_records[i].last_erases,
readed - bench_records[i].last_readed,
progged - bench_records[i].last_progged,
erased - bench_records[i].last_erased);
}
// remove our record
memmove(&bench_records[i],
&bench_records[i+1],
bench_record_count-(i+1));
bench_record_count -= 1;
goto done;
}
}
// not found?
fprintf(stderr, "error: bench stopped before it was started (%s)\n",
probe);
assert(false);
exit(-1);
done:;
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
}
void bench_result(const char *probe, uintmax_t n, uintmax_t result) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
// we just print these directly
printf("benched %s %jd %"PRIu64"\n",
probe,
n,
result);
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
}
void bench_fresult(const char *probe, uintmax_t n, double result) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
// we just print these directly
printf("benched %s %jd %.6f\n",
probe,
n,
result);
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
}
// encode our permutation into a reusable id
static void perm_printid(
const struct bench_suite *suite,
const struct bench_case *case_) {
(void)suite;
// case[:permutation]
printf("%s:", case_->name);
for (size_t d = 0; d < bench_define_count; d++) {
if (bench_define_ispermutation(bench_defines[d])) {
leb16_print(d);
leb16_print(*bench_defines[d]->define);
}
}
}
// a quick trie for keeping track of permutations we've seen
typedef struct bench_seen {
struct bench_seen_branch *branches;
size_t branch_count;
size_t branch_capacity;
} bench_seen_t;
struct bench_seen_branch {
intmax_t define;
struct bench_seen branch;
};
bool bench_seen_insert(bench_seen_t *seen) {
// use the currently set defines
bool was_seen = true;
for (size_t d = 0; d < bench_define_count; d++) {
// treat unpermuted defines the same as 0
intmax_t v = bench_define_ispermutation(bench_defines[d])
? *bench_defines[d]->define
: 0;
// already seen?
struct bench_seen_branch *branch = NULL;
for (size_t i = 0; i < seen->branch_count; i++) {
if (seen->branches[i].define == v) {
branch = &seen->branches[i];
break;
}
}
// need to create a new node
if (!branch) {
was_seen = false;
branch = mappend(
(void**)&seen->branches,
sizeof(struct bench_seen_branch),
&seen->branch_count,
&seen->branch_capacity);
branch->define = v;
branch->branch = (bench_seen_t){NULL, 0, 0};
}
seen = &branch->branch;
}
return was_seen;
}
void bench_seen_cleanup(bench_seen_t *seen) {
for (size_t i = 0; i < seen->branch_count; i++) {
bench_seen_cleanup(&seen->branches[i].branch);
}
free(seen->branches);
}
// iterate through permutations in a bench case
static void case_forperm(
const bench_id_t *id,
const struct bench_suite *suite,
const struct bench_case *case_,
void (*cb)(
void *data,
const struct bench_suite *suite,
const struct bench_case *case_),
void *data) {
// explicit permutation?
if (id && id->defines) {
// define case permutation, the exact case perm doesn't matter here
bench_define_case(id, suite, case_, 0);
size_t permutations = bench_define_permutations();
for (size_t p = 0; p < permutations; p++) {
// define permutation permutation
bench_define_permutation(p);
cb(data, suite, case_);
}
return;
}
// deduplicate permutations with the same defines
//
// this can easily happen when overriding multiple case permutations,
// we can't tell that multiple case permutations don't change defines,
// duplicating results
bench_seen_t seen = {NULL, 0, 0};
for (size_t k = 0;
k < ((case_->permutations) ? case_->permutations : 1);
k++) {
// define case permutation
bench_define_case(id, suite, case_, k);
size_t permutations = bench_define_permutations();
for (size_t p = 0; p < permutations; p++) {
// define permutation permutation
bench_define_permutation(p);
// have we seen this permutation before?
bool was_seen = bench_seen_insert(&seen);
if (!(k == 0 && p == 0) && was_seen) {
continue;
}
cb(data, suite, case_);
}
}
bench_seen_cleanup(&seen);
}
// how many permutations are there actually in a bench case
struct perm_count_state {
size_t total;
size_t filtered;
};
void perm_count(
void *data,
const struct bench_suite *suite,
const struct bench_case *case_) {
struct perm_count_state *state = data;
(void)suite;
state->total += 1;
if (!case_->run || !(bench_force || !case_->if_ || case_->if_())) {
return;
}
state->filtered += 1;
}
// operations we can do
static void summary(void) {
printf("%-23s %7s %7s %7s %15s\n",
"", "flags", "suites", "cases", "perms");
size_t suites = 0;
size_t cases = 0;
bench_flags_t flags = 0;
struct perm_count_state perms = {0, 0};
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
bench_define_suite(&bench_ids[t], bench_suites[i]);
size_t cases_ = 0;
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
cases += 1;
cases_ += 1;
case_forperm(
&bench_ids[t],
bench_suites[i],
&bench_suites[i]->cases[j],
perm_count,
&perms);
}
// no benches found?
if (!cases_) {
continue;
}
suites += 1;
flags |= bench_suites[i]->flags;
}
}
char perm_buf[64];
sprintf(perm_buf, "%zu/%zu", perms.filtered, perms.total);
char flag_buf[64];
sprintf(flag_buf, "%s%s",
(flags & BENCH_INTERNAL) ? "i" : "",
(!flags) ? "-" : "");
printf("%-23s %7s %7zu %7zu %15s\n",
"TOTAL",
flag_buf,
suites,
cases,
perm_buf);
}
static void list_suites(void) {
// at least size so that names fit
unsigned name_width = 23;
for (size_t i = 0; i < bench_suite_count; i++) {
size_t len = strlen(bench_suites[i]->name);
if (len > name_width) {
name_width = len;
}
}
name_width = 4*((name_width+1+4-1)/4)-1;
printf("%-*s %7s %7s %15s\n",
name_width, "suite", "flags", "cases", "perms");
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
bench_define_suite(&bench_ids[t], bench_suites[i]);
size_t cases = 0;
struct perm_count_state perms = {0, 0};
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
cases += 1;
case_forperm(
&bench_ids[t],
bench_suites[i],
&bench_suites[i]->cases[j],
perm_count,
&perms);
}
// no benches found?
if (!cases) {
continue;
}
char perm_buf[64];
sprintf(perm_buf, "%zu/%zu", perms.filtered, perms.total);
char flag_buf[64];
sprintf(flag_buf, "%s%s",
(bench_suites[i]->flags & BENCH_INTERNAL) ? "i" : "",
(!bench_suites[i]->flags) ? "-" : "");
printf("%-*s %7s %7zu %15s\n",
name_width,
bench_suites[i]->name,
flag_buf,
cases,
perm_buf);
}
}
}
static void list_cases(void) {
// at least size so that names fit
unsigned name_width = 23;
for (size_t i = 0; i < bench_suite_count; i++) {
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
size_t len = strlen(bench_suites[i]->cases[j].name);
if (len > name_width) {
name_width = len;
}
}
}
name_width = 4*((name_width+1+4-1)/4)-1;
printf("%-*s %7s %15s\n", name_width, "case", "flags", "perms");
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
bench_define_suite(&bench_ids[t], bench_suites[i]);
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
struct perm_count_state perms = {0, 0};
case_forperm(
&bench_ids[t],
bench_suites[i],
&bench_suites[i]->cases[j],
perm_count,
&perms);
char perm_buf[64];
sprintf(perm_buf, "%zu/%zu", perms.filtered, perms.total);
char flag_buf[64];
sprintf(flag_buf, "%s%s",
(bench_suites[i]->cases[j].flags & BENCH_INTERNAL)
? "i" : "",
(!bench_suites[i]->cases[j].flags)
? "-" : "");
printf("%-*s %7s %15s\n",
name_width,
bench_suites[i]->cases[j].name,
flag_buf,
perm_buf);
}
}
}
}
static void list_suite_paths(void) {
// at least size so that names fit
unsigned name_width = 23;
for (size_t i = 0; i < bench_suite_count; i++) {
size_t len = strlen(bench_suites[i]->name);
if (len > name_width) {
name_width = len;
}
}
name_width = 4*((name_width+1+4-1)/4)-1;
printf("%-*s %s\n", name_width, "suite", "path");
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
size_t cases = 0;
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
cases += 1;
}
}
// no benches found?
if (!cases) {
continue;
}
printf("%-*s %s\n",
name_width,
bench_suites[i]->name,
bench_suites[i]->path);
}
}
}
static void list_case_paths(void) {
// at least size so that names fit
unsigned name_width = 23;
for (size_t i = 0; i < bench_suite_count; i++) {
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
size_t len = strlen(bench_suites[i]->cases[j].name);
if (len > name_width) {
name_width = len;
}
}
}
name_width = 4*((name_width+1+4-1)/4)-1;
printf("%-*s %s\n", name_width, "case", "path");
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
printf("%-*s %s\n",
name_width,
bench_suites[i]->cases[j].name,
bench_suites[i]->cases[j].path);
}
}
}
}
struct list_defines_define {
const char *name;
intmax_t *values;
size_t value_count;
size_t value_capacity;
};
struct list_defines_defines {
struct list_defines_define *defines;
size_t define_count;
size_t define_capacity;
};
static void list_defines_add(
struct list_defines_defines *defines,
const bench_define_t *define) {
const char *name = define->name;
intmax_t v = *define->define;
// define already in defines?
for (size_t i = 0; i < defines->define_count; i++) {
if (strcmp(defines->defines[i].name, name) == 0) {
// value already in values?
for (size_t j = 0; j < defines->defines[i].value_count; j++) {
if (defines->defines[i].values[j] == v) {
return;
}
}
*(intmax_t*)mappend(
(void**)&defines->defines[i].values,
sizeof(intmax_t),
&defines->defines[i].value_count,
&defines->defines[i].value_capacity) = v;
return;
}
}
// new define?
struct list_defines_define *define_ = mappend(
(void**)&defines->defines,
sizeof(struct list_defines_define),
&defines->define_count,
&defines->define_capacity);
define_->name = name;
define_->values = malloc(sizeof(intmax_t));
define_->values[0] = v;
define_->value_count = 1;
define_->value_capacity = 1;
}
void perm_list_defines(
void *data,
const struct bench_suite *suite,
const struct bench_case *case_) {
struct list_defines_defines *defines = data;
(void)suite;
(void)case_;
// collect defines
for (size_t d = 0; d < bench_define_count; d++) {
if (bench_define_isdefined(bench_defines[d])) {
list_defines_add(defines, bench_defines[d]);
}
}
}
void perm_list_permutation_defines(
void *data,
const struct bench_suite *suite,
const struct bench_case *case_) {
struct list_defines_defines *defines = data;
(void)suite;
(void)case_;
// collect permutation_defines
for (size_t d = 0; d < bench_define_count; d++) {
if (bench_define_ispermutation(bench_defines[d])) {
list_defines_add(defines, bench_defines[d]);
}
}
}
static void list_defines(void) {
struct list_defines_defines defines = {NULL, 0, 0};
// add defines
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
bench_define_suite(&bench_ids[t], bench_suites[i]);
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
case_forperm(
&bench_ids[t],
bench_suites[i],
&bench_suites[i]->cases[j],
perm_list_defines,
&defines);
}
}
}
for (size_t i = 0; i < defines.define_count; i++) {
printf("%s=", defines.defines[i].name);
for (size_t j = 0; j < defines.defines[i].value_count; j++) {
printf("%jd", defines.defines[i].values[j]);
if (j != defines.defines[i].value_count-1) {
printf(",");
}
}
printf("\n");
}
for (size_t i = 0; i < defines.define_count; i++) {
free(defines.defines[i].values);
}
free(defines.defines);
}
static void list_permutation_defines(void) {
struct list_defines_defines defines = {NULL, 0, 0};
// add permutation defines
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
bench_define_suite(&bench_ids[t], bench_suites[i]);
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
case_forperm(
&bench_ids[t],
bench_suites[i],
&bench_suites[i]->cases[j],
perm_list_permutation_defines,
&defines);
}
}
}
for (size_t i = 0; i < defines.define_count; i++) {
printf("%s=", defines.defines[i].name);
for (size_t j = 0; j < defines.defines[i].value_count; j++) {
printf("%jd", defines.defines[i].values[j]);
if (j != defines.defines[i].value_count-1) {
printf(",");
}
}
printf("\n");
}
for (size_t i = 0; i < defines.define_count; i++) {
free(defines.defines[i].values);
}
free(defines.defines);
}
static void list_implicit_defines(void) {
struct list_defines_defines defines = {NULL, 0, 0};
// yes we do need to define a suite/case, these do a bit of bookeeping
// around mapping defines
bench_define_suite(NULL,
&(const struct bench_suite){0});
bench_define_case(NULL,
&(const struct bench_suite){0},
&(const struct bench_case){0},
0);
size_t permutations = bench_define_permutations();
for (size_t p = 0; p < permutations; p++) {
// define permutation permutation
bench_define_permutation(p);
// add implicit defines
for (size_t d = 0; d < bench_define_count; d++) {
list_defines_add(&defines, bench_defines[d]);
}
}
for (size_t i = 0; i < defines.define_count; i++) {
printf("%s=", defines.defines[i].name);
for (size_t j = 0; j < defines.defines[i].value_count; j++) {
printf("%jd", defines.defines[i].values[j]);
if (j != defines.defines[i].value_count-1) {
printf(",");
}
}
printf("\n");
}
for (size_t i = 0; i < defines.define_count; i++) {
free(defines.defines[i].values);
}
free(defines.defines);
}
// bench bd wrappers for heap/stack tracking
int bench_bd_read(const struct lfs3_cfg *cfg, lfs3_block_t block,
lfs3_off_t off, void *buffer, lfs3_size_t size) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
#ifdef BENCH_KIWIBD
int err = lfs3_kiwibd_read(cfg, block, off, buffer, size);
#else
int err = lfs3_emubd_read(cfg, block, off, buffer, size);
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
return err;
}
int bench_bd_prog(const struct lfs3_cfg *cfg, lfs3_block_t block,
lfs3_off_t off, const void *buffer, lfs3_size_t size) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
#ifdef BENCH_KIWIBD
int err = lfs3_kiwibd_prog(cfg, block, off, buffer, size);
#else
int err = lfs3_emubd_prog(cfg, block, off, buffer, size);
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
return err;
}
int bench_bd_erase(const struct lfs3_cfg *cfg, lfs3_block_t block) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
#ifdef BENCH_KIWIBD
int err = lfs3_kiwibd_erase(cfg, block);
#else
int err = lfs3_emubd_erase(cfg, block);
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
return err;
}
int bench_bd_sync(const struct lfs3_cfg *cfg) {
#ifdef BENCH_YES_STACK
BENCH_STACK_PAUSE();
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_PAUSE();
#endif
#ifdef BENCH_KIWIBD
int err = lfs3_kiwibd_sync(cfg);
#else
int err = lfs3_emubd_sync(cfg);
#endif
#ifdef BENCH_YES_HEAP
BENCH_HEAP_RESUME();
#endif
#ifdef BENCH_YES_STACK
BENCH_STACK_RESUME();
#endif
return err;
}
// global bench step count
size_t bench_step = 0;
void perm_run(
void *data,
const struct bench_suite *suite,
const struct bench_case *case_) {
(void)data;
// skip this step?
if (!(bench_step >= bench_step_start
&& bench_step < bench_step_stop
&& (bench_step-bench_step_start) % bench_step_step == 0)) {
bench_step += 1;
return;
}
bench_step += 1;
// filter?
if (!case_->run || !(bench_force || !case_->if_ || case_->if_())) {
printf("skipped ");
perm_printid(suite, case_);
printf("\n");
return;
}
// create block device and configuration
#ifndef BENCH_KIWIBD
lfs3_emubd_t bd;
#else
lfs3_kiwibd_t bd;
#endif
struct lfs3_cfg cfg = {
.context = &bd,
.read = bench_bd_read,
.prog = bench_bd_prog,
.erase = bench_bd_erase,
.sync = bench_bd_sync,
#define BENCH_CFG(k, v) \
.k = v,
#include "bench_defines.h"
#undef BENCH_CFG
};
// using emubd?
#ifndef BENCH_KIWIBD
struct lfs3_emubd_cfg bdcfg = {
.read_sleep = bench_read_sleep,
.prog_sleep = bench_prog_sleep,
.erase_sleep = bench_erase_sleep,
#define BENCH_BDCFG(k, v) \
.k = v,
#include "bench_defines.h"
#undef BENCH_CFG
};
int err = lfs3_emubd_createcfg(&cfg, bench_disk_path, &bdcfg);
if (err) {
fprintf(stderr, "error: could not create emubd: %d\n", err);
exit(-1);
}
// using kiwibd?
#else
struct lfs3_kiwibd_cfg bdcfg = {
.read_sleep = bench_read_sleep,
.prog_sleep = bench_prog_sleep,
.erase_sleep = bench_erase_sleep,
#define BENCH_BDCFG(k, v) \
.k = v,
#include "bench_defines.h"
#undef BENCH_CFG
};
int err = lfs3_kiwibd_createcfg(&cfg, bench_disk_path, &bdcfg);
if (err) {
fprintf(stderr, "error: could not create kiwibd: %d\n", err);
exit(-1);
}
#endif
// run the bench
printf("running ");
perm_printid(suite, case_);
printf("\n");
bench_reset(&cfg);
#ifdef BENCH_YES_STACK
bench_stack_enter();
#endif
#ifdef BENCH_YES_HEAP
bench_heap_enter();
#endif
case_->run(&cfg);
#ifdef BENCH_YES_HEAP
bench_heap_exit();
#endif
#ifdef BENCH_YES_STACK
bench_stack_exit();
#endif
printf("finished ");
perm_printid(suite, case_);
printf("\n");
// cleanup
#ifndef BENCH_KIWIBD
err = lfs3_emubd_destroy(&cfg);
if (err) {
fprintf(stderr, "error: could not destroy emubd: %d\n", err);
exit(-1);
}
#else
err = lfs3_kiwibd_destroy(&cfg);
if (err) {
fprintf(stderr, "error: could not destroy kiwibd: %d\n", err);
exit(-1);
}
#endif
}
static void run(void) {
// ignore disconnected pipes
signal(SIGPIPE, SIG_IGN);
for (size_t t = 0; t < bench_id_count; t++) {
for (size_t i = 0; i < bench_suite_count; i++) {
bench_define_suite(&bench_ids[t], bench_suites[i]);
for (size_t j = 0; j < bench_suites[i]->case_count; j++) {
// does neither suite nor case name match?
if (bench_ids[t].name && !(
strcmp(bench_ids[t].name,
bench_suites[i]->name) == 0
|| strcmp(bench_ids[t].name,
bench_suites[i]->cases[j].name) == 0)) {
continue;
}
case_forperm(
&bench_ids[t],
bench_suites[i],
&bench_suites[i]->cases[j],
perm_run,
NULL);
}
}
}
}
// option handling
enum opt_flags {
OPT_HELP = 'h',
OPT_SUMMARY = 'Y',
OPT_LIST_SUITES = 'l',
OPT_LIST_CASES = 'L',
OPT_LIST_SUITE_PATHS = 1,
OPT_LIST_CASE_PATHS = 2,
OPT_LIST_DEFINES = 3,
OPT_LIST_PERMUTATION_DEFINES = 4,
OPT_LIST_IMPLICIT_DEFINES = 5,
OPT_DEFINE = 'D',
OPT_DEFINE_DEPTH = 6,
OPT_STEP = 's',
OPT_FORCE = 7,
OPT_DISK = 'd',
OPT_TRACE = 't',
OPT_TRACE_BACKTRACE = 8,
OPT_TRACE_PERIOD = 9,
OPT_TRACE_FREQ = 10,
OPT_READ_SLEEP = 11,
OPT_PROG_SLEEP = 12,
OPT_ERASE_SLEEP = 13,
};
const char *short_opts = "hYlLD:s:d:t:";
const struct option long_opts[] = {
{"help", no_argument, NULL, OPT_HELP},
{"summary", no_argument, NULL, OPT_SUMMARY},
{"list-suites", no_argument, NULL, OPT_LIST_SUITES},
{"list-cases", no_argument, NULL, OPT_LIST_CASES},
{"list-suite-paths", no_argument, NULL, OPT_LIST_SUITE_PATHS},
{"list-case-paths", no_argument, NULL, OPT_LIST_CASE_PATHS},
{"list-defines", no_argument, NULL, OPT_LIST_DEFINES},
{"list-permutation-defines",
no_argument, NULL, OPT_LIST_PERMUTATION_DEFINES},
{"list-implicit-defines",
no_argument, NULL, OPT_LIST_IMPLICIT_DEFINES},
{"define", required_argument, NULL, OPT_DEFINE},
{"define-depth", required_argument, NULL, OPT_DEFINE_DEPTH},
{"step", required_argument, NULL, OPT_STEP},
{"force", no_argument, NULL, OPT_FORCE},
{"disk", required_argument, NULL, OPT_DISK},
{"trace", required_argument, NULL, OPT_TRACE},
{"trace-backtrace", no_argument, NULL, OPT_TRACE_BACKTRACE},
{"trace-period", required_argument, NULL, OPT_TRACE_PERIOD},
{"trace-freq", required_argument, NULL, OPT_TRACE_FREQ},
{"read-sleep", required_argument, NULL, OPT_READ_SLEEP},
{"prog-sleep", required_argument, NULL, OPT_PROG_SLEEP},
{"erase-sleep", required_argument, NULL, OPT_ERASE_SLEEP},
{NULL, 0, NULL, 0},
};
const char *const help_text[] = {
"Show this help message.",
"Show quick summary.",
"List bench suites.",
"List bench cases.",
"List the path for each bench suite.",
"List the path and line number for each bench case.",
"List all defines in this bench-runner.",
"List explicit defines in this bench-runner.",
"List implicit defines in this bench-runner.",
"Override a bench define.",
"How deep to evaluate recursive defines before erroring.",
"Comma-separated range of permutations to run.",
"Ignore bench filters.",
"Direct block device operations to this file.",
"Direct trace output to this file.",
"Include a backtrace with every trace statement.",
"Sample trace output at this period in cycles.",
"Sample trace output at this frequency in hz.",
"Artificial read delay in seconds.",
"Artificial prog delay in seconds.",
"Artificial erase delay in seconds.",
};
int main(int argc, char **argv) {
void (*op)(void) = run;
size_t bench_override_define_capacity = 0;
size_t bench_id_capacity = 0;
// parse options
while (true) {
int c = getopt_long(argc, argv, short_opts, long_opts, NULL);
switch (c) {
// generate help message
case OPT_HELP:;
printf("usage: %s [options] [bench_id]\n", argv[0]);
printf("\n");
printf("options:\n");
size_t i = 0;
while (long_opts[i].name) {
size_t indent;
if (long_opts[i].has_arg == no_argument) {
if (long_opts[i].val >= '0' && long_opts[i].val < 'z') {
indent = printf(" -%c, --%s ",
long_opts[i].val,
long_opts[i].name);
} else {
indent = printf(" --%s ",
long_opts[i].name);
}
} else {
if (long_opts[i].val >= '0' && long_opts[i].val < 'z') {
indent = printf(" -%c %s, --%s %s ",
long_opts[i].val,
long_opts[i].name,
long_opts[i].name,
long_opts[i].name);
} else {
indent = printf(" --%s %s ",
long_opts[i].name,
long_opts[i].name);
}
}
// a quick, hacky, byte-level method for text wrapping
size_t len = strlen(help_text[i]);
size_t j = 0;
if (indent < 24) {
printf("%*s %.80s\n",
(int)(24-1-indent),
"",
&help_text[i][j]);
j += 80;
} else {
printf("\n");
}
while (j < len) {
printf("%24s%.80s\n", "", &help_text[i][j]);
j += 80;
}
i += 1;
}
printf("\n");
exit(0);
// summary/list flags
case OPT_SUMMARY:;
op = summary;
break;
case OPT_LIST_SUITES:;
op = list_suites;
break;
case OPT_LIST_CASES:;
op = list_cases;
break;
case OPT_LIST_SUITE_PATHS:;
op = list_suite_paths;
break;
case OPT_LIST_CASE_PATHS:;
op = list_case_paths;
break;
case OPT_LIST_DEFINES:;
op = list_defines;
break;
case OPT_LIST_PERMUTATION_DEFINES:;
op = list_permutation_defines;
break;
case OPT_LIST_IMPLICIT_DEFINES:;
op = list_implicit_defines;
break;
// configuration
case OPT_DEFINE:;
// allocate space
bench_define_t *override = mappend(
(void**)&bench_override_defines,
sizeof(bench_define_t),
&bench_override_define_count,
&bench_override_define_capacity);
// parse into string key/intmax_t value, cannibalizing the
// arg in the process
char *sep = strchr(optarg, '=');
char *parsed = NULL;
if (!sep) {
goto invalid_define;
}
*sep = '\0';
override->name = optarg;
optarg = sep+1;
// parse comma-separated permutations
{
bench_override_value_t *override_values = NULL;
size_t override_value_count = 0;
size_t override_value_capacity = 0;
size_t override_permutations = 0;
while (true) {
optarg += strspn(optarg, " ");
if (strncmp(optarg, "range", strlen("range")) == 0) {
// range of values
optarg += strlen("range");
optarg += strspn(optarg, " ");
if (*optarg != '(') {
goto invalid_define;
}
optarg += 1;
intmax_t start = strtoumax(optarg, &parsed, 0);
intmax_t stop = -1;
intmax_t step = 1;
// allow empty string for start=0
if (parsed == optarg) {
start = 0;
}
optarg = parsed + strspn(parsed, " ");
if (*optarg != ',' && *optarg != ')') {
goto invalid_define;
}
if (*optarg == ',') {
optarg += 1;
stop = strtoumax(optarg, &parsed, 0);
// allow empty string for stop=end
if (parsed == optarg) {
stop = -1;
}
optarg = parsed + strspn(parsed, " ");
if (*optarg != ',' && *optarg != ')') {
goto invalid_define;
}
if (*optarg == ',') {
optarg += 1;
step = strtoumax(optarg, &parsed, 0);
// allow empty string for stop=1
if (parsed == optarg) {
step = 1;
}
optarg = parsed + strspn(parsed, " ");
if (*optarg != ')') {
goto invalid_define;
}
}
} else {
// single value = stop only
stop = start;
start = 0;
}
if (*optarg != ')') {
goto invalid_define;
}
optarg += 1;
// append range
*(bench_override_value_t*)mappend(
(void**)&override_values,
sizeof(bench_override_value_t),
&override_value_count,
&override_value_capacity)
= (bench_override_value_t){
.start = start,
.stop = stop,
.step = step,
};
if (step > 0) {
override_permutations += (stop-1 - start)
/ step + 1;
} else {
override_permutations += (start-1 - stop)
/ -step + 1;
}
} else if (*optarg != '\0') {
// single value
intmax_t define = strtoumax(optarg, &parsed, 0);
if (parsed == optarg) {
goto invalid_define;
}
optarg = parsed + strspn(parsed, " ");
// append value
*(bench_override_value_t*)mappend(
(void**)&override_values,
sizeof(bench_override_value_t),
&override_value_count,
&override_value_capacity)
= (bench_override_value_t){
.start = define,
.step = 0,
};
override_permutations += 1;
} else {
break;
}
if (*optarg == ',') {
optarg += 1;
}
}
// define should be patched in bench_define_suite
override->define = NULL;
override->cb = bench_override_cb;
override->data = malloc(sizeof(bench_override_data_t));
*(bench_override_data_t*)override->data
= (bench_override_data_t){
.values = override_values,
.value_count = override_value_count,
};
override->permutations = override_permutations;
}
break;
invalid_define:;
fprintf(stderr, "error: invalid define: %s\n", optarg);
exit(-1);
case OPT_DEFINE_DEPTH:;
parsed = NULL;
bench_define_depth = strtoumax(optarg, &parsed, 0);
if (parsed == optarg) {
fprintf(stderr, "error: invalid define-depth: %s\n", optarg);
exit(-1);
}
break;
case OPT_STEP:;
parsed = NULL;
bench_step_start = strtoumax(optarg, &parsed, 0);
bench_step_stop = -1;
bench_step_step = 1;
// allow empty string for start=0
if (parsed == optarg) {
bench_step_start = 0;
}
optarg = parsed + strspn(parsed, " ");
if (*optarg != ',' && *optarg != '\0') {
goto step_unknown;
}
if (*optarg == ',') {
optarg += 1;
bench_step_stop = strtoumax(optarg, &parsed, 0);
// allow empty string for stop=end
if (parsed == optarg) {
bench_step_stop = -1;
}
optarg = parsed + strspn(parsed, " ");
if (*optarg != ',' && *optarg != '\0') {
goto step_unknown;
}
if (*optarg == ',') {
optarg += 1;
bench_step_step = strtoumax(optarg, &parsed, 0);
// allow empty string for stop=1
if (parsed == optarg) {
bench_step_step = 1;
}
optarg = parsed + strspn(parsed, " ");
if (*optarg != '\0') {
goto step_unknown;
}
}
} else {
// single value = stop only
bench_step_stop = bench_step_start;
bench_step_start = 0;
}
break;
step_unknown:;
fprintf(stderr, "error: invalid step: %s\n", optarg);
exit(-1);
case OPT_FORCE:;
bench_force = true;
break;
case OPT_DISK:;
bench_disk_path = optarg;
break;
case OPT_TRACE:;
bench_trace_path = optarg;
break;
case OPT_TRACE_BACKTRACE:;
bench_trace_backtrace = true;
break;
case OPT_TRACE_PERIOD:;
parsed = NULL;
bench_trace_period = strtoumax(optarg, &parsed, 0);
if (parsed == optarg) {
fprintf(stderr, "error: invalid trace-period: %s\n", optarg);
exit(-1);
}
break;
case OPT_TRACE_FREQ:;
parsed = NULL;
bench_trace_freq = strtoumax(optarg, &parsed, 0);
if (parsed == optarg) {
fprintf(stderr, "error: invalid trace-freq: %s\n", optarg);
exit(-1);
}
break;
case OPT_READ_SLEEP:;
parsed = NULL;
double read_sleep = strtod(optarg, &parsed);
if (parsed == optarg) {
fprintf(stderr, "error: invalid read-sleep: %s\n", optarg);
exit(-1);
}
bench_read_sleep = read_sleep*1.0e9;
break;
case OPT_PROG_SLEEP:;
parsed = NULL;
double prog_sleep = strtod(optarg, &parsed);
if (parsed == optarg) {
fprintf(stderr, "error: invalid prog-sleep: %s\n", optarg);
exit(-1);
}
bench_prog_sleep = prog_sleep*1.0e9;
break;
case OPT_ERASE_SLEEP:;
parsed = NULL;
double erase_sleep = strtod(optarg, &parsed);
if (parsed == optarg) {
fprintf(stderr, "error: invalid erase-sleep: %s\n", optarg);
exit(-1);
}
bench_erase_sleep = erase_sleep*1.0e9;
break;
// done parsing
case -1:;
goto getopt_done;
// unknown arg, getopt prints a message for us
default:;
exit(-1);
}
}
getopt_done: ;
if (argc > optind) {
// reset our bench identifier list
bench_ids = NULL;
bench_id_count = 0;
bench_id_capacity = 0;
}
// parse bench identifier, if any, cannibalizing the arg in the process
for (; argc > optind; optind++) {
bench_define_t *defines = NULL;
size_t define_count = 0;
// parse name, can be suite or case
char *name = argv[optind];
char *defines_ = strchr(name, ':');
if (defines_) {
*defines_ = '\0';
defines_ += 1;
}
// remove optional path and .toml suffix
char *slash = strrchr(name, '/');
if (slash) {
name = slash+1;
}
size_t name_len = strlen(name);
if (name_len > 5 && strcmp(&name[name_len-5], ".toml") == 0) {
name[name_len-5] = '\0';
}
if (defines_) {
// parse defines
while (true) {
char *parsed;
size_t d = leb16_parse(defines_, &parsed);
intmax_t v = leb16_parse(parsed, &parsed);
if (parsed == defines_) {
break;
}
defines_ = parsed;
if (d >= define_count) {
// align to power of two to avoid any superlinear growth
size_t ncount = 1 << lfs3_nlog2(d+1);
defines = realloc(defines,
ncount*sizeof(bench_define_t));
memset(defines+define_count, 0,
(ncount-define_count)*sizeof(bench_define_t));
define_count = ncount;
}
// name/define should be patched in bench_define_suite
defines[d] = BENCH_LIT(NULL, v);
}
}
// append to identifier list
*(bench_id_t*)mappend(
(void**)&bench_ids,
sizeof(bench_id_t),
&bench_id_count,
&bench_id_capacity) = (bench_id_t){
.name = name,
.defines = defines,
.define_count = define_count,
};
}
// do the thing
op();
// cleanup (need to be done for valgrind benching)
bench_define_cleanup();
if (bench_override_defines) {
for (size_t i = 0; i < bench_override_define_count; i++) {
free((void*)(
(const bench_override_data_t*)
bench_override_defines[i].data)->values);
free((void*)bench_override_defines[i].data);
}
free((void*)bench_override_defines);
}
if (bench_id_capacity) {
for (size_t i = 0; i < bench_id_count; i++) {
free((void*)bench_ids[i].defines);
}
free((void*)bench_ids);
}
}
View Git Blame Copy Permalink