summaryrefslogtreecommitdiff
path: root/src/utest/perf/thread_mq_tc.c
blob: 3dcf099f3cc10ffd9e3f641875e493574c6c0638 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
 * 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 messagequeue
 * 2025-11-30     westcity-YOLO  Add standardized utest documentation block
 */

/**
 * Test Case Name: Kernel Core Message Queue Performance Test
 *
 * Test Objectives:
 * - Measures message queue synchronization performance
 * - Validates message passing with data payload (char 'A')
 * - Provides latency metrics for inter-thread communication
 *
 * Test Scenarios:
 * - **Message Queue Operation**: Single char message ('A') transfer
 * - **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 < 45μs
 * - 0 errors in message content verification
 * - Consistent results across test cycles
 * - No memory leaks during test
 *
 * Dependencies:
 * - RT_USING_MESSAGEQUEUE must be enabled
 * - RT_USING_UTEST framework
 * - Hardware timer support (for high-precision timing)
 *
 * Expected Results:
 * [  PASSED  ] [ result   ] testcase (core.mq)
 * - Structured performance data table (Min/Max/Avg latency)
 * - Final line: "=== Message Queue Performance Test Results End ==="
 * - Executable via: `utest_run core.mq` 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_mq_t perf_thread_mq = RT_NULL;

static void perf_thread_mq1(void *parameter)
{
    char recv = 0;
    rt_perf_t *perf = (rt_perf_t *)parameter;
    while (1)
    {
        rt_mq_recv(perf_thread_mq, &recv, 1, RT_WAITING_FOREVER);
        rt_perf_stop(perf);
        if (recv != 'A')
        {
            LOG_E("mq recv value error!");
            rt_mq_delete(perf_thread_mq);
            return;
        }

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

static void perf_thread_mq2(void *parameter)
{
    rt_perf_t *perf = (rt_perf_t *)parameter;
    char send = 'A';
    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_mq_send(perf_thread_mq, &send, 1);
    }
}

rt_err_t rt_perf_thread_mq(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_mq");
#endif

    perf_thread_mq = rt_mq_create("perf_thread_mq", 1, 1, RT_IPC_FLAG_PRIO);
    if (perf_thread_mq == RT_NULL)
    {
        LOG_E("perf_thread_mq 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_mq1", perf_thread_mq1, perf,
                                THREAD_STACK_SIZE, THREAD_PRIORITY, THREAD_TIMESLICE);
    if (thread1 == RT_NULL)
    {
        LOG_E("perf_thread_mq1 create failed.");
        return -RT_ERROR;
    }

    thread2 = rt_thread_create("perf_thread_mq2", perf_thread_mq2, perf,
                                THREAD_STACK_SIZE, THREAD_PRIORITY + 1, THREAD_TIMESLICE);
    if (thread2 == RT_NULL)
    {
        LOG_E("perf_thread_mq2 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;
}