ztress.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__
#define TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__
 
#include <zephyr/sys/util.h>
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ZTRESS_ID_THREAD 0
#define ZTRESS_ID_K_TIMER 1
 
#define ZTRESS_TIMER(handler, user_data, exec_cnt, init_timeout) \
        (ZTRESS_ID_K_TIMER, handler, user_data, exec_cnt, 0, init_timeout)
 
#define ZTRESS_THREAD(handler, user_data, exec_cnt, preempt_cnt, init_timeout) \
        (ZTRESS_ID_THREAD, handler, user_data, exec_cnt, preempt_cnt, init_timeout)
 
typedef bool (*ztress_handler)(void *user_data, uint32_t cnt, bool last, int prio);
 
struct ztress_context_data {
        /* Handler. */
        ztress_handler handler;
 
        /* User data */
        void *user_data;
 
        /* Minimum number of executions to complete the test. */
        uint32_t exec_cnt;
 
        /* Minimum number of preemptions to complete the test. Valid only for
         * thread context.
         */
        uint32_t preempt_cnt;
 
        /* Initial timeout. */
        k_timeout_t t;
};
 
#define ZTRESS_CONTEXT_INITIALIZER(_handler, _user_data, _exec_cnt, _preempt_cnt, _t) \
        { \
                .handler = (_handler), \
                .user_data = (_user_data), \
                .exec_cnt = (_exec_cnt), \
                .preempt_cnt = (_preempt_cnt), \
                .t = (_t) \
        }
 
#define Z_ZTRESS_GET_HANDLER_DATA2(_, ...) \
        ZTRESS_CONTEXT_INITIALIZER(__VA_ARGS__)
 
#define Z_ZTRESS_GET_HANDLER_DATA(data) \
        Z_ZTRESS_GET_HANDLER_DATA2 data
 
#define Z_ZTRESS_HAS_TIMER(data, ...) \
        GET_ARG_N(1, __DEBRACKET data)
 
#define Z_ZTRESS_TIMER_IDX(idx, data) \
        ((GET_ARG_N(1, __DEBRACKET data)) == ZTRESS_ID_K_TIMER ? idx : 0)
 
#define Z_ZTRESS_TIMER_CONTEXT_VALIDATE(...) \
        BUILD_ASSERT((FOR_EACH_IDX(Z_ZTRESS_TIMER_IDX, (+), __VA_ARGS__)) == 0, \
                        "There can only be up to one ZTRESS_TIMER context and it must " \
                        "be the first in the list")
 
#define ZTRESS_EXECUTE(...) do {                                                        \
        Z_ZTRESS_TIMER_CONTEXT_VALIDATE(__VA_ARGS__);                                   \
        int has_timer = Z_ZTRESS_HAS_TIMER(__VA_ARGS__);                                \
        struct ztress_context_data _ctx_data1[] = {                                     \
                FOR_EACH(Z_ZTRESS_GET_HANDLER_DATA, (,), __VA_ARGS__)                   \
        };                                                                              \
        size_t cnt = ARRAY_SIZE(_ctx_data1) - has_timer;                                \
        static struct ztress_context_data _ctx_data[ARRAY_SIZE(_ctx_data1)];            \
        for (size_t i = 0; i < ARRAY_SIZE(_ctx_data1); i++) {                           \
                _ctx_data[i] = _ctx_data1[i];                                           \
        }                                                                               \
        int exec_err = ztress_execute(has_timer ? &_ctx_data[0] : NULL,                 \
                                 &_ctx_data[has_timer], cnt);                           \
                                                                                        \
        zassert_equal(exec_err, 0, "ztress_execute failed (err: %d)", exec_err);        \
} while (0)
 
int ztress_execute(struct ztress_context_data *timer_data,
                     struct ztress_context_data *thread_data,
                     size_t cnt);
 
void ztress_abort(void);
 
void ztress_set_timeout(k_timeout_t t);
 
void ztress_report(void);
 
int ztress_exec_count(uint32_t id);
 
int ztress_preempt_count(uint32_t id);
 
uint32_t ztress_optimized_ticks(uint32_t id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__ */