/* Copyright (c) 2014, Linaro Limited
 * All rights reserved.
 *
 * SPDX-License-Identifier:     BSD-3-Clause
 */

/**
 * @file
 *
 * ODP test application common headers
 */

#ifndef ODP_CUNICT_COMMON_H
#define ODP_CUNICT_COMMON_H

#include <stdint.h>
#include "CUnit/Basic.h"
#include "CUnit/TestDB.h"

#define MAX_WORKERS 32 /**< Maximum number of work threads */

typedef int (*cunit_test_check_active)(void);

typedef struct {
	CU_TestInfo testinfo;
	cunit_test_check_active check_active;
} odp_testinfo_t;

typedef struct {
	const char       *pName;
	CU_InitializeFunc pInitFunc;
	CU_CleanupFunc    pCleanupFunc;
	odp_testinfo_t   *pTests;
} odp_suiteinfo_t;

static inline int odp_cunit_test_inactive(void) { return 0; }
static inline void odp_cunit_test_missing(void) { }

/* An active test case, with the test name matching the test function name */
#define ODP_TEST_INFO(test_func) \
	{{#test_func, test_func}, NULL}

/* A test case that is unconditionally inactive. Its name will be registered
 * with CUnit but it won't be executed and will be reported as inactive in
 * the result summary. */
#define ODP_TEST_INFO_INACTIVE(test_func) \
	{{#test_func, odp_cunit_test_missing}, odp_cunit_test_inactive}

/* A test case that may be marked as inactive at runtime based on the
 * return value of the cond_func function. A return value of 0 means
 * inactive, anything else is active. */
#define ODP_TEST_INFO_CONDITIONAL(test_func, cond_func) \
	{{#test_func, test_func}, cond_func}

#define ODP_TEST_INFO_NULL {CU_TEST_INFO_NULL, NULL}
#define ODP_SUITE_INFO_NULL {NULL, NULL, NULL, NULL}

typedef struct {
	uint32_t foo;
	uint32_t bar;
} test_shared_data_t;

/**
 * Thread argument
 */
typedef struct {
	int testcase; /**< specifies which set of API's to exercise */
	int numthrds; /**< no of pthreads to create */
} pthrd_arg;

/* register suites to be run via odp_cunit_run() */
int odp_cunit_register(odp_suiteinfo_t testsuites[]);
/* update tests previously registered via odp_cunit_register() */
int odp_cunit_update(odp_suiteinfo_t testsuites[]);
/* the function, called by module main(), to run the testsuites: */
int odp_cunit_run(void);

/** create thread fro start_routine function */
int odp_cunit_thread_create(void *func_ptr(void *), pthrd_arg *arg);
int odp_cunit_thread_exit(pthrd_arg *);

/**
 * Global tests initialization/termination.
 *
 * Initialize global resources needed by the test executable. Default
 * definition does ODP init / term (both global and local).
 * Test executables can override it by calling one of the register function
 * below.
 * The functions are called at the very beginning and very end of the test
 * execution. Passing NULL to odp_cunit_register_global_init() and/or
 * odp_cunit_register_global_term() is legal and will simply prevent the
 * default (ODP init/term) to be done.
 */
void odp_cunit_register_global_init(int (*func_init_ptr)(void));

void odp_cunit_register_global_term(int (*func_term_ptr)(void));

#endif /* ODP_CUNICT_COMMON_H */