Zephyr Benchmarking Framework

Macros
#define	ZTEST_BENCHMARK_SUITE(suite, setup_fn, teardown_fn)
	Define a benchmark suite.
#define	ZTEST_BENCHMARK_SETUP_TEARDOWN(suite_name, benchmark, samples, setup_fn, teardown_fn)
	Define a benchmark with setup and teardown functions.
#define	ZTEST_BENCHMARK_TIMED_SETUP_TEARDOWN(testsuite, benchmark, duration, setup_fn, teardown_fn)
	Define a timed benchmark with setup and teardown functions.
#define	ZTEST_BENCHMARK(suite, benchmark, samples)
	Define a benchmark without setup and teardown functions.
#define	ZTEST_BENCHMARK_TIMED(suite, benchmark, duration)
	Define a timed benchmark without setup and teardown functions.

Detailed Description

Macro Definition Documentation

ZTEST_BENCHMARK

#define ZTEST_BENCHMARK	(		suite,
			benchmark,
			samples )

#include </__w/zephyr/zephyr/subsys/testsuite/ztest/include/zephyr/benchmark.h>

Value:

ZTEST_BENCHMARK_SETUP_TEARDOWN(suite, benchmark, samples, NULL, NULL)

Define a benchmark without setup and teardown functions.

Parameters

suite	Name of the suite the benchmark belongs to
benchmark	Name of the benchmark
samples	Number of iterations to run the benchmark

ZTEST_BENCHMARK_SETUP_TEARDOWN

#define ZTEST_BENCHMARK_SETUP_TEARDOWN	(		suite_name,
			benchmark,
			samples,
			setup_fn,
			teardown_fn )

#include </__w/zephyr/zephyr/subsys/testsuite/ztest/include/zephyr/benchmark.h>

Value:

static __noinline void benchmark##_fn(void);                                            \
static const STRUCT_SECTION_ITERABLE(ztest_benchmark, benchmark) =                      \
{                                                                                       \
        .name = #benchmark,                                                             \
        .iterations = samples,                                                          \
        .setup = setup_fn,                                                              \
        .run = benchmark##_fn,                                                          \
        .teardown = teardown_fn,                                                        \
        .suite = &suite_name,                                                           \
};                                                                                      \
static __noinline void benchmark##_fn(void)

Define a benchmark with setup and teardown functions.

Parameters

suite_name	Name of the suite the benchmark belongs to
benchmark	Name of the benchmark
samples	Number of iterations to run the benchmark
setup_fn	Function to run before the benchmark
teardown_fn	Function to run after the benchmark

ZTEST_BENCHMARK_SUITE

#define ZTEST_BENCHMARK_SUITE	(		suite,
			setup_fn,
			teardown_fn )

#include </__w/zephyr/zephyr/subsys/testsuite/ztest/include/zephyr/benchmark.h>

Value:

static const STRUCT_SECTION_ITERABLE(ztest_benchmark_suite, suite) =    \
{                                                                       \
        .name = #suite,                                                 \
        .setup = setup_fn,                                              \
        .teardown = teardown_fn,                                        \
}

Define a benchmark suite.

Parameters

suite	Name of the suite
setup_fn	Function to run before the suite
teardown_fn	Function to run after the suite

ZTEST_BENCHMARK_TIMED

#define ZTEST_BENCHMARK_TIMED	(		suite,
			benchmark,
			duration )

#include </__w/zephyr/zephyr/subsys/testsuite/ztest/include/zephyr/benchmark.h>

Value:

ZTEST_BENCHMARK_TIMED_SETUP_TEARDOWN(suite, benchmark, duration, NULL, NULL)

Define a timed benchmark without setup and teardown functions.

Parameters

suite	Name of the suite the benchmark belongs to
benchmark	Name of the benchmark
duration	Duration in milliseconds to run the benchmark

ZTEST_BENCHMARK_TIMED_SETUP_TEARDOWN

#define ZTEST_BENCHMARK_TIMED_SETUP_TEARDOWN	(		testsuite,
			benchmark,
			duration,
			setup_fn,
			teardown_fn )

#include </__w/zephyr/zephyr/subsys/testsuite/ztest/include/zephyr/benchmark.h>

Value:

static __noinline void benchmark##_fn(void);                                            \
static const STRUCT_SECTION_ITERABLE(ztest_benchmark_timed, benchmark) =                \
{                                                                                       \
        .name = #benchmark,                                                             \
        .duration_ms = duration,                                                        \
        .setup = setup_fn,                                                              \
        .run = benchmark##_fn,                                                          \
        .teardown = teardown_fn,                                                        \
        .suite = &testsuite,                                                            \
};                                                                                      \
static __noinline void benchmark##_fn(void)

Define a timed benchmark with setup and teardown functions.

Parameters

testsuite	Name of the suite the benchmark belongs to
benchmark	Name of the benchmark
duration	Duration in milliseconds to run the benchmark
setup_fn	Function to run before the benchmark
teardown_fn	Function to run after the benchmark