1 /*
2  * Copyright (c) 2006-2024, RT-Thread Development Team
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  *
6  * Change Logs:
7  * Date           Author       Notes
8  * 2024-01-17     Shell        the first version
9  */
10 #include <rtthread.h>
11 #include <stdlib.h>
12 #include "utest.h"
13 
14 /**
15  * Stressful Test for Mutex
16  */
17 
18 #define TEST_SECONDS 30
19 #define TEST_LOOP_TICKS (TEST_SECONDS * RT_TICK_PER_SECOND)
20 #define TEST_THREAD_COUNTS (RT_CPUS_NR)
21 #define TEST_PROGRESS_COUNTS (36)
22 #define TEST_PROGRESS_ON (TEST_LOOP_TICKS/TEST_PROGRESS_COUNTS)
23 #define TEST_PRIORITY_HIGHEST (UTEST_THR_PRIORITY+1)
24 #define TEST_RANDOM_LATENCY_MAX (1000 * 1000)
25 
26 static struct rt_semaphore _thr_exit_sem;
27 static rt_atomic_t _progress_counter;
28 static rt_atomic_t _exit_flag;
29 static struct rt_mutex _racing_lock;
30 
test_thread_entry(void * param)31 static void test_thread_entry(void *param)
32 {
33     while (1)
34     {
35         rt_mutex_take(&_racing_lock, RT_WAITING_FOREVER);
36         rt_mutex_release(&_racing_lock);
37 
38         if (rt_atomic_load(&_exit_flag))
39         {
40             break;
41         }
42     }
43 
44     rt_sem_release(&_thr_exit_sem);
45 }
46 
mutex_stress_tc(void)47 static void mutex_stress_tc(void)
48 {
49     rt_err_t error;
50     rt_thread_t tester;
51     const rt_base_t priority_base = TEST_PRIORITY_HIGHEST;
52 
53     for (size_t i = 0; i < TEST_THREAD_COUNTS; i++)
54     {
55         tester = rt_thread_create(
56             "tester",
57             test_thread_entry,
58             (void *)0,
59             UTEST_THR_STACK_SIZE,
60             priority_base + (i % (RT_THREAD_PRIORITY_MAX - TEST_PRIORITY_HIGHEST)),
61             1);
62 
63         rt_thread_startup(tester);
64     }
65 
66     for (size_t i = 0; i < TEST_LOOP_TICKS; i++)
67     {
68         rt_thread_delay(1);
69 
70         if (rt_atomic_add(&_progress_counter, 1) % TEST_PROGRESS_ON == 0)
71             uassert_true(1);
72     }
73 
74     /* trigger exit request for all sub-threads */
75     rt_atomic_store(&_exit_flag, 1);
76 
77     /* waiting for sub-threads to exit */
78     for (size_t i = 0; i < TEST_THREAD_COUNTS; i++)
79     {
80         error = rt_sem_take(&_thr_exit_sem, RT_WAITING_FOREVER);
81         uassert_int_equal(error, RT_EOK);
82     }
83 }
84 
utest_tc_init(void)85 static rt_err_t utest_tc_init(void)
86 {
87     int *pseed = rt_malloc(sizeof(int));
88     srand(*(int *)pseed);
89     rt_free(pseed);
90 
91     rt_sem_init(&_thr_exit_sem, "test", 0, RT_IPC_FLAG_PRIO);
92     rt_mutex_init(&_racing_lock, "ipc", RT_IPC_FLAG_PRIO);
93     return RT_EOK;
94 }
95 
utest_tc_cleanup(void)96 static rt_err_t utest_tc_cleanup(void)
97 {
98     rt_sem_detach(&_thr_exit_sem);
99     rt_mutex_detach(&_racing_lock);
100     return RT_EOK;
101 }
102 
testcase(void)103 static void testcase(void)
104 {
105     UTEST_UNIT_RUN(mutex_stress_tc);
106 }
107 UTEST_TC_EXPORT(testcase, "testcases.kernel.scheduler.mutex", utest_tc_init, utest_tc_cleanup, TEST_SECONDS);
108