littlefs/runners/bench_runner.h

/*
 * Runner for littlefs benchmarks
 *
 * Copyright (c) 2022, The littlefs authors.
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef BENCH_RUNNER_H
#define BENCH_RUNNER_H


// override LFS3_TRACE
void bench_trace(const char *fmt, ...);

#define LFS3_TRACE_(fmt, ...) \
    bench_trace("%s:%d:trace: " fmt "%s\n", \
        __FILE__, \
        __LINE__, \
        __VA_ARGS__)
#define LFS3_TRACE(...) LFS3_TRACE_(__VA_ARGS__, "")
#define LFS3_EMUBD_TRACE(...) LFS3_TRACE_(__VA_ARGS__, "")

// BENCH_START/BENCH_STOP macros measure readed/proged/erased bytes
// through emubd
void bench_start(const char *m, uintmax_t n);
void bench_stop(const char *m);

#define BENCH_START(m, n) bench_start(m, n)
#define BENCH_STOP(m) bench_stop(m)

// BENCH_RESULT/BENCH_FRESULT allow for explicit non-io measurements
void bench_result(const char *m, uintmax_t n, uintmax_t result);
void bench_fresult(const char *m, uintmax_t n, double result);

#define BENCH_RESULT(m, n, result) bench_result(m, n, result)
#define BENCH_FRESULT(m, n, result) bench_fresult(m, n, result)


// note these are indirectly included in any generated files
#include "bd/lfs3_emubd.h"
#include <stdio.h>

// give source a chance to define feature macros
#undef _FEATURES_H
#undef _STDIO_H


// generated bench configurations
struct lfs3_cfg;

enum bench_flags {
    BENCH_INTERNAL  = 0x1,
};
typedef uint8_t bench_flags_t;

typedef struct bench_define {
    const char *name;
    intmax_t *define;
    intmax_t (*cb)(void *data, size_t i);
    void *data;
    size_t permutations;
} bench_define_t;

struct bench_case {
    const char *name;
    const char *path;
    bench_flags_t flags;

    const bench_define_t *defines;
    size_t permutations;

    bool (*if_)(void);
    void (*run)(struct lfs3_cfg *cfg);
};

struct bench_suite {
    const char *name;
    const char *path;
    bench_flags_t flags;

    const bench_define_t *defines;
    size_t define_count;

    const struct bench_case *cases;
    size_t case_count;
};

extern const struct bench_suite *const bench_suites[];
extern const size_t bench_suite_count;


// deterministic prng for pseudo-randomness in benches
uint32_t bench_prng(uint32_t *state);

#define BENCH_PRNG(state) bench_prng(state)

// generation of specific permutations of an array for exhaustive benching
size_t bench_factorial(size_t x);
void bench_permutation(size_t i, uint32_t *buffer, size_t size);

#define BENCH_FACTORIAL(x) bench_factorial(x)
#define BENCH_PERMUTATION(i, buffer, size) bench_permutation(i, buffer, size)


// a few preconfigured defines that control how benches run
#define BENCH_IMPLICIT_DEFINES \
    /*        name                      value (overridable)                */ \
    BENCH_DEFINE(READ_SIZE,             1                                   ) \
    BENCH_DEFINE(PROG_SIZE,             1                                   ) \
    BENCH_DEFINE(BLOCK_SIZE,            4096                                ) \
    BENCH_DEFINE(BLOCK_COUNT,           DISK_SIZE/BLOCK_SIZE                ) \
    BENCH_DEFINE(DISK_SIZE,             1024*1024                           ) \
    BENCH_DEFINE(BLOCK_RECYCLES,        -1                                  ) \
    BENCH_DEFINE(RCACHE_SIZE,           LFS3_MAX(16, READ_SIZE)             ) \
    BENCH_DEFINE(PCACHE_SIZE,           LFS3_MAX(16, PROG_SIZE)             ) \
    BENCH_DEFINE(FILE_CACHE_SIZE,       16                                  ) \
    BENCH_DEFINE(LOOKAHEAD_SIZE,        16                                  ) \
    BENCH_DEFINE(GC_FLAGS,              LFS3_GC_ALL                         ) \
    BENCH_DEFINE(GC_STEPS,              0                                   ) \
    BENCH_DEFINE(GC_COMPACTMETA_THRESH, 0                                   ) \
    BENCH_DEFINE(SHRUB_SIZE,            BLOCK_SIZE/4                        ) \
    BENCH_DEFINE(FRAGMENT_SIZE,         LFS3_MIN(BLOCK_SIZE/8, 512)         ) \
    BENCH_DEFINE(CRYSTAL_THRESH,        BLOCK_SIZE/8                        ) \
    BENCH_DEFINE(GBMAP_REPOP_THRESH,    BLOCK_COUNT/4                       ) \
    BENCH_DEFINE(ERASE_VALUE,           0xff                                ) \
    BENCH_DEFINE(ERASE_CYCLES,          0                                   ) \
    BENCH_DEFINE(BADBLOCK_BEHAVIOR,     LFS3_EMUBD_BADBLOCK_PROGERROR       ) \
    BENCH_DEFINE(POWERLOSS_BEHAVIOR,    LFS3_EMUBD_POWERLOSS_ATOMIC         ) \
    BENCH_DEFINE(EMUBD_SEED,            0                                   )

// declare defines as global intmax_ts
#define BENCH_DEFINE(k, v) \
    extern intmax_t k;

    BENCH_IMPLICIT_DEFINES
#undef BENCH_DEFINE

// map defines to cfg struct fields
#define BENCH_CFG \
    .read_size              = READ_SIZE,                \
    .prog_size              = PROG_SIZE,                \
    .block_size             = BLOCK_SIZE,               \
    .block_count            = BLOCK_COUNT,              \
    .block_recycles         = BLOCK_RECYCLES,           \
    .rcache_size            = RCACHE_SIZE,              \
    .pcache_size            = PCACHE_SIZE,              \
    .file_cache_size        = FILE_CACHE_SIZE,          \
    .lookahead_size         = LOOKAHEAD_SIZE,           \
    BENCH_GBMAP_CFG                                     \
    BENCH_GC_CFG                                        \
    .gc_compactmeta_thresh  = GC_COMPACTMETA_THRESH,    \
    .shrub_size             = SHRUB_SIZE,               \
    .fragment_size          = FRAGMENT_SIZE,            \
    .crystal_thresh         = CRYSTAL_THRESH,

#ifdef LFS3_GBMAP
#define BENCH_GBMAP_CFG \
    .gbmap_repop_thresh     = GBMAP_REPOP_THRESH,
#else
#define BENCH_GBMAP_CFG
#endif

#ifdef LFS3_GC
#define BENCH_GC_CFG \
    .gc_flags               = GC_FLAGS,                 \
    .gc_steps               = GC_STEPS,
#else
#define BENCH_GC_CFG
#endif

#define BENCH_BDCFG \
    .erase_value            = ERASE_VALUE,              \
    .erase_cycles           = ERASE_CYCLES,             \
    .badblock_behavior      = BADBLOCK_BEHAVIOR,        \
    .powerloss_behavior     = POWERLOSS_BEHAVIOR,       \
    .seed                   = EMUBD_SEED,


#endif