/*
 * Copyright (c) 2006-2025, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author         Notes
 * 2025-07-03     rcitach        test case for mbox
 * 2025-11-30     westcity-YOLO  Add standardized utest documentation block
 */

/**
 * Test Case Name: Kernel Core Mailbox Performance Test
 *
 * Test Objectives:
 * - Measures mailbox object synchronization performance
 * - Validates mailbox message passing with priority handling
 * - Provides latency metrics for inter-thread communication
 *
 * Test Scenarios:
 * - **Mailbox Message Passing**: Single message (1) sent/received
 * - **Priority Handling**: Higher-priority thread (THREAD_PRIORITY+1) response
 * - **Stress Test**: Repeated message passing (RT_UTEST_SYS_PERF_TC_COUNT times)
 * - **Thread Coordination**: Two threads exchanging messages via semaphores
 *
 * Verification Metrics:
 * - Message passing latency < 40μs
 * - 0 errors in mailbox operations
 * - Consistent results across test cycles
 * - No memory leaks during test
 *
 * Dependencies:
 * - RT_USING_MAILBOX must be enabled
 * - RT_USING_UTEST framework
 * - Hardware timer support (for high-precision timing)
 *
 * Expected Results:
 * [  PASSED  ] [ result   ] testcase (core.mbox)
 * - Structured performance data table (Min/Max/Avg latency)
 * - Final line: "=== Mailbox Performance Test Results End ==="
 * - Executable via: `utest_run core.mbox` in msh
 */

#include <rtthread.h>
#include <rthw.h>
#include <rtdevice.h>
#include <utest.h>
#include <utest_assert.h>
#include <perf_tc.h>

static rt_sem_t sem1 = RT_NULL;
static rt_sem_t complete_sem = RT_NULL;
static rt_mailbox_t perf_thread_mbox = RT_NULL;

static void perf_thread_mbox1(void *parameter)
{
    rt_ubase_t recv = 0;
    rt_err_t ret = RT_EOK;
    rt_perf_t *perf = (rt_perf_t *)parameter;
    while (1)
    {
        ret = rt_mb_recv(perf_thread_mbox, &recv, RT_WAITING_FOREVER);
        rt_perf_stop(perf);
        if (ret != RT_EOK)
        {
            LOG_E("mbox recv value error!\n");
            rt_mb_delete(perf_thread_mbox);
            return;
        }

        if (perf->count >= RT_UTEST_SYS_PERF_TC_COUNT)
        {
            rt_mb_delete(perf_thread_mbox);
            rt_sem_delete(sem1);
            return;
        }
        rt_sem_release(sem1);
    }
}

static void perf_thread_mbox2(void *parameter)
{
    rt_perf_t *perf = (rt_perf_t *)parameter;
    rt_err_t ret = RT_EOK;
    while (1)
    {
        if (perf->count >= RT_UTEST_SYS_PERF_TC_COUNT)
        {
            rt_sem_release(complete_sem);
            return;
        }
        rt_sem_take(sem1, RT_WAITING_FOREVER);
        rt_perf_start(perf);
        rt_mb_send(perf_thread_mbox, 1);
    }
}

rt_err_t rt_perf_thread_mbox(rt_perf_t *perf)
{
    rt_thread_t thread1 = RT_NULL;
    rt_thread_t thread2 = RT_NULL;

# if __STDC_VERSION__ >= 199901L
    rt_strcpy(perf->name,__func__);
#else
    rt_strcpy(perf->name,"rt_perf_thread_mbox");
#endif

    perf_thread_mbox = rt_mb_create("perf_thread_mbox", 1, RT_IPC_FLAG_PRIO);
    if (perf_thread_mbox == RT_NULL)
    {
        LOG_E("perf thread mbox create failed.");
        return -RT_ERROR;
    }

    sem1 = rt_sem_create("sem1", 1, RT_IPC_FLAG_FIFO);
    complete_sem = rt_sem_create("complete", 0, RT_IPC_FLAG_FIFO);

    thread1 = rt_thread_create("perf_thread_mbox1", perf_thread_mbox1, perf,
                                THREAD_STACK_SIZE, THREAD_PRIORITY, THREAD_TIMESLICE);
    if (thread1 == RT_NULL)
    {
        LOG_E("perf_thread_mbox1 create failed.");
        return -RT_ERROR;
    }

    thread2 = rt_thread_create("perf_thread_mbox2", perf_thread_mbox2, perf,
                                THREAD_STACK_SIZE, THREAD_PRIORITY + 1, THREAD_TIMESLICE);
    if (thread2 == RT_NULL)
    {
        LOG_E("perf_thread_mbox2 create failed.");
        return -RT_ERROR;
    }

    rt_thread_startup(thread1);
    rt_thread_startup(thread2);

    rt_sem_take(complete_sem, RT_WAITING_FOREVER);
    rt_perf_dump(perf);
    rt_sem_delete(complete_sem);
    return RT_EOK;
}